IX509PrivateKey interface (certenroll.h)
The IX509PrivateKey interface represents an asymmetric private key that can be used for encryption, signing, and key agreement. Private keys are referenced in the following objects:
Inheritance
The IX509PrivateKey interface inherits from the IDispatch interface. IX509PrivateKey also has these types of members:
Methods
The IX509PrivateKey interface has these methods.
| IX509PrivateKey::Close Releases the handle of the cryptographic service provider (CSP) or the handle of the Cryptography API:_Next Generation (CNG) key storage provider (KSP). |
| IX509PrivateKey::Create Creates an asymmetric private key. |
| IX509PrivateKey::Delete Releases the handle of the cryptographic service provider (CSP) or the handle of the Cryptography API:_Next Generation (CNG) key storage provider (KSP) and deletes the key from disk or smart card. |
| IX509PrivateKey::Export Copies the private key to a byte array. |
| IX509PrivateKey::ExportPublicKey Exports the public key portion of the asymmetric key pair. |
| IX509PrivateKey::get_Algorithm Specifies or retrieves an object identifier (OID) for the public key algorithm. (Get) |
| IX509PrivateKey::get_Certificate Specifies or retrieves a byte array that contains the certificate associated with the private key. (Get) |
| IX509PrivateKey::get_ContainerName Specifies or retrieves the name of the key container. (Get) |
| IX509PrivateKey::get_ContainerNamePrefix Specifies or retrieves a prefix added to the name of the key container. (Get) |
| IX509PrivateKey::get_CspInformations Specifies or retrieves a collection of ICspInformation objects that contain information about the available cryptographic providers that support the public key algorithm associated with the private key. (Get) |
| IX509PrivateKey::get_CspStatus Specifies or retrieves an ICspStatus object that contains information about the cryptographic provider and algorithm pair associated with the private key. (Get) |
| IX509PrivateKey::get_DefaultContainer Retrieves a Boolean value that specifies whether the private key represents the default key container. |
| IX509PrivateKey::get_Description Specifies or retrieves a string that contains a description of the private key. (Get) |
| IX509PrivateKey::get_Existing Specifies or retrieves a Boolean value that indicates whether the private key has been created or imported. (Get) |
| IX509PrivateKey::get_ExportPolicy Specifies or retrieves export constraints for a private key. (Get) |
| IX509PrivateKey::get_FriendlyName Specifies or retrieves a display name for the private key. (Get) |
| IX509PrivateKey::get_KeyProtection Specifies or retrieves a value that indicates how a private key is protected before use. (Get) |
| IX509PrivateKey::get_KeySpec Specifies or retrieves a value that identifies whether a private key can be used for signing, or encryption, or both. (Get) |
| IX509PrivateKey::get_KeyUsage Specifies or retrieves a value that identifies the specific purpose for which a private key can be used. (Get) |
| IX509PrivateKey::get_LegacyCsp Specifies or retrieves a Boolean value that indicates whether the provider is a CryptoAPI (legacy) cryptographic service provider (CSP). (Get) |
| IX509PrivateKey::get_Length Specifies or retrieves the length, in bits, of the private key. (Get) |
| IX509PrivateKey::get_MachineContext Specifies or retrieves a Boolean value that identifies the local certificate store context. (Get) |
| IX509PrivateKey::get_Opened Retrieves a Boolean value that specifies whether the private key is open. |
| IX509PrivateKey::get_ParentWindow Specifies or retrieves the ID of the window used to display key information. (Get) |
| IX509PrivateKey::get_ProviderName Specifies or retrieves the name of the cryptographic provider. (Get) |
| IX509PrivateKey::get_ProviderType Specifies or retrieves the type of cryptographic provider associated with the private key. (Get) |
| IX509PrivateKey::get_ReaderName Specifies or retrieves the name of a smart card reader. (Get) |
| IX509PrivateKey::get_SecurityDescriptor Specifies or retrieves the security descriptor for the private key. (Get) |
| IX509PrivateKey::get_Silent Specifies or retrieves a Boolean value that indicates whether the Certificate Enrollment Control is allowed to display a dialog box when the private key is accessed. (Get) |
| IX509PrivateKey::get_UIContextMessage Specifies or retrieves a string that contains user interface text associated with the private key. (Get) |
| IX509PrivateKey::get_UniqueContainerName Retrieves a unique name for the key container. |
| IX509PrivateKey::Import Imports an existing private key into a key container within a cryptographic provider. |
| IX509PrivateKey::Open Opens an existing private key. |
| IX509PrivateKey::put_Algorithm Specifies or retrieves an object identifier (OID) for the public key algorithm. (Put) |
| IX509PrivateKey::put_Certificate Specifies or retrieves a byte array that contains the certificate associated with the private key. (Put) |
| IX509PrivateKey::put_ContainerName Specifies or retrieves the name of the key container. (Put) |
| IX509PrivateKey::put_ContainerNamePrefix Specifies or retrieves a prefix added to the name of the key container. (Put) |
| IX509PrivateKey::put_CspInformations Specifies or retrieves a collection of ICspInformation objects that contain information about the available cryptographic providers that support the public key algorithm associated with the private key. (Put) |
| IX509PrivateKey::put_CspStatus Specifies or retrieves an ICspStatus object that contains information about the cryptographic provider and algorithm pair associated with the private key. (Put) |
| IX509PrivateKey::put_Description Specifies or retrieves a string that contains a description of the private key. (Put) |
| IX509PrivateKey::put_Existing Specifies or retrieves a Boolean value that indicates whether the private key has been created or imported. (Put) |
| IX509PrivateKey::put_ExportPolicy Specifies or retrieves export constraints for a private key. (Put) |
| IX509PrivateKey::put_FriendlyName Specifies or retrieves a display name for the private key. (Put) |
| IX509PrivateKey::put_KeyProtection Specifies or retrieves a value that indicates how a private key is protected before use. (Put) |
| IX509PrivateKey::put_KeySpec Specifies or retrieves a value that identifies whether a private key can be used for signing, or encryption, or both. (Put) |
| IX509PrivateKey::put_KeyUsage Specifies or retrieves a value that identifies the specific purpose for which a private key can be used. (Put) |
| IX509PrivateKey::put_LegacyCsp Specifies or retrieves a Boolean value that indicates whether the provider is a CryptoAPI (legacy) cryptographic service provider (CSP). (Put) |
| IX509PrivateKey::put_Length Specifies or retrieves the length, in bits, of the private key. (Put) |
| IX509PrivateKey::put_MachineContext Specifies or retrieves a Boolean value that identifies the local certificate store context. (Put) |
| IX509PrivateKey::put_ParentWindow Specifies or retrieves the ID of the window used to display key information. (Put) |
| IX509PrivateKey::put_Pin Specifies a personal identification number (PIN) that is used to authenticate users prior to accessing a private key container on a smart card. |
| IX509PrivateKey::put_ProviderName Specifies or retrieves the name of the cryptographic provider. (Put) |
| IX509PrivateKey::put_ProviderType Specifies or retrieves the type of cryptographic provider associated with the private key. (Put) |
| IX509PrivateKey::put_ReaderName Specifies or retrieves the name of a smart card reader. (Put) |
| IX509PrivateKey::put_SecurityDescriptor Specifies or retrieves the security descriptor for the private key. (Put) |
| IX509PrivateKey::put_Silent Specifies or retrieves a Boolean value that indicates whether the Certificate Enrollment Control is allowed to display a dialog box when the private key is accessed. (Put) |
| IX509PrivateKey::put_UIContextMessage Specifies or retrieves a string that contains user interface text associated with the private key. (Put) |
| IX509PrivateKey::Verify Verifies that a private key exists and can be used by the client but does not open the key. |
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 |