TSPServer Component
Properties Methods Events Configuration Settings Errors
The TSPServer component supports server-side functionality of the timestamping protocol.
Syntax
TsbxTSPServer
Remarks
Use this control to serve timestamping requests from 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.
| Accuracy | The accuracy of the server time, in microseconds. |
| Active | Indicates whether the server is active and is listening to new connections. |
| 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. |
| ClientAuth | Enables or disables certificate-based client authentication. |
| DefaultPolicy | Specifies the default TSA policy. |
| Endpoint | Specifies the resource address of the TSA endpoint. |
| 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. |
| FIPSMode | Reserved. |
| 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. |
| SigningCertificate | The certificate to be used for signing. |
| SigningChain | The signing certificate chain. |
| SocketSettings | Manages network connection settings. |
| TLSSettings | Manages TLS layer settings. |
| TSAName | Specifies the name of TSA. |
| Users | Provides a list of registered users. |
| WebsiteName | Specifies the web site name to use in the certificate. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting. |
| DoAction | Performs an additional action. |
| 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. |
| ProcessGenericRequest | Processes a generic timestamp request. |
| Start | Starts the TSP server. |
| Stop | Stops the TSP server. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
| 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. |
| 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. |
| Notification | This event notifies the application about an underlying control flow event. |
| TimestampRequest | Reports an incoming timestamp request. |
| TLSEstablished | Reports the setup of a TLS session. |
| TLSHandshake | TBD. |
| TLSPSK | Requests a pre-shared key for TLS-PSK. |
| TLSShutdown | Reports closure of a TLS session. |
Configuration Settings
The following is a list of configuration settings for the component 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. |
| 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. |
| Tag | Allows to store any custom data. |
| 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. |
Accuracy Property (TSPServer Component)
The accuracy of the server time, in microseconds.
Syntax
property Accuracy: Int64 read get_Accuracy write set_Accuracy;
Default Value
0
Remarks
Use this property to provide the accuracy of the time returned by the server, in microseconds. This specifies the maximum deviation of the returned time from the actual server time.
Active Property (TSPServer Component)
Indicates whether the server is active and is listening to new connections.
Syntax
property Active: Boolean read get_Active;
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.
AuthBasic Property (TSPServer Component)
Enables or disables basic authentication.
Syntax
property AuthBasic: Boolean read get_AuthBasic write set_AuthBasic;
Default Value
false
Remarks
Use this property to enable or disable basic user authentication in the HTTP server.
AuthDigest Property (TSPServer Component)
Enables or disables digest authentication.
Syntax
property AuthDigest: Boolean read get_AuthDigest write set_AuthDigest;
Default Value
false
Remarks
Use this property to enable or disable digest-based user authentication in the HTTP server.
AuthDigestExpire Property (TSPServer Component)
Specifies digest expiration time for digest authentication.
Syntax
property AuthDigestExpire: Integer read get_AuthDigestExpire write set_AuthDigestExpire;
Default Value
20
Remarks
Use this property to specify the digest expiration time for digest authentication, in seconds.
AuthRealm Property (TSPServer Component)
Specifies authentication realm for digest and NTLM authentication.
Syntax
property AuthRealm: String read get_AuthRealm write set_AuthRealm;
Default Value
'SecureBlackbox'
Remarks
Specifies authentication realm for digest and NTLM authentication types.
BoundPort Property (TSPServer Component)
Indicates the bound listening port.
Syntax
property BoundPort: Integer read get_BoundPort;
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.
ClientAuth Property (TSPServer Component)
Enables or disables certificate-based client authentication.
Syntax
property ClientAuth: TsbxClientAuthTypes read get_ClientAuth write set_ClientAuth;
TsbxClientAuthTypes = ( ccatNoAuth, ccatRequestCert, ccatRequireCert );
Default Value
ccatNoAuth
Remarks
Set this property to true to tune up the client authentication type: ccatNoAuth = 0; ccatRequestCert = 1; ccatRequireCert = 2;
DefaultPolicy Property (TSPServer Component)
Specifies the default TSA policy.
Syntax
property DefaultPolicy: String read get_DefaultPolicy write set_DefaultPolicy;
Default Value
''
Remarks
Use this property to specify the default TSA policy.
Endpoint Property (TSPServer Component)
Specifies the resource address of the TSA endpoint.
Syntax
property Endpoint: String read get_Endpoint write set_Endpoint;
Default Value
'/'
Remarks
Use this property to specify the endpoint of which the TSA service should be responding.
ErrorOrigin Property (TSPServer Component)
Indicates the endpoint where the error originates from.
Syntax
property ErrorOrigin: TsbxErrorOrigins read get_ErrorOrigin write set_ErrorOrigin;
TsbxErrorOrigins = ( eoLocal, eoRemote );
Default Value
eoLocal
Remarks
Use this property to establish whether the reported error originates from a local or remote endpoint.
| eoLocal | 0 | |
| eoRemote | 1 |
This property is not available at design time.
ErrorSeverity Property (TSPServer Component)
The severity of the error that happened.
Syntax
property ErrorSeverity: TsbxErrorSeverities read get_ErrorSeverity write set_ErrorSeverity;
TsbxErrorSeverities = ( esInfo, esWarning, esFatal );
Default Value
esWarning
Remarks
Use this property to establish whether the error is fatal.
| esWarning | 1 | |
| esFatal | 2 |
This property is not available at design time.
ExternalCrypto Property (TSPServer Component)
Provides access to external signing and DC parameters.
Syntax
property ExternalCrypto: TsbxExternalCrypto read get_ExternalCrypto;
Remarks
Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on OnExternalSign event) and asynchronous (based on DC protocol and DCAuth signing component).
This property is read-only.
FIPSMode Property (TSPServer Component)
Reserved.
Syntax
property FIPSMode: Boolean read get_FIPSMode write set_FIPSMode;
Default Value
false
Remarks
This property is reserved for future use.
Host Property (TSPServer Component)
The host to bind the listening port to.
Syntax
property Host: String read get_Host write set_Host;
Default Value
''
Remarks
Use this property to specify the IP address on which to listen to incoming connections.
PinnedClient Property (TSPServer Component)
Populates the pinned client details.
Syntax
property PinnedClient: TsbxTLSClientEntry read get_PinnedClient;
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 (TSPServer Component)
Contains the certificate chain of the pinned client.
Syntax
property PinnedClientChain: TsbxCertificateList read get_PinnedClientChain;
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 (TSPServer Component)
Specifies the port number to listen for connections on.
Syntax
property Port: Integer read get_Port write set_Port;
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 (TSPServer Component)
Specifies the lower limit of the listening port range for incoming connections.
Syntax
property PortRangeFrom: Integer read get_PortRangeFrom write set_PortRangeFrom;
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.
PortRangeTo Property (TSPServer Component)
Specifies the upper limit of the listening port range for incoming connections.
Syntax
property PortRangeTo: Integer read get_PortRangeTo write set_PortRangeTo;
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.
ServerCertificates Property (TSPServer Component)
The server's TLS certificates.
Syntax
property ServerCertificates: TsbxCertificateList read get_ServerCertificates write set_ServerCertificates;
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 ciphersuite preferences.
This property is not available at design time.
SessionTimeout Property (TSPServer Component)
Specifies the default session timeout value in milliseconds.
Syntax
property SessionTimeout: Integer read get_SessionTimeout write set_SessionTimeout;
Default Value
360000
Remarks
Specifies the period of inactivity (in milliseconds) after which the connection will be terminated by the server.
SigningCertificate Property (TSPServer Component)
The certificate to be used for signing.
Syntax
property SigningCertificate: TsbxCertificate read get_SigningCertificate write set_SigningCertificate;
Remarks
Use this property to specify the certificate that shall be used for signing the data. Note that this certificate should have a private key associated with it. Use SigningChain to supply the rest of the certificate chain for inclusion into the signature.
This property is not available at design time.
SigningChain Property (TSPServer Component)
The signing certificate chain.
Syntax
property SigningChain: TsbxCertificateList read get_SigningChain write set_SigningChain;
Remarks
Use this property to provide the chain for the signing certificate. Use SigningCertificate property, if it is available, to provide the signing certificate itself.
This property is not available at design time.
SocketSettings Property (TSPServer Component)
Manages network connection settings.
Syntax
property SocketSettings: TsbxSocketSettings read get_SocketSettings;
Remarks
Use this property to tune up network connection parameters.
This property is read-only.
TLSSettings Property (TSPServer Component)
Manages TLS layer settings.
Syntax
property TLSSettings: TsbxTLSSettings read get_TLSSettings;
Remarks
Use this property to tune up the TLS layer parameters.
This property is read-only.
TSAName Property (TSPServer Component)
Specifies the name of TSA.
Syntax
property TSAName: String read get_TSAName write set_TSAName;
Default Value
''
Remarks
Use this property to provide the alternative name of the TSA, in RDN format.
Users Property (TSPServer Component)
Provides a list of registered users.
Syntax
property Users: TsbxUserAccountList read get_Users write set_Users;
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 (TSPServer Component)
Specifies the web site name to use in the certificate.
Syntax
property WebsiteName: String read get_WebsiteName write set_WebsiteName;
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'.
Config Method (TSPServer Component)
Sets or retrieves a configuration setting.
Syntax
function Config(ConfigurationString: String): 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 (TSPServer Component)
Performs an additional action.
Syntax
function DoAction(ActionID: String; ActionParams: String): 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 of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
DropClient Method (TSPServer Component)
Terminates a client connection.
Syntax
procedure DropClient(ConnectionId: Int64; Forced: 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 (TSPServer Component)
Returns the contents of the client's HTTP request.
Syntax
function GetRequestBytes(ConnectionId: Int64): TBytes;
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.
GetRequestHeader Method (TSPServer Component)
Returns a request header value.
Syntax
function GetRequestHeader(ConnectionId: Int64; HeaderName: String): 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.
GetRequestString Method (TSPServer Component)
Returns the contents of the client's HTTP request.
Syntax
function GetRequestString(ConnectionId: Int64): 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.
GetRequestUsername Method (TSPServer Component)
Returns the username for a connection.
Syntax
function GetRequestUsername(ConnectionId: Int64): 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.
ListClients Method (TSPServer Component)
Enumerates the connected clients.
Syntax
function ListClients(): 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 (TSPServer Component)
Takes a snapshot of the connection's properties.
Syntax
procedure PinClient(ConnectionId: Int64);
Remarks
Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient and PinnedClientChain properties.
ProcessGenericRequest Method (TSPServer Component)
Processes a generic timestamp request.
Syntax
function ProcessGenericRequest(RequestBytes: TBytes; TimeTokenOnly: Boolean): TBytes;
Remarks
This method processes a generic timestamping request and produces a response. Use it to generate timestamps for requests obtained externally, out of the default HTTP channel.
This method respects all current settings of the server object, and invokes TimestampRequest to consult about the request and response details with the application.
If TimeTokenOnly is set, the return value will only contain the TimeStampToken piece of the response. If it is switched off, the whole TimeStampResp structure will be returned.
Start Method (TSPServer Component)
Starts the TSP server.
Syntax
procedure Start();
Remarks
Use this method to start listening for incoming connections.
Stop Method (TSPServer Component)
Stops the TSP server.
Syntax
procedure Stop();
Remarks
Call this method to stop listening for incoming connections.
Accept Event (TSPServer Component)
Reports an incoming connection.
Syntax
type TAcceptEvent = procedure ( Sender: TObject; const RemoteAddress: String; RemotePort: Integer; var Accept: Boolean ) of Object;
property OnAccept: TAcceptEvent read FOnAccept write FOnAccept;
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 (TSPServer Component)
Fires when a connected client makes an authentication attempt.
Syntax
type TAuthAttemptEvent = procedure ( Sender: TObject; ConnectionID: Int64; const HTTPMethod: String; const URI: String; const AuthMethod: String; const Username: String; const Password: String; var Allow: Boolean ) of Object;
property OnAuthAttempt: TAuthAttemptEvent read FOnAuthAttempt write FOnAuthAttempt;
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.
CertificateValidate Event (TSPServer Component)
Fires when a client certificate needs to be validated.
Syntax
type TCertificateValidateEvent = procedure ( Sender: TObject; ConnectionID: Int64; var Accept: Boolean ) of Object;
property OnCertificateValidate: TCertificateValidateEvent read FOnCertificateValidate write FOnCertificateValidate;
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.
Connect Event (TSPServer Component)
Reports an accepted connection.
Syntax
type TConnectEvent = procedure ( Sender: TObject; ConnectionID: Int64; const RemoteAddress: String; RemotePort: Integer ) of Object;
property OnConnect: TConnectEvent read FOnConnect write FOnConnect;
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 GetRequest or AuthAttempt.
Disconnect Event (TSPServer Component)
Fires to report a disconnected client.
Syntax
type TDisconnectEvent = procedure ( Sender: TObject; ConnectionID: Int64 ) of Object;
property OnDisconnect: TDisconnectEvent read FOnDisconnect write FOnDisconnect;
Remarks
The component fires this event when a connected client disconnects.
Error Event (TSPServer Component)
Information about errors during data delivery.
Syntax
type TErrorEvent = procedure ( Sender: TObject; ConnectionId: Int64; ErrorCode: Integer; const Description: String ) of Object;
property OnError: TErrorEvent read FOnError write FOnError;
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 (TSPServer Component)
Handles remote or external signing initiated by the server protocol.
Syntax
type TExternalSignEvent = procedure ( Sender: TObject; ConnectionID: Int64; const OperationId: String; const HashAlgorithm: String; const Pars: String; const Data: String; var SignedData: String ) of Object;
property OnExternalSign: TExternalSignEvent read FOnExternalSign write FOnExternalSign;
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 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 contain algorithm-dependent parameters.
The component uses base16 (hex) encoding for 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
Notification Event (TSPServer Component)
This event notifies the application about an underlying control flow event.
Syntax
type TNotificationEvent = procedure ( Sender: TObject; const EventID: String; const EventParam: String ) of Object;
property OnNotification: TNotificationEvent read FOnNotification write FOnNotification;
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 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.
TimestampRequest Event (TSPServer Component)
Reports an incoming timestamp request.
Syntax
type TTimestampRequestEvent = procedure ( Sender: TObject; ConnectionId: Int64; const HashAlgorithm: String; MessageImprint: TBytes; var Time: String; var Accept: Boolean ) of Object;
property OnTimestampRequest: TTimestampRequestEvent read FOnTimestampRequest write FOnTimestampRequest;
Remarks
This event is fired when a new incoming timestamp request is received. Use it to track or alter the details of a generated timestamp.
MessageImprint contains the digest of the message that needs to be timestamped, which was created using HashAlgorithm. Time is the time to be certified. Set Accept to true to accept the request and generate a timestamp, or to false to reject the request.
Supported hash algorithms:
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
TLSEstablished Event (TSPServer Component)
Reports the setup of a TLS session.
Syntax
type TTLSEstablishedEvent = procedure ( Sender: TObject; ConnectionID: Int64 ) of Object;
property OnTLSEstablished: TTLSEstablishedEvent read FOnTLSEstablished write FOnTLSEstablished;
Remarks
Subscribe to this event to be notified about the setup of a TLS connection by a connected client.
TLSHandshake Event (TSPServer Component)
TBD.
Syntax
type TTLSHandshakeEvent = procedure ( Sender: TObject; ConnectionID: Int64; const ServerName: String ) of Object;
property OnTLSHandshake: TTLSHandshakeEvent read FOnTLSHandshake write FOnTLSHandshake;
Remarks
TBD
TLSPSK Event (TSPServer Component)
Requests a pre-shared key for TLS-PSK.
Syntax
type TTLSPSKEvent = procedure ( Sender: TObject; ConnectionID: Int64; const Identity: String; var PSK: String; var Ciphersuite: String ) of Object;
property OnTLSPSK: TTLSPSKEvent read FOnTLSPSK write FOnTLSPSK;
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 ciphersuite associated with that identity and their key.
TLSShutdown Event (TSPServer Component)
Reports closure of a TLS session.
Syntax
type TTLSShutdownEvent = procedure ( Sender: TObject; ConnectionID: Int64 ) of Object;
property OnTLSShutdown: TTLSShutdownEvent read FOnTLSShutdown write FOnTLSShutdown;
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.
Certificate Type
Provides details of an individual X.509 certificate.
Remarks
This type provides access to X.509 certificate details.
Fields
|
Bytes TBytes |
Returns raw certificate data in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CA Boolean |
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CAKeyID TBytes |
A unique identifier (fingerprint) of the CA certificate's private key. Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CRLDistributionPoints String |
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Curve String |
Specifies the elliptic curve of the EC public key.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Fingerprint TBytes |
Contains the fingerprint (a hash imprint) of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
FriendlyName String |
Contains an associated alias (friendly name) of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Handle Int64 |
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
HashAlgorithm String |
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Issuer String |
The common name of the certificate issuer (CA), typically a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
IssuerRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyAlgorithm String |
Specifies the public key algorithm of this certificate.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyBits Integer |
Returns the length of the public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyFingerprint TBytes |
Returns a fingerprint of the public key contained in the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyUsage Integer |
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. This value is a bit mask of the following values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyValid Boolean |
Returns True if the certificate's key is cryptographically valid, and False otherwise. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
OCSPLocations String |
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
OCSPNoCheck Boolean |
TBD. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Origin Integer |
Returns the origin of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PolicyIDs String |
Contains identifiers (OIDs) of the applicable certificate policies. The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PrivateKeyBytes TBytes |
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PrivateKeyExists Boolean |
Indicates whether the certificate has an associated private key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PrivateKeyExtractable Boolean |
Indicates whether the private key is extractable |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PublicKeyBytes TBytes |
Contains the certificate's public key in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
QualifiedStatements TsbxQualifiedStatementsTypes |
TBD |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SelfSigned Boolean |
Indicates whether the certificate is self-signed (root) or signed by an external CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SerialNumber TBytes |
Returns the certificate's serial number. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SigAlgorithm String |
Indicates the algorithm that was used by the CA to sign this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Subject String |
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SubjectAlternativeName String |
TBD. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SubjectKeyID TBytes |
Contains a unique identifier (fingerprint) of the certificate's private key. Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SubjectRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ValidFrom String |
The time point at which the certificate becomes valid, in UTC. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ValidTo String |
The time point at which the certificate expires, in UTC. |
Constructors
>
constructor Create();
Creates a new object with default field values.
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
|
AsyncDocumentID String |
Specifies the document ID for SignAsyncEnd() call Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. This value helps ASiCSigner identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CustomParams String |
Custom parameters to be passed to the signing service (uninterpreted). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Data String |
Additional data to be included in the async state and mirrored back by the requestor |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ExternalHashCalculation Boolean |
Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
HashAlgorithm String |
Specifies the request's signature hash algorithm.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyID String |
The ID of the pre-shared key used for DC request authentication. Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides extra protection layer for the protocol and diminishes the risk of private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use KeySecret to pass the key itself. The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted. Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users. Example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeySecret String |
The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work. Read more about configuring authentication in the KeyID topic. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Method TsbxAsyncSignMethods |
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup. Available options:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Mode TsbxExternalCryptoModes |
Specifies the external cryptography mode. Available options:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PublicKeyAlgorithm String |
Provide public key algorithm here if the certificate is not available on the pre-signing stage.
|
Constructors
>
constructor Create();
Creates a new ExternalCrypto object with default field values.
SocketSettings Type
A container for the socket settings.
Remarks
This type is a container for socket-layer parameters.
Fields
|
DNSMode TsbxDNSResolveModes |
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
|
||||||||
|
DNSPort Integer |
Specifies the port number to be used for sending queries to the DNS server. |
||||||||
|
DNSQueryTimeout Integer |
The timeout (in milliseconds) for each DNS query. The value of 0 indicates the infinite timeout. |
||||||||
|
DNSServers String |
The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
||||||||
|
DNSTotalTimeout Integer |
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates the infinite timeout. |
||||||||
|
IncomingSpeedLimit Integer |
The maximum number of bytes to read from the socket, per second. |
||||||||
|
LocalAddress String |
The local network interface to bind the socket to. |
||||||||
|
LocalPort Integer |
The local port number to bind the socket to. |
||||||||
|
OutgoingSpeedLimit Integer |
The maximum number of bytes to write to the socket, per second. |
||||||||
|
Timeout Integer |
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack). |
||||||||
|
UseIPv6 Boolean |
Enables or disables IP protocol version 6. |
Constructors
>
constructor Create();
Creates a new SocketSettings object.
TLSClientEntry Type
A container for a connected TLS client's details.
Remarks
Use this property to access the details of a particular connected client.
Fields
|
Address String |
The client's IP address. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ChainValidationDetails Integer |
The details of a certificate chain validation outcome. They may often suggest what reasons that contributed to the overall validation result. Returns a bit mask of the following options:
|
||||||||||||||||||||||||||||||||||||||||||||||||
|
ChainValidationResult TsbxChainValidities |
The outcome of a certificate chain validation routine. Available options:
Use the ValidationLog property to access the detailed validation log. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
Ciphersuite String |
The cipher suite employed by this connection. For TLS connections, this property returns the ciphersuite that was/is employed by the connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ClientAuthenticated Boolean |
Specifies whether client authentication was performed during this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
DigestAlgorithm String |
The digest algorithm used in a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
EncryptionAlgorithm String |
The symmetric encryption algorithm used in a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ID Int64 |
The client connection's unique identifier. This value is used throughout to refer to a particular client connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyExchangeAlgorithm String |
The key exchange algorithm used in a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyExchangeKeyBits Integer |
The length of the key exchange key of a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
NamedECCurve String |
The elliptic curve used in this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
PFSCipher Boolean |
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). |
||||||||||||||||||||||||||||||||||||||||||||||||
|
Port Integer |
The remote port of the client connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
PreSharedIdentity String |
Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
PublicKeyBits Integer |
The length of the public key. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ResumedSession Boolean |
Indicates whether a TLS-enabled connection was spawned from another TLS connection |
||||||||||||||||||||||||||||||||||||||||||||||||
|
SecureConnection Boolean |
Indicates whether TLS or SSL is enabled for this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
SignatureAlgorithm String |
The signature algorithm used in a TLS handshake. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
SymmetricBlockSize Integer |
The block size of the symmetric algorithm used. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
SymmetricKeyBits Integer |
The key length of the symmetric algorithm used. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
TotalBytesReceived Int64 |
The total number of bytes received over this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
TotalBytesSent Int64 |
The total number of bytes sent over this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ValidationLog String |
Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
Version String |
Indicates the version of SSL/TLS protocol negotiated during this connection. |
Constructors
>
constructor Create();
Creates a new TLSClientEntry object.
TLSSettings Type
A container for TLS connection settings.
Remarks
TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.
Fields
|
AutoValidateCertificates Boolean |
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
|||||||||||||||||||||||||||||||||
|
BaseConfiguration TsbxSecureTransportPredefinedConfigurations |
Selects the base configuration for the TLS settings. Several profiles are on offer, tuned up for different purposes, such as high security or higher compatibility.
|
|||||||||||||||||||||||||||||||||
|
Ciphersuites String |
A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases that allow to blanketly enable or disable all ciphersuites at once. Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
|
|||||||||||||||||||||||||||||||||
|
ECCurves String |
Defines the elliptic curves to enable. |
|||||||||||||||||||||||||||||||||
|
Extensions String |
Provides access to TLS extensions. |
|||||||||||||||||||||||||||||||||
|
ForceResumeIfDestinationChanges Boolean |
Whether to force TLS session resumption when the destination address changes. |
|||||||||||||||||||||||||||||||||
|
PreSharedIdentity String |
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
|||||||||||||||||||||||||||||||||
|
PreSharedKey String |
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
|||||||||||||||||||||||||||||||||
|
PreSharedKeyCiphersuite String |
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
|||||||||||||||||||||||||||||||||
|
RenegotiationAttackPreventionMode TsbxRenegotiationAttackPreventionModes |
Selects renegotiation attack prevention mechanism. The following options are available:
|
|||||||||||||||||||||||||||||||||
|
RevocationCheck TsbxRevocationCheckKinds |
Specifies the kind(s) of revocation check to perform. Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
This setting controls the way the revocation checks are performed. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time. There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs). This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The 'crcAll*' modes are much stricter, and may be used in scenarios where bulletproof validity information is essential. |
|||||||||||||||||||||||||||||||||
|
SSLOptions Integer |
Various SSL (TLS) protocol options, set of
|
|||||||||||||||||||||||||||||||||
|
TLSMode TsbxSSLModes |
Specifies the TLS mode to use.
|
|||||||||||||||||||||||||||||||||
|
UseExtendedMasterSecret Boolean |
Enables Extended Master Secret Extension, as defined in RFC 7627. |
|||||||||||||||||||||||||||||||||
|
UseSessionResumption Boolean |
Enables or disables TLS session resumption capability. |
|||||||||||||||||||||||||||||||||
|
Versions Integer |
Th SSL/TLS versions to enable by default.
|
Constructors
>
constructor Create();
Creates a new TLSSettings object.
UserAccount Type
A container for user account information.
Remarks
UserAccount objects are used to store user account information, such as logins and passwords.
Fields
|
AssociatedData TBytes |
Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used. |
|||||||||
|
BasePath String |
Base path for this user in the server's file system. |
|||||||||
|
Cert TBytes |
Contains the user's certificate. |
|||||||||
|
Data String |
Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings. |
|||||||||
|
Handle Int64 |
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
|
|||||||||
|
HashAlgorithm String |
Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests:
|
|||||||||
|
IncomingSpeedLimit Integer |
Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation". |
|||||||||
|
OtpAlgorithm TsbxOTPAlgorithms |
The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value.
|
|||||||||
|
OtpValue Integer |
The user's time interval (TOTP) or Counter (HOTP). |
|||||||||
|
OutgoingSpeedLimit Integer |
Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation". |
|||||||||
|
Password String |
The user's authentication password. |
|||||||||
|
PasswordLen Integer |
Specifies the length of the user's OTP password. |
|||||||||
|
SharedSecret TBytes |
Contains the user's secret key, which is essentially a shared secret between the client and server. Shared secrets can be used in TLS-driven protocols, as well as in OTP (where it is called a 'key secret') for generating one-time passwords on one side, and validate them on the other. |
|||||||||
|
SSHKey TBytes |
Contains the user's SSH key. |
|||||||||
|
Username String |
The registered name (login) of the user. |
Constructors
>
constructor Create();
Creates a new UserAccount object.
Configuration Settings (TSPServer 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 method.TSPServer Configuration Settings | ||||||||||||||||||||||||||||||
| AllowOptionsResponseWithoutAuth: Enables unauthenticated responses to OPTIONS requests.Set this property to true to allow the server serve OPTIONS requests without prior authentication of the client. | ||||||||||||||||||||||||||||||
ClientAuth:
Enables or disables certificate-based client authentication.Set this property to one of the below values to tune up the client authentication logic:
If this property is set to 1 or 2, the component will request certificates from the connecting clients. Depending on the setting, the clients that fail to provide their certificate in response will be allowed or disallowed to proceed with the connection. The server signals about a received certificate by firing its CertificateValidate event. Use PinClient method in the event handler to pin the client details, and access the provided certificate chain via the PinnedClientChain property. Note that this event is fired from the connecting clients threads, so please make sure you avoid bottlenecks in the event handler and put appropriate thread safety measures in place. Unlike the client-side components, the server component does not perform automated certificate validation against the local security policy. You must perform appropriate certificate validation steps in your CertificateValidate event handler. |
||||||||||||||||||||||||||||||
| DualStack: Allows the use of ip4 and ip6 simultaneously.This setting specifies a socket can use ip4 and ip6 simultaneously. | ||||||||||||||||||||||||||||||
| HomePage: Specifies the home page resource name.Use this property to specify the home page (/) resource name. | ||||||||||||||||||||||||||||||
| Host: The host to bind to.Specifies a specific interface the server should listen on. | ||||||||||||||||||||||||||||||
| RequestFilter: The request string modifier.Use this property to tune up the request string as returned by GetRequestString method. Supported filters: params (request parameters only), params[Index] or params['Name'] (a specific request parameter), parts[Index] (the contents of a particular part of a multipart message). An empty request filter makes GetRequestString return the whole body of the request. | ||||||||||||||||||||||||||||||
| ServerSSLDHKeyLength: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. | ||||||||||||||||||||||||||||||
| WebsiteName: The website name for the TLS certificate.Assign this property with a name to put in a self-generated TLS certificate. | ||||||||||||||||||||||||||||||
Base Configuration Settings | ||||||||||||||||||||||||||||||
| CheckKeyIntegrityBeforeUse:
Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit,
but prevents a selection of attacks on RSA keys where keys with unknown origins are used.
You can switch this property off to improve performance if your project only uses known, good private keys. |
||||||||||||||||||||||||||||||
| CookieCaching:
Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the component.
Supported values are:
|
||||||||||||||||||||||||||||||
| Cookies: Gets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the component and/or restore them back between application sessions. | ||||||||||||||||||||||||||||||
| DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. | ||||||||||||||||||||||||||||||
| EnableClientSideSSLFFDHE:
Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower
algorithm if compared to EC DHE; enabling it may result in slower connections.
This setting only applies to sessions negotiated with TLS version 1.3. |
||||||||||||||||||||||||||||||
| GlobalCookies: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the components that have its CookieCaching property set to "global". | ||||||||||||||||||||||||||||||
| HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other components. | ||||||||||||||||||||||||||||||
| LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogDetails:
Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogFile: Specifies the debug log filename.Use this property to provide a path to the log file. | ||||||||||||||||||||||||||||||
| LogFilters:
Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.
Supported filter names are:
|
||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogMaxEventCount:
Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects,
depending on the rotation setting and/or the flush mode.
The default value of this setting is 100. |
||||||||||||||||||||||||||||||
LogRotationMode:
Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. | ||||||||||||||||||||||||||||||
| Tag: Allows to store any custom data.Use this config property to store any custom data. | ||||||||||||||||||||||||||||||
| UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. | ||||||||||||||||||||||||||||||
| UseSystemOAEPAndPSS:
Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable.
If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations
using its own OAEP/PSS implementation.
This setting only applies to certificates originating from a Windows system store. |
||||||||||||||||||||||||||||||
| UseSystemRandom: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. |
Trappable Errors (TSPServer Component)
TSPServer Errors
| 1048577 Invalid parameter value (SB_ERROR_INVALID_PARAMETER) | |
| 1048578 Component is configured incorrectly (SB_ERROR_INVALID_SETUP) | |
| 1048579 Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE) | |
| 1048580 Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE) | |
| 1048581 Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY) | |
| 1048581 Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |