CryptHashPublicKeyInfo function
Applies to: desktop apps only
The CryptHashPublicKeyInfo function encodes the public key information in a CERT_PUBLIC_KEY_INFO structure and computes the hash of the encoded bytes. The hash created is used with key identifier functions.
Syntax
BOOL WINAPI CryptHashPublicKeyInfo( __in HCRYPTPROV_LEGACY hCryptProv, __in ALG_ID Algid, __in DWORD dwFlags, __in DWORD dwCertEncodingType, __in PCERT_PUBLIC_KEY_INFO pInfo, __out BYTE *pbComputedHash, __inout DWORD *pcbComputedHash );
Parameters
- hCryptProv [in]
-
This parameter is not used and should be set to NULL.
Windows Server 2003, Windows XP, and Windows 2000: A handle of the cryptographic service provider (CSP) to use to compute the hash.This parameter's data type is HCRYPTPROV.
Unless there is a strong reason for passing in a specific cryptographic provider in hCryptProv, zero is passed in. Passing in zero causes the default RSA or Digital Signature Standard (DSS) provider to be acquired before doing hash, signature verification, or recipient encryption operations.
- Algid [in]
-
An ALG_ID structure that specifies the CryptoAPI hash algorithm to use. If Algid is zero, the default hash algorithm, SHA1, is used.
- dwFlags [in]
-
Values to be passed on to CryptCreateHash.
- dwCertEncodingType [in]
-
Specifies the encoding type used. It is always acceptable to specify both the certificate and message encoding types by combining them with a bitwise-OR operation as shown in the following example:
X509_ASN_ENCODING | PKCS_7_ASN_ENCODING
Currently defined encoding types are:
- X509_ASN_ENCODING
- PKCS_7_ASN_ENCODING
- pInfo [in]
-
A pointer to a CERT_PUBLIC_KEY_INFO structure that contains the public key information to be encoded and hashed.
- pbComputedHash [out]
-
A pointer to a buffer to receive the computed hash.
To set the size of this information for memory allocation purposes, this parameter can be NULL. For more information, see Retrieving Data of Unknown Length.
- pcbComputedHash [in, out]
-
A pointer to a DWORD that contains the size, in bytes, of the buffer pointed to by the pbComputedHash parameter. When the function returns, the DWORD contains the number of bytes stored in the buffer.
Note When processing the data returned in the buffer, applications need to use the actual size of the data returned. The actual size can be slightly smaller than the size of the buffer specified on input. On input, buffer sizes are usually specified large enough to ensure that the largest possible output data will fit in the buffer. On output, the variable pointed to by this parameter is updated to reflect the actual size of the data copied to the buffer.
Return value
If the function succeeds, the function returns nonzero (TRUE).
If the function fails, it returns zero (FALSE). For extended error information, call GetLastError.
Note Errors from the called functions CryptCreateHash, CryptGetHashParam, and CryptHashData can be propagated to this function. This function has the following error codes.
| Return code | Description |
|---|---|
|
If the buffer specified by the pbComputedHash parameter is not large enough to hold the returned data, the function sets the ERROR_MORE_DATA code, and stores the required buffer size, in bytes, in the variable pointed to by pcbComputedHash. |
|
Invalid certificate encoding type. Currently only X509_ASN_ENCODING is supported. |
If the function fails, GetLastError may return an Abstract Syntax Notation One (ASN.1) encoding/decoding error. For information about these errors, see ASN.1 Encoding/Decoding Return Values.
Requirements
|
Minimum supported client | Windows 2000 Professional |
|---|---|
|
Minimum supported server | Windows 2000 Server |
|
Header |
|
|
Library |
|
|
DLL |
|
See also
Send comments about this topic to Microsoft
Build date: 3/6/2012
