CryptExportKey 関数 (wincrypt.h)

エクスポートするキーへのハンドルが関数に渡され、関数は キー BLOB を返します。 このキー BLOB は、セキュリティで保護されていないトランスポート経由で送信することも、セキュリティで保護されていないストレージの場所に格納することもできます。 この関数は、 Schannel セッション キー、通常の セッション キー、 公開キー、または 公開/秘密キーのペアをエクスポートできます。 エクスポートするキー BLOB は、目的の受信者が CryptImportKey 関数を使用してキーまたはキー ペアを受信者の CSP にインポートするまで役に立ちません。

構文

BOOL CryptExportKey(
  [in]      HCRYPTKEY hKey,
  [in]      HCRYPTKEY hExpKey,
  [in]      DWORD     dwBlobType,
  [in]      DWORD     dwFlags,
  [out]     BYTE      *pbData,
  [in, out] DWORD     *pdwDataLen
);

パラメーター

[in] hKey

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

[in] hExpKey

宛先ユーザーの暗号化キーへのハンドル。 エクスポートされたキー BLOB 内の キー データは、このキーを使用して暗号化されます。 これにより、宛先ユーザーのみがキー BLOB を使用できるようになります。 hExpKey と hKey はどちらも同じ CSP から取得する必要があります。

ほとんどの場合、これは宛先ユーザーの キー交換公開キー です。 ただし、一部の CSP の特定のプロトコルでは、宛先ユーザーに属するセッション キーをこの目的で使用する必要があります。

dwBlobType で指定されたキー BLOB の種類が PUBLICKEYBLOB の場合、このパラメーターは使用されず、ゼロに設定する必要があります。

dwBlobType で指定されたキー BLOB の種類が PRIVATEKEYBLOB の場合、これは通常、キー BLOB の暗号化に使用されるセッション キーへのハンドルです。 一部の CSP では、このパラメーターを 0 にできます。この場合、アプリケーションは 秘密キー BLOB を 保護するために手動で暗号化する必要があります。

このパラメーターに対する Microsoft 暗号化サービス プロバイダーの応答方法を確認するには、「Microsoft Cryptographic Service Providers」の秘密キー BLOB セクションを参照してください。

[in] dwBlobType

pbData でエクスポートするキー BLOB の種類を指定します。 これは、「 暗号化キー ストレージと Exchange」で説明されているように、次のいずれかの定数である必要があります。

[in] dwFlags

関数の追加オプションを指定します。 このパラメーターには、0 または次の値の 1 つ以上の組み合わせを指定できます。

[out] pbData

キー BLOB データを受け取るバッファーへのポインター。 この BLOB の形式は、 dwBlobType パラメーターで要求された BLOB の種類によって異なります。 PRIVATEKEYBLOB、PUBLICKEYBLOB、SIMPLEBLOB の形式については、「 基本プロバイダー キー BLOB」を参照してください。

このパラメーターが NULL の場合、必要なバッファー サイズは pdwDataLen パラメーターが指す値に配置されます。 詳細については、「 不明な長さのデータの取得」を参照してください。

[in, out] pdwDataLen

入力時に pbData パラメーターが指すバッファーのサイズ (バイト単位) を含む DWORD 値へのポインター。 関数が戻るとき、この値にはバッファーに格納されているバイト数が含まれます。

戻り値

関数が成功した場合、関数は 0 以外 (TRUE) を返します。

関数が失敗した場合は、0 (FALSE) を返します。 拡張エラー情報については、 GetLastError を呼び出します。

"NTE" の前にあるエラー コードは、使用されている特定の CSP によって生成されます。 次の表に、考えられるエラー コードの一部を示します。

注釈

PLAINTEXTKEYBLOB を使用する DES キー順列の場合、パリティ ビットを含む完全なキー サイズのみをエクスポートできます。 次のキー サイズがサポートされています。

例

次の例は、暗号化キーまたはキー ペアをより安全な方法でエクスポートする方法を示しています。 この例では、暗号化コンテキストが取得され、公開キーがエクスポート可能であることを前提としています。 この関数を使用するための完全なコンテキストを含む例については、「 サンプル C プログラム: ハッシュの署名とハッシュ署名の検証」を参照してください。 この関数を使用する別の例については、「 サンプル C プログラム: セッション キーのエクスポート」を参照してください。

#include <windows.h>
#include <stdio.h>
#include <Wincrypt.h>

BOOL GetExportedKey(
    HCRYPTKEY hKey, 
    DWORD dwBlobType,
    LPBYTE *ppbKeyBlob, 
    LPDWORD pdwBlobLen)
{
    DWORD dwBlobLength;
    *ppbKeyBlob = NULL;
    *pdwBlobLen = 0;

    // Export the public key. Here the public key is exported to a 
    // PUBLICKEYBLOB. This BLOB can be written to a file and
    // sent to another user.

    if(CryptExportKey(   
        hKey,    
        NULL,    
        dwBlobType,
        0,    
        NULL, 
        &dwBlobLength)) 
    {
        printf("Size of the BLOB for the public key determined. \n");
    }
    else
    {
        printf("Error computing BLOB length.\n");
        return FALSE;
    }

    // Allocate memory for the pbKeyBlob.
    if(*ppbKeyBlob = (LPBYTE)malloc(dwBlobLength)) 
    {
        printf("Memory has been allocated for the BLOB. \n");
    }
    else
    {
        printf("Out of memory. \n");
        return FALSE;
    }

    // Do the actual exporting into the key BLOB.
    if(CryptExportKey(   
        hKey, 
        NULL,    
        dwBlobType,    
        0,    
        *ppbKeyBlob,    
        &dwBlobLength))
    {
        printf("Contents have been written to the BLOB. \n");
        *pdwBlobLen = dwBlobLength;
    }
    else
    {
        printf("Error exporting key.\n");
        free(*ppbKeyBlob);
        *ppbKeyBlob = NULL;

        return FALSE;
    }

    return TRUE;
}

要件

こちらもご覧ください

CryptImportKey

キー生成と Exchange 関数