KMIPServer Component

Properties Methods Events Config Settings Errors

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

Syntax

nsoftware.SecureBlackbox.KMIPServer

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


Config	This method 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	ToDo
AfterReKey	ToDo
AfterRekeyKeyPair	ToDo
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	TBD
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	TBD
Connect	Reports an accepted connection.
Decrypt	TBD
DeleteAttribute	TBD
DeriveKey	TBD
Disconnect	Fires to report a disconnected client.
Encrypt	TBD
Error	Information about errors during data delivery.
ExternalSign	Handles remote or external signing initiated by the server protocol.
Generate	TBD
GenerateKey	TBD
GenerateKeyPair	TBD
GetUsageAllocation	TBD
Hash	TBD
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	TBD
ListAttributes	TBD
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	TBD
ReadAttribute	TBD
ReadObject	TBD
ReCertify	TBD
RecoverObject	TBD
ReKey	TBD
RekeyKeyPair	TBD
RemoveObject	TBD
Request	TBD
Response	TBD
RevokeObject	TBD
RNGGenerate	TBD
RNGSeed	TBD
SetAttribute	TBD
Sign	TBD
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	TBD
Verify	TBD
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.


AuthBasic	Turns on/off the basic authentication.
AuthDigest	Turns on/off the digest authentication.
DualStack	Allows the use of ip4 and ip6 simultaneously.
MajorProtocolVersion	Major protocol version on the KMIP server.
MinorProtocolVersion	Minor protocol version on the KMIP server.
SSLMode	Whether to establish a TLS-secured connection.
UseChunkedTransfer	Whether to use chunked encoding of the data.
UseCompression	Whether to use GZip compression.
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.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
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.
UseOwnDNSResolver	Specifies whether the client components should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.

Active Property (KMIPServer Component)

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

public bool Active { get; }

Public ReadOnly Property Active As Boolean

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

C#
VB.NET

public bool AllowKeepAlive { get; set; }

Public Property AllowKeepAlive As Boolean

Default Value

True

Remarks

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

AuthRealm Property (KMIPServer Component)

Specifies authentication realm for digest and NTLM authentication.

Syntax

C#
VB.NET

public string AuthRealm { get; set; }

Public Property AuthRealm As String

Default Value

"SecureBlackbox"

Remarks

Specifies authentication realm for digest and NTLM authentication types.

AuthTypes Property (KMIPServer Component)

Defines allowed HTTP authentication types.

Syntax

C#
VB.NET

public int AuthTypes { get; set; }

Public Property AuthTypes As Integer

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

C#
VB.NET

public int BoundPort { get; }

Public ReadOnly Property BoundPort As Integer

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

C#
VB.NET

public Certificate CACertificate { get; set; }

Public Property CACertificate As Certificate

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

C#
VB.NET

public Certificate Certificate { get; set; }

Public Property Certificate As 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

C#
VB.NET

public int CompressionLevel { get; set; }

Public Property CompressionLevel As Integer

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

C#
VB.NET

public ExternalCrypto ExternalCrypto { get; }

Public ReadOnly Property ExternalCrypto As ExternalCrypto

Remarks

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

This property is read-only.

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

FIPSMode Property (KMIPServer Component)

Reserved.

Syntax

C#
VB.NET

public bool FIPSMode { get; set; }

Public Property FIPSMode As Boolean

Default Value

False

Remarks

This property is reserved for future use.

HandshakeTimeout Property (KMIPServer Component)

Specifies the handshake timeout in milliseconds.

Syntax

C#
VB.NET

public int HandshakeTimeout { get; set; }

Public Property HandshakeTimeout As Integer

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Host Property (KMIPServer Component)

Specifies the host name of the KMIP server.

Syntax

C#
VB.NET

public string Host { get; set; }

Public Property Host As String

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

C#
VB.NET

public CryptoKey Key { get; set; }

Public Property Key As CryptoKey

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

C#
VB.NET

public TLSConnectionInfo PinnedClient { get; }

Public ReadOnly Property PinnedClient As TLSConnectionInfo

Remarks

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

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

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

C#
VB.NET

public CertificateList PinnedClientChain { get; }

Public ReadOnly Property PinnedClientChain As CertificateList

Remarks

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

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

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

Port Property (KMIPServer Component)

A port to listen for connections on.

Syntax

C#
VB.NET

public int Port { get; set; }

Public Property Port As Integer

Default Value

5696

Remarks

Use this property to specify the listening port.

ReadOnly Property (KMIPServer Component)

ToDo

Syntax

C#
VB.NET

public bool ReadOnly { get; set; }

Public Property ReadOnly As Boolean

Default Value

False

Remarks

ToDo

This property is not available at design time.

SessionTimeout Property (KMIPServer Component)

Specifies the default session timeout value in milliseconds.

Syntax

C#
VB.NET

public int SessionTimeout { get; set; }

Public Property SessionTimeout As Integer

Default Value

360000

Remarks

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

SocketSettings Property (KMIPServer Component)

Manages network connection settings.

Syntax

C#
VB.NET

public SocketSettings SocketSettings { get; }

Public ReadOnly Property SocketSettings As SocketSettings

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

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

StorageFileName Property (KMIPServer Component)

A path to the KMIP object database.

Syntax

C#
VB.NET

public string StorageFileName { get; set; }

Public Property StorageFileName As String

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

C#
VB.NET

public CertificateList TLSServerChain { get; }

Public Property TLSServerChain As CertificateList

Remarks

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

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

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

This property is not available at design time.

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

TLSSettings Property (KMIPServer Component)

Manages TLS layer settings.

Syntax

C#
VB.NET

public TLSSettings TLSSettings { get; }

Public ReadOnly Property TLSSettings As TLSSettings

Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

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

UseChunkedTransfer Property (KMIPServer Component)

Enables chunked transfer.

Syntax

C#
VB.NET

public bool UseChunkedTransfer { get; set; }

Public Property UseChunkedTransfer As Boolean

Default Value

False

Remarks

Use this property to enable chunked content encoding.

UseCompression Property (KMIPServer Component)

Enables or disables server-side compression.

Syntax

C#
VB.NET

public bool UseCompression { get; set; }

Public Property UseCompression As Boolean

Default Value

False

Remarks

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

UseHTTP Property (KMIPServer Component)

ToDo

Syntax

C#
VB.NET

public bool UseHTTP { get; set; }

Public Property UseHTTP As Boolean

Default Value

False

Remarks

ToDo

This property is not available at design time.

Users Property (KMIPServer Component)

A database of registered users.

Syntax

C#
VB.NET

public UserAccountList Users { get; }

Public Property Users As UserAccountList

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.

Config Method (KMIPServer Component)

This method sets or retrieves a configuration setting.

Syntax

C#
VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoAction Method (KMIPServer Component)

Performs an additional action.

Syntax

C#
VB.NET

public string DoAction(string actionID, string actionParams);

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

Remarks

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

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

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

DropClient Method (KMIPServer Component)

Terminates a client connection.

Syntax

C#
VB.NET

public void DropClient(long connectionId, bool forced);

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

Remarks

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

GetClientCert Method (KMIPServer Component)

Populates the per-connection certificate object.

Syntax

C#
VB.NET

public void GetClientCert(long connectionID);

Public Sub GetClientCert(ByVal ConnectionID As Long)

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

C#
VB.NET

public void GetClientKey(long connectionID);

Public Sub GetClientKey(ByVal ConnectionID As Long)

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

C#
VB.NET

public string GetRequestHeader(long connectionId, string headerName);

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

Remarks

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

GetResponseHeader Method (KMIPServer Component)

Returns a response header value.

Syntax

C#
VB.NET

public string GetResponseHeader(long connectionId, string headerName);

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

Remarks

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

ListClients Method (KMIPServer Component)

Enumerates the connected clients.

Syntax

C#
VB.NET

public string ListClients();

Public Function ListClients() As String

Remarks

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

PinClient Method (KMIPServer Component)

Takes a snapshot of the connection's properties.

Syntax

C#
VB.NET

public void PinClient(long connectionId);

Public Sub PinClient(ByVal ConnectionId As Long)

Remarks

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

ProcessGenericRequest Method (KMIPServer Component)

Processes a generic HTTP request.

Syntax

C#
VB.NET

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

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

Remarks

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

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

The method returns the complete HTTP response including HTTP headers.

Reset Method (KMIPServer Component)

Resets the component settings.

Syntax

C#
VB.NET

public void Reset();

Public Sub Reset()

Remarks

Reset is a generic method available in every component.

SetClientBytes Method (KMIPServer Component)

Commits a data buffer to the connection.

Syntax

C#
VB.NET

public void SetClientBytes(long connectionID, byte[] value);

Public Sub SetClientBytes(ByVal ConnectionID As Long, ByVal Value As Byte())

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

C#
VB.NET

public void SetClientCert(long connectionID);

Public Sub SetClientCert(ByVal ConnectionID As Long)

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

C#
VB.NET

public void SetClientKey(long connectionID);

Public Sub SetClientKey(ByVal ConnectionID As Long)

Remarks

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

SetResponseHeader Method (KMIPServer Component)

Sets a response header.

Syntax

C#
VB.NET

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

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

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

C#
VB.NET

public void Start();

Public Sub 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

C#
VB.NET

public void Stop();

Public Sub Stop()

Remarks

Call this method to stop the KMIP server.

Accept Event (KMIPServer Component)

Reports an incoming connection.

Syntax

C#
VB.NET

public event OnAcceptHandler OnAccept;

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

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

Public Event OnAccept As OnAcceptHandler

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

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

Remarks

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

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

ActivateObject Event (KMIPServer Component)

Notifies the application about the object activation request.

Syntax

C#
VB.NET

public event OnActivateObjectHandler OnActivateObject;

public delegate void OnActivateObjectHandler(object sender, KMIPServerActivateObjectEventArgs e);

public class KMIPServerActivateObjectEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public int OperationStatus { get; set; }
}

Public Event OnActivateObject As OnActivateObjectHandler

Public Delegate Sub OnActivateObjectHandler(sender As Object, e As KMIPServerActivateObjectEventArgs)

Public Class KMIPServerActivateObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public Property OperationStatus As Integer
End Class

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.

Add Event (KMIPServer Component)

Passes the certificate import request to the application.

Syntax

C#
VB.NET

public event OnAddHandler OnAdd;

public delegate void OnAddHandler(object sender, KMIPServerAddEventArgs e);

public class KMIPServerAddEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string Group { get; set; }
  public string CertId { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnAdd As OnAddHandler

Public Delegate Sub OnAddHandler(sender As Object, e As KMIPServerAddEventArgs)

Public Class KMIPServerAddEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public Property Group As String
  Public Property CertId As String
  Public Property OperationStatus As Integer
End Class

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.

AddKey Event (KMIPServer Component)

Expects the application to handle the key import request.

Syntax

C#
VB.NET

public event OnAddKeyHandler OnAddKey;

public delegate void OnAddKeyHandler(object sender, KMIPServerAddKeyEventArgs e);

public class KMIPServerAddKeyEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string Group { get; set; }
  public string KeyId { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnAddKey As OnAddKeyHandler

Public Delegate Sub OnAddKeyHandler(sender As Object, e As KMIPServerAddKeyEventArgs)

Public Class KMIPServerAddKeyEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public Property Group As String
  Public Property KeyId As String
  Public Property OperationStatus As Integer
End Class

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.

AfterAdd Event (KMIPServer Component)

Notifies the application about completion of the certificate import operation.

Syntax

C#
VB.NET

public event OnAfterAddHandler OnAfterAdd;

public delegate void OnAfterAddHandler(object sender, KMIPServerAfterAddEventArgs e);

public class KMIPServerAfterAddEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string Group { get; set; }
  public string CertId { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterAdd As OnAfterAddHandler

Public Delegate Sub OnAfterAddHandler(sender As Object, e As KMIPServerAfterAddEventArgs)

Public Class KMIPServerAfterAddEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public Property Group As String
  Public Property CertId As String
  Public Property OperationStatus As Integer
End Class

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.

AfterAddKey Event (KMIPServer Component)

Reports the completion of the key import procedure.

Syntax

C#
VB.NET

public event OnAfterAddKeyHandler OnAfterAddKey;

public delegate void OnAfterAddKeyHandler(object sender, KMIPServerAfterAddKeyEventArgs e);

public class KMIPServerAfterAddKeyEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string Group { get; set; }
  public string KeyId { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterAddKey As OnAfterAddKeyHandler

Public Delegate Sub OnAfterAddKeyHandler(sender As Object, e As KMIPServerAfterAddKeyEventArgs)

Public Class KMIPServerAfterAddKeyEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public Property Group As String
  Public Property KeyId As String
  Public Property OperationStatus As Integer
End Class

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.

AfterBrowse Event (KMIPServer Component)

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

Syntax

C#
VB.NET

public event OnAfterBrowseHandler OnAfterBrowse;

public delegate void OnAfterBrowseHandler(object sender, KMIPServerAfterBrowseEventArgs e);

public class KMIPServerAfterBrowseEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string ObjectId { get; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterBrowse As OnAfterBrowseHandler

Public Delegate Sub OnAfterBrowseHandler(sender As Object, e As KMIPServerAfterBrowseEventArgs)

Public Class KMIPServerAfterBrowseEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property ObjectId As String
  Public Property OperationStatus As Integer
End Class

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.

AfterDecrypt Event (KMIPServer Component)

Notifies the application about completion of the decryption call.

Syntax

C#
VB.NET

public event OnAfterDecryptHandler OnAfterDecrypt;

public delegate void OnAfterDecryptHandler(object sender, KMIPServerAfterDecryptEventArgs e);

public class KMIPServerAfterDecryptEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public byte[] DecryptedData { get; }
  public string CorrelationValue { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterDecrypt As OnAfterDecryptHandler

Public Delegate Sub OnAfterDecryptHandler(sender As Object, e As KMIPServerAfterDecryptEventArgs)

Public Class KMIPServerAfterDecryptEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public ReadOnly Property DecryptedData As Byte()
  Public Property CorrelationValue As String
  Public Property OperationStatus As Integer
End Class

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.

AfterDeriveKey Event (KMIPServer Component)

Notifies the application about completion of the key derivation request.

Syntax

C#
VB.NET

public event OnAfterDeriveKeyHandler OnAfterDeriveKey;

public delegate void OnAfterDeriveKeyHandler(object sender, KMIPServerAfterDeriveKeyEventArgs e);

public class KMIPServerAfterDeriveKeyEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string NewKeyId { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterDeriveKey As OnAfterDeriveKeyHandler

Public Delegate Sub OnAfterDeriveKeyHandler(sender As Object, e As KMIPServerAfterDeriveKeyEventArgs)

Public Class KMIPServerAfterDeriveKeyEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public Property NewKeyId As String
  Public Property OperationStatus As Integer
End Class

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.

AfterEdit Event (KMIPServer Component)

Notifies the application of completion of the object editing operation.

Syntax

C#
VB.NET

public event OnAfterEditHandler OnAfterEdit;

public delegate void OnAfterEditHandler(object sender, KMIPServerAfterEditEventArgs e);

public class KMIPServerAfterEditEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string ObjectId { get; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterEdit As OnAfterEditHandler

Public Delegate Sub OnAfterEditHandler(sender As Object, e As KMIPServerAfterEditEventArgs)

Public Class KMIPServerAfterEditEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property ObjectId As String
  Public Property OperationStatus As Integer
End Class

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.

AfterEncrypt Event (KMIPServer Component)

Notifies the application about the completion of the encryption call.

Syntax

C#
VB.NET

public event OnAfterEncryptHandler OnAfterEncrypt;

public delegate void OnAfterEncryptHandler(object sender, KMIPServerAfterEncryptEventArgs e);

public class KMIPServerAfterEncryptEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public byte[] EncryptedData { get; }
  public string CorrelationValue { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterEncrypt As OnAfterEncryptHandler

Public Delegate Sub OnAfterEncryptHandler(sender As Object, e As KMIPServerAfterEncryptEventArgs)

Public Class KMIPServerAfterEncryptEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public ReadOnly Property EncryptedData As Byte()
  Public Property CorrelationValue As String
  Public Property OperationStatus As Integer
End Class

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.

AfterGenerate Event (KMIPServer Component)

Signifies completion of certificate generation.

Syntax

C#
VB.NET

public event OnAfterGenerateHandler OnAfterGenerate;

public delegate void OnAfterGenerateHandler(object sender, KMIPServerAfterGenerateEventArgs e);

public class KMIPServerAfterGenerateEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string CertId { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterGenerate As OnAfterGenerateHandler

Public Delegate Sub OnAfterGenerateHandler(sender As Object, e As KMIPServerAfterGenerateEventArgs)

Public Class KMIPServerAfterGenerateEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public Property CertId As String
  Public Property OperationStatus As Integer
End Class

Remarks

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

AfterGenerateKey Event (KMIPServer Component)

Notifies the application of the completion of key generation procedure.

Syntax

C#
VB.NET

public event OnAfterGenerateKeyHandler OnAfterGenerateKey;

public delegate void OnAfterGenerateKeyHandler(object sender, KMIPServerAfterGenerateKeyEventArgs e);

public class KMIPServerAfterGenerateKeyEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string KeyId { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterGenerateKey As OnAfterGenerateKeyHandler

Public Delegate Sub OnAfterGenerateKeyHandler(sender As Object, e As KMIPServerAfterGenerateKeyEventArgs)

Public Class KMIPServerAfterGenerateKeyEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public Property KeyId As String
  Public Property OperationStatus As Integer
End Class

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.

AfterGenerateKeyPair Event (KMIPServer Component)

Notifies the application of the completion of keypair generation.

Syntax

C#
VB.NET

public event OnAfterGenerateKeyPairHandler OnAfterGenerateKeyPair;

public delegate void OnAfterGenerateKeyPairHandler(object sender, KMIPServerAfterGenerateKeyPairEventArgs e);

public class KMIPServerAfterGenerateKeyPairEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string PrivateKeyId { get; set; }
  public string PublicKeyId { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterGenerateKeyPair As OnAfterGenerateKeyPairHandler

Public Delegate Sub OnAfterGenerateKeyPairHandler(sender As Object, e As KMIPServerAfterGenerateKeyPairEventArgs)

Public Class KMIPServerAfterGenerateKeyPairEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public Property PrivateKeyId As String
  Public Property PublicKeyId As String
  Public Property OperationStatus As Integer
End Class

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.

AfterHash Event (KMIPServer Component)

Notifies the application about completion of the hashing call.

Syntax

C#
VB.NET

public event OnAfterHashHandler OnAfterHash;

public delegate void OnAfterHashHandler(object sender, KMIPServerAfterHashEventArgs e);

public class KMIPServerAfterHashEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public byte[] HashData { get; }
  public string CorrelationValue { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterHash As OnAfterHashHandler

Public Delegate Sub OnAfterHashHandler(sender As Object, e As KMIPServerAfterHashEventArgs)

Public Class KMIPServerAfterHashEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public ReadOnly Property HashData As Byte()
  Public Property CorrelationValue As String
  Public Property OperationStatus As Integer
End Class

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.

AfterList Event (KMIPServer Component)

Notifies the application about completion of the list command.

Syntax

C#
VB.NET

public event OnAfterListHandler OnAfterList;

public delegate void OnAfterListHandler(object sender, KMIPServerAfterListEventArgs e);

public class KMIPServerAfterListEventArgs : EventArgs {
  public long ConnectionId { get; }
  public int ObjectType { get; }
  public int ObjectStatus { get; }
  public bool OnlyFreshObjects { get; }
  public string ObjectIds { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterList As OnAfterListHandler

Public Delegate Sub OnAfterListHandler(sender As Object, e As KMIPServerAfterListEventArgs)

Public Class KMIPServerAfterListEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectType As Integer
  Public ReadOnly Property ObjectStatus As Integer
  Public ReadOnly Property OnlyFreshObjects As Boolean
  Public Property ObjectIds As String
  Public Property OperationStatus As Integer
End Class

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.

AfterObtainLease Event (KMIPServer Component)

Reports the completion of lease allocation operation.

Syntax

C#
VB.NET

public event OnAfterObtainLeaseHandler OnAfterObtainLease;

public delegate void OnAfterObtainLeaseHandler(object sender, KMIPServerAfterObtainLeaseEventArgs e);

public class KMIPServerAfterObtainLeaseEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public int LeaseTime { get; set; }
  public string LastChangeDate { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterObtainLease As OnAfterObtainLeaseHandler

Public Delegate Sub OnAfterObtainLeaseHandler(sender As Object, e As KMIPServerAfterObtainLeaseEventArgs)

Public Class KMIPServerAfterObtainLeaseEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public Property LeaseTime As Integer
  Public Property LastChangeDate As String
  Public Property OperationStatus As Integer
End Class

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.

AfterReadObject Event (KMIPServer Component)

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

Syntax

C#
VB.NET

public event OnAfterReadObjectHandler OnAfterReadObject;

public delegate void OnAfterReadObjectHandler(object sender, KMIPServerAfterReadObjectEventArgs e);

public class KMIPServerAfterReadObjectEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public int ObjectType { get; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterReadObject As OnAfterReadObjectHandler

Public Delegate Sub OnAfterReadObjectHandler(sender As Object, e As KMIPServerAfterReadObjectEventArgs)

Public Class KMIPServerAfterReadObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public ReadOnly Property ObjectType As Integer
  Public Property OperationStatus As Integer
End Class

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.

AfterReCertify Event (KMIPServer Component)

ToDo

Syntax

C#
VB.NET

public event OnAfterReCertifyHandler OnAfterReCertify;

public delegate void OnAfterReCertifyHandler(object sender, KMIPServerAfterReCertifyEventArgs e);

public class KMIPServerAfterReCertifyEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string NewCertId { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterReCertify As OnAfterReCertifyHandler

Public Delegate Sub OnAfterReCertifyHandler(sender As Object, e As KMIPServerAfterReCertifyEventArgs)

Public Class KMIPServerAfterReCertifyEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public Property NewCertId As String
  Public Property OperationStatus As Integer
End Class

Remarks

ToDo

AfterReKey Event (KMIPServer Component)

ToDo

Syntax

C#
VB.NET

public event OnAfterReKeyHandler OnAfterReKey;

public delegate void OnAfterReKeyHandler(object sender, KMIPServerAfterReKeyEventArgs e);

public class KMIPServerAfterReKeyEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string NewKeyId { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterReKey As OnAfterReKeyHandler

Public Delegate Sub OnAfterReKeyHandler(sender As Object, e As KMIPServerAfterReKeyEventArgs)

Public Class KMIPServerAfterReKeyEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public Property NewKeyId As String
  Public Property OperationStatus As Integer
End Class

Remarks

ToDo

AfterRekeyKeyPair Event (KMIPServer Component)

ToDo

Syntax

C#
VB.NET

public event OnAfterRekeyKeyPairHandler OnAfterRekeyKeyPair;

public delegate void OnAfterRekeyKeyPairHandler(object sender, KMIPServerAfterRekeyKeyPairEventArgs e);

public class KMIPServerAfterRekeyKeyPairEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string NewPrivateKeyId { get; set; }
  public string NewPublicKeyId { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterRekeyKeyPair As OnAfterRekeyKeyPairHandler

Public Delegate Sub OnAfterRekeyKeyPairHandler(sender As Object, e As KMIPServerAfterRekeyKeyPairEventArgs)

Public Class KMIPServerAfterRekeyKeyPairEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public Property NewPrivateKeyId As String
  Public Property NewPublicKeyId As String
  Public Property OperationStatus As Integer
End Class

Remarks

ToDo

AfterRemoveObject Event (KMIPServer Component)

Notifies the application about completion of the object removal request.

Syntax

C#
VB.NET

public event OnAfterRemoveObjectHandler OnAfterRemoveObject;

public delegate void OnAfterRemoveObjectHandler(object sender, KMIPServerAfterRemoveObjectEventArgs e);

public class KMIPServerAfterRemoveObjectEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterRemoveObject As OnAfterRemoveObjectHandler

Public Delegate Sub OnAfterRemoveObjectHandler(sender As Object, e As KMIPServerAfterRemoveObjectEventArgs)

Public Class KMIPServerAfterRemoveObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public Property OperationStatus As Integer
End Class

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.

AfterSign Event (KMIPServer Component)

Notifies the application of completion of a signing operation.

Syntax

C#
VB.NET

public event OnAfterSignHandler OnAfterSign;

public delegate void OnAfterSignHandler(object sender, KMIPServerAfterSignEventArgs e);

public class KMIPServerAfterSignEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public bool InputIsHash { get; }
  public byte[] SignatureData { get; }
  public string CorrelationValue { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterSign As OnAfterSignHandler

Public Delegate Sub OnAfterSignHandler(sender As Object, e As KMIPServerAfterSignEventArgs)

Public Class KMIPServerAfterSignEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public ReadOnly Property InputIsHash As Boolean
  Public ReadOnly Property SignatureData As Byte()
  Public Property CorrelationValue As String
  Public Property OperationStatus As Integer
End Class

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.

AfterVerify Event (KMIPServer Component)

Notifies the application about completion of the Verify operation.

Syntax

C#
VB.NET

public event OnAfterVerifyHandler OnAfterVerify;

public delegate void OnAfterVerifyHandler(object sender, KMIPServerAfterVerifyEventArgs e);

public class KMIPServerAfterVerifyEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public bool InputIsHash { get; }
  public int ValidationResult { get; set; }
  public string CorrelationValue { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterVerify As OnAfterVerifyHandler

Public Delegate Sub OnAfterVerifyHandler(sender As Object, e As KMIPServerAfterVerifyEventArgs)

Public Class KMIPServerAfterVerifyEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public ReadOnly Property InputIsHash As Boolean
  Public Property ValidationResult As Integer
  Public Property CorrelationValue As String
  Public Property OperationStatus As Integer
End Class

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.

AfterVerifyHash Event (KMIPServer Component)

Notifies the application about completion of the hash verification.

Syntax

C#
VB.NET

public event OnAfterVerifyHashHandler OnAfterVerifyHash;

public delegate void OnAfterVerifyHashHandler(object sender, KMIPServerAfterVerifyHashEventArgs e);

public class KMIPServerAfterVerifyHashEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public bool IsValid { get; set; }
  public string CorrelationValue { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterVerifyHash As OnAfterVerifyHashHandler

Public Delegate Sub OnAfterVerifyHashHandler(sender As Object, e As KMIPServerAfterVerifyHashEventArgs)

Public Class KMIPServerAfterVerifyHashEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public Property IsValid As Boolean
  Public Property CorrelationValue As String
  Public Property OperationStatus As Integer
End Class

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.

ArchiveObject Event (KMIPServer Component)

Notifies the application about the received object archival request.

Syntax

C#
VB.NET

public event OnArchiveObjectHandler OnArchiveObject;

public delegate void OnArchiveObjectHandler(object sender, KMIPServerArchiveObjectEventArgs e);

public class KMIPServerArchiveObjectEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public int OperationStatus { get; set; }
}

Public Event OnArchiveObject As OnArchiveObjectHandler

Public Delegate Sub OnArchiveObjectHandler(sender As Object, e As KMIPServerArchiveObjectEventArgs)

Public Class KMIPServerArchiveObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public Property OperationStatus As Integer
End Class

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.

AuthAttempt Event (KMIPServer Component)

Fires when a connected client makes an authentication attempt.

Syntax

C#
VB.NET

public event OnAuthAttemptHandler OnAuthAttempt;

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

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

Public Event OnAuthAttempt As OnAuthAttemptHandler

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

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

Remarks

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

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

BeforeAdd Event (KMIPServer Component)

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

Syntax

C#
VB.NET

public event OnBeforeAddHandler OnBeforeAdd;

public delegate void OnBeforeAddHandler(object sender, KMIPServerBeforeAddEventArgs e);

public class KMIPServerBeforeAddEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string Group { get; set; }
  public int Action { get; set; }
}

Public Event OnBeforeAdd As OnBeforeAddHandler

Public Delegate Sub OnBeforeAddHandler(sender As Object, e As KMIPServerBeforeAddEventArgs)

Public Class KMIPServerBeforeAddEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public Property Group As String
  Public Property Action As Integer
End Class

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

C#
VB.NET

public event OnBeforeAddKeyHandler OnBeforeAddKey;

public delegate void OnBeforeAddKeyHandler(object sender, KMIPServerBeforeAddKeyEventArgs e);

public class KMIPServerBeforeAddKeyEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string Group { get; set; }
  public int Action { get; set; }
}

Public Event OnBeforeAddKey As OnBeforeAddKeyHandler

Public Delegate Sub OnBeforeAddKeyHandler(sender As Object, e As KMIPServerBeforeAddKeyEventArgs)

Public Class KMIPServerBeforeAddKeyEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public Property Group As String
  Public Property Action As Integer
End Class

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

C#
VB.NET

public event OnBeforeBrowseHandler OnBeforeBrowse;

public delegate void OnBeforeBrowseHandler(object sender, KMIPServerBeforeBrowseEventArgs e);

public class KMIPServerBeforeBrowseEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string ObjectId { get; }
  public int Action { get; set; }
}

Public Event OnBeforeBrowse As OnBeforeBrowseHandler

Public Delegate Sub OnBeforeBrowseHandler(sender As Object, e As KMIPServerBeforeBrowseEventArgs)

Public Class KMIPServerBeforeBrowseEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property ObjectId As String
  Public Property Action As Integer
End Class

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

C#
VB.NET

public event OnBeforeDecryptHandler OnBeforeDecrypt;

public delegate void OnBeforeDecryptHandler(object sender, KMIPServerBeforeDecryptEventArgs e);

public class KMIPServerBeforeDecryptEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public string CorrelationValue { get; set; }
  public int Action { get; set; }
}

Public Event OnBeforeDecrypt As OnBeforeDecryptHandler

Public Delegate Sub OnBeforeDecryptHandler(sender As Object, e As KMIPServerBeforeDecryptEventArgs)

Public Class KMIPServerBeforeDecryptEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public Property CorrelationValue As String
  Public Property Action As Integer
End Class

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

C#
VB.NET

public event OnBeforeDeriveKeyHandler OnBeforeDeriveKey;

public delegate void OnBeforeDeriveKeyHandler(object sender, KMIPServerBeforeDeriveKeyEventArgs e);

public class KMIPServerBeforeDeriveKeyEventArgs : EventArgs {
  public long ConnectionId { get; }
  public int ObjectType { get; }
  public string ObjectIds { get; }
  public string DerivationMethod { get; }
  public int Action { get; set; }
}

Public Event OnBeforeDeriveKey As OnBeforeDeriveKeyHandler

Public Delegate Sub OnBeforeDeriveKeyHandler(sender As Object, e As KMIPServerBeforeDeriveKeyEventArgs)

Public Class KMIPServerBeforeDeriveKeyEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectType As Integer
  Public ReadOnly Property ObjectIds As String
  Public ReadOnly Property DerivationMethod As String
  Public Property Action As Integer
End Class

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

C#
VB.NET

public event OnBeforeEditHandler OnBeforeEdit;

public delegate void OnBeforeEditHandler(object sender, KMIPServerBeforeEditEventArgs e);

public class KMIPServerBeforeEditEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string ObjectId { get; }
  public int Action { get; set; }
}

Public Event OnBeforeEdit As OnBeforeEditHandler

Public Delegate Sub OnBeforeEditHandler(sender As Object, e As KMIPServerBeforeEditEventArgs)

Public Class KMIPServerBeforeEditEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property ObjectId As String
  Public Property Action As Integer
End Class

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

C#
VB.NET

public event OnBeforeEncryptHandler OnBeforeEncrypt;

public delegate void OnBeforeEncryptHandler(object sender, KMIPServerBeforeEncryptEventArgs e);

public class KMIPServerBeforeEncryptEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public string CorrelationValue { get; set; }
  public int Action { get; set; }
}

Public Event OnBeforeEncrypt As OnBeforeEncryptHandler

Public Delegate Sub OnBeforeEncryptHandler(sender As Object, e As KMIPServerBeforeEncryptEventArgs)

Public Class KMIPServerBeforeEncryptEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public Property CorrelationValue As String
  Public Property Action As Integer
End Class

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

C#
VB.NET

public event OnBeforeGenerateHandler OnBeforeGenerate;

public delegate void OnBeforeGenerateHandler(object sender, KMIPServerBeforeGenerateEventArgs e);

public class KMIPServerBeforeGenerateEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string PublicKeyId { get; }
  public int Action { get; set; }
}

Public Event OnBeforeGenerate As OnBeforeGenerateHandler

Public Delegate Sub OnBeforeGenerateHandler(sender As Object, e As KMIPServerBeforeGenerateEventArgs)

Public Class KMIPServerBeforeGenerateEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property PublicKeyId As String
  Public Property Action As Integer
End Class

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

C#
VB.NET

public event OnBeforeGenerateKeyHandler OnBeforeGenerateKey;

public delegate void OnBeforeGenerateKeyHandler(object sender, KMIPServerBeforeGenerateKeyEventArgs e);

public class KMIPServerBeforeGenerateKeyEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string KeyAlgorithm { get; set; }
  public int KeyLength { get; set; }
  public int Action { get; set; }
}

Public Event OnBeforeGenerateKey As OnBeforeGenerateKeyHandler

Public Delegate Sub OnBeforeGenerateKeyHandler(sender As Object, e As KMIPServerBeforeGenerateKeyEventArgs)

Public Class KMIPServerBeforeGenerateKeyEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public Property KeyAlgorithm As String
  Public Property KeyLength As Integer
  Public Property Action As Integer
End Class

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

C#
VB.NET

public event OnBeforeGenerateKeyPairHandler OnBeforeGenerateKeyPair;

public delegate void OnBeforeGenerateKeyPairHandler(object sender, KMIPServerBeforeGenerateKeyPairEventArgs e);

public class KMIPServerBeforeGenerateKeyPairEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string KeyAlgorithm { get; set; }
  public int KeyLength { get; set; }
  public string Scheme { get; set; }
  public string SchemeParams { get; set; }
  public int Action { get; set; }
}

Public Event OnBeforeGenerateKeyPair As OnBeforeGenerateKeyPairHandler

Public Delegate Sub OnBeforeGenerateKeyPairHandler(sender As Object, e As KMIPServerBeforeGenerateKeyPairEventArgs)

Public Class KMIPServerBeforeGenerateKeyPairEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public Property KeyAlgorithm As String
  Public Property KeyLength As Integer
  Public Property Scheme As String
  Public Property SchemeParams As String
  Public Property Action As Integer
End Class

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

C#
VB.NET

public event OnBeforeHashHandler OnBeforeHash;

public delegate void OnBeforeHashHandler(object sender, KMIPServerBeforeHashEventArgs e);

public class KMIPServerBeforeHashEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public string HashAlgorithm { get; }
  public string CorrelationValue { get; set; }
  public int Action { get; set; }
}

Public Event OnBeforeHash As OnBeforeHashHandler

Public Delegate Sub OnBeforeHashHandler(sender As Object, e As KMIPServerBeforeHashEventArgs)

Public Class KMIPServerBeforeHashEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public ReadOnly Property HashAlgorithm As String
  Public Property CorrelationValue As String
  Public Property Action As Integer
End Class

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

C#
VB.NET

public event OnBeforeListHandler OnBeforeList;

public delegate void OnBeforeListHandler(object sender, KMIPServerBeforeListEventArgs e);

public class KMIPServerBeforeListEventArgs : EventArgs {
  public long ConnectionId { get; }
  public int ObjectType { get; }
  public int ObjectStatus { get; }
  public bool OnlyFreshObjects { get; }
  public int Action { get; set; }
}

Public Event OnBeforeList As OnBeforeListHandler

Public Delegate Sub OnBeforeListHandler(sender As Object, e As KMIPServerBeforeListEventArgs)

Public Class KMIPServerBeforeListEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectType As Integer
  Public ReadOnly Property ObjectStatus As Integer
  Public ReadOnly Property OnlyFreshObjects As Boolean
  Public Property Action As Integer
End Class

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

C#
VB.NET

public event OnBeforeObtainLeaseHandler OnBeforeObtainLease;

public delegate void OnBeforeObtainLeaseHandler(object sender, KMIPServerBeforeObtainLeaseEventArgs e);

public class KMIPServerBeforeObtainLeaseEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public int Action { get; set; }
}

Public Event OnBeforeObtainLease As OnBeforeObtainLeaseHandler

Public Delegate Sub OnBeforeObtainLeaseHandler(sender As Object, e As KMIPServerBeforeObtainLeaseEventArgs)

Public Class KMIPServerBeforeObtainLeaseEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public Property Action As Integer
End Class

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

C#
VB.NET

public event OnBeforeReadObjectHandler OnBeforeReadObject;

public delegate void OnBeforeReadObjectHandler(object sender, KMIPServerBeforeReadObjectEventArgs e);

public class KMIPServerBeforeReadObjectEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public int Action { get; set; }
}

Public Event OnBeforeReadObject As OnBeforeReadObjectHandler

Public Delegate Sub OnBeforeReadObjectHandler(sender As Object, e As KMIPServerBeforeReadObjectEventArgs)

Public Class KMIPServerBeforeReadObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public Property Action As Integer
End Class

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

C#
VB.NET

public event OnBeforeReCertifyHandler OnBeforeReCertify;

public delegate void OnBeforeReCertifyHandler(object sender, KMIPServerBeforeReCertifyEventArgs e);

public class KMIPServerBeforeReCertifyEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string OldCertId { get; }
  public int Action { get; set; }
}

Public Event OnBeforeReCertify As OnBeforeReCertifyHandler

Public Delegate Sub OnBeforeReCertifyHandler(sender As Object, e As KMIPServerBeforeReCertifyEventArgs)

Public Class KMIPServerBeforeReCertifyEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property OldCertId As String
  Public Property Action As Integer
End Class

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

C#
VB.NET

public event OnBeforeReKeyHandler OnBeforeReKey;

public delegate void OnBeforeReKeyHandler(object sender, KMIPServerBeforeReKeyEventArgs e);

public class KMIPServerBeforeReKeyEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string OldKeyId { get; }
  public int Action { get; set; }
}

Public Event OnBeforeReKey As OnBeforeReKeyHandler

Public Delegate Sub OnBeforeReKeyHandler(sender As Object, e As KMIPServerBeforeReKeyEventArgs)

Public Class KMIPServerBeforeReKeyEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property OldKeyId As String
  Public Property Action As Integer
End Class

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

C#
VB.NET

public event OnBeforeRekeyKeyPairHandler OnBeforeRekeyKeyPair;

public delegate void OnBeforeRekeyKeyPairHandler(object sender, KMIPServerBeforeRekeyKeyPairEventArgs e);

public class KMIPServerBeforeRekeyKeyPairEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string OldPrivateKeyId { get; }
  public int Action { get; set; }
}

Public Event OnBeforeRekeyKeyPair As OnBeforeRekeyKeyPairHandler

Public Delegate Sub OnBeforeRekeyKeyPairHandler(sender As Object, e As KMIPServerBeforeRekeyKeyPairEventArgs)

Public Class KMIPServerBeforeRekeyKeyPairEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property OldPrivateKeyId As String
  Public Property Action As Integer
End Class

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)

TBD

Syntax

C#
VB.NET

public event OnBeforeRemoveObjectHandler OnBeforeRemoveObject;

public delegate void OnBeforeRemoveObjectHandler(object sender, KMIPServerBeforeRemoveObjectEventArgs e);

public class KMIPServerBeforeRemoveObjectEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public int Action { get; set; }
}

Public Event OnBeforeRemoveObject As OnBeforeRemoveObjectHandler

Public Delegate Sub OnBeforeRemoveObjectHandler(sender As Object, e As KMIPServerBeforeRemoveObjectEventArgs)

Public Class KMIPServerBeforeRemoveObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public Property Action As Integer
End Class

Remarks

TBD

BeforeSign Event (KMIPServer Component)

Notifies the application about the initiation of a signing operation.

Syntax

C#
VB.NET

public event OnBeforeSignHandler OnBeforeSign;

public delegate void OnBeforeSignHandler(object sender, KMIPServerBeforeSignEventArgs e);

public class KMIPServerBeforeSignEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public string HashAlgorithm { get; }
  public bool InputIsHash { get; }
  public string CorrelationValue { get; set; }
  public int Action { get; set; }
}

Public Event OnBeforeSign As OnBeforeSignHandler

Public Delegate Sub OnBeforeSignHandler(sender As Object, e As KMIPServerBeforeSignEventArgs)

Public Class KMIPServerBeforeSignEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public ReadOnly Property HashAlgorithm As String
  Public ReadOnly Property InputIsHash As Boolean
  Public Property CorrelationValue As String
  Public Property Action As Integer
End Class

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

C#
VB.NET

public event OnBeforeVerifyHandler OnBeforeVerify;

public delegate void OnBeforeVerifyHandler(object sender, KMIPServerBeforeVerifyEventArgs e);

public class KMIPServerBeforeVerifyEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public string HashAlgorithm { get; }
  public bool InputIsHash { get; }
  public string CorrelationValue { get; set; }
  public int Action { get; set; }
}

Public Event OnBeforeVerify As OnBeforeVerifyHandler

Public Delegate Sub OnBeforeVerifyHandler(sender As Object, e As KMIPServerBeforeVerifyEventArgs)

Public Class KMIPServerBeforeVerifyEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public ReadOnly Property HashAlgorithm As String
  Public ReadOnly Property InputIsHash As Boolean
  Public Property CorrelationValue As String
  Public Property Action As Integer
End Class

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

C#
VB.NET

public event OnBeforeVerifyHashHandler OnBeforeVerifyHash;

public delegate void OnBeforeVerifyHashHandler(object sender, KMIPServerBeforeVerifyHashEventArgs e);

public class KMIPServerBeforeVerifyHashEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public string HashAlgorithm { get; }
  public string CorrelationValue { get; set; }
  public int Action { get; set; }
}

Public Event OnBeforeVerifyHash As OnBeforeVerifyHashHandler

Public Delegate Sub OnBeforeVerifyHashHandler(sender As Object, e As KMIPServerBeforeVerifyHashEventArgs)

Public Class KMIPServerBeforeVerifyHashEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public ReadOnly Property HashAlgorithm As String
  Public Property CorrelationValue As String
  Public Property Action As Integer
End Class

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

C#
VB.NET

public event OnCancelHandler OnCancel;

public delegate void OnCancelHandler(object sender, KMIPServerCancelEventArgs e);

public class KMIPServerCancelEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string AsyncCorrelationValue { get; }
  public int CancellationResult { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnCancel As OnCancelHandler

Public Delegate Sub OnCancelHandler(sender As Object, e As KMIPServerCancelEventArgs)

Public Class KMIPServerCancelEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property AsyncCorrelationValue As String
  Public Property CancellationResult As Integer
  Public Property OperationStatus As Integer
End Class

Remarks

The component uses this event to notify the application about the cancellation request received. TBD

Check Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnCheckHandler OnCheck;

public delegate void OnCheckHandler(object sender, KMIPServerCheckEventArgs e);

public class KMIPServerCheckEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public long UsageLimitsCount { get; set; }
  public int CryptographicUsageMask { get; set; }
  public int LeaseTime { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnCheck As OnCheckHandler

Public Delegate Sub OnCheckHandler(sender As Object, e As KMIPServerCheckEventArgs)

Public Class KMIPServerCheckEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public Property UsageLimitsCount As Long
  Public Property CryptographicUsageMask As Integer
  Public Property LeaseTime As Integer
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

Connect Event (KMIPServer Component)

Reports an accepted connection.

Syntax

C#
VB.NET

public event OnConnectHandler OnConnect;

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

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

Public Event OnConnect As OnConnectHandler

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

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

Remarks

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

Decrypt Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnDecryptHandler OnDecrypt;

public delegate void OnDecryptHandler(object sender, KMIPServerDecryptEventArgs e);

public class KMIPServerDecryptEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public byte[] Data { get; }
  public string IV { get; }
  public bool InitIndicator { get; }
  public bool FinalIndicator { get; }
  public int BlockCipherMode { get; }
  public int TagLength { get; }
  public int PaddingMethod { get; }
  public string CorrelationValue { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnDecrypt As OnDecryptHandler

Public Delegate Sub OnDecryptHandler(sender As Object, e As KMIPServerDecryptEventArgs)

Public Class KMIPServerDecryptEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public ReadOnly Property Data As Byte()
  Public ReadOnly Property IV As String
  Public ReadOnly Property InitIndicator As Boolean
  Public ReadOnly Property FinalIndicator As Boolean
  Public ReadOnly Property BlockCipherMode As Integer
  Public ReadOnly Property TagLength As Integer
  Public ReadOnly Property PaddingMethod As Integer
  Public Property CorrelationValue As String
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

DeleteAttribute Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnDeleteAttributeHandler OnDeleteAttribute;

public delegate void OnDeleteAttributeHandler(object sender, KMIPServerDeleteAttributeEventArgs e);

public class KMIPServerDeleteAttributeEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public string AttributeName { get; }
  public string AttributeValue { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnDeleteAttribute As OnDeleteAttributeHandler

Public Delegate Sub OnDeleteAttributeHandler(sender As Object, e As KMIPServerDeleteAttributeEventArgs)

Public Class KMIPServerDeleteAttributeEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public ReadOnly Property AttributeName As String
  Public Property AttributeValue As String
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

DeriveKey Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnDeriveKeyHandler OnDeriveKey;

public delegate void OnDeriveKeyHandler(object sender, KMIPServerDeriveKeyEventArgs e);

public class KMIPServerDeriveKeyEventArgs : EventArgs {
  public long ConnectionId { get; }
  public int ObjectType { get; }
  public string ObjectIds { get; }
  public string DerivationMethod { get; }
  public byte[] InitializationVector { get; }
  public byte[] DerivationData { get; }
  public string NewKeyId { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnDeriveKey As OnDeriveKeyHandler

Public Delegate Sub OnDeriveKeyHandler(sender As Object, e As KMIPServerDeriveKeyEventArgs)

Public Class KMIPServerDeriveKeyEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectType As Integer
  Public ReadOnly Property ObjectIds As String
  Public ReadOnly Property DerivationMethod As String
  Public ReadOnly Property InitializationVector As Byte()
  Public ReadOnly Property DerivationData As Byte()
  Public Property NewKeyId As String
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

Disconnect Event (KMIPServer Component)

Fires to report a disconnected client.

Syntax

C#
VB.NET

public event OnDisconnectHandler OnDisconnect;

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

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

Public Event OnDisconnect As OnDisconnectHandler

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

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

Remarks

The component fires this event when a connected client disconnects.

Encrypt Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnEncryptHandler OnEncrypt;

public delegate void OnEncryptHandler(object sender, KMIPServerEncryptEventArgs e);

public class KMIPServerEncryptEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public byte[] Data { get; }
  public bool InitIndicator { get; }
  public bool FinalIndicator { get; }
  public int BlockCipherMode { get; }
  public int TagLength { get; }
  public int PaddingMethod { get; }
  public bool RandomIV { get; }
  public string IV { get; set; }
  public string CorrelationValue { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnEncrypt As OnEncryptHandler

Public Delegate Sub OnEncryptHandler(sender As Object, e As KMIPServerEncryptEventArgs)

Public Class KMIPServerEncryptEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public ReadOnly Property Data As Byte()
  Public ReadOnly Property InitIndicator As Boolean
  Public ReadOnly Property FinalIndicator As Boolean
  Public ReadOnly Property BlockCipherMode As Integer
  Public ReadOnly Property TagLength As Integer
  Public ReadOnly Property PaddingMethod As Integer
  Public ReadOnly Property RandomIV As Boolean
  Public Property IV As String
  Public Property CorrelationValue As String
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

Error Event (KMIPServer Component)

Information about errors during data delivery.

Syntax

C#
VB.NET

public event OnErrorHandler OnError;

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

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

Public Event OnError As OnErrorHandler

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

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

Remarks

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

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the HTTPS section.

ExternalSign Event (KMIPServer Component)

Handles remote or external signing initiated by the server protocol.

Syntax

C#
VB.NET

public event OnExternalSignHandler OnExternalSign;

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

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

Public Event OnExternalSign As OnExternalSignHandler

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

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

Remarks

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

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

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

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

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

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

Generate Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnGenerateHandler OnGenerate;

public delegate void OnGenerateHandler(object sender, KMIPServerGenerateEventArgs e);

public class KMIPServerGenerateEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string PublicKeyId { get; }
  public string CertId { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnGenerate As OnGenerateHandler

Public Delegate Sub OnGenerateHandler(sender As Object, e As KMIPServerGenerateEventArgs)

Public Class KMIPServerGenerateEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property PublicKeyId As String
  Public Property CertId As String
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

GenerateKey Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnGenerateKeyHandler OnGenerateKey;

public delegate void OnGenerateKeyHandler(object sender, KMIPServerGenerateKeyEventArgs e);

public class KMIPServerGenerateKeyEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string KeyAlgorithm { get; }
  public int KeyLength { get; }
  public string Group { get; }
  public string KeyId { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnGenerateKey As OnGenerateKeyHandler

Public Delegate Sub OnGenerateKeyHandler(sender As Object, e As KMIPServerGenerateKeyEventArgs)

Public Class KMIPServerGenerateKeyEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property KeyAlgorithm As String
  Public ReadOnly Property KeyLength As Integer
  Public ReadOnly Property Group As String
  Public Property KeyId As String
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

GenerateKeyPair Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnGenerateKeyPairHandler OnGenerateKeyPair;

public delegate void OnGenerateKeyPairHandler(object sender, KMIPServerGenerateKeyPairEventArgs e);

public class KMIPServerGenerateKeyPairEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string KeyAlgorithm { get; }
  public int KeyLength { get; }
  public string Scheme { get; }
  public string SchemeParams { get; }
  public string Group { get; }
  public string PrivateKeyId { get; set; }
  public string PublicKeyId { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnGenerateKeyPair As OnGenerateKeyPairHandler

Public Delegate Sub OnGenerateKeyPairHandler(sender As Object, e As KMIPServerGenerateKeyPairEventArgs)

Public Class KMIPServerGenerateKeyPairEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property KeyAlgorithm As String
  Public ReadOnly Property KeyLength As Integer
  Public ReadOnly Property Scheme As String
  Public ReadOnly Property SchemeParams As String
  Public ReadOnly Property Group As String
  Public Property PrivateKeyId As String
  Public Property PublicKeyId As String
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

GetUsageAllocation Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnGetUsageAllocationHandler OnGetUsageAllocation;

public delegate void OnGetUsageAllocationHandler(object sender, KMIPServerGetUsageAllocationEventArgs e);

public class KMIPServerGetUsageAllocationEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public int UsageLimitsCount { get; }
  public int OperationStatus { get; set; }
}

Public Event OnGetUsageAllocation As OnGetUsageAllocationHandler

Public Delegate Sub OnGetUsageAllocationHandler(sender As Object, e As KMIPServerGetUsageAllocationEventArgs)

Public Class KMIPServerGetUsageAllocationEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public ReadOnly Property UsageLimitsCount As Integer
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

Hash Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnHashHandler OnHash;

public delegate void OnHashHandler(object sender, KMIPServerHashEventArgs e);

public class KMIPServerHashEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public string HashAlgorithm { get; }
  public byte[] Data { get; }
  public bool InitIndicator { get; }
  public bool FinalIndicator { get; }
  public string CorrelationValue { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnHash As OnHashHandler

Public Delegate Sub OnHashHandler(sender As Object, e As KMIPServerHashEventArgs)

Public Class KMIPServerHashEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public ReadOnly Property HashAlgorithm As String
  Public ReadOnly Property Data As Byte()
  Public ReadOnly Property InitIndicator As Boolean
  Public ReadOnly Property FinalIndicator As Boolean
  Public Property CorrelationValue As String
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

HeadersPrepared Event (KMIPServer Component)

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

Syntax

C#
VB.NET

public event OnHeadersPreparedHandler OnHeadersPrepared;

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

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

Public Event OnHeadersPrepared As OnHeadersPreparedHandler

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

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

Remarks

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

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

KMIPAuthAttempt Event (KMIPServer Component)

Fires when a connected client makes an authentication attempt.

Syntax

C#
VB.NET

public event OnKMIPAuthAttemptHandler OnKMIPAuthAttempt;

public delegate void OnKMIPAuthAttemptHandler(object sender, KMIPServerKMIPAuthAttemptEventArgs e);

public class KMIPServerKMIPAuthAttemptEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string Username { get; }
  public string Password { get; }
  public bool Accept { get; set; }
}

Public Event OnKMIPAuthAttempt As OnKMIPAuthAttemptHandler

Public Delegate Sub OnKMIPAuthAttemptHandler(sender As Object, e As KMIPServerKMIPAuthAttemptEventArgs)

Public Class KMIPServerKMIPAuthAttemptEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property Username As String
  Public ReadOnly Property Password As String
  Public Property Accept As Boolean
End Class

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)

TBD

Syntax

C#
VB.NET

public event OnListHandler OnList;

public delegate void OnListHandler(object sender, KMIPServerListEventArgs e);

public class KMIPServerListEventArgs : EventArgs {
  public long ConnectionId { get; }
  public int ObjectType { get; }
  public int ObjectStatus { get; }
  public bool OnlyFreshObject { get; }
  public int OffsetItems { get; }
  public int MaximumItems { get; }
  public string ObjectIds { get; set; }
  public int LocatedItems { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnList As OnListHandler

Public Delegate Sub OnListHandler(sender As Object, e As KMIPServerListEventArgs)

Public Class KMIPServerListEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectType As Integer
  Public ReadOnly Property ObjectStatus As Integer
  Public ReadOnly Property OnlyFreshObject As Boolean
  Public ReadOnly Property OffsetItems As Integer
  Public ReadOnly Property MaximumItems As Integer
  Public Property ObjectIds As String
  Public Property LocatedItems As Integer
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

ListAttributes Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnListAttributesHandler OnListAttributes;

public delegate void OnListAttributesHandler(object sender, KMIPServerListAttributesEventArgs e);

public class KMIPServerListAttributesEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public string AttributeNames { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnListAttributes As OnListAttributesHandler

Public Delegate Sub OnListAttributesHandler(sender As Object, e As KMIPServerListAttributesEventArgs)

Public Class KMIPServerListAttributesEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public Property AttributeNames As String
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

Notification Event (KMIPServer Component)

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

Syntax

C#
VB.NET

public event OnNotificationHandler OnNotification;

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

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

Public Event OnNotification As OnNotificationHandler

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

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

Remarks

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

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

ObtainLease Event (KMIPServer Component)

Lets the application handle the lease request.

Syntax

C#
VB.NET

public event OnObtainLeaseHandler OnObtainLease;

public delegate void OnObtainLeaseHandler(object sender, KMIPServerObtainLeaseEventArgs e);

public class KMIPServerObtainLeaseEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public int LeaseTime { get; set; }
  public string LastChangeDate { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnObtainLease As OnObtainLeaseHandler

Public Delegate Sub OnObtainLeaseHandler(sender As Object, e As KMIPServerObtainLeaseEventArgs)

Public Class KMIPServerObtainLeaseEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public Property LeaseTime As Integer
  Public Property LastChangeDate As String
  Public Property OperationStatus As Integer
End Class

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.

OperationAttempt Event (KMIPServer Component)

Fires when a request is received from the client.

Syntax

C#
VB.NET

public event OnOperationAttemptHandler OnOperationAttempt;

public delegate void OnOperationAttemptHandler(object sender, KMIPServerOperationAttemptEventArgs e);

public class KMIPServerOperationAttemptEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string Operation { get; }
  public string Username { get; }
  public bool Reject { get; set; }
}

Public Event OnOperationAttempt As OnOperationAttemptHandler

Public Delegate Sub OnOperationAttemptHandler(sender As Object, e As KMIPServerOperationAttemptEventArgs)

Public Class KMIPServerOperationAttemptEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property Operation As String
  Public ReadOnly Property Username As String
  Public Property Reject As Boolean
End Class

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)

TBD

Syntax

C#
VB.NET

public event OnPollHandler OnPoll;

public delegate void OnPollHandler(object sender, KMIPServerPollEventArgs e);

public class KMIPServerPollEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string AsyncCorrelationValue { get; }
  public int OperationStatus { get; set; }
}

Public Event OnPoll As OnPollHandler

Public Delegate Sub OnPollHandler(sender As Object, e As KMIPServerPollEventArgs)

Public Class KMIPServerPollEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property AsyncCorrelationValue As String
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

ReadAttribute Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnReadAttributeHandler OnReadAttribute;

public delegate void OnReadAttributeHandler(object sender, KMIPServerReadAttributeEventArgs e);

public class KMIPServerReadAttributeEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public string AttributeName { get; }
  public string AttributeValue { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnReadAttribute As OnReadAttributeHandler

Public Delegate Sub OnReadAttributeHandler(sender As Object, e As KMIPServerReadAttributeEventArgs)

Public Class KMIPServerReadAttributeEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public ReadOnly Property AttributeName As String
  Public Property AttributeValue As String
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

ReadObject Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnReadObjectHandler OnReadObject;

public delegate void OnReadObjectHandler(object sender, KMIPServerReadObjectEventArgs e);

public class KMIPServerReadObjectEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public int ObjectType { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnReadObject As OnReadObjectHandler

Public Delegate Sub OnReadObjectHandler(sender As Object, e As KMIPServerReadObjectEventArgs)

Public Class KMIPServerReadObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public Property ObjectType As Integer
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

ReCertify Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnReCertifyHandler OnReCertify;

public delegate void OnReCertifyHandler(object sender, KMIPServerReCertifyEventArgs e);

public class KMIPServerReCertifyEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string OldCertId { get; }
  public int Offset { get; }
  public string Group { get; }
  public string NewCertId { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnReCertify As OnReCertifyHandler

Public Delegate Sub OnReCertifyHandler(sender As Object, e As KMIPServerReCertifyEventArgs)

Public Class KMIPServerReCertifyEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property OldCertId As String
  Public ReadOnly Property Offset As Integer
  Public ReadOnly Property Group As String
  Public Property NewCertId As String
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

RecoverObject Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnRecoverObjectHandler OnRecoverObject;

public delegate void OnRecoverObjectHandler(object sender, KMIPServerRecoverObjectEventArgs e);

public class KMIPServerRecoverObjectEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public int OperationStatus { get; set; }
}

Public Event OnRecoverObject As OnRecoverObjectHandler

Public Delegate Sub OnRecoverObjectHandler(sender As Object, e As KMIPServerRecoverObjectEventArgs)

Public Class KMIPServerRecoverObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

ReKey Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnReKeyHandler OnReKey;

public delegate void OnReKeyHandler(object sender, KMIPServerReKeyEventArgs e);

public class KMIPServerReKeyEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string OldKeyId { get; }
  public int Offset { get; }
  public string Group { get; }
  public string NewKeyId { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnReKey As OnReKeyHandler

Public Delegate Sub OnReKeyHandler(sender As Object, e As KMIPServerReKeyEventArgs)

Public Class KMIPServerReKeyEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property OldKeyId As String
  Public ReadOnly Property Offset As Integer
  Public ReadOnly Property Group As String
  Public Property NewKeyId As String
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

RekeyKeyPair Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnRekeyKeyPairHandler OnRekeyKeyPair;

public delegate void OnRekeyKeyPairHandler(object sender, KMIPServerRekeyKeyPairEventArgs e);

public class KMIPServerRekeyKeyPairEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string OldPrivateKeyId { get; }
  public int Offset { get; }
  public string Group { get; }
  public string NewPrivateKeyId { get; set; }
  public string NewPublicKeyId { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnRekeyKeyPair As OnRekeyKeyPairHandler

Public Delegate Sub OnRekeyKeyPairHandler(sender As Object, e As KMIPServerRekeyKeyPairEventArgs)

Public Class KMIPServerRekeyKeyPairEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property OldPrivateKeyId As String
  Public ReadOnly Property Offset As Integer
  Public ReadOnly Property Group As String
  Public Property NewPrivateKeyId As String
  Public Property NewPublicKeyId As String
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

RemoveObject Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnRemoveObjectHandler OnRemoveObject;

public delegate void OnRemoveObjectHandler(object sender, KMIPServerRemoveObjectEventArgs e);

public class KMIPServerRemoveObjectEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public int OperationStatus { get; set; }
}

Public Event OnRemoveObject As OnRemoveObjectHandler

Public Delegate Sub OnRemoveObjectHandler(sender As Object, e As KMIPServerRemoveObjectEventArgs)

Public Class KMIPServerRemoveObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

Request Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnRequestHandler OnRequest;

public delegate void OnRequestHandler(object sender, KMIPServerRequestEventArgs e);

public class KMIPServerRequestEventArgs : EventArgs {
  public long ConnectionId { get; }
  public byte[] RequestData { get; }
}

Public Event OnRequest As OnRequestHandler

Public Delegate Sub OnRequestHandler(sender As Object, e As KMIPServerRequestEventArgs)

Public Class KMIPServerRequestEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property RequestData As Byte()
End Class

Remarks

TBD

Response Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnResponseHandler OnResponse;

public delegate void OnResponseHandler(object sender, KMIPServerResponseEventArgs e);

public class KMIPServerResponseEventArgs : EventArgs {
  public long ConnectionId { get; }
  public byte[] ResponseData { get; }
}

Public Event OnResponse As OnResponseHandler

Public Delegate Sub OnResponseHandler(sender As Object, e As KMIPServerResponseEventArgs)

Public Class KMIPServerResponseEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ResponseData As Byte()
End Class

Remarks

TBD

RevokeObject Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnRevokeObjectHandler OnRevokeObject;

public delegate void OnRevokeObjectHandler(object sender, KMIPServerRevokeObjectEventArgs e);

public class KMIPServerRevokeObjectEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public int ReasonCode { get; }
  public string ReasonMessage { get; }
  public int OperationStatus { get; set; }
}

Public Event OnRevokeObject As OnRevokeObjectHandler

Public Delegate Sub OnRevokeObjectHandler(sender As Object, e As KMIPServerRevokeObjectEventArgs)

Public Class KMIPServerRevokeObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public ReadOnly Property ReasonCode As Integer
  Public ReadOnly Property ReasonMessage As String
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

RNGGenerate Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnRNGGenerateHandler OnRNGGenerate;

public delegate void OnRNGGenerateHandler(object sender, KMIPServerRNGGenerateEventArgs e);

public class KMIPServerRNGGenerateEventArgs : EventArgs {
  public long ConnectionId { get; }
  public int DataLength { get; }
  public int OperationStatus { get; set; }
}

Public Event OnRNGGenerate As OnRNGGenerateHandler

Public Delegate Sub OnRNGGenerateHandler(sender As Object, e As KMIPServerRNGGenerateEventArgs)

Public Class KMIPServerRNGGenerateEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property DataLength As Integer
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

RNGSeed Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnRNGSeedHandler OnRNGSeed;

public delegate void OnRNGSeedHandler(object sender, KMIPServerRNGSeedEventArgs e);

public class KMIPServerRNGSeedEventArgs : EventArgs {
  public long ConnectionId { get; }
  public byte[] Data { get; }
  public int BytesUsed { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnRNGSeed As OnRNGSeedHandler

Public Delegate Sub OnRNGSeedHandler(sender As Object, e As KMIPServerRNGSeedEventArgs)

Public Class KMIPServerRNGSeedEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property Data As Byte()
  Public Property BytesUsed As Integer
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

SetAttribute Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnSetAttributeHandler OnSetAttribute;

public delegate void OnSetAttributeHandler(object sender, KMIPServerSetAttributeEventArgs e);

public class KMIPServerSetAttributeEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public string AttributeName { get; }
  public string AttributeValue { get; }
  public int OperationStatus { get; set; }
}

Public Event OnSetAttribute As OnSetAttributeHandler

Public Delegate Sub OnSetAttributeHandler(sender As Object, e As KMIPServerSetAttributeEventArgs)

Public Class KMIPServerSetAttributeEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public ReadOnly Property AttributeName As String
  Public ReadOnly Property AttributeValue As String
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

Sign Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnSignHandler OnSign;

public delegate void OnSignHandler(object sender, KMIPServerSignEventArgs e);

public class KMIPServerSignEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public string HashAlgorithm { get; }
  public bool InputIsHash { get; }
  public byte[] Data { get; }
  public bool InitIndicator { get; }
  public bool FinalIndicator { get; }
  public string CorrelationValue { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnSign As OnSignHandler

Public Delegate Sub OnSignHandler(sender As Object, e As KMIPServerSignEventArgs)

Public Class KMIPServerSignEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public ReadOnly Property HashAlgorithm As String
  Public ReadOnly Property InputIsHash As Boolean
  Public ReadOnly Property Data As Byte()
  Public ReadOnly Property InitIndicator As Boolean
  Public ReadOnly Property FinalIndicator As Boolean
  Public Property CorrelationValue As String
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

TLSCertValidate Event (KMIPServer Component)

Fires when a client certificate needs to be validated.

Syntax

C#
VB.NET

public event OnTLSCertValidateHandler OnTLSCertValidate;

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

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

Public Event OnTLSCertValidate As OnTLSCertValidateHandler

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

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

Remarks

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

TLSEstablished Event (KMIPServer Component)

Reports the setup of a TLS session.

Syntax

C#
VB.NET

public event OnTLSEstablishedHandler OnTLSEstablished;

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

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

Public Event OnTLSEstablished As OnTLSEstablishedHandler

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

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

Remarks

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

TLSHandshake Event (KMIPServer Component)

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

Syntax

C#
VB.NET

public event OnTLSHandshakeHandler OnTLSHandshake;

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

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

Public Event OnTLSHandshake As OnTLSHandshakeHandler

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

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

Remarks

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

TLSPSK Event (KMIPServer Component)

Requests a pre-shared key for TLS-PSK.

Syntax

C#
VB.NET

public event OnTLSPSKHandler OnTLSPSK;

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

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

Public Event OnTLSPSK As OnTLSPSKHandler

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

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

Remarks

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

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

TLSShutdown Event (KMIPServer Component)

Reports closure of a TLS session.

Syntax

C#
VB.NET

public event OnTLSShutdownHandler OnTLSShutdown;

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

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

Public Event OnTLSShutdown As OnTLSShutdownHandler

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

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

Remarks

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

ValidateChain Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnValidateChainHandler OnValidateChain;

public delegate void OnValidateChainHandler(object sender, KMIPServerValidateChainEventArgs e);

public class KMIPServerValidateChainEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectIds { get; }
  public int Validity { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnValidateChain As OnValidateChainHandler

Public Delegate Sub OnValidateChainHandler(sender As Object, e As KMIPServerValidateChainEventArgs)

Public Class KMIPServerValidateChainEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectIds As String
  Public Property Validity As Integer
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

Verify Event (KMIPServer Component)

TBD

Syntax

C#
VB.NET

public event OnVerifyHandler OnVerify;

public delegate void OnVerifyHandler(object sender, KMIPServerVerifyEventArgs e);

public class KMIPServerVerifyEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public string HashAlgorithm { get; }
  public bool InputIsHash { get; }
  public byte[] Data { get; }
  public byte[] SignatureData { get; }
  public bool InitIndicator { get; }
  public bool FinalIndicator { get; }
  public int ValidationResult { get; set; }
  public string CorrelationValue { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnVerify As OnVerifyHandler

Public Delegate Sub OnVerifyHandler(sender As Object, e As KMIPServerVerifyEventArgs)

Public Class KMIPServerVerifyEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public ReadOnly Property HashAlgorithm As String
  Public ReadOnly Property InputIsHash As Boolean
  Public ReadOnly Property Data As Byte()
  Public ReadOnly Property SignatureData As Byte()
  Public ReadOnly Property InitIndicator As Boolean
  Public ReadOnly Property FinalIndicator As Boolean
  Public Property ValidationResult As Integer
  Public Property CorrelationValue As String
  Public Property OperationStatus As Integer
End Class

Remarks

TBD

VerifyHash Event (KMIPServer Component)

Delegates the hash verification operation to a custom handler.

Syntax

C#
VB.NET

public event OnVerifyHashHandler OnVerifyHash;

public delegate void OnVerifyHashHandler(object sender, KMIPServerVerifyHashEventArgs e);

public class KMIPServerVerifyHashEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string ObjectId { get; }
  public string HashAlgorithm { get; }
  public byte[] Data { get; }
  public byte[] Hash { get; }
  public bool InitIndicator { get; }
  public bool FinalIndicator { get; }
  public bool IsValid { get; set; }
  public string CorrelationValue { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnVerifyHash As OnVerifyHashHandler

Public Delegate Sub OnVerifyHashHandler(sender As Object, e As KMIPServerVerifyHashEventArgs)

Public Class KMIPServerVerifyHashEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property ObjectId As String
  Public ReadOnly Property HashAlgorithm As String
  Public ReadOnly Property Data As Byte()
  Public ReadOnly Property Hash As Byte()
  Public ReadOnly Property InitIndicator As Boolean
  Public ReadOnly Property FinalIndicator As Boolean
  Public Property IsValid As Boolean
  Public Property CorrelationValue As String
  Public Property OperationStatus As Integer
End Class

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.

Certificate Type

Encapsulates an individual X.509 certificate.

Remarks

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

Fields

Bytes
byte[] (read-only)
Default: ""

Returns the raw certificate data in DER format.

CA
bool
Default: 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 field when generating a new certificate to have its Basic Constraints extension generated automatically.

CAKeyID
byte[] (read-only)
Default: ""

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
CertTypes (read-only)
Default: 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: ""

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 field 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: ""

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

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

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.

HashAlgorithm
string
Default: ""

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

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

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: "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 fields to get more details about the key the certificate contains.

KeyBits
int (read-only)
Default: 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 field would typically contain auxiliary values, and therefore be longer.

KeyFingerprint
string (read-only)
Default: ""

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 field. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

KeyUsage
int
Default: 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 field before generating the certificate to propagate the key usage flags to the new certificate.

KeyValid
bool (read-only)
Default: False

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

OCSPLocations
string
Default: ""

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

Set this field 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
bool
Default: False

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

Origin
int (read-only)
Default: 0

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

PolicyIDs
string
Default: ""

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 field 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
byte[] (read-only)
Default: ""

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

PrivateKeyExists
bool (read-only)
Default: 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 field 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
bool (read-only)
Default: False

Indicates whether the private key is extractable (exportable).

PublicKeyBytes
byte[] (read-only)
Default: ""

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
bool (read-only)
Default: 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
QualifiedStatementsTypes
Default: 0

Returns a simplified qualified status of the certificate.

Qualifiers
string (read-only)
Default: ""

A list of qualifiers.

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

SelfSigned
bool (read-only)
Default: False

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

SerialNumber
byte[]
Default: ""

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

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
PKISources (read-only)
Default: 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: ""

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

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
byte[]
Default: ""

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 fields 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: ""

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
bool (read-only)
Default: 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: ""

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

ValidTo
string
Default: ""

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

Constructors

C#
VB.NET

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

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

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

C#
VB.NET

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

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

Loads the X.509 certificate from a memory buffer. CertBytes is a buffer containing the raw certificate data. CertStartIndex and CertCount specify the starting position and number of bytes to be read from the buffer, respectively. KeyBytes is a buffer containing the private key data. KeyStartIndex and KeyCount specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

C#
VB.NET

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

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

C#
VB.NET

public Certificate(string path, string password);

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

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data. Password is a password encrypting the certificate.

C#
VB.NET

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

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

Loads the X.509 certificate from a file. CertPath specifies the full path to the file containing the certificate data. KeyPath specifies the full path to the file containing the private key. Password is a password encrypting the certificate.

C#
VB.NET

public Certificate(string path);

Public Certificate(ByVal Path As String)

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data.

C#
VB.NET

public Certificate(System.IO.Stream stream);

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

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.

C#
VB.NET

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

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

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data. Password is a password encrypting the certificate.

C#
VB.NET

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

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

Loads the X.509 certificate from a stream. CertStream is a stream containing the certificate data. KeyStream is a stream containing the private key. Password is a password encrypting the certificate.

C#
VB.NET

public Certificate();

Public Certificate()

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.

Fields

Algorithm
string
Default: ""

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
int (read-only)
Default: 0

The length of the key in bits.

Curve
string
Default: ""

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

Exportable
bool (read-only)
Default: False

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

Fingerprint
string (read-only)
Default: ""

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

ID
byte[]
Default: ""

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
byte[]
Default: ""

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
byte[] (read-only)
Default: ""

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

Nonce
byte[]
Default: ""

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

Private
bool (read-only)
Default: False

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

Public
bool (read-only)
Default: False

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

Subject
byte[]
Default: ""

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

Symmetric
bool (read-only)
Default: False

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

Valid
bool (read-only)
Default: 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

C#
VB.NET

public CryptoKey();

Public CryptoKey()

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.

Fields

AsyncDocumentID
string
Default: ""

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

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

Data
string
Default: ""

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

ExternalHashCalculation
bool
Default: 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: "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: ""

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

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

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

Available options:


asmdPKCS1	`0`
asmdPKCS7	`1`

Mode
ExternalCryptoModes
Default: 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: ""

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

C#
VB.NET

public ExternalCrypto();

Public ExternalCrypto()

Creates a new ExternalCrypto object with default field values.

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

DNSMode
DNSResolveModes
Default: 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
int
Default: 0

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

DNSQueryTimeout
int
Default: 0

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

DNSServers
string
Default: ""

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

DNSTotalTimeout
int
Default: 0

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

IncomingSpeedLimit
int
Default: 0

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

LocalAddress
string
Default: ""

The local network interface to bind the socket to.

LocalPort
int
Default: 0

The local port number to bind the socket to.

OutgoingSpeedLimit
int
Default: 0

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

Timeout
int
Default: 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
bool
Default: False

Enables or disables IP protocol version 6.

Constructors

C#
VB.NET

public SocketSettings();

Public SocketSettings()

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.

Fields

AEADCipher
bool (read-only)
Default: False

Indicates whether the encryption algorithm used is an AEAD cipher.

ChainValidationDetails
int (read-only)
Default: 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
ChainValidities (read-only)
Default: 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: ""

The cipher suite employed by this connection.

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

ClientAuthenticated
bool (read-only)
Default: False

Specifies whether client authentication was performed during this connection.

ClientAuthRequested
bool (read-only)
Default: False

Specifies whether client authentication was requested during this connection.

ConnectionEstablished
bool (read-only)
Default: False

Indicates whether the connection has been established fully.

ConnectionID
byte[] (read-only)
Default: ""

The unique identifier assigned to this connection.

DigestAlgorithm
string (read-only)
Default: ""

The digest algorithm used in a TLS-enabled connection.

EncryptionAlgorithm
string (read-only)
Default: ""

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

Exportable
bool (read-only)
Default: False

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

ID
long (read-only)
Default: -1

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

KeyExchangeAlgorithm
string (read-only)
Default: ""

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

KeyExchangeKeyBits
int (read-only)
Default: 0

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

NamedECCurve
string (read-only)
Default: ""

The elliptic curve used in this connection.

PFSCipher
bool (read-only)
Default: False

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

PreSharedIdentity
string
Default: ""

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

PreSharedIdentityHint
string (read-only)
Default: ""

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

PublicKeyBits
int (read-only)
Default: 0

The length of the public key.

RemoteAddress
string (read-only)
Default: ""

The client's IP address.

RemotePort
int (read-only)
Default: 0

The remote port of the client connection.

ResumedSession
bool (read-only)
Default: False

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

SecureConnection
bool (read-only)
Default: False

Indicates whether TLS or SSL is enabled for this connection.

ServerAuthenticated
bool (read-only)
Default: False

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

SignatureAlgorithm
string (read-only)
Default: ""

The signature algorithm used in a TLS handshake.

SymmetricBlockSize
int (read-only)
Default: 0

The block size of the symmetric algorithm used.

SymmetricKeyBits
int (read-only)
Default: 0

The key length of the symmetric algorithm used.

TotalBytesReceived
long (read-only)
Default: 0

The total number of bytes received over this connection.

TotalBytesSent
long (read-only)
Default: 0

The total number of bytes sent over this connection.

ValidationLog
string (read-only)
Default: ""

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

Version
string (read-only)
Default: ""

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

Constructors

C#
VB.NET

public TLSConnectionInfo();

Public TLSConnectionInfo()

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.

Fields

AutoValidateCertificates
bool
Default: True

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

BaseConfiguration
SecureTransportPredefinedConfigurations
Default: 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: ""

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

Defines the elliptic curves to enable.

Extensions
string
Default: ""

Provides access to TLS extensions.

ForceResumeIfDestinationChanges
bool
Default: False

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

PreSharedIdentity
string
Default: ""

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

PreSharedKey
string
Default: ""

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

PreSharedKeyCiphersuite
string
Default: ""

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

RenegotiationAttackPreventionMode
RenegotiationAttackPreventionModes
Default: 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
RevocationCheckKinds
Default: 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`	Check all provided CRL endpoints for all chain certificates.
crcAllOCSP	`3`	Check all provided OCSP endpoints for all chain certificates.
crcAllCRLAndOCSP	`4`	Check all CRL and OCSP endpoints for all chain certificates.
crcAnyCRL	`5`	At least one CRL check for every certificate in the chain must succeed.
crcAnyOCSP	`6`	At least one OCSP check for every certificate in the chain must succeed.
crcAnyCRLOrOCSP	`7`	At least one CRL or OCSP check for every certificate in the chain must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL	`8`	At least one CRL or OCSP check for every certificate in the chain must succeed. OCSP endpoints are checked first.

This setting controls the way the revocation checks are performed. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to 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.

SSLOptions
int
Default: 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
SSLModes
Default: 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
bool
Default: False

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

UseSessionResumption
bool
Default: False

Enables or disables the TLS session resumption capability.

Versions
int
Default: 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

C#
VB.NET

public TLSSettings();

Public TLSSettings()

Creates a new TLSSettings object.

UserAccount Type

A container for user account information.

Remarks

UserAccount objects are used to store user account information, such as logins and passwords.

Fields

AssociatedData
byte[]
Default: ""

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

BasePath
string
Default: ""

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

Certificate
byte[]
Default: ""

Contains the user's certificate.

Data
string
Default: ""

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

Email
string
Default: ""

The user's email address.

HashAlgorithm
string
Default: ""

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

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

OtpAlgorithm
OTPAlgorithms
Default: 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
int
Default: 0

Specifies the length of the user's OTP password.

OtpValue
int
Default: 0

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

OutgoingSpeedLimit
int
Default: 0

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

Password
string
Default: ""

The user's authentication password.

SharedSecret
byte[]
Default: ""

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
byte[]
Default: ""

Contains the user's SSH key.

Username
string
Default: ""

The registered name (login) of the user.

Constructors

C#
VB.NET

public UserAccount();

Public UserAccount()

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

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.

DualStack: Allows the use of ip4 and ip6 simultaneously.

This setting specifies a socket can use ip4 and ip6 simultaneously.

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.

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.

UseCompression: Whether to use GZip compression.

Use this property to tell the component that it should use data compression when generating responses.

Base Config Settings

CheckKeyIntegrityBeforeUse: Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching: Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the component.

Supported values are:


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.

EnableClientSideSSLFFDHE: Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies: Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the components that have its CookieCaching property set to "global".

HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other components.

LogDestination: Specifies the debug log destination.

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

Supported values are:


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.

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

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.

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`)