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 中的金鑰類型是由 Magic 結構 BCRYPT_KEY_BLOB 的成員所決定。
BCRYPT_PRIVATE_KEY_BLOB
匯出任何類型的泛型私鑰。 私鑰不一定包含公鑰。 此 BLOB 中的金鑰類型是由 Magic 結構 BCRYPT_KEY_BLOB 的成員所決定。
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 可以從使用者模式或核心模式呼叫。 核心模式呼叫端可以在 IRQL PASSIVE_LEVELDISPATCH_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