KMIPServer Component

Properties Methods Events Config Settings Errors

The KMIPServer component provides server-side functionality for Key Management Interoperability Protocol (KMIP).

Syntax

TsbxKMIPServer

Remarks

The Key Management Interoperability Protocol (KMIP) is an OASIS standard for communication between key management servers and clients. KMIP servers are typically responsible for managing cryptographic keys and providing access to them to remote client applications.

Property List

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


Active	Indicates if the KMIP server is active and listening to incoming connections.
AllowKeepAlive	Enables or disables keep-alive mode.
AuthRealm	Specifies authentication realm for digest and NTLM authentication.
AuthTypes	Defines allowed HTTP authentication types.
BoundPort	Indicates the bound listening port.
CACertificate	The default CA certificate.
Certificate	Contains the certificate that has just been generated or added.
CompressionLevel	The default compression level to use.
ExternalCrypto	Provides access to external signing and DC parameters.
FIPSMode	Reserved.
HandshakeTimeout	Specifies the handshake timeout in milliseconds.
Host	Specifies the host name of the KMIP server.
Key	Contains the key that has just been generated or added.
PinnedClient	Populates the pinned client details.
PinnedClientChain	Contains the certificate chain of the pinned client.
Port	A port to listen for connections on.
ReadOnly	Controls whether the server works in read-only mode.
SessionTimeout	Specifies the default session timeout value in milliseconds.
SocketSettings	Manages network connection settings.
StorageFileName	A path to the KMIP object database.
TLSServerChain	The server's TLS certificates.
TLSSettings	Manages TLS layer settings.
UseChunkedTransfer	Enables chunked transfer.
UseCompression	Enables or disables server-side compression.
UseHTTP	Specifies whether the server should use HTTP instead of KMIP-over-TCP/TLS.
Users	A database of registered users.

Method List

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


Cleanup	Cleans up the server environment by purging expired sessions and cleaning caches.
Config	Sets or retrieves a configuration setting.
DoAction	Performs an additional action.
DropClient	Terminates a client connection.
GetClientCert	Populates the per-connection certificate object.
GetClientKey	Populates the per-connection key object.
GetRequestHeader	Returns a request header value.
GetResponseHeader	Returns a response header value.
ListClients	Enumerates the connected clients.
PinClient	Takes a snapshot of the connection's properties.
ProcessGenericRequest	Processes a generic HTTP request.
Reset	Resets the component settings.
SetClientBytes	Commits a data buffer to the connection.
SetClientCert	Commits the per-connection certificate object to the connection context.
SetClientKey	Commits the per-connection key object to the connection context.
SetResponseHeader	Sets a response header.
Start	Start the KMIP server.
Stop	Stops the KMIP 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.
ActivateObject	Notifies the application about the object activation request.
Add	Passes the certificate import request to the application.
AddKey	Expects the application to handle the key import request.
AfterAdd	Notifies the application about completion of the certificate import operation.
AfterAddKey	Reports the completion of the key import procedure.
AfterBrowse	KMIP server uses this event to notify the application about the completion of the browsing (attribute request) operation.
AfterDecrypt	Notifies the application about completion of the decryption call.
AfterDeriveKey	Notifies the application about completion of the key derivation request.
AfterEdit	Notifies the application of completion of the object editing operation.
AfterEncrypt	Notifies the application about the completion of the encryption call.
AfterGenerate	Signifies completion of certificate generation.
AfterGenerateKey	Notifies the application of the completion of key generation procedure.
AfterGenerateKeyPair	Notifies the application of the completion of keypair generation.
AfterHash	Notifies the application about completion of the hashing call.
AfterList	Notifies the application about completion of the list command.
AfterObtainLease	Reports the completion of lease allocation operation.
AfterReadObject	Notifies the application of the completion of the read operation on the object.
AfterReCertify	Notifies the application about the completion of the re-certify operation.
AfterReKey	Notifies the application about the completion of the re-key operation.
AfterRekeyKeyPair	Notifies the application about the completion of the re-key keypair operation.
AfterRemoveObject	Notifies the application about completion of the object removal request.
AfterSign	Notifies the application of completion of a signing operation.
AfterVerify	Notifies the application about completion of the Verify operation.
AfterVerifyHash	Notifies the application about completion of the hash verification.
ArchiveObject	Notifies the application about the received object archival request.
AuthAttempt	Fires when a connected client makes an authentication attempt.
BeforeAdd	Fires when a certificate import request is received from a client.
BeforeAddKey	Fires when a key import request is received from the client.
BeforeBrowse	Notifies the application about the browse request being received.
BeforeDecrypt	Notifies the application about the initiation of the decryption operation.
BeforeDeriveKey	Fires when a derive key request is received.
BeforeEdit	Notifies the application about the start of the object editing operation.
BeforeEncrypt	Notifies the application about the initiation of an encryption operation.
BeforeGenerate	Fires when a certificate generation request is received.
BeforeGenerateKey	Fires when a key generation request is received.
BeforeGenerateKeyPair	Fires when a key generation request is received.
BeforeHash	Notifies the application about the initiation of the hashing operation.
BeforeList	Notifies the application about the initiation of the list operation.
BeforeObtainLease	Notifies the application about the client requesting an object lease.
BeforeReadObject	Notifies the application about the start of the object reading request.
BeforeReCertify	Notifies the application about a re-certification request.
BeforeReKey	Notifies the application about a re-key request received.
BeforeRekeyKeyPair	Notifies the application about a keypair re-key request received.
BeforeRemoveObject	Notifies the application about an incoming Remove Object request.
BeforeSign	Notifies the application about the initiation of a signing operation.
BeforeVerify	Notifies the application about the initiation of the verify operation.
BeforeVerifyHash	Notifies the application about the initiation of the hash verification operation.
Cancel	Reports a cancellation request received from the client.
Check	Notifies the application about a Check request received.
Connect	Reports an accepted connection.
Decrypt	Instructs the application to decrypt a chunk of data.
DeleteAttribute	Instructs the application to delete an object attribute.
DeriveKey	Notifies the application of key derivation request.
Disconnect	Fires to report a disconnected client.
Encrypt	Instructs the application to encrypt a chunk of data.
Error	Information about errors during data delivery.
ExternalSign	Handles remote or external signing initiated by the server protocol.
Generate	Notifies the application about an incoming Generate request.
GenerateKey	Notifies the application about an incoming Generate request.
GenerateKeyPair	Notifies the application about an incoming Generate request.
GetUsageAllocation	Notifies the application about an incoming Get Usage Allocation request.
Hash	Instructs the application to update the current hashing operation.
HeadersPrepared	Fires when the response headers have been formed and are ready to be sent to the server.
KMIPAuthAttempt	Fires when a connected client makes an authentication attempt.
List	Instructs the application to return the list of objects that match the specified criteria.
ListAttributes	Requests a list of object attribute names from the application.
Notification	This event notifies the application about an underlying control flow event.
ObtainLease	Lets the application handle the lease request.
OperationAttempt	Fires when a request is received from the client.
Poll	Notifies the application about the received Poll request.
ReadAttribute	Requests an object attribute value from the application.
ReadObject	Requests the details of the object from the application.
ReCertify	Notifies the application about an incoming re-certification request.
RecoverObject	Notifies the application about an incoming Recover Object request.
ReKey	Notifies the application about an incoming re-key request.
RekeyKeyPair	Notifies the application about an incoming re-key request.
RemoveObject	Notifies the application about the object deletion request.
Request	Notifies the application about KMIP requests being received.
Response	Notifies the application about KMIP responses being sent back.
RevokeObject	Instructs the application to revoke an object.
RNGGenerate	Asks the application for another block of random numbers.
RNGSeed	Tells the application to seed the random number generator.
SetAttribute	Passes a set-attribute request to the application.
Sign	Instructs the application to sign data with a private key.
TLSCertValidate	Fires when a client certificate needs to be validated.
TLSEstablished	Reports the setup of a TLS session.
TLSHandshake	Fires when a newly established client connection initiates a TLS handshake.
TLSPSK	Requests a pre-shared key for TLS-PSK.
TLSShutdown	Reports closure of a TLS session.
ValidateChain	Passes the chain validation request to the application.
Verify	KMIPServer fires this event to notify the application about a verification operation request, and expects the application to perform it.
VerifyHash	Delegates the hash verification operation to a custom handler.

Config Settings

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


AllowKeepAlive	Enables or disables keep-alive mode.
AllowOptionsResponseWithoutAuth	Enables unauthenticated responses to OPTIONS requests.
AuthBasic	Turns on/off the basic authentication.
AuthDigest	Turns on/off the digest authentication.
AuthDigestExpire	Specifies digest expiration time for digest authentication.
AuthRealm	Specifies authentication realm for digest and NTLM authentication.
CompressionLevel	The default compression level to use.
DualStack	Allows the use of ip4 and ip6 simultaneously.
HomePage	Specifies the home page resource name.
MajorProtocolVersion	Major protocol version on the KMIP server.
MinorProtocolVersion	Minor protocol version on the KMIP server.
RequestFilter	The request string modifier.
SSLMode	Whether to establish a TLS-secured connection.
UseChunkedTransfer	Whether to use chunked encoding of the data.
UseChunkedTransfer	Enables chunked transfer.
UseCompression	Whether to use GZip compression.
UseCompression	Enables or disables server-side compression.
ASN1UseGlobalTagCache	Controls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPins	Specifies whether CSP-level PINs should be assigned to CNG keys.
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.
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
DNSLocalSuffix	The suffix to assign for TLD names.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicy	The hardware crypto usage policy.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
HttpVersion	The HTTP version to use in any inner HTTP client components created.
IgnoreExpiredMSCTLSigningCert	Whether to tolerate the expired Windows Update signing certificate.
ListDelimiter	The delimiter character for multi-element lists.
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.
OldClientSideRSAFallback	Specifies whether the SSH client should use a SHA1 fallback.
ProductVersion	Returns the version of the SecureBlackbox library.
ServerSSLDHKeyLength	Sets the size of the TLS DHE key exchange group.
StaticDNS	Specifies whether static DNS rules should be used.
StaticIPAddress[domain]	Gets or sets an IP address for the specified domain name.
StaticIPAddresses	Gets or sets all the static DNS rules.
Tag	Allows to store any custom data.
TLSSessionGroup	Specifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetime	Specifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeInterval	Specifies how often the session cache should remove the expired TLS sessions.
UseInternalRandom	Switches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidation	Enables legacy AdES validation mode.
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.
UseSystemNativeSizeCalculation	An internal CryptoAPI access tweak.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.

Active Property (KMIPServer Component)

Indicates if the KMIP server is active and listening to incoming connections.

Syntax

property Active: Boolean read get_Active;

Default Value

false

Remarks

Check this property to find out if the KMIP server is in an active state. Use Start and Stop methods to launch and stop the server.

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

AllowKeepAlive Property (KMIPServer Component)

Enables or disables keep-alive mode.

Syntax

property AllowKeepAlive: Boolean read get_AllowKeepAlive write set_AllowKeepAlive;

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 (KMIPServer 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.

AuthTypes Property (KMIPServer Component)

Defines allowed HTTP authentication types.

Syntax

property AuthTypes: Integer read get_AuthTypes write set_AuthTypes;

Default Value

Remarks

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


haBasic	`0x01`	Basic authentication
haDigest	`0x02`	Digest authentication (RFC 2617)
haNTLM	`0x04`	Windows NTLM authentication
haKerberos	`0x08`	Kerberos (Negotiate) authentication
haOAuth2	`0x10`	OAuth2 authentication

BoundPort Property (KMIPServer Component)

Indicates the bound listening port.

Syntax

property BoundPort: Integer read get_BoundPort;

Default Value

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.

CACertificate Property (KMIPServer Component)

The default CA certificate.

Syntax

property CACertificate: TsbxCertificate read get_CACertificate write set_CACertificate;

Remarks

KMIP server uses this certificate to sign incoming certificate requests. All certificates generated by the KMIP server will be signed by this CA.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

Certificate Property (KMIPServer Component)

Contains the certificate that has just been generated or added.

Syntax

property Certificate: TsbxCertificate read get_Certificate write set_Certificate;

Remarks

Use this property to access the certificate that has just been generated or added.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

CompressionLevel Property (KMIPServer Component)

The default compression level to use.

Syntax

property CompressionLevel: Integer read get_CompressionLevel write set_CompressionLevel;

Default Value

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.

ExternalCrypto Property (KMIPServer 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 the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).

This property is read-only.

Please refer to the ExternalCrypto type for a complete list of fields.

FIPSMode Property (KMIPServer Component)

Reserved.

Syntax

property FIPSMode: Boolean read get_FIPSMode write set_FIPSMode;

Default Value

false

Remarks

This property is reserved for future use.

HandshakeTimeout Property (KMIPServer Component)

Specifies the handshake timeout in milliseconds.

Syntax

property HandshakeTimeout: Integer read get_HandshakeTimeout write set_HandshakeTimeout;

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Host Property (KMIPServer Component)

Specifies the host name of the KMIP server.

Syntax

property Host: String read get_Host write set_Host;

Default Value

Remarks

Use this property to specify the address of the KMIP server.

Key Property (KMIPServer Component)

Contains the key that has just been generated or added.

Syntax

property Key: TsbxCryptoKey read get_Key write set_Key;

Remarks

Use this property to access the key that has just been generated or added.

This property is not available at design time.

Please refer to the CryptoKey type for a complete list of fields.

PinnedClient Property (KMIPServer Component)

Populates the pinned client details.

Syntax

property PinnedClient: TsbxTLSConnectionInfo 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.

Please refer to the TLSConnectionInfo type for a complete list of fields.

PinnedClientChain Property (KMIPServer 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.

Please refer to the Certificate type for a complete list of fields.

Port Property (KMIPServer Component)

A port to listen for connections on.

Syntax

property Port: Integer read get_Port write set_Port;

Default Value

5696

Remarks

Use this property to specify the listening port.

ReadOnly Property (KMIPServer Component)

Controls whether the server works in read-only mode.

Syntax

property ReadOnly: Boolean read get_ReadOnly write set_ReadOnly;

Default Value

false

Remarks

Use this property to enable or disable read-only mode on the server. It is an easy way to prevent connecting users from adding or removing objects managed by the server.

This property is not available at design time.

SessionTimeout Property (KMIPServer 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.

SocketSettings Property (KMIPServer 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.

Please refer to the SocketSettings type for a complete list of fields.

StorageFileName Property (KMIPServer Component)

A path to the KMIP object database.

Syntax

property StorageFileName: String read get_StorageFileName write set_StorageFileName;

Default Value

Remarks

Assign the path to the database of objects managed by the KMIP server to this property.

TLSServerChain Property (KMIPServer Component)

The server's TLS certificates.

Syntax

property TLSServerChain: TsbxCertificateList read get_TLSServerChain write set_TLSServerChain;

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.

Please refer to the Certificate type for a complete list of fields.

TLSSettings Property (KMIPServer 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.

Please refer to the TLSSettings type for a complete list of fields.

UseChunkedTransfer Property (KMIPServer Component)

Enables chunked transfer.

Syntax

property UseChunkedTransfer: Boolean read get_UseChunkedTransfer write set_UseChunkedTransfer;

Default Value

false

Remarks

Use this property to enable chunked content encoding.

UseCompression Property (KMIPServer Component)

Enables or disables server-side compression.

Syntax

property UseCompression: Boolean read get_UseCompression write set_UseCompression;

Default Value

false

Remarks

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

UseHTTP Property (KMIPServer Component)

Specifies whether the server should use HTTP instead of KMIP-over-TCP/TLS.

Syntax

property UseHTTP: Boolean read get_UseHTTP write set_UseHTTP;

Default Value

false

Remarks

Set this property to true to tell the server to expect HTTP(S) connections instead of TCP-based KMIP requests.

This property is not available at design time.

Users Property (KMIPServer Component)

A database of registered users.

Syntax

property Users: TsbxUserAccountList read get_Users write set_Users;

Remarks

Use this property to configure user authentication on the KMIP server.

This property is not available at design time.

Please refer to the UserAccount type for a complete list of fields.

Cleanup Method (KMIPServer Component)

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

Syntax

procedure 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 (KMIPServer 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 (KMIPServer 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 (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 (KMIPServer 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.

GetClientCert Method (KMIPServer Component)

Populates the per-connection certificate object.

Syntax

procedure GetClientCert(ConnectionID: Int64);

Remarks

This method populates the certificate template/object received with the certificate generation request in Certificate property.

Call this method from your BeforeGenerate event handler to populate the certificate template, as received in the request. It is still not late to alter the details of the certificate on this stage.

Call it from your AfterGenerate event handler to populate the certificate that has been generated.

GetClientKey Method (KMIPServer Component)

Populates the per-connection key object.

Syntax

procedure GetClientKey(ConnectionID: Int64);

Remarks

This method populates the key template/object received with the key generation request in Key property.

Call this method from your BeforeGenerateKey event handler to populate the key template, as received in the request. It is still not late to alter the details of the key on this stage.

Call it from your AfterGenerateKey event handler to populate the key that has been generated.

GetRequestHeader Method (KMIPServer 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.

GetResponseHeader Method (KMIPServer Component)

Returns a response header value.

Syntax

function GetResponseHeader(ConnectionId: Int64; HeaderName: String): 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 (KMIPServer 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 (KMIPServer 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 (KMIPServer Component)

Processes a generic HTTP request.

Syntax

function ProcessGenericRequest(ConnectionId: Int64; RequestBytes: TBytes): TBytes;

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.

Reset Method (KMIPServer Component)

Resets the component settings.

Syntax

procedure Reset();

Remarks

Reset is a generic method available in every component.

SetClientBytes Method (KMIPServer Component)

Commits a data buffer to the connection.

Syntax

procedure SetClientBytes(ConnectionID: Int64; Value: TBytes);

Remarks

Use this method from your Response Encrypt AfterEncrypt Decrypt AfterDecrypt Sign AfterSign events handler to commit a new data to the server component.

SetClientCert Method (KMIPServer Component)

Commits the per-connection certificate object to the connection context.

Syntax

procedure SetClientCert(ConnectionID: Int64);

Remarks

This method commits the certificate object stored in Certificate to the connection context.

SetClientKey Method (KMIPServer Component)

Commits the per-connection key object to the connection context.

Syntax

procedure SetClientKey(ConnectionID: Int64);

Remarks

This method commits the key object stored in Key to the connection context.

SetResponseHeader Method (KMIPServer Component)

Sets a response header.

Syntax

procedure SetResponseHeader(ConnectionId: Int64; HeaderName: String; Value: 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.

Start Method (KMIPServer Component)

Start the KMIP server.

Syntax

procedure Start();

Remarks

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

Stop Method (KMIPServer Component)

Stops the KMIP server.

Syntax

procedure Stop();

Remarks

Call this method to stop the KMIP server.

Accept Event (KMIPServer 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.

ActivateObject Event (KMIPServer Component)

Notifies the application about the object activation request.

Syntax

type TActivateObjectEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  var OperationStatus: Integer
) of Object;

property OnActivateObject: TActivateObjectEvent read FOnActivateObject write FOnActivateObject;

Remarks

Subscribe to this event to get notified about object activation requests. The ObjectId parameter contain the unique identifier of the object being activated.

Object activation requests are handled in a simplified way, without using the three-step virtualization approach.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

Add Event (KMIPServer Component)

Passes the certificate import request to the application.

Syntax

type TAddEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  var Group: String;
  var CertId: String;
  var OperationStatus: Integer
) of Object;

property OnAdd: TAddEvent read FOnAdd write FOnAdd;

Remarks

The server uses this event to allow the application to customize a certificate import request. This request fires after BeforeAdd if the Action parameter passed back to it was set to fraCustom.

The Group parameter indicates the shared name for the certificate elements (public key, private key, certificate). The CertId provides a unique identifier for the certificate object. Both can be adjusted by the application as required. Use the Certificate object to access the certificate parameters.

Upon completion of the processing, set the value of OperationStatus to match the result of the operation.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

AddKey Event (KMIPServer Component)

Expects the application to handle the key import request.

Syntax

type TAddKeyEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  var Group: String;
  var KeyId: String;
  var OperationStatus: Integer
) of Object;

property OnAddKey: TAddKeyEvent read FOnAddKey write FOnAddKey;

Remarks

Application uses this event to wiretap into the key import procedure. For this event to be invoked, the fraCustom action needs to be previously returned from the BeforeAddKey event.

The handler of this event should process the key data provided via the Key property, typically by storing the key object in a local database. The handler also should set the KeyId and, optionally, Group parameters to match the properties of the new key object. The result of the operation should be returned via the OperationStatus parameter.

See the

Handling and overriding server operations using the Three-Step Virtualization

Most of the server components shipped with SecureBlackbox are highly customizable, allowing the user to override or alter the way the clients' requests are handled by default. The customization feature paves the way for creation of bespoke or virtualized server solutions that work over standardized protocols.

The possibility of customization is typically offered through a three-step virtualization model. Every customizable operation or request that can be handled by the server - say, RenameFile - is represented with a triple of events:

BeforeRenameFile
RenameFile
AfterRenameFile

The first event fires right after the respective request has been received from a client. It provides the details of the operation, such as the original and target file names, and, importantly, a by-reference (writable) Action parameter. The event handler can set the Action parameter to one of the three settings given below. The setting chosen defines the further operation flow:

fraAuto: the operation shall be handled automatically by the server: in this case, a file will be searched in the provided local directory and renamed.
fraCustom: indicates that the user wants to take care of the operation by themselves. If this setting is chosen, the server takes no action, and instead fires the RenameFile event shortly after BeforeRenameFile completes. The user is expected to handle RenameFile and perform the requested action - that is, rename the file - manually.
fraAbort: the operation should be aborted as not supported/allowed. Neither the server nor the user are expected to perform it.

The second event (RenameFile) only fires if Action was set to fraCustom in the earlier call to BeforeRenameFile. It lets the user handle the requested operation in the way they want. The user code must fulfil the operation (for example, rename a database entry, if building a virtualized server), and return the operation result as the event's OperationResult parameter.

If the Action parameter was set to fraAuto, RenameFile is not called. The server performs the operation automatically.

The third event, AfterRenameFile, fires upon completion of the operation, either in automatic or custom mode. The user code can check and/or adjust the result to be returned to the client.

To summarize:

If Action is set to fraAuto, the next call about this operation will be to AfterRenameFile.
If Action is set to fraCustom, the next call about the operation will be to RenameFile, and after that to AfterRenameFile.
If Action is set to fraAbort, the operation is rejected and no further calls about it are performed.

notes for more details about handling and virtualizing requests in SecureBlackbox servers.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

AfterAdd Event (KMIPServer Component)

Notifies the application about completion of the certificate import operation.

Syntax

type TAfterAddEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  var Group: String;
  var CertId: String;
  var OperationStatus: Integer
) of Object;

property OnAfterAdd: TAfterAddEvent read FOnAfterAdd write FOnAfterAdd;

Remarks

The component fires this event upon completion of certificate import routine. The certificate object that has been generated can be read from the Certificate property.

The Group and CertId parameters contain the name of the group and the unique identifier assigned to the new certificate. The OperationStatus parameter contains the result of the operation. The application can adjust them as required.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

AfterAddKey Event (KMIPServer Component)

Reports the completion of the key import procedure.

Syntax

type TAfterAddKeyEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  var Group: String;
  var KeyId: String;
  var OperationStatus: Integer
) of Object;

property OnAfterAddKey: TAfterAddKeyEvent read FOnAfterAddKey write FOnAfterAddKey;

Remarks

The component uses the AfterAddKey event to notify the application about completion of the key import processing. The OperationStatus parameter returns the operation result. The KeyId and Group parameters are set to match the properties of the newly created key. The application can change them if required.

This event fires both for "normal" and "virtualized" requests, independently of the value of the Action parameter returned from the BeforeAddKey event. See the

Handling and overriding server operations using the Three-Step Virtualization

BeforeRenameFile
RenameFile
AfterRenameFile

fraAuto: the operation shall be handled automatically by the server: in this case, a file will be searched in the provided local directory and renamed.
fraCustom: indicates that the user wants to take care of the operation by themselves. If this setting is chosen, the server takes no action, and instead fires the RenameFile event shortly after BeforeRenameFile completes. The user is expected to handle RenameFile and perform the requested action - that is, rename the file - manually.
fraAbort: the operation should be aborted as not supported/allowed. Neither the server nor the user are expected to perform it.

If the Action parameter was set to fraAuto, RenameFile is not called. The server performs the operation automatically.

The third event, AfterRenameFile, fires upon completion of the operation, either in automatic or custom mode. The user code can check and/or adjust the result to be returned to the client.

To summarize:

If Action is set to fraAuto, the next call about this operation will be to AfterRenameFile.
If Action is set to fraCustom, the next call about the operation will be to RenameFile, and after that to AfterRenameFile.
If Action is set to fraAbort, the operation is rejected and no further calls about it are performed.

notes for more details about handling and virtualizing requests in SecureBlackbox servers.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

AfterBrowse Event (KMIPServer Component)

KMIP server uses this event to notify the application about the completion of the browsing (attribute request) operation.

Syntax

type TAfterBrowseEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const ObjectId: String;
  var OperationStatus: Integer
) of Object;

property OnAfterBrowse: TAfterBrowseEvent read FOnAfterBrowse write FOnAfterBrowse;

Remarks

The ConnectionID parameter identifies the client connection, and the ObjectId parameter specifies the unique ID of the object the attributes of which are being requested.

This event follows the three-step virtualization approach, and fires after the preceding BeforeBrowse and ReadAttribute events.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

See the

Handling and overriding server operations using the Three-Step Virtualization

BeforeRenameFile
RenameFile
AfterRenameFile

fraAuto: the operation shall be handled automatically by the server: in this case, a file will be searched in the provided local directory and renamed.
fraCustom: indicates that the user wants to take care of the operation by themselves. If this setting is chosen, the server takes no action, and instead fires the RenameFile event shortly after BeforeRenameFile completes. The user is expected to handle RenameFile and perform the requested action - that is, rename the file - manually.
fraAbort: the operation should be aborted as not supported/allowed. Neither the server nor the user are expected to perform it.

If the Action parameter was set to fraAuto, RenameFile is not called. The server performs the operation automatically.

The third event, AfterRenameFile, fires upon completion of the operation, either in automatic or custom mode. The user code can check and/or adjust the result to be returned to the client.

To summarize:

If Action is set to fraAuto, the next call about this operation will be to AfterRenameFile.
If Action is set to fraCustom, the next call about the operation will be to RenameFile, and after that to AfterRenameFile.
If Action is set to fraAbort, the operation is rejected and no further calls about it are performed.

notes for more details about handling and virtualizing requests in SecureBlackbox servers.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

AfterDecrypt Event (KMIPServer Component)

Notifies the application about completion of the decryption call.

Syntax

type TAfterDecryptEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  const DecryptedData: TBytes;
  var CorrelationValue: String;
  var OperationStatus: Integer
) of Object;

property OnAfterDecrypt: TAfterDecryptEvent read FOnAfterDecrypt write FOnAfterDecrypt;

Remarks

The component uses this event to notify the application about completion of the decrypt request. The event parameters provide the details of the decryption operation. This event fires independently of whether the build-in or virtualized decryption is used.

The ObjectId parameter contains the unique identifier of the decryption key. DecryptedData contains the decryption result. The CorrelationValue string is a linking token that allows to associate several pieces of a multi-step decryption operation together. The OperationStatus contains the result of the operation.

See the

Handling and overriding server operations using the Three-Step Virtualization

BeforeRenameFile
RenameFile
AfterRenameFile

fraAuto: the operation shall be handled automatically by the server: in this case, a file will be searched in the provided local directory and renamed.
fraCustom: indicates that the user wants to take care of the operation by themselves. If this setting is chosen, the server takes no action, and instead fires the RenameFile event shortly after BeforeRenameFile completes. The user is expected to handle RenameFile and perform the requested action - that is, rename the file - manually.
fraAbort: the operation should be aborted as not supported/allowed. Neither the server nor the user are expected to perform it.

If the Action parameter was set to fraAuto, RenameFile is not called. The server performs the operation automatically.

The third event, AfterRenameFile, fires upon completion of the operation, either in automatic or custom mode. The user code can check and/or adjust the result to be returned to the client.

To summarize:

If Action is set to fraAuto, the next call about this operation will be to AfterRenameFile.
If Action is set to fraCustom, the next call about the operation will be to RenameFile, and after that to AfterRenameFile.
If Action is set to fraAbort, the operation is rejected and no further calls about it are performed.

notes for more details about handling and virtualizing requests in SecureBlackbox servers.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

AfterDeriveKey Event (KMIPServer Component)

Notifies the application about completion of the key derivation request.

Syntax

type TAfterDeriveKeyEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  var NewKeyId: String;
  var OperationStatus: Integer
) of Object;

property OnAfterDeriveKey: TAfterDeriveKeyEvent read FOnAfterDeriveKey write FOnAfterDeriveKey;

Remarks

Use this event to get notified about completion of key derivation requests. The OperationStatus parameter specifies the result of the key derivation operation. The NewKeyId contains the unique identifier of the new key. You can change both parameters if required.

See the

Handling and overriding server operations using the Three-Step Virtualization

BeforeRenameFile
RenameFile
AfterRenameFile

fraAuto: the operation shall be handled automatically by the server: in this case, a file will be searched in the provided local directory and renamed.
fraCustom: indicates that the user wants to take care of the operation by themselves. If this setting is chosen, the server takes no action, and instead fires the RenameFile event shortly after BeforeRenameFile completes. The user is expected to handle RenameFile and perform the requested action - that is, rename the file - manually.
fraAbort: the operation should be aborted as not supported/allowed. Neither the server nor the user are expected to perform it.

If the Action parameter was set to fraAuto, RenameFile is not called. The server performs the operation automatically.

The third event, AfterRenameFile, fires upon completion of the operation, either in automatic or custom mode. The user code can check and/or adjust the result to be returned to the client.

To summarize:

If Action is set to fraAuto, the next call about this operation will be to AfterRenameFile.
If Action is set to fraCustom, the next call about the operation will be to RenameFile, and after that to AfterRenameFile.
If Action is set to fraAbort, the operation is rejected and no further calls about it are performed.

notes for more details about handling and virtualizing requests in SecureBlackbox servers.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

AfterEdit Event (KMIPServer Component)

Notifies the application of completion of the object editing operation.

Syntax

type TAfterEditEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const ObjectId: String;
  var OperationStatus: Integer
) of Object;

property OnAfterEdit: TAfterEditEvent read FOnAfterEdit write FOnAfterEdit;

Remarks

The component fires this event to notify the application about completion of an edit operation. An edit operation consists of a number of individual attribute update requests.

The ObjectId parameter contains the unique identifier of the object that was edited. Use the OperationStatus parameter to check or update the result of the operation.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

AfterEncrypt Event (KMIPServer Component)

Notifies the application about the completion of the encryption call.

Syntax

type TAfterEncryptEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  const EncryptedData: TBytes;
  var CorrelationValue: String;
  var OperationStatus: Integer
) of Object;

property OnAfterEncrypt: TAfterEncryptEvent read FOnAfterEncrypt write FOnAfterEncrypt;

Remarks

The component uses this event to notify the application about completion of the encrypt request. The event parameters provide the details of the encryption operation. This event fires independently of whether the build-in or virtualized decryption is used.

The ObjectId parameter contains the unique identifier of the encryption key. EncryptedData contains the encryption result. The CorrelationValue string is a linking token that allows to associate several pieces of a multi-step encryption operation together. The OperationStatus contains the result of the operation.

See the

Handling and overriding server operations using the Three-Step Virtualization

BeforeRenameFile
RenameFile
AfterRenameFile

fraAuto: the operation shall be handled automatically by the server: in this case, a file will be searched in the provided local directory and renamed.
fraCustom: indicates that the user wants to take care of the operation by themselves. If this setting is chosen, the server takes no action, and instead fires the RenameFile event shortly after BeforeRenameFile completes. The user is expected to handle RenameFile and perform the requested action - that is, rename the file - manually.
fraAbort: the operation should be aborted as not supported/allowed. Neither the server nor the user are expected to perform it.

If the Action parameter was set to fraAuto, RenameFile is not called. The server performs the operation automatically.

The third event, AfterRenameFile, fires upon completion of the operation, either in automatic or custom mode. The user code can check and/or adjust the result to be returned to the client.

To summarize:

If Action is set to fraAuto, the next call about this operation will be to AfterRenameFile.
If Action is set to fraCustom, the next call about the operation will be to RenameFile, and after that to AfterRenameFile.
If Action is set to fraAbort, the operation is rejected and no further calls about it are performed.

notes for more details about handling and virtualizing requests in SecureBlackbox servers.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

AfterGenerate Event (KMIPServer Component)

Signifies completion of certificate generation.

Syntax

type TAfterGenerateEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  var CertId: String;
  var OperationStatus: Integer
) of Object;

property OnAfterGenerate: TAfterGenerateEvent read FOnAfterGenerate write FOnAfterGenerate;

Remarks

The component fires this event upon completion of certificate generation routine. The generated certificate can be read from Certificate.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

AfterGenerateKey Event (KMIPServer Component)

Notifies the application of the completion of key generation procedure.

Syntax

type TAfterGenerateKeyEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  var KeyId: String;
  var OperationStatus: Integer
) of Object;

property OnAfterGenerateKey: TAfterGenerateKeyEvent read FOnAfterGenerateKey write FOnAfterGenerateKey;

Remarks

The component uses this event to notify the application about the completion of the key generation procedure. The KeyId parameter contains the ID of the new key object (and can be changed by the user code if required). The OperationStatus parameter reports the result of the operation.

This event is the third and conclusive in the sequence of BeforeGenerateKey, GenerateKey, and the AfterGenerateKey events. See the

Handling and overriding server operations using the Three-Step Virtualization

BeforeRenameFile
RenameFile
AfterRenameFile

fraAuto: the operation shall be handled automatically by the server: in this case, a file will be searched in the provided local directory and renamed.
fraCustom: indicates that the user wants to take care of the operation by themselves. If this setting is chosen, the server takes no action, and instead fires the RenameFile event shortly after BeforeRenameFile completes. The user is expected to handle RenameFile and perform the requested action - that is, rename the file - manually.
fraAbort: the operation should be aborted as not supported/allowed. Neither the server nor the user are expected to perform it.

If the Action parameter was set to fraAuto, RenameFile is not called. The server performs the operation automatically.

The third event, AfterRenameFile, fires upon completion of the operation, either in automatic or custom mode. The user code can check and/or adjust the result to be returned to the client.

To summarize:

If Action is set to fraAuto, the next call about this operation will be to AfterRenameFile.
If Action is set to fraCustom, the next call about the operation will be to RenameFile, and after that to AfterRenameFile.
If Action is set to fraAbort, the operation is rejected and no further calls about it are performed.

notes for more details about handling and virtualizing requests in SecureBlackbox servers.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

AfterGenerateKeyPair Event (KMIPServer Component)

Notifies the application of the completion of keypair generation.

Syntax

type TAfterGenerateKeyPairEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  var PrivateKeyId: String;
  var PublicKeyId: String;
  var OperationStatus: Integer
) of Object;

property OnAfterGenerateKeyPair: TAfterGenerateKeyPairEvent read FOnAfterGenerateKeyPair write FOnAfterGenerateKeyPair;

Remarks

The component uses this event to notify the application about the completion of the keypair generation operation. The PrivateKeyId and PublicKeyId parameters contain the IDs of the new private and public keys respectively. The OperationStatus parameter returns the result of the operation.

See the

Handling and overriding server operations using the Three-Step Virtualization

BeforeRenameFile
RenameFile
AfterRenameFile

fraAuto: the operation shall be handled automatically by the server: in this case, a file will be searched in the provided local directory and renamed.
fraCustom: indicates that the user wants to take care of the operation by themselves. If this setting is chosen, the server takes no action, and instead fires the RenameFile event shortly after BeforeRenameFile completes. The user is expected to handle RenameFile and perform the requested action - that is, rename the file - manually.
fraAbort: the operation should be aborted as not supported/allowed. Neither the server nor the user are expected to perform it.

If the Action parameter was set to fraAuto, RenameFile is not called. The server performs the operation automatically.

The third event, AfterRenameFile, fires upon completion of the operation, either in automatic or custom mode. The user code can check and/or adjust the result to be returned to the client.

To summarize:

If Action is set to fraAuto, the next call about this operation will be to AfterRenameFile.
If Action is set to fraCustom, the next call about the operation will be to RenameFile, and after that to AfterRenameFile.
If Action is set to fraAbort, the operation is rejected and no further calls about it are performed.

notes for more details about handling and virtualizing requests in SecureBlackbox servers.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

AfterHash Event (KMIPServer Component)

Notifies the application about completion of the hashing call.

Syntax

type TAfterHashEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  const HashData: TBytes;
  var CorrelationValue: String;
  var OperationStatus: Integer
) of Object;

property OnAfterHash: TAfterHashEvent read FOnAfterHash write FOnAfterHash;

Remarks

Subscribe to this event to be notified about completion of the hashing request processing. The DataHash parameter contains the hash that has been calculated. The OperationStatus parameter contains the operation result. If the hashing operation was a MAC (keyed) operation, the ID of the key is passed to the ObjectId parameter.

See the

Handling and overriding server operations using the Three-Step Virtualization

BeforeRenameFile
RenameFile
AfterRenameFile

fraAuto: the operation shall be handled automatically by the server: in this case, a file will be searched in the provided local directory and renamed.
fraCustom: indicates that the user wants to take care of the operation by themselves. If this setting is chosen, the server takes no action, and instead fires the RenameFile event shortly after BeforeRenameFile completes. The user is expected to handle RenameFile and perform the requested action - that is, rename the file - manually.
fraAbort: the operation should be aborted as not supported/allowed. Neither the server nor the user are expected to perform it.

If the Action parameter was set to fraAuto, RenameFile is not called. The server performs the operation automatically.

The third event, AfterRenameFile, fires upon completion of the operation, either in automatic or custom mode. The user code can check and/or adjust the result to be returned to the client.

To summarize:

If Action is set to fraAuto, the next call about this operation will be to AfterRenameFile.
If Action is set to fraCustom, the next call about the operation will be to RenameFile, and after that to AfterRenameFile.
If Action is set to fraAbort, the operation is rejected and no further calls about it are performed.

notes for more details about handling and virtualizing requests in SecureBlackbox servers.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

AfterList Event (KMIPServer Component)

Notifies the application about completion of the list command.

Syntax

type TAfterListEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  ObjectType: Integer;
  ObjectStatus: Integer;
  OnlyFreshObjects: Boolean;
  var ObjectIds: String;
  var OperationStatus: Integer
) of Object;

property OnAfterList: TAfterListEvent read FOnAfterList write FOnAfterList;

Remarks

The component uses this event to notify the application about the completion of the list command. The ObjectType, ObjectStatus, and OnlyFreshObjects contain the listing criteria. The ObjectIds contains a list of object unique identifiers, separated by newlines.

See the

Handling and overriding server operations using the Three-Step Virtualization

BeforeRenameFile
RenameFile
AfterRenameFile

fraAuto: the operation shall be handled automatically by the server: in this case, a file will be searched in the provided local directory and renamed.
fraCustom: indicates that the user wants to take care of the operation by themselves. If this setting is chosen, the server takes no action, and instead fires the RenameFile event shortly after BeforeRenameFile completes. The user is expected to handle RenameFile and perform the requested action - that is, rename the file - manually.
fraAbort: the operation should be aborted as not supported/allowed. Neither the server nor the user are expected to perform it.

If the Action parameter was set to fraAuto, RenameFile is not called. The server performs the operation automatically.

The third event, AfterRenameFile, fires upon completion of the operation, either in automatic or custom mode. The user code can check and/or adjust the result to be returned to the client.

To summarize:

If Action is set to fraAuto, the next call about this operation will be to AfterRenameFile.
If Action is set to fraCustom, the next call about the operation will be to RenameFile, and after that to AfterRenameFile.
If Action is set to fraAbort, the operation is rejected and no further calls about it are performed.

notes for more details about handling and virtualizing requests in SecureBlackbox servers.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

AfterObtainLease Event (KMIPServer Component)

Reports the completion of lease allocation operation.

Syntax

type TAfterObtainLeaseEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  var LeaseTime: Integer;
  var LastChangeDate: String;
  var OperationStatus: Integer
) of Object;

property OnAfterObtainLease: TAfterObtainLeaseEvent read FOnAfterObtainLease write FOnAfterObtainLease;

Remarks

The component uses this event to notify the application about the completion of lease allocation operation. The ObjectId parameter specifies the identifier of the object a lease for each is allocated. The LeaseTime and LastChangeDate parameters specify parameters of the lease.

See the

Handling and overriding server operations using the Three-Step Virtualization

BeforeRenameFile
RenameFile
AfterRenameFile

fraAuto: the operation shall be handled automatically by the server: in this case, a file will be searched in the provided local directory and renamed.
fraCustom: indicates that the user wants to take care of the operation by themselves. If this setting is chosen, the server takes no action, and instead fires the RenameFile event shortly after BeforeRenameFile completes. The user is expected to handle RenameFile and perform the requested action - that is, rename the file - manually.
fraAbort: the operation should be aborted as not supported/allowed. Neither the server nor the user are expected to perform it.

If the Action parameter was set to fraAuto, RenameFile is not called. The server performs the operation automatically.

The third event, AfterRenameFile, fires upon completion of the operation, either in automatic or custom mode. The user code can check and/or adjust the result to be returned to the client.

To summarize:

If Action is set to fraAuto, the next call about this operation will be to AfterRenameFile.
If Action is set to fraCustom, the next call about the operation will be to RenameFile, and after that to AfterRenameFile.
If Action is set to fraAbort, the operation is rejected and no further calls about it are performed.

notes for more details about handling and virtualizing requests in SecureBlackbox servers.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

AfterReadObject Event (KMIPServer Component)

Notifies the application of the completion of the read operation on the object.

Syntax

type TAfterReadObjectEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  ObjectType: Integer;
  var OperationStatus: Integer
) of Object;

property OnAfterReadObject: TAfterReadObjectEvent read FOnAfterReadObject write FOnAfterReadObject;

Remarks

Use this event to be notified about completion of the read operation.

See the

Handling and overriding server operations using the Three-Step Virtualization

BeforeRenameFile
RenameFile
AfterRenameFile

fraAuto: the operation shall be handled automatically by the server: in this case, a file will be searched in the provided local directory and renamed.
fraCustom: indicates that the user wants to take care of the operation by themselves. If this setting is chosen, the server takes no action, and instead fires the RenameFile event shortly after BeforeRenameFile completes. The user is expected to handle RenameFile and perform the requested action - that is, rename the file - manually.
fraAbort: the operation should be aborted as not supported/allowed. Neither the server nor the user are expected to perform it.

If the Action parameter was set to fraAuto, RenameFile is not called. The server performs the operation automatically.

The third event, AfterRenameFile, fires upon completion of the operation, either in automatic or custom mode. The user code can check and/or adjust the result to be returned to the client.

To summarize:

If Action is set to fraAuto, the next call about this operation will be to AfterRenameFile.
If Action is set to fraCustom, the next call about the operation will be to RenameFile, and after that to AfterRenameFile.
If Action is set to fraAbort, the operation is rejected and no further calls about it are performed.

notes for more details about handling and virtualizing requests in SecureBlackbox servers.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

AfterReCertify Event (KMIPServer Component)

Notifies the application about the completion of the re-certify operation.

Syntax

type TAfterReCertifyEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  var NewCertId: String;
  var OperationStatus: Integer
) of Object;

property OnAfterReCertify: TAfterReCertifyEvent read FOnAfterReCertify write FOnAfterReCertify;

Remarks

The server component uses this event to notify the application about the completion of the re-certification (certificate renewal) operation. The NewCertId contains the unique ID of the new certificate object. You can adjust it if required.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

AfterReKey Event (KMIPServer Component)

Notifies the application about the completion of the re-key operation.

Syntax

type TAfterReKeyEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  var NewKeyId: String;
  var OperationStatus: Integer
) of Object;

property OnAfterReKey: TAfterReKeyEvent read FOnAfterReKey write FOnAfterReKey;

Remarks

The server component uses this event to notify the application about the completion of the re-key (key renewal) operation. The NewKeyId contains the unique ID of the new key object. You can adjust it if required.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

AfterRekeyKeyPair Event (KMIPServer Component)

Notifies the application about the completion of the re-key keypair operation.

Syntax

type TAfterRekeyKeyPairEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  var NewPrivateKeyId: String;
  var NewPublicKeyId: String;
  var OperationStatus: Integer
) of Object;

property OnAfterRekeyKeyPair: TAfterRekeyKeyPairEvent read FOnAfterRekeyKeyPair write FOnAfterRekeyKeyPair;

Remarks

The server component uses this event to notify the application about the completion of the re-key (asymmetric key renewal) operation. The NewPrivateKeyId and NewPublicKeyId parameters contains the unique ID of the new key objects. You can adjust them if required.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

AfterRemoveObject Event (KMIPServer Component)

Notifies the application about completion of the object removal request.

Syntax

type TAfterRemoveObjectEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  var OperationStatus: Integer
) of Object;

property OnAfterRemoveObject: TAfterRemoveObjectEvent read FOnAfterRemoveObject write FOnAfterRemoveObject;

Remarks

Subscribe to this event to be notified about completion of an object removal request. The OperationStatus parameter contains the result of the operation.

See the

Handling and overriding server operations using the Three-Step Virtualization

BeforeRenameFile
RenameFile
AfterRenameFile

fraAuto: the operation shall be handled automatically by the server: in this case, a file will be searched in the provided local directory and renamed.
fraCustom: indicates that the user wants to take care of the operation by themselves. If this setting is chosen, the server takes no action, and instead fires the RenameFile event shortly after BeforeRenameFile completes. The user is expected to handle RenameFile and perform the requested action - that is, rename the file - manually.
fraAbort: the operation should be aborted as not supported/allowed. Neither the server nor the user are expected to perform it.

If the Action parameter was set to fraAuto, RenameFile is not called. The server performs the operation automatically.

The third event, AfterRenameFile, fires upon completion of the operation, either in automatic or custom mode. The user code can check and/or adjust the result to be returned to the client.

To summarize:

If Action is set to fraAuto, the next call about this operation will be to AfterRenameFile.
If Action is set to fraCustom, the next call about the operation will be to RenameFile, and after that to AfterRenameFile.
If Action is set to fraAbort, the operation is rejected and no further calls about it are performed.

notes for more details about handling and virtualizing requests in SecureBlackbox servers.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

AfterSign Event (KMIPServer Component)

Notifies the application of completion of a signing operation.

Syntax

type TAfterSignEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  InputIsHash: Boolean;
  const SignatureData: TBytes;
  var CorrelationValue: String;
  var OperationStatus: Integer
) of Object;

property OnAfterSign: TAfterSignEvent read FOnAfterSign write FOnAfterSign;

Remarks

The component uses this event to notify the application about the completion of a signing operation.

The ObjectId parameter contains the unique identifier of the signing key. SignatureData contains the signing result. The CorrelationValue string is a linking token that allows to associate several pieces of a multi-step signing operation together. The OperationStatus contains the result of the operation.

See the

Handling and overriding server operations using the Three-Step Virtualization

BeforeRenameFile
RenameFile
AfterRenameFile

fraAuto: the operation shall be handled automatically by the server: in this case, a file will be searched in the provided local directory and renamed.
fraCustom: indicates that the user wants to take care of the operation by themselves. If this setting is chosen, the server takes no action, and instead fires the RenameFile event shortly after BeforeRenameFile completes. The user is expected to handle RenameFile and perform the requested action - that is, rename the file - manually.
fraAbort: the operation should be aborted as not supported/allowed. Neither the server nor the user are expected to perform it.

If the Action parameter was set to fraAuto, RenameFile is not called. The server performs the operation automatically.

The third event, AfterRenameFile, fires upon completion of the operation, either in automatic or custom mode. The user code can check and/or adjust the result to be returned to the client.

To summarize:

If Action is set to fraAuto, the next call about this operation will be to AfterRenameFile.
If Action is set to fraCustom, the next call about the operation will be to RenameFile, and after that to AfterRenameFile.
If Action is set to fraAbort, the operation is rejected and no further calls about it are performed.

notes for more details about handling and virtualizing requests in SecureBlackbox servers.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

AfterVerify Event (KMIPServer Component)

Notifies the application about completion of the Verify operation.

Syntax

type TAfterVerifyEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  InputIsHash: Boolean;
  var ValidationResult: Integer;
  var CorrelationValue: String;
  var OperationStatus: Integer
) of Object;

property OnAfterVerify: TAfterVerifyEvent read FOnAfterVerify write FOnAfterVerify;

Remarks

The component fires this event to notify the application of a completion of a verification operation. The ValidationResult parameter contains the validity status of the signature.

The ObjectId parameter contains the unique identifier of the verifying key. The OperationStatus parameter contains the result of the operation.

See the

Handling and overriding server operations using the Three-Step Virtualization

BeforeRenameFile
RenameFile
AfterRenameFile

fraAuto: the operation shall be handled automatically by the server: in this case, a file will be searched in the provided local directory and renamed.
fraCustom: indicates that the user wants to take care of the operation by themselves. If this setting is chosen, the server takes no action, and instead fires the RenameFile event shortly after BeforeRenameFile completes. The user is expected to handle RenameFile and perform the requested action - that is, rename the file - manually.
fraAbort: the operation should be aborted as not supported/allowed. Neither the server nor the user are expected to perform it.

If the Action parameter was set to fraAuto, RenameFile is not called. The server performs the operation automatically.

The third event, AfterRenameFile, fires upon completion of the operation, either in automatic or custom mode. The user code can check and/or adjust the result to be returned to the client.

To summarize:

If Action is set to fraAuto, the next call about this operation will be to AfterRenameFile.
If Action is set to fraCustom, the next call about the operation will be to RenameFile, and after that to AfterRenameFile.
If Action is set to fraAbort, the operation is rejected and no further calls about it are performed.

notes for more details about handling and virtualizing requests in SecureBlackbox servers.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

AfterVerifyHash Event (KMIPServer Component)

Notifies the application about completion of the hash verification.

Syntax

type TAfterVerifyHashEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  var IsValid: Boolean;
  var CorrelationValue: String;
  var OperationStatus: Integer
) of Object;

property OnAfterVerifyHash: TAfterVerifyHashEvent read FOnAfterVerifyHash write FOnAfterVerifyHash;

Remarks

The component uses this event to notify the application about hash verification result. The optional ObjectId parameter contains the unique identifier of the key object if HMAC algorithm is used.

The IsValid parameter contains the validity factor of the hash.

See the

Handling and overriding server operations using the Three-Step Virtualization

BeforeRenameFile
RenameFile
AfterRenameFile

fraAuto: the operation shall be handled automatically by the server: in this case, a file will be searched in the provided local directory and renamed.
fraCustom: indicates that the user wants to take care of the operation by themselves. If this setting is chosen, the server takes no action, and instead fires the RenameFile event shortly after BeforeRenameFile completes. The user is expected to handle RenameFile and perform the requested action - that is, rename the file - manually.
fraAbort: the operation should be aborted as not supported/allowed. Neither the server nor the user are expected to perform it.

If the Action parameter was set to fraAuto, RenameFile is not called. The server performs the operation automatically.

The third event, AfterRenameFile, fires upon completion of the operation, either in automatic or custom mode. The user code can check and/or adjust the result to be returned to the client.

To summarize:

If Action is set to fraAuto, the next call about this operation will be to AfterRenameFile.
If Action is set to fraCustom, the next call about the operation will be to RenameFile, and after that to AfterRenameFile.
If Action is set to fraAbort, the operation is rejected and no further calls about it are performed.

notes for more details about handling and virtualizing requests in SecureBlackbox servers.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

ArchiveObject Event (KMIPServer Component)

Notifies the application about the received object archival request.

Syntax

type TArchiveObjectEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  var OperationStatus: Integer
) of Object;

property OnArchiveObject: TArchiveObjectEvent read FOnArchiveObject write FOnArchiveObject;

Remarks

The component fires this event when it receives an object archival request from a connected client. The archival procedure go through a simplified handling route, without the three-step flow.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

AuthAttempt Event (KMIPServer 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.

BeforeAdd Event (KMIPServer Component)

Fires when a certificate import request is received from a client.

Syntax

type TBeforeAddEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  var Group: String;
  var Action: Integer
) of Object;

property OnBeforeAdd: TBeforeAddEvent read FOnBeforeAdd write FOnBeforeAdd;

Remarks

The component fires this event when it receives a request from the client to import a certificate on to the server. The supplied certificate is available in Certificate object.

The Group parameter specifies a common identifier for objects related to the certificate being imported: the certificate, its public key, and its private key.

BeforeAddKey Event (KMIPServer Component)

Fires when a key import request is received from the client.

Syntax

type TBeforeAddKeyEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  var Group: String;
  var Action: Integer
) of Object;

property OnBeforeAddKey: TBeforeAddKeyEvent read FOnBeforeAddKey write FOnBeforeAddKey;

Remarks

The component fires this event when it receives a request from the client to import a key on to the server. The supplied key is available in the Key parameter.

For keypairs, the Group parameter contains a common label that will be applied to both parts of that keypair (the public key object and the private key object).

BeforeBrowse Event (KMIPServer Component)

Notifies the application about the browse request being received.

Syntax

type TBeforeBrowseEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const ObjectId: String;
  var Action: Integer
) of Object;

property OnBeforeBrowse: TBeforeBrowseEvent read FOnBeforeBrowse write FOnBeforeBrowse;

Remarks

The component uses this event to notify the application about a browse request received for an object ObjectId.

BeforeDecrypt Event (KMIPServer Component)

Notifies the application about the initiation of the decryption operation.

Syntax

type TBeforeDecryptEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  var CorrelationValue: String;
  var Action: Integer
) of Object;

property OnBeforeDecrypt: TBeforeDecryptEvent read FOnBeforeDecrypt write FOnBeforeDecrypt;

Remarks

The component fires this event to notify the application about the initiation of the decryption operation. The ObjectId parameter contains a reference to the decryption key. The optional CorrelationValue parameter can be used to link consecutive steps of multi-part decryption operation together.

Use the Action parameter to indicate the procedure you want to use for this request. See the

Handling and overriding server operations using the Three-Step Virtualization

BeforeRenameFile
RenameFile
AfterRenameFile

fraAuto: the operation shall be handled automatically by the server: in this case, a file will be searched in the provided local directory and renamed.
fraCustom: indicates that the user wants to take care of the operation by themselves. If this setting is chosen, the server takes no action, and instead fires the RenameFile event shortly after BeforeRenameFile completes. The user is expected to handle RenameFile and perform the requested action - that is, rename the file - manually.
fraAbort: the operation should be aborted as not supported/allowed. Neither the server nor the user are expected to perform it.

If the Action parameter was set to fraAuto, RenameFile is not called. The server performs the operation automatically.

The third event, AfterRenameFile, fires upon completion of the operation, either in automatic or custom mode. The user code can check and/or adjust the result to be returned to the client.

To summarize:

If Action is set to fraAuto, the next call about this operation will be to AfterRenameFile.
If Action is set to fraCustom, the next call about the operation will be to RenameFile, and after that to AfterRenameFile.
If Action is set to fraAbort, the operation is rejected and no further calls about it are performed.

notes for more details about handling and virtualizing requests in SecureBlackbox servers.

BeforeDeriveKey Event (KMIPServer Component)

Fires when a derive key request is received.

Syntax

type TBeforeDeriveKeyEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  ObjectType: Integer;
  const ObjectIds: String;
  const DerivationMethod: String;
  var Action: Integer
) of Object;

property OnBeforeDeriveKey: TBeforeDeriveKeyEvent read FOnBeforeDeriveKey write FOnBeforeDeriveKey;

Remarks

The component fires this event when it receives a request from the client to derive a key. The supplied certificate is available in Key.

BeforeEdit Event (KMIPServer Component)

Notifies the application about the start of the object editing operation.

Syntax

type TBeforeEditEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const ObjectId: String;
  var Action: Integer
) of Object;

property OnBeforeEdit: TBeforeEditEvent read FOnBeforeEdit write FOnBeforeEdit;

Remarks

The editing operation consists of a sequence of attribute update requests. Each attribute is provided to the application via an individual SetAttribute call. When the list of supplied attributes has been exhausted, the AfterEdit event call follows.

The ObjectId parameter specifies the identifier of the object being edited.

BeforeEncrypt Event (KMIPServer Component)

Notifies the application about the initiation of an encryption operation.

Syntax

type TBeforeEncryptEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  var CorrelationValue: String;
  var Action: Integer
) of Object;

property OnBeforeEncrypt: TBeforeEncryptEvent read FOnBeforeEncrypt write FOnBeforeEncrypt;

Remarks

The component fires this event to notify the application about the initiation of an encryption operation. The ObjectId parameter contains a reference to the encryption key. The optional CorrelationValue parameter can be used to link consecutive steps of multi-part encryption operation together.

Use the Action parameter to indicate the procedure you want to use for this request. See the

Handling and overriding server operations using the Three-Step Virtualization

BeforeRenameFile
RenameFile
AfterRenameFile

fraAuto: the operation shall be handled automatically by the server: in this case, a file will be searched in the provided local directory and renamed.
fraCustom: indicates that the user wants to take care of the operation by themselves. If this setting is chosen, the server takes no action, and instead fires the RenameFile event shortly after BeforeRenameFile completes. The user is expected to handle RenameFile and perform the requested action - that is, rename the file - manually.
fraAbort: the operation should be aborted as not supported/allowed. Neither the server nor the user are expected to perform it.

If the Action parameter was set to fraAuto, RenameFile is not called. The server performs the operation automatically.

The third event, AfterRenameFile, fires upon completion of the operation, either in automatic or custom mode. The user code can check and/or adjust the result to be returned to the client.

To summarize:

If Action is set to fraAuto, the next call about this operation will be to AfterRenameFile.
If Action is set to fraCustom, the next call about the operation will be to RenameFile, and after that to AfterRenameFile.
If Action is set to fraAbort, the operation is rejected and no further calls about it are performed.

notes for more details about handling and virtualizing requests in SecureBlackbox servers.

BeforeGenerate Event (KMIPServer Component)

Fires when a certificate generation request is received.

Syntax

type TBeforeGenerateEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const PublicKeyId: String;
  var Action: Integer
) of Object;

property OnBeforeGenerate: TBeforeGenerateEvent read FOnBeforeGenerate write FOnBeforeGenerate;

Remarks

The component fires this event when it receives a request from the client to generate a certificate. The supplied certificate template is available in Certificate.

BeforeGenerateKey Event (KMIPServer Component)

Fires when a key generation request is received.

Syntax

type TBeforeGenerateKeyEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  var KeyAlgorithm: String;
  var KeyLength: Integer;
  var Action: Integer
) of Object;

property OnBeforeGenerateKey: TBeforeGenerateKeyEvent read FOnBeforeGenerateKey write FOnBeforeGenerateKey;

Remarks

The component fires this event when it receives a request from the client to generate a key. KeyAlgorithm and KeyLength parameters specify the requested key properties.

BeforeGenerateKeyPair Event (KMIPServer Component)

Fires when a key generation request is received.

Syntax

type TBeforeGenerateKeyPairEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  var KeyAlgorithm: String;
  var KeyLength: Integer;
  var Scheme: String;
  var SchemeParams: String;
  var Action: Integer
) of Object;

property OnBeforeGenerateKeyPair: TBeforeGenerateKeyPairEvent read FOnBeforeGenerateKeyPair write FOnBeforeGenerateKeyPair;

Remarks

The component fires this event when it receives a request from the client to generate a keypair. KeyAlgorithm, KeyLength, Scheme and SchemeParams parameters specify the requested key properties.

BeforeHash Event (KMIPServer Component)

Notifies the application about the initiation of the hashing operation.

Syntax

type TBeforeHashEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  const HashAlgorithm: String;
  var CorrelationValue: String;
  var Action: Integer
) of Object;

property OnBeforeHash: TBeforeHashEvent read FOnBeforeHash write FOnBeforeHash;

Remarks

The component fires this event to notify the application about the initiation of a hashing operation. The optional ObjectId parameter contains a reference to the hashing key if HMAC-based hashing is used. The optional CorrelationValue parameter can be used to link consecutive steps of multi-part hash operation together.

Use the Action parameter to indicate the procedure you want to use for this request. See the

Handling and overriding server operations using the Three-Step Virtualization

BeforeRenameFile
RenameFile
AfterRenameFile

fraAuto: the operation shall be handled automatically by the server: in this case, a file will be searched in the provided local directory and renamed.
fraCustom: indicates that the user wants to take care of the operation by themselves. If this setting is chosen, the server takes no action, and instead fires the RenameFile event shortly after BeforeRenameFile completes. The user is expected to handle RenameFile and perform the requested action - that is, rename the file - manually.
fraAbort: the operation should be aborted as not supported/allowed. Neither the server nor the user are expected to perform it.

If the Action parameter was set to fraAuto, RenameFile is not called. The server performs the operation automatically.

The third event, AfterRenameFile, fires upon completion of the operation, either in automatic or custom mode. The user code can check and/or adjust the result to be returned to the client.

To summarize:

If Action is set to fraAuto, the next call about this operation will be to AfterRenameFile.
If Action is set to fraCustom, the next call about the operation will be to RenameFile, and after that to AfterRenameFile.
If Action is set to fraAbort, the operation is rejected and no further calls about it are performed.

notes for more details about handling and virtualizing requests in SecureBlackbox servers.

BeforeList Event (KMIPServer Component)

Notifies the application about the initiation of the list operation.

Syntax

type TBeforeListEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  ObjectType: Integer;
  ObjectStatus: Integer;
  OnlyFreshObjects: Boolean;
  var Action: Integer
) of Object;

property OnBeforeList: TBeforeListEvent read FOnBeforeList write FOnBeforeList;

Remarks

The component uses this event to notify the application of the received list call. The ObjectType, ObjectStatus, and OnlyFreshObjects parameters provide the listing criteria.

BeforeObtainLease Event (KMIPServer Component)

Notifies the application about the client requesting an object lease.

Syntax

type TBeforeObtainLeaseEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  var Action: Integer
) of Object;

property OnBeforeObtainLease: TBeforeObtainLeaseEvent read FOnBeforeObtainLease write FOnBeforeObtainLease;

Remarks

Use this event to get notified about the connected client requesting an object lease.

BeforeReadObject Event (KMIPServer Component)

Notifies the application about the start of the object reading request.

Syntax

type TBeforeReadObjectEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  var Action: Integer
) of Object;

property OnBeforeReadObject: TBeforeReadObjectEvent read FOnBeforeReadObject write FOnBeforeReadObject;

Remarks

Object "reading" consists of a number of individual attribute requests. If fraCustom action is returned from this event handler, the component will fire ReadObject and ReadAttribute events repeatedly to request information about the object from your code.

BeforeReCertify Event (KMIPServer Component)

Notifies the application about a re-certification request.

Syntax

type TBeforeReCertifyEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const OldCertId: String;
  var Action: Integer
) of Object;

property OnBeforeReCertify: TBeforeReCertifyEvent read FOnBeforeReCertify write FOnBeforeReCertify;

Remarks

The component uses this event to notify the application about a re-certification request (a request to re-issue an existing certificate).

The OldCertId parameter indicates the unique identifier of the certificate object that needs to be re-issued.

This event provides a pre-notification for the operation. If your code sets the Action parameter to fraCustom, this event will be followed by a ReCertify call that will let you handle the actual request as required.

BeforeReKey Event (KMIPServer Component)

Notifies the application about a re-key request received.

Syntax

type TBeforeReKeyEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const OldKeyId: String;
  var Action: Integer
) of Object;

property OnBeforeReKey: TBeforeReKeyEvent read FOnBeforeReKey write FOnBeforeReKey;

Remarks

The component uses this event to notify the application about a key re-issue request received from the client. The OldKeyId parameter contains the unique identifier of the old key object.

BeforeRekeyKeyPair Event (KMIPServer Component)

Notifies the application about a keypair re-key request received.

Syntax

type TBeforeRekeyKeyPairEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const OldPrivateKeyId: String;
  var Action: Integer
) of Object;

property OnBeforeRekeyKeyPair: TBeforeRekeyKeyPairEvent read FOnBeforeRekeyKeyPair write FOnBeforeRekeyKeyPair;

Remarks

The component uses this event to notify the application about a keypair re-issue request received from the client. The OldPrivateKeyId parameter contains the unique identifier of the old private key object.

BeforeRemoveObject Event (KMIPServer Component)

Notifies the application about an incoming Remove Object request.

Syntax

type TBeforeRemoveObjectEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  var Action: Integer
) of Object;

property OnBeforeRemoveObject: TBeforeRemoveObjectEvent read FOnBeforeRemoveObject write FOnBeforeRemoveObject;

Remarks

Subscribe to this event to choose the operation flow (automated/custom) for the object removal operation.

BeforeSign Event (KMIPServer Component)

Notifies the application about the initiation of a signing operation.

Syntax

type TBeforeSignEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  const Algorithm: String;
  const HashAlgorithm: String;
  InputIsHash: Boolean;
  var CorrelationValue: String;
  var Action: Integer
) of Object;

property OnBeforeSign: TBeforeSignEvent read FOnBeforeSign write FOnBeforeSign;

Remarks

The component fires this event to notify the application about the initiation of the signing operation. The ObjectId parameter contains a reference to the signing key. The optional CorrelationValue parameter can be used to link consecutive steps of multi-part signing operation together.

Use the Action parameter to indicate the procedure you want to use for this request. See the

Handling and overriding server operations using the Three-Step Virtualization

BeforeRenameFile
RenameFile
AfterRenameFile

fraAuto: the operation shall be handled automatically by the server: in this case, a file will be searched in the provided local directory and renamed.
fraCustom: indicates that the user wants to take care of the operation by themselves. If this setting is chosen, the server takes no action, and instead fires the RenameFile event shortly after BeforeRenameFile completes. The user is expected to handle RenameFile and perform the requested action - that is, rename the file - manually.
fraAbort: the operation should be aborted as not supported/allowed. Neither the server nor the user are expected to perform it.

If the Action parameter was set to fraAuto, RenameFile is not called. The server performs the operation automatically.

The third event, AfterRenameFile, fires upon completion of the operation, either in automatic or custom mode. The user code can check and/or adjust the result to be returned to the client.

To summarize:

If Action is set to fraAuto, the next call about this operation will be to AfterRenameFile.
If Action is set to fraCustom, the next call about the operation will be to RenameFile, and after that to AfterRenameFile.
If Action is set to fraAbort, the operation is rejected and no further calls about it are performed.

notes for more details about handling and virtualizing requests in SecureBlackbox servers.

BeforeVerify Event (KMIPServer Component)

Notifies the application about the initiation of the verify operation.

Syntax

type TBeforeVerifyEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  const HashAlgorithm: String;
  InputIsHash: Boolean;
  var CorrelationValue: String;
  var Action: Integer
) of Object;

property OnBeforeVerify: TBeforeVerifyEvent read FOnBeforeVerify write FOnBeforeVerify;

Remarks

The component fires this event to notify the application about the initiation of the verification operation. The ObjectId parameter contains a reference to the verification key.

Use the Action parameter to indicate the procedure you want to use for this request. See the

Handling and overriding server operations using the Three-Step Virtualization

BeforeRenameFile
RenameFile
AfterRenameFile

fraAuto: the operation shall be handled automatically by the server: in this case, a file will be searched in the provided local directory and renamed.
fraCustom: indicates that the user wants to take care of the operation by themselves. If this setting is chosen, the server takes no action, and instead fires the RenameFile event shortly after BeforeRenameFile completes. The user is expected to handle RenameFile and perform the requested action - that is, rename the file - manually.
fraAbort: the operation should be aborted as not supported/allowed. Neither the server nor the user are expected to perform it.

If the Action parameter was set to fraAuto, RenameFile is not called. The server performs the operation automatically.

The third event, AfterRenameFile, fires upon completion of the operation, either in automatic or custom mode. The user code can check and/or adjust the result to be returned to the client.

To summarize:

If Action is set to fraAuto, the next call about this operation will be to AfterRenameFile.
If Action is set to fraCustom, the next call about the operation will be to RenameFile, and after that to AfterRenameFile.
If Action is set to fraAbort, the operation is rejected and no further calls about it are performed.

notes for more details about handling and virtualizing requests in SecureBlackbox servers.

BeforeVerifyHash Event (KMIPServer Component)

Notifies the application about the initiation of the hash verification operation.

Syntax

type TBeforeVerifyHashEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  const HashAlgorithm: String;
  var CorrelationValue: String;
  var Action: Integer
) of Object;

property OnBeforeVerifyHash: TBeforeVerifyHashEvent read FOnBeforeVerifyHash write FOnBeforeVerifyHash;

Remarks

The component fires this event to notify the application about the initiation of the hash verification operation. The ObjectId parameter contains a reference to the HMAC key, if MAC algorithm is used.

Use the Action parameter to indicate the procedure you want to use for this request. See the

Handling and overriding server operations using the Three-Step Virtualization

BeforeRenameFile
RenameFile
AfterRenameFile

fraAuto: the operation shall be handled automatically by the server: in this case, a file will be searched in the provided local directory and renamed.
fraCustom: indicates that the user wants to take care of the operation by themselves. If this setting is chosen, the server takes no action, and instead fires the RenameFile event shortly after BeforeRenameFile completes. The user is expected to handle RenameFile and perform the requested action - that is, rename the file - manually.
fraAbort: the operation should be aborted as not supported/allowed. Neither the server nor the user are expected to perform it.

If the Action parameter was set to fraAuto, RenameFile is not called. The server performs the operation automatically.

The third event, AfterRenameFile, fires upon completion of the operation, either in automatic or custom mode. The user code can check and/or adjust the result to be returned to the client.

To summarize:

If Action is set to fraAuto, the next call about this operation will be to AfterRenameFile.
If Action is set to fraCustom, the next call about the operation will be to RenameFile, and after that to AfterRenameFile.
If Action is set to fraAbort, the operation is rejected and no further calls about it are performed.

notes for more details about handling and virtualizing requests in SecureBlackbox servers.

Cancel Event (KMIPServer Component)

Reports a cancellation request received from the client.

Syntax

type TCancelEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const AsyncCorrelationValue: String;
  var CancellationResult: Integer;
  var OperationStatus: Integer
) of Object;

property OnCancel: TCancelEvent read FOnCancel write FOnCancel;

Remarks

The component uses this event to notify the application about the cancellation request received. The application should handle the cancellation request and set CancellationResult and OperationStatus to one of the following values:


kccCancelled	`0x01`
kccUnableToCancel	`0x02`
kccCompleted	`0x03`
kccFailed	`0x04`
kccUnavailable	`0x05`


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

Check Event (KMIPServer Component)

Notifies the application about a Check request received.

Syntax

type TCheckEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  var UsageLimitsCount: Int64;
  var CryptographicUsageMask: Integer;
  var LeaseTime: Integer;
  var OperationStatus: Integer
) of Object;

property OnCheck: TCheckEvent read FOnCheck write FOnCheck;

Remarks

The component fires this event to notify the application about the Check request received from the client side. Applications working in virtual mode should implement the relevant logic in their event handlers.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

Connect Event (KMIPServer 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.

Decrypt Event (KMIPServer Component)

Instructs the application to decrypt a chunk of data.

Syntax

type TDecryptEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  const Data: TBytes;
  const IV: String;
  InitIndicator: Boolean;
  FinalIndicator: Boolean;
  const BlockCipherMode: String;
  TagLength: Integer;
  const PaddingMethod: String;
  var CorrelationValue: String;
  var OperationStatus: Integer
) of Object;

property OnDecrypt: TDecryptEvent read FOnDecrypt write FOnDecrypt;

Remarks

The server uses this event to inform the application of a decryption request submitted by the client and, optionally, request the application to decrypt the data block with the provided set of parameters. The decryption logic only needs to be implemented if the application uses the virtual storage mode.

In the event handler, use the parameters provided to decrypt Data with the key identified with ObjectId. The InitIndicator and FinalIndicator tell whether the provided block is first and/or last in a sequence of blocks forming a multi-step decryption operation. If the block is not the last one, set CorrelationValue to a random string to preserve continuity between consecutive block decryptions.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

DeleteAttribute Event (KMIPServer Component)

Instructs the application to delete an object attribute.

Syntax

type TDeleteAttributeEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  const AttributeName: String;
  var AttributeValue: String;
  var OperationStatus: Integer
) of Object;

property OnDeleteAttribute: TDeleteAttributeEvent read FOnDeleteAttribute write FOnDeleteAttribute;

Remarks

The server fires this event to relay the KMIP client's Delete Attribute request to the application if the application chose to use custom flow in the preceding BeforeEdit event.

The event handler is expected to delete the AttributeName from the ObjectId's attribute set, and return the (now deleted) AttributeValue and the OperationStatus back to the server.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

DeriveKey Event (KMIPServer Component)

Notifies the application of key derivation request.

Syntax

type TDeriveKeyEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  ObjectType: Integer;
  const ObjectIds: String;
  const DerivationMethod: String;
  const InitializationVector: TBytes;
  const DerivationData: TBytes;
  var NewKeyId: String;
  var OperationStatus: Integer
) of Object;

property OnDeriveKey: TDeriveKeyEvent read FOnDeriveKey write FOnDeriveKey;

Remarks

The server fires this event to notify the application of a received key derivation request. Applications working in virtual mode should react to this event by performing the requested operation and returning the ID of the new key via the NewKeyId parameter.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

Disconnect Event (KMIPServer 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.

Encrypt Event (KMIPServer Component)

Instructs the application to encrypt a chunk of data.

Syntax

type TEncryptEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  const Data: TBytes;
  InitIndicator: Boolean;
  FinalIndicator: Boolean;
  const BlockCipherMode: String;
  TagLength: Integer;
  const PaddingMethod: String;
  RandomIV: Boolean;
  var IV: String;
  var CorrelationValue: String;
  var OperationStatus: Integer
) of Object;

property OnEncrypt: TEncryptEvent read FOnEncrypt write FOnEncrypt;

Remarks

The server uses this event to request the application to encrypt a data block with the provided set of parameters. This event is only fired if the application chose to use a custom encryption flow in the preceding BeforeEncrypt call.

In the event handler, use the parameters provided to encrypt Data with the key identified with ObjectId. The InitIndicator and FinalIndicator tell whether the provided block is first and/or last in a sequence of blocks forming a multi-step encryption operation. If the block is not last, set CorrelationValue to a random string to preserve continuity between consecutive block encryptions.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

Error Event (KMIPServer Component)

Information about errors during data delivery.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  ErrorCode: Integer;
  Fatal: Boolean;
  Remote: Boolean;
  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 (KMIPServer 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 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(); };

Generate Event (KMIPServer Component)

Notifies the application about an incoming Generate request.

Syntax

type TGenerateEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const PublicKeyId: String;
  var CertId: String;
  var OperationStatus: Integer
) of Object;

property OnGenerate: TGenerateEvent read FOnGenerate write FOnGenerate;

Remarks

Subscribe to this event to get notified about incoming certificate generate requests. The PublicKeyId parameter specifies the public key that the new certificate should be generated over.

Applications using the server in virtual storage mode should implement the generation logic in the event handler and return the new CertId back along with OperationStatus.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

GenerateKey Event (KMIPServer Component)

Notifies the application about an incoming Generate request.

Syntax

type TGenerateKeyEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const KeyAlgorithm: String;
  KeyLength: Integer;
  const Group: String;
  var KeyId: String;
  var OperationStatus: Integer
) of Object;

property OnGenerateKey: TGenerateKeyEvent read FOnGenerateKey write FOnGenerateKey;

Remarks

Subscribe to this event to get notified about incoming key generation requests. The KeyAlgorithm and KeyLength parameters specify the parameters of the key to be generated. Use the Group parameter to arrange together keys belonging to the same set, such as private and public parts of a keypair.

Applications using the server in virtual storage mode should implement the generation logic in the event handler and return the new KeyId back along with OperationStatus.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

GenerateKeyPair Event (KMIPServer Component)

Notifies the application about an incoming Generate request.

Syntax

type TGenerateKeyPairEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const KeyAlgorithm: String;
  KeyLength: Integer;
  const Scheme: String;
  const SchemeParams: String;
  const Group: String;
  var PrivateKeyId: String;
  var PublicKeyId: String;
  var OperationStatus: Integer
) of Object;

property OnGenerateKeyPair: TGenerateKeyPairEvent read FOnGenerateKeyPair write FOnGenerateKeyPair;

Remarks

Subscribe to this event to get notified about incoming keypair generation requests. The KeyAlgorithm, KeyLength, Scheme and SchemeParams parameters specify the parameters of the keypair to be generated. Use the Group parameter to put together keys belonging to the same set, such as private and public parts of a keypair.

Applications using the server in virtual storage mode should implement the generation logic in the event handler and return the new PrivateKeyId and PublicKeyId back along with OperationStatus.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

GetUsageAllocation Event (KMIPServer Component)

Notifies the application about an incoming Get Usage Allocation request.

Syntax

type TGetUsageAllocationEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  UsageLimitsCount: Integer;
  var OperationStatus: Integer
) of Object;

property OnGetUsageAllocation: TGetUsageAllocationEvent read FOnGetUsageAllocation write FOnGetUsageAllocation;

Remarks

The component uses this event to tell the application about a Get Usage Allocation request received.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

Hash Event (KMIPServer Component)

Instructs the application to update the current hashing operation.

Syntax

type THashEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  const HashAlgorithm: String;
  const Data: TBytes;
  InitIndicator: Boolean;
  FinalIndicator: Boolean;
  var CorrelationValue: String;
  var OperationStatus: Integer
) of Object;

property OnHash: THashEvent read FOnHash write FOnHash;

Remarks

The server fires this event to pass a new chunk of data to the application for inclusion in the hash. This event is only fired if the application chose to process the hashing operation manually in the preceding BeforeHash event.

The ObjectId specifies the key object for Hash+MAC operations. The Data parameters contains the data buffer that needs to be added to the hash, with InitIndicator and FinalIndicator specifying the very first and very last data blocks respectively.

Return a unique CorrelationValue to chain pieces of a multi-block hashing operation together.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

HeadersPrepared Event (KMIPServer Component)

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

Syntax

type THeadersPreparedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64
) of Object;

property OnHeadersPrepared: THeadersPreparedEvent read FOnHeadersPrepared write FOnHeadersPrepared;

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.

KMIPAuthAttempt Event (KMIPServer Component)

Fires when a connected client makes an authentication attempt.

Syntax

type TKMIPAuthAttemptEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const Username: String;
  const Password: String;
  var Accept: Boolean
) of Object;

property OnKMIPAuthAttempt: TKMIPAuthAttemptEvent read FOnKMIPAuthAttempt write FOnKMIPAuthAttempt;

Remarks

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

Username and Password contain the professed credentials.

List Event (KMIPServer Component)

Instructs the application to return the list of objects that match the specified criteria.

Syntax

type TListEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  ObjectType: Integer;
  ObjectStatus: Integer;
  OnlyFreshObjects: Boolean;
  OffsetItems: Integer;
  MaximumItems: Integer;
  var ObjectIds: String;
  var LocatedItems: Integer;
  var OperationStatus: Integer
) of Object;

property OnList: TListEvent read FOnList write FOnList;

Remarks

The server uses this event to request a list of objects in accordance with the List call received from a KMIP client. This event only fires if the application chose to follow a custom listing flow in the preceding BeforeList event.

The event handler should use the filtering parameters provided to form the list of IDs and return it via the ObjectIds parameters. Note that ObjectType contains a bit mask of the object types that need to be returned. If that mask is set to zero, objects of all types must be considered.

The OnlyFreshObjects modifier tells the server to only return the objects that were not previously exported to the client.


otUnknown	`0x00`
otCertificate	`0x01`
otSymmetricKey	`0x02`
otPublicKey	`0x04`
otPrivateKey	`0x08`


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

ListAttributes Event (KMIPServer Component)

Requests a list of object attribute names from the application.

Syntax

type TListAttributesEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  var AttributeNames: String;
  var OperationStatus: Integer
) of Object;

property OnListAttributes: TListAttributesEvent read FOnListAttributes write FOnListAttributes;

Remarks

The server fires this event to request a list of names of attributes defined for the object. This event is only fired if the application chose to use a custom flow for attribute listing in the preceding BeforeBrowse event call.

Following completion of this event, the server will call the ReadAttribute event for each attribute name to request the respective values.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

Notification Event (KMIPServer 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 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.

This component can fire this event with the following EventID values:


ListeningStarted	Notifies the application that the server has started listening for incoming connections.
ListeningStopped	Notifies the application that the server has stopped listening to incoming connections.

ObtainLease Event (KMIPServer Component)

Lets the application handle the lease request.

Syntax

type TObtainLeaseEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  var LeaseTime: Integer;
  var LastChangeDate: String;
  var OperationStatus: Integer
) of Object;

property OnObtainLease: TObtainLeaseEvent read FOnObtainLease write FOnObtainLease;

Remarks

Subscribe to this event to react to object lease requests in virtualized mode.

The ObjectId parameter indicates the object a lease for which is requested. The LeaseTime and LastChangeDate specify the requested parameters of the lease. You can adjust them as required.

Set OperationStatus to indicate the intended operation result to the client.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

OperationAttempt Event (KMIPServer Component)

Fires when a request is received from the client.

Syntax

type TOperationAttemptEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const Operation: String;
  const Username: String;
  var Reject: Boolean
) of Object;

property OnOperationAttempt: TOperationAttemptEvent read FOnOperationAttempt write FOnOperationAttempt;

Remarks

The Operation parameter specifies the operation to perform, and Username the originator of the request. Use the Reject parameter to reject the request.

Poll Event (KMIPServer Component)

Notifies the application about the received Poll request.

Syntax

type TPollEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const AsyncCorrelationValue: String;
  var OperationStatus: Integer
) of Object;

property OnPoll: TPollEvent read FOnPoll write FOnPoll;

Remarks

KMIP clients may use Poll requests to check with the server asynchronously about the progress of an operation they started earlier. Use the handler of this event to return the OperationStatus for the operation identified with the AsyncCorrelationValue parameter.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

ReadAttribute Event (KMIPServer Component)

Requests an object attribute value from the application.

Syntax

type TReadAttributeEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  const AttributeName: String;
  var AttributeValue: String;
  var OperationStatus: Integer
) of Object;

property OnReadAttribute: TReadAttributeEvent read FOnReadAttribute write FOnReadAttribute;

Remarks

The server uses this event to request an attribute value from the application. This event is only fired if the application chose the custom object browsing flow in the preceding BeforeBrowse event.

This event is fired for every AttributeName in the list returned by the application from a preceding ListAttributes event call.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

ReadObject Event (KMIPServer Component)

Requests the details of the object from the application.

Syntax

type TReadObjectEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  var ObjectType: Integer;
  var OperationStatus: Integer
) of Object;

property OnReadObject: TReadObjectEvent read FOnReadObject write FOnReadObject;

Remarks

The server fires this event to request the details of the object from the application. This event is only invoked if the application chose to use custom operation handling in the preceding BeforeReadObject event call.

The event handler should set the ObjectType and OperationStatus as required, and provide the relevant object via the Certificate or Key property and commiting it using SetClientCert or SetClientKey respectively.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

ReCertify Event (KMIPServer Component)

Notifies the application about an incoming re-certification request.

Syntax

type TReCertifyEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const OldCertId: String;
  Offset: Integer;
  const Group: String;
  var NewCertId: String;
  var OperationStatus: Integer
) of Object;

property OnReCertify: TReCertifyEvent read FOnReCertify write FOnReCertify;

Remarks

The server uses this event to notify the application about the incoming re-certification request.

If the application uses the component in virtual mode, it should perform the requested re-certification operation in the event handler and return the identifier of the new certificate via the NewCertId parameter.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

RecoverObject Event (KMIPServer Component)

Notifies the application about an incoming Recover Object request.

Syntax

type TRecoverObjectEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  var OperationStatus: Integer
) of Object;

property OnRecoverObject: TRecoverObjectEvent read FOnRecoverObject write FOnRecoverObject;

Remarks

Subscribe to this event to get notified about the Recover Object request. Applications that use the component in the virtual mode should handle the request in their event handler and set OperationStatus in accordance with the operation result.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

ReKey Event (KMIPServer Component)

Notifies the application about an incoming re-key request.

Syntax

type TReKeyEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const OldKeyId: String;
  Offset: Integer;
  const Group: String;
  var NewKeyId: String;
  var OperationStatus: Integer
) of Object;

property OnReKey: TReKeyEvent read FOnReKey write FOnReKey;

Remarks

The server uses this event to notify the application about the incoming re-keying request.

If the application uses the component in virtual mode, it should perform the requested re-key operation in the event handler and return the identifier of the new key via the NewKeyId parameter.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

RekeyKeyPair Event (KMIPServer Component)

Notifies the application about an incoming re-key request.

Syntax

type TRekeyKeyPairEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const OldPrivateKeyId: String;
  Offset: Integer;
  const Group: String;
  var NewPrivateKeyId: String;
  var NewPublicKeyId: String;
  var OperationStatus: Integer
) of Object;

property OnRekeyKeyPair: TRekeyKeyPairEvent read FOnRekeyKeyPair write FOnRekeyKeyPair;

Remarks

The server uses this event to notify the application about the incoming asymmetric re-keying request.

If the application uses the component in virtual mode, it should perform the requested re-certification operation in the event handler and return the identifiers of the new public and private keys via the NewPublicKeyId and NewPrivateKeyId parameters.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

RemoveObject Event (KMIPServer Component)

Notifies the application about the object deletion request.

Syntax

type TRemoveObjectEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  var OperationStatus: Integer
) of Object;

property OnRemoveObject: TRemoveObjectEvent read FOnRemoveObject write FOnRemoveObject;

Remarks

The server uses this event to notify the application about the incoming object removal request. Applications working in virtual mode should perform the requested operation in the event handler and set OperationStatus according to the outcome of the operation.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

Request Event (KMIPServer Component)

Notifies the application about KMIP requests being received.

Syntax

type TRequestEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const RequestData: TBytes
) of Object;

property OnRequest: TRequestEvent read FOnRequest write FOnRequest;

Remarks

Subscribe to this event to get notified about incoming KMIP requests. The RequestData parameter contains the serialized KMIP request object.

Response Event (KMIPServer Component)

Notifies the application about KMIP responses being sent back.

Syntax

type TResponseEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ResponseData: TBytes
) of Object;

property OnResponse: TResponseEvent read FOnResponse write FOnResponse;

Remarks

Subscribe to this event to get notified about KMIP protocol responses being sent back to KMIP clients.

RevokeObject Event (KMIPServer Component)

Instructs the application to revoke an object.

Syntax

type TRevokeObjectEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  ReasonCode: Integer;
  const ReasonMessage: String;
  var OperationStatus: Integer
) of Object;

property OnRevokeObject: TRevokeObjectEvent read FOnRevokeObject write FOnRevokeObject;

Remarks

The server uses this event to relay a client's Revoke Object request to the application.

The application must mark the requested object (ObjectId) as revoked, providing ReasonCode and ReasonMessage as evidence.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

RNGGenerate Event (KMIPServer Component)

Asks the application for another block of random numbers.

Syntax

type TRNGGenerateEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  DataLength: Integer;
  var OperationStatus: Integer
) of Object;

property OnRNGGenerate: TRNGGenerateEvent read FOnRNGGenerate write FOnRNGGenerate;

Remarks

The server uses this event to request another chunk of random data from the application, following a client's PRNG Generate request.

An application that handles this event must use its PRNG to generate DataLength bytes of data and pass that data buffer back to the server via the SetClientBytes method.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

RNGSeed Event (KMIPServer Component)

Tells the application to seed the random number generator.

Syntax

type TRNGSeedEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const Data: TBytes;
  var BytesUsed: Integer;
  var OperationStatus: Integer
) of Object;

property OnRNGSeed: TRNGSeedEvent read FOnRNGSeed write FOnRNGSeed;

Remarks

The server component uses this event to notify the application about the client's RNG Seed call. The application that handles this event must seed the provided data to its PRNG and return the number of BytesUsed along with the OperationStatus.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

SetAttribute Event (KMIPServer Component)

Passes a set-attribute request to the application.

Syntax

type TSetAttributeEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  const AttributeName: String;
  const AttributeValue: String;
  var OperationStatus: Integer
) of Object;

property OnSetAttribute: TSetAttributeEvent read FOnSetAttribute write FOnSetAttribute;

Remarks

The server component uses this event to tell the application that a certain attribute on an object should be set. This event only fires if the application chose to handle the edit operation manually in BeforeEdit event handler.

The handler of this event should attempt to set the AttributeName attribute of the respective object as requested and return the operation result in the OperationStatus parameter.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

Sign Event (KMIPServer Component)

Instructs the application to sign data with a private key.

Syntax

type TSignEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  const Algorithm: String;
  const HashAlgorithm: String;
  InputIsHash: Boolean;
  const Data: TBytes;
  InitIndicator: Boolean;
  FinalIndicator: Boolean;
  var CorrelationValue: String;
  var OperationStatus: Integer
) of Object;

property OnSign: TSignEvent read FOnSign write FOnSign;

Remarks

The server used this event to request the application to sign the provided Data (or the hash of the data, subject to InputIsHash) with the private key identified by the ObjectId parameter. This event is only fired if the application chose to proceed with the custom signing flow in the preceding BeforeSign event.

The InitIndicator and FinalIndicator provide guidance as to whether the data block is the first or last in a sequence of blocks. For blocks that are not last, generate a unique CorrelationValue to ensure continuity between consecutive data blocks.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

TLSCertValidate Event (KMIPServer Component)

Fires when a client certificate needs to be validated.

Syntax

type TTLSCertValidateEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  var Accept: Boolean
) of Object;

property OnTLSCertValidate: TTLSCertValidateEvent read FOnTLSCertValidate write FOnTLSCertValidate;

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 (KMIPServer 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 (KMIPServer Component)

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

Syntax

type TTLSHandshakeEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const ServerName: String;
  var Abort: Boolean
) of Object;

property OnTLSHandshake: TTLSHandshakeEvent read FOnTLSHandshake write FOnTLSHandshake;

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 (KMIPServer 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 cipher suite associated with that identity and their key.

TLSShutdown Event (KMIPServer 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.

ValidateChain Event (KMIPServer Component)

Passes the chain validation request to the application.

Syntax

type TValidateChainEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectIds: String;
  var Validity: Integer;
  var OperationStatus: Integer
) of Object;

property OnValidateChain: TValidateChainEvent read FOnValidateChain write FOnValidateChain;

Remarks

The server fires this event to notify the application about the received chain validation request. The application needs to build a chain out of certificates contained in the ObjectIds list, validate it, and return the validation result via the Validity parameter, which can take one of the following values:


cvtValid	`0`	The chain is valid
cvtValidButUntrusted	`1`	The chain is valid, but the root certificate is not trusted
cvtInvalid	`2`	The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)
cvtCantBeEstablished	`3`	The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

Verify Event (KMIPServer Component)

KMIPServer fires this event to notify the application about a verification operation request, and expects the application to perform it.

Syntax

type TVerifyEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  const HashAlgorithm: String;
  InputIsHash: Boolean;
  const Data: TBytes;
  const SignatureData: TBytes;
  InitIndicator: Boolean;
  FinalIndicator: Boolean;
  var ValidationResult: Integer;
  var CorrelationValue: String;
  var OperationStatus: Integer
) of Object;

property OnVerify: TVerifyEvent read FOnVerify write FOnVerify;

Remarks

Subscribe to this event to be notified about public key signature verification operations. For this event to be invoked, the fraCustom action needs to be previously returned from the BeforeVerify event.

The parameters of this event provide the details of the verification request:

ObjectId: the key object to verify the signature with.
HashAlgorithm: the hash algorithm to use for verification.
InputIsHash: specifies whether Data contains the hash of the signed object or the object itself.
Data: the signed data that needs to be verified.
SignatureData: the signature data.
InitIndicator: whether the provided data block starts a sequence of blocks.
FinalIndicator: whether the provided data block ends a sequence of blocks.

Upon processing, set the ValidationResult and OperationStatus in accordance with the operation result.

See the

Handling and overriding server operations using the Three-Step Virtualization

BeforeRenameFile
RenameFile
AfterRenameFile

fraAuto: the operation shall be handled automatically by the server: in this case, a file will be searched in the provided local directory and renamed.
fraCustom: indicates that the user wants to take care of the operation by themselves. If this setting is chosen, the server takes no action, and instead fires the RenameFile event shortly after BeforeRenameFile completes. The user is expected to handle RenameFile and perform the requested action - that is, rename the file - manually.
fraAbort: the operation should be aborted as not supported/allowed. Neither the server nor the user are expected to perform it.

If the Action parameter was set to fraAuto, RenameFile is not called. The server performs the operation automatically.

The third event, AfterRenameFile, fires upon completion of the operation, either in automatic or custom mode. The user code can check and/or adjust the result to be returned to the client.

To summarize:

If Action is set to fraAuto, the next call about this operation will be to AfterRenameFile.
If Action is set to fraCustom, the next call about the operation will be to RenameFile, and after that to AfterRenameFile.
If Action is set to fraAbort, the operation is rejected and no further calls about it are performed.

notes for more details about handling and virtualizing requests in SecureBlackbox servers.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

VerifyHash Event (KMIPServer Component)

Delegates the hash verification operation to a custom handler.

Syntax

type TVerifyHashEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const ObjectId: String;
  const HashAlgorithm: String;
  const Data: TBytes;
  const Hash: TBytes;
  InitIndicator: Boolean;
  FinalIndicator: Boolean;
  var IsValid: Boolean;
  var CorrelationValue: String;
  var OperationStatus: Integer
) of Object;

property OnVerifyHash: TVerifyHashEvent read FOnVerifyHash write FOnVerifyHash;

Remarks

This event allows the application to wiretap into the server's verification procedure. It is invoked if the Action parameter in the preceding BeforeVerify hash call was set to fraCustom.

KMIPServer uses this event to delegate both hash and MAC (keyed hash) verifications.

The ObjectId parameter contains the identifier of the key object that should be used to calculate the MAC code. This parameter is empty if a simple hashing operation is requested. The Data parameter contains the data that should be verified against the hash.

The Hash parameter contains the hash or MAC record. The Algorithm parameter specifies the hash algorithm.

In this handler, the application should calculate an Algorithm hash over Data, and verify that the result matches Hash. If the result does match, it should set the IsValid parameter to true. If the hashes do not match, or if any of the call parameters are malformed or not understood by the application, it should set IsValid to false.


ostOk	`1`
ostNoSuchFile	`2`
ostAccessDenied	`3`
ostWriteProtect	`4`
ostUnsupported	`5`
ostInvalidParameter	`6`
ostEOF	`7`

Certificate Type

Encapsulates an individual X.509 certificate.

Remarks

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

The following fields are available:

Fields

Bytes
TBytes (read-only)
Default Value: ""

Returns the raw certificate data in DER format.

CA
Boolean
Default Value: False

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.

CAKeyID
TBytes (read-only)
Default Value: ""

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the SubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

CertType
TsbxCertTypes (read-only)
Default Value: 0

Returns the type of the entity contained in the Certificate object.

A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the CertificateManager component to load or create new certificate and certificate requests objects.

CRLDistributionPoints
String
Default Value: ""

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

Curve
String
Default Value: ""

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.


SB_EC_SECP112R1	`SECP112R1`
SB_EC_SECP112R2	`SECP112R2`
SB_EC_SECP128R1	`SECP128R1`
SB_EC_SECP128R2	`SECP128R2`
SB_EC_SECP160K1	`SECP160K1`
SB_EC_SECP160R1	`SECP160R1`
SB_EC_SECP160R2	`SECP160R2`
SB_EC_SECP192K1	`SECP192K1`
SB_EC_SECP192R1	`SECP192R1`
SB_EC_SECP224K1	`SECP224K1`
SB_EC_SECP224R1	`SECP224R1`
SB_EC_SECP256K1	`SECP256K1`
SB_EC_SECP256R1	`SECP256R1`
SB_EC_SECP384R1	`SECP384R1`
SB_EC_SECP521R1	`SECP521R1`
SB_EC_SECT113R1	`SECT113R1`
SB_EC_SECT113R2	`SECT113R2`
SB_EC_SECT131R1	`SECT131R1`
SB_EC_SECT131R2	`SECT131R2`
SB_EC_SECT163K1	`SECT163K1`
SB_EC_SECT163R1	`SECT163R1`
SB_EC_SECT163R2	`SECT163R2`
SB_EC_SECT193R1	`SECT193R1`
SB_EC_SECT193R2	`SECT193R2`
SB_EC_SECT233K1	`SECT233K1`
SB_EC_SECT233R1	`SECT233R1`
SB_EC_SECT239K1	`SECT239K1`
SB_EC_SECT283K1	`SECT283K1`
SB_EC_SECT283R1	`SECT283R1`
SB_EC_SECT409K1	`SECT409K1`
SB_EC_SECT409R1	`SECT409R1`
SB_EC_SECT571K1	`SECT571K1`
SB_EC_SECT571R1	`SECT571R1`
SB_EC_PRIME192V1	`PRIME192V1`
SB_EC_PRIME192V2	`PRIME192V2`
SB_EC_PRIME192V3	`PRIME192V3`
SB_EC_PRIME239V1	`PRIME239V1`
SB_EC_PRIME239V2	`PRIME239V2`
SB_EC_PRIME239V3	`PRIME239V3`
SB_EC_PRIME256V1	`PRIME256V1`
SB_EC_C2PNB163V1	`C2PNB163V1`
SB_EC_C2PNB163V2	`C2PNB163V2`
SB_EC_C2PNB163V3	`C2PNB163V3`
SB_EC_C2PNB176W1	`C2PNB176W1`
SB_EC_C2TNB191V1	`C2TNB191V1`
SB_EC_C2TNB191V2	`C2TNB191V2`
SB_EC_C2TNB191V3	`C2TNB191V3`
SB_EC_C2ONB191V4	`C2ONB191V4`
SB_EC_C2ONB191V5	`C2ONB191V5`
SB_EC_C2PNB208W1	`C2PNB208W1`
SB_EC_C2TNB239V1	`C2TNB239V1`
SB_EC_C2TNB239V2	`C2TNB239V2`
SB_EC_C2TNB239V3	`C2TNB239V3`
SB_EC_C2ONB239V4	`C2ONB239V4`
SB_EC_C2ONB239V5	`C2ONB239V5`
SB_EC_C2PNB272W1	`C2PNB272W1`
SB_EC_C2PNB304W1	`C2PNB304W1`
SB_EC_C2TNB359V1	`C2TNB359V1`
SB_EC_C2PNB368W1	`C2PNB368W1`
SB_EC_C2TNB431R1	`C2TNB431R1`
SB_EC_NISTP192	`NISTP192`
SB_EC_NISTP224	`NISTP224`
SB_EC_NISTP256	`NISTP256`
SB_EC_NISTP384	`NISTP384`
SB_EC_NISTP521	`NISTP521`
SB_EC_NISTB163	`NISTB163`
SB_EC_NISTB233	`NISTB233`
SB_EC_NISTB283	`NISTB283`
SB_EC_NISTB409	`NISTB409`
SB_EC_NISTB571	`NISTB571`
SB_EC_NISTK163	`NISTK163`
SB_EC_NISTK233	`NISTK233`
SB_EC_NISTK283	`NISTK283`
SB_EC_NISTK409	`NISTK409`
SB_EC_NISTK571	`NISTK571`
SB_EC_GOSTCPTEST	`GOSTCPTEST`
SB_EC_GOSTCPA	`GOSTCPA`
SB_EC_GOSTCPB	`GOSTCPB`
SB_EC_GOSTCPC	`GOSTCPC`
SB_EC_GOSTCPXCHA	`GOSTCPXCHA`
SB_EC_GOSTCPXCHB	`GOSTCPXCHB`
SB_EC_BRAINPOOLP160R1	`BRAINPOOLP160R1`
SB_EC_BRAINPOOLP160T1	`BRAINPOOLP160T1`
SB_EC_BRAINPOOLP192R1	`BRAINPOOLP192R1`
SB_EC_BRAINPOOLP192T1	`BRAINPOOLP192T1`
SB_EC_BRAINPOOLP224R1	`BRAINPOOLP224R1`
SB_EC_BRAINPOOLP224T1	`BRAINPOOLP224T1`
SB_EC_BRAINPOOLP256R1	`BRAINPOOLP256R1`
SB_EC_BRAINPOOLP256T1	`BRAINPOOLP256T1`
SB_EC_BRAINPOOLP320R1	`BRAINPOOLP320R1`
SB_EC_BRAINPOOLP320T1	`BRAINPOOLP320T1`
SB_EC_BRAINPOOLP384R1	`BRAINPOOLP384R1`
SB_EC_BRAINPOOLP384T1	`BRAINPOOLP384T1`
SB_EC_BRAINPOOLP512R1	`BRAINPOOLP512R1`
SB_EC_BRAINPOOLP512T1	`BRAINPOOLP512T1`
SB_EC_CURVE25519	`CURVE25519`
SB_EC_CURVE448	`CURVE448`

Fingerprint
String (read-only)
Default Value: ""

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

FriendlyName
String (read-only)
Default Value: ""

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

Handle
Int64
Default Value: 0

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

HashAlgorithm
String
Default Value: ""

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use SigAlgorithm to find out the hash algorithm that is part of the certificate signature.


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`

Issuer
String (read-only)
Default Value: ""

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via IssuerRDN.

IssuerRDN
String
Default Value: ""

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

KeyAlgorithm
String
Default Value: "0"

Specifies the public key algorithm of this certificate.


SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION	`rsaEncryption`
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION	`md2withRSAEncryption`
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION	`md5withRSAEncryption`
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION	`sha1withRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA	`id-dsa`
SB_CERT_ALGORITHM_ID_DSA_SHA1	`id-dsa-with-sha1`
SB_CERT_ALGORITHM_DH_PUBLIC	`dhpublicnumber`
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION	`sha224WithRSAEncryption`
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION	`sha256WithRSAEncryption`
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION	`sha384WithRSAEncryption`
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION	`sha512WithRSAEncryption`
SB_CERT_ALGORITHM_ID_RSAPSS	`id-RSASSA-PSS`
SB_CERT_ALGORITHM_ID_RSAOAEP	`id-RSAES-OAEP`
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160	`ripemd160withRSA`
SB_CERT_ALGORITHM_ID_ELGAMAL	`elGamal`
SB_CERT_ALGORITHM_SHA1_ECDSA	`ecdsa-with-SHA1`
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA	`ecdsa-recommended`
SB_CERT_ALGORITHM_SHA224_ECDSA	`ecdsa-with-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA	`ecdsa-with-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA	`ecdsa-with-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA	`ecdsa-with-SHA512`
SB_CERT_ALGORITHM_EC	`id-ecPublicKey`
SB_CERT_ALGORITHM_SPECIFIED_ECDSA	`ecdsa-specified`
SB_CERT_ALGORITHM_GOST_R3410_1994	`id-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3410_2001	`id-GostR3410-2001`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994	`id-GostR3411-94-with-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001	`id-GostR3411-94-with-GostR3410-2001`
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN	`ecdsa-plain-SHA1`
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN	`ecdsa-plain-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN	`ecdsa-plain-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN	`ecdsa-plain-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN	`ecdsa-plain-SHA512`
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN	`ecdsa-plain-RIPEMD160`
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION	`whirlpoolWithRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA_SHA224	`id-dsa-with-sha224`
SB_CERT_ALGORITHM_ID_DSA_SHA256	`id-dsa-with-sha256`
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA	`id-ecdsa-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA	`id-ecdsa-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA	`id-ecdsa-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA	`id-ecdsa-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-512`
SB_CERT_ALGORITHM_ID_DSA_SHA3_224	`id-dsa-with-sha3-224`
SB_CERT_ALGORITHM_ID_DSA_SHA3_256	`id-dsa-with-sha3-256`
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA	`id-ecdsa-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA	`id-ecdsa-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA	`id-ecdsa-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA	`id-ecdsa-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA	`id-ecdsa-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA	`id-ecdsa-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA	`id-ecdsa-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA	`id-ecdsa-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b512`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224	`id-dsa-with-blake2s224`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256	`id-dsa-with-blake2s256`
SB_CERT_ALGORITHM_EDDSA_ED25519	`id-Ed25519`
SB_CERT_ALGORITHM_EDDSA_ED448	`id-Ed448`
SB_CERT_ALGORITHM_EDDSA_ED25519_PH	`id-Ed25519ph`
SB_CERT_ALGORITHM_EDDSA_ED448_PH	`id-Ed448ph`
SB_CERT_ALGORITHM_EDDSA	`id-EdDSA`
SB_CERT_ALGORITHM_EDDSA_SIGNATURE	`id-EdDSA-sig`

Use the KeyBits, Curve, and PublicKeyBytes properties to get more details about the key the certificate contains.

KeyBits
Integer (read-only)
Default Value: 0

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the PublicKeyBytes or PrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

KeyFingerprint
String (read-only)
Default Value: ""

Returns a SHA1 fingerprint of the public key contained in the certificate.

Note that the key fingerprint is different from the certificate fingerprint accessible via the Fingerprint property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

KeyUsage
Integer
Default Value: 0

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:


ckuUnknown	`0x00000`	Unknown key usage
ckuDigitalSignature	`0x00001`	Digital signature
ckuNonRepudiation	`0x00002`	Non-repudiation
ckuKeyEncipherment	`0x00004`	Key encipherment
ckuDataEncipherment	`0x00008`	Data encipherment
ckuKeyAgreement	`0x00010`	Key agreement
ckuKeyCertSign	`0x00020`	Certificate signing
ckuCRLSign	`0x00040`	Revocation signing
ckuEncipherOnly	`0x00080`	Encipher only
ckuDecipherOnly	`0x00100`	Decipher only
ckuServerAuthentication	`0x00200`	Server authentication
ckuClientAuthentication	`0x00400`	Client authentication
ckuCodeSigning	`0x00800`	Code signing
ckuEmailProtection	`0x01000`	Email protection
ckuTimeStamping	`0x02000`	Timestamping
ckuOCSPSigning	`0x04000`	OCSP signing
ckuSmartCardLogon	`0x08000`	Smartcard logon
ckuKeyPurposeClientAuth	`0x10000`	Kerberos - client authentication
ckuKeyPurposeKDC	`0x20000`	Kerberos - KDC

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

KeyValid
Boolean (read-only)
Default Value: False

Returns True if the certificate's key is cryptographically valid, and False otherwise.

OCSPLocations
String
Default Value: ""

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this property before calling the certificate manager's Generate method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

OCSPNoCheck
Boolean
Default Value: False

Accessor to the value of the certificate's ocsp-no-check extension.

Origin
Integer (read-only)
Default Value: 0

Returns the location that the certificate was taken or loaded from.

PolicyIDs
String
Default Value: ""

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.

Set this property when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

PrivateKeyBytes
TBytes (read-only)
Default Value: ""

Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.

PrivateKeyExists
Boolean (read-only)
Default Value: False

Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.

This property is independent from PrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

PrivateKeyExtractable
Boolean (read-only)
Default Value: False

Indicates whether the private key is extractable (exportable).

PublicKeyBytes
TBytes (read-only)
Default Value: ""

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

Qualified
Boolean (read-only)
Default Value: False

Indicates whether the certificate is qualified.

This property is set to True if the certificate is confirmed by a Trusted List to be qualified.

QualifiedStatements
TsbxQualifiedStatementsTypes
Default Value: 0

Returns a simplified qualified status of the certificate.

Qualifiers
String (read-only)
Default Value: ""

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.

SelfSigned
Boolean (read-only)
Default Value: False

Indicates whether the certificate is self-signed (root) or signed by an external CA.

SerialNumber
TBytes
Default Value: ""

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

SigAlgorithm
String (read-only)
Default Value: ""

Indicates the algorithm that was used by the CA to sign this certificate.

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

Source
TsbxPKISources (read-only)
Default Value: 0

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Subject
String (read-only)
Default Value: ""

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via SubjectRDN.

SubjectAlternativeName
String
Default Value: ""

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Subject alternative names are used to provide additional names that are impractical to store in the main SubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.

SubjectKeyID
TBytes
Default Value: ""

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The SubjectKeyID and CAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

SubjectRDN
String
Default Value: ""

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

Valid
Boolean (read-only)
Default Value: False

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

ValidFrom
String
Default Value: ""

The time point at which the certificate becomes valid, in UTC.

ValidTo
String
Default Value: ""

The time point at which the certificate expires, in UTC.

Constructors

constructor Create();

Creates a new object with default field values.

CryptoKey Type

This container represents a cryptographic key.

Remarks

This type is a universal placeholder for cryptographic keys.

The following fields are available:

Fields

Algorithm
String
Default Value: ""

The algorithm of the cryptographic key. A cryptokey object may hold either symmetric, MAC, or public key. Public key algorithms: RSA, ECDSA, Elgamal, DH.


SB_SYMMETRIC_ALGORITHM_RC4	`RC4`
SB_SYMMETRIC_ALGORITHM_DES	`DES`
SB_SYMMETRIC_ALGORITHM_3DES	`3DES`
SB_SYMMETRIC_ALGORITHM_RC2	`RC2`
SB_SYMMETRIC_ALGORITHM_AES128	`AES128`
SB_SYMMETRIC_ALGORITHM_AES192	`AES192`
SB_SYMMETRIC_ALGORITHM_AES256	`AES256`
SB_SYMMETRIC_ALGORITHM_IDENTITY	`Identity`
SB_SYMMETRIC_ALGORITHM_BLOWFISH	`Blowfish`
SB_SYMMETRIC_ALGORITHM_CAST128	`CAST128`
SB_SYMMETRIC_ALGORITHM_IDEA	`IDEA`
SB_SYMMETRIC_ALGORITHM_TWOFISH	`Twofish`
SB_SYMMETRIC_ALGORITHM_TWOFISH128	`Twofish128`
SB_SYMMETRIC_ALGORITHM_TWOFISH192	`Twofish192`
SB_SYMMETRIC_ALGORITHM_TWOFISH256	`Twofish256`
SB_SYMMETRIC_ALGORITHM_CAMELLIA	`Camellia`
SB_SYMMETRIC_ALGORITHM_CAMELLIA128	`Camellia128`
SB_SYMMETRIC_ALGORITHM_CAMELLIA192	`Camellia192`
SB_SYMMETRIC_ALGORITHM_CAMELLIA256	`Camellia256`
SB_SYMMETRIC_ALGORITHM_SERPENT	`Serpent`
SB_SYMMETRIC_ALGORITHM_SERPENT128	`Serpent128`
SB_SYMMETRIC_ALGORITHM_SERPENT192	`Serpent192`
SB_SYMMETRIC_ALGORITHM_SERPENT256	`Serpent256`
SB_SYMMETRIC_ALGORITHM_SEED	`SEED`
SB_SYMMETRIC_ALGORITHM_RABBIT	`Rabbit`
SB_SYMMETRIC_ALGORITHM_SYMMETRIC	`Generic`
SB_SYMMETRIC_ALGORITHM_GOST_28147_1989	`GOST-28147-1989`
SB_SYMMETRIC_ALGORITHM_CHACHA20	`ChaCha20`


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`

Bits
Integer (read-only)
Default Value: 0

The length of the key in bits.

Curve
String
Default Value: ""

This property specifies the name of the curve the EC key is built on.

Exportable
Boolean (read-only)
Default Value: False

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

Fingerprint
String (read-only)
Default Value: ""

Contains the fingerprint (a hash imprint) of this key.

Handle
Int64
Default Value: 0

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.

ID
TBytes
Default Value: ""

Provides access to a storage-specific key identifier. Key identifiers are used by cryptographic providers to refer to a particular key and/or distinguish between different keys. They are typically unique within a storage, but there is no guarantee that a particular cryptoprovider will conform to that (or will assign any key IDs at all).

IV
TBytes
Default Value: ""

The initialization vector (IV) of a symmetric key. This is normally a public part of a symmetric key, the idea of which is to introduce randomness to the encrypted data and/or serve as a first block in chaining ciphers.

Key
TBytes (read-only)
Default Value: ""

The byte array representation of the key. This may not be available for non-Exportable keys.

Nonce
TBytes
Default Value: ""

A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness.

Private
Boolean (read-only)
Default Value: False

Returns True if the object hosts a private key, and False otherwise.

Public
Boolean (read-only)
Default Value: False

Returns True if the object hosts a public key, and False otherwise.

Subject
TBytes
Default Value: ""

Returns the key subject. This is a cryptoprovider-dependent value, which normally aims to provide some user-friendly insight into the key owner.

Symmetric
Boolean (read-only)
Default Value: False

Returns True if the object contains a symmetric key, and False otherwise.

Valid
Boolean (read-only)
Default Value: False

Returns True if this key is valid. The term Valid highly depends on the kind of the key being stored. A symmetric key is considered valid if its length fits the algorithm being set. The validity of an RSA key also ensures that the RSA key elements (primes, exponents, and modulus) are consistent.

Constructors

constructor Create();

Creates an empty crypto key object.

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.

The following fields are available:

AsyncDocumentID

CustomParams

Data

ExternalHashCalculation

Fields

AsyncDocumentID
String
Default Value: ""

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component 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 the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

CustomParams
String
Default Value: ""

Custom parameters to be passed to the signing service (uninterpreted).

Data
String
Default Value: ""

Additional data to be included in the async state and mirrored back by the requestor.

ExternalHashCalculation
Boolean
Default Value: False

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth component.

If set to true, the component will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

HashAlgorithm
String
Default Value: "SHA256"

Specifies the request's signature hash algorithm.


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`

KeyID
String
Default Value: ""

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 an extra protection layer for the protocol and diminishes the risk of the 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: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

KeySecret
String
Default Value: ""

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
Default Value: 0

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:


asmdPKCS1	`0`
asmdPKCS7	`1`

Mode
TsbxExternalCryptoModes
Default Value: 0

Specifies the external cryptography mode.

Available options:


ecmDefault	The default value (`0`)
ecmDisabled	Do not use DC or external signing (`1`)
ecmGeneric	Generic external signing with the OnExternalSign event (`2`)
ecmDCAuth	DCAuth signing (`3`)
ecmDCAuthJSON	DCAuth signing in JSON format (`4`)

PublicKeyAlgorithm
String
Default Value: ""

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.


SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION	`rsaEncryption`
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION	`md2withRSAEncryption`
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION	`md5withRSAEncryption`
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION	`sha1withRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA	`id-dsa`
SB_CERT_ALGORITHM_ID_DSA_SHA1	`id-dsa-with-sha1`
SB_CERT_ALGORITHM_DH_PUBLIC	`dhpublicnumber`
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION	`sha224WithRSAEncryption`
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION	`sha256WithRSAEncryption`
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION	`sha384WithRSAEncryption`
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION	`sha512WithRSAEncryption`
SB_CERT_ALGORITHM_ID_RSAPSS	`id-RSASSA-PSS`
SB_CERT_ALGORITHM_ID_RSAOAEP	`id-RSAES-OAEP`
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160	`ripemd160withRSA`
SB_CERT_ALGORITHM_ID_ELGAMAL	`elGamal`
SB_CERT_ALGORITHM_SHA1_ECDSA	`ecdsa-with-SHA1`
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA	`ecdsa-recommended`
SB_CERT_ALGORITHM_SHA224_ECDSA	`ecdsa-with-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA	`ecdsa-with-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA	`ecdsa-with-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA	`ecdsa-with-SHA512`
SB_CERT_ALGORITHM_EC	`id-ecPublicKey`
SB_CERT_ALGORITHM_SPECIFIED_ECDSA	`ecdsa-specified`
SB_CERT_ALGORITHM_GOST_R3410_1994	`id-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3410_2001	`id-GostR3410-2001`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994	`id-GostR3411-94-with-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001	`id-GostR3411-94-with-GostR3410-2001`
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN	`ecdsa-plain-SHA1`
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN	`ecdsa-plain-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN	`ecdsa-plain-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN	`ecdsa-plain-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN	`ecdsa-plain-SHA512`
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN	`ecdsa-plain-RIPEMD160`
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION	`whirlpoolWithRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA_SHA224	`id-dsa-with-sha224`
SB_CERT_ALGORITHM_ID_DSA_SHA256	`id-dsa-with-sha256`
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA	`id-ecdsa-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA	`id-ecdsa-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA	`id-ecdsa-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA	`id-ecdsa-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-512`
SB_CERT_ALGORITHM_ID_DSA_SHA3_224	`id-dsa-with-sha3-224`
SB_CERT_ALGORITHM_ID_DSA_SHA3_256	`id-dsa-with-sha3-256`
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA	`id-ecdsa-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA	`id-ecdsa-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA	`id-ecdsa-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA	`id-ecdsa-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA	`id-ecdsa-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA	`id-ecdsa-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA	`id-ecdsa-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA	`id-ecdsa-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b512`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224	`id-dsa-with-blake2s224`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256	`id-dsa-with-blake2s256`
SB_CERT_ALGORITHM_EDDSA_ED25519	`id-Ed25519`
SB_CERT_ALGORITHM_EDDSA_ED448	`id-Ed448`
SB_CERT_ALGORITHM_EDDSA_ED25519_PH	`id-Ed25519ph`
SB_CERT_ALGORITHM_EDDSA_ED448_PH	`id-Ed448ph`
SB_CERT_ALGORITHM_EDDSA	`id-EdDSA`
SB_CERT_ALGORITHM_EDDSA_SIGNATURE	`id-EdDSA-sig`

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.

The following fields are available:

Fields

DNSMode
TsbxDNSResolveModes
Default Value: 0

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.


dmAuto	`0`
dmPlatform	`1`
dmOwn	`2`
dmOwnSecure	`3`

DNSPort
Integer
Default Value: 0

Specifies the port number to be used for sending queries to the DNS server.

DNSQueryTimeout
Integer
Default Value: 0

The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.

DNSServers
String
Default Value: ""

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

DNSTotalTimeout
Integer
Default Value: 0

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.

IncomingSpeedLimit
Integer
Default Value: 0

The maximum number of bytes to read from the socket, per second.

LocalAddress
String
Default Value: ""

The local network interface to bind the socket to.

LocalPort
Integer
Default Value: 0

The local port number to bind the socket to.

OutgoingSpeedLimit
Integer
Default Value: 0

The maximum number of bytes to write to the socket, per second.

Timeout
Integer
Default Value: 60000

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
Default Value: False

Enables or disables IP protocol version 6.

Constructors

constructor Create();

Creates a new SocketSettings object.

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.

The following fields are available:

Fields

AEADCipher
Boolean (read-only)
Default Value: False

Indicates whether the encryption algorithm used is an AEAD cipher.

ChainValidationDetails
Integer (read-only)
Default Value: 0

The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:


cvrBadData	`0x0001`	One or more certificates in the validation path are malformed
cvrRevoked	`0x0002`	One or more certificates are revoked
cvrNotYetValid	`0x0004`	One or more certificates are not yet valid
cvrExpired	`0x0008`	One or more certificates are expired
cvrInvalidSignature	`0x0010`	A certificate contains a non-valid digital signature
cvrUnknownCA	`0x0020`	A CA certificate for one or more certificates has not been found (chain incomplete)
cvrCAUnauthorized	`0x0040`	One of the CA certificates are not authorized to act as CA
cvrCRLNotVerified	`0x0080`	One or more CRLs could not be verified
cvrOCSPNotVerified	`0x0100`	One or more OCSP responses could not be verified
cvrIdentityMismatch	`0x0200`	The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate
cvrNoKeyUsage	`0x0400`	A mandatory key usage is not enabled in one of the chain certificates
cvrBlocked	`0x0800`	One or more certificates are blocked
cvrFailure	`0x1000`	General validation failure
cvrChainLoop	`0x2000`	Chain loop: one of the CA certificates recursively signs itself
cvrWeakAlgorithm	`0x4000`	A weak algorithm is used in one of certificates or revocation elements
cvrUserEnforced	`0x8000`	The chain was considered invalid following intervention from a user code

ChainValidationResult
TsbxChainValidities (read-only)
Default Value: 0

The outcome of a certificate chain validation routine.

Available options:


cvtValid	`0`	The chain is valid
cvtValidButUntrusted	`1`	The chain is valid, but the root certificate is not trusted
cvtInvalid	`2`	The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)
cvtCantBeEstablished	`3`	The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

Use the ValidationLog property to access the detailed validation log.

Ciphersuite
String (read-only)
Default Value: ""

The cipher suite employed by this connection.

For TLS connections, this property returns the ciphersuite that was/is employed by the connection.

ClientAuthenticated
Boolean (read-only)
Default Value: False

Specifies whether client authentication was performed during this connection.

ClientAuthRequested
Boolean (read-only)
Default Value: False

Specifies whether client authentication was requested during this connection.

ConnectionEstablished
Boolean (read-only)
Default Value: False

Indicates whether the connection has been established fully.

ConnectionID
TBytes (read-only)
Default Value: ""

The unique identifier assigned to this connection.

DigestAlgorithm
String (read-only)
Default Value: ""

The digest algorithm used in a TLS-enabled connection.

EncryptionAlgorithm
String (read-only)
Default Value: ""

The symmetric encryption algorithm used in a TLS-enabled connection.

Exportable
Boolean (read-only)
Default Value: False

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

ID
Int64 (read-only)
Default Value: -1

The client connection's unique identifier. This value is used throughout to refer to a particular client connection.

KeyExchangeAlgorithm
String (read-only)
Default Value: ""

The key exchange algorithm used in a TLS-enabled connection.

KeyExchangeKeyBits
Integer (read-only)
Default Value: 0

The length of the key exchange key of a TLS-enabled connection.

NamedECCurve
String (read-only)
Default Value: ""

The elliptic curve used in this connection.

PFSCipher
Boolean (read-only)
Default Value: False

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

PreSharedIdentity
String
Default Value: ""

Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

PreSharedIdentityHint
String (read-only)
Default Value: ""

A hint professed by the server to help the client select the PSK identity to use.

PublicKeyBits
Integer (read-only)
Default Value: 0

The length of the public key.

RemoteAddress
String (read-only)
Default Value: ""

The client's IP address.

RemotePort
Integer (read-only)
Default Value: 0

The remote port of the client connection.

ResumedSession
Boolean (read-only)
Default Value: False

Indicates whether a TLS-enabled connection was spawned from another TLS connection

SecureConnection
Boolean (read-only)
Default Value: False

Indicates whether TLS or SSL is enabled for this connection.

ServerAuthenticated
Boolean (read-only)
Default Value: False

Indicates whether server authentication was performed during a TLS-enabled connection.

SignatureAlgorithm
String (read-only)
Default Value: ""

The signature algorithm used in a TLS handshake.

SymmetricBlockSize
Integer (read-only)
Default Value: 0

The block size of the symmetric algorithm used.

SymmetricKeyBits
Integer (read-only)
Default Value: 0

The key length of the symmetric algorithm used.

TotalBytesReceived
Int64 (read-only)
Default Value: 0

The total number of bytes received over this connection.

TotalBytesSent
Int64 (read-only)
Default Value: 0

The total number of bytes sent over this connection.

ValidationLog
String (read-only)
Default Value: ""

Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.

Version
String (read-only)
Default Value: ""

Indicates the version of SSL/TLS protocol negotiated during this connection.

Constructors

constructor Create();

Creates a new TLSConnectionInfo object.

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.

The following fields are available:

AutoValidateCertificates

ForceResumeIfDestinationChanges

PreSharedIdentity

PreSharedKey

PreSharedKeyCiphersuite

RenegotiationAttackPreventionMode

RevocationCheck

SSLOptions

TLSMode

UseExtendedMasterSecret

UseSessionResumption

Versions

Fields

AutoValidateCertificates
Boolean
Default Value: True

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

BaseConfiguration
TsbxSecureTransportPredefinedConfigurations
Default Value: 0

Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.


stpcDefault	`0`
stpcCompatible	`1`
stpcComprehensiveInsecure	`2`
stpcHighlySecure	`3`

Ciphersuites
String
Default Value: ""

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, allowing all ciphersuites to be blanketly enabled or disabled 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:

NULL_NULL_NULL
RSA_NULL_MD5
RSA_NULL_SHA
RSA_RC4_MD5
RSA_RC4_SHA
RSA_RC2_MD5
RSA_IDEA_MD5
RSA_IDEA_SHA
RSA_DES_MD5
RSA_DES_SHA
RSA_3DES_MD5
RSA_3DES_SHA
RSA_AES128_SHA
RSA_AES256_SHA
DH_DSS_DES_SHA
DH_DSS_3DES_SHA
DH_DSS_AES128_SHA
DH_DSS_AES256_SHA
DH_RSA_DES_SHA
DH_RSA_3DES_SHA
DH_RSA_AES128_SHA
DH_RSA_AES256_SHA
DHE_DSS_DES_SHA
DHE_DSS_3DES_SHA
DHE_DSS_AES128_SHA
DHE_DSS_AES256_SHA
DHE_RSA_DES_SHA
DHE_RSA_3DES_SHA
DHE_RSA_AES128_SHA
DHE_RSA_AES256_SHA
DH_ANON_RC4_MD5
DH_ANON_DES_SHA
DH_ANON_3DES_SHA
DH_ANON_AES128_SHA
DH_ANON_AES256_SHA
RSA_RC2_MD5_EXPORT
RSA_RC4_MD5_EXPORT
RSA_DES_SHA_EXPORT
DH_DSS_DES_SHA_EXPORT
DH_RSA_DES_SHA_EXPORT
DHE_DSS_DES_SHA_EXPORT
DHE_RSA_DES_SHA_EXPORT
DH_ANON_RC4_MD5_EXPORT
DH_ANON_DES_SHA_EXPORT
RSA_CAMELLIA128_SHA
DH_DSS_CAMELLIA128_SHA
DH_RSA_CAMELLIA128_SHA
DHE_DSS_CAMELLIA128_SHA
DHE_RSA_CAMELLIA128_SHA
DH_ANON_CAMELLIA128_SHA
RSA_CAMELLIA256_SHA
DH_DSS_CAMELLIA256_SHA
DH_RSA_CAMELLIA256_SHA
DHE_DSS_CAMELLIA256_SHA
DHE_RSA_CAMELLIA256_SHA
DH_ANON_CAMELLIA256_SHA
PSK_RC4_SHA
PSK_3DES_SHA
PSK_AES128_SHA
PSK_AES256_SHA
DHE_PSK_RC4_SHA
DHE_PSK_3DES_SHA
DHE_PSK_AES128_SHA
DHE_PSK_AES256_SHA
RSA_PSK_RC4_SHA
RSA_PSK_3DES_SHA
RSA_PSK_AES128_SHA
RSA_PSK_AES256_SHA
RSA_SEED_SHA
DH_DSS_SEED_SHA
DH_RSA_SEED_SHA
DHE_DSS_SEED_SHA
DHE_RSA_SEED_SHA
DH_ANON_SEED_SHA
SRP_SHA_3DES_SHA
SRP_SHA_RSA_3DES_SHA
SRP_SHA_DSS_3DES_SHA
SRP_SHA_AES128_SHA
SRP_SHA_RSA_AES128_SHA
SRP_SHA_DSS_AES128_SHA
SRP_SHA_AES256_SHA
SRP_SHA_RSA_AES256_SHA
SRP_SHA_DSS_AES256_SHA
ECDH_ECDSA_NULL_SHA
ECDH_ECDSA_RC4_SHA
ECDH_ECDSA_3DES_SHA
ECDH_ECDSA_AES128_SHA
ECDH_ECDSA_AES256_SHA
ECDHE_ECDSA_NULL_SHA
ECDHE_ECDSA_RC4_SHA
ECDHE_ECDSA_3DES_SHA
ECDHE_ECDSA_AES128_SHA
ECDHE_ECDSA_AES256_SHA
ECDH_RSA_NULL_SHA
ECDH_RSA_RC4_SHA
ECDH_RSA_3DES_SHA
ECDH_RSA_AES128_SHA
ECDH_RSA_AES256_SHA
ECDHE_RSA_NULL_SHA
ECDHE_RSA_RC4_SHA
ECDHE_RSA_3DES_SHA
ECDHE_RSA_AES128_SHA
ECDHE_RSA_AES256_SHA
ECDH_ANON_NULL_SHA
ECDH_ANON_RC4_SHA
ECDH_ANON_3DES_SHA
ECDH_ANON_AES128_SHA
ECDH_ANON_AES256_SHA
RSA_NULL_SHA256
RSA_AES128_SHA256
RSA_AES256_SHA256
DH_DSS_AES128_SHA256
DH_RSA_AES128_SHA256
DHE_DSS_AES128_SHA256
DHE_RSA_AES128_SHA256
DH_DSS_AES256_SHA256
DH_RSA_AES256_SHA256
DHE_DSS_AES256_SHA256
DHE_RSA_AES256_SHA256
DH_ANON_AES128_SHA256
DH_ANON_AES256_SHA256
RSA_AES128_GCM_SHA256
RSA_AES256_GCM_SHA384
DHE_RSA_AES128_GCM_SHA256
DHE_RSA_AES256_GCM_SHA384
DH_RSA_AES128_GCM_SHA256
DH_RSA_AES256_GCM_SHA384
DHE_DSS_AES128_GCM_SHA256
DHE_DSS_AES256_GCM_SHA384
DH_DSS_AES128_GCM_SHA256
DH_DSS_AES256_GCM_SHA384
DH_ANON_AES128_GCM_SHA256
DH_ANON_AES256_GCM_SHA384
ECDHE_ECDSA_AES128_SHA256
ECDHE_ECDSA_AES256_SHA384
ECDH_ECDSA_AES128_SHA256
ECDH_ECDSA_AES256_SHA384
ECDHE_RSA_AES128_SHA256
ECDHE_RSA_AES256_SHA384
ECDH_RSA_AES128_SHA256
ECDH_RSA_AES256_SHA384
ECDHE_ECDSA_AES128_GCM_SHA256
ECDHE_ECDSA_AES256_GCM_SHA384
ECDH_ECDSA_AES128_GCM_SHA256
ECDH_ECDSA_AES256_GCM_SHA384
ECDHE_RSA_AES128_GCM_SHA256
ECDHE_RSA_AES256_GCM_SHA384
ECDH_RSA_AES128_GCM_SHA256
ECDH_RSA_AES256_GCM_SHA384
PSK_AES128_GCM_SHA256
PSK_AES256_GCM_SHA384
DHE_PSK_AES128_GCM_SHA256
DHE_PSK_AES256_GCM_SHA384
RSA_PSK_AES128_GCM_SHA256
RSA_PSK_AES256_GCM_SHA384
PSK_AES128_SHA256
PSK_AES256_SHA384
PSK_NULL_SHA256
PSK_NULL_SHA384
DHE_PSK_AES128_SHA256
DHE_PSK_AES256_SHA384
DHE_PSK_NULL_SHA256
DHE_PSK_NULL_SHA384
RSA_PSK_AES128_SHA256
RSA_PSK_AES256_SHA384
RSA_PSK_NULL_SHA256
RSA_PSK_NULL_SHA384
RSA_CAMELLIA128_SHA256
DH_DSS_CAMELLIA128_SHA256
DH_RSA_CAMELLIA128_SHA256
DHE_DSS_CAMELLIA128_SHA256
DHE_RSA_CAMELLIA128_SHA256
DH_ANON_CAMELLIA128_SHA256
RSA_CAMELLIA256_SHA256
DH_DSS_CAMELLIA256_SHA256
DH_RSA_CAMELLIA256_SHA256
DHE_DSS_CAMELLIA256_SHA256
DHE_RSA_CAMELLIA256_SHA256
DH_ANON_CAMELLIA256_SHA256
ECDHE_ECDSA_CAMELLIA128_SHA256
ECDHE_ECDSA_CAMELLIA256_SHA384
ECDH_ECDSA_CAMELLIA128_SHA256
ECDH_ECDSA_CAMELLIA256_SHA384
ECDHE_RSA_CAMELLIA128_SHA256
ECDHE_RSA_CAMELLIA256_SHA384
ECDH_RSA_CAMELLIA128_SHA256
ECDH_RSA_CAMELLIA256_SHA384
RSA_CAMELLIA128_GCM_SHA256
RSA_CAMELLIA256_GCM_SHA384
DHE_RSA_CAMELLIA128_GCM_SHA256
DHE_RSA_CAMELLIA256_GCM_SHA384
DH_RSA_CAMELLIA128_GCM_SHA256
DH_RSA_CAMELLIA256_GCM_SHA384
DHE_DSS_CAMELLIA128_GCM_SHA256
DHE_DSS_CAMELLIA256_GCM_SHA384
DH_DSS_CAMELLIA128_GCM_SHA256
DH_DSS_CAMELLIA256_GCM_SHA384
DH_anon_CAMELLIA128_GCM_SHA256
DH_anon_CAMELLIA256_GCM_SHA384
ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
ECDH_ECDSA_CAMELLIA128_GCM_SHA256
ECDH_ECDSA_CAMELLIA256_GCM_SHA384
ECDHE_RSA_CAMELLIA128_GCM_SHA256
ECDHE_RSA_CAMELLIA256_GCM_SHA384
ECDH_RSA_CAMELLIA128_GCM_SHA256
ECDH_RSA_CAMELLIA256_GCM_SHA384
PSK_CAMELLIA128_GCM_SHA256
PSK_CAMELLIA256_GCM_SHA384
DHE_PSK_CAMELLIA128_GCM_SHA256
DHE_PSK_CAMELLIA256_GCM_SHA384
RSA_PSK_CAMELLIA128_GCM_SHA256
RSA_PSK_CAMELLIA256_GCM_SHA384
PSK_CAMELLIA128_SHA256
PSK_CAMELLIA256_SHA384
DHE_PSK_CAMELLIA128_SHA256
DHE_PSK_CAMELLIA256_SHA384
RSA_PSK_CAMELLIA128_SHA256
RSA_PSK_CAMELLIA256_SHA384
ECDHE_PSK_CAMELLIA128_SHA256
ECDHE_PSK_CAMELLIA256_SHA384
ECDHE_PSK_RC4_SHA
ECDHE_PSK_3DES_SHA
ECDHE_PSK_AES128_SHA
ECDHE_PSK_AES256_SHA
ECDHE_PSK_AES128_SHA256
ECDHE_PSK_AES256_SHA384
ECDHE_PSK_NULL_SHA
ECDHE_PSK_NULL_SHA256
ECDHE_PSK_NULL_SHA384
ECDHE_RSA_CHACHA20_POLY1305_SHA256
ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
DHE_RSA_CHACHA20_POLY1305_SHA256
PSK_CHACHA20_POLY1305_SHA256
ECDHE_PSK_CHACHA20_POLY1305_SHA256
DHE_PSK_CHACHA20_POLY1305_SHA256
RSA_PSK_CHACHA20_POLY1305_SHA256
AES128_GCM_SHA256
AES256_GCM_SHA384
CHACHA20_POLY1305_SHA256
AES128_CCM_SHA256
AES128_CCM8_SHA256

ClientAuth
TsbxClientAuthTypes
Default Value: 0

Enables or disables certificate-based client authentication.

Set this property to true to tune up the client authentication type:


ccatNoAuth	`0`
ccatRequestCert	`1`
ccatRequireCert	`2`

ECCurves
String
Default Value: ""

Defines the elliptic curves to enable.

Extensions
String
Default Value: ""

Provides access to TLS extensions.

ForceResumeIfDestinationChanges
Boolean
Default Value: False

Whether to force TLS session resumption when the destination address changes.

PreSharedIdentity
String
Default Value: ""

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

PreSharedKey
String
Default Value: ""

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

PreSharedKeyCiphersuite
String
Default Value: ""

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

RenegotiationAttackPreventionMode
TsbxRenegotiationAttackPreventionModes
Default Value: 2

Selects the renegotiation attack prevention mechanism.

The following options are available:


crapmCompatible	`0`	TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled).
crapmStrict	`1`	Renegotiation attack prevention is enabled and enforced.
crapmAuto	`2`	Automatically choose whether to enable or disable renegotiation attack prevention.

RevocationCheck
TsbxRevocationCheckKinds
Default Value: 1

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.


crcNone	`0`	No revocation checking.
crcAuto	`1`	Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future.
crcAllCRL	`2`	All provided CRL endpoints will be checked, and all checks must succeed.
crcAllOCSP	`3`	All provided OCSP endpoints will be checked, and all checks must succeed.
crcAllCRLAndOCSP	`4`	All provided CRL and OCSP endpoints will be checked, and all checks must succeed.
crcAnyCRL	`5`	All provided CRL endpoints will be checked, and at least one check must succeed.
crcAnyOCSP	`6`	All provided OCSP endpoints will be checked, and at least one check must succeed.
crcAnyCRLOrOCSP	`7`	All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL	`8`	All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first.

This setting controls the way the revocation checks are performed for every certificate in the chain. 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 the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The 'crcAll*' modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

SSLOptions
Integer
Default Value: 16

Various SSL (TLS) protocol options, set of


cssloExpectShutdownMessage	`0x001`	Wait for the close-notify message when shutting down the connection
cssloOpenSSLDTLSWorkaround	`0x002`	(DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions
cssloDisableKexLengthAlignment	`0x004`	Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it.
cssloForceUseOfClientCertHashAlg	`0x008`	Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it.
cssloAutoAddServerNameExtension	`0x010`	Automatically add the server name extension when known
cssloAcceptTrustedSRPPrimesOnly	`0x020`	Accept trusted SRP primes only
cssloDisableSignatureAlgorithmsExtension	`0x040`	Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it.
cssloIntolerateHigherProtocolVersions	`0x080`	(server option) Do not allow fallback from TLS versions higher than currently enabled
cssloStickToPrefCertHashAlg	`0x100`	Stick to preferred certificate hash algorithms
cssloNoImplicitTLS12Fallback	`0x200`	Disable implicit TLS 1.3 to 1.2 fallbacks
cssloUseHandshakeBatches	`0x400`	Send the handshake message as large batches rather than individually

TLSMode
TsbxSSLModes
Default Value: 0

Specifies the TLS mode to use.


smDefault	`0`
smNoTLS	`1`	Do not use TLS
smExplicitTLS	`2`	Connect to the server without any encryption and then request an SSL session.
smImplicitTLS	`3`	Connect to the specified port, and establish the SSL session at once.
smMixedTLS	`4`	Connect to the specified port, and establish the SSL session at once, but allow plain data.

UseExtendedMasterSecret
Boolean
Default Value: False

Enables the Extended Master Secret Extension, as defined in RFC 7627.

UseSessionResumption
Boolean
Default Value: False

Enables or disables the TLS session resumption capability.

Versions
Integer
Default Value: 16

The SSL/TLS versions to enable by default.


csbSSL2	`0x01`	SSL 2
csbSSL3	`0x02`	SSL 3
csbTLS1	`0x04`	TLS 1.0
csbTLS11	`0x08`	TLS 1.1
csbTLS12	`0x10`	TLS 1.2
csbTLS13	`0x20`	TLS 1.3

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.

The following fields are available:

Fields

AssociatedData
TBytes
Default Value: ""

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

BasePath
String
Default Value: ""

Base path for this user in the server's file system.

Certificate
TBytes
Default Value: ""

Contains the user's certificate.

Data
String
Default Value: ""

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

Email
String
Default Value: ""

The user's email address.

Handle
Int64
Default Value: 0

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.

HashAlgorithm
String
Default Value: ""

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:


SB_MAC_ALGORITHM_HMAC_SHA1	`SHA1`
SB_MAC_ALGORITHM_HMAC_SHA256	`SHA256`
SB_MAC_ALGORITHM_HMAC_SHA512	`SHA512`

IncomingSpeedLimit
Integer
Default Value: 0

Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".

OtpAlgorithm
TsbxOTPAlgorithms
Default Value: 0

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.


oaHmac	`0`
oaTime	`1`

OTPLen
Integer
Default Value: 0

Specifies the length of the user's OTP password.

OtpValue
Integer
Default Value: 0

The user's time interval (TOTP) or Counter (HOTP).

OutgoingSpeedLimit
Integer
Default Value: 0

Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".

Password
String
Default Value: ""

The user's authentication password.

SharedSecret
TBytes
Default Value: ""

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
Default Value: ""

Contains the user's SSH key.

Username
String
Default Value: ""

The registered name (login) of the user.

Constructors

constructor Create();

Creates a new UserAccount object

Config Settings (KMIPServer 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.

KMIPServer Config Settings

AllowKeepAlive: Enables or disables keep-alive mode.

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.

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.

AuthBasic: Turns on/off the basic authentication.

When switched on, connecting clients can use the basic authentication.

AuthDigest: Turns on/off the digest authentication.

When switched on, connecting clients can use the digest authentication.

AuthDigestExpire: Specifies digest expiration time for digest authentication.

Use this property to specify the digest expiration time for digest authentication, in seconds. The default setting is 20.

AuthRealm: Specifies authentication realm for digest and NTLM authentication.

Specifies authentication realm for digest and NTLM authentication types.

CompressionLevel: The default compression level to use.

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.

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.

MajorProtocolVersion: Major protocol version on the KMIP server.

Use this property to specify the major version of KMIP used on the server.

MinorProtocolVersion: Minor protocol version on the KMIP server.

Use this property to specify the minor version of KMIP used on the server.

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.

SSLMode: Whether to establish a TLS-secured connection.

When SSLMode is True, the component establishes a TLS session and encrypts the data.

UseChunkedTransfer: Whether to use chunked encoding of the data.

Set this property to true to generate chunked responses to the clients. Enables chunked transfer.

Use this property to enable chunked content encoding.

UseChunkedTransfer: Whether to use chunked encoding of the data.

Set this property to true to generate chunked responses to the clients. Enables chunked transfer.

Use this property to enable chunked content encoding.

UseCompression: Whether to use GZip compression.

Use this property to tell the component that it should use data compression when generating responses. Enables or disables server-side compression.

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

UseCompression: Whether to use GZip compression.

Use this property to tell the component that it should use data compression when generating responses. Enables or disables server-side compression.

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

Base Config Settings

ASN1UseGlobalTagCache: Controls whether ASN.1 module should use a global object cache.

This is a performance setting. It is unlikely that you will ever need to adjust it.

AssignSystemSmartCardPins: Specifies whether CSP-level PINs should be assigned to CNG keys.

This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

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:


off		No caching (default)
local		Local caching
global		Global caching

Cookies: Gets or sets local cookies for the component.

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.

DNSLocalSuffix: The suffix to assign for TLD names.

Use this global setting to adjust the default suffix to assign to top-level domain names. The default is .local.

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

HardwareCryptoUsePolicy: The hardware crypto usage policy.

This global setting controls the hardware cryptography usage policy: auto, enable, or disable.

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.

HttpVersion: The HTTP version to use in any inner HTTP client components created.

Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

IgnoreExpiredMSCTLSigningCert: Whether to tolerate the expired Windows Update signing certificate.

It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

ListDelimiter: The delimiter character for multi-element lists.

Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

LogDestination: Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:


file		File
console		Console
systemlog		System Log (supported for Android only)
debugger		Debugger (supported for VCL for Windows and .Net)

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:


time		Current time
level		Level
package		Package name
module		Module name
class		Class name
method		Method name
threadid		Thread Id
contenttype		Content type
content		Content
all		All details

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:


exclude-package		Exclude a package specified in the value
exclude-module		Exclude a module specified in the value
exclude-class		Exclude a class specified in the value
exclude-method		Exclude a method specified in the value
include-package		Include a package specified in the value
include-module		Include a module specified in the value
include-class		Include a class specified in the value
include-method		Include a method specified in the value

LogFlushMode: Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:


none		No flush (caching only)
immediate		Immediate flush (real-time logging)
maxcount		Flush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel: Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:


none		None (by default)
fatal		Severe errors that cause premature termination.
error		Other runtime errors or unexpected conditions.
warning		Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
info		Interesting runtime events (startup/shutdown).
debug		Detailed information on flow of through the system.
trace		More detailed information.

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:


none		No rotation
deleteolder		Delete older entries from the cache upon reaching LogMaxEventCount
keepolder		Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

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.

OldClientSideRSAFallback: Specifies whether the SSH client should use a SHA1 fallback.

Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

ProductVersion: Returns the version of the SecureBlackbox library.

This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

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.

StaticDNS: Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the component. Works only if UseOwnDNSResolver is set to true.

Supported values are:


none		No static DNS rules (default)
local		Local static DNS rules
global		Global static DNS rules

StaticIPAddress[domain]: Gets or sets an IP address for the specified domain name.

Use this property to get or set an IP address for the specified domain name in the internal (of the component) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character.

StaticIPAddresses: Gets or sets all the static DNS rules.

Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the component is set to "local", the property returns/restores the rules from/to the internal storage of the component. If StaticDNS of the component is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

Tag: Allows to store any custom data.

Use this config property to store any custom data.

TLSSessionGroup: Specifies the group name of TLS sessions to be used for session resumption.

Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the components.

TLSSessionLifetime: Specifies lifetime in seconds of the cached TLS session.

Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

TLSSessionPurgeInterval: Specifies how often the session cache should remove the expired TLS sessions.

Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

UseInternalRandom: Switches between SecureBlackbox-own and platform PRNGs.

Allows to switch between internal/native PRNG implementation and the one provided by the platform.

UseLegacyAdESValidation: Enables legacy AdES validation mode.

Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

UseOwnDNSResolver: Specifies whether the client components should use own DNS resolver.

Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

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.

UseSystemNativeSizeCalculation: An internal CryptoAPI access tweak.

This is an internal setting. Please do not use it unless instructed by the support team.

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 (KMIPServer Component)

KMIPServer Errors

1048577	Invalid parameter (`SB_ERROR_INVALID_PARAMETER`)
1048578	Invalid configuration (`SB_ERROR_INVALID_SETUP`)
1048579	Invalid state (`SB_ERROR_INVALID_STATE`)
1048580	Invalid value (`SB_ERROR_INVALID_VALUE`)
1048581	Private key not found (`SB_ERROR_NO_PRIVATE_KEY`)
1048582	Cancelled by the user (`SB_ERROR_CANCELLED_BY_USER`)
1048583	The file was not found (`SB_ERROR_NO_SUCH_FILE`)
1048584	Unsupported feature or operation (`SB_ERROR_UNSUPPORTED_FEATURE`)
1048585	General error (`SB_ERROR_GENERAL_ERROR`)
20971521	KMIP request failed (`SB_ERROR_KMIP_REQUEST_FAILED`)
20971522	The input file does not exist (`SB_ERROR_KMIP_INPUTFILE_NOT_EXISTS`)
20971523	Unsupported key algorithm (`SB_ERROR_KMIP_UNSUPPORTED_KEY_ALGORITHM`)
20971524	Invalid key (`SB_ERROR_KMIP_INVALID_KEY`)