BCryptCreateHash 関数 (bcrypt.h)

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

構文

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

パラメーター

[in, out] hAlgorithm

ハッシュまたは MAC インターフェイスをサポートするアルゴリズム プロバイダーのハンドル。 このハンドルは 、BCryptOpenAlgorithmProvider 関数を呼び出すことによって取得されるか、 CNG アルゴリズム擬似ハンドルである場合があります。

[out] phHash

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

[out, optional] pbHashObject

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

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

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

[in] cbHashObject

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

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

[in, optional] pbSecret

MAC に使用するキーを含むバッファーへのポインター。 cbSecret パラメーターには、このバッファーのサイズが含まれています。 ハッシュ アルゴリズムと共に使用する場合は、BCryptOpenAlgorithmProvider の BCRYPT_ALG_HANDLE_HMAC フラグを使用して、アルゴリズムを HMAC に昇格する必要があります。

ハッシュを計算するには、このパラメーターを NULL に設定します。

[in] cbSecret

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

[in] dwFlags

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

戻り値

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

可能な戻りコードには、以下が含まれますが、これらに限定されません。

備考

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

オブジェクトが使用されなくなった場合、呼び出し元は BCryptDestroyHash で phHash を解放する必要があります。

カーネル モードでこの関数を呼び出すには、ドライバー開発キット (DDK) の一部である Cng.libを使用します。 Windows Server 2008 と Windows Vista: カーネル モードでこの関数を呼び出すには、 Ksecdd.libを使用します。

必要条件

関連項目

BCryptDuplicateHash

BCryptHashData

BCryptFinishHash

BCryptDestroyHash