IX509CertificateRequestCmc::SignatureInformation property

The SignatureInformation property retrieves the IX509SignatureInformation object that contains information about the primary signature used to sign the certificate request. This property is web enabled.

This property is read-only.

Syntax

HRESULT get_SignatureInformation(
  [out]  IX509SignatureInformation **ppValue
);

Property value

Address of a variable that receives a pointer to the IX509SignatureInformation interface.

Error codes

If the function succeeds, the function returns S_OK.

If the function fails, it returns an HRESULT value that indicates the error. Possible values include, but are not limited to, those in the following table. For a list of common error codes, see Common HRESULT Values.

Remarks

The IX509SignatureInformation object contains information about the hash, public key and signature algorithms used for the primary signature that signs the certificate request. A CMC request can have a primary signature plus zero or more certificate-based signatures. Certificate-based signatures can be included in a request if, for example, one or more additional parties must vouch for the identity of the entity requesting the new certificate. You can call the SignerCertificates property to retrieve a collection of these additional certificate-based signatures.

The primary signature is typically created by using the private key that matches the public key in the inner PKCS #10 request object. Because the private key is usually created to enroll a new request in a certificate hierarchy, the primary signature is not certificate-based, and you must call the SignatureInformation property to retrieve it.

If the IX509SignatureInformation object does not exist when the SignatureInformation property is called or creation of the signature was deferred during initialization, this property:

• Retrieves the innermost PKCS #10 request object.
• Retrieves and duplicates the signature information from the inner request.
• Attempts to retrieve the private key associated with the inner PKCS #10 and sets the NullSigned property if no private key can be found.
• Retrieves the hash algorithm, if one is specified, from the template associated with the inner request and sets the HashAlgorithm property.
• Retrieves the asymmetric algorithm, if one is specified, from the private key associated with the inner request and sets the PublicKeyAlgorithm property.
• Retrieves the private key flags from the template and sets the AlternateSignatureAlgorithm if appropriate

You must initialize the CMC request object before calling this property. For more information, see the following topics:

• Initialize
• InitializeDecode
• InitializeFromCertificate
• InitializeFromInnerRequest
• InitializeFromInnerRequestTemplateName
• InitializeFromTemplateName

Requirements

See also

IX509CertificateRequestCmc

IX509CertificateRequestPkcs10

Send comments about this topic to Microsoft

Build date: 10/26/2012