SSHKeyManager Class

Properties   Methods   Events   Config Settings   Errors  

The SSHKeyManager class provides access to SSH key management functions.

Class Name

SecureBlackbox_SSHKeyManager

Procedural Interface

 secureblackbox_sshkeymanager_open();
 secureblackbox_sshkeymanager_close($res);
 secureblackbox_sshkeymanager_register_callback($res, $id, $function);
 secureblackbox_sshkeymanager_get_last_error($res);
 secureblackbox_sshkeymanager_get_last_error_code($res);
 secureblackbox_sshkeymanager_set($res, $id, $index, $value);
 secureblackbox_sshkeymanager_get($res, $id, $index);
 secureblackbox_sshkeymanager_do_config($res, $configurationstring);
 secureblackbox_sshkeymanager_do_createnew($res);
 secureblackbox_sshkeymanager_do_doaction($res, $actionid, $actionparams);
 secureblackbox_sshkeymanager_do_exportbytes($res, $format, $privatekey, $password);
 secureblackbox_sshkeymanager_do_exporttocert($res);
 secureblackbox_sshkeymanager_do_exporttocryptokey($res);
 secureblackbox_sshkeymanager_do_exporttofile($res, $filename, $format, $privatekey, $password);
 secureblackbox_sshkeymanager_do_generate($res, $keyalgorithm, $scheme, $schemeparams, $keybits);
 secureblackbox_sshkeymanager_do_getkeyparam($res, $name);
 secureblackbox_sshkeymanager_do_getkeyparamstr($res, $name);
 secureblackbox_sshkeymanager_do_importbytes($res, $bytes, $password);
 secureblackbox_sshkeymanager_do_importfromcert($res);
 secureblackbox_sshkeymanager_do_importfromcryptokey($res);
 secureblackbox_sshkeymanager_do_importfromfile($res, $path, $password);
 secureblackbox_sshkeymanager_do_reset($res);
 secureblackbox_sshkeymanager_do_setkeyparam($res, $name, $value);
 secureblackbox_sshkeymanager_do_setkeyparamstr($res, $name, $valuestr);

Remarks

SSHKeyManager provides the capabilities of generating, storing, importing, and exporting SSH keys.

The SSHKeyManager class serves the following typical purposes:

• Loading private keys to be used with client-side 'public key' authentication.
• Loading private keys to be used as server host keys.
• Loading known public keys for peer authenticity validation.
• Generating new keypairs for client or server authentication.
• Changing passwords on existing keys.

Importing keys

To import a key, call one of the Import*() methods. Apart from importing from a buffer or file, SSHKeyManager lets you import keys from X.509 certificates (ImportFromCert) and raw cryptographic keys (ImportFromCryptoKey).

SSHKeyManager supports most of the widely used key formats: OpenSSH (v1 and v2), Putty (including v3), IETF, and binary.

Generating keypairs

To generate a keypair, call CreateNew, followed by Generate. The details of the newly generated key will become available in the Key object.

Once the key has been generated, save it to a file (ExportToFile) or elsewhere. Make sure to save both parts of the keypair (public and private).

Using SSHKeyManager with SSHClient and SFTPClient

One of the uses of SSHKeyManager with client-side SSH classes is for setting up private keys for client authentication. Use the component as following:

• Import the private key as described above.
• Make sure the details of the key in the Key object are correct.
• Assign the Key object to the SSH or SFTP client's Key property.

Using SSHKeyManager with SFTPServer

In a similar way, SSHKeyManager can be used to configure the host key on the server side:

• Import the private key as described above.
• Make sure the details of the Key are correct.
• Add the Key object to the SFTPServer's ServerKeys collection.

Note: you can have more than one host key attached to the server. This is often the case where the server owner wants it to support various public key algorithms.

Supported algorithms

SSHKeyManager supports all popular SSH public key algorithms: RSA, ECDSA, EdDSA, and DSS.

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.

CertBytes Property (SecureBlackbox_SSHKeyManager Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getCertBytes();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 1 );

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

CertCA Property (SecureBlackbox_SSHKeyManager Class)

Indicates whether the certificate has a CA capability.

Object Oriented Interface

public function getCertCA();
public function setCertCA($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 2 );
secureblackbox_sshkeymanager_set($res, 2, $value );

Default Value

false

Remarks

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.

This property is not available at design time.

Data Type

Boolean

CertCAKeyID Property (SecureBlackbox_SSHKeyManager Class)

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Object Oriented Interface

public function getCertCAKeyID();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 3 );

Remarks

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the CertSubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

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

Data Type

Byte Array

CertCertType Property (SecureBlackbox_SSHKeyManager Class)

Returns the type of the entity contained in the Certificate object.

Object Oriented Interface

public function getCertCertType();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 4 );

Default Value

0

Remarks

Returns the type of the entity contained in the Certificate object.

A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the CertificateManager class to load or create new certificate and certificate requests objects.

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

Data Type

Integer

CertCRLDistributionPoints Property (SecureBlackbox_SSHKeyManager Class)

Contains a list of locations of CRL distribution points used to check this certificate's validity.

Object Oriented Interface

public function getCertCRLDistributionPoints();
public function setCertCRLDistributionPoints($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 5 );
secureblackbox_sshkeymanager_set($res, 5, $value );

Default Value

''

Remarks

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

This property is not available at design time.

Data Type

String

CertCurve Property (SecureBlackbox_SSHKeyManager Class)

Specifies the elliptic curve associated with the certificate's public key.

Object Oriented Interface

public function getCertCurve();
public function setCertCurve($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 6 );
secureblackbox_sshkeymanager_set($res, 6, $value );

Default Value

''

Remarks

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.

This property is not available at design time.

Data Type

String

CertFingerprint Property (SecureBlackbox_SSHKeyManager Class)

Contains the fingerprint (a hash imprint) of this certificate.

Object Oriented Interface

public function getCertFingerprint();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 7 );

Default Value

''

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

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

Data Type

String

CertFriendlyName Property (SecureBlackbox_SSHKeyManager Class)

Contains an associated alias (friendly name) of the certificate.

Object Oriented Interface

public function getCertFriendlyName();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 8 );

Default Value

''

Remarks

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

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

Data Type

String

CertHandle Property (SecureBlackbox_SSHKeyManager Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getCertHandle();
public function setCertHandle($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 9 );
secureblackbox_sshkeymanager_set($res, 9, $value );

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

CertHashAlgorithm Property (SecureBlackbox_SSHKeyManager Class)

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).

Object Oriented Interface

public function getCertHashAlgorithm();
public function setCertHashAlgorithm($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 10 );
secureblackbox_sshkeymanager_set($res, 10, $value );

Default Value

''

Remarks

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use CertSigAlgorithm to find out the hash algorithm that is part of the certificate signature.

This property is not available at design time.

Data Type

String

CertIssuer Property (SecureBlackbox_SSHKeyManager Class)

The common name of the certificate issuer (CA), typically a company name.

Object Oriented Interface

public function getCertIssuer();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 11 );

Default Value

''

Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via CertIssuerRDN.

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

Data Type

String

CertIssuerRDN Property (SecureBlackbox_SSHKeyManager Class)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Object Oriented Interface

public function getCertIssuerRDN();
public function setCertIssuerRDN($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 12 );
secureblackbox_sshkeymanager_set($res, 12, $value );

Default Value

''

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

This property is not available at design time.

Data Type

String

CertKeyAlgorithm Property (SecureBlackbox_SSHKeyManager Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getCertKeyAlgorithm();
public function setCertKeyAlgorithm($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 13 );
secureblackbox_sshkeymanager_set($res, 13, $value );

Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

Use the CertKeyBits, CertCurve, and CertPublicKeyBytes properties to get more details about the key the certificate contains.

This property is not available at design time.

Data Type

String

CertKeyBits Property (SecureBlackbox_SSHKeyManager Class)

Returns the length of the public key in bits.

Object Oriented Interface

public function getCertKeyBits();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 14 );

Default Value

0

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the CertPublicKeyBytes or CertPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

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

Data Type

Integer

CertKeyFingerprint Property (SecureBlackbox_SSHKeyManager Class)

Returns a SHA1 fingerprint of the public key contained in the certificate.

Object Oriented Interface

public function getCertKeyFingerprint();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 15 );

Default Value

''

Remarks

Returns a SHA1 fingerprint of the public key contained in the certificate.

Note that the key fingerprint is different from the certificate fingerprint accessible via the CertFingerprint property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

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

Data Type

String

CertKeyUsage Property (SecureBlackbox_SSHKeyManager Class)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Object Oriented Interface

public function getCertKeyUsage();
public function setCertKeyUsage($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 16 );
secureblackbox_sshkeymanager_set($res, 16, $value );

Default Value

0

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

This property is not available at design time.

Data Type

Integer

CertKeyValid Property (SecureBlackbox_SSHKeyManager Class)

Returns True if the certificate's key is cryptographically valid, and False otherwise.

Object Oriented Interface

public function getCertKeyValid();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 17 );

Default Value

false

Remarks

Returns True if the certificate's key is cryptographically valid, and False otherwise.

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

Data Type

Boolean

CertOCSPLocations Property (SecureBlackbox_SSHKeyManager Class)

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Object Oriented Interface

public function getCertOCSPLocations();
public function setCertOCSPLocations($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 18 );
secureblackbox_sshkeymanager_set($res, 18, $value );

Default Value

''

Remarks

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this property before calling the certificate manager's Generate method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

This property is not available at design time.

Data Type

String

CertOCSPNoCheck Property (SecureBlackbox_SSHKeyManager Class)

Accessor to the value of the certificate's ocsp-no-check extension.

Object Oriented Interface

public function getCertOCSPNoCheck();
public function setCertOCSPNoCheck($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 19 );
secureblackbox_sshkeymanager_set($res, 19, $value );

Default Value

false

Remarks

Accessor to the value of the certificate's ocsp-no-check extension.

This property is not available at design time.

Data Type

Boolean

CertOrigin Property (SecureBlackbox_SSHKeyManager Class)

Returns the location that the certificate was taken or loaded from.

Object Oriented Interface

public function getCertOrigin();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 20 );

Default Value

0

Remarks

Returns the location that the certificate was taken or loaded from.

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

Data Type

Integer

CertPolicyIDs Property (SecureBlackbox_SSHKeyManager Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface

public function getCertPolicyIDs();
public function setCertPolicyIDs($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 21 );
secureblackbox_sshkeymanager_set($res, 21, $value );

Default Value

''

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

Set this property when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

This property is not available at design time.

Data Type

String

CertPrivateKeyBytes Property (SecureBlackbox_SSHKeyManager Class)

Returns the certificate's private key in DER-encoded format.

Object Oriented Interface

public function getCertPrivateKeyBytes();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 22 );

Remarks

Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.

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

Data Type

Byte Array

CertPrivateKeyExists Property (SecureBlackbox_SSHKeyManager Class)

Indicates whether the certificate has a usable private key associated with it.

Object Oriented Interface

public function getCertPrivateKeyExists();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 23 );

Default Value

false

Remarks

Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.

This property is independent from CertPrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

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

Data Type

Boolean

CertPrivateKeyExtractable Property (SecureBlackbox_SSHKeyManager Class)

Indicates whether the private key is extractable (exportable).

Object Oriented Interface

public function getCertPrivateKeyExtractable();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 24 );

Default Value

false

Remarks

Indicates whether the private key is extractable (exportable).

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

Data Type

Boolean

CertPublicKeyBytes Property (SecureBlackbox_SSHKeyManager Class)

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getCertPublicKeyBytes();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 25 );

Remarks

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

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

Data Type

Byte Array

CertQualified Property (SecureBlackbox_SSHKeyManager Class)

Indicates whether the certificate is qualified.

Object Oriented Interface

public function getCertQualified();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 26 );

Default Value

false

Remarks

Indicates whether the certificate is qualified.

This property is set to True if the certificate is confirmed by a Trusted List to be qualified.

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

Data Type

Boolean

CertQualifiedStatements Property (SecureBlackbox_SSHKeyManager Class)

Returns a simplified qualified status of the certificate.

Object Oriented Interface

public function getCertQualifiedStatements();
public function setCertQualifiedStatements($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 27 );
secureblackbox_sshkeymanager_set($res, 27, $value );

Default Value

0

Remarks

Returns a simplified qualified status of the certificate.

This property is not available at design time.

Data Type

Integer

CertQualifiers Property (SecureBlackbox_SSHKeyManager Class)

A list of qualifiers.

Object Oriented Interface

public function getCertQualifiers();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 28 );

Default Value

''

Remarks

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.

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

Data Type

String

CertSelfSigned Property (SecureBlackbox_SSHKeyManager Class)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Object Oriented Interface

public function getCertSelfSigned();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 29 );

Default Value

false

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

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

Data Type

Boolean

CertSerialNumber Property (SecureBlackbox_SSHKeyManager Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getCertSerialNumber();
public function setCertSerialNumber($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 30 );
secureblackbox_sshkeymanager_set($res, 30, $value );

Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

This property is not available at design time.

Data Type

Byte Array

CertSigAlgorithm Property (SecureBlackbox_SSHKeyManager Class)

Indicates the algorithm that was used by the CA to sign this certificate.

Object Oriented Interface

public function getCertSigAlgorithm();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 31 );

Default Value

''

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

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

Data Type

String

CertSource Property (SecureBlackbox_SSHKeyManager Class)

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Object Oriented Interface

public function getCertSource();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 32 );

Default Value

0

Remarks

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

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

Data Type

Integer

CertSubject Property (SecureBlackbox_SSHKeyManager Class)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Object Oriented Interface

public function getCertSubject();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 33 );

Default Value

''

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via CertSubjectRDN.

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

Data Type

String

CertSubjectAlternativeName Property (SecureBlackbox_SSHKeyManager Class)

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Object Oriented Interface

public function getCertSubjectAlternativeName();
public function setCertSubjectAlternativeName($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 34 );
secureblackbox_sshkeymanager_set($res, 34, $value );

Default Value

''

Remarks

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Subject alternative names are used to provide additional names that are impractical to store in the main CertSubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.

This property is not available at design time.

Data Type

String

CertSubjectKeyID Property (SecureBlackbox_SSHKeyManager Class)

Contains a unique identifier of the certificate's cryptographic key.

Object Oriented Interface

public function getCertSubjectKeyID();
public function setCertSubjectKeyID($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 35 );
secureblackbox_sshkeymanager_set($res, 35, $value );

Remarks

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The CertSubjectKeyID and CertCAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

This property is not available at design time.

Data Type

Byte Array

CertSubjectRDN Property (SecureBlackbox_SSHKeyManager Class)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Object Oriented Interface

public function getCertSubjectRDN();
public function setCertSubjectRDN($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 36 );
secureblackbox_sshkeymanager_set($res, 36, $value );

Default Value

''

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

This property is not available at design time.

Data Type

String

CertValid Property (SecureBlackbox_SSHKeyManager Class)

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

Object Oriented Interface

public function getCertValid();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 37 );

Default Value

false

Remarks

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

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

Data Type

Boolean

CertValidFrom Property (SecureBlackbox_SSHKeyManager Class)

The time point at which the certificate becomes valid, in UTC.

Object Oriented Interface

public function getCertValidFrom();
public function setCertValidFrom($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 38 );
secureblackbox_sshkeymanager_set($res, 38, $value );

Default Value

''

Remarks

The time point at which the certificate becomes valid, in UTC.

This property is not available at design time.

Data Type

String

CertValidTo Property (SecureBlackbox_SSHKeyManager Class)

The time point at which the certificate expires, in UTC.

Object Oriented Interface

public function getCertValidTo();
public function setCertValidTo($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 39 );
secureblackbox_sshkeymanager_set($res, 39, $value );

Default Value

''

Remarks

The time point at which the certificate expires, in UTC.

This property is not available at design time.

Data Type

String

CryptoKeyAlgorithm Property (SecureBlackbox_SSHKeyManager Class)

The algorithm of the cryptographic key.

Object Oriented Interface

public function getCryptoKeyAlgorithm();
public function setCryptoKeyAlgorithm($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 40 );
secureblackbox_sshkeymanager_set($res, 40, $value );

Default Value

''

Remarks

The algorithm of the cryptographic key. A cryptokey object may hold either symmetric, MAC, or public key. Public key algorithms: RSA, ECDSA, Elgamal, DH.

This property is not available at design time.

Data Type

String

CryptoKeyBits Property (SecureBlackbox_SSHKeyManager Class)

The length of the key in bits.

Object Oriented Interface

public function getCryptoKeyBits();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 41 );

Default Value

0

Remarks

The length of the key in bits.

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

Data Type

Integer

CryptoKeyCurve Property (SecureBlackbox_SSHKeyManager Class)

This property specifies the name of the curve the EC key is built on.

Object Oriented Interface

public function getCryptoKeyCurve();
public function setCryptoKeyCurve($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 42 );
secureblackbox_sshkeymanager_set($res, 42, $value );

Default Value

''

Remarks

This property specifies the name of the curve the EC key is built on.

This property is not available at design time.

Data Type

String

CryptoKeyExportable Property (SecureBlackbox_SSHKeyManager Class)

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

Object Oriented Interface

public function getCryptoKeyExportable();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 43 );

Default Value

false

Remarks

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

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

Data Type

Boolean

CryptoKeyFingerprint Property (SecureBlackbox_SSHKeyManager Class)

Contains the fingerprint (a hash imprint) of this key.

Object Oriented Interface

public function getCryptoKeyFingerprint();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 44 );

Default Value

''

Remarks

Contains the fingerprint (a hash imprint) of this key.

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

Data Type

String

CryptoKeyHandle Property (SecureBlackbox_SSHKeyManager Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getCryptoKeyHandle();
public function setCryptoKeyHandle($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 45 );
secureblackbox_sshkeymanager_set($res, 45, $value );

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

CryptoKeyID Property (SecureBlackbox_SSHKeyManager Class)

Provides access to a storage-specific key identifier.

Object Oriented Interface

public function getCryptoKeyID();
public function setCryptoKeyID($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 46 );
secureblackbox_sshkeymanager_set($res, 46, $value );

Remarks

Provides access to a storage-specific key identifier. Key identifiers are used by cryptographic providers to refer to a particular key and/or distinguish between different keys. They are typically unique within a storage, but there is no guarantee that a particular cryptoprovider will conform to that (or will assign any key IDs at all).

This property is not available at design time.

Data Type

Byte Array

CryptoKeyIV Property (SecureBlackbox_SSHKeyManager Class)

The initialization vector (IV) of a symmetric key.

Object Oriented Interface

public function getCryptoKeyIV();
public function setCryptoKeyIV($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 47 );
secureblackbox_sshkeymanager_set($res, 47, $value );

Remarks

The initialization vector (IV) of a symmetric key. This is normally a public part of a symmetric key, the idea of which is to introduce randomness to the encrypted data and/or serve as a first block in chaining ciphers.

This property is not available at design time.

Data Type

Byte Array

CryptoKeyKey Property (SecureBlackbox_SSHKeyManager Class)

The byte array representation of the key.

Object Oriented Interface

public function getCryptoKeyKey();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 48 );

Remarks

The byte array representation of the key. This may not be available for non-CryptoKeyExportable keys.

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

Data Type

Byte Array

CryptoKeyNonce Property (SecureBlackbox_SSHKeyManager Class)

A nonce value associated with a key.

Object Oriented Interface

public function getCryptoKeyNonce();
public function setCryptoKeyNonce($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 49 );
secureblackbox_sshkeymanager_set($res, 49, $value );

Remarks

A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness.

This property is not available at design time.

Data Type

Byte Array

CryptoKeyPrivate Property (SecureBlackbox_SSHKeyManager Class)

Returns True if the object hosts a private key, and False otherwise.

Object Oriented Interface

public function getCryptoKeyPrivate();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 50 );

Default Value

false

Remarks

Returns True if the object hosts a private key, and False otherwise.

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

Data Type

Boolean

CryptoKeyPublic Property (SecureBlackbox_SSHKeyManager Class)

Returns True if the object hosts a public key, and False otherwise.

Object Oriented Interface

public function getCryptoKeyPublic();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 51 );

Default Value

false

Remarks

Returns True if the object hosts a public key, and False otherwise.

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

Data Type

Boolean

CryptoKeySubject Property (SecureBlackbox_SSHKeyManager Class)

Returns the key subject.

Object Oriented Interface

public function getCryptoKeySubject();
public function setCryptoKeySubject($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 52 );
secureblackbox_sshkeymanager_set($res, 52, $value );

Remarks

Returns the key subject. This is a cryptoprovider-dependent value, which normally aims to provide some user-friendly insight into the key owner.

This property is not available at design time.

Data Type

Byte Array

CryptoKeySymmetric Property (SecureBlackbox_SSHKeyManager Class)

Returns True if the object contains a symmetric key, and False otherwise.

Object Oriented Interface

public function getCryptoKeySymmetric();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 53 );

Default Value

false

Remarks

Returns True if the object contains a symmetric key, and False otherwise.

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

Data Type

Boolean

CryptoKeyValid Property (SecureBlackbox_SSHKeyManager Class)

Returns True if this key is valid.

Object Oriented Interface

public function getCryptoKeyValid();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 54 );

Default Value

false

Remarks

Returns True if this key is valid. The term Valid highly depends on the kind of the key being stored. A symmetric key is considered valid if its length fits the algorithm being set. The validity of an RSA key also ensures that the RSA key elements (primes, exponents, and modulus) are consistent.

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

Data Type

Boolean

FIPSMode Property (SecureBlackbox_SSHKeyManager Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();
public function setFIPSMode($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 55 );
secureblackbox_sshkeymanager_set($res, 55, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

KeyAlgorithm Property (SecureBlackbox_SSHKeyManager Class)

Specifies the key algorithm.

Object Oriented Interface

public function getKeyAlgorithm();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 56 );

Default Value

''

Remarks

Specifies the key algorithm.

The following algorithms are currently supported:

• RSA
• DSS
• ECDSA
• EDDSA

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

Data Type

String

KeyBits Property (SecureBlackbox_SSHKeyManager Class)

The number of bits in the key: the more the better, 2048 or 4096 are typical values.

Object Oriented Interface

public function getKeyBits();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 57 );

Default Value

0

Remarks

The number of bits in the key: the more the better, 2048 or 4096 are typical values.

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

Data Type

Integer

KeyComment Property (SecureBlackbox_SSHKeyManager Class)

The comment for the public key.

Object Oriented Interface

public function getKeyComment();
public function setKeyComment($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 58 );
secureblackbox_sshkeymanager_set($res, 58, $value );

Default Value

''

Remarks

The comment for the public key.

This property is not available at design time.

Data Type

String

KeyCurve Property (SecureBlackbox_SSHKeyManager Class)

Specifies the elliptical curve when EC cryptography is used.

Object Oriented Interface

public function getKeyCurve();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 59 );

Default Value

''

Remarks

Specifies the elliptical curve when EC cryptography is used.

The following curves are currently supported:

• NISTP256
• NISTP384
• NISTP521
• NISTK163
• NISTP192
• NISTP224
• NISTK233
• NISTB233
• NISTK283
• NISTK409
• NISTB409
• NISTK571
• CURVE25519 (EdDSA curve)
• CURVE448 (EdDSA curve)

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

Data Type

String

KeyDSSG Property (SecureBlackbox_SSHKeyManager Class)

The G (Generator) parameter of the DSS signature key.

Object Oriented Interface

public function getKeyDSSG();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 60 );

Remarks

The G (Generator) parameter of the DSS signature key. The string should contain the binary data of G.

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

Data Type

Byte Array

KeyDSSP Property (SecureBlackbox_SSHKeyManager Class)

The P (Prime) parameter of the DSS signature key.

Object Oriented Interface

public function getKeyDSSP();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 61 );

Remarks

The P (Prime) parameter of the DSS signature key. The string should contain the binary data of P.

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

Data Type

Byte Array

KeyDSSQ Property (SecureBlackbox_SSHKeyManager Class)

The Q (Prime Factor) parameter of the DSS signature key.

Object Oriented Interface

public function getKeyDSSQ();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 62 );

Remarks

The Q (Prime Factor) parameter of the DSS signature key. The string should contain the binary data of Q.

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

Data Type

Byte Array

KeyDSSX Property (SecureBlackbox_SSHKeyManager Class)

The X (Private key) parameter of the DSS signature key.

Object Oriented Interface

public function getKeyDSSX();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 63 );

Remarks

The X (Private key) parameter of the DSS signature key. The string should contain the binary data of X.

This parameter may be empty if there's no need to sign data with this key (e.g. if the key is a server public key needed only to authenticate the server).

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

Data Type

Byte Array

KeyDSSY Property (SecureBlackbox_SSHKeyManager Class)

The Y (Public key) parameter of the DSS signature key.

Object Oriented Interface

public function getKeyDSSY();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 64 );

Remarks

The Y (Public key) parameter of the DSS signature key. The string should contain the binary data of Y.

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

Data Type

Byte Array

KeyECCD Property (SecureBlackbox_SSHKeyManager Class)

The value of the secret key (the order of the public key, D) if elliptic curve (EC) cryptography is used.

Object Oriented Interface

public function getKeyECCD();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 65 );

Remarks

The value of the secret key (the order of the public key, D) if elliptic curve (EC) cryptography is used. The string should contain the binary data of D.

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

Data Type

Byte Array

KeyECCQX Property (SecureBlackbox_SSHKeyManager Class)

The value of the X coordinate of the public key if elliptic curve (EC) cryptography is used.

Object Oriented Interface

public function getKeyECCQX();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 66 );

Remarks

The value of the X coordinate of the public key if elliptic curve (EC) cryptography is used. The string should contain the binary data of X.

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

Data Type

Byte Array

KeyECCQY Property (SecureBlackbox_SSHKeyManager Class)

The value of the Y coordinate of the public key if elliptic curve (EC) cryptography is used.

Object Oriented Interface

public function getKeyECCQY();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 67 );

Remarks

The value of the Y coordinate of the public key if elliptic curve (EC) cryptography is used. The string should contain the binary data of Y.

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

Data Type

Byte Array

KeyEdPrivate Property (SecureBlackbox_SSHKeyManager Class)

The value of the private key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

Object Oriented Interface

public function getKeyEdPrivate();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 68 );

Remarks

The value of the private key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

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

Data Type

Byte Array

KeyEdPublic Property (SecureBlackbox_SSHKeyManager Class)

The value of the public key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

Object Oriented Interface

public function getKeyEdPublic();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 69 );

Remarks

The value of the public key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

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

Data Type

Byte Array

KeyFingerprintMD5 Property (SecureBlackbox_SSHKeyManager Class)

Contains the MD5 fingerprint (hash) of the key.

Object Oriented Interface

public function getKeyFingerprintMD5();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 70 );

Default Value

''

Remarks

Contains the MD5 fingerprint (hash) of the key.

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

Data Type

String

KeyFingerprintSHA1 Property (SecureBlackbox_SSHKeyManager Class)

Contains the SHA-1 fingerprint (hash) of the key.

Object Oriented Interface

public function getKeyFingerprintSHA1();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 71 );

Default Value

''

Remarks

Contains the SHA-1 fingerprint (hash) of the key.

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

Data Type

String

KeyFingerprintSHA256 Property (SecureBlackbox_SSHKeyManager Class)

Contains the SHA-256 fingerprint (hash) of the key.

Object Oriented Interface

public function getKeyFingerprintSHA256();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 72 );

Default Value

''

Remarks

Contains the SHA-256 fingerprint (hash) of the key.

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

Data Type

String

KeyHandle Property (SecureBlackbox_SSHKeyManager Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getKeyHandle();
public function setKeyHandle($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 73 );
secureblackbox_sshkeymanager_set($res, 73, $value );

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

KeyIsExtractable Property (SecureBlackbox_SSHKeyManager Class)

Whether the key is extractable (e.

Object Oriented Interface

public function getKeyIsExtractable();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 74 );

Default Value

false

Remarks

Whether the key is extractable (e.g., from a security token), or not.

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

Data Type

Boolean

KeyIsPrivate Property (SecureBlackbox_SSHKeyManager Class)

Whether this key is a private key or not.

Object Oriented Interface

public function getKeyIsPrivate();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 75 );

Default Value

false

Remarks

Whether this key is a private key or not.

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

Data Type

Boolean

KeyIsPublic Property (SecureBlackbox_SSHKeyManager Class)

Whether this key is a public key or not.

Object Oriented Interface

public function getKeyIsPublic();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 76 );

Default Value

false

Remarks

Whether this key is a public key or not.

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

Data Type

Boolean

KeyKDFRounds Property (SecureBlackbox_SSHKeyManager Class)

Returns the number of iterations of the Key Derivation Function (KDF) used to generate this key.

Object Oriented Interface

public function getKeyKDFRounds();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 77 );

Default Value

0

Remarks

Returns the number of iterations of the Key Derivation Function (KDF) used to generate this key.

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

Data Type

Integer

KeyKDFSalt Property (SecureBlackbox_SSHKeyManager Class)

The salt value used by the Key Derivation Function (KDF) to generate this key.

Object Oriented Interface

public function getKeyKDFSalt();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 78 );

Remarks

The salt value used by the Key Derivation Function (KDF) to generate this key.

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

Data Type

Byte Array

KeyKeyFormat Property (SecureBlackbox_SSHKeyManager Class)

Specifies the format in which the key is stored.

Object Oriented Interface

public function getKeyKeyFormat();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 79 );

Default Value

0

Remarks

Specifies the format in which the key is stored.

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

Data Type

Integer

KeyKeyProtectionAlgorithm Property (SecureBlackbox_SSHKeyManager Class)

Specifies the key protection algorithm.

Object Oriented Interface

public function getKeyKeyProtectionAlgorithm();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 80 );

Default Value

''

Remarks

Specifies the key protection algorithm.

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

Data Type

String

KeyRSAExponent Property (SecureBlackbox_SSHKeyManager Class)

Returns the e parameter (public exponent) of the RSA key.

Object Oriented Interface

public function getKeyRSAExponent();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 81 );

Remarks

Returns the e parameter (public exponent) of the RSA key.

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

Data Type

Byte Array

KeyRSAIQMP Property (SecureBlackbox_SSHKeyManager Class)

Returns the iqmp parameter of the RSA key.

Object Oriented Interface

public function getKeyRSAIQMP();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 82 );

Remarks

Returns the iqmp parameter of the RSA key.

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

Data Type

Byte Array

KeyRSAModulus Property (SecureBlackbox_SSHKeyManager Class)

Returns the m parameter (public modulus) of the RSA key.

Object Oriented Interface

public function getKeyRSAModulus();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 83 );

Remarks

Returns the m parameter (public modulus) of the RSA key.

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

Data Type

Byte Array

KeyRSAP Property (SecureBlackbox_SSHKeyManager Class)

Returns the p parameter (first factor of the common modulus n) of the RSA key.

Object Oriented Interface

public function getKeyRSAP();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 84 );

Remarks

Returns the p parameter (first factor of the common modulus n) of the RSA key.

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

Data Type

Byte Array

KeyRSAPrivateExponent Property (SecureBlackbox_SSHKeyManager Class)

Returns the d parameter (private exponent) of the RSA key.

Object Oriented Interface

public function getKeyRSAPrivateExponent();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 85 );

Remarks

Returns the d parameter (private exponent) of the RSA key.

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

Data Type

Byte Array

KeyRSAQ Property (SecureBlackbox_SSHKeyManager Class)

Returns the q parameter (second factor of the common modulus n) of the RSA key.

Object Oriented Interface

public function getKeyRSAQ();

Procedural Interface

secureblackbox_sshkeymanager_get($res, 86 );

Remarks

Returns the q parameter (second factor of the common modulus n) of the RSA key.

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

Data Type

Byte Array

KeySubject Property (SecureBlackbox_SSHKeyManager Class)

Specifies the public key owner (subject).

Object Oriented Interface

public function getKeySubject();
public function setKeySubject($value);

Procedural Interface

secureblackbox_sshkeymanager_get($res, 87 );
secureblackbox_sshkeymanager_set($res, 87, $value );

Default Value

''

Remarks

Specifies the public key owner (subject). This property is used only for IETF-keys.

This property is not available at design time.

Data Type

String

Config Method (SecureBlackbox_SSHKeyManager Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_sshkeymanager_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.

CreateNew Method (SecureBlackbox_SSHKeyManager Class)

Creates a template for a new keypair.

Object Oriented Interface

public function doCreateNew();

Procedural Interface

secureblackbox_sshkeymanager_do_createnew($res);

Remarks

This method pre-generates a template for a new key.

Adjust the properties of the Key object and call Generate to complete the generation.

DoAction Method (SecureBlackbox_SSHKeyManager Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_sshkeymanager_do_doaction($res, $actionid, $actionparams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Common ActionIDs:

ExportBytes Method (SecureBlackbox_SSHKeyManager Class)

Writes the key to a memory buffer.

Object Oriented Interface

public function doExportBytes($format, $privatekey, $password);

Procedural Interface

secureblackbox_sshkeymanager_do_exportbytes($res, $format, $privatekey, $password);

Remarks

Use this method to save Key in the buffer. Format specifies the format in which the key should be stored, as following:

The PrivateKey parameter tells whether it the private (or public, otherwise) key should be exported. The Password defines the password that should be used to encrypt the private key.

ExportToCert Method (SecureBlackbox_SSHKeyManager Class)

Exports the key to a certificate.

Object Oriented Interface

public function doExportToCert();

Procedural Interface

secureblackbox_sshkeymanager_do_exporttocert($res);

Remarks

Use this method to save the Key (both the public and secret parts) to the certificate specified in Certificate.

ExportToCryptoKey Method (SecureBlackbox_SSHKeyManager Class)

Exports the key to a crypto key object.

Object Oriented Interface

public function doExportToCryptoKey();

Procedural Interface

secureblackbox_sshkeymanager_do_exporttocryptokey($res);

Remarks

Use this method to save the Key (both the public and secret parts) to the crypto key provided via CryptoKey.

ExportToFile Method (SecureBlackbox_SSHKeyManager Class)

Writes key to file.

Object Oriented Interface

public function doExportToFile($filename, $format, $privatekey, $password);

Procedural Interface

secureblackbox_sshkeymanager_do_exporttofile($res, $filename, $format, $privatekey, $password);

Remarks

Use this method to save Key in the file. Format specifies the format in which the key should be stored, as following:

The PrivateKey parameter tells whether it the private (or public, otherwise) key should be exported. Path designates the path to the file that the key should be written to, and Password defines the password that should be used to encrypt the private key.

Generate Method (SecureBlackbox_SSHKeyManager Class)

Generates a new SSH key.

Object Oriented Interface

public function doGenerate($keyalgorithm, $scheme, $schemeparams, $keybits);

Procedural Interface

secureblackbox_sshkeymanager_do_generate($res, $keyalgorithm, $scheme, $schemeparams, $keybits);

Remarks

Call this method to generate a new key or keypair with the desired KeyAlgorithm and KeyBits of length.

The generated key will be populated in the Key property.

The KeyAlgorithm parameter supports the following algorithm identifiers:

• RSA
• DSS
• ECDSA
• EDDSA

If using ECDSA, the following curves are supported (to be passed as the Scheme parameter):

• NISTP256
• NISTP384
• NISTP521
• NISTK163
• NISTP192
• NISTP224
• NISTK233
• NISTB233
• NISTK283
• NISTK409
• NISTB409
• NISTK571

The following curves can also be used with EDDSA:

• CURVE25519
• CURVE448

// generating a curve25519 keypair KeyMgr.Generate("EDDSA", "CURVE25519", "", 0); // generating an ECDSA/P521 key KeyMgr.Generate("ECDSA", "NISTP521", "", 521); // generating an RSA key KeyMgr.Generate("RSA", "", "", 2048);

GetKeyParam Method (SecureBlackbox_SSHKeyManager Class)

Returns an algorithm-specific key parameter.

Object Oriented Interface

public function doGetKeyParam($name);

Procedural Interface

secureblackbox_sshkeymanager_do_getkeyparam($res, $name);

Remarks

Use this method to retrieve an algorithm-specific key parameter.

GetKeyParamStr Method (SecureBlackbox_SSHKeyManager Class)

Returns an algorithm-specific key parameter to a string.

Object Oriented Interface

public function doGetKeyParamStr($name);

Procedural Interface

secureblackbox_sshkeymanager_do_getkeyparamstr($res, $name);

Remarks

Use this method to get an algorithm-specific key parameter to a string.

The only parameter currently supported is 'Headers', which provides access to key file headers where PEM-like format is used.

ImportBytes Method (SecureBlackbox_SSHKeyManager Class)

Loads key from buffer.

Object Oriented Interface

public function doImportBytes($bytes, $password);

Procedural Interface

secureblackbox_sshkeymanager_do_importbytes($res, $bytes, $password);

Remarks

Use this method to read a key stored in a buffer. Password specifies a password to decrypt the private key.

This method automatically recognizes the format that the key is stored in.

ImportFromCert Method (SecureBlackbox_SSHKeyManager Class)

Loads a key from a certificate.

Object Oriented Interface

public function doImportFromCert();

Procedural Interface

secureblackbox_sshkeymanager_do_importfromcert($res);

Remarks

Use this method to load a key, either public or secret, from a certificate.

ImportFromCryptoKey Method (SecureBlackbox_SSHKeyManager Class)

Imports a key from a crypto key.

Object Oriented Interface

public function doImportFromCryptoKey();

Procedural Interface

secureblackbox_sshkeymanager_do_importfromcryptokey($res);

Remarks

Use this method to load a key, either public or private, from a crypto key. Provide the key via CryptoKey property.

ImportFromFile Method (SecureBlackbox_SSHKeyManager Class)

Loads key from file.

Object Oriented Interface

public function doImportFromFile($path, $password);

Procedural Interface

secureblackbox_sshkeymanager_do_importfromfile($res, $path, $password);

Remarks

Use this method to read a key stored in a file. Path specifies the full path to the file, Password is a password to decrypt the private key.

This method automatically recognizes the format that the key is stored in.

Reset Method (SecureBlackbox_SSHKeyManager Class)

Resets the class settings.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_sshkeymanager_do_reset($res);

Remarks

Reset is a generic method available in every class.

SetKeyParam Method (SecureBlackbox_SSHKeyManager Class)

Sets an algorithm-specific key parameter.

Object Oriented Interface

public function doSetKeyParam($name, $value);

Procedural Interface

secureblackbox_sshkeymanager_do_setkeyparam($res, $name, $value);

Remarks

Use this method to set an algorithm-specific key parameter.

SetKeyParamStr Method (SecureBlackbox_SSHKeyManager Class)

Sets an algorithm-specific key parameter.

Object Oriented Interface

public function doSetKeyParamStr($name, $valuestr);

Procedural Interface

secureblackbox_sshkeymanager_do_setkeyparamstr($res, $name, $valuestr);

Remarks

Use this method to set an algorithm-specific key parameter provided in a string.

The only parameter currently supported is 'Headers', which provides access to key file headers where PEM-like format is used.

Error Event (SecureBlackbox_SSHKeyManager Class)

Information about errors during SSH key management.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_sshkeymanager_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The event is fired in case of exceptional conditions during key management.

ErrorCode contains an error code and Description contains a textual description of the error.

Notification Event (SecureBlackbox_SSHKeyManager Class)

This event notifies the application about an underlying control flow event.

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_sshkeymanager_register_callback($res, 2, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

Config Settings (SSHKeyManager 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.

SSHKeyManager Config Settings

Base Config Settings

Trappable Errors (SSHKeyManager Class)

SSHKeyManager Errors