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_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 列または省略可能列で示されているように、次のパラメーターを含めることができるか、または含まれている必要があります。
パラメーター | 必須または省略可能 |
---|---|
NCRYPTBUFFER_CERT_BLOB | 必須 |
NCRYPTBUFFER_PKCS_ALG_OID | 必須 |
NCRYPTBUFFER_PKCS_ALG_PARAM | オプション |
NCRYPT_PKCS8_PRIVATE_KEY_BLOB
PKCS #8 秘密キー BLOB をエクスポートします。 pParameterList パラメーターによって識別されるパラメーターには、Required 列または省略可能列で示されているように、次のパラメーターを含めることができるか、または含まれている必要があります。
パラメーター | 必須または省略可能 |
---|---|
NCRYPTBUFFER_PKCS_ALG_OID | オプション |
NCRYPTBUFFER_PKCS_ALG_PARAM | オプション |
NCRYPTBUFFER_PKCS_SECRET | オプション |
NCRYPT_PROTECTED_KEY_BLOB
保護されたキーを NCRYPT_KEY_BLOB_HEADER 構造でエクスポートします。
Windows 8とWindows Server 2012: この値のサポートが開始されます。
[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 つ以上の組み合わせにすることができます。 有効なフラグのセットは、各キー ストレージ プロバイダーに固有です。 次のフラグは、すべてのプロバイダーに適用されます。
値 | 意味 |
---|---|
NCRYPT_SILENT_FLAG | キー サービス プロバイダー (KSP) にユーザー インターフェイスが表示されないことを要求します。 プロバイダーが操作する UI を表示する必要がある場合、呼び出しは失敗し、KSP は NTE_SILENT_CONTEXT エラー コードを最後のエラーとして設定する必要があります。 |
戻り値
関数の成功または失敗を示す状態コードを返します。
可能なリターン コードには、次のものが含まれますが、これらに限定されません。
リターン コード | 説明 |
---|---|
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 つ以上のパラメーターが無効です。 |
注釈
サービスは 、StartService 関数からこの関数を呼び出してはなりません。 サービスが StartService 関数からこの関数を呼び出すと、デッドロックが発生し、サービスが応答を停止する可能性があります。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ | UWP アプリ] |
サポートされている最小のサーバー | Windows Server 2008 [デスクトップ アプリ | UWP アプリ] |
対象プラットフォーム | Windows |
ヘッダー | ncrypt.h |
Library | Ncrypt.lib |
[DLL] | Ncrypt.dll |