NCryptExportKey 函数 (ncrypt.h)

项目
02/29/2024

NCryptExportKey 函数将 CNG 密钥导出到内存 BLOB。

语法

SECURITY_STATUS NCryptExportKey(
  [in]            NCRYPT_KEY_HANDLE hKey,
  [in, optional]  NCRYPT_KEY_HANDLE hExportKey,
  [in]            LPCWSTR           pszBlobType,
  [in, optional]  NCryptBufferDesc  *pParameterList,
  [out, optional] PBYTE             pbOutput,
  [in]            DWORD             cbOutput,
  [out]           DWORD             *pcbResult,
  [in]            DWORD             dwFlags
);

参数

[in] hKey

要导出的密钥的句柄。

[in, optional] hExportKey

目标用户的加密密钥的句柄。使用此密钥对导出的密钥 BLOB 中的密钥数据进行加密。这可确保只有目标用户才能使用密钥 BLOB。

[in] pszBlobType

一个以 null 结尾的 Unicode 字符串，其中包含指定要导出的 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_BLOB结构。

BCRYPT_DSA_PUBLIC_BLOB

导出 DSA 公钥。 pbOutput 缓冲区接收紧跟密钥数据的BCRYPT_DSA_KEY_BLOB结构。

BCRYPT_ECCPRIVATE_BLOB

(ECC) 私钥导出椭圆曲线加密。 pbOutput 缓冲区接收紧跟键数据的BCRYPT_ECCKEY_BLOB结构。

BCRYPT_ECCPUBLIC_BLOB

导出 ECC 公钥。 pbOutput 缓冲区接收紧跟键数据的BCRYPT_ECCKEY_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_RSAPRIVATE_BLOB

以可使用 CryptoAPI 导入的形式导出 RSA 公钥/私钥对。

LEGACY_RSAPUBLIC_BLOB

以可使用 CryptoAPI 导入的表单导出 RSA 公钥。

NCRYPT_CIPHER_KEY_BLOB

在 NCRYPT_KEY_BLOB_HEADER 结构中导出密码密钥。

Windows 8和Windows Server 2012：开始支持此值。

NCRYPT_OPAQUETRANSPORT_BLOB

以特定于单个 CSP 且适合传输的格式导出密钥。不透明 BLOB 不可传输，必须使用生成 BLOB 的同一 CSP 导入。

NCRYPT_PKCS7_ENVELOPE_BLOB

导出 PKCS #7 信封 BLOB。 pParameterList 参数标识的参数可以或必须包含以下参数，如必需列或可选列所指示的那样。

参数	必需还是可选
NCRYPTBUFFER_CERT_BLOB	必需
NCRYPTBUFFER_PKCS_ALG_OID	必需
NCRYPTBUFFER_PKCS_ALG_PARAM	可选

NCRYPT_PKCS8_PRIVATE_KEY_BLOB

导出 PKCS #8 私钥 BLOB。 pParameterList 参数标识的参数可以或必须包含以下参数，如必需列或可选列所指示的那样。

参数	必需还是可选
NCRYPTBUFFER_PKCS_ALG_OID	可选
NCRYPTBUFFER_PKCS_ALG_PARAM	可选
NCRYPTBUFFER_PKCS_SECRET	可选

NCRYPT_PROTECTED_KEY_BLOB

在 NCRYPT_KEY_BLOB_HEADER 结构中导出受保护的密钥。

Windows 8和Windows Server 2012：开始支持此值。

[in, optional] pParameterList

接收密钥的参数信息的 NCryptBufferDesc 结构的地址。如果不需要此信息，此参数可以为 NULL 。

[out, optional] pbOutput

接收密钥 BLOB 的缓冲区的地址。 cbOutput 参数包含此缓冲区的大小。如果此参数为 NULL，则此函数会将所需大小（以字节为单位）放在由印刷电路板Result 参数指向的 DWORD 中。

[in] cbOutput

pbOutput 缓冲区的大小（以字节为单位）。

[out] pcbResult

接收复制到 pbOutput 缓冲区的字节数的 DWORD 变量的地址。如果 pbOutput 参数为 NULL，则此函数会将所需大小（以字节为单位）放在此参数指向的 DWORD 中。

[in] dwFlags

用于修改函数行为的标志。这可以是零，也可以是以下一个或多个值的组合。有效标志集特定于每个密钥存储提供程序。以下标志适用于所有提供程序。

值	含义
NCRYPT_SILENT_FLAG	请求关键服务提供程序 (KSP) 不显示任何用户界面。如果提供程序必须显示 UI 才能操作，则调用将失败，KSP 应将 NTE_SILENT_CONTEXT 错误代码设置为最后一个错误。

返回值

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

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

返回代码	说明
ERROR_SUCCESS	函数成功。
NTE_BAD_FLAGS	dwFlags 参数包含无效的值。
NTE_BAD_KEY_STATE	由 hKey 参数指定的键无效。此错误的最常见原因是未使用 NCryptFinalizeKey 函数完成密钥。
NTE_BAD_TYPE	hKey 参数指定的密钥无法导出到 pszBlobType 参数指定的 BLOB 类型中。
NTE_INVALID_HANDLE	hKey 或 hExportKey 参数无效。
NTE_INVALID_PARAMETER	一个或多个参数无效。

注解

服务不得从其 StartService 函数调用此函数。如果服务从其 StartService 函数调用此函数，则可能会出现死锁，并且服务可能会停止响应。

要求

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

另请参阅

NCryptBuffer

通过