# RSA Class Implements RSA public-key cryptography to encrypt/decrypt and sign/verify messages. ## Syntax ```text class ipworksencrypt.RSA ``` ## Remarks The RSA class implements RSA public-key cryptography to encrypt/decrypt messages and sign/verify hash signatures. To begin you must either specify an existing key or create a new key. Existing private keys may be specified by setting key. To create a new key call [create_key](#create_key-method). Alternatively an existing certificate may be specified by setting certificate **Signing** To sign data first set key or certificate. Specify the input data using [input_file](#input_file-property) or [input_message](#input_message-property). Next call [sign](#sign-method). The class will populate [hash_value](#hash_value-property) and [hash_signature](#hash_signature-property). After calling [sign](#sign-method) the public key must be sent to the recipient along with [hash_signature](#hash_signature-property). **Encrypting** To encrypt data set recipient_key or recipient_cert. Specify the input data using [input_file](#input_file-property) or [input_message](#input_message-property). Next call [encrypt](#encrypt-method). The class will populate [output_message](#output_message-property), or write to the file specified by [output_file](#output_file-property). **Signature Verification** To verify a signature specify the input data using [input_file](#input_file-property) or [input_message](#input_message-property). Set signer_key or signer_cert. Next set [hash_signature](#hash_signature-property) and call [verify_signature](#verify_signature-method). The [verify_signature](#verify_signature-method) method will return True if the signature was successfully verified. **Decrypting** To decrypt data first set key or certificate. Specify the input data using [input_file](#input_file-property) or [input_message](#input_message-property). Next call [decrypt](#decrypt-method). The class will populate [output_message](#output_message-property), or write to the file specified by [output_file](#output_file-property). **Input and Output Properties** The class will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [input_file](#input_file-property) - [input_message](#input_message-property) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [output_file](#output_file-property) - [output_message](#output_message-property): The output data is written to this property if no other destination is specified. **RSA Keys** A RSA key is made up of a number of individual parameters. The public key consists of the following parameters: - [key_modulus](#key_modulus-property) - [key_exponent](#key_exponent-property) The class also includes the [key_public_key](#key_public_key-property) property which holds the PEM formatted public key for ease of use. This is helpful if you are in control of both sides of the encryption/signing and decryption/signature verification process. When sending the public key to a recipient note that not all implementations will support using the PEM formatted value in [key_public_key](#key_public_key-property) in which case the individual parameters must be sent. The private key may be represented in one of two ways. Both are mathematically equivalent. Private key format 1: - [key_modulus](#key_modulus-property) - [key_p](#key_p-property) - [key_q](#key_q-property) - [key_dp](#key_dp-property) - [key_dq](#key_dq-property) Private key format 2 is simpler but has decreased performance when decrypting and signing. This format is: - [key_modulus](#key_modulus-property) - [key_d](#key_d-property) The class also include the [key_private_key](#key_private_key-property) property which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily. ## 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_effective_date](#cert_effective_date-property) | The date on which this certificate becomes valid. | | [cert_encoded](#cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [cert_expiration_date](#cert_expiration_date-property) | The date on which the certificate expires. | | [cert_extended_key_usage](#cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [cert_fingerprint](#cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [cert_fingerprint_sha1](#cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [cert_fingerprint_sha256](#cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [cert_issuer](#cert_issuer-property) | The issuer of the certificate. | | [cert_private_key](#cert_private_key-property) | The private key of the certificate (if available). | | [cert_private_key_available](#cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [cert_private_key_container](#cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [cert_public_key](#cert_public_key-property) | The public key of the certificate. | | [cert_public_key_algorithm](#cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [cert_public_key_length](#cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [cert_serial_number](#cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [cert_signature_algorithm](#cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [cert_store](#cert_store-property) | The name of the certificate store for the client certificate. | | [cert_store_password](#cert_store_password-property) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [cert_store_type](#cert_store_type-property) | The type of certificate store for this certificate. | | [cert_subject](#cert_subject-property) | The subject of the certificate used for client authentication. | | [cert_subject_alt_names](#cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [cert_thumbprint_md5](#cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [cert_thumbprint_sha1](#cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [cert_thumbprint_sha256](#cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [cert_usage](#cert_usage-property) | The text description of UsageFlags . | | [cert_usage_flags](#cert_usage_flags-property) | The flags that show intended use for the certificate. | | [cert_version](#cert_version-property) | The certificate's version number. | | [hash_algorithm](#hash_algorithm-property) | The hash algorithm used for signing and signature verification. | | [hash_signature](#hash_signature-property) | The hash signature. | | [hash_value](#hash_value-property) | The hash value of the data. | | [input_file](#input_file-property) | The file to process. | | [input_message](#input_message-property) | The message to process. | | [key_d](#key_d-property) | Represents the D parameter for the RSA algorithm. | | [key_dp](#key_dp-property) | Represents the DP parameter for the RSA algorithm. | | [key_dq](#key_dq-property) | Represents the DQ parameter for the RSA algorithm. | | [key_exponent](#key_exponent-property) | Represents the Exponent parameter for the RSA algorithm. | | [key_inverse_q](#key_inverse_q-property) | Represents the InverseQ parameter for the RSA algorithm. | | [key_modulus](#key_modulus-property) | Represents the Modulus parameter for the RSA algorithm. | | [key_p](#key_p-property) | Represents the P parameter for the RSA algorithm. | | [key_private_key](#key_private_key-property) | This property is a PEM formatted private key. | | [key_public_key](#key_public_key-property) | This property is a PEM formatted public key. | | [key_q](#key_q-property) | Represents the Q parameter for the RSA algorithm. | | [output_file](#output_file-property) | The output file when encrypting or decrypting. | | [output_message](#output_message-property) | The output message after processing. | | [overwrite](#overwrite-property) | Indicates whether or not the class should overwrite files. | | [recipient_cert_effective_date](#recipient_cert_effective_date-property) | The date on which this certificate becomes valid. | | [recipient_cert_encoded](#recipient_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [recipient_cert_expiration_date](#recipient_cert_expiration_date-property) | The date on which the certificate expires. | | [recipient_cert_extended_key_usage](#recipient_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [recipient_cert_fingerprint](#recipient_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [recipient_cert_fingerprint_sha1](#recipient_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [recipient_cert_fingerprint_sha256](#recipient_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [recipient_cert_issuer](#recipient_cert_issuer-property) | The issuer of the certificate. | | [recipient_cert_private_key](#recipient_cert_private_key-property) | The private key of the certificate (if available). | | [recipient_cert_private_key_available](#recipient_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [recipient_cert_private_key_container](#recipient_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [recipient_cert_public_key](#recipient_cert_public_key-property) | The public key of the certificate. | | [recipient_cert_public_key_algorithm](#recipient_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [recipient_cert_public_key_length](#recipient_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [recipient_cert_serial_number](#recipient_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [recipient_cert_signature_algorithm](#recipient_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [recipient_cert_store](#recipient_cert_store-property) | The name of the certificate store for the client certificate. | | [recipient_cert_store_password](#recipient_cert_store_password-property) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [recipient_cert_store_type](#recipient_cert_store_type-property) | The type of certificate store for this certificate. | | [recipient_cert_subject](#recipient_cert_subject-property) | The subject of the certificate used for client authentication. | | [recipient_cert_subject_alt_names](#recipient_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [recipient_cert_thumbprint_md5](#recipient_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [recipient_cert_thumbprint_sha1](#recipient_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [recipient_cert_thumbprint_sha256](#recipient_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [recipient_cert_usage](#recipient_cert_usage-property) | The text description of UsageFlags . | | [recipient_cert_usage_flags](#recipient_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [recipient_cert_version](#recipient_cert_version-property) | The certificate's version number. | | [recipient_key_exponent](#recipient_key_exponent-property) | Represents the Exponent parameter for the RSA algorithm. | | [recipient_key_modulus](#recipient_key_modulus-property) | Represents the Modulus parameter for the RSA algorithm. | | [recipient_key_public_key](#recipient_key_public_key-property) | This property is a PEM formatted public key. | | [signer_cert_effective_date](#signer_cert_effective_date-property) | The date on which this certificate becomes valid. | | [signer_cert_encoded](#signer_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [signer_cert_expiration_date](#signer_cert_expiration_date-property) | The date on which the certificate expires. | | [signer_cert_extended_key_usage](#signer_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [signer_cert_fingerprint](#signer_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [signer_cert_fingerprint_sha1](#signer_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [signer_cert_fingerprint_sha256](#signer_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [signer_cert_issuer](#signer_cert_issuer-property) | The issuer of the certificate. | | [signer_cert_private_key](#signer_cert_private_key-property) | The private key of the certificate (if available). | | [signer_cert_private_key_available](#signer_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [signer_cert_private_key_container](#signer_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [signer_cert_public_key](#signer_cert_public_key-property) | The public key of the certificate. | | [signer_cert_public_key_algorithm](#signer_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [signer_cert_public_key_length](#signer_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [signer_cert_serial_number](#signer_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [signer_cert_signature_algorithm](#signer_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [signer_cert_store](#signer_cert_store-property) | The name of the certificate store for the client certificate. | | [signer_cert_store_password](#signer_cert_store_password-property) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [signer_cert_store_type](#signer_cert_store_type-property) | The type of certificate store for this certificate. | | [signer_cert_subject](#signer_cert_subject-property) | The subject of the certificate used for client authentication. | | [signer_cert_subject_alt_names](#signer_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [signer_cert_thumbprint_md5](#signer_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [signer_cert_thumbprint_sha1](#signer_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [signer_cert_thumbprint_sha256](#signer_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [signer_cert_usage](#signer_cert_usage-property) | The text description of UsageFlags . | | [signer_cert_usage_flags](#signer_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [signer_cert_version](#signer_cert_version-property) | The certificate's version number. | | [signer_key_exponent](#signer_key_exponent-property) | Represents the Exponent parameter for the RSA algorithm. | | [signer_key_modulus](#signer_key_modulus-property) | Represents the Modulus parameter for the RSA algorithm. | | [signer_key_public_key](#signer_key_public_key-property) | This property is a PEM formatted public key. | | [use_hex](#use_hex-property) | Whether input or output is hex encoded. | | [use_oaep](#use_oaep-property) | Whether to use Optimal Asymmetric Encryption Padding (OAEP). | | [use_pss](#use_pss-property) | Whether to use RSA-PSS during signing and verification. | ## 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_key](#create_key-method) | Creates a new key. | | [decrypt](#decrypt-method) | Decrypts the input data using the specified private key. | | [encrypt](#encrypt-method) | Encrypts the input data using the recipient's public key. | | [reset](#reset-method) | Resets the class. | | [sign](#sign-method) | Creates a hash signature. | | [verify_signature](#verify_signature-method) | Verifies the signature for the specified data. | ## 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) | Fired when information is available about errors during data delivery. | | [on_progress](#on_progress-event) | Fired as progress is made. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [KeyFormat](#KeyFormat) | How the public and private key are formatted. | | [KeySize](#KeySize) | The size, in bits, of the secret key. | | [OAEPMGF1HashAlgorithm](#OAEPMGF1HashAlgorithm) | The MGF1 hash algorithm used with OAEP. | | [OAEPParams](#OAEPParams) | The hex encoded OAEP parameters. | | [UsePrimitive](#UsePrimitive) | Enables primitive RSA encryption with no padding scheme or output modification. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. | | [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. | | [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the class whether or not to use FIPS certified APIs. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_cert_effective_date() -> str: ... cert_effective_date = property(get_cert_effective_date, None) ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. # cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_cert_encoded() -> bytes: ... def set_cert_encoded(value: bytes) -> None: ... cert_encoded = property(get_cert_encoded, set_cert_encoded) ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [cert_store](#cert_store-property) and [cert_subject](#cert_subject-property) properties also may be used to specify a certificate. When [cert_encoded](#cert_encoded-property) is set, a search is initiated in the current [cert_store](#cert_store-property) for the private key of the certificate. If the key is found, [cert_subject](#cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [cert_subject](#cert_subject-property) is set to an empty string. # cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_cert_expiration_date() -> str: ... cert_expiration_date = property(get_cert_expiration_date, None) ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. # cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_cert_extended_key_usage() -> str: ... cert_extended_key_usage = property(get_cert_extended_key_usage, None) ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. # cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_cert_fingerprint() -> str: ... cert_fingerprint = property(get_cert_fingerprint, None) ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. # cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_cert_fingerprint_sha1() -> str: ... cert_fingerprint_sha1 = property(get_cert_fingerprint_sha1, None) ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. # cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_cert_fingerprint_sha256() -> str: ... cert_fingerprint_sha256 = property(get_cert_fingerprint_sha256, None) ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. # cert_issuer property The issuer of the certificate. ## Syntax ```text def get_cert_issuer() -> str: ... cert_issuer = property(get_cert_issuer, None) ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. # cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_cert_private_key() -> str: ... cert_private_key = property(get_cert_private_key, None) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [cert_private_key](#cert_private_key-property) may be available but not exportable. In this case, [cert_private_key](#cert_private_key-property) returns an empty string. This property is read-only. # cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_cert_private_key_available() -> bool: ... cert_private_key_available = property(get_cert_private_key_available, None) ``` ## Default Value FALSE ## Remarks Whether a [cert_private_key](#cert_private_key-property) is available for the selected certificate. If [cert_private_key_available](#cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. # cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_cert_private_key_container() -> str: ... cert_private_key_container = property(get_cert_private_key_container, None) ``` ## Default Value "" ## Remarks The name of the [cert_private_key](#cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. # cert_public_key property The public key of the certificate. ## Syntax ```text def get_cert_public_key() -> str: ... cert_public_key = property(get_cert_public_key, None) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. # cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_cert_public_key_algorithm() -> str: ... cert_public_key_algorithm = property(get_cert_public_key_algorithm, None) ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. # cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_cert_public_key_length() -> int: ... cert_public_key_length = property(get_cert_public_key_length, None) ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. # cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_cert_serial_number() -> str: ... cert_serial_number = property(get_cert_serial_number, None) ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. # cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_cert_signature_algorithm() -> str: ... cert_signature_algorithm = property(get_cert_signature_algorithm, None) ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. # cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_cert_store() -> bytes: ... def set_cert_store(value: bytes) -> None: ... cert_store = property(get_cert_store, set_cert_store) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [cert_store_type](#cert_store_type-property) property denotes the type of the certificate store specified by [cert_store](#cert_store-property). If the store is password-protected, specify the password in [cert_store_password](#cert_store_password-property). [cert_store](#cert_store-property) is used in conjunction with the [cert_subject](#cert_subject-property) property to specify client certificates. If [cert_store](#cert_store-property) has a value, and [cert_subject](#cert_subject-property) or [cert_encoded](#cert_encoded-property) is set, a search for a certificate is initiated. Please see the [cert_subject](#cert_subject-property) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). # cert_store_password property If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text def get_cert_store_password() -> str: ... def set_cert_store_password(value: str) -> None: ... cert_store_password = property(get_cert_store_password, set_cert_store_password) ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. # cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_cert_store_type() -> int: ... def set_cert_store_type(value: int) -> None: ... cert_store_type = property(get_cert_store_type, set_cert_store_type) ``` ## Possible Values ```text 0 # User1 # Machine2 # PFXFile3 # PFXBlob4 # JKSFile5 # JKSBlob6 # PEMKeyFile7 # PEMKeyBlob8 # PublicKeyFile9 # PublicKeyBlob10 # SSHPublicKeyBlob11 # P7BFile12 # P7BBlob13 # SSHPublicKeyFile14 # PPKFile15 # PPKBlob16 # XMLFile17 # XMLBlob18 # JWKFile19 # JWKBlob20 # SecurityKey21 # BCFKSFile22 # BCFKSBlob23 # PKCS1199 # Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [cert_store_type](#cert_store_type-property), the full path of the PKCS#11 DLL as the [cert_store](#cert_store-property), and the PIN as the [cert_store_password](#cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [cert_store](#cert_store-property) and set [cert_store_password](#cert_store_password-property) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | # cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_cert_subject() -> str: ... def set_cert_subject(value: str) -> None: ... cert_subject = property(get_cert_subject, set_cert_subject) ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. # cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_cert_subject_alt_names() -> str: ... cert_subject_alt_names = property(get_cert_subject_alt_names, None) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. # cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_cert_thumbprint_md5() -> str: ... cert_thumbprint_md5 = property(get_cert_thumbprint_md5, None) ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_cert_thumbprint_sha1() -> str: ... cert_thumbprint_sha1 = property(get_cert_thumbprint_sha1, None) ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_cert_thumbprint_sha256() -> str: ... cert_thumbprint_sha256 = property(get_cert_thumbprint_sha256, None) ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # cert_usage property The text description of UsageFlags . ## Syntax ```text def get_cert_usage() -> str: ... cert_usage = property(get_cert_usage, None) ``` ## Default Value "" ## Remarks The text description of [cert_usage_flags](#cert_usage_flags-property). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. # cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_cert_usage_flags() -> int: ... cert_usage_flags = property(get_cert_usage_flags, None) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [cert_usage_flags](#cert_usage_flags-property) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [cert_usage](#cert_usage-property) property for a text representation of [cert_usage_flags](#cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. This property is read-only. # cert_version property The certificate's version number. ## Syntax ```text def get_cert_version() -> str: ... cert_version = property(get_cert_version, None) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. # hash_algorithm property The hash algorithm used for signing and signature verification. ## Syntax ```text def get_hash_algorithm() -> int: ... def set_hash_algorithm(value: int) -> None: ... hash_algorithm = property(get_hash_algorithm, set_hash_algorithm) ``` ## Possible Values ```text 0 # SHA11 # SHA2242 # SHA2563 # SHA3844 # SHA5125 # RIPEMD1606 # MD27 # MD58 # MD5SHA1 ``` ## Default Value 2 ## Remarks This property specifies the hash algorithm used for signing and signature verification. Possible values are: | | | | --- | --- | | 0 (rhaSHA1) | SHA-1 | | 1 (rhaSHA224) | SHA-224 | | 2 (rhaSHA256 - default) | SHA-256 | | 3 (rhaSHA384) | SHA-384 | | 4 (rhaSHA512) | SHA-512 | | 5 (rhaRIPEMD160) | RIPEMD-160 | | 6 (rhaMD2) | MD2 | | 7 (rhaMD5) | MD5 | | 8 (rhaMD5SHA1) | MD5SHA1 | # hash_signature property The hash signature. ## Syntax ```text def get_hash_signature() -> bytes: ... def set_hash_signature(value: bytes) -> None: ... hash_signature = property(get_hash_signature, set_hash_signature) ``` ## Default Value "" ## Remarks This property holds the computed hash signature. This is populated after calling [sign](#sign-method). This must be set before calling [verify_signature](#verify_signature-method). # hash_value property The hash value of the data. ## Syntax ```text def get_hash_value() -> bytes: ... def set_hash_value(value: bytes) -> None: ... hash_value = property(get_hash_value, set_hash_value) ``` ## Default Value "" ## Remarks This property holds the computed hash value for the specified data. This is populated when calling [sign](#sign-method) or [verify_signature](#verify_signature-method) when an input file is specified by setting [input_file](#input_file-property) or [input_message](#input_message-property). If you know the hash value prior to using the class you may specify the pre-computed hash value here. **Hash Notes** The class will determine whether or not to recompute the hash based on the properties that are set. If a file is specified by [input_file](#input_file-property) or [input_message](#input_message-property), the hash will be recomputed when calling [sign](#sign-method) or [verify_signature](#verify_signature-method). If the hash_value property is set, the class will only sign the hash or verify the hash signature. Setting [input_file](#input_file-property) or [input_message](#input_message-property) clears the hash_value property. Setting the hash_value property clears the input file selection. # input_file property The file to process. ## Syntax ```text def get_input_file() -> str: ... def set_input_file(value: str) -> None: ... input_file = property(get_input_file, set_input_file) ``` ## Default Value "" ## Remarks This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed. **Input and Output Properties** The class will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - input_file - [input_message](#input_message-property) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [output_file](#output_file-property) - [output_message](#output_message-property): The output data is written to this property if no other destination is specified. # input_message property The message to process. ## Syntax ```text def get_input_message() -> bytes: ... def set_input_message(value: bytes) -> None: ... input_message = property(get_input_message, set_input_message) ``` ## Default Value "" ## Remarks This property specifies the message to be processed. **Input and Output Properties** The class will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [input_file](#input_file-property) - input_message When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [output_file](#output_file-property) - [output_message](#output_message-property): The output data is written to this property if no other destination is specified. # key_d property Represents the D parameter for the RSA algorithm. ## Syntax ```text def get_key_d() -> bytes: ... def set_key_d(value: bytes) -> None: ... key_d = property(get_key_d, set_key_d) ``` ## Default Value "" ## Remarks Represents the D parameter for the RSA algorithm. # key_dp property Represents the DP parameter for the RSA algorithm. ## Syntax ```text def get_key_dp() -> bytes: ... def set_key_dp(value: bytes) -> None: ... key_dp = property(get_key_dp, set_key_dp) ``` ## Default Value "" ## Remarks Represents the DP parameter for the RSA algorithm. # key_dq property Represents the DQ parameter for the RSA algorithm. ## Syntax ```text def get_key_dq() -> bytes: ... def set_key_dq(value: bytes) -> None: ... key_dq = property(get_key_dq, set_key_dq) ``` ## Default Value "" ## Remarks Represents the DQ parameter for the RSA algorithm. # key_exponent property Represents the Exponent parameter for the RSA algorithm. ## Syntax ```text def get_key_exponent() -> bytes: ... def set_key_exponent(value: bytes) -> None: ... key_exponent = property(get_key_exponent, set_key_exponent) ``` ## Default Value "" ## Remarks Represents the Exponent parameter for the RSA algorithm. # key_inverse_q property Represents the InverseQ parameter for the RSA algorithm. ## Syntax ```text def get_key_inverse_q() -> bytes: ... def set_key_inverse_q(value: bytes) -> None: ... key_inverse_q = property(get_key_inverse_q, set_key_inverse_q) ``` ## Default Value "" ## Remarks Represents the InverseQ parameter for the RSA algorithm. This parameter is optional and is automatically calculated as necessary. # key_modulus property Represents the Modulus parameter for the RSA algorithm. ## Syntax ```text def get_key_modulus() -> bytes: ... def set_key_modulus(value: bytes) -> None: ... key_modulus = property(get_key_modulus, set_key_modulus) ``` ## Default Value "" ## Remarks Represents the Modulus parameter for the RSA algorithm. # key_p property Represents the P parameter for the RSA algorithm. ## Syntax ```text def get_key_p() -> bytes: ... def set_key_p(value: bytes) -> None: ... key_p = property(get_key_p, set_key_p) ``` ## Default Value "" ## Remarks Represents the P parameter for the RSA algorithm. # key_private_key property This property is a PEM formatted private key. ## Syntax ```text def get_key_private_key() -> str: ... def set_key_private_key(value: str) -> None: ... key_private_key = property(get_key_private_key, set_key_private_key) ``` ## Default Value "" ## Remarks This property is a PEM formatted private key. The purpose of this property is to allow easier management of the private key parameters by using only a single value. # key_public_key property This property is a PEM formatted public key. ## Syntax ```text def get_key_public_key() -> str: ... def set_key_public_key(value: str) -> None: ... key_public_key = property(get_key_public_key, set_key_public_key) ``` ## Default Value "" ## Remarks This property is a PEM formatted public key. The purpose of this property is to allow easier management of the public key parameters by using only a single value. # key_q property Represents the Q parameter for the RSA algorithm. ## Syntax ```text def get_key_q() -> bytes: ... def set_key_q(value: bytes) -> None: ... key_q = property(get_key_q, set_key_q) ``` ## Default Value "" ## Remarks Represents the Q parameter for the RSA algorithm. # output_file property The output file when encrypting or decrypting. ## Syntax ```text def get_output_file() -> str: ... def set_output_file(value: str) -> None: ... output_file = property(get_output_file, set_output_file) ``` ## Default Value "" ## Remarks This property specifies the file to which the output will be written when [encrypt](#encrypt-method) or [decrypt](#decrypt-method) is called. This may be set to an absolute or relative path. This property is only applicable to [encrypt](#encrypt-method) and [decrypt](#decrypt-method). **Input and Output Properties** The class will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [input_file](#input_file-property) - [input_message](#input_message-property) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - output_file - [output_message](#output_message-property): The output data is written to this property if no other destination is specified. # output_message property The output message after processing. ## Syntax ```text def get_output_message() -> bytes: ... output_message = property(get_output_message, None) ``` ## Default Value "" ## Remarks This property will be populated with the output from the operation if [output_file](#output_file-property) is not set. **Input and Output Properties** The class will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [input_file](#input_file-property) - [input_message](#input_message-property) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [output_file](#output_file-property) - output_message: The output data is written to this property if no other destination is specified. This property is read-only. # overwrite property Indicates whether or not the class should overwrite files. ## Syntax ```text def get_overwrite() -> bool: ... def set_overwrite(value: bool) -> None: ... overwrite = property(get_overwrite, set_overwrite) ``` ## Default Value FALSE ## Remarks This property indicates whether or not the class will overwrite [output_file](#output_file-property). If overwrite is False, an error will be thrown whenever [output_file](#output_file-property) exists before an operation. The default value is False. # recipient_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_recipient_cert_effective_date() -> str: ... recipient_cert_effective_date = property(get_recipient_cert_effective_date, None) ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. # recipient_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_recipient_cert_encoded() -> bytes: ... def set_recipient_cert_encoded(value: bytes) -> None: ... recipient_cert_encoded = property(get_recipient_cert_encoded, set_recipient_cert_encoded) ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [recipient_cert_store](#recipient_cert_store-property) and [recipient_cert_subject](#recipient_cert_subject-property) properties also may be used to specify a certificate. When [recipient_cert_encoded](#recipient_cert_encoded-property) is set, a search is initiated in the current [recipient_cert_store](#recipient_cert_store-property) for the private key of the certificate. If the key is found, [recipient_cert_subject](#recipient_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [recipient_cert_subject](#recipient_cert_subject-property) is set to an empty string. # recipient_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_recipient_cert_expiration_date() -> str: ... recipient_cert_expiration_date = property(get_recipient_cert_expiration_date, None) ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. # recipient_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_recipient_cert_extended_key_usage() -> str: ... recipient_cert_extended_key_usage = property(get_recipient_cert_extended_key_usage, None) ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. # recipient_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_recipient_cert_fingerprint() -> str: ... recipient_cert_fingerprint = property(get_recipient_cert_fingerprint, None) ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. # recipient_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_recipient_cert_fingerprint_sha1() -> str: ... recipient_cert_fingerprint_sha1 = property(get_recipient_cert_fingerprint_sha1, None) ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. # recipient_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_recipient_cert_fingerprint_sha256() -> str: ... recipient_cert_fingerprint_sha256 = property(get_recipient_cert_fingerprint_sha256, None) ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. # recipient_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_recipient_cert_issuer() -> str: ... recipient_cert_issuer = property(get_recipient_cert_issuer, None) ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. # recipient_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_recipient_cert_private_key() -> str: ... recipient_cert_private_key = property(get_recipient_cert_private_key, None) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [recipient_cert_private_key](#recipient_cert_private_key-property) may be available but not exportable. In this case, [recipient_cert_private_key](#recipient_cert_private_key-property) returns an empty string. This property is read-only. # recipient_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_recipient_cert_private_key_available() -> bool: ... recipient_cert_private_key_available = property(get_recipient_cert_private_key_available, None) ``` ## Default Value FALSE ## Remarks Whether a [recipient_cert_private_key](#recipient_cert_private_key-property) is available for the selected certificate. If [recipient_cert_private_key_available](#recipient_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. # recipient_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_recipient_cert_private_key_container() -> str: ... recipient_cert_private_key_container = property(get_recipient_cert_private_key_container, None) ``` ## Default Value "" ## Remarks The name of the [recipient_cert_private_key](#recipient_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. # recipient_cert_public_key property The public key of the certificate. ## Syntax ```text def get_recipient_cert_public_key() -> str: ... recipient_cert_public_key = property(get_recipient_cert_public_key, None) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. # recipient_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_recipient_cert_public_key_algorithm() -> str: ... recipient_cert_public_key_algorithm = property(get_recipient_cert_public_key_algorithm, None) ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. # recipient_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_recipient_cert_public_key_length() -> int: ... recipient_cert_public_key_length = property(get_recipient_cert_public_key_length, None) ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. # recipient_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_recipient_cert_serial_number() -> str: ... recipient_cert_serial_number = property(get_recipient_cert_serial_number, None) ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. # recipient_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_recipient_cert_signature_algorithm() -> str: ... recipient_cert_signature_algorithm = property(get_recipient_cert_signature_algorithm, None) ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. # recipient_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_recipient_cert_store() -> bytes: ... def set_recipient_cert_store(value: bytes) -> None: ... recipient_cert_store = property(get_recipient_cert_store, set_recipient_cert_store) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [recipient_cert_store_type](#recipient_cert_store_type-property) property denotes the type of the certificate store specified by [recipient_cert_store](#recipient_cert_store-property). If the store is password-protected, specify the password in [recipient_cert_store_password](#recipient_cert_store_password-property). [recipient_cert_store](#recipient_cert_store-property) is used in conjunction with the [recipient_cert_subject](#recipient_cert_subject-property) property to specify client certificates. If [recipient_cert_store](#recipient_cert_store-property) has a value, and [recipient_cert_subject](#recipient_cert_subject-property) or [recipient_cert_encoded](#recipient_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [recipient_cert_subject](#recipient_cert_subject-property) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). # recipient_cert_store_password property If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text def get_recipient_cert_store_password() -> str: ... def set_recipient_cert_store_password(value: str) -> None: ... recipient_cert_store_password = property(get_recipient_cert_store_password, set_recipient_cert_store_password) ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. # recipient_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_recipient_cert_store_type() -> int: ... def set_recipient_cert_store_type(value: int) -> None: ... recipient_cert_store_type = property(get_recipient_cert_store_type, set_recipient_cert_store_type) ``` ## Possible Values ```text 0 # User1 # Machine2 # PFXFile3 # PFXBlob4 # JKSFile5 # JKSBlob6 # PEMKeyFile7 # PEMKeyBlob8 # PublicKeyFile9 # PublicKeyBlob10 # SSHPublicKeyBlob11 # P7BFile12 # P7BBlob13 # SSHPublicKeyFile14 # PPKFile15 # PPKBlob16 # XMLFile17 # XMLBlob18 # JWKFile19 # JWKBlob20 # SecurityKey21 # BCFKSFile22 # BCFKSBlob23 # PKCS1199 # Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [recipient_cert_store_type](#recipient_cert_store_type-property), the full path of the PKCS#11 DLL as the [recipient_cert_store](#recipient_cert_store-property), and the PIN as the [recipient_cert_store_password](#recipient_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [recipient_cert_store](#recipient_cert_store-property) and set [recipient_cert_store_password](#recipient_cert_store_password-property) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | # recipient_cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_recipient_cert_subject() -> str: ... def set_recipient_cert_subject(value: str) -> None: ... recipient_cert_subject = property(get_recipient_cert_subject, set_recipient_cert_subject) ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. # recipient_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_recipient_cert_subject_alt_names() -> str: ... recipient_cert_subject_alt_names = property(get_recipient_cert_subject_alt_names, None) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. # recipient_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_recipient_cert_thumbprint_md5() -> str: ... recipient_cert_thumbprint_md5 = property(get_recipient_cert_thumbprint_md5, None) ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # recipient_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_recipient_cert_thumbprint_sha1() -> str: ... recipient_cert_thumbprint_sha1 = property(get_recipient_cert_thumbprint_sha1, None) ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # recipient_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_recipient_cert_thumbprint_sha256() -> str: ... recipient_cert_thumbprint_sha256 = property(get_recipient_cert_thumbprint_sha256, None) ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # recipient_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_recipient_cert_usage() -> str: ... recipient_cert_usage = property(get_recipient_cert_usage, None) ``` ## Default Value "" ## Remarks The text description of [recipient_cert_usage_flags](#recipient_cert_usage_flags-property). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. # recipient_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_recipient_cert_usage_flags() -> int: ... recipient_cert_usage_flags = property(get_recipient_cert_usage_flags, None) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [recipient_cert_usage_flags](#recipient_cert_usage_flags-property) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [recipient_cert_usage](#recipient_cert_usage-property) property for a text representation of [recipient_cert_usage_flags](#recipient_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. This property is read-only. # recipient_cert_version property The certificate's version number. ## Syntax ```text def get_recipient_cert_version() -> str: ... recipient_cert_version = property(get_recipient_cert_version, None) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. # recipient_key_exponent property Represents the Exponent parameter for the RSA algorithm. ## Syntax ```text def get_recipient_key_exponent() -> bytes: ... def set_recipient_key_exponent(value: bytes) -> None: ... recipient_key_exponent = property(get_recipient_key_exponent, set_recipient_key_exponent) ``` ## Default Value "" ## Remarks Represents the Exponent parameter for the RSA algorithm. # recipient_key_modulus property Represents the Modulus parameter for the RSA algorithm. ## Syntax ```text def get_recipient_key_modulus() -> bytes: ... def set_recipient_key_modulus(value: bytes) -> None: ... recipient_key_modulus = property(get_recipient_key_modulus, set_recipient_key_modulus) ``` ## Default Value "" ## Remarks Represents the Modulus parameter for the RSA algorithm. # recipient_key_public_key property This property is a PEM formatted public key. ## Syntax ```text def get_recipient_key_public_key() -> str: ... def set_recipient_key_public_key(value: str) -> None: ... recipient_key_public_key = property(get_recipient_key_public_key, set_recipient_key_public_key) ``` ## Default Value "" ## Remarks This property is a PEM formatted public key. The purpose of this property is to allow easier management of the public key parameters by using only a single value. # signer_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_signer_cert_effective_date() -> str: ... signer_cert_effective_date = property(get_signer_cert_effective_date, None) ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. # signer_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_signer_cert_encoded() -> bytes: ... def set_signer_cert_encoded(value: bytes) -> None: ... signer_cert_encoded = property(get_signer_cert_encoded, set_signer_cert_encoded) ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [signer_cert_store](#signer_cert_store-property) and [signer_cert_subject](#signer_cert_subject-property) properties also may be used to specify a certificate. When [signer_cert_encoded](#signer_cert_encoded-property) is set, a search is initiated in the current [signer_cert_store](#signer_cert_store-property) for the private key of the certificate. If the key is found, [signer_cert_subject](#signer_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [signer_cert_subject](#signer_cert_subject-property) is set to an empty string. # signer_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_signer_cert_expiration_date() -> str: ... signer_cert_expiration_date = property(get_signer_cert_expiration_date, None) ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. # signer_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_signer_cert_extended_key_usage() -> str: ... signer_cert_extended_key_usage = property(get_signer_cert_extended_key_usage, None) ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. # signer_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_signer_cert_fingerprint() -> str: ... signer_cert_fingerprint = property(get_signer_cert_fingerprint, None) ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. # signer_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_signer_cert_fingerprint_sha1() -> str: ... signer_cert_fingerprint_sha1 = property(get_signer_cert_fingerprint_sha1, None) ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. # signer_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_signer_cert_fingerprint_sha256() -> str: ... signer_cert_fingerprint_sha256 = property(get_signer_cert_fingerprint_sha256, None) ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. # signer_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_signer_cert_issuer() -> str: ... signer_cert_issuer = property(get_signer_cert_issuer, None) ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. # signer_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_signer_cert_private_key() -> str: ... signer_cert_private_key = property(get_signer_cert_private_key, None) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [signer_cert_private_key](#signer_cert_private_key-property) may be available but not exportable. In this case, [signer_cert_private_key](#signer_cert_private_key-property) returns an empty string. This property is read-only. # signer_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_signer_cert_private_key_available() -> bool: ... signer_cert_private_key_available = property(get_signer_cert_private_key_available, None) ``` ## Default Value FALSE ## Remarks Whether a [signer_cert_private_key](#signer_cert_private_key-property) is available for the selected certificate. If [signer_cert_private_key_available](#signer_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. # signer_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_signer_cert_private_key_container() -> str: ... signer_cert_private_key_container = property(get_signer_cert_private_key_container, None) ``` ## Default Value "" ## Remarks The name of the [signer_cert_private_key](#signer_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. # signer_cert_public_key property The public key of the certificate. ## Syntax ```text def get_signer_cert_public_key() -> str: ... signer_cert_public_key = property(get_signer_cert_public_key, None) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. # signer_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_signer_cert_public_key_algorithm() -> str: ... signer_cert_public_key_algorithm = property(get_signer_cert_public_key_algorithm, None) ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. # signer_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_signer_cert_public_key_length() -> int: ... signer_cert_public_key_length = property(get_signer_cert_public_key_length, None) ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. # signer_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_signer_cert_serial_number() -> str: ... signer_cert_serial_number = property(get_signer_cert_serial_number, None) ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. # signer_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_signer_cert_signature_algorithm() -> str: ... signer_cert_signature_algorithm = property(get_signer_cert_signature_algorithm, None) ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. # signer_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_signer_cert_store() -> bytes: ... def set_signer_cert_store(value: bytes) -> None: ... signer_cert_store = property(get_signer_cert_store, set_signer_cert_store) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [signer_cert_store_type](#signer_cert_store_type-property) property denotes the type of the certificate store specified by [signer_cert_store](#signer_cert_store-property). If the store is password-protected, specify the password in [signer_cert_store_password](#signer_cert_store_password-property). [signer_cert_store](#signer_cert_store-property) is used in conjunction with the [signer_cert_subject](#signer_cert_subject-property) property to specify client certificates. If [signer_cert_store](#signer_cert_store-property) has a value, and [signer_cert_subject](#signer_cert_subject-property) or [signer_cert_encoded](#signer_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [signer_cert_subject](#signer_cert_subject-property) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). # signer_cert_store_password property If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text def get_signer_cert_store_password() -> str: ... def set_signer_cert_store_password(value: str) -> None: ... signer_cert_store_password = property(get_signer_cert_store_password, set_signer_cert_store_password) ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. # signer_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_signer_cert_store_type() -> int: ... def set_signer_cert_store_type(value: int) -> None: ... signer_cert_store_type = property(get_signer_cert_store_type, set_signer_cert_store_type) ``` ## Possible Values ```text 0 # User1 # Machine2 # PFXFile3 # PFXBlob4 # JKSFile5 # JKSBlob6 # PEMKeyFile7 # PEMKeyBlob8 # PublicKeyFile9 # PublicKeyBlob10 # SSHPublicKeyBlob11 # P7BFile12 # P7BBlob13 # SSHPublicKeyFile14 # PPKFile15 # PPKBlob16 # XMLFile17 # XMLBlob18 # JWKFile19 # JWKBlob20 # SecurityKey21 # BCFKSFile22 # BCFKSBlob23 # PKCS1199 # Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [signer_cert_store_type](#signer_cert_store_type-property), the full path of the PKCS#11 DLL as the [signer_cert_store](#signer_cert_store-property), and the PIN as the [signer_cert_store_password](#signer_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [signer_cert_store](#signer_cert_store-property) and set [signer_cert_store_password](#signer_cert_store_password-property) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | # signer_cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_signer_cert_subject() -> str: ... def set_signer_cert_subject(value: str) -> None: ... signer_cert_subject = property(get_signer_cert_subject, set_signer_cert_subject) ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. # signer_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_signer_cert_subject_alt_names() -> str: ... signer_cert_subject_alt_names = property(get_signer_cert_subject_alt_names, None) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. # signer_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_signer_cert_thumbprint_md5() -> str: ... signer_cert_thumbprint_md5 = property(get_signer_cert_thumbprint_md5, None) ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # signer_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_signer_cert_thumbprint_sha1() -> str: ... signer_cert_thumbprint_sha1 = property(get_signer_cert_thumbprint_sha1, None) ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # signer_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_signer_cert_thumbprint_sha256() -> str: ... signer_cert_thumbprint_sha256 = property(get_signer_cert_thumbprint_sha256, None) ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # signer_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_signer_cert_usage() -> str: ... signer_cert_usage = property(get_signer_cert_usage, None) ``` ## Default Value "" ## Remarks The text description of [signer_cert_usage_flags](#signer_cert_usage_flags-property). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. # signer_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_signer_cert_usage_flags() -> int: ... signer_cert_usage_flags = property(get_signer_cert_usage_flags, None) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [signer_cert_usage_flags](#signer_cert_usage_flags-property) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [signer_cert_usage](#signer_cert_usage-property) property for a text representation of [signer_cert_usage_flags](#signer_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. This property is read-only. # signer_cert_version property The certificate's version number. ## Syntax ```text def get_signer_cert_version() -> str: ... signer_cert_version = property(get_signer_cert_version, None) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. # signer_key_exponent property Represents the Exponent parameter for the RSA algorithm. ## Syntax ```text def get_signer_key_exponent() -> bytes: ... def set_signer_key_exponent(value: bytes) -> None: ... signer_key_exponent = property(get_signer_key_exponent, set_signer_key_exponent) ``` ## Default Value "" ## Remarks Represents the Exponent parameter for the RSA algorithm. # signer_key_modulus property Represents the Modulus parameter for the RSA algorithm. ## Syntax ```text def get_signer_key_modulus() -> bytes: ... def set_signer_key_modulus(value: bytes) -> None: ... signer_key_modulus = property(get_signer_key_modulus, set_signer_key_modulus) ``` ## Default Value "" ## Remarks Represents the Modulus parameter for the RSA algorithm. # signer_key_public_key property This property is a PEM formatted public key. ## Syntax ```text def get_signer_key_public_key() -> str: ... def set_signer_key_public_key(value: str) -> None: ... signer_key_public_key = property(get_signer_key_public_key, set_signer_key_public_key) ``` ## Default Value "" ## Remarks This property is a PEM formatted public key. The purpose of this property is to allow easier management of the public key parameters by using only a single value. # use_hex property Whether input or output is hex encoded. ## Syntax ```text def get_use_hex() -> bool: ... def set_use_hex(value: bool) -> None: ... use_hex = property(get_use_hex, set_use_hex) ``` ## Default Value FALSE ## Remarks This property specifies whether the encrypted data, [hash_value](#hash_value-property), and [hash_signature](#hash_signature-property) are hex encoded. If set to True, when [encrypt](#encrypt-method) is called the class will perform the encryption as normal and then hex encode the output. [output_message](#output_message-property) or [output_file](#output_file-property) will hold hex encoded data. If set to True, when [decrypt](#decrypt-method) is called the class will expect [input_message](#input_message-property) or [input_file](#input_file-property) to hold hex encoded data. The class will then hex decode the data and perform decryption as normal. If set to True, when [sign](#sign-method) is called the class will compute the hash for the specified file and populate [hash_value](#hash_value-property) with the hex encoded hash value. It will then create the hash signature and populate [hash_signature](#hash_signature-property) with the hex encoded hash signature value. If [hash_value](#hash_value-property) is specified directly, it must be a hex encoded value. If set to True, when [verify_signature](#verify_signature-method) is called the class will compute the hash value for the specified file and populate [hash_value](#hash_value-property) with the hex encoded hash value. It will then hex decode [hash_signature](#hash_signature-property) and verify the signature. [hash_signature](#hash_signature-property) must hold a hex encoded value. If [hash_value](#hash_value-property) is specified directly, it must be a hex encoded value. # use_oaep property Whether to use Optimal Asymmetric Encryption Padding (OAEP). ## Syntax ```text def get_use_oaep() -> bool: ... def set_use_oaep(value: bool) -> None: ... use_oaep = property(get_use_oaep, set_use_oaep) ``` ## Default Value FALSE ## Remarks Whether to use Optimal Asymmetric Encryption Padding (OAEP). By default this value is False and the class will use PKCS1. Note: When set to True the [hash_algorithm](#hash_algorithm-property) is also applicable when calling [encrypt](#encrypt-method) and [decrypt](#decrypt-method). # use_pss property Whether to use RSA-PSS during signing and verification. ## Syntax ```text def get_use_pss() -> bool: ... def set_use_pss(value: bool) -> None: ... use_pss = property(get_use_pss, set_use_pss) ``` ## Default Value FALSE ## Remarks This property specifies whether RSA-PSS will be used when signing and verifying messages. The default value is False. # 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](#rsa-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](#rsa-config-settings), you must call *Config("PROPERTY")*. The value will be returned as a string. # create_key method Creates a new key. ## Syntax ```text def create_key() -> None: ... ``` ## Remarks This method creates a new public and private key. When calling create_key the key property is populated with a new private and public key. **RSA Keys** A RSA key is made up of a number of individual parameters. The public key consists of the following parameters: - [key_modulus](#key_modulus-property) - [key_exponent](#key_exponent-property) The class also includes the [key_public_key](#key_public_key-property) property which holds the PEM formatted public key for ease of use. This is helpful if you are in control of both sides of the encryption/signing and decryption/signature verification process. When sending the public key to a recipient note that not all implementations will support using the PEM formatted value in [key_public_key](#key_public_key-property) in which case the individual parameters must be sent. The private key may be represented in one of two ways. Both are mathematically equivalent. Private key format 1: - [key_modulus](#key_modulus-property) - [key_p](#key_p-property) - [key_q](#key_q-property) - [key_dp](#key_dp-property) - [key_dq](#key_dq-property) Private key format 2 is simpler but has decreased performance when decrypting and signing. This format is: - [key_modulus](#key_modulus-property) - [key_d](#key_d-property) The class also include the [key_private_key](#key_private_key-property) property which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily. # decrypt method Decrypts the input data using the specified private key. ## Syntax ```text def decrypt() -> None: ... ``` ## Remarks This method decrypts the input data using the private key specified in key. Alternatively, a certificate may be specified by setting certificate. **Input and Output Properties** The class will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [input_file](#input_file-property) - [input_message](#input_message-property) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [output_file](#output_file-property) - [output_message](#output_message-property): The output data is written to this property if no other destination is specified. **Key Size and the Maximum Length of Data** RSA has an upper limit to the amount of data that can be encrypted or decrypted, also known as message length. This can typically be calculated as the size of the key minus the size of the RSA header and padding. When not using OAEP, the following formula and table can be referenced. (RSA Key Bytes) - (Header Bytes) = Length of data, where Header Bytes is always 11. | RSA Key Length (bits) | Length (bits) | Length (bytes) | | --- | --- | --- | | 1024 | 936 | 117 | | 2048 | 1960 | 245 | | 3072 | 2984 | 373 | | 4096 | 4008 | 501 | When using OAEP, the following formula and table can be referenced. (RSA Key Bytes) - (2 * Hash Length Bytes) - 2 = Length of data. The table below assumes SHA-256 for the hash, so Hash Length Bytes is 32. | RSA Key Length (bits) | Length (bits) | Length (bytes) | | --- | --- | --- | | 1024 | 496 | 62 | | 2048 | 1520 | 190 | | 3072 | 2544 | 318 | | 4096 | 3568 | 446 | # encrypt method Encrypts the input data using the recipient's public key. ## Syntax ```text def encrypt() -> None: ... ``` ## Remarks This method encrypts the input data using the public key specified in recipient_key. Alternatively, a certificate may be specified by setting recipient_cert. **Input and Output Properties** The class will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [input_file](#input_file-property) - [input_message](#input_message-property) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [output_file](#output_file-property) - [output_message](#output_message-property): The output data is written to this property if no other destination is specified. **Key Size and the Maximum Length of Data** RSA has an upper limit to the amount of data that can be encrypted or decrypted, also known as message length. This can typically be calculated as the size of the key minus the size of the RSA header and padding. When not using OAEP, the following formula and table can be referenced. (RSA Key Bytes) - (Header Bytes) = Length of data, where Header Bytes is always 11. | RSA Key Length (bits) | Length (bits) | Length (bytes) | | --- | --- | --- | | 1024 | 936 | 117 | | 2048 | 1960 | 245 | | 3072 | 2984 | 373 | | 4096 | 4008 | 501 | When using OAEP, the following formula and table can be referenced. (RSA Key Bytes) - (2 * Hash Length Bytes) - 2 = Length of data. The table below assumes SHA-256 for the hash, so Hash Length Bytes is 32. | RSA Key Length (bits) | Length (bits) | Length (bytes) | | --- | --- | --- | | 1024 | 496 | 62 | | 2048 | 1520 | 190 | | 3072 | 2544 | 318 | | 4096 | 3568 | 446 | # reset method Resets the class. ## Syntax ```text def reset() -> None: ... ``` ## Remarks When called, the class will reset all of its properties to their default values. # sign method Creates a hash signature. ## Syntax ```text def sign() -> None: ... ``` ## Remarks This method will create a hash signature. Before calling this method specify the input file by setting [input_file](#input_file-property) or [input_message](#input_message-property). A key is required to create the hash signature. You may create a new key by calling [create_key](#create_key-method), or specify an existing key pair in key. Alternatively, a certificate may be specified by setting certificate. When this method is called the class will compute the hash for the specified file and populate [hash_value](#hash_value-property). It will then create the hash signature using the specified key and populate [hash_signature](#hash_signature-property). To create the hash signature without first computing the hash simply specify [hash_value](#hash_value-property) before calling this method. The [on_progress](#on_progress-event) event will fire with updates for the hash computation progress only. The hash signature creation process is quick and does not require progress updates. # verify_signature method Verifies the signature for the specified data. ## Syntax ```text def verify_signature() -> bool: ... ``` ## Remarks This method will verify a hash signature. Before calling this method specify the input file by setting [input_file](#input_file-property) or [input_message](#input_message-property). A public key and the hash signature are required to perform the signature verification. Specify the public key in signer_key. Alternatively, a certificate may be specified by setting signer_cert. Specify the hash signature in [hash_signature](#hash_signature-property). When this method is called the class will compute the hash for the specified file and populate [hash_value](#hash_value-property). It will verify the signature using the specified signer_key and [hash_signature](#hash_signature-property). To verify the hash signature without first computing the hash simply specify [hash_value](#hash_value-property) before calling this method. The [on_progress](#on_progress-event) event will fire with updates for the hash computation progress only. The hash signature verification process is quick and does not require progress updates. # on_error event Fired when information is available about errors during data delivery. ## Syntax ```text class RSAErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class RSA: @property def on_error() -> Callable[[RSAErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[RSAErrorEventParams], None]) -> None: ... ``` ## Remarks The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error. The *error_code* parameter contains an error code, and the *description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#rsa-errors) section. # on_progress event Fired as progress is made. ## Syntax ```text class RSAProgressEventParams(object): @property def bytes_processed() -> int: ... @property def percent_processed() -> int: ... # In class RSA: @property def on_progress() -> Callable[[RSAProgressEventParams], None]: ... @on_progress.setter def on_progress(event_hook: Callable[[RSAProgressEventParams], None]) -> None: ... ``` ## Remarks This event is fired automatically as data is processed by the class. The *PercentProcessed* parameter indicates the current status of the operation. The *BytesProcessed* parameter holds the total number of bytes processed so far. # RSA 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. ### RSA Config Settings **KeyFormat**: How the public and private key are formatted.This setting controls the format of [key_public_key](#key_public_key-property) and [key_private_key](#key_private_key-property). By default these properties hold PEM formatted public and private key data. When set to 1 (XML) the keys are stored in a XML format. This only affects the values returned by the class; the actual keys remain the same regardless of this setting. Possible values are: - 0 (PEM - PKCS#1) - 1 (XML) - 2 (PEM - PKCS#8 - default) The default value is 2 (PEM - PKCS#8). **KeySize**: The size, in bits, of the secret key.This specifies the size, in bits, of the secret key. The minimum key size for RSA is 384. The maximum key size is 4096. Note that large values such as 4096 will impact performance. The default value is 1024. **OAEPMGF1HashAlgorithm**: The MGF1 hash algorithm used with OAEP.This configuration setting specifies the MGF1 hash algorithm used when [use_oaep](#use_oaep-property) is set to True. The default value is *SHA256*. Possible values are as follows: - "SHA1" - "SHA224" - "SHA256" (default) - "SHA384" - "SHA512" - "RIPEMD160" - "MD2" - "MD5" - "MD5SHA1" Note: The RSA hash algorithm used for OAEP is controlled via the [hash_algorithm](#hash_algorithm-property) property. **OAEPParams**: The hex encoded OAEP parameters.This configuration setting optionally specifies Optimal Asymmetric Encryption Padding (OAEP) parameters to be used when [use_oaep](#use_oaep-property) is set to True. The value is an optional application-defined label and should be hex encoded. In most cases this does not need to be set; both sides must use the same value for encryption and decryption to succeed. **UsePrimitive**: Enables primitive RSA encryption with no padding scheme or output modification.Instructs the component to use primitive RSA encryption with no padding scheme and without stripping leading zeros from the output of [encrypt](#encrypt-method). The output size will match the modulus length, as defined by the original RSA specification. Overrides the [use_oaep](#use_oaep-property) property if specified. **Warning:** This configuration is not considered cryptographically secure on its own. Padding schemes play a critical role in the security of modern RSA implementations. Use only when necessary for compatibility, and note that the user assumes all responsibility when enabling this option. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *True* to mask sensitive data. The default is *True*. **ProcessIdleEvents**: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True. **SelectWaitMillis**: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20. **UseFIPSCompliantAPI**: Tells the class whether or not to use FIPS certified APIs.When set to *True*, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries. FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *True*. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior. For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article. NOTE: This setting is applicable only on Windows. NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *False*, the class will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *True* tells the class to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to *False* by default. On Linux/macOS, this setting is set to *True* by default. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section. # RSA Errors ### RSA Errors | | | | --- | --- | | 102 | No Key specified. | | 104 | Cannot read or write file. | | 105 | key parameters incorrect. | | 106 | Cannot create hash. | | 111 | OutputFile already exists and Overwrite is False. | | 113 | Input data or HashValue must be specified. | | 121 | Invalid certificate. | | 124 | HashSignature must be specified. | | 304 | Cannot write file. | | 305 | Cannot read file. | | 306 | Cannot create file. | | 1101 | Missing RSA parameter: Modulus | | 1102 | Invalid RSA parameter: Modulus cannot be zero. | | 1103 | Missing RSA parameters: Public or Private exponent must be present. | | 1104 | Invalid RSA parameter: Exponent cannot be zero. | | 1105 | Invalid RSA parameter: D cannot be zero. | | 1106 | Invalid hash algorithm. | | 1107 | Missing hash value. | | 1108 | HashSignature must be specified. | | 1109 | Invalid hash size. | | 1110 | Public key must be specified. | | 1111 | Key must be specified. | | 1112 | RSA key too short to sign message. | | 1113 | Missing the data to encrypt/decrypt. | | 1114 | Invalid cipher length. The data may not have been encrypted with the public key corresponding to the specified private key data. | | 1115 | Invalid cipher text. The data may not have been encrypted with the public key corresponding to the specified private key data. | | 1116 | Inadequate padding. The data may not have been encrypted with the public key corresponding to the specified private key data. | | 1117 | Missing delimiter. The data may not have been encrypted with the public key corresponding to the specified private key data. | | 1118 | Message too long. |