CertMgr Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

InPay_CertMgr

Procedural Interface

 inpay_certmgr_open();
 inpay_certmgr_close($res);
 inpay_certmgr_register_callback($res, $id, $function);
 inpay_certmgr_get_last_error($res);
 inpay_certmgr_get_last_error_code($res);
 inpay_certmgr_set($res, $id, $index, $value);
 inpay_certmgr_get($res, $id, $index);
 inpay_certmgr_do_config($res, $configurationstring);
 inpay_certmgr_do_createcertificate($res, $certsubject, $serialnumber);
 inpay_certmgr_do_createkey($res, $keyname);
 inpay_certmgr_do_deletecertificate($res);
 inpay_certmgr_do_deletekey($res, $keyname);
 inpay_certmgr_do_exportcertificate($res, $certfile, $password);
 inpay_certmgr_do_generatecsr($res, $certsubject, $keyname);
 inpay_certmgr_do_importcertificate($res, $certfile, $password, $subject);
 inpay_certmgr_do_importsignedcsr($res, $signedcsr, $keyname);
 inpay_certmgr_do_issuecertificate($res, $certsubject, $serialnumber);
 inpay_certmgr_do_listcertificatestores($res);
 inpay_certmgr_do_listkeys($res);
 inpay_certmgr_do_listmachinestores($res);
 inpay_certmgr_do_liststorecertificates($res);
 inpay_certmgr_do_readcertificate($res, $filename);
 inpay_certmgr_do_readcsr($res, $csr);
 inpay_certmgr_do_reset($res);
 inpay_certmgr_do_savecertificate($res, $filename);
 inpay_certmgr_do_showcertificatechain($res);
 inpay_certmgr_do_signcsr($res, $csr, $serialnumber);

Remarks

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

Method List

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

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.

Config Settings

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

CertEffectiveDate Property (InPay_CertMgr Class)

This is the date on which this certificate becomes valid.

Object Oriented Interface

public function getCertEffectiveDate();

Procedural Interface

inpay_certmgr_get($res, 1 );

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 (InPay_CertMgr Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getCertEncoded();


public function setCertEncoded($value);

Procedural Interface

inpay_certmgr_get($res, 2 );


inpay_certmgr_set($res, 2, $value );

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

Binary String

CertExpirationDate Property (InPay_CertMgr Class)

This is the date the certificate expires.

Object Oriented Interface

public function getCertExpirationDate();

Procedural Interface

inpay_certmgr_get($res, 3 );

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 (InPay_CertMgr Class)

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

Object Oriented Interface

public function getCertExtendedKeyUsage();


public function setCertExtendedKeyUsage($value);

Procedural Interface

inpay_certmgr_get($res, 4 );


inpay_certmgr_set($res, 4, $value );

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 (InPay_CertMgr Class)

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

Object Oriented Interface

public function getCertFingerprint();

Procedural Interface

inpay_certmgr_get($res, 5 );

Default Value

''

Remarks

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

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 (InPay_CertMgr Class)

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

Object Oriented Interface

public function getCertFingerprintSHA1();

Procedural Interface

inpay_certmgr_get($res, 6 );

Default Value

''

Remarks

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

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 (InPay_CertMgr Class)

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

Object Oriented Interface

public function getCertFingerprintSHA256();

Procedural Interface

inpay_certmgr_get($res, 7 );

Default Value

''

Remarks

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

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 (InPay_CertMgr Class)

This is the issuer of the certificate.

Object Oriented Interface

public function getCertIssuer();

Procedural Interface

inpay_certmgr_get($res, 8 );

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 (InPay_CertMgr Class)

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

Object Oriented Interface

public function getCertKeyPassword();


public function setCertKeyPassword($value);

Procedural Interface

inpay_certmgr_get($res, 9 );


inpay_certmgr_set($res, 9, $value );

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 (InPay_CertMgr Class)

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

Object Oriented Interface

public function getCertPrivateKey();

Procedural Interface

inpay_certmgr_get($res, 10 );

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 (InPay_CertMgr Class)

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

Object Oriented Interface

public function getCertPrivateKeyAvailable();

Procedural Interface

inpay_certmgr_get($res, 11 );

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 (InPay_CertMgr Class)

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

Object Oriented Interface

public function getCertPrivateKeyContainer();

Procedural Interface

inpay_certmgr_get($res, 12 );

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 (InPay_CertMgr Class)

This is the public key of the certificate.

Object Oriented Interface

public function getCertPublicKey();

Procedural Interface

inpay_certmgr_get($res, 13 );

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 (InPay_CertMgr Class)

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

Object Oriented Interface

public function getCertPublicKeyAlgorithm();


public function setCertPublicKeyAlgorithm($value);

Procedural Interface

inpay_certmgr_get($res, 14 );


inpay_certmgr_set($res, 14, $value );

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 (InPay_CertMgr Class)

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

Object Oriented Interface

public function getCertPublicKeyLength();

Procedural Interface

inpay_certmgr_get($res, 15 );

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 (InPay_CertMgr Class)

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

Object Oriented Interface

public function getCertSerialNumber();

Procedural Interface

inpay_certmgr_get($res, 16 );

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 (InPay_CertMgr Class)

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

Object Oriented Interface

public function getCertSignatureAlgorithm();

Procedural Interface

inpay_certmgr_get($res, 17 );

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 (InPay_CertMgr Class)

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

Object Oriented Interface

public function getCertSubject();


public function setCertSubject($value);

Procedural Interface

inpay_certmgr_get($res, 21 );


inpay_certmgr_set($res, 21, $value );

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.

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

Data Type

String

CertSubjectAltNames Property (InPay_CertMgr Class)

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

Object Oriented Interface

public function getCertSubjectAltNames();

Procedural Interface

inpay_certmgr_get($res, 22 );

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 (InPay_CertMgr Class)

This property contains the MD5 hash of the certificate.

Object Oriented Interface

public function getCertThumbprintMD5();

Procedural Interface

inpay_certmgr_get($res, 23 );

Default Value

''

Remarks

This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

CertThumbprintSHA1 Property (InPay_CertMgr Class)

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

Object Oriented Interface

public function getCertThumbprintSHA1();

Procedural Interface

inpay_certmgr_get($res, 24 );

Default Value

''

Remarks

This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

CertThumbprintSHA256 Property (InPay_CertMgr Class)

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

Object Oriented Interface

public function getCertThumbprintSHA256();

Procedural Interface

inpay_certmgr_get($res, 25 );

Default Value

''

Remarks

This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

CertUsage Property (InPay_CertMgr Class)

This property contains the text description of UsageFlags .

Object Oriented Interface

public function getCertUsage();


public function setCertUsage($value);

Procedural Interface

inpay_certmgr_get($res, 26 );


inpay_certmgr_set($res, 26, $value );

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 (InPay_CertMgr Class)

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

Object Oriented Interface

public function getCertUsageFlags();


public function setCertUsageFlags($value);

Procedural Interface

inpay_certmgr_get($res, 27 );


inpay_certmgr_set($res, 27, $value );

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:

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 (InPay_CertMgr Class)

This property contains the certificate's version number.

Object Oriented Interface

public function getCertVersion();

Procedural Interface

inpay_certmgr_get($res, 28 );

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 (InPay_CertMgr Class)

The number of records in the CertExtension arrays.

Object Oriented Interface

public function getCertExtensionCount();


public function setCertExtensionCount($value);

Procedural Interface

inpay_certmgr_get($res, 29 );


inpay_certmgr_set($res, 29, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• CertExtensionCritical
• CertExtensionOID
• CertExtensionValue

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

This property is not available at design time.

Data Type

Integer

CertExtensionCritical Property (InPay_CertMgr Class)

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

Object Oriented Interface

public function getCertExtensionCritical($certextensionindex);

Procedural Interface

inpay_certmgr_get($res, 30 , $certextensionindex);

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 (InPay_CertMgr Class)

This property contains the ASN.

Object Oriented Interface

public function getCertExtensionOID($certextensionindex);

Procedural Interface

inpay_certmgr_get($res, 31 , $certextensionindex);

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 (InPay_CertMgr Class)

This property contains the raw value of the certificate extension.

Object Oriented Interface

public function getCertExtensionValue($certextensionindex);

Procedural Interface

inpay_certmgr_get($res, 32 , $certextensionindex);

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.

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

Binary String

CertStore Property (InPay_CertMgr Class)

This is the certificate store to search for certificates.

Object Oriented Interface

public function getCertStore();


public function setCertStore($value);

Procedural Interface

inpay_certmgr_get($res, 33 );


inpay_certmgr_set($res, 33, $value );

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:

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

Binary String

CertStorePassword Property (InPay_CertMgr Class)

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

Object Oriented Interface

public function getCertStorePassword();


public function setCertStorePassword($value);

Procedural Interface

inpay_certmgr_get($res, 34 );


inpay_certmgr_set($res, 34, $value );

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 (InPay_CertMgr Class)

This is the type of certificate store for CertStore .

Object Oriented Interface

public function getCertStoreType();


public function setCertStoreType($value);

Procedural Interface

inpay_certmgr_get($res, 35 );


inpay_certmgr_set($res, 35, $value );

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:

Data Type

Integer

ExportedCert Property (InPay_CertMgr Class)

This is the exported certificate string.

Object Oriented Interface

public function getExportedCert();

Procedural Interface

inpay_certmgr_get($res, 36 );

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

Binary String

ExportFormat Property (InPay_CertMgr Class)

This is the format to which the certificate is exported.

Object Oriented Interface

public function getExportFormat();


public function setExportFormat($value);

Procedural Interface

inpay_certmgr_get($res, 37 );


inpay_certmgr_set($res, 37, $value );

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.

-----BEGIN CERTIFICATE-----
MIIBkTCB+6ADAgECAgEBMA0GCSqGSIb3DQEBBQUAMA4xDDAKBgNVBAMTAzEwMDAgFw0wNzAx
...
Pg49SpQ+HcUibIpum2O0hmnySH7BPGfXD8Lu
-----END CERTIFICATE-----

-----BEGIN RSA PRIVATE KEY-----
MIICWwIBAAKBgQD5/STHUd7YkN1JyoyYnUvCf+Fyx1+ZleBJxvwDcm3yaZ98bvry
...
91y8ydb3mQ9l1hZudo2sj8tHnvEgph0r7B8hMM6Qaw==
-----END RSA PRIVATE KEY-----

-----BEGIN RSA PUBLIC KEY-----
MIGJAoGBALAyxV5assz+9v7aHbj93NYN5uGB/1z7kb2Nx4hj02QyRYbcD4htkhK4Qcq2GCsG
...
MxW4+pdeN4oEZ6rbMZt01bvMwNRX2GDEyQBhAgMBAAE=
-----END RSA PUBLIC KEY-----

-----BEGIN RSA PRIVATE KEY-----
MIICWwIBAAKBgQD5/STHUd7YkN1JyoyYnUvCf+Fyx1+ZleBJxvwDcm3yaZ98bvry
...
91y8ydb3mQ9l1hZudo2sj8tHnvEgph0r7B8hMM6Qaw==
-----END RSA PRIVATE KEY-----

-----BEGIN PUBLIC KEY-----
MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCxdTNtpJQbw90cq6aJEx5vRIBrAiCAB9/F
...
8UdUliXeU8UGYjVcMhGy5oPsVeBXGcPAqF2mjXdBKNnzlSlctOLnYRBS5jwRuNfTQQIDAQAB
-----END PUBLIC KEY-----

-----BEGIN PRIVATE KEY-----
MIICdQIBADANBgkqhkiG9w0BAQEFAASCAl8wggJbAgEAAoGBAPn9JMdR3tiQ3UnK
...
HSvsHyEwzpBr
-----END PRIVATE KEY-----

ssh-rsa AAAAB3NzaC1y...

-----BEGIN OPENSSH PRIVATE KEY-----
b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAlwAAAAdzc2gtcnNh
...
AwQFBgcICQo=
-----END OPENSSH PRIVATE KEY-----

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

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

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

{
	"kty": "EC",
	"crv": "P-256",
	"x": "M_P_uqzP43FYW-kXWlpEDlX3nPZUr1QaMllAxUnao7w",
	"y": "zRFhp7iCXYIoTgerQ4LjGPTujodlimrwIMk-3enj_1Q"
}

{
	"kty": "EC",
	"crv": "P-256",
	"x": "M_P_uqzP43FYW-kXWlpEDlX3nPZUr1QaMllAxUnao7w",
	"y": "zRFhp7iCXYIoTgerQ4LjGPTujodlimrwIMk-3enj_1Q",
	"d": "eFBtl-uaB9Y4b-CIav5IYX4gGRFBvpBmrMOOQ7L-euI"
}

<X509Data>
	<X509Certificate>MIIB...D8Lu</X509Certificate>
</X509Data>

<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 (InPay_CertMgr Class)

This controls whether to export the private key.

Object Oriented Interface

public function getExportPrivateKey();


public function setExportPrivateKey($value);

Procedural Interface

inpay_certmgr_get($res, 38 );


inpay_certmgr_set($res, 38, $value );

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 (InPay_CertMgr Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

inpay_certmgr_do_config($res, $configurationstring);

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.

CreateCertificate Method (InPay_CertMgr Class)

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

Object Oriented Interface

public function doCreateCertificate($certsubject, $serialnumber);

Procedural Interface

inpay_certmgr_do_createcertificate($res, $certsubject, $serialnumber);

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.

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.

CreateKey Method (InPay_CertMgr Class)

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

Object Oriented Interface

public function doCreateKey($keyname);

Procedural Interface

inpay_certmgr_do_createkey($res, $keyname);

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.

DeleteCertificate Method (InPay_CertMgr Class)

This method deletes the currently selected certificate from the store.

Object Oriented Interface

public function doDeleteCertificate();

Procedural Interface

inpay_certmgr_do_deletecertificate($res);

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.

DeleteKey Method (InPay_CertMgr Class)

This method deletes the keyset associated with the provided name.

Object Oriented Interface

public function doDeleteKey($keyname);

Procedural Interface

inpay_certmgr_do_deletekey($res, $keyname);

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.

ExportCertificate Method (InPay_CertMgr Class)

This method exports the currently selected certificate.

Object Oriented Interface

public function doExportCertificate($certfile, $password);

Procedural Interface

inpay_certmgr_do_exportcertificate($res, $certfile, $password);

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.

-----BEGIN CERTIFICATE-----
MIIBkTCB+6ADAgECAgEBMA0GCSqGSIb3DQEBBQUAMA4xDDAKBgNVBAMTAzEwMDAgFw0wNzAx
...
Pg49SpQ+HcUibIpum2O0hmnySH7BPGfXD8Lu
-----END CERTIFICATE-----

-----BEGIN RSA PRIVATE KEY-----
MIICWwIBAAKBgQD5/STHUd7YkN1JyoyYnUvCf+Fyx1+ZleBJxvwDcm3yaZ98bvry
...
91y8ydb3mQ9l1hZudo2sj8tHnvEgph0r7B8hMM6Qaw==
-----END RSA PRIVATE KEY-----

-----BEGIN RSA PUBLIC KEY-----
MIGJAoGBALAyxV5assz+9v7aHbj93NYN5uGB/1z7kb2Nx4hj02QyRYbcD4htkhK4Qcq2GCsG
...
MxW4+pdeN4oEZ6rbMZt01bvMwNRX2GDEyQBhAgMBAAE=
-----END RSA PUBLIC KEY-----

-----BEGIN RSA PRIVATE KEY-----
MIICWwIBAAKBgQD5/STHUd7YkN1JyoyYnUvCf+Fyx1+ZleBJxvwDcm3yaZ98bvry
...
91y8ydb3mQ9l1hZudo2sj8tHnvEgph0r7B8hMM6Qaw==
-----END RSA PRIVATE KEY-----

-----BEGIN PUBLIC KEY-----
MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCxdTNtpJQbw90cq6aJEx5vRIBrAiCAB9/F
...
8UdUliXeU8UGYjVcMhGy5oPsVeBXGcPAqF2mjXdBKNnzlSlctOLnYRBS5jwRuNfTQQIDAQAB
-----END PUBLIC KEY-----

-----BEGIN PRIVATE KEY-----
MIICdQIBADANBgkqhkiG9w0BAQEFAASCAl8wggJbAgEAAoGBAPn9JMdR3tiQ3UnK
...
HSvsHyEwzpBr
-----END PRIVATE KEY-----

ssh-rsa AAAAB3NzaC1y...

-----BEGIN OPENSSH PRIVATE KEY-----
b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAlwAAAAdzc2gtcnNh
...
AwQFBgcICQo=
-----END OPENSSH PRIVATE KEY-----

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

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

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

{
	"kty": "EC",
	"crv": "P-256",
	"x": "M_P_uqzP43FYW-kXWlpEDlX3nPZUr1QaMllAxUnao7w",
	"y": "zRFhp7iCXYIoTgerQ4LjGPTujodlimrwIMk-3enj_1Q"
}

{
	"kty": "EC",
	"crv": "P-256",
	"x": "M_P_uqzP43FYW-kXWlpEDlX3nPZUr1QaMllAxUnao7w",
	"y": "zRFhp7iCXYIoTgerQ4LjGPTujodlimrwIMk-3enj_1Q",
	"d": "eFBtl-uaB9Y4b-CIav5IYX4gGRFBvpBmrMOOQ7L-euI"
}

<X509Data>
	<X509Certificate>MIIB...D8Lu</X509Certificate>
</X509Data>

<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", "");

GenerateCSR Method (InPay_CertMgr Class)

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

Object Oriented Interface

public function doGenerateCSR($certsubject, $keyname);

Procedural Interface

inpay_certmgr_do_generatecsr($res, $certsubject, $keyname);

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.

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

NOTE: This functionality is only available in Windows.

ImportCertificate Method (InPay_CertMgr Class)

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

Object Oriented Interface

public function doImportCertificate($certfile, $password, $subject);

Procedural Interface

inpay_certmgr_do_importcertificate($res, $certfile, $password, $subject);

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", "", "*");

ImportSignedCSR Method (InPay_CertMgr Class)

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

Object Oriented Interface

public function doImportSignedCSR($signedcsr, $keyname);

Procedural Interface

inpay_certmgr_do_importsignedcsr($res, $signedcsr, $keyname);

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.

IssueCertificate Method (InPay_CertMgr Class)

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

Object Oriented Interface

public function doIssueCertificate($certsubject, $serialnumber);

Procedural Interface

inpay_certmgr_do_issuecertificate($res, $certsubject, $serialnumber);

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.

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.

ListCertificateStores Method (InPay_CertMgr Class)

This lists the certificate stores.

Object Oriented Interface

public function doListCertificateStores();

Procedural Interface

inpay_certmgr_do_listcertificatestores($res);

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.

ListKeys Method (InPay_CertMgr Class)

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

Object Oriented Interface

public function doListKeys();

Procedural Interface

inpay_certmgr_do_listkeys($res);

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.

ListMachineStores Method (InPay_CertMgr Class)

This lists the machine certificate stores.

Object Oriented Interface

public function doListMachineStores();

Procedural Interface

inpay_certmgr_do_listmachinestores($res);

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.

ListStoreCertificates Method (InPay_CertMgr Class)

This lists the certificates in a store.

Object Oriented Interface

public function doListStoreCertificates();

Procedural Interface

inpay_certmgr_do_liststorecertificates($res);

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.

ReadCertificate Method (InPay_CertMgr Class)

This loads a certificate from a file.

Object Oriented Interface

public function doReadCertificate($filename);

Procedural Interface

inpay_certmgr_do_readcertificate($res, $filename);

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.

ReadCSR Method (InPay_CertMgr Class)

This reads a Certificate Signing Request (CSR).

Object Oriented Interface

public function doReadCSR($csr);

Procedural Interface

inpay_certmgr_do_readcsr($res, $csr);

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:

• CertSubject
• CertPublicKeyLength
• CertPublicKeyAlgorithm

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:

Reset Method (InPay_CertMgr Class)

This resets all certificate properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

inpay_certmgr_do_reset($res);

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.

SaveCertificate Method (InPay_CertMgr Class)

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

Object Oriented Interface

public function doSaveCertificate($filename);

Procedural Interface

inpay_certmgr_do_savecertificate($res, $filename);

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.

ShowCertificateChain Method (InPay_CertMgr Class)

This shows the certificate chain.

Object Oriented Interface

public function doShowCertificateChain();

Procedural Interface

inpay_certmgr_do_showcertificatechain($res);

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.

SignCSR Method (InPay_CertMgr Class)

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

Object Oriented Interface

public function doSignCSR($csr, $serialnumber);

Procedural Interface

inpay_certmgr_do_signcsr($res, $csr, $serialnumber);

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.

CertChain Event (InPay_CertMgr Class)

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

Object Oriented Interface

public function fireCertChain($param);

Procedural Interface

inpay_certmgr_register_callback($res, 1, array($this, 'fireCertChain'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'certserialnumber'
 'truststatus'
 'trustinfo'

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:

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:

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

CertList Event (InPay_CertMgr Class)

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

Object Oriented Interface

public function fireCertList($param);

Procedural Interface

inpay_certmgr_register_callback($res, 2, array($this, 'fireCertList'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'certserialnumber'
 'hasprivatekey'

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 (InPay_CertMgr Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

inpay_certmgr_register_callback($res, 3, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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 (InPay_CertMgr Class)

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

Object Oriented Interface

public function fireKeyList($param);

Procedural Interface

inpay_certmgr_register_callback($res, 4, array($this, 'fireKeyList'));

Parameter List

 'keycontainer'
 'keytype'
 'algid'
 'keylen'

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 (InPay_CertMgr Class)

This event fires once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

inpay_certmgr_register_callback($res, 5, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

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:

Message is the log entry.

LogType identifies the type of log entry.

StoreList Event (InPay_CertMgr Class)

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

Object Oriented Interface

public function fireStoreList($param);

Procedural Interface

inpay_certmgr_register_callback($res, 6, array($this, 'fireStoreList'));

Parameter List

 'certstore'

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.

Config Settings (CertMgr Class)

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.