Win32 API 日本語リファレンス
ホームSecurity.Cryptography › BCryptDeriveKey

BCryptDeriveKey

関数
共有シークレットからKDFを用いて鍵データを導出する。
DLLbcrypt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

NTSTATUS BCryptDeriveKey(
    BCRYPT_SECRET_HANDLE hSharedSecret,
    LPCWSTR pwszKDF,
    BCryptBufferDesc* pParameterList,   // optional
    BYTE* pbDerivedKey,   // optional
    DWORD cbDerivedKey,
    DWORD* pcbResult,
    DWORD dwFlags
);

パラメーター

名前方向
hSharedSecretBCRYPT_SECRET_HANDLEin
pwszKDFLPCWSTRin
pParameterListBCryptBufferDesc*inoptional
pbDerivedKeyBYTE*outoptional
cbDerivedKeyDWORDin
pcbResultDWORD*out
dwFlagsDWORDin

戻り値の型: NTSTATUS

各言語での呼び出し定義

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

NTSTATUS BCryptDeriveKey(
    BCRYPT_SECRET_HANDLE hSharedSecret,
    LPCWSTR pwszKDF,
    BCryptBufferDesc* pParameterList,   // optional
    BYTE* pbDerivedKey,   // optional
    DWORD cbDerivedKey,
    DWORD* pcbResult,
    DWORD dwFlags
);
[DllImport("bcrypt.dll", ExactSpelling = true)]
static extern int BCryptDeriveKey(
    IntPtr hSharedSecret,   // BCRYPT_SECRET_HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string pwszKDF,   // LPCWSTR
    IntPtr pParameterList,   // BCryptBufferDesc* optional
    IntPtr pbDerivedKey,   // BYTE* optional, out
    uint cbDerivedKey,   // DWORD
    out uint pcbResult,   // DWORD* out
    uint dwFlags   // DWORD
);
<DllImport("bcrypt.dll", ExactSpelling:=True)>
Public Shared Function BCryptDeriveKey(
    hSharedSecret As IntPtr,   ' BCRYPT_SECRET_HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> pwszKDF As String,   ' LPCWSTR
    pParameterList As IntPtr,   ' BCryptBufferDesc* optional
    pbDerivedKey As IntPtr,   ' BYTE* optional, out
    cbDerivedKey As UInteger,   ' DWORD
    <Out> ByRef pcbResult As UInteger,   ' DWORD* out
    dwFlags As UInteger   ' DWORD
) As Integer
End Function
' hSharedSecret : BCRYPT_SECRET_HANDLE
' pwszKDF : LPCWSTR
' pParameterList : BCryptBufferDesc* optional
' pbDerivedKey : BYTE* optional, out
' cbDerivedKey : DWORD
' pcbResult : DWORD* out
' dwFlags : DWORD
Declare PtrSafe Function BCryptDeriveKey Lib "bcrypt" ( _
    ByVal hSharedSecret As LongPtr, _
    ByVal pwszKDF As LongPtr, _
    ByVal pParameterList As LongPtr, _
    ByVal pbDerivedKey As LongPtr, _
    ByVal cbDerivedKey As Long, _
    ByRef pcbResult As Long, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

BCryptDeriveKey = ctypes.windll.bcrypt.BCryptDeriveKey
BCryptDeriveKey.restype = ctypes.c_int
BCryptDeriveKey.argtypes = [
    wintypes.HANDLE,  # hSharedSecret : BCRYPT_SECRET_HANDLE
    wintypes.LPCWSTR,  # pwszKDF : LPCWSTR
    ctypes.c_void_p,  # pParameterList : BCryptBufferDesc* optional
    ctypes.POINTER(ctypes.c_ubyte),  # pbDerivedKey : BYTE* optional, out
    wintypes.DWORD,  # cbDerivedKey : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbResult : DWORD* out
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('bcrypt.dll')
BCryptDeriveKey = Fiddle::Function.new(
  lib['BCryptDeriveKey'],
  [
    Fiddle::TYPE_VOIDP,  # hSharedSecret : BCRYPT_SECRET_HANDLE
    Fiddle::TYPE_VOIDP,  # pwszKDF : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pParameterList : BCryptBufferDesc* optional
    Fiddle::TYPE_VOIDP,  # pbDerivedKey : BYTE* optional, out
    -Fiddle::TYPE_INT,  # cbDerivedKey : DWORD
    Fiddle::TYPE_VOIDP,  # pcbResult : DWORD* out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "bcrypt")]
extern "system" {
    fn BCryptDeriveKey(
        hSharedSecret: *mut core::ffi::c_void,  // BCRYPT_SECRET_HANDLE
        pwszKDF: *const u16,  // LPCWSTR
        pParameterList: *mut BCryptBufferDesc,  // BCryptBufferDesc* optional
        pbDerivedKey: *mut u8,  // BYTE* optional, out
        cbDerivedKey: u32,  // DWORD
        pcbResult: *mut u32,  // DWORD* out
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("bcrypt.dll")]
public static extern int BCryptDeriveKey(IntPtr hSharedSecret, [MarshalAs(UnmanagedType.LPWStr)] string pwszKDF, IntPtr pParameterList, IntPtr pbDerivedKey, uint cbDerivedKey, out uint pcbResult, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'bcrypt_BCryptDeriveKey' -Namespace Win32 -PassThru
# $api::BCryptDeriveKey(hSharedSecret, pwszKDF, pParameterList, pbDerivedKey, cbDerivedKey, pcbResult, dwFlags)
#uselib "bcrypt.dll"
#func global BCryptDeriveKey "BCryptDeriveKey" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; BCryptDeriveKey hSharedSecret, pwszKDF, varptr(pParameterList), varptr(pbDerivedKey), cbDerivedKey, varptr(pcbResult), dwFlags   ; 戻り値は stat
; hSharedSecret : BCRYPT_SECRET_HANDLE -> "sptr"
; pwszKDF : LPCWSTR -> "sptr"
; pParameterList : BCryptBufferDesc* optional -> "sptr"
; pbDerivedKey : BYTE* optional, out -> "sptr"
; cbDerivedKey : DWORD -> "sptr"
; pcbResult : DWORD* out -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "bcrypt.dll"
#cfunc global BCryptDeriveKey "BCryptDeriveKey" sptr, wstr, var, var, int, var, int
; res = BCryptDeriveKey(hSharedSecret, pwszKDF, pParameterList, pbDerivedKey, cbDerivedKey, pcbResult, dwFlags)
; hSharedSecret : BCRYPT_SECRET_HANDLE -> "sptr"
; pwszKDF : LPCWSTR -> "wstr"
; pParameterList : BCryptBufferDesc* optional -> "var"
; pbDerivedKey : BYTE* optional, out -> "var"
; cbDerivedKey : DWORD -> "int"
; pcbResult : DWORD* out -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; NTSTATUS BCryptDeriveKey(BCRYPT_SECRET_HANDLE hSharedSecret, LPCWSTR pwszKDF, BCryptBufferDesc* pParameterList, BYTE* pbDerivedKey, DWORD cbDerivedKey, DWORD* pcbResult, DWORD dwFlags)
#uselib "bcrypt.dll"
#cfunc global BCryptDeriveKey "BCryptDeriveKey" intptr, wstr, var, var, int, var, int
; res = BCryptDeriveKey(hSharedSecret, pwszKDF, pParameterList, pbDerivedKey, cbDerivedKey, pcbResult, dwFlags)
; hSharedSecret : BCRYPT_SECRET_HANDLE -> "intptr"
; pwszKDF : LPCWSTR -> "wstr"
; pParameterList : BCryptBufferDesc* optional -> "var"
; pbDerivedKey : BYTE* optional, out -> "var"
; cbDerivedKey : DWORD -> "int"
; pcbResult : DWORD* out -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	bcrypt = windows.NewLazySystemDLL("bcrypt.dll")
	procBCryptDeriveKey = bcrypt.NewProc("BCryptDeriveKey")
)

// hSharedSecret (BCRYPT_SECRET_HANDLE), pwszKDF (LPCWSTR), pParameterList (BCryptBufferDesc* optional), pbDerivedKey (BYTE* optional, out), cbDerivedKey (DWORD), pcbResult (DWORD* out), dwFlags (DWORD)
r1, _, err := procBCryptDeriveKey.Call(
	uintptr(hSharedSecret),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pwszKDF))),
	uintptr(pParameterList),
	uintptr(pbDerivedKey),
	uintptr(cbDerivedKey),
	uintptr(pcbResult),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // NTSTATUS
function BCryptDeriveKey(
  hSharedSecret: THandle;   // BCRYPT_SECRET_HANDLE
  pwszKDF: PWideChar;   // LPCWSTR
  pParameterList: Pointer;   // BCryptBufferDesc* optional
  pbDerivedKey: Pointer;   // BYTE* optional, out
  cbDerivedKey: DWORD;   // DWORD
  pcbResult: Pointer;   // DWORD* out
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'bcrypt.dll' name 'BCryptDeriveKey';
result := DllCall("bcrypt\BCryptDeriveKey"
    , "Ptr", hSharedSecret   ; BCRYPT_SECRET_HANDLE
    , "WStr", pwszKDF   ; LPCWSTR
    , "Ptr", pParameterList   ; BCryptBufferDesc* optional
    , "Ptr", pbDerivedKey   ; BYTE* optional, out
    , "UInt", cbDerivedKey   ; DWORD
    , "Ptr", pcbResult   ; DWORD* out
    , "UInt", dwFlags   ; DWORD
    , "Int")   ; return: NTSTATUS
●BCryptDeriveKey(hSharedSecret, pwszKDF, pParameterList, pbDerivedKey, cbDerivedKey, pcbResult, dwFlags) = DLL("bcrypt.dll", "int BCryptDeriveKey(void*, char*, void*, void*, dword, void*, dword)")
# 呼び出し: BCryptDeriveKey(hSharedSecret, pwszKDF, pParameterList, pbDerivedKey, cbDerivedKey, pcbResult, dwFlags)
# hSharedSecret : BCRYPT_SECRET_HANDLE -> "void*"
# pwszKDF : LPCWSTR -> "char*"
# pParameterList : BCryptBufferDesc* optional -> "void*"
# pbDerivedKey : BYTE* optional, out -> "void*"
# cbDerivedKey : DWORD -> "dword"
# pcbResult : DWORD* out -> "void*"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。