Share via

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 值的指標。 此句柄用於後續的哈希或 MAC 函式，例如 BCryptHashData 函式。 當您完成使用此句柄時，請將它傳遞至 BCryptDestroyHash 函式來釋放它。

[out] pbHashObject

接收哈希或 MAC 物件的緩衝區指標。 cbHashObject 參數包含這個緩衝區的大小。 呼叫 BCryptGetProperty 函式以取得此緩衝區的必要大小，以取得 BCRYPT_OBJECT_LENGTH 屬性。 這會為指定的演算法提供哈希或 MAC 物件的大小。

只有在 phHash 參數指向的句柄被終結之後，才能釋放此記憶體。

如果此參數的值是 NULL ，而 cbHashObject 參數的值是零，則哈希物件的記憶體會由此函式配置並釋放。 Windows 7： 從 Windows 7 開始，可以使用此記憶體管理功能。

[in, optional] cbHashObject

pbHashObject 緩衝區的大小，以位元組為單位。

如果此參數的值是零，而且 pbHashObject 參數的值是 NULL，則此函式會配置並釋放索引鍵物件的記憶體。 Windows 7： 從 Windows 7 開始，可以使用此記憶體管理功能。

[in, optional] pbSecret

緩衝區的指標，其中包含要用於哈希或MAC的索引鍵。 cbSecret 參數包含這個緩衝區的大小。 此金鑰只適用於 BCryptOpenAlgorithmProvider 函式使用 BCRYPT_ALG_HANDLE_HMAC_FLAG 旗標所開啟的哈希演算法。 否則，請將此參數設定為 NULL。

[in] cbSecret

pbSecret 緩衝區的大小，以位元組為單位。 如果未使用任何索引鍵，請將此參數設定為零。

[in] dwFlags

修改函式行為的旗標。 這可以是零或下列值。

值 意義
BCRYPT_HASH_REUSABLE_FLAG
 建立可重複使用的哈希物件。 對象可以在呼叫 BCryptFinishHash 之後立即用於新的哈希作業。 如需詳細資訊，請參閱 使用 CNG 建立哈希。

Windows Server 2008 R2、Windows 7、Windows Server 2008 和 Windows Vista： 不支援此旗標。

傳回值

傳回狀態代碼，指出函式的成功或失敗。

可能的傳回碼包括但不限於下列各項。

傳回碼 Description
STATUS_SUCCESS
 函式成功。
STATUS_BUFFER_TOO_SMALL
 cbHashObject 參數所指定的哈希物件大小不足以保存哈希物件。
STATUS_INVALID_HANDLE
 hAlgorithm 參數中的演算法句柄無效。
STATUS_INVALID_PARAMETER
 一或多個參數無效。
STATUS_NOT_SUPPORTED
 hAlgorithm 參數指定的演算法提供者不支援哈希介面。

備註

根據提供者支持的處理器模式， BCryptCreateHash 可以從使用者模式或核心模式呼叫。 核心模式呼叫端可以在 IRQL PASSIVE_LEVEL 或DISPATCH_LEVELIRQL 上執行。 如果目前的 IRQL 層級 DISPATCH_LEVEL， 則 hAlgorithm 參數中提供的句柄必須使用 BCRYPT_PROV_DISPATCH 旗標開啟，而且傳遞至 BCryptCreateHash 函式的任何指標都必須參考非分頁 (或鎖定) 記憶體。

若要在核心模式中呼叫此函式，請使用 Cng.lib，這是驅動程式開發工具包 (DDK) 的一部分。 如需詳細資訊，請參閱 WDK 和開發人員工具。Windows Server 2008 和 Windows Vista： 若要在核心模式中呼叫此函式，請使用 Ksecdd.lib。

規格需求

需求 值
最低支援的用戶端 Windows Vista [傳統型應用程式 |UWP 應用程式]
最低支援的伺服器 Windows Server 2008 [傳統型應用程式 |UWP 應用程式]
目標平台 Windows
標頭 bcrypt.h
程式庫 Bcrypt.lib
Dll Bcrypt.dll

另請參閱

BCryptDestroyHash