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 密钥句柄后，才能释放此内存。

如果此参数的值为 NULL 且 cbKeyObject 参数的值为零，则此函数将分配并释放密钥对象的内存。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_LEVELIRQL 或 DISPATCH_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 应用]
目标平台 Windows
标头 bcrypt.h
Library Bcrypt.lib
DLL Bcrypt.dll

另请参阅

BCryptDestroyKey