# FTP Class

The FTP Class can be used to transfer files to and from FTP servers using the FTP protocol.

## Syntax

```text
class ipworksssl.FTP
```

## Remarks

The FTP Class supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the [on_ssl_server_authentication](#on_ssl_server_authentication-event) event allows you to check the server identity and other security attributes. The [on_ssl_status](#on_ssl_status-event) event provides information about the SSL handshake. Additional SSL-related settings are also supported through the [config](#config-method) method.

The FTP Class implements a standard FTP client as specified in RFC 959 and RFC 1579 with the added option of SSL security (RFC 2228) in both the protocol and data channels.

The first step in using the class is specifying the [remote_host](#remote_host-property), [user](#user-property) and [password](#password-property). The file to upload to or download from is given by the [remote_file](#remote_file-property) property. The file to download to or upload from is specified by [local_file](#local_file-property). The current path in the server is set by calling [change_remote_path](#change_remote_path-method). The [passive](#passive-property) property is especially useful if the client is behind a firewall, which inhibits incoming connections to higher ports.

If [local_file](#local_file-property) is set to something other than an empty string, then files are received in [local_file](#local_file-property), and otherwise data are received through the [on_transfer](#on_transfer-event) event. [on_start_transfer](#on_start_transfer-event) and [on_end_transfer](#on_end_transfer-event) are fired at the beginning and end of transmission.

The [on_pi_trail](#on_pi_trail-event) event traces the interaction between the client and the server (the FTP protocol interface connection).

Directory listings are received through the [on_dir_list](#on_dir_list-event) event.

## Property List

*The following is the full list of the properties of the class with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [account](#account-property) | The property includes the user account needed to log in. |
| [connected](#connected-property) | Whether the class is connected. |
| [dir_list_count](#dir_list_count-property) | The number of records in the DirList arrays. |
| [dir_list_entry](#dir_list_entry-property) | This property contains the raw entry as received from the server. |
| [dir_list_file_name](#dir_list_file_name-property) | This property shows the file name in the last directory listing. |
| [dir_list_file_size](#dir_list_file_size-property) | This property shows the file size in the last directory listing. |
| [dir_list_file_time](#dir_list_file_time-property) | This property shows the file time in the last directory listing. |
| [dir_list_is_dir](#dir_list_is_dir-property) | This property specifies whether entries in the last directory listing are directories. |
| [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. |
| [last_reply](#last_reply-property) | This property indicates the last reply received from the server. |
| [local_file](#local_file-property) | This is the path to a local file for download or upload. If the file exists, it is overwritten. |
| [local_host](#local_host-property) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| [overwrite](#overwrite-property) | This indicates whether or not the class should overwrite files during transfer. |
| [passive](#passive-property) | This controls whether or not to direct the server into a passive mode. It is recommended if behind a firewall. |
| [password](#password-property) | This is the password used to log in. |
| [remote_file](#remote_file-property) | This is the name of the remote file for uploading, downloading, and performing other operations. |
| [remote_host](#remote_host-property) | This is the domain name or IP address of the FTP server. |
| [remote_port](#remote_port-property) | This is the port for the FTP service (default is 21). |
| [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_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. |
| [start_byte](#start_byte-property) | This is the byte index in RemoteFile and LocalFile from which to start a transmission. |
| [timeout](#timeout-property) | The timeout for the class. |
| [transfer_mode](#transfer_mode-property) | This property indicates the transfer mode (ASCII or binary). If the value is 0 (default), the initial server mode will be used. |
| [user](#user-property) | This property contains the user identifier to use to log in. |

## Method List

*The following is the full list of the methods of the class with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [abort](#abort-method) | The method aborts the current upload or download. |
| [append](#append-method) | This method appends data from LocalFile to a RemoteFile on an FTP server. |
| [change_remote_path](#change_remote_path-method) | This method changes the current path on the FTP server. |
| [change_transfer_mode](#change_transfer_mode-method) | This method changes the transfer mode for the current connection. |
| [check_file_exists](#check_file_exists-method) | This method returns True if the file specified by RemoteFile exists on the server. |
| [config](#config-method) | Sets or retrieves a configuration setting. |
| [connect](#connect-method) | This method connects to the FTP server without logging in. |
| [delete_file](#delete_file-method) | This method removes a file specified by FileName from an FTP server. |
| [disconnect](#disconnect-method) | This method disconnects from the server without first logging off. |
| [do_events](#do_events-method) | This method processes events from the internal message queue. |
| [download](#download-method) | This method downloads a RemoteFile from an FTP server. |
| [interrupt](#interrupt-method) | This method interrupts the current method. |
| [list_directory](#list_directory-method) | List the current directory specified by ChangeRemotePath on an FTP server. |
| [list_directory_long](#list_directory_long-method) | This method lists extended directory information for the remote path specified by calling ChangeRemotePath . |
| [logoff](#logoff-method) | This method is used to log off from the FTP server by posting a QUIT command. |
| [logon](#logon-method) | This method is used to log on to the FTP RemoteHost using the current User and Password . |
| [make_directory](#make_directory-method) | This method is used to create a directory on the FTP server. |
| [query_file_size](#query_file_size-method) | This returns the size of the file specified by RemoteFile . |
| [query_file_time](#query_file_time-method) | This returns the modified time of the file specified by RemoteFile . |
| [query_remote_path](#query_remote_path-method) | This queries the server for the current path. |
| [remove_directory](#remove_directory-method) | This removes a directory specified by DirName from an FTP server. |
| [rename_file](#rename_file-method) | This changes the name of RemoteFile to NewName . |
| [reset](#reset-method) | This method will reset the class. |
| [send_command](#send_command-method) | This method sends the exact command directly to the server. |
| [store_unique](#store_unique-method) | This method uploads a file with a unique name to an FTP server. |
| [upload](#upload-method) | This method uploads a file specified by LocalFile to an FTP server. |

## 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_dir_list](#on_dir_list-event) | This event is fired when a directory entry is received. |
| [on_end_transfer](#on_end_transfer-event) | This event is fired when a file finishes downloading or uploading. |
| [on_error](#on_error-event) | Fired when information is available about errors during data delivery. |
| [on_pi_trail](#on_pi_trail-event) | This event traces the commands sent to the server, and the respective replies. |
| [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 fires when a file starts downloading or uploading. |
| [on_transfer](#on_transfer-event) | This event is fired during the file download or upload. |

## Config Settings

*The following is a list of config settings for the class with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [ActiveModeIP](#ActiveModeIP) | Allows the specification of the IP address that the server will connect to for active mode connections. |
| [ActiveModePORTAddress](#ActiveModePORTAddress) | Allows the specification of the PORT address value for active mode connections. |
| [AppendToLocalFile](#AppendToLocalFile) | Append downloaded files to a local file. |
| [ApplyFileMaskLocally](#ApplyFileMaskLocally) | Whether to filter the directory listing locally or on the server. |
| [AutoSelectDataIP](#AutoSelectDataIP) | Automatically select the data connection IP. |
| [CalculatePercentDone](#CalculatePercentDone) | Enables or Disables calculating the percent complete for downloads. |
| [CheckTotalEntry](#CheckTotalEntry) | Whether to ignore directory listing total lines. |
| [DILinger](#DILinger) | When set to True, DI connections are terminated gracefully. |
| [DILingerTime](#DILingerTime) | Time in seconds to have the DI connection linger. |
| [FileTimeFormat](#FileTimeFormat) | The format of file time reported by the server. |
| [IgnoreEntries](#IgnoreEntries) | Directory entry data to ignore. |
| [MaskSensitiveData](#MaskSensitiveData) | Masks passwords in logs. |
| [ModeZCompressionLevel](#ModeZCompressionLevel) | Used to specify the level of compression used. |
| [PortRange](#PortRange) | Allows the specification of a port range where the class listens for active mode connections. |
| [PreserveFileTime](#PreserveFileTime) | Attempts to preserve timestamps when transferring files. |
| [RealTimeUpload](#RealTimeUpload) | Enables real time uploading. |
| [RealTimeUploadAgeLimit](#RealTimeUploadAgeLimit) | The age limit in seconds when using RealTimeUpload. |
| [ReusePISSLSessionInDI](#ReusePISSLSessionInDI) | Whether the PI SSL session will be reused for the DI connection. |
| [ReuseSSLSessionInDI](#ReuseSSLSessionInDI) | Whether the SSL session will be reused for the DI connection. |
| [UseClearChannel](#UseClearChannel) | Allows for the Clear Command Channel (CCC) command. |
| [UseClearDataChannel](#UseClearDataChannel) | Allows for the PROT C command. |
| [UseEPSV](#UseEPSV) | Allows extended passive mode. |
| [UseMLSD](#UseMLSD) | Uses listings for machine processing. |
| [UseMLST](#UseMLST) | Uses single file listing for machine processing. |
| [UseModeZ](#UseModeZ) | Allows compression to be used when transferring data. |
| [UseOldAUTHSSL](#UseOldAUTHSSL) | Allows use of the 'AUTH SSL' command instead of 'AUTH TLS'. |
| [UseProtWhenImplicit](#UseProtWhenImplicit) | Sends the PROT P command to the server. |
| [UseRemoteHostAddressForPassive](#UseRemoteHostAddressForPassive) | Instructs the class to use the address specified by RemoteHost when establishing a data connection. |
| [VirtualHostName](#VirtualHostName) | Sends the HOST command to the server. |
| [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. |
| [EnableFallback](#EnableFallback) | Whether to try the other addresses the remote host resolves to when a connection attempt fails. |
| [FallbackTimeout](#FallbackTimeout) | The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled. |
| [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. |

# account property

The property includes the user account needed to log in.

## Syntax

```text
def get_account() -> str: ...
def set_account(value: str) -> None: ...
account = property(get_account, set_account)
```

## Default Value

""

## Remarks

This property contains the user account to use when logging in. Some servers may require an account to [logon](#logon-method) or to access specific privileges, such as uploading or deleting files.

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

# dir_list_count property

The number of records in the DirList arrays.

## Syntax

```text
def get_dir_list_count() -> int: ...
dir_list_count = property(get_dir_list_count, None)
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [dir_list_entry](#dir_list_entry-property)
- [dir_list_file_name](#dir_list_file_name-property)
- [dir_list_file_size](#dir_list_file_size-property)
- [dir_list_file_time](#dir_list_file_time-property)
- [dir_list_is_dir](#dir_list_is_dir-property)

The array indices start at *0* and end at *dir_list_count - 1*.

This property is read-only.

# dir_list_entry property

This property contains the raw entry as received from the server.

## Syntax

```text
def get_dir_list_entry(entry_index: int) -> str: ...
```

## Default Value

""

## Remarks

This property contains the raw entry as received from the server. It is the complete unparsed entry in the directory listing.

The *entry_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [dir_list_count](#dir_list_count-property) property.

This property is read-only.

# dir_list_file_name property

This property shows the file name in the last directory listing.

## Syntax

```text
def get_dir_list_file_name(entry_index: int) -> str: ...
```

## Default Value

""

## Remarks

This property shows the file name in the last directory listing. This also may be the directory name if a directory is being listed. You can tell whether it is a file or a directory by the Boolean [dir_list_is_dir](#dir_list_is_dir-property) property.

The *entry_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [dir_list_count](#dir_list_count-property) property.

This property is read-only.

# dir_list_file_size property

This property shows the file size in the last directory listing.

## Syntax

```text
def get_dir_list_file_size(entry_index: int) -> int: ...
```

## Default Value

0

## Remarks

This property shows the file size in the last directory listing.

The *entry_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [dir_list_count](#dir_list_count-property) property.

This property is read-only.

# dir_list_file_time property

This property shows the file time in the last directory listing.

## Syntax

```text
def get_dir_list_file_time(entry_index: int) -> str: ...
```

## Default Value

""

## Remarks

This property shows the file time in the last directory listing. This contains the date/time stamp in which the file was created.

NOTE: In Unix systems, the date is given in two types of formats: If the date is in the past 12 months, the exact time is specified and the year is omitted. Otherwise, only the date and the year, but not hours or minutes, are given.

The *entry_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [dir_list_count](#dir_list_count-property) property.

This property is read-only.

# dir_list_is_dir property

This property specifies whether entries in the last directory listing are directories.

## Syntax

```text
def get_dir_list_is_dir(entry_index: int) -> bool: ...
```

## Default Value

FALSE

## Remarks

This property specifies whether entries in the last directory listing are directories. This Boolean value denotes whether or not the directory entry listed in [dir_list_file_name](#dir_list_file_name-property) is a file or a directory.

The *entry_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [dir_list_count](#dir_list_count-property) property.

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](#FTP_p_FirewallFirewallType) is set to a valid value. See the description of the [firewall_type](#FTP_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.

# 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_file property

This is the path to a local file for download or upload. If the file exists, it is overwritten.

## Syntax

```text
def get_local_file() -> str: ...
def set_local_file(value: str) -> None: ...
local_file = property(get_local_file, set_local_file)
```

## Default Value

""

## Remarks

This property is used by the [upload](#upload-method) and [download](#download-method) methods to specify the path to a local file to be downloaded or uploaded. See the method descriptions for more information.

**Example (Setting LocalFile)**

```text
FTPControl.LocalFile = "C:\localfile.txt"
FTPControl.RemoteFile = "remotefile.txt"
FTPControl.Download()

FTPControl.LocalFile = "C:\localfile2.txt"
FTPControl.RemoteFile = "folder/remotefile2.txt"
FTPControl.Download()
```

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

# overwrite property

This indicates whether or not the class should overwrite files during transfer.

## Syntax

```text
def get_overwrite() -> bool: ...
def set_overwrite(value: bool) -> None: ...
overwrite = property(get_overwrite, set_overwrite)
```

## Default Value

FALSE

## Remarks

This property is a value indicating whether or not the class should overwrite downloaded files. If overwrite is False, an error will be thrown whenever [local_file](#local_file-property) exists before a download operation.

# passive property

This controls whether or not to direct the server into a passive mode. It is recommended if behind a firewall.

## Syntax

```text
def get_passive() -> bool: ...
def set_passive(value: bool) -> None: ...
passive = property(get_passive, set_passive)
```

## Default Value

TRUE

## Remarks

This property controls whether or not to direct the server into a passive mode. Many firewalls will not allow the FTP server to open a connection from outside to the higher ports where the FTP client class expects them to be. If passive is set to *TRUE*, the class will use the *PASV* command instead of the *PORT* command and thus will direct the server into a passive mode: connections are initiated only by the client.

# password property

This is the password used to log in.

## 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 used to log in. It must be set before the class connects to the FTP server.

# remote_file property

This is the name of the remote file for uploading, downloading, and performing other operations.

## Syntax

```text
def get_remote_file() -> str: ...
def set_remote_file(value: str) -> None: ...
remote_file = property(get_remote_file, set_remote_file)
```

## Default Value

""

## Remarks

This property contains the name of the remote file to be uploaded or downloaded and is either an absolute file path or a relative path based on the remote path set by calling [change_remote_path](#change_remote_path-method).

A number of methods use remote_file as an argument.

**Example 1. Setting RemoteFile:**

```text
FTPControl.LocalFile = "C:\localfile.txt"
FTPControl.RemoteFile = "remotefile.txt"
FTPControl.Download()

FTPControl.LocalFile = "C:\localfile2.txt"
FTPControl.RemoteFile = "folder/remotefile2.txt"
FTPControl.Download()
```

NOTE: As long as file masks are supported by the server, then this property will act as a file mask when performing [list_directory](#list_directory-method) or [list_directory_long](#list_directory_long-method). If not supported, then [ApplyFileMaskLocally](#ApplyFileMaskLocally) could be set to True to filter the results locally.

**Example 2. Using RemoteFile as a file mask:**

```text
FTPControl.RemoteFile = "*.txt"
FTPControl.ListDirectory()
```

The following special characters are supported for pattern matching:

|  |  |
| --- | --- |
| ? | Any single character. |
| * | Any characters or no characters (e.g., C*t matches Cat, Cot, Coast, Ct). |
| [,-] | A range of characters (e.g., [a-z], [a], [0-9], [0-9,a-d,f,r-z]). |
| \ | The slash is ignored and exact matching is performed on the next character. |

If these characters need to be used as a literal in a pattern, then they must be escaped by surrounding them with brackets []. NOTE: "]" and "-" do not need to be escaped. See below for the escape sequences:

| Character | Escape Sequence |
| --- | --- |
| ? | [?] |
| * | [*] |
| [ | [[] |
| \ | [\] |

For example, to match the value [Something].txt, specify the pattern [[]Something].txt.

# remote_host property

This is the domain name or IP address of the FTP server.

## Syntax

```text
def get_remote_host() -> str: ...
def set_remote_host(value: str) -> None: ...
remote_host = property(get_remote_host, set_remote_host)
```

## Default Value

""

## Remarks

This property specifies the IP address (IP number in dotted internet format) or the domain name of the FTP 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 and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

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.

# remote_port property

This is the port for the FTP service (default is 21).

## Syntax

```text
def get_remote_port() -> int: ...
def set_remote_port(value: int) -> None: ...
remote_port = property(get_remote_port, set_remote_port)
```

## Default Value

21

## Remarks

This property contains the port for the FTP service, which defaults to 21 if not set. 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 an implicit Secure Sockets Layer (SSL), use port 990 (please see the [ssl_start_mode](#ssl_start_mode-property) property for more information).

# 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_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   # Explicit
```

## Default Value

0

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

# start_byte property

This is the byte index in RemoteFile and LocalFile from which to start a transmission.

## Syntax

```text
def get_start_byte() -> str: ...
def set_start_byte(value: str) -> None: ...
start_byte = property(get_start_byte, set_start_byte)
```

## Default Value

"0"

## Remarks

This property contains a zero-based index in both [remote_file](#remote_file-property) and [local_file](#local_file-property) that determines the point from which the transmission of data begins. This is useful for resuming interrupted downloads and uploads of files from FTP servers.

Once set, the start_byte index is used for all future downloads and uploads. The property must be reset to "0" for normal downloads and uploads.

The type of the property is a string instead of numeric value to allow for certain implementations that expect an alphanumeric marker for the start index.

In the [on_transfer](#on_transfer-event) event, the *TransferredBytes* parameter will include the bytes skipped (i.e., it will show start_byte more bytes than actually transferred).

NOTE: Some FTP servers may not support the FTP *REST* command. If that is the case with the server you are accessing, you will not be able to use the start_byte property.

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

# transfer_mode property

This property indicates the transfer mode (ASCII or binary). If the value is 0 (default), the initial server mode will be used.

## Syntax

```text
def get_transfer_mode() -> int: ...
transfer_mode = property(get_transfer_mode, None)
```

## Possible Values

```text
0   # Default1   # ASCII2   # Binary
```

## Default Value

0

## Remarks

This property indicates the current transfer mode, which is either ASCII or binary. To change the transfer mode call the [change_transfer_mode](#change_transfer_mode-method) method. Possible values for this property are:

|  |  |
| --- | --- |
| tmDefault (0) | The initial mode of the FTP server is taken. No change. |
| tmASCII (1) | Files are transferred in ASCII mode (a TYPE A command). |
| tmBinary (2) | Files are transferred in binary mode (a TYPE I command). |

This property is read-only.

# user property

This property contains the user identifier to use to log in.

## 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 to be used when logging in. It must be set before the class connects to the FTP server.

# abort method

The method aborts the current upload or download.

## Syntax

```text
def abort() -> None: ...
```

## Remarks

This method sends an *ABOR* command to the FTP server. It is used to interrupt file uploads and downloads.

# append method

This method appends data from LocalFile to a RemoteFile on an FTP server.

## Syntax

```text
def append() -> None: ...
```

## Remarks

This method causes the server-data transfer process (DTP) to accept the data transferred through the data connection and to store the data in a file on the server site. If the file specified in the pathname exists on the server site, then the data shall be appended to that file; otherwise, the file specified in the pathname shall be created on the server site. This method is similar to the [upload](#upload-method) method, but the local file specified by [local_file](#local_file-property) is appended to [remote_file](#remote_file-property) on the server as opposed to replacing it, as with the [upload](#upload-method) method. [remote_file](#remote_file-property) is either an absolute path on the server, or a path relative to the current path set by [change_remote_path](#change_remote_path-method). The server will create a file with that name if it doesn't already exist (similar to upload). If no FTP session is in place, one is automatically created by first calling the [logon](#logon-method) method.

# change_remote_path method

This method changes the current path on the FTP server.

## Syntax

```text
def change_remote_path(remote_path: str) -> None: ...
```

## Remarks

This method changes the current path on the FTP server to the specified *remote_path*. When called, the class will issue a command to the server to change the directory. The *remote_path* parameter may hold an absolute or relative path.

**Absolute Paths**

If the path begins with a */*, it is considered an absolute path and must specify the entire path from the root of the server. For instance:

```csharp
component.ChangeRemotePath("/home/testuser/myfolder");
```

**Relative Paths**

If the path does not begin with a */*, it is considered a relative path and is resolved in relation to the current directory. For instance, a value of *myfolder* will indicate a subfolder of the current directory. The special value *..* refers to the parent directory of the current path. For instance:

```csharp
//Change to the 'myfolder' sub-directory
component.ChangeRemotePath("myfolder");
//Navigate up two levels and then into the 'another/folder' path.
component.ChangeRemotePath("../../another/folder");
```

# change_transfer_mode method

This method changes the transfer mode for the current connection.

## Syntax

```text
def change_transfer_mode(transfer_mode: int) -> None: ...
```

## Remarks

This method optionally changes the transfer mode used for the connection. The *transfer_mode* parameter indicates the new transfer mode to be used.

In many cases, it is not necessary to explicitly change the transfer mode; however, the binary transfer mode is useful to ensure that files are preserved byte-for-byte during the transfer. For instance, when uploading or downloading images or archives, the binary transfer mode will ensure that no line-ending transformations are performed by the server before data are transmitted.

Valid values for the *transfer_mode* parameter are as follows:

|  |  |
| --- | --- |
| 0 (Default) | Files are transferred using the default mode of the FTP server. |
| 1 (ASCII) | Files are transferred in ASCII mode (sends the command "TYPE A"). |
| 2 (Binary) | Files are transferred in Binary mode (sends the command "TYPE I"). |

# check_file_exists method

This method returns True if the file specified by RemoteFile exists on the server.

## Syntax

```text
def check_file_exists() -> bool: ...
```

## Remarks

This method sends a command to the server to determine if the file specified by [remote_file](#remote_file-property) exists. If the file exists, this method returns *True*, otherwise it returns *False*. [remote_file](#remote_file-property) must be specified before calling this method. For instance:

```csharp
component.ChangeRemotePath("/home/testuser/myfolder");
component.RemoteFile = "test.txt";
if(component.CheckFileExists()) {
	//Do something
}
```

# 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](#ftp-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](#ftp-config-settings), you must call *Config("PROPERTY")*. The value will be returned as a string.

# connect method

This method connects to the FTP server without logging in.

## Syntax

```text
def connect() -> None: ...
```

## Remarks

This method establishes a connection with the [remote_host](#remote_host-property) but does not log in. In most cases, it is recommended to use the [logon](#logon-method) method, which will both establish a connection and log in to the server.

This method may be useful in cases in which it is desirable to separate the connection and logon operations, for instance, confirming that a host is available by first creating the connection.

# delete_file method

This method removes a file specified by FileName from an FTP server.

## Syntax

```text
def delete_file(file_name: str) -> None: ...
```

## Remarks

This method is used to remove a file specified by *file_name* from an FTP server. The remote file or directory specified by *file_name* is deleted. *file_name* is either an absolute path on the server, or a path relative to remote path set by [change_remote_path](#change_remote_path-method). If no FTP session is in place, one is automatically created by first calling the [logon](#logon-method) method.

# disconnect method

This method disconnects from the server without first logging off.

## Syntax

```text
def disconnect() -> None: ...
```

## Remarks

This method immediately disconnects from the server without first logging off.

In most cases, the [logoff](#logoff-method) method should be used to log off and disconnect from the server. Call the disconnect method in cases in which it is desirable to immediately disconnect without first logging off.

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

# download method

This method downloads a RemoteFile from an FTP server.

## Syntax

```text
def download() -> None: ...
```

## Remarks

This method is used to download the remote file specified by [remote_file](#remote_file-property) to the local file specified by [local_file](#local_file-property), or it is retrieved through the [on_transfer](#on_transfer-event) event if the [local_file](#local_file-property) property is "" (empty string). [remote_file](#remote_file-property) is either an absolute path on the server or a path relative to a remote path set by calling [change_remote_path](#change_remote_path-method). If no FTP session is in place, one is automatically created by first calling the [logon](#logon-method) method.

**Example (Download a File)**

```text
FTPControl.LocalFile = "C:\localfile.txt"
FTPControl.RemoteFile = "remotefile.txt"
FTPControl.Download()

FTPControl.LocalFile = "C:\localfile2.txt"
FTPControl.RemoteFile = "folder/remotefile2.txt"
FTPControl.Download()
```

# 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_directory method

List the current directory specified by ChangeRemotePath on an FTP server.

## Syntax

```text
def list_directory() -> None: ...
```

## Remarks

This method is used to list the directory (or file mask) specified in [remote_file](#remote_file-property). [remote_file](#remote_file-property) is either an absolute path on the server, or a path relative to the remote path set by [change_remote_path](#change_remote_path-method). The file listing is received through the [on_dir_list](#on_dir_list-event) event.

Similar to [list_directory_long](#list_directory_long-method), except that only file names are returned.

NOTE: Because [remote_file](#remote_file-property) acts as a file mask, to retrieve a complete directory listing [remote_file](#remote_file-property) should be set to an empty string or a mask like "*". If no FTP session is in place, one is automatically created by first calling the [logon](#logon-method) method.

# list_directory_long method

This method lists extended directory information for the remote path specified by calling ChangeRemotePath .

## Syntax

```text
def list_directory_long() -> None: ...
```

## Remarks

This method is used to request a directory (or file mask) listing specified in [remote_file](#remote_file-property). [remote_file](#remote_file-property) is either an absolute path on the server, or a path relative to the remote path set by calling [change_remote_path](#change_remote_path-method). The file listing is received through the [on_dir_list](#on_dir_list-event) event. Extended file information is returned.

NOTE: Because [remote_file](#remote_file-property) acts as a file mask, to retrieve a complete directory listing [remote_file](#remote_file-property) should be set to empty string or a mask like "*". If no FTP session is in place, one is automatically created by first calling the [logon](#logon-method) method.

# logoff method

This method is used to log off from the FTP server by posting a QUIT command.

## Syntax

```text
def logoff() -> None: ...
```

## Remarks

This method is used to log off from the FTP server by posting a *QUIT* command. If that fails, the connection is terminated by the local host.

# logon method

This method is used to log on to the FTP RemoteHost using the current User and Password .

## Syntax

```text
def logon() -> None: ...
```

## Remarks

This method is used to log on to the FTP server using the current [user](#user-property) and [password](#password-property). If [transfer_mode](#transfer_mode-property) is not 0 (Default), then the FTP transfer mode is set to the appropriate value.

**Example (Logging On)**

```text
FTPControl.RemoteHost = "ftpserver"
FTPControl.User = "username"
FTPControl.Password = "password"
FTPControl.Logon()
```

# make_directory method

This method is used to create a directory on the FTP server.

## Syntax

```text
def make_directory(new_dir: str) -> None: ...
```

## Remarks

This method is used to create a directory with a path specified by *new_dir* on the FTP server. *new_dir* is either an absolute path on the server, or a path relative to the remote path that is set by calling [change_remote_path](#change_remote_path-method). If no FTP session is in place, one is automatically created by first calling the [logon](#logon-method) method.

NOTE: When make_directory is called, [remote_file](#remote_file-property) is changed to *new_dir*.

# query_file_size method

This returns the size of the file specified by RemoteFile .

## Syntax

```text
def query_file_size() -> int: ...
```

## Remarks

This method sends the *SIZE* command to the server to obtain the size (in bytes) of the file specified by [remote_file](#remote_file-property). [remote_file](#remote_file-property) must be specified before calling this method. For instance:

```csharp
component.ChangeRemotePath("/home/testuser/myfolder");
component.RemoteFile = "test.txt";
long myFileSize = component.QueryFileSize();
```

If [remote_file](#remote_file-property) does not exist on the server, the class fails with an error.

# query_file_time method

This returns the modified time of the file specified by RemoteFile .

## Syntax

```text
def query_file_time() -> str: ...
```

## Remarks

This method sends the *MDTM* command to the server to obtain the modified time of the file specified by [remote_file](#remote_file-property). The time returned by this method will be UTC time. [remote_file](#remote_file-property) must be specified before calling this method. For instance:

```csharp
component.ChangeRemotePath("/home/testuser/myfolder");
component.RemoteFile = "test.txt";
string myModifiedTime = component.QueryFileTime();
```

The [FileTimeFormat](#FileTimeFormat) configuration setting controls the format of the returned value.

# query_remote_path method

This queries the server for the current path.

## Syntax

```text
def query_remote_path() -> str: ...
```

## Remarks

This method queries the server for the current path. When called, the class will issue a command to the server to retrieve the current path value. The return value of this method is the path returned by the server. For instance:

```csharp
string remotePath = component.QueryRemotePath();
```

# remove_directory method

This removes a directory specified by DirName from an FTP server.

## Syntax

```text
def remove_directory(dir_name: str) -> None: ...
```

## Remarks

This method is used to remove a directory with path specified by *dir_name* from the FTP server. *dir_name* is either an absolute path on the server, or a path relative to the remote path set by calling [change_remote_path](#change_remote_path-method). If no FTP session is in place, one is automatically created by first calling the [logon](#logon-method) method.

# rename_file method

This changes the name of RemoteFile to NewName .

## Syntax

```text
def rename_file(new_name: str) -> None: ...
```

## Remarks

This method is used to change the name of a remote file, specified by [remote_file](#remote_file-property) to *new_name*. [remote_file](#remote_file-property) and *new_name* are either absolute paths on the server, or a path relative to a remote path set by calling [change_remote_path](#change_remote_path-method). If no FTP session is in place, one is automatically created by first calling the [logon](#logon-method) method.

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

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

# store_unique method

This method uploads a file with a unique name to an FTP server.

## Syntax

```text
def store_unique() -> None: ...
```

## Remarks

This method is used to upload a file with a unique name to an FTP server. This is similar to the [upload](#upload-method) method, but the server determines a unique name for the [local_file](#local_file-property) to be saved on the current directory set by calling [change_remote_path](#change_remote_path-method). The server includes the new name of the file in its response. The user should check the [on_pi_trail](#on_pi_trail-event) event, or [last_reply](#last_reply-property) property to retrieve this generated filename.

# upload method

This method uploads a file specified by LocalFile to an FTP server.

## Syntax

```text
def upload() -> None: ...
```

## Remarks

This method uploads a local file specified by [local_file](#local_file-property) to the remote file specified by [remote_file](#remote_file-property). [remote_file](#remote_file-property) is either an absolute path on the server, or a path relative to the remote path set by calling [change_remote_path](#change_remote_path-method). If no FTP session is in place, one is automatically created by first calling the [logon](#logon-method) method.

If you want to append to a server file, please refer to the [append](#append-method) method.

**Example 1: Upload a File**

```text
FTPControl.LocalFile = "C:\localfile.txt"
FTPControl.RemoteFile = "remotefile.txt"
FTPControl.Upload()

FTPControl.LocalFile = "C:\localfile2.txt"
FTPControl.RemoteFile = "folder/remotefile2.txt"
FTPControl.Upload()
```

# on_connection_status event

Fired to indicate changes in the connection state.

## Syntax

```text
class FTPConnectionStatusEventParams(object):
  @property
  def connection_event() -> str: ...

  @property
  def status_code() -> int: ...

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

# In class FTP:
@property
def on_connection_status() -> Callable[[FTPConnectionStatusEventParams], None]: ...
@on_connection_status.setter
def on_connection_status(event_hook: Callable[[FTPConnectionStatusEventParams], 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_dir_list event

This event is fired when a directory entry is received.

## Syntax

```text
class FTPDirListEventParams(object):
  @property
  def dir_entry() -> str: ...

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

  @property
  def is_dir() -> bool: ...

  @property
  def file_size() -> int: ...

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

# In class FTP:
@property
def on_dir_list() -> Callable[[FTPDirListEventParams], None]: ...
@on_dir_list.setter
def on_dir_list(event_hook: Callable[[FTPDirListEventParams], None]) -> None: ...
```

## Remarks

The on_dir_list events are fired when a directory listing is received as a response to a [list_directory](#list_directory-method) or [list_directory_long](#list_directory_long-method) call.

The [on_start_transfer](#on_start_transfer-event) and [on_end_transfer](#on_end_transfer-event) events mark the beginning and end of the event stream.

The *dir_entry* parameter contains the filename when [list_directory](#list_directory-method) is called and includes extended file information when [list_directory_long](#list_directory_long-method) is called.

The class tries to fill out the *file_name*, *is_dir*, *file_size*, and *file_time* parameters when calling the [list_directory_long](#list_directory_long-method) method. Except for *file_name*, these parameters are empty when a short "List Directory" is performed.

In Unix systems, the date is given in two types of formats: If the date is in the past 12 months the exact time is specified and the year is omitted. Otherwise, only the date and the year, but not hours or minutes, are given.

# on_end_transfer event

This event is fired when a file finishes downloading or uploading.

## Syntax

```text
class FTPEndTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class FTP:
@property
def on_end_transfer() -> Callable[[FTPEndTransferEventParams], None]: ...
@on_end_transfer.setter
def on_end_transfer(event_hook: Callable[[FTPEndTransferEventParams], None]) -> None: ...
```

## Remarks

The on_end_transfer event fires when a Data Interface connection is closed. This occurs when the file finishes transferring or a directory listing is finished.

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 FTPErrorEventParams(object):
  @property
  def error_code() -> int: ...

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

# In class FTP:
@property
def on_error() -> Callable[[FTPErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[FTPErrorEventParams], 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](#ftp-errors) section.

# on_pi_trail event

This event traces the commands sent to the server, and the respective replies.

## Syntax

```text
class FTPPITrailEventParams(object):
  @property
  def direction() -> int: ...

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

# In class FTP:
@property
def on_pi_trail() -> Callable[[FTPPITrailEventParams], None]: ...
@on_pi_trail.setter
def on_pi_trail(event_hook: Callable[[FTPPITrailEventParams], None]) -> None: ...
```

## Remarks

The on_pi_trail event is useful for debugging purposes. It shows all of the interactions between the client and the server, line by line.

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_ssl_server_authentication event

Fired after the server presents its certificate to the client.

## Syntax

```text
class FTPSSLServerAuthenticationEventParams(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 FTP:
@property
def on_ssl_server_authentication() -> Callable[[FTPSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[FTPSSLServerAuthenticationEventParams], 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 FTPSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class FTP:
@property
def on_ssl_status() -> Callable[[FTPSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[FTPSSLStatusEventParams], 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 fires when a file starts downloading or uploading.

## Syntax

```text
class FTPStartTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class FTP:
@property
def on_start_transfer() -> Callable[[FTPStartTransferEventParams], None]: ...
@on_start_transfer.setter
def on_start_transfer(event_hook: Callable[[FTPStartTransferEventParams], None]) -> None: ...
```

## Remarks

The on_start_transfer event fires when a Data Interface connection is created. This is when the file starts transferring or a directory listing is started.

The *Direction* parameter shows whether the client (0) or the server (1) is sending the data.

# on_transfer event

This event is fired during the file download or upload.

## Syntax

```text
class FTPTransferEventParams(object):
  @property
  def direction() -> int: ...

  @property
  def bytes_transferred() -> int: ...

  @property
  def percent_done() -> int: ...

  @property
  def text() -> bytes: ...

# In class FTP:
@property
def on_transfer() -> Callable[[FTPTransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[FTPTransferEventParams], None]) -> None: ...
```

## Remarks

One or more on_transfer events are fired during file transfer. The *bytes_transferred* parameter shows the number of bytes transferred since the beginning of the transfer.

*text* contains the portion of the file data being delivered.

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.

# FTP 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.

### FTP Config Settings

**ActiveModeIP**: Allows the specification of the IP address that the server will connect to for active mode connections.The [ActiveModeIP](#ActiveModeIP) configuration setting can be used to specify the IP address that the server will connect to when using an active mode configuration ([passive](#passive-property) = False). When this configuration setting is set, the port number where the component listens for active mode connections will still be managed by the component. The [PortRange](#PortRange) also can be used to ensure that the correct port is used by the client.

NOTE: This configuration setting will be ignored if [ActiveModePORTAddress](#ActiveModePORTAddress) is also specified.

**ActiveModePORTAddress**: Allows the specification of the PORT address value for active mode connections.When using an active mode configuration ([passive](#passive-property) = False) with a firewall, it may be necessary to specify the actual PORT value to be sent to the server. [ActiveModePORTAddress](#ActiveModePORTAddress) takes the protocol-level parameter in the form "a,b,c,d,e,f" where "a,b,c,d" is the external IP address separated by commas, and e and f represent, respectively, the high-byte (divide by 256) and the low-byte (mod 256) values of the external port where the FTP client is listening.

This configuration setting must be used in conjunction with [PortRange](#PortRange) to ensure that the correct port is used by the client.

**AppendToLocalFile**: Append downloaded files to a local file.If set to True, the downloaded files will be appended to the file specified in [local_file](#local_file-property).

**ApplyFileMaskLocally**: Whether to filter the directory listing locally or on the server.If set to *True* any filemask provided to [remote_file](#remote_file-property) will be applied locally, after the server has returned the results. When set to *False* (default), the value in [remote_file](#remote_file-property) will be sent to the server as part of the relevant listing command. Because using filemasks with list commands is not standardized, some servers do not support them and will return an error.

**AutoSelectDataIP**: Automatically select the data connection IP.This setting controls the selection logic of the data connection. By default, this value is True and the class will attempt to determine the best IP for the data connection based on the returned value from the server. It is recommended to leave this value set to True unless there is a reason to disable it.

In many cases, FTP servers are not configured to return a valid public IP in the PASV response. When Secure Sockets Layer/Transport Layer Security (SSL/TLS) is used any network address translation (NAT) done by the firewall cannot occur. The result is the client may receive an IP that is not accessible.

This setting is designed to allow the connection to succeed in as many cases as possible. When the IP for the data connection is received from the server, the class will inspect the value. If the received value is not within the known private IP ranges, the class will use it, assuming it is a valid public IP. If the received value is a private IP, the class will instead assume the data connection should be established to the same IP as the command connection (true in almost all cases).

When this setting is False, the class will not perform any checks on the received value. When set to False, [UseRemoteHostAddressForPassive](#UseRemoteHostAddressForPassive) is applicable.

**CalculatePercentDone**: Enables or Disables calculating the percent complete for downloads.When set to *True* (default), the class sends an FTP *SIZE* command to retrieve the file size before beginning a download. When downloading a large quantity of small files, performance may be increased by disabling this feature.

**CheckTotalEntry**: Whether to ignore directory listing total lines.Some servers will include "total" information when returning a directory listing that contains non-entry data. When CheckTotalEntry is set to True (default), the component will ignore lines beginning with "total" to account for this. In some cases, it may be desirable to include these lines in the resulting dir_list data; this can be done by setting this configuration setting to False.

**DILinger**: When set to True, DI connections are terminated gracefully. This property controls how the DI connection is closed. The default is True.

In the case that DILinger is True (default), follow two scenarios to determine how long the connection will linger. In the first scenario, if [DILingerTime](#DILingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, [DILingerTime](#DILingerTime) is a positive value, the system will attempt to send pending data until the specified [DILingerTime](#DILingerTime) 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 (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.

**DILingerTime**: Time in seconds to have the DI connection linger. LingerTime is the time, in seconds, to let the socket connection linger. This value is 0 by default, which means it will use the default IP timeout.

**FileTimeFormat**: The format of file time reported by the server.The default value is "M/d/yyyy hh:mm:ss tt". When set, the class will format the time returned by the server when calling the [query_file_time](#query_file_time-method) method. To disable all formatting, set this to empty string.

This setting applies only when calling [query_file_time](#query_file_time-method). It does not apply to the *FileTime* parameter of the [on_dir_list](#on_dir_list-event) event.

**IgnoreEntries**: Directory entry data to ignore.Sometimes the FTP server will return data in a directory listing that is not entry data and can be ignored. The IgnoreEntries configuration setting takes a comma-separated list of entries to ignore. Only the beginning of the entries need to be specified and correct case is not required.

**MaskSensitiveData**: Masks passwords in logs.The default value is True. When set to True, the class will mask passwords that otherwise would appear in its logs.

**ModeZCompressionLevel**: Used to specify the level of compression used.The default value is 7. Valid values range from 0 to 9. A higher value indicates that a higher compression level is being used. This is valid only when [UseModeZ](#UseModeZ) is set to True.

**PortRange**: Allows the specification of a port range where the class listens for active mode connections.When set to use active mode ([passive](#passive-property) = False), the class uses any available port to listen to incoming connections from the server. You can override this behavior by setting [PortRange](#PortRange) to a value containing the range of ports the class will be listening to.

The range is provided as *start-end*, for instance: "1024-" stands for anything higher than 1024, "1024-2048" stands for ports between 1024 and 2048 inclusive, "4000-4010, 50000-50010" stands for ports between 4000 and 4010 or between 50000 and 50010.

**PreserveFileTime**: Attempts to preserve timestamps when transferring files.When set to True, the class will try to preserve timestamps when transferring files. The *MDTM* command is used when downloading, and the *MFTM* command is used when uploading. The server must support these commands for this to work and is False by default.

**RealTimeUpload**: Enables real time uploading.When this value is set to True, the class will upload the data in the file specified by [local_file](#local_file-property) and continue monitoring [local_file](#local_file-property) for additional data to upload until no new data is found for [RealTimeUploadAgeLimit](#RealTimeUploadAgeLimit) seconds. This allows you to start uploading a file immediately after the file is created and continue uploading as data is written to the file. The default value is False.

**RealTimeUploadAgeLimit**: The age limit in seconds when using RealTimeUpload.This value is only applicable when [RealTimeUpload](#RealTimeUpload) is set to "True". This specifies the number of seconds for which the class will monitor [local_file](#local_file-property) for new data to upload. If this limit is reached and no new data are found in [local_file](#local_file-property) the upload will complete. The default value is "1".

**ReusePISSLSessionInDI**: Whether the PI SSL session will be reused for the DI connection.When set to True (default), the class will reuse the PI SSL session when creating the DI connection. When set to False, the class will create a separate SSL session for the DI connection. The default value is True.

**ReuseSSLSessionInDI**: Whether the SSL session will be reused for the DI connection.When set to True (default), the class will ask the server to reuse the existing DI Secure Sockets Layer (SSL) session. When set to False, a new SSL session will always be created for the DI connection.

**UseClearChannel**: Allows for the Clear Command Channel (CCC) command.When this is set, the class will send the *CCC* command to the server requesting a clear (unprotected) command channel.

**UseClearDataChannel**: Allows for the PROT C command.When this is set, the class will use a clear (unprotected) data channel by sending the *PROT C* command to the server.

**UseEPSV**: Allows extended passive mode.When this is set, the extended passive mode will be used.

**UseMLSD**: Uses listings for machine processing.When this is set to True, the class will list files in the directory using the *MLSD* command. This command is an extension to the protocol that defines a more standardized and reliable directory listing format. Not all servers support this command. The default value is False.

When set to True, set [remote_file](#remote_file-property) to the filemask and call either [list_directory](#list_directory-method) or [list_directory_long](#list_directory_long-method). There is no difference between the two methods when this setting is enabled.

**UseMLST**: Uses single file listing for machine processing.This setting is similar to [UseMLSD](#UseMLSD) except that it is valid only for a single file. When this is set to True, the class will list the file or folder specified by [remote_file](#remote_file-property). If [remote_file](#remote_file-property) is not set, a listing for the current directory will be returned. This command is an extension to the protocol, which defines a more standardized and reliable directory listing format, but does so only for a single file or folder. Not all servers support this command. The default value is False.

When set to True, set [remote_file](#remote_file-property) to the file or folder you wish to get information about and call either [list_directory](#list_directory-method) or [list_directory_long](#list_directory_long-method). There is no difference between the two methods when this setting is enabled. When both [UseMLSD](#UseMLSD) and [UseMLST](#UseMLST) are set, [UseMLSD](#UseMLSD) takes precedence.

**UseModeZ**: Allows compression to be used when transferring data.The default value is False. When set to True, the class will issue the *MODE Z* command to the FTP server. This will enable deflate compression so that all data transferred are first compressed either by the server (when downloading) or by the class (when uploading). NOTE: Not all servers support this feature.

**UseOldAUTHSSL**: Allows use of the 'AUTH SSL' command instead of 'AUTH TLS'.By default, the class uses the standard *AUTH TLS* command to initiate the SSL handshake with the server. This configuration setting is included for optional support of older servers that support only the *AUTH SSL* command.

NOTE: Using *AUTH SSL* instead of *AUTH TLS* is strongly discouraged because of potential security vulnerabilities. If you must use this configuration setting, please do so very carefully.

**UseProtWhenImplicit**: Sends the PROT P command to the server.When [ssl_start_mode](#ssl_start_mode-property) is set to *sslImplicit*, setting this to True will instruct the class to send the *PROT P* command to the server. This explicitly tells the server that the data channel will be protected. The default value is True.

**UseRemoteHostAddressForPassive**: Instructs the class to use the address specified by RemoteHost when establishing a data connection.When this setting is True, the class will use the address specified by [remote_host](#remote_host-property) when establishing a data connection for directory listings and file transfers. This setting is applicable only when [AutoSelectDataIP](#AutoSelectDataIP) is set to False.

When this setting is False (default) and [AutoSelectDataIP](#AutoSelectDataIP) is also False, the class will use the IP address returned by the server when establishing a data connection.

This setting is not applicable when [passive](#passive-property) is set to False (Active mode).

**VirtualHostName**: Sends the HOST command to the server.Defined in RFC 7151, the *HOST* command allows user-FTP processes to specify which virtual host to connect to for a server-FTP process that is handling requests for multiple virtual hosts on a single IP address. When this configuration setting is set, the *HOST* command is sent to the server before authenticating.

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

**EnableFallback**: Whether to try the other addresses the remote host resolves to when a connection attempt fails.When set to True and [remote_host](#remote_host-property) resolves to more than one address, the class will try the remaining addresses in turn if the connection to the first one fails, and only fails with an error once every address has been tried. The error reported is the one from the last attempt. Use [FallbackTimeout](#FallbackTimeout) to limit the total time spent.

NOTE: Only addresses of the same IP version as the first one are tried, this setting does not fall back from IPv6 to IPv4. Selecting between IPv6 and IPv4 is done by [UseIPv6](#UseIPv6) when the host is resolved.

This setting must be set before the connection is established. The default value for this setting is False.

**FallbackTimeout**: The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled.This setting limits the total time that the class will spend on all of the connection attempts made when [EnableFallback](#EnableFallback) is enabled. The default value is 0, in which case each attempt uses the operating system's own connection timeout.

NOTE: This setting only applies when [EnableFallback](#EnableFallback) is True. It is unrelated to [ConnectionTimeout](#ConnectionTimeout), which is specified in seconds and applies to the [connected](#connected-property) operation as a whole.

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

# FTP Errors

### FTP Errors

|  |  |
| --- | --- |
| 118 | Firewall error. The error description contains detailed information. |
| 141 | FTP error. The error message contains the server reply. |
| 142 | Communication error. The error message contains the description. |
| 143 | Busy executing current method. |
| 144 | Local file error. The error description contains detailed information. |
| 145 | Can't open [local_file](#local_file-property) for reading. |
| 146 | No [remote_file](#remote_file-property) specified while uploading. |
| 147 | Data interface error. The error description contains detailed information. |
| 148 | LocalFile already exists and overwrite is False. |
| 149 | Windows message queue dropped a message (typically due to heavy load). |
| 301 | Operation is interrupted. |
| 302 | Can't open local file. |
| 311 | Accept failed for data connection. |
| 312 | Asynchronous select failed for data connection. |

The class may also return one of the following error codes, which are inherited from other classes.

### SSLClient Errors

|  |  |
| --- | --- |
| 100 | You cannot change the [remote_port](#remote_port-property) at this time. A connection is in progress. |
| 101 | You cannot change the [remote_host](#remote_host-property) (Server) at this time. A connection is in progress. |
| 102 | The [remote_host](#remote_host-property) 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](#remote_port-property) 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). |