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_OPAQUE_KEY_BLOB
 1 つの 暗号化サービス プロバイダー (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構造体を受け取ります。 この 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

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

戻り値

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

可能なリターン コードには、次のものが含まれますが、これらに限定されません。

リターン コード 説明
STATUS_SUCCESS
 関数は成功しました。
STATUS_BUFFER_TOO_SMALL
 cbOutput パラメーターで指定されたサイズは、暗号テキストを保持するのに十分な大きさではありません。
STATUS_INVALID_HANDLE
 hKey パラメーターのキー ハンドルが無効です。
STATUS_INVALID_PARAMETER
 1 つ以上のパラメーターが無効です。
STATUS_NOT_SUPPORTED
 指定された BLOB の種類は、プロバイダーではサポートされていません。

注釈

プロバイダーがサポートするプロセッサ モードに応じて、 BCryptExportKey をユーザー モードまたはカーネル モードから呼び出すことができます。 カーネル モードの呼び出し元は、PASSIVE_LEVEL IRQL または IRQL DISPATCH_LEVELで実行できます。 現在の 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 アプリ]
対象プラットフォーム Windows
ヘッダー bcrypt.h
Library Bcrypt.lib
[DLL] Bcrypt.dll

こちらもご覧ください

BCryptImportKey

BCryptImportKeyPair