IPWorks Auth 2020 .NET Edition

Questions / Feedback?

CertMgr Component

Properties   Methods   Events   Configuration Settings   Errors  

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




The component 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 component, 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 component with short descriptions. Click on the links for further details.

CertThe current selected certificate.
CertExtensionsA list of extensions used by the currently selected certificate.
CertStoreThe certificate store to search for certificates.
CertStorePasswordThe password for the certificate store (if any).
CertStoreTypeThe type of certificate store for CertStore .
ExportedCertThe exported certificate string.
ExportFormatThe format to which the certficate is exported.
ExportPrivateKeyWhether to export the private key.

Method List

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

ConfigSets or retrieves a configuration setting.
CreateCertificateCreates a new self-signed certificate in the current store.
CreateKeyCreates a new keyset associated with the provided name.
DeleteCertificateDeletes the currently selected certificate from the store.
DeleteKeyDeletes the keyset associated with the provided name.
ExportCertificateExports the currently selected certificate.
GenerateCSRGenerates a new CSR to be sent to a signing authority.
ImportCertificateImports a certificate from a file into the current certificate store.
ImportSignedCSRImports a signed CSR.
IssueCertificateCreates a new certificate in the current store, signed by the selected certificate.
ListCertificateStoresLists certificate stores.
ListKeysList keysets in a CSP.
ListMachineStoresList machine certificate stores.
ListStoreCertificatesList certificates in a store.
ReadCertificateLoads a certificate from a file.
ReadCSRReads a Certificate Signing Request (CSR).
ResetResets all certificate properties to their default values.
SaveCertificateThis method saves the currently selected public certificate to a file.
ShowCertificateChainShow certificate chain.
SignCSRCreates a signed certificate from a CSR.

Event List

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

CertChainShows the certificate chain for the certificate (see the ShowCertificateChain method).
CertListLists the certificates in a store (see the ListStoreCertificates method).
ErrorInformation about errors during data delivery.
KeyListLists the keysets in a CSP (see the ListKeys method).
LogFires once for each log message.
StoreListLists the system certificate stores (see the ListCertificateStores and ListMachineStores methods).

Configuration Settings

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

CertCommentA comment to include in a saved certificate.
CertExtendedKeyUsageThe extended key usage of the certificate.
CertKeyLengthThe public key length for created certificates and keys.
CertKeyTypeThe types of keys created for new certificates.
CertPublicKeyAlgorithmThe public key algorithm used when a certificate is created.
CertSignatureAlgorithmThe signature algorithm used when creating certificates.
CertSubjectAltNamesSubject Alternative Names for creating or issuing certificates.
CertUsageFlagsSets the flags indicating the usage of the created certificate.
CertValidityOffsetThe number of days until the certificate becomes valid.
CertValidityTimeThe validity period for the certificate.
CreatedKeyThe PKCS8 formatted private and public key pair created after calling CreateKey.
CSPThe Cryptographic Service Provider.
CSRKeyThe PKCS8 formatted private key to use when generating a CSR.
EncodeExportedCertWhether the certificate being exported to a string is encoded.
ImportCertActionSpecified the action to take if a matching certificate or a link to a matching certificate already exists.
ImportCertStoreTypeThe type of certificate store being specified for import.
JWKAlgorithmThe JWK algorithm.
JWKExportX5CWhether to export a certificate chain to the x5c parameter.
JWKKeyIdThe JWK key Id.
JWKKeyOpsThe JWK intended key operations list.
JWKUseThe JWK use parameter value.
KeyFormatHow the public and private key are formatted.
LogLevelThe level of detail that is logged.
ReplaceKeyWhether or not to replace an existing key when creating a new key.
RequestSubjectAltNamesSubject Alternative Names for a Certificate Signing Request.
X509AlgorithmPublic Key Algorithm OID.
X509SignatureAlgorithmSignature Algorithm OID.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Auth 2020 .NET Edition - Version 20.0 [Build 8155]