Export (0) Print
Expand All

IEnroll2 interface

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

The IEnroll2 interface represents the Certificate Enrollment Control and is used primarily to generate certificate requests.

Inheritance

The IEnroll2 interface has been extended by IEnroll4, which in turn inherits all the methods and properties of the IEnroll2 interface.

Members

The IEnroll2 interface inherits from IEnroll. IEnroll2 also has these types of members:

Methods

The IEnroll2 interface has these methods.

MethodDescription
acceptFilePKCS7WStr

Accepts and processes a PKCS #7 message containing a certificate, then stores the message to a file.

acceptPKCS7Blob

Accepts and processes a PKCS #7 message containing a certificate. The PKCS #7 is input as a parameter.

AddAuthenticatedAttributesToPKCS7Request

Adds authenticated attributes to a PKCS #7 certificate request.

AddCertTypeToRequestWStr

Adds a certificate template to a request (used to support the enterprise certification authority (CA)).

AddExtensionsToRequest

Adds extensions to the certificate request.

AddNameValuePairToSignatureWStr

Adds the name and value pair of an attribute to the request. It is up to the CA to interpret the meaning of the name-value pair.

createFilePKCS10WStr

Creates a base64-encoded PKCS #10 certificate request and saves it in a file.

createPKCS10WStr

Creates a base64-encoded PKCS #10 certificate request.

CreatePKCS7RequestFromRequest

Creates a PKCS #7 request from an existing certificate request.

EnumAlgs

Retrieves the IDs of cryptographic algorithms in a given algorithm class that are supported by the current CSP.

enumContainersWStr

Retrieves the names of the containers for the CSP specified by the ProviderNameWStr property.

enumProvidersWStr

Retrieves the names of the available cryptographic service providers (CSPs) specified by the ProviderType property.

freeRequestInfoBlob

Deletes a certificate context.

get_CAStoreFlags

Retrieves the value of the CAStoreFlags property.

get_CAStoreNameWStr

Retrieves the value of the CAStoreNameWStr property.

get_CAStoreTypeWStr

Retrieves the value of the CAStoreTypeWStr property.

get_ContainerNameWStr

Retrieves the value of the ContainerNameWStr property.

get_DeleteRequestCert

Retrieves the value of the DeleteRequestCert property.

get_EnableSMIMECapabilities

Retrieves the value of the EnableSMIMECapabilities property.

get_EnableT61DNEncoding

Retrieves the value of the EnableT61DNEncoding property.

get_GenKeyFlags

Retrieves the value of the GenKeyFlags property.

get_HashAlgID

Retrieves the value of the HashAlgID property.

get_HashAlgorithmWStr

Retrieves the value of the HashAlgorithmWStr property.

get_KeySpec

Retrieves the value of the KeySpec property.

get_LimitExchangeKeyToEncipherment

Retrieves the value of the LimitExchangeKeyToEncipherment property.

get_MyStoreFlags

Retrieves the value of the MyStoreFlags property.

get_MyStoreNameWStr

Retrieves the value of the MyStoreNameWStr property.

get_MyStoreTypeWStr

Retrieves the value of the MyStoreTypeWStr property.

get_ProviderFlags

Retrieves the value of the ProviderFlags property.

get_ProviderNameWStr

Retrieves the value of the ProviderNameWStr property.

get_ProviderType

Retrieves the value of the ProviderType property.

get_PVKFileNameWStr

Retrieves the value of the PVKFileNameWStr property.

get_RenewalCertificate

Retrieves the value of the RenewalCertificate property.

get_RequestStoreFlags

Retrieves the value of the RequestStoreFlags property.

get_RequestStoreNameWStr

Retrieves the value of the RequestStoreNameWStr property.

get_RequestStoreTypeWStr

Retrieves the value of the RequestStoreTypeWStr property.

get_ReuseHardwareKeyIfUnableToGenNew

Retrieves the value of the ReuseHardwareKeyIfUnableToGenNew property.

get_RootStoreFlags

Retrieves the value of the RootStoreFlags property.

get_RootStoreNameWStr

Retrieves the value of the RootStoreNameWStr property.

get_RootStoreTypeWStr

Retrieves the value of the RootStoreTypeWStr property.

get_SPCFileNameWStr

Retrieves the value of the SPCFileNameWStr property.

get_UseExistingKeySet

Retrieves the value of the UseExistingKeySet property.

get_WriteCertToCSP

Retrieves the value of the WriteCertToCSP property.

get_WriteCertToUserDS

Retrieves the value of the WriteCertToUserDS property.

GetAlgNameWStr

Retrieves the name of a cryptographic algorithm given its ID. The values retrieved by this method depend on the current CSP.

getCAStore

Reserved for future use.

getCertContextFromPKCS7

Retrieves the certificate, contained in a PKCS #7 message, that was issued in response to a PKCS #10 certificate request.

GetKeyLen

Retrieves the minimum and maximum key lengths for the signature and exchange keys.

getMyStore

Reserved for future use.

getROOTHStore

Reserved for future use.

GetSupportedKeySpec

Retrieves information regarding the CSP's support for signature or exchange keys.

InstallPKCS7Blob

Processes a certificate or chain of certificates, placing them into the appropriate certificate stores. This method differs from the acceptPKCS7Blob method in that InstallPKCS7Blob does not receive a request certificate.

put_CAStoreFlags

Sets the value of the CAStoreFlags property.

put_CAStoreNameWStr

Sets the value of the CAStoreNameWStr property.

put_CAStoreTypeWStr

Sets the value of the CAStoreTypeWStr property.

put_ContainerNameWStr

Sets the value of the ContainerNameWStr property.

put_DeleteRequestCert

Sets the value of the DeleteRequestCert property.

put_EnableSMIMECapabilities

Sets the value of the EnableSMIMECapabilities property.

put_EnableT61DNEncoding

Sets the value of the EnableT61DNEncoding property.

put_GenKeyFlags

Sets the value of the GenKeyFlags property.

put_HashAlgID

Sets the value of the HashAlgID property.

put_HashAlgorithmWStr

Sets the value of the HashAlgorithmWStr property.

put_KeySpec

Sets the value of the KeySpec property.

put_LimitExchangeKeyToEncipherment

Sets the value of the LimitExchangeKeyToEncipherment property.

put_MyStoreFlags

Sets the value of the MyStoreFlags property.

put_MyStoreNameWStr

Sets the value of the MyStoreNameWStr property.

put_MyStoreTypeWStr

Sets the value of the MyStoreTypeWStr property.

put_ProviderFlags

Sets the value of the ProviderFlags property.

put_ProviderNameWStr

Sets the value of the ProviderNameWStr property.

put_ProviderType

Sets the value of the ProviderType property.

put_PVKFileNameWStr

Sets the value of the PVKFileNameWStr property.

put_RenewalCertificate

Sets the value of the RenewalCertificate property.

put_RequestStoreFlags

Sets the value of the RequestStoreFlags property.

put_RequestStoreNameWStr

Sets the value of the RequestStoreNameWStr property.

put_RequestStoreTypeWStr

Sets the value of the RequestStoreTypeWStr property.

put_ReuseHardwareKeyIfUnableToGenNew

Sets the value of the ReuseHardwareKeyIfUnableToGenNew property.

put_RootStoreFlags

Sets the value of the RootStoreFlags property.

put_RootStoreNameWStr

Sets the value of the RootStoreNameWStr property.

put_RootStoreTypeWStr

Sets the value of the RootStoreTypeWStr property.

put_SPCFileNameWStr

Sets the value of the SPCFileNameWStr property.

put_UseExistingKeySet

Sets the value of the UseExistingKeySet property.

put_WriteCertToCSP

Sets the value of the WriteCertToCSP property.

put_WriteCertToUserDS

Sets the value of the WriteCertToUserDS property.

Reset

Returns the certificate enrollment control object to its initial state.

SetHStoreCA

Specifies the handle to use for the CA store.

SetHStoreMy

Specifies the handle to use for the MY store.

SetHStoreRequest

Specifies the handle to use for the request store.

SetHStoreROOT

Specifies the handle to use for the ROOT store.

 

Properties

The IEnroll2 interface has these properties.

PropertyDescription

CAStoreFlags

Sets or retrieves a flag that controls the certificate store when it is opened.

CAStoreNameWStr

Sets or retrieves the name of the store where all non-"ROOT" and non-"MY" certificates are kept.

CAStoreTypeWStr

Sets or retrieves the type of store to use for the store specified by the CAStoreNameWStr property.

ContainerNameWStr

Sets or retrieves the name of the key container to use.

DeleteRequestCert

Sets or retrieves a Boolean indicator that controls whether dummy certificates in the request store are deleted.

EnableSMIMECapabilities

Sets or retrieves a Boolean value that controls whether the PKCS #10 will contain a signed attribute for Secure/Multipurpose Internet Mail Extensions (S/MIME) capabilities.

EnableT61DNEncoding

Sets or retrieves a Boolean value that controls whether the distinguished name in the request is encoded as a T61 string instead of as a UNICODE string.

GenKeyFlags

Sets or retrieves the values passed to CryptGenKey when the certificate request is generated.

HashAlgID

Sets or retrieves the hash algorithm used when signing a PKCS #10 certificate request.

HashAlgorithmWStr

Sets or retrieves only the signature hash algorithm used to sign the PKCS #10.

KeySpec

Sets or retrieves the type of key generated.

LimitExchangeKeyToEncipherment

Sets or retrieves a Boolean value that controls whether an AT_KEYEXCHANGE request contains digital signature and non-repudiation key usages.

MyStoreFlags

Sets or retrieves the registry location used for the MY store.

MyStoreNameWStr

Sets or retrieves the name of the store where certificates with linked private keys are kept.

MyStoreTypeWStr

Sets or retrieves the type of store specified by the MyStoreNameWStr property.

ProviderFlags

Sets or retrieves the CSP type.

ProviderNameWStr

Sets or retrieves the name of the CSP to use.

ProviderType

Sets or retrieves the type of provider.

PVKFileNameWStr

Sets or retrieves the name of the file that will contain exported keys.

RenewalCertificate

Specifies the certificate context for the renewal certificate.

RequestStoreFlags

Sets or retrieves the registry location used for the REQUEST store.

RequestStoreNameWStr

Sets or retrieves the name of the store that contains the dummy certificate. This dummy certificate, along with the added private keys, remains in the request store until a certification authority processes the request and responds with a PKCS #7.

RequestStoreTypeWStr

Sets or retrieves the type of store to use for the store specified by the RequestStoreNameWStr property.

ReuseHardwareKeyIfUnableToGenNew

Sets or retrieves a Boolean value that determines the action taken by the certificate enrollment control object if an error is encountered when generating a new key.

RootStoreFlags

Sets or retrieves the registry location used for the ROOT store.

RootStoreNameWStr

Sets or retrieves the name of the root store where all intrinsically trusted self-signed ROOT certificates are kept.

RootStoreTypeWStr

Sets or retrieves the type of store to use for the store specified by the RootStoreNameWStr property.

SPCFileNameWStr

Sets or retrieves the name of the file to write the resulting base64-encoded PKCS #7 as returned from the certification authority.

UseExistingKeySet

Sets or retrieves a Boolean value that indicates whether the existing keys should be used.

WriteCertToCSP

Sets or retrieves a Boolean value that indicates whether a certificate should be written to the CSP.

WriteCertToUserDS

Sets or retrieves a Boolean value that controls whether the certificate is written to the user's Active Directory store.

 

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

End of client support

Windows XP

End of server support

Windows Server 2003

Header

Xenroll.h

Library

Uuid.lib

DLL

Xenroll.dll

IID

IID_IEnroll2 is defined as c080e199-b7df-11d2-a421-00c04f79fe8e

 

 

Community Additions

ADD
Show:
© 2014 Microsoft