NCryptDeriveKey 函数 (ncrypt.h)

NCryptDeriveKey 函数从NCRYPT_SECRET_HANDLE派生密钥。 此函数旨在用作使用持久机密协议密钥的机密协议过程的一部分。

若要改用持久机密来派生密钥材料,请使用 NCryptKeyDerivation 函数。

Syntax

SECURITY_STATUS NCryptDeriveKey(
  [in]            NCRYPT_SECRET_HANDLE hSharedSecret,
  [in]            LPCWSTR              pwszKDF,
  [in, optional]  NCryptBufferDesc     *pParameterList,
  [out, optional] PBYTE                pbDerivedKey,
  [in]            DWORD                cbDerivedKey,
  [out]           DWORD                *pcbResult,
  [in]            ULONG                dwFlags
);

参数

[in] hSharedSecret

要从中创建密钥的机密句柄。 此句柄当前从 NCryptSecretAgreement 函数获取。

[in] pwszKDF

指向以 null 结尾的 Unicode 字符串的指针,该字符串标识用于派 生密钥的密钥派生函数 (KDF)。 这可以是以下字符串之一。

BCRYPT_KDF_HASH (L“HASH”)

使用哈希密钥派生函数。

如果 cbDerivedKey 参数小于派生密钥的大小,此函数将仅将指定的字节数复制到 pbDerivedKey 缓冲区。 如果 cbDerivedKey 参数大于派生密钥的大小,此函数会将密钥复制到 pbDerivedKey 缓冲区,并将 由 tcpResult 指向的变量设置为复制的实际字节数。

pParameterList 参数标识的参数可以或必须包含以下参数,如必需列或可选列指示。

参数 Description 必需还是可选
KDF_HASH_ALGORITHM 一个以 null 结尾的 Unicode 字符串,用于标识要使用的哈希算法。 这可以是 CNG 算法标识符 的标准哈希算法标识符之一,也可以是另一个已注册哈希算法的标识符。

如果未指定此参数,则使用 SHA1 哈希算法。
可选
KDF_SECRET_PREPEND 要添加到哈希函数的消息输入开头的值。 有关详细信息,请参阅 “备注”。 可选
KDF_SECRET_APPEND 要添加到哈希函数的消息输入末尾的值。 有关详细信息,请参阅 “备注”。 可选

对 KDF 的调用按以下伪代码所示进行。

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

BCRYPT_KDF_HMAC (L“HMAC”)

使用 Hash-Based 消息身份验证代码 (HMAC)密钥派生函数。

如果 cbDerivedKey 参数小于派生密钥的大小,此函数将仅将指定的字节数复制到 pbDerivedKey 缓冲区。 如果 cbDerivedKey 参数大于派生密钥的大小,此函数会将密钥复制到 pbDerivedKey 缓冲区,并将 由 tcpResult 指向的变量设置为复制的实际字节数。

pParameterList 参数标识的参数可以或必须包含以下参数,如必需列或可选列指示。

参数 Description 必需还是可选
KDF_HASH_ALGORITHM 一个以 null 结尾的 Unicode 字符串,用于标识要使用的哈希算法。 这可以是 CNG 算法标识符 的标准哈希算法标识符之一,也可以是另一个已注册哈希算法的标识符。

如果未指定此参数,则使用 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 参数标识的参数可以或必须包含以下参数,如必需列或可选列指示。

参数 Description 必需还是可选
KDF_TLS_PRF_LABEL 一个包含 PRF 标签的 ANSI 字符串。 必选
KDF_TLS_PRF_SEED PRF 种子。 种子长度必须为 64 字节。 必选
KDF_TLS_PRF_PROTOCOL 一个 DWORD 值,该值指定要使用的 PRF 算法的 TLS 协议版本。

有效值为:
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_VERSION、TLS1_2_PROTOCOL_VERSION和DTLS1_0_PROTOCOL_VERSION。

Windows Server 2008 R2、Windows 7、Windows Server 2008 和 Windows Vista: 不支持DTLS1_0_PROTOCOL_VERSION。
可选
KDF_HASH_ALGORITHM 要与 PRF 中的 HMAC 一起使用的哈希的 CNG 算法 ID,用于 TLS 1.2 协议版本。 有效选项为 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(第 4.1 节),该哈希函数具有与用于生成机密句柄的算法相对应的强度。

pParameterList 参数标识的参数可以或必须包含以下参数,如必需列或可选列指示。 所有参数值都被视为不透明的字节数组。

参数 Description 必需还是可选
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”)

返回原始机密的 little-endian 表示形式,无需进行任何修改。

如果 cbDerivedKey 参数小于派生密钥的大小,此函数将仅将指定的字节数复制到 pbDerivedKey 缓冲区。 如果 cbDerivedKey 参数大于派生密钥的大小,此函数会将密钥复制到 pbDerivedKey 缓冲区,并将 由 tcpResult 指向的变量设置为复制的实际字节数。

Windows 8、Windows Server 2008、Windows Vista、Windows Server 2003 和 Windows XP: 不支持此值。

BCRYPT_KDF_HKDF(L“HKF”)

使用 RFC 5869 中的基于 HKF(基于 HMAC 的提取和扩展 KDF)函数。

在HKF中,从以下任一项派生密钥之间进行了区分:

  1. 机密协议函数的输出,该函数不是统一随机的,被视为输入键键材料(IKM)。 几乎所有 BCryptDeriveKey 的用户都将拥有此表单的机密句柄。
  2. 统一随机机密值。
第一步是从机密句柄“提取”伪随机密钥(PRK)。

此步骤是通过对具有 BCRYPT_HKDF_HASH_ALGORITHM 的机密句柄调用 BCryptSetProperty 来设置在 HKF 的 HMAC 计算中使用的哈希算法来执行的。

随后对 BCryptSetProperty 进行第二次调用,并使用以下任一方法之一:

  1. 如果机密句柄表示 IKM,请使用 BCRYPT_HKDF_SALT_AND_FINALIZE 提供可选的盐值,并从 IKM 中提取 PRK 并完成机密句柄。
  2. 否则,请使用 BCRYPT_HKDF_PRK_AND_FINALIZE 将机密值直接转换为 HKF PRK 并完成机密句柄。
第二步是将 PRK“展开”到输出派生密钥中。

此步骤是通过对最终的机密句柄调用 BCryptDeriveKey 来执行的。

pParameterList 参数标识的参数可以或必须包含以下参数,如必需列或可选列指示。 所有参数值都被视为不透明的字节数组。

参数 Description 必需还是可选
KDF_HKDF_INFO 指定 HKF 展开步骤中 的信息 字段。 指示可选上下文和应用程序特定信息。 可选

对 KDF 的调用按以下伪代码所示进行。

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

Windows 10: 开始支持 HKF。

[in, optional] pParameterList

包含 KDF 参数的 NCryptBufferDesc 结构的地址。 此参数是可选的,如果不需要此参数,则可以 NULL 使用此参数。

[out, optional] pbDerivedKey

接收密钥的缓冲区的地址。 cbDerivedKey 参数包含此缓冲区的大小。 如果此参数是NULL,则此函数会将所需的大小(以字节为单位)放在由Result 参数指向的 DWORD 中。

[in] cbDerivedKey

pbDerivedKey 缓冲区的大小(以字节为单位)。

[out] pcbResult

指向 DWORD 的指针,用于接收复制到 pbDerivedKey 缓冲区的字节数。 如果 pbDerivedKey 参数是 NULL,此函数会将所需的大小(以字节为单位)放置在此参数指向的 DWORD 中。

[in] dwFlags

一组标志,用于修改此函数的行为。

此值可以为零或以下值:

价值 Meaning
KDF_USE_SECRET_AS_HMAC_KEY_FLAG hSharedSecret 中的值也将用作 HMAC 密钥。 如果指定了此标志,则 KDF_HMAC_KEY 参数不应包含在 pParameterList 参数的参数集中。 此标志仅由 BCRYPT_KDF_HMAC 密钥派生函数使用。

返回值

返回一个状态代码,指示函数的成功或失败。

可能的返回代码包括但不限于以下代码。

返回代码 Description
ERROR_SUCCESS 函数成功。
NTE_INVALID_HANDLE hSharedSecret 参数中的句柄无效。
NTE_INVALID_PARAMETER 一个或多个参数无效。

注解

pParameterList 参数中的 NCryptBufferDesc 结构可以包含多个KDF_SECRET_PREPENDKDF_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 函数中使用原始机密时,请务必注意这一点,因为其中大多数函数采用大端编码输入。

服务不得从其 StartService 函数调用此函数。 如果服务从其 StartService 函数调用此函数,可能会发生死锁,并且服务可能会停止响应。

要求

Requirement 价值
最低支持的客户端 Windows Vista [桌面应用 |UWP 应用]
支持的最低服务器 Windows Server 2008 [桌面应用 |UWP 应用]
目标平台 Windows操作系统
Header ncrypt.h
Library Ncrypt.lib
DLL Ncrypt.dll

另请参阅

NCryptBufferDesc

NCryptSecretAgreement