KMIPServer Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

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 class with short descriptions. Click on the links for further details.

Method List

---

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

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

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

Active Property (KMIPServer Class)

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

Syntax

public boolean isActive();

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

Enables or disables keep-alive mode.

Syntax

public boolean isAllowKeepAlive();


public void setAllowKeepAlive(boolean allowKeepAlive);

Default Value

True

Remarks

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

AuthRealm Property (KMIPServer Class)

Specifies authentication realm for digest and NTLM authentication.

Syntax

public String getAuthRealm();


public void setAuthRealm(String authRealm);

Default Value

"SecureBlackbox"

Remarks

Specifies authentication realm for digest and NTLM authentication types.

AuthTypes Property (KMIPServer Class)

Defines allowed HTTP authentication types.

Syntax

public int getAuthTypes();


public void setAuthTypes(int authTypes);

Default Value

0

Remarks

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

BoundPort Property (KMIPServer Class)

Indicates the bound listening port.

Syntax

public int getBoundPort();

Default Value

0

Remarks

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

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

CACertificate Property (KMIPServer Class)

The default CA certificate.

Syntax

public Certificate getCACertificate();


public void setCACertificate(Certificate CACertificate);

Remarks

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

This property is not available at design time.

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

Certificate Property (KMIPServer Class)

Contains the certificate that has just been generated or added.

Syntax

public Certificate getCertificate();


public void setCertificate(Certificate 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 Class)

The default compression level to use.

Syntax

public int getCompressionLevel();


public void setCompressionLevel(int compressionLevel);

Default Value

6

Remarks

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

ExternalCrypto Property (KMIPServer Class)

Provides access to external signing and DC parameters.

Syntax

public ExternalCrypto getExternalCrypto();

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

Reserved.

Syntax

public boolean isFIPSMode();


public void setFIPSMode(boolean FIPSMode);

Default Value

False

Remarks

This property is reserved for future use.

HandshakeTimeout Property (KMIPServer Class)

Specifies the handshake timeout in milliseconds.

Syntax

public int getHandshakeTimeout();


public void setHandshakeTimeout(int handshakeTimeout);

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Host Property (KMIPServer Class)

Specifies the host name of the KMIP server.

Syntax

public String getHost();


public void setHost(String host);

Default Value

""

Remarks

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

Key Property (KMIPServer Class)

Contains the key that has just been generated or added.

Syntax

public CryptoKey getKey();


public void setKey(CryptoKey key);

Remarks

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

This property is not available at design time.

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

PinnedClient Property (KMIPServer Class)

Populates the pinned client details.

Syntax

public TLSConnectionInfo getPinnedClient();

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

Contains the certificate chain of the pinned client.

Syntax

public CertificateList getPinnedClientChain();

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

A port to listen for connections on.

Syntax

public int getPort();


public void setPort(int port);

Default Value

5696

Remarks

Use this property to specify the listening port.

ReadOnly Property (KMIPServer Class)

ToDo.

Syntax

public boolean isReadOnly();


public void setReadOnly(boolean readOnly);

Default Value

False

Remarks

ToDo

This property is not available at design time.

SessionTimeout Property (KMIPServer Class)

Specifies the default session timeout value in milliseconds.

Syntax

public int getSessionTimeout();


public void setSessionTimeout(int sessionTimeout);

Default Value

360000

Remarks

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

SocketSettings Property (KMIPServer Class)

Manages network connection settings.

Syntax

public SocketSettings getSocketSettings();

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

A path to the KMIP object database.

Syntax

public String getStorageFileName();


public void setStorageFileName(String storageFileName);

Default Value

""

Remarks

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

TLSServerChain Property (KMIPServer Class)

The server's TLS certificates.

Syntax

public CertificateList getTLSServerChain();


public void setTLSServerChain(CertificateList TLSServerChain);

Remarks

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

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

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

This property is not available at design time.

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

TLSSettings Property (KMIPServer Class)

Manages TLS layer settings.

Syntax

public TLSSettings getTLSSettings();

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

Enables chunked transfer.

Syntax

public boolean isUseChunkedTransfer();


public void setUseChunkedTransfer(boolean useChunkedTransfer);

Default Value

False

Remarks

Use this property to enable chunked content encoding.

UseCompression Property (KMIPServer Class)

Enables or disables server-side compression.

Syntax

public boolean isUseCompression();


public void setUseCompression(boolean useCompression);

Default Value

False

Remarks

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

UseHTTP Property (KMIPServer Class)

ToDo.

Syntax

public boolean isUseHTTP();


public void setUseHTTP(boolean useHTTP);

Default Value

False

Remarks

ToDo

This property is not available at design time.

Users Property (KMIPServer Class)

A database of registered users.

Syntax

public UserAccountList getUsers();


public void setUsers(UserAccountList users);

Remarks

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

This property is not available at design time.

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

Config Method (KMIPServer Class)

This method sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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 Class)

Performs an additional action.

Syntax

public String doAction(String actionID, String actionParams);

Remarks

DoAction is a generic method available in every class. 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 Class)

Terminates a client connection.

Syntax

public void dropClient(long connectionId, boolean forced);

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

Populates the per-connection certificate object.

Syntax

public void getClientCert(long connectionID);

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

Populates the per-connection key object.

Syntax

public void getClientKey(long connectionID);

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

Returns a request header value.

Syntax

public String getRequestHeader(long connectionId, String headerName);

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

Returns a response header value.

Syntax

public String getResponseHeader(long connectionId, String headerName);

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

Enumerates the connected clients.

Syntax

public String listClients();

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

Takes a snapshot of the connection's properties.

Syntax

public void pinClient(long connectionId);

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

Processes a generic HTTP request.

Syntax

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

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

Resets the class settings.

Syntax

public void reset();

Remarks

Reset is a generic method available in every class.

SetClientBytes Method (KMIPServer Class)

Commits a data buffer to the connection.

Syntax

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

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

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

Syntax

public void setClientCert(long connectionID);

Remarks

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

SetClientKey Method (KMIPServer Class)

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

Syntax

public void setClientKey(long connectionID);

Remarks

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

SetResponseHeader Method (KMIPServer Class)

Sets a response header.

Syntax

public boolean setResponseHeader(long connectionId, String headerName, String value);

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

Start the KMIP server.

Syntax

public void start();

Remarks

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

Stop Method (KMIPServer Class)

Stops the KMIP server.

Syntax

public void stop();

Remarks

Call this method to stop the KMIP server.

Accept Event (KMIPServer Class)

Reports an incoming connection.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void accept(KMIPServerAcceptEvent e) {}
  ...
}

public class KMIPServerAcceptEvent {
  public String remoteAddress;
  public int remotePort;
  public boolean accept; //read-write
}

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

Notifies the application about the object activation request.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void activateObject(KMIPServerActivateObjectEvent e) {}
  ...
}

public class KMIPServerActivateObjectEvent {
  public long connectionId;
  public String objectId;
  public int operationStatus; //read-write
}

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

Passes the certificate import request to the application.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void add(KMIPServerAddEvent e) {}
  ...
}

public class KMIPServerAddEvent {
  public long connectionId;
  public String group; //read-write
  public String certId; //read-write
  public int operationStatus; //read-write
}

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

Expects the application to handle the key import request.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void addKey(KMIPServerAddKeyEvent e) {}
  ...
}

public class KMIPServerAddKeyEvent {
  public long connectionId;
  public String group; //read-write
  public String keyId; //read-write
  public int operationStatus; //read-write
}

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

Notifies the application about completion of the certificate import operation.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void afterAdd(KMIPServerAfterAddEvent e) {}
  ...
}

public class KMIPServerAfterAddEvent {
  public long connectionId;
  public String group; //read-write
  public String certId; //read-write
  public int operationStatus; //read-write
}

Remarks

The class 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 Class)

Reports the completion of the key import procedure.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void afterAddKey(KMIPServerAfterAddKeyEvent e) {}
  ...
}

public class KMIPServerAfterAddKeyEvent {
  public long connectionId;
  public String group; //read-write
  public String keyId; //read-write
  public int operationStatus; //read-write
}

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

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.

AfterBrowse Event (KMIPServer Class)

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

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void afterBrowse(KMIPServerAfterBrowseEvent e) {}
  ...
}

public class KMIPServerAfterBrowseEvent {
  public long connectionID;
  public String objectId;
  public int operationStatus; //read-write
}

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:

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.

AfterDecrypt Event (KMIPServer Class)

Notifies the application about completion of the decryption call.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void afterDecrypt(KMIPServerAfterDecryptEvent e) {}
  ...
}

public class KMIPServerAfterDecryptEvent {
  public long connectionId;
  public String objectId;
  public byte[] decryptedData;
  public String correlationValue; //read-write
  public int operationStatus; //read-write
}

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

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.

AfterDeriveKey Event (KMIPServer Class)

Notifies the application about completion of the key derivation request.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void afterDeriveKey(KMIPServerAfterDeriveKeyEvent e) {}
  ...
}

public class KMIPServerAfterDeriveKeyEvent {
  public long connectionId;
  public String newKeyId; //read-write
  public int operationStatus; //read-write
}

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

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.

AfterEdit Event (KMIPServer Class)

Notifies the application of completion of the object editing operation.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void afterEdit(KMIPServerAfterEditEvent e) {}
  ...
}

public class KMIPServerAfterEditEvent {
  public long connectionID;
  public String objectId;
  public int operationStatus; //read-write
}

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

Notifies the application about the completion of the encryption call.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void afterEncrypt(KMIPServerAfterEncryptEvent e) {}
  ...
}

public class KMIPServerAfterEncryptEvent {
  public long connectionId;
  public String objectId;
  public byte[] encryptedData;
  public String correlationValue; //read-write
  public int operationStatus; //read-write
}

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

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.

AfterGenerate Event (KMIPServer Class)

Signifies completion of certificate generation.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void afterGenerate(KMIPServerAfterGenerateEvent e) {}
  ...
}

public class KMIPServerAfterGenerateEvent {
  public long connectionId;
  public String certId; //read-write
  public int operationStatus; //read-write
}

Remarks

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

AfterGenerateKey Event (KMIPServer Class)

Notifies the application of the completion of key generation procedure.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void afterGenerateKey(KMIPServerAfterGenerateKeyEvent e) {}
  ...
}

public class KMIPServerAfterGenerateKeyEvent {
  public long connectionId;
  public String keyId; //read-write
  public int operationStatus; //read-write
}

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

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.

AfterGenerateKeyPair Event (KMIPServer Class)

Notifies the application of the completion of keypair generation.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void afterGenerateKeyPair(KMIPServerAfterGenerateKeyPairEvent e) {}
  ...
}

public class KMIPServerAfterGenerateKeyPairEvent {
  public long connectionId;
  public String privateKeyId; //read-write
  public String publicKeyId; //read-write
  public int operationStatus; //read-write
}

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

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.

AfterHash Event (KMIPServer Class)

Notifies the application about completion of the hashing call.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void afterHash(KMIPServerAfterHashEvent e) {}
  ...
}

public class KMIPServerAfterHashEvent {
  public long connectionId;
  public String objectId;
  public byte[] hashData;
  public String correlationValue; //read-write
  public int operationStatus; //read-write
}

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

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.

AfterList Event (KMIPServer Class)

Notifies the application about completion of the list command.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void afterList(KMIPServerAfterListEvent e) {}
  ...
}

public class KMIPServerAfterListEvent {
  public long connectionId;
  public int objectType;
  public int objectStatus;
  public boolean onlyFreshObjects;
  public String objectIds; //read-write
  public int operationStatus; //read-write
}

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

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.

AfterObtainLease Event (KMIPServer Class)

Reports the completion of lease allocation operation.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void afterObtainLease(KMIPServerAfterObtainLeaseEvent e) {}
  ...
}

public class KMIPServerAfterObtainLeaseEvent {
  public long connectionId;
  public String objectId;
  public int leaseTime; //read-write
  public String lastChangeDate; //read-write
  public int operationStatus; //read-write
}

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

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.

AfterReadObject Event (KMIPServer Class)

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

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void afterReadObject(KMIPServerAfterReadObjectEvent e) {}
  ...
}

public class KMIPServerAfterReadObjectEvent {
  public long connectionId;
  public String objectId;
  public int objectType;
  public int operationStatus; //read-write
}

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

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.

AfterReCertify Event (KMIPServer Class)

ToDo.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void afterReCertify(KMIPServerAfterReCertifyEvent e) {}
  ...
}

public class KMIPServerAfterReCertifyEvent {
  public long connectionId;
  public String newCertId; //read-write
  public int operationStatus; //read-write
}

Remarks

ToDo

AfterReKey Event (KMIPServer Class)

ToDo.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void afterReKey(KMIPServerAfterReKeyEvent e) {}
  ...
}

public class KMIPServerAfterReKeyEvent {
  public long connectionId;
  public String newKeyId; //read-write
  public int operationStatus; //read-write
}

Remarks

ToDo

AfterRekeyKeyPair Event (KMIPServer Class)

ToDo.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void afterRekeyKeyPair(KMIPServerAfterRekeyKeyPairEvent e) {}
  ...
}

public class KMIPServerAfterRekeyKeyPairEvent {
  public long connectionId;
  public String newPrivateKeyId; //read-write
  public String newPublicKeyId; //read-write
  public int operationStatus; //read-write
}

Remarks

ToDo

AfterRemoveObject Event (KMIPServer Class)

Notifies the application about completion of the object removal request.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void afterRemoveObject(KMIPServerAfterRemoveObjectEvent e) {}
  ...
}

public class KMIPServerAfterRemoveObjectEvent {
  public long connectionId;
  public String objectId;
  public int operationStatus; //read-write
}

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

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.

AfterSign Event (KMIPServer Class)

Notifies the application of completion of a signing operation.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void afterSign(KMIPServerAfterSignEvent e) {}
  ...
}

public class KMIPServerAfterSignEvent {
  public long connectionId;
  public String objectId;
  public boolean inputIsHash;
  public byte[] signatureData;
  public String correlationValue; //read-write
  public int operationStatus; //read-write
}

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

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.

AfterVerify Event (KMIPServer Class)

Notifies the application about completion of the Verify operation.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void afterVerify(KMIPServerAfterVerifyEvent e) {}
  ...
}

public class KMIPServerAfterVerifyEvent {
  public long connectionId;
  public String objectId;
  public boolean inputIsHash;
  public int validationResult; //read-write
  public String correlationValue; //read-write
  public int operationStatus; //read-write
}

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

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.

AfterVerifyHash Event (KMIPServer Class)

Notifies the application about completion of the hash verification.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void afterVerifyHash(KMIPServerAfterVerifyHashEvent e) {}
  ...
}

public class KMIPServerAfterVerifyHashEvent {
  public long connectionId;
  public String objectId;
  public boolean isValid; //read-write
  public String correlationValue; //read-write
  public int operationStatus; //read-write
}

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

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.

ArchiveObject Event (KMIPServer Class)

Notifies the application about the received object archival request.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void archiveObject(KMIPServerArchiveObjectEvent e) {}
  ...
}

public class KMIPServerArchiveObjectEvent {
  public long connectionId;
  public String objectId;
  public int operationStatus; //read-write
}

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

Fires when a connected client makes an authentication attempt.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void authAttempt(KMIPServerAuthAttemptEvent e) {}
  ...
}

public class KMIPServerAuthAttemptEvent {
  public long connectionID;
  public String HTTPMethod;
  public String URI;
  public String authMethod;
  public String username;
  public String password;
  public boolean allow; //read-write
}

Remarks

The class 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 Class)

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

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void beforeAdd(KMIPServerBeforeAddEvent e) {}
  ...
}

public class KMIPServerBeforeAddEvent {
  public long connectionId;
  public String group; //read-write
  public int action; //read-write
}

Remarks

The class 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 Class)

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

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void beforeAddKey(KMIPServerBeforeAddKeyEvent e) {}
  ...
}

public class KMIPServerBeforeAddKeyEvent {
  public long connectionId;
  public String group; //read-write
  public int action; //read-write
}

Remarks

The class 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 Class)

Notifies the application about the browse request being received.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void beforeBrowse(KMIPServerBeforeBrowseEvent e) {}
  ...
}

public class KMIPServerBeforeBrowseEvent {
  public long connectionID;
  public String objectId;
  public int action; //read-write
}

Remarks

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

BeforeDecrypt Event (KMIPServer Class)

Notifies the application about the initiation of the decryption operation.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void beforeDecrypt(KMIPServerBeforeDecryptEvent e) {}
  ...
}

public class KMIPServerBeforeDecryptEvent {
  public long connectionId;
  public String objectId;
  public String correlationValue; //read-write
  public int action; //read-write
}

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

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.

BeforeDeriveKey Event (KMIPServer Class)

Fires when a derive key request is received.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void beforeDeriveKey(KMIPServerBeforeDeriveKeyEvent e) {}
  ...
}

public class KMIPServerBeforeDeriveKeyEvent {
  public long connectionId;
  public int objectType;
  public String objectIds;
  public String derivationMethod;
  public int action; //read-write
}

Remarks

The class 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 Class)

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

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void beforeEdit(KMIPServerBeforeEditEvent e) {}
  ...
}

public class KMIPServerBeforeEditEvent {
  public long connectionID;
  public String objectId;
  public int action; //read-write
}

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

Notifies the application about the initiation of an encryption operation.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void beforeEncrypt(KMIPServerBeforeEncryptEvent e) {}
  ...
}

public class KMIPServerBeforeEncryptEvent {
  public long connectionId;
  public String objectId;
  public String correlationValue; //read-write
  public int action; //read-write
}

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

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.

BeforeGenerate Event (KMIPServer Class)

Fires when a certificate generation request is received.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void beforeGenerate(KMIPServerBeforeGenerateEvent e) {}
  ...
}

public class KMIPServerBeforeGenerateEvent {
  public long connectionId;
  public String publicKeyId;
  public int action; //read-write
}

Remarks

The class 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 Class)

Fires when a key generation request is received.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void beforeGenerateKey(KMIPServerBeforeGenerateKeyEvent e) {}
  ...
}

public class KMIPServerBeforeGenerateKeyEvent {
  public long connectionId;
  public String keyAlgorithm; //read-write
  public int keyLength; //read-write
  public int action; //read-write
}

Remarks

The class 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 Class)

Fires when a key generation request is received.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void beforeGenerateKeyPair(KMIPServerBeforeGenerateKeyPairEvent e) {}
  ...
}

public class KMIPServerBeforeGenerateKeyPairEvent {
  public long connectionId;
  public String keyAlgorithm; //read-write
  public int keyLength; //read-write
  public String scheme; //read-write
  public String schemeParams; //read-write
  public int action; //read-write
}

Remarks

The class 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 Class)

Notifies the application about the initiation of the hashing operation.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void beforeHash(KMIPServerBeforeHashEvent e) {}
  ...
}

public class KMIPServerBeforeHashEvent {
  public long connectionId;
  public String objectId;
  public String hashAlgorithm;
  public String correlationValue; //read-write
  public int action; //read-write
}

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

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.

BeforeList Event (KMIPServer Class)

Notifies the application about the initiation of the list operation.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void beforeList(KMIPServerBeforeListEvent e) {}
  ...
}

public class KMIPServerBeforeListEvent {
  public long connectionId;
  public int objectType;
  public int objectStatus;
  public boolean onlyFreshObjects;
  public int action; //read-write
}

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

Notifies the application about the client requesting an object lease.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void beforeObtainLease(KMIPServerBeforeObtainLeaseEvent e) {}
  ...
}

public class KMIPServerBeforeObtainLeaseEvent {
  public long connectionId;
  public String objectId;
  public int action; //read-write
}

Remarks

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

BeforeReadObject Event (KMIPServer Class)

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

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void beforeReadObject(KMIPServerBeforeReadObjectEvent e) {}
  ...
}

public class KMIPServerBeforeReadObjectEvent {
  public long connectionId;
  public String objectId;
  public int action; //read-write
}

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

Notifies the application about a re-certification request.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void beforeReCertify(KMIPServerBeforeReCertifyEvent e) {}
  ...
}

public class KMIPServerBeforeReCertifyEvent {
  public long connectionId;
  public String oldCertId;
  public int action; //read-write
}

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

Notifies the application about a re-key request received.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void beforeReKey(KMIPServerBeforeReKeyEvent e) {}
  ...
}

public class KMIPServerBeforeReKeyEvent {
  public long connectionId;
  public String oldKeyId;
  public int action; //read-write
}

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

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

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void beforeRekeyKeyPair(KMIPServerBeforeRekeyKeyPairEvent e) {}
  ...
}

public class KMIPServerBeforeRekeyKeyPairEvent {
  public long connectionId;
  public String oldPrivateKeyId;
  public int action; //read-write
}

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

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void beforeRemoveObject(KMIPServerBeforeRemoveObjectEvent e) {}
  ...
}

public class KMIPServerBeforeRemoveObjectEvent {
  public long connectionId;
  public String objectId;
  public int action; //read-write
}

Remarks

TBD

BeforeSign Event (KMIPServer Class)

Notifies the application about the initiation of a signing operation.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void beforeSign(KMIPServerBeforeSignEvent e) {}
  ...
}

public class KMIPServerBeforeSignEvent {
  public long connectionId;
  public String objectId;
  public String hashAlgorithm;
  public boolean inputIsHash;
  public String correlationValue; //read-write
  public int action; //read-write
}

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

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.

BeforeVerify Event (KMIPServer Class)

Notifies the application about the initiation of the verify operation.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void beforeVerify(KMIPServerBeforeVerifyEvent e) {}
  ...
}

public class KMIPServerBeforeVerifyEvent {
  public long connectionId;
  public String objectId;
  public String hashAlgorithm;
  public boolean inputIsHash;
  public String correlationValue; //read-write
  public int action; //read-write
}

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

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.

BeforeVerifyHash Event (KMIPServer Class)

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

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void beforeVerifyHash(KMIPServerBeforeVerifyHashEvent e) {}
  ...
}

public class KMIPServerBeforeVerifyHashEvent {
  public long connectionId;
  public String objectId;
  public String hashAlgorithm;
  public String correlationValue; //read-write
  public int action; //read-write
}

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

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.

Cancel Event (KMIPServer Class)

Reports a cancellation request received from the client.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void cancel(KMIPServerCancelEvent e) {}
  ...
}

public class KMIPServerCancelEvent {
  public long connectionId;
  public String asyncCorrelationValue;
  public int cancellationResult; //read-write
  public int operationStatus; //read-write
}

Remarks

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

Check Event (KMIPServer Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void check(KMIPServerCheckEvent e) {}
  ...
}

public class KMIPServerCheckEvent {
  public long connectionId;
  public String objectId;
  public long usageLimitsCount; //read-write
  public int cryptographicUsageMask; //read-write
  public int leaseTime; //read-write
  public int operationStatus; //read-write
}

Remarks

TBD

Connect Event (KMIPServer Class)

Reports an accepted connection.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void connect(KMIPServerConnectEvent e) {}
  ...
}

public class KMIPServerConnectEvent {
  public long connectionID;
  public String remoteAddress;
  public int remotePort;
}

Remarks

The class 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 Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void decrypt(KMIPServerDecryptEvent e) {}
  ...
}

public class KMIPServerDecryptEvent {
  public long connectionId;
  public String objectId;
  public byte[] data;
  public String IV;
  public boolean initIndicator;
  public boolean finalIndicator;
  public int blockCipherMode;
  public int tagLength;
  public int paddingMethod;
  public String correlationValue; //read-write
  public int operationStatus; //read-write
}

Remarks

TBD

DeleteAttribute Event (KMIPServer Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void deleteAttribute(KMIPServerDeleteAttributeEvent e) {}
  ...
}

public class KMIPServerDeleteAttributeEvent {
  public long connectionId;
  public String objectId;
  public String attributeName;
  public String attributeValue; //read-write
  public int operationStatus; //read-write
}

Remarks

TBD

DeriveKey Event (KMIPServer Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void deriveKey(KMIPServerDeriveKeyEvent e) {}
  ...
}

public class KMIPServerDeriveKeyEvent {
  public long connectionId;
  public int objectType;
  public String objectIds;
  public String derivationMethod;
  public byte[] initializationVector;
  public byte[] derivationData;
  public String newKeyId; //read-write
  public int operationStatus; //read-write
}

Remarks

TBD

Disconnect Event (KMIPServer Class)

Fires to report a disconnected client.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void disconnect(KMIPServerDisconnectEvent e) {}
  ...
}

public class KMIPServerDisconnectEvent {
  public long connectionID;
}

Remarks

The class fires this event when a connected client disconnects.

Encrypt Event (KMIPServer Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void encrypt(KMIPServerEncryptEvent e) {}
  ...
}

public class KMIPServerEncryptEvent {
  public long connectionId;
  public String objectId;
  public byte[] data;
  public boolean initIndicator;
  public boolean finalIndicator;
  public int blockCipherMode;
  public int tagLength;
  public int paddingMethod;
  public boolean randomIV;
  public String IV; //read-write
  public String correlationValue; //read-write
  public int operationStatus; //read-write
}

Remarks

TBD

Error Event (KMIPServer Class)

Information about errors during data delivery.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void error(KMIPServerErrorEvent e) {}
  ...
}

public class KMIPServerErrorEvent {
  public long connectionID;
  public int errorCode;
  public boolean fatal;
  public boolean remote;
  public String description;
}

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

Handles remote or external signing initiated by the server protocol.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void externalSign(KMIPServerExternalSignEvent e) {}
  ...
}

public class KMIPServerExternalSignEvent {
  public long connectionID;
  public String operationId;
  public String hashAlgorithm;
  public String pars;
  public String data;
  public String signedData; //read-write
}

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 class via the SignedData parameter.

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

The class 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 Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void generate(KMIPServerGenerateEvent e) {}
  ...
}

public class KMIPServerGenerateEvent {
  public long connectionId;
  public String publicKeyId;
  public String certId; //read-write
  public int operationStatus; //read-write
}

Remarks

TBD

GenerateKey Event (KMIPServer Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void generateKey(KMIPServerGenerateKeyEvent e) {}
  ...
}

public class KMIPServerGenerateKeyEvent {
  public long connectionId;
  public String keyAlgorithm;
  public int keyLength;
  public String group;
  public String keyId; //read-write
  public int operationStatus; //read-write
}

Remarks

TBD

GenerateKeyPair Event (KMIPServer Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void generateKeyPair(KMIPServerGenerateKeyPairEvent e) {}
  ...
}

public class KMIPServerGenerateKeyPairEvent {
  public long connectionId;
  public String keyAlgorithm;
  public int keyLength;
  public String scheme;
  public String schemeParams;
  public String group;
  public String privateKeyId; //read-write
  public String publicKeyId; //read-write
  public int operationStatus; //read-write
}

Remarks

TBD

GetUsageAllocation Event (KMIPServer Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void getUsageAllocation(KMIPServerGetUsageAllocationEvent e) {}
  ...
}

public class KMIPServerGetUsageAllocationEvent {
  public long connectionId;
  public String objectId;
  public int usageLimitsCount;
  public int operationStatus; //read-write
}

Remarks

TBD

Hash Event (KMIPServer Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void hash(KMIPServerHashEvent e) {}
  ...
}

public class KMIPServerHashEvent {
  public long connectionId;
  public String objectId;
  public String hashAlgorithm;
  public byte[] data;
  public boolean initIndicator;
  public boolean finalIndicator;
  public String correlationValue; //read-write
  public int operationStatus; //read-write
}

Remarks

TBD

HeadersPrepared Event (KMIPServer Class)

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

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void headersPrepared(KMIPServerHeadersPreparedEvent e) {}
  ...
}

public class KMIPServerHeadersPreparedEvent {
  public long connectionID;
}

Remarks

The class 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 Class)

Fires when a connected client makes an authentication attempt.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void KMIPAuthAttempt(KMIPServerKMIPAuthAttemptEvent e) {}
  ...
}

public class KMIPServerKMIPAuthAttemptEvent {
  public long connectionId;
  public String username;
  public String password;
  public boolean accept; //read-write
}

Remarks

The class 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 Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void list(KMIPServerListEvent e) {}
  ...
}

public class KMIPServerListEvent {
  public long connectionId;
  public int objectType;
  public int objectStatus;
  public boolean onlyFreshObject;
  public int offsetItems;
  public int maximumItems;
  public String objectIds; //read-write
  public int locatedItems; //read-write
  public int operationStatus; //read-write
}

Remarks

TBD

ListAttributes Event (KMIPServer Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void listAttributes(KMIPServerListAttributesEvent e) {}
  ...
}

public class KMIPServerListAttributesEvent {
  public long connectionId;
  public String objectId;
  public String attributeNames; //read-write
  public int operationStatus; //read-write
}

Remarks

TBD

Notification Event (KMIPServer Class)

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

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void notification(KMIPServerNotificationEvent e) {}
  ...
}

public class KMIPServerNotificationEvent {
  public String eventID;
  public String eventParam;
}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. 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 class, the exact action it is performing, or the document being processed, one or both may be omitted.

ObtainLease Event (KMIPServer Class)

Lets the application handle the lease request.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void obtainLease(KMIPServerObtainLeaseEvent e) {}
  ...
}

public class KMIPServerObtainLeaseEvent {
  public long connectionId;
  public String objectId;
  public int leaseTime; //read-write
  public String lastChangeDate; //read-write
  public int operationStatus; //read-write
}

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

Fires when a request is received from the client.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void operationAttempt(KMIPServerOperationAttemptEvent e) {}
  ...
}

public class KMIPServerOperationAttemptEvent {
  public long connectionId;
  public String operation;
  public String username;
  public boolean reject; //read-write
}

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

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void poll(KMIPServerPollEvent e) {}
  ...
}

public class KMIPServerPollEvent {
  public long connectionId;
  public String asyncCorrelationValue;
  public int operationStatus; //read-write
}

Remarks

TBD

ReadAttribute Event (KMIPServer Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void readAttribute(KMIPServerReadAttributeEvent e) {}
  ...
}

public class KMIPServerReadAttributeEvent {
  public long connectionId;
  public String objectId;
  public String attributeName;
  public String attributeValue; //read-write
  public int operationStatus; //read-write
}

Remarks

TBD

ReadObject Event (KMIPServer Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void readObject(KMIPServerReadObjectEvent e) {}
  ...
}

public class KMIPServerReadObjectEvent {
  public long connectionId;
  public String objectId;
  public int objectType; //read-write
  public int operationStatus; //read-write
}

Remarks

TBD

ReCertify Event (KMIPServer Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void reCertify(KMIPServerReCertifyEvent e) {}
  ...
}

public class KMIPServerReCertifyEvent {
  public long connectionId;
  public String oldCertId;
  public int offset;
  public String group;
  public String newCertId; //read-write
  public int operationStatus; //read-write
}

Remarks

TBD

RecoverObject Event (KMIPServer Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void recoverObject(KMIPServerRecoverObjectEvent e) {}
  ...
}

public class KMIPServerRecoverObjectEvent {
  public long connectionId;
  public String objectId;
  public int operationStatus; //read-write
}

Remarks

TBD

ReKey Event (KMIPServer Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void reKey(KMIPServerReKeyEvent e) {}
  ...
}

public class KMIPServerReKeyEvent {
  public long connectionId;
  public String oldKeyId;
  public int offset;
  public String group;
  public String newKeyId; //read-write
  public int operationStatus; //read-write
}

Remarks

TBD

RekeyKeyPair Event (KMIPServer Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void rekeyKeyPair(KMIPServerRekeyKeyPairEvent e) {}
  ...
}

public class KMIPServerRekeyKeyPairEvent {
  public long connectionId;
  public String oldPrivateKeyId;
  public int offset;
  public String group;
  public String newPrivateKeyId; //read-write
  public String newPublicKeyId; //read-write
  public int operationStatus; //read-write
}

Remarks

TBD

RemoveObject Event (KMIPServer Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void removeObject(KMIPServerRemoveObjectEvent e) {}
  ...
}

public class KMIPServerRemoveObjectEvent {
  public long connectionId;
  public String objectId;
  public int operationStatus; //read-write
}

Remarks

TBD

Request Event (KMIPServer Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void request(KMIPServerRequestEvent e) {}
  ...
}

public class KMIPServerRequestEvent {
  public long connectionId;
  public byte[] requestData;
}

Remarks

TBD

Response Event (KMIPServer Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void response(KMIPServerResponseEvent e) {}
  ...
}

public class KMIPServerResponseEvent {
  public long connectionId;
  public byte[] responseData;
}

Remarks

TBD

RevokeObject Event (KMIPServer Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void revokeObject(KMIPServerRevokeObjectEvent e) {}
  ...
}

public class KMIPServerRevokeObjectEvent {
  public long connectionId;
  public String objectId;
  public int reasonCode;
  public String reasonMessage;
  public int operationStatus; //read-write
}

Remarks

TBD

RNGGenerate Event (KMIPServer Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void RNGGenerate(KMIPServerRNGGenerateEvent e) {}
  ...
}

public class KMIPServerRNGGenerateEvent {
  public long connectionId;
  public int dataLength;
  public int operationStatus; //read-write
}

Remarks

TBD

RNGSeed Event (KMIPServer Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void RNGSeed(KMIPServerRNGSeedEvent e) {}
  ...
}

public class KMIPServerRNGSeedEvent {
  public long connectionId;
  public byte[] data;
  public int bytesUsed; //read-write
  public int operationStatus; //read-write
}

Remarks

TBD

SetAttribute Event (KMIPServer Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void setAttribute(KMIPServerSetAttributeEvent e) {}
  ...
}

public class KMIPServerSetAttributeEvent {
  public long connectionId;
  public String objectId;
  public String attributeName;
  public String attributeValue;
  public int operationStatus; //read-write
}

Remarks

TBD

Sign Event (KMIPServer Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void sign(KMIPServerSignEvent e) {}
  ...
}

public class KMIPServerSignEvent {
  public long connectionId;
  public String objectId;
  public String hashAlgorithm;
  public boolean inputIsHash;
  public byte[] data;
  public boolean initIndicator;
  public boolean finalIndicator;
  public String correlationValue; //read-write
  public int operationStatus; //read-write
}

Remarks

TBD

TLSCertValidate Event (KMIPServer Class)

Fires when a client certificate needs to be validated.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void TLSCertValidate(KMIPServerTLSCertValidateEvent e) {}
  ...
}

public class KMIPServerTLSCertValidateEvent {
  public long connectionID;
  public boolean accept; //read-write
}

Remarks

The class 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 Class)

Reports the setup of a TLS session.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void TLSEstablished(KMIPServerTLSEstablishedEvent e) {}
  ...
}

public class KMIPServerTLSEstablishedEvent {
  public long connectionID;
}

Remarks

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

TLSHandshake Event (KMIPServer Class)

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

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void TLSHandshake(KMIPServerTLSHandshakeEvent e) {}
  ...
}

public class KMIPServerTLSHandshakeEvent {
  public long connectionID;
  public String serverName;
  public boolean abort; //read-write
}

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

Requests a pre-shared key for TLS-PSK.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void TLSPSK(KMIPServerTLSPSKEvent e) {}
  ...
}

public class KMIPServerTLSPSKEvent {
  public long connectionID;
  public String identity;
  public String PSK; //read-write
  public String ciphersuite; //read-write
}

Remarks

The class 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 Class)

Reports closure of a TLS session.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void TLSShutdown(KMIPServerTLSShutdownEvent e) {}
  ...
}

public class KMIPServerTLSShutdownEvent {
  public long connectionID;
}

Remarks

The class 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 Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void validateChain(KMIPServerValidateChainEvent e) {}
  ...
}

public class KMIPServerValidateChainEvent {
  public long connectionId;
  public String objectIds;
  public int validity; //read-write
  public int operationStatus; //read-write
}

Remarks

TBD

Verify Event (KMIPServer Class)

TBD.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void verify(KMIPServerVerifyEvent e) {}
  ...
}

public class KMIPServerVerifyEvent {
  public long connectionId;
  public String objectId;
  public String hashAlgorithm;
  public boolean inputIsHash;
  public byte[] data;
  public byte[] signatureData;
  public boolean initIndicator;
  public boolean finalIndicator;
  public int validationResult; //read-write
  public String correlationValue; //read-write
  public int operationStatus; //read-write
}

Remarks

TBD

VerifyHash Event (KMIPServer Class)

Delegates the hash verification operation to a custom handler.

Syntax

public class DefaultKMIPServerEventListener implements KMIPServerEventListener {
  ...
  public void verifyHash(KMIPServerVerifyHashEvent e) {}
  ...
}

public class KMIPServerVerifyHashEvent {
  public long connectionId;
  public String objectId;
  public String hashAlgorithm;
  public byte[] data;
  public byte[] hash;
  public boolean initIndicator;
  public boolean finalIndicator;
  public boolean isValid; //read-write
  public String correlationValue; //read-write
  public int operationStatus; //read-write
}

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

Constructors

public Certificate( bytes,  startIndex,  count,  password);

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.

public Certificate( certBytes,  certStartIndex,  certCount,  keyBytes,  keyStartIndex,  keyCount,  password);

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.

public Certificate( bytes,  startIndex,  count);

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.

public Certificate( path,  password);

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.

public Certificate( certPath,  keyPath,  password);

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.

public Certificate( path);

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

public Certificate( stream);

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

public Certificate( stream,  password);

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

public Certificate( certStream,  keyStream,  password);

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.

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

Constructors

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

Constructors

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

Constructors

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

Constructors

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

Constructors

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

Constructors

public UserAccount();

Creates a new UserAccount object.

Config Settings (KMIPServer Class)

The class 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 class, access to these internal properties is provided through the Config method.

KMIPServer Config Settings

Base Config Settings

Trappable Errors (KMIPServer Class)

KMIPServer Errors