NCryptExportKey 関数 (ncrypt.h)

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

エクスポートする 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構造体を受け取ります。

注: ML-KEM、 BCRYPT_MLKEM_PRIVATE_BLOBを使用 してインポートされた秘密キーを含むキー ハンドルには、秘密シード キーをエクスポートするための十分な情報がありません。

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

BCRYPT_MLKEM_PRIVATE_BLOB

ML-KEM プライベート (カプセル化解除) キーをエクスポートします。 pbOutput バッファーは、パラメーター セットとキー データの直後にBCRYPT_MLKEM_KEY_BLOB構造体を受け取ります。

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

BCRYPT_MLKEM_PUBLIC_BLOB

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

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

BCRYPT_PQDSA_PRIVATE_SEED_BLOB

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

手記：BCRYPT_PQDSA_PRIVATE_BLOBを使用してインポートされた秘密キーを含む PQDSA キー ハンドルには、秘密シード キーをエクスポートするための十分な情報がありません。

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

BCRYPT_PQDSA_PRIVATE_BLOB

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

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

BCRYPT_PQDSA_PUBLIC_BLOB

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

Windows Insider (ビルド 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

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_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

1 つの CSP に固有の形式でキーをエクスポートし、トランスポートに適しています。 不透明 BLOB は転送できないため、BLOB を生成したのと同じ CSP を使用してインポートする必要があります。

NCRYPT_PKCS7_ENVELOPE_BLOB

PKCS #7 エンベロープ BLOB をエクスポートします。 pParameterList パラメーターによって識別されるパラメーターは、Required 列または省略可能な列で示されているように、次のパラメーターを含めることができます。または含まれている必要があります。

NCRYPT_PKCS8_PRIVATE_KEY_BLOB

PKCS #8 秘密キー BLOB をエクスポートします。 pParameterList パラメーターによって識別されるパラメーターは、Required 列または省略可能な列で示されているように、次のパラメーターを含めることができます。または含まれている必要があります。

NCRYPT_PROTECTED_KEY_BLOB

保護されたキーを NCRYPT_KEY_BLOB_HEADER 構造体にエクスポートします。

Windows 8 および Windows Server 2012: この値のサポートが開始されます。

NCRYPT_PQ_PRIVATE_KEY_BLOB

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

[in, optional] pParameterList

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

[out, optional] pbOutput

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

[in] cbOutput

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

[out] pcbResult

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

[in] dwFlags

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

戻り値

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

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

注釈

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

要求事項

こちらも参照ください

• NCryptBuffer
• NCryptFinalizeKey