# AzureRelayReceiver Component

An Azure Relay Service listener to accept and communicate with clients.

## Syntax

```text
nsoftware.IPWorksMQ.AzureRelayReceiver
```

## Remarks

The AzureRelayReceiver component implements the listener role in the Azure Relay service. The component will connect to the server and listen for incoming connections. Once a connection is established data can be exchange freely in both directions allowing a flexible messaging environment.

### 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-azurerelayreceiver-component) to *True*.

When set to *True* the component will immediately attempt to make a connection to the Azure Relay Service and begin listening. The following properties are applicable when setting [Listening](#listening-property-azurerelayreceiver-component):

- [AccessKey](#accesskey-property-azurerelayreceiver-component) (required)
- [AccessKeyName](#accesskeyname-property-azurerelayreceiver-component) (required)
- [HybridConnection](#hybridconnection-property-azurerelayreceiver-component) (required)
- [NamespaceAddress](#namespaceaddress-property-azurerelayreceiver-component) (required)
- [DefaultTimeout](#defaulttimeout-property-azurerelayreceiver-component)
- [ForwardingHost](#forwardinghost-property-azurerelayreceiver-component)
- [ForwardingPort](#forwardingport-property-azurerelayreceiver-component)

To stop listening set [Listening](#listening-property-azurerelayreceiver-component) to *False*. To shutdown the server including existing connections call [Shutdown](#shutdown-method-azurerelayreceiver-component).

### Handling Connections

When a connection is made the [ConnectionRequest](#connectionrequest-event-azurerelayreceiver-component) 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 [ConnectionConnected](#connectionconnected-event-azurerelayreceiver-component) and [ConnectionReadyToSend](#connectionreadytosend-event-azurerelayreceiver-component) events fire when the connection completes and is ready to send and receive data.

When data is received from the client the [ConnectionDataIn](#connectiondatain-event-azurerelayreceiver-component) event fires with the received data.

To send data to the client set [SendBytes](#sendbytes-method-azurerelayreceiver-component)or call [Send](#send-method-azurerelayreceiver-component), [SendFile](#sendfile-method-azurerelayreceiver-component), or [SendText](#sendtext-method-azurerelayreceiver-component).

When the client disconnects the [ConnectionDisconnected](#connectiondisconnected-event-azurerelayreceiver-component) event fires. To initiate the client disconnection call [Disconnect](#disconnect-method-azurerelayreceiver-component).

### Handling HTTP Connections

Azure Relay also supports HTTP connections which follow a request/response model. When an HTTP request is received the [HTTPRequest](#httprequest-event-azurerelayreceiver-component) event fires with information about the request including the request body. Save the *ConnectionId* value obtained within [HTTPRequest](#httprequest-event-azurerelayreceiver-component) for use with [SendHTTPResponse](#sendhttpresponse-method-azurerelayreceiver-component).

To send a HTTP response call [SendHTTPResponse](#sendhttpresponse-method-azurerelayreceiver-component) with the *ConnectionId*, status code and description, and any response day to be sent back to the client.

### Forwarding Connections

The component supports forwarding incoming connection to a separate destination. This functionality allows [AzureRelayReceiver](#azurerelayreceiver-component) to act as a proxy for incoming requests. When [ForwardingHost](#forwardinghost-property-azurerelayreceiver-component) and [ForwardingPort](#forwardingport-property-azurerelayreceiver-component) are set anytime a connection is made the component will establish a separate connection to the [ForwardingHost](#forwardinghost-property-azurerelayreceiver-component) and forward all incoming traffic. Responses from the [ForwardingHost](#forwardinghost-property-azurerelayreceiver-component) are then automatically sent back over the connection.

When connection forwarding is used no special steps are needed to send or receive data. Data flows freely between the connected client and the [ForwardingHost](#forwardinghost-property-azurerelayreceiver-component).

Note: Forwarding is not supported for HTTP requests.

### Code Example (WebSockets)

```csharp
Azurerelayreceiver listener = new Azurerelayreceiver();
listener.AccessKey = "9oKRDwjl0s440MlLUi4qHxDL34j1FS6K3t5TRoJ216c=";
listener.AccessKeyName = "RootManageSharedAccessKey";
listener.NamespaceAddress = "myrelay.servicebus.windows.net";
listener.HybridConnection = "hc1";

listener.OnConnectionRequest += (s, e) =>
{
  Console.WriteLine("Connection Request From: " + e.RemoteAddress + ":" + e.RemotePort);
  e.Accept = true;
};

listener.OnConnectionReadyToSend += (s, e) =>
{
  Console.WriteLine("Connection [" + e.ConnectionId + "] connected and ready to send and receive.");
};

listener.OnConnectionDataIn += (s, e) =>
{
  Console.WriteLine("Received data from " + e.ConnectionId + ": " + e.Text);
  //echo the data back
  listener.SendText(e.ConnectionId, e.Text);
  Console.WriteLine("Echoed received data back");
};

listener.Listening = true;

while (true)
  listener.DoEvents();
```

### Code Example (HTTP)

```csharp
Azurerelaylistener listener = new Azurerelaylistener();
listener.AccessKey = "9oKRDwjl0s440MlLUi4qHxDL34j1FS6K3t5TRoJ216c=";
listener.AccessKeyName = "RootManageSharedAccessKey";
listener.NamespaceAddress = "myrelay.servicebus.windows.net";
listener.HybridConnection = "hc1";

listener.OnHTTPRequest += (s, e) => {
  Console.WriteLine("HTTP Request from " + e.RemoteAddress + ":" + e.RemotePort);
  Console.WriteLine("HTTP Method: " + e.RequestMethod);
  Console.WriteLine("HTTP Request: " + e.RequestData);
  myConnectionId = e.ConnectionId;
};

//Send a response using the ConnectionId value from the HTTPRequest event
listener.SendHTTPResponse(myConnectionId, 200, "OK", myResponseBody);
```

## 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](#accesskey-property-azurerelayreceiver-component) | The Shared Access Key. |
| [AccessKeyName](#accesskeyname-property-azurerelayreceiver-component) | The Shared Access Key Name. |
| [Connected](#connected-property-azurerelayreceiver-component) | Whether the component is connected. |
| [Connections](#connections-property-azurerelayreceiver-component) | A collection of currently connected clients. |
| [DefaultTimeout](#defaulttimeout-property-azurerelayreceiver-component) | An initial timeout value to be used by incoming connections. |
| [Firewall](#firewall-property-azurerelayreceiver-component) | A set of properties related to firewall access. |
| [ForwardingHost](#forwardinghost-property-azurerelayreceiver-component) | The address to which traffic will automatically be forwarded. |
| [ForwardingPort](#forwardingport-property-azurerelayreceiver-component) | The port to which traffic will automatically be forwarded. |
| [HybridConnection](#hybridconnection-property-azurerelayreceiver-component) | The hybrid connection name. |
| [Listening](#listening-property-azurerelayreceiver-component) | If True , the component is listening for incoming connections. |
| [LocalHost](#localhost-property-azurerelayreceiver-component) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| [NamespaceAddress](#namespaceaddress-property-azurerelayreceiver-component) | The namespace address of the relay. |
| [Proxy](#proxy-property-azurerelayreceiver-component) | A set of properties related to proxy access. |
| [SSLAcceptServerCert](#sslacceptservercert-property-azurerelayreceiver-component) | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
| [SSLCert](#sslcert-property-azurerelayreceiver-component) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. |
| [SSLProvider](#sslprovider-property-azurerelayreceiver-component) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
| [SSLServerCert](#sslservercert-property-azurerelayreceiver-component) | The server certificate for the last established connection. |

## 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](#config-method-azurerelayreceiver-component) | Sets or retrieves a configuration setting. |
| [Disconnect](#disconnect-method-azurerelayreceiver-component) | This method disconnects the specified client. |
| [DoEvents](#doevents-method-azurerelayreceiver-component) | This method processes events from the internal message queue. |
| [Interrupt](#interrupt-method-azurerelayreceiver-component) | Interrupts a synchronous send to the remote host. |
| [PauseData](#pausedata-method-azurerelayreceiver-component) | This method pauses data reception. |
| [ProcessData](#processdata-method-azurerelayreceiver-component) | This method reenables data reception after a call to [PauseData](#pausedata-method-azurerelayreceiver-component) . |
| [Send](#send-method-azurerelayreceiver-component) | This method sends binary data to the client. |
| [SendBytes](#sendbytes-method-azurerelayreceiver-component) | This method sends binary data to the specified client. |
| [SendFile](#sendfile-method-azurerelayreceiver-component) | This method sends the file to the remote host. |
| [SendHTTPResponse](#sendhttpresponse-method-azurerelayreceiver-component) | Send the HTTP response. |
| [SendText](#sendtext-method-azurerelayreceiver-component) | This method sends text to the specified client. |
| [SetUploadStream](#setuploadstream-method-azurerelayreceiver-component) | This method uploads the data in the specified stream. |
| [Shutdown](#shutdown-method-azurerelayreceiver-component) | This method shuts down the server. |
| [StartListening](#startlistening-method-azurerelayreceiver-component) | Starts listening for incoming connections. |
| [StopListening](#stoplistening-method-azurerelayreceiver-component) | This method stops listening for new connections. |

## 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](#connected-event-azurerelayreceiver-component) | This event is fired immediately after the WebSocket handshake completes (or fails). |
| [ConnectionConnected](#connectionconnected-event-azurerelayreceiver-component) | Fired when a client has connected. |
| [ConnectionDataIn](#connectiondatain-event-azurerelayreceiver-component) | Fired when data is received. |
| [ConnectionDisconnected](#connectiondisconnected-event-azurerelayreceiver-component) | Fired when a WebSocket connection is disconnected. |
| [ConnectionError](#connectionerror-event-azurerelayreceiver-component) | Information about errors during data delivery. |
| [ConnectionReadyToSend](#connectionreadytosend-event-azurerelayreceiver-component) | Fired when the component is ready to send data. |
| [ConnectionRequest](#connectionrequest-event-azurerelayreceiver-component) | Fires when a WebSocket connection is requested. |
| [ConnectionStatus](#connectionstatus-event-azurerelayreceiver-component) | This event is fired to indicate changes in connection state. |
| [Disconnected](#disconnected-event-azurerelayreceiver-component) | Fired when a connection is closed. |
| [Error](#error-event-azurerelayreceiver-component) | Fired when information is available about errors during data delivery. |
| [Header](#header-event-azurerelayreceiver-component) | Fired every time a header line comes in. |
| [HTTPRequest](#httprequest-event-azurerelayreceiver-component) | Fires when an HTTP request is received. |
| [Log](#log-event-azurerelayreceiver-component) | This event fires once for each log message. |
| [Redirect](#redirect-event-azurerelayreceiver-component) | Fired when a redirection is received from the server. |
| [SSLServerAuthentication](#sslserverauthentication-event-azurerelayreceiver-component) | Fired after the server presents its certificate to the client. |
| [SSLStatus](#sslstatus-event-azurerelayreceiver-component) | Fired when secure connection progress messages are available. |

## Config Settings

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

|  |  |
| --- | --- |
| [AccessToken](#AccessToken) | Returns an access token for use outside of the components. |
| [AutoRenewThreshold](#AutoRenewThreshold) | The threshold in seconds after which the token is renewed. |
| [AzureRelayKeepAliveTime](#AzureRelayKeepAliveTime) | The inactivity period in seconds before a ping packet is sent to keep the connection alive. |
| [DiagnosticId](#DiagnosticId) | A diagnostic id used to enable end-to-end tracing. |
| [LogLevel](#LogLevel) | The level of detail that is logged. |
| [TokenValidity](#TokenValidity) | The validity time in seconds of the access token. |
| [BufferMessage](#BufferMessage) | Indicates whether or not the entire message is buffered before firing the DataIn event. |
| [DisconnectStatusCode](#DisconnectStatusCode) | Specifies the status code when closing a connection. |
| [DisconnectStatusDescription](#DisconnectStatusDescription) | Specifies the message associated with the disconnect status code. |
| [MaxFrameSize](#MaxFrameSize) | Specifies the maximum size of the outgoing message in bytes before fragmentation occurs. |
| [MessageLength\[ConnectionId\]](#MessageLength[ConnectionId]) | The length of the message (in bytes) when sending asynchronously. |
| [WaitForCloseResponse](#WaitForCloseResponse) | Determines whether or not the component will forcibly close a connection. |
| [AllowedClients](#AllowedClients) | A comma-separated list of host names or IP addresses that can access the component. |
| [BindExclusively](#BindExclusively) | Whether or not the component considers a local port reserved for exclusive use. |
| [BlockedClients](#BlockedClients) | A comma-separated list of host names or IP addresses that cannot access the component. |
| [CloseStreamAfterTransfer](#CloseStreamAfterTransfer) | If true, the component will close the upload or download stream after the transfer. |
| [DefaultConnectionTimeout](#DefaultConnectionTimeout) | The inactivity timeout applied to the SSL handshake. |
| [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. |
| [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. |
| [MaxConnections](#MaxConnections) | The maximum number of connections available. |
| [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. |
| [PreferredDHGroupBits](#PreferredDHGroupBits) | Size of the Diffie-Hellman group, in bits. |
| [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. |
| [UseBackgroundThread](#UseBackgroundThread) | Whether threads created by the component are background threads. |
| [UseIPv6](#UseIPv6) | Whether to use IPv6. |
| [CACertFilePaths](#CACertFilePaths) | The paths to CA certificate files when using Mono on Unix/Linux. |
| [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. |
| [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. |

# AccessKey Property ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

The Shared Access Key.

## Syntax

```text
public string AccessKey { get; set; }
```

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

# AccessKeyName Property ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

The Shared Access Key Name.

## Syntax

```text
public string AccessKeyName { get; set; }
```

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

# Connected Property ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

Whether the component is connected.

## Syntax

```text
public bool Connected { get; }
```

## Default Value

False

## Remarks

This property is used to determine whether or not the component is connected to the remote host. Use the Connect and [Disconnect](#disconnect-method-azurerelayreceiver-component) methods to manage the connection.

This property is read-only and not available at design time.

# Connections Property ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

A collection of currently connected clients.

## Syntax

```text
public AzureRelayConnectionMap Connections { get; }
```

## Remarks

This property is a collection of currently connected clients. All of the connections may be managed using this property. Each connection is described by the different fields of the [AzureRelayConnection](#azurerelayconnection-type) type.

This collection is a hashtable type of collection, in which the connection Id string is used as the key to the desired connection. The connection Id is present when events such as the [ConnectionConnected](#connectionconnected-event-azurerelayreceiver-component) event fires.

This property is read-only.

 Please refer to the [AzureRelayConnection](#azurerelayconnection-type) type for a complete list of fields.

# DefaultTimeout Property ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

An initial timeout value to be used by incoming connections.

## Syntax

```text
public int DefaultTimeout { get; set; }
```

## Default Value

0

## Remarks

This property is used by the component to set the operational timeout value of all inbound connections once they are established.

If DefaultTimeout is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If DefaultTimeout is set to a positive value, the component will wait for the operation to complete before returning control.

# Firewall Property ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

A set of properties related to firewall access.

## Syntax

```text
public Firewall Firewall { get; set; }
```

## Remarks

This is a [Firewall](#firewall-type)-type property, which contains fields describing the firewall through which the component will attempt to connect.

 Please refer to the [Firewall](#firewall-type) type for a complete list of fields.

# ForwardingHost Property ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

The address to which traffic will automatically be forwarded.

## Syntax

```text
public string ForwardingHost { get; set; }
```

## Default Value

""

## Remarks

ForwardingHost optionally specifies an address to which traffic will be automatically forwarded. Traffic will only be forwarded if both ForwardingHost and [ForwardingPort](#forwardingport-property-azurerelayreceiver-component) are specified.

When a connection is made the component will automatically establish a connection to ForwardingHost on the port specified by [ForwardingPort](#forwardingport-property-azurerelayreceiver-component). Data will then flow freely between the connected client and the ForwardingHost.

Note: This functionality is not applicable to HTTP requests.

# ForwardingPort Property ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

The port to which traffic will automatically be forwarded.

## Syntax

```text
public int ForwardingPort { get; set; }
```

## Default Value

0

## Remarks

ForwardingPort is used together with [ForwardingHost](#forwardinghost-property-azurerelayreceiver-component) to define a location where traffic is automatically forwarded.

[ForwardingHost](#forwardinghost-property-azurerelayreceiver-component) optionally specifies an address to which traffic will be automatically forwarded. Traffic will only be forwarded if both [ForwardingHost](#forwardinghost-property-azurerelayreceiver-component) and ForwardingPort are specified.

When a connection is made the component will automatically establish a connection to [ForwardingHost](#forwardinghost-property-azurerelayreceiver-component) on the port specified by ForwardingPort. Data will then flow freely between the connected client and the [ForwardingHost](#forwardinghost-property-azurerelayreceiver-component).

Note: This functionality is not applicable to HTTP requests.

# HybridConnection Property ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

The hybrid connection name.

## Syntax

```text
public string HybridConnection { get; set; }
```

## Default Value

""

## Remarks

This setting specifies the name of the hybrid connection that was created in the Azure portal. For instance *hc1*.

# Listening Property ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

If * True * , the component is listening for incoming connections.

## Syntax

```text
public bool Listening { get; }
```

## Default Value

False

## Remarks

This setting indicates whether the component accepts incoming connections. When *true* the component has connected to the Azure Service and started listening for incoming connections. The initiate the connection and begin listening call the [StartListening](#startlistening-method-azurerelayreceiver-component) method.

Use the [StartListening](#startlistening-method-azurerelayreceiver-component) and [StopListening](#stoplistening-method-azurerelayreceiver-component) methods to control whether the component is listening.

This property is read-only and not available at design time.

# LocalHost Property ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

## Syntax

```text
public string LocalHost { get; set; }
```

## 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 component initiate connections (or accept in the case of server components) 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 component is connected, the LocalHost 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: LocalHost is not persistent. You must always set it in code, and never in the property window.

# NamespaceAddress Property ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

The namespace address of the relay.

## Syntax

```text
public string NamespaceAddress { get; set; }
```

## Default Value

""

## Remarks

This property specifies the full fully qualified domain name of the relay namespace. For instance *myrelay.servicebus.windows.net*.

# Proxy Property ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

A set of properties related to proxy access.

## Syntax

```text
public Proxy Proxy { get; set; }
```

## Remarks

This property contains fields describing the proxy through which the component will attempt to connect.

 Please refer to the [Proxy](#proxy-type) type for a complete list of fields.

# SSLAcceptServerCert Property ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

## Syntax

```text
public Certificate SSLAcceptServerCert { get; set; }
```

## Remarks

If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

NOTE: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# SSLCert Property ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

## Syntax

```text
public Certificate SSLCert { get; set; }
```

## Remarks

This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the [Encoded](#Certificate_f_Encoded) field to the encoded certificate. To select a certificate, use the store and subject fields.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# SSLProvider Property ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

## Syntax

```text
public AzureRelayReceiverSSLProviders SSLProvider { get; set; }
enum AzureRelayReceiverSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}
```

## Default Value

0

## Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of *0* (Automatic) is recommended and should not be changed. When set to *0* (Automatic), the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

|  |  |
| --- | --- |
| 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
| 1 (sslpPlatform) | Uses the platform/system implementation. |
| 2 (sslpInternal) | Uses the internal implementation. |

 **Additional Notes**

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the component will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

The .NET Standard library will always use the internal implementation on all platforms.

# SSLServerCert Property ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

The server certificate for the last established connection.

## Syntax

```text
public Certificate SSLServerCert { get; }
```

## Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# Config Method ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

Sets or retrieves a configuration setting.

## Syntax

```text
public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);
```

## Remarks

Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-azurerelayreceiver-component) for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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-azurerelayreceiver-component), you must call *Config("PROPERTY")*. The value will be returned as a string.

# Disconnect Method ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

This method disconnects the specified client.

## Syntax

```text
public void Disconnect(string connectionId);

Async Version
public async Task Disconnect(string connectionId);
public async Task Disconnect(string connectionId, CancellationToken cancellationToken);
```

## Remarks

Calling this method will disconnect the client specified by the *ConnectionId* parameter.

# DoEvents Method ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

This method processes events from the internal message queue.

## Syntax

```text
public void DoEvents();

Async Version
public async Task DoEvents();
public async Task DoEvents(CancellationToken cancellationToken);
```

## Remarks

When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns.

# Interrupt Method ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

Interrupts a synchronous send to the remote host.

## Syntax

```text
public void Interrupt(string connectionId);

Async Version
public async Task Interrupt(string connectionId);
public async Task Interrupt(string connectionId, CancellationToken cancellationToken);
```

## Remarks

This property is called using the Connection ID if you wish to interrupt a connection and stop a file from uploading without disconnecting the client connected to the component. If you use [SendFile](#sendfile-method-azurerelayreceiver-component) to upload a file, the component will run synchronously on that Connection ID until it is completed.

# PauseData Method ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

This method pauses data reception.

## Syntax

```text
public void PauseData(string connectionId);

Async Version
public async Task PauseData(string connectionId);
public async Task PauseData(string connectionId, CancellationToken cancellationToken);
```

## Remarks

This method pauses data reception for the connection identified by *ConnectionId* when called. While data reception is paused, the DataIn event will not fire for the specified connection. Call [ProcessData](#processdata-method-azurerelayreceiver-component) to reenable data reception.

# ProcessData Method ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

This method reenables data reception after a call to [PauseData](#pausedata-method-azurerelayreceiver-component) .

## Syntax

```text
public void ProcessData(string connectionId);

Async Version
public async Task ProcessData(string connectionId);
public async Task ProcessData(string connectionId, CancellationToken cancellationToken);
```

## Remarks

This method reenables data reception for the connection identified by *ConnectionId* after a previous call to [PauseData](#pausedata-method-azurerelayreceiver-component). When [PauseData](#pausedata-method-azurerelayreceiver-component) is called, the DataIn event will not fire for the specified connection. To reenable data reception and allow DataIn to fire, call this method.

NOTE: This method is used only after previously calling [PauseData](#pausedata-method-azurerelayreceiver-component). It does not need to be called to process incoming data by default.

# Send Method ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

This method sends binary data to the client.

## Syntax

```text
public void Send(string connectionId, byte[] data);

Async Version
public async Task Send(string connectionId, byte[] data);
public async Task Send(string connectionId, byte[] data, CancellationToken cancellationToken);
```

## Remarks

This method sends the binary data specified by *Data* to the client specified by *ConnectionId*.

# SendBytes Method ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

This method sends binary data to the specified client.

## Syntax

```text
public void SendBytes(string connectionId, byte[] data);

Async Version
public async Task SendBytes(string connectionId, byte[] data);
public async Task SendBytes(string connectionId, byte[] data, CancellationToken cancellationToken);
```

## Remarks

This method sends binary data to the client identified by *ConnectionId*. To send text, use the [SendText](#sendtext-method-azurerelayreceiver-component) method instead.

When [Timeout](#AzureRelayConnection_f_Timeout) is set to 0 and SSLEnabled is set to False, the component will behave asynchronously. If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation fails with exception 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.

NOTE: The ReadyToSend event is not fired when part of the data is sent successfully.

When SSLEnabled is True or [Timeout](#AzureRelayConnection_f_Timeout) is set to a positive value, the component behaves synchronously.

This method sends binary data to the client identified by *ConnectionId*. To send text, use the [SendText](#sendtext-method-azurerelayreceiver-component) method instead.

When [Timeout](#AzureRelayConnection_f_Timeout) is set to 0 and SSLEnabled is set to False, the component will behave asynchronously. If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation fails with exception 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.

NOTE: The ReadyToSend event is not fired when part of the data is sent successfully.

When SSLEnabled is True or [Timeout](#AzureRelayConnection_f_Timeout) is set to a positive value, the component behaves synchronously.

# SendFile Method ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

This method sends the file to the remote host.

## Syntax

```text
public void SendFile(string connectionId, string fileName);

Async Version
public async Task SendFile(string connectionId, string fileName);
public async Task SendFile(string connectionId, string fileName, CancellationToken cancellationToken);
```

## Remarks

This method sends the file to the client specified by the *ConnectionId*.

Note: This method operate synchronously. [DefaultTimeout](#defaulttimeout-property-azurerelayreceiver-component) or [Timeout](#AzureRelayConnection_f_Timeout) must be set to a positive value before calling this method.

# SendHTTPResponse Method ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

Send the HTTP response.

## Syntax

```text
public void SendHTTPResponse(string connectionId, int statusCode, string statusDescription, byte[] responseData);

Async Version
public async Task SendHTTPResponse(string connectionId, int statusCode, string statusDescription, byte[] responseData);
public async Task SendHTTPResponse(string connectionId, int statusCode, string statusDescription, byte[] responseData, CancellationToken cancellationToken);
```

## Remarks

This method sends an HTTP response to the HTTP request identified by *ConnectionId*.

The response status code and description, as well as the response body, are sent to the client using this method. The *ConnectionId* value should be obtained from the [HTTPRequest](#httprequest-event-azurerelayreceiver-component) event.

*StatusCode* is the three digit HTTP status code to return, for instance *200*.

*StatusDescription* is the text corresponding to the *StatusCode*. For instance *OK*.

*ResponseBody* specifies the body to be sent back to the client (if any).

### Code Example (HTTP)

```csharp
Azurerelaylistener listener = new Azurerelaylistener();
listener.AccessKey = "9oKRDwjl0s440MlLUi4qHxDL34j1FS6K3t5TRoJ216c=";
listener.AccessKeyName = "RootManageSharedAccessKey";
listener.NamespaceAddress = "myrelay.servicebus.windows.net";
listener.HybridConnection = "hc1";

listener.OnHTTPRequest += (s, e) => {
  Console.WriteLine("HTTP Request from " + e.RemoteAddress + ":" + e.RemotePort);
  Console.WriteLine("HTTP Method: " + e.RequestMethod);
  Console.WriteLine("HTTP Request: " + e.RequestData);
  myConnectionId = e.ConnectionId;
};

//Send a response using the ConnectionId value from the HTTPRequest event
listener.SendHTTPResponse(myConnectionId, 200, "OK", myResponseBody);
```

# SendText Method ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

This method sends text to the specified client.

## Syntax

```text
public void SendText(string connectionId, string text);

Async Version
public async Task SendText(string connectionId, string text);
public async Task SendText(string connectionId, string text, CancellationToken cancellationToken);
```

## Remarks

This method sends text to the client identified by *ConnectionId*. To send binary data, use the [SendBytes](#sendbytes-method-azurerelayreceiver-component) method instead.

When [Timeout](#AzureRelayConnection_f_Timeout) is set to 0 and SSLEnabled is set to False, the component will behave asynchronously. If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation fails with exception 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.

NOTE: The ReadyToSend event is not fired when part of the data is sent successfully.

When SSLEnabled is True or [Timeout](#AzureRelayConnection_f_Timeout) is set to a positive value, the component behaves synchronously.

This method sends text to the client identified by *ConnectionId*. Data sent with this method will always be treated as text data regardless of the value of [DataFormat](#AzureRelayConnection_f_DataFormat). The component will UTF-8 encode the supplied text.

This method sends text to the client identified by *ConnectionId*. To send binary data, use the [SendBytes](#sendbytes-method-azurerelayreceiver-component) method instead.

When [Timeout](#AzureRelayConnection_f_Timeout) is set to 0 and SSLEnabled is set to False, the component will behave asynchronously. If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation fails with exception 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.

NOTE: The ReadyToSend event is not fired when part of the data is sent successfully.

When SSLEnabled is True or [Timeout](#AzureRelayConnection_f_Timeout) is set to a positive value, the component behaves synchronously.

# SetUploadStream Method ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

This method uploads the data in the specified stream.

## Syntax

```text
public void SetUploadStream(string connectionId, System.IO.Stream stream);

Async Version
public async Task SetUploadStream(string connectionId, System.IO.Stream stream);
public async Task SetUploadStream(string connectionId, System.IO.Stream stream, CancellationToken cancellationToken);
```

## Remarks

This method uploads the data in the specified stream to the connection identified by *ConnectionId*. The component will automatically close this stream if [CloseStreamAfterTransfer](#CloseStreamAfterTransfer) is *true* (default).

# Shutdown Method ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

This method shuts down the server.

## Syntax

```text
public void Shutdown();

Async Version
public async Task Shutdown();
public async Task Shutdown(CancellationToken cancellationToken);
```

## Remarks

This method shuts down the server. Calling this method is equivalent to calling [StopListening](#stoplistening-method-azurerelayreceiver-component) and then breaking every client connection by calling [Disconnect](#disconnect-method-azurerelayreceiver-component).

# StartListening Method ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

Starts listening for incoming connections.

## Syntax

```text
public void StartListening();

Async Version
public async Task StartListening();
public async Task StartListening(CancellationToken cancellationToken);
```

## Remarks

This method begins listening for incoming connections on the port specified by LocalPort. Once listening events will fire as new clients connect and data is transferred.

To stop listening for new connections call [StopListening](#stoplistening-method-azurerelayreceiver-component). To stop listening for new connections and disconnect all existing clients call [Shutdown](#shutdown-method-azurerelayreceiver-component).

The following properties are applicable when calling this method:

- [AccessKey](#accesskey-property-azurerelayreceiver-component) (required)
- [AccessKeyName](#accesskeyname-property-azurerelayreceiver-component) (required)
- [HybridConnection](#hybridconnection-property-azurerelayreceiver-component) (required)
- [NamespaceAddress](#namespaceaddress-property-azurerelayreceiver-component) (required)
- [DefaultTimeout](#defaulttimeout-property-azurerelayreceiver-component)
- [ForwardingHost](#forwardinghost-property-azurerelayreceiver-component)
- [ForwardingPort](#forwardingport-property-azurerelayreceiver-component)

# StopListening Method ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

This method stops listening for new connections.

## Syntax

```text
public void StopListening();

Async Version
public async Task StopListening();
public async Task StopListening(CancellationToken cancellationToken);
```

## 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-azurerelayreceiver-component) instead.

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-azurerelayreceiver-component) instead.

# Connected Event ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

This event is fired immediately after the WebSocket handshake completes (or fails).

## Syntax

```text
public event OnConnectedHandler OnConnected;

public delegate void OnConnectedHandler(object sender, AzureRelayReceiverConnectedEventArgs e);

public class AzureRelayReceiverConnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}
```

## Remarks

The Connected event will fire after the entire WebSocket connection and handshake process finishes (or fails). This consists of three steps: (1) the initial TCP connection (along with SSL negotiation, if used), (2) the HTTP "Upgrade" request, and (3) the 101 HTTP response.

If the connection is made normally, *StatusCode* is 0 and *Description* is "OK".

If the connection fails, *StatusCode* has the error code returned by the TCP/IP stack. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the error.

NOTE: Please refer to the [Error Codes](#trappable-errors-azurerelayreceiver-component) section for more information.

# ConnectionConnected Event ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

Fired when a client has connected.

## Syntax

```text
public event OnConnectionConnectedHandler OnConnectionConnected;

public delegate void OnConnectionConnectedHandler(object sender, AzureRelayReceiverConnectionConnectedEventArgs e);

public class AzureRelayReceiverConnectionConnectedEventArgs : EventArgs {
  public string ConnectionId { get; }
}
```

## Remarks

This event fires when a client has successfully established a WebSocket connection.

*ConnectionId* identifies the connection.

# ConnectionDataIn Event ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

Fired when data is received.

## Syntax

```text
public event OnConnectionDataInHandler OnConnectionDataIn;

public delegate void OnConnectionDataInHandler(object sender, AzureRelayReceiverConnectionDataInEventArgs e);

public class AzureRelayReceiverConnectionDataInEventArgs : EventArgs {
  public string ConnectionId { get; }
  public int DataFormat { get; }
  public string Text { get; }  public byte[] TextB { get; }
  public bool EOM { get; }
}
```

## Remarks

The DataIn event provides the data received from the client identified by the *ConnectionId* parameter.

The incoming data are provided through the *Text* parameter.

The *DataFormat* parameter identifies the encoding (if any) of the data. Possible value are as follows:

|  |  |
| --- | --- |
| 0 | If LineMode is disabled, a value of 0 indicates a continuation packet. If LineMode is enabled, the value will always be 0, regardless of packet type. |
| 1 | The data are UTF-8 encoded. |
| 2 | The data are binary and have no encoding. |

The *EOM* parameter stands for End of Message. By default, the component will fire the DataIn event as data are received. Larger messages will be fragmented and will cause the event to fire multiple times. When *EOM* is True within the event, this indicates the current fragment is also the final fragment of the message. The component may also be configured to buffer the message internally until the complete message is received. To enable this, set [BufferMessage](#BufferMessage) to True.

The *EOL* parameter stands for End of Line. When LineMode is False, *EOL* will always be False. When LineMode is True, *EOL* will be True if the DataIn event fired because an EOL was received and will be False if the DataIn event fired because [MaxLineLength](#MaxLineLength) was reached.

# ConnectionDisconnected Event ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

Fired when a WebSocket connection is disconnected.

## Syntax

```text
public event OnConnectionDisconnectedHandler OnConnectionDisconnected;

public delegate void OnConnectionDisconnectedHandler(object sender, AzureRelayReceiverConnectionDisconnectedEventArgs e);

public class AzureRelayReceiverConnectionDisconnectedEventArgs : EventArgs {
  public string ConnectionId { get; }
  public int StatusCode { get; }
  public string Description { get; }
}
```

## Remarks

When the connection is closed the *StatusCode* parameter may be used to determine if the disconnect occurred normally or if there was an error condition. If the connection is closed normally the *StatusCode* will be 1000. The *Description* parameter will contain a textual description returned by the server. Common *StatusCode* values are:

|  |  |
| --- | --- |
| 1000 (default) | Normal closure. |
| 1001 | The resource is going away. For instance, the server is shutting down or a browser is navigating away from the page. |
| 1002 | A protocol error occurred. |
| 1003 | Unexpected data were received (e.g., an endpoint that accepts only text data could send this if binary data are received). |
| 1007 | Invalid payload data were received (e.g., an endpoint that receives non-UTF-8 data in a text message could send this). |
| 1008 | A generic code that indicates the endpoint received a message that violates its policy. |
| 1009 | A message that was too large was received. |
| 1010 | A required extension could not be negotiated. |
| 1011 | An unexpected error occurred. |

# ConnectionError Event ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

Information about errors during data delivery.

## Syntax

```text
public event OnConnectionErrorHandler OnConnectionError;

public delegate void OnConnectionErrorHandler(object sender, AzureRelayReceiverConnectionErrorEventArgs e);

public class AzureRelayReceiverConnectionErrorEventArgs : EventArgs {
  public string ConnectionId { get; }
  public int ErrorCode { get; }
  public string Description { get; }
}
```

## Remarks

The [Error](#error-event-azurerelayreceiver-component) event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

*ConnectionId* 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-azurerelayreceiver-component) section.

*ErrorCode* 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-azurerelayreceiver-component) section.

# ConnectionReadyToSend Event ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

Fired when the component is ready to send data.

## Syntax

```text
public event OnConnectionReadyToSendHandler OnConnectionReadyToSend;

public delegate void OnConnectionReadyToSendHandler(object sender, AzureRelayReceiverConnectionReadyToSendEventArgs e);

public class AzureRelayReceiverConnectionReadyToSendEventArgs : EventArgs {
  public string ConnectionId { get; }
}
```

## Remarks

The ReadyToSend event indicates that the underlying TCP/IP subsystem is ready to accept data after a failed [Send](#send-method-azurerelayreceiver-component). The event is also fired immediately after a connection is established.

# ConnectionRequest Event ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

Fires when a WebSocket connection is requested.

## Syntax

```text
public event OnConnectionRequestHandler OnConnectionRequest;

public delegate void OnConnectionRequestHandler(object sender, AzureRelayReceiverConnectionRequestEventArgs e);

public class AzureRelayReceiverConnectionRequestEventArgs : EventArgs {
  public bool Accept { get; set; }
  public string RendezvousAddress { get; }
  public string Id { get; }
  public string ConnectHeaders { get; }
  public string SubProtocols { get; }
  public string Extensions { get; }
  public string Host { get; }
  public string RemoteAddress { get; }
  public int RemotePort { get; }
  public int StatusCode { get; set; }
  public string StatusDescription { get; set; }
}
```

## Remarks

This event fires when a client requests a connection. The parameters of this event may be used to determine whether to accept or reject the connection.

To accept a connection set *Accept* to *True* (default). To reject a connection set *Accept* to *False* and set *StatusCode* and *StatusDescription*.

*Accept* defines whether the connection request is accepted or rejected. The default value is *True*. Set this to *False* to reject the connection.

*RendezvousAddress* holds the rendezvous URL to which the connection specific websocket connection will be made. This is informational only.

*Id* holds the Id of the connection. If an Id was specified by the client it is present here, otherwise the Azure Relay Service generates a value. For instance: *b3ac97ea-d0f0-4286-bf1d-d493a4a22c27_G23_G22*.

*ConnectHeaders* contains a JSON object with the HTTP headers that have been supplied by the sender to the Azure Relay service. For instance:

```text
"connectHeaders": {
	"Sec-WebSocket-Key": "wIdDlRBg\/J\/Hx12q6iFdUQ==",
	"Sec-WebSocket-Version": "13",
	"Origin": "null",
	"Connection": "Upgrade",
	"Upgrade": "websocket",
	"Accept-Encoding": "gzip, deflate",
	"Host": "nstest.servicebus.windows.net",
	"User-Agent": "IPWorks HTTP Component - www.nsoftware.com"
}
```

*SubProtocols* holds the subprotocols (application-level protocols layered over the WebSocket Protocol) sent by the client in the initial WebSocket connection request.

*Extensions* holds the WebSocket extensions sent by the client in the initial WebSocket connection request.

*Host* is the Host header value of the connected client.

*RemoteAddress* is the IP address of the connecting client.

*RemotePort* is the port used by the connecting client.

*StatusCode* is a 3 digit HTTP status code used when *Accept* is set to False. Set this to any 3 digit HTTP status code when rejecting a connection. For instance: *404*.

*StatusDescription* should be set to the text description corresponding to the *StatusCode* value when rejecting a connection. For instance: *Not Found*.

# ConnectionStatus Event ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

This event is fired to indicate changes in connection state.

## Syntax

```text
public event OnConnectionStatusHandler OnConnectionStatus;

public delegate void OnConnectionStatusHandler(object sender, AzureRelayReceiverConnectionStatusEventArgs e);

public class AzureRelayReceiverConnectionStatusEventArgs : EventArgs {
  public string ConnectionEvent { get; }
  public int StatusCode { get; }
  public string Description { get; }
}
```

## Remarks

The ConnectionStatus event is fired when the connection state changes, such as completion of a firewall or proxy connection or completion of a security handshake.

The *ConnectionEvent* parameter indicates the type of connection event. Values may include the following:

|  |  |
| --- | --- |
|  | Firewall connection complete. |
|  | SSL handshake complete (where applicable). |
|  | WebSocket handshake complete. |
|  | Remote host connection complete. |
|  | Remote host disconnected. |
|  | WebSocket connection broken. |
|  | Secure Sockets Layer (SSL) connection broken. |
|  | Firewall host disconnected. |

 *StatusCode* includes the error code returned by the TCP/IP stack. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the error.

# Disconnected Event ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

Fired when a connection is closed.

## Syntax

```text
public event OnDisconnectedHandler OnDisconnected;

public delegate void OnDisconnectedHandler(object sender, AzureRelayReceiverDisconnectedEventArgs e);

public class AzureRelayReceiverDisconnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}
```

## Remarks

If the connection is broken normally, *StatusCode* is 0 and *Description* is "OK".

If the connection is broken for any other reason, *StatusCode* has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the TCP/IP error.

Please refer to the [Error Codes](#trappable-errors-azurerelayreceiver-component) section for more information.

# Error Event ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

Fired when information is available about errors during data delivery.

## Syntax

```text
public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, AzureRelayReceiverErrorEventArgs e);

public class AzureRelayReceiverErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}
```

## Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-azurerelayreceiver-component) section.

# Header Event ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

Fired every time a header line comes in.

## Syntax

```text
public event OnHeaderHandler OnHeader;

public delegate void OnHeaderHandler(object sender, AzureRelayReceiverHeaderEventArgs e);

public class AzureRelayReceiverHeaderEventArgs : EventArgs {
  public string Field { get; }
  public string Value { get; }
}
```

## Remarks

The *Field* parameter contains the name of the HTTP header (which is the same as it is delivered). The *Value* parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the *Field* parameter contains "" (empty string).

# HTTPRequest Event ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

Fires when an HTTP request is received.

## Syntax

```text
public event OnHTTPRequestHandler OnHTTPRequest;

public delegate void OnHTTPRequestHandler(object sender, AzureRelayReceiverHTTPRequestEventArgs e);

public class AzureRelayReceiverHTTPRequestEventArgs : EventArgs {
  public string ConnectionId { get; }
  public string RendezvousAddress { get; }
  public string Id { get; }
  public string RequestHeaders { get; }
  public string RequestTarget { get; }
  public string RequestMethod { get; }
  public string Host { get; }
  public string RemoteAddress { get; }
  public int RemotePort { get; }
  public string RequestData { get; }  public byte[] RequestDataB { get; }
}
```

## Remarks

This event fires when an HTTP request is received. The parameters of this event describe the details of the HTTP request.

The *ConnectionId* value must be saved and used when calling [SendHTTPResponse](#sendhttpresponse-method-azurerelayreceiver-component).

### Parameter Descriptions

*ConnectionId* contains an identifier generated by the component to identify each connection. This identifier is unique to this connection.

*RendezvousAddress* holds the rendezvous URL to which the connection specific websocket connection may be made. This is for information only, no action needs to be taken based on this value. For instance: *wss://g2-prod-by3-003-sb.servicebus.windows.net/$hc/hc1?sb-hc-action=request&sb-hc-id=e1df5efe-0988-450c-9512-f9f1d91b39a0_G2*

*Id* holds the Id of the connection. If an Id was specified by the client it is present here, otherwise the Azure Relay service generates a value. For instance: *2d4acb89-7d15-4aeb-bcd5-66e031580a90_G21_G1*.

*RequestHeaders* contains a JSON object containing the HTTP headers supplied to the Azure Relay service by the sender. Note that authorization values used to authenticate to the Azure Relay service, as well as all headers defined in RFC 7230 with the exception of *Via* are also stripped. For instance headers such as *Content-Length* are stripped by the relay and are not present in this value. For instance:

```text
"requestHeaders": {
	"Accept-Encoding": "gzip, deflate",
	"Host": "nstest.servicebus.windows.net",
	"User-Agent": "IPWorks HTTP Component - www.nsoftware.com",
	"Via": "1.1 nstest.servicebus.windows.net"
}
```

*RequestTarget* is the request target including query string params, as defined in RFC 7230 section 5.3. For instance */hc1*.

*RequestMethod* contains HTTP method sent in the request. For instance *POST* or *GET*.

*Host* holds the *Host* header value of the connected client.

*RemoteHost* contains the IP address of the remote host that initiated the HTTP request (the client).

*RemotePort* contains the port used by the remote host to establish the connection.

*RequestData* holds the body of the HTTP request (if any).

# Log Event ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

This event fires once for each log message.

## Syntax

```text
public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, AzureRelayReceiverLogEventArgs e);

public class AzureRelayReceiverLogEventArgs : EventArgs {
  public string ConnectionId { get; }
  public int LogLevel { get; }
  public string Message { get; }
  public string LogType { get; }
}
```

## Remarks

This event fires once for each log message generated by the component. 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.

# Redirect Event ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

Fired when a redirection is received from the server.

## Syntax

```text
public event OnRedirectHandler OnRedirect;

public delegate void OnRedirectHandler(object sender, AzureRelayReceiverRedirectEventArgs e);

public class AzureRelayReceiverRedirectEventArgs : EventArgs {
  public string Location { get; }
  public bool Accept { get; set; }
}
```

## Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The *Accept* parameter is always True by default, but if you do not want to follow the redirection, *Accept* may be set to False, in which case the component throws an exception. *Location* is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

# SSLServerAuthentication Event ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

Fired after the server presents its certificate to the client.

## Syntax

```text
public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, AzureRelayReceiverSSLServerAuthenticationEventArgs e);

public class AzureRelayReceiverSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}
```

## Remarks

During this event, the client can decide whether or not to continue with the connection process. The *Accept* parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

 When *Accept* is False, *Status* shows why the verification failed (otherwise, *Status* contains the string *OK*). If it is decided to continue, you can override and accept the certificate by setting the *Accept* parameter to True.

# SSLStatus Event ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

Fired when secure connection progress messages are available.

## Syntax

```text
public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, AzureRelayReceiverSSLStatusEventArgs e);

public class AzureRelayReceiverSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}
```

## Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

# AzureRelayConnection Type

A currently connected client.

## Remarks

This type describes the connection of a client which is currently connected to the component. You may use the different fields of this type to manage the connection.

The following fields are available:

- [AcceptData](#AzureRelayConnection_f_AcceptData)

- [Address](#AzureRelayConnection_f_Address)

- [BytesSent](#AzureRelayConnection_f_BytesSent)

- [Connected](#AzureRelayConnection_f_Connected)

- [ConnectHeaders](#AzureRelayConnection_f_ConnectHeaders)

- [ConnectionId](#AzureRelayConnection_f_ConnectionId)

- [DataFormat](#AzureRelayConnection_f_DataFormat)

- [Extensions](#AzureRelayConnection_f_Extensions)

- [Host](#AzureRelayConnection_f_Host)

- [Id](#AzureRelayConnection_f_Id)

- [ReadyToSend](#AzureRelayConnection_f_ReadyToSend)

- [RemoteAddress](#AzureRelayConnection_f_RemoteAddress)

- [RemotePort](#AzureRelayConnection_f_RemotePort)

- [SubProtocols](#AzureRelayConnection_f_SubProtocols)

- [Timeout](#AzureRelayConnection_f_Timeout)

- [UploadStream](#AzureRelayConnection_f_UploadStream)

## Fields

 **AcceptData** *bool (read-only)*
Default: True

Setting this field to False, temporarily disables data reception (and the [ConnectionDataIn](#connectiondatain-event-azurerelayreceiver-component) event) on the connection. Setting this to True, re-enables data reception.

 **Address** *string (read-only)*
Default: ""

This field holds the rendezvous URL to which the connection specific websocket connection will be made. This is for information only, no action needs to be taken based on this value. For instance: *wss://g21-prod-by3-003-sb.servicebus.windows.net/$hc/hc1?sb-hc-action=accept&sb-hc-id=2d4acb89-7d15-4aeb-bcd5-66e031580a90_G21_G1*

 **BytesSent** *int (read-only)*
Default: 0

This field shows how many bytes were sent after calling Send or SendBytes. Please see Send or SendBytes for more information.

NOTE: This field will always return 0 when the component is operating in the synchronous mode (i.e., the [Timeout](#AzureRelayConnection_f_Timeout) property is set to a positive value).

 **Connected** *bool (read-only)*
Default: False

This field indicates the status of individual connections.

When *true*, the connection is established. Use the Disconnect method to disconnect an existing connection.

 **ConnectHeaders** *string (read-only)*
Default: ""

A JSON object containing the HTTP headers that have been supplied by the sender to the Azure Relay service. For instance:

```text
"connectHeaders": {
	"Sec-WebSocket-Key": "QocLBwK5J40Qp35L2duoBg==",
	"Sec-WebSocket-Version": "13",
	"Origin": "null",
	"Connection": "Upgrade",
	"Upgrade": "websocket",
	"Accept-Encoding": "gzip, deflate",
	"Host": "nstest.servicebus.windows.net",
	"User-Agent": "IPWorks HTTP Component - www.nsoftware.com"
}
```

 **ConnectionId** *string (read-only)*
Default: ""

This field contains an identifier generated by the component to identify each connection. This identifier is unique to this connection.

 **DataFormat** *DataFormats*
Default: 0

This field includes the format of the data being sent. When data are sent over an established connection, it is either considered as text or binary data. Text data are UTF-8 encoded. Binary data have no encoding associated with it.

Possible values are as follows:

|  |  |
| --- | --- |
| 0 (dfAutomatic - default) | The component will attempt to automatically determine the correct data format. This is suitable for most cases. |
| 1 (dfText) | The component will UTF-8 encode the specified data before sending. Data that already have been UTF-8 encoded also may be supplied. |
| 2 (dfBinary) | The component will send the data exactly as they are provided. |
| 9 (dfPing) | The component will send the ping with data exactly as they are provided. |
| 10 (dfPong) | The component will send the pong with data exactly as they are provided. |

 **Extensions** *string (read-only)*
Default: ""

The WebSocket extensions sent by the client in the initial WebSocket connection request.

 **Host** *string (read-only)*
Default: ""

This field includes the Host header value of the connected client.

 **Id** *string (read-only)*
Default: ""

This field holds the Id of the connection. If an Id was specified by the client it is present here, otherwise the Azure Relay service generates a value. For instance: *2d4acb89-7d15-4aeb-bcd5-66e031580a90_G21_G1*.

 **ReadyToSend** *bool (read-only)*
Default: False

This field indicates whether the component is ready to send data.

This is *true* after a client connects but will become *false* after a failed call to Send or SendBytes. After a failed call to Send or SendBytes, the ReadyToSend event will fire and this field will be *true* when data can be sent again.

 **RemoteAddress** *string (read-only)*
Default: ""

This field holds the IP address of the connecting client.

 **RemotePort** *int (read-only)*
Default: 0

This field holds the port of the connecting client.

 **SubProtocols** *string (read-only)*
Default: ""

This field includes the subprotocols (application-level protocols layered over the WebSocket Protocol) sent by the client in the initial WebSocket connection request.

 **Timeout** *int*
Default: 0

This field specifies a timeout for the component.

 This field defines the timeout when sending data. If the [Timeout](#AzureRelayConnection_f_Timeout) field is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If [Timeout](#AzureRelayConnection_f_Timeout) is set to a positive value, the component will wait for the operation to complete before returning control.

The component will use DoEvents 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 component throws an exception.

NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the [Timeout](#AzureRelayConnection_f_Timeout) field is 0.

 **UploadStream** *System.IO.Stream*
Default: ""

Setting this field uploads the data in the specified stream to the current connection. The component will automatically close this stream if [CloseStreamAfterTransfer](#CloseStreamAfterTransfer) is true (default).

## Constructors

```text
public AzureRelayConnection();
```

# Certificate Type

This is the digital certificate being used.

## Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

The following fields are available:

- [EffectiveDate](#Certificate_f_EffectiveDate)

- [ExpirationDate](#Certificate_f_ExpirationDate)

- [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage)

- [Fingerprint](#Certificate_f_Fingerprint)

- [FingerprintSHA1](#Certificate_f_FingerprintSHA1)

- [FingerprintSHA256](#Certificate_f_FingerprintSHA256)

- [Issuer](#Certificate_f_Issuer)

- [PrivateKey](#Certificate_f_PrivateKey)

- [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable)

- [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer)

- [PublicKey](#Certificate_f_PublicKey)

- [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm)

- [PublicKeyLength](#Certificate_f_PublicKeyLength)

- [SerialNumber](#Certificate_f_SerialNumber)

- [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm)

- [Store](#Certificate_f_Store)

- [StorePassword](#Certificate_f_StorePassword)

- [StoreType](#Certificate_f_StoreType)

- [SubjectAltNames](#Certificate_f_SubjectAltNames)

- [ThumbprintMD5](#Certificate_f_ThumbprintMD5)

- [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1)

- [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256)

- [Usage](#Certificate_f_Usage)

- [UsageFlags](#Certificate_f_UsageFlags)

- [Version](#Certificate_f_Version)

- [Subject](#Certificate_f_Subject)

- [Encoded](#Certificate_f_Encoded)

## Fields

 **EffectiveDate** *string (read-only)*
Default: ""

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.

 **ExpirationDate** *string (read-only)*
Default: ""

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.

 **ExtendedKeyUsage** *string (read-only)*
Default: ""

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

 **Fingerprint** *string (read-only)*
Default: ""

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*

 **FingerprintSHA1** *string (read-only)*
Default: ""

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*

 **FingerprintSHA256** *string (read-only)*
Default: ""

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*

 **Issuer** *string (read-only)*
Default: ""

The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

 **PrivateKey** *string (read-only)*
Default: ""

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string.

 **PrivateKeyAvailable** *bool (read-only)*
Default: False

Whether a [PrivateKey](#Certificate_f_PrivateKey) is available for the selected certificate. If [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) is True, the certificate may be used for authentication purposes (e.g., server authentication).

 **PrivateKeyContainer** *string (read-only)*
Default: ""

The name of the [PrivateKey](#Certificate_f_PrivateKey) container for the certificate (if available). This functionality is available only on Windows platforms.

 **PublicKey** *string (read-only)*
Default: ""

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

 **PublicKeyAlgorithm** *string (read-only)*
Default: ""

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.

 **PublicKeyLength** *int (read-only)*
Default: 0

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

 **SerialNumber** *string (read-only)*
Default: ""

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.

 **SignatureAlgorithm** *string (read-only)*
Default: ""

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.

 **Store** *string*
Default: "MY"

The name of the certificate store for the client certificate.

The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword).

[Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field 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).

 **StoreB** *byte []*
Default: "MY"

The name of the certificate store for the client certificate.

The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword).

[Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field 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).

 **StorePassword** *string*
Default: ""

If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store.

 **StoreType** *CertStoreTypes*
Default: 0

The type of certificate store for this certificate.

 The component supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the component will automatically determine the type. This field 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](#certificate-type) object and pass cstPKCS11 as the [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) component by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](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 [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_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. |

 **SubjectAltNames** *string (read-only)*
Default: ""

Comma-separated lists of alternative subject names for the certificate.

 **ThumbprintMD5** *string (read-only)*
Default: ""

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.

 **ThumbprintSHA1** *string (read-only)*
Default: ""

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.

 **ThumbprintSHA256** *string (read-only)*
Default: ""

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.

 **Usage** *string (read-only)*
Default: ""

The text description of [UsageFlags](#Certificate_f_UsageFlags).

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.

 **UsageFlags** *int (read-only)*
Default: 0

The flags that show intended use for the certificate. The value of [UsageFlags](#Certificate_f_UsageFlags) 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 [Usage](#Certificate_f_Usage) field for a text representation of [UsageFlags](#Certificate_f_UsageFlags).

This functionality currently is not available when the provider is OpenSSL.

 **Version** *string (read-only)*
Default: ""

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

 **Subject** *string*
Default: ""

The subject of the certificate used for client authentication.

This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store.

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.

 **Encoded** *string*
Default: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate.

When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string.

 **EncodedB** *byte []*
Default: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate.

When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string.

## Constructors

```text
public Certificate();
```

 Creates a instance whose properties can be set.

```text
public Certificate(string certificateFile);
```

 Opens * CertificateFile * and reads out the contents as an X.509 public key.

```text
public Certificate(byte[] encoded);
```

 Parses * Encoded * as an X.509 public key.

```text
public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store.

 * ConfigurationString * is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the * cstUser * , * cstMachine * , * cstPublicKeyFile * , and * cstPFXFile * store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations.

 After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the component will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key.

```text
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the component will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key.

# Firewall Type

The firewall the component will connect through.

## Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall [Host](#Firewall_f_Host) and the [FirewallType](#Firewall_f_FirewallType).

The following fields are available:

- [AutoDetect](#Firewall_f_AutoDetect)

- [FirewallType](#Firewall_f_FirewallType)

- [Host](#Firewall_f_Host)

- [Password](#Firewall_f_Password)

- [Port](#Firewall_f_Port)

- [User](#Firewall_f_User)

## Fields

 **AutoDetect** *bool*
Default: False

Whether to automatically detect and use firewall system settings, if available.

 **FirewallType** *FirewallTypes*
Default: 0

The type of firewall to connect through. The applicable values are as follows:

|  |  |
| --- | --- |
| fwNone (0) | No firewall (default setting). |
| fwTunnel (1) | Connect through a tunneling proxy. [Port](#Firewall_f_Port) is set to 80. |
| fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [Port](#Firewall_f_Port) is set to 1080. |
| fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [Port](#Firewall_f_Port) is set to 1080. |
| fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [Port](#Firewall_f_Port) is set to 1080. |

 **Host** *string*
Default: ""

The name or IP address of the firewall (optional). If a [Host](#Firewall_f_Host) is given, the requested connections will be authenticated through the specified firewall when connecting.

If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the component throws an exception.

 **Password** *string*
Default: ""

A password if authentication is to be used when connecting through the firewall. If [Host](#Firewall_f_Host) is specified, the [User](#Firewall_f_User) and [Password](#Firewall_f_Password) fields are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.

 **Port** *int*
Default: 0

The Transmission Control Protocol (TCP) port for the firewall [Host](#Firewall_f_Host). See the description of the [Host](#Firewall_f_Host) field for details.

NOTE: This field is set automatically when [FirewallType](#Firewall_f_FirewallType) is set to a valid value. See the description of the [FirewallType](#Firewall_f_FirewallType) field for details.

 **User** *string*
Default: ""

A username if authentication is to be used when connecting through a firewall. If [Host](#Firewall_f_Host) is specified, this field and the [Password](#Firewall_f_Password) field are used to connect and authenticate to the given [Firewall](#firewall-type). If the authentication fails, the component throws an exception.

## Constructors

```text
public Firewall();
```

# Proxy Type

The proxy the component will connect to.

## Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the [Server](#Proxy_f_Server) and the [AuthScheme](#Proxy_f_AuthScheme).

The following fields are available:

- [AuthScheme](#Proxy_f_AuthScheme)

- [AutoDetect](#Proxy_f_AutoDetect)

- [Password](#Proxy_f_Password)

- [Port](#Proxy_f_Port)

- [Server](#Proxy_f_Server)

- [SSL](#Proxy_f_SSL)

- [User](#Proxy_f_User)

## Fields

 **AuthScheme** *ProxyAuthSchemes*
Default: 0

The type of authorization to perform when connecting to the proxy. This is used only when the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are set.

[AuthScheme](#Proxy_f_AuthScheme) should be set to authNone (3) when no authentication is expected.

By default, [AuthScheme](#Proxy_f_AuthScheme) is authBasic (0), and if the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are set, the component will attempt basic authentication.

If [AuthScheme](#Proxy_f_AuthScheme) is set to authDigest (1), digest authentication will be attempted instead.

If [AuthScheme](#Proxy_f_AuthScheme) is set to authProprietary (2), then the authorization token will not be generated by the component. Look at the configuration file for the component being used to find more information about manually setting this token.

If [AuthScheme](#Proxy_f_AuthScheme) is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this field will clear the values of [User](#Proxy_f_User) and [Password](#Proxy_f_Password).

 **AutoDetect** *bool*
Default: False

Whether to automatically detect and use proxy system settings, if available. The default value is *false*.

 **Password** *string*
Default: ""

A password if authentication is to be used for the proxy.

If [AuthScheme](#Proxy_f_AuthScheme) is set to Basic Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*.

If [AuthScheme](#Proxy_f_AuthScheme) is set to Digest Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to respond to the Digest Authentication challenge from the server.

If [AuthScheme](#Proxy_f_AuthScheme) is set to NTLM Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to authenticate through NTLM negotiation.

 **Port** *int*
Default: 80

The Transmission Control Protocol (TCP) port for the proxy [Server](#Proxy_f_Server) (default 80). See the description of the [Server](#Proxy_f_Server) field for details.

 **Server** *string*
Default: ""

If a proxy [Server](#Proxy_f_Server) is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the [Server](#Proxy_f_Server) field is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the [Server](#Proxy_f_Server) field is set to the corresponding address. If the search is not successful, an error is returned.

 **SSL** *ProxySSLTypes*
Default: 0

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

|  |  |
| --- | --- |
| psAutomatic (0) | Default setting. If the URL is an https URL, the component will use the psTunnel option. If the URL is an http URL, the component will use the psNever option. |
| psAlways (1) | The connection is always SSL-enabled. |
| psNever (2) | The connection is not SSL-enabled. |
| psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |

 **User** *string*
Default: ""

A username if authentication is to be used for the proxy.

If [AuthScheme](#Proxy_f_AuthScheme) is set to Basic Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*.

If [AuthScheme](#Proxy_f_AuthScheme) is set to Digest Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to respond to the Digest Authentication challenge from the server.

If [AuthScheme](#Proxy_f_AuthScheme) is set to NTLM Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to authenticate through NTLM negotiation.

## Constructors

```text
public Proxy();
```

```text
public Proxy(string server, int port);
```

```text
public Proxy(string server, int port, string user, string password);
```

# Config Settings ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

 The component 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 component, access to these *internal properties* is provided through the [Config](#config-method-azurerelayreceiver-component) method.

### AzureRelayReceiver 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*

**AutoRenewThreshold**: The threshold in seconds after which the token is renewed.This setting specifies a threshold used by the component to determine when to automatically renew the listener token while connected to the Azure Relay service.

When connected to the Azure Relay a Shared Access Token grants access to the service. After [TokenValidity](#TokenValidity) seconds this token will expire. To prevent disconnection the component will automatically renew the token once the remaining seconds on the life of the token is below this threshold.

For instance if [AutoRenewThreshold](#AutoRenewThreshold) is set to *100* (seconds). Once the component token is valid for only 99 seconds it will be automatically renewed.

The default value is *300* (seconds).

**AzureRelayKeepAliveTime**: The inactivity period in seconds before a ping packet is sent to keep the connection alive.This setting specifies the inactivity period in seconds after which a ping packet is sent on the control channel to keep the connection to the Azure Relay Service alive.

The default value is *0* (disabled).

Note: This functionality is not yet supported

**DiagnosticId**: A diagnostic id used to enable end-to-end tracing.This setting optionally specifies a diagnostic Id that is associated with the control connection established to the Azure Relay server when [Listening](#listening-property-azurerelayreceiver-component) is set to True. If set, this allows end-to-end tracing of the connection for diagnostic purposes. If specified this should be a GUID. For instance *f479cece-a32d-4caf-aed3-6dcc3b7b661e*.

**LogLevel**: The level of detail that is logged.This setting controls the level of detail that is logged through the [Log](#log-event-azurerelayreceiver-component) 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.

### WebSocketServer Config Settings

**BufferMessage**: Indicates whether or not the entire message is buffered before firing the DataIn event.When receiving large messages the DataIn, this event may fire multiple times to provide data as it is received in each message fragment. When [BufferMessage](#BufferMessage) is set to True, the component will internally buffer the message as it is received until it is complete before firing the DataIn event. The default value is False.

**DisconnectStatusCode**: Specifies the status code when closing a connection.When the [Disconnect](#disconnect-method-azurerelayreceiver-component) method is called, the component will send the status code specified here. By default, the value is 1,000, which indicates a normal closure. Any other value represents an error condition. You may set any value you wish, but the protocol defines the following common values.

|  |  |
| --- | --- |
| 1000 (default) | Normal closure. |
| 1001 | The resource is going away. For instance, the server is shutting down or a browser is navigating away from the page. |
| 1002 | A protocol error occurred. |
| 1003 | Unexpected data were received (e.g., an endpoint that accepts only text data could send this if binary data are received). |
| 1007 | Invalid payload data were received (e.g., an endpoint that receives non-UTF-8 data in a text message could send this). |
| 1008 | A generic code that indicates the endpoint received a message that violates its policy. |
| 1009 | A message that was too large was received. |
| 1010 | A required extension could not be negotiated. |
| 1011 | An unexpected error occurred. |

**DisconnectStatusDescription**: Specifies the message associated with the disconnect status code.This configuration setting may be used to provide a textual description of the status code sent when closing the connection. This configuration setting works in conjunction with [DisconnectStatusCode](#DisconnectStatusCode). For any of the standard codes listed in [DisconnectStatusCode](#DisconnectStatusCode), the component will use a default description that may be overridden with this setting. For any nonstandard codes that are not listed, this setting should be set or no description will be sent.

**MaxFrameSize**: Specifies the maximum size of the outgoing message in bytes before fragmentation occurs.This configuration setting specifies the maximum size of the outgoing message in bytes before fragmentation will occur. When a message that is larger than [MaxFrameSize](#MaxFrameSize) is sent, it will be broken into fragments with the maximum size specified here. The default value is 131072 (128K).

When a message is fragmented, the receiving side may check the *EOM* parameter of the DataIn event to determine when the message is complete.

NOTE: When Timeout is set to *0* messages that are fragmented are always sent as individual smaller messages and *EOM* will always be *True* in the DataIn event on the receiving side.

**MessageLength[ConnectionId]**: The length of the message (in bytes) when sending asynchronously.This setting specifies the length of messages being sent when operating asynchronously.

When [DefaultTimeout](#defaulttimeout-property-azurerelayreceiver-component) is set to *0* the component operates asynchronously and by default all data sent when [Send](#send-method-azurerelayreceiver-component) is called or [SendBytes](#sendbytes-method-azurerelayreceiver-component) or [SendText](#sendtext-method-azurerelayreceiver-component) is set is considered a complete message. Each packet leaving the component has the End-of-Message flag set.

To send messages which may be fragmented, set [MessageLength](#MessageLength) to the length of the message (in bytes) that is being sent. When set the component will consider the next [MessageLength](#MessageLength) bytes sent as part of a single message and only the last packet will set the End-of-Message flag.

This setting is helpful when data is organized into messages and the receiving side expected the End-of-Message flag to signal the end of a message.

Note: This setting is only applicable when [DefaultTimeout](#defaulttimeout-property-azurerelayreceiver-component) is set to *0*. When [DefaultTimeout](#defaulttimeout-property-azurerelayreceiver-component) is set to a positive value the message data may be passed in its entirety to [SendBytes](#sendbytes-method-azurerelayreceiver-component) or [SendText](#sendtext-method-azurerelayreceiver-component) or [Send](#send-method-azurerelayreceiver-component) and will be automatically handled as needed by the component.

**WaitForCloseResponse**: Determines whether or not the component will forcibly close a connection.When true (default) the component will wait for a response from the client when closing the connection. When this setting is set to false, the component will forcibly close the connection without waiting for a response from the client.

### TCPServer Config Settings

**AllowedClients**: A comma-separated list of host names or IP addresses that can access the component.This configuration setting defines a comma-separated list of host names or IPv4 addresses that may access the component. The wildcard character "*" is supported. The default value is "*" and all connections are accepted.

When a client connects, the client's address is checked against the list defined here. If there is no match, the [ConnectionRequest](#connectionrequest-event-azurerelayreceiver-component) event fires with an *Accept* value set to *false*. If no action is taken within the [ConnectionRequest](#connectionrequest-event-azurerelayreceiver-component) event, the client will be disconnected.

**BindExclusively**: Whether or not the component considers a local port reserved for exclusive use.If this is *true* (default), the component will bind to the local port with the ExclusiveAddressUse option set, meaning that nothing else can bind to the same port. Also the component will not be able to bind to local ports that are already in use by some other instance, and attempts to do so will result in failure.

**BlockedClients**: A comma-separated list of host names or IP addresses that cannot access the component.This configuration setting defines a comma-separated list of host names or IPv4 addresses that cannot access the component.The default value is "" and all connections are accepted.

When a client connects, the client's address is checked against the list defined here. If there is a match, the [ConnectionRequest](#connectionrequest-event-azurerelayreceiver-component) event fires with an *Accept* value set to *false*. If no action is taken within the [ConnectionRequest](#connectionrequest-event-azurerelayreceiver-component) event, the client will not be connected.

**CloseStreamAfterTransfer**: If true, the component will close the upload or download stream after the transfer.This configuration setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. To keep streams open after the transfer of data, set this to False. The default value is True.

**DefaultConnectionTimeout**: The inactivity timeout applied to the SSL handshake.This configuration setting specifies the inactivity (in seconds) to apply to incoming Secure Sockets Layer (SSL) connections. When set to a positive value, if the other end is unresponsive for the specified number of seconds, the connection will timeout. This is not applicable to the entire handshake. It is applicable only to the inactivity of the connecting client during the handshake if a response is expected and none is received within the timeout window. The default value is 0, and no connection-specific timeout is applied.

NOTE: This is applicable only to incoming SSL connections. This should be set only if there is a specific reason to do so.

**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. Increasing the value of the [InBufferSize](#InBufferSize) setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated, the [InBufferSize](#InBufferSize) reverts to its defined size. The same thing will happen if you attempt to make it too large or too small.

[InBufferSize](#InBufferSize) is shared among incoming connections. When the setting is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.

**KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.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 setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. If this value is not specified here, the system default is 1 second. This setting is applicable to all connections.

NOTE: This value is not applicable in macOS.

**KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.By default, the operating system will determine the time a connection is idle before a TCP keep-alive packet is sent. If this value is not specified here, the system default is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. This setting is applicable to all connections.

**MaxConnections**: The maximum number of connections available. This is the maximum number of connections available. This setting must be set before [Listening](#listening-property-azurerelayreceiver-component) is set to *true*, and once set, it can no longer be changed for the current instance of the component. The maximum value for this setting is 100,000 connections. Use this setting with caution. Extremely large values may affect performance.

**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. Increasing the value of the [OutBufferSize](#OutBufferSize) setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the [OutBufferSize](#OutBufferSize) reverts to its defined size. The same thing will happen if you attempt to make it too large or too small.

[OutBufferSize](#OutBufferSize) is shared among incoming connections. When the setting is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.

**PreferredDHGroupBits**: Size of the Diffie-Hellman group, in bits.This configuration setting specifies the key length used by the Diffie-Hellman key algorithm. The default value is *2048* (bits).

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

**UseBackgroundThread**: Whether threads created by the component are background threads.If set to *true*, when the component creates a thread, the thread's IsBackground property will be explicitly set to *true*. By default, this setting is *false*.

**UseIPv6**: Whether to use IPv6.When set to 0 (default), the component will use IPv4 exclusively. When set to 1, the component will use IPv6 exclusively. When set to 2, the component will listen for both IPv4 and IPv6 connections. If IPv6 is not available on the system, only IPv4 will be used. The default value is 0. Possible values are as follows:

|  |  |
| --- | --- |
| 0 | IPv4 Only |
| 1 | IPv6 Only |
| 2 | IPv6 and IPv4 |

### SSL Config Settings

**CACertFilePaths**: The paths to CA certificate files when using Mono on Unix/Linux.This configuration setting specifies the paths on disk to certificate authority (CA) certificate files when using Mono on Unix/Linux. It is not applicable in any other circumstances.

The value is formatted as a list of paths separated by semicolons. The component will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is as follows:

*/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem*

**LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#sslprovider-property-azurerelayreceiver-component) 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 [SSLStatus](#sslstatus-event-azurerelayreceiver-component) event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-azurerelayreceiver-component) is set to *Platform*.

**ReuseSSLSession**: Determines if the SSL session is reused.

If set to True, the component 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 component is the same.

**SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-azurerelayreceiver-component) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the [SSLCert](#sslcert-property-azurerelayreceiver-component) 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 component will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the component will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The component 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 component throws an exception.

When set to 0 (default), the CRL check will not be performed by the component. 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 component will use OCSP to check the validity of the server certificate. If set to 1 or 2, the component will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The component 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 component throws an exception.

When set to 0 (default), the component 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 [SSLStatus](#sslstatus-event-azurerelayreceiver-component) 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 SSLAuthenticateClients 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 component 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 [SSLProvider](#sslprovider-property-azurerelayreceiver-component) 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 [SSLProvider](#sslprovider-property-azurerelayreceiver-component) 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 [SSLProvider](#sslprovider-property-azurerelayreceiver-component) 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 [SSLProvider](#sslprovider-property-azurerelayreceiver-component) 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 component will first try to use the platform TLS 1.3 implementation when the [SSLProvider](#sslprovider-property-azurerelayreceiver-component) 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, [SSLProvider](#sslprovider-property-azurerelayreceiver-component) 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 component when the [SSLProvider](#sslprovider-property-azurerelayreceiver-component) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#sslprovider-property-azurerelayreceiver-component) 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 [SSLProvider](#sslprovider-property-azurerelayreceiver-component) 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 [SSLServerAuthentication](#sslserverauthentication-event-azurerelayreceiver-component) 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 [SSLServerAuthentication](#sslserverauthentication-event-azurerelayreceiver-component) event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-azurerelayreceiver-component) event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

Note: When [SSLProvider](#sslprovider-property-azurerelayreceiver-component) is set to *Internal* this value is automatically set to *true*. This is needed for proper validation when using the internal provider.

**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 component 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 component will only append, it will not overwrite previous values.

NOTE: This configuration setting is applicable only when [SSLProvider](#sslprovider-property-azurerelayreceiver-component) 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 in Java or 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 [SSLProvider](#sslprovider-property-azurerelayreceiver-component) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2.

When specified the component 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 component throws an exception.

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 [SSLProvider](#sslprovider-property-azurerelayreceiver-component) 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

# Trappable Errors ([AzureRelayReceiver](#azurerelayreceiver-component) Component)

### WebSocketServer Errors

|  |  |
| --- | --- |
| 4202 | Error sending data to the connected client. |

### TCPServer Errors

|  |  |
| --- | --- |
| 100 | You cannot change the RemotePort at this time. A connection is in progress. |
| 101 | You cannot change the RemoteHost at this time. A connection is in progress. |
| 102 | The RemoteHost address is invalid (0.0.0.0). |
| 104 | TCPServer is already listening. |
| 106 | Cannot change LocalPort when TCPServer is listening. |
| 107 | Cannot change [LocalHost](#localhost-property-azurerelayreceiver-component) when TCPServer is listening. |
| 108 | Cannot change [MaxConnections](#MaxConnections) when TCPServer is listening. |
| 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. |
| 116 | RemotePort cannot be zero. Please specify a valid service port number. |
| 126 | Invalid ConnectionId. |
| 135 | Operation would block. |

### SSL Errors

|  |  |
| --- | --- |
| 270 | Cannot load specified security library. |
| 271 | Cannot open certificate store. |
| 272 | Cannot find specified certificate. |
| 273 | Cannot acquire security credentials. |
| 274 | Cannot find certificate chain. |
| 275 | Cannot verify certificate chain. |
| 276 | Error during handshake. |
| 280 | Error verifying certificate. |
| 281 | Could not find client certificate. |
| 282 | Could not find server certificate. |
| 283 | Error encrypting data. |
| 284 | Error decrypting data. |

### TCP/IP Errors

|  |  |
| --- | --- |
| 10004 | [10004] Interrupted system call. |
| 10009 | [10009] Bad file number. |
| 10013 | [10013] Access denied. |
| 10014 | [10014] Bad address. |
| 10022 | [10022] Invalid argument. |
| 10024 | [10024] Too many open files. |
| 10035 | [10035] Operation would block. |
| 10036 | [10036] Operation now in progress. |
| 10037 | [10037] Operation already in progress. |
| 10038 | [10038] Socket operation on nonsocket. |
| 10039 | [10039] Destination address required. |
| 10040 | [10040] Message is too long. |
| 10041 | [10041] Protocol wrong type for socket. |
| 10042 | [10042] Bad protocol option. |
| 10043 | [10043] Protocol is not supported. |
| 10044 | [10044] Socket type is not supported. |
| 10045 | [10045] Operation is not supported on socket. |
| 10046 | [10046] Protocol family is not supported. |
| 10047 | [10047] Address family is not supported by protocol family. |
| 10048 | [10048] Address already in use. |
| 10049 | [10049] Cannot assign requested address. |
| 10050 | [10050] Network is down. |
| 10051 | [10051] Network is unreachable. |
| 10052 | [10052] Net dropped connection or reset. |
| 10053 | [10053] Software caused connection abort. |
| 10054 | [10054] Connection reset by peer. |
| 10055 | [10055] No buffer space available. |
| 10056 | [10056] Socket is already connected. |
| 10057 | [10057] Socket is not connected. |
| 10058 | [10058] Cannot send after socket shutdown. |
| 10059 | [10059] Too many references, cannot splice. |
| 10060 | [10060] Connection timed out. |
| 10061 | [10061] Connection refused. |
| 10062 | [10062] Too many levels of symbolic links. |
| 10063 | [10063] File name is too long. |
| 10064 | [10064] Host is down. |
| 10065 | [10065] No route to host. |
| 10066 | [10066] Directory is not empty |
| 10067 | [10067] Too many processes. |
| 10068 | [10068] Too many users. |
| 10069 | [10069] Disc Quota Exceeded. |
| 10070 | [10070] Stale NFS file handle. |
| 10071 | [10071] Too many levels of remote in path. |
| 10091 | [10091] Network subsystem is unavailable. |
| 10092 | [10092] WINSOCK DLL Version out of range. |
| 10093 | [10093] Winsock is not loaded yet. |
| 11001 | [11001] Host not found. |
| 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
| 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
| 11004 | [11004] Valid name, no data record (check DNS setup). |