# SSHKeyManager Class The SSHKeyManager class provides access to SSH key management functions. ## Syntax ```text 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](#import_from_cert-method)) and raw cryptographic keys ([import_from_crypto_key](#import_from_crypto_key-method)). 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](#create_new-method), followed by [generate](#generate-method). 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](#export_to_file-method)) 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.* | | | | --- | --- | | [ca_algorithm](#ca_algorithm-property) | Specifies the key algorithm. | | [ca_bits](#ca_bits-property) | The number of bits in the key: the more the better, 2048 or 4096 are typical values. | | [ca_comment](#ca_comment-property) | The comment for the public key. | | [ca_curve](#ca_curve-property) | Specifies the elliptical curve when EC cryptography is used. | | [ca_extractable](#ca_extractable-property) | Whether the key is extractable (e. | | [ca_fingerprint_md5](#ca_fingerprint_md5-property) | Contains the MD5 fingerprint (hash) of the key. | | [ca_fingerprint_sha1](#ca_fingerprint_sha1-property) | Contains the SHA-1 fingerprint (hash) of the key. | | [ca_fingerprint_sha256](#ca_fingerprint_sha256-property) | Contains the SHA-256 fingerprint (hash) of the key. | | [ca_handle](#ca_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [ca_key_format](#ca_key_format-property) | Specifies the format in which the key is stored. | | [ca_key_protection_algorithm](#ca_key_protection_algorithm-property) | Specifies the key protection algorithm. | | [ca_private](#ca_private-property) | Whether this key is a private key or not. | | [ca_public](#ca_public-property) | Whether this key is a public key or not. | | [ca_subject](#ca_subject-property) | Specifies the public key owner (subject). | | [cert_bytes](#cert_bytes-property) | Returns the raw certificate data in DER format. | | [cert_handle](#cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [crypto_key_handle](#crypto_key_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [fips_mode](#fips_mode-property) | Reserved. | | [key_algorithm](#key_algorithm-property) | Specifies the key algorithm. | | [key_bits](#key_bits-property) | The number of bits in the key: the more the better, 2048 or 4096 are typical values. | | [key_comment](#key_comment-property) | The comment for the public key. | | [key_curve](#key_curve-property) | Specifies the elliptical curve when EC cryptography is used. | | [key_extractable](#key_extractable-property) | Whether the key is extractable (e. | | [key_fingerprint_md5](#key_fingerprint_md5-property) | Contains the MD5 fingerprint (hash) of the key. | | [key_fingerprint_sha1](#key_fingerprint_sha1-property) | Contains the SHA-1 fingerprint (hash) of the key. | | [key_fingerprint_sha256](#key_fingerprint_sha256-property) | Contains the SHA-256 fingerprint (hash) of the key. | | [key_handle](#key_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [key_format](#key_format-property) | Specifies the format in which the key is stored. | | [key_protection_algorithm](#key_protection_algorithm-property) | Specifies the key protection algorithm. | | [key_private](#key_private-property) | Whether this key is a private key or not. | | [key_public](#key_public-property) | Whether this key is a public key or not. | | [key_subject](#key_subject-property) | Specifies the public key owner (subject). | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [config](#config-method) | Sets or retrieves a configuration setting. | | [create_new](#create_new-method) | Creates a template for a new keypair. | | [do_action](#do_action-method) | Performs an additional action. | | [export_bytes](#export_bytes-method) | Writes the key to a memory buffer. | | [export_to_cert](#export_to_cert-method) | Exports the key to a certificate. | | [export_to_crypto_key](#export_to_crypto_key-method) | Exports the key to a crypto key object. | | [export_to_file](#export_to_file-method) | Writes key to file. | | [generate](#generate-method) | Generates a new SSH key. | | [generate_cert](#generate_cert-method) | Generates a new OpenSSH certificate. | | [get_key_param](#get_key_param-method) | Returns an key-specific key parameter. | | [get_key_param_str](#get_key_param_str-method) | Returns an algorithm-specific key parameter to a string. | | [import_bytes](#import_bytes-method) | Loads key from buffer. | | [import_from_cert](#import_from_cert-method) | Loads a key from an X.509 certificate. | | [import_from_crypto_key](#import_from_crypto_key-method) | Imports a key from a crypto key. | | [import_from_file](#import_from_file-method) | Loads key from file. | | [reset](#reset-method) | Resets the class settings. | | [set_key_param](#set_key_param-method) | Sets a key-specific key parameter. | | [set_key_param_str](#set_key_param_str-method) | Sets a key-specific key parameter. | ## 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.* | | | | --- | --- | | [on_error](#on_error-event) | Information about errors during SSH key management. | | [on_notification](#on_notification-event) | This event notifies the application about an underlying control flow event. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [DuplicatePublicKeyInOpenSSHEdDSA](#DuplicatePublicKeyInOpenSSHEdDSA) | Enables or disables inclusion of the public part in private EdDSA keys. | | [HashAlgorithm](#HashAlgorithm) | Specifies the hash algorithm to be used with an RSA key when authenticating. | | [ImportMode](#ImportMode) | Alters the behaviour of Import* methods. | | [TempPath](#TempPath) | Path for storing temporary files. | | [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. | | [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. | | [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. | | [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. | | [Cookies](#Cookies) | Gets or sets local cookies for the class. | | [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. | | [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. | | [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. | | [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. | | [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. | | [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. | | [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. | | [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. | | [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. | | [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. | | [LogDestination](#LogDestination) | Specifies the debug log destination. | | [LogDetails](#LogDetails) | Specifies the debug log details to dump. | | [LogFile](#LogFile) | Specifies the debug log filename. | | [LogFilters](#LogFilters) | Specifies the debug log filters. | | [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. | | [LogLevel](#LogLevel) | Specifies the debug log level. | | [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. | | [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. | | [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. | | [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. | | [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. | | [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. | | [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. | | [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. | | [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. | | [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [Tag](#Tag) | Allows to store any custom data. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. | | [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. | | [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. | | [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. | | [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. | | [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. | | [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. | | [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. | | [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. | | [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. | | [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. | | [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. | | [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. | # ca_algorithm property Specifies the key algorithm. ## Syntax ```text def get_ca_algorithm() -> str: ... ca_algorithm = property(get_ca_algorithm, None) ``` ## Default Value "" ## Remarks Specifies the key algorithm. The following key algorithms are currently supported and can be returned by this property: - RSA - DSS - ECDSA - EDDSA - MLDSA - ECDSA-SK - EDDSA-SK This property is read-only. # ca_bits property The number of bits in the key: the more the better, 2048 or 4096 are typical values. ## Syntax ```text def get_ca_bits() -> int: ... ca_bits = property(get_ca_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. # ca_comment property The comment for the public key. ## Syntax ```text def get_ca_comment() -> str: ... def set_ca_comment(value: str) -> None: ... ca_comment = property(get_ca_comment, set_ca_comment) ``` ## Default Value "" ## Remarks The comment for the public key. # ca_curve property Specifies the elliptical curve when EC cryptography is used. ## Syntax ```text def get_ca_curve() -> str: ... ca_curve = property(get_ca_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. # ca_extractable property Whether the key is extractable (e. ## Syntax ```text def get_ca_extractable() -> bool: ... ca_extractable = property(get_ca_extractable, None) ``` ## Default Value FALSE ## Remarks Whether the key is extractable (e.g., from a security token), or not. This property is read-only. # ca_fingerprint_md5 property Contains the MD5 fingerprint (hash) of the key. ## Syntax ```text def get_ca_fingerprint_md5() -> str: ... ca_fingerprint_md5 = property(get_ca_fingerprint_md5, None) ``` ## Default Value "" ## Remarks Contains the MD5 fingerprint (hash) of the key. This property is read-only. # ca_fingerprint_sha1 property Contains the SHA-1 fingerprint (hash) of the key. ## Syntax ```text def get_ca_fingerprint_sha1() -> str: ... ca_fingerprint_sha1 = property(get_ca_fingerprint_sha1, None) ``` ## Default Value "" ## Remarks Contains the SHA-1 fingerprint (hash) of the key. This property is read-only. # ca_fingerprint_sha256 property Contains the SHA-256 fingerprint (hash) of the key. ## Syntax ```text def get_ca_fingerprint_sha256() -> str: ... ca_fingerprint_sha256 = property(get_ca_fingerprint_sha256, None) ``` ## Default Value "" ## Remarks Contains the SHA-256 fingerprint (hash) of the key. This property is read-only. # ca_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_ca_handle() -> int: ... def set_ca_handle(value: int) -> None: ... ca_handle = property(get_ca_handle, set_ca_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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` # ca_key_format property Specifies the format in which the key is stored. ## Syntax ```text def get_ca_key_format() -> int: ... ca_key_format = property(get_ca_key_format, None) ``` ## Possible Values ```text 0 # OpenSSH1 # OpenSSH22 # IETF3 # PuTTY4 # X5095 # Binary6 # SSH17 # PGP8 # PKCS89 # PuTTY310 # OpenSSHCert ``` ## Default Value 0 ## Remarks Specifies the format in which the key is stored. | | | | | --- | --- | --- | | ckfOpenSSH | 0 | | | ckfOpenSSH2 | 1 | | | ckfIETF | 2 | | | ckfPuTTY | 3 | | | ckfX509 | 4 | | | ckfBinary | 5 | | | ckfSSH1 | 6 | | | ckfPGP | 7 | | | ckfPKCS8 | 8 | | | ckfPuTTY3 | 9 | | | ckfOpenSSHCert | 10 | | This property is read-only. # ca_key_protection_algorithm property Specifies the key protection algorithm. ## Syntax ```text def get_ca_key_protection_algorithm() -> str: ... ca_key_protection_algorithm = property(get_ca_key_protection_algorithm, None) ``` ## Default Value "" ## Remarks Specifies the key protection algorithm. This property is read-only. # ca_private property Whether this key is a private key or not. ## Syntax ```text def get_ca_private() -> bool: ... ca_private = property(get_ca_private, None) ``` ## Default Value FALSE ## Remarks Whether this key is a private key or not. This property is read-only. # ca_public property Whether this key is a public key or not. ## Syntax ```text def get_ca_public() -> bool: ... ca_public = property(get_ca_public, None) ``` ## Default Value FALSE ## Remarks Whether this key is a public key or not. This property is read-only. # ca_subject property Specifies the public key owner (subject). ## Syntax ```text def get_ca_subject() -> str: ... def set_ca_subject(value: str) -> None: ... ca_subject = property(get_ca_subject, set_ca_subject) ``` ## Default Value "" ## Remarks Specifies the public key owner (subject). This property is used only for IETF-keys. # cert_bytes property Returns the raw certificate data in DER format. ## Syntax ```text 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_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text 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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` # crypto_key_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text 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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` # fips_mode property Reserved. ## Syntax ```text 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 ```text def get_key_algorithm() -> str: ... key_algorithm = property(get_key_algorithm, None) ``` ## Default Value "" ## Remarks Specifies the key algorithm. The following key algorithms are currently supported and can be returned by this property: - RSA - DSS - ECDSA - EDDSA - MLDSA - ECDSA-SK - EDDSA-SK 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 ```text 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 ```text 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 ```text 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_extractable property Whether the key is extractable (e. ## Syntax ```text def get_key_extractable() -> bool: ... key_extractable = property(get_key_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_fingerprint_md5 property Contains the MD5 fingerprint (hash) of the key. ## Syntax ```text 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 ```text 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 ```text 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 ```text 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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` # key_format property Specifies the format in which the key is stored. ## Syntax ```text def get_key_format() -> int: ... key_format = property(get_key_format, None) ``` ## Possible Values ```text 0 # OpenSSH1 # OpenSSH22 # IETF3 # PuTTY4 # X5095 # Binary6 # SSH17 # PGP8 # PKCS89 # PuTTY310 # OpenSSHCert ``` ## Default Value 0 ## Remarks Specifies the format in which the key is stored. | | | | | --- | --- | --- | | ckfOpenSSH | 0 | | | ckfOpenSSH2 | 1 | | | ckfIETF | 2 | | | ckfPuTTY | 3 | | | ckfX509 | 4 | | | ckfBinary | 5 | | | ckfSSH1 | 6 | | | ckfPGP | 7 | | | ckfPKCS8 | 8 | | | ckfPuTTY3 | 9 | | | ckfOpenSSHCert | 10 | | This property is read-only. # key_protection_algorithm property Specifies the key protection algorithm. ## Syntax ```text def get_key_protection_algorithm() -> str: ... key_protection_algorithm = property(get_key_protection_algorithm, None) ``` ## Default Value "" ## Remarks Specifies the key protection algorithm. This property is read-only. # key_private property Whether this key is a private key or not. ## Syntax ```text def get_key_private() -> bool: ... key_private = property(get_key_private, None) ``` ## Default Value FALSE ## Remarks Whether this key is a private key or not. This property is read-only. # key_public property Whether this key is a public key or not. ## Syntax ```text def get_key_public() -> bool: ... key_public = property(get_key_public, None) ``` ## Default Value FALSE ## Remarks Whether this key is a public key or not. This property is read-only. # key_subject property Specifies the public key owner (subject). ## Syntax ```text 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 ```text 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](#sshkeymanager-config-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](#sshkeymanager-config-settings), you must call *Config("PROPERTY")*. The value will be returned as a string. # create_new method Creates a template for a new keypair. ## Syntax ```text 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](#generate-method) to complete the generation. # do_action method Performs an additional action. ## Syntax ```text 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: | | | | | | --- | --- | --- | --- | | Action | Parameters | Returned value | Description | | ResetTrustedListCache | none | none | Clears the cached list of trusted lists. | | ResetCertificateCache | none | none | Clears the cached certificates. | | ResetCRLCache | none | none | Clears the cached CRLs. | | ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. | # export_bytes method Writes the key to a memory buffer. ## Syntax ```text 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: | | | | | --- | --- | --- | | ckfOpenSSH | 0 | | | ckfOpenSSH2 | 1 | | | ckfIETF | 2 | | | ckfPuTTY | 3 | | | ckfX509 | 4 | | | ckfBinary | 5 | | | ckfSSH1 | 6 | | | ckfPGP | 7 | | | ckfPKCS8 | 8 | | | ckfPuTTY3 | 9 | | | ckfOpenSSHCert | 10 | | 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 ```text 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 ```text 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 ```text 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: | | | | | --- | --- | --- | | ckfOpenSSH | 0 | | | ckfOpenSSH2 | 1 | | | ckfIETF | 2 | | | ckfPuTTY | 3 | | | ckfX509 | 4 | | | ckfBinary | 5 | | | ckfSSH1 | 6 | | | ckfPGP | 7 | | | ckfPKCS8 | 8 | | | ckfPuTTY3 | 9 | | | ckfOpenSSHCert | 10 | | 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 ```text 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 - MLDSA - ECDSA-SK - EDDSA-SK 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 The following ML-DSA variants are supported - or use blanket 'MLDSA' algorithm with explicit *KeyBits* setting: - ML-DSA-44 - ML-DSA-65 - ML-DSA-87 Use the following algorithm names to generate OpenSSH certificates: - RSA-cert, RSA-certv01 - ECDSA-cert, ECDSA-certv01 - EDDSA-cert, EDDSA-certv01 The "-cert" algorithms will generate a certificate with the standard name (e.g. ssh-rsa-cert). The "-certv01" algorithms will generate a certificate with the respective vendor-extension name (e.g. ssh-rsa-cert-v01@openssh.com). While the latter are widely use in real world, it is expected that once the standard is published implementations will switch to the standard naming. ```text // generating a curve25519 keypair KeyMgr.Generate("EDDSA", "CURVE25519", "", 0); // KeyBits is irrelevant for this fixed-length scheme // generating an ECDSA/P521 key KeyMgr.Generate("ECDSA", "NISTP521", "", 521); // generating an RSA key KeyMgr.Generate("RSA", "", "", 2048); // generating a Ed25519 OpenSSH certificate with vendor-extension name KeyMgr.Generate("EDDSA-certv01", "CURVE25519", "", 0); KeyMgr.ExportToFile(Path, ckfOpenSSHCert, false, ""); // exporting the certificate file KeyMgr.ExportToFile(Path + ".priv", ckfOpenSSH2, true, ""); // exporting the private key ``` # generate_cert method Generates a new OpenSSH certificate. ## Syntax ```text def generate_cert(key_algorithm: str, scheme: str, scheme_params: str, key_bits: int, serial_number: int, role: int, identifier: str, principals: str, valid_from: str, valid_to: str, pars: str) -> None: ... ``` ## Remarks Call this method to generate a new OpenSSH certificate with the desired parameters. OpenSSH certificates are extended cryptographic entities that, unlike generic SSH keys, can provide association between the cryptographic material of the key and the persona of their owner. Certificates include information about their holder, such as a username or a host name, can be constrained to a certain validity period, and include additional permissions or restrictions, such as which commands the holder is allowed to issue. Every OpenSSH certificate must be signed by a separate private key, called a CA (*certifying authority*), at the time of its creation. A CA key is a generic OpenSSH key owned by the certificate issuer - for example, a server or network administrator. The public part of the CA key becomes part of the certificate and can be used by to validate the certificate: - the validating party first checks that the CA key embedded in the certificate is trusted, in the same way as it does for generic keys (e.g. by checking the .ssh directory or confirming the fingerprint with the user). - if the CA key is valid and trusted, it checks the integrity of its signature over the certificate data. - finally, it validates that the information contained in the certificate - such as the hostname - matches the host they intend to connect to. Certificates provide multiple benefits for SSH key ecosystem, such as capabilities to set up implicit trust relationships, manage users centrally, and include key usage policies within the keys themselves. Just like generic keys, certificates can be used for both host and user authentication. Note that OpenSSH certificates are not related to PKI (X.509) certificates in any way. They offer a somewhat similar, yet entirely different authentication mechanism. You can choose to use this method to generate a certificate over a fresh new cryptographic keypair or a pre-existing SSH key. In the latter case, load the existing SSH key into SSHKeyManager first using [import_from_file](#import_from_file-method) or similar methods. When a certificate is generated over an existing key, the algorithm and scheme parameters are discarded. The *KeyAlgorithm* parameter supports the following algorithm identifiers: - RSA - DSS - ECDSA - EDDSA - MLDSA - ECDSA-SK - EDDSA-SK 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 The following ML-DSA variants are supported - or use blanket 'MLDSA' algorithm with explicit *KeyBits* setting: - ML-DSA-44 - ML-DSA-65 - ML-DSA-87 Just as with using the [generate](#generate-method) method, you can use certificate-related algorithm aliases: - RSA-cert, RSA-certv01 - ECDSA-cert, ECDSA-certv01 - EDDSA-cert, EDDSA-certv01 The "-cert" algorithms will generate a certificate with the standard name (e.g. ssh-rsa-cert). The "-certv01" algorithms will generate a certificate with the respective vendor-extension name (e.g. ssh-rsa-cert-v01@openssh.com). While the latter are widely use in real world, it is expected that once the standard is published implementations will switch to the standard naming. Unlike the [generate](#generate-method) method, this method will always generate a certificate, even if a generic (e.g. *RSA*) algorithm name is provided to the *Algorithm* parameter. In that case the algorithm will be extended to the certificate-specific algorithm name (*RSA-cert* in this case). Note that the component will always apply the 'final' "-cert" algorithm name, so if you are looking to generate a certificate with an interim "-cert-v01@openssh.com" key, please use the *RSA-certv01* syntax. ```text // generating a client-side Ed25519 OpenSSH certificate with vendor-extension ('draft') name KeyMgr.GenerateCert("EDDSA-certv01", "CURVE25519", "", 0, 12, 1 { user }, "John Peters Workstation", "johnp", "", "2029-12-31", ""); KeyMgr.ExportToFile(Path, ckfOpenSSHCert, false, ""); // exporting the certificate file KeyMgr.ExportToFile(Path + ".priv", ckfOpenSSH2, true, ""); // exporting the private key // generating a host-side RSA OpenSSH certificate with RFC name KeyMgr.GenerateCert("RSA", "", "", 2048, 1001, 2 { host }, "Local File Server", "fileserver", "192.168.1.91", "", ""); KeyMgr.ExportToFile(Path, ckfOpenSSHCert, false, ""); // exporting the certificate file KeyMgr.ExportToFile(Path + ".priv", ckfOpenSSH2, true, ""); // exporting the private key ``` # get_key_param method Returns an key-specific key parameter. ## Syntax ```text def get_key_param(name: str) -> bytes: ... ``` ## Remarks Use this method to retrieve a binary key parameter. The following parameters are currently supported: | | | | | --- | --- | --- | | CertIdentifier | | The OpenSSH certificate identifier (OpenSSH certificates only) | | CertCriticalOptions[i] | | The i-th critical option name (OpenSSH certificates only) | | CertCriticalOptionValues[i] | | The i-th critical option value (OpenSSH certificates only) | | CertExtensions[i] | | The i-th extension name (OpenSSH certificates only) | | CertExtensionValues[i] | | The i-th extension value (OpenSSH certificates only) | | CertSigningKey | | A byte array containing the body of the CA key that has signed the current key (OpenSSH certificates only) | # get_key_param_str method Returns an algorithm-specific key parameter to a string. ## Syntax ```text def get_key_param_str(name: str) -> str: ... ``` ## Remarks Use this method to get a key parameter to a string. The following parameters are currently supported: | | | | | --- | --- | --- | | Headers | | The key file headers where PEM-like format is used. | | CertSerialNumber | | The serial number of the certificate (OpenSSH certificates only) | | CertRole | | The certificate role (host (2) or user (1)) (OpenSSH certificates only) | | CertIdentifier | | The identifier of the certificate (OpenSSH certificates only) | | CertPrincipals | | A list of principals associated with the certificate (OpenSSH certificates only) | | CertValidFrom | | The starting moment of the certificate validity period (OpenSSH certificates only) | | CertValidTo | | The ending moment of the certificate validity period (OpenSSH certificates only) | | CertCriticalOptionCount | | The number of critical options included in the certificate (use for iterating) (OpenSSH certificates only) | | CertCriticalOptions[i] | | The i-th critical option (OpenSSH certificates only) | | CertCriticalOptionValues[i] | | The i-th critical option value (OpenSSH certificates only) | | CertExtensionCount | | The number of extensions included in the certificate (use for iterating) (OpenSSH certificates only) | | CertExtensions[i] | | The i-th extension name (OpenSSH certificates only) (OpenSSH certificates only) | | CertExtensionValues[i] | | The i-th extension value (OpenSSH certificates only) | | CertSigningKey | | A string containing the body of the CA key that has signed the current key (OpenSSH certificates only) | # import_bytes method Loads key from buffer. ## Syntax ```text 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 an X.509 certificate. ## Syntax ```text def import_from_cert() -> None: ... ``` ## Remarks Use this method to load a key, either public or secret, from an X.509 certificate. # import_from_crypto_key method Imports a key from a crypto key. ## Syntax ```text 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 ```text 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 ```text def reset() -> None: ... ``` ## Remarks reset is a generic method available in every class. # set_key_param method Sets a key-specific key parameter. ## Syntax ```text def set_key_param(name: str, value: bytes) -> None: ... ``` ## Remarks Use this method to set a key- or algorithm-specific key parameter. The following parameters are currently supported: | | | | | --- | --- | --- | | CertIdentifier | | The OpenSSH certificate identifier (OpenSSH certificates only) | | CertCriticalOptions[i] | | The i-th critical option name (OpenSSH certificates only) | | CertCriticalOptionValues[i] | | The i-th critical option value (OpenSSH certificates only) | | CertExtensions[i] | | The i-th extension name (OpenSSH certificates only) | | CertExtensionValues[i] | | The i-th extension value (OpenSSH certificates only) | | CertSigningKey | | A byte array containing the body of the CA key that has signed the current key (OpenSSH certificates only) | # set_key_param_str method Sets a key-specific key parameter. ## Syntax ```text def set_key_param_str(name: str, value_str: str) -> None: ... ``` ## Remarks Use this method to set a key-specific or algorithm-specific key parameter provided in a string. The following parameters are currently supported: | | | | | --- | --- | --- | | Headers | | The key file headers where PEM-like format is used. | | CertSerialNumber | | The serial number of the certificate (OpenSSH certificates only) | | CertRole | | The certificate role ('host' (2) or 'user' (1)) (OpenSSH certificates only) | | CertIdentifier | | The identifier of the certificate (OpenSSH certificates only) | | CertPrincipals | | A list of principals associated with the certificate (OpenSSH certificates only) | | CertValidFrom | | The starting moment of the certificate validity period. YYYY-MM-DD HH:MM:SS format assumed (OpenSSH certificates only) | | CertValidTo | | The ending moment of the certificate validity period YYYY-MM-DD HH:MM:SS format assumed (OpenSSH certificates only) | | CertCriticalOptionCount | | The number of critical options included in the certificate (use for iterating) (OpenSSH certificates only) | | CertCriticalOptions[i] | | The i-th critical option (OpenSSH certificates only) | | CertCriticalOptionValues[i] | | The i-th critical option value (OpenSSH certificates only) | | CertExtensionCount | | The number of extensions included in the certificate (use for iterating) (OpenSSH certificates only) | | CertExtensions[i] | | The i-th extension name (OpenSSH certificates only) (OpenSSH certificates only) | | CertExtensionValues[i] | | The i-th extension value (OpenSSH certificates only) | | CertSigningKey | | A string containing the body of the CA key that has signed the current key (OpenSSH certificates only) | The below example shows the use of key parameters for setting up the details of an OpenSSH certificate: ```text mgr.CreateNew(); mgr.SetKeyParamStr("CertSerialNumber", "1984"); mgr.SetKeyParamStr("CertRole", "user"); mgr.SetKeyParamStr("CertIdentifier", "New OpenSSH certificate"); mgr.SetKeyParamStr("CertPrincipals", "john\r\njane"); mgr.SetKeyParamStr("CertValidFrom", "2026-01-01 12:34:56"); mgr.SetKeyParamStr("CertValidTo", "2029-01-01 12:34:56"); // adding a critical option explicitly mgr.SetKeyParamStr("CertCriticalOptionCount", '1'); mgr.SetKeyParamStr("CertCriticalOptions[0]", 'force-command'); mgr.SetKeyParamStr("CertCriticalOptionValues[0]", "\x0\x0\x0\x5ls -l"); // adding a known critical option using a shortcut mgr.SetKeyParamStr("CertCriticalOptionValues[verify-required]", ""); mgr.SetKeyParamStr("CertCriticalOptionValues[source-address]", "\x0\x0\x0\x1D" + "127.0.0.1,127.0.0.2,127.0.0.3"); // same syntax applies to extensions mgr.SetKeyParamStr("CertExtensionCount", "1"); mgr.SetKeyParamStr("CertExtensions[0]", "permit-pty"); mgr.SetKeyParamStr("CertExtensionValues[permit-port-forwarding]", ""); // setting the private CA key bytes := otherMgr.ExportBytes(ckfOpenSSH2, true, ""); mgr.SetKeyParam("CertSigningKey", bytes); mgr.Generate("EDDSA-certv01", "CURVE25519", "", 0); mgr.ExportToFile(Path, ckfOpenSSHCert, false, ""); mgr.ExportToFile(Path + ".priv", ckfOpenSSH2, true, ""); ``` # on_error event Information about errors during SSH key management. ## Syntax ```text 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 ```text 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](#config-method) method. ### SSHKeyManager Config Settings **DuplicatePublicKeyInOpenSSHEdDSA**: Enables or disables inclusion of the public part in private EdDSA keys.This is a global setting that regulates whether to include the public EdDSA part when writing EdDSA private keys. This is a compatibility setting. **HashAlgorithm**: Specifies the hash algorithm to be used with an RSA key when authenticating.This property specifies the hash algorithm that you would like to use when authenticating with this key. This only applies to RSA keys to resolve ambiguity between ssh-rsa and rsa-sha2-256/512 algorithms. **ImportMode**: Alters the behaviour of Import* methods.The only value allowed by this property is *Merge*. If set, the Import* call appends the data provided in the array/file/stream to the SSH key currently held in the component. Use the Merge mode to load an associated private key to a manager object that holds a public OpenSSH certificate. **TempPath**: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except [PDFSigner](PDFSigner.md#PDFSigner), where this limitation does not apply. ### Base Config Settings **ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it. **AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it. **CheckKeyIntegrityBeforeUse**: Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used. You can switch this property off to improve performance if your project only uses known, good private keys. **CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class. Supported values are: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the class.Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. **DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. **DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*. **EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections. This setting only applies to sessions negotiated with TLS version 1.3. **EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components. **EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components. **GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its *CookieCaching* property set to "global". **HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy. Supported Values: | | | | --- | --- | | auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). | | enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. | | disable | Do not use hardware cryptography. | **HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. **HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use. **IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account. **ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence. **LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped. Supported values are: | | | | | --- | --- | --- | | file | | File | | console | | Console | | systemlog | | System Log (supported for Android only) | | debugger | | Debugger (supported for VCL for Windows and .Net) | **LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump. Supported values are: | | | | | --- | --- | --- | | time | | Current time | | level | | Level | | package | | Package name | | module | | Module name | | class | | Class name | | method | | Method name | | threadid | | Thread Id | | contenttype | | Content type | | content | | Content | | all | | All details | **LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file. **LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters. Supported filter names are: | | | | | --- | --- | --- | | exclude-package | | Exclude a package specified in the value | | exclude-module | | Exclude a module specified in the value | | exclude-class | | Exclude a class specified in the value | | exclude-method | | Exclude a method specified in the value | | include-package | | Include a package specified in the value | | include-module | | Include a module specified in the value | | include-class | | Include a class specified in the value | | include-method | | Include a method specified in the value | **LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined: | | | | | --- | --- | --- | | none | | No flush (caching only) | | immediate | | Immediate flush (real-time logging) | | maxcount | | Flush cached entries upon reaching LogMaxEventCount entries in the cache. | **LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level. Supported values are: | | | | | --- | --- | --- | | none | | None (by default) | | fatal | | Severe errors that cause premature termination. | | error | | Other runtime errors or unexpected conditions. | | warning | | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | | info | | Interesting runtime events (startup/shutdown). | | debug | | Detailed information on flow of through the system. | | trace | | More detailed information. | **LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode. The default value of this setting is 100. **LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined: | | | | | --- | --- | --- | | none | | No rotation | | deleteolder | | Delete older entries from the cache upon reaching LogMaxEventCount | | keepolder | | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) | **MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. **MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. **OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. **OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak. **PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached. Supported Values: | | | | --- | --- | | certificate | Enables caching of certificates. | | crl | Enables caching of Certificate Revocation Lists (CRLs). | | ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. | Example (default value): ```text PKICache=certificate,crl,ocsp ``` In this example, the component caches certificates, CRLs, and OCSP responses. **PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts. The default value is an empty string - no cached PKI data is stored on disk. Example: ```text PKICachePath=C:\Temp\cache ``` In this example, the cached PKI data is stored in the C:\Temp\cache directory. **ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision). **ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. **StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*. Supported values are: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global static DNS rules | **StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character. **StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the class is set to "*local*", the property returns/restores the rules from/to the internal storage of the class. If *StaticDNS* of the class is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. **Tag**: Allows to store any custom data.Use this config property to store any custom data. **TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes. **TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes). **TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute). **UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used. **UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform. **UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details). **UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used. **UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. **UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. **UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team. **UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation. This setting only applies to certificates originating from a Windows system store. **UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. **XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures. The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing. Syntax: ```text Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2"); ``` Where: OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map. PrimaryName: The main descriptor name used in the XML signature when the OID is encountered. Alias1, Alias2, ...: Optional alternative names recognized during parsing. Usage Examples: Map OID 2.5.4.5 to SERIALNUMBER: ```text Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER"); ``` Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: ```text Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS"); ``` **XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing. **XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1). **XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value. # SSHKeyManager Errors ### SSHKeyManager Errors | | | | --- | --- | | 1048577 | Invalid parameter ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) | | 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) | | 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) | | 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) | | 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) | | 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) | | 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) | | 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) | | 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) | | 34603009 | Failed to loaded the trusted keys ([SB_ERROR_SSH_INVALID_KEY](constants.md#const_SBERRORSSHINVALIDKEY)) | | 34603010 | Other operation is in progress ([SB_ERROR_SSH_BUSY](constants.md#const_SBERRORSSHBUSY)) | | 34603011 | Command execution failed ([SB_ERROR_SSH_EXEC_FAILED](constants.md#const_SBERRORSSHEXECFAILED)) | | 34603012 | Failed to read data from the connection ([SB_ERROR_SSH_READ_FAILED](constants.md#const_SBERRORSSHREADFAILED)) | | 34603013 | Failed to write data to the connection ([SB_ERROR_SSH_WRITE_FAILED](constants.md#const_SBERRORSSHWRITEFAILED)) | | 34603014 | No signing key provided ([SB_ERROR_SSH_NO_SIGNING_KEY](constants.md#const_SBERRORSSHNOSIGNINGKEY)) |