CryptHashMessage 函式 (wincrypt.h)

發行項
03/03/2024

CryptHashMessage 函式會建立訊息的哈希。

語法

BOOL CryptHashMessage(
  [in]                PCRYPT_HASH_MESSAGE_PARA pHashPara,
  [in]                BOOL                     fDetachedHash,
  [in]                DWORD                    cToBeHashed,
  [in]                const BYTE * []          rgpbToBeHashed,
  [in]                DWORD []                 rgcbToBeHashed,
  [out]               BYTE                     *pbHashedBlob,
  [in, out]           DWORD                    *pcbHashedBlob,
  [out, optional]     BYTE                     *pbComputedHash,
  [in, out, optional] DWORD                    *pcbComputedHash
);

參數

[in] pHashPara

包含哈希參數之CRYPT_HASH_MESSAGE_PARA 結構的指標。

[in] fDetachedHash

如果此參數設定為 TRUE，則只有 pbComputedHash 會以 pbHashedBlob 編碼。否則，會編碼 rgpbToBeHashed 和 pbComputedHash 。

[in] cToBeHashed

rgpbToBeHashed 和 rgcbToBeHashed 中的陣列元素數目。除非 fDetachedHash 設定為 TRUE，否則此參數只能是一個。

[in] rgpbToBeHashed

緩衝區的指標陣列，其中包含要哈希的內容。

[in] rgcbToBeHashed

由 rgpbToBeHashed 指向之緩衝區的大小陣列，以位元組為單位。

[out] pbHashedBlob

緩衝區的指標，用來接收編碼以進行傳輸的哈希訊息。

如果額外的處理不需要哈希訊息，或為記憶體配置目的設定哈希訊息的大小，這個參數可以是 NULL 。如果此參數為 NULL，則不會傳回哈希訊息。如需詳細資訊，請參閱擷取未知長度的數據。

[in, out] pcbHashedBlob

DWORD 的指標，指定 pbHashedBlob 參數所指向之緩衝區的大小，以位元組為單位。當函式傳回時，此變數會包含已解密訊息的大小，以位元組為單位，複製到 pbHashedBlob。此參數必須是 DWORD 的位址，而不是 NULL ，否則不會傳回緩衝區的長度。

注意處理傳回的數據時，應用程式必須使用所傳回數據的實際大小。實際大小可能會稍微小於輸入中指定的緩衝區大小。在輸入時，緩衝區大小通常會指定夠大，以確保最大可能的輸出數據會放入緩衝區中。在輸出時，會更新此參數所指向的變數，以反映複製到緩衝區的數據實際大小。

[out, optional] pbComputedHash

要接收新建立哈希值的緩衝區指標。如果不需要新建立的哈希進行其他處理，或為記憶體配置目的設定哈希的大小，這個參數可以是 NULL 。如需詳細資訊，請參閱擷取未知長度的數據。

[in, out, optional] pcbComputedHash

DWORD 的指標，指定 pbComputedHash 參數所指向緩衝區的大小，以位元組為單位。當函式傳回時，此 DWORD 會包含新建立哈希的大小，以位元組為單位，複製到 pbComputedHash。

傳回值

如果函式成功，函式會傳回非零 (TRUE) 。

如果函式失敗，它會傳回零 (FALSE) 。如需擴充的錯誤資訊，請呼叫 GetLastError。

注意來自所呼叫函式 CryptCreateHash、CryptHashData 和 CryptGetHashParam 的錯誤可能會傳播至此函式。

GetLastError 函式最常傳回下列錯誤碼。

傳回碼	Description
E_INVALIDARG	訊息編碼類型無效。目前僅支援PKCS_7_ASN_ENCODING。 *pHashPara 中的 cbSize 無效。
ERROR_MORE_DATA	如果 pbHashedBlob 參數指定的緩衝區不足以保存傳回的數據，函式會設定ERROR_MORE_DATA程式代碼，並將所需的緩衝區大小以位元組為單位儲存到 pbHashedBlob 所指向的變數中。

如果函式失敗， GetLastError 可能會傳回抽象語法表示法 1 (ASN.1) 編碼/譯碼錯誤。如需這些錯誤的相關信息，請參閱 ASN.1 編碼/譯碼傳回值。

規格需求

需求	值
最低支援的用戶端	Windows XP [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2003 [僅限桌面應用程式]
目標平台	Windows
標頭	wincrypt.h
程式庫	Crypt32.lib
Dll	Crypt32.dll

另請參閱

CryptVerifyDetachedMessageHash

CryptVerifyMessageHash

簡化的訊息函式

CryptHashMessage 函式 (wincrypt.h)

語法

參數

傳回值

規格需求

另請參閱

意見反應

意見反應

其他資源