BCryptImportKey 関数 (bcrypt.h)

  • [アーティクル]

BCryptImportKey 関数は、キー BLOB から対称キーをインポートします。 BCryptImportKeyPair 関数は、公開キーと秘密キーのペアをインポートするために使用されます。

構文

NTSTATUS BCryptImportKey(
  [in]            BCRYPT_ALG_HANDLE hAlgorithm,
  [in, optional]  BCRYPT_KEY_HANDLE hImportKey,
  [in]            LPCWSTR           pszBlobType,
  [out]           BCRYPT_KEY_HANDLE *phKey,
  [out, optional] PUCHAR            pbKeyObject,
  [in]            ULONG             cbKeyObject,
  [in]            PUCHAR            pbInput,
  [in]            ULONG             cbInput,
  [in]            ULONG             dwFlags
);

パラメーター

[in] hAlgorithm

キーをインポートするアルゴリズム プロバイダーのハンドル。 このハンドルは、 BCryptOpenAlgorithmProvider 関数を呼び出すことによって取得されます。

[in, optional] hImportKey

pbInput パラメーターでキー BLOB のラップを解除するために必要なキー暗号化キーのハンドル。

メモ ハンドルは、インポートするキーを指定したのと同じプロバイダーによって提供される必要があります。

 

Windows Server 2008 と Windows Vista: このパラメーターは使用されず、 NULL に設定する必要があります。

[in] pszBlobType

pbInput バッファーに含まれる BLOB の種類を指定する識別子を含む null で終わる Unicode 文字列。 次のいずれかの値を指定できます。

値 意味
BCRYPT_AES_WRAP_KEY_BLOB
 AES キーでラップされたキー BLOB から対称キーをインポートします。 hImportKey パラメーターは、キー暗号化キーへの有効なBCRYPT_KEY_HANDLE ポインターを参照する必要があります。

Windows Server 2008 と Windows Vista: この BLOB の種類はサポートされていません。
BCRYPT_KEY_DATA_BLOB
 データ BLOB から対称キーをインポートします。 pbInput パラメーターは、キー BLOB の直後にBCRYPT_KEY_DATA_BLOB_HEADER構造体へのポインターです。
BCRYPT_OPAQUE_KEY_BLOB
 1 つの CSP に固有の形式で対称キー BLOB をインポートします。 不透明 BLOB は転送可能ではなく、BLOB を生成したのと同じ CSP を使用してインポートする必要があります。 不透明 BLOB は、キーのプロセス間転送にのみ使用することを目的としており、プロバイダーのバージョン間で永続化および読み取りを行うのに適していません。

[out] phKey

インポートされたキーのハンドルを受け取る BCRYPT_KEY_HANDLE へのポインター。 このハンドルは、 BCryptEncrypt などのキーを必要とする後続の関数で使用されます。 このハンドルは、 BCryptDestroyKey 関数に渡すことによって不要になったときに解放する必要があります。

[out, optional] pbKeyObject

インポートされたキー オブジェクトを受け取るバッファーへのポインター。 cbKeyObject パラメーターには、このバッファーのサイズが含まれています。 このバッファーの必要なサイズは、 BCryptGetProperty 関数を呼び出して BCRYPT_OBJECT_LENGTH プロパティを取得することで取得できます。 これにより、指定したアルゴリズムのキー オブジェクトのサイズが提供されます。

このメモリは、 phKey キー ハンドルが破棄された後にのみ解放できます。

[in] cbKeyObject

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

[in] pbInput

インポートするキー BLOB を含むバッファーのアドレス。 cbInput パラメーターには、このバッファーのサイズが含まれています。 pszBlobType パラメーターは、このバッファーに含まれるキー BLOB の種類を指定します。

[in] cbInput

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

[in] dwFlags

この関数の動作を変更するフラグのセット。 フラグは現在定義されていないため、このパラメーターは 0 にする必要があります。

戻り値

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

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

リターン コード 説明
STATUS_SUCCESS
 関数は成功しました。
STATUS_BUFFER_TOO_SMALL
 cbKeyObject パラメーターで指定されたキー オブジェクトのサイズが、キー オブジェクトを保持するのに十分な大きさではありません。
STATUS_INVALID_HANDLE
 hAlgorithm パラメーターのアルゴリズム ハンドルが無効です。
STATUS_INVALID_PARAMETER
 1 つ以上のパラメーターが無効です。
STATUS_NOT_SUPPORTED
 hAlgorithm パラメーターで指定されたアルゴリズム プロバイダーは、pszBlobType パラメーターで指定された BLOB 型をサポートしていません。

注釈

プロバイダーがサポートするプロセッサ モードに応じて、 BCryptImportKey を ユーザー モードまたはカーネル モードから呼び出すことができます。 カーネル モードの呼び出し元は、PASSIVE_LEVEL IRQL または IRQL DISPATCH_LEVELで実行できます。 現在の IRQL レベルが DISPATCH_LEVELされている場合、 hAlgorithm パラメーターで指定されたハンドルは 、BCRYPT_PROV_DISPATCH フラグを使用して開かれている必要があります。 また、BCryptImportKey 関数に渡されるすべてのポインターは、非ページ (またはロックされた) メモリを参照する必要があります。

カーネル モードでこの関数を呼び出すには、ドライバー開発キット (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

こちらもご覧ください

BCryptDestroyKey

BCryptExportKey

BCryptImportKeyPair