AzureRelayProxy Component
Properties Methods Events Configuration Settings Errors
Allows local connections to be proxied to the Azure Relay Service.
Syntax
IPWorksMQ.Azurerelayproxy
Remarks
The AzureRelayProxy component 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 NamespaceAddress and data then flows freely between the connected client and the Azure Relay Service. Each new connection made to AzureRelayProxy 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 component.
+---------+ +----------+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 to True.
When set to True the component 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:
- AccessKey (required)
- AccessKeyName (required)
- HybridConnection (required)
- NamespaceAddress (required)
To use SSL for incoming connections set SSLCert to a valid certificate with private key and set SSLEnabled to True before setting Listening.
DoEvents should be called in a loop to ensure timely processing of all activity, including connection requests and data transfer.
To stop listening set Listening to False. To shutdown the server including existing connections call Shutdown.
Handling Connections
When a connection is made the ConnectionRequest 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 Connected 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 Disconnected event fires. To initiate the client disconnection call Disconnect.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| AccessKey | The Shared Access Key. |
| AccessKeyName | The Shared Access Key Name. |
| ConnectionBacklog | The maximum number of pending connections maintained by the TCP/IP subsystem. |
| Connections | A collection of currently connected clients. |
| DefaultIdleTimeout | The default idle timeout for inactive clients. |
| DefaultTimeout | An initial timeout value to be used by incoming connections. |
| HybridConnection | The hybrid connection name. |
| KeepAlive | When True, KEEPALIVE packets are enabled (for long connections). |
| Linger | When set to True, connections are terminated gracefully. |
| Listening | If True, the component accepts incoming connections on LocalPort. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| LocalPort | The TCP port in the local host where the component listens. |
| NamespaceAddress | The namespace address of the relay. |
| SSLAuthenticateClients | If true, the server asks the client(s) for a certificate. |
| SSLCert | The certificate to be used during SSL negotiation. |
| SSLEnabled | Whether TLS/SSL is enabled. |
| SSLStartMode | Determines how the component starts the SSL negotiation. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| config | Sets or retrieves a configuration setting. |
| disconnect | Disconnect the specified client. |
| doEvents | Processes events from the internal message queue. |
| reset | Reset the component. |
| shutdown | Shuts down the server. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
| Connected | Fired immediately after a connection completes (or fails). |
| ConnectionRequest | Fired when a request for connection comes from a remote host. |
| Disconnected | Fired when a connection is closed. |
| Error | Information about errors during data delivery. |
| Log | Fires once for each log message. |
| SSLClientAuthentication | Fired when the client presents its credentials to the server. |
| SSLConnectionRequest | Fires when an SSL connection is requested. |
| SSLStatus | Shows the progress of the secure connection. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| AccessToken | Returns an access token for use outside of the components. |
| LogLevel | The level of detail that is logged. |
| TokenValidity | The validity time in seconds of the access token. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
| AllowNTLMFallback | Whether to allow fallback from Negotiate to NTLM when authenticating. |
| Append | Whether to append data to LocalFile. |
| Authorization | The Authorization string to be sent to the server. |
| BytesTransferred | Contains the number of bytes transferred in the response data. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
| EncodeURL | If set to true the URL will be encoded by the component. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to true the component will perform a GET on the new location. |
| HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
| HTTPVersion | The version of HTTP used by the component. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| LogLevel | The level of detail that is logged. |
| MaxHeaders | Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired. |
| MaxHTTPCookies | Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| NegotiatedHTTPVersion | The negotiated HTTP version. |
| OtherHeaders | Other headers as determined by the user (optional). |
| ProxyAuthorization | The authorization string to be sent to the proxy server. |
| ProxyAuthScheme | The authorization scheme to be used for the proxy. |
| ProxyPassword | A password if authentication is to be used for the proxy. |
| ProxyPort | Port for the proxy server (default 80). |
| ProxyServer | Name or IP address of a proxy server (optional). |
| ProxyUser | A user name if authentication is to be used for the proxy. |
| SentHeaders | The full set of headers as sent by the client. |
| StatusLine | The first line of the last response from the server. |
| TransferredData | The contents of the last response from the server. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
| TransferredHeaders | The full set of headers as received from the server. |
| TransferredRequest | The full request as sent by the client. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| UseIDNs | Whether to encode hostnames to internationalized domain names. |
| UsePlatformDeflate | Whether to use the platform implementation to decompress compressed responses. |
| UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
| UserAgent | Information about the user agent (browser). |
| CloseStreamAfterTransfer | If true, the component will close the upload or download stream after the transfer. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallListener | If true, the component binds to a SOCKS firewall as a server (IPPort only). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The port in the local host where the component binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseIPv6 | Whether to use IPv6. |
| UseNTLMv2 | Whether to use NTLM V2. |
| LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLContextProtocol | The protocol used when getting an SSLContext instance. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
| SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
| SSLNegotiatedCipherSuite | Returns the negotiated ciphersuite. |
| SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
| SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
| SSLNegotiatedProtocol | Returns the negotiated protocol version. |
| SSLProvider | The name of the security provider to use. |
| SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
| SSLTrustManagerFactoryAlgorithm | The algorithm to be used to create a TrustManager through TrustManagerFactory. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
| TLS12SupportedGroups | The supported groups for ECC. |
| TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |