# PPOP Class The PPOP class is used retrieve and process OpenPGP encrypted and/or signed messages from Internet Post Office servers (POP). ## Syntax ```text class ipworkspgp.PPOP ``` ## Remarks The PPOP class implements a standard internet post office (POP3) client, as specified in RFC 1725, and supports decrypting and verifying signatures of encrypted and signed emails using OpenPGP. You can send an OpenPGP signed and encrypted message using the PSMTP class by calling the encrypt, sign, and sign_and_encrypt methods. **Connect to the Server** To connect to a [mail_server](#mail_server-property), first set the appropriate [user](#user-property) and [password](#password-property) and then connect by calling the [connect](#connect-method) method. Upon successful connection to the [mail_server](#mail_server-property), the number of waiting messages is shown by the [message_count](#message_count-property) property. A message is selected by setting the [message_number](#message_number-property) property to a number between 1 and [message_count](#message_count-property) (inclusive). Then, the message text and/or headers are received by calling the [retrieve](#retrieve-method) method. **Receive Messages** The message text is received through the [on_transfer](#on_transfer-event) event, whereas the message headers are received through the [on_header](#on_header-event) event. Additionally, up to [max_lines](#max_lines-property) from the message body are provided in the [message_text](#message_text-property) property. The [on_start_transfer](#on_start_transfer-event) and [on_end_transfer](#on_end_transfer-event) events are fired at the beginning and end of message transmission. The [on_pi_trail](#on_pi_trail-event) event provides a trace of the interaction between the client and server (excluding message transfers). **Verify** To verify the signature of a message specify the public key to be used for signature verification by setting the **SignerKey*** properties. For instance: ```text PPOP1.SignerKeyCount = 1 PPOP1.SignerKeyKeyring(0) = "c:\my_keyring_dir" PPOP1.SignerKeyUserId(0) = "sender@nsoftware.com" ``` The specified public key will be used to verify the signature when calling [verify_signature](#verify_signature-method). **Decrypt** To process an encrypted or signed message first retrieve the message text and headers by calling [retrieve](#retrieve-method). To decrypt a message specify the private key to be used for decryption by setting the **Key*** properties. For instance: ```text PPOP1.KeyCount = 1 PPOP1.KeyKeyring(0) = "c:\my_keyring_dir" PPOP1.KeyUserId(0) = "recipient@nsoftware.com" PPOP1.KeyPassphrase(0) = "password" ``` The specified private key will be used to decrypt the message when calling [decrypt](#decrypt-method). **Decrypt and Verify** To decrypt and verify in one step, you can call [decrypt_and_verify_signature](#decrypt_and_verify_signature-method). Set the public key of the sender in the and the private key to be used for decryption in the **Key*** properties . ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [auth_mechanism](#auth_mechanism-property) | This property includes the authentication mechanism to be used when connecting to the mail server. | | [connected](#connected-property) | Whether the class is connected. | | [firewall_auto_detect](#firewall_auto_detect-property) | Whether to automatically detect and use firewall system settings, if available. | | [firewall_host](#firewall_host-property) | The name or IP address of the firewall (optional). | | [firewall_password](#firewall_password-property) | A password if authentication is to be used when connecting through the firewall. | | [firewall_port](#firewall_port-property) | The Transmission Control Protocol (TCP) port for the firewall Host . | | [firewall_type](#firewall_type-property) | The type of firewall to connect through. | | [firewall_user](#firewall_user-property) | A username if authentication is to be used when connecting through a firewall. | | [idle](#idle-property) | The current status of the class. | | [include_headers](#include_headers-property) | This property instructs the class to include the headers in the MessageText and LocalFile. | | [key_count](#key_count-property) | The number of records in the Key arrays. | | [key_curve](#key_curve-property) | This property specifies the elliptic curve if PublicKeyAlgorithm is ECDSA , EdDSA , Ed25519 , Ed448 , ML-DSA-65+Ed25519 , or ML-DSA-87+Ed448 . | | [key_effective_date](#key_effective_date-property) | The date when this key becomes valid. | | [key_encoded](#key_encoded-property) | The key. | | [key_expiration_date](#key_expiration_date-property) | The date the key expires. | | [key_fingerprint](#key_fingerprint-property) | The hex-encoded, 20-byte fingerprint of the key. | | [key_id](#key_id-property) | The hex-encoded, 4-byte or 8-byte key Id. | | [keyring](#keyring-property) | The location of the keyring. | | [key_other_user_ids](#key_other_user_ids-property) | If the specified key has alternate user Ids associated with it, this property returns a comma-separated list of the other user Ids. | | [key_passphrase](#key_passphrase-property) | The passphrase for the key's secret key (if any). | | [key_public_key](#key_public_key-property) | The public key of the key. | | [key_public_key_algorithm](#key_public_key_algorithm-property) | A text description of the public key algorithm of the key. | | [key_public_key_length](#key_public_key_length-property) | The length of the public key in bits. | | [key_revoked](#key_revoked-property) | Whether or not the key is revoked. | | [key_secret_key](#key_secret_key-property) | The secret key of the key (if available). | | [key_secret_key_available](#key_secret_key_available-property) | Whether or not a secret key is available for the selected key. | | [key_usage](#key_usage-property) | A text description of UsageFlags . | | [key_usage_flags](#key_usage_flags-property) | Flags that show the intended use for the key. | | [key_user_id](#key_user_id-property) | The user Id of the key. | | [key_version](#key_version-property) | This property can be used to query the OpenPGP version of the currently selected Key . | | [last_reply](#last_reply-property) | This property indicates the last reply received from the server. | | [local_host](#local_host-property) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [mail_port](#mail_port-property) | This property includes the server port for POP (default 110). | | [mail_server](#mail_server-property) | This property includes the name or address of a mail server (internet post office server). | | [max_lines](#max_lines-property) | This property includes the maximum number of message lines other than headers to retrieve. | | [message](#message-property) | This property provides the raw message content. | | [message_cc](#message_cc-property) | This property includes the value of the CC header of the last retrieved message. | | [message_count](#message_count-property) | This property includes the number of messages in the mailbox. | | [message_date](#message_date-property) | This property includes the value of the date header of the last retrieved message. | | [message_from](#message_from-property) | This property includes the value of the from header of the last retrieved message. | | [message_header_count](#message_header_count-property) | The number of records in the MessageHeader arrays. | | [message_header_field](#message_header_field-property) | This property contains the name of the HTTP header (this is the same case as it is delivered). | | [message_header_value](#message_header_value-property) | This property contains the header contents. | | [message_headers_string](#message_headers_string-property) | This property includes a string representation of the full headers of the message as retrieved from the server. | | [message_number](#message_number-property) | This property includes the current (selected) message. | | [message_recipient_count](#message_recipient_count-property) | The number of records in the MessageRecipient arrays. | | [message_recipient_address](#message_recipient_address-property) | This property contains the email address of the recipient. | | [message_recipient_name](#message_recipient_name-property) | This property contains the name of the recipient. | | [message_recipient_options](#message_recipient_options-property) | This property contains the recipient sending options (used only by SMTP). | | [message_recipient_type](#message_recipient_type-property) | This property contains the recipient type: To, Cc, or Bcc. | | [message_reply_to](#message_reply_to-property) | This property includes the value of the Reply-To header of the last retrieved message. | | [message_subject](#message_subject-property) | This property includes the value of the Subject header of the last retrieved message. | | [message_text](#message_text-property) | This property includes the full text of the message as retrieved from the server. | | [message_to](#message_to-property) | This property includes the value of the To header of the last retrieved message. | | [o_auth_access_token](#o_auth_access_token-property) | The access token returned by the authorization server. | | [o_auth_authorization_scope](#o_auth_authorization_scope-property) | The scope request or response parameter used during authorization. | | [o_auth_client_id](#o_auth_client_id-property) | The id of the client assigned when registering the application. | | [o_auth_client_secret](#o_auth_client_secret-property) | The secret value for the client assigned when registering the application. | | [o_auth_refresh_token](#o_auth_refresh_token-property) | Specifies the refresh token received from or sent to the authorization server. | | [o_auth_return_url](#o_auth_return_url-property) | The URL where the user (browser) returns after authenticating. | | [o_auth_server_auth_url](#o_auth_server_auth_url-property) | The URL of the authorization server. | | [o_auth_server_token_url](#o_auth_server_token_url-property) | The URL of the token server used to obtain the access token. | | [password](#password-property) | This property includes the password for the mailbox user. | | [signer_key_count](#signer_key_count-property) | The number of records in the SignerKey arrays. | | [signer_key_curve](#signer_key_curve-property) | This property specifies the elliptic curve if PublicKeyAlgorithm is ECDSA , EdDSA , Ed25519 , Ed448 , ML-DSA-65+Ed25519 , or ML-DSA-87+Ed448 . | | [signer_key_effective_date](#signer_key_effective_date-property) | The date when this key becomes valid. | | [signer_key_encoded](#signer_key_encoded-property) | The key. | | [signer_key_expiration_date](#signer_key_expiration_date-property) | The date the key expires. | | [signer_key_fingerprint](#signer_key_fingerprint-property) | The hex-encoded, 20-byte fingerprint of the key. | | [signer_key_id](#signer_key_id-property) | The hex-encoded, 4-byte or 8-byte key Id. | | [signer_key_keyring](#signer_key_keyring-property) | The location of the keyring. | | [signer_key_other_user_ids](#signer_key_other_user_ids-property) | If the specified key has alternate user Ids associated with it, this property returns a comma-separated list of the other user Ids. | | [signer_key_passphrase](#signer_key_passphrase-property) | The passphrase for the key's secret key (if any). | | [signer_key_public_key](#signer_key_public_key-property) | The public key of the key. | | [signer_key_public_key_algorithm](#signer_key_public_key_algorithm-property) | A text description of the public key algorithm of the key. | | [signer_key_public_key_length](#signer_key_public_key_length-property) | The length of the public key in bits. | | [signer_key_revoked](#signer_key_revoked-property) | Whether or not the key is revoked. | | [signer_key_secret_key](#signer_key_secret_key-property) | The secret key of the key (if available). | | [signer_key_secret_key_available](#signer_key_secret_key_available-property) | Whether or not a secret key is available for the selected key. | | [signer_key_usage](#signer_key_usage-property) | A text description of UsageFlags . | | [signer_key_usage_flags](#signer_key_usage_flags-property) | Flags that show the intended use for the key. | | [signer_key_user_id](#signer_key_user_id-property) | The user Id of the key. | | [signer_key_version](#signer_key_version-property) | This property can be used to query the OpenPGP version of the currently selected Key . | | [ssl_accept_server_cert_effective_date](#ssl_accept_server_cert_effective_date-property) | The date on which this certificate becomes valid. | | [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [ssl_accept_server_cert_expiration_date](#ssl_accept_server_cert_expiration_date-property) | The date on which the certificate expires. | | [ssl_accept_server_cert_extended_key_usage](#ssl_accept_server_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [ssl_accept_server_cert_fingerprint](#ssl_accept_server_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssl_accept_server_cert_fingerprint_sha1](#ssl_accept_server_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssl_accept_server_cert_fingerprint_sha256](#ssl_accept_server_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssl_accept_server_cert_issuer](#ssl_accept_server_cert_issuer-property) | The issuer of the certificate. | | [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) | The private key of the certificate (if available). | | [ssl_accept_server_cert_private_key_available](#ssl_accept_server_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [ssl_accept_server_cert_private_key_container](#ssl_accept_server_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [ssl_accept_server_cert_public_key](#ssl_accept_server_cert_public_key-property) | The public key of the certificate. | | [ssl_accept_server_cert_public_key_algorithm](#ssl_accept_server_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [ssl_accept_server_cert_public_key_length](#ssl_accept_server_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [ssl_accept_server_cert_serial_number](#ssl_accept_server_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [ssl_accept_server_cert_signature_algorithm](#ssl_accept_server_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) | The name of the certificate store for the client certificate. | | [ssl_accept_server_cert_store_password](#ssl_accept_server_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. | | [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property) | The type of certificate store for this certificate. | | [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) | The subject of the certificate used for client authentication. | | [ssl_accept_server_cert_subject_alt_names](#ssl_accept_server_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [ssl_accept_server_cert_thumbprint_md5](#ssl_accept_server_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [ssl_accept_server_cert_thumbprint_sha1](#ssl_accept_server_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [ssl_accept_server_cert_thumbprint_sha256](#ssl_accept_server_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [ssl_accept_server_cert_usage](#ssl_accept_server_cert_usage-property) | The text description of UsageFlags . | | [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [ssl_accept_server_cert_version](#ssl_accept_server_cert_version-property) | The certificate's version number. | | [ssl_cert_effective_date](#ssl_cert_effective_date-property) | The date on which this certificate becomes valid. | | [ssl_cert_encoded](#ssl_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [ssl_cert_expiration_date](#ssl_cert_expiration_date-property) | The date on which the certificate expires. | | [ssl_cert_extended_key_usage](#ssl_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [ssl_cert_fingerprint](#ssl_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssl_cert_fingerprint_sha1](#ssl_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssl_cert_fingerprint_sha256](#ssl_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssl_cert_issuer](#ssl_cert_issuer-property) | The issuer of the certificate. | | [ssl_cert_private_key](#ssl_cert_private_key-property) | The private key of the certificate (if available). | | [ssl_cert_private_key_available](#ssl_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [ssl_cert_private_key_container](#ssl_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [ssl_cert_public_key](#ssl_cert_public_key-property) | The public key of the certificate. | | [ssl_cert_public_key_algorithm](#ssl_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [ssl_cert_public_key_length](#ssl_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [ssl_cert_serial_number](#ssl_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [ssl_cert_signature_algorithm](#ssl_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [ssl_cert_store](#ssl_cert_store-property) | The name of the certificate store for the client certificate. | | [ssl_cert_store_password](#ssl_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. | | [ssl_cert_store_type](#ssl_cert_store_type-property) | The type of certificate store for this certificate. | | [ssl_cert_subject](#ssl_cert_subject-property) | The subject of the certificate used for client authentication. | | [ssl_cert_subject_alt_names](#ssl_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [ssl_cert_thumbprint_md5](#ssl_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [ssl_cert_thumbprint_sha1](#ssl_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [ssl_cert_thumbprint_sha256](#ssl_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [ssl_cert_usage](#ssl_cert_usage-property) | The text description of UsageFlags . | | [ssl_cert_usage_flags](#ssl_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [ssl_cert_version](#ssl_cert_version-property) | The certificate's version number. | | [ssl_enabled](#ssl_enabled-property) | This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. | | [ssl_provider](#ssl_provider-property) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. | | [ssl_server_cert_effective_date](#ssl_server_cert_effective_date-property) | The date on which this certificate becomes valid. | | [ssl_server_cert_encoded](#ssl_server_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [ssl_server_cert_expiration_date](#ssl_server_cert_expiration_date-property) | The date on which the certificate expires. | | [ssl_server_cert_extended_key_usage](#ssl_server_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [ssl_server_cert_fingerprint](#ssl_server_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssl_server_cert_fingerprint_sha1](#ssl_server_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssl_server_cert_fingerprint_sha256](#ssl_server_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssl_server_cert_issuer](#ssl_server_cert_issuer-property) | The issuer of the certificate. | | [ssl_server_cert_private_key](#ssl_server_cert_private_key-property) | The private key of the certificate (if available). | | [ssl_server_cert_private_key_available](#ssl_server_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [ssl_server_cert_private_key_container](#ssl_server_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [ssl_server_cert_public_key](#ssl_server_cert_public_key-property) | The public key of the certificate. | | [ssl_server_cert_public_key_algorithm](#ssl_server_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [ssl_server_cert_public_key_length](#ssl_server_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [ssl_server_cert_serial_number](#ssl_server_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [ssl_server_cert_signature_algorithm](#ssl_server_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [ssl_server_cert_store](#ssl_server_cert_store-property) | The name of the certificate store for the client certificate. | | [ssl_server_cert_store_password](#ssl_server_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. | | [ssl_server_cert_store_type](#ssl_server_cert_store_type-property) | The type of certificate store for this certificate. | | [ssl_server_cert_subject](#ssl_server_cert_subject-property) | The subject of the certificate used for client authentication. | | [ssl_server_cert_subject_alt_names](#ssl_server_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [ssl_server_cert_thumbprint_md5](#ssl_server_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [ssl_server_cert_thumbprint_sha1](#ssl_server_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [ssl_server_cert_thumbprint_sha256](#ssl_server_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [ssl_server_cert_usage](#ssl_server_cert_usage-property) | The text description of UsageFlags . | | [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [ssl_server_cert_version](#ssl_server_cert_version-property) | The certificate's version number. | | [ssl_start_mode](#ssl_start_mode-property) | This property determines how the class starts the Secure Sockets Layer (SSL) negotiation. | | [timeout](#timeout-property) | The timeout for the class. | | [user](#user-property) | This property includes the user identifier for the mailbox. | ## 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. | | [connect](#connect-method) | This method connects to the mail server and attempts to log in. | | [decrypt](#decrypt-method) | Decrypts the message. | | [decrypt_and_verify_signature](#decrypt_and_verify_signature-method) | Decrypts and verifies the signature of the message. | | [delete](#delete-method) | This method deletes a message specified by MessageNumber on the server. | | [disconnect](#disconnect-method) | This method disconnects from the mail server. | | [do_events](#do_events-method) | This method processes events from the internal message queue. | | [interrupt](#interrupt-method) | This method interrupts the current method. | | [list_message_sizes](#list_message_sizes-method) | This method retrieves a list of all message sizes from the server. | | [list_message_ui_ds](#list_message_ui_ds-method) | This method retrieves a list of all message UIDs from the server. | | [localize_date](#localize_date-method) | This method converts a valid RFC 822 message date to a local date and time. | | [query_message_size](#query_message_size-method) | This method returns the size in bytes of the current message. | | [query_message_uid](#query_message_uid-method) | This method returns the unique identifier (UID) of the message as specified by the server. | | [query_total_size](#query_total_size-method) | This method returns the cumulative size in bytes of messages in the mailbox (including headers). | | [reset](#reset-method) | This method will reset the class. | | [retrieve](#retrieve-method) | This method retrieves a message specified by MessageNumber from the server. | | [retrieve_headers](#retrieve_headers-method) | This method retrieves headers for a message specified by MessageNumber . | | [send_command](#send_command-method) | This method sends the exact command directly to the server. | | [verify_signature](#verify_signature-method) | Verifies the signature of the current message. | ## 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_connection_status](#on_connection_status-event) | Fired to indicate changes in the connection state. | | [on_end_transfer](#on_end_transfer-event) | This event is fired when the message completes transferring. | | [on_error](#on_error-event) | Fired when information is available about errors during data delivery. | | [on_header](#on_header-event) | This event is fired for every message header being retrieved. | | [on_key_passphrase](#on_key_passphrase-event) | Fired if the passphrase of current key is incorrect or empty. | | [on_launch_browser](#on_launch_browser-event) | Fires before launching a browser with the authorization URL. | | [on_log](#on_log-event) | Fired once for each log message. | | [on_message_list](#on_message_list-event) | This event is fired for every message listed by ListMessageSizes and/or ListMessageUIDs . | | [on_pi_trail](#on_pi_trail-event) | This event traces the commands sent to the mail server, and the respective replies. | | [on_progress](#on_progress-event) | Fired as progress is made. | | [on_recipient_info](#on_recipient_info-event) | Fired for each recipient key of the encrypted message. | | [on_signature_info](#on_signature_info-event) | Fired during verification of the signed message. | | [on_ssl_server_authentication](#on_ssl_server_authentication-event) | Fired after the server presents its certificate to the client. | | [on_ssl_status](#on_ssl_status-event) | Fired when secure connection progress messages are available. | | [on_start_transfer](#on_start_transfer-event) | This event is fired when the message starts transferring. | | [on_status](#on_status-event) | Shows the progress of the operation. | | [on_transfer](#on_transfer-event) | This event is fired when the message is transferred from MailServer . | | [on_verification_status](#on_verification_status-event) | Fired after verification of the signed message. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Comment](#Comment) | The OpenPGP message comment. | | [LogLevel](#LogLevel) | Specifies the level of detail that is logged. | | [ProcessAttachments](#ProcessAttachments) | Whether or not to process attachments. | | [RequireValidSignature](#RequireValidSignature) | Specifies if an invalid signature is considered an error condition. | | [SymmetricPassphrase](#SymmetricPassphrase) | The password used for symmetric encryption or decryption. | | [VerifyClearTextSignatureWithCache](#VerifyClearTextSignatureWithCache) | Whether the cleartext message is cached in memory when verifying a cleartext signature. | | [VersionHeader](#VersionHeader) | The Version header value in the ASCII armored OpenPGP message. | | [AuthorizationIdentity](#AuthorizationIdentity) | The value to use as the authorization identity when SASL authentication is used. | | [AutoDecodeSubject](#AutoDecodeSubject) | Instructs the class to automatically decode message subjects. | | [GetMessageSize](#GetMessageSize) | Whether to poll the server for the message size prior to retrieving it. | | [MaxLineLength](#MaxLineLength) | The maximum expected length for message lines. | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the class whether or not to automatically detect and use firewall system settings, if available. | | [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). | | [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. | | [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. | | [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. | | [FirewallType](#FirewallType) | Determines the type of firewall to connect through. | | [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [Linger](#Linger) | When set to True, connections are terminated gracefully. | | [LingerTime](#LingerTime) | Time in seconds to have the connection linger. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the class binds. | | [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. | | [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. | | [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. | | [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. | | [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. | | [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. | | [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLCACertFilePaths](#SSLCACertFilePaths) | The paths to CA certificate files on Unix/Linux. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. | | [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. | | [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. | | [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [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. | # auth_mechanism property This property includes the authentication mechanism to be used when connecting to the mail server. ## Syntax ```text def get_auth_mechanism() -> int: ... def set_auth_mechanism(value: int) -> None: ... auth_mechanism = property(get_auth_mechanism, set_auth_mechanism) ``` ## Possible Values ```text 0 # UserPassword1 # CRAMMD52 # NTLM3 # APOP4 # SASLPlain5 # SASLDigestMD56 # Kerberos7 # XOAUTH2 ``` ## Default Value 0 ## Remarks This property is used as the authentication mechanism when connecting to the mail server. By default, this property is amUserPassword (0), and default plaintext authentication is used to log in to the server. Other, more secure, options include amCRAMMD5 (1) for CRAM-MD5, amNTLM (2) for NTLM authentication, amAPOP (3) for APOP authentication, and amSASLDigestMD5 (5) for SASL DIGEST-MD5 authentication. amSASLPlain (4) is also available, but most servers require a Secure Sockets Layer (SSL) connection when utilizing this authentication mechanism. amKerberos (6) is for Kerberos authentication. NOTE: This functionality is available only in Windows. # connected property Whether the class is connected. ## Syntax ```text def get_connected() -> bool: ... connected = property(get_connected, None) ``` ## Default Value FALSE ## Remarks This property is used to determine whether or not the class is connected to the remote host. Use the [connect](#connect-method) and [disconnect](#disconnect-method) methods to manage the connection. This property is read-only. # firewall_auto_detect property Whether to automatically detect and use firewall system settings, if available. ## Syntax ```text def get_firewall_auto_detect() -> bool: ... def set_firewall_auto_detect(value: bool) -> None: ... firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect) ``` ## Default Value FALSE ## Remarks Whether to automatically detect and use firewall system settings, if available. # firewall_host property The name or IP address of the firewall (optional). ## Syntax ```text def get_firewall_host() -> str: ... def set_firewall_host(value: str) -> None: ... firewall_host = property(get_firewall_host, set_firewall_host) ``` ## Default Value "" ## Remarks The name or IP address of the firewall (optional). If a [firewall_host](#firewall_host-property) is given, the requested connections will be authenticated through the specified firewall when connecting. If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error. # firewall_password property A password if authentication is to be used when connecting through the firewall. ## Syntax ```text def get_firewall_password() -> str: ... def set_firewall_password(value: str) -> None: ... firewall_password = property(get_firewall_password, set_firewall_password) ``` ## Default Value "" ## Remarks A password if authentication is to be used when connecting through the firewall. If [firewall_host](#firewall_host-property) is specified, the [firewall_user](#firewall_user-property) and [firewall_password](#firewall_password-property) properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error. # firewall_port property The Transmission Control Protocol (TCP) port for the firewall Host . ## Syntax ```text def get_firewall_port() -> int: ... def set_firewall_port(value: int) -> None: ... firewall_port = property(get_firewall_port, set_firewall_port) ``` ## Default Value 0 ## Remarks The Transmission Control Protocol (TCP) port for the firewall [firewall_host](#firewall_host-property). See the description of the [firewall_host](#firewall_host-property) property for details. NOTE: This property is set automatically when [firewall_type](#PPOP_p_FirewallFirewallType) is set to a valid value. See the description of the [firewall_type](#PPOP_p_FirewallFirewallType) property for details. # firewall_type property The type of firewall to connect through. ## Syntax ```text def get_firewall_type() -> int: ... def set_firewall_type(value: int) -> None: ... firewall_type = property(get_firewall_type, set_firewall_type) ``` ## Possible Values ```text 0 # None1 # Tunnel2 # SOCKS43 # SOCKS510 # SOCKS4A ``` ## Default Value 0 ## Remarks The type of firewall to connect through. The applicable values are as follows: | | | | --- | --- | | fwNone (0) | No firewall (default setting). | | fwTunnel (1) | Connect through a tunneling proxy. [firewall_port](#firewall_port-property) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [firewall_port](#firewall_port-property) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [firewall_port](#firewall_port-property) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [firewall_port](#firewall_port-property) is set to 1080. | # firewall_user property A username if authentication is to be used when connecting through a firewall. ## Syntax ```text def get_firewall_user() -> str: ... def set_firewall_user(value: str) -> None: ... firewall_user = property(get_firewall_user, set_firewall_user) ``` ## Default Value "" ## Remarks A username if authentication is to be used when connecting through a firewall. If [firewall_host](#firewall_host-property) is specified, this property and the [firewall_password](#firewall_password-property) property are used to connect and authenticate to the given [Firewall](#Type_Firewall). If the authentication fails, the class fails with an error. # idle property The current status of the class. ## Syntax ```text def get_idle() -> bool: ... idle = property(get_idle, None) ``` ## Default Value TRUE ## Remarks This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times. This property is read-only. # include_headers property This property instructs the class to include the headers in the MessageText and LocalFile. ## Syntax ```text def get_include_headers() -> bool: ... def set_include_headers(value: bool) -> None: ... include_headers = property(get_include_headers, set_include_headers) ``` ## Default Value FALSE ## Remarks This property instructs the component to include the headers in the MessageText and LocalFile. If set to True, the headers for the message being retrieved will be placed before the message body in the [message_text](#message_text-property) property;. If local_file is set, then the headers will be written to that file before the message body. In this manner, the whole content of a MIME-encoded message can be passed to the [MIME](MIME.md#MIME) class for further message processing. # key_count property The number of records in the Key arrays. ## Syntax ```text def get_key_count() -> int: ... def set_key_count(value: int) -> None: ... key_count = property(get_key_count, set_key_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [key_curve](#key_curve-property) - [key_effective_date](#key_effective_date-property) - [key_encoded](#key_encoded-property) - [key_expiration_date](#key_expiration_date-property) - [key_fingerprint](#key_fingerprint-property) - [key_id](#key_id-property) - [key_other_user_ids](#key_other_user_ids-property) - [key_passphrase](#key_passphrase-property) - [key_public_key](#key_public_key-property) - [key_public_key_algorithm](#key_public_key_algorithm-property) - [key_public_key_length](#key_public_key_length-property) - [key_revoked](#key_revoked-property) - [keyring](#keyring-property) - [key_secret_key](#key_secret_key-property) - [key_secret_key_available](#key_secret_key_available-property) - [key_usage](#key_usage-property) - [key_usage_flags](#key_usage_flags-property) - [key_user_id](#key_user_id-property) - [key_version](#key_version-property) The array indices start at *0* and end at *key_count - 1*. # key_curve property This property specifies the elliptic curve if PublicKeyAlgorithm is ECDSA , EdDSA , Ed25519 , Ed448 , ML-DSA-65+Ed25519 , or ML-DSA-87+Ed448 . ## Syntax ```text def get_key_curve(key_index: int) -> str: ... ``` ## Default Value "" ## Remarks This property specifies the elliptic curve if [key_public_key_algorithm](#key_public_key_algorithm-property) is *ECDSA*, *EdDSA*, *Ed25519*, *Ed448*, *ML-DSA-65+Ed25519*, or *ML-DSA-87+Ed448*. Possible values are: | Curve | Valid Public Key Algorithms | Description | | --- | --- | --- | | secp256r1 | ECDSA | NIST curve P-256 | | secp384r1 | ECDSA | NIST curve P-384 | | secp521r1 | ECDSA | NIST curve P-521 | | secp256k1 | ECDSA | Secp256k1 | | brainpoolP256r1 | ECDSA | Brainpool curve P-256r1 | | brainpoolP384r1 | ECDSA | Brainpool curve P-384r1 | | brainpoolP512r1 | ECDSA | Brainpool curve P-512r1 | | Ed25519 | EdDSA, Ed25519, ML-DSA-65+Ed25519 | Ed25519 | | Ed448 | Ed448, ML-DSA-87+Ed448 | Ed448 | The *key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [key_count](#key_count-property) property. This property is read-only. # key_effective_date property The date when this key becomes valid. ## Syntax ```text def get_key_effective_date(key_index: int) -> str: ... ``` ## Default Value "" ## Remarks The date when this key becomes valid. Prior to this it is not valid. The following is an example of a valid encoded date: 23-Jan-2000 15:00:00. The *key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [key_count](#key_count-property) property. This property is read-only. # key_encoded property The key. ## Syntax ```text def get_key_encoded(key_index: int) -> bytes: ... def set_key_encoded(key_index: int, value: bytes) -> None: ... ``` ## Default Value "" ## Remarks The key. This property can be used to assign a specific key. The [key_fingerprint](#key_fingerprint-property), [key_id](#key_id-property), and [key_user_id](#key_user_id-property) properties may also be used to specify a key. The *key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [key_count](#key_count-property) property. # key_expiration_date property The date the key expires. ## Syntax ```text def get_key_expiration_date(key_index: int) -> str: ... ``` ## Default Value "" ## Remarks The date the key expires. After this date the key will no longer be valid. The following is an example of a valid encoded date: 23-Jan-2001 15:00:00. The *key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [key_count](#key_count-property) property. This property is read-only. # key_fingerprint property The hex-encoded, 20-byte fingerprint of the key. ## Syntax ```text def get_key_fingerprint(key_index: int) -> str: ... def set_key_fingerprint(key_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte fingerprint of the key. When a key is loaded, this property is populated with the Fingerprint associated with the key. This property may be set to load a key from the [keyring](#PPOP_p_KeyKeyring). When this property is set the class will search the [keyring](#PPOP_p_KeyKeyring) for a key associated with the Fingerprint specified. This is in the form: ```text 5E70662EA810E768391A2FE8F7B7D49C89C9D7B1 ``` The *key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [key_count](#key_count-property) property. # key_id property The hex-encoded, 4-byte or 8-byte key Id. ## Syntax ```text def get_key_id(key_index: int) -> str: ... def set_key_id(key_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The hex-encoded, 4-byte or 8-byte key Id. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's *Fingerprint*. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's *Fingerprint* instead. For instance: ```text 5E70662EA810E768 ``` When a key is loaded, this property is populated with the Id associated with the key. This property may be set to load a key from the [keyring](#PPOP_p_KeyKeyring). When this property is set the class will search the [keyring](#PPOP_p_KeyKeyring) for a key associated with the Id specified. The KeyIdLength setting may be set to control the length of the returned key Id. NOTE: It is recommended to use the [key_fingerprint](#key_fingerprint-property) property when loading a key from the [keyring](#PPOP_p_KeyKeyring), as it is possible for different keys to have the same Id. The *key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [key_count](#key_count-property) property. # keyring property The location of the keyring. ## Syntax ```text def get_keyring(key_index: int) -> str: ... def set_keyring(key_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The location of the keyring. If the keyring is stored in a directory, set this property to the directory. The directory must contain the files "secring.gpg" and "pubring.gpg". A keyring may also be stored in a single file. If the keyring is a file this property should be set to the path of the file. When This property is set the class will read the keyring and populate the key property with the first key found in the keyring. Set [key_user_id](#KeyMgr_p_KeyUserId) to select a different key in the current keyring. The *key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [key_count](#key_count-property) property. # key_other_user_ids property If the specified key has alternate user Ids associated with it, this property returns a comma-separated list of the other user Ids. ## Syntax ```text def get_key_other_user_ids(key_index: int) -> str: ... ``` ## Default Value "" ## Remarks If the specified key has alternate user Ids associated with it, this property returns a comma-separated list of the other user Ids. The *key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [key_count](#key_count-property) property. This property is read-only. # key_passphrase property The passphrase for the key's secret key (if any). ## Syntax ```text def get_key_passphrase(key_index: int) -> str: ... def set_key_passphrase(key_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The passphrase for the key's secret key (if any). This must be specified before operations requiring the secret key are attempted. The passphrase may be supplied in this property or through the on_key_passphrase event, which will fire when a passphrase is required. The passphrase is required when using the following methods in KeyMgr: - add_user_id - sign_user_id - change_expiration_date - change_passphrase When using the OpenPGP class, or an email-based class, the following methods require a passphrase for the key: - decrypt - sign - sign_and_encrypt The *key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [key_count](#key_count-property) property. # key_public_key property The public key of the key. ## Syntax ```text def get_key_public_key(key_index: int) -> str: ... ``` ## Default Value "" ## Remarks The public key of the key. The key is provided as ASCII armored data. The *key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [key_count](#key_count-property) property. This property is read-only. # key_public_key_algorithm property A text description of the public key algorithm of the key. ## Syntax ```text def get_key_public_key_algorithm(key_index: int) -> str: ... ``` ## Default Value "" ## Remarks A text description of the public key algorithm of the key. Possible values are: - RSA - DSA - ECDSA - EdDSA - Ed25519 - Ed448 - ML-DSA-65+Ed25519 - ML-DSA-87+Ed448 - RSA-Legacy The *key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [key_count](#key_count-property) property. This property is read-only. # key_public_key_length property The length of the public key in bits. ## Syntax ```text def get_key_public_key_length(key_index: int) -> int: ... ``` ## Default Value 0 ## Remarks The length of the public key in bits. Common values are 1024, 2048, and 3072. If the [key_public_key_algorithm](#key_public_key_algorithm-property) property is *ECDSA*, *EdDSA*, *Ed25519*, *Ed448*, *ML-DSA-65+Ed25519*, or *ML-DSA-87+Ed448*, the length of the public key is determined by the [key_curve](#key_curve-property). Possible lengths are: | Curve | Public Key Length (bits) | | --- | --- | | secp256r1 | 256 | | secp384r1 | 384 | | secp521r1 | 528 | | secp256k1 | 256 | | Ed25519 | 256 | | Ed448 | 456 | The *key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [key_count](#key_count-property) property. This property is read-only. # key_revoked property Whether or not the key is revoked. ## Syntax ```text def get_key_revoked(key_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Whether or not the key is revoked. The *key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [key_count](#key_count-property) property. This property is read-only. # key_secret_key property The secret key of the key (if available). ## Syntax ```text def get_key_secret_key(key_index: int) -> str: ... ``` ## Default Value "" ## Remarks The secret key of the key (if available). The key is provided as ASCII armored data. The *key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [key_count](#key_count-property) property. This property is read-only. # key_secret_key_available property Whether or not a secret key is available for the selected key. ## Syntax ```text def get_key_secret_key_available(key_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Whether or not a secret key is available for the selected key. The *key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [key_count](#key_count-property) property. This property is read-only. # key_usage property A text description of UsageFlags . ## Syntax ```text def get_key_usage(key_index: int) -> str: ... ``` ## Default Value "" ## Remarks A text description of [key_usage_flags](#key_usage_flags-property). The value will be of one or more of the following strings, separated by commas: - Certifying Other Certificates - Signing Emails and Files - Encrypting Emails and Files - Split Key - Authenticate Against Servers - Group Key The *key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [key_count](#key_count-property) property. This property is read-only. # key_usage_flags property Flags that show the intended use for the key. ## Syntax ```text def get_key_usage_flags(key_index: int) -> int: ... ``` ## Default Value 47 ## Remarks Flags that show the intended use for the key. The default value is 0x0F. The value of [key_usage_flags](#key_usage_flags-property) is a combination of the following flags: | | | | --- | --- | | 0x01 | This key may be used to certify other keys. | | 0x02 | This key may be used to sign data. | | 0x0C | This key may be used to encrypt communications and encrypt storage. | | 0x10 | The private component of this key may have been split by a secret-sharing mechanism. | | 0x20 | This key may be used for authentication. | | 0x80 | The private component of this key may be in the possession of more than one person. | Please refer to the [key_usage](#key_usage-property) property for a text representation of [key_usage_flags](#key_usage_flags-property). The *key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [key_count](#key_count-property) property. This property is read-only. # key_user_id property The user Id of the key. ## Syntax ```text def get_key_user_id(key_index: int) -> str: ... def set_key_user_id(key_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The user Id of the key. When a key is loaded this property is populated with the user Id associated with the key. This property may be set to load a key from the [keyring](#PPOP_p_KeyKeyring). When this property is set the class will search the [keyring](#PPOP_p_KeyKeyring) for a key associated with the UserId specified. When loading a key with multiple user Ids, this property will be populated with the UserId that was most recently added to the key. To discover all of the UserIds associated with a key query this property and [key_other_user_ids](#KeyMgr_p_KeyOtherUserIds) after loading the key. The *UserId* format is: ```text FirstName LastName (Comment) ``` Not all values are required when selecting or generating a key, but at least FirstName or Email are required. Note that for OpenPGP v6, a key may be created with or without a *UserId*, as the field is optional. If a key was created without a *UserId*, the key's *Fingerprint* can be used as its identifier instead. When using this property to select a key you may also specify the key's Id, or any of its subkeys' Ids, instead of a user Id. The class will then search for a key with a matching Id. This is helpful in situations where you do not have the UserId but still need to load the key, such as within the OpenPGP class's on_recipient_info event. The *key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [key_count](#key_count-property) property. # key_version property This property can be used to query the OpenPGP version of the currently selected Key . ## Syntax ```text def get_key_version(key_index: int) -> int: ... ``` ## Default Value 4 ## Remarks This property can be used to query the OpenPGP version of the currently selected key. Possible values are: - *4* - OpenPGP v4 (default) - *5* - LibrePGP v5 - *6* - OpenPGP v6 The *key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [key_count](#key_count-property) property. This property is read-only. # last_reply property This property indicates the last reply received from the server. ## Syntax ```text def get_last_reply() -> str: ... last_reply = property(get_last_reply, None) ``` ## Default Value "" ## Remarks This property indicates the last reply received from the server. It can be used for informational purposes. The same information and more also can be retrieved through the [on_pi_trail](#on_pi_trail-event) event. This property is read-only. # local_host property The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax ```text def get_local_host() -> str: ... def set_local_host(value: str) -> None: ... local_host = property(get_local_host, set_local_host) ``` ## Default Value "" ## Remarks This property contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used. If the class is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). NOTE: local_host is not persistent. You must always set it in code, and never in the property window. # mail_port property This property includes the server port for POP (default 110). ## Syntax ```text def get_mail_port() -> int: ... def set_mail_port(value: int) -> None: ... mail_port = property(get_mail_port, set_mail_port) ``` ## Default Value 110 ## Remarks This property contains the server port for POP (default 110). A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error. For implicit Secure Sockets Layer (SSL), use port 995 (please refer to the [ssl_start_mode](#ssl_start_mode-property) property for more information). # mail_server property This property includes the name or address of a mail server (internet post office server). ## Syntax ```text def get_mail_server() -> str: ... def set_mail_server(value: str) -> None: ... mail_server = property(get_mail_server, set_mail_server) ``` ## Default Value "" ## Remarks This property specifies the IP address (IP number in dotted internet format) or the domain name of the mail server. It is set before a connection is attempted and cannot be changed once a connection is in progress. If this property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error. If the class is configured to use a *SOCKS* firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution. # max_lines property This property includes the maximum number of message lines other than headers to retrieve. ## Syntax ```text def get_max_lines() -> int: ... def set_max_lines(value: int) -> None: ... max_lines = property(get_max_lines, set_max_lines) ``` ## Default Value 0 ## Remarks This property is used to limit the number of text lines other than headers retrieved for messages. It can be used to preview message headers and a portion of their contents, without incurring the overhead of downloading the entire message. The default value of the property is 0. In this case, the entire message will be retrieved, without interruptions. Note: If you are not retrieving the entire message (max_lines is nonzero), no data will be written to local_file. # message property This property provides the raw message content. ## Syntax ```text def get_message() -> bytes: ... message = property(get_message, None) ``` ## Default Value "" ## Remarks This property is populated after calling [retrieve](#retrieve-method) and holds the raw message content. This can be used to access the data before any processing is done by the class. This property is read-only. # message_cc property This property includes the value of the CC header of the last retrieved message. ## Syntax ```text def get_message_cc() -> str: ... message_cc = property(get_message_cc, None) ``` ## Default Value "" ## Remarks This property contains the value of the CC header of the last retrieved message. The same information also may be retrieved through the [on_header](#on_header-event) event. This property is read-only. # message_count property This property includes the number of messages in the mailbox. ## Syntax ```text def get_message_count() -> int: ... message_count = property(get_message_count, None) ``` ## Default Value 0 ## Remarks This property contains the number of messages in the mailbox. When the class is not connected to the server, the value of this property is 0. When connected, it contains the number of messages in the mailbox as reported by the POP server. This property is read-only. # message_date property This property includes the value of the date header of the last retrieved message. ## Syntax ```text def get_message_date() -> str: ... message_date = property(get_message_date, None) ``` ## Default Value "" ## Remarks This property contains the value of the date header of the last retrieved message. The same information also may be retrieved through the [on_header](#on_header-event) event. This property is read-only. # message_from property This property includes the value of the from header of the last retrieved message. ## Syntax ```text def get_message_from() -> str: ... message_from = property(get_message_from, None) ``` ## Default Value "" ## Remarks This property contains the value of the from header of the last retrieved message. The same information also may be retrieved through the [on_header](#on_header-event) event. This property is read-only. # message_header_count property The number of records in the MessageHeader arrays. ## Syntax ```text def get_message_header_count() -> int: ... message_header_count = property(get_message_header_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [message_header_field](#message_header_field-property) - [message_header_value](#message_header_value-property) The array indices start at *0* and end at *message_header_count - 1*. This property is read-only. # message_header_field property This property contains the name of the HTTP header (this is the same case as it is delivered). ## Syntax ```text def get_message_header_field(message_header_index: int) -> str: ... ``` ## Default Value "" ## Remarks This property contains the name of the HTTP [Header](#Type_Header) (this is the same case as it is delivered). The *message_header_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [message_header_count](#message_header_count-property) property. This property is read-only. # message_header_value property This property contains the header contents. ## Syntax ```text def get_message_header_value(message_header_index: int) -> str: ... ``` ## Default Value "" ## Remarks This property contains the [Header](#Type_Header) contents. The *message_header_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [message_header_count](#message_header_count-property) property. This property is read-only. # message_headers_string property This property includes a string representation of the full headers of the message as retrieved from the server. ## Syntax ```text def get_message_headers_string() -> str: ... message_headers_string = property(get_message_headers_string, None) ``` ## Default Value "" ## Remarks This property contains a string representation of the full headers of the message as retrieved from the server. If the class is not connected, or [message_number](#message_number-property) does not contain a valid message number, the value of this property is an empty string. Otherwise, it contains the full headers of the mail message as reported by the server. The [mail_server](#mail_server-property) is asked about the headers of the message only if the [message_number](#message_number-property) property has changed. If [message_number](#message_number-property) has not changed, the class returns a cached value. **Example. Connect and Retrieve Messages:** ```text POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 MessageText = POPControl.MessageText MessageHeadersString = POPControl.MessageHeadersString ``` This property is read-only. # message_number property This property includes the current (selected) message. ## Syntax ```text def get_message_number() -> int: ... def set_message_number(value: int) -> None: ... message_number = property(get_message_number, set_message_number) ``` ## Default Value 1 ## Remarks This property indicates the current (selected) message. This property specifies a message number in between 1 and [message_count](#message_count-property). The various class methods related to single messages use this property as a message pointer (see method descriptions and the [query_message_size](#query_message_size-method) method). # message_recipient_count property The number of records in the MessageRecipient arrays. ## Syntax ```text def get_message_recipient_count() -> int: ... message_recipient_count = property(get_message_recipient_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [message_recipient_address](#message_recipient_address-property) - [message_recipient_name](#message_recipient_name-property) - [message_recipient_options](#message_recipient_options-property) - [message_recipient_type](#message_recipient_type-property) The array indices start at *0* and end at *message_recipient_count - 1*. This property is read-only. # message_recipient_address property This property contains the email address of the recipient. ## Syntax ```text def get_message_recipient_address(recipient_index: int) -> str: ... ``` ## Default Value "" ## Remarks This property contains the email address of the recipient. The *recipient_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [message_recipient_count](#message_recipient_count-property) property. This property is read-only. # message_recipient_name property This property contains the name of the recipient. ## Syntax ```text def get_message_recipient_name(recipient_index: int) -> str: ... ``` ## Default Value "" ## Remarks This property contains the name of the recipient. The *recipient_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [message_recipient_count](#message_recipient_count-property) property. This property is read-only. # message_recipient_options property This property contains the recipient sending options (used only by SMTP). ## Syntax ```text def get_message_recipient_options(recipient_index: int) -> str: ... ``` ## Default Value "" ## Remarks This property contains the recipient sending options (used only by SMTP). This must be a string of RFC-compliant recipient options (used by [SMTP](#SMTP)). One type of option is a delivery status notification sent per recipient, which is specified by RFC 1891. ```text component.MessageRecipientOptions(0) = "NOTIFY SUCCESS,FAILURE,DELAY"; ``` The *recipient_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [message_recipient_count](#message_recipient_count-property) property. This property is read-only. # message_recipient_type property This property contains the recipient type: To, Cc, or Bcc. ## Syntax ```text def get_message_recipient_type(recipient_index: int) -> int: ... ``` ## Possible Values ```text 0 # To1 # Cc2 # BCc ``` ## Default Value 0 ## Remarks This property contains the recipient type: To, Cc, or Bcc. The *recipient_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [message_recipient_count](#message_recipient_count-property) property. This property is read-only. # message_reply_to property This property includes the value of the Reply-To header of the last retrieved message. ## Syntax ```text def get_message_reply_to() -> str: ... message_reply_to = property(get_message_reply_to, None) ``` ## Default Value "" ## Remarks This property contains the value of the Reply-To header of the last retrieved message. The same information also may be retrieved through the [on_header](#on_header-event) event. This property is read-only. # message_subject property This property includes the value of the Subject header of the last retrieved message. ## Syntax ```text def get_message_subject() -> str: ... message_subject = property(get_message_subject, None) ``` ## Default Value "" ## Remarks This property contains the value of the Subject header of the last retrieved message. The same information also may be retrieved through the [on_header](#on_header-event) event. This property is read-only. # message_text property This property includes the full text of the message as retrieved from the server. ## Syntax ```text def get_message_text() -> str: ... message_text = property(get_message_text, None) ``` ## Default Value "" ## Remarks This property contains the full text of the message as retrieved from the server. If the class is not connected, or [message_number](#message_number-property) does not contain a valid message number, the value of this property is an empty string. Otherwise, it contains the text of the mail message as reported by the server (a maximum of [max_lines](#max_lines-property)). The [mail_server](#mail_server-property) is asked about the text of the message only if the [message_number](#message_number-property) property has changed. If [message_number](#message_number-property) has not changed, the class returns a cached value. **Example. Connect and Retrieve Messages:** ```text POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 MessageText = POPControl.MessageText MessageHeaders = POPControl.MessageHeaders ``` This property is read-only. # message_to property This property includes the value of the To header of the last retrieved message. ## Syntax ```text def get_message_to() -> str: ... message_to = property(get_message_to, None) ``` ## Default Value "" ## Remarks This property contains the value of the To header of the last retrieved message. The same information also may be retrieved through the [on_header](#on_header-event) event. This property is read-only. # o_auth_access_token property The access token returned by the authorization server. ## Syntax ```text def get_o_auth_access_token() -> str: ... def set_o_auth_access_token(value: str) -> None: ... o_auth_access_token = property(get_o_auth_access_token, set_o_auth_access_token) ``` ## Default Value "" ## Remarks The access token returned by the authorization server. This is set when the class makes a request to the token server. # o_auth_authorization_scope property The scope request or response parameter used during authorization. ## Syntax ```text def get_o_auth_authorization_scope() -> str: ... def set_o_auth_authorization_scope(value: str) -> None: ... o_auth_authorization_scope = property(get_o_auth_authorization_scope, set_o_auth_authorization_scope) ``` ## Default Value "" ## Remarks The scope request or response parameter used during authorization. # o_auth_client_id property The id of the client assigned when registering the application. ## Syntax ```text def get_o_auth_client_id() -> str: ... def set_o_auth_client_id(value: str) -> None: ... o_auth_client_id = property(get_o_auth_client_id, set_o_auth_client_id) ``` ## Default Value "" ## Remarks The id of the client assigned when registering the application. # o_auth_client_secret property The secret value for the client assigned when registering the application. ## Syntax ```text def get_o_auth_client_secret() -> str: ... def set_o_auth_client_secret(value: str) -> None: ... o_auth_client_secret = property(get_o_auth_client_secret, set_o_auth_client_secret) ``` ## Default Value "" ## Remarks The secret value for the client assigned when registering the application. # o_auth_refresh_token property Specifies the refresh token received from or sent to the authorization server. ## Syntax ```text def get_o_auth_refresh_token() -> str: ... def set_o_auth_refresh_token(value: str) -> None: ... o_auth_refresh_token = property(get_o_auth_refresh_token, set_o_auth_refresh_token) ``` ## Default Value "" ## Remarks Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the o_auth_grant_type property is set to a grant that can use refresh tokens. # o_auth_return_url property The URL where the user (browser) returns after authenticating. ## Syntax ```text def get_o_auth_return_url() -> str: ... def set_o_auth_return_url(value: str) -> None: ... o_auth_return_url = property(get_o_auth_return_url, set_o_auth_return_url) ``` ## Default Value "" ## Remarks The URL where the user (browser) returns after authenticating. This property is mapped to the *redirect_uri* parameter when making a request to the authorization server. Typically, this is automatically set by the class when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing. # o_auth_server_auth_url property The URL of the authorization server. ## Syntax ```text def get_o_auth_server_auth_url() -> str: ... def set_o_auth_server_auth_url(value: str) -> None: ... o_auth_server_auth_url = property(get_o_auth_server_auth_url, set_o_auth_server_auth_url) ``` ## Default Value "" ## Remarks The URL of the authorization server. # o_auth_server_token_url property The URL of the token server used to obtain the access token. ## Syntax ```text def get_o_auth_server_token_url() -> str: ... def set_o_auth_server_token_url(value: str) -> None: ... o_auth_server_token_url = property(get_o_auth_server_token_url, set_o_auth_server_token_url) ``` ## Default Value "" ## Remarks The URL of the token server used to obtain the access token. # password property This property includes the password for the mailbox user. ## Syntax ```text def get_password() -> str: ... def set_password(value: str) -> None: ... password = property(get_password, set_password) ``` ## Default Value "" ## Remarks This property contains the password for the mailbox user. This property must be set before the class connects to the [mail_server](#mail_server-property). # signer_key_count property The number of records in the SignerKey arrays. ## Syntax ```text def get_signer_key_count() -> int: ... def set_signer_key_count(value: int) -> None: ... signer_key_count = property(get_signer_key_count, set_signer_key_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [signer_key_curve](#signer_key_curve-property) - [signer_key_effective_date](#signer_key_effective_date-property) - [signer_key_encoded](#signer_key_encoded-property) - [signer_key_expiration_date](#signer_key_expiration_date-property) - [signer_key_fingerprint](#signer_key_fingerprint-property) - [signer_key_id](#signer_key_id-property) - [signer_key_keyring](#signer_key_keyring-property) - [signer_key_other_user_ids](#signer_key_other_user_ids-property) - [signer_key_passphrase](#signer_key_passphrase-property) - [signer_key_public_key](#signer_key_public_key-property) - [signer_key_public_key_algorithm](#signer_key_public_key_algorithm-property) - [signer_key_public_key_length](#signer_key_public_key_length-property) - [signer_key_revoked](#signer_key_revoked-property) - [signer_key_secret_key](#signer_key_secret_key-property) - [signer_key_secret_key_available](#signer_key_secret_key_available-property) - [signer_key_usage](#signer_key_usage-property) - [signer_key_usage_flags](#signer_key_usage_flags-property) - [signer_key_user_id](#signer_key_user_id-property) - [signer_key_version](#signer_key_version-property) The array indices start at *0* and end at *signer_key_count - 1*. # signer_key_curve property This property specifies the elliptic curve if PublicKeyAlgorithm is ECDSA , EdDSA , Ed25519 , Ed448 , ML-DSA-65+Ed25519 , or ML-DSA-87+Ed448 . ## Syntax ```text def get_signer_key_curve(signer_key_index: int) -> str: ... ``` ## Default Value "" ## Remarks This property specifies the elliptic curve if [signer_key_public_key_algorithm](#signer_key_public_key_algorithm-property) is *ECDSA*, *EdDSA*, *Ed25519*, *Ed448*, *ML-DSA-65+Ed25519*, or *ML-DSA-87+Ed448*. Possible values are: | Curve | Valid Public Key Algorithms | Description | | --- | --- | --- | | secp256r1 | ECDSA | NIST curve P-256 | | secp384r1 | ECDSA | NIST curve P-384 | | secp521r1 | ECDSA | NIST curve P-521 | | secp256k1 | ECDSA | Secp256k1 | | brainpoolP256r1 | ECDSA | Brainpool curve P-256r1 | | brainpoolP384r1 | ECDSA | Brainpool curve P-384r1 | | brainpoolP512r1 | ECDSA | Brainpool curve P-512r1 | | Ed25519 | EdDSA, Ed25519, ML-DSA-65+Ed25519 | Ed25519 | | Ed448 | Ed448, ML-DSA-87+Ed448 | Ed448 | The *signer_key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signer_key_count](#signer_key_count-property) property. This property is read-only. # signer_key_effective_date property The date when this key becomes valid. ## Syntax ```text def get_signer_key_effective_date(signer_key_index: int) -> str: ... ``` ## Default Value "" ## Remarks The date when this key becomes valid. Prior to this it is not valid. The following is an example of a valid encoded date: 23-Jan-2000 15:00:00. The *signer_key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signer_key_count](#signer_key_count-property) property. This property is read-only. # signer_key_encoded property The key. ## Syntax ```text def get_signer_key_encoded(signer_key_index: int) -> bytes: ... def set_signer_key_encoded(signer_key_index: int, value: bytes) -> None: ... ``` ## Default Value "" ## Remarks The key. This property can be used to assign a specific key. The [signer_key_fingerprint](#signer_key_fingerprint-property), [signer_key_id](#signer_key_id-property), and [signer_key_user_id](#signer_key_user_id-property) properties may also be used to specify a key. The *signer_key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signer_key_count](#signer_key_count-property) property. # signer_key_expiration_date property The date the key expires. ## Syntax ```text def get_signer_key_expiration_date(signer_key_index: int) -> str: ... ``` ## Default Value "" ## Remarks The date the key expires. After this date the key will no longer be valid. The following is an example of a valid encoded date: 23-Jan-2001 15:00:00. The *signer_key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signer_key_count](#signer_key_count-property) property. This property is read-only. # signer_key_fingerprint property The hex-encoded, 20-byte fingerprint of the key. ## Syntax ```text def get_signer_key_fingerprint(signer_key_index: int) -> str: ... def set_signer_key_fingerprint(signer_key_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte fingerprint of the key. When a key is loaded, this property is populated with the Fingerprint associated with the key. This property may be set to load a key from the [signer_key_keyring](#signer_key_keyring-property). When this property is set the class will search the [signer_key_keyring](#signer_key_keyring-property) for a key associated with the Fingerprint specified. This is in the form: ```text 5E70662EA810E768391A2FE8F7B7D49C89C9D7B1 ``` The *signer_key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signer_key_count](#signer_key_count-property) property. # signer_key_id property The hex-encoded, 4-byte or 8-byte key Id. ## Syntax ```text def get_signer_key_id(signer_key_index: int) -> str: ... def set_signer_key_id(signer_key_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The hex-encoded, 4-byte or 8-byte key Id. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's *Fingerprint*. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's *Fingerprint* instead. For instance: ```text 5E70662EA810E768 ``` When a key is loaded, this property is populated with the Id associated with the key. This property may be set to load a key from the [signer_key_keyring](#signer_key_keyring-property). When this property is set the class will search the [signer_key_keyring](#signer_key_keyring-property) for a key associated with the Id specified. The KeyIdLength setting may be set to control the length of the returned key Id. NOTE: It is recommended to use the [signer_key_fingerprint](#signer_key_fingerprint-property) property when loading a key from the [signer_key_keyring](#signer_key_keyring-property), as it is possible for different keys to have the same Id. The *signer_key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signer_key_count](#signer_key_count-property) property. # signer_key_keyring property The location of the keyring. ## Syntax ```text def get_signer_key_keyring(signer_key_index: int) -> str: ... def set_signer_key_keyring(signer_key_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The location of the keyring. If the keyring is stored in a directory, set this property to the directory. The directory must contain the files "secring.gpg" and "pubring.gpg". A keyring may also be stored in a single file. If the keyring is a file this property should be set to the path of the file. When This property is set the class will read the keyring and populate the key property with the first key found in the keyring. Set [key_user_id](#KeyMgr_p_KeyUserId) to select a different key in the current keyring. The *signer_key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signer_key_count](#signer_key_count-property) property. # signer_key_other_user_ids property If the specified key has alternate user Ids associated with it, this property returns a comma-separated list of the other user Ids. ## Syntax ```text def get_signer_key_other_user_ids(signer_key_index: int) -> str: ... ``` ## Default Value "" ## Remarks If the specified key has alternate user Ids associated with it, this property returns a comma-separated list of the other user Ids. The *signer_key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signer_key_count](#signer_key_count-property) property. This property is read-only. # signer_key_passphrase property The passphrase for the key's secret key (if any). ## Syntax ```text def get_signer_key_passphrase(signer_key_index: int) -> str: ... def set_signer_key_passphrase(signer_key_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The passphrase for the key's secret key (if any). This must be specified before operations requiring the secret key are attempted. The passphrase may be supplied in this property or through the on_key_passphrase event, which will fire when a passphrase is required. The passphrase is required when using the following methods in KeyMgr: - add_user_id - sign_user_id - change_expiration_date - change_passphrase When using the OpenPGP class, or an email-based class, the following methods require a passphrase for the key: - decrypt - sign - sign_and_encrypt The *signer_key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signer_key_count](#signer_key_count-property) property. # signer_key_public_key property The public key of the key. ## Syntax ```text def get_signer_key_public_key(signer_key_index: int) -> str: ... ``` ## Default Value "" ## Remarks The public key of the key. The key is provided as ASCII armored data. The *signer_key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signer_key_count](#signer_key_count-property) property. This property is read-only. # signer_key_public_key_algorithm property A text description of the public key algorithm of the key. ## Syntax ```text def get_signer_key_public_key_algorithm(signer_key_index: int) -> str: ... ``` ## Default Value "" ## Remarks A text description of the public key algorithm of the key. Possible values are: - RSA - DSA - ECDSA - EdDSA - Ed25519 - Ed448 - ML-DSA-65+Ed25519 - ML-DSA-87+Ed448 - RSA-Legacy The *signer_key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signer_key_count](#signer_key_count-property) property. This property is read-only. # signer_key_public_key_length property The length of the public key in bits. ## Syntax ```text def get_signer_key_public_key_length(signer_key_index: int) -> int: ... ``` ## Default Value 0 ## Remarks The length of the public key in bits. Common values are 1024, 2048, and 3072. If the [signer_key_public_key_algorithm](#signer_key_public_key_algorithm-property) property is *ECDSA*, *EdDSA*, *Ed25519*, *Ed448*, *ML-DSA-65+Ed25519*, or *ML-DSA-87+Ed448*, the length of the public key is determined by the [signer_key_curve](#signer_key_curve-property). Possible lengths are: | Curve | Public Key Length (bits) | | --- | --- | | secp256r1 | 256 | | secp384r1 | 384 | | secp521r1 | 528 | | secp256k1 | 256 | | Ed25519 | 256 | | Ed448 | 456 | The *signer_key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signer_key_count](#signer_key_count-property) property. This property is read-only. # signer_key_revoked property Whether or not the key is revoked. ## Syntax ```text def get_signer_key_revoked(signer_key_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Whether or not the key is revoked. The *signer_key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signer_key_count](#signer_key_count-property) property. This property is read-only. # signer_key_secret_key property The secret key of the key (if available). ## Syntax ```text def get_signer_key_secret_key(signer_key_index: int) -> str: ... ``` ## Default Value "" ## Remarks The secret key of the key (if available). The key is provided as ASCII armored data. The *signer_key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signer_key_count](#signer_key_count-property) property. This property is read-only. # signer_key_secret_key_available property Whether or not a secret key is available for the selected key. ## Syntax ```text def get_signer_key_secret_key_available(signer_key_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Whether or not a secret key is available for the selected key. The *signer_key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signer_key_count](#signer_key_count-property) property. This property is read-only. # signer_key_usage property A text description of UsageFlags . ## Syntax ```text def get_signer_key_usage(signer_key_index: int) -> str: ... ``` ## Default Value "" ## Remarks A text description of [signer_key_usage_flags](#signer_key_usage_flags-property). The value will be of one or more of the following strings, separated by commas: - Certifying Other Certificates - Signing Emails and Files - Encrypting Emails and Files - Split Key - Authenticate Against Servers - Group Key The *signer_key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signer_key_count](#signer_key_count-property) property. This property is read-only. # signer_key_usage_flags property Flags that show the intended use for the key. ## Syntax ```text def get_signer_key_usage_flags(signer_key_index: int) -> int: ... ``` ## Default Value 47 ## Remarks Flags that show the intended use for the key. The default value is 0x0F. The value of [signer_key_usage_flags](#signer_key_usage_flags-property) is a combination of the following flags: | | | | --- | --- | | 0x01 | This key may be used to certify other keys. | | 0x02 | This key may be used to sign data. | | 0x0C | This key may be used to encrypt communications and encrypt storage. | | 0x10 | The private component of this key may have been split by a secret-sharing mechanism. | | 0x20 | This key may be used for authentication. | | 0x80 | The private component of this key may be in the possession of more than one person. | Please refer to the [signer_key_usage](#signer_key_usage-property) property for a text representation of [signer_key_usage_flags](#signer_key_usage_flags-property). The *signer_key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signer_key_count](#signer_key_count-property) property. This property is read-only. # signer_key_user_id property The user Id of the key. ## Syntax ```text def get_signer_key_user_id(signer_key_index: int) -> str: ... def set_signer_key_user_id(signer_key_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The user Id of the key. When a key is loaded this property is populated with the user Id associated with the key. This property may be set to load a key from the [signer_key_keyring](#signer_key_keyring-property). When this property is set the class will search the [signer_key_keyring](#signer_key_keyring-property) for a key associated with the UserId specified. When loading a key with multiple user Ids, this property will be populated with the UserId that was most recently added to the key. To discover all of the UserIds associated with a key query this property and [key_other_user_ids](#KeyMgr_p_KeyOtherUserIds) after loading the key. The *UserId* format is: ```text FirstName LastName (Comment) ``` Not all values are required when selecting or generating a key, but at least FirstName or Email are required. Note that for OpenPGP v6, a key may be created with or without a *UserId*, as the field is optional. If a key was created without a *UserId*, the key's *Fingerprint* can be used as its identifier instead. When using this property to select a key you may also specify the key's Id, or any of its subkeys' Ids, instead of a user Id. The class will then search for a key with a matching Id. This is helpful in situations where you do not have the UserId but still need to load the key, such as within the OpenPGP class's on_recipient_info event. The *signer_key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signer_key_count](#signer_key_count-property) property. # signer_key_version property This property can be used to query the OpenPGP version of the currently selected Key . ## Syntax ```text def get_signer_key_version(signer_key_index: int) -> int: ... ``` ## Default Value 4 ## Remarks This property can be used to query the OpenPGP version of the currently selected key. Possible values are: - *4* - OpenPGP v4 (default) - *5* - LibrePGP v5 - *6* - OpenPGP v6 The *signer_key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signer_key_count](#signer_key_count-property) property. This property is read-only. # ssl_accept_server_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_ssl_accept_server_cert_effective_date() -> str: ... ssl_accept_server_cert_effective_date = property(get_ssl_accept_server_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. # ssl_accept_server_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_ssl_accept_server_cert_encoded() -> bytes: ... def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ... ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded) ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) and [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) properties also may be used to specify a certificate. When [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property) is set, a search is initiated in the current [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) for the private key of the certificate. If the key is found, [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) is set to an empty string. # ssl_accept_server_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_ssl_accept_server_cert_expiration_date() -> str: ... ssl_accept_server_cert_expiration_date = property(get_ssl_accept_server_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. # ssl_accept_server_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_ssl_accept_server_cert_extended_key_usage() -> str: ... ssl_accept_server_cert_extended_key_usage = property(get_ssl_accept_server_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. # ssl_accept_server_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_fingerprint() -> str: ... ssl_accept_server_cert_fingerprint = property(get_ssl_accept_server_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. # ssl_accept_server_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_fingerprint_sha1() -> str: ... ssl_accept_server_cert_fingerprint_sha1 = property(get_ssl_accept_server_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. # ssl_accept_server_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_fingerprint_sha256() -> str: ... ssl_accept_server_cert_fingerprint_sha256 = property(get_ssl_accept_server_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. # ssl_accept_server_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_issuer() -> str: ... ssl_accept_server_cert_issuer = property(get_ssl_accept_server_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. # ssl_accept_server_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_ssl_accept_server_cert_private_key() -> str: ... ssl_accept_server_cert_private_key = property(get_ssl_accept_server_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 [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) may be available but not exportable. In this case, [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) returns an empty string. This property is read-only. # ssl_accept_server_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_ssl_accept_server_cert_private_key_available() -> bool: ... ssl_accept_server_cert_private_key_available = property(get_ssl_accept_server_cert_private_key_available, None) ``` ## Default Value FALSE ## Remarks Whether a [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) is available for the selected certificate. If [ssl_accept_server_cert_private_key_available](#ssl_accept_server_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. # ssl_accept_server_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_ssl_accept_server_cert_private_key_container() -> str: ... ssl_accept_server_cert_private_key_container = property(get_ssl_accept_server_cert_private_key_container, None) ``` ## Default Value "" ## Remarks The name of the [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. # ssl_accept_server_cert_public_key property The public key of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_public_key() -> str: ... ssl_accept_server_cert_public_key = property(get_ssl_accept_server_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. # ssl_accept_server_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_ssl_accept_server_cert_public_key_algorithm() -> str: ... ssl_accept_server_cert_public_key_algorithm = property(get_ssl_accept_server_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. # ssl_accept_server_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_ssl_accept_server_cert_public_key_length() -> int: ... ssl_accept_server_cert_public_key_length = property(get_ssl_accept_server_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. # ssl_accept_server_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_ssl_accept_server_cert_serial_number() -> str: ... ssl_accept_server_cert_serial_number = property(get_ssl_accept_server_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. # ssl_accept_server_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_ssl_accept_server_cert_signature_algorithm() -> str: ... ssl_accept_server_cert_signature_algorithm = property(get_ssl_accept_server_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. # ssl_accept_server_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_ssl_accept_server_cert_store() -> bytes: ... def set_ssl_accept_server_cert_store(value: bytes) -> None: ... ssl_accept_server_cert_store = property(get_ssl_accept_server_cert_store, set_ssl_accept_server_cert_store) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property) property denotes the type of the certificate store specified by [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property). If the store is password-protected, specify the password in [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property). [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) is used in conjunction with the [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) property to specify client certificates. If [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) has a value, and [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) or [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [ssl_accept_server_cert_subject](#ssl_accept_server_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). # ssl_accept_server_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_ssl_accept_server_cert_store_password() -> str: ... def set_ssl_accept_server_cert_store_password(value: str) -> None: ... ssl_accept_server_cert_store_password = property(get_ssl_accept_server_cert_store_password, set_ssl_accept_server_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. # ssl_accept_server_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_ssl_accept_server_cert_store_type() -> int: ... def set_ssl_accept_server_cert_store_type(value: int) -> None: ... ssl_accept_server_cert_store_type = property(get_ssl_accept_server_cert_store_type, set_ssl_accept_server_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 [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property), the full path of the PKCS#11 DLL as the [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property), and the PIN as the [ssl_accept_server_cert_store_password](#ssl_accept_server_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 [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) and set [ssl_accept_server_cert_store_password](#ssl_accept_server_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. | # ssl_accept_server_cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_ssl_accept_server_cert_subject() -> str: ... def set_ssl_accept_server_cert_subject(value: str) -> None: ... ssl_accept_server_cert_subject = property(get_ssl_accept_server_cert_subject, set_ssl_accept_server_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. # ssl_accept_server_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_ssl_accept_server_cert_subject_alt_names() -> str: ... ssl_accept_server_cert_subject_alt_names = property(get_ssl_accept_server_cert_subject_alt_names, None) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. # ssl_accept_server_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_thumbprint_md5() -> str: ... ssl_accept_server_cert_thumbprint_md5 = property(get_ssl_accept_server_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. # ssl_accept_server_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_thumbprint_sha1() -> str: ... ssl_accept_server_cert_thumbprint_sha1 = property(get_ssl_accept_server_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. # ssl_accept_server_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_thumbprint_sha256() -> str: ... ssl_accept_server_cert_thumbprint_sha256 = property(get_ssl_accept_server_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. # ssl_accept_server_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_ssl_accept_server_cert_usage() -> str: ... ssl_accept_server_cert_usage = property(get_ssl_accept_server_cert_usage, None) ``` ## Default Value "" ## Remarks The text description of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_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. # ssl_accept_server_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_ssl_accept_server_cert_usage_flags() -> int: ... ssl_accept_server_cert_usage_flags = property(get_ssl_accept_server_cert_usage_flags, None) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_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 [ssl_accept_server_cert_usage](#ssl_accept_server_cert_usage-property) property for a text representation of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. This property is read-only. # ssl_accept_server_cert_version property The certificate's version number. ## Syntax ```text def get_ssl_accept_server_cert_version() -> str: ... ssl_accept_server_cert_version = property(get_ssl_accept_server_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. # ssl_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_ssl_cert_effective_date() -> str: ... ssl_cert_effective_date = property(get_ssl_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. # ssl_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_ssl_cert_encoded() -> bytes: ... def set_ssl_cert_encoded(value: bytes) -> None: ... ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded) ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_cert_store](#ssl_cert_store-property) and [ssl_cert_subject](#ssl_cert_subject-property) properties also may be used to specify a certificate. When [ssl_cert_encoded](#ssl_cert_encoded-property) is set, a search is initiated in the current [ssl_cert_store](#ssl_cert_store-property) for the private key of the certificate. If the key is found, [ssl_cert_subject](#ssl_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_cert_subject](#ssl_cert_subject-property) is set to an empty string. # ssl_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_ssl_cert_expiration_date() -> str: ... ssl_cert_expiration_date = property(get_ssl_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. # ssl_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_ssl_cert_extended_key_usage() -> str: ... ssl_cert_extended_key_usage = property(get_ssl_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. # ssl_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_ssl_cert_fingerprint() -> str: ... ssl_cert_fingerprint = property(get_ssl_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. # ssl_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_ssl_cert_fingerprint_sha1() -> str: ... ssl_cert_fingerprint_sha1 = property(get_ssl_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. # ssl_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_ssl_cert_fingerprint_sha256() -> str: ... ssl_cert_fingerprint_sha256 = property(get_ssl_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. # ssl_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_ssl_cert_issuer() -> str: ... ssl_cert_issuer = property(get_ssl_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. # ssl_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_ssl_cert_private_key() -> str: ... ssl_cert_private_key = property(get_ssl_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 [ssl_cert_private_key](#ssl_cert_private_key-property) may be available but not exportable. In this case, [ssl_cert_private_key](#ssl_cert_private_key-property) returns an empty string. This property is read-only. # ssl_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_ssl_cert_private_key_available() -> bool: ... ssl_cert_private_key_available = property(get_ssl_cert_private_key_available, None) ``` ## Default Value FALSE ## Remarks Whether a [ssl_cert_private_key](#ssl_cert_private_key-property) is available for the selected certificate. If [ssl_cert_private_key_available](#ssl_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. # ssl_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_ssl_cert_private_key_container() -> str: ... ssl_cert_private_key_container = property(get_ssl_cert_private_key_container, None) ``` ## Default Value "" ## Remarks The name of the [ssl_cert_private_key](#ssl_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. # ssl_cert_public_key property The public key of the certificate. ## Syntax ```text def get_ssl_cert_public_key() -> str: ... ssl_cert_public_key = property(get_ssl_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. # ssl_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_ssl_cert_public_key_algorithm() -> str: ... ssl_cert_public_key_algorithm = property(get_ssl_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. # ssl_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_ssl_cert_public_key_length() -> int: ... ssl_cert_public_key_length = property(get_ssl_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. # ssl_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_ssl_cert_serial_number() -> str: ... ssl_cert_serial_number = property(get_ssl_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. # ssl_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_ssl_cert_signature_algorithm() -> str: ... ssl_cert_signature_algorithm = property(get_ssl_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. # ssl_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_ssl_cert_store() -> bytes: ... def set_ssl_cert_store(value: bytes) -> None: ... ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ssl_cert_store_type](#ssl_cert_store_type-property) property denotes the type of the certificate store specified by [ssl_cert_store](#ssl_cert_store-property). If the store is password-protected, specify the password in [ssl_cert_store_password](#ssl_cert_store_password-property). [ssl_cert_store](#ssl_cert_store-property) is used in conjunction with the [ssl_cert_subject](#ssl_cert_subject-property) property to specify client certificates. If [ssl_cert_store](#ssl_cert_store-property) has a value, and [ssl_cert_subject](#ssl_cert_subject-property) or [ssl_cert_encoded](#ssl_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [ssl_cert_subject](#ssl_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). # ssl_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_ssl_cert_store_password() -> str: ... def set_ssl_cert_store_password(value: str) -> None: ... ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_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. # ssl_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_ssl_cert_store_type() -> int: ... def set_ssl_cert_store_type(value: int) -> None: ... ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_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 [ssl_cert_store_type](#ssl_cert_store_type-property), the full path of the PKCS#11 DLL as the [ssl_cert_store](#ssl_cert_store-property), and the PIN as the [ssl_cert_store_password](#ssl_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 [ssl_cert_store](#ssl_cert_store-property) and set [ssl_cert_store_password](#ssl_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. | # ssl_cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_ssl_cert_subject() -> str: ... def set_ssl_cert_subject(value: str) -> None: ... ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_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. # ssl_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_ssl_cert_subject_alt_names() -> str: ... ssl_cert_subject_alt_names = property(get_ssl_cert_subject_alt_names, None) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. # ssl_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_ssl_cert_thumbprint_md5() -> str: ... ssl_cert_thumbprint_md5 = property(get_ssl_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. # ssl_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_ssl_cert_thumbprint_sha1() -> str: ... ssl_cert_thumbprint_sha1 = property(get_ssl_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. # ssl_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_ssl_cert_thumbprint_sha256() -> str: ... ssl_cert_thumbprint_sha256 = property(get_ssl_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. # ssl_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_ssl_cert_usage() -> str: ... ssl_cert_usage = property(get_ssl_cert_usage, None) ``` ## Default Value "" ## Remarks The text description of [ssl_cert_usage_flags](#ssl_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. # ssl_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_ssl_cert_usage_flags() -> int: ... ssl_cert_usage_flags = property(get_ssl_cert_usage_flags, None) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [ssl_cert_usage_flags](#ssl_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 [ssl_cert_usage](#ssl_cert_usage-property) property for a text representation of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. This property is read-only. # ssl_cert_version property The certificate's version number. ## Syntax ```text def get_ssl_cert_version() -> str: ... ssl_cert_version = property(get_ssl_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. # ssl_enabled property This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. ## Syntax ```text def get_ssl_enabled() -> bool: ... def set_ssl_enabled(value: bool) -> None: ... ssl_enabled = property(get_ssl_enabled, set_ssl_enabled) ``` ## Default Value FALSE ## Remarks This property specifies whether TLS/SSL is enabled in the class. When False (default), the class operates in plaintext mode. When True, TLS/SSL is enabled. TLS/SSL may also be enabled by setting [ssl_start_mode](#ssl_start_mode-property). Setting [ssl_start_mode](#ssl_start_mode-property) will automatically update this property value. # ssl_provider property The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax ```text def get_ssl_provider() -> int: ... def set_ssl_provider(value: int) -> None: ... ssl_provider = property(get_ssl_provider, set_ssl_provider) ``` ## Possible Values ```text 0 # Automatic1 # Platform2 # Internal ``` ## Default Value 0 ## Remarks This property specifies the SSL/TLS implementation to use. In most cases the default value of *0* (Automatic) is recommended and should not be changed. When set to *0* (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used. Possible values are as follows: | | | | --- | --- | | 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. | | 1 (sslpPlatform) | Uses the platform/system implementation. | | 2 (sslpInternal) | Uses the internal implementation. | **Additional Notes** In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform. When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the class will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. # ssl_server_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_ssl_server_cert_effective_date() -> str: ... ssl_server_cert_effective_date = property(get_ssl_server_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. # ssl_server_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_ssl_server_cert_encoded() -> bytes: ... ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None) ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_server_cert_store](#ssl_server_cert_store-property) and [ssl_server_cert_subject](#ssl_server_cert_subject-property) properties also may be used to specify a certificate. When [ssl_server_cert_encoded](#ssl_server_cert_encoded-property) is set, a search is initiated in the current [ssl_server_cert_store](#ssl_server_cert_store-property) for the private key of the certificate. If the key is found, [ssl_server_cert_subject](#ssl_server_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_server_cert_subject](#ssl_server_cert_subject-property) is set to an empty string. This property is read-only. # ssl_server_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_ssl_server_cert_expiration_date() -> str: ... ssl_server_cert_expiration_date = property(get_ssl_server_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. # ssl_server_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_ssl_server_cert_extended_key_usage() -> str: ... ssl_server_cert_extended_key_usage = property(get_ssl_server_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. # ssl_server_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_ssl_server_cert_fingerprint() -> str: ... ssl_server_cert_fingerprint = property(get_ssl_server_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. # ssl_server_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_ssl_server_cert_fingerprint_sha1() -> str: ... ssl_server_cert_fingerprint_sha1 = property(get_ssl_server_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. # ssl_server_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_ssl_server_cert_fingerprint_sha256() -> str: ... ssl_server_cert_fingerprint_sha256 = property(get_ssl_server_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. # ssl_server_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_ssl_server_cert_issuer() -> str: ... ssl_server_cert_issuer = property(get_ssl_server_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. # ssl_server_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_ssl_server_cert_private_key() -> str: ... ssl_server_cert_private_key = property(get_ssl_server_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 [ssl_server_cert_private_key](#ssl_server_cert_private_key-property) may be available but not exportable. In this case, [ssl_server_cert_private_key](#ssl_server_cert_private_key-property) returns an empty string. This property is read-only. # ssl_server_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_ssl_server_cert_private_key_available() -> bool: ... ssl_server_cert_private_key_available = property(get_ssl_server_cert_private_key_available, None) ``` ## Default Value FALSE ## Remarks Whether a [ssl_server_cert_private_key](#ssl_server_cert_private_key-property) is available for the selected certificate. If [ssl_server_cert_private_key_available](#ssl_server_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. # ssl_server_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_ssl_server_cert_private_key_container() -> str: ... ssl_server_cert_private_key_container = property(get_ssl_server_cert_private_key_container, None) ``` ## Default Value "" ## Remarks The name of the [ssl_server_cert_private_key](#ssl_server_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. # ssl_server_cert_public_key property The public key of the certificate. ## Syntax ```text def get_ssl_server_cert_public_key() -> str: ... ssl_server_cert_public_key = property(get_ssl_server_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. # ssl_server_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_ssl_server_cert_public_key_algorithm() -> str: ... ssl_server_cert_public_key_algorithm = property(get_ssl_server_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. # ssl_server_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_ssl_server_cert_public_key_length() -> int: ... ssl_server_cert_public_key_length = property(get_ssl_server_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. # ssl_server_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_ssl_server_cert_serial_number() -> str: ... ssl_server_cert_serial_number = property(get_ssl_server_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. # ssl_server_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_ssl_server_cert_signature_algorithm() -> str: ... ssl_server_cert_signature_algorithm = property(get_ssl_server_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. # ssl_server_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_ssl_server_cert_store() -> bytes: ... ssl_server_cert_store = property(get_ssl_server_cert_store, None) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ssl_server_cert_store_type](#ssl_server_cert_store_type-property) property denotes the type of the certificate store specified by [ssl_server_cert_store](#ssl_server_cert_store-property). If the store is password-protected, specify the password in [ssl_server_cert_store_password](#ssl_server_cert_store_password-property). [ssl_server_cert_store](#ssl_server_cert_store-property) is used in conjunction with the [ssl_server_cert_subject](#ssl_server_cert_subject-property) property to specify client certificates. If [ssl_server_cert_store](#ssl_server_cert_store-property) has a value, and [ssl_server_cert_subject](#ssl_server_cert_subject-property) or [ssl_server_cert_encoded](#ssl_server_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [ssl_server_cert_subject](#ssl_server_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). This property is read-only. # ssl_server_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_ssl_server_cert_store_password() -> str: ... ssl_server_cert_store_password = property(get_ssl_server_cert_store_password, None) ``` ## 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. This property is read-only. # ssl_server_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_ssl_server_cert_store_type() -> int: ... ssl_server_cert_store_type = property(get_ssl_server_cert_store_type, None) ``` ## 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 [ssl_server_cert_store_type](#ssl_server_cert_store_type-property), the full path of the PKCS#11 DLL as the [ssl_server_cert_store](#ssl_server_cert_store-property), and the PIN as the [ssl_server_cert_store_password](#ssl_server_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 [ssl_server_cert_store](#ssl_server_cert_store-property) and set [ssl_server_cert_store_password](#ssl_server_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. | This property is read-only. # ssl_server_cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_ssl_server_cert_subject() -> str: ... ssl_server_cert_subject = property(get_ssl_server_cert_subject, None) ``` ## 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. This property is read-only. # ssl_server_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_ssl_server_cert_subject_alt_names() -> str: ... ssl_server_cert_subject_alt_names = property(get_ssl_server_cert_subject_alt_names, None) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. # ssl_server_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_ssl_server_cert_thumbprint_md5() -> str: ... ssl_server_cert_thumbprint_md5 = property(get_ssl_server_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. # ssl_server_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_ssl_server_cert_thumbprint_sha1() -> str: ... ssl_server_cert_thumbprint_sha1 = property(get_ssl_server_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. # ssl_server_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_ssl_server_cert_thumbprint_sha256() -> str: ... ssl_server_cert_thumbprint_sha256 = property(get_ssl_server_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. # ssl_server_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_ssl_server_cert_usage() -> str: ... ssl_server_cert_usage = property(get_ssl_server_cert_usage, None) ``` ## Default Value "" ## Remarks The text description of [ssl_server_cert_usage_flags](#ssl_server_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. # ssl_server_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_ssl_server_cert_usage_flags() -> int: ... ssl_server_cert_usage_flags = property(get_ssl_server_cert_usage_flags, None) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [ssl_server_cert_usage_flags](#ssl_server_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 [ssl_server_cert_usage](#ssl_server_cert_usage-property) property for a text representation of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. This property is read-only. # ssl_server_cert_version property The certificate's version number. ## Syntax ```text def get_ssl_server_cert_version() -> str: ... ssl_server_cert_version = property(get_ssl_server_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. # ssl_start_mode property This property determines how the class starts the Secure Sockets Layer (SSL) negotiation. ## Syntax ```text def get_ssl_start_mode() -> int: ... def set_ssl_start_mode(value: int) -> None: ... ssl_start_mode = property(get_ssl_start_mode, set_ssl_start_mode) ``` ## Possible Values ```text 0 # Automatic1 # Implicit2 # Explicit3 # None ``` ## Default Value 3 ## Remarks The ssl_start_mode property may have one of the following values: | | | | --- | --- | | 0 (sslAutomatic) | If the remote port is set to the standard plaintext port of the protocol (where applicable), the class will behave the same as if ssl_start_mode is set to sslExplicit. In all other cases, SSL negotiation will be implicit (sslImplicit). | | 1 (sslImplicit) | The SSL negotiation will start immediately after the connection is established. | | 2 (sslExplicit) | The class will first connect in plaintext, and then will explicitly start SSL negotiation through a protocol command such as STARTTLS. | | 3 (sslNone - default) | No SSL negotiation; no SSL security. All communication will be in plaintext mode. | # timeout property The timeout for the class. ## Syntax ```text def get_timeout() -> int: ... def set_timeout(value: int) -> None: ... timeout = property(get_timeout, set_timeout) ``` ## Default Value 60 ## Remarks If the timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered. If timeout is set to a positive value, the class will wait for the operation to complete before returning control. The class will use [do_events](#do_events-method) to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive. If timeout expires, and the operation is not yet complete, the class fails with an error. NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received. The default value for the timeout property is 60 seconds. # user property This property includes the user identifier for the mailbox. ## Syntax ```text def get_user() -> str: ... def set_user(value: str) -> None: ... user = property(get_user, set_user) ``` ## Default Value "" ## Remarks This property contains the user identifier for the mailbox. This property must be set before the class connects to the [mail_server](#mail_server-property). # 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](#ppop-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](#ppop-config-settings), you must call *Config("PROPERTY")*. The value will be returned as a string. # connect method This method connects to the mail server and attempts to log in. ## Syntax ```text def connect() -> None: ... ``` ## Remarks This method connects to the mail server and attempts to log in using the current [user](#user-property) and [password](#password-property). Then it retrieves the initial statistics about the mailbox contents ([message_count](#message_count-property) and [query_total_size](#query_total_size-method)). **Example. Connect to POP Mailbox:** ```text POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 POPControl.Retrieve() MessageText = POPControl.MessageText MessageHeaders = POPControl.MessageHeaders ``` # decrypt method Decrypts the message. ## Syntax ```text def decrypt() -> None: ... ``` ## Remarks This method decrypts the specified message. The message will be decrypted using the keys specified in keys. Before decryption begins the class will fire the [on_recipient_info](#on_recipient_info-event) event with information about the encrypted message, including the key used to encrypt the message. Within this event you may use the available information to load the correct key into keys. # decrypt_and_verify_signature method Decrypts and verifies the signature of the message. ## Syntax ```text def decrypt_and_verify_signature() -> None: ... ``` ## Remarks This method attempts to both decrypt and verify the signature of the message. All of the properties affected by calling the [decrypt](#decrypt-method) and [verify_signature](#verify_signature-method) methods are affected in the same manner. This method may be used when the data is signed, encrypted, or signed and encrypted. For instance, if the data is encrypted but not signed you may still use this method and the class will perform the decryption without error. The message will be decrypted using the keys specified in keys. Before decryption begins the class will fire the [on_recipient_info](#on_recipient_info-event) event with information about the encrypted message, including the key used to encrypt the message. Within this event you may use the available information to load the correct key into keys. The message will be verified using the keys specified in signer_keys. Before verification begins the class will fire the [on_signature_info](#on_signature_info-event) event with information about the signature including the key used to sign the message. Within this event you may use the information available to load the correct key into signer_keys. By default, if the signature is not valid the class fails with an error. The configuration setting [RequireValidSignature](#RequireValidSignature) may be set to False to disable this requirement. When [RequireValidSignature](#RequireValidSignature) is set to False, the *Status* parameter of the [on_verification_status](#on_verification_status-event) event should be checked to determine the result of the operation. NOTE: This method does not attempt to check the validity of the signing key itself. # delete method This method deletes a message specified by MessageNumber on the server. ## Syntax ```text def delete() -> None: ... ``` ## Remarks This method asks the [mail_server](#mail_server-property) to delete the message specified by [message_number](#message_number-property). The message will not actually be deleted from the server until the connection is closed. To cancel a previous Delete, use the [reset](#reset-method) method. # disconnect method This method disconnects from the mail server. ## Syntax ```text def disconnect() -> None: ... ``` ## Remarks This method makes the class disconnect from the [mail_server](#mail_server-property) by sending the *QUIT* command. If successful, all changes to the mailbox are committed by the server. Otherwise, changes are rolled back to the initial state that the server was in before the connection. # do_events method This method processes events from the internal message queue. ## Syntax ```text def do_events() -> None: ... ``` ## Remarks When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns. # interrupt method This method interrupts the current method. ## Syntax ```text def interrupt() -> None: ... ``` ## Remarks If there is no method in progress, interrupt simply returns, doing nothing. # list_message_sizes method This method retrieves a list of all message sizes from the server. ## Syntax ```text def list_message_sizes() -> None: ... ``` ## Remarks This message retrieves a list of all message sizes from the server. For each message listed, a [on_message_list](#on_message_list-event) event will fire containing the number and size of the message. # list_message_ui_ds method This method retrieves a list of all message UIDs from the server. ## Syntax ```text def list_message_ui_ds() -> None: ... ``` ## Remarks This method retrieves a list of all message UIDs from the server. For each message listed, a [on_message_list](#on_message_list-event) event will fire containing the number and UID of the message. # localize_date method This method converts a valid RFC 822 message date to a local date and time. ## Syntax ```text def localize_date(date_time: str) -> str: ... ``` ## Remarks This method can be used to convert an RFC 822 date and time string to the corresponding local date and time. NOTE: Dates will be returned in the format: "MM/dd/yyyy hh:mm:ss". # query_message_size method This method returns the size in bytes of the current message. ## Syntax ```text def query_message_size() -> int: ... ``` ## Remarks This method queries the server for the size in bytes of the message specified by [message_number](#message_number-property). The method returns the size (in bytes) of the message. If the class is not connected, or [message_number](#message_number-property) does not contain a valid message number, the return value is *0*. Otherwise, it returns the size of the mail message (including headers) as reported by the server. The [mail_server](#mail_server-property) is asked about the size of the message only if the [message_number](#message_number-property) property has changed. If [message_number](#message_number-property) has not changed, the class returns a cached value. # query_message_uid method This method returns the unique identifier (UID) of the message as specified by the server. ## Syntax ```text def query_message_uid() -> str: ... ``` ## Remarks This method returns the unique identifier (UID) of the message specified by [message_number](#message_number-property). If the class is not connected, or [message_number](#message_number-property) does not contain a valid message number, the return value of this method is an empty string. Otherwise, it returns the UID of the mail message as reported by the server. The [mail_server](#mail_server-property) is asked about the UID of the message only if the [message_number](#message_number-property) property has changed. If [message_number](#message_number-property) has not changed, the class returns a cached value. # query_total_size method This method returns the cumulative size in bytes of messages in the mailbox (including headers). ## Syntax ```text def query_total_size() -> int: ... ``` ## Remarks This method returns the cumulative size in bytes of messages in the mailbox (including headers). When the class is not connected to the server, the return value of this method is *0*. When connected, it returns the cumulative size of all the messages in the mail box as reported by the POP server. # reset method This method will reset the class. ## Syntax ```text def reset() -> None: ... ``` ## Remarks This method will reset the class's properties to their default values. # retrieve method This method retrieves a message specified by MessageNumber from the server. ## Syntax ```text def retrieve() -> None: ... ``` ## Remarks This method is used to retrieve a message specified by [message_number](#message_number-property) from the server. It asks the [mail_server](#mail_server-property) to retrieve the message specified by [message_number](#message_number-property). The message headers will arrive in the [on_header](#on_header-event) event, and the message text will arrive in the [on_transfer](#on_transfer-event) event. The [max_lines](#max_lines-property) property defines the number of lines retrieved. **Example. Connect and Retrieve Messages:** ```text POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 POPControl.Retrieve() ``` # retrieve_headers method This method retrieves headers for a message specified by MessageNumber . ## Syntax ```text def retrieve_headers() -> None: ... ``` ## Remarks Calling this method will retrieve the headers for the message specified by the [message_number](#message_number-property) property. The message headers will be provided by the [on_header](#on_header-event) event and also stored in the message_headers property. **Example. Connect and Retrieve Message Headers:** ```text POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 POPControl.RetrieveHeaders() ``` # send_command method This method sends the exact command directly to the server. ## Syntax ```text def send_command(command: str) -> None: ... ``` ## Remarks This method sends the command specified by *command* to the server exactly as it is provided. Use this method to send additional or custom commands directly to the server. After calling this method, check the [last_reply](#last_reply-property) property or monitor the [on_pi_trail](#on_pi_trail-event) event to obtain the server's response. # verify_signature method Verifies the signature of the current message. ## Syntax ```text def verify_signature() -> None: ... ``` ## Remarks This method verifies the signature of the message. The message will be verified using the keys specified in signer_keys. Before verification begins the class will fire the [on_signature_info](#on_signature_info-event) event with information about the signature including the key used to sign the message. Within this event you may use the information available to load the correct key into signer_keys. By default, if the signature is not valid the class fails with an error. The configuration setting [RequireValidSignature](#RequireValidSignature) may be set to False to disable this requirement. When [RequireValidSignature](#RequireValidSignature) is set to False, the *Status* parameter of the [on_verification_status](#on_verification_status-event) event should be checked to determine the result of the operation. # on_connection_status event Fired to indicate changes in the connection state. ## Syntax ```text class PPOPConnectionStatusEventParams(object): @property def connection_event() -> str: ... @property def status_code() -> int: ... @property def description() -> str: ... # In class PPOP: @property def on_connection_status() -> Callable[[PPOPConnectionStatusEventParams], None]: ... @on_connection_status.setter def on_connection_status(event_hook: Callable[[PPOPConnectionStatusEventParams], None]) -> None: ... ``` ## Remarks This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake. The *connection_event* parameter indicates the type of connection event. Values may include the following: | | | | --- | --- | | | Firewall connection complete. | | | Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). | | | Remote host connection complete. | | | Remote host disconnected. | | | SSL or S/Shell connection broken. | | | Firewall host disconnected. | *status_code* has the error code returned by the Transmission Control Protocol (TCP)/IP stack. *description* contains a description of this code. The value of *status_code* is equal to the value of the error. # on_end_transfer event This event is fired when the message completes transferring. ## Syntax ```text class PPOPEndTransferEventParams(object): @property def direction() -> int: ... # In class PPOP: @property def on_end_transfer() -> Callable[[PPOPEndTransferEventParams], None]: ... @on_end_transfer.setter def on_end_transfer(event_hook: Callable[[PPOPEndTransferEventParams], None]) -> None: ... ``` ## Remarks The on_end_transfer event is fired when the message body completes transferring from the server to the local host. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. # on_error event Fired when information is available about errors during data delivery. ## Syntax ```text class PPOPErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class PPOP: @property def on_error() -> Callable[[PPOPErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[PPOPErrorEventParams], 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](#ppop-errors) section. # on_header event This event is fired for every message header being retrieved. ## Syntax ```text class PPOPHeaderEventParams(object): @property def field() -> str: ... @property def value() -> str: ... # In class PPOP: @property def on_header() -> Callable[[PPOPHeaderEventParams], None]: ... @on_header.setter def on_header(event_hook: Callable[[PPOPHeaderEventParams], None]) -> None: ... ``` ## Remarks The *field* parameter contains the name of the header (in the same case as it is delivered). The *value* parameter contains the header contents. If the header line being retrieved is a continuation header line, then the *field* parameter contains "" (empty string). # on_key_passphrase event Fired if the passphrase of current key is incorrect or empty. ## Syntax ```text class PPOPKeyPassphraseEventParams(object): @property def user_id() -> str: ... @property def key_id() -> str: ... @property def fingerprint() -> str: ... @property def passphrase() -> str: ... @passphrase.setter def passphrase(value) -> None: ... # In class PPOP: @property def on_key_passphrase() -> Callable[[PPOPKeyPassphraseEventParams], None]: ... @on_key_passphrase.setter def on_key_passphrase(event_hook: Callable[[PPOPKeyPassphraseEventParams], None]) -> None: ... ``` ## Remarks This event fires when the passphrase for the key is required. The passphrase must be specified before operations requiring the secret key are attempted. The passphrase may be supplied by setting the *Passphrase* parameter in this event, or by specifying the [key_passphrase](#key_passphrase-property) property before attempting the operation. The passphrase is required when using the following methods in KeyMgr: - add_user_id - sign_user_id - change_expiration_date - change_passphrase When using the OpenPGP class, or an email-based class, the following methods require a passphrase for the key: - [decrypt](#decrypt-method) - sign - sign_and_encrypt *UserId* holds the user Id of the key the passphrase is required for. The *UserId* format is: ```text FirstName LastName (Comment) ``` Not all values are required when selecting or generating a key, but at least FirstName or Email are required. Note that for OpenPGP v6, a key may be created with or without a *UserId*, as the field is optional. If a key was created without a *UserId*, the key's *Fingerprint* can be used as its identifier instead. *KeyId* is the hex-encoded, 4-byte or 8-byte Id of the key the passphrase is required for. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's *Fingerprint*. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's *Fingerprint* instead. For instance: ```text 5E70662EA810E768 ``` *Fingerprint* holds the hex-encoded, 20-byte fingerprint of the key the passphrase is required for. This is in the form: ```text 5E70662EA810E768391A2FE8F7B7D49C89C9D7B1 ``` # on_launch_browser event Fires before launching a browser with the authorization URL. ## Syntax ```text class PPOPLaunchBrowserEventParams(object): @property def url() -> str: ... @url.setter def url(value) -> None: ... @property def command() -> str: ... @command.setter def command(value) -> None: ... # In class PPOP: @property def on_launch_browser() -> Callable[[PPOPLaunchBrowserEventParams], None]: ... @on_launch_browser.setter def on_launch_browser(event_hook: Callable[[PPOPLaunchBrowserEventParams], None]) -> None: ... ``` ## Remarks When the client_profile property is set to ocpApplication and get_authorization is called, the class will fire this event with the *command*, which will be executed by the class. The *url* parameter will be the authorization URL that the user will be directed to authenticate. Within this event, you may override the current value of either *command* or *url* and provide your own value. If *command* is set to an empty string, the class will not attempt to launch the browser and instead you will be responsible for directing the user to the authorization URL specified by the URL parameter. If *command* is not empty, the URL will be appended to the end. In Windows, ShellExecute is used to execute *command*, which limits the verbs available for use in *command* to: - edit - explore - find - open - print # on_log event Fired once for each log message. ## Syntax ```text class PPOPLogEventParams(object): @property def log_level() -> int: ... @property def message() -> str: ... @property def log_type() -> str: ... # In class PPOP: @property def on_log() -> Callable[[PPOPLogEventParams], None]: ... @on_log.setter def on_log(event_hook: Callable[[PPOPLogEventParams], None]) -> None: ... ``` ## Remarks This event is fired once for each log message generated by the class. The verbosity is controlled by the [LogLevel](#LogLevel) setting. *log_level* indicates the level of message. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). *message* is the log entry. *log_type* identifies the type of log entry. Possible values are as follows: - "Info" - "RequestHeaders" - "ResponseHeaders" - "RequestBody" - "ResponseBody" - "ProxyRequest" - "ProxyResponse" - "FirewallRequest" - "FirewallResponse" # on_message_list event This event is fired for every message listed by ListMessageSizes and/or ListMessageUIDs . ## Syntax ```text class PPOPMessageListEventParams(object): @property def message_number() -> int: ... @property def message_uid() -> str: ... @property def message_size() -> int: ... # In class PPOP: @property def on_message_list() -> Callable[[PPOPMessageListEventParams], None]: ... @on_message_list.setter def on_message_list(event_hook: Callable[[PPOPMessageListEventParams], None]) -> None: ... ``` ## Remarks When [list_message_sizes](#list_message_sizes-method) is called, *message_size* is valid, and *message_uid* is always an empty string. When [list_message_ui_ds](#list_message_ui_ds-method) is called, *message_uid* is valid, and *message_size* is 0. # on_pi_trail event This event traces the commands sent to the mail server, and the respective replies. ## Syntax ```text class PPOPPITrailEventParams(object): @property def direction() -> int: ... @property def message() -> str: ... # In class PPOP: @property def on_pi_trail() -> Callable[[PPOPPITrailEventParams], None]: ... @on_pi_trail.setter def on_pi_trail(event_hook: Callable[[PPOPPITrailEventParams], None]) -> None: ... ``` ## Remarks The on_pi_trail event is useful for debugging purposes. It shows all of the interaction between the client and the server, line by line, except for message header and body transfers. The *message* parameter contains the full text of the message. The *direction* parameter shows the originator of the message: | | | | --- | --- | | 0 (Client) | The message originates from the client. | | 1 (Server) | The message originates from the server. | | 2 (Info) | The message is an informative message originating from the client software (the class code). | # on_progress event Fired as progress is made. ## Syntax ```text class PPOPProgressEventParams(object): @property def bytes_processed() -> int: ... @property def percent_processed() -> int: ... # In class PPOP: @property def on_progress() -> Callable[[PPOPProgressEventParams], None]: ... @on_progress.setter def on_progress(event_hook: Callable[[PPOPProgressEventParams], 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. # on_recipient_info event Fired for each recipient key of the encrypted message. ## Syntax ```text class PPOPRecipientInfoEventParams(object): @property def key_id() -> str: ... @property def fingerprint() -> str: ... @property def public_key_algorithm() -> str: ... # In class PPOP: @property def on_recipient_info() -> Callable[[PPOPRecipientInfoEventParams], None]: ... @on_recipient_info.setter def on_recipient_info(event_hook: Callable[[PPOPRecipientInfoEventParams], None]) -> None: ... ``` ## Remarks This event fires when the [decrypt](#decrypt-method) or [decrypt_and_verify_signature](#decrypt_and_verify_signature-method) method is called. *KeyId* is the hex-encoded 4- or 8-byte Id of the key used to encrypt the message. If a subkey was used to encrypt the message this will be the Id of that subkey. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's *Fingerprint*. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's *Fingerprint* instead. For instance: ```text 5E70662EA810E768 ``` *Fingerprint* holds the hex-encoded, 20-byte fingerprint of the key. This is in the form: ```text 5E70662EA810E768391A2FE8F7B7D49C89C9D7B1 ``` The *KeyId* and *Fingerprint* parameters can be used to identify the correct key to specify in the **Key*** properties. The **Key*** properties can be set from within this event as this event fires directly before the decryption process begins. It is recommended to use the *Fingerprint* to identify the correct key, as it is possible for different keys to have the same *KeyId*. *PublicKeyAlgorithm* is the algorithm of the public key used to encrypt the message. Possible values are: - *RSA* - *DSA* - *ECDSA* - *EdDSA* - *Ed25519* - *Ed448* - *RSA-Legacy* - *ECDH* (Subkeys only) - *X25519* (Subkeys only) - *X448* (Subkeys only) - *ML-KEM* (Subkeys only; LibrePGP/GnuPG) - *ML-KEM-768+X25519* (Subkeys only) - *ML-KEM-1024+X448* (Subkeys only) # on_signature_info event Fired during verification of the signed message. ## Syntax ```text class PPOPSignatureInfoEventParams(object): @property def key_id() -> str: ... @property def fingerprint() -> str: ... @property def signing_algorithm() -> str: ... @property def public_key_algorithm() -> str: ... # In class PPOP: @property def on_signature_info() -> Callable[[PPOPSignatureInfoEventParams], None]: ... @on_signature_info.setter def on_signature_info(event_hook: Callable[[PPOPSignatureInfoEventParams], None]) -> None: ... ``` ## Remarks This event fires when the [verify_signature](#verify_signature-method) or [decrypt_and_verify_signature](#decrypt_and_verify_signature-method) method is called. It provides information about the signature of the message. *KeyId* is the hex-encoded 4- or 8-byte Id of the key used to sign the message. If a subkey was used to sign the message this will be the Id of that subkey. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's *Fingerprint*. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's *Fingerprint* instead. For instance: ```text 5E70662EA810E768 ``` *Fingerprint* holds the hex-encoded, 20-byte fingerprint of the key. This is in the form: ```text 5E70662EA810E768391A2FE8F7B7D49C89C9D7B1 ``` The *KeyId* and *Fingerprint* parameters can be used to identify the correct key to specify in the **SignerKey*** properties. The **SignerKey*** properties can be set from within this event as this event fires directly before the verification process begins. It is recommended to use the *Fingerprint* to identify the correct key, as it is possible for different keys to have the same *KeyId*. *SigningAlgorithm* describes the hash algorithm used when the message was originally signed. This value is applicable only to the message signature, not the key used to sign the message. Possible values are: - *SHA1* - *MD5* - *SHA256* - *SHA384* - *SHA512* - *SHA224* - *RIPEMD160* - *SHA3-256* - *SHA3-512* *PublicKeyAlgorithm* is the algorithm of the public key used to sign the message. Possible values are: - *RSA* - *DSA* - *ECDSA* - *EdDSA* - *Ed25519* - *Ed448* - *RSA-Legacy* - *ML-DSA-65+Ed25519* - *ML-DSA-87+Ed448* - *ECDH* (Subkeys only) - *X25519* (Subkeys only) - *X448* (Subkeys only) # on_ssl_server_authentication event Fired after the server presents its certificate to the client. ## Syntax ```text class PPOPSSLServerAuthenticationEventParams(object): @property def cert_encoded() -> bytes: ... @property def cert_subject() -> str: ... @property def cert_issuer() -> str: ... @property def status() -> str: ... @property def accept() -> bool: ... @accept.setter def accept(value) -> None: ... # In class PPOP: @property def on_ssl_server_authentication() -> Callable[[PPOPSSLServerAuthenticationEventParams], None]: ... @on_ssl_server_authentication.setter def on_ssl_server_authentication(event_hook: Callable[[PPOPSSLServerAuthenticationEventParams], None]) -> None: ... ``` ## Remarks During this event, the client can decide whether or not to continue with the connection process. The *accept* parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue. When *accept* is False, *status* shows why the verification failed (otherwise, *status* contains the string *OK*). If it is decided to continue, you can override and accept the certificate by setting the *accept* parameter to True. # on_ssl_status event Fired when secure connection progress messages are available. ## Syntax ```text class PPOPSSLStatusEventParams(object): @property def message() -> str: ... # In class PPOP: @property def on_ssl_status() -> Callable[[PPOPSSLStatusEventParams], None]: ... @on_ssl_status.setter def on_ssl_status(event_hook: Callable[[PPOPSSLStatusEventParams], None]) -> None: ... ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # on_start_transfer event This event is fired when the message starts transferring. ## Syntax ```text class PPOPStartTransferEventParams(object): @property def direction() -> int: ... # In class PPOP: @property def on_start_transfer() -> Callable[[PPOPStartTransferEventParams], None]: ... @on_start_transfer.setter def on_start_transfer(event_hook: Callable[[PPOPStartTransferEventParams], None]) -> None: ... ``` ## Remarks The on_start_transfer event is fired when the message body starts transferring from the server to the local host. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. # on_status event Shows the progress of the operation. ## Syntax ```text class PPOPStatusEventParams(object): @property def message() -> str: ... # In class PPOP: @property def on_status() -> Callable[[PPOPStatusEventParams], None]: ... @on_status.setter def on_status(event_hook: Callable[[PPOPStatusEventParams], None]) -> None: ... ``` ## Remarks The event is fired for informational and logging purposes only. It may be used to track the progress of an operation. The level of detail is controlled by the [LogLevel](#LogLevel) setting. # on_transfer event This event is fired when the message is transferred from MailServer . ## Syntax ```text class PPOPTransferEventParams(object): @property def direction() -> int: ... @property def bytes_transferred() -> int: ... @property def percent_done() -> int: ... @property def text() -> bytes: ... @property def eol() -> bool: ... # In class PPOP: @property def on_transfer() -> Callable[[PPOPTransferEventParams], None]: ... @on_transfer.setter def on_transfer(event_hook: Callable[[PPOPTransferEventParams], None]) -> None: ... ``` ## Remarks The *text* parameter contains the portion of the message data to be retrieved. The *bytes_transferred* parameter contains the number of bytes transferred since the beginning of the message, including header bytes. At the end of transmission (i.e., when the last on_transfer event is fired), *bytes_transferred* equals the value of the [query_message_size](#query_message_size-method) method. The on_transfer event is fired for every line of the message. For complete lines, there is no terminating newline at the end of the *text* parameter, and *eol* is True. The *eol* parameter is False when a line is broken (usually for being too long). A faster way to retrieve a message is to assign a value to the local_file property and use the on_transfer event to check the progress rather than to get the actual data. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. The *PercentDone* parameter shows the progress of the transfer in the corresponding direction. If *PercentDone* can not be calculated the value will be -1. NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance. NOTE: For the *percent_done* parameter value to be correct, the [GetMessageSize](#GetMessageSize) configuration setting must be set to True. # on_verification_status event Fired after verification of the signed message. ## Syntax ```text class PPOPVerificationStatusEventParams(object): @property def key_id() -> str: ... @property def fingerprint() -> str: ... @property def status() -> int: ... # In class PPOP: @property def on_verification_status() -> Callable[[PPOPVerificationStatusEventParams], None]: ... @on_verification_status.setter def on_verification_status(event_hook: Callable[[PPOPVerificationStatusEventParams], None]) -> None: ... ``` ## Remarks This event fires when [verify_signature](#verify_signature-method) or [decrypt_and_verify_signature](#decrypt_and_verify_signature-method) is called. It provides information about the result. *KeyId* is the hex-encoded 4- or 8-byte Id of the key used to sign the message. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's *Fingerprint*. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's *Fingerprint* instead. For instance: ```text 5E70662EA810E768 ``` *Fingerprint* holds the hex-encoded, 20-byte fingerprint of the key. This is in the form: ```text 5E70662EA810E768391A2FE8F7B7D49C89C9D7B1 ``` *Status* holds the result of the operation. Possible values are: | | | | --- | --- | | 0 | Verification succeeded | | 1 | Verification failed | | 2 | The required key could not be found | | 3 | Verification succeeded but the key is expired. | # PPOP 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. ### PPOP Config Settings **Comment**: The OpenPGP message comment.OpenPGP messages may contain a comment. This setting holds the comment (if any) after calling [decrypt](#decrypt-method), [decrypt_and_verify_signature](#decrypt_and_verify_signature-method), or [verify_signature](#verify_signature-method). **LogLevel**: Specifies the level of detail that is logged.This setting controls the level of detail that is logged through the [on_status](#on_status-event) event. Possible values are: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data is logged. | | 3 (Debug) | Debug data is logged. | **ProcessAttachments**: Whether or not to process attachments.This setting controls whether attachments are processed when calling [decrypt](#decrypt-method), [decrypt_and_verify_signature](#decrypt_and_verify_signature-method), or [verify_signature](#verify_signature-method). When set to True if an attachment is a valid OpenPGP message it will be decrypted and/or verified. If it is not a valid OpenPGP message it will be left as is. When set to False the attachments are not processed. The default value is True. **RequireValidSignature**: Specifies if an invalid signature is considered an error condition.By default, if the signature is not valid the class fails with an error. This setting may be set to False to disable this requirement. When False, the *Status* parameter of the [on_verification_status](#on_verification_status-event) event should be checked to determine the result of the operation. The default value is True. **SymmetricPassphrase**: The password used for symmetric encryption or decryption.This setting specifies the passphrase when using symmetric encryption. If a value is provided, symmetric encryption/decryption will be attempted. In this case no keys are used for either encryption or decryption. Only encrypt and [decrypt](#decrypt-method) are valid operations when a value is set. sign, sign_and_encrypt, [verify_signature](#verify_signature-method), and [decrypt_and_verify_signature](#decrypt_and_verify_signature-method) are not valid operations when using this option. **VerifyClearTextSignatureWithCache**: Whether the cleartext message is cached in memory when verifying a cleartext signature.When verifying a cleartext signature, this configuration setting determines whether the cleartext message is cached in memory. This config is *True* by default, and **must** be true when verifying an OpenPGP v6 cleartext signature. When enabled, the cleartext portion will be cached in memory until the signature is fully processed. NOTE: If the signature is known to be an OpenPGP v4 cleartext signature beforehand (i.e., signed with a v4 key), this config may be set to *False*. However, if this config is disabled, the class will be unable to verify OpenPGP v6 cleartext signatures. In this case, the class will throw an exception when calling [verify_signature](#verify_signature-method) or [decrypt_and_verify_signature](#decrypt_and_verify_signature-method). **VersionHeader**: The Version header value in the ASCII armored OpenPGP message.This setting specifies the Version header value included in the ASCII armored OpenPGP message. This may be set before calling encrypt, sign, or sign_and_encrypt. The default value is "IPWorks PGP 2026". This setting will be populated after calling [decrypt](#decrypt-method), [verify_signature](#verify_signature-method), or [decrypt_and_verify_signature](#decrypt_and_verify_signature-method). ### POP Config Settings **AuthorizationIdentity**: The value to use as the authorization identity when SASL authentication is used. When [auth_mechanism](#auth_mechanism-property) is set to amSASLPlain or amSASLDigestMD5, this configuration setting may specify an authorization identity to be used when authenticating. **AutoDecodeSubject**: Instructs the class to automatically decode message subjects.Subjects that have been Quoted-Printable or Base64 encoded are automatically decoded when this configuration setting is True (default). Only subjects in the format "=?iso-8859-1?Q?data?=" will be correctly decoded. **GetMessageSize**: Whether to poll the server for the message size prior to retrieving it.By default, this value is False. When set to True, the class will retrieve the message size from the server before downloading it and the *PercentDone* parameter of the [on_transfer](#on_transfer-event) event will be populated. When this value is False (default), the *PercentDone* parameter of the [on_transfer](#on_transfer-event) event will not be updated and will evaluate to -1. **MaxLineLength**: The maximum expected length for message lines.Normally, internet mail message lines are up to 80 bytes long; however, different mail systems might use other values. Change the value of this property if you are expecting longer lines. ### TCPClient Config Settings **ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use [timeout](#timeout-property) for establishing a connection and transmitting/receiving data. **FirewallAutoDetect**: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classes that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned. NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting. **FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error. NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by classes that do not directly expose Firewall properties. **FirewallType**: Determines the type of firewall to connect through.Possible values are as follows: | | | | --- | --- | | 0 | No firewall (default setting). | | 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error. NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. **Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action. **LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [local_host](#local_host-property) setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface. If the class is connected, the [local_host](#local_host-property) setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). **LocalPort**: The port in the local host where the class binds. This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established. local_port cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems. **MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an eol string. If an eol string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the on_data_in event is fired with the *EOL* parameter set to True, and the buffer is reset. If no eol is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the on_data_in event is fired with the *EOL* parameter set to False, and the buffer is reset. The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes. **MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. **ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: *www.google.com;www.example.com* **TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets. NOTE: This value is not applicable in Java. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **UseIPv6**: Whether to use IPv6.When set to *0* (default), the class will use IPv4 exclusively. When set to *1*, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 only | | 1 | IPv6 only | | 2 | IPv6 with IPv4 fallback | **UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1. ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [ssl_provider](#ssl_provider-property) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes. When enabled, SSL packet logs are output using the [on_ssl_status](#on_ssl_status-event) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if [ssl_provider](#ssl_provider-property) is set to *Platform*. **OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL. The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL. The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences: -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL. The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH". **OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL. By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG. **ReuseSSLSession**: Determines if the SSL session is reused. If set to True, the class will reuse the context if and only if the following criteria are met: - The target host name is the same. - The system cache entry has not expired (default timeout is 10 hours). - The application process that calls the function is the same. - The logon session is the same. - The instance of the class is the same. **SSLCACertFilePaths**: The paths to CA certificate files on Unix/Linux.This configuration setting specifies the paths on disk to CA certificate files on Unix/Linux. The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates. The default value is as follows: */etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem* **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [ssl_provider](#ssl_provider-property) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the ssl_cert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the class will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error. When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the class fails with an error. When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated. NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [on_ssl_status](#on_ssl_status-event) event. Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when ssl_authenticate_clients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation. By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the class will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when [ssl_provider](#ssl_provider-property) is set to *Platform* include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); ``` Possible values when [ssl_provider](#ssl_provider-property) is set to *Platform* include the following: - CALG_3DES - CALG_3DES_112 - CALG_AES - CALG_AES_128 - CALG_AES_192 - CALG_AES_256 - CALG_AGREEDKEY_ANY - CALG_CYLINK_MEK - CALG_DES - CALG_DESX - CALG_DH_EPHEM - CALG_DH_SF - CALG_DSS_SIGN - CALG_ECDH - CALG_ECDH_EPHEM - CALG_ECDSA - CALG_ECMQV - CALG_HASH_REPLACE_OWF - CALG_HUGHES_MD5 - CALG_HMAC - CALG_KEA_KEYX - CALG_MAC - CALG_MD2 - CALG_MD4 - CALG_MD5 - CALG_NO_SIGN - CALG_OID_INFO_CNG_ONLY - CALG_OID_INFO_PARAMETERS - CALG_PCT1_MASTER - CALG_RC2 - CALG_RC4 - CALG_RC5 - CALG_RSA_KEYX - CALG_RSA_SIGN - CALG_SCHANNEL_ENC_KEY - CALG_SCHANNEL_MAC_KEY - CALG_SCHANNEL_MASTER_HASH - CALG_SEAL - CALG_SHA - CALG_SHA1 - CALG_SHA_256 - CALG_SHA_384 - CALG_SHA_512 - CALG_SKIPJACK - CALG_SSL2_MASTER - CALG_SSL3_MASTER - CALG_SSL3_SHAMD5 - CALG_TEK - CALG_TLS1_MASTER - CALG_TLS1PRF Example values when [ssl_provider](#ssl_provider-property) is set to *Internal*include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA"); ``` Possible values when [ssl_provider](#ssl_provider-property) is set to *Internal* include the following: - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 - TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA - TLS_DHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA - TLS_DHE_DSS_WITH_AES_256_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_DES_CBC_SHA - TLS_DHE_RSA_WITH_DES_CBC_SHA - TLS_DHE_DSS_WITH_DES_CBC_SHA - TLS_RSA_WITH_RC4_128_MD5 - TLS_RSA_WITH_RC4_128_SHA When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength). **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols. Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values: | | | | --- | --- | | TLS1.3 | 12288 (Hex 3000) | | TLS1.2 | 3072 (Hex C00) (Default - Client and Server) | | TLS1.1 | 768 (Hex 300) (Default - Client) | | TLS1 | 192 (Hex C0) (Default - Client) | | SSL3 | 48 (Hex 30) | | SSL2 | 12 (Hex 0C) | Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases. **SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:** By default when TLS 1.3 is enabled, the class will first try to use the platform TLS 1.3 implementation when the [ssl_provider](#ssl_provider-property) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. In editions that are designed to run on Windows, [ssl_provider](#ssl_provider-property) can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version. If set to *1* (Platform provider), please be aware of the following notes: - The platform provider is available only on Windows 11/Windows Server 2022 and up. - [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported. - If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions. **SSLEnabledProtocols: SSL2 and SSL3 Notes: ** SSL 2.0 and 3.0 are not supported by the class when the [ssl_provider](#ssl_provider-property) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [ssl_provider](#ssl_provider-property) needs to be set to platform. **SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *False* by default, but it can be set to *True* to enable the extension. This configuration setting is applicable only when [ssl_provider](#ssl_provider-property) is set to *Internal*. **SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event) event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event) event. This includes the leaf certificate, any intermediate certificate, and the root certificate. **SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when [ssl_provider](#ssl_provider-property) is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions: | | | | --- | --- | | 0x00000001 | Ignore time validity status of certificate. | | 0x00000002 | Ignore time validity status of CTL. | | 0x00000004 | Ignore non-nested certificate times. | | 0x00000010 | Allow unknown certificate authority. | | 0x00000020 | Ignore wrong certificate usage. | | 0x00000100 | Ignore unknown certificate revocation status. | | 0x00000200 | Ignore unknown CTL signer revocation status. | | 0x00000400 | Ignore unknown certificate authority revocation status. | | 0x00000800 | Ignore unknown root revocation status. | | 0x00008000 | Allow test root certificate. | | 0x00004000 | Trust test root certificate. | | 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). | This functionality is currently not available when the provider is OpenSSL. **SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [ssl_provider](#ssl_provider-property) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class fails with an error. The format of this value is a comma-separated list of hash-signature combinations. For instance: ```csharp component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); ``` The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*. To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. **TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC. The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*. When using TLS 1.2 and [ssl_provider](#ssl_provider-property) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported: - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) **TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server. The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting. NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group. In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" - "ffdhe_6144" - "ffdhe_8192" **TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following: - "ed25519" (default) - "ed448" (default) - "ecdsa_secp256r1_sha256" (default) - "ecdsa_secp384r1_sha384" (default) - "ecdsa_secp521r1_sha512" (default) - "rsa_pkcs1_sha256" (default) - "rsa_pkcs1_sha384" (default) - "rsa_pkcs1_sha512" (default) - "rsa_pss_sha256" (default) - "rsa_pss_sha384" (default) - "rsa_pss_sha512" (default) The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3. **TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" (default) - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" (default) - "ffdhe_6144" (default) - "ffdhe_8192" (default) - "mlkem_512" (default) - "mlkem_768" (default) - "mlkem_1024" (default) - "x25519_mlkem_768" (default) - "secp256r1_mlkem_768" (default) Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported: - Windows Server 2025 - Windows 11 24H2 - Windows 11 25H2 ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [timeout](#timeout-property) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (UDP) ports. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. ### 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](#do_events-method) 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. # PPOP Errors ### POP Errors | | | | --- | --- | | 116 | [mail_port](#mail_port-property) cannot be zero. Please specify a valid service port number. | | 118 | Firewall error. Error message contains detailed description. | | 171 | POP protocol error. Description contains the server reply. | | 172 | Error communicating with server. Error text is attached. | | 173 | Please specify a valid [mail_server](#mail_server-property). | | 174 | Busy executing current method. | The class may also return one of the following error codes, which are inherited from other classes. ### TCPClient Errors | | | | --- | --- | | 100 | You cannot change the remote_port at this time. A connection is in progress. | | 101 | You cannot change the remote_host (Server) at this time. A connection is in progress. | | 102 | The remote_host address is invalid (0.0.0.0). | | 104 | Already connected. If you want to reconnect, close the current connection first. | | 106 | You cannot change the local_port at this time. A connection is in progress. | | 107 | You cannot change the [local_host](#local_host-property) at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | remote_port cannot be zero. Please specify a valid service port number. | | 117 | You cannot change the UseConnection option while the class is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 302 | Could not open file. | | 434 | Unable to convert string to selected CodePage. | | 1105 | Already connecting. If you want to reconnect, close the current connection first. | | 1117 | You need to connect first. | | 1119 | You cannot change the LocalHost at this time. A connection is in progress. | | 1120 | Connection dropped by remote host. | ### SSL Errors | | | | --- | --- | | 270 | Cannot load specified security library. | | 271 | Cannot open certificate store. | | 272 | Cannot find specified certificate. | | 273 | Cannot acquire security credentials. | | 274 | Cannot find certificate chain. | | 275 | Cannot verify certificate chain. | | 276 | Error during handshake. | | 280 | Error verifying certificate. | | 281 | Could not find client certificate. | | 282 | Could not find server certificate. | | 283 | Error encrypting data. | | 284 | Error decrypting data. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). | ### OpenPGP Errors | | | | --- | --- | | 101 | Cannot decode ASCII Armor data. | | 102 | Unknown ASCII Armor data type. | | 103 | Checksum failed. | | 104 | Unknown ASCII Armor header. | | 105 | Cannot decode PGP packet. | | 106 | Cannot encode PGP packet. | | 107 | Unknown PGP packet tag. | | 108 | Unsupported version. | | 109 | Unsupported algorithm. | | 110 | Unknown subpacket. | | 111 | Internal error. | | 112 | Feature not supported. | | 113 | Secret data was not encrypted. | | 114 | Cannot find the key. | | 115 | Error reading file. | | 116 | Error writing file. | | 117 | Error reading key. | | 118 | Error writing key. | | 119 | Cannot verify signature. | | 120 | Cannot create signature. | | 121 | Invalid UserId. | | 122 | Invalid passphrase. | | 123 | Data encryption failed. | | 124 | Error creating key. | | 125 | Unsupported symmetric algorithm. | | 126 | Unsupported hash. | | 127 | Unsupported compression algorithm. | | 128 | Invalid key usage. | | 129 | Component is busy. | | 130 | Error decrypting data. | | 131 | Data is not compressed. | | 132 | Error decompressing data. | | 133 | Error compressing data. | | 134 | Unsupported signature. | | 135 | Failed to overwrite file. | | 141 | No input. | | 142 | Signing was required, but the message was not signed. | | 143 | Encryption was required, but the message was not encrypted. | | 146 | No data integrity packet was found (MDC), but one was required. | | 200 | Out of memory. |