RESTServer Component

Properties   Methods   Events   Config Settings   Errors  

The RESTServer component supports server-side functionality of the REST protocol.

Syntax

nsoftware.SecureBlackbox.RESTServer

Remarks

Use this control to add REST server functionality to your application.

Property List

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

Method List

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

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.

Config Settings

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

Active Property (RESTServer Component)

Indicates whether the server is active and is listening to new connections.

Syntax

• C#
• VB.NET

public bool Active { get; }

Public ReadOnly Property Active As Boolean

Default Value

False

Remarks

This read-only property returns True if the server is listening to incoming connections.

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

AllowCustomRequests Property (RESTServer Component)

Allows custom requests.

Syntax

• C#
• VB.NET

public bool AllowCustomRequests { get; set; }

Public Property AllowCustomRequests As Boolean

Default Value

True

Remarks

Use this property to allow custom requests.

AllowKeepAlive Property (RESTServer Component)

Enables or disables keep-alive mode.

Syntax

• C#
• VB.NET

public bool AllowKeepAlive { get; set; }

Public Property AllowKeepAlive As Boolean

Default Value

True

Remarks

Use this property to enable or disable the keep-alive connection mode. If keep-alive is enabled, clients that choose to use it may stay connected for a while.

AuthRealm Property (RESTServer Component)

Specifies authentication realm for digest and NTLM authentication.

Syntax

• C#
• VB.NET

public string AuthRealm { get; set; }

Public Property AuthRealm As String

Default Value

"SecureBlackbox"

Remarks

Specifies authentication realm for digest and NTLM authentication types.

AuthTypes Property (RESTServer Component)

Defines allowed HTTP authentication types.

Syntax

• C#
• VB.NET

public int AuthTypes { get; set; }

Public Property AuthTypes As Integer

Default Value

0

Remarks

Use this property to define which authentication types the component should support or attempt to use by enabling the relevant bitmask flags:

BoundPort Property (RESTServer Component)

Indicates the bound listening port.

Syntax

• C#
• VB.NET

public int BoundPort { get; }

Public ReadOnly Property BoundPort As Integer

Default Value

0

Remarks

Check this property to find out the port that has been allocated to the server by the system. The bound port always equals Port if it is provided, or is allocated dynamically if configured to fall in the range between PortRangeFrom and PortRangeTo constraints.

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

CompressionLevel Property (RESTServer Component)

The default compression level to use.

Syntax

• C#
• VB.NET

public int CompressionLevel { get; set; }

Public Property CompressionLevel As Integer

Default Value

6

Remarks

Assign this property with the compression level (1 to 9) to apply for gzipped responses. 1 stands for the lightest but fastest compression, and 9 for the best but the slowest.

DocumentRoot Property (RESTServer Component)

The document root of the server.

Syntax

• C#
• VB.NET

public string DocumentRoot { get; set; }

Public Property DocumentRoot As String

Default Value

""

Remarks

Use this property to specify a local folder which is going to be the server's document root (the mount point of the virtual home directory).

ExternalCrypto Property (RESTServer Component)

Provides access to external signing and DC parameters.

Syntax

• C#
• VB.NET

public ExternalCrypto ExternalCrypto { get; }

Public ReadOnly Property ExternalCrypto As ExternalCrypto

Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).

This property is read-only.

FIPSMode Property (RESTServer Component)

Reserved.

Syntax

• C#
• VB.NET

public bool FIPSMode { get; set; }

Public Property FIPSMode As Boolean

Default Value

False

Remarks

This property is reserved for future use.

HandshakeTimeout Property (RESTServer Component)

Specifies the handshake timeout in milliseconds.

Syntax

• C#
• VB.NET

public int HandshakeTimeout { get; set; }

Public Property HandshakeTimeout As Integer

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Host Property (RESTServer Component)

The host to bind the listening port to.

Syntax

• C#
• VB.NET

public string Host { get; set; }

Public Property Host As String

Default Value

""

Remarks

Use this property to specify the IP address on which to listen to incoming connections.

PinnedClient Property (RESTServer Component)

Populates the pinned client details.

Syntax

• C#
• VB.NET

public TLSConnectionInfo PinnedClient { get; }

Public ReadOnly Property PinnedClient As TLSConnectionInfo

Remarks

Use this property to access the details of the client connection previously pinned with PinClient method.

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

PinnedClientChain Property (RESTServer Component)

Contains the certificate chain of the pinned client.

Syntax

• C#
• VB.NET

public CertificateList PinnedClientChain { get; }

Public ReadOnly Property PinnedClientChain As CertificateList

Remarks

Use this property to access the certificate chain of the client connection pinned previously with a PinClient call.

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

Port Property (RESTServer Component)

Specifies the port number to listen for connections on.

Syntax

• C#
• VB.NET

public int Port { get; set; }

Public Property Port As Integer

Default Value

80

Remarks

Use this property to specify the port number to listen to connections on. Standard port numbers are 80 for an HTTP server, and 443 for an HTTPS server.

Alternatively, you may specify the acceptable range of listening ports via PortRangeFrom and PortRangeTo properties. In this case the port will be allocated within the requested range by the operating system, and reported in BoundPort.

PortRangeFrom Property (RESTServer Component)

Specifies the lower limit of the listening port range for incoming connections.

Syntax

• C#
• VB.NET

public int PortRangeFrom { get; set; }

Public Property PortRangeFrom As Integer

Default Value

0

Remarks

Use this property to specify the lower limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via Port), the port will be allocated within the requested range by the operating system, and reported in BoundPort.

Note that this property is ignored if the Port property is set to a non-zero value, in which case the server always aims to listen on that fixed port.

PortRangeTo Property (RESTServer Component)

Specifies the upper limit of the listening port range for incoming connections.

Syntax

• C#
• VB.NET

public int PortRangeTo { get; set; }

Public Property PortRangeTo As Integer

Default Value

0

Remarks

Use this property to specify the upper limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via Port), the port will be allocated within the requested range by the operating system, and reported in BoundPort.

Note that this property is ignored if the Port property is set to a non-zero value, in which case the server always aims to listen on that fixed port.

SessionTimeout Property (RESTServer Component)

Specifies the default session timeout value in milliseconds.

Syntax

• C#
• VB.NET

public int SessionTimeout { get; set; }

Public Property SessionTimeout As Integer

Default Value

360000

Remarks

Specifies the period of inactivity (in milliseconds) after which the connection will be terminated by the server.

SocketSettings Property (RESTServer Component)

Manages network connection settings.

Syntax

• C#
• VB.NET

public SocketSettings SocketSettings { get; }

Public ReadOnly Property SocketSettings As SocketSettings

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

TLSServerChain Property (RESTServer Component)

The server's TLS certificates.

Syntax

• C#
• VB.NET

public CertificateList TLSServerChain { get; }

Public Property TLSServerChain As CertificateList

Remarks

Use this property to provide a list of TLS certificates for the server endpoint.

A TLS endpoint needs a certificate to be able to accept TLS connections. At least one of the certificates in the collection - the endpoint certificate - must have a private key associated with it.

The collection may include more than one endpoint certificate, and more than one chain. A typical usage scenario is to include two chains (ECDSA and RSA), to cater for clients with different cipher suite preferences.

This property is not available at design time.

TLSSettings Property (RESTServer Component)

Manages TLS layer settings.

Syntax

• C#
• VB.NET

public TLSSettings TLSSettings { get; }

Public ReadOnly Property TLSSettings As TLSSettings

Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

UseChunkedTransfer Property (RESTServer Component)

Enables chunked transfer.

Syntax

• C#
• VB.NET

public bool UseChunkedTransfer { get; set; }

Public Property UseChunkedTransfer As Boolean

Default Value

False

Remarks

Use this property to enable chunked content encoding.

UseCompression Property (RESTServer Component)

Enables or disables server-side compression.

Syntax

• C#
• VB.NET

public bool UseCompression { get; set; }

Public Property UseCompression As Boolean

Default Value

False

Remarks

Use this property to enable or disable server-side content compression.

Users Property (RESTServer Component)

Provides a list of registered users.

Syntax

• C#
• VB.NET

public UserAccountList Users { get; }

Public Property Users As UserAccountList

Remarks

Assign a list of 'known' users to this property to automate authentication handling by the component.

This property is not available at design time.

WebsiteName Property (RESTServer Component)

Specifies the web site name to use in the certificate.

Syntax

• C#
• VB.NET

public string WebsiteName { get; set; }

Public Property WebsiteName As String

Default Value

"secureblackbox"

Remarks

If using an internally-generated certificate, use this property to specify the web site name to be included as a common name. A typical common name consists of the host name, such as '192.168.10.10' or 'domain.com'.

Cleanup Method (RESTServer Component)

Cleans up the server environment by purging expired sessions and cleaning caches.

Syntax

• C#
• VB.NET

public void Cleanup();

Public Sub Cleanup()

Remarks

Call this method while the server is active to clean up the environment allocated for the server by releasing unused resources and cleaning caches.

Config Method (RESTServer Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings 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, you must call Config("PROPERTY"). The value will be returned as a string.

DoAction Method (RESTServer Component)

Performs an additional action.

Syntax

• C#
• VB.NET

public string DoAction(string actionID, string actionParams);

Public Function DoAction(ByVal ActionID As String, ByVal ActionParams As String) As String

Remarks

DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

DropClient Method (RESTServer Component)

Terminates a client connection.

Syntax

• C#
• VB.NET

public void DropClient(long connectionId, bool forced);

Public Sub DropClient(ByVal ConnectionId As Long, ByVal Forced As Boolean)

Remarks

Call this method to shut down a connected client. Forced indicates whether the connection should be closed in a graceful manner.

GetRequestBytes Method (RESTServer Component)

Returns the contents of the client's HTTP request.

Syntax

• C#
• VB.NET

public byte[] GetRequestBytes(long connectionId, string requestFilter);

Public Function GetRequestBytes(ByVal ConnectionId As Long, ByVal RequestFilter As String) As Byte()

Remarks

Use this method to get the body of the client's HTTP request. Note that the body of GET and HEAD requests is empty. The method returns the requested content.

The RequestFilter parameter allows you to select the element(s) that you would like to get. An empty request filter makes the whole body to be returned. The following request filters are currently supported:

GetRequestHeader Method (RESTServer Component)

Returns a request header value.

Syntax

• C#
• VB.NET

public string GetRequestHeader(long connectionId, string headerName);

Public Function GetRequestHeader(ByVal ConnectionId As Long, ByVal HeaderName As String) As String

Remarks

Use this method to get the value of a request header. A good place to call this method is a request-marking event, such as GetRequest or PostRequest.

GetRequestStream Method (RESTServer Component)

Returns the contents of the client's HTTP request.

Syntax

• C#
• VB.NET

public void GetRequestStream(long connectionId, string requestFilter, System.IO.Stream outputStream);

Public Sub GetRequestStream(ByVal ConnectionId As Long, ByVal RequestFilter As String, ByVal OutputStream As System.IO.Stream)

Remarks

Use this method to get the body of the client's HTTP request into a stream. Note that the body of GET and HEAD requests is empty.

The RequestFilter parameter allows you to select the element(s) of the requests that you would like to get. An empty request filter makes the whole body to be returned. The following request filters are currently supported:

GetRequestString Method (RESTServer Component)

Returns the contents of the client's HTTP request.

Syntax

• C#
• VB.NET

public string GetRequestString(long connectionId, string requestFilter);

Public Function GetRequestString(ByVal ConnectionId As Long, ByVal RequestFilter As String) As String

Remarks

Use this method to get the body of the client's HTTP request to a string. Note that the body of GET and HEAD requests is empty.

The RequestFilter parameter allows you to select the element(s) of the requests that you would like to get. An empty request filter makes the whole body to be returned. The following request filters are currently supported:

GetRequestUsername Method (RESTServer Component)

Returns the username for a connection.

Syntax

• C#
• VB.NET

public string GetRequestUsername(long connectionId);

Public Function GetRequestUsername(ByVal ConnectionId As Long) As String

Remarks

Use this method to obtain a username for an active connection. The method will return an empty string if no authentication has been performed on the connection.

GetResponseHeader Method (RESTServer Component)

Returns a response header value.

Syntax

• C#
• VB.NET

public string GetResponseHeader(long connectionId, string headerName);

Public Function GetResponseHeader(ByVal ConnectionId As Long, ByVal HeaderName As String) As String

Remarks

Use this method to get the value of a response header. A good place to call this method is HeadersPrepared event. Call the method with empty HeaderName to get the whole response header.

ListClients Method (RESTServer Component)

Enumerates the connected clients.

Syntax

• C#
• VB.NET

public string ListClients();

Public Function ListClients() As String

Remarks

This method enumerates the connected clients. It returns a list of strings, with each string being of 'ConnectionID|Address|Port' format, and representing a single connection.

PinClient Method (RESTServer Component)

Takes a snapshot of the connection's properties.

Syntax

• C#
• VB.NET

public void PinClient(long connectionId);

Public Sub PinClient(ByVal ConnectionId As Long)

Remarks

Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient and PinnedClientChain properties.

ProcessGenericRequest Method (RESTServer Component)

Processes a generic HTTP request.

Syntax

• C#
• VB.NET

public byte[] ProcessGenericRequest(long connectionId, byte[] requestBytes);

Public Function ProcessGenericRequest(ByVal ConnectionId As Long, ByVal RequestBytes As Byte()) As Byte()

Remarks

This method processes a generic HTTP request and produces a response. Use it to generate HTTP responses for requests obtained externally, out of the default HTTP channel.

This method respects all current settings of the server object, and invokes the corresponding events to consult about the request and response details with the application. ConnectionId allows to identify the request in the events.

The method returns the complete HTTP response including HTTP headers.

ProcessGenericRequestStream Method (RESTServer Component)

Processes a generic HTTP request from a stream.

Syntax

• C#
• VB.NET

public void ProcessGenericRequestStream(long connectionId, string requestHeaders, System.IO.Stream requestData, System.IO.Stream responseData);

Public Sub ProcessGenericRequestStream(ByVal ConnectionId As Long, ByVal RequestHeaders As String, ByVal RequestData As System.IO.Stream, ByVal ResponseData As System.IO.Stream)

Remarks

This method processes a generic HTTP request and produces a response. Use it to generate HTTP responses for requests obtained externally, out of the default HTTP channel.

The method expects the request headers in RequestHeaders, and the request data is read from RequestData stream. Once the request is processed, the response headers are reported through HeadersPrepared event before any data is written to ResponseData stream. ConnectionId allows to identify the request in the events.

This method respects all current settings of the server object, and invokes the corresponding events to consult about the request and response details with the application.

Reset Method (RESTServer Component)

Resets the component settings.

Syntax

• C#
• VB.NET

public void Reset();

Public Sub Reset()

Remarks

Reset is a generic method available in every component.

SetResponseBytes Method (RESTServer Component)

Sets a byte array to be served as a response.

Syntax

• C#
• VB.NET

public void SetResponseBytes(long connectionId, byte[] bytes, string contentType, string responseFilter);

Public Sub SetResponseBytes(ByVal ConnectionId As Long, ByVal Bytes As Byte(), ByVal ContentType As String, ByVal ResponseFilter As String)

Remarks

Use this property to provide the response content in a byte array. The ResponseFilter parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is parts:

SetResponseFile Method (RESTServer Component)

Sets a file to be served as a response.

Syntax

• C#
• VB.NET

public void SetResponseFile(long connectionId, string fileName, string contentType, string responseFilter);

Public Sub SetResponseFile(ByVal ConnectionId As Long, ByVal FileName As String, ByVal ContentType As String, ByVal ResponseFilter As String)

Remarks

Use this property to provide the response content in a file. The ResponseFilter parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is parts:

SetResponseHeader Method (RESTServer Component)

Sets a response header.

Syntax

• C#
• VB.NET

public void SetResponseHeader(long connectionId, string headerName, string value);

Public Sub SetResponseHeader(ByVal ConnectionId As Long, ByVal HeaderName As String, ByVal Value As String)

Remarks

Use this method to set a response header. A good place to call this method is a request-marking event, such as GetRequest or PostRequest.

SetResponseJSON Method (RESTServer Component)

Sets a string to be served as a JSON response.

Syntax

• C#
• VB.NET

public void SetResponseJSON(long connectionId, string data, string responseFilter);

Public Sub SetResponseJSON(ByVal ConnectionId As Long, ByVal Data As String, ByVal ResponseFilter As String)

Remarks

Use this property to provide the JSON response content in a string.

SetResponseStatus Method (RESTServer Component)

Sets an HTTP status to be sent with the response.

Syntax

• C#
• VB.NET

public void SetResponseStatus(long connectionId, int statusCode);

Public Sub SetResponseStatus(ByVal ConnectionId As Long, ByVal StatusCode As Integer)

Remarks

Use this method to set an HTTP status for the request. A good place to call this method is a request-marking event, such as GetRequest.

SetResponseStream Method (RESTServer Component)

Sets a stream to be served as a response.

Syntax

• C#
• VB.NET

public void SetResponseStream(long connectionId, System.IO.Stream dataStream, bool closeStream, string contentType, string responseFilter);

Public Sub SetResponseStream(ByVal ConnectionId As Long, ByVal DataStream As System.IO.Stream, ByVal CloseStream As Boolean, ByVal ContentType As String, ByVal ResponseFilter As String)

Remarks

Use this property to provide the response content in a stream. Set CloseStream to indicate that the stream should be disposed of once sent. The ResponseFilter parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is parts:

SetResponseString Method (RESTServer Component)

Sets a string to be served as a response.

Syntax

• C#
• VB.NET

public void SetResponseString(long connectionId, string dataStr, string contentType, string responseFilter);

Public Sub SetResponseString(ByVal ConnectionId As Long, ByVal DataStr As String, ByVal ContentType As String, ByVal ResponseFilter As String)

Remarks

Use this property to provide the response content in a string. The ResponseFilter parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is parts:

SetResponseXML Method (RESTServer Component)

Sets a string to be served as an XML response.

Syntax

• C#
• VB.NET

public void SetResponseXML(long connectionId, string data, string responseFilter);

Public Sub SetResponseXML(ByVal ConnectionId As Long, ByVal Data As String, ByVal ResponseFilter As String)

Remarks

Use this property to provide the XML response content in a string.

Start Method (RESTServer Component)

Starts the server.

Syntax

• C#
• VB.NET

public void Start();

Public Sub Start()

Remarks

Use this method to activate the server and start listening to incoming connections.

Stop Method (RESTServer Component)

Stops the server.

Syntax

• C#
• VB.NET

public void Stop();

Public Sub Stop()

Remarks

Call this method to stop listening to incoming connections and deactivate the server.

Accept Event (RESTServer Component)

Reports an incoming connection.

Syntax

• C#
• VB.NET

public event OnAcceptHandler OnAccept;

public delegate void OnAcceptHandler(object sender, RESTServerAcceptEventArgs e);

public class RESTServerAcceptEventArgs : EventArgs {
  public string RemoteAddress { get; }
  public int RemotePort { get; }
  public bool Accept { get; set; }
}

Public Event OnAccept As OnAcceptHandler

Public Delegate Sub OnAcceptHandler(sender As Object, e As RESTServerAcceptEventArgs)

Public Class RESTServerAcceptEventArgs Inherits EventArgs
  Public ReadOnly Property RemoteAddress As String
  Public ReadOnly Property RemotePort As Integer
  Public Property Accept As Boolean
End Class

Remarks

This event is fired when a new connection from RemoteAddress:RemotePort is ready to be accepted. Use the Accept parameter to accept or decline it.

Subscribe to Connect event to be notified of every connection that has been set up.

AuthAttempt Event (RESTServer Component)

Fires when a connected client makes an authentication attempt.

Syntax

• C#
• VB.NET

public event OnAuthAttemptHandler OnAuthAttempt;

public delegate void OnAuthAttemptHandler(object sender, RESTServerAuthAttemptEventArgs e);

public class RESTServerAuthAttemptEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string HTTPMethod { get; }
  public string URI { get; }
  public string AuthMethod { get; }
  public string Username { get; }
  public string Password { get; }
  public bool Allow { get; set; }
}

Public Event OnAuthAttempt As OnAuthAttemptHandler

Public Delegate Sub OnAuthAttemptHandler(sender As Object, e As RESTServerAuthAttemptEventArgs)

Public Class RESTServerAuthAttemptEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property HTTPMethod As String
  Public ReadOnly Property URI As String
  Public ReadOnly Property AuthMethod As String
  Public ReadOnly Property Username As String
  Public ReadOnly Property Password As String
  Public Property Allow As Boolean
End Class

Remarks

The component fires this event whenever a client attempts to authenticate itself. Use the Allow parameter to let the client through.

ConnectionID contains the unique session identifier for that client, HTTPMethod specifies the HTTP method (GET, POST, etc.) used to access the URI resource, AuthMethod specifies the authentication method, and Username and Password contain the professed credentials.

Connect Event (RESTServer Component)

Reports an accepted connection.

Syntax

• C#
• VB.NET

public event OnConnectHandler OnConnect;

public delegate void OnConnectHandler(object sender, RESTServerConnectEventArgs e);

public class RESTServerConnectEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string RemoteAddress { get; }
  public int RemotePort { get; }
}

Public Event OnConnect As OnConnectHandler

Public Delegate Sub OnConnectHandler(sender As Object, e As RESTServerConnectEventArgs)

Public Class RESTServerConnectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property RemoteAddress As String
  Public ReadOnly Property RemotePort As Integer
End Class

Remarks

The component fires this event to report that a new connection has been established. ConnectionId indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as TLSHandshake or Data.

CustomRequest Event (RESTServer Component)

Reports a request of a non-standard type (method).

Syntax

• C#
• VB.NET

public event OnCustomRequestHandler OnCustomRequest;

public delegate void OnCustomRequestHandler(object sender, RESTServerCustomRequestEventArgs e);

public class RESTServerCustomRequestEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string URI { get; }
  public string HTTPMethod { get; }
  public bool Handled { get; set; }
}

Public Event OnCustomRequest As OnCustomRequestHandler

Public Delegate Sub OnCustomRequestHandler(sender As Object, e As RESTServerCustomRequestEventArgs)

Public Class RESTServerCustomRequestEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property URI As String
  Public ReadOnly Property HTTPMethod As String
  Public Property Handled As Boolean
End Class

Remarks

The component fires this event to notify the application about a non-standard request received from the client. The HTTPMethod contains the non-standard HTTP method.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Handled to true to indicate that your application's code will take care of the request. The application does it by providing the necessary details via SetResponseStatus, SetResponseHeader, and SetResponseFile methods. If the returned value of Handled is false, the server will try to take care of the request automatically by searching for the requested resource in DocumentRoot.

Data Event (RESTServer Component)

Supplies a data chunk received within a POST or PUT upload.

Syntax

• C#
• VB.NET

public event OnDataHandler OnData;

public delegate void OnDataHandler(object sender, RESTServerDataEventArgs e);

public class RESTServerDataEventArgs : EventArgs {
  public long ConnectionID { get; }
  public byte[] Buffer { get; }
}

Public Event OnData As OnDataHandler

Public Delegate Sub OnDataHandler(sender As Object, e As RESTServerDataEventArgs)

Public Class RESTServerDataEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Buffer As Byte()
End Class

Remarks

This event is fired to supply another piece of data received within a POST or PUT upload operation. This event may fire multiple times during a single request upload to pass the uploaded data to the application chunk-by-chunk.

DeleteRequest Event (RESTServer Component)

Reports a DELETE request.

Syntax

• C#
• VB.NET

public event OnDeleteRequestHandler OnDeleteRequest;

public delegate void OnDeleteRequestHandler(object sender, RESTServerDeleteRequestEventArgs e);

public class RESTServerDeleteRequestEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string URI { get; }
  public bool Handled { get; set; }
}

Public Event OnDeleteRequest As OnDeleteRequestHandler

Public Delegate Sub OnDeleteRequestHandler(sender As Object, e As RESTServerDeleteRequestEventArgs)

Public Class RESTServerDeleteRequestEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property URI As String
  Public Property Handled As Boolean
End Class

Remarks

The component fires this event to notify the application about a DELETE request received from the client.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Handled to true to indicate that your application's code will take care of the request. The application does it by providing the necessary details via SetResponseStatus, SetResponseHeader, and SetResponseFile methods. If the returned value of Handled is false, the server will try to take care of the request automatically by searching for the requested resource in DocumentRoot.

Disconnect Event (RESTServer Component)

Fires to report a disconnected client.

Syntax

• C#
• VB.NET

public event OnDisconnectHandler OnDisconnect;

public delegate void OnDisconnectHandler(object sender, RESTServerDisconnectEventArgs e);

public class RESTServerDisconnectEventArgs : EventArgs {
  public long ConnectionID { get; }
}

Public Event OnDisconnect As OnDisconnectHandler

Public Delegate Sub OnDisconnectHandler(sender As Object, e As RESTServerDisconnectEventArgs)

Public Class RESTServerDisconnectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
End Class

Remarks

The component fires this event when a connected client disconnects.

Error Event (RESTServer Component)

Information about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

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

public class RESTServerErrorEventArgs : EventArgs {
  public long ConnectionId { get; }
  public int ErrorCode { get; }
  public bool Fatal { get; }
  public bool Remote { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As RESTServerErrorEventArgs)

Public Class RESTServerErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Fatal As Boolean
  Public ReadOnly Property Remote As Boolean
  Public ReadOnly Property Description As String
End Class

Remarks

The event is fired in case of exceptional conditions during message processing.

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 HTTPS section.

ExternalSign Event (RESTServer Component)

Handles remote or external signing initiated by the server protocol.

Syntax

• C#
• VB.NET

public event OnExternalSignHandler OnExternalSign;

public delegate void OnExternalSignHandler(object sender, RESTServerExternalSignEventArgs e);

public class RESTServerExternalSignEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string OperationId { get; }
  public string HashAlgorithm { get; }
  public string Pars { get; }
  public string Data { get; }
  public string SignedData { get; set; }
}

Public Event OnExternalSign As OnExternalSignHandler

Public Delegate Sub OnExternalSignHandler(sender As Object, e As RESTServerExternalSignEventArgs)

Public Class RESTServerExternalSignEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property OperationId As String
  Public ReadOnly Property HashAlgorithm As String
  Public ReadOnly Property Pars As String
  Public ReadOnly Property Data As String
  Public Property SignedData As String
End Class

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the component via the SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.

The component uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

FileError Event (RESTServer Component)

Reports a file access error to the application.

Syntax

• C#
• VB.NET

public event OnFileErrorHandler OnFileError;

public delegate void OnFileErrorHandler(object sender, RESTServerFileErrorEventArgs e);

public class RESTServerFileErrorEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string FileName { get; }
  public int ErrorCode { get; }
}

Public Event OnFileError As OnFileErrorHandler

Public Delegate Sub OnFileErrorHandler(sender As Object, e As RESTServerFileErrorEventArgs)

Public Class RESTServerFileErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property FileName As String
  Public ReadOnly Property ErrorCode As Integer
End Class

Remarks

The component uses this event to report a file access errors. FileName and ErrorCode contain the file path and the error code respectively.

GetRequest Event (RESTServer Component)

Reports a GET request.

Syntax

• C#
• VB.NET

public event OnGetRequestHandler OnGetRequest;

public delegate void OnGetRequestHandler(object sender, RESTServerGetRequestEventArgs e);

public class RESTServerGetRequestEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string URI { get; }
  public bool Handled { get; set; }
}

Public Event OnGetRequest As OnGetRequestHandler

Public Delegate Sub OnGetRequestHandler(sender As Object, e As RESTServerGetRequestEventArgs)

Public Class RESTServerGetRequestEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property URI As String
  Public Property Handled As Boolean
End Class

Remarks

The component fires this event to notify the application about a GET request received from the client.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Handled to true to indicate that your application's code will take care of the request. The application does it by providing the necessary details via SetResponseStatus, SetResponseHeader, SetResponseFile or SetResponseString methods. If the returned value of Handled is false, the server will try to take care of the request automatically by searching for the requested resource in DocumentRoot.

HeadersPrepared Event (RESTServer Component)

Fires when the response headers have been formed and are ready to be sent to the server.

Syntax

• C#
• VB.NET

public event OnHeadersPreparedHandler OnHeadersPrepared;

public delegate void OnHeadersPreparedHandler(object sender, RESTServerHeadersPreparedEventArgs e);

public class RESTServerHeadersPreparedEventArgs : EventArgs {
  public long ConnectionID { get; }
}

Public Event OnHeadersPrepared As OnHeadersPreparedHandler

Public Delegate Sub OnHeadersPreparedHandler(sender As Object, e As RESTServerHeadersPreparedEventArgs)

Public Class RESTServerHeadersPreparedEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
End Class

Remarks

The component fires this event when the response headers are ready to be sent to the server. ConnectionID indicates the connection that processed the request.

Use GetResponseHeader method with an empty header name to get the whole response header.

HeadRequest Event (RESTServer Component)

Reports a HEAD request.

Syntax

• C#
• VB.NET

public event OnHeadRequestHandler OnHeadRequest;

public delegate void OnHeadRequestHandler(object sender, RESTServerHeadRequestEventArgs e);

public class RESTServerHeadRequestEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string URI { get; }
  public bool Handled { get; set; }
}

Public Event OnHeadRequest As OnHeadRequestHandler

Public Delegate Sub OnHeadRequestHandler(sender As Object, e As RESTServerHeadRequestEventArgs)

Public Class RESTServerHeadRequestEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property URI As String
  Public Property Handled As Boolean
End Class

Remarks

The component fires this event to notify the application about a HEAD request received from the client.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Handled to true to indicate that your application's code will take care of the request. The application does it by providing the necessary details via SetResponseStatus, SetResponseHeader, and SetResponseFile methods. If the returned value of Handled is false, the server will try to take care of the request automatically by searching for the requested resource in DocumentRoot.

Notification Event (RESTServer Component)

This event notifies the application about an underlying control flow event.

Syntax

• C#
• VB.NET

public event OnNotificationHandler OnNotification;

public delegate void OnNotificationHandler(object sender, RESTServerNotificationEventArgs e);

public class RESTServerNotificationEventArgs : EventArgs {
  public string EventID { get; }
  public string EventParam { get; }
}

Public Event OnNotification As OnNotificationHandler

Public Delegate Sub OnNotificationHandler(sender As Object, e As RESTServerNotificationEventArgs)

Public Class RESTServerNotificationEventArgs Inherits EventArgs
  Public ReadOnly Property EventID As String
  Public ReadOnly Property EventParam As String
End Class

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

OptionsRequest Event (RESTServer Component)

Reports an OPTIONS request.

Syntax

• C#
• VB.NET

public event OnOptionsRequestHandler OnOptionsRequest;

public delegate void OnOptionsRequestHandler(object sender, RESTServerOptionsRequestEventArgs e);

public class RESTServerOptionsRequestEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string URI { get; }
  public bool Handled { get; set; }
}

Public Event OnOptionsRequest As OnOptionsRequestHandler

Public Delegate Sub OnOptionsRequestHandler(sender As Object, e As RESTServerOptionsRequestEventArgs)

Public Class RESTServerOptionsRequestEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property URI As String
  Public Property Handled As Boolean
End Class

Remarks

The component fires this event to notify the application about an OPTIONS request received from the client.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Handled to true to indicate that your application's code will take care of the request. The application does it by providing the necessary details via SetResponseStatus, SetResponseHeader, and SetResponseFile methods. If the returned value of Handled is false, the server will try to take care of the request automatically by searching for the requested resource in DocumentRoot.

PatchRequest Event (RESTServer Component)

Reports a PATCH request.

Syntax

• C#
• VB.NET

public event OnPatchRequestHandler OnPatchRequest;

public delegate void OnPatchRequestHandler(object sender, RESTServerPatchRequestEventArgs e);

public class RESTServerPatchRequestEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string URI { get; }
  public bool Handled { get; set; }
}

Public Event OnPatchRequest As OnPatchRequestHandler

Public Delegate Sub OnPatchRequestHandler(sender As Object, e As RESTServerPatchRequestEventArgs)

Public Class RESTServerPatchRequestEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property URI As String
  Public Property Handled As Boolean
End Class

Remarks

The component fires this event to notify the application about a PATCH request received from the client.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Handled to true to indicate that your application's code will take care of the request. The application does it by providing the necessary details via SetResponseStatus, SetResponseHeader, and SetResponseFile methods. If the returned value of Handled is false, the server will try to take care of the request automatically by searching for the requested resource in DocumentRoot.

PostRequest Event (RESTServer Component)

Reports a POST request.

Syntax

• C#
• VB.NET

public event OnPostRequestHandler OnPostRequest;

public delegate void OnPostRequestHandler(object sender, RESTServerPostRequestEventArgs e);

public class RESTServerPostRequestEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string URI { get; }
  public bool Handled { get; set; }
}

Public Event OnPostRequest As OnPostRequestHandler

Public Delegate Sub OnPostRequestHandler(sender As Object, e As RESTServerPostRequestEventArgs)

Public Class RESTServerPostRequestEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property URI As String
  Public Property Handled As Boolean
End Class

Remarks

The component fires this event to notify the application about a POST request received from the client.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Handled to true to indicate that your application's code will take care of the request. The application does it by providing the necessary details via SetResponseStatus, SetResponseHeader, and SetResponseFile methods. If the returned value of Handled is false, the server will try to take care of the request automatically by searching for the requested resource in DocumentRoot.

PutRequest Event (RESTServer Component)

Reports a PUT request.

Syntax

• C#
• VB.NET

public event OnPutRequestHandler OnPutRequest;

public delegate void OnPutRequestHandler(object sender, RESTServerPutRequestEventArgs e);

public class RESTServerPutRequestEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string URI { get; }
  public bool Handled { get; set; }
}

Public Event OnPutRequest As OnPutRequestHandler

Public Delegate Sub OnPutRequestHandler(sender As Object, e As RESTServerPutRequestEventArgs)

Public Class RESTServerPutRequestEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property URI As String
  Public Property Handled As Boolean
End Class

Remarks

The component fires this event to notify the application about a PUT request received from the client.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Handled to true to indicate that your application's code will take care of the request. The application does it by providing the necessary details via SetResponseStatus, SetResponseHeader, and SetResponseFile methods. If the returned value of Handled is false, the server will try to take care of the request automatically by searching for the requested resource in DocumentRoot.

ResourceAccess Event (RESTServer Component)

Reports an attempt to access a resource.

Syntax

• C#
• VB.NET

public event OnResourceAccessHandler OnResourceAccess;

public delegate void OnResourceAccessHandler(object sender, RESTServerResourceAccessEventArgs e);

public class RESTServerResourceAccessEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string HTTPMethod { get; }
  public string URI { get; }
  public bool Allow { get; set; }
  public string RedirectURI { get; set; }
}

Public Event OnResourceAccess As OnResourceAccessHandler

Public Delegate Sub OnResourceAccessHandler(sender As Object, e As RESTServerResourceAccessEventArgs)

Public Class RESTServerResourceAccessEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property HTTPMethod As String
  Public ReadOnly Property URI As String
  Public Property Allow As Boolean
  Public Property RedirectURI As String
End Class

Remarks

The component fires this event to notify the application about a request received from the client. The HTTPMethod parameter indicates the HTTP method used (GET, POST, etc.)

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Allow to false to prevent the client from accessing the resource. The component will automatically send a "forbidden" status code (403).

Set a non-empty value to RedirectURI to notify the client that the resource has moved to another place. The component will automatically send a "found" status code (302). If Allow is set to false, the value of RedirectURI is ignored.

TLSCertValidate Event (RESTServer Component)

Fires when a client certificate needs to be validated.

Syntax

• C#
• VB.NET

public event OnTLSCertValidateHandler OnTLSCertValidate;

public delegate void OnTLSCertValidateHandler(object sender, RESTServerTLSCertValidateEventArgs e);

public class RESTServerTLSCertValidateEventArgs : EventArgs {
  public long ConnectionID { get; }
  public bool Accept { get; set; }
}

Public Event OnTLSCertValidate As OnTLSCertValidateHandler

Public Delegate Sub OnTLSCertValidateHandler(sender As Object, e As RESTServerTLSCertValidateEventArgs)

Public Class RESTServerTLSCertValidateEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public Property Accept As Boolean
End Class

Remarks

The component fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the Accept parameter.

TLSEstablished Event (RESTServer Component)

Reports the setup of a TLS session.

Syntax

• C#
• VB.NET

public event OnTLSEstablishedHandler OnTLSEstablished;

public delegate void OnTLSEstablishedHandler(object sender, RESTServerTLSEstablishedEventArgs e);

public class RESTServerTLSEstablishedEventArgs : EventArgs {
  public long ConnectionID { get; }
}

Public Event OnTLSEstablished As OnTLSEstablishedHandler

Public Delegate Sub OnTLSEstablishedHandler(sender As Object, e As RESTServerTLSEstablishedEventArgs)

Public Class RESTServerTLSEstablishedEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
End Class

Remarks

Subscribe to this event to be notified about the setup of a TLS connection by a connected client.

TLSHandshake Event (RESTServer Component)

Fires when a newly established client connection initiates a TLS handshake.

Syntax

• C#
• VB.NET

public event OnTLSHandshakeHandler OnTLSHandshake;

public delegate void OnTLSHandshakeHandler(object sender, RESTServerTLSHandshakeEventArgs e);

public class RESTServerTLSHandshakeEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string ServerName { get; }
  public bool Abort { get; set; }
}

Public Event OnTLSHandshake As OnTLSHandshakeHandler

Public Delegate Sub OnTLSHandshakeHandler(sender As Object, e As RESTServerTLSHandshakeEventArgs)

Public Class RESTServerTLSHandshakeEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property ServerName As String
  Public Property Abort As Boolean
End Class

Remarks

Use this event to get notified about the initiation of the TLS handshake by the remote client. The ServerName parameter specifies the requested host from the client hello message.

TLSPSK Event (RESTServer Component)

Requests a pre-shared key for TLS-PSK.

Syntax

• C#
• VB.NET

public event OnTLSPSKHandler OnTLSPSK;

public delegate void OnTLSPSKHandler(object sender, RESTServerTLSPSKEventArgs e);

public class RESTServerTLSPSKEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Identity { get; }
  public string PSK { get; set; }
  public string Ciphersuite { get; set; }
}

Public Event OnTLSPSK As OnTLSPSKHandler

Public Delegate Sub OnTLSPSKHandler(sender As Object, e As RESTServerTLSPSKEventArgs)

Public Class RESTServerTLSPSKEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Identity As String
  Public Property PSK As String
  Public Property Ciphersuite As String
End Class

Remarks

The component fires this event to report that a client has requested a TLS-PSK negotiation. ConnectionId indicates the unique connection ID that requested the PSK handshake.

Use Identity to look up for the corresponding pre-shared key in the server's database, then assign the key to the PSK parameter. If TLS 1.3 PSK is used, you will also need to assign the Ciphersuite parameter with the cipher suite associated with that identity and their key.

TLSShutdown Event (RESTServer Component)

Reports closure of a TLS session.

Syntax

• C#
• VB.NET

public event OnTLSShutdownHandler OnTLSShutdown;

public delegate void OnTLSShutdownHandler(object sender, RESTServerTLSShutdownEventArgs e);

public class RESTServerTLSShutdownEventArgs : EventArgs {
  public long ConnectionID { get; }
}

Public Event OnTLSShutdown As OnTLSShutdownHandler

Public Delegate Sub OnTLSShutdownHandler(sender As Object, e As RESTServerTLSShutdownEventArgs)

Public Class RESTServerTLSShutdownEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
End Class

Remarks

The component fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a Disconnect, which marks the closure of the underlying TCP session.

TraceRequest Event (RESTServer Component)

Reports a TRACE request.

Syntax

• C#
• VB.NET

public event OnTraceRequestHandler OnTraceRequest;

public delegate void OnTraceRequestHandler(object sender, RESTServerTraceRequestEventArgs e);

public class RESTServerTraceRequestEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string URI { get; }
  public bool Handled { get; set; }
}

Public Event OnTraceRequest As OnTraceRequestHandler

Public Delegate Sub OnTraceRequestHandler(sender As Object, e As RESTServerTraceRequestEventArgs)

Public Class RESTServerTraceRequestEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property URI As String
  Public Property Handled As Boolean
End Class

Remarks

The component fires this event to notify the application about a TRACE request received from the client.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Handled to true to indicate that your application's code will take care of the request. The application does it by providing the necessary details via SetResponseStatus, SetResponseHeader, and SetResponseFile methods. If the returned value of Handled is false, the server will try to take care of the request automatically by searching for the requested resource in DocumentRoot.

Certificate Type

Encapsulates an individual X.509 certificate.

Remarks

This type keeps and provides access to X.509 certificate details.

Fields

Constructors

• C#
• VB.NET

public Certificate(byte[] bytes, int startIndex, int count, string password);

Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer, ByVal Password As String)

• C#
• VB.NET

public Certificate(byte[] certBytes, int certStartIndex, int certCount, byte[] keyBytes, int keyStartIndex, int keyCount, string password);

Public Certificate(ByVal CertBytes As Byte(), ByVal CertStartIndex As Integer, ByVal CertCount As Integer, ByVal KeyBytes As Byte(), ByVal KeyStartIndex As Integer, ByVal KeyCount As Integer, ByVal Password As String)

• C#
• VB.NET

public Certificate(byte[] bytes, int startIndex, int count);

Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)

• C#
• VB.NET

public Certificate(string path, string password);

Public Certificate(ByVal Path As String, ByVal Password As String)

• C#
• VB.NET

public Certificate(string certPath, string keyPath, string password);

Public Certificate(ByVal CertPath As String, ByVal KeyPath As String, ByVal Password As String)

• C#
• VB.NET

public Certificate(string path);

Public Certificate(ByVal Path As String)

• C#
• VB.NET

public Certificate(System.IO.Stream stream);

Public Certificate(ByVal Stream As System.IO.Stream)

• C#
• VB.NET

public Certificate(System.IO.Stream stream, string password);

Public Certificate(ByVal Stream As System.IO.Stream, ByVal Password As String)

• C#
• VB.NET

public Certificate(System.IO.Stream certStream, System.IO.Stream keyStream, string password);

Public Certificate(ByVal CertStream As System.IO.Stream, ByVal KeyStream As System.IO.Stream, ByVal Password As String)

• C#
• VB.NET

public Certificate();

Public Certificate()

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

Fields

Constructors

• C#
• VB.NET

public ExternalCrypto();

Public ExternalCrypto()

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

Constructors

• C#
• VB.NET

public SocketSettings();

Public SocketSettings()

TLSConnectionInfo Type

Contains information about a network connection.

Remarks

Use this property to check various details of the network connection. These include the total amounts of data transferred, the availability of TLS, and its parameters.

Fields

Constructors

• C#
• VB.NET

public TLSConnectionInfo();

Public TLSConnectionInfo()

TLSSettings Type

A container for TLS connection settings.

Remarks

The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.

Fields