# Struct ipworksmq::AzureRelayProxy Allows local connections to be proxied to the Azure Relay Service. ## Syntax ```text ipworksmq::AzureRelayProxy ``` ## Remarks The [AzureRelayProxy](#struct-ipworksmqazurerelayproxy) struct is designed to listen locally and forward received data over a connection to the Azure Relay Service. This allows any TCP-based client to connect and send data to Azure Relay Service without any additional knowledge. When listening and a client connects a corresponding connection is made to the specified [namespace_address](#namespace_address-property-azurerelayproxy-struct) and data then flows freely between the connected client and the Azure Relay Service. Each new connection made to [AzureRelayProxy](#struct-ipworksmqazurerelayproxy) results in a new connection made to the Azure Relay Service. Connections are not shared between clients. The diagram below illustrates the design of this struct. ```text +---------+ +----------+ Client A <---- TCP ----> | Azure | <==== WebSocket ====> | Azure | Client B <---- TCP ----> | Relay | <==== WebSocket ====> | Relay | Client C <---- TCP ----> | Proxy | <==== WebSocket ====> | Service | +---------+ +----------+ ``` ### Authenticating and Listening Authentication to Azure Relay is performed using the Shared Access Key Name and Shared Access Key created from the Azure portal for the Relay. To begin listening for incoming connections set [listening](#listening-property-azurerelayproxy-struct) to *True*. When set to *True* the struct will begin listening for incoming connection. When a connection is made a corresponding connection is made to the Azure Relay Service. The following properties are required when setting [listening](#listening-property-azurerelayproxy-struct): - [access_key](#access_key-property-azurerelayproxy-struct) (required) - [access_key_name](#access_key_name-property-azurerelayproxy-struct) (required) - [hybrid_connection](#hybrid_connection-property-azurerelayproxy-struct) (required) - [namespace_address](#namespace_address-property-azurerelayproxy-struct) (required) To use SSL for incoming connections set ssl_cert to a valid certificate with private key and set [ssl_enabled](#ssl_enabled-property-azurerelayproxy-struct) to *True* before setting [listening](#listening-property-azurerelayproxy-struct). [do_events](#do_events-method-azurerelayproxy-struct) should be called in a loop to ensure timely processing of all activity, including connection requests and data transfer. To stop listening set [listening](#listening-property-azurerelayproxy-struct) to *False*. To shutdown the server including existing connections call [shutdown](#shutdown-method-azurerelayproxy-struct). ### Handling Connections When a connection is made the [on_connection_request](#on_connection_request-event-azurerelayproxy-struct) event fires with information about the connecting client. From within this event the client connection may be accepted (default) or rejected. If the client connection is accepted the [on_connected](#on_connected-event-azurerelayproxy-struct) event fire when the connection completes and is ready to send and receive data. Data will be proxied between the connected client and the Azure Relay Service. No special steps are required. When the client disconnects the [on_disconnected](#on_disconnected-event-azurerelayproxy-struct) event fires. To initiate the client disconnection call [disconnect](#disconnect-method-azurerelayproxy-struct). ### Object Lifetime The *new()* method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksMQ. Due to this, the AzureRelayProxy struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of AzureRelayProxy when you have finished using the instance. ## Property List *The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [access_key](#access_key-property-azurerelayproxy-struct) | The Shared Access Key. | | [access_key_name](#access_key_name-property-azurerelayproxy-struct) | The Shared Access Key Name. | | [connection_backlog](#connection_backlog-property-azurerelayproxy-struct) | This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem. | | [azure_relay_proxy_connection_count](#azure_relay_proxy_connection_count-property-azurerelayproxy-struct) | The number of records in the AzureRelayProxyConnection arrays. | | [azure_relay_proxy_connection_connected](#azure_relay_proxy_connection_connected-property-azurerelayproxy-struct) | This property indicates the status of individual connections. | | [azure_relay_proxy_connection_connection_id](#azure_relay_proxy_connection_connection_id-property-azurerelayproxy-struct) | This property contains an identifier generated by the struct to identify each connection. | | [azure_relay_proxy_connection_idle_timeout](#azure_relay_proxy_connection_idle_timeout-property-azurerelayproxy-struct) | This property contains the idle timeout for this connection. | | [azure_relay_proxy_connection_local_address](#azure_relay_proxy_connection_local_address-property-azurerelayproxy-struct) | This property shows the IP address of the interface through which the connection is passing. | | [azure_relay_proxy_connection_remote_host](#azure_relay_proxy_connection_remote_host-property-azurerelayproxy-struct) | This property shows the IP address of the remote host through which the connection is coming. | | [azure_relay_proxy_connection_remote_port](#azure_relay_proxy_connection_remote_port-property-azurerelayproxy-struct) | This property shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming. | | [azure_relay_proxy_connection_timeout](#azure_relay_proxy_connection_timeout-property-azurerelayproxy-struct) | This property specifies a timeout for the struct. | | [azure_relay_proxy_connection_user_data](#azure_relay_proxy_connection_user_data-property-azurerelayproxy-struct) | The UserData property holds connection-specific user-specified data. | | [default_idle_timeout](#default_idle_timeout-property-azurerelayproxy-struct) | This property includes the default idle timeout for inactive clients. | | [default_timeout](#default_timeout-property-azurerelayproxy-struct) | This property includes an initial timeout value to be used by incoming connections. | | [hybrid_connection](#hybrid_connection-property-azurerelayproxy-struct) | The hybrid connection name. | | [keep_alive](#keep_alive-property-azurerelayproxy-struct) | When True, KEEPALIVE packets are enabled (for long connections). | | [linger](#linger-property-azurerelayproxy-struct) | When set to True, connections are terminated gracefully. | | [listening](#listening-property-azurerelayproxy-struct) | This property indicates whether the struct is listening for incoming connections on LocalPort. | | [local_host](#local_host-property-azurerelayproxy-struct) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [local_port](#local_port-property-azurerelayproxy-struct) | This property includes the Transmission Control Protocol (TCP) port in the local host where the struct listens. | | [namespace_address](#namespace_address-property-azurerelayproxy-struct) | The namespace address of the relay. | | [ssl_authenticate_clients](#ssl_authenticate_clients-property-azurerelayproxy-struct) | If set to True, the server asks the client(s) for a certificate. | | [ssl_cert_effective_date](#ssl_cert_effective_date-property-azurerelayproxy-struct) | The date on which this certificate becomes valid. | | [ssl_cert_expiration_date](#ssl_cert_expiration_date-property-azurerelayproxy-struct) | The date on which the certificate expires. | | [ssl_cert_extended_key_usage](#ssl_cert_extended_key_usage-property-azurerelayproxy-struct) | A comma-delimited list of extended key usage identifiers. | | [ssl_cert_fingerprint](#ssl_cert_fingerprint-property-azurerelayproxy-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssl_cert_fingerprint_sha1](#ssl_cert_fingerprint_sha1-property-azurerelayproxy-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssl_cert_fingerprint_sha256](#ssl_cert_fingerprint_sha256-property-azurerelayproxy-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssl_cert_issuer](#ssl_cert_issuer-property-azurerelayproxy-struct) | The issuer of the certificate. | | [ssl_cert_private_key](#ssl_cert_private_key-property-azurerelayproxy-struct) | The private key of the certificate (if available). | | [ssl_cert_private_key_available](#ssl_cert_private_key_available-property-azurerelayproxy-struct) | Whether a PrivateKey is available for the selected certificate. | | [ssl_cert_private_key_container](#ssl_cert_private_key_container-property-azurerelayproxy-struct) | The name of the PrivateKey container for the certificate (if available). | | [ssl_cert_public_key](#ssl_cert_public_key-property-azurerelayproxy-struct) | The public key of the certificate. | | [ssl_cert_public_key_algorithm](#ssl_cert_public_key_algorithm-property-azurerelayproxy-struct) | The textual description of the certificate's public key algorithm. | | [ssl_cert_public_key_length](#ssl_cert_public_key_length-property-azurerelayproxy-struct) | The length of the certificate's public key (in bits). | | [ssl_cert_serial_number](#ssl_cert_serial_number-property-azurerelayproxy-struct) | The serial number of the certificate encoded as a string. | | [ssl_cert_signature_algorithm](#ssl_cert_signature_algorithm-property-azurerelayproxy-struct) | The text description of the certificate's signature algorithm. | | [ssl_cert_store](#ssl_cert_store-property-azurerelayproxy-struct) | The name of the certificate store for the client certificate. | | [ssl_cert_store_password](#ssl_cert_store_password-property-azurerelayproxy-struct) | 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-azurerelayproxy-struct) | The type of certificate store for this certificate. | | [ssl_cert_subject_alt_names](#ssl_cert_subject_alt_names-property-azurerelayproxy-struct) | Comma-separated lists of alternative subject names for the certificate. | | [ssl_cert_thumbprint_md5](#ssl_cert_thumbprint_md5-property-azurerelayproxy-struct) | The MD5 hash of the certificate. | | [ssl_cert_thumbprint_sha1](#ssl_cert_thumbprint_sha1-property-azurerelayproxy-struct) | The SHA-1 hash of the certificate. | | [ssl_cert_thumbprint_sha256](#ssl_cert_thumbprint_sha256-property-azurerelayproxy-struct) | The SHA-256 hash of the certificate. | | [ssl_cert_usage](#ssl_cert_usage-property-azurerelayproxy-struct) | The text description of UsageFlags . | | [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-azurerelayproxy-struct) | The flags that show intended use for the certificate. | | [ssl_cert_version](#ssl_cert_version-property-azurerelayproxy-struct) | The certificate's version number. | | [ssl_cert_subject](#ssl_cert_subject-property-azurerelayproxy-struct) | The subject of the certificate used for client authentication. | | [ssl_cert_encoded](#ssl_cert_encoded-property-azurerelayproxy-struct) | The certificate (PEM/Base64 encoded). | | [ssl_enabled](#ssl_enabled-property-azurerelayproxy-struct) | This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. | | [ssl_start_mode](#ssl_start_mode-property-azurerelayproxy-struct) | This property determines how the struct starts the Secure Sockets Layer (SSL) negotiation. | ## Method List *The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [config](#config-method-azurerelayproxy-struct) | Sets or retrieves a configuration setting. | | [disconnect](#disconnect-method-azurerelayproxy-struct) | This method disconnects the specified client. | | [do_events](#do_events-method-azurerelayproxy-struct) | This method processes events from the internal message queue. | | [reset](#reset-method-azurerelayproxy-struct) | This method will reset the struct. | | [shutdown](#shutdown-method-azurerelayproxy-struct) | This method shuts down the server. | | [start_listening](#start_listening-method-azurerelayproxy-struct) | This method starts listening for incoming connections. | | [stop_listening](#stop_listening-method-azurerelayproxy-struct) | This method stops listening for new connections. | ## Event List *The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [on_connected](#on_connected-event-azurerelayproxy-struct) | This event is fired immediately after a connection completes (or fails). | | [on_connection_request](#on_connection_request-event-azurerelayproxy-struct) | This event is fired when a request for connection comes from a remote host. | | [on_disconnected](#on_disconnected-event-azurerelayproxy-struct) | This event is fired when a connection is closed. | | [on_error](#on_error-event-azurerelayproxy-struct) | This event fires information about errors during data delivery. | | [on_log](#on_log-event-azurerelayproxy-struct) | This event fires once for each log message. | | [on_ssl_client_authentication](#on_ssl_client_authentication-event-azurerelayproxy-struct) | This event is fired when the client presents its credentials to the server. | | [on_ssl_connection_request](#on_ssl_connection_request-event-azurerelayproxy-struct) | This event fires when a Secure Sockets Layer (SSL) connection is requested. | | [on_ssl_status](#on_ssl_status-event-azurerelayproxy-struct) | This event is fired to show the progress of the secure connection. | ## Config Settings *The following is a list of config settings for the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AccessToken](#AccessToken) | Returns an access token for use outside of the structs. | | [LogLevel](#LogLevel) | The level of detail that is logged. | | [TokenValidity](#TokenValidity) | The validity time in seconds of the access token. | | [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 struct. | | [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. | | [GetOn302Redirect](#GetOn302Redirect) | If set to True the struct 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 struct. | | [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 struct. | | [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. | | [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 struct 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 struct 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. | | [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. | # access_key property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The Shared Access Key. ## Syntax *Rust Syntax* ```text fn access_key(&self ) -> Result fn set_access_key(&self, value : &str) -> Option fn set_access_key_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property specifies the Shared Access Key to use when authenticating. This is the primary or secondary key of the shared access policy created in the Azure portal. For instance *8oKRDwkl0s440MlLUi4qHxDL34j1FS6K3t5TRoJ216c=*. ## Data Type String # access_key_name property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The Shared Access Key Name. ## Syntax *Rust Syntax* ```text fn access_key_name(&self ) -> Result fn set_access_key_name(&self, value : &str) -> Option fn set_access_key_name_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property specifies the Shared Access Key name to use when authenticating. This is the name of the shared access policy created in the Azure portal. For instance *RootManageSharedAccessKey*. ## Data Type String # connection_backlog property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem. ## Syntax *Rust Syntax* ```text fn connection_backlog(&self ) -> Result fn set_connection_backlog(&self, value : i32) -> Option ``` ## Default Value 5 ## Remarks This property contains the maximum number of pending connections maintained by the TCP/IP subsystem. This value reflects the SOMAXCONN option for the main listening socket. The default value for most systems is 5. You may set this property to a larger value if the server is expected to receive a large number of connections, and queuing them is desirable. ## Data Type i32 # azure_relay_proxy_connection_count property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The number of records in the AzureRelayProxyConnection arrays. ## Syntax *Rust Syntax* ```text fn azure_relay_proxy_connection_count(&self ) -> Result ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [azure_relay_proxy_connection_connected](#azure_relay_proxy_connection_connected-property-azurerelayproxy-struct) - [azure_relay_proxy_connection_connection_id](#azure_relay_proxy_connection_connection_id-property-azurerelayproxy-struct) - [azure_relay_proxy_connection_idle_timeout](#azure_relay_proxy_connection_idle_timeout-property-azurerelayproxy-struct) - [azure_relay_proxy_connection_local_address](#azure_relay_proxy_connection_local_address-property-azurerelayproxy-struct) - [azure_relay_proxy_connection_remote_host](#azure_relay_proxy_connection_remote_host-property-azurerelayproxy-struct) - [azure_relay_proxy_connection_remote_port](#azure_relay_proxy_connection_remote_port-property-azurerelayproxy-struct) - [azure_relay_proxy_connection_timeout](#azure_relay_proxy_connection_timeout-property-azurerelayproxy-struct) - [azure_relay_proxy_connection_user_data](#azure_relay_proxy_connection_user_data-property-azurerelayproxy-struct) The array indices start at *0* and end at *azure_relay_proxy_connection_count - 1*. This property is read-only. ## Data Type i32 # azure_relay_proxy_connection_connected property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This property indicates the status of individual connections. ## Syntax *Rust Syntax* ```text fn azure_relay_proxy_connection_connected(&self , ConnectionId : i32) -> Result ``` ## Default Value false ## Remarks This property indicates the status of individual connections. When *true*, the connection is established. Use the disconnect method to disconnect an existing connection. The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [AzureRelayProxyConnectionCount](#azure_relay_proxy_connection_count-property-azurerelayproxy-struct) property. This property is read-only. ## Data Type bool # azure_relay_proxy_connection_connection_id property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This property contains an identifier generated by the struct to identify each connection. ## Syntax *Rust Syntax* ```text fn azure_relay_proxy_connection_connection_id(&self , ConnectionId : i32) -> Result ``` ## Default Value 0 ## Remarks This property contains an identifier generated by the struct to identify each connection. This identifier is unique to this connection. The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [AzureRelayProxyConnectionCount](#azure_relay_proxy_connection_count-property-azurerelayproxy-struct) property. This property is read-only. ## Data Type i32 # azure_relay_proxy_connection_idle_timeout property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This property contains the idle timeout for this connection. ## Syntax *Rust Syntax* ```text fn azure_relay_proxy_connection_idle_timeout(&self , ConnectionId : i32) -> Result fn set_azure_relay_proxy_connection_idle_timeout(&self, ConnectionId : i32, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property contains the idle timeout for this connection. This property is similar to default_idle_timeout but may be set on a per-connection basis to override default_idle_timeout. This property specifies the idle timeout (in seconds) for the connected client. When set to a positive value, the struct will disconnect idle clients after the specified timeout. This applies only to clients that have not sent to received data within the specified number of seconds. If set to 0 (default), no idle timeout is applied. NOTE: do_events must be called for the struct to check existing connections. The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [AzureRelayProxyConnectionCount](#azure_relay_proxy_connection_count-property-azurerelayproxy-struct) property. ## Data Type i32 # azure_relay_proxy_connection_local_address property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This property shows the IP address of the interface through which the connection is passing. ## Syntax *Rust Syntax* ```text fn azure_relay_proxy_connection_local_address(&self , ConnectionId : i32) -> Result ``` ## Default Value "" ## Remarks This property shows the IP address of the interface through which the connection is passing. [azure_relay_proxy_connection_local_address](#azure_relay_proxy_connection_local_address-property-azurerelayproxy-struct) is important for multihomed hosts so that it can be used to find the particular network interface through which an individual connection is going. The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [AzureRelayProxyConnectionCount](#azure_relay_proxy_connection_count-property-azurerelayproxy-struct) property. This property is read-only. ## Data Type String # azure_relay_proxy_connection_remote_host property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This property shows the IP address of the remote host through which the connection is coming. ## Syntax *Rust Syntax* ```text fn azure_relay_proxy_connection_remote_host(&self , ConnectionId : i32) -> Result ``` ## Default Value "" ## Remarks This property shows the IP address of the remote host through which the connection is coming. The connection must be valid or an error will be fired. If the struct is configured to use a *SOCKS* firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution. The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [AzureRelayProxyConnectionCount](#azure_relay_proxy_connection_count-property-azurerelayproxy-struct) property. This property is read-only. ## Data Type String # azure_relay_proxy_connection_remote_port property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This property shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming. ## Syntax *Rust Syntax* ```text fn azure_relay_proxy_connection_remote_port(&self , ConnectionId : i32) -> Result ``` ## Default Value 0 ## Remarks This property shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming. The connection must be valid or an error will be fired. The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [AzureRelayProxyConnectionCount](#azure_relay_proxy_connection_count-property-azurerelayproxy-struct) property. This property is read-only. ## Data Type i32 # azure_relay_proxy_connection_timeout property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This property specifies a timeout for the struct. ## Syntax *Rust Syntax* ```text fn azure_relay_proxy_connection_timeout(&self , ConnectionId : i32) -> Result fn set_azure_relay_proxy_connection_timeout(&self, ConnectionId : i32, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property specifies a timeout for the struct. If the [azure_relay_proxy_connection_timeout](#azure_relay_proxy_connection_timeout-property-azurerelayproxy-struct) property is set to 0, all operations return immediately, potentially failing with a *WOULDBLOCK* error if data cannot be sent immediately. If [azure_relay_proxy_connection_timeout](#azure_relay_proxy_connection_timeout-property-azurerelayproxy-struct) is set to a positive value, data is sent in a blocking manner and the struct will wait for the operation to complete before returning control. The struct will handle any potential *WOULDBLOCK* errors internally and automatically retry the operation for a maximum of [azure_relay_proxy_connection_timeout](#azure_relay_proxy_connection_timeout-property-azurerelayproxy-struct) seconds. The struct will use do_events 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 struct 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 [azure_relay_proxy_connection_timeout](#azure_relay_proxy_connection_timeout-property-azurerelayproxy-struct) property is 0 (asynchronous operation). The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [AzureRelayProxyConnectionCount](#azure_relay_proxy_connection_count-property-azurerelayproxy-struct) property. ## Data Type i32 # azure_relay_proxy_connection_user_data property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The UserData property holds connection-specific user-specified data. ## Syntax *Rust Syntax* ```text fn azure_relay_proxy_connection_user_data(&self , ConnectionId : i32) -> Result, IPWorksMQError> fn set_azure_relay_proxy_connection_user_data(&self, ConnectionId : i32, value : Vec) -> Option fn set_azure_relay_proxy_connection_user_data_ref(&self, ConnectionId : i32, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The [azure_relay_proxy_connection_user_data](#azure_relay_proxy_connection_user_data-property-azurerelayproxy-struct) property holds connection-specific user-specified data. User-specified data may be set or retrieved at any point while the connection is valid. This provides a simple way to associate arbitrary data with a specific connection. The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [AzureRelayProxyConnectionCount](#azure_relay_proxy_connection_count-property-azurerelayproxy-struct) property. ## Data Type Vec # default_idle_timeout property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This property includes the default idle timeout for inactive clients. ## Syntax *Rust Syntax* ```text fn default_idle_timeout(&self ) -> Result fn set_default_idle_timeout(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property specifies the idle timeout (in seconds) for clients. When set to a positive value, the struct will disconnect idle clients after the specified timeout. This applies only to clients that have not sent or received data within default_idle_timeout seconds. If set to 0 (default), no idle timeout is applied. NOTE: [do_events](#do_events-method-azurerelayproxy-struct) must be called for the struct to check existing connections. ## Data Type i32 # default_timeout property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This property includes an initial timeout value to be used by incoming connections. ## Syntax *Rust Syntax* ```text fn default_timeout(&self ) -> Result fn set_default_timeout(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property is used by the struct to set the operational timeout value of all inbound connections once they are established. By default, the timeout is 0, meaning that all inbound connections will behave asynchronously. ## Data Type i32 # hybrid_connection property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The hybrid connection name. ## Syntax *Rust Syntax* ```text fn hybrid_connection(&self ) -> Result fn set_hybrid_connection(&self, value : &str) -> Option fn set_hybrid_connection_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This setting specifies the name of the hybrid connection that was created in the Azure portal. For instance *hc1*. ## Data Type String # keep_alive property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) When True, KEEPALIVE packets are enabled (for long connections). ## Syntax *Rust Syntax* ```text fn keep_alive(&self ) -> Result fn set_keep_alive(&self, value : bool) -> Option ``` ## Default Value false ## Remarks This property enables the SO_KEEPALIVE option on the incoming connections. This option prevents long connections from timing out in case of inactivity. NOTE: System Transmission Control Protocol (TCP)/IP stack implementations are not required to support SO_KEEPALIVE. This property is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified. ## Data Type bool # linger property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) When set to True, connections are terminated gracefully. ## Syntax *Rust Syntax* ```text fn linger(&self ) -> Result fn set_linger(&self, value : bool) -> Option ``` ## Default Value true ## Remarks This property controls how a connection is closed. The default is True. In this case, the connection is closed only after all the data are sent. Setting it to False forces an abrupt (hard) disconnection. Any data that were in the sending queue may be lost. The default behavior (which is also the default mode for stream sockets) might result in an indefinite delay in closing the connection. Although the struct returns control immediately, the system might indefinitely hold system resources until all pending data are sent (even after your application closes). This means that valuable system resources might be wasted. Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you have sent (e.g., by a client acknowledgment), then setting this property to False might be the appropriate course of action. This property is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified. ## Data Type bool # listening property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This property indicates whether the struct is listening for incoming connections on LocalPort. ## Syntax *Rust Syntax* ```text fn listening(&self ) -> Result ``` ## Default Value false ## Remarks This property indicates whether the struct is listening for connections on the port specified by the [local_port](#local_port-property-azurerelayproxy-struct) property. Use the [start_listening](#start_listening-method-azurerelayproxy-struct) and [stop_listening](#stop_listening-method-azurerelayproxy-struct) methods to control whether the struct is listening. This property is read-only. ## Data Type bool # local_host property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax *Rust Syntax* ```text fn local_host(&self ) -> Result fn set_local_host(&self, value : &str) -> Option fn set_local_host_ref(&self, value : &String) -> Option ``` ## 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 struct initiate connections (or accept in the case of server structs) 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 struct 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. ## Data Type String # local_port property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This property includes the Transmission Control Protocol (TCP) port in the local host where the struct listens. ## Syntax *Rust Syntax* ```text fn local_port(&self ) -> Result fn set_local_port(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property must be set before the struct can start listening. If its value is 0, then the TCP/IP subsystem picks a port number at random. The port number can be found by checking the value of this property after the struct is listening (i.e., after successfully assigning True to the [listening](#listening-property-azurerelayproxy-struct) property). The service port is not shared among servers so two structs cannot be listening on the same port at the same time. ## Data Type i32 # namespace_address property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The namespace address of the relay. ## Syntax *Rust Syntax* ```text fn namespace_address(&self ) -> Result fn set_namespace_address(&self, value : &str) -> Option fn set_namespace_address_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property specifies the full fully qualified domain name of the relay namespace. For instance *myrelay.servicebus.windows.net*. ## Data Type String # ssl_authenticate_clients property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) If set to True, the server asks the client(s) for a certificate. ## Syntax *Rust Syntax* ```text fn ssl_authenticate_clients(&self ) -> Result fn set_ssl_authenticate_clients(&self, value : bool) -> Option ``` ## Default Value false ## Remarks This property is used in conjunction with the [on_ssl_client_authentication](#on_ssl_client_authentication-event-azurerelayproxy-struct) event. Please refer to the documentation of the [on_ssl_client_authentication](#on_ssl_client_authentication-event-azurerelayproxy-struct) event for details. ## Data Type bool # ssl_cert_effective_date property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn ssl_cert_effective_date(&self ) -> Result ``` ## 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. ## Data Type String # ssl_cert_expiration_date property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn ssl_cert_expiration_date(&self ) -> Result ``` ## 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. ## Data Type String # ssl_cert_extended_key_usage property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn ssl_cert_extended_key_usage(&self ) -> Result ``` ## 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. ## Data Type String # ssl_cert_fingerprint property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_fingerprint(&self ) -> Result ``` ## 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. ## Data Type String # ssl_cert_fingerprint_sha1 property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_fingerprint_sha1(&self ) -> Result ``` ## 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. ## Data Type String # ssl_cert_fingerprint_sha256 property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_fingerprint_sha256(&self ) -> Result ``` ## 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. ## Data Type String # ssl_cert_issuer property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_issuer(&self ) -> Result ``` ## 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. ## Data Type String # ssl_cert_private_key property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssl_cert_private_key(&self ) -> Result ``` ## 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-azurerelayproxy-struct) may be available but not exportable. In this case, [ssl_cert_private_key](#ssl_cert_private_key-property-azurerelayproxy-struct) returns an empty string. This property is read-only. ## Data Type String # ssl_cert_private_key_available property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_private_key_available(&self ) -> Result ``` ## Default Value false ## Remarks Whether a [ssl_cert_private_key](#ssl_cert_private_key-property-azurerelayproxy-struct) is available for the selected certificate. If [ssl_cert_private_key_available](#ssl_cert_private_key_available-property-azurerelayproxy-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type bool # ssl_cert_private_key_container property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssl_cert_private_key_container(&self ) -> Result ``` ## Default Value "" ## Remarks The name of the [ssl_cert_private_key](#ssl_cert_private_key-property-azurerelayproxy-struct) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # ssl_cert_public_key property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_public_key(&self ) -> Result ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type String # ssl_cert_public_key_algorithm property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn ssl_cert_public_key_algorithm(&self ) -> Result ``` ## 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. ## Data Type String # ssl_cert_public_key_length property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn ssl_cert_public_key_length(&self ) -> Result ``` ## 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. ## Data Type i32 # ssl_cert_serial_number property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn ssl_cert_serial_number(&self ) -> Result ``` ## 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. ## Data Type String # ssl_cert_signature_algorithm property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn ssl_cert_signature_algorithm(&self ) -> Result ``` ## 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. ## Data Type String # ssl_cert_store property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_store(&self ) -> Result, IPWorksMQError> fn set_ssl_cert_store(&self, value : Vec) -> Option fn set_ssl_cert_store_ref(&self, value : &[u8]) -> Option ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ssl_cert_store_type](#ssl_cert_store_type-property-azurerelayproxy-struct) property denotes the type of the certificate store specified by [ssl_cert_store](#ssl_cert_store-property-azurerelayproxy-struct). If the store is password-protected, specify the password in [ssl_cert_store_password](#ssl_cert_store_password-property-azurerelayproxy-struct). [ssl_cert_store](#ssl_cert_store-property-azurerelayproxy-struct) is used in conjunction with the [ssl_cert_subject](#ssl_cert_subject-property-azurerelayproxy-struct) property to specify client certificates. If [ssl_cert_store](#ssl_cert_store-property-azurerelayproxy-struct) has a value, and [ssl_cert_subject](#ssl_cert_subject-property-azurerelayproxy-struct) or [ssl_cert_encoded](#ssl_cert_encoded-property-azurerelayproxy-struct) is set, a search for a certificate is initiated. Please see the [ssl_cert_subject](#ssl_cert_subject-property-azurerelayproxy-struct) 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). ## Data Type Vec # ssl_cert_store_password property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *Rust Syntax* ```text fn ssl_cert_store_password(&self ) -> Result fn set_ssl_cert_store_password(&self, value : &str) -> Option fn set_ssl_cert_store_password_ref(&self, value : &String) -> Option ``` ## 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. ## Data Type String # ssl_cert_store_type property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_store_type(&self ) -> Result fn set_ssl_cert_store_type(&self, value : i32) -> Option ``` ## 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 struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct 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-azurerelayproxy-struct), the full path of the PKCS#11 DLL as the [ssl_cert_store](#ssl_cert_store-property-azurerelayproxy-struct), and the PIN as the [ssl_cert_store_password](#ssl_cert_store_password-property-azurerelayproxy-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct 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-azurerelayproxy-struct) and set [ssl_cert_store_password](#ssl_cert_store_password-property-azurerelayproxy-struct) 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. | ## Data Type i32 # ssl_cert_subject_alt_names property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_subject_alt_names(&self ) -> Result ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # ssl_cert_thumbprint_md5 property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_thumbprint_md5(&self ) -> Result ``` ## 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. ## Data Type String # ssl_cert_thumbprint_sha1 property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_thumbprint_sha1(&self ) -> Result ``` ## 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. ## Data Type String # ssl_cert_thumbprint_sha256 property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_thumbprint_sha256(&self ) -> Result ``` ## 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. ## Data Type String # ssl_cert_usage property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn ssl_cert_usage(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-azurerelayproxy-struct). 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. ## Data Type String # ssl_cert_usage_flags property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_usage_flags(&self ) -> Result ``` ## 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-azurerelayproxy-struct) 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-azurerelayproxy-struct) property for a text representation of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-azurerelayproxy-struct). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type i32 # ssl_cert_version property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn ssl_cert_version(&self ) -> Result ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type String # ssl_cert_subject property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn ssl_cert_subject(&self ) -> Result fn set_ssl_cert_subject(&self, value : &str) -> Option fn set_ssl_cert_subject_ref(&self, value : &String) -> Option ``` ## 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. ## Data Type String # ssl_cert_encoded property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn ssl_cert_encoded(&self ) -> Result, IPWorksMQError> fn set_ssl_cert_encoded(&self, value : Vec) -> Option fn set_ssl_cert_encoded_ref(&self, value : &[u8]) -> Option ``` ## 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-azurerelayproxy-struct) and [ssl_cert_subject](#ssl_cert_subject-property-azurerelayproxy-struct) properties also may be used to specify a certificate. When [ssl_cert_encoded](#ssl_cert_encoded-property-azurerelayproxy-struct) is set, a search is initiated in the current [ssl_cert_store](#ssl_cert_store-property-azurerelayproxy-struct) for the private key of the certificate. If the key is found, [ssl_cert_subject](#ssl_cert_subject-property-azurerelayproxy-struct) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_cert_subject](#ssl_cert_subject-property-azurerelayproxy-struct) is set to an empty string. ## Data Type Vec # ssl_enabled property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. ## Syntax *Rust Syntax* ```text fn ssl_enabled(&self ) -> Result fn set_ssl_enabled(&self, value : bool) -> Option ``` ## Default Value false ## Remarks This property specifies whether TLS/SSL is enabled in the struct. When False (default), the struct operates in plaintext mode. When True, TLS/SSL is enabled. TLS/SSL may also be enabled by setting [ssl_start_mode](#ssl_start_mode-property-azurerelayproxy-struct). Setting [ssl_start_mode](#ssl_start_mode-property-azurerelayproxy-struct) will automatically update this property value. ## Data Type bool # ssl_start_mode property ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This property determines how the struct starts the Secure Sockets Layer (SSL) negotiation. ## Syntax *Rust Syntax* ```text fn ssl_start_mode(&self ) -> Result fn set_ssl_start_mode(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // Automatic1 // Implicit2 // Explicit3 // None ``` ## Default Value 3 ## Remarks The ssl_start_mode property may have one of the following values: | | | | --- | --- | | 0 (sslAutomatic) | If the remote port is set to the standard plaintext port of the protocol (where applicable), the struct will behave the same as if ssl_start_mode is set to sslExplicit. In all other cases, SSL negotiation will be implicit (sslImplicit). | | 1 (sslImplicit) | The SSL negotiation will start immediately after the connection is established. | | 2 (sslExplicit) | The struct will first connect in plaintext, and then will explicitly start SSL negotiation through a protocol command such as STARTTLS. | | 3 (sslNone - default) | No SSL negotiation; no SSL security. All communication will be in plaintext mode. | ## Data Type i32 # config method ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) Sets or retrieves a configuration setting. ## Syntax *Rust Syntax* ```text fn config(&self, configuration_string : &str) -> Result ``` ## Remarks config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-azurerelayproxy-struct) for the struct. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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](#config-settings-azurerelayproxy-struct), you must call *Config("PROPERTY")*. The value will be returned as a string. # disconnect method ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This method disconnects the specified client. ## Syntax *Rust Syntax* ```text fn disconnect(&self, connection_id : i32) -> Result<(), IPWorksMQError> ``` ## Remarks Calling this method will disconnect the client specified by the *connection_id* parameter. # do_events method ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This method processes events from the internal message queue. ## Syntax *Rust Syntax* ```text fn do_events(&self) -> Result<(), IPWorksMQError> ``` ## Remarks When do_events is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns. # reset method ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This method will reset the struct. ## Syntax *Rust Syntax* ```text fn reset(&self) -> Result<(), IPWorksMQError> ``` ## Remarks This method will reset the struct's properties to their default values. # shutdown method ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This method shuts down the server. ## Syntax *Rust Syntax* ```text fn shutdown(&self) -> Result<(), IPWorksMQError> ``` ## Remarks This method shuts down the server. Calling this method is equivalent to calling [stop_listening](#stop_listening-method-azurerelayproxy-struct) and then breaking every client connection by calling [disconnect](#disconnect-method-azurerelayproxy-struct). # start_listening method ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This method starts listening for incoming connections. ## Syntax *Rust Syntax* ```text fn start_listening(&self) -> Result<(), IPWorksMQError> ``` ## Remarks This method begins listening for incoming connections on the port specified by [local_port](#local_port-property-azurerelayproxy-struct). Once listening, events will fire as new clients connect and data are transferred. To stop listening for new connections, call [stop_listening](#stop_listening-method-azurerelayproxy-struct). To stop listening for new connections and to disconnect all existing clients, call [shutdown](#shutdown-method-azurerelayproxy-struct). # stop_listening method ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This method stops listening for new connections. ## Syntax *Rust Syntax* ```text fn stop_listening(&self) -> Result<(), IPWorksMQError> ``` ## Remarks This method stops listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections. To stop listening and to disconnect all existing clients, call [shutdown](#shutdown-method-azurerelayproxy-struct) instead. # on_connected event ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This event is fired immediately after a connection completes (or fails). ## Syntax *Rust Syntax* ```text // AzureRelayProxyConnectedEventArgs carries the AzureRelayProxy Connected event's parameters. pub struct AzureRelayProxyConnectedEventArgs { fn connection_id(&self) -> i32 fn status_code(&self) -> i32 fn description(&self) -> &String } // AzureRelayProxyConnectedEvent defines the signature of the AzureRelayProxy Connected event's handler function. pub trait AzureRelayProxyConnectedEvent { fn on_connected(&self, sender : AzureRelayProxy, e : &mut AzureRelayProxyConnectedEventArgs); } impl <'a> AzureRelayProxy<'a> { pub fn on_connected(&self) -> &'a dyn AzureRelayProxyConnectedEvent; pub fn set_on_connected(&mut self, value : &'a dyn AzureRelayProxyConnectedEvent); ... } ``` ## 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 system. *description* contains a description of this code. The value of *status_code* is equal to the value of the system error. Please refer to the [Error Codes](#trappable-errors-azurerelayproxy-struct) section for more information. # on_connection_request event ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This event is fired when a request for connection comes from a remote host. ## Syntax *Rust Syntax* ```text // AzureRelayProxyConnectionRequestEventArgs carries the AzureRelayProxy ConnectionRequest event's parameters. pub struct AzureRelayProxyConnectionRequestEventArgs { fn address(&self) -> &String fn port(&self) -> i32 fn accept(&self) -> bool fn set_accept(&self, value : bool) } // AzureRelayProxyConnectionRequestEvent defines the signature of the AzureRelayProxy ConnectionRequest event's handler function. pub trait AzureRelayProxyConnectionRequestEvent { fn on_connection_request(&self, sender : AzureRelayProxy, e : &mut AzureRelayProxyConnectionRequestEventArgs); } impl <'a> AzureRelayProxy<'a> { pub fn on_connection_request(&self) -> &'a dyn AzureRelayProxyConnectionRequestEvent; pub fn set_on_connection_request(&mut self, value : &'a dyn AzureRelayProxyConnectionRequestEvent); ... } ``` ## Remarks This event indicates an incoming connection. The connection is accepted by default. *address* and *port* will contain information about the remote host requesting the inbound connection. If you want to refuse it, you can set the *accept* parameter to False. # on_disconnected event ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This event is fired when a connection is closed. ## Syntax *Rust Syntax* ```text // AzureRelayProxyDisconnectedEventArgs carries the AzureRelayProxy Disconnected event's parameters. pub struct AzureRelayProxyDisconnectedEventArgs { fn connection_id(&self) -> i32 fn status_code(&self) -> i32 fn description(&self) -> &String } // AzureRelayProxyDisconnectedEvent defines the signature of the AzureRelayProxy Disconnected event's handler function. pub trait AzureRelayProxyDisconnectedEvent { fn on_disconnected(&self, sender : AzureRelayProxy, e : &mut AzureRelayProxyDisconnectedEventArgs); } impl <'a> AzureRelayProxy<'a> { pub fn on_disconnected(&self) -> &'a dyn AzureRelayProxyDisconnectedEvent; pub fn set_on_disconnected(&mut self, value : &'a dyn AzureRelayProxyDisconnectedEvent); ... } ``` ## 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 system. *description* contains a description of this code. The value of *status_code* is equal to the value of the system error. Please refer to the [Error Codes](#trappable-errors-azurerelayproxy-struct) section for more information. # on_error event ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This event fires information about errors during data delivery. ## Syntax *Rust Syntax* ```text // AzureRelayProxyErrorEventArgs carries the AzureRelayProxy Error event's parameters. pub struct AzureRelayProxyErrorEventArgs { fn connection_id(&self) -> i32 fn error_code(&self) -> i32 fn description(&self) -> &String } // AzureRelayProxyErrorEvent defines the signature of the AzureRelayProxy Error event's handler function. pub trait AzureRelayProxyErrorEvent { fn on_error(&self, sender : AzureRelayProxy, e : &mut AzureRelayProxyErrorEventArgs); } impl <'a> AzureRelayProxy<'a> { pub fn on_error(&self) -> &'a dyn AzureRelayProxyErrorEvent; pub fn set_on_error(&mut self, value : &'a dyn AzureRelayProxyErrorEvent); ... } ``` ## Remarks The on_error event is fired in case of exceptional conditions during message processing. Normally, the struct fails with an error. *error_code* contains an error code and *description* contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-azurerelayproxy-struct) section. *connection_id* indicates the connection for which the error is applicable. # on_log event ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This event fires once for each log message. ## Syntax *Rust Syntax* ```text // AzureRelayProxyLogEventArgs carries the AzureRelayProxy Log event's parameters. pub struct AzureRelayProxyLogEventArgs { fn connection_id(&self) -> i32 fn log_level(&self) -> i32 fn message(&self) -> &String fn log_type(&self) -> &String } // AzureRelayProxyLogEvent defines the signature of the AzureRelayProxy Log event's handler function. pub trait AzureRelayProxyLogEvent { fn on_log(&self, sender : AzureRelayProxy, e : &mut AzureRelayProxyLogEventArgs); } impl <'a> AzureRelayProxy<'a> { pub fn on_log(&self) -> &'a dyn AzureRelayProxyLogEvent; pub fn set_on_log(&mut self, value : &'a dyn AzureRelayProxyLogEvent); ... } ``` ## Remarks This event fires once for each log message generated by the struct. The verbosity is controlled by the [LogLevel](#LogLevel) setting. **LogLevel** 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 connection status details. The value 2 (Verbose) logs additional information about the initial HTTP request. The value 3 (Debug) logs additional debug information (if available). **Message** is the log entry. **LogType** identifies the type of log entry. Possible values are as follows: - "Info" - "Error" - "Verbose" - "Debug" **ConnectionId** specifies the Id of the connection to which the log applies. # on_ssl_client_authentication event ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This event is fired when the client presents its credentials to the server. ## Syntax *Rust Syntax* ```text // AzureRelayProxySSLClientAuthenticationEventArgs carries the AzureRelayProxy SSLClientAuthentication event's parameters. pub struct AzureRelayProxySSLClientAuthenticationEventArgs { fn connection_id(&self) -> i32 fn cert_encoded(&self) -> &[u8] fn cert_subject(&self) -> &String fn cert_issuer(&self) -> &String fn status(&self) -> &String fn accept(&self) -> bool fn set_accept(&self, value : bool) } // AzureRelayProxySSLClientAuthenticationEvent defines the signature of the AzureRelayProxy SSLClientAuthentication event's handler function. pub trait AzureRelayProxySSLClientAuthenticationEvent { fn on_ssl_client_authentication(&self, sender : AzureRelayProxy, e : &mut AzureRelayProxySSLClientAuthenticationEventArgs); } impl <'a> AzureRelayProxy<'a> { pub fn on_ssl_client_authentication(&self) -> &'a dyn AzureRelayProxySSLClientAuthenticationEvent; pub fn set_on_ssl_client_authentication(&mut self, value : &'a dyn AzureRelayProxySSLClientAuthenticationEvent); ... } ``` ## Remarks This event enables the server to decide whether or not to continue. The *accept* parameter is a recommendation on whether to continue or to 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"). # on_ssl_connection_request event ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This event fires when a Secure Sockets Layer (SSL) connection is requested. ## Syntax *Rust Syntax* ```text // AzureRelayProxySSLConnectionRequestEventArgs carries the AzureRelayProxy SSLConnectionRequest event's parameters. pub struct AzureRelayProxySSLConnectionRequestEventArgs { fn connection_id(&self) -> i32 fn supported_cipher_suites(&self) -> &String fn supported_signature_algs(&self) -> &String fn cert_store_type(&self) -> i32 fn set_cert_store_type(&self, value : i32) fn cert_store(&self) -> &String fn set_cert_store(&self, value : &str) fn set_cert_store_ref(&self, value : &String) fn cert_password(&self) -> &String fn set_cert_password(&self, value : &str) fn set_cert_password_ref(&self, value : &String) fn cert_subject(&self) -> &String fn set_cert_subject(&self, value : &str) fn set_cert_subject_ref(&self, value : &String) } // AzureRelayProxySSLConnectionRequestEvent defines the signature of the AzureRelayProxy SSLConnectionRequest event's handler function. pub trait AzureRelayProxySSLConnectionRequestEvent { fn on_ssl_connection_request(&self, sender : AzureRelayProxy, e : &mut AzureRelayProxySSLConnectionRequestEventArgs); } impl <'a> AzureRelayProxy<'a> { pub fn on_ssl_connection_request(&self) -> &'a dyn AzureRelayProxySSLConnectionRequestEvent; pub fn set_on_ssl_connection_request(&mut self, value : &'a dyn AzureRelayProxySSLConnectionRequestEvent); ... } ``` ## Remarks This event fires when an SSL connection is requested and ssl_provider is set to *Internal*. This event provides an opportunity to select an alternative certificate to the connecting client. This event does not fire when ssl_provider is set to *Platform*. This event allows the struct to be configured to use both RSA and ECDSA certificates depending on the connecting client's capabilities. *connection_id* is the connection Id of the client requesting the connection. *supported_cipher_suites* is a comma-separated list of cipher suites that the client supports. *supported_signature_algs* is a comma-separated list of certificate signature algorithms that the client supports. *cert_store_type* is the store type of the alternate certificate to use for this connection. The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct 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 object and pass cstPKCS11 as the [](#f_StoreType), the full path of the PKCS#11 DLL as the [](#f_Store), and the PIN as the [](#f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) struct by calling the [list_store_certificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](CertMgr.md#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 [](#f_Store) and set [](#f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | *cert_store* is the store name or location of the alternate certificate to use for this connection. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). *cert_password* is the password of the certificate store containing the alternate certificate to use for this connection. *cert_subject* is the subject of the alternate certificate to use for this connection. The special value *** matches any subject and will select the first certificate in the 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. # on_ssl_status event ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) This event is fired to show the progress of the secure connection. ## Syntax *Rust Syntax* ```text // AzureRelayProxySSLStatusEventArgs carries the AzureRelayProxy SSLStatus event's parameters. pub struct AzureRelayProxySSLStatusEventArgs { fn connection_id(&self) -> i32 fn message(&self) -> &String } // AzureRelayProxySSLStatusEvent defines the signature of the AzureRelayProxy SSLStatus event's handler function. pub trait AzureRelayProxySSLStatusEvent { fn on_ssl_status(&self, sender : AzureRelayProxy, e : &mut AzureRelayProxySSLStatusEventArgs); } impl <'a> AzureRelayProxy<'a> { pub fn on_ssl_status(&self) -> &'a dyn AzureRelayProxySSLStatusEvent; pub fn set_on_ssl_status(&mut self, value : &'a dyn AzureRelayProxySSLStatusEvent); ... } ``` ## Remarks The event is fired for informational and logging purposes only. It is used to track the progress of the connection. # Config Settings ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) The struct 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 struct, access to these *internal properties* is provided through the [config](#config-method-azurerelayproxy-struct) method. ### AzureRelayProxy Config Settings **AccessToken**: Returns an access token for use outside of the components.This setting returns an access token suitable for use in the HTTP *Authorization* header of a request. This is useful when a separate HTTP client is used to make a HTTP request to the relay service. The value returned by this setting can be set directly as the value for the *Authorization* header. The value will be in the format: *SharedAccessSignature sr=sb%3a%2f%2fnstest.servicebus.windows.net%2fhc1&sig=a2EjYWw%2fDlg%2bPcNb%2fC7%2fxBbM11JjfgdO6ZVsQRm18Gg%3d&se=1555368805&skn=RootManageSharedAccessKey* **LogLevel**: The level of detail that is logged.This setting controls the level of detail that is logged through the [on_log](#on_log-event-azurerelayproxy-struct) event. Possible values are: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data is logged. | | 3 (Debug) | Debug data is logged. | The value 1 (Info) logs basic information about the connection and connecting clients. The value 2 (Verbose) logs detailed information about each connection and the control connection. The value 3 (Debug) logs additional debug information (if any). **TokenValidity**: The validity time in seconds of the access token.This setting specifies the validity time of the access token to create when authenticating. The default value is *3600* seconds. ### HTTP Config Settings **AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#AllowHTTPCompression) is True, the struct 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 struct 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 struct will accept compressed data. It then will uncompress the data it has received. The struct will handle data compressed by both gzip and deflate compression algorithms. When True, the struct 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 is set to "2.0". If set to True (default), the struct will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the struct 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. When set to True, downloaded data will be appended to local_file. This may be used in conjunction with range to resume a failed download. This is applicable only when local_file 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 struct can be extended with other security schemes in addition to the authorization schemes already implemented by the struct. The auth_scheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time user and password are set, they are Base64 encoded, and the result is put in the authorization 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 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 struct.If set to True, the URL passed to the struct 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 struct returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new url for the object is retrieved automatically every time. If this property is set to 2 (Same Scheme), the new url is retrieved automatically only if the URL Scheme is the same; otherwise, the struct 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 and password 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 event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_redirect 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 struct fails with an error instead. Following are the valid options: - 0 - Never - 1 - Always - 2 - Same Scheme **GetOn302Redirect**: If set to True the struct will perform a GET on the new location.The default value is False. If set to True, the struct 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 struct.This property specifies the HTTP version used by the struct. 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 struct 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-azurerelayproxy-struct) 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 is set to any value other than frNever, the struct 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 is set to "2.0" (if the server does not support "2.0"), then the struct 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 struct 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](#AzureRelayProxy_p_ProxyUser) and [proxy_password](#AzureRelayProxy_p_ProxyPassword) are specified, this value is calculated using the algorithm specified by [proxy_auth_scheme](#AzureRelayProxy_p_ProxyAuthScheme). **ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by structs 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 structs that do not directly expose Proxy properties. **ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by structs 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 structs 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 structs 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 struct.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 struct. **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 struct 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 struct 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*. **UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the struct will attempt to use the Proxy auto-config URL when establishing a connection and [proxy_auto_detect](#AzureRelayProxy_p_ProxyAutoDetect) is set to *True*. When *True* (default), the struct 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 struct will use timeout for establishing a connection and transmitting/receiving data. **FirewallAutoDetect**: Tells the struct whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by structs 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 structs 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 struct fails with an error. NOTE: This setting is provided for use by structs 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 structs 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 structs 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 struct fails with an error. NOTE: This setting is provided for use by structs 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 struct 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-azurerelayproxy-struct) 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 struct initiate connections (or accept in the case of server structs) only through that interface. If the struct is connected, the [local_host](#local_host-property-azurerelayproxy-struct) 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 struct binds. This configuration setting must be set before a connection is attempted. It instructs the struct 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](#local_port-property-azurerelayproxy-struct) after the connection is established. [local_port](#local_port-property-azurerelayproxy-struct) 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 struct will use IPv4 exclusively. When set to *1*, the struct will use IPv6 exclusively. To instruct the struct 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 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-azurerelayproxy-struct) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if ssl_provider 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 struct 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 struct is the same. **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When ssl_provider 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 struct will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the struct will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The struct 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 struct fails with an error. When set to 0 (default), the CRL check will not be performed by the struct. 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 struct will use OCSP to check the validity of the server certificate. If set to 1 or 2, the struct will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The struct 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 struct fails with an error. When set to 0 (default), the struct 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-azurerelayproxy-struct) 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](#ssl_authenticate_clients-property-azurerelayproxy-struct) 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 struct 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 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 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 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 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 struct will first try to use the platform TLS 1.3 implementation when the ssl_provider 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 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 struct when the ssl_provider 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 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 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 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 event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the on_ssl_server_authentication 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 struct 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 struct will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when ssl_provider 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 is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the struct 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 struct 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 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 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 struct 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 struct is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. # Trappable Errors ([AzureRelayProxy](#struct-ipworksmqazurerelayproxy) Struct) ### AzureRelayProxy Errors | | | | --- | --- | | 4001 | Error transmitting packet. | | 4002 | Error sending CLOSE packet. | | 4003 | General protocol error. |