ホーム › Security.Cryptography › BCryptKeyDerivation

BCryptKeyDerivation

関数

鍵オブジェクトからパラメータに基づき鍵データを導出する。

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

シグネチャ

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

NTSTATUS BCryptKeyDerivation(
    BCRYPT_KEY_HANDLE hKey,
    BCryptBufferDesc* pParameterList,   // optional
    BYTE* pbDerivedKey,
    DWORD cbDerivedKey,
    DWORD* pcbResult,
    DWORD dwFlags
);

パラメーター

名前型方向説明

hKey BCRYPT_KEY_HANDLE in キー派生関数 (KDF) キーのハンドル。「解説」を参照してください。

pParameterList

BCryptBufferDesc*

inoptional

KDF パラメーターを格納する BCryptBufferDesc 構造体のアドレス。このパラメーターは省略可能であり、不要な場合は NULL を指定できます。

パラメーターには、キー派生関数 (KDF) に固有のものと汎用的なものがあります。次の表は、Microsoft Primitive プロバイダーが実装する個々の KDF について、必須および省略可能なパラメーターを示しています。追加情報の一部は BCryptBuffer のドキュメントに記載されています。

KDF	パラメーター	必須	既定値
カウンターモードの SP800-108 HMAC	KDF_LABEL	はい
	KDF_CONTEXT	はい
	KDF_HASH_ALGORITHM	はい
SP800-56A	KDF_ALGORITHMID	はい
	KDF_PARTYUINFO	はい
	KDF_PARTYVINFO	はい
	KDF_HASH_ALGORITHM	はい
	KDF_SUPPPUBINFO	いいえ	""
	KDF_SUPPPRIVINFO	いいえ	""
PBKDF2	KDF_HASH_ALGORITHM	はい
	KDF_SALT	はい
	KDF_ITERATION_COUNT	いいえ	10000
CAPI_KDF	KDF_HASH_ALGORITHM	はい
TLS1_1_PRF	KDF_TLS_PRF_LABEL	はい
	KDF_TLS_PRF_SEED	はい
TLS1_2_PRF	KDF_TLS_PRF_LABEL	はい
	KDF_TLS_PRF_SEED	はい
	KDF_HASH_ALGORITHM	はい
HKDF	KDF_HKDF_INFO	いいえ	""

一部のアルゴリズムでは、複数のパラメーターを個別に指定する代わりに KDF_GENERIC_PARAMETER を使用できます。これは、次のように KDF 固有のパラメーターに対応付けられます。

カウンターモードの SP800-108 HMAC:

KDF_GENERIC_PARAMETER = KDF_LABEL || 0x00 || KDF_CONTEXT

SP800-56A:

KDF_GENERIC_PARAMETER = KDF_ALGORITHMID || KDF_PARTYUINFO || KDF_PARTYVINFO {|| KDF_SUPPPUBINFO } {|| KDF_SUPPPRIVINFO }

PBKDF2:

KDF_GENERIC_PARAMETER = KDF_SALT

pbDerivedKey BYTE* out キーを受け取るバッファーのアドレス。cbDerivedKey パラメーターには、このバッファーのサイズを指定します。

cbDerivedKey DWORD in pbDerivedKey パラメーターが指すバッファーのサイズ (バイト単位)。

pcbResult DWORD* out pbDerivedKey パラメーターが指すバッファーにコピーされたバイト数を受け取る ULONG へのポインター。

dwFlags

DWORD

この関数の動作を変更するフラグ。Microsoft Primitive プロバイダーでは次の値を使用できます。

値	意味
BCRYPT_CAPI_AES_FLAG	対象のアルゴリズムが AES であり、そのためキーを二重に拡張する必要があることを指定します。このフラグは CAPI_KDF アルゴリズムでのみ有効です。

戻り値の型: NTSTATUS

公式ドキュメント

シークレットアグリーメントを必要とせずにキーを派生させます。

戻り値

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

解説(Remarks)

BCryptKeyDerivation を使用する流れは次のとおりです。

使用する KDF アルゴリズムを決定し、そのアルゴリズムハンドルを取得します。BCryptOpenAlgorithmProvider では次のアルゴリズム識別子を使用できます。

キーの派生元となるシークレットデータを決定し、アルゴリズムハンドルとともに BCryptGenerateSymmetricKey に渡して、KDF キーハンドルを生成します。
KDF キーハンドルを指定して BCryptKeyDerivation を呼び出します。

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

HKDF

HKDF では、次のどちらからキーを派生させるのかが区別されます。

一様ランダムではなく、入力キーマテリアル (IKM) と見なされる、シークレットアグリーメント関数の出力。
一様ランダムなシークレット値。

最初の手順は、提供されたシークレットデータから疑似ランダムキー (PRK) を "Extract" (抽出) することです。

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

提供されたシークレットデータが IKM を表す場合は、BCRYPT_HKDF_SALT_AND_FINALIZE を使用して省略可能なソルト値を指定し、IKM から PRK を抽出して KDF キーハンドルを確定します。
それ以外の場合は、BCRYPT_HKDF_PRK_AND_FINALIZE を使用して、提供されたシークレットを直接 HKDF の PRK に変換し、KDF キーハンドルを確定します。

2 番目の手順は、PRK を出力の派生キーへと "Expand" (展開) することです。

この手順は、確定済みの KDF キーハンドルに対して BCryptKeyDerivation を呼び出すことで行います。

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

各言語での呼び出し定義

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

NTSTATUS BCryptKeyDerivation(
    BCRYPT_KEY_HANDLE hKey,
    BCryptBufferDesc* pParameterList,   // optional
    BYTE* pbDerivedKey,
    DWORD cbDerivedKey,
    DWORD* pcbResult,
    DWORD dwFlags
);

[DllImport("bcrypt.dll", ExactSpelling = true)]
static extern int BCryptKeyDerivation(
    IntPtr hKey,   // BCRYPT_KEY_HANDLE
    IntPtr pParameterList,   // BCryptBufferDesc* optional
    IntPtr pbDerivedKey,   // BYTE* out
    uint cbDerivedKey,   // DWORD
    out uint pcbResult,   // DWORD* out
    uint dwFlags   // DWORD
);

<DllImport("bcrypt.dll", ExactSpelling:=True)>
Public Shared Function BCryptKeyDerivation(
    hKey As IntPtr,   ' BCRYPT_KEY_HANDLE
    pParameterList As IntPtr,   ' BCryptBufferDesc* optional
    pbDerivedKey As IntPtr,   ' BYTE* out
    cbDerivedKey As UInteger,   ' DWORD
    <Out> ByRef pcbResult As UInteger,   ' DWORD* out
    dwFlags As UInteger   ' DWORD
) As Integer
End Function

' hKey : BCRYPT_KEY_HANDLE
' pParameterList : BCryptBufferDesc* optional
' pbDerivedKey : BYTE* out
' cbDerivedKey : DWORD
' pcbResult : DWORD* out
' dwFlags : DWORD
Declare PtrSafe Function BCryptKeyDerivation Lib "bcrypt" ( _
    ByVal hKey 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

BCryptKeyDerivation = ctypes.windll.bcrypt.BCryptKeyDerivation
BCryptKeyDerivation.restype = ctypes.c_int
BCryptKeyDerivation.argtypes = [
    wintypes.HANDLE,  # hKey : BCRYPT_KEY_HANDLE
    ctypes.c_void_p,  # pParameterList : BCryptBufferDesc* optional
    ctypes.POINTER(ctypes.c_ubyte),  # pbDerivedKey : BYTE* 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')
BCryptKeyDerivation = Fiddle::Function.new(
  lib['BCryptKeyDerivation'],
  [
    Fiddle::TYPE_VOIDP,  # hKey : BCRYPT_KEY_HANDLE
    Fiddle::TYPE_VOIDP,  # pParameterList : BCryptBufferDesc* optional
    Fiddle::TYPE_VOIDP,  # pbDerivedKey : BYTE* 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 BCryptKeyDerivation(
        hKey: *mut core::ffi::c_void,  // BCRYPT_KEY_HANDLE
        pParameterList: *mut BCryptBufferDesc,  // BCryptBufferDesc* optional
        pbDerivedKey: *mut u8,  // BYTE* 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 BCryptKeyDerivation(IntPtr hKey, IntPtr pParameterList, IntPtr pbDerivedKey, uint cbDerivedKey, out uint pcbResult, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'bcrypt_BCryptKeyDerivation' -Namespace Win32 -PassThru
# $api::BCryptKeyDerivation(hKey, pParameterList, pbDerivedKey, cbDerivedKey, pcbResult, dwFlags)

#uselib "bcrypt.dll"
#func global BCryptKeyDerivation "BCryptKeyDerivation" sptr, sptr, sptr, sptr, sptr, sptr
; BCryptKeyDerivation hKey, varptr(pParameterList), varptr(pbDerivedKey), cbDerivedKey, varptr(pcbResult), dwFlags   ; 戻り値は stat
; hKey : BCRYPT_KEY_HANDLE -> "sptr"
; pParameterList : BCryptBufferDesc* optional -> "sptr"
; pbDerivedKey : BYTE* out -> "sptr"
; cbDerivedKey : DWORD -> "sptr"
; pcbResult : DWORD* out -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "bcrypt.dll"
#cfunc global BCryptKeyDerivation "BCryptKeyDerivation" sptr, var, var, int, var, int
; res = BCryptKeyDerivation(hKey, pParameterList, pbDerivedKey, cbDerivedKey, pcbResult, dwFlags)
; hKey : BCRYPT_KEY_HANDLE -> "sptr"
; pParameterList : BCryptBufferDesc* optional -> "var"
; pbDerivedKey : BYTE* out -> "var"
; cbDerivedKey : DWORD -> "int"
; pcbResult : DWORD* out -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "bcrypt.dll"
#cfunc global BCryptKeyDerivation "BCryptKeyDerivation" sptr, sptr, sptr, int, sptr, int
; res = BCryptKeyDerivation(hKey, varptr(pParameterList), varptr(pbDerivedKey), cbDerivedKey, varptr(pcbResult), dwFlags)
; hKey : BCRYPT_KEY_HANDLE -> "sptr"
; pParameterList : BCryptBufferDesc* optional -> "sptr"
; pbDerivedKey : BYTE* out -> "sptr"
; cbDerivedKey : DWORD -> "int"
; pcbResult : DWORD* out -> "sptr"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。