BCryptGenerateSymmetricKey 函数 (bcrypt.h)

BCryptGenerateSymmetricKey 函数创建一个密钥对象,用于提供的密钥中的对称密钥加密算法。

语法

NTSTATUS BCryptGenerateSymmetricKey(
  [in, out]       BCRYPT_ALG_HANDLE hAlgorithm,
  [out]           BCRYPT_KEY_HANDLE *phKey,
  [out, optional] PUCHAR            pbKeyObject,
  [in]            ULONG             cbKeyObject,
  [in]            PUCHAR            pbSecret,
  [in]            ULONG             cbSecret,
  [in]            ULONG             dwFlags
);

参数

[in, out] hAlgorithm

使用 BCryptOpenAlgorithmProvider 函数创建的算法提供程序的句柄。 创建提供程序时指定的算法必须支持对称密钥加密。

[out] phKey

指向接收密钥句柄的 BCRYPT_KEY_HANDLE 的指针。 此句柄用于需要密钥的后续函数,例如 BCryptEncrypt。 当不再需要此句柄时,必须将其传递给 BCryptDestroyKey 函数来释放该句柄。

[out, optional] pbKeyObject

指向接收密钥对象的缓冲区的指针。 cbKeyObject 参数包含此缓冲区的大小。 可以通过调用 BCryptGetProperty 函数来获取此缓冲区的所需大小以获取 BCRYPT_OBJECT_LENGTH 属性。 这将为指定的算法提供键对象的大小。

此内存只能在销毁 phKey 密钥句柄后释放。

如果此参数的值 NULLcbKeyObject 参数的值为零,则此函数分配并释放密钥对象的内存。Windows 7:从 Windows 7 开始提供此内存管理功能。

[in] cbKeyObject

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

如果此参数的值为零,并且 pbKeyObject 参数的值 NULL,则此函数分配并释放密钥对象的内存。Windows 7:从 Windows 7 开始提供此内存管理功能。

[in] pbSecret

指向包含从中创建密钥对象的键的缓冲区的指针。 cbSecret 参数包含此缓冲区的大小。 这通常是密码或其他可重现数据的哈希。 如果传入的数据超过目标键大小,将截断数据,并且将忽略多余的数据。

注意 强烈建议应用程序传入目标密钥所需的确切字节数。
 

[in] cbSecret

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

[in] dwFlags

一组标志,用于修改此函数的行为。 当前未定义任何标志,因此此参数应为零。

返回值

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

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

返回代码 描述
STATUS_SUCCESS
函数成功。
STATUS_BUFFER_TOO_SMALL
cbKeyObject 参数指定的键对象的大小不足以容纳键对象。
STATUS_INVALID_HANDLE
hAlgorithm 参数中的算法句柄无效。
STATUS_INVALID_PARAMETER
一个或多个参数无效。

言论

根据提供程序支持的处理器模式,BCryptGenerateSymmetricKey 可以从用户模式或内核模式调用。 内核模式调用方可以在 PASSIVE_LEVELIRQLDISPATCH_LEVEL IRQL 上执行。 如果当前 IRQL 级别 DISPATCH_LEVEL,则必须使用 BCRYPT_PROV_DISPATCH 标志打开 hAlgorithm 参数中提供的句柄,并且传递给 BCryptGenerateSymmetricKey 函数的任何指针都必须引用非分页(或锁定)内存。

若要在内核模式下调用此函数,请使用 Cng.lib,这是驱动程序开发工具包(DDK)的一部分。 Windows Server 2008 和 Windows Vista:若要在内核模式下调用此函数,请使用 Ksecdd.lib。

要求

要求 价值
最低支持的客户端 Windows Vista [桌面应用 |UWP 应用]
支持的最低服务器 Windows Server 2008 [桌面应用 |UWP 应用]
目标平台 窗户
标头 bcrypt.h
Bcrypt.lib
DLL Bcrypt.dll

另请参阅

BCryptDestroyKey