ホーム › Security.Cryptography › NCryptProtectSecret

NCryptProtectSecret

関数

保護記述子を用いてデータを暗号化保護する。

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

シグネチャ

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

HRESULT NCryptProtectSecret(
    NCRYPT_DESCRIPTOR_HANDLE hDescriptor,
    DWORD dwFlags,
    const BYTE* pbData,
    DWORD cbData,
    const NCRYPT_ALLOC_PARA* pMemPara,   // optional
    HWND hWnd,   // optional
    BYTE** ppbProtectedBlob,
    DWORD* pcbProtectedBlob
);

パラメーター

名前

型

方向

説明

hDescriptor

NCRYPT_DESCRIPTOR_HANDLE

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

dwFlags

DWORD

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

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

pbData

BYTE*

保護対象のバイト配列へのポインター。

cbData

DWORD

pbData パラメーターで指定されたバイナリ配列のバイト数。

pMemPara

NCRYPT_ALLOC_PARA*

inoptional

カスタムメモリ管理関数を指定するために使用できる NCRYPT_ALLOC_PARA 構造体へのポインター。この引数を NULL に設定した場合、メモリの割り当てには内部的に LocalAlloc 関数が使用されるため、アプリケーションは ppbProtectedBlob パラメーターが指すメモリを解放するために LocalFree を呼び出す必要があります。

hWnd

HWND

inoptional

表示するユーザーインターフェイスがある場合の、その親ウィンドウへのハンドル。

ppbProtectedBlob

BYTE**

out

暗号化されたデータへのポインターを受け取る変数のアドレス。

pcbProtectedBlob

DWORD*

out

ppbProtectedBlob 変数が指す暗号化データのサイズ (バイト単位) を格納する ULONG 変数へのポインター。

戻り値の型: HRESULT

公式ドキュメント

指定された保護記述子に対してデータを暗号化します。

戻り値

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

戻り値	説明
ERROR_SUCCESS	関数は成功しました。
NTE_INVALID_PARAMETER	pbData、ppbProtectedBlob、pcbProtectedBlob の各パラメーターを NULL にすることはできません。 cbData パラメーターを 1 未満にすることはできません。
NTE_NO_MEMORY	コンテンツ暗号化キーを割り当てるためのメモリが不足しています。
NTE_INVALID_HANDLE	hDescriptor パラメーターで指定されたハンドルが無効です。

解説(Remarks)

キー、キーマテリアル、およびパスワードを保護するには NCryptProtectSecret 関数を使用します。より大きなメッセージを暗号化するには、NCryptStreamOpenToProtect 関数および NCryptStreamUpdate 関数を使用します。

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

各言語での呼び出し定義

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

HRESULT NCryptProtectSecret(
    NCRYPT_DESCRIPTOR_HANDLE hDescriptor,
    DWORD dwFlags,
    const BYTE* pbData,
    DWORD cbData,
    const NCRYPT_ALLOC_PARA* pMemPara,   // optional
    HWND hWnd,   // optional
    BYTE** ppbProtectedBlob,
    DWORD* pcbProtectedBlob
);

[DllImport("ncrypt.dll", ExactSpelling = true)]
static extern int NCryptProtectSecret(
    IntPtr hDescriptor,   // NCRYPT_DESCRIPTOR_HANDLE
    uint dwFlags,   // DWORD
    IntPtr pbData,   // BYTE*
    uint cbData,   // DWORD
    IntPtr pMemPara,   // NCRYPT_ALLOC_PARA* optional
    IntPtr hWnd,   // HWND optional
    IntPtr ppbProtectedBlob,   // BYTE** out
    out uint pcbProtectedBlob   // DWORD* out
);

<DllImport("ncrypt.dll", ExactSpelling:=True)>
Public Shared Function NCryptProtectSecret(
    hDescriptor As IntPtr,   ' NCRYPT_DESCRIPTOR_HANDLE
    dwFlags As UInteger,   ' DWORD
    pbData As IntPtr,   ' BYTE*
    cbData As UInteger,   ' DWORD
    pMemPara As IntPtr,   ' NCRYPT_ALLOC_PARA* optional
    hWnd As IntPtr,   ' HWND optional
    ppbProtectedBlob As IntPtr,   ' BYTE** out
    <Out> ByRef pcbProtectedBlob As UInteger   ' DWORD* out
) As Integer
End Function

' hDescriptor : NCRYPT_DESCRIPTOR_HANDLE
' dwFlags : DWORD
' pbData : BYTE*
' cbData : DWORD
' pMemPara : NCRYPT_ALLOC_PARA* optional
' hWnd : HWND optional
' ppbProtectedBlob : BYTE** out
' pcbProtectedBlob : DWORD* out
Declare PtrSafe Function NCryptProtectSecret Lib "ncrypt" ( _
    ByVal hDescriptor As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pbData As LongPtr, _
    ByVal cbData As Long, _
    ByVal pMemPara As LongPtr, _
    ByVal hWnd As LongPtr, _
    ByVal ppbProtectedBlob As LongPtr, _
    ByRef pcbProtectedBlob As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

NCryptProtectSecret = ctypes.windll.ncrypt.NCryptProtectSecret
NCryptProtectSecret.restype = ctypes.c_int
NCryptProtectSecret.argtypes = [
    wintypes.HANDLE,  # hDescriptor : NCRYPT_DESCRIPTOR_HANDLE
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbData : BYTE*
    wintypes.DWORD,  # cbData : DWORD
    ctypes.c_void_p,  # pMemPara : NCRYPT_ALLOC_PARA* optional
    wintypes.HANDLE,  # hWnd : HWND optional
    ctypes.c_void_p,  # ppbProtectedBlob : BYTE** out
    ctypes.POINTER(wintypes.DWORD),  # pcbProtectedBlob : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ncrypt.dll')
NCryptProtectSecret = Fiddle::Function.new(
  lib['NCryptProtectSecret'],
  [
    Fiddle::TYPE_VOIDP,  # hDescriptor : NCRYPT_DESCRIPTOR_HANDLE
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pbData : BYTE*
    -Fiddle::TYPE_INT,  # cbData : DWORD
    Fiddle::TYPE_VOIDP,  # pMemPara : NCRYPT_ALLOC_PARA* optional
    Fiddle::TYPE_VOIDP,  # hWnd : HWND optional
    Fiddle::TYPE_VOIDP,  # ppbProtectedBlob : BYTE** out
    Fiddle::TYPE_VOIDP,  # pcbProtectedBlob : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ncrypt")]
extern "system" {
    fn NCryptProtectSecret(
        hDescriptor: *mut core::ffi::c_void,  // NCRYPT_DESCRIPTOR_HANDLE
        dwFlags: u32,  // DWORD
        pbData: *const u8,  // BYTE*
        cbData: u32,  // DWORD
        pMemPara: *const NCRYPT_ALLOC_PARA,  // NCRYPT_ALLOC_PARA* optional
        hWnd: *mut core::ffi::c_void,  // HWND optional
        ppbProtectedBlob: *mut *mut u8,  // BYTE** out
        pcbProtectedBlob: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ncrypt.dll")]
public static extern int NCryptProtectSecret(IntPtr hDescriptor, uint dwFlags, IntPtr pbData, uint cbData, IntPtr pMemPara, IntPtr hWnd, IntPtr ppbProtectedBlob, out uint pcbProtectedBlob);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ncrypt_NCryptProtectSecret' -Namespace Win32 -PassThru
# $api::NCryptProtectSecret(hDescriptor, dwFlags, pbData, cbData, pMemPara, hWnd, ppbProtectedBlob, pcbProtectedBlob)

#uselib "ncrypt.dll"
#func global NCryptProtectSecret "NCryptProtectSecret" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; NCryptProtectSecret hDescriptor, dwFlags, varptr(pbData), cbData, varptr(pMemPara), hWnd, varptr(ppbProtectedBlob), varptr(pcbProtectedBlob)   ; 戻り値は stat
; hDescriptor : NCRYPT_DESCRIPTOR_HANDLE -> "sptr"
; dwFlags : DWORD -> "sptr"
; pbData : BYTE* -> "sptr"
; cbData : DWORD -> "sptr"
; pMemPara : NCRYPT_ALLOC_PARA* optional -> "sptr"
; hWnd : HWND optional -> "sptr"
; ppbProtectedBlob : BYTE** out -> "sptr"
; pcbProtectedBlob : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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