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 は、Advanced Encryption Standard (AES) キー ラップ アルゴリズムで使用できる対称キーのハンドルである必要があります。 hKey ハンドルが Microsoft プロバイダーからの場合、hExportKey は AES キー ハンドルである必要があります。

Windows Server 2008 と Windows Vista: このパラメーターは使用されず、 NULLに設定する必要があります。

[in] pszBlobType

エクスポートする BLOB の種類を指定する識別子を含む null で終わる Unicode 文字列。 次のいずれかの値を指定できます。

価値	意味
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_BLOBまたはBCRYPT_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_BLOBまたはBCRYPT_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 バッファーは、キー BLOB の直後にBCRYPT_KEY_DATA_BLOB_HEADER構造を受け取ります。
BCRYPT_MLKEM_PUBLIC_BLOB	BLOB は ML-KEM BLOB であり、FIPS 203 ごとに標準のバイト エンコード ML-KEM カプセル化キーのインポートとエクスポートを提供します。 pbOutput バッファーには、バイト エンコード KEM カプセル化キー、BCRYPT_MLKEM_PUBLIC_MAGIC、および ML-KEM パラメーター セットを含むBCRYPT_MLKEM_KEY_BLOB構造体が含まれている必要があります。
BCRYPT_MLKEM_PRIVATE_BLOB	BLOB は、FIPS 203 ごとに標準のバイト エンコード ML-KEM カプセル化解除キーのインポートとエクスポートを提供する ML-KEM BLOB です。 pbOutput バッファーには、バイト エンコード KEM カプセル化解除キー、BCRYPT_MLKEM_PRIVATE_MAGIC、およびパラメーター セットを含むBCRYPT_MLKEM_KEY_BLOB構造体 ML-KEM 含める必要があります。
BCRYPT_MLKEM_PRIVATE_SEED_BLOB	BLOB は、FIPS 203 ごとに ML-KEM シードのインポートとエクスポートを提供する ML-KEM BLOB です。 pbOutput バッファーには、KEM シード、BCRYPT_MLKEM_SEED_MAGIC、およびパラメーター セットを含むBCRYPT_MLKEM_KEY_BLOB構造体 ML-KEM 必要があります。
BCRYPT_OPAQUE_KEY_BLOB	1 つの 暗号化サービス プロバイダー (CSP) に固有の形式で対称キーをエクスポートします。 不透明 BLOB は転送できないため、BLOB を生成したのと同じ CSP を使用してインポートする必要があります。 不透明 BLOB は、キーのプロセス間転送にのみ使用することを目的としており、プロバイダーのバージョン間で永続化および読み取りを行うのに適していません。
BCRYPT_PQDSA_PUBLIC_BLOB	BLOB は、FIPS 204 および 205 ごとの PQ デジタル署名公開キーのインポートとエクスポートを提供する ML-DSA、SLH-DSA、LMS、または XMSS BLOB です。 pbOutput バッファーには、キー マテリアル、パブリック マジック、および PQ パラメーター セットを含むBCRYPT_PQDSA_KEY_BLOB構造体が含まれている必要があります。
BCRYPT_PQDSA_PRIVATE_BLOB	BLOB は、FIPS 204 および 205 ごとの PQ デジタル署名秘密キーのインポートとエクスポートを提供する ML-DSA、SLH-DSA、LMS、または XMSS BLOB です。 pbOutput バッファーには、キー マテリアル、プライベート マジック、および PQ パラメーター セットを含むBCRYPT_PQDSA_KEY_BLOB構造体が含まれている必要があります。
BCRYPT_PQDSA_PRIVATE_SEED_BLOB	BLOB は、FIPS 204 および 205 ごとの PQ デジタル署名プライベート シードのインポートとエクスポートを提供する ML-DSA、SLH-DSA、LMS、または XMSS BLOB です。 pbOutput バッファーには、シード値、プライベート シード マジック、および PQ パラメーター セットを含むBCRYPT_PQDSA_KEY_BLOB構造体が含まれている必要があります。
BCRYPT_PRIVATE_KEY_BLOB	任意の型の汎用秘密キーをエクスポートします。 秘密キーに公開キーが含まれているとは限りません。 この BLOB のキーの種類は、BCRYPT_KEY_BLOB構造体の Magic メンバーによって決まります。
BCRYPT_PUBLIC_KEY_BLOB	任意の型のジェネリック公開キーをエクスポートします。 この BLOB のキーの種類は、BCRYPT_KEY_BLOB構造体の Magic メンバーによって決まります。
BCRYPT_RSAFULLPRIVATE_BLOB	完全な RSA 公開キーと秘密キーのペアをエクスポートします。 pbOutput バッファーは、キー データの直後にBCRYPT_RSAKEY_BLOB構造体を受け取ります。 この BLOB には、 BCRYPT_RSAPRIVATE_BLOB の種類と比較した追加のキー マテリアルが含まれます。
BCRYPT_RSAPRIVATE_BLOB	RSA 公開キーと秘密キーのペアをエクスポートします。 pbOutput バッファーは、キー データの直後にBCRYPT_RSAKEY_BLOB構造体を受け取ります。
BCRYPT_RSAPUBLIC_BLOB	RSA 公開キーをエクスポートします。 pbOutput バッファーは、キー データの直後にBCRYPT_RSAKEY_BLOB構造体を受け取ります。
LEGACY_DH_PRIVATE_BLOB	CryptoAPI を使用してインポートできる Diffie-Hellman 公開キーと秘密キーのペアを含むレガシDiffie-Hellman バージョン 3 の秘密キー BLOB をエクスポートします。
LEGACY_DH_PUBLIC_BLOB	CryptoAPI を使用してインポートできる Diffie-Hellman 公開キーを含むレガシDiffie-Hellman バージョン 3 公開キー BLOB を エクスポートします。
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場合、この関数は、pcbResult パラメーターが指す ULONG に必要なサイズ (バイト単位) を配置します。

[in] cbOutput

pbOutput バッファーのサイズをバイト単位で格納します。

[out] pcbResult

pbOutput バッファーにコピーされたバイト数を受け取る ULONG へのポインター。 pbOutput パラメーターがNULL場合、この関数は、このパラメーターが指す ULONG に必要なサイズ (バイト単位) を配置します。

[in] dwFlags

この関数の動作を変更するフラグのセット。 この関数にはフラグは定義されていません。

ML-KEM キーの場合、このパラメーターは 0 にする必要があります。

戻り値

関数の成功または失敗を示す状態コードを返します。

可能な戻りコードには、以下が含まれますが、これらに限定されません。

リターン コード	形容
STATUS_SUCCESS	関数が成功しました。
STATUS_BUFFER_TOO_SMALL	cbOutput パラメーターで指定されたサイズは、暗号テキストを保持するのに十分な大きさではありません。 buffer pbOutput が小さすぎる場合、 pcbResult は pbOutput に必要なバイト数を受け取ります。
STATUS_INVALID_HANDLE	hKey パラメーターのキー ハンドルが無効です。
STATUS_INVALID_PARAMETER	1 つ以上のパラメーターが無効です。
STATUS_NOT_SUPPORTED	指定された BLOB の種類は、プロバイダーではサポートされていません。 指定されたキー ハンドルがプライベート シードのエクスポートをサポートしていない場合。 解説を参照してください。

備考

ML-KEM プライベート シードのエクスポートは、呼び出し元が BCrypt を使用してキーを生成した場合、またはプライベート シードをインポートしてハンドルが作成された場合にのみ使用できます。

プロバイダーがサポートするプロセッサ モードに応じて、 BCryptExportKey をユーザー モードまたはカーネル モードから呼び出すことができます。 カーネル モードの呼び出し元は、PASSIVE_LEVELIRQL または DISPATCH_LEVEL IRQL で実行できます。 現在の IRQL レベルが DISPATCH_LEVELされている場合、 hKey パラメーターで指定されたハンドルは、 BCRYPT_PROV_DISPATCH フラグで開かれたプロバイダーによって返されるアルゴリズム ハンドルから派生する必要があり、 BCryptExportKey 関数に渡されるすべてのポインターは、非ページ (またはロックされた) メモリを参照する必要があります。

カーネル モードでこの関数を呼び出すには、ドライバー開発キット (DDK) の一部である Cng.libを使用します。 Windows Server 2008 と Windows Vista: カーネル モードでこの関数を呼び出すには、 Ksecdd.libを使用します。

必要条件

要件	価値
サポートされる最小クライアント	Windows Vista [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー	Windows Server 2008 [デスクトップ アプリ |UWP アプリ]
ターゲット プラットフォーム の	ウィンドウズ
ヘッダー	bcrypt.h
図書館	Bcrypt.lib
DLL	Bcrypt.dll

関連項目

BCryptImportKey

BCryptImportKeyPair