IEnroll4::HashAlgorithmWStr property

[This property is no longer available for use as of Windows Server 2008 and Windows Vista.]

The HashAlgorithmWStr property sets or retrieves only the signature hashing algorithm used to sign the PKCS #10 certification request.

This property was first defined in the IEnroll interface.

This property is read/write.

Syntax

HRESULT put_HashAlgorithmWStr(
  [in]   LPWSTR szwHashAlg
);

HRESULT get_HashAlgorithmWStr(
  [out]  LPWSTR *pszwHashAlg
);

Property value

A pointer to a null-terminated wide character string that contains the hash algorithm. The string can be any object identifier (OID) for a hashing algorithm. The following list shows some possible values. The default value is "SHA1".

• "SHA1"
• "MD2"
• "MD5"

Error codes

If the property access methods put_HashAlgorithmWStr and get_HashAlgorithmWStr succeed, they return S_OK.

Any other HRESULT value indicates that the call failed.

Remarks

This signature hashing algorithm is not to be confused with the hashing algorithm used to sign the certificate. The enrollment control currently supports any OID for hashing algorithms, plus the following display name values: SHA1 (the default), MD2, and MD5. When retrieving this property, the retrieved value is in OID format (that is, SHA1 appears as 1.3.14.3.2.29). When setting this property, the corresponding OID format can be used as an alternative to the text shown for the defined friendly values.

The Certificate Enrollment Control considers the value of the HashAlgorithmWStr property as a hint to the hashing algorithm to use for signing the PKCS #10 certification request. If the cryptographic service provider (CSP) supports the algorithm specified in the HashAlgorithmWStr property, the algorithm will be used. Otherwise, the Certificate Enrollment Control will try to use SHA1. If SHA1 is not supported by the CSP, then MD5 will be tried. If neither SHA1 nor MD5 is supported, the Certificate Enrollment Control will try to use the first hashing algorithm returned from the CSP.

The HashAlgorithmWStr property affects the behavior of the following methods:

• createPKCS10WStr
• createFilePKCS10WStr

If both the HashAlgID and HashAlgorithmWStr properties are set, whichever is last updated will specify which hashing algorithm will be used to sign the PKCS #10 certification request.

Requirements

See also

IEnroll4

Send comments about this topic to Microsoft

Build date: 10/26/2012