BCryptGenerateSymmetricKey 関数 (bcrypt.h)

  • [アーティクル]

BCryptGenerateSymmetricKey 関数は、指定されたキーから対称キー暗号化アルゴリズムで使用するキー オブジェクトを作成します。

構文

NTSTATUS BCryptGenerateSymmetricKey(
  [in, out]       BCRYPT_ALG_HANDLE hAlgorithm,
  [out]           BCRYPT_KEY_HANDLE *phKey,
  [out, optional] PUCHAR            pbKeyObject,
  [in]            ULONG             cbKeyObject,
  [in]            PUCHAR            pbSecret,
  [in]            ULONG             cbSecret,
  [in]            ULONG             dwFlags
);

パラメーター

[in, out] hAlgorithm

BCryptOpenAlgorithmProvider 関数を使用して作成されたアルゴリズム プロバイダーのハンドル。 プロバイダーの作成時に指定されたアルゴリズムは、対称キー暗号化をサポートする必要があります。

[out] phKey

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

[out, optional] pbKeyObject

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

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

このパラメーターの値が NULL で 、cbKeyObject パラメーターの値が 0 の場合、キー オブジェクトのメモリはこの関数によって割り当てられ、解放されます。Windows 7: このメモリ管理機能は、Windows 7 以降で使用できます。

[in] cbKeyObject

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

このパラメーターの値が 0 で 、pbKeyObject パラメーターの値が NULL の場合、この関数によってキー オブジェクトのメモリが割り当てられ、解放されます。Windows 7: このメモリ管理機能は、Windows 7 以降で使用できます。

[in] pbSecret

キー オブジェクトの作成元となるキーを含むバッファーへのポインター。 cbSecret パラメーターには、このバッファーのサイズが含まれています。 これは通常、パスワードまたはその他の再現可能なデータのハッシュです。 渡されたデータがターゲット キー サイズを超えた場合、データは切り捨てられ、超過分は無視されます。

メモ アプリケーションでは、ターゲット キーに必要な正確なバイト数を渡すように強くお勧めします。
 

[in] cbSecret

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

[in] dwFlags

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

戻り値

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

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

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

注釈

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

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