Docs

IPWorks SSH 2022 Qt Edition

Version 22.0 [Build 8172]

CertMgr Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

CertMgr

Remarks

The class methods, such as ListCertificateStores or ListStoreCertificates, are used to list certificate stores and certificates. The corresponding lists are returned through 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.

CertEffectiveDateThis is the date on which this certificate becomes valid.
CertEncodedThis is the certificate (PEM/base64 encoded).
CertExpirationDateThis is the date the certificate expires.
CertExtendedKeyUsageThis is a comma-delimited list of extended key usage identifiers.
CertFingerprintThis is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
CertFingerprintSHA1This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
CertFingerprintSHA256This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
CertIssuerThis is the issuer of the certificate.
CertKeyPasswordThis is the password for the certificate's private key (if any).
CertPrivateKeyThis is the private key of the certificate (if available).
CertPrivateKeyAvailableThis property shows whether a PrivateKey is available for the selected certificate.
CertPrivateKeyContainerThis is the name of the PrivateKey container for the certificate (if available).
CertPublicKeyThis is the public key of the certificate.
CertPublicKeyAlgorithmThis property contains the textual description of the certificate's public key algorithm.
CertPublicKeyLengthThis is the length of the certificate's public key (in bits).
CertSerialNumberThis is the serial number of the certificate encoded as a string.
CertSignatureAlgorithmThe property contains the text description of the certificate's signature algorithm.
CertSubjectThis is the subject of the certificate used for client authentication.
CertSubjectAltNamesThis property contains comma-separated lists of alternative subject names for the certificate.
CertThumbprintMD5This property contains the MD5 hash of the certificate.
CertThumbprintSHA1This property contains the SHA-1 hash of the certificate.
CertThumbprintSHA256This property contains the SHA-256 hash of the certificate.
CertUsageThis property contains the text description of UsageFlags .
CertUsageFlagsThis property contains the flags that show intended use for the certificate.
CertVersionThis property contains the certificate's version number.
CertExtensionCountThe number of records in the CertExtension arrays.
CertExtensionCriticalThis property specifies whether or not the extension is defined as critical.
CertExtensionOIDThis property contains the ASN.
CertExtensionValueThis property contains the raw value of the certificate extension.
CertStoreThis is the certificate store to search for certificates.
CertStorePasswordThis is the password for the certificate store (if any).
CertStoreTypeThis is the type of certificate store for CertStore .
ExportedCertThis is the exported certificate string.
ExportFormatThis is the format to which the certificate is exported.
ExportPrivateKeyThis controls whether 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.
CreateCertificateThis method creates a new self-signed certificate in the current store.
CreateKeyThis method creates a new keyset associated with the provided name.
DeleteCertificateThis method deletes the currently selected certificate from the store.
DeleteKeyThis method deletes the keyset associated with the provided name.
ExportCertificateThis method exports the currently selected certificate.
GenerateCSRThis method generates a new Certificate Signing Request (CSR) to be sent to a signing authority.
ImportCertificateThis method imports a certificate from a file into the current certificate store.
ImportSignedCSRThis method mports a signed Certificate Signing Request (CSR).
IssueCertificateThis creates a new certificate in the current store and is signed by the selected certificate.
ListCertificateStoresThis lists the certificate stores.
ListKeysThis lists the keysets in a Cryptographic Service Provider (CSP).
ListMachineStoresThis lists the machine certificate stores.
ListStoreCertificatesThis lists the certificates in a store.
ReadCertificateThis loads a certificate from a file.
ReadCSRThis reads a Certificate Signing Request (CSR).
ResetThis resets all certificate properties to their default values.
SaveCertificateThis method saves the currently selected public certificate to a file.
ShowCertificateChainThis shows the certificate chain.
SignCSRThis creates a signed certificate from a Certificate Signing Request (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.

CertChainThis event shows the certificate chain for the certificate (see the ShowCertificateChain method).
CertListThis event lists the certificates in a store (see the ListStoreCertificates method).
ErrorInformation about errors during data delivery.
KeyListThis lists the keysets in a Cryptographic Service Provider (CSP); see the ListKeys method.
LogThis event fires once for each log message.
StoreListThis lists 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.
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.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

CertEffectiveDate Property (CertMgr Class)

This is the date on which this certificate becomes valid.

Syntax

QString GetCertEffectiveDate();

Default Value

""

Remarks

This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

CertEncoded Property (CertMgr Class)

This is the certificate (PEM/base64 encoded).

Syntax

QByteArray GetCertEncoded();
int SetCertEncoded(QByteArray qbaCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The CertStore and CertSubject properties also may be used to specify a certificate.

When CertEncoded is set, a search is initiated in the current CertStore for the private key of the certificate. If the key is found, CertSubject is updated to reflect the full subject of the selected certificate; otherwise, CertSubject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

CertExpirationDate Property (CertMgr Class)

This is the date the certificate expires.

Syntax

QString GetCertExpirationDate();

Default Value

""

Remarks

This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

CertExtendedKeyUsage Property (CertMgr Class)

This is a comma-delimited list of extended key usage identifiers.

Syntax

QString GetCertExtendedKeyUsage();
int SetCertExtendedKeyUsage(QString qsCertExtendedKeyUsage);

Default Value

""

Remarks

This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

Data Type

String

CertFingerprint Property (CertMgr Class)

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

QString GetCertFingerprint();

Default Value

""

Remarks

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

CertFingerprintSHA1 Property (CertMgr Class)

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

QString GetCertFingerprintSHA1();

Default Value

""

Remarks

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

CertFingerprintSHA256 Property (CertMgr Class)

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

QString GetCertFingerprintSHA256();

Default Value

""

Remarks

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

CertIssuer Property (CertMgr Class)

This is the issuer of the certificate.

Syntax

QString GetCertIssuer();

Default Value

""

Remarks

This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

CertKeyPassword Property (CertMgr Class)

This is the password for the certificate's private key (if any).

Syntax

QString GetCertKeyPassword();
int SetCertKeyPassword(QString qsCertKeyPassword);

Default Value

""

Remarks

This is the password for the certificate's private key (if any).

Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the CertStorePassword. CertKeyPassword. This field can be used to read such password-protected private keys.

Note: this property defaults to the value of CertStorePassword. To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling CertPrivateKey.

Data Type

String

CertPrivateKey Property (CertMgr Class)

This is the private key of the certificate (if available).

Syntax

QString GetCertPrivateKey();

Default Value

""

Remarks

This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The CertPrivateKey may be available but not exportable. In this case, CertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

CertPrivateKeyAvailable Property (CertMgr Class)

This property shows whether a PrivateKey is available for the selected certificate.

Syntax

bool GetCertPrivateKeyAvailable();

Default Value

false

Remarks

This property shows whether a CertPrivateKey is available for the selected certificate. If CertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

CertPrivateKeyContainer Property (CertMgr Class)

This is the name of the PrivateKey container for the certificate (if available).

Syntax

QString GetCertPrivateKeyContainer();

Default Value

""

Remarks

This is the name of the CertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

CertPublicKey Property (CertMgr Class)

This is the public key of the certificate.

Syntax

QString GetCertPublicKey();

Default Value

""

Remarks

This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

CertPublicKeyAlgorithm Property (CertMgr Class)

This property contains the textual description of the certificate's public key algorithm.

Syntax

QString GetCertPublicKeyAlgorithm();
int SetCertPublicKeyAlgorithm(QString qsCertPublicKeyAlgorithm);

Default Value

""

Remarks

This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

Data Type

String

CertPublicKeyLength Property (CertMgr Class)

This is the length of the certificate's public key (in bits).

Syntax

int GetCertPublicKeyLength();

Default Value

0

Remarks

This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

CertSerialNumber Property (CertMgr Class)

This is the serial number of the certificate encoded as a string.

Syntax

QString GetCertSerialNumber();

Default Value

""

Remarks

This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

CertSignatureAlgorithm Property (CertMgr Class)

The property contains the text description of the certificate's signature algorithm.

Syntax

QString GetCertSignatureAlgorithm();

Default Value

""

Remarks

The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

CertSubject Property (CertMgr Class)

This is the subject of the certificate used for client authentication.

Syntax

QString GetCertSubject();
int SetCertSubject(QString qsCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma it must be quoted.

Data Type

String

CertSubjectAltNames Property (CertMgr Class)

This property contains comma-separated lists of alternative subject names for the certificate.

Syntax

QString GetCertSubjectAltNames();

Default Value

""

Remarks

This property contains comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

CertThumbprintMD5 Property (CertMgr Class)

This property contains the MD5 hash of the certificate.

Syntax

QString GetCertThumbprintMD5();

Default Value

""

Remarks

This property contains the MD5 hash of the certificate. If the hash does not already exist, it is computed.

This property is read-only.

Data Type

String

CertThumbprintSHA1 Property (CertMgr Class)

This property contains the SHA-1 hash of the certificate.

Syntax

QString GetCertThumbprintSHA1();

Default Value

""

Remarks

This property contains the SHA-1 hash of the certificate. If the hash does not already exist, it is computed.

This property is read-only.

Data Type

String

CertThumbprintSHA256 Property (CertMgr Class)

This property contains the SHA-256 hash of the certificate.

Syntax

QString GetCertThumbprintSHA256();

Default Value

""

Remarks

This property contains the SHA-256 hash of the certificate. If the hash does not already exist, it is computed.

This property is read-only.

Data Type

String

CertUsage Property (CertMgr Class)

This property contains the text description of UsageFlags .

Syntax

QString GetCertUsage();
int SetCertUsage(QString qsCertUsage);

Default Value

""

Remarks

This property contains the text description of CertUsageFlags.

This value will be of one or more of the following strings and will be separated by commas:

  • Digital Signatures
  • Key Authentication
  • Key Encryption
  • Data Encryption
  • Key Agreement
  • Certificate Signing
  • Key Signing

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

Data Type

String

CertUsageFlags Property (CertMgr Class)

This property contains the flags that show intended use for the certificate.

Syntax

int GetCertUsageFlags();
int SetCertUsageFlags(int iCertUsageFlags);

Default Value

0

Remarks

This property contains the flags that show intended use for the certificate. The value of CertUsageFlags is a combination of the following flags:

0x80Digital Signatures
0x40Key Authentication
0x20Key Encryption
0x10Data Encryption
0x08Key Agreement
0x04Certificate Signing
0x02Key Signing

Please see the CertUsage property for a text representation of CertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

Data Type

Integer

CertVersion Property (CertMgr Class)

This property contains the certificate's version number.

Syntax

QString GetCertVersion();

Default Value

""

Remarks

This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

CertExtensionCount Property (CertMgr Class)

The number of records in the CertExtension arrays.

Syntax

int GetCertExtensionCount();
int SetCertExtensionCount(int iCertExtensionCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at CertExtensionCount - 1.

This property is not available at design time.

Data Type

Integer

CertExtensionCritical Property (CertMgr Class)

This property specifies whether or not the extension is defined as critical.

Syntax

bool GetCertExtensionCritical(int iCertExtensionIndex);

Default Value

false

Remarks

This property specifies whether or not the extension is defined as critical.

The CertExtensionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertExtensionCount property.

This property is read-only and not available at design time.

Data Type

Boolean

CertExtensionOID Property (CertMgr Class)

This property contains the ASN.

Syntax

QString GetCertExtensionOID(int iCertExtensionIndex);

Default Value

""

Remarks

This property contains the ASN.1 Object-Identifier (OID) that defines this certificate extension.

The CertExtensionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertExtensionCount property.

This property is read-only and not available at design time.

Data Type

String

CertExtensionValue Property (CertMgr Class)

This property contains the raw value of the certificate extension.

Syntax

QByteArray GetCertExtensionValue(int iCertExtensionIndex);

Default Value

""

Remarks

This property contains the raw value of the certificate extension. This value is encoded according to the extension's ASN.1 specification and should contain everything following the OID. The following example is provided for clarity.

The example will

  • Add a sequence of basicConstraints indicating the holder of this certificate may not act as a CA.
  • Add a sequence of cRLDistributionPoints showing where to get CRLs.
Certmgr mgr = new Certmgr(); mgr.Cert = new Certificate(CertStoreTypes.cstPFXFile, @"C:\signingcert.pfx", "password", "*"); mgr.CertExtensions.Clear(); mgr.Config("CertUsageFlags=0xA0"); //Key Encryption and Digital Signatures mgr.Config("CertExtendedKeyUsage=1.3.6.1.5.5.7.3.1,1.3.6.1.5.5.7.3.2"); //Server and Client authentication (respectively) mgr.Config("CertValidityTime=10000"); Netcode nc = new Netcode(); nc.Format = NetcodeFormats.fmtHex; // Set basicConstraints to be an end-entity. // Below is the hex-encoded value broken down. // 30 // Tag = sequence // 03 // Length // 01 // Tag = boolean // 01 // Length // 00 // False (not a CA) // Convert hex string to byte[] nc.EncodedData = "3003010100"; nc.Decode(); string oid = "2.5.29.19"; // basicConstraints byte[] value = nc.DecodedDataB; bool critical = false; CertExtension basicConstraints = new CertExtension(oid, value, critical); mgr.CertExtensions.Add(basicConstraints); // Add one point: http://www.nsoftware.com/dummy/MyCA.crl // Below is the hex-encoded value broken down. // 30 // Tag = sequence // 2F // Length // 30 // Tag = DistributionPoint // 2D // Length // A0 // Tag = DistributionPointName // 2B // Length // A0 // Tag = GeneralNames // 29 // Length // 86 // Tag = GeneralName // 27 // Length // 687474703A2F2F7777772E6E736F6674776172652E636F6D2F64756D6D792F4D7943412E63726C // URL // Convert hex string to byte[] nc.EncodedData = "302F302DA02BA0298627687474703A2F2F7777772E6E736F6674776172652E636F6D2F64756D6D792F4D7943412E63726C"; nc.Decode(); oid = "2.5.29.31"; // cRLDistributionPoints value = nc.DecodedDataB; critical = false; CertExtension crlDistributionPoints = new CertExtension(oid, value, critical); mgr.CertExtensions.Add(crlDistributionPoints); mgr.IssueCertificate("CN=www.petsbymatilda.com", 123); Console.WriteLine(mgr.Cert.Encoded);

The CertExtensionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertExtensionCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

CertStore Property (CertMgr Class)

This is the certificate store to search for certificates.

Syntax

QByteArray GetCertStore();
int SetCertStore(QByteArray qbaCertStore);

Default Value

"MY"

Remarks

The CertStoreType property specifies the type of the certificate store specified by CertStore. If the store is password protected, specify the password in CertStorePassword.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Byte Array

CertStorePassword Property (CertMgr Class)

This is the password for the certificate store (if any).

Syntax

QString GetCertStorePassword();
int SetCertStorePassword(QString qsCertStorePassword);

Default Value

""

Remarks

The value of this property is used to open the certificate store if the certificate store requires a password.

Data Type

String

CertStoreType Property (CertMgr Class)

This is the type of certificate store for CertStore .

Syntax

int GetCertStoreType();
int SetCertStoreType(int iCertStoreType);

Possible Values

CST_USER(0), 
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_AUTO(99)

Default Value

0

Remarks

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
20 (cstSecurityKey)The certificate is present on a physical security key accessible via a PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstSecurityKey, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the and set to the PIN.

Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstSecurityKey; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstSecurityKey, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

ExportedCert Property (CertMgr Class)

This is the exported certificate string.

Syntax

QByteArray GetExportedCert();

Default Value

""

Remarks

This property holds the exported certificate if it was not exported to a file.

When calling ExportCertificate if the CertFile parameter is an empty string, the certificate will be exported as a string and available in this property. This allows certificate data to be exported without writing any data to disk.

When ExportFormat is set to PFX or P7B, the EncodeExportedCert setting controls whether the value is binary or Base64 encoded.

This property is read-only and not available at design time.

Data Type

Byte Array

ExportFormat Property (CertMgr Class)

This is the format to which the certificate is exported.

Syntax

QString GetExportFormat();
int SetExportFormat(QString qsExportFormat);

Default Value

"PFX"

Remarks

ExportFormat is applicable when ExportCertificate is called and may be used to specify the output format. The applicability of each format depends on whether ExportPrivateKey is set. Some formats are applicable only when exporting to a private key and some values are applicable only when exporting to a public key.

ExportFormatApplicabilityDescription
"PFX" or "PKCS12" (default) Private Keys A PFX file (PKCS12).
"PEM" Public and Private Keys

A PEM-formatted public certificate (X509/PKCS1/PKCS8), or PEM formatted private key (PKCS1/PKCS8).

When ExportPrivateKey is False the exported certificate will be a PEM formatted X509 public certificate if the certificate being exported includes X509 data. If no X509 information is present, the public key will be exported in PKCS1 public key format for RSA/DSA keys and PKCS8 public key format for ECDSA/EdDSA keys.

When ExportPrivateKey is True the exported certificate will be a PEM-formatted PKCS1 private key for RSA/DSA keys and a PEM-formatted PKCS8 private key for ECDSA/EdDSA keys.

For example, when ExportPrivateKey is False:

-----BEGIN CERTIFICATE-----
MIIBkTCB+6ADAgECAgEBMA0GCSqGSIb3DQEBBQUAMA4xDDAKBgNVBAMTAzEwMDAgFw0wNzAx
...
Pg49SpQ+HcUibIpum2O0hmnySH7BPGfXD8Lu
-----END CERTIFICATE-----
Example when ExportPrivateKey is True:
-----BEGIN RSA PRIVATE KEY-----
MIICWwIBAAKBgQD5/STHUd7YkN1JyoyYnUvCf+Fyx1+ZleBJxvwDcm3yaZ98bvry
...
91y8ydb3mQ9l1hZudo2sj8tHnvEgph0r7B8hMM6Qaw==
-----END RSA PRIVATE KEY-----

"PKCS1" Public and Private KeysA PEM-formatted PKCS1 key file.

For example, when ExportPrivateKey is False:

-----BEGIN RSA PUBLIC KEY-----
MIGJAoGBALAyxV5assz+9v7aHbj93NYN5uGB/1z7kb2Nx4hj02QyRYbcD4htkhK4Qcq2GCsG
...
MxW4+pdeN4oEZ6rbMZt01bvMwNRX2GDEyQBhAgMBAAE=
-----END RSA PUBLIC KEY-----
Example when ExportPrivateKey is True:
-----BEGIN RSA PRIVATE KEY-----
MIICWwIBAAKBgQD5/STHUd7YkN1JyoyYnUvCf+Fyx1+ZleBJxvwDcm3yaZ98bvry
...
91y8ydb3mQ9l1hZudo2sj8tHnvEgph0r7B8hMM6Qaw==
-----END RSA PRIVATE KEY-----

"PKCS8" Public and Private KeysA PEM-formatted PKCS8 key file.

Example when ExportPrivateKey is False:

-----BEGIN PUBLIC KEY-----
MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCxdTNtpJQbw90cq6aJEx5vRIBrAiCAB9/F
...
8UdUliXeU8UGYjVcMhGy5oPsVeBXGcPAqF2mjXdBKNnzlSlctOLnYRBS5jwRuNfTQQIDAQAB
-----END PUBLIC KEY-----
Example when ExportPrivateKey is True:
-----BEGIN PRIVATE KEY-----
MIICdQIBADANBgkqhkiG9w0BAQEFAASCAl8wggJbAgEAAoGBAPn9JMdR3tiQ3UnK
...
HSvsHyEwzpBr
-----END PRIVATE KEY-----

"OpenSSH" Public and Private KeysAn OpenSSH public or private key file.

For example, when ExportPrivateKey is False:

ssh-rsa AAAAB3NzaC1y...
Example when ExportPrivateKey is True:
-----BEGIN OPENSSH PRIVATE KEY-----
b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAlwAAAAdzc2gtcnNh
...
AwQFBgcICQo=
-----END OPENSSH PRIVATE KEY-----

"PPK" Private KeysA PuTTY private key file.

For example,

PuTTY-User-Key-File-2: ssh-rsa
Encryption: none
Comment: rsa-key-20180822
Public-Lines: 4
AAAAB3NzaC1yc2EAAAADAQABAAAAgQCmz5j5kWUKxfwiv6J0LQ4wN9ekpeORXVaP
...
8pSSWejQ5Q==
Private-Lines: 8
AAAAgH87Sp/YcSw1dKoAZuWb0/2dKkKwMRIYEkS15caRpzAteay6WWX7l1sgBTU7
...
Oa0=
Private-MAC: d53e24f44bde8d1d3844a142fbb1fa7c88ea3585

"SSH2PublicKey"Public KeysAn SSH2 public key.

For example,

---- BEGIN SSH2 PUBLIC KEY ----
AAAAB3NzaC1yc2EAAAADAQABAAAAgQD5/STHUd7YkN1JyoyYnUvCf+Fyx1+ZleBJxvwDcm3y
...
6bVPTODELil1PVWJDlfdwoLZZKY2ACFHzxBqaOlYv1rbd2JIYAuqGca2ow==
---- END SSH2 PUBLIC KEY ----

"SSH2PrivateKey"Private KeysAn SSH2 private key.

For example,

---- BEGIN SSH2 ENCRYPTED PRIVATE KEY ----
AAAAB3NzaC1yc2EAAAADAQABAAAAgQD5/STHUd7YkN1JyoyYnUvCf+Fyx1+ZleBJxvwDcm3y
...
6bVPTODELil1PVWJDlfdwoLZZKY2ACFHzxBqaOlYv1rbd2JIYAuqGca2ow==
---- END SSH2 ENCRYPTED PRIVATE KEY ----

"JWK"Private and Public KeysA JSON Web Key (JWK).

For example, when ExportPrivateKey is False:

{
	"kty": "EC",
	"crv": "P-256",
	"x": "M_P_uqzP43FYW-kXWlpEDlX3nPZUr1QaMllAxUnao7w",
	"y": "zRFhp7iCXYIoTgerQ4LjGPTujodlimrwIMk-3enj_1Q"
}
For example, when ExportPrivateKey is True:
{
	"kty": "EC",
	"crv": "P-256",
	"x": "M_P_uqzP43FYW-kXWlpEDlX3nPZUr1QaMllAxUnao7w",
	"y": "zRFhp7iCXYIoTgerQ4LjGPTujodlimrwIMk-3enj_1Q",
	"d": "eFBtl-uaB9Y4b-CIav5IYX4gGRFBvpBmrMOOQ7L-euI"
}

"XML"Private and Public KeysAn XML file holding the key or X509 data.

For example, when ExportPrivateKey is False:

<X509Data>
	<X509Certificate>MIIB...D8Lu</X509Certificate>
</X509Data>
For example, when ExportPrivateKey is True:
<RSAKeyValue>
	<Modulus>+f0k...tqM=</Modulus>
	<Exponent>AQAB</Exponent>
	<P>/cOnF...tGw==</P>
	<Q>/DD5...dGQ==</Q>
	<DP>d75...N0w==</DP>
	<DQ>Cyv...rKQ==</DQ>
	<InverseQ>fsB...Qaw==</InverseQ>
	<D>J7p...YJE=</D>
</RSAKeyValue>

Data Type

String

ExportPrivateKey Property (CertMgr Class)

This controls whether to export the private key.

Syntax

bool GetExportPrivateKey();
int SetExportPrivateKey(bool bExportPrivateKey);

Default Value

true

Remarks

This property controls whether the private key is exported when ExportCertificate is called.

If set to True (default), the private key is exported. If set to False, only the public key is exported.

Data Type

Boolean

Config Method (CertMgr Class)

Sets or retrieves a configuration setting.

Syntax

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CreateCertificate Method (CertMgr Class)

This method creates a new self-signed certificate in the current store.

Syntax

int CreateCertificate(const QString& qsCertSubject, int iSerialNumber);

Remarks

This method creates a new self-signed certificate in the current store, which contains the following:

CertSubject specifies the subject of the new certificate. A new keyset (public/private key pair) is generated and associated with the new certificate.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma it must be quoted.

SerialNumber specifies the certificate serial number. All certificates signed by the same issuer must have different (unique) serial numbers.

The time validity of the new certificate is determined by the CertValidityTime configuration setting, and the key size by the CertKeyLength configuration setting.

In the Unix edition of the toolkit, the certificate will be created in memory. Call ExportCertificate to export the newly created certificate to a PEM file.

Error Handling

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CreateKey Method (CertMgr Class)

This method creates a new keyset associated with the provided name.

Syntax

int CreateKey(const QString& qsKeyName);

Remarks

This method will create a new keyset (public/private key pair) within the Cryptographic Service Provider (CSP) used by the class. The CSP can be set using the CSP configuration setting.

NOTE: This functionality is only available in Windows.

Error Handling

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DeleteCertificate Method (CertMgr Class)

This method deletes the currently selected certificate from the store.

Syntax

int DeleteCertificate();

Remarks

This method will delete the selected certificate from the store. If the certificate cannot be deleted, an error is returned.

This functionality is currently not available when the provider is OpenSSL.

Error Handling

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DeleteKey Method (CertMgr Class)

This method deletes the keyset associated with the provided name.

Syntax

int DeleteKey(const QString& qsKeyName);

Remarks

This method will delete the keyset (public/private key pair) associated with KeyName from the Cryptographic Service Provider (CSP). The CSP can be set using the CSP configuration setting.

NOTE: This functionality is only available in Windows.

Error Handling

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ExportCertificate Method (CertMgr Class)

This method exports the currently selected certificate.

Syntax

int ExportCertificate(const QString& qsCertFile, const QString& qsPassword);

Remarks

This method exports the certificate currently selected by CertSubject to the file specified by the CertFile parameter in the format specified by ExportFormat. This method may be used effectively to convert between a variety of formats.

The Password parameter specifies a password for the private key when ExportPrivateKey is set to True. Password is not applicable when ExportPrivateKey is set to False.

If CertFile is set to an empty string, the exported certificate will not be written to disk and instead will be held as a string by the ExportedCert property.

ExportFormat is applicable when ExportCertificate is called and may be used to specify the output format. The applicability of each format depends on whether ExportPrivateKey is set. Some formats are applicable only when exporting to a private key and some values are applicable only when exporting to a public key.

ExportFormatApplicabilityDescription
"PFX" or "PKCS12" (default) Private Keys A PFX file (PKCS12).
"PEM" Public and Private Keys

A PEM-formatted public certificate (X509/PKCS1/PKCS8), or PEM formatted private key (PKCS1/PKCS8).

When ExportPrivateKey is False the exported certificate will be a PEM formatted X509 public certificate if the certificate being exported includes X509 data. If no X509 information is present, the public key will be exported in PKCS1 public key format for RSA/DSA keys and PKCS8 public key format for ECDSA/EdDSA keys.

When ExportPrivateKey is True the exported certificate will be a PEM-formatted PKCS1 private key for RSA/DSA keys and a PEM-formatted PKCS8 private key for ECDSA/EdDSA keys.

For example, when ExportPrivateKey is False:

-----BEGIN CERTIFICATE-----
MIIBkTCB+6ADAgECAgEBMA0GCSqGSIb3DQEBBQUAMA4xDDAKBgNVBAMTAzEwMDAgFw0wNzAx
...
Pg49SpQ+HcUibIpum2O0hmnySH7BPGfXD8Lu
-----END CERTIFICATE-----
Example when ExportPrivateKey is True:
-----BEGIN RSA PRIVATE KEY-----
MIICWwIBAAKBgQD5/STHUd7YkN1JyoyYnUvCf+Fyx1+ZleBJxvwDcm3yaZ98bvry
...
91y8ydb3mQ9l1hZudo2sj8tHnvEgph0r7B8hMM6Qaw==
-----END RSA PRIVATE KEY-----

"PKCS1" Public and Private KeysA PEM-formatted PKCS1 key file.

For example, when ExportPrivateKey is False:

-----BEGIN RSA PUBLIC KEY-----
MIGJAoGBALAyxV5assz+9v7aHbj93NYN5uGB/1z7kb2Nx4hj02QyRYbcD4htkhK4Qcq2GCsG
...
MxW4+pdeN4oEZ6rbMZt01bvMwNRX2GDEyQBhAgMBAAE=
-----END RSA PUBLIC KEY-----
Example when ExportPrivateKey is True:
-----BEGIN RSA PRIVATE KEY-----
MIICWwIBAAKBgQD5/STHUd7YkN1JyoyYnUvCf+Fyx1+ZleBJxvwDcm3yaZ98bvry
...
91y8ydb3mQ9l1hZudo2sj8tHnvEgph0r7B8hMM6Qaw==
-----END RSA PRIVATE KEY-----

"PKCS8" Public and Private KeysA PEM-formatted PKCS8 key file.

Example when ExportPrivateKey is False:

-----BEGIN PUBLIC KEY-----
MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCxdTNtpJQbw90cq6aJEx5vRIBrAiCAB9/F
...
8UdUliXeU8UGYjVcMhGy5oPsVeBXGcPAqF2mjXdBKNnzlSlctOLnYRBS5jwRuNfTQQIDAQAB
-----END PUBLIC KEY-----
Example when ExportPrivateKey is True:
-----BEGIN PRIVATE KEY-----
MIICdQIBADANBgkqhkiG9w0BAQEFAASCAl8wggJbAgEAAoGBAPn9JMdR3tiQ3UnK
...
HSvsHyEwzpBr
-----END PRIVATE KEY-----

"OpenSSH" Public and Private KeysAn OpenSSH public or private key file.

For example, when ExportPrivateKey is False:

ssh-rsa AAAAB3NzaC1y...
Example when ExportPrivateKey is True:
-----BEGIN OPENSSH PRIVATE KEY-----
b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAlwAAAAdzc2gtcnNh
...
AwQFBgcICQo=
-----END OPENSSH PRIVATE KEY-----

"PPK" Private KeysA PuTTY private key file.

For example,

PuTTY-User-Key-File-2: ssh-rsa
Encryption: none
Comment: rsa-key-20180822
Public-Lines: 4
AAAAB3NzaC1yc2EAAAADAQABAAAAgQCmz5j5kWUKxfwiv6J0LQ4wN9ekpeORXVaP
...
8pSSWejQ5Q==
Private-Lines: 8
AAAAgH87Sp/YcSw1dKoAZuWb0/2dKkKwMRIYEkS15caRpzAteay6WWX7l1sgBTU7
...
Oa0=
Private-MAC: d53e24f44bde8d1d3844a142fbb1fa7c88ea3585

"SSH2PublicKey"Public KeysAn SSH2 public key.

For example,

---- BEGIN SSH2 PUBLIC KEY ----
AAAAB3NzaC1yc2EAAAADAQABAAAAgQD5/STHUd7YkN1JyoyYnUvCf+Fyx1+ZleBJxvwDcm3y
...
6bVPTODELil1PVWJDlfdwoLZZKY2ACFHzxBqaOlYv1rbd2JIYAuqGca2ow==
---- END SSH2 PUBLIC KEY ----

"SSH2PrivateKey"Private KeysAn SSH2 private key.

For example,

---- BEGIN SSH2 ENCRYPTED PRIVATE KEY ----
AAAAB3NzaC1yc2EAAAADAQABAAAAgQD5/STHUd7YkN1JyoyYnUvCf+Fyx1+ZleBJxvwDcm3y
...
6bVPTODELil1PVWJDlfdwoLZZKY2ACFHzxBqaOlYv1rbd2JIYAuqGca2ow==
---- END SSH2 ENCRYPTED PRIVATE KEY ----

"JWK"Private and Public KeysA JSON Web Key (JWK).

For example, when ExportPrivateKey is False:

{
	"kty": "EC",
	"crv": "P-256",
	"x": "M_P_uqzP43FYW-kXWlpEDlX3nPZUr1QaMllAxUnao7w",
	"y": "zRFhp7iCXYIoTgerQ4LjGPTujodlimrwIMk-3enj_1Q"
}
For example, when ExportPrivateKey is True:
{
	"kty": "EC",
	"crv": "P-256",
	"x": "M_P_uqzP43FYW-kXWlpEDlX3nPZUr1QaMllAxUnao7w",
	"y": "zRFhp7iCXYIoTgerQ4LjGPTujodlimrwIMk-3enj_1Q",
	"d": "eFBtl-uaB9Y4b-CIav5IYX4gGRFBvpBmrMOOQ7L-euI"
}

"XML"Private and Public KeysAn XML file holding the key or X509 data.

For example, when ExportPrivateKey is False:

<X509Data>
	<X509Certificate>MIIB...D8Lu</X509Certificate>
</X509Data>
For example, when ExportPrivateKey is True:
<RSAKeyValue>
	<Modulus>+f0k...tqM=</Modulus>
	<Exponent>AQAB</Exponent>
	<P>/cOnF...tGw==</P>
	<Q>/DD5...dGQ==</Q>
	<DP>d75...N0w==</DP>
	<DQ>Cyv...rKQ==</DQ>
	<InverseQ>fsB...Qaw==</InverseQ>
	<D>J7p...YJE=</D>
</RSAKeyValue>

ExportCertificate Example:

//Convert from PFX to PPK certmgr.SetCertStoreType(CST_PFXFILE); certmgr.SetCertStore("..\\test.pfx", strlen("..\\test.pfx")); certmgr.SetCertStorePassword("password"); certmgr.SetCertSubject("*"); certmgr.SetExportPrivateKey(true); certmgr.SetExportFormat("PPK"); int ret_code = certmgr.ExportCertificate("..\\test.ppk", "newpassword"); //Export public certificate from PFX certmgr.SetCertStoreType(CST_PFXFILE); certmgr.SetCertStore("..\\test.pfx", strlen("..\\test.pfx")); certmgr.SetCertStorePassword("password"); certmgr.SetCertSubject("*"); certmgr.SetExportPrivateKey(false); certmgr.SetExportFormat("PEM"); ret_code = certmgr.ExportCertificate("..\\exported.cer", ""); //Convert .cer file to SSH2 Public Key certmgr.SetCertStoreType(CST_PUBLIC_KEY_FILE); certmgr.SetCertStore("..\\exported.cer", strlen("..\\exported.cer")); certmgr.SetCertSubject("*"); certmgr.SetExportPrivateKey(false); certmgr.SetExportFormat("SSH2PublicKey"); ret_code = certmgr.ExportCertificate("C:\\ssh2.pub", "");

Error Handling

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GenerateCSR Method (CertMgr Class)

This method generates a new Certificate Signing Request (CSR) to be sent to a signing authority.

Syntax

QString GenerateCSR(const QString& qsCertSubject, const QString& qsKeyName);

Remarks

This method will generate a new CSR to be sent to the signing authority. CertSubject specifies the subject of the CSR. KeyName specifies the name of the keyset (public/private key pair) to be used. If the keyset does not already exist in the Cryptographic Service Provider (CSP), the class will automatically generate one. To set the CSP, use the CSP configuration setting.

Note: Remember the name of the keyset that is used when creating a CSR. The keyset must be re-associated with the certificate after the trust authority has signed the CSR.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma it must be quoted.

NOTE: This functionality is only available in Windows.

Error Handling

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ImportCertificate Method (CertMgr Class)

This method imports a certificate from a file into the current certificate store.

Syntax

int ImportCertificate(const QString& qsCertFile, const QString& qsPassword, const QString& qsSubject);

Remarks

This method will import a certificate from a file into the current certificate store.

On Windows platforms, certificates may be imported only to the Windows certificate store. To load a certificate without importing it to a Windows store, set Cert*.

Certificate files with or without a private key may be imported. If the file specified by CertFile contains a private key, the private key will be imported along with the public certificate. If the file specified by CertFile contains only a public certificate, only the public certificate will be imported.

The Password parameter specifies the certificate password (if any). When importing a public certificate, set Password to an empty string.

The format of the certificate file being imported must contain valid X509 data to be imported. Not all certificate file formats include X509 data, such as PPK or PKCS8 private keys. If the CertFile is of a format that cannot be imported, the class fails with an error.

Note: On Linux-based operating systems, this method loads the specified certificate without importing into any system location.

Subject is optional. If empty, the first certificate in the store is loaded instead of the matching certificate.

ImportCertificate Example

//Import a PFX certmgr.ImportCertificate("..\\test.pfx", "password", "*"); //Import a public certificate (CER) certmgr.ImportCertificate("..\\test.cer", "", "*");

Error Handling

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ImportSignedCSR Method (CertMgr Class)

This method mports a signed Certificate Signing Request (CSR).

Syntax

int ImportSignedCSR(const QByteArray& qbaSignedCSR, const QString& qsKeyName);

Remarks

This method will import a signed CSR. SignedCSR specifies a certificate that has been signed by a trusted authority. KeyName is the name of the keyset (public/private key pair) that was used to create the original CSR.

NOTE: This functionality is only available in Windows.

Error Handling

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

IssueCertificate Method (CertMgr Class)

This creates a new certificate in the current store and is signed by the selected certificate.

Syntax

int IssueCertificate(const QString& qsCertSubject, int iSerialNumber);

Remarks

This method creates a new certificate in the current store and is signed by the selected certificate. CertSubject specifies the subject of the new certificate. A new keyset (public/private key pair) is generated and associated with the new certificate.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma it must be quoted.

SerialNumber specifies the certificate serial number. All certificates signed by the same issuer must have different (unique) serial numbers.

The current certificate selected by the class will be used as the issuing certificate.

If no certificate has been selected in the current CertStore before calling this method, or if the selected certificate does not have an associated private key, the method fails with an error.

The time validity of the new certificate is determined by the CertValidityTime configuration setting, and the key size by the CertKeyLength configuration setting.

NOTE: This functionality is only available in Windows.

Error Handling

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListCertificateStores Method (CertMgr Class)

This lists the certificate stores.

Syntax

QString ListCertificateStores();

Remarks

This method lists the system certificate stores for the current user account. The results are provided through the StoreList event.

The same information is also returned upon method completion as a set of lines and is given one per certificate store name.

NOTE: This functionality is only available in Windows.

Error Handling

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ListKeys Method (CertMgr Class)

This lists the keysets in a Cryptographic Service Provider (CSP).

Syntax

QString ListKeys();

Remarks

This method lists the keys (public/private key pairs) in a CSP. The results are provided through the KeyList event.

The same information is also returned upon method completion as a set of lines and is given one per key, with each line containing the following information separated by Tab characters: KeyContainer, KeyType, AlgId, and KeyLen.

NOTE: This functionality is only available in Windows.

Error Handling

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ListMachineStores Method (CertMgr Class)

This lists the machine certificate stores.

Syntax

QString ListMachineStores();

Remarks

This method behaves the same as the ListCertificateStores method, but it lists the certificate stores in the machine account (under HKEY_LOCAL_MACHINE in the registry).

NOTE: This functionality is only available in Windows.

Error Handling

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ListStoreCertificates Method (CertMgr Class)

This lists the certificates in a store.

Syntax

QString ListStoreCertificates();

Remarks

This method lists the certificates in a store. The results are provided through the CertList event.

The same information is also returned upon method completion as a set of lines and is given one per certificate, with each line containing the following information separated by Tab characters: CertSubject, CertIssuer, CertSerialNumber, and HasPrivateKey (as "1" or "0").

In the Unix edition of the toolkit, this is available only when a PFX file is loaded.

Error Handling

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ReadCertificate Method (CertMgr Class)

This loads a certificate from a file.

Syntax

int ReadCertificate(const QString& qsFileName);

Remarks

Note: This method is present for backward compatibility. It is recommended to specify the Cert* properties to load a certificate.

This method will load a certificate from a file. The file contents can be encoded in Base64 PEM or ASN DER format.

Error Handling

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ReadCSR Method (CertMgr Class)

This reads a Certificate Signing Request (CSR).

Syntax

QString ReadCSR(const QString& qsCSR);

Remarks

This method reads a CSR and returns a string holding information about the CSR. The Cert property is also populated with relevant information about the CSR, including the following:

The method accepts the CSR parameter as either a Base64-encoded string PEM or a path to a file.

The return value will be in the following format:

Certificate Request:
    Data:
        Version: 0 (0x0)
        Subject: C=AU, S=Some-State, O=Internet Widgits Pty Ltd
        Subject Public Key Info:
            Public Key Algorithm: X957_DSA (1.2.840.10040.4.1)
                Public-Key: (0 bit)
                pub:
                    02:82:01:00:66:70:68:60:08:63:bc:ff:26:62:77:74:
                    f6:b8:a8:11:f4:2c:5d:a1:79:b9:8e:ea:30:2e:6b:5a:
                    1b:35:39:24:91:1b:c1:ba:49:a0:c5:af:47:6e:73:0a:
                    f3:f6:6b:99:94:21:32:e5:24:b3:a8:a4:85:93:84:26:
                    e8:5c:4a:5d:2e:5e:82:df:ab:cc:e5:8d:51:ac:45:c2:
                    09:e5:21:f1:ce:c9:a0:3d:1d:7a:ab:fa:dd:d6:56:a8:
                    b2:61:26:8e:27:83:36:8a:0c:9b:cb:61:1a:b5:63:95:
                    ef:a5:bd:f2:8e:a7:fc:ca:d2:81:87:a5:6a:88:03:2e:
                    ca:fb:24:fa:d0:df:8a:2e:a9:e0:31:fc:57:e1:02:ca:
                    ee:99:01:d2:a5:33:34:47:92:b3:8b:31:f5:f1:1d:bf:
                    eb:07:70:71:6f:d1:c0:4c:0a:9d:99:af:ae:7e:bc:85:
                    e4:d2:22:1c:38:4b:60:e8:31:4d:f7:10:06:10:03:55:
                    f5:af:ba:a9:53:a5:9b:ae:d1:f8:38:34:80:e4:1c:9e:
                    06:8d:cc:39:3e:b2:e9:32:82:85:d2:d0:ed:b2:8e:d6:
                    6f:96:87:08:62:cc:9e:d3:75:76:b5:85:31:c6:a4:94:
                    59:15:ec:de:70:5a:34:2c:ff:27:ad:fc:14:01:e6:39:
                    8a:c9:91:3e:
                P:
                    00:dc:a6:15:cc:1a:e1:44:16:dc:a8:68:a4:18:9a:ab:
                    bf:5d:bf:b7:d1:5e:38:5f:b6:0e:21:ef:df:83:6a:5c:
                    31:f0:c9:07:3c:13:2c:9c:32:d0:89:76:2b:80:ad:3f:
                    6b:5d:5a:1d:69:31:f5:80:d5:65:ba:b5:28:a3:38:ba:
                    93:25:c4:fc:93:99:a2:00:5d:5e:c6:1b:f2:63:f0:24:
                    72:52:b4:49:97:19:93:fe:47:bf:9e:2e:54:d1:8a:b9:
                    09:8d:54:e8:de:31:e8:0d:21:b0:81:b2:f5:bd:38:3c:
                    15:02:d6:c1:aa:ab:17:8f:a8:f8:1f:1b:34:09:85:75:
                    3d:6e:28:2d:72:af:47:fd:ae:c4:f3:78:53:d7:07:a7:
                    c4:72:35:2d:6b:9e:42:08:1d:46:c9:38:d2:53:27:63:
                    a2:1d:be:11:9f:dd:9d:5b:e4:ad:fa:71:30:61:84:60:
                    a0:bf:bd:3a:51:b4:b5:1e:48:26:36:66:9e:52:f9:70:
                    35:e3:38:53:2e:90:ed:9f:0f:9d:67:b9:57:dd:53:e6:
                    ca:92:58:40:6d:15:e4:ae:2e:16:74:33:ed:48:90:15:
                    30:b7:fd:47:58:91:d5:c5:e2:3b:1f:1d:3b:a7:59:40:
                    2e:22:1a:9a:89:1b:31:a2:6f:cf:4c:a1:3b:93:ed:8a:
                    11:
                Q:
                    00:e3:ae:12:04:80:be:0f:d4:78:ef:02:27:26:b3:64:
                    6d:2b:e0:c9:da:15:00:a9:9c:45:6d:e6:44:ef:dd:75:
                    71:
                G:
                    18:fb:52:54:fe:bc:54:9e:17:a9:51:a1:e0:b9:6a:ab:
                    48:0e:06:60:f3:cd:fd:3c:14:9a:a0:35:d1:33:d4:d8:
                    b4:ee:ce:0b:5c:c7:60:24:e8:39:17:d8:75:13:90:44:
                    f5:f6:ef:50:cd:b4:af:66:90:f7:00:13:66:2f:ea:e2:
                    29:39:cd:a4:16:20:df:00:fd:53:6d:02:8b:4f:09:a5:
                    7f:72:7c:28:c8:70:2a:85:49:a1:65:36:66:91:52:e7:
                    14:b1:b8:b9:79:39:a6:d5:f8:b9:cd:ce:af:2d:88:66:
                    b5:d9:bb:9e:60:c8:9e:82:b4:3f:ff:23:37:4b:20:e4:
                    88:b0:d4:6e:b7:b5:8c:e6:98:cb:88:c2:6e:10:46:af:
                    44:0f:53:22:c2:fb:80:d3:30:05:c0:a6:4b:f8:e0:08:
                    3e:69:b6:17:b1:7d:2f:8f:07:66:9c:e5:94:3f:fc:ea:
                    f9:6c:9d:49:7c:91:f3:5a:92:b4:a7:b9:dc:42:7d:1a:
                    b0:99:ad:6d:b8:d9:03:6e:40:13:1c:3e:e2:80:f5:a1:
                    da:75:49:29:be:36:ad:78:74:46:0d:00:e9:6d:bf:8c:
                    65:50:4c:ad:ba:a7:1c:ac:5a:13:9e:d6:6a:3a:9f:cb:
                    1f:7d:5d:e2:3e:79:22:c2:56:c8:70:74:53:9a:4e:6c:
        Attributes:

    Signature Algorithm: 2.16.840.1.101.3.4.3.2 (2.16.840.1.101.3.4.3.2)
        00:30:44:02:20:42:00:86:14:2d:70:71:1b:77:b4:f0:
        ae:32:76:7b:1d:71:98:a2:70:69:4c:a9:e6:c1:9b:ad:
        df:af:a3:30:10:02:20:12:8f:ed:0b:1e:d5:f6:84:24:
        a9:fe:bc:45:75:eb:02:62:13:07:2c:ae:3f:ce:f3:da:
        95:25:47:97:bf:a6:9e:

Error Handling

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Reset Method (CertMgr Class)

This resets all certificate properties to their default values.

Syntax

int Reset();

Remarks

This method will reset all certificate properties to their default values. If a certificate and a private key are selected or a certificate store is opened, both are released upon calling this method.

Error Handling

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SaveCertificate Method (CertMgr Class)

This method saves the currently selected public certificate to a file.

Syntax

int SaveCertificate(const QString& qsFileName);

Remarks

Note: This method is present for backward compatibility. It is recommended to use ExportCertificate to export both public and private certificates and keys.

This method saves the public certificate of the currently selected certificate in Base64 PEM format to the location specified by the FileName parameter.

If the destination file exists, it is overwritten.

Error Handling

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ShowCertificateChain Method (CertMgr Class)

This shows the certificate chain.

Syntax

QString ShowCertificateChain();

Remarks

This method shows the certificate chain for the certificate. The results are provided through the CertChain event.

The same information is also returned upon method completion as a set of lines and is given one per key, with each line containing the following information separated by Tab characters: CertSubject, CertIssuer, CertSerialNumber, TrustStatus, and TrustInfo.

NOTE: This functionality is only available in Windows.

Error Handling

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

SignCSR Method (CertMgr Class)

This creates a signed certificate from a Certificate Signing Request (CSR).

Syntax

QString SignCSR(const QByteArray& qbaCSR, int iSerialNumber);

Remarks

This method will create a signed certificate from a CSR. CSR specifies the CSR to be signed.

SerialNumber specifies the certificate serial number. All certificates signed by the same issuer must have different (unique) serial numbers.

The time validity of the new certificate is determined by the CertValidityTime configuration setting, and the key size is determined by the CertKeyLength configuration setting.

NOTE: This functionality is only available in Windows.

Error Handling

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CertChain Event (CertMgr Class)

This event shows the certificate chain for the certificate (see the ShowCertificateChain method).

Syntax

class CertMgrCertChainEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &CertSerialNumber();

  int TrustStatus();

  int TrustInfo();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void CertChain(CertMgrCertChainEventParams *e);
// Or, subclass CertMgr and override this emitter function. virtual int FireCertChain(CertMgrCertChainEventParams *e) {...}

Remarks

This event is fired for every certificate in the certificate chain of the certificate assigned to the class.

The TrustStatus parameter contains information about the trust status of the entire certificate chain. A value of 0 signifies that the security subsystem has verified the certificate. Other values are combinations of one or more of the following flags:

0x00000001This certificate or one of the certificates in the certificate chain is not time valid.
0x00000002Certificates in the chain are not properly time nested.
0x00000004Trust for this certificate or one of the certificates in the certificate chain has been revoked.
0x00000008This certificate or one of the certificates in the certificate chain does not have a valid signature.
0x00000010The certificate or the certificate chain is not valid for its proposed usage.
0x00000020The certificate or certificate chain is based on an untrusted root.
0x00000040The revocation status of the certificate or one of the certificates in the certificate chain is unknown.
0x00000080One of the certificates in the chain was issued by a certification authority that the original certificate had certified.
0x00010000The certificate chain is not complete.
0x00020000A certificate trust list (CTL) used to create this chain was not time valid.
0x00040000A CTL used to create this chain did not have a valid signature.
0x00080000A CTL used to create this chain is not valid for this usage.

The TrustInfo parameter contains additional information about the status of the entire certificate chain. It is a combination of one or more of the following flags:

0x00000001An exact match issuer certificate has been found for this certificate.
0x00000002A key match issuer certificate has been found for this certificate.
0x00000004A name match issuer certificate has been found for this certificate.
0x00000008This certificate is self-signed.
0x00010000The certificate chain created is a complex chain.

The CertSubject and CertIssuer parameters contain the distinguished names of the certificate owner and issuer, respectively.

CertList Event (CertMgr Class)

This event lists the certificates in a store (see the ListStoreCertificates method).

Syntax

class CertMgrCertListEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &CertSerialNumber();

  bool HasPrivateKey();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void CertList(CertMgrCertListEventParams *e);
// Or, subclass CertMgr and override this emitter function. virtual int FireCertList(CertMgrCertListEventParams *e) {...}

Remarks

The CertSubject and CertIssuer parameters contain distinguished names of the certificate owner and issuer, respectively. The HasPrivateKey flag shows whether the private key for the certificate is available in the system.

The StoreList event and the ListCertificateStores and ListMachineStores methods are used to list the certificate stores in the system.

Error Event (CertMgr Class)

Information about errors during data delivery.

Syntax

class CertMgrErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Error(CertMgrErrorEventParams *e);
// Or, subclass CertMgr and override this emitter function. virtual int FireError(CertMgrErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

KeyList Event (CertMgr Class)

This lists the keysets in a Cryptographic Service Provider (CSP); see the ListKeys method.

Syntax

class CertMgrKeyListEventParams {
public:
  const QString &KeyContainer();

  int KeyType();

  const QString &AlgId();

  int KeyLen();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void KeyList(CertMgrKeyListEventParams *e);
// Or, subclass CertMgr and override this emitter function. virtual int FireKeyList(CertMgrKeyListEventParams *e) {...}

Remarks

The KeyContainer parameter is the name used to identify the keyset (public/private key pair) when it was first created.

KeyType shows the key type: 1 for key exchange (encryption) keys, and 2 for digital signature keys.

KeyLen shows the length of the public key (in bits).

Log Event (CertMgr Class)

This event fires once for each log message.

Syntax

class CertMgrLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Log(CertMgrLogEventParams *e);
// Or, subclass CertMgr and override this emitter function. virtual int FireLog(CertMgrLogEventParams *e) {...}

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data are logged.
3 (Debug) Debug data are logged.

Message is the log entry.

LogType identifies the type of log entry.

StoreList Event (CertMgr Class)

This lists the system certificate stores (see the ListCertificateStores and ListMachineStores methods).

Syntax

class CertMgrStoreListEventParams {
public:
  const QString &CertStore();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void StoreList(CertMgrStoreListEventParams *e);
// Or, subclass CertMgr and override this emitter function. virtual int FireStoreList(CertMgrStoreListEventParams *e) {...}

Remarks

The CertStore parameter contains the name of the certificate store being listed.

The CertList event and the ListStoreCertificates method are used to list the certificates in the store.

Configuration Settings (CertMgr Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

CertMgr Configuration Settings

CertComment:   A comment to include in a saved certificate.

This settings specifies the certificate comment when calling ExportCertificate. This setting is applicable only when ExportFormat is set to one of the following values:

When ExportFormat is set to SSH2PublicKey, the value of this setting must be the full header (e.g., Comment: My Comment).
CertCustomExtensionCount:   The number of records in the CertCustomExtension arrays.

This property controls the size of the following arrays:

The array indices start at 0 and end at CertExtensionCount-1.

CertCustomExtensionCritical[i]:   Whether or not the extension is defined as critical.

Whether or not the certificate extension at index "i" is defined as critical.

Valid array indices are from 0 to CertCustomExtensionCount - 1.

CertCustomExtensionOID[i]:   The ASN of the extension at index 'i'.

The ASN.1 object identifier (OID) that defines the certificate extension at index 'i'.

Valid array indices are from 0 to CertCustomExtensionCount - 1.

CertCustomExtensionValue[i]:   The raw value of the extension at index 'i'.

The raw value of this certificate extension (as a byte string). This value is encoded according to the extension's ASN.1 specification.

Valid array indices are from 0 to CertCustomExtensionCount - 1.

CertExtendedKeyUsage:   The extended key usage of the certificate.

This setting specifies the extended key usage flags of the certificate created by calling CreateCertificate or IssueCertificate. If specified, the value is a comma-separated list of OIDs. Common OIDs are as follows:

1.3.6.1.5.5.7.3.1 Server Authentication
1.3.6.1.5.5.7.3.2 Client Authentication
1.3.6.1.5.5.7.3.3 Code Signing
1.3.6.1.5.5.7.3.4 Secure Email
1.3.6.1.5.5.7.3.8 Time Stamping
1.3.6.1.5.5.7.3.9 OCSP Signing

For instance, the following value specified the extended key usage for Server Authentication, Client Authentication, and Code Signing: 1.3.6.1.5.5.7.3.1, 1.3.6.1.5.5.7.3.2, and 1.3.6.1.5.5.7.3.3

CertKeyLength:   The public key length for created certificates and keys.

When CreateCertificate creates a new certificate and associated key, or when CreateKey creates a key, this setting determines the length of the new public key (in bits). The default value is 2048.

CertKeyType:   The types of keys created for new certificates.

When CreateCertificate creates a new certificate and associated key, or when CreateKey creates a key, this setting determines the type of key generated: 1 for key exchange (encryption) keys, and 2 for digital signature keys. The default value is 1.

CertPublicKeyAlgorithm:   The public key algorithm used when a certificate is created.

When CreateCertificate creates a new certificate and associated key, this setting determines the public key algorithm of the generated keys. Following are the valid values:

  • RSA (default)
  • DSA
  • ECDSA_P256
  • ECDSA_P384
  • ECDSA_P521
  • ECDSA_Secp256k1
  • ECDSA_Secp224k1
  • ECDSA_Secp192k1
  • ECDSA_Secp160k1
  • Ed25519
  • Ed448

CertSignatureAlgorithm:   The signature algorithm used when creating certificates.

When CreateCertificate or IssueCertificate creates a new certificate, the signature algorithm used is specified by this setting. Following are the possible values:

  • MD2
  • MD5
  • SHA1
  • SHA256 (default)
  • SHA384
  • SHA512

CertSubjectAltNames:   Subject Alternative Names for creating or issuing certificates.

This allows the Subject Alternative Names extension to be specified when creating or issuing a certificate via CreateCertificate or IssueCertificate. This setting only supports email, DNS, URI, and IPv4 addresses. Separate alternative names should be separated by commas. For example:

string altNames = "email:copy,dns:domain.com,dns.1:other.domain.com,uri:http://www.domain.com,ip:192.168.1.102"

CertUsageFlags:   Sets the flags indicating the usage of the created certificate.

This setting specifies the usage flags of the certificate created by calling CreateCertificate or IssueCertificate. If specified, the value is the binary or one or more of the supported values. For instance a value of 12 or 0xC is the binary or is one of the Certificate Signing and Key Signing usage flags. Following are the supported flags:

0x80 Digital Signatures
0x40 Key Authentication
0x20 Key Encryption
0x10 Data Encryption
0x08 Key Agreement
0x04 Certificate Signing
0x02 Key Signing

CertValidityOffset:   The number of days until the certificate becomes valid.

This configuration setting can be used to change when a newly created certificate becomes valid. By default, the certificate is valid as soon as it is created. Set CertValidityOffset to the number of days that this starting period should be offset from the current day. This setting also accepts negative values for back-dating the validity of a certificate. The default value is 0.

CertValidityTime:   The validity period for the certificate.

This configuration setting determines the duration in days that a newly created certificate remains valid. The certificate becomes valid as soon as it is created, unless CertValidityOffset is set. The duration is not changed if CertValidityOffset is set; the certificate will still expire CertValidityTime days after the validity period begins. The default value is 365 days.

CreatedKey:   The PKCS8 formatted private and public key pair created after calling CreateKey.

This setting returns the PKCS8 formatted private and public key pair of the key created when CreateKey is called. This is useful in scenarios where exporting the key for use in another environment is required.

CSP:   The Cryptographic Service Provider.

The name of the Cryptographic Service Provider used to provide access to certificate signing operations.

CSRIgnoredExtensions:   Extensions to be ignorned when signing a CSR.

Set this configuration setting to a comma separated list of OID's of any extensions already present in the CSR that should be ignored when the CSR is signed.

For example if the SAN's in a CSR should be ignored the below code would work: CertMgr1->Config("CSRIgnoredExtensions=2.5.29.17");

CSRKey:   The PKCS8 formatted private key to use when generating a CSR.

This setting optionally specifies a PKCS8 formatted private key to use when calling GenerateCSR. When set, the keyName parameter of GenerateCSR is ignored and the key specified by this setting is used instead.

EncodeExportedCert:   Whether the certificate being exported to a string is encoded.

This setting controls whether the certificate exported as a string when ExportCertificate is called is encoded. If ExportFormat is set to PFX or P7B before calling ExportCertificate the exported certificate may be binary (EncodeExportedCert is False), or base64 encoded (EncodeExportedCert is True) to allow easier handling of the certificate data.

The default value is False.

ImportCertAction:   Specified the action to take if a matching certificate or a link to a matching certificate already exists.

When calling ImportCertificate if a matching certificate or a link to a matching certificate already exists in the Windows certificate store this setting governs what action will be taken. Possible values are:

1CERT_STORE_ADD_NEW - Imports a certificate only if no existing certificate is present.
2CERT_STORE_ADD_USE_EXISTING - If an existing certificate is found, it is not replaced.
3 (default)CERT_STORE_ADD_REPLACE_EXISTING - If an existing certificate is found it is replaced.
4CERT_STORE_ADD_ALWAYS - No checks are performed and a new certificate is always added to the store. This can result in duplicates.
5CERT_STORE_ADD_REPLACE_EXISTING_INHERIT_PROPERTIES - If an existing certificate is found it is replaced, and the new certificate inherits properties from the certificate it replaces.
6CERT_STORE_ADD_NEWER - Imports a certificate only if the certificate is newer than an existing matching certificate.
7CERT_STORE_ADD_NEWER_INHERIT_PROPERTIES - Imports a certificate only if the certificate is newer than an existing matching certificate, and inherits the properties of old certificate it replaces.

ImportCertStoreType:   The type of certificate store being specified for import.

When calling ImportCertificate, this setting controls the type of the certificate being specified in the first parameter.

This config can take one of the following values:

2 (cstPFXFile)The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
99 (cstAuto - default)The certificate type is automatically determined from the input.

Note that this functionality is currently for Windows platforms only.

JWKAlgorithm:   The JWK algorithm.

This setting specifies the JWK algorithm. It can be set before calling ExportCertificate (if ExportFormat is set to JWK) to control the key algorithm used to create the JWK. This setting will also be populated after loading a JWK file.

Valid values are:

  • (empty string)
  • HS256
  • HS384
  • HS512
  • RS256
  • RS384
  • RS512
  • EC256
  • EC384
  • EC512
  • EC256K

JWKExportX5C:   Whether to export a certificate chain to the x5c parameter.

When set to true, the component will attempt to build the X.509 certificate chain for the certificate currently selected by CertSubject. If successful, the x5c parameter will be added to the JWK. It can be set before calling ExportCertificate (if ExportFormat is set to JWK).

The default value is False.

JWKKeyId:   The JWK key Id.

This setting specifies the JWK key Id. It can be set before calling ExportCertificate (if ExportFormat is set to JWK). This setting will also be populated after loading a JWK file.

JWKKeyOps:   The JWK intended key operations list.

This setting specifies the intended key operations for the JWK. It can be set before calling ExportCertificate (if ExportFormat is set to JWK). This setting will also be populated after loading a JWK file.

This setting format is a JSON array. Examples: ["sign","verify"] or ["encrypt"].

JWKUse:   The JWK use parameter value.

This setting specifies the intended usage of the key. It can be set before calling ExportCertificate (if ExportFormat is set to JWK). This setting will also be populated after loading a JWK file.

Valid values are enc and sig.

KeyFormat:   How the public and private key are formatted.

This setting controls the format of CertPublicKey and CertPrivateKey. By default these properties hold PEM formatted public and private key data. When set to 1 (XML) the keys are stored in a XML format. This only affects the values returned by the class; the actual keys remain the same regardless of this setting. Possible values are:

  • 0 (PEM - default)
  • 1 (XML)
The default value is 0 (PEM).
LogLevel:   The level of detail that is logged.

This setting controls the level of detail that is logged through the Log event. Possible values are:

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data are logged.
3 (Debug) Debug data are logged.

ReplaceKey:   Whether or not to replace an existing key when creating a new key.

If this is false (default), the component will throw an error if a duplicate key exists while generating a new keyset using CreateKey. If set to true, the component will replace a key if it already exists when generating new keys.

RequestSubjectAltNames:   Subject Alternative Names for a Certificate Signing Request.

This allows Subject Alternative Names to be added to a Certificate Signing request. The setting only supports email, DNS, URI, and IPv4 addresses. Separate alternative names should be separated by commas. For example:

string altNames = "email:copy,dns:domain.com,dns.1:other.domain.com,uri:http://www.domain.com,ip:192.168.1.102"

X509Algorithm:   Public Key Algorithm OID.

This setting exposes the Public Key Algorithm object identifier (OID) value for the currently loaded Cert.

X509SignatureAlgorithm:   Signature Algorithm OID.

This setting exposes the Signature Algorithm object identifier (OID) value for the currently loaded Cert.

Base Configuration Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

By default the class will use the system security libraries to perform cryptographic functions. Setting this to True tells the class to use the internal implementation instead of using the system's security API.

Trappable Errors (CertMgr Class)

CertMgr Errors

143   Busy executing current method.
144   No certificate selected.
221   Cannot acquire CSP.
222   Cannot generate key.
270   Cannot load specified security library.
271   Cannot open certificate store.
272   Cannot find specified certificate.
274   Cannot get certificate chain.
275   Cannot verify certificate chain.
279   Error enumerating certificate stores.
280   The certificate could not be decoded.
281   Cannot find security provider.
282   Cannot add certificate to store.
283   The certificate could not be encoded.
285   Cannot create certificate signing request.
286   Cannot acquire Issuer private key.
287   Cannot delete certificate.
288   Cannot export certificate.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks SSH 2022 Qt Edition - Version 22.0 [Build 8172]