IX509CertificateRequest interface (certenroll.h)
The IX509CertificateRequest interface represents an abstract base certificate request that identifies methods and properties common to and inherited by each of the request objects implemented by the Certificate Enrollment API. The following list discusses the inheritance structure of these objects:
-
A PKCS #10 certificate request implements the IX509CertificateRequest and IX509CertificateRequestPkcs10 interfaces.
-
PKCS #7 certificate request implements the IX509CertificateRequest and IX509CertificateRequestPkcs7 interfaces.
Although the PKCS #7 specification defines a secure message syntax rather than a type of certificate request, the implementation of the IX509CertificateRequestPkcs7 interface in this SDK requires that it contain a PKCS #10 request. Therefore, this documentation refers to a PKCS #7 object as a certificate request.
-
A CMC (Certificate Management Message over CMS) certificate request implements the IX509CertificateRequest, IX509CertificateRequestPkcs7, and IX509CertificateRequestCmc interfaces.
-
An object that can be used to represent a self-generated certificate (a certificate not issued by a certification authority) implements the IX509CertificateRequest, IX509CertificateRequestPkcs10, and IX509CertificateRequestCertificate interfaces.
Inheritance
The IX509CertificateRequest interface inherits from the IDispatch interface. IX509CertificateRequest also has these types of members:
Methods
The IX509CertificateRequest interface has these methods.
| IX509CertificateRequest::Encode Signs and encodes a certificate request and creates a key pair if one does not exist. |
| IX509CertificateRequest::get_AlternateSignatureAlgorithm Specifies and retrieves a Boolean value that indicates whether the signature algorithm object identifier (OID) for a PKCS (Get) |
| IX509CertificateRequest::get_ClientId Specifies and retrieves a value that identifies the executable that created the request. (Get) |
| IX509CertificateRequest::get_CspInformations Specifies and retrieves a collection of cryptographic providers available for use by the request object. (Get) |
| IX509CertificateRequest::get_EnrollmentContext Retrieves a value that specifies whether the certificate is intended for a computer or a user. |
| IX509CertificateRequest::get_HashAlgorithm Specifies and retrieves the object identifier (OID) of the hash algorithm used to sign the certificate request. (Get) |
| IX509CertificateRequest::get_ParentWindow Specifies and retrieves the ID of the window used by key-related user interface dialogs. (Get) |
| IX509CertificateRequest::get_RawData Retrieves a byte array that contains the signed, Distinguished Encoding Rules (DER) encoded certificate request. |
| IX509CertificateRequest::get_RenewalCertificate Specifies or retrieves a byte array that contains the Distinguished Encoding Rules (DER) encoded certificate that is being renewed. (Get) |
| IX509CertificateRequest::get_Silent Specifies or retrieves a Boolean value that indicates whether any of the key-related modal dialogs are displayed during the certificate enrollment process. (Get) |
| IX509CertificateRequest::get_SuppressDefaults Specifies or retrieves a Boolean value that indicates whether the default extensions and attributes are included in the request. (Get) |
| IX509CertificateRequest::get_Type Retrieves a value that specifies the type of the request object. |
| IX509CertificateRequest::get_UIContextMessage Specifies or retrieves a context string to display in the user interface. (Get) |
| IX509CertificateRequest::GetInnerRequest Retrieves a nested request object. |
| IX509CertificateRequest::Initialize Initializes the request object for a user or a computer. |
| IX509CertificateRequest::put_AlternateSignatureAlgorithm Specifies and retrieves a Boolean value that indicates whether the signature algorithm object identifier (OID) for a PKCS (Put) |
| IX509CertificateRequest::put_ClientId Specifies and retrieves a value that identifies the executable that created the request. (Put) |
| IX509CertificateRequest::put_CspInformations Specifies and retrieves a collection of cryptographic providers available for use by the request object. (Put) |
| IX509CertificateRequest::put_HashAlgorithm Specifies and retrieves the object identifier (OID) of the hash algorithm used to sign the certificate request. (Put) |
| IX509CertificateRequest::put_ParentWindow Specifies and retrieves the ID of the window used by key-related user interface dialogs. (Put) |
| IX509CertificateRequest::put_RenewalCertificate Specifies or retrieves a byte array that contains the Distinguished Encoding Rules (DER) encoded certificate that is being renewed. (Put) |
| IX509CertificateRequest::put_Silent Specifies or retrieves a Boolean value that indicates whether any of the key-related modal dialogs are displayed during the certificate enrollment process. (Put) |
| IX509CertificateRequest::put_SuppressDefaults Specifies or retrieves a Boolean value that indicates whether the default extensions and attributes are included in the request. (Put) |
| IX509CertificateRequest::put_UIContextMessage Specifies or retrieves a context string to display in the user interface. (Put) |
| IX509CertificateRequest::ResetForEncode Restores the state of the request object to that which existed before the Encode method was called. |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista [desktop apps only] |
| Minimum supported server | Windows Server 2008 [desktop apps only] |
| Target Platform | Windows |
| Header | certenroll.h |
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for