RESTServer Module
Properties Methods Events Configuration 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 module with short descriptions. Click on the links for further details.
| Active | Indicates whether the server is active and is listening to new connections. |
| AllowKeepAlive | Enables or disables keep-alive mode. |
| AuthBasic | Enables or disables basic authentication. |
| AuthDigest | Enables or disables digest authentication. |
| AuthDigestExpire | Specifies digest expiration time for digest authentication. |
| AuthRealm | Specifies authentication realm for digest and NTLM authentication. |
| BoundPort | Indicates the bound listening port. |
| CompressionLevel | The default compression level to use. |
| DocumentRoot | The document root of the server. |
| ErrorOrigin | Indicates the endpoint where the error originates from. |
| ErrorSeverity | The severity of the error that happened. |
| ExternalCrypto | Provides access to external signing and DC parameters. |
| HandshakeTimeout | Specifies the handshake timeout in milliseconds. |
| Host | The host to bind the listening port to. |
| PinnedClient | Populates the pinned client details. |
| PinnedClientChain | Contains the certificate chain of the pinned client. |
| Port | Specifies the port number to listen for connections on. |
| PortRangeFrom | Specifies the lower limit of the listening port range for incoming connections. |
| PortRangeTo | Specifies the upper limit of the listening port range for incoming connections. |
| ServerCertificates | The server's TLS certificates. |
| SessionTimeout | Specifies the default session timeout value in milliseconds. |
| SocketSettings | Manages network connection settings. |
| TempDir | The temporary path to use. |
| TLSSettings | Manages TLS layer settings. |
| UseChunkedTransfer | Enables chunked transfer. |
| UseCompression | Enables or disables server-side compression. |
| Users | Provides a list of registered users. |
| UseTLS | Enables or disables the TLS requirement. |
| WebsiteName | Specifies the web site name to use in the certificate. |
Method List
The following is the full list of the methods of the module with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting. |
| DropClient | Terminates a client connection. |
| GetRequestBytes | Returns the contents of the client's HTTP request. |
| GetRequestHeader | Returns a request header value. |
| GetRequestString | Returns the contents of the client's HTTP request. |
| GetRequestUsername | Returns the username for a connection. |
| ListClients | Enumerates the connected clients. |
| PinClient | Takes a snapshot of the connection's properties. |
| SetResponseBytes | Sets a byte array to be served as a response. |
| SetResponseFile | Sets a file to be served as a response. |
| SetResponseHeader | Sets a response header. |
| SetResponseJSON | Sets a string to be served as a JSON response. |
| SetResponseStatus | Sets an HTTP status to be sent with the response. |
| SetResponseString | Sets a string to be served as a response. |
| SetResponseXML | Sets a string to be served as an XML response. |
| Start | Starts the server. |
| Stop | Stops the server. |
Event List
The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.
| Accept | Reports an incoming connection. |
| AuthAttempt | Fires when a connected client makes an authentication attempt. |
| CertificateValidate | Fires when a client certificate needs to be validated. |
| Connect | Reports an accepted connection. |
| CustomRequest | Reports a request of a non-standard type (method). |
| Data | Supplies a data chunk received within a POST or PUT upload. |
| DeleteRequest | Reports a DELETE request. |
| Disconnect | Fires to report a disconnected client. |
| Error | Information about errors during data delivery. |
| ExternalSign | Handles remote or external signing initiated by the server protocol. |
| FileError | Reports a file access error to the application. |
| GetRequest | Reports a GET request. |
| HeadRequest | Reports a HEAD request. |
| Notification | This event notifies the application about an underlying control flow event. |
| OptionsRequest | Reports an OPTIONS request. |
| PatchRequest | Reports a PATCH request. |
| PostRequest | Reports a POST request. |
| PutRequest | Reports a PUT request. |
| TLSEstablished | Reports the setup of a TLS session. |
| TLSPSK | Requests a pre-shared key for TLS-PSK. |
| TLSShutdown | Reports closure of a TLS session. |
| TraceRequest | Reports a TRACE request. |
Configuration Settings
The following is a list of configuration settings for the module with short descriptions. Click on the links for further details.
| AllowOptionsResponseWithoutAuth | Enables unauthenticated responses to OPTIONS requests. |
| ClientAuth | Enables or disables certificate-based client authentication. |
| DualStack | Allows the use of ip4 and ip6 simultaneously. |
| HomePage | Specifies the home page resource name. |
| Host | The host to bind to. |
| RequestFilter | The request string modifier. |
| ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
| TLSExtensions | Provides access to TLS extensions. |
| WebsiteName | The website name for the TLS certificate. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| UseOwnDNSResolver | Specifies whether the client components should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |