BCryptCreateHash 関数 (bcrypt.h)

  • [アーティクル]

BCryptCreateHash 関数は、ハッシュまたはメッセージ認証コード (MAC) オブジェクトを作成するために呼び出されます。

構文

NTSTATUS BCryptCreateHash(
  [in, out]      BCRYPT_ALG_HANDLE  hAlgorithm,
  [out]          BCRYPT_HASH_HANDLE *phHash,
  [out]          PUCHAR             pbHashObject,
  [in, optional] ULONG              cbHashObject,
  [in, optional] PUCHAR             pbSecret,
  [in]           ULONG              cbSecret,
  [in]           ULONG              dwFlags
);

パラメーター

[in, out] hAlgorithm

BCryptOpenAlgorithmProvider 関数を使用して作成されたアルゴリズム プロバイダーのハンドル。 プロバイダーの作成時に指定されたアルゴリズムは、ハッシュ インターフェイスをサポートする必要があります。

[out] phHash

ハッシュまたは MAC オブジェクトを表 すハンドルを受け取るBCRYPT_HASH_HANDLE値へのポインター。 このハンドルは、 BCryptHashData 関数などの後続のハッシュ関数または MAC 関数で使用されます。 このハンドルの使用が完了したら、 BCryptDestroyHash 関数に渡して解放します。

[out] pbHashObject

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

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

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

[in, optional] cbHashObject

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

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

[in, optional] pbSecret

ハッシュまたは MAC に使用するキーを含むバッファーへのポインター。 cbSecret パラメーターには、このバッファーのサイズが含まれています。 このキーは、BCRYPT_ALG_HANDLE_HMAC_FLAG フラグを使用して BCryptOpenAlgorithmProvider 関数によって開かれたハッシュ アルゴリズムにのみ適用されます。 それ以外の場合は、このパラメーターを NULL に設定 します。

[in] cbSecret

pbSecret バッファーのサイズ (バイト単位)。 キーが使用されていない場合は、このパラメーターを 0 に設定します。

[in] dwFlags

関数の動作を変更するフラグ。 0 または次の値を指定できます。

値 意味
BCRYPT_HASH_REUSABLE_FLAG
 再利用可能なハッシュ オブジェクトを作成します。 オブジェクトは、 BCryptFinishHash を呼び出した直後に新しいハッシュ操作に使用できます。 詳細については、「 CNG を使用したハッシュの作成」を参照してください。

Windows Server 2008 R2、Windows 7、Windows Server 2008、Windows Vista: このフラグはサポートされていません。

戻り値

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

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

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

注釈

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

カーネル モードでこの関数を呼び出すには、ドライバー開発キット (DDK) の一部である Cng.lib を使用します。 詳細については、「 WDK と開発者ツール」を参照してください。Windows Server 2008 と Windows Vista: カーネル モードでこの関数を呼び出すには、Ksecdd.lib を使用します。

要件

要件 値
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ | UWP アプリ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリ | UWP アプリ]
対象プラットフォーム Windows
ヘッダー bcrypt.h
Library Bcrypt.lib
[DLL] Bcrypt.dll

こちらもご覧ください

BCryptDestroyHash