# HTTP Class The HTTP Class can be used to retrieve documents from the World Wide Web. ## Syntax ```text class ipworks.HTTP ``` ## Remarks The HTTP 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 HTTP Class implements a standard HTTP client through a simple plug-and-play interface as defined in RFC 1945 and RFC 2616 with the added option of SSL security. The class contains a number of properties that map directly to HTTP request headers. Files are received through two events: (1) [on_transfer](#on_transfer-event) for content, and (2) [on_header](#on_header-event) for HTTP headers. The [on_start_transfer](#on_start_transfer-event) and [on_end_transfer](#on_end_transfer-event) events are fired at the beginning and end of transmission. To receive a document, call the [get](#get-method) method with the *URL* parameter. Data can be POST-ed to the HTTP server by assigning it to the [post_data](#post_data-property) property and then calling the [post](#post-method) method. The *PUT* and *PATCH* methods are also supported. You should specify the [user](#user-property) and [password](#password-property) properties or alternatively the [Authorization](#Authorization) and call the [put](#put-method) or [patch](#patch-method) methods with the specified *URL*. The [attached_file](#attached_file-property) will be sent to the server. The HTTP Class supports the HTTP Basic authentication scheme through the [user](#user-property) and [password](#password-property) properties. Other authentication schemes can be implemented by using the [auth_scheme](#auth_scheme-property) property. ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [accept](#accept-property) | This property includes a list of acceptable MIME types for the request. | | [allow_http_compression](#allow_http_compression-property) | This property enables HTTP compression for receiving data. | | [attached_file](#attached_file-property) | This property includes a file to append to PostData if the POST or PUT methods are used. | | [authorization](#authorization-property) | This property includes the Authorization string to be sent to the server. | | [auth_scheme](#auth_scheme-property) | This property specifies the authentication scheme to use when server authentication is required. | | [connected](#connected-property) | Whether the class is connected. | | [content_type](#content_type-property) | This property includes the content type for posts and puts. | | [cookie_count](#cookie_count-property) | The number of records in the Cookie arrays. | | [cookie_domain](#cookie_domain-property) | The domain of a received cookie. | | [cookie_expiration](#cookie_expiration-property) | An expiration time for the cookie (if provided by the server). | | [cookie_name](#cookie_name-property) | The name of the cookie. | | [cookie_path](#cookie_path-property) | A path name to limit the cookie to (if provided by the server). | | [cookie_secure](#cookie_secure-property) | The security flag of the received cookie. | | [cookie_value](#cookie_value-property) | The value of the cookie. | | [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. | | [follow_redirects](#follow_redirects-property) | Determines what happens when the server issues a redirect. | | [from_address](#from_address-property) | This property includes the email address of the HTTP agent (optional). | | [http_method](#http_method-property) | This property includes the HTTP method used for the request. | | [http_version](#http_version-property) | This property includes the HTTP Version used by the class. | | [idle](#idle-property) | The current status of the class. | | [if_modified_since](#if_modified_since-property) | This property includes a date determining the maximum age of the desired document. | | [local_file](#local_file-property) | This property includes the path to a local file for downloading. 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. | | [other_headers](#other_headers-property) | Other headers as determined by the user (optional). | | [parsed_header_count](#parsed_header_count-property) | The number of records in the ParsedHeader arrays. | | [parsed_header_field](#parsed_header_field-property) | This property contains the name of the HTTP header (this is the same case as it is delivered). | | [parsed_header_value](#parsed_header_value-property) | This property contains the header contents. | | [password](#password-property) | This property includes a password if authentication is to be used. | | [post_data](#post_data-property) | This property includes the data to post with the URL if the POST method is used. | | [pragma](#pragma-property) | This property includes a browser- or server-specific header line (optional). | | [proxy_auth_scheme](#proxy_auth_scheme-property) | The type of authorization to perform when connecting to the proxy. | | [proxy_auto_detect](#proxy_auto_detect-property) | Whether to automatically detect and use proxy system settings, if available. | | [proxy_password](#proxy_password-property) | A password if authentication is to be used for the proxy. | | [proxy_port](#proxy_port-property) | The Transmission Control Protocol (TCP) port for the proxy Server (default 80). | | [proxy_server](#proxy_server-property) | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. | | [proxy_ssl](#proxy_ssl-property) | When to use a Secure Sockets Layer (SSL) for the connection to the proxy. | | [proxy_user](#proxy_user-property) | A username if authentication is to be used for the proxy. | | [range](#range-property) | This property includes the byte-range to be sent to the server. | | [referer](#referer-property) | This property includes the referer URL/document (optional). | | [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. | | [status_line](#status_line-property) | This property is the first line of the last server response. | | [timeout](#timeout-property) | The timeout for the class. | | [transferred_data](#transferred_data-property) | This property includes the contents of the last response from the server. | | [transferred_data_limit](#transferred_data_limit-property) | This property specifies the maximum amount of data to be transferred. | | [transferred_headers](#transferred_headers-property) | The full set of headers as received from the server. | | [url](#url-property) | This property specifies the URL to retrieve. | | [url_path](#url_path-property) | This property specifies the path for the URL. | | [url_port](#url_port-property) | This property specifies the port for the URL. | | [url_scheme](#url_scheme-property) | This property includes the scheme for the URL. | | [url_server](#url_server-property) | This property specifies the server for the URL. | | [user](#user-property) | This property includes a user name if authentication is to be used. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [add_cookie](#add_cookie-method) | Adds a cookie and the corresponding value to the outgoing request headers. | | [calc_authorization](#calc_authorization-method) | This method calculates the Authorization header based on provided credentials. | | [config](#config-method) | Sets or retrieves a configuration setting. | | [connect](#connect-method) | This method connects to the remote host without performing any action. | | [delete](#delete-method) | This method deletes an object on the server. | | [disconnect](#disconnect-method) | This method disconnects from the server. | | [do_events](#do_events-method) | This method processes events from the internal message queue. | | [get](#get-method) | This retrieves the document using the HTTP GET method. | | [head](#head-method) | This retrieves the document headers using the HTTP HEAD method. | | [interrupt](#interrupt-method) | This method interrupts the current method. | | [patch](#patch-method) | This method partially updates data on the HTTP server using the HTTP PATCH method. | | [post](#post-method) | This method posts data to the HTTP server using the HTTP POST method. | | [put](#put-method) | This method sends data to the HTTP server using the HTTP PUT method. | | [query](#query-method) | Sends a query to the HTTP server using the HTTP QUERY method. | | [reset](#reset-method) | This method will reset the class. | | [reset_headers](#reset_headers-method) | This method resets all HTTP headers, cookies, LocalFile , and AttachedFile . | ## 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_connected](#on_connected-event) | Fired immediately after a connection completes (or fails). | | [on_connection_status](#on_connection_status-event) | Fired to indicate changes in the connection state. | | [on_disconnected](#on_disconnected-event) | Fired when a connection is closed. | | [on_end_transfer](#on_end_transfer-event) | Fired when a document finishes transferring. | | [on_error](#on_error-event) | Fired when information is available about errors during data delivery. | | [on_header](#on_header-event) | Fired every time a header line comes in. | | [on_log](#on_log-event) | Fired once for each log message. | | [on_redirect](#on_redirect-event) | Fired when a redirection is received from the server. | | [on_set_cookie](#on_set_cookie-event) | Fired for every cookie set by the server. | | [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) | Fired when a document starts transferring (after the headers). | | [on_status](#on_status-event) | Fired when the HTTP status line is received from the server. | | [on_transfer](#on_transfer-event) | Fired while a document transfers (delivers document). | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AcceptEncoding](#AcceptEncoding) | Used to tell the server which types of content encodings the client supports. | | [AllowHTTPCompression](#AllowHTTPCompression) | This property enables HTTP compression for receiving data. | | [AllowHTTPFallback](#AllowHTTPFallback) | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. | | [Append](#Append) | Whether to append data to LocalFile. | | [Authorization](#Authorization) | The Authorization string to be sent to the server. | | [BytesTransferred](#BytesTransferred) | Contains the number of bytes transferred in the response data. | | [ChunkSize](#ChunkSize) | Specifies the chunk size in bytes when using chunked encoding. | | [CompressHTTPRequest](#CompressHTTPRequest) | Set to true to compress the body of a PUT or POST request. | | [EncodeURL](#EncodeURL) | If set to True the URL will be encoded by the class. | | [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. | | [GetOn302Redirect](#GetOn302Redirect) | If set to True the class will perform a GET on the new location. | | [HTTP2HeadersWithoutIndexing](#HTTP2HeadersWithoutIndexing) | HTTP2 headers that should not update the dynamic header table with incremental indexing. | | [HTTPVersion](#HTTPVersion) | The version of HTTP used by the class. | | [IfModifiedSince](#IfModifiedSince) | A date determining the maximum age of the desired document. | | [KeepAlive](#KeepAlive) | Determines whether the HTTP connection is closed after completion of the request. | | [KerberosSPN](#KerberosSPN) | The Service Principal Name for the Kerberos Domain Controller. | | [LogLevel](#LogLevel) | The level of detail that is logged. | | [MaxRedirectAttempts](#MaxRedirectAttempts) | Limits the number of redirects that are followed in a request. | | [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) | The negotiated HTTP version. | | [OtherHeaders](#OtherHeaders) | Other headers as determined by the user (optional). | | [ProxyAuthorization](#ProxyAuthorization) | The authorization string to be sent to the proxy server. | | [ProxyAuthScheme](#ProxyAuthScheme) | The authorization scheme to be used for the proxy. | | [ProxyPassword](#ProxyPassword) | A password if authentication is to be used for the proxy. | | [ProxyPort](#ProxyPort) | Port for the proxy server (default 80). | | [ProxyServer](#ProxyServer) | Name or IP address of a proxy server (optional). | | [ProxyUser](#ProxyUser) | A user name if authentication is to be used for the proxy. | | [SentHeaders](#SentHeaders) | The full set of headers as sent by the client. | | [StatusCode](#StatusCode) | The status code of the last response from the server. | | [StatusLine](#StatusLine) | The first line of the last response from the server. | | [TransferredData](#TransferredData) | The contents of the last response from the server. | | [TransferredDataLimit](#TransferredDataLimit) | The maximum number of incoming bytes to be stored by the class. | | [TransferredHeaders](#TransferredHeaders) | The full set of headers as received from the server. | | [TransferredRequest](#TransferredRequest) | The full request as sent by the client. | | [UseChunkedEncoding](#UseChunkedEncoding) | Enables or Disables HTTP chunked encoding for transfers. | | [UseIDNs](#UseIDNs) | Whether to encode hostnames to internationalized domain names. | | [UsePlatformHTTPClient](#UsePlatformHTTPClient) | Whether or not to use the platform HTTP client. | | [UseProxyAutoConfigURL](#UseProxyAutoConfigURL) | Whether to use a Proxy auto-config file when attempting a connection. | | [UserAgent](#UserAgent) | Information about the user agent (browser). | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the class whether or not to automatically detect and use firewall system settings, if available. | | [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). | | [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. | | [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. | | [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. | | [FirewallType](#FirewallType) | Determines the type of firewall to connect through. | | [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [Linger](#Linger) | When set to True, connections are terminated gracefully. | | [LingerTime](#LingerTime) | Time in seconds to have the connection linger. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the class binds. | | [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. | | [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. | | [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. | | [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. | | [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. | | [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. | | [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLCACertFilePaths](#SSLCACertFilePaths) | The paths to CA certificate files on Unix/Linux. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. | | [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. | | [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. | | [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. | | [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # accept property This property includes a list of acceptable MIME types for the request. ## Syntax ```text def get_accept() -> str: ... def set_accept(value: str) -> None: ... accept = property(get_accept, set_accept) ``` ## Default Value "" ## Remarks If this property contains a nonempty string, an HTTP *Accept* header is added to the request. The *Accept* header is used for content negotiation. It provides the server with a comma-separated list of MIME types that are acceptable for its response. # allow_http_compression property This property enables HTTP compression for receiving data. ## Syntax ```text def get_allow_http_compression() -> bool: ... def set_allow_http_compression(value: bool) -> None: ... allow_http_compression = property(get_allow_http_compression, set_allow_http_compression) ``` ## Default Value TRUE ## Remarks This property enables HTTP compression for receiving data. When set to True, the class will accept compressed data. It will then uncompress the data it has received. The class will handle data compressed by both gzip and Deflate compression algorithms. When True, the class adds an "Accept-Encoding" header to the outgoing request. The value for this header can be controlled by the [AcceptEncoding](#AcceptEncoding) config. The default value for this header is "gzip, deflate". [transferred_data](#transferred_data-property) will contain the decompressed data received by the server, but the [on_transfer](#on_transfer-event) event will report exactly what is received by the server (compressed data). # attached_file property This property includes a file to append to PostData if the POST or PUT methods are used. ## Syntax ```text def get_attached_file() -> str: ... def set_attached_file(value: str) -> None: ... attached_file = property(get_attached_file, set_attached_file) ``` ## Default Value "" ## Remarks If this property contains a nonempty string, then if the HTTP *POST* or *PUT* methods are used (through the [post](#post-method) or [put](#put-method) methods), the contents of this property are appended to the HTTP request after any data in [post_data](#post_data-property). An HTTP *Content-Length* header is also added to request. Its value is the cumulative length of the [post_data](#post_data-property) string and the file. If data are being uploaded to a web service the [WebUpload](WebUpload.md#WebUpload) class is recommended because it will automatically encode file and form variables. Alternatively, the [MIME](MIME.md#MIME) class may be used to construct the raw MIME entity, which may be sent by this property. # authorization property This property includes the Authorization string to be sent to the server. ## Syntax ```text def get_authorization() -> str: ... def set_authorization(value: str) -> None: ... authorization = property(get_authorization, set_authorization) ``` ## Default Value "" ## Remarks If the authorization property contains a nonempty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server. A common use for this property is to specify OAuth authorization string. This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class. The [auth_scheme](#auth_scheme-property) property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time [user](#user-property) and [password](#password-property) are set, they are Base64 encoded, and the result is put in the authorization property in the form "Basic [encoded-user-password]". # auth_scheme property This property specifies the authentication scheme to use when server authentication is required. ## Syntax ```text def get_auth_scheme() -> int: ... def set_auth_scheme(value: int) -> None: ... auth_scheme = property(get_auth_scheme, set_auth_scheme) ``` ## Possible Values ```text 0 # Basic1 # Digest2 # Proprietary3 # None4 # Ntlm5 # Negotiate6 # OAuth ``` ## Default Value 0 ## Remarks This property will tell the class which type of authorization to perform when the [user](#user-property) and [password](#password-property) properties are set. This property should be set to authNone (3) when no authentication is to be performed. By default, this property is authBasic (0), and if the [user](#user-property) and [password](#password-property) properties are set, the class will attempt HTTP Basic Authentication. If auth_scheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead. If auth_scheme is set to authProprietary (2), then the authorization token must be supplied through the [authorization](#authorization-property) property. If auth_scheme is set to authOAuth (6), then the authorization string must be supplied through the [authorization](#authorization-property) property. NOTE: If you set the [authorization](#authorization-property) property and auth_scheme is not authProprietary or authOAuth, then the auth_scheme will be set automatically to authProprietary (2) by the class. For security, changing the value of this property will cause the class to clear the values of [user](#user-property), [password](#password-property), and [Authorization](#Authorization). # 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. # content_type property This property includes the content type for posts and puts. ## Syntax ```text def get_content_type() -> str: ... def set_content_type(value: str) -> None: ... content_type = property(get_content_type, set_content_type) ``` ## Default Value "" ## Remarks If this property contains a nonempty string, a *Content-Type* HTTP request header is added to the request. The purpose of the header is to show the contents of the data during a [post](#post-method) or [put](#put-method) to the server. The most common example is posting of HTML form input data. In that case, this property must be set to *"application/x-www-form-urlencoded"*. # cookie_count property The number of records in the Cookie arrays. ## Syntax ```text def get_cookie_count() -> int: ... def set_cookie_count(value: int) -> None: ... cookie_count = property(get_cookie_count, set_cookie_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [cookie_domain](#cookie_domain-property) - [cookie_expiration](#cookie_expiration-property) - [cookie_name](#cookie_name-property) - [cookie_path](#cookie_path-property) - [cookie_secure](#cookie_secure-property) - [cookie_value](#cookie_value-property) The array indices start at *0* and end at *cookie_count - 1*. # cookie_domain property The domain of a received cookie. ## Syntax ```text def get_cookie_domain(cookie_index: int) -> str: ... ``` ## Default Value "" ## Remarks The domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by url_server as the cookie domain. The *cookie_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cookie_count](#cookie_count-property) property. This property is read-only. # cookie_expiration property An expiration time for the cookie (if provided by the server). ## Syntax ```text def get_cookie_expiration(cookie_index: int) -> str: ... ``` ## Default Value "" ## Remarks An expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this property will contain an empty string. The convention is to drop the cookie at the end of the session. The *cookie_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cookie_count](#cookie_count-property) property. This property is read-only. # cookie_name property The name of the cookie. ## Syntax ```text def get_cookie_name(cookie_index: int) -> str: ... def set_cookie_name(cookie_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The name of the cookie. This property, along with [cookie_value](#cookie_value-property), stores the cookie that is to be sent to the server. The on_set_cookie event displays the cookies sent by the server and their properties. The *cookie_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cookie_count](#cookie_count-property) property. # cookie_path property A path name to limit the cookie to (if provided by the server). ## Syntax ```text def get_cookie_path(cookie_index: int) -> str: ... ``` ## Default Value "" ## Remarks A path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path property will be an empty string. The convention in this case is to use the path specified by url_path as the cookie path. The *cookie_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cookie_count](#cookie_count-property) property. This property is read-only. # cookie_secure property The security flag of the received cookie. ## Syntax ```text def get_cookie_secure(cookie_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks The security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection. The *cookie_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cookie_count](#cookie_count-property) property. This property is read-only. # cookie_value property The value of the cookie. ## Syntax ```text def get_cookie_value(cookie_index: int) -> str: ... def set_cookie_value(cookie_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The value of the cookie. A corresponding value is associated with the cookie specified by [cookie_name](#cookie_name-property). This property holds that value. The on_set_cookie event provides the cookies set by the server. The *cookie_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cookie_count](#cookie_count-property) property. # 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](#HTTP_p_FirewallFirewallType) is set to a valid value. See the description of the [firewall_type](#HTTP_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. # follow_redirects property Determines what happens when the server issues a redirect. ## Syntax ```text def get_follow_redirects() -> int: ... def set_follow_redirects(value: int) -> None: ... follow_redirects = property(get_follow_redirects, set_follow_redirects) ``` ## Possible Values ```text 0 # Never1 # Always2 # SameScheme ``` ## Default Value 0 ## Remarks This property determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to frAlways (1), the new [url](#url-property) for the object is retrieved automatically every time. If this property is set to frSameScheme (2), the new [url](#url-property) is retrieved automatically only if the [url_scheme](#url_scheme-property) is the same; otherwise, the class fails with an error. NOTE: Following the HTTP specification, unless this property is set to frAlways (1), automatic redirects will be performed only for *GET* or *HEAD* requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities. Furthermore, if either the new URL server or port are different from the existing one, [user](#user-property) and [password](#password-property) are also reset to empty. If, however, this property is set to frAlways (1), the same credentials are used to connect to the new server. A [on_redirect](#on_redirect-event) event is fired for every URL the product is redirected to. In the case of automatic redirections, the [on_redirect](#on_redirect-event) event is a good place to set properties related to the new connection (e.g., new authentication parameters). The default value is frNever (0). In this case, redirects are never followed, and the class fails with an error instead. # from_address property This property includes the email address of the HTTP agent (optional). ## Syntax ```text def get_from_address() -> str: ... def set_from_address(value: str) -> None: ... from_address = property(get_from_address, set_from_address) ``` ## Default Value "" ## Remarks This property contains the email address of the HTTP agent (optional). If it contains a nonempty string, an HTTP *From:* header is added to the request. This header generally gives the email address of the requester of the document. # http_method property This property includes the HTTP method used for the request. ## Syntax ```text def get_http_method() -> str: ... def set_http_method(value: str) -> None: ... http_method = property(get_http_method, set_http_method) ``` ## Default Value "" ## Remarks This property contains the HTTP method used for the request. If an empty string is provided, the http_method is determined automatically by the method being called. You may change it to a custom value if you require an HTTP method other than what is provided by the class. When providing a custom value, make the request by calling the [post](#post-method) method. # http_version property This property includes the HTTP Version used by the class. ## Syntax ```text def get_http_version() -> str: ... def set_http_version(value: str) -> None: ... http_version = property(get_http_version, set_http_version) ``` ## Default Value "1.1" ## Remarks This property specifies the HTTP version used by the class. Possible values are as follows: - "1.0" - "1.1" (default) - "2.0" - "3.0" When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details. **HTTP/2 Notes** When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error. If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#AllowHTTPFallback) setting controls whether this behavior is allowed (default) or disallowed. **HTTP/3 Notes** HTTP/3 is supported only in .NET and Java. When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in 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. # if_modified_since property This property includes a date determining the maximum age of the desired document. ## Syntax ```text def get_if_modified_since() -> str: ... def set_if_modified_since(value: str) -> None: ... if_modified_since = property(get_if_modified_since, set_if_modified_since) ``` ## Default Value "" ## Remarks If this property contains a nonempty string, an *If-Modified-Since* HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: If the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the class fails with an error The format of the date value for if_modified_since is detailed in the HTTP specs. An example is Sat, 29 Oct 1994 19:43:31 GMT. # local_file property This property includes the path to a local file for downloading. 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 when getting a document. If this property is empty, then the received data are provided through [transferred_data](#transferred_data-property) and the [on_transfer](#on_transfer-event) event. # 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. # other_headers property Other headers as determined by the user (optional). ## Syntax ```text def get_other_headers() -> str: ... def set_other_headers(value: str) -> None: ... other_headers = property(get_other_headers, set_other_headers) ``` ## Default Value "" ## Remarks This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like [content_type](#content_type-property) and [from_address](#from_address-property). The headers must follow the format *Header: Value* as described in the HTTP specifications. Header lines should be separated by CRLF (*"\r\n"*) . Use this property with caution. If this property contains invalid headers, HTTP requests may fail. This property is useful for extending the functionality of the class beyond what is provided. # parsed_header_count property The number of records in the ParsedHeader arrays. ## Syntax ```text def get_parsed_header_count() -> int: ... parsed_header_count = property(get_parsed_header_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [parsed_header_field](#parsed_header_field-property) - [parsed_header_value](#parsed_header_value-property) The array indices start at *0* and end at *parsed_header_count - 1*. This property is read-only. # parsed_header_field property This property contains the name of the HTTP header (this is the same case as it is delivered). ## Syntax ```text def get_parsed_header_field(parsed_header_index: int) -> str: ... ``` ## Default Value "" ## Remarks This property contains the name of the HTTP [Header](#Type_Header) (this is the same case as it is delivered). The *parsed_header_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [parsed_header_count](#parsed_header_count-property) property. This property is read-only. # parsed_header_value property This property contains the header contents. ## Syntax ```text def get_parsed_header_value(parsed_header_index: int) -> str: ... ``` ## Default Value "" ## Remarks This property contains the [Header](#Type_Header) contents. The *parsed_header_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [parsed_header_count](#parsed_header_count-property) property. This property is read-only. # password property This property includes a password if authentication is to be used. ## Syntax ```text def get_password() -> str: ... def set_password(value: str) -> None: ... password = property(get_password, set_password) ``` ## Default Value "" ## Remarks This property contains a password if authentication is to be used. If [auth_scheme](#auth_scheme-property) is set to HTTP Basic Authentication, the [user](#user-property) and password are Base64 encoded and the result is put in the [Authorization](#Authorization) configuration setting in the form "Basic [encoded-user-password]". If [auth_scheme](#auth_scheme-property) is set to HTTP Digest Authentication, the [user](#user-property) and password properties are used to respond to the HTTP Digest Authentication challenge from the server. If [auth_scheme](#auth_scheme-property) is set to NTLM, NTLM authentication will be attempted. If [auth_scheme](#auth_scheme-property) is set to NTLM and [user](#user-property) and password are empty, the class will attempt to authenticate using the current user's credentials. # post_data property This property includes the data to post with the URL if the POST method is used. ## Syntax ```text def get_post_data() -> bytes: ... def set_post_data(value: bytes) -> None: ... post_data = property(get_post_data, set_post_data) ``` ## Default Value "" ## Remarks If this property has a nonempty string, then the HTTP [post](#post-method) method is used. The contents of this property are appended to the HTTP request after the HTTP headers. An HTTP *Content-Length* header is added to the request. Its value is the length of the string in post_data, or, if the [attached_file](#attached_file-property) property has been set, its value is the cumulative length of the string and the file. See the description of the [attached_file](#attached_file-property) property for details. If the goal is to upload a file or binary form data to a receiving script, the postdata must be MIME encoded. The WebUpload component is specifically designed for this and will perform all of the MIME encoding for you automatically. The WebForm component can be used for any form data posting. Posting HTML form input data is the most common example of this property. In this case, the [content_type](#content_type-property) property must be set to "application/x-www-form-urlencoded". **Example. Performing a Post:** ```text HTTPControl.ContentType = "application/x-www-form-urlencoded" HTTPControl.PostData = "firstname=Tom&lastname=Thompson&country=US" HTTPControl.Post(myurl) ``` # pragma property This property includes a browser- or server-specific header line (optional). ## Syntax ```text def get_pragma() -> str: ... def set_pragma(value: str) -> None: ... pragma = property(get_pragma, set_pragma) ``` ## Default Value "" ## Remarks If this property contains a nonempty string, a *Pragma* HTTP request header is added to the request. The meaning of the header depends on the implementation. It can be used to send or receive proprietary information to or from the server. # proxy_auth_scheme property The type of authorization to perform when connecting to the proxy. ## Syntax ```text def get_proxy_auth_scheme() -> int: ... def set_proxy_auth_scheme(value: int) -> None: ... proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme) ``` ## Possible Values ```text 0 # Basic1 # Digest2 # Proprietary3 # None4 # Ntlm5 # Negotiate ``` ## Default Value 0 ## Remarks The type of authorization to perform when connecting to the proxy. This is used only when the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are set. [proxy_auth_scheme](#proxy_auth_scheme-property) should be set to authNone (3) when no authentication is expected. By default, [proxy_auth_scheme](#proxy_auth_scheme-property) is authBasic (0), and if the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are set, the class will attempt basic authentication. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to authDigest (1), digest authentication will be attempted instead. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to authNtlm (4), NTLM authentication will be used. For security reasons, setting this property will clear the values of [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property). # proxy_auto_detect property Whether to automatically detect and use proxy system settings, if available. ## Syntax ```text def get_proxy_auto_detect() -> bool: ... def set_proxy_auto_detect(value: bool) -> None: ... proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect) ``` ## Default Value FALSE ## Remarks Whether to automatically detect and use proxy system settings, if available. The default value is *False*. # proxy_password property A password if authentication is to be used for the proxy. ## Syntax ```text def get_proxy_password() -> str: ... def set_proxy_password(value: str) -> None: ... proxy_password = property(get_proxy_password, set_proxy_password) ``` ## Default Value "" ## Remarks A password if authentication is to be used for the proxy. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to Basic Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to Digest Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are used to respond to the Digest Authentication challenge from the server. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to NTLM Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are used to authenticate through NTLM negotiation. # proxy_port property The Transmission Control Protocol (TCP) port for the proxy Server (default 80). ## Syntax ```text def get_proxy_port() -> int: ... def set_proxy_port(value: int) -> None: ... proxy_port = property(get_proxy_port, set_proxy_port) ``` ## Default Value 80 ## Remarks The Transmission Control Protocol (TCP) port for the proxy [proxy_server](#proxy_server-property) (default 80). See the description of the [proxy_server](#proxy_server-property) property for details. # proxy_server property If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. ## Syntax ```text def get_proxy_server() -> str: ... def set_proxy_server(value: str) -> None: ... proxy_server = property(get_proxy_server, set_proxy_server) ``` ## Default Value "" ## Remarks If a proxy [proxy_server](#proxy_server-property) is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the [proxy_server](#proxy_server-property) property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the [proxy_server](#proxy_server-property) property is set to the corresponding address. If the search is not successful, an error is returned. # proxy_ssl property When to use a Secure Sockets Layer (SSL) for the connection to the proxy. ## Syntax ```text def get_proxy_ssl() -> int: ... def set_proxy_ssl(value: int) -> None: ... proxy_ssl = property(get_proxy_ssl, set_proxy_ssl) ``` ## Possible Values ```text 0 # Automatic1 # Always2 # Never3 # Tunnel ``` ## Default Value 0 ## Remarks When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows: | | | | --- | --- | | psAutomatic (0) | Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option. | | psAlways (1) | The connection is always SSL-enabled. | | psNever (2) | The connection is not SSL-enabled. | | psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. | # proxy_user property A username if authentication is to be used for the proxy. ## Syntax ```text def get_proxy_user() -> str: ... def set_proxy_user(value: str) -> None: ... proxy_user = property(get_proxy_user, set_proxy_user) ``` ## Default Value "" ## Remarks A username if authentication is to be used for the proxy. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to Basic Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to Digest Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are used to respond to the Digest Authentication challenge from the server. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to NTLM Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are used to authenticate through NTLM negotiation. # range property This property includes the byte-range to be sent to the server. ## Syntax ```text def get_range() -> str: ... def set_range(value: str) -> None: ... range = property(get_range, set_range) ``` ## Default Value "" ## Remarks If this property contains a nonempty string, a *Range* HTTP request header is added to the request. This header tells the server to send only a certain range of bytes. The format of this property consists of a range of bytes specified by two numbers separated by '-' (e.g., "0-499") Following are examples of this format: | | | | --- | --- | | First 500 bytes | 0-499 | | Second 500 bytes | 500-999 | | Final 500 bytes | -500 | # referer property This property includes the referer URL/document (optional). ## Syntax ```text def get_referer() -> str: ... def set_referer(value: str) -> None: ... referer = property(get_referer, set_referer) ``` ## Default Value "" ## Remarks If this property contains a nonempty string, a *Referer* HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL. # 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. # status_line property This property is the first line of the last server response. ## Syntax ```text def get_status_line() -> str: ... status_line = property(get_status_line, None) ``` ## Default Value "" ## Remarks This property contains the first line of the last server response. This value can be used for diagnostic purposes. If an HTTP error is returned when calling a method of the class, the error string is the same as the status_line property. The HTTP protocol specifies the structure of the status_line as follows: [HTTP version] [Result Code] [Description]. This property is read-only. # 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. # transferred_data property This property includes the contents of the last response from the server. ## Syntax ```text def get_transferred_data() -> bytes: ... transferred_data = property(get_transferred_data, None) ``` ## Default Value "" ## Remarks This property contains the contents of the last response from the server. If the [local_file](#local_file-property) is empty, the data are accumulated in transferred_data and also can be received in the [on_transfer](#on_transfer-event) event. Otherwise, this property returns an empty string. [transferred_data_limit](#transferred_data_limit-property) controls the maximum amount of data accumulated in transferred_data (by default there is no limit). This property is read-only. # transferred_data_limit property This property specifies the maximum amount of data to be transferred. ## Syntax ```text def get_transferred_data_limit() -> int: ... def set_transferred_data_limit(value: int) -> None: ... transferred_data_limit = property(get_transferred_data_limit, set_transferred_data_limit) ``` ## Default Value 0 ## Remarks This property contains the maximum amount of data to be transferred. The default value is 0, which will not impose any limits on the amount of data accumulated in the [transferred_data](#transferred_data-property) property. # transferred_headers property The full set of headers as received from the server. ## Syntax ```text def get_transferred_headers() -> str: ... transferred_headers = property(get_transferred_headers, None) ``` ## Default Value "" ## Remarks This property returns the complete set of raw headers as received from the server. The [on_header](#on_header-event) event shows the individual headers as parsed by the class. This property is read-only. # url property This property specifies the URL to retrieve. ## Syntax ```text def get_url() -> str: ... def set_url(value: str) -> None: ... url = property(get_url, set_url) ``` ## Default Value "" ## Remarks This property contains the URL of the document. This value is parsed, and the results are put in the [url_scheme](#url_scheme-property), [url_server](#url_server-property), [url_port](#url_port-property), and [url_path](#url_path-property) properties. # url_path property This property specifies the path for the URL. ## Syntax ```text def get_url_path() -> str: ... def set_url_path(value: str) -> None: ... url_path = property(get_url_path, set_url_path) ``` ## Default Value "" ## Remarks This property contains the path for the URL. The URL path is determined by parsing the value set in the [url](#url-property) property. # url_port property This property specifies the port for the URL. ## Syntax ```text def get_url_port() -> int: ... def set_url_port(value: int) -> None: ... url_port = property(get_url_port, set_url_port) ``` ## Default Value 443 ## Remarks This property contains the port for the URL. The HTTP server port is determined by parsing the value set in the [url](#url-property) property. # url_scheme property This property includes the scheme for the URL. ## Syntax ```text def get_url_scheme() -> str: ... def set_url_scheme(value: str) -> None: ... url_scheme = property(get_url_scheme, set_url_scheme) ``` ## Default Value "https" ## Remarks This property contains the scheme for the URL. The URL scheme is determined by parsing the value set in the [url](#url-property) property. The supported schemes are "http" and "https". # url_server property This property specifies the server for the URL. ## Syntax ```text def get_url_server() -> str: ... def set_url_server(value: str) -> None: ... url_server = property(get_url_server, set_url_server) ``` ## Default Value "" ## Remarks This property contains the server for the URL. The HTTP server name is determined by parsing the value set in the [url](#url-property) property. # user property This property includes a user name if authentication is to be used. ## Syntax ```text def get_user() -> str: ... def set_user(value: str) -> None: ... user = property(get_user, set_user) ``` ## Default Value "" ## Remarks This property contains a user name if authentication is to be used. If [auth_scheme](#auth_scheme-property) is set to HTTP Basic Authentication, The user and [password](#password-property) are Base64 encoded, and the result is put in the [Authorization](#Authorization) property in the form "Basic [encoded-user-password]". If [auth_scheme](#auth_scheme-property) is set to HTTP Digest Authentication, the user and [password](#password-property) properties are used to respond to the HTTP Digest Authentication challenge from the server. If [auth_scheme](#auth_scheme-property) is set to NTLM, NTLM authentication will be attempted. If [auth_scheme](#auth_scheme-property) is set to NTLM, and user and [password](#password-property) are empty, the class will attempt to authenticate using the current user's credentials. # add_cookie method Adds a cookie and the corresponding value to the outgoing request headers. ## Syntax ```text def add_cookie(cookie_name: str, cookie_value: str) -> None: ... ``` ## Remarks This method adds a cookie and the corresponding value to the outgoing request headers. Please refer to the cookies property for more information on cookies and how they are managed. # calc_authorization method This method calculates the Authorization header based on provided credentials. ## Syntax ```text def calc_authorization() -> None: ... ``` ## Remarks This method calculates the [authorization](#authorization-property) value using the values provided in [auth_scheme](#auth_scheme-property), [user](#user-property), and [password](#password-property). In most cases, this method does not need to be called. The class will automatically calculate any required authorization values when a method is called, such as [get](#get-method) or [post](#post-method). This method may be useful in cases in which the [authorization](#authorization-property) value needs to be calculated before sending a request. # 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](#http-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](#http-config-settings), you must call *Config("PROPERTY")*. The value will be returned as a string. # connect method This method connects to the remote host without performing any action. ## Syntax ```text def connect() -> None: ... ``` ## Remarks This method establishes a connection with the remote host specified by [url](#url-property), but it does not send a request. In most cases, it is recommended to use the appropriate method, such as [get](#get-method) or [post](#post-method), which will both establish a connection and send a request. This method may be useful in cases in which it is desirable to establish a connection without performing any operation (e.g., when testing connectivity). # delete method This method deletes an object on the server. ## Syntax ```text def delete(url: str) -> None: ... ``` ## Remarks This method is used to delete an object at the URL specified by using the HTTP *DELETE* method. The server response text is received through the [on_transfer](#on_transfer-event) event, and the HTTP response headers through the [on_header](#on_header-event) event. If [local_file](#local_file-property) is not empty, the data (not the headers) are written there as well. Normally, the user should have assigned correct values to [user](#user-property) and [password](#password-property) or [Authorization](#Authorization). # disconnect method This method disconnects from the server. ## Syntax ```text def disconnect() -> None: ... ``` ## Remarks This method immediately disconnects from the server. In most cases, the connection is closed automatically, and this method does not need to be called. Call the disconnect method in cases in which it is desirable to immediately disconnect. # 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. # get method This retrieves the document using the HTTP GET method. ## Syntax ```text def get(url: str) -> None: ... ``` ## Remarks This retrieves the document using the HTTP *GET* method. The document contents are delivered through the [on_transfer](#on_transfer-event) event, and the HTTP response headers are delivered through the [on_header](#on_header-event) event. If [local_file](#local_file-property) is not empty, the data (not the headers) are written there as well. # head method This retrieves the document headers using the HTTP HEAD method. ## Syntax ```text def head(url: str) -> None: ... ``` ## Remarks This retrieves the document headers using the HTTP *HEAD* method. The headers are received through the [on_header](#on_header-event) event. # 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. # patch method This method partially updates data on the HTTP server using the HTTP PATCH method. ## Syntax ```text def patch(url: str) -> None: ... ``` ## Remarks This method modifies specific parts of data on the HTTP server using the HTTP *PATCH* method. Patched data are taken from the [post_data](#post_data-property) or [attached_file](#attached_file-property) properties. The server response text is received through the [on_transfer](#on_transfer-event) event, and the HTTP response headers are received through the [on_header](#on_header-event) event. If [local_file](#local_file-property) is not empty, the data (not the headers) are written there as well. # post method This method posts data to the HTTP server using the HTTP POST method. ## Syntax ```text def post(url: str) -> None: ... ``` ## Remarks This method posts data to the HTTP server using the HTTP *POST* method. Posted data are taken from the [post_data](#post_data-property) or [attached_file](#attached_file-property) properties. The server response text is received through the [on_transfer](#on_transfer-event) event, and the HTTP response headers are received through the [on_header](#on_header-event) event. If [local_file](#local_file-property) is not empty, the data (not the headers) are written there as well. If the goal is to upload a file or binary form data to a receiving script, the postdata must be [MIME](MIME.md#MIME) encoded, or you should use the [WebUpload](WebUpload.md#WebUpload) or [WebForm](WebForm.md#WebForm) component. **Example. Performing a Post:** ```text HTTPControl.ContentType = "application/x-www-form-urlencoded" HTTPControl.PostData = "firstname=Tom&lastname=Thompson&country=US" HTTPControl.Post(myurl) ``` # put method This method sends data to the HTTP server using the HTTP PUT method. ## Syntax ```text def put(url: str) -> None: ... ``` ## Remarks This method sends data to the HTTP server. The data are taken from the [post_data](#post_data-property) or [attached_file](#attached_file-property) properties. The server response text is received through the [on_transfer](#on_transfer-event) event, and the HTTP response headers are received through the [on_header](#on_header-event) event. If [local_file](#local_file-property) is not empty, the data (not the headers) are written there as well. The user normally should have assigned the correct values to [user](#user-property) and [password](#password-property) or [Authorization](#Authorization). # query method Sends a query to the HTTP server using the HTTP QUERY method. ## Syntax ```text def query(url: str) -> None: ... ``` ## Remarks This method sends a query to the HTTP server using the HTTP *QUERY* method, which is used to safely request data from the server by sending the query in the body of the request instead of encoding it in the URL. This is useful when the query is too large or complex to be expressed as a query string. Query data are taken from the [post_data](#post_data-property) or [attached_file](#attached_file-property) properties. The server response text is received through the [on_transfer](#on_transfer-event) event, and the HTTP response headers are received through the [on_header](#on_header-event) event. If [local_file](#local_file-property) is not empty, the data (not the headers) are written there as well. ```text HTTPControl.ContentType = "application/x-www-form-urlencoded" HTTPControl.PostData = "firstname=Tom&lastname=Thompson&country=US" HTTPControl.Query(myurl) ``` # 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. # reset_headers method This method resets all HTTP headers, cookies, LocalFile , and AttachedFile . ## Syntax ```text def reset_headers() -> None: ... ``` ## Remarks This method resets all the HTTP headers as well as [local_file](#local_file-property) and [attached_file](#attached_file-property) to "" (empty string). It also resets the cookie properties. Use this method before creating a new request to ensure that headers from the previous message are not carried over to the next one. # on_connected event Fired immediately after a connection completes (or fails). ## Syntax ```text class HTTPConnectedEventParams(object): @property def status_code() -> int: ... @property def description() -> str: ... # In class HTTP: @property def on_connected() -> Callable[[HTTPConnectedEventParams], None]: ... @on_connected.setter def on_connected(event_hook: Callable[[HTTPConnectedEventParams], None]) -> None: ... ``` ## Remarks If the connection is made normally, *status_code* is 0 and *description* is "OK". If the connection fails, *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. Please refer to the [Error Codes](#http-errors) section for more information. # on_connection_status event Fired to indicate changes in the connection state. ## Syntax ```text class HTTPConnectionStatusEventParams(object): @property def connection_event() -> str: ... @property def status_code() -> int: ... @property def description() -> str: ... # In class HTTP: @property def on_connection_status() -> Callable[[HTTPConnectionStatusEventParams], None]: ... @on_connection_status.setter def on_connection_status(event_hook: Callable[[HTTPConnectionStatusEventParams], 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_disconnected event Fired when a connection is closed. ## Syntax ```text class HTTPDisconnectedEventParams(object): @property def status_code() -> int: ... @property def description() -> str: ... # In class HTTP: @property def on_disconnected() -> Callable[[HTTPDisconnectedEventParams], None]: ... @on_disconnected.setter def on_disconnected(event_hook: Callable[[HTTPDisconnectedEventParams], None]) -> None: ... ``` ## Remarks If the connection is broken normally, *status_code* is 0 and *description* is "OK". If the connection is broken for any other reason, *status_code* has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. *description* contains a description of this code. The value of *status_code* is equal to the value of the TCP/IP error. Please refer to the [Error Codes](#http-errors) section for more information. # on_end_transfer event Fired when a document finishes transferring. ## Syntax ```text class HTTPEndTransferEventParams(object): @property def direction() -> int: ... # In class HTTP: @property def on_end_transfer() -> Callable[[HTTPEndTransferEventParams], None]: ... @on_end_transfer.setter def on_end_transfer(event_hook: Callable[[HTTPEndTransferEventParams], None]) -> None: ... ``` ## Remarks This event is fired first when the client finishes sending data to the server (in a *POST* or *PUT* request) and then when the document text finishes transferring from the server to the local host. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. # on_error event Fired when information is available about errors during data delivery. ## Syntax ```text class HTTPErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class HTTP: @property def on_error() -> Callable[[HTTPErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[HTTPErrorEventParams], 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](#http-errors) section. # on_header event Fired every time a header line comes in. ## Syntax ```text class HTTPHeaderEventParams(object): @property def field() -> str: ... @property def value() -> str: ... # In class HTTP: @property def on_header() -> Callable[[HTTPHeaderEventParams], None]: ... @on_header.setter def on_header(event_hook: Callable[[HTTPHeaderEventParams], None]) -> None: ... ``` ## Remarks The *field* parameter contains the name of the HTTP header (which is the same as it is delivered). The *value* parameter contains the header contents. If the header line being retrieved is a continuation header line, then the *field* parameter contains "" (empty string). # on_log event Fired once for each log message. ## Syntax ```text class HTTPLogEventParams(object): @property def log_level() -> int: ... @property def message() -> str: ... @property def log_type() -> str: ... # In class HTTP: @property def on_log() -> Callable[[HTTPLogEventParams], None]: ... @on_log.setter def on_log(event_hook: Callable[[HTTPLogEventParams], None]) -> None: ... ``` ## Remarks This event is fired once for each log message generated by the class. The verbosity is controlled by the [LogLevel](#LogLevel) setting. *log_level* indicates the level of message. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). *message* is the log entry. *log_type* identifies the type of log entry. Possible values are as follows: - "Info" - "RequestHeaders" - "ResponseHeaders" - "RequestBody" - "ResponseBody" - "ProxyRequest" - "ProxyResponse" - "FirewallRequest" - "FirewallResponse" # on_redirect event Fired when a redirection is received from the server. ## Syntax ```text class HTTPRedirectEventParams(object): @property def location() -> str: ... @property def accept() -> bool: ... @accept.setter def accept(value) -> None: ... # In class HTTP: @property def on_redirect() -> Callable[[HTTPRedirectEventParams], None]: ... @on_redirect.setter def on_redirect(event_hook: Callable[[HTTPRedirectEventParams], None]) -> None: ... ``` ## Remarks This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The *accept* parameter is always True by default, but if you do not want to follow the redirection, *accept* may be set to False, in which case the class fails with an error. *location* is the location to which the client is being redirected. Further control over redirection is provided in the [follow_redirects](#follow_redirects-property) property. # on_set_cookie event Fired for every cookie set by the server. ## Syntax ```text class HTTPSetCookieEventParams(object): @property def name() -> str: ... @property def value() -> str: ... @property def expires() -> str: ... @property def domain() -> str: ... @property def path() -> str: ... @property def secure() -> bool: ... # In class HTTP: @property def on_set_cookie() -> Callable[[HTTPSetCookieEventParams], None]: ... @on_set_cookie.setter def on_set_cookie(event_hook: Callable[[HTTPSetCookieEventParams], None]) -> None: ... ``` ## Remarks This event is fired for every *Set-Cookie:* header received from the HTTP server. The *name* parameter contains the name of the cookie, with the corresponding value supplied in the *value* parameter. The *expires* parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the *expires* parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session. The *domain* parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the *domain* parameter will be an empty string. The convention in this case is to use the server specified in the URL ([url_server](#url_server-property)) as the cookie domain. The *path* parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the *path* parameter will be an empty string. The convention in this case is to use the path specified in the URL ([url_path](#url_path-property)) as the cookie path. The *secure* parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection. # on_ssl_server_authentication event Fired after the server presents its certificate to the client. ## Syntax ```text class HTTPSSLServerAuthenticationEventParams(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 HTTP: @property def on_ssl_server_authentication() -> Callable[[HTTPSSLServerAuthenticationEventParams], None]: ... @on_ssl_server_authentication.setter def on_ssl_server_authentication(event_hook: Callable[[HTTPSSLServerAuthenticationEventParams], 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 HTTPSSLStatusEventParams(object): @property def message() -> str: ... # In class HTTP: @property def on_ssl_status() -> Callable[[HTTPSSLStatusEventParams], None]: ... @on_ssl_status.setter def on_ssl_status(event_hook: Callable[[HTTPSSLStatusEventParams], 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 Fired when a document starts transferring (after the headers). ## Syntax ```text class HTTPStartTransferEventParams(object): @property def direction() -> int: ... # In class HTTP: @property def on_start_transfer() -> Callable[[HTTPStartTransferEventParams], None]: ... @on_start_transfer.setter def on_start_transfer(event_hook: Callable[[HTTPStartTransferEventParams], None]) -> None: ... ``` ## Remarks This event is fired first when the client starts sending data to the server (in a *POST* or *PUT* request) and then when the document text starts transferring from the server to the local host. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. # on_status event Fired when the HTTP status line is received from the server. ## Syntax ```text class HTTPStatusEventParams(object): @property def http_version() -> str: ... @property def status_code() -> int: ... @property def description() -> str: ... # In class HTTP: @property def on_status() -> Callable[[HTTPStatusEventParams], None]: ... @on_status.setter def on_status(event_hook: Callable[[HTTPStatusEventParams], None]) -> None: ... ``` ## Remarks *http_version* is a string containing the HTTP version string as returned from the server (e.g., "1.1"). *status_code* contains the HTTP status code (e.g., 200), and *description* the associated message returned by the server (e.g., "OK"). # on_transfer event Fired while a document transfers (delivers document). ## Syntax ```text class HTTPTransferEventParams(object): @property def direction() -> int: ... @property def bytes_transferred() -> int: ... @property def percent_done() -> int: ... @property def text() -> bytes: ... # In class HTTP: @property def on_transfer() -> Callable[[HTTPTransferEventParams], None]: ... @on_transfer.setter def on_transfer(event_hook: Callable[[HTTPTransferEventParams], None]) -> None: ... ``` ## Remarks The *text* parameter contains the portion of the document text being received. It is empty if data are being posted to the server. The *bytes_transferred* parameter contains the number of bytes transferred in this *direction* since the beginning of the document text (excluding HTTP response headers). 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. # HTTP 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. ### HTTP Config Settings **AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#AllowHTTPCompression) is True, the class adds an *Accept-Encoding* header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the *Accept-Encoding* header. NOTE: The class only supports gzip and deflate decompression algorithms. **AllowHTTPCompression**: This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms. When True, the class adds an *Accept-Encoding* header to the outgoing request. The value for this header can be controlled by the [AcceptEncoding](#AcceptEncoding) configuration setting. The default value for this header is "gzip, deflate". The default value is True. **AllowHTTPFallback**: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when [http_version](#http_version-property) is set to "2.0". If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2. The default value is True. **Append**: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to [local_file](#local_file-property). When set to True, downloaded data will be appended to [local_file](#local_file-property). This may be used in conjunction with [range](#range-property) to resume a failed download. This is applicable only when [local_file](#local_file-property) is set. The default value is False. **Authorization**: The Authorization string to be sent to the server.If the [Authorization](#Authorization) property contains a nonempty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server. This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class. The [auth_scheme](#auth_scheme-property) property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time [user](#user-property) and [password](#password-property) are set, they are Base64 encoded, and the result is put in the [authorization](#authorization-property) property in the form "Basic [encoded-user-password]". **BytesTransferred**: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the [on_transfer](#on_transfer-event) event, by [BytesTransferred](#BytesTransferred). **ChunkSize**: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when [UseChunkedEncoding](#UseChunkedEncoding) is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384. **CompressHTTPRequest**: Set to true to compress the body of a PUT or POST request.If set to True, the body of a *PUT* or *POST* request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request. The default value is False. **EncodeURL**: If set to True the URL will be encoded by the class.If set to True, the URL passed to the class will be URL encoded. The default value is False. **FollowRedirects**: Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new [url](#url-property) for the object is retrieved automatically every time. If this property is set to 2 (Same Scheme), the new [url](#url-property) is retrieved automatically only if the URL Scheme is the same; otherwise, the class fails with an error. **Note:** Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for *GET* or *HEAD* requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities. Furthermore, if either the new URL server or port are different from the existing one, [user](#user-property) and [password](#password-property) are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server. A [on_redirect](#on_redirect-event) event is fired for every URL the product is redirected to. In the case of automatic redirections, the [on_redirect](#on_redirect-event) event is a good place to set properties related to the new connection (e.g., new authentication parameters). The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead. Following are the valid options: - 0 - Never - 1 - Always - 2 - Same Scheme **GetOn302Redirect**: If set to True the class will perform a GET on the new location.The default value is False. If set to True, the class will perform a *GET* on the new location. Otherwise, it will use the same HTTP method again. **HTTP2HeadersWithoutIndexing**: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names. **HTTPVersion**: The version of HTTP used by the class.This property specifies the HTTP version used by the class. Possible values are as follows: - "1.0" - "1.1" (default) - "2.0" - "3.0" When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details. **HTTP/2 Notes** When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error. If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#AllowHTTPFallback) setting controls whether this behavior is allowed (default) or disallowed. **HTTP/3 Notes** HTTP/3 is supported only in .NET and Java. When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error. **IfModifiedSince**: A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: ```text Sat, 29 Oct 2017 19:43:31 GMT. ``` **KeepAlive**: Determines whether the HTTP connection is closed after completion of the request.If *True*, the component will not send the *Connection: Close* header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If *False*, the connection will be closed immediately after the server response is received. The default value for [KeepAlive](#KeepAlive) is *False*. **KerberosSPN**: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here. **LogLevel**: The level of detail that is logged.This configuration setting controls the level of detail that is logged through the [on_log](#on_log-event) event. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). **MaxRedirectAttempts**: Limits the number of redirects that are followed in a request.When [follow_redirects](#follow_redirects-property) is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20. **NegotiatedHTTPVersion**: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When [http_version](#http_version-property) is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used. **OtherHeaders**: Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers. The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF (*"\r\n"*) . Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail. This configuration setting is useful for extending the functionality of the class beyond what is provided. **ProxyAuthorization**: The authorization string to be sent to the proxy server.This is similar to the [Authorization](#Authorization) configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a *Proxy-Authorization* HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) are specified, this value is calculated using the algorithm specified by [proxy_auth_scheme](#proxy_auth_scheme-property). **ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyPassword**: A password if authentication is to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyServer**: Name or IP address of a proxy server (optional).This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyUser**: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties. **SentHeaders**: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client. **StatusCode**: The status code of the last response from the server.This configuration setting contains the result code of the last response from the server. **StatusLine**: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be *[HTTP version] [Result Code] [Description]*. **TransferredData**: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server. **TransferredDataLimit**: The maximum number of incoming bytes to be stored by the class.If [TransferredDataLimit](#TransferredDataLimit) is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class. **TransferredHeaders**: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server. **TransferredRequest**: The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request: .NET ```text Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); ``` C++ ```text HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest")); ``` **UseChunkedEncoding**: Enables or Disables HTTP chunked encoding for transfers.If [UseChunkedEncoding](#UseChunkedEncoding) is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False. NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding. **UseIDNs**: Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name). The default value is False and the hostname will always be used exactly as specified. NOTE: The [CodePage](#CodePage) setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set [CodePage](#CodePage) to *65001*. In the C++ Edition for Windows, the *W version of the class must be used. For instance, *DNSW* or *HTTPW*. **UsePlatformHTTPClient**: Whether or not to use the platform HTTP client.When using this configuration setting, if True, the component will use the default HTTP client for the platform (*URLConnection* in Java, *WebRequest* in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine). NOTE: This setting is applicable only to Mac/iOS editions. **UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and [proxy_auto_detect](#proxy_auto_detect-property) is set to *True*. When *True* (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use. **UserAgent**: Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com". Override the default with the name and version of your software. ### TCPClient Config Settings **ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use [timeout](#timeout-property) for establishing a connection and transmitting/receiving data. **FirewallAutoDetect**: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classes that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned. NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting. **FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error. NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by classes that do not directly expose Firewall properties. **FirewallType**: Determines the type of firewall to connect through.Possible values are as follows: | | | | --- | --- | | 0 | No firewall (default setting). | | 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error. NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. **Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action. **LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [local_host](#local_host-property) setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface. If the class is connected, the [local_host](#local_host-property) setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). **LocalPort**: The port in the local host where the class binds. This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established. local_port cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems. **MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an eol string. If an eol string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the on_data_in event is fired with the *EOL* parameter set to True, and the buffer is reset. If no eol is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the on_data_in event is fired with the *EOL* parameter set to False, and the buffer is reset. The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes. **MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. **ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: *www.google.com;www.example.com* **TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets. NOTE: This value is not applicable in Java. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **UseIPv6**: Whether to use IPv6.When set to *0* (default), the class will use IPv4 exclusively. When set to *1*, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 only | | 1 | IPv6 only | | 2 | IPv6 with IPv4 fallback | **UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1. ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [ssl_provider](#ssl_provider-property) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes. When enabled, SSL packet logs are output using the [on_ssl_status](#on_ssl_status-event) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if [ssl_provider](#ssl_provider-property) is set to *Platform*. **OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL. The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL. The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences: -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL. The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH". **OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL. By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG. **ReuseSSLSession**: Determines if the SSL session is reused. If set to True, the class will reuse the context if and only if the following criteria are met: - The target host name is the same. - The system cache entry has not expired (default timeout is 10 hours). - The application process that calls the function is the same. - The logon session is the same. - The instance of the class is the same. **SSLCACertFilePaths**: The paths to CA certificate files on Unix/Linux.This configuration setting specifies the paths on disk to CA certificate files on Unix/Linux. The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates. The default value is as follows: */etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem* **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [ssl_provider](#ssl_provider-property) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the ssl_cert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the class will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error. When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the class fails with an error. When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated. NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [on_ssl_status](#on_ssl_status-event) event. Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when ssl_authenticate_clients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation. By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the class will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when [ssl_provider](#ssl_provider-property) is set to *Platform* include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); ``` Possible values when [ssl_provider](#ssl_provider-property) is set to *Platform* include the following: - CALG_3DES - CALG_3DES_112 - CALG_AES - CALG_AES_128 - CALG_AES_192 - CALG_AES_256 - CALG_AGREEDKEY_ANY - CALG_CYLINK_MEK - CALG_DES - CALG_DESX - CALG_DH_EPHEM - CALG_DH_SF - CALG_DSS_SIGN - CALG_ECDH - CALG_ECDH_EPHEM - CALG_ECDSA - CALG_ECMQV - CALG_HASH_REPLACE_OWF - CALG_HUGHES_MD5 - CALG_HMAC - CALG_KEA_KEYX - CALG_MAC - CALG_MD2 - CALG_MD4 - CALG_MD5 - CALG_NO_SIGN - CALG_OID_INFO_CNG_ONLY - CALG_OID_INFO_PARAMETERS - CALG_PCT1_MASTER - CALG_RC2 - CALG_RC4 - CALG_RC5 - CALG_RSA_KEYX - CALG_RSA_SIGN - CALG_SCHANNEL_ENC_KEY - CALG_SCHANNEL_MAC_KEY - CALG_SCHANNEL_MASTER_HASH - CALG_SEAL - CALG_SHA - CALG_SHA1 - CALG_SHA_256 - CALG_SHA_384 - CALG_SHA_512 - CALG_SKIPJACK - CALG_SSL2_MASTER - CALG_SSL3_MASTER - CALG_SSL3_SHAMD5 - CALG_TEK - CALG_TLS1_MASTER - CALG_TLS1PRF Example values when [ssl_provider](#ssl_provider-property) is set to *Internal*include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA"); ``` Possible values when [ssl_provider](#ssl_provider-property) is set to *Internal* include the following: - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 - TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA - TLS_DHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA - TLS_DHE_DSS_WITH_AES_256_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_DES_CBC_SHA - TLS_DHE_RSA_WITH_DES_CBC_SHA - TLS_DHE_DSS_WITH_DES_CBC_SHA - TLS_RSA_WITH_RC4_128_MD5 - TLS_RSA_WITH_RC4_128_SHA When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength). **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols. Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values: | | | | --- | --- | | TLS1.3 | 12288 (Hex 3000) | | TLS1.2 | 3072 (Hex C00) (Default - Client and Server) | | TLS1.1 | 768 (Hex 300) (Default - Client) | | TLS1 | 192 (Hex C0) (Default - Client) | | SSL3 | 48 (Hex 30) | | SSL2 | 12 (Hex 0C) | Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases. **SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:** By default when TLS 1.3 is enabled, the class will first try to use the platform TLS 1.3 implementation when the [ssl_provider](#ssl_provider-property) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. In editions that are designed to run on Windows, [ssl_provider](#ssl_provider-property) can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version. If set to *1* (Platform provider), please be aware of the following notes: - The platform provider is available only on Windows 11/Windows Server 2022 and up. - [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported. - If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions. **SSLEnabledProtocols: SSL2 and SSL3 Notes: ** SSL 2.0 and 3.0 are not supported by the class when the [ssl_provider](#ssl_provider-property) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [ssl_provider](#ssl_provider-property) needs to be set to platform. **SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *False* by default, but it can be set to *True* to enable the extension. This configuration setting is applicable only when [ssl_provider](#ssl_provider-property) is set to *Internal*. **SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event) event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event) event. This includes the leaf certificate, any intermediate certificate, and the root certificate. **SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when [ssl_provider](#ssl_provider-property) is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions: | | | | --- | --- | | 0x00000001 | Ignore time validity status of certificate. | | 0x00000002 | Ignore time validity status of CTL. | | 0x00000004 | Ignore non-nested certificate times. | | 0x00000010 | Allow unknown certificate authority. | | 0x00000020 | Ignore wrong certificate usage. | | 0x00000100 | Ignore unknown certificate revocation status. | | 0x00000200 | Ignore unknown CTL signer revocation status. | | 0x00000400 | Ignore unknown certificate authority revocation status. | | 0x00000800 | Ignore unknown root revocation status. | | 0x00008000 | Allow test root certificate. | | 0x00004000 | Trust test root certificate. | | 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). | This functionality is currently not available when the provider is OpenSSL. **SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [ssl_provider](#ssl_provider-property) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class fails with an error. The format of this value is a comma-separated list of hash-signature combinations. For instance: ```csharp component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); ``` The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*. To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. **TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC. The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*. When using TLS 1.2 and [ssl_provider](#ssl_provider-property) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported: - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) **TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server. The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting. NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group. In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" - "ffdhe_6144" - "ffdhe_8192" **TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following: - "ed25519" (default) - "ed448" (default) - "ecdsa_secp256r1_sha256" (default) - "ecdsa_secp384r1_sha384" (default) - "ecdsa_secp521r1_sha512" (default) - "rsa_pkcs1_sha256" (default) - "rsa_pkcs1_sha384" (default) - "rsa_pkcs1_sha512" (default) - "rsa_pss_sha256" (default) - "rsa_pss_sha384" (default) - "rsa_pss_sha512" (default) The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3. **TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" (default) - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" (default) - "ffdhe_6144" (default) - "ffdhe_8192" (default) - "mlkem_512" (default) - "mlkem_768" (default) - "mlkem_1024" (default) - "x25519_mlkem_768" (default) - "secp256r1_mlkem_768" (default) Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported: - Windows Server 2025 - Windows 11 24H2 - Windows 11 25H2 ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [timeout](#timeout-property) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (UDP) ports. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *True* to mask sensitive data. The default is *True*. **ProcessIdleEvents**: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True. **SelectWaitMillis**: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when [do_events](#do_events-method) is called, the class will wait for the amount of time specified here before returning. The default value is 20. **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. # HTTP Errors ### HTTP Errors | | | | --- | --- | | 118 | Firewall error. The error description contains the detailed message. | | 143 | Busy executing current method. | | 151 | HTTP protocol error. The error message has the server response. | | 152 | No server specified in [url](#url-property). | | 153 | Specified [url_scheme](#url_scheme-property) is invalid. | | 155 | Range operation is not supported by server. | | 156 | Invalid cookie index (out of range). | | 301 | Interrupted. | | 302 | Cannot open [attached_file](#attached_file-property). | The class may also return one of the following error codes, which are inherited from other classes. ### TCPClient Errors | | | | --- | --- | | 100 | You cannot change the remote_port at this time. A connection is in progress. | | 101 | You cannot change the remote_host (Server) at this time. A connection is in progress. | | 102 | The remote_host address is invalid (0.0.0.0). | | 104 | Already connected. If you want to reconnect, close the current connection first. | | 106 | You cannot change the local_port at this time. A connection is in progress. | | 107 | You cannot change the [local_host](#local_host-property) at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | remote_port cannot be zero. Please specify a valid service port number. | | 117 | You cannot change the UseConnection option while the class is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 302 | Could not open file. | | 434 | Unable to convert string to selected CodePage. | | 1105 | Already connecting. If you want to reconnect, close the current connection first. | | 1117 | You need to connect first. | | 1119 | You cannot change the LocalHost at this time. A connection is in progress. | | 1120 | Connection dropped by remote host. | ### SSL Errors | | | | --- | --- | | 270 | Cannot load specified security library. | | 271 | Cannot open certificate store. | | 272 | Cannot find specified certificate. | | 273 | Cannot acquire security credentials. | | 274 | Cannot find certificate chain. | | 275 | Cannot verify certificate chain. | | 276 | Error during handshake. | | 280 | Error verifying certificate. | | 281 | Could not find client certificate. | | 282 | Could not find server certificate. | | 283 | Error encrypting data. | | 284 | Error decrypting data. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). |