SSHKeyManager Component

Properties   Methods   Events   Config Settings   Errors  

The SSHKeyManager component provides access to SSH key management functions.

Syntax

TsbxSSHKeyManager

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

Method List

---

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

Event List

---

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

Config Settings

---

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

CertBytes Property (SSHKeyManager Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray CertBytes = { read=FCertBytes };

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 (SSHKeyManager Component)

Indicates whether the certificate has a CA capability.

Syntax

__property bool CertCA = { read=FCertCA, write=FSetCertCA };

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 (SSHKeyManager Component)

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

Syntax

__property DynamicArray CertCAKeyID = { read=FCertCAKeyID };

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 (SSHKeyManager Component)

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

Syntax

__property TsbxSSHKeyManagerCertCertTypes CertCertType = { read=FCertCertType };

enum TsbxSSHKeyManagerCertCertTypes {
  ctUnknown=0,
  ctX509Certificate=1,
  ctX509CertificateRequest=2
};

Default Value

ctUnknown

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 component 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 (SSHKeyManager Component)

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

Syntax

__property String CertCRLDistributionPoints = { read=FCertCRLDistributionPoints, write=FSetCertCRLDistributionPoints };

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 (SSHKeyManager Component)

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

Syntax

__property String CertCurve = { read=FCertCurve, write=FSetCertCurve };

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 (SSHKeyManager Component)

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

Syntax

__property String CertFingerprint = { read=FCertFingerprint };

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 (SSHKeyManager Component)

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

Syntax

__property String CertFriendlyName = { read=FCertFriendlyName };

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 (SSHKeyManager Component)

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

Syntax

__property __int64 CertHandle = { read=FCertHandle, write=FSetCertHandle };

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 (SSHKeyManager Component)

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

Syntax

__property String CertHashAlgorithm = { read=FCertHashAlgorithm, write=FSetCertHashAlgorithm };

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 (SSHKeyManager Component)

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

Syntax

__property String CertIssuer = { read=FCertIssuer };

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 (SSHKeyManager Component)

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

Syntax

__property String CertIssuerRDN = { read=FCertIssuerRDN, write=FSetCertIssuerRDN };

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 (SSHKeyManager Component)

Specifies the public key algorithm of this certificate.

Syntax

__property String CertKeyAlgorithm = { read=FCertKeyAlgorithm, write=FSetCertKeyAlgorithm };

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 (SSHKeyManager Component)

Returns the length of the public key in bits.

Syntax

__property int CertKeyBits = { read=FCertKeyBits };

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 (SSHKeyManager Component)

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

Syntax

__property String CertKeyFingerprint = { read=FCertKeyFingerprint };

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 (SSHKeyManager Component)

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

Syntax

__property int CertKeyUsage = { read=FCertKeyUsage, write=FSetCertKeyUsage };

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 (SSHKeyManager Component)

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

Syntax

__property bool CertKeyValid = { read=FCertKeyValid };

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 (SSHKeyManager Component)

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

Syntax

__property String CertOCSPLocations = { read=FCertOCSPLocations, write=FSetCertOCSPLocations };

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 (SSHKeyManager Component)

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

Syntax

__property bool CertOCSPNoCheck = { read=FCertOCSPNoCheck, write=FSetCertOCSPNoCheck };

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 (SSHKeyManager Component)

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

Syntax

__property int CertOrigin = { read=FCertOrigin };

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 (SSHKeyManager Component)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

__property String CertPolicyIDs = { read=FCertPolicyIDs, write=FSetCertPolicyIDs };

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 (SSHKeyManager Component)

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

Syntax

__property DynamicArray CertPrivateKeyBytes = { read=FCertPrivateKeyBytes };

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 (SSHKeyManager Component)

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

Syntax

__property bool CertPrivateKeyExists = { read=FCertPrivateKeyExists };

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 (SSHKeyManager Component)

Indicates whether the private key is extractable (exportable).

Syntax

__property bool CertPrivateKeyExtractable = { read=FCertPrivateKeyExtractable };

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 (SSHKeyManager Component)

Contains the certificate's public key in DER format.

Syntax

__property DynamicArray CertPublicKeyBytes = { read=FCertPublicKeyBytes };

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 (SSHKeyManager Component)

Indicates whether the certificate is qualified.

Syntax

__property bool CertQualified = { read=FCertQualified };

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 (SSHKeyManager Component)

Returns a simplified qualified status of the certificate.

Syntax

__property TsbxSSHKeyManagerCertQualifiedStatements CertQualifiedStatements = { read=FCertQualifiedStatements, write=FSetCertQualifiedStatements };

enum TsbxSSHKeyManagerCertQualifiedStatements {
  qstNonQualified=0,
  qstQualifiedHardware=1,
  qstQualifiedSoftware=2
};

Default Value

qstNonQualified

Remarks

Returns a simplified qualified status of the certificate.

This property is not available at design time.

Data Type

Integer

CertQualifiers Property (SSHKeyManager Component)

A list of qualifiers.

Syntax

__property String CertQualifiers = { read=FCertQualifiers };

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 (SSHKeyManager Component)

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

Syntax

__property bool CertSelfSigned = { read=FCertSelfSigned };

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 (SSHKeyManager Component)

Returns the certificate's serial number.

Syntax

__property DynamicArray CertSerialNumber = { read=FCertSerialNumber, write=FSetCertSerialNumber };

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 (SSHKeyManager Component)

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

Syntax

__property String CertSigAlgorithm = { read=FCertSigAlgorithm };

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 (SSHKeyManager Component)

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

Syntax

__property TsbxSSHKeyManagerCertSources CertSource = { read=FCertSource };

enum TsbxSSHKeyManagerCertSources {
  pksUnknown=0,
  pksSignature=1,
  pksDocument=2,
  pksUser=3,
  pksLocal=4,
  pksOnline=5
};

Default Value

pksUnknown

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 (SSHKeyManager Component)

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

Syntax

__property String CertSubject = { read=FCertSubject };

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 (SSHKeyManager Component)

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

Syntax

__property String CertSubjectAlternativeName = { read=FCertSubjectAlternativeName, write=FSetCertSubjectAlternativeName };

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 (SSHKeyManager Component)

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

Syntax

__property DynamicArray CertSubjectKeyID = { read=FCertSubjectKeyID, write=FSetCertSubjectKeyID };

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 (SSHKeyManager Component)

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

Syntax

__property String CertSubjectRDN = { read=FCertSubjectRDN, write=FSetCertSubjectRDN };

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 (SSHKeyManager Component)

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.

Syntax

__property bool CertValid = { read=FCertValid };

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 (SSHKeyManager Component)

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

Syntax

__property String CertValidFrom = { read=FCertValidFrom, write=FSetCertValidFrom };

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 (SSHKeyManager Component)

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

Syntax

__property String CertValidTo = { read=FCertValidTo, write=FSetCertValidTo };

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 (SSHKeyManager Component)

The algorithm of the cryptographic key.

Syntax

__property String CryptoKeyAlgorithm = { read=FCryptoKeyAlgorithm, write=FSetCryptoKeyAlgorithm };

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 (SSHKeyManager Component)

The length of the key in bits.

Syntax

__property int CryptoKeyBits = { read=FCryptoKeyBits };

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 (SSHKeyManager Component)

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

Syntax

__property String CryptoKeyCurve = { read=FCryptoKeyCurve, write=FSetCryptoKeyCurve };

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 (SSHKeyManager Component)

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

Syntax

__property bool CryptoKeyExportable = { read=FCryptoKeyExportable };

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 (SSHKeyManager Component)

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

Syntax

__property String CryptoKeyFingerprint = { read=FCryptoKeyFingerprint };

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 (SSHKeyManager Component)

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

Syntax

__property __int64 CryptoKeyHandle = { read=FCryptoKeyHandle, write=FSetCryptoKeyHandle };

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 (SSHKeyManager Component)

Provides access to a storage-specific key identifier.

Syntax

__property DynamicArray CryptoKeyID = { read=FCryptoKeyID, write=FSetCryptoKeyID };

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 (SSHKeyManager Component)

The initialization vector (IV) of a symmetric key.

Syntax

__property DynamicArray CryptoKeyIV = { read=FCryptoKeyIV, write=FSetCryptoKeyIV };

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 (SSHKeyManager Component)

The byte array representation of the key.

Syntax

__property DynamicArray CryptoKeyKey = { read=FCryptoKeyKey };

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 (SSHKeyManager Component)

A nonce value associated with a key.

Syntax

__property DynamicArray CryptoKeyNonce = { read=FCryptoKeyNonce, write=FSetCryptoKeyNonce };

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 (SSHKeyManager Component)

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

Syntax

__property bool CryptoKeyPrivate = { read=FCryptoKeyPrivate };

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 (SSHKeyManager Component)

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

Syntax

__property bool CryptoKeyPublic = { read=FCryptoKeyPublic };

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 (SSHKeyManager Component)

Returns the key subject.

Syntax

__property DynamicArray CryptoKeySubject = { read=FCryptoKeySubject, write=FSetCryptoKeySubject };

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 (SSHKeyManager Component)

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

Syntax

__property bool CryptoKeySymmetric = { read=FCryptoKeySymmetric };

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 (SSHKeyManager Component)

Returns True if this key is valid.

Syntax

__property bool CryptoKeyValid = { read=FCryptoKeyValid };

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 (SSHKeyManager Component)

Reserved.

Syntax

__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

KeyAlgorithm Property (SSHKeyManager Component)

Specifies the key algorithm.

Syntax

__property String KeyAlgorithm = { read=FKeyAlgorithm };

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 (SSHKeyManager Component)

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

Syntax

__property int KeyBits = { read=FKeyBits };

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 (SSHKeyManager Component)

The comment for the public key.

Syntax

__property String KeyComment = { read=FKeyComment, write=FSetKeyComment };

Default Value

""

Remarks

The comment for the public key.

This property is not available at design time.

Data Type

String

KeyCurve Property (SSHKeyManager Component)

Specifies the elliptical curve when EC cryptography is used.

Syntax

__property String KeyCurve = { read=FKeyCurve };

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 (SSHKeyManager Component)

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

Syntax

__property DynamicArray KeyDSSG = { read=FKeyDSSG };

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 (SSHKeyManager Component)

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

Syntax

__property DynamicArray KeyDSSP = { read=FKeyDSSP };

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 (SSHKeyManager Component)

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

Syntax

__property DynamicArray KeyDSSQ = { read=FKeyDSSQ };

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 (SSHKeyManager Component)

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

Syntax

__property DynamicArray KeyDSSX = { read=FKeyDSSX };

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 (SSHKeyManager Component)

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

Syntax

__property DynamicArray KeyDSSY = { read=FKeyDSSY };

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 (SSHKeyManager Component)

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

Syntax

__property DynamicArray KeyECCD = { read=FKeyECCD };

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 (SSHKeyManager Component)

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

Syntax

__property DynamicArray KeyECCQX = { read=FKeyECCQX };

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 (SSHKeyManager Component)

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

Syntax

__property DynamicArray KeyECCQY = { read=FKeyECCQY };

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 (SSHKeyManager Component)

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

Syntax

__property DynamicArray KeyEdPrivate = { read=FKeyEdPrivate };

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 (SSHKeyManager Component)

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

Syntax

__property DynamicArray KeyEdPublic = { read=FKeyEdPublic };

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 (SSHKeyManager Component)

Contains the MD5 fingerprint (hash) of the key.

Syntax

__property String KeyFingerprintMD5 = { read=FKeyFingerprintMD5 };

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 (SSHKeyManager Component)

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

Syntax

__property String KeyFingerprintSHA1 = { read=FKeyFingerprintSHA1 };

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 (SSHKeyManager Component)

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

Syntax

__property String KeyFingerprintSHA256 = { read=FKeyFingerprintSHA256 };

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 (SSHKeyManager Component)

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

Syntax

__property __int64 KeyHandle = { read=FKeyHandle, write=FSetKeyHandle };

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 (SSHKeyManager Component)

Whether the key is extractable (e.

Syntax

__property bool KeyIsExtractable = { read=FKeyIsExtractable };

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 (SSHKeyManager Component)

Whether this key is a private key or not.

Syntax

__property bool KeyIsPrivate = { read=FKeyIsPrivate };

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 (SSHKeyManager Component)

Whether this key is a public key or not.

Syntax

__property bool KeyIsPublic = { read=FKeyIsPublic };

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 (SSHKeyManager Component)

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

Syntax

__property int KeyKDFRounds = { read=FKeyKDFRounds };

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 (SSHKeyManager Component)

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

Syntax

__property DynamicArray KeyKDFSalt = { read=FKeyKDFSalt };

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 (SSHKeyManager Component)

Specifies the format in which the key is stored.

Syntax

__property TsbxSSHKeyManagerKeyKeyFormats KeyKeyFormat = { read=FKeyKeyFormat };

enum TsbxSSHKeyManagerKeyKeyFormats {
  ckfOpenSSH=0,
  ckfOpenSSH2=1,
  ckfIETF=2,
  ckfPuTTY=3,
  ckfX509=4,
  ckfBinary=5,
  ckfSSH1=6,
  ckfPGP=7,
  ckfPKCS8=8,
  ckfPuTTY3=9
};

Default Value

ckfOpenSSH

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 (SSHKeyManager Component)

Specifies the key protection algorithm.

Syntax

__property String KeyKeyProtectionAlgorithm = { read=FKeyKeyProtectionAlgorithm };

Default Value

""

Remarks

Specifies the key protection algorithm.

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

Data Type

String

KeyRSAExponent Property (SSHKeyManager Component)

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

Syntax

__property DynamicArray KeyRSAExponent = { read=FKeyRSAExponent };

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 (SSHKeyManager Component)

Returns the iqmp parameter of the RSA key.

Syntax

__property DynamicArray KeyRSAIQMP = { read=FKeyRSAIQMP };

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 (SSHKeyManager Component)

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

Syntax

__property DynamicArray KeyRSAModulus = { read=FKeyRSAModulus };

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 (SSHKeyManager Component)

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

Syntax

__property DynamicArray KeyRSAP = { read=FKeyRSAP };

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 (SSHKeyManager Component)

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

Syntax

__property DynamicArray KeyRSAPrivateExponent = { read=FKeyRSAPrivateExponent };

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 (SSHKeyManager Component)

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

Syntax

__property DynamicArray KeyRSAQ = { read=FKeyRSAQ };

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 (SSHKeyManager Component)

Specifies the public key owner (subject).

Syntax

__property String KeySubject = { read=FKeySubject, write=FSetKeySubject };

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 (SSHKeyManager Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 (SSHKeyManager Component)

Creates a template for a new keypair.

Syntax

void __fastcall CreateNew();

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 (SSHKeyManager Component)

Performs an additional action.

Syntax

String __fastcall DoAction(String ActionID, String ActionParams);

Remarks

DoAction is a generic method available in every component. 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 (SSHKeyManager Component)

Writes the key to a memory buffer.

Syntax

DynamicArray<Byte> __fastcall ExportBytes(int Format, bool PrivateKey, String 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 (SSHKeyManager Component)

Exports the key to a certificate.

Syntax

void __fastcall ExportToCert();

Remarks

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

ExportToCryptoKey Method (SSHKeyManager Component)

Exports the key to a crypto key object.

Syntax

void __fastcall ExportToCryptoKey();

Remarks

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

ExportToFile Method (SSHKeyManager Component)

Writes key to file.

Syntax

void __fastcall ExportToFile(String FileName, int Format, bool PrivateKey, String 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 (SSHKeyManager Component)

Generates a new SSH key.

Syntax

void __fastcall Generate(String KeyAlgorithm, String Scheme, String SchemeParams, int 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 (SSHKeyManager Component)

Returns an algorithm-specific key parameter.

Syntax

DynamicArray<Byte> __fastcall GetKeyParam(String Name);

Remarks

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

GetKeyParamStr Method (SSHKeyManager Component)

Returns an algorithm-specific key parameter to a string.

Syntax

String __fastcall GetKeyParamStr(String 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 (SSHKeyManager Component)

Loads key from buffer.

Syntax

void __fastcall ImportBytes(DynamicArray<Byte> Bytes, String 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 (SSHKeyManager Component)

Loads a key from a certificate.

Syntax

void __fastcall ImportFromCert();

Remarks

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

ImportFromCryptoKey Method (SSHKeyManager Component)

Imports a key from a crypto key.

Syntax

void __fastcall ImportFromCryptoKey();

Remarks

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

ImportFromFile Method (SSHKeyManager Component)

Loads key from file.

Syntax

void __fastcall ImportFromFile(String Path, String 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 (SSHKeyManager Component)

Resets the component settings.

Syntax

void __fastcall Reset();

Remarks

Reset is a generic method available in every component.

SetKeyParam Method (SSHKeyManager Component)

Sets an algorithm-specific key parameter.

Syntax

void __fastcall SetKeyParam(String Name, DynamicArray<Byte> Value);

Remarks

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

SetKeyParamStr Method (SSHKeyManager Component)

Sets an algorithm-specific key parameter.

Syntax

void __fastcall SetKeyParamStr(String Name, String 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 (SSHKeyManager Component)

Information about errors during SSH key management.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TsbxSSHKeyManagerErrorEventParams;
typedef void __fastcall (__closure *TsbxSSHKeyManagerErrorEvent)(System::TObject* Sender, TsbxSSHKeyManagerErrorEventParams *e);
__property TsbxSSHKeyManagerErrorEvent OnError = { read=FOnError, write=FOnError };

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 (SSHKeyManager Component)

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

Syntax

typedef struct {
  String EventID;
  String EventParam;
} TsbxSSHKeyManagerNotificationEventParams;
typedef void __fastcall (__closure *TsbxSSHKeyManagerNotificationEvent)(System::TObject* Sender, TsbxSSHKeyManagerNotificationEventParams *e);
__property TsbxSSHKeyManagerNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. 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 component, the exact action it is performing, or the document being processed, one or both may be omitted.

Config Settings (SSHKeyManager Component)

The component 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 component, access to these internal properties is provided through the Config method.

SSHKeyManager Config Settings

Base Config Settings

Trappable Errors (SSHKeyManager Component)

SSHKeyManager Errors