BCryptExportKey 函数 (bcrypt.h)

BCryptExportKey 函数将密钥导出到内存 BLOB,以供以后使用。

语法

NTSTATUS BCryptExportKey(
  [in]  BCRYPT_KEY_HANDLE hKey,
  [in]  BCRYPT_KEY_HANDLE hExportKey,
  [in]  LPCWSTR           pszBlobType,
  [out] PUCHAR            pbOutput,
  [in]  ULONG             cbOutput,
  [out] ULONG             *pcbResult,
  [in]  ULONG             dwFlags
);

参数

[in] hKey

要导出的密钥的句柄。

[in] hExportKey

要包装导出密钥的密钥的句柄。 导出类型为 BCRYPT_AES_WRAP_KEY_BLOB; 的 BLOB 时,请使用此参数;否则,将其设置为 NULL

注释hExportKey 句柄必须由提供 hKey 句柄的同一提供程序提供,hExportKey 必须是对称密钥的句柄,该密钥可在 高级加密标准(AES)密钥包装算法中使用。 当 hKey 句柄来自Microsoft提供程序时,hExportKey 必须是 AES 密钥句柄。

 

Windows Server 2008 和 Windows Vista:此参数未使用,应设置为 NULL

[in] pszBlobType

一个以 null 结尾的 Unicode 字符串,其中包含指定要导出的 BLOB 类型的标识符。 这可以是以下值之一。

价值 意义
BCRYPT_AES_WRAP_KEY_BLOB
导出 AES 密钥包装的键。 hExportKey 参数必须引用指向密钥加密密钥的有效 BCRYPT_KEY_HANDLE 指针,hKey 参数表示的密钥必须是长度为 8 字节的倍数。

Windows Server 2008 和 Windows Vista:不支持 此 BLOB 类型。

BCRYPT_DH_PRIVATE_BLOB
导出 Diffie-Hellman 公钥/私钥对。 pbOutput 缓冲区立即接收 BCRYPT_DH_KEY_BLOB 结构,后跟密钥数据。
BCRYPT_DH_PUBLIC_BLOB
导出 Diffie-Hellman 公钥pbOutput 缓冲区立即接收 BCRYPT_DH_KEY_BLOB 结构,后跟密钥数据。
BCRYPT_DSA_PRIVATE_BLOB
导出 DSA 公钥/私钥对。 pbOutput 缓冲区接收紧跟密钥数据的 BCRYPT_DSA_KEY_BLOBBCRYPT_DSA_KEY_BLOB_V2 结构。 BCRYPT_DSA_KEY_BLOB 用于 512 到 1024 位的密钥长度。 BCRYPT_DSA_KEY_BLOB_V2 用于超过 1024 位但小于或等于 3072 位的密钥长度。

Windows 8:支持 BCRYPT_DSA_KEY_BLOB_V2 开始。

BCRYPT_DSA_PUBLIC_BLOB
导出 DSA 公钥。 pbOutput 缓冲区接收紧跟密钥数据的 BCRYPT_DSA_KEY_BLOBBCRYPT_DSA_KEY_BLOB_V2 结构。 BCRYPT_DSA_KEY_BLOB 用于 512 到 1024 位的密钥长度。 BCRYPT_DSA_KEY_BLOB_V2 用于超过 1024 位但小于或等于 3072 位的密钥长度。

Windows 8:支持 BCRYPT_DSA_KEY_BLOB_V2 开始。

BCRYPT_ECCPRIVATE_BLOB
导出 椭圆曲线加密(ECC)私钥pbOutput 缓冲区立即接收 BCRYPT_ECCKEY_BLOB 结构,后跟密钥数据。
BCRYPT_ECCPUBLIC_BLOB
导出 ECC 公钥。 pbOutput 缓冲区立即接收 BCRYPT_ECCKEY_BLOB 结构,后跟密钥数据。
BCRYPT_KEY_DATA_BLOB
将对称密钥导出到数据 BLOB。 pbOutput 缓冲区立即接收 BCRYPT_KEY_DATA_BLOB_HEADER 结构,后跟密钥 BLOB。
BCRYPT_OPAQUE_KEY_BLOB
以特定于单个 加密服务提供商(CSP)的格式导出对称密钥。 不透明 BLOB 不可传输,必须使用生成 BLOB 的同一 CSP 导入。 不透明 BLOB 仅用于密钥的进程间传输,不适合跨提供程序的版本持久保存和读取。
BCRYPT_PUBLIC_KEY_BLOB
导出任何类型的通用公钥。 此 BLOB 中的密钥类型由 BCRYPT_KEY_BLOB 结构的 Magic 成员决定。
BCRYPT_PRIVATE_KEY_BLOB
导出任何类型的通用私钥。 私钥不一定包含公钥。 此 BLOB 中的密钥类型由 BCRYPT_KEY_BLOB 结构的 Magic 成员决定。
BCRYPT_RSAFULLPRIVATE_BLOB
导出完整的 RSA 公钥/私钥对。 pbOutput 缓冲区立即接收 BCRYPT_RSAKEY_BLOB 结构,后跟密钥数据。 与 BCRYPT_RSAPRIVATE_BLOB 类型相比,此 BLOB 将包含其他密钥材料。
BCRYPT_RSAPRIVATE_BLOB
导出 RSA 公钥/私钥对。 pbOutput 缓冲区立即接收 BCRYPT_RSAKEY_BLOB 结构,后跟密钥数据。
BCRYPT_RSAPUBLIC_BLOB
导出 RSA 公钥。 pbOutput 缓冲区立即接收 BCRYPT_RSAKEY_BLOB 结构,后跟密钥数据。
LEGACY_DH_PRIVATE_BLOB
导出旧版 Diffie-Hellman 版本 3 私钥 BLOB,其中包含可以使用 CryptoAPI导入的 Diffie-Hellman 公钥/私钥对。
LEGACY_DH_PUBLIC_BLOB
导出旧版 Diffie-Hellman 版本 3 公钥 BLOB,其中包含可以使用 CryptoAPI 导入的 Diffie-Hellman 公钥。
LEGACY_DSA_PRIVATE_BLOB
以可以使用 CryptoAPI 导入的形式导出 DSA 公钥/私钥对。
LEGACY_DSA_PUBLIC_BLOB
使用 CryptoAPI 以可导入的形式导出 DSA 公钥。
LEGACY_DSA_V2_PRIVATE_BLOB
使用 CryptoAPI 以可导入的形式导出 DSA 版本 2 私钥。
LEGACY_RSAPRIVATE_BLOB
以可以使用 CryptoAPI 导入的形式导出 RSA 公钥/私钥对。
LEGACY_RSAPUBLIC_BLOB
使用 CryptoAPI 以可导入的形式导出 RSA 公钥。

[out] pbOutput

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

[in] cbOutput

包含 pbOutput 缓冲区的大小(以字节为单位)。

[out] pcbResult

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

[in] dwFlags

一组标志,用于修改此函数的行为。 此函数未定义任何标志。

返回值

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

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

返回代码 描述
STATUS_SUCCESS
函数成功。
STATUS_BUFFER_TOO_SMALL
cbOutput 参数指定的大小不够大,无法容纳密码文本。
STATUS_INVALID_HANDLE
hKey 参数中的键句柄无效。
STATUS_INVALID_PARAMETER
一个或多个参数无效。
STATUS_NOT_SUPPORTED
提供程序不支持指定的 BLOB 类型。

言论

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

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

要求

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

另请参阅

BCryptImportKey

BCryptImportKeyPair