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キーを作成する元となるシークレットハンドル。このハンドルは BCryptSecretAgreement 関数から取得します。
pwszKDFLPCWSTRin

キーの派生に使用する 鍵導出関数 (KDF) を識別する、null 終端の Unicode 文字列へのポインター。次のいずれかの文字列を指定できます。

BCRYPT_KDF_HASH (L"HASH")

ハッシュ鍵導出関数を使用します。

cbDerivedKey パラメーターが派生キーのサイズより小さい場合、この関数は指定されたバイト数のみを pbDerivedKey バッファーにコピーします。これは結果として得られるキーの安全強度を大幅に低下させる可能性があるため、通常は望ましくない使い方です。

cbDerivedKey パラメーターが派生キーのサイズより大きい場合、この関数はキーを pbDerivedKey バッファーにコピーし、pcbResult が指す変数に実際にコピーされたバイト数を設定します。

pParameterList パラメーターで識別されるパラメーターには、「必須または任意」列に示されているとおり、次のパラメーターを含めることができる、または含める必要があります。

Parameter 説明 必須または任意
KDF_HASH_ALGORITHM 使用するハッシュアルゴリズムを識別する null 終端の Unicode 文字列。CNG Algorithm Identifiers の標準ハッシュアルゴリズム識別子の 1 つ、または別の登録済みハッシュアルゴリズムの識別子を指定できます。

このパラメーターを指定しない場合は、SHA1 ハッシュアルゴリズムが使用されます。
任意
KDF_SECRET_PREPEND ハッシュ関数へのメッセージ入力の先頭に追加する値。詳細については「解説」を参照してください。 任意
KDF_SECRET_APPEND ハッシュ関数へのメッセージ入力の末尾に追加する値。詳細については「解説」を参照してください。 任意

KDF の呼び出しは次の疑似コードのように行われます。

KDF-Output = Hash(
    KDF-Prepend + 
    hSharedSecret + 
    KDF-Append)

BCRYPT_KDF_HMAC (L"HMAC")

ハッシュベースメッセージ認証コード (HMAC) 鍵導出関数を使用します。

cbDerivedKey パラメーターが派生キーのサイズより小さい場合、この関数は指定されたバイト数のみを pbDerivedKey バッファーにコピーします。これは結果として得られるキーの安全強度を大幅に低下させる可能性があるため、通常は望ましくない使い方です。

cbDerivedKey パラメーターが派生キーのサイズより大きい場合、この関数はキーを pbDerivedKey バッファーにコピーし、pcbResult が指す変数に実際にコピーされたバイト数を設定します。

pParameterList パラメーターで識別されるパラメーターには、「必須または任意」列に示されているとおり、次のパラメーターを含めることができる、または含める必要があります。

Parameter 説明 必須または任意
KDF_HASH_ALGORITHM 使用するハッシュアルゴリズムを識別する null 終端の Unicode 文字列。CNG Algorithm Identifiers の標準ハッシュアルゴリズム識別子の 1 つ、または別の登録済みハッシュアルゴリズムの識別子を指定できます。

このパラメーターを指定しない場合は、SHA1 ハッシュアルゴリズムが使用されます。
任意
KDF_HMAC_KEY 疑似乱数関数 (PRF) に使用するキー。 任意
KDF_SECRET_PREPEND ハッシュ関数へのメッセージ入力の先頭に追加する値。詳細については「解説」を参照してください。 任意
KDF_SECRET_APPEND ハッシュ関数へのメッセージ入力の末尾に追加する値。詳細については「解説」を参照してください。 任意

KDF の呼び出しは次の疑似コードのように行われます。

KDF-Output = HMAC-Hash(
    KDF_HMAC_KEY,
    KDF-Prepend + 
    hSharedSecret + 
    KDF-Append)

BCRYPT_KDF_TLS_PRF (L"TLS_PRF")

トランスポート層セキュリティ (TLS) 疑似乱数関数 (PRF) 鍵導出関数を使用します。派生キーのサイズは常に 48 バイトであるため、cbDerivedKey パラメーターは 48 でなければなりません。

pParameterList パラメーターで識別されるパラメーターには、「必須または任意」列に示されているとおり、次のパラメーターを含めることができる、または含める必要があります。

Parameter 説明 必須または任意
KDF_TLS_PRF_LABEL PRF ラベルを含む ANSI 文字列。 必須
KDF_TLS_PRF_SEED PRF シード。シードは 64 バイト長でなければなりません。 必須
KDF_TLS_PRF_PROTOCOL PRF アルゴリズムを使用する TLS プロトコルバージョンを指定する DWORD 値。

有効な値は次のとおりです。
SSL2_PROTOCOL_VERSION (0x0002)
SSL3_PROTOCOL_VERSION (0x0300)
TLS1_PROTOCOL_VERSION (0x0301)
TLS1_0_PROTOCOL_VERSION (0x0301)
TLS1_1_PROTOCOL_VERSION (0x0302)
TLS1_2_PROTOCOL_VERSION (0x0303)
DTLS1_0_PROTOCOL_VERSION (0xfeff)

Windows Server 2008 および Windows Vista: TLS1_1_PROTOCOL_VERSIONTLS1_2_PROTOCOL_VERSIONDTLS1_0_PROTOCOL_VERSION はサポートされていません。

Windows Server 2008 R2、Windows 7、Windows Server 2008 および Windows Vista: DTLS1_0_PROTOCOL_VERSION はサポートされていません。
任意
KDF_HASH_ALGORITHM TLS 1.2 プロトコルバージョンにおいて、PRF 内の HMAC で使用するハッシュの CNG アルゴリズム ID。有効な選択肢は SHA-256 と SHA-384 です。指定しない場合は SHA-256 が使用されます。 任意

KDF の呼び出しは次の疑似コードのように行われます。

KDF-Output = PRF(
    hSharedSecret, 
    KDF_TLS_PRF_LABEL, 
    KDF_TLS_PRF_SEED)

BCRYPT_KDF_SP80056A_CONCAT (L"SP800_56A_CONCAT")

SP800-56A 鍵導出関数を使用します。これは SP800-56C rev2 のワンステップ KDF としても知られています。

この KDF は承認済みハッシュ関数をパラメーターとして受け取りますが、この API はハッシュ関数を内部で選択し、ハッシュアルゴリズムの安全強度をシークレットハンドルの生成に使用されたアルゴリズムに合わせます (例: ECDH P-256 は SHA256 を、ECDH P-384 は SHA384 を使用します)。

pParameterList パラメーターで識別されるパラメーターには、「必須または任意」列に示されているとおり、次のパラメーターを含めることができる、または含める必要があります。すべてのパラメーター値は不透明なバイト配列として扱われます。

Parameter 説明 必須または任意
KDF_ALGORITHMID SP800-56A 鍵導出関数における OtherInfo フィールドの AlgorithmID サブフィールドを指定します。派生キーの意図された用途を示します。 必須
KDF_PARTYUINFO SP800-56A 鍵導出関数における OtherInfo フィールドの PartyUInfo サブフィールドを指定します。このフィールドにはイニシエーターが提供する公開情報が含まれます。 必須
KDF_PARTYVINFO SP800-56A 鍵導出関数における OtherInfo フィールドの PartyVInfo サブフィールドを指定します。このフィールドにはレスポンダーが提供する公開情報が含まれます。 必須
KDF_SUPPPUBINFO SP800-56A 鍵導出関数における OtherInfo フィールドの SuppPubInfo サブフィールドを指定します。このフィールドにはイニシエーターとレスポンダーの双方が知っている公開情報が含まれます。 任意
KDF_SUPPPRIVINFO SP800-56A 鍵導出関数における OtherInfo フィールドの SuppPrivInfo サブフィールドを指定します。共有シークレットなど、イニシエーターとレスポンダーの双方が知っている非公開情報が含まれます。 任意

KDF の呼び出しは次の疑似コードのように行われます。

KDF-Output = SP_800-56A_KDF(
    hSharedSecret,
    KDF_ALGORITHMID,
    KDF_PARTYUINFO,
    KDF_PARTYVINFO,
    KDF_SUPPPUBINFO,
    KDF_SUPPPRIVINFO)

Windows Server 2008、Windows Vista、Windows Server 2003 および Windows XP: この値はサポートされていません。

BCRYPT_KDF_RAW_SECRET (L"TRUNCATE")

生のシークレットのリトルエンディアン表現を、一切変更を加えずに返します。このオプションの使用は通常は望ましくない使い方ですが、サポートされていない KDF との相互運用が必要な場合に必要となることがあります。

cbDerivedKey パラメーターが派生キーのサイズより小さい場合、この関数は指定されたバイト数のみを pbDerivedKey バッファーにコピーします。これは結果として得られるキーの安全強度を大幅に低下させる可能性があるため、通常は望ましくない使い方です。

cbDerivedKey パラメーターが派生キーのサイズより大きい場合、この関数はキーを pbDerivedKey バッファーにコピーし、pcbResult が指す変数に実際にコピーされたバイト数を設定します。

Windows 8、Windows Server 2008、Windows Vista、Windows Server 2003 および Windows XP: この値はサポートされていません。

BCRYPT_KDF_HKDF (L"HKDF")

RFC 5869 の HKDF (HMAC ベースの Extract-and-Expand KDF) 関数を使用します。

HKDF では、次のいずれかからキーを派生する場合に区別が設けられます。

  1. 一様にランダムではなく、入力キー材料 (IKM) と見なされる、シークレット合意関数の出力。BCryptDeriveKey のほぼすべての利用者は、この形式のシークレットハンドルを持ちます。
  2. 一様にランダムなシークレット値。
最初のステップは、シークレットハンドルから疑似乱数キー (PRK) を「抽出 (Extract)」することです。

このステップは、シークレットハンドルに対して BCRYPT_HKDF_HASH_ALGORITHM を指定して BCryptSetProperty を呼び出し、HKDF の HMAC 計算で使用するハッシュアルゴリズムを設定することで実行されます。 これに続いて、次のいずれかを指定して BCryptSetProperty を 2 回目に呼び出します。

  1. シークレットハンドルが IKM を表す場合は、BCRYPT_HKDF_SALT_AND_FINALIZE を使用して任意のソルト値を提供し、IKM から PRK を抽出してシークレットハンドルを確定します。
  2. それ以外の場合は、BCRYPT_HKDF_PRK_AND_FINALIZE を使用して、シークレット値を HKDF PRK へ直接変換し、シークレットハンドルを確定します。
2 番目のステップは、PRK を出力派生キーへ「展開 (Expand)」することです。

このステップは、確定されたシークレットハンドルに対して BCryptDeriveKey を呼び出すことで実行されます。

pParameterList パラメーターで識別されるパラメーターには、「必須または任意」列に示されているとおり、次のパラメーターを含めることができる、または含める必要があります。すべてのパラメーター値は不透明なバイト配列として扱われます。

Parameter 説明 必須または任意
KDF_HKDF_INFO HKDF Expand ステップの info フィールドを指定します。任意のコンテキストおよびアプリケーション固有の情報を示します。 任意

KDF の呼び出しは次の疑似コードのように行われます。

KDF-Output = HKDF-Expand(
    hSharedSecret.PRK,
    info,
    cbDerivedKey)

Windows 10: HKDF のサポートが開始されます。

pParameterListBCryptBufferDesc*inoptionalKDF パラメーターを含む BCryptBufferDesc 構造体のアドレス。このパラメーターは任意であり、不要な場合は NULL を指定できます。
pbDerivedKeyBYTE*outoptionalキーを受け取るバッファーのアドレス。cbDerivedKey パラメーターにはこのバッファーのサイズが含まれます。このパラメーターが NULL の場合、この関数は必要なサイズ (バイト単位) を pcbResult パラメーターが指す ULONG に格納します。
cbDerivedKeyDWORDinpbDerivedKey バッファーのサイズ (バイト単位)。
pcbResultDWORD*outpbDerivedKey バッファーにコピーされたバイト数を受け取る ULONG へのポインター。pbDerivedKey パラメーターが NULL の場合、この関数は必要なサイズ (バイト単位) をこのパラメーターが指す ULONG に格納します。
dwFlagsDWORDin

この関数の動作を変更するフラグのセット。

ゼロ、または次の値を指定できます。

意味
KDF_USE_SECRET_AS_HMAC_KEY_FLAG hSharedSecret 内の値が HMAC キーとしても機能します。このフラグを指定する場合、pParameterList パラメーターのパラメーターセットに KDF_HMAC_KEY パラメーターを含めないでください。このフラグは BCRYPT_KDF_HMAC 鍵導出関数でのみ使用されます。

戻り値の型: NTSTATUS

公式ドキュメント

シークレットハンドルからキーを派生します。(BCryptDeriveKey)

戻り値

関数の成功または失敗を示すステータスコードを返します。

返される可能性のあるコードには、次のものが含まれますが、これらに限定されません。

戻り値コード 説明
STATUS_SUCCESS 関数は成功しました。
STATUS_INTERNAL_ERROR 内部エラーが発生しました。
STATUS_INVALID_HANDLE hSharedSecret パラメーターのハンドルが無効です。
STATUS_INVALID_PARAMETER 1 つ以上のパラメーターが無効です。

解説(Remarks)

pParameterList パラメーター内の BCryptBufferDesc 構造体には、KDF_SECRET_PREPEND および KDF_SECRET_APPEND パラメーターを複数含めることができます。これらのパラメーターが複数指定された場合、KDF が呼び出される前に、配列内に含まれる順序でパラメーター値が連結されます。たとえば、次のパラメーター値が指定されたとします。

BYTE abValue0[] = {0x01};
BYTE abValue1[] = {0x04, 0x05};
BYTE abValue2[] = {0x10, 0x11, 0x12};
BYTE abValue3[] = {0x20, 0x21, 0x22, 0x23};

Parameter[0].type = KDF_SECRET_APPEND
Parameter[0].value = abValue0;
Parameter[0].length = sizeof (abValue0);
Parameter[1].type = KDF_SECRET_PREPEND
Parameter[1].value = abValue1;
Parameter[1].length = sizeof (abValue1);
Parameter[2].type = KDF_SECRET_APPEND
Parameter[2].value = abValue2;
Parameter[2].length = sizeof (abValue2);
Parameter[3].type = KDF_SECRET_PREPEND
Parameter[3].value = abValue3;
Parameter[3].length = sizeof (abValue3);

上記のパラメーター値が指定された場合、実際の KDF に渡される連結された値は次のとおりです。

Type: KDF_SECRET_PREPEND
Value: {0x04, 0x05, 0x20, 0x21, 0x22, 0x23}, length 6

Type: KDF_SECRET_APPEND
Value: {0x01, 0x10, 0x11, 0x12}, length 4

pwszKDF パラメーターが BCRYPT_KDF_RAW_SECRET に設定されている場合、返されるシークレットは (他の pwszKDF 値とは異なり) リトルエンディアン形式でエンコードされます。生のシークレットを他の CNG 関数で使用する場合は、その多くがビッグエンディアンでエンコードされた入力を受け取るため、この点に注意することが重要です。

サポートされているアルゴリズムプロバイダーを使用する場合、BCryptDeriveKey はユーザーモードまたはカーネルモードのいずれからでも呼び出すことができます。カーネルモードの呼び出し元は PASSIVE_LEVEL IRQL または DISPATCH_LEVEL IRQL のいずれかで実行できます。現在の IRQL レベルが DISPATCH_LEVEL の場合、hSharedSecret パラメーターで提供されるハンドルは非ページ (またはロックされた) メモリ内に存在する必要があり、BCRYPT_PROV_DISPATCH フラグを使用して開かれたプロバイダーによって返されたアルゴリズムハンドルから派生したものでなければなりません。

この関数をカーネルモードで呼び出すには、Driver Development Kit (DDK) の一部である Cng.lib を使用します。Windows Server 2008 および Windows Vista: この関数をカーネルモードで呼び出すには、Ksecdd.lib を使用します。

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

各言語での呼び出し定義

// 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)。
const std = @import("std");

extern "bcrypt" fn BCryptDeriveKey(
    hSharedSecret: ?*anyopaque, // BCRYPT_SECRET_HANDLE
    pwszKDF: [*c]const u16, // LPCWSTR
    pParameterList: [*c]BCryptBufferDesc, // BCryptBufferDesc* optional
    pbDerivedKey: [*c]u8, // BYTE* optional, out
    cbDerivedKey: u32, // DWORD
    pcbResult: [*c]u32, // DWORD* out
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc BCryptDeriveKey(
    hSharedSecret: pointer,  # BCRYPT_SECRET_HANDLE
    pwszKDF: WideCString,  # LPCWSTR
    pParameterList: ptr BCryptBufferDesc,  # BCryptBufferDesc* optional
    pbDerivedKey: ptr uint8,  # BYTE* optional, out
    cbDerivedKey: uint32,  # DWORD
    pcbResult: ptr uint32,  # DWORD* out
    dwFlags: uint32  # DWORD
): int32 {.importc: "BCryptDeriveKey", stdcall, dynlib: "bcrypt.dll".}
pragma(lib, "bcrypt");
extern(Windows)
int BCryptDeriveKey(
    void* hSharedSecret,   // BCRYPT_SECRET_HANDLE
    const(wchar)* pwszKDF,   // LPCWSTR
    BCryptBufferDesc* pParameterList,   // BCryptBufferDesc* optional
    ubyte* pbDerivedKey,   // BYTE* optional, out
    uint cbDerivedKey,   // DWORD
    uint* pcbResult,   // DWORD* out
    uint dwFlags   // DWORD
);
ccall((:BCryptDeriveKey, "bcrypt.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cwstring, Ptr{BCryptBufferDesc}, Ptr{UInt8}, UInt32, Ptr{UInt32}, UInt32),
      hSharedSecret, pwszKDF, pParameterList, pbDerivedKey, cbDerivedKey, pcbResult, dwFlags)
# hSharedSecret : BCRYPT_SECRET_HANDLE -> Ptr{Cvoid}
# pwszKDF : LPCWSTR -> Cwstring
# pParameterList : BCryptBufferDesc* optional -> Ptr{BCryptBufferDesc}
# pbDerivedKey : BYTE* optional, out -> Ptr{UInt8}
# cbDerivedKey : DWORD -> UInt32
# pcbResult : DWORD* out -> Ptr{UInt32}
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t BCryptDeriveKey(
    void* hSharedSecret,
    const uint16_t* pwszKDF,
    void* pParameterList,
    uint8_t* pbDerivedKey,
    uint32_t cbDerivedKey,
    uint32_t* pcbResult,
    uint32_t dwFlags);
]]
local bcrypt = ffi.load("bcrypt")
-- bcrypt.BCryptDeriveKey(hSharedSecret, pwszKDF, pParameterList, pbDerivedKey, cbDerivedKey, pcbResult, dwFlags)
-- hSharedSecret : BCRYPT_SECRET_HANDLE
-- pwszKDF : LPCWSTR
-- pParameterList : BCryptBufferDesc* optional
-- pbDerivedKey : BYTE* optional, out
-- cbDerivedKey : DWORD
-- pcbResult : DWORD* out
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('bcrypt.dll');
const BCryptDeriveKey = lib.func('__stdcall', 'BCryptDeriveKey', 'int32_t', ['void *', 'str16', 'void *', 'uint8_t *', 'uint32_t', 'uint32_t *', 'uint32_t']);
// BCryptDeriveKey(hSharedSecret, pwszKDF, pParameterList, pbDerivedKey, cbDerivedKey, pcbResult, dwFlags)
// hSharedSecret : BCRYPT_SECRET_HANDLE -> 'void *'
// pwszKDF : LPCWSTR -> 'str16'
// pParameterList : BCryptBufferDesc* optional -> 'void *'
// pbDerivedKey : BYTE* optional, out -> 'uint8_t *'
// cbDerivedKey : DWORD -> 'uint32_t'
// pcbResult : DWORD* out -> 'uint32_t *'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("bcrypt.dll", {
  BCryptDeriveKey: { parameters: ["pointer", "buffer", "pointer", "pointer", "u32", "pointer", "u32"], result: "i32" },
});
// lib.symbols.BCryptDeriveKey(hSharedSecret, pwszKDF, pParameterList, pbDerivedKey, cbDerivedKey, pcbResult, dwFlags)
// hSharedSecret : BCRYPT_SECRET_HANDLE -> "pointer"
// pwszKDF : LPCWSTR -> "buffer"
// pParameterList : BCryptBufferDesc* optional -> "pointer"
// pbDerivedKey : BYTE* optional, out -> "pointer"
// cbDerivedKey : DWORD -> "u32"
// pcbResult : DWORD* out -> "pointer"
// dwFlags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t BCryptDeriveKey(
    void* hSharedSecret,
    const uint16_t* pwszKDF,
    void* pParameterList,
    uint8_t* pbDerivedKey,
    uint32_t cbDerivedKey,
    uint32_t* pcbResult,
    uint32_t dwFlags);
C, "bcrypt.dll");
// $ffi->BCryptDeriveKey(hSharedSecret, pwszKDF, pParameterList, pbDerivedKey, cbDerivedKey, pcbResult, dwFlags);
// hSharedSecret : BCRYPT_SECRET_HANDLE
// pwszKDF : LPCWSTR
// pParameterList : BCryptBufferDesc* optional
// pbDerivedKey : BYTE* optional, out
// cbDerivedKey : DWORD
// pcbResult : DWORD* out
// dwFlags : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Bcrypt extends StdCallLibrary {
    Bcrypt INSTANCE = Native.load("bcrypt", Bcrypt.class);
    int BCryptDeriveKey(
        Pointer hSharedSecret,   // BCRYPT_SECRET_HANDLE
        WString pwszKDF,   // LPCWSTR
        Pointer pParameterList,   // BCryptBufferDesc* optional
        byte[] pbDerivedKey,   // BYTE* optional, out
        int cbDerivedKey,   // DWORD
        IntByReference pcbResult,   // DWORD* out
        int dwFlags   // DWORD
    );
}
@[Link("bcrypt")]
lib Libbcrypt
  fun BCryptDeriveKey = BCryptDeriveKey(
    hSharedSecret : Void*,   # BCRYPT_SECRET_HANDLE
    pwszKDF : UInt16*,   # LPCWSTR
    pParameterList : BCryptBufferDesc*,   # BCryptBufferDesc* optional
    pbDerivedKey : UInt8*,   # BYTE* optional, out
    cbDerivedKey : UInt32,   # DWORD
    pcbResult : UInt32*,   # DWORD* out
    dwFlags : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef BCryptDeriveKeyNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Pointer<Void>, Pointer<Uint8>, Uint32, Pointer<Uint32>, Uint32);
typedef BCryptDeriveKeyDart = int Function(Pointer<Void>, Pointer<Utf16>, Pointer<Void>, Pointer<Uint8>, int, Pointer<Uint32>, int);
final BCryptDeriveKey = DynamicLibrary.open('bcrypt.dll')
    .lookupFunction<BCryptDeriveKeyNative, BCryptDeriveKeyDart>('BCryptDeriveKey');
// hSharedSecret : BCRYPT_SECRET_HANDLE -> Pointer<Void>
// pwszKDF : LPCWSTR -> Pointer<Utf16>
// pParameterList : BCryptBufferDesc* optional -> Pointer<Void>
// pbDerivedKey : BYTE* optional, out -> Pointer<Uint8>
// cbDerivedKey : DWORD -> Uint32
// pcbResult : DWORD* out -> Pointer<Uint32>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "BCryptDeriveKey"
  c_BCryptDeriveKey :: Ptr () -> CWString -> Ptr () -> Ptr Word8 -> Word32 -> Ptr Word32 -> Word32 -> IO Int32
-- hSharedSecret : BCRYPT_SECRET_HANDLE -> Ptr ()
-- pwszKDF : LPCWSTR -> CWString
-- pParameterList : BCryptBufferDesc* optional -> Ptr ()
-- pbDerivedKey : BYTE* optional, out -> Ptr Word8
-- cbDerivedKey : DWORD -> Word32
-- pcbResult : DWORD* out -> Ptr Word32
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let bcryptderivekey =
  foreign "BCryptDeriveKey"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr void) @-> (ptr uint8_t) @-> uint32_t @-> (ptr uint32_t) @-> uint32_t @-> returning int32_t)
(* hSharedSecret : BCRYPT_SECRET_HANDLE -> (ptr void) *)
(* pwszKDF : LPCWSTR -> (ptr uint16_t) *)
(* pParameterList : BCryptBufferDesc* optional -> (ptr void) *)
(* pbDerivedKey : BYTE* optional, out -> (ptr uint8_t) *)
(* cbDerivedKey : DWORD -> uint32_t *)
(* pcbResult : DWORD* out -> (ptr uint32_t) *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library bcrypt (t "bcrypt.dll"))
(cffi:use-foreign-library bcrypt)

(cffi:defcfun ("BCryptDeriveKey" bcrypt-derive-key :convention :stdcall) :int32
  (h-shared-secret :pointer)   ; BCRYPT_SECRET_HANDLE
  (pwsz-kdf (:string :encoding :utf-16le))   ; LPCWSTR
  (p-parameter-list :pointer)   ; BCryptBufferDesc* optional
  (pb-derived-key :pointer)   ; BYTE* optional, out
  (cb-derived-key :uint32)   ; DWORD
  (pcb-result :pointer)   ; DWORD* out
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $BCryptDeriveKey = Win32::API::More->new('bcrypt',
    'int BCryptDeriveKey(HANDLE hSharedSecret, LPCWSTR pwszKDF, LPVOID pParameterList, LPVOID pbDerivedKey, DWORD cbDerivedKey, LPVOID pcbResult, DWORD dwFlags)');
# my $ret = $BCryptDeriveKey->Call($hSharedSecret, $pwszKDF, $pParameterList, $pbDerivedKey, $cbDerivedKey, $pcbResult, $dwFlags);
# hSharedSecret : BCRYPT_SECRET_HANDLE -> HANDLE
# pwszKDF : LPCWSTR -> LPCWSTR
# pParameterList : BCryptBufferDesc* optional -> LPVOID
# pbDerivedKey : BYTE* optional, out -> LPVOID
# cbDerivedKey : DWORD -> DWORD
# pcbResult : DWORD* out -> LPVOID
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型