SSHKeyManager Class

Properties   Methods   Events   Config Settings   Errors  

The SSHKeyManager class provides access to SSH key management functions.

Syntax

class secureblackbox.SSHKeyManager

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 (import_from_cert) and raw cryptographic keys (import_from_crypto_key).

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 create_new, 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 (export_to_file) 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.

cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_cert_bytes() -> bytes: ...

cert_bytes = property(get_cert_bytes, None)

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

cert_ca Property

Indicates whether the certificate has a CA capability.

Syntax

def get_cert_ca() -> bool: ...
def set_cert_ca(value: bool) -> None: ...

cert_ca = property(get_cert_ca, set_cert_ca)

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.

cert_ca_key_id Property

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

Syntax

def get_cert_ca_key_id() -> bytes: ...

cert_ca_key_id = property(get_cert_ca_key_id, None)

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 cert_subject_key_id setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

This property is read-only.

cert_cert_type Property

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

Syntax

def get_cert_cert_type() -> int: ...

cert_cert_type = property(get_cert_cert_type, None)

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.

cert_crl_distribution_points Property

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

Syntax

def get_cert_crl_distribution_points() -> str: ...
def set_cert_crl_distribution_points(value: str) -> None: ...

cert_crl_distribution_points = property(get_cert_crl_distribution_points, set_cert_crl_distribution_points)

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.

cert_curve Property

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

Syntax

def get_cert_curve() -> str: ...
def set_cert_curve(value: str) -> None: ...

cert_curve = property(get_cert_curve, set_cert_curve)

Default Value

""

Remarks

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

cert_fingerprint Property

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

Syntax

def get_cert_fingerprint() -> str: ...

cert_fingerprint = property(get_cert_fingerprint, None)

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.

cert_friendly_name Property

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

Syntax

def get_cert_friendly_name() -> str: ...

cert_friendly_name = property(get_cert_friendly_name, None)

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.

cert_handle Property

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

Syntax

def get_cert_handle() -> int: ...
def set_cert_handle(value: int) -> None: ...

cert_handle = property(get_cert_handle, set_cert_handle)

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());

cert_hash_algorithm Property

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

Syntax

def get_cert_hash_algorithm() -> str: ...
def set_cert_hash_algorithm(value: str) -> None: ...

cert_hash_algorithm = property(get_cert_hash_algorithm, set_cert_hash_algorithm)

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 cert_sig_algorithm to find out the hash algorithm that is part of the certificate signature.

cert_issuer Property

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

Syntax

def get_cert_issuer() -> str: ...

cert_issuer = property(get_cert_issuer, None)

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

This property is read-only.

cert_issuer_rdn Property

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

Syntax

def get_cert_issuer_rdn() -> str: ...
def set_cert_issuer_rdn(value: str) -> None: ...

cert_issuer_rdn = property(get_cert_issuer_rdn, set_cert_issuer_rdn)

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

cert_key_algorithm Property

Specifies the public key algorithm of this certificate.

Syntax

def get_cert_key_algorithm() -> str: ...
def set_cert_key_algorithm(value: str) -> None: ...

cert_key_algorithm = property(get_cert_key_algorithm, set_cert_key_algorithm)

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the cert_key_bits, cert_curve, and cert_public_key_bytes properties to get more details about the key the certificate contains.

cert_key_bits Property

Returns the length of the public key in bits.

Syntax

def get_cert_key_bits() -> int: ...

cert_key_bits = property(get_cert_key_bits, None)

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 cert_public_key_bytes or cert_private_key_bytes property would typically contain auxiliary values, and therefore be longer.

This property is read-only.

cert_key_fingerprint Property

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

Syntax

def get_cert_key_fingerprint() -> str: ...

cert_key_fingerprint = property(get_cert_key_fingerprint, None)

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

cert_key_usage Property

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

Syntax

def get_cert_key_usage() -> int: ...
def set_cert_key_usage(value: int) -> None: ...

cert_key_usage = property(get_cert_key_usage, set_cert_key_usage)

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.

cert_key_valid Property

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

Syntax

def get_cert_key_valid() -> bool: ...

cert_key_valid = property(get_cert_key_valid, None)

Default Value

FALSE

Remarks

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

This property is read-only.

cert_ocsp_locations Property

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

Syntax

def get_cert_ocsp_locations() -> str: ...
def set_cert_ocsp_locations(value: str) -> None: ...

cert_ocsp_locations = property(get_cert_ocsp_locations, set_cert_ocsp_locations)

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.

cert_ocsp_no_check Property

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

Syntax

def get_cert_ocsp_no_check() -> bool: ...
def set_cert_ocsp_no_check(value: bool) -> None: ...

cert_ocsp_no_check = property(get_cert_ocsp_no_check, set_cert_ocsp_no_check)

Default Value

FALSE

Remarks

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

cert_origin Property

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

Syntax

def get_cert_origin() -> int: ...

cert_origin = property(get_cert_origin, None)

Default Value

0

Remarks

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

This property is read-only.

cert_policy_i_ds Property

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

def get_cert_policy_i_ds() -> str: ...
def set_cert_policy_i_ds(value: str) -> None: ...

cert_policy_i_ds = property(get_cert_policy_i_ds, set_cert_policy_i_ds)

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.

cert_private_key_bytes Property

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

Syntax

def get_cert_private_key_bytes() -> bytes: ...

cert_private_key_bytes = property(get_cert_private_key_bytes, None)

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.

cert_private_key_exists Property

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

Syntax

def get_cert_private_key_exists() -> bool: ...

cert_private_key_exists = property(get_cert_private_key_exists, None)

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 cert_private_key_bytes, 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.

cert_private_key_extractable Property

Indicates whether the private key is extractable (exportable).

Syntax

def get_cert_private_key_extractable() -> bool: ...

cert_private_key_extractable = property(get_cert_private_key_extractable, None)

Default Value

FALSE

Remarks

Indicates whether the private key is extractable (exportable).

This property is read-only.

cert_public_key_bytes Property

Contains the certificate's public key in DER format.

Syntax

def get_cert_public_key_bytes() -> bytes: ...

cert_public_key_bytes = property(get_cert_public_key_bytes, None)

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.

cert_qualified Property

Indicates whether the certificate is qualified.

Syntax

def get_cert_qualified() -> bool: ...

cert_qualified = property(get_cert_qualified, None)

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.

cert_qualified_statements Property

Returns a simplified qualified status of the certificate.

Syntax

def get_cert_qualified_statements() -> int: ...
def set_cert_qualified_statements(value: int) -> None: ...

cert_qualified_statements = property(get_cert_qualified_statements, set_cert_qualified_statements)

Default Value

0

Remarks

Returns a simplified qualified status of the certificate.

cert_qualifiers Property

A list of qualifiers.

Syntax

def get_cert_qualifiers() -> str: ...

cert_qualifiers = property(get_cert_qualifiers, None)

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.

cert_self_signed Property

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

Syntax

def get_cert_self_signed() -> bool: ...

cert_self_signed = property(get_cert_self_signed, None)

Default Value

FALSE

Remarks

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

This property is read-only.

cert_serial_number Property

Returns the certificate's serial number.

Syntax

def get_cert_serial_number() -> bytes: ...
def set_cert_serial_number(value: bytes) -> None: ...

cert_serial_number = property(get_cert_serial_number, set_cert_serial_number)

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.

cert_sig_algorithm Property

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

Syntax

def get_cert_sig_algorithm() -> str: ...

cert_sig_algorithm = property(get_cert_sig_algorithm, None)

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.

cert_source Property

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

Syntax

def get_cert_source() -> int: ...

cert_source = property(get_cert_source, None)

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.

cert_subject Property

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

Syntax

def get_cert_subject() -> str: ...

cert_subject = property(get_cert_subject, None)

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

This property is read-only.

cert_subject_alternative_name Property

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

Syntax

def get_cert_subject_alternative_name() -> str: ...
def set_cert_subject_alternative_name(value: str) -> None: ...

cert_subject_alternative_name = property(get_cert_subject_alternative_name, set_cert_subject_alternative_name)

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

cert_subject_key_id Property

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

Syntax

def get_cert_subject_key_id() -> bytes: ...
def set_cert_subject_key_id(value: bytes) -> None: ...

cert_subject_key_id = property(get_cert_subject_key_id, set_cert_subject_key_id)

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 cert_subject_key_id and cert_ca_key_id properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

cert_subject_rdn Property

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

Syntax

def get_cert_subject_rdn() -> str: ...
def set_cert_subject_rdn(value: str) -> None: ...

cert_subject_rdn = property(get_cert_subject_rdn, set_cert_subject_rdn)

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.

cert_valid Property

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

def get_cert_valid() -> bool: ...

cert_valid = property(get_cert_valid, None)

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.

cert_valid_from Property

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

Syntax

def get_cert_valid_from() -> str: ...
def set_cert_valid_from(value: str) -> None: ...

cert_valid_from = property(get_cert_valid_from, set_cert_valid_from)

Default Value

""

Remarks

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

cert_valid_to Property

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

Syntax

def get_cert_valid_to() -> str: ...
def set_cert_valid_to(value: str) -> None: ...

cert_valid_to = property(get_cert_valid_to, set_cert_valid_to)

Default Value

""

Remarks

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

crypto_key_algorithm Property

The algorithm of the cryptographic key.

Syntax

def get_crypto_key_algorithm() -> str: ...
def set_crypto_key_algorithm(value: str) -> None: ...

crypto_key_algorithm = property(get_crypto_key_algorithm, set_crypto_key_algorithm)

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.

crypto_key_bits Property

The length of the key in bits.

Syntax

def get_crypto_key_bits() -> int: ...

crypto_key_bits = property(get_crypto_key_bits, None)

Default Value

0

Remarks

The length of the key in bits.

This property is read-only.

crypto_key_curve Property

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

Syntax

def get_crypto_key_curve() -> str: ...
def set_crypto_key_curve(value: str) -> None: ...

crypto_key_curve = property(get_crypto_key_curve, set_crypto_key_curve)

Default Value

""

Remarks

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

crypto_key_exportable Property

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

Syntax

def get_crypto_key_exportable() -> bool: ...

crypto_key_exportable = property(get_crypto_key_exportable, None)

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.

crypto_key_fingerprint Property

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

Syntax

def get_crypto_key_fingerprint() -> str: ...

crypto_key_fingerprint = property(get_crypto_key_fingerprint, None)

Default Value

""

Remarks

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

This property is read-only.

crypto_key_handle Property

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

Syntax

def get_crypto_key_handle() -> int: ...
def set_crypto_key_handle(value: int) -> None: ...

crypto_key_handle = property(get_crypto_key_handle, set_crypto_key_handle)

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());

crypto_key_id Property

Provides access to a storage-specific key identifier.

Syntax

def get_crypto_key_id() -> bytes: ...
def set_crypto_key_id(value: bytes) -> None: ...

crypto_key_id = property(get_crypto_key_id, set_crypto_key_id)

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

crypto_key_iv Property

The initialization vector (IV) of a symmetric key.

Syntax

def get_crypto_key_iv() -> bytes: ...
def set_crypto_key_iv(value: bytes) -> None: ...

crypto_key_iv = property(get_crypto_key_iv, set_crypto_key_iv)

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.

crypto_key_key Property

The byte array representation of the key.

Syntax

def get_crypto_key_key() -> bytes: ...

crypto_key_key = property(get_crypto_key_key, None)

Remarks

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

This property is read-only.

crypto_key_nonce Property

A nonce value associated with a key.

Syntax

def get_crypto_key_nonce() -> bytes: ...
def set_crypto_key_nonce(value: bytes) -> None: ...

crypto_key_nonce = property(get_crypto_key_nonce, set_crypto_key_nonce)

Remarks

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

crypto_key_private Property

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

Syntax

def get_crypto_key_private() -> bool: ...

crypto_key_private = property(get_crypto_key_private, None)

Default Value

FALSE

Remarks

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

This property is read-only.

crypto_key_public Property

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

Syntax

def get_crypto_key_public() -> bool: ...

crypto_key_public = property(get_crypto_key_public, None)

Default Value

FALSE

Remarks

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

This property is read-only.

crypto_key_subject Property

Returns the key subject.

Syntax

def get_crypto_key_subject() -> bytes: ...
def set_crypto_key_subject(value: bytes) -> None: ...

crypto_key_subject = property(get_crypto_key_subject, set_crypto_key_subject)

Remarks

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

crypto_key_symmetric Property

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

Syntax

def get_crypto_key_symmetric() -> bool: ...

crypto_key_symmetric = property(get_crypto_key_symmetric, None)

Default Value

FALSE

Remarks

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

This property is read-only.

crypto_key_valid Property

Returns True if this key is valid.

Syntax

def get_crypto_key_valid() -> bool: ...

crypto_key_valid = property(get_crypto_key_valid, None)

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.

fips_mode Property

Reserved.

Syntax

def get_fips_mode() -> bool: ...
def set_fips_mode(value: bool) -> None: ...

fips_mode = property(get_fips_mode, set_fips_mode)

Default Value

FALSE

Remarks

This property is reserved for future use.

key_algorithm Property

Specifies the key algorithm.

Syntax

def get_key_algorithm() -> str: ...

key_algorithm = property(get_key_algorithm, None)

Default Value

""

Remarks

Specifies the key algorithm.

The following algorithms are currently supported:

• RSA
• DSS
• ECDSA
• EDDSA

This property is read-only.

key_bits Property

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

Syntax

def get_key_bits() -> int: ...

key_bits = property(get_key_bits, None)

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.

key_comment Property

The comment for the public key.

Syntax

def get_key_comment() -> str: ...
def set_key_comment(value: str) -> None: ...

key_comment = property(get_key_comment, set_key_comment)

Default Value

""

Remarks

The comment for the public key.

key_curve Property

Specifies the elliptical curve when EC cryptography is used.

Syntax

def get_key_curve() -> str: ...

key_curve = property(get_key_curve, None)

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.

key_dssg Property

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

Syntax

def get_key_dssg() -> bytes: ...

key_dssg = property(get_key_dssg, None)

Remarks

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

This property is read-only.

key_dssp Property

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

Syntax

def get_key_dssp() -> bytes: ...

key_dssp = property(get_key_dssp, None)

Remarks

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

This property is read-only.

key_dssq Property

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

Syntax

def get_key_dssq() -> bytes: ...

key_dssq = property(get_key_dssq, None)

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.

key_dssx Property

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

Syntax

def get_key_dssx() -> bytes: ...

key_dssx = property(get_key_dssx, None)

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.

key_dssy Property

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

Syntax

def get_key_dssy() -> bytes: ...

key_dssy = property(get_key_dssy, None)

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.

key_eccd Property

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

Syntax

def get_key_eccd() -> bytes: ...

key_eccd = property(get_key_eccd, None)

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.

key_eccqx Property

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

Syntax

def get_key_eccqx() -> bytes: ...

key_eccqx = property(get_key_eccqx, None)

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.

key_eccqy Property

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

Syntax

def get_key_eccqy() -> bytes: ...

key_eccqy = property(get_key_eccqy, None)

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.

key_ed_private Property

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

Syntax

def get_key_ed_private() -> bytes: ...

key_ed_private = property(get_key_ed_private, None)

Remarks

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

This property is read-only.

key_ed_public Property

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

Syntax

def get_key_ed_public() -> bytes: ...

key_ed_public = property(get_key_ed_public, None)

Remarks

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

This property is read-only.

key_fingerprint_md5 Property

Contains the MD5 fingerprint (hash) of the key.

Syntax

def get_key_fingerprint_md5() -> str: ...

key_fingerprint_md5 = property(get_key_fingerprint_md5, None)

Default Value

""

Remarks

Contains the MD5 fingerprint (hash) of the key.

This property is read-only.

key_fingerprint_sha1 Property

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

Syntax

def get_key_fingerprint_sha1() -> str: ...

key_fingerprint_sha1 = property(get_key_fingerprint_sha1, None)

Default Value

""

Remarks

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

This property is read-only.

key_fingerprint_sha256 Property

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

Syntax

def get_key_fingerprint_sha256() -> str: ...

key_fingerprint_sha256 = property(get_key_fingerprint_sha256, None)

Default Value

""

Remarks

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

This property is read-only.

key_handle Property

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

Syntax

def get_key_handle() -> int: ...
def set_key_handle(value: int) -> None: ...

key_handle = property(get_key_handle, set_key_handle)

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());

key_is_extractable Property

Whether the key is extractable (e.

Syntax

def get_key_is_extractable() -> bool: ...

key_is_extractable = property(get_key_is_extractable, None)

Default Value

FALSE

Remarks

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

This property is read-only.

key_is_private Property

Whether this key is a private key or not.

Syntax

def get_key_is_private() -> bool: ...

key_is_private = property(get_key_is_private, None)

Default Value

FALSE

Remarks

Whether this key is a private key or not.

This property is read-only.

key_is_public Property

Whether this key is a public key or not.

Syntax

def get_key_is_public() -> bool: ...

key_is_public = property(get_key_is_public, None)

Default Value

FALSE

Remarks

Whether this key is a public key or not.

This property is read-only.

key_kdf_rounds Property

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

Syntax

def get_key_kdf_rounds() -> int: ...

key_kdf_rounds = property(get_key_kdf_rounds, None)

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.

key_kdf_salt Property

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

Syntax

def get_key_kdf_salt() -> bytes: ...

key_kdf_salt = property(get_key_kdf_salt, None)

Remarks

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

This property is read-only.

key_key_format Property

Specifies the format in which the key is stored.

Syntax

def get_key_key_format() -> int: ...

key_key_format = property(get_key_key_format, None)

Default Value

0

Remarks

Specifies the format in which the key is stored.

This property is read-only.

key_key_protection_algorithm Property

Specifies the key protection algorithm.

Syntax

def get_key_key_protection_algorithm() -> str: ...

key_key_protection_algorithm = property(get_key_key_protection_algorithm, None)

Default Value

""

Remarks

Specifies the key protection algorithm.

This property is read-only.

key_rsa_exponent Property

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

Syntax

def get_key_rsa_exponent() -> bytes: ...

key_rsa_exponent = property(get_key_rsa_exponent, None)

Remarks

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

This property is read-only.

key_rsaiqmp Property

Returns the iqmp parameter of the RSA key.

Syntax

def get_key_rsaiqmp() -> bytes: ...

key_rsaiqmp = property(get_key_rsaiqmp, None)

Remarks

Returns the iqmp parameter of the RSA key.

This property is read-only.

key_rsa_modulus Property

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

Syntax

def get_key_rsa_modulus() -> bytes: ...

key_rsa_modulus = property(get_key_rsa_modulus, None)

Remarks

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

This property is read-only.

key_rsap Property

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

Syntax

def get_key_rsap() -> bytes: ...

key_rsap = property(get_key_rsap, None)

Remarks

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

This property is read-only.

key_rsa_private_exponent Property

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

Syntax

def get_key_rsa_private_exponent() -> bytes: ...

key_rsa_private_exponent = property(get_key_rsa_private_exponent, None)

Remarks

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

This property is read-only.

key_rsaq Property

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

Syntax

def get_key_rsaq() -> bytes: ...

key_rsaq = property(get_key_rsaq, None)

Remarks

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

This property is read-only.

key_subject Property

Specifies the public key owner (subject).

Syntax

def get_key_subject() -> str: ...
def set_key_subject(value: str) -> None: ...

key_subject = property(get_key_subject, set_key_subject)

Default Value

""

Remarks

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

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

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.

create_new Method

Creates a template for a new keypair.

Syntax

def create_new() -> None: ...

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.

do_action Method

Performs an additional action.

Syntax

def do_action(action_id: str, action_params: str) -> str: ...

Remarks

do_action 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:

export_bytes Method

Writes the key to a memory buffer.

Syntax

def export_bytes(format: int, private_key: bool, password: str) -> bytes: ...

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.

export_to_cert Method

Exports the key to a certificate.

Syntax

def export_to_cert() -> None: ...

Remarks

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

export_to_crypto_key Method

Exports the key to a crypto key object.

Syntax

def export_to_crypto_key() -> None: ...

Remarks

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

export_to_file Method

Writes key to file.

Syntax

def export_to_file(file_name: str, format: int, private_key: bool, password: str) -> None: ...

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

Generates a new SSH key.

Syntax

def generate(key_algorithm: str, scheme: str, scheme_params: str, key_bits: int) -> None: ...

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

get_key_param Method

Returns an algorithm-specific key parameter.

Syntax

def get_key_param(name: str) -> bytes: ...

Remarks

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

get_key_param_str Method

Returns an algorithm-specific key parameter to a string.

Syntax

def get_key_param_str(name: str) -> str: ...

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.

import_bytes Method

Loads key from buffer.

Syntax

def import_bytes(bytes: bytes, password: str) -> None: ...

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.

import_from_cert Method

Loads a key from a certificate.

Syntax

def import_from_cert() -> None: ...

Remarks

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

import_from_crypto_key Method

Imports a key from a crypto key.

Syntax

def import_from_crypto_key() -> None: ...

Remarks

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

import_from_file Method

Loads key from file.

Syntax

def import_from_file(path: str, password: str) -> None: ...

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

Resets the class settings.

Syntax

def reset() -> None: ...

Remarks

reset is a generic method available in every class.

set_key_param Method

Sets an algorithm-specific key parameter.

Syntax

def set_key_param(name: str, value: bytes) -> None: ...

Remarks

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

set_key_param_str Method

Sets an algorithm-specific key parameter.

Syntax

def set_key_param_str(name: str, value_str: str) -> None: ...

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.

on_error Event

Information about errors during SSH key management.

Syntax

class SSHKeyManagerErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class SSHKeyManager:
@property
def on_error() -> Callable[[SSHKeyManagerErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[SSHKeyManagerErrorEventParams], None]) -> None: ...

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.

on_notification Event

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

Syntax

class SSHKeyManagerNotificationEventParams(object):
  @property
  def event_id() -> str: ...

  @property
  def event_param() -> str: ...

# In class SSHKeyManager:
@property
def on_notification() -> Callable[[SSHKeyManagerNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[SSHKeyManagerNotificationEventParams], None]) -> None: ...

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.

SSHKeyManager Config Settings

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

SSHKeyManager Errors

SSHKeyManager Errors