CertMgr Bean

Properties Methods Events Configuration Settings Errors

The CertMgr component is used to manage the digital certificates installed on a system.

Syntax

IPWorksOpenPGP.Certmgr

Remarks

The bean methods, such as ListCertificateStores or ListStoreCertificates, are used to list certificate stores and certificates. The corresponding lists are returned via the StoreList and CertList events. Encoded certificates are provided through the events.

You can load a certificate by setting the Cert property of the bean, then you can get information about the certificate through the corresponding fields of the Cert property (described below).

The Subject, SerialNumber, and Issuer fields identify the certificate. The EffectiveDate and ExpirationDate show the time boundaries of the certificate.

PublicKey, PublicKeyAlgorithm, PublicKeyLength, and Version provide information about the certificate keys and the certificate format (version).

UsageFlags specifies the intended usage of the certificate. The Usage field provides a text description of these flags.

Property List

The following is the full list of the properties of the bean with short descriptions. Click on the links for further details.


Cert	The current selected certificate.
CertExtensions	A list of extensions used by the currently selected certificate.
CertStore	The certificate store to search for certificates.
CertStorePassword	The password for the certificate store (if any).
CertStoreType	The type of certificate store for CertStore .

Method List

The following is the full list of the methods of the bean with short descriptions. Click on the links for further details.


config	Sets or retrieves a configuration setting .
createCertificate	Creates a new self-signed certificate in the current store.
createKey	Creates a new keyset associated with the provided name.
deleteCertificate	Deletes the currently selected certificate from the store.
deleteKey	Deletes the keyset associated with the provided name.
exportCertificate	Saves the current certificate to a PFX file.
generateCSR	Generates a new CSR to be sent to a signing authority.
importCertificate	Imports a certificate from a PFX file into the current certificate store.
importSignedCSR	Imports a signed CSR.
issueCertificate	Creates a new certificate in the current store, signed by the selected certificate.
listCertificateStores	Lists certificate stores.
listKeys	List keysets in a CSP.
listMachineStores	List machine certificate stores.
listStoreCertificates	List certificates in a store.
readCertificate	Loads a certificate from a file.
reset	Resets all certificate properties to their default values.
saveCertificate	Saves the current certificate to a file.
showCertificateChain	Show certificate chain.
signCSR	Creates a signed certificate from a CSR.

Event List

The following is the full list of the events fired by the bean with short descriptions. Click on the links for further details.


CertChain	Shows the certificate chain for the certificate (see the ShowCertificateChain method).
CertList	Lists the certificates in a store (see the ListStoreCertificates method).
Error	Information about errors during data delivery.
KeyList	Lists the keysets in a CSP (see the ListKeys method).
StoreList	Lists the system certificate stores (see the ListCertificateStores and ListMachineStores methods).

Configuration Settings

The following is a list of configuration settings for the bean with short descriptions. Click on the links for further details.


CertComment	A comment to include in a saved certificate.
CertCustomExtensionCount	The number of records in the CertCustomExtension arrays.
CertCustomExtensionCritical[i]	Whether or not the extension is defined as critical.
CertCustomExtensionOID[i]	The ASN of the extension at index 'i'.
CertCustomExtensionValue[i]	The raw value of the extension at index 'i'.
CertificateOutputFormat	The format of the certificate to save.
CertKeyLength	The public key length for created certificates and keys.
CertKeyType	The types of keys created for new certificates.
CertSignatureAlgorithm	The signature algorithm used when creating certificates.
CertValidityTime	The validity period for the certificate.
CSP	The Cryptographic Service Provider.
ImportCertAction	Specified the action to take if a matching certificate or a link to a matching certificate already exists.
KeyFormat	How the public and private key are formatted.
ReplaceKey	Whether or not to replace an existing key when creating a new key.
CodePage	The system code page used for Unicode to Multibyte translations.