SSHKeyManager Class
Properties Methods Events Configuration Settings Errors
The SSHKeyManager class stores information about SSH keys.
Syntax
class secureblackboxlite.SSHKeyManager
Remarks
SSHKeyManager provides the capabilities of generating, storing, importing, and exporting SSH keys.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| cert_bytes | Returns raw certificate data in DER format. |
| cert_ca | Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
| cert_ca_key_id | A unique identifier (fingerprint) of the CA certificate's private key. |
| cert_crl_distribution_points | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
| cert_curve | Specifies the elliptic curve of the EC public key. |
| cert_fingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
| cert_friendly_name | Contains an associated alias (friendly name) of the certificate. |
| cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| cert_hash_algorithm | Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN . |
| cert_issuer | The common name of the certificate issuer (CA), typically a company name. |
| cert_issuer_rdn | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
| cert_key_algorithm | Specifies the public key algorithm of this certificate. |
| cert_key_bits | Returns the length of the public key. |
| cert_key_fingerprint | Returns a fingerprint of the public key contained in the certificate. |
| cert_key_usage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| cert_key_valid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| cert_ocsp_locations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
| cert_origin | Returns the origin of this certificate. |
| cert_policy_i_ds | Contains identifiers (OIDs) of the applicable certificate policies. |
| cert_private_key_bytes | Contains the certificate's private key. |
| cert_private_key_exists | Indicates whether the certificate has an associated private key. |
| cert_private_key_extractable | Indicates whether the private key is extractable. |
| cert_public_key_bytes | Contains the certificate's public key in DER format. |
| cert_self_signed | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| cert_serial_number | Returns the certificate's serial number. |
| cert_sig_algorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
| cert_subject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| cert_subject_key_id | Contains a unique identifier (fingerprint) of the certificate's private key. |
| cert_subject_rdn | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
| cert_valid_from | The time point at which the certificate becomes valid, in UTC. |
| cert_valid_to | The time point at which the certificate expires, in UTC. |
| crypto_key_algorithm | The algorithm of the cryptographic key. |
| crypto_key_bits | The length of the key in bits. |
| crypto_key_exportable | Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise. |
| crypto_key_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| crypto_key_id | Provides access to a storage-specific key identifier. |
| crypto_key_iv | The initialization vector (IV) of a symmetric key. |
| crypto_key_key | The byte array representation of the key. |
| crypto_key_nonce | A nonce value associated with a key. |
| crypto_key_private | Returns True if the object hosts a private key, and False otherwise. |
| crypto_key_public | Returns True if the object hosts a public key, and False otherwise. |
| crypto_key_subject | Returns the key subject. |
| crypto_key_symmetric | Returns True if the object contains a symmetric key, and False otherwise. |
| crypto_key_valid | Returns True if this key is valid. |
| key_algorithm | Specifies the key algorithm. |
| key_bits | The number of bits in the key: the more the better, 2048 or 4096 are typical values. |
| key_comment | The comment for the public key. |
| key_curve | Specifies the elliptical curve when EC cryptography is used. |
| key_dssg | The G (Generator) parameter of the DSS signature key. |
| key_dssp | The P (Prime) parameter of the DSS signature key. |
| key_dssq | The Q (Prime Factor) parameter of the DSS signature key. |
| key_dssx | The X (Private key) parameter of the DSS signature key. |
| key_dssy | The Y (Public key) parameter of the DSS signature key. |
| key_eccd | The value of the secret key (the order of the public key, D) if elliptic curve (EC) cryptography is used. |
| key_eccqx | The value of the X coordinate of the public key if elliptic curve (EC) cryptography is used. |
| key_eccqy | The value of the Y coordinate of the public key if elliptic curve (EC) cryptography is used. |
| key_ed_private | The value of the private key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used. |
| key_ed_public | The value of the public key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used. |
| key_fingerprint_md5 | Contains the MD5 fingerprint (hash) of the key. |
| key_fingerprint_sha1 | Contains the SHA-1 fingerprint (hash) of the key. |
| key_fingerprint_sha256 | Contains the SHA-256 fingerprint (hash) of the key. |
| key_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| key_is_extractable | Whether the key is extractable (e. |
| key_is_private | Whether this key is a private key or not. |
| key_is_public | Whether this key is a public key or not. |
| key_kdf_rounds | Returns the number of iterations of the Key Derivation Function (KDF) used to generate this key. |
| key_kdf_salt | The salt value used by the Key Derivation Function (KDF) to generate this key. |
| key_key_format | Specifies the format in which the key is stored. |
| key_key_protection_algorithm | Specifies the key protection algorithm. |
| key_rsa_exponent | Returns the e parameter (public exponent) of the RSA key. |
| key_rsaiqmp | Returns the iqmp parameter of the RSA key. |
| key_rsa_modulus | Returns the m parameter (public modulus) of the RSA key. |
| key_rsap | Returns the p parameter (first factor of the common modulus n) of the RSA key. |
| key_rsa_private_exponent | Returns the d parameter (private exponent) of the RSA key. |
| key_rsaq | Returns the q parameter (second factor of the common modulus n) of the RSA key. |
| key_subject | 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 | Sets or retrieves a configuration setting. |
| export_bytes | Writes the key to a memory buffer. |
| export_to_cert | Exports the key to a certificate. |
| export_to_crypto_key | Exports the key to a crypto key object. |
| export_to_file | Writes key to file. |
| generate | Generates a new SSH key. |
| get_key_param | Returns an algorithm-specific key parameter. |
| get_key_param_str | Returns an algorithm-specific key parameter to a string. |
| import_bytes | Loads key from buffer. |
| import_from_cert | Loads a key from a certificate. |
| import_from_crypto_key | Imports a key from a crypto key. |
| import_from_file | Loads key from file. |
| set_key_param | Sets an algorithm-specific key parameter. |
| set_key_param_str | Sets an algorithm-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 | Information about errors during SSH key management. |
| on_notification | This event notifies the application about an underlying control flow event. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| TempPath | Path for storing temporary files. |