CertMgr Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Class Name

IPWorksSNMP_CertMgr

Procedural Interface

 ipworkssnmp_certmgr_open();
 ipworkssnmp_certmgr_close($res);
 ipworkssnmp_certmgr_register_callback($res, $id, $function);
 ipworkssnmp_certmgr_get_last_error($res);
 ipworkssnmp_certmgr_get_last_error_code($res);
 ipworkssnmp_certmgr_set($res, $id, $index, $value);
 ipworkssnmp_certmgr_get($res, $id, $index);
 ipworkssnmp_certmgr_do_config($res, $configurationstring);
 ipworkssnmp_certmgr_do_createcertificate($res, $certsubject, $serialnumber);
 ipworkssnmp_certmgr_do_createkey($res, $keyname);
 ipworkssnmp_certmgr_do_deletecertificate($res);
 ipworkssnmp_certmgr_do_deletekey($res, $keyname);
 ipworkssnmp_certmgr_do_exportcertificate($res, $certfile, $password);
 ipworkssnmp_certmgr_do_generatecsr($res, $certsubject, $keyname);
 ipworkssnmp_certmgr_do_importcertificate($res, $certfile, $password, $subject);
 ipworkssnmp_certmgr_do_importsignedcsr($res, $signedcsr, $keyname);
 ipworkssnmp_certmgr_do_issuecertificate($res, $certsubject, $serialnumber);
 ipworkssnmp_certmgr_do_listcertificatestores($res);
 ipworkssnmp_certmgr_do_listkeys($res);
 ipworkssnmp_certmgr_do_listmachinestores($res);
 ipworkssnmp_certmgr_do_liststorecertificates($res);
 ipworkssnmp_certmgr_do_readcertificate($res, $filename);
 ipworkssnmp_certmgr_do_readcsr($res, $csr);
 ipworkssnmp_certmgr_do_reset($res);
 ipworkssnmp_certmgr_do_savecertificate($res, $filename);
 ipworkssnmp_certmgr_do_showcertificatechain($res);
 ipworkssnmp_certmgr_do_signcsr($res, $csr, $serialnumber);

Remarks

The class 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 class, then you can get information about the certificate through the corresponding fields of the Cert property (described below).

The CertSubject, CertSerialNumber, and CertIssuer properties identify the certificate. The CertEffectiveDate and CertExpirationDate show the time boundaries of the certificate.

CertPublicKey, CertPublicKeyAlgorithm, CertPublicKeyLength, and CertVersion provide information about the certificate keys and the certificate format (version).

CertUsageFlags specifies the intended usage of the certificate. The CertUsage property provides a text description of these flags.

Property List


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

CertEffectiveDateThe date which this certificate becomes valid.
CertEncodedThe certificate (PEM/base64 encoded).
CertExpirationDateThe date the certificate expires.
CertExtendedKeyUsageA comma-delimited list of extended key usage identifiers.
CertFingerprintThe hex-encoded, 16-byte MD5 fingerprint of the certificate.
CertIssuerThe issuer of the certificate.
CertKeyPasswordThe password for the certificate's private key (if any).
CertPrivateKeyThe private key of the certificate (if available).
CertPrivateKeyAvailableShows whether a PrivateKey is available for the selected certificate.
CertPrivateKeyContainerThe name of the PrivateKey container for the certificate (if available).
CertPublicKeyThe public key of the certificate.
CertPublicKeyAlgorithmTextual description of the public key algorithm of the certificate.
CertPublicKeyLengthThe length of the certificate public key (in bits).
CertSerialNumberThe serial number of the certificate encoded as a string.
CertSignatureAlgorithmText description of the signature algorithm of the certificate.
CertSubjectThe subject of the certificate used for client authentication.
CertSubjectAltNamesA comma-separated lists of alternative subject names of the certificate.
CertThumbprintMD5MD5 hash of the certificate.
CertThumbprintSHA1SHA1 hash of the certificate.
CertThumbprintSHA256SHA256 hash of the certificate.
CertUsageText description of UsageFlags .
CertUsageFlagsFlags that show intended use for the certificate.
CertVersionThe certificate's version number.
CertExtensionCountThe number of records in the CertExtension arrays.
CertExtensionCriticalWhether or not the extension is defined as critical.
CertExtensionOIDThe ASN.
CertExtensionValueThe raw value of this certificate extension.
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 class 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 class 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 class with short descriptions. Click on the links for further details.

CertCommentA comment to include in a saved certificate.
CertCustomExtensionCountThe 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'.
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.
CSRIgnoredExtensionsExtensions to be ignorned when signing a CSR.
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.
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.
RequestExtendedKeyUsageThe extended key usage of the Certificate Signing Request.
RequestSubjectAltNamesSubject Alternative Names for a Certificate Signing Request.
RequestUsageFlagsSets the flags indicating the usage of the created Certificate Signing Request.
X509AlgorithmPublic Key Algorithm OID.
X509SignatureAlgorithmSignature Algorithm OID.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks SNMP 2020 PHP Edition - Version 20.0 [Build 7941]