ホーム › Security.Cryptography › NCryptStreamOpenToProtect

NCryptStreamOpenToProtect

関数

ストリーム形式でデータを保護するためのハンドルを開く。

DLLncrypt.dll呼出規約winapi対応OSwindows8.0

シグネチャ

// ncrypt.dll
#include <windows.h>

HRESULT NCryptStreamOpenToProtect(
    NCRYPT_DESCRIPTOR_HANDLE hDescriptor,
    DWORD dwFlags,
    HWND hWnd,   // optional
    NCRYPT_PROTECT_STREAM_INFO* pStreamInfo,
    NCRYPT_STREAM_HANDLE* phStream
);

パラメーター

名前

型

方向

説明

hDescriptor

NCRYPT_DESCRIPTOR_HANDLE

保護記述子のハンドル。このハンドルは NCryptCreateProtectionDescriptor を呼び出して作成します。

dwFlags

DWORD

このフラグは 0、または次の値を指定できます。

値	意味
NCRYPT_SILENT_FLAG	キーサービスプロバイダーがユーザーインターフェイスを表示しないように要求します。

hWnd

HWND

inoptional

表示するユーザーインターフェイス(存在する場合)の親ウィンドウのハンドル。

pStreamInfo

NCRYPT_PROTECT_STREAM_INFO*

暗号化されたデータを受け取るユーザー定義のコールバック関数のアドレスと、ユーザー定義のコンテキストデータへのポインターを含む NCRYPT_PROTECT_STREAM_INFO 構造体へのポインター。

phStream

NCRYPT_STREAM_HANDLE*

out

ストリームオブジェクトハンドルへのポインター。

戻り値の型: HRESULT

公式ドキュメント

指定された保護記述子に対して、大量のデータを暗号化するために使用できるストリームオブジェクトを開きます。

戻り値

関数の成功または失敗を示すステータスコードを返します。返される可能性のあるコードには、次のものが含まれますが、これらに限定されません。

戻り値	説明
ERROR_SUCCESS	関数は成功しました。
NTE_BAD_FLAGS	dwFlags パラメーターには 0、NCRYPT_MACHINE_KEY_FLAG、または NCRYPT_SILENT_FLAG を指定する必要があります。
NTE_INVALID_HANDLE	hDescriptor パラメーターで指定されたハンドルが無効です。
NTE_INVALID_PARAMETER	phStream および pStreamInfo パラメーターを NULL にすることはできません。 pStreamInfo パラメーターが指す NCRYPT_PROTECT_STREAM_INFO 構造体の pfnStreamOutput メンバーが指すコールバック関数を NULL にすることはできません。
NTE_NO_MEMORY	データストリームを割り当てるためのメモリが不足していました。

解説(Remarks)

NCryptStreamOpenToProtect 関数は、大きなメッセージの暗号化に使用できる内部ストリームオブジェクトを作成します。このオブジェクトを直接使用することはできません。代わりに、この関数が返すオブジェクトハンドルを使用する必要があります。

NCryptStreamUpdate 関数を呼び出す前に、この関数を呼び出します。大きなファイルを暗号化する場合は、ファイルをブロックごとに進めるループ内で NCryptStreamUpdate を使用し、進むたびに各ブロックを暗号化し、各ブロックが完了するたびにコールバックに通知します。詳細については、NCryptStreamUpdate を参照してください。

NCryptStreamOpenToProtect 関数は、暗号化されていない保護記述子ルール文字列をストリームオブジェクトのヘッダーに書き込みます。これにより、NCryptStreamOpenToUnprotect は、暗号化中に使用されたものと同じプロテクターを使用してストリームの復号を開始できるようになります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// ncrypt.dll
#include <windows.h>

HRESULT NCryptStreamOpenToProtect(
    NCRYPT_DESCRIPTOR_HANDLE hDescriptor,
    DWORD dwFlags,
    HWND hWnd,   // optional
    NCRYPT_PROTECT_STREAM_INFO* pStreamInfo,
    NCRYPT_STREAM_HANDLE* phStream
);

[DllImport("ncrypt.dll", ExactSpelling = true)]
static extern int NCryptStreamOpenToProtect(
    IntPtr hDescriptor,   // NCRYPT_DESCRIPTOR_HANDLE
    uint dwFlags,   // DWORD
    IntPtr hWnd,   // HWND optional
    IntPtr pStreamInfo,   // NCRYPT_PROTECT_STREAM_INFO*
    IntPtr phStream   // NCRYPT_STREAM_HANDLE* out
);

<DllImport("ncrypt.dll", ExactSpelling:=True)>
Public Shared Function NCryptStreamOpenToProtect(
    hDescriptor As IntPtr,   ' NCRYPT_DESCRIPTOR_HANDLE
    dwFlags As UInteger,   ' DWORD
    hWnd As IntPtr,   ' HWND optional
    pStreamInfo As IntPtr,   ' NCRYPT_PROTECT_STREAM_INFO*
    phStream As IntPtr   ' NCRYPT_STREAM_HANDLE* out
) As Integer
End Function

' hDescriptor : NCRYPT_DESCRIPTOR_HANDLE
' dwFlags : DWORD
' hWnd : HWND optional
' pStreamInfo : NCRYPT_PROTECT_STREAM_INFO*
' phStream : NCRYPT_STREAM_HANDLE* out
Declare PtrSafe Function NCryptStreamOpenToProtect Lib "ncrypt" ( _
    ByVal hDescriptor As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal hWnd As LongPtr, _
    ByVal pStreamInfo As LongPtr, _
    ByVal phStream As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

NCryptStreamOpenToProtect = ctypes.windll.ncrypt.NCryptStreamOpenToProtect
NCryptStreamOpenToProtect.restype = ctypes.c_int
NCryptStreamOpenToProtect.argtypes = [
    wintypes.HANDLE,  # hDescriptor : NCRYPT_DESCRIPTOR_HANDLE
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.HANDLE,  # hWnd : HWND optional
    ctypes.c_void_p,  # pStreamInfo : NCRYPT_PROTECT_STREAM_INFO*
    ctypes.c_void_p,  # phStream : NCRYPT_STREAM_HANDLE* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ncrypt.dll')
NCryptStreamOpenToProtect = Fiddle::Function.new(
  lib['NCryptStreamOpenToProtect'],
  [
    Fiddle::TYPE_VOIDP,  # hDescriptor : NCRYPT_DESCRIPTOR_HANDLE
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # hWnd : HWND optional
    Fiddle::TYPE_VOIDP,  # pStreamInfo : NCRYPT_PROTECT_STREAM_INFO*
    Fiddle::TYPE_VOIDP,  # phStream : NCRYPT_STREAM_HANDLE* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ncrypt")]
extern "system" {
    fn NCryptStreamOpenToProtect(
        hDescriptor: *mut core::ffi::c_void,  // NCRYPT_DESCRIPTOR_HANDLE
        dwFlags: u32,  // DWORD
        hWnd: *mut core::ffi::c_void,  // HWND optional
        pStreamInfo: *mut NCRYPT_PROTECT_STREAM_INFO,  // NCRYPT_PROTECT_STREAM_INFO*
        phStream: *mut *mut core::ffi::c_void  // NCRYPT_STREAM_HANDLE* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ncrypt.dll")]
public static extern int NCryptStreamOpenToProtect(IntPtr hDescriptor, uint dwFlags, IntPtr hWnd, IntPtr pStreamInfo, IntPtr phStream);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ncrypt_NCryptStreamOpenToProtect' -Namespace Win32 -PassThru
# $api::NCryptStreamOpenToProtect(hDescriptor, dwFlags, hWnd, pStreamInfo, phStream)

#uselib "ncrypt.dll"
#func global NCryptStreamOpenToProtect "NCryptStreamOpenToProtect" sptr, sptr, sptr, sptr, sptr
; NCryptStreamOpenToProtect hDescriptor, dwFlags, hWnd, varptr(pStreamInfo), phStream   ; 戻り値は stat
; hDescriptor : NCRYPT_DESCRIPTOR_HANDLE -> "sptr"
; dwFlags : DWORD -> "sptr"
; hWnd : HWND optional -> "sptr"
; pStreamInfo : NCRYPT_PROTECT_STREAM_INFO* -> "sptr"
; phStream : NCRYPT_STREAM_HANDLE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ncrypt.dll"
#cfunc global NCryptStreamOpenToProtect "NCryptStreamOpenToProtect" sptr, int, sptr, var, sptr
; res = NCryptStreamOpenToProtect(hDescriptor, dwFlags, hWnd, pStreamInfo, phStream)
; hDescriptor : NCRYPT_DESCRIPTOR_HANDLE -> "sptr"
; dwFlags : DWORD -> "int"
; hWnd : HWND optional -> "sptr"
; pStreamInfo : NCRYPT_PROTECT_STREAM_INFO* -> "var"
; phStream : NCRYPT_STREAM_HANDLE* out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ncrypt.dll"
#cfunc global NCryptStreamOpenToProtect "NCryptStreamOpenToProtect" sptr, int, sptr, sptr, sptr
; res = NCryptStreamOpenToProtect(hDescriptor, dwFlags, hWnd, varptr(pStreamInfo), phStream)
; hDescriptor : NCRYPT_DESCRIPTOR_HANDLE -> "sptr"
; dwFlags : DWORD -> "int"
; hWnd : HWND optional -> "sptr"
; pStreamInfo : NCRYPT_PROTECT_STREAM_INFO* -> "sptr"
; phStream : NCRYPT_STREAM_HANDLE* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。