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_LEVELIRQL または DISPATCH_LEVEL IRQL で実行できます。 現在の 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 アプリ]
ターゲット プラットフォーム の ウィンドウズ
ヘッダー bcrypt.h
ライブラリ Bcrypt.lib
DLL Bcrypt.dll

関連項目

BCryptDestroyHash