ホーム › Security.Cryptography › NCryptExportKeyFn

NCryptExportKeyFn

コールバック

シグネチャ

HRESULT NCryptExportKeyFn(
    NCRYPT_PROV_HANDLE hProvider,
    NCRYPT_KEY_HANDLE hKey,
    NCRYPT_KEY_HANDLE hExportKey,
    LPWSTR pszBlobType,
    BCryptBufferDesc* pParameterList,
    BYTE* pbOutput,
    DWORD cbOutput,
    DWORD* pcbResult,
    DWORD dwFlags
);

パラメーター

フィールド

型

説明

hProvider

NCRYPT_PROV_HANDLE

hKey

NCRYPT_KEY_HANDLE

エクスポートするキーのハンドルです。

hExportKey

NCRYPT_KEY_HANDLE

エクスポート先のユーザーの暗号キーへのハンドルです。エクスポートされるキー BLOB 内のキーデータは、このキーを使用して暗号化されます。これにより、エクスポート先のユーザーだけがそのキー BLOB を利用できるようになります。

pszBlobType

LPWSTR

エクスポートする BLOB の種類を指定する識別子を格納した、null 終端の Unicode 文字列です。次のいずれかの値を指定できます。

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_MLKEM_PRIVATE_SEED_BLOB

ML-KEM の秘密シードキーをエクスポートします。pbOutput バッファーは、BCRYPT_MLKEM_KEY_BLOB 構造体と、その直後に続くパラメーターセットおよびキーデータを受け取ります。

注: BCRYPT_MLKEM_PRIVATE_BLOB を使用してインポートされた秘密キーを保持する ML-KEM キーハンドルは、秘密シードキーをエクスポートするための情報が不足しています。

Windows Insiders (ビルド 27843): ML-KEM のサポートが開始されます。

BCRYPT_MLKEM_PRIVATE_BLOB

ML-KEM の秘密キー (デカプセル化キー) をエクスポートします。pbOutput バッファーは、BCRYPT_MLKEM_KEY_BLOB 構造体と、その直後に続くパラメーターセットおよびキーデータを受け取ります。

Windows Insiders (ビルド 27843): ML-KEM のサポートが開始されます。

BCRYPT_MLKEM_PUBLIC_BLOB

ML-KEM の公開キー (カプセル化キー) をエクスポートします。pbOutput バッファーは、BCRYPT_MLKEM_KEY_BLOB 構造体と、その直後に続くパラメーターセットおよびキーデータを受け取ります。

Windows Insiders (ビルド 27843): ML-KEM のサポートが開始されます。

BCRYPT_PQDSA_PRIVATE_SEED_BLOB

PQDSA の秘密シードキーをエクスポートします。pbOutput バッファーは、BCRYPT_PQDSA_KEY_BLOB 構造体と、その直後に続くパラメーターセットおよびキーデータを受け取ります。

注: BCRYPT_PQDSA_PRIVATE_BLOB を使用してインポートされた秘密キーを保持する PQDSA キーハンドルは、秘密シードキーをエクスポートするための情報が不足しています。

Windows Insiders (ビルド 27843): ML-DSA のサポートが開始されます。

BCRYPT_PQDSA_PRIVATE_BLOB

PQDSA の秘密キーをエクスポートします。pbOutput バッファーは、BCRYPT_PQDSA_KEY_BLOB 構造体と、その直後に続くパラメーターセットおよびキーデータを受け取ります。

Windows Insiders (ビルド 27843): ML-DSA のサポートが開始されます。

BCRYPT_PQDSA_PUBLIC_BLOB

PQDSA の公開キーをエクスポートします。pbOutput バッファーは、BCRYPT_PQDSA_KEY_BLOB 構造体と、その直後に続くパラメーターセットおよびキーデータを受け取ります。

Windows Insiders (ビルド 27843): ML-DSA のサポートが開始されます。

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

Diffie-Hellman の公開キー/秘密キーのペアを格納した、レガシの Diffie-Hellman バージョン 3 秘密キー BLOB をエクスポートします。この BLOB は CryptoAPI を使用してインポートできます。

LEGACY_DH_PUBLIC_BLOB

Diffie-Hellman の公開キーを格納した、レガシの Diffie-Hellman バージョン 3 秘密キー BLOB をエクスポートします。この BLOB は CryptoAPI を使用してインポートできます。

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: この値のサポートが開始されます。

NCRYPT_PQ_PRIVATE_KEY_BLOB

任意の種類のポスト量子アルゴリズムの汎用的な秘密キーをエクスポートします。この BLOB に含まれるキーの種類は、NCRYPT_PQ_BLOB 構造体の Magic メンバーによって決まります。

pParameterList

BCryptBufferDesc*

キーのパラメーター情報を受け取る NCryptBufferDesc 構造体のアドレスです。この情報が不要な場合、このパラメーターは NULL にできます。

pbOutput

BYTE*

キー BLOB を受け取るバッファーのアドレスです。cbOutput パラメーターには、このバッファーのサイズを指定します。このパラメーターが NULL の場合、この関数は必要なサイズ (バイト単位) を pcbResult パラメーターが指す DWORD に格納します。

cbOutput

DWORD

pbOutput バッファーのサイズ (バイト単位) です。

pcbResult

DWORD*

pbOutput バッファーにコピーされたバイト数を受け取る DWORD 変数のアドレスです。pbOutput パラメーターが NULL の場合、この関数は必要なサイズ (バイト単位) を、このパラメーターが指す DWORD に格納します。

dwFlags

DWORD

関数の動作を変更するフラグです。0 を指定するか、次の値の 1 つ以上を組み合わせて指定できます。有効なフラグの種類はキーストレージプロバイダーごとに異なります。次のフラグはすべてのプロバイダーに適用されます。

値	意味
NCRYPT_SILENT_FLAG	キーストレージプロバイダー (KSP) がユーザーインターフェイスを一切表示しないよう要求します。動作するために UI の表示が必要なプロバイダーの場合、呼び出しは失敗し、KSP は最後のエラーとして NTE_SILENT_CONTEXT エラーコードを設定します。

公式ドキュメント

NCryptExportKey 関数は、CNG キーをメモリ BLOB にエクスポートします。

戻り値

関数の成功または失敗を示すステータスコードを返します。

返される可能性のあるコードには、次のものが含まれます (これらに限定されません)。

戻り値	説明
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	1 つ以上のパラメーターが無効です。

解説(Remarks)

サービスは、StartService 関数からこの関数を呼び出してはなりません。サービスが StartService 関数からこの関数を呼び出すと、デッドロックが発生し、サービスが応答しなくなる場合があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)