Struct secureblackbox::KMIPServer

Properties   Methods   Events   Config Settings   Errors  

The KMIPServer struct 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.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by SecureBlackbox. Due to this, the KMIPServer struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of KMIPServer when you have finished using the instance.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

active property (KMIPServer Struct)

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

Syntax

fn active(&self ) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

allow_keep_alive property (KMIPServer Struct)

Enables or disables keep-alive mode.

Syntax

fn allow_keep_alive(&self ) -> Result<bool, SecureBlackboxError> 
fn set_allow_keep_alive(&self, value : bool) ->  Option<SecureBlackboxError> 

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.

Data Type

bool

auth_realm property (KMIPServer Struct)

Specifies authentication realm for digest and NTLM authentication.

Syntax

fn auth_realm(&self ) -> Result<String, SecureBlackboxError> 
fn set_auth_realm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_auth_realm_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"SecureBlackbox"

Remarks

Specifies authentication realm for digest and NTLM authentication types.

Data Type

String

auth_types property (KMIPServer Struct)

Defines allowed HTTP authentication types.

Syntax

fn auth_types(&self ) -> Result<i32, SecureBlackboxError> 
fn set_auth_types(&self, value : i32) ->  Option<SecureBlackboxError> 

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:

Data Type

i32

bound_port property (KMIPServer Struct)

Indicates the bound listening port.

Syntax

fn bound_port(&self ) -> Result<i32, SecureBlackboxError> 

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 port_range_from and port_range_to constraints.

This property is read-only.

Data Type

i32

ca_cert_bytes property (KMIPServer Struct)

Returns the raw certificate data in DER format.

Syntax

fn ca_cert_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

Vec

ca_cert_handle property (KMIPServer Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn ca_cert_handle(&self ) -> Result<i64, SecureBlackboxError> 
fn set_ca_cert_handle(&self, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

Data Type

i64

certificate_bytes property (KMIPServer Struct)

Returns the raw certificate data in DER format.

Syntax

fn certificate_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

Vec

certificate_handle property (KMIPServer Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn certificate_handle(&self ) -> Result<i64, SecureBlackboxError> 
fn set_certificate_handle(&self, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

Data Type

i64

compression_level property (KMIPServer Struct)

The default compression level to use.

Syntax

fn compression_level(&self ) -> Result<i32, SecureBlackboxError> 
fn set_compression_level(&self, value : i32) ->  Option<SecureBlackboxError> 

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.

Data Type

i32

external_crypto_async_document_id property (KMIPServer Struct)

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

Syntax

fn external_crypto_async_document_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_async_document_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_async_document_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

external_crypto_custom_params property (KMIPServer Struct)

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

Syntax

fn external_crypto_custom_params(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_custom_params(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_custom_params_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

external_crypto_data property (KMIPServer Struct)

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

Syntax

fn external_crypto_data(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_data(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_data_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

external_crypto_external_hash_calculation property (KMIPServer Struct)

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

fn external_crypto_external_hash_calculation(&self ) -> Result<bool, SecureBlackboxError> 
fn set_external_crypto_external_hash_calculation(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

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

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

Data Type

bool

external_crypto_hash_algorithm property (KMIPServer Struct)

Specifies the request's signature hash algorithm.

Syntax

fn external_crypto_hash_algorithm(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_hash_algorithm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_hash_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

external_crypto_key_id property (KMIPServer Struct)

The ID of the pre-shared key used for DC request authentication.

Syntax

fn external_crypto_key_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_key_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_key_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use external_crypto_key_secret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

external_crypto_key_secret property (KMIPServer Struct)

The pre-shared key used for DC request authentication.

Syntax

fn external_crypto_key_secret(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_key_secret(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_key_secret_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the external_crypto_key_id topic.

Data Type

String

external_crypto_method property (KMIPServer Struct)

Specifies the asynchronous signing method.

Syntax

fn external_crypto_method(&self ) -> Result<i32, SecureBlackboxError> 
fn set_external_crypto_method(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // PKCS1
1   // PKCS7

Default Value

0

Remarks

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

Available options:

Data Type

i32

external_crypto_mode property (KMIPServer Struct)

Specifies the external cryptography mode.

Syntax

fn external_crypto_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_external_crypto_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Default
1   // Disabled
2   // Generic
3   // DCAuth
4   // DCAuthJSON

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

Data Type

i32

external_crypto_public_key_algorithm property (KMIPServer Struct)

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

Syntax

fn external_crypto_public_key_algorithm(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_public_key_algorithm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_public_key_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

fips_mode property (KMIPServer Struct)

Reserved.

Syntax

fn fips_mode(&self ) -> Result<bool, SecureBlackboxError> 
fn set_fips_mode(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

This property is reserved for future use.

Data Type

bool

handshake_timeout property (KMIPServer Struct)

Specifies the handshake timeout in milliseconds.

Syntax

fn handshake_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_handshake_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Data Type

i32

host property (KMIPServer Struct)

Specifies the host name of the KMIP server.

Syntax

fn host(&self ) -> Result<String, SecureBlackboxError> 
fn set_host(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_host_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

key_algorithm property (KMIPServer Struct)

The algorithm of the cryptographic key.

Syntax

fn key_algorithm(&self ) -> Result<String, SecureBlackboxError> 
fn set_key_algorithm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_key_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

key_bits property (KMIPServer Struct)

The length of the key in bits.

Syntax

fn key_bits(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The length of the key in bits.

This property is read-only.

Data Type

i32

key_curve property (KMIPServer Struct)

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

Syntax

fn key_curve(&self ) -> Result<String, SecureBlackboxError> 
fn set_key_curve(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_key_curve_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

key_exportable property (KMIPServer Struct)

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

Syntax

fn key_exportable(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

key_fingerprint property (KMIPServer Struct)

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

Syntax

fn key_fingerprint(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

key_handle property (KMIPServer Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn key_handle(&self ) -> Result<i64, SecureBlackboxError> 
fn set_key_handle(&self, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

Data Type

i64

key_id property (KMIPServer Struct)

Provides access to a storage-specific key identifier.

Syntax

fn key_id(&self ) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_key_id(&self, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_key_id_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

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

Data Type

Vec

key_iv property (KMIPServer Struct)

The initialization vector (IV) of a symmetric key.

Syntax

fn key_iv(&self ) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_key_iv(&self, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_key_iv_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

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

Data Type

Vec

key_nonce property (KMIPServer Struct)

A nonce value associated with a key.

Syntax

fn key_nonce(&self ) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_key_nonce(&self, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_key_nonce_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

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

Data Type

Vec

key_private property (KMIPServer Struct)

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

Syntax

fn key_private(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

key_public property (KMIPServer Struct)

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

Syntax

fn key_public(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

key_subject property (KMIPServer Struct)

Returns the key subject.

Syntax

fn key_subject(&self ) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_key_subject(&self, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_key_subject_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

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

Data Type

Vec

key_symmetric property (KMIPServer Struct)

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

Syntax

fn key_symmetric(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

key_valid property (KMIPServer Struct)

Returns True if this key is valid.

Syntax

fn key_valid(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

key_value property (KMIPServer Struct)

The byte array representation of the key value.

Syntax

fn key_value(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

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

This property used to be called Key in SecureBlackbox versions 2024 and older.

This property is read-only.

Data Type

Vec

pinned_client_aead_cipher property (KMIPServer Struct)

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

fn pinned_client_aead_cipher(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

This property is read-only.

Data Type

bool

pinned_client_chain_validation_details property (KMIPServer Struct)

The details of a certificate chain validation outcome.

Syntax

fn pinned_client_chain_validation_details(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

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

Returns a bit mask of the following options:

This property is read-only.

Data Type

i32

pinned_client_chain_validation_result property (KMIPServer Struct)

The outcome of a certificate chain validation routine.

Syntax

fn pinned_client_chain_validation_result(&self ) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Valid
1   // ValidButUntrusted
2   // Invalid
3   // CantBeEstablished

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

This property is read-only.

Data Type

i32

pinned_client_ciphersuite property (KMIPServer Struct)

The cipher suite employed by this connection.

Syntax

fn pinned_client_ciphersuite(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The cipher suite employed by this connection.

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

This property is read-only.

Data Type

String

pinned_client_client_authenticated property (KMIPServer Struct)

Specifies whether client authentication was performed during this connection.

Syntax

fn pinned_client_client_authenticated(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether client authentication was performed during this connection.

This property is read-only.

Data Type

bool

pinned_client_client_auth_requested property (KMIPServer Struct)

Specifies whether client authentication was requested during this connection.

Syntax

fn pinned_client_client_auth_requested(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether client authentication was requested during this connection.

This property is read-only.

Data Type

bool

pinned_client_connection_established property (KMIPServer Struct)

Indicates whether the connection has been established fully.

Syntax

fn pinned_client_connection_established(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the connection has been established fully.

This property is read-only.

Data Type

bool

pinned_client_connection_id property (KMIPServer Struct)

The unique identifier assigned to this connection.

Syntax

fn pinned_client_connection_id(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

The unique identifier assigned to this connection.

This property is read-only.

Data Type

Vec

pinned_client_digest_algorithm property (KMIPServer Struct)

The digest algorithm used in a TLS-enabled connection.

Syntax

fn pinned_client_digest_algorithm(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The digest algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

String

pinned_client_encryption_algorithm property (KMIPServer Struct)

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

Syntax

fn pinned_client_encryption_algorithm(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

pinned_client_exportable property (KMIPServer Struct)

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

Syntax

fn pinned_client_exportable(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

pinned_client_group property (KMIPServer Struct)

The elliptic curve used in this connection.

Syntax

fn pinned_client_group(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The elliptic curve used in this connection.

This property was named NamedECCurve in SecureBlackbox 2024 and earlier versions.

This property is read-only.

Data Type

String

pinned_client_id property (KMIPServer Struct)

The client connection's unique identifier.

Syntax

fn pinned_client_id(&self ) -> Result<i64, SecureBlackboxError> 

Default Value

-1

Remarks

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

This property is read-only.

Data Type

i64

pinned_client_key_exchange_algorithm property (KMIPServer Struct)

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

Syntax

fn pinned_client_key_exchange_algorithm(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

pinned_client_key_exchange_key_bits property (KMIPServer Struct)

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

Syntax

fn pinned_client_key_exchange_key_bits(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

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

This property is read-only.

Data Type

i32

pinned_client_pfs_cipher property (KMIPServer Struct)

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

Syntax

fn pinned_client_pfs_cipher(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

pinned_client_pre_shared_identity property (KMIPServer Struct)

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

Syntax

fn pinned_client_pre_shared_identity(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

pinned_client_pre_shared_identity_hint property (KMIPServer Struct)

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

Syntax

fn pinned_client_pre_shared_identity_hint(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

pinned_client_public_key_bits property (KMIPServer Struct)

The length of the public key.

Syntax

fn pinned_client_public_key_bits(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The length of the public key.

This property is read-only.

Data Type

i32

pinned_client_remote_address property (KMIPServer Struct)

The client's IP address.

Syntax

fn pinned_client_remote_address(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The client's IP address.

This property is read-only.

Data Type

String

pinned_client_remote_port property (KMIPServer Struct)

The remote port of the client connection.

Syntax

fn pinned_client_remote_port(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The remote port of the client connection.

This property is read-only.

Data Type

i32

pinned_client_resumed_session property (KMIPServer Struct)

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

Syntax

fn pinned_client_resumed_session(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

pinned_client_secure_connection property (KMIPServer Struct)

Indicates whether TLS or SSL is enabled for this connection.

Syntax

fn pinned_client_secure_connection(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether TLS or SSL is enabled for this connection.

This property is read-only.

Data Type

bool

pinned_client_server_authenticated property (KMIPServer Struct)

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

Syntax

fn pinned_client_server_authenticated(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

pinned_client_signature_algorithm property (KMIPServer Struct)

The signature algorithm used in a TLS handshake.

Syntax

fn pinned_client_signature_algorithm(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The signature algorithm used in a TLS handshake.

This property is read-only.

Data Type

String

pinned_client_symmetric_block_size property (KMIPServer Struct)

The block size of the symmetric algorithm used.

Syntax

fn pinned_client_symmetric_block_size(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The block size of the symmetric algorithm used.

This property is read-only.

Data Type

i32

pinned_client_symmetric_key_bits property (KMIPServer Struct)

The key length of the symmetric algorithm used.

Syntax

fn pinned_client_symmetric_key_bits(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The key length of the symmetric algorithm used.

This property is read-only.

Data Type

i32

pinned_client_total_bytes_received property (KMIPServer Struct)

The total number of bytes received over this connection.

Syntax

fn pinned_client_total_bytes_received(&self ) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

The total number of bytes received over this connection.

This property is read-only.

Data Type

i64

pinned_client_total_bytes_sent property (KMIPServer Struct)

The total number of bytes sent over this connection.

Syntax

fn pinned_client_total_bytes_sent(&self ) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

The total number of bytes sent over this connection.

This property is read-only.

Data Type

i64

pinned_client_validation_log property (KMIPServer Struct)

Contains the server certificate's chain validation log.

Syntax

fn pinned_client_validation_log(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

pinned_client_version property (KMIPServer Struct)

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

Syntax

fn pinned_client_version(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

pinned_client_cert_count property (KMIPServer Struct)

The number of records in the PinnedClientCert arrays.

Syntax

fn pinned_client_cert_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• pinned_client_cert_bytes
• pinned_client_cert_ca_key_id
• pinned_client_cert_fingerprint
• pinned_client_cert_handle
• pinned_client_cert_issuer
• pinned_client_cert_issuer_rdn
• pinned_client_cert_key_algorithm
• pinned_client_cert_key_bits
• pinned_client_cert_key_fingerprint
• pinned_client_cert_key_usage
• pinned_client_cert_public_key_bytes
• pinned_client_cert_self_signed
• pinned_client_cert_serial_number
• pinned_client_cert_sig_algorithm
• pinned_client_cert_subject
• pinned_client_cert_subject_key_id
• pinned_client_cert_subject_rdn
• pinned_client_cert_valid_from
• pinned_client_cert_valid_to

The array indices start at 0 and end at pinned_client_cert_count - 1.

This property is read-only.

Data Type

i32

pinned_client_cert_bytes property (KMIPServer Struct)

Returns the raw certificate data in DER format.

Syntax

fn pinned_client_cert_bytes(&self , PinnedClientCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

Vec

pinned_client_cert_ca_key_id property (KMIPServer Struct)

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

Syntax

fn pinned_client_cert_ca_key_id(&self , PinnedClientCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

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

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

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

Vec

pinned_client_cert_fingerprint property (KMIPServer Struct)

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

Syntax

fn pinned_client_cert_fingerprint(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_handle property (KMIPServer Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn pinned_client_cert_handle(&self , PinnedClientCertIndex : i32) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

i64

pinned_client_cert_issuer property (KMIPServer Struct)

The common name of the certificate issuer (CA), typically a company name.

Syntax

fn pinned_client_cert_issuer(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_issuer_rdn property (KMIPServer Struct)

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

Syntax

fn pinned_client_cert_issuer_rdn(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_key_algorithm property (KMIPServer Struct)

Specifies the public key algorithm of this certificate.

Syntax

fn pinned_client_cert_key_algorithm(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the pinned_client_cert_key_bits, pinned_client_cert_curve, and pinned_client_cert_public_key_bytes properties to get more details about the key the certificate contains.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_key_bits property (KMIPServer Struct)

Returns the length of the public key in bits.

Syntax

fn pinned_client_cert_key_bits(&self , PinnedClientCertIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Returns the length of the public key in bits.

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

i32

pinned_client_cert_key_fingerprint property (KMIPServer Struct)

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

Syntax

fn pinned_client_cert_key_fingerprint(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_key_usage property (KMIPServer Struct)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

fn pinned_client_cert_key_usage(&self , PinnedClientCertIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

i32

pinned_client_cert_public_key_bytes property (KMIPServer Struct)

Contains the certificate's public key in DER format.

Syntax

fn pinned_client_cert_public_key_bytes(&self , PinnedClientCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Contains the certificate's public key in DER format.

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

Vec

pinned_client_cert_self_signed property (KMIPServer Struct)

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

Syntax

fn pinned_client_cert_self_signed(&self , PinnedClientCertIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

bool

pinned_client_cert_serial_number property (KMIPServer Struct)

Returns the certificate's serial number.

Syntax

fn pinned_client_cert_serial_number(&self , PinnedClientCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the certificate's serial number.

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

Vec

pinned_client_cert_sig_algorithm property (KMIPServer Struct)

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

Syntax

fn pinned_client_cert_sig_algorithm(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_subject property (KMIPServer Struct)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

fn pinned_client_cert_subject(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_subject_key_id property (KMIPServer Struct)

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

Syntax

fn pinned_client_cert_subject_key_id(&self , PinnedClientCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

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

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

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

Vec

pinned_client_cert_subject_rdn property (KMIPServer Struct)

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

Syntax

fn pinned_client_cert_subject_rdn(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

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

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_valid_from property (KMIPServer Struct)

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

Syntax

fn pinned_client_cert_valid_from(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_valid_to property (KMIPServer Struct)

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

Syntax

fn pinned_client_cert_valid_to(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

port property (KMIPServer Struct)

A port to listen for connections on.

Syntax

fn port(&self ) -> Result<i32, SecureBlackboxError> 
fn set_port(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

5696

Remarks

Use this property to specify the listening port.

Data Type

i32

read_only property (KMIPServer Struct)

Controls whether the server works in read-only mode.

Syntax

fn read_only(&self ) -> Result<bool, SecureBlackboxError> 
fn set_read_only(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

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

Data Type

bool

session_timeout property (KMIPServer Struct)

Specifies the default session timeout value in milliseconds.

Syntax

fn session_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_session_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

360000

Remarks

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

Data Type

i32

socket_incoming_speed_limit property (KMIPServer Struct)

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

Syntax

fn socket_incoming_speed_limit(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_incoming_speed_limit(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

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

Data Type

i32

socket_local_address property (KMIPServer Struct)

The local network interface to bind the socket to.

Syntax

fn socket_local_address(&self ) -> Result<String, SecureBlackboxError> 
fn set_socket_local_address(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_socket_local_address_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The local network interface to bind the socket to.

Data Type

String

socket_local_port property (KMIPServer Struct)

The local port number to bind the socket to.

Syntax

fn socket_local_port(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_local_port(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

i32

socket_outgoing_speed_limit property (KMIPServer Struct)

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

Syntax

fn socket_outgoing_speed_limit(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_outgoing_speed_limit(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

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

Data Type

i32

socket_timeout property (KMIPServer Struct)

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

Syntax

fn socket_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

60000

Remarks

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

Data Type

i32

socket_use_ipv6 property (KMIPServer Struct)

Enables or disables IP protocol version 6.

Syntax

fn socket_use_ipv6(&self ) -> Result<bool, SecureBlackboxError> 
fn set_socket_use_ipv6(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

bool

storage_file_name property (KMIPServer Struct)

A path to the KMIP object database.

Syntax

fn storage_file_name(&self ) -> Result<String, SecureBlackboxError> 
fn set_storage_file_name(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_storage_file_name_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

tls_server_cert_count property (KMIPServer Struct)

The number of records in the TLSServerCert arrays.

Syntax

fn tls_server_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_server_cert_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• tls_server_cert_bytes
• tls_server_cert_handle

The array indices start at 0 and end at tls_server_cert_count - 1.

Data Type

i32

tls_server_cert_bytes property (KMIPServer Struct)

Returns the raw certificate data in DER format.

Syntax

fn tls_server_cert_bytes(&self , TLSServerCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

Vec

tls_server_cert_handle property (KMIPServer Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn tls_server_cert_handle(&self , TLSServerCertIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_tls_server_cert_handle(&self, TLSServerCertIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

Data Type

i64

tls_auto_validate_certificates property (KMIPServer Struct)

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

Syntax

fn tls_auto_validate_certificates(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_auto_validate_certificates(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

true

Remarks

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

Data Type

bool

tls_base_configuration property (KMIPServer Struct)

Selects the base configuration for the TLS settings.

Syntax

fn tls_base_configuration(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_base_configuration(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Default
1   // Compatible
2   // ComprehensiveInsecure
3   // HighlySecure

Default Value

0

Remarks

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

Data Type

i32

tls_ciphersuites property (KMIPServer Struct)

A list of ciphersuites separated with commas or semicolons.

Syntax

fn tls_ciphersuites(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_ciphersuites(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_ciphersuites_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by tls_base_configuration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

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

Data Type

String

tls_client_auth property (KMIPServer Struct)

Enables or disables certificate-based client authentication.

Syntax

fn tls_client_auth(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_client_auth(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // NoAuth
1   // RequestCert
2   // RequireCert

Default Value

0

Remarks

Enables or disables certificate-based client authentication.

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

Data Type

i32

tls_extensions property (KMIPServer Struct)

Provides access to TLS extensions.

Syntax

fn tls_extensions(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_extensions(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_extensions_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Provides access to TLS extensions.

Data Type

String

tls_force_resume_if_destination_changes property (KMIPServer Struct)

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

Syntax

fn tls_force_resume_if_destination_changes(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_force_resume_if_destination_changes(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

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

Data Type

bool

tls_groups property (KMIPServer Struct)

Specifies a list of key exchange groups to attempt during the TLS key exchange.

Syntax

fn tls_groups(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_groups(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_groups_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies a list of key exchange groups to attempt during the TLS key exchange.

Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the all placeholder:

// Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048"; // Only enable the hybrid X25519/ML-KEM768 group client.TLSSettings.Groups = "-all;+x25519mlkem768";

The list of groups supported by the component is provided below. All the names are case-insensitive:

Elliptic curve-based groups:

• SECT163K1
• SECT163R1
• SECT163R2
• SECT193R1
• SECT193R2
• SECT233K1
• SECT233R1
• SECT239K1
• SECT283K1
• SECT283R1
• SECT409K1
• SECT409R1
• SECT571K1
• SECT571R1
• SECP160K1
• SECP160R1
• SECP160R2
• SECP192K1
• SECP192R1
• SECP224K1
• SECP224R1
• SECP256K1
• SECP256R1
• SECP384R1
• SECP521R1
• BRAINPOOLP256R1
• BRAINPOOLP384R1
• BRAINPOOLP512R1
• X25519
• X448

Finite field-based groups:

• FFDHE2048
• FFDHE3072
• FFDHE4096
• FFDHE6144
• FFDHE8192

Post-Quantum and Hybrid groups:

• MLKEM512
• MLKEM768
• MLKEM1024
• SECP256R1MLKEM768
• X25519MLKEM768
• SECP384R1MLKEM1024

Note: this property was called ECCurves in SecureBlackbox 2024 and older.

Data Type

String

tls_pre_shared_identity property (KMIPServer Struct)

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

Syntax

fn tls_pre_shared_identity(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_pre_shared_identity(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_pre_shared_identity_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

tls_pre_shared_key property (KMIPServer Struct)

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

Syntax

fn tls_pre_shared_key(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_pre_shared_key(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_pre_shared_key_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

tls_pre_shared_key_ciphersuite property (KMIPServer Struct)

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

Syntax

fn tls_pre_shared_key_ciphersuite(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_pre_shared_key_ciphersuite(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_pre_shared_key_ciphersuite_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

tls_renegotiation_attack_prevention_mode property (KMIPServer Struct)

Selects the renegotiation attack prevention mechanism.

Syntax

fn tls_renegotiation_attack_prevention_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_renegotiation_attack_prevention_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Compatible
1   // Strict
2   // Auto

Default Value

2

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

i32

tls_revocation_check property (KMIPServer Struct)

Specifies the kind(s) of revocation check to perform.

Syntax

fn tls_revocation_check(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_revocation_check(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // None
1   // Auto
2   // AllCRL
3   // AllOCSP
4   // AllCRLAndOCSP
5   // AnyCRL
6   // AnyOCSP
7   // AnyCRLOrOCSP
8   // AnyOCSPOrCRL

Default Value

1

Remarks

Specifies the kind(s) of revocation check to perform.

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

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

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

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

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

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

Data Type

i32

tls_ssl_options property (KMIPServer Struct)

Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.

Syntax

fn tls_ssl_options(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_ssl_options(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

i32

tls_mode property (KMIPServer Struct)

Specifies the TLS mode to use.

Syntax

fn tls_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Default
1   // NoTLS
2   // ExplicitTLS
3   // ImplicitTLS
4   // MixedTLS

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

i32

tls_use_extended_master_secret property (KMIPServer Struct)

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

Syntax

fn tls_use_extended_master_secret(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_use_extended_master_secret(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

true

Remarks

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

Data Type

bool

tls_use_session_resumption property (KMIPServer Struct)

Enables or disables the TLS session resumption capability.

Syntax

fn tls_use_session_resumption(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_use_session_resumption(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

bool

tls_versions property (KMIPServer Struct)

The SSL/TLS versions to enable by default.

Syntax

fn tls_versions(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_versions(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

48

Remarks

The SSL/TLS versions to enable by default.

Data Type

i32

use_chunked_transfer property (KMIPServer Struct)

Enables chunked transfer.

Syntax

fn use_chunked_transfer(&self ) -> Result<bool, SecureBlackboxError> 
fn set_use_chunked_transfer(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Use this property to enable chunked content encoding.

Data Type

bool

use_compression property (KMIPServer Struct)

Enables or disables server-side compression.

Syntax

fn use_compression(&self ) -> Result<bool, SecureBlackboxError> 
fn set_use_compression(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

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

Data Type

bool

use_http property (KMIPServer Struct)

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

Syntax

fn use_http(&self ) -> Result<bool, SecureBlackboxError> 
fn set_use_http(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

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

Data Type

bool

user_count property (KMIPServer Struct)

The number of records in the User arrays.

Syntax

fn user_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_user_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• user_associated_data
• user_base_path
• user_certificate
• user_data
• user_email
• user_handle
• user_hash_algorithm
• user_incoming_speed_limit
• username
• user_otp_algorithm
• user_otp_len
• user_otp_value
• user_outgoing_speed_limit
• user_password
• user_shared_secret
• user_ssh_key

The array indices start at 0 and end at user_count - 1.

Data Type

i32

user_associated_data property (KMIPServer Struct)

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

Syntax

fn user_associated_data(&self , UserIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_user_associated_data(&self, UserIndex : i32, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_user_associated_data_ref(&self, UserIndex : i32, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

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

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

Vec

user_base_path property (KMIPServer Struct)

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

Syntax

fn user_base_path(&self , UserIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_user_base_path(&self, UserIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_user_base_path_ref(&self, UserIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

String

user_certificate property (KMIPServer Struct)

Contains the user's certificate.

Syntax

fn user_certificate(&self , UserIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_user_certificate(&self, UserIndex : i32, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_user_certificate_ref(&self, UserIndex : i32, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

Contains the user's certificate.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

Vec

user_data property (KMIPServer Struct)

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

Syntax

fn user_data(&self , UserIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_user_data(&self, UserIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_user_data_ref(&self, UserIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

String

user_email property (KMIPServer Struct)

The user's email address.

Syntax

fn user_email(&self , UserIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_user_email(&self, UserIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_user_email_ref(&self, UserIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The user's email address.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

String

user_handle property (KMIPServer Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn user_handle(&self , UserIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_user_handle(&self, UserIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

i64

user_hash_algorithm property (KMIPServer Struct)

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user.

Syntax

fn user_hash_algorithm(&self , UserIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_user_hash_algorithm(&self, UserIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_user_hash_algorithm_ref(&self, UserIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests:

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

String

user_incoming_speed_limit property (KMIPServer Struct)

Specifies the incoming speed limit for this user.

Syntax

fn user_incoming_speed_limit(&self , UserIndex : i32) -> Result<i32, SecureBlackboxError> 
fn set_user_incoming_speed_limit(&self, UserIndex : i32, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

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

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

i32

user_otp_algorithm property (KMIPServer Struct)

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP).

Syntax

fn user_otp_algorithm(&self , UserIndex : i32) -> Result<i32, SecureBlackboxError> 
fn set_user_otp_algorithm(&self, UserIndex : i32, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // None
1   // Hmac
2   // Time

Default Value

0

Remarks

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

i32

user_otp_len property (KMIPServer Struct)

Specifies the length of the user's OTP password.

Syntax

fn user_otp_len(&self , UserIndex : i32) -> Result<i32, SecureBlackboxError> 
fn set_user_otp_len(&self, UserIndex : i32, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Specifies the length of the user's OTP password.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

i32

user_otp_value property (KMIPServer Struct)

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

Syntax

fn user_otp_value(&self , UserIndex : i32) -> Result<i32, SecureBlackboxError> 
fn set_user_otp_value(&self, UserIndex : i32, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

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

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

i32

user_outgoing_speed_limit property (KMIPServer Struct)

Specifies the outgoing speed limit for this user.

Syntax

fn user_outgoing_speed_limit(&self , UserIndex : i32) -> Result<i32, SecureBlackboxError> 
fn set_user_outgoing_speed_limit(&self, UserIndex : i32, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

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

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

i32

user_password property (KMIPServer Struct)

The user's authentication password.

Syntax

fn user_password(&self , UserIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_user_password(&self, UserIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_user_password_ref(&self, UserIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The user's authentication password.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

String

user_shared_secret property (KMIPServer Struct)

Contains the user's secret key, which is essentially a shared secret between the client and server.

Syntax

fn user_shared_secret(&self , UserIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_user_shared_secret(&self, UserIndex : i32, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_user_shared_secret_ref(&self, UserIndex : i32, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

Contains the user's secret key, which is essentially a shared secret between the client and server.

Shared secrets can be used in TLS-driven protocols, as well as in OTP (where it is called a 'key secret') for generating one-time passwords on one side, and validate them on the other.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

Vec

user_ssh_key property (KMIPServer Struct)

Contains the user's SSH key.

Syntax

fn user_ssh_key(&self , UserIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_user_ssh_key(&self, UserIndex : i32, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_user_ssh_key_ref(&self, UserIndex : i32, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

Contains the user's SSH key.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

Vec

username property (KMIPServer Struct)

The registered name (login) of the user.

Syntax

fn username(&self , UserIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_username(&self, UserIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_username_ref(&self, UserIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The registered name (login) of the user.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

String

cleanup method (KMIPServer Struct)

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

Syntax

fn cleanup(&self) -> Result<(), SecureBlackboxError>

Remarks

Call this method while the server is active to clean up the environment allocated for the server by releasing unused resources and cleaning caches.

config method (KMIPServer Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, SecureBlackboxError>

Remarks

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

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

do_action method (KMIPServer Struct)

Performs an additional action.

Syntax

fn do_action(&self, action_id : &str, action_params : &str) ->  Result<String, SecureBlackboxError>

Remarks

do_action is a generic method available in every struct. 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;....

Common ActionIDs:

drop_client method (KMIPServer Struct)

Terminates a client connection.

Syntax

fn drop_client(&self, connection_id : i64, forced : bool) -> Result<(), SecureBlackboxError>

Remarks

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

get_client_cert method (KMIPServer Struct)

Populates the per-connection certificate object.

Syntax

fn get_client_cert(&self, connection_id : i64) -> Result<(), SecureBlackboxError>

Remarks

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

Call this method from your on_before_generate 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 on_after_generate event handler to populate the certificate that has been generated.

get_client_key method (KMIPServer Struct)

Populates the per-connection key object.

Syntax

fn get_client_key(&self, connection_id : i64) -> Result<(), SecureBlackboxError>

Remarks

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

Call this method from your on_before_generate_key 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 on_after_generate_key event handler to populate the key that has been generated.

get_request_header method (KMIPServer Struct)

Returns a request header value.

Syntax

fn get_request_header(&self, connection_id : i64, header_name : &str) ->  Result<String, SecureBlackboxError>

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 on_get_request or on_post_request.

get_response_header method (KMIPServer Struct)

Returns a response header value.

Syntax

fn get_response_header(&self, connection_id : i64, header_name : &str) ->  Result<String, SecureBlackboxError>

Remarks

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

list_clients method (KMIPServer Struct)

Enumerates the connected clients.

Syntax

fn list_clients(&self) ->  Result<String, SecureBlackboxError>

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.

pin_client method (KMIPServer Struct)

Takes a snapshot of the connection's properties.

Syntax

fn pin_client(&self, connection_id : i64) -> Result<(), SecureBlackboxError>

Remarks

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

process_generic_request method (KMIPServer Struct)

Processes a generic HTTP request.

Syntax

fn process_generic_request(&self, connection_id : i64, request_bytes : &[u8]) ->  Result<Vec<u8>, SecureBlackboxError>

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

Resets the struct settings.

Syntax

fn reset(&self) -> Result<(), SecureBlackboxError>

Remarks

reset is a generic method available in every struct.

set_client_bytes method (KMIPServer Struct)

Commits a data buffer to the connection.

Syntax

fn set_client_bytes(&self, connection_id : i64, value : &[u8]) -> Result<(), SecureBlackboxError>

Remarks

Use this method from your on_response on_encrypt on_after_encrypt on_decrypt on_after_decrypt on_sign on_after_sign events handler to commit a new data to the server component.

set_client_cert method (KMIPServer Struct)

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

Syntax

fn set_client_cert(&self, connection_id : i64) -> Result<(), SecureBlackboxError>

Remarks

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

set_client_key method (KMIPServer Struct)

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

Syntax

fn set_client_key(&self, connection_id : i64) -> Result<(), SecureBlackboxError>

Remarks

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

set_response_header method (KMIPServer Struct)

Sets a response header.

Syntax

fn set_response_header(&self, connection_id : i64, header_name : &str, value : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to set a response header. A good place to call this method is a request-marking event, such as on_get_request or on_post_request.

start method (KMIPServer Struct)

Start the KMIP server.

Syntax

fn start(&self) -> Result<(), SecureBlackboxError>

Remarks

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

stop method (KMIPServer Struct)

Stops the KMIP server.

Syntax

fn stop(&self) -> Result<(), SecureBlackboxError>

Remarks

Call this method to stop the KMIP server.

on_accept event (KMIPServer Struct)

Reports an incoming connection.

Syntax

// KMIPServerAcceptEventArgs carries the KMIPServer Accept event's parameters.
pub struct KMIPServerAcceptEventArgs {
  fn remote_address(&self) -> &String
  fn remote_port(&self) -> i32
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// KMIPServerAcceptEvent defines the signature of the KMIPServer Accept event's handler function.
pub trait KMIPServerAcceptEvent {
  fn on_accept(&self, sender : KMIPServer, e : &mut KMIPServerAcceptEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_accept(&self) -> &'a dyn KMIPServerAcceptEvent;
  pub fn set_on_accept(&mut self, value : &'a dyn KMIPServerAcceptEvent);
  ...
}

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 on_connect event to be notified of every connection that has been set up.

on_activate_object event (KMIPServer Struct)

Notifies the application about the object activation request.

Syntax

// KMIPServerActivateObjectEventArgs carries the KMIPServer ActivateObject event's parameters.
pub struct KMIPServerActivateObjectEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerActivateObjectEvent defines the signature of the KMIPServer ActivateObject event's handler function.
pub trait KMIPServerActivateObjectEvent {
  fn on_activate_object(&self, sender : KMIPServer, e : &mut KMIPServerActivateObjectEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_activate_object(&self) -> &'a dyn KMIPServerActivateObjectEvent;
  pub fn set_on_activate_object(&mut self, value : &'a dyn KMIPServerActivateObjectEvent);
  ...
}

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.

on_add event (KMIPServer Struct)

Passes the certificate import request to the application.

Syntax

// KMIPServerAddEventArgs carries the KMIPServer Add event's parameters.
pub struct KMIPServerAddEventArgs {
  fn connection_id(&self) -> i64
  fn group(&self) -> &String
  fn set_group(&self, value : &str)
  fn set_group_ref(&self, value : &String)
  fn cert_id(&self) -> &String
  fn set_cert_id(&self, value : &str)
  fn set_cert_id_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerAddEvent defines the signature of the KMIPServer Add event's handler function.
pub trait KMIPServerAddEvent {
  fn on_add(&self, sender : KMIPServer, e : &mut KMIPServerAddEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_add(&self) -> &'a dyn KMIPServerAddEvent;
  pub fn set_on_add(&mut self, value : &'a dyn KMIPServerAddEvent);
  ...
}

Remarks

The server uses this event to allow the application to customize a certificate import request. This request fires after on_before_add 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.

on_add_key event (KMIPServer Struct)

Expects the application to handle the key import request.

Syntax

// KMIPServerAddKeyEventArgs carries the KMIPServer AddKey event's parameters.
pub struct KMIPServerAddKeyEventArgs {
  fn connection_id(&self) -> i64
  fn group(&self) -> &String
  fn set_group(&self, value : &str)
  fn set_group_ref(&self, value : &String)
  fn key_id(&self) -> &String
  fn set_key_id(&self, value : &str)
  fn set_key_id_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerAddKeyEvent defines the signature of the KMIPServer AddKey event's handler function.
pub trait KMIPServerAddKeyEvent {
  fn on_add_key(&self, sender : KMIPServer, e : &mut KMIPServerAddKeyEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_add_key(&self) -> &'a dyn KMIPServerAddKeyEvent;
  pub fn set_on_add_key(&mut self, value : &'a dyn KMIPServerAddKeyEvent);
  ...
}

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 on_before_add_key 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 Three-step Virtualization article for more details about handling and virtualizing requests in SecureBlackbox servers.

on_after_add event (KMIPServer Struct)

Notifies the application about completion of the certificate import operation.

Syntax

// KMIPServerAfterAddEventArgs carries the KMIPServer AfterAdd event's parameters.
pub struct KMIPServerAfterAddEventArgs {
  fn connection_id(&self) -> i64
  fn group(&self) -> &String
  fn set_group(&self, value : &str)
  fn set_group_ref(&self, value : &String)
  fn cert_id(&self) -> &String
  fn set_cert_id(&self, value : &str)
  fn set_cert_id_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerAfterAddEvent defines the signature of the KMIPServer AfterAdd event's handler function.
pub trait KMIPServerAfterAddEvent {
  fn on_after_add(&self, sender : KMIPServer, e : &mut KMIPServerAfterAddEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_after_add(&self) -> &'a dyn KMIPServerAfterAddEvent;
  pub fn set_on_after_add(&mut self, value : &'a dyn KMIPServerAfterAddEvent);
  ...
}

Remarks

The struct 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.

on_after_add_key event (KMIPServer Struct)

Reports the completion of the key import procedure.

Syntax

// KMIPServerAfterAddKeyEventArgs carries the KMIPServer AfterAddKey event's parameters.
pub struct KMIPServerAfterAddKeyEventArgs {
  fn connection_id(&self) -> i64
  fn group(&self) -> &String
  fn set_group(&self, value : &str)
  fn set_group_ref(&self, value : &String)
  fn key_id(&self) -> &String
  fn set_key_id(&self, value : &str)
  fn set_key_id_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerAfterAddKeyEvent defines the signature of the KMIPServer AfterAddKey event's handler function.
pub trait KMIPServerAfterAddKeyEvent {
  fn on_after_add_key(&self, sender : KMIPServer, e : &mut KMIPServerAfterAddKeyEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_after_add_key(&self) -> &'a dyn KMIPServerAfterAddKeyEvent;
  pub fn set_on_after_add_key(&mut self, value : &'a dyn KMIPServerAfterAddKeyEvent);
  ...
}

Remarks

The component uses the on_after_add_key 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 on_before_add_key event. See the Three-step Virtualization article for more details about handling and virtualizing requests in SecureBlackbox servers.

on_after_browse event (KMIPServer Struct)

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

Syntax

// KMIPServerAfterBrowseEventArgs carries the KMIPServer AfterBrowse event's parameters.
pub struct KMIPServerAfterBrowseEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerAfterBrowseEvent defines the signature of the KMIPServer AfterBrowse event's handler function.
pub trait KMIPServerAfterBrowseEvent {
  fn on_after_browse(&self, sender : KMIPServer, e : &mut KMIPServerAfterBrowseEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_after_browse(&self) -> &'a dyn KMIPServerAfterBrowseEvent;
  pub fn set_on_after_browse(&mut self, value : &'a dyn KMIPServerAfterBrowseEvent);
  ...
}

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 on_before_browse and on_read_attribute events.

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

See the Three-step Virtualization article for more details about handling and virtualizing requests in SecureBlackbox servers.

on_after_decrypt event (KMIPServer Struct)

Notifies the application about completion of the decryption call.

Syntax

// KMIPServerAfterDecryptEventArgs carries the KMIPServer AfterDecrypt event's parameters.
pub struct KMIPServerAfterDecryptEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn decrypted_data(&self) -> &[u8]
  fn correlation_value(&self) -> &String
  fn set_correlation_value(&self, value : &str)
  fn set_correlation_value_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerAfterDecryptEvent defines the signature of the KMIPServer AfterDecrypt event's handler function.
pub trait KMIPServerAfterDecryptEvent {
  fn on_after_decrypt(&self, sender : KMIPServer, e : &mut KMIPServerAfterDecryptEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_after_decrypt(&self) -> &'a dyn KMIPServerAfterDecryptEvent;
  pub fn set_on_after_decrypt(&mut self, value : &'a dyn KMIPServerAfterDecryptEvent);
  ...
}

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 Three-step Virtualization article for more details about handling and virtualizing requests in SecureBlackbox servers.

on_after_derive_key event (KMIPServer Struct)

Notifies the application about completion of the key derivation request.

Syntax

// KMIPServerAfterDeriveKeyEventArgs carries the KMIPServer AfterDeriveKey event's parameters.
pub struct KMIPServerAfterDeriveKeyEventArgs {
  fn connection_id(&self) -> i64
  fn new_key_id(&self) -> &String
  fn set_new_key_id(&self, value : &str)
  fn set_new_key_id_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerAfterDeriveKeyEvent defines the signature of the KMIPServer AfterDeriveKey event's handler function.
pub trait KMIPServerAfterDeriveKeyEvent {
  fn on_after_derive_key(&self, sender : KMIPServer, e : &mut KMIPServerAfterDeriveKeyEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_after_derive_key(&self) -> &'a dyn KMIPServerAfterDeriveKeyEvent;
  pub fn set_on_after_derive_key(&mut self, value : &'a dyn KMIPServerAfterDeriveKeyEvent);
  ...
}

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 Three-step Virtualization article for more details about handling and virtualizing requests in SecureBlackbox servers.

on_after_edit event (KMIPServer Struct)

Notifies the application of completion of the object editing operation.

Syntax

// KMIPServerAfterEditEventArgs carries the KMIPServer AfterEdit event's parameters.
pub struct KMIPServerAfterEditEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerAfterEditEvent defines the signature of the KMIPServer AfterEdit event's handler function.
pub trait KMIPServerAfterEditEvent {
  fn on_after_edit(&self, sender : KMIPServer, e : &mut KMIPServerAfterEditEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_after_edit(&self) -> &'a dyn KMIPServerAfterEditEvent;
  pub fn set_on_after_edit(&mut self, value : &'a dyn KMIPServerAfterEditEvent);
  ...
}

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.

on_after_encrypt event (KMIPServer Struct)

Notifies the application about the completion of the encryption call.

Syntax

// KMIPServerAfterEncryptEventArgs carries the KMIPServer AfterEncrypt event's parameters.
pub struct KMIPServerAfterEncryptEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn encrypted_data(&self) -> &[u8]
  fn correlation_value(&self) -> &String
  fn set_correlation_value(&self, value : &str)
  fn set_correlation_value_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerAfterEncryptEvent defines the signature of the KMIPServer AfterEncrypt event's handler function.
pub trait KMIPServerAfterEncryptEvent {
  fn on_after_encrypt(&self, sender : KMIPServer, e : &mut KMIPServerAfterEncryptEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_after_encrypt(&self) -> &'a dyn KMIPServerAfterEncryptEvent;
  pub fn set_on_after_encrypt(&mut self, value : &'a dyn KMIPServerAfterEncryptEvent);
  ...
}

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 Three-step Virtualization article for more details about handling and virtualizing requests in SecureBlackbox servers.

on_after_generate event (KMIPServer Struct)

Signifies completion of certificate generation.

Syntax

// KMIPServerAfterGenerateEventArgs carries the KMIPServer AfterGenerate event's parameters.
pub struct KMIPServerAfterGenerateEventArgs {
  fn connection_id(&self) -> i64
  fn cert_id(&self) -> &String
  fn set_cert_id(&self, value : &str)
  fn set_cert_id_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerAfterGenerateEvent defines the signature of the KMIPServer AfterGenerate event's handler function.
pub trait KMIPServerAfterGenerateEvent {
  fn on_after_generate(&self, sender : KMIPServer, e : &mut KMIPServerAfterGenerateEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_after_generate(&self) -> &'a dyn KMIPServerAfterGenerateEvent;
  pub fn set_on_after_generate(&mut self, value : &'a dyn KMIPServerAfterGenerateEvent);
  ...
}

Remarks

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

on_after_generate_key event (KMIPServer Struct)

Notifies the application of the completion of key generation procedure.

Syntax

// KMIPServerAfterGenerateKeyEventArgs carries the KMIPServer AfterGenerateKey event's parameters.
pub struct KMIPServerAfterGenerateKeyEventArgs {
  fn connection_id(&self) -> i64
  fn key_id(&self) -> &String
  fn set_key_id(&self, value : &str)
  fn set_key_id_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerAfterGenerateKeyEvent defines the signature of the KMIPServer AfterGenerateKey event's handler function.
pub trait KMIPServerAfterGenerateKeyEvent {
  fn on_after_generate_key(&self, sender : KMIPServer, e : &mut KMIPServerAfterGenerateKeyEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_after_generate_key(&self) -> &'a dyn KMIPServerAfterGenerateKeyEvent;
  pub fn set_on_after_generate_key(&mut self, value : &'a dyn KMIPServerAfterGenerateKeyEvent);
  ...
}

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 on_before_generate_key, on_generate_key, and the on_after_generate_key events. See the Three-step Virtualization article for more details about handling and virtualizing requests in SecureBlackbox servers.

on_after_generate_key_pair event (KMIPServer Struct)

Notifies the application of the completion of keypair generation.

Syntax

// KMIPServerAfterGenerateKeyPairEventArgs carries the KMIPServer AfterGenerateKeyPair event's parameters.
pub struct KMIPServerAfterGenerateKeyPairEventArgs {
  fn connection_id(&self) -> i64
  fn private_key_id(&self) -> &String
  fn set_private_key_id(&self, value : &str)
  fn set_private_key_id_ref(&self, value : &String)
  fn public_key_id(&self) -> &String
  fn set_public_key_id(&self, value : &str)
  fn set_public_key_id_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerAfterGenerateKeyPairEvent defines the signature of the KMIPServer AfterGenerateKeyPair event's handler function.
pub trait KMIPServerAfterGenerateKeyPairEvent {
  fn on_after_generate_key_pair(&self, sender : KMIPServer, e : &mut KMIPServerAfterGenerateKeyPairEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_after_generate_key_pair(&self) -> &'a dyn KMIPServerAfterGenerateKeyPairEvent;
  pub fn set_on_after_generate_key_pair(&mut self, value : &'a dyn KMIPServerAfterGenerateKeyPairEvent);
  ...
}

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 Three-step Virtualization article for more details about handling and virtualizing requests in SecureBlackbox servers.

on_after_hash event (KMIPServer Struct)

Notifies the application about completion of the hashing call.

Syntax

// KMIPServerAfterHashEventArgs carries the KMIPServer AfterHash event's parameters.
pub struct KMIPServerAfterHashEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn hash_data(&self) -> &[u8]
  fn correlation_value(&self) -> &String
  fn set_correlation_value(&self, value : &str)
  fn set_correlation_value_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerAfterHashEvent defines the signature of the KMIPServer AfterHash event's handler function.
pub trait KMIPServerAfterHashEvent {
  fn on_after_hash(&self, sender : KMIPServer, e : &mut KMIPServerAfterHashEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_after_hash(&self) -> &'a dyn KMIPServerAfterHashEvent;
  pub fn set_on_after_hash(&mut self, value : &'a dyn KMIPServerAfterHashEvent);
  ...
}

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 Three-step Virtualization article for more details about handling and virtualizing requests in SecureBlackbox servers.

on_after_list event (KMIPServer Struct)

Notifies the application about completion of the list command.

Syntax

// KMIPServerAfterListEventArgs carries the KMIPServer AfterList event's parameters.
pub struct KMIPServerAfterListEventArgs {
  fn connection_id(&self) -> i64
  fn object_type(&self) -> i32
  fn object_status(&self) -> i32
  fn only_fresh_objects(&self) -> bool
  fn object_ids(&self) -> &String
  fn set_object_ids(&self, value : &str)
  fn set_object_ids_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerAfterListEvent defines the signature of the KMIPServer AfterList event's handler function.
pub trait KMIPServerAfterListEvent {
  fn on_after_list(&self, sender : KMIPServer, e : &mut KMIPServerAfterListEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_after_list(&self) -> &'a dyn KMIPServerAfterListEvent;
  pub fn set_on_after_list(&mut self, value : &'a dyn KMIPServerAfterListEvent);
  ...
}

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 Three-step Virtualization article for more details about handling and virtualizing requests in SecureBlackbox servers.

on_after_obtain_lease event (KMIPServer Struct)

Reports the completion of lease allocation operation.

Syntax

// KMIPServerAfterObtainLeaseEventArgs carries the KMIPServer AfterObtainLease event's parameters.
pub struct KMIPServerAfterObtainLeaseEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn lease_time(&self) -> i32
  fn set_lease_time(&self, value : i32)
  fn last_change_date(&self) -> &String
  fn set_last_change_date(&self, value : &str)
  fn set_last_change_date_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerAfterObtainLeaseEvent defines the signature of the KMIPServer AfterObtainLease event's handler function.
pub trait KMIPServerAfterObtainLeaseEvent {
  fn on_after_obtain_lease(&self, sender : KMIPServer, e : &mut KMIPServerAfterObtainLeaseEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_after_obtain_lease(&self) -> &'a dyn KMIPServerAfterObtainLeaseEvent;
  pub fn set_on_after_obtain_lease(&mut self, value : &'a dyn KMIPServerAfterObtainLeaseEvent);
  ...
}

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 Three-step Virtualization article for more details about handling and virtualizing requests in SecureBlackbox servers.

on_after_read_object event (KMIPServer Struct)

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

Syntax

// KMIPServerAfterReadObjectEventArgs carries the KMIPServer AfterReadObject event's parameters.
pub struct KMIPServerAfterReadObjectEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn object_type(&self) -> i32
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerAfterReadObjectEvent defines the signature of the KMIPServer AfterReadObject event's handler function.
pub trait KMIPServerAfterReadObjectEvent {
  fn on_after_read_object(&self, sender : KMIPServer, e : &mut KMIPServerAfterReadObjectEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_after_read_object(&self) -> &'a dyn KMIPServerAfterReadObjectEvent;
  pub fn set_on_after_read_object(&mut self, value : &'a dyn KMIPServerAfterReadObjectEvent);
  ...
}

Remarks

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

See the Three-step Virtualization article for more details about handling and virtualizing requests in SecureBlackbox servers.

on_after_re_certify event (KMIPServer Struct)

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

Syntax

// KMIPServerAfterReCertifyEventArgs carries the KMIPServer AfterReCertify event's parameters.
pub struct KMIPServerAfterReCertifyEventArgs {
  fn connection_id(&self) -> i64
  fn new_cert_id(&self) -> &String
  fn set_new_cert_id(&self, value : &str)
  fn set_new_cert_id_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerAfterReCertifyEvent defines the signature of the KMIPServer AfterReCertify event's handler function.
pub trait KMIPServerAfterReCertifyEvent {
  fn on_after_re_certify(&self, sender : KMIPServer, e : &mut KMIPServerAfterReCertifyEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_after_re_certify(&self) -> &'a dyn KMIPServerAfterReCertifyEvent;
  pub fn set_on_after_re_certify(&mut self, value : &'a dyn KMIPServerAfterReCertifyEvent);
  ...
}

Remarks

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

on_after_re_key event (KMIPServer Struct)

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

Syntax

// KMIPServerAfterReKeyEventArgs carries the KMIPServer AfterReKey event's parameters.
pub struct KMIPServerAfterReKeyEventArgs {
  fn connection_id(&self) -> i64
  fn new_key_id(&self) -> &String
  fn set_new_key_id(&self, value : &str)
  fn set_new_key_id_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerAfterReKeyEvent defines the signature of the KMIPServer AfterReKey event's handler function.
pub trait KMIPServerAfterReKeyEvent {
  fn on_after_re_key(&self, sender : KMIPServer, e : &mut KMIPServerAfterReKeyEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_after_re_key(&self) -> &'a dyn KMIPServerAfterReKeyEvent;
  pub fn set_on_after_re_key(&mut self, value : &'a dyn KMIPServerAfterReKeyEvent);
  ...
}

Remarks

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

on_after_rekey_key_pair event (KMIPServer Struct)

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

Syntax

// KMIPServerAfterRekeyKeyPairEventArgs carries the KMIPServer AfterRekeyKeyPair event's parameters.
pub struct KMIPServerAfterRekeyKeyPairEventArgs {
  fn connection_id(&self) -> i64
  fn new_private_key_id(&self) -> &String
  fn set_new_private_key_id(&self, value : &str)
  fn set_new_private_key_id_ref(&self, value : &String)
  fn new_public_key_id(&self) -> &String
  fn set_new_public_key_id(&self, value : &str)
  fn set_new_public_key_id_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerAfterRekeyKeyPairEvent defines the signature of the KMIPServer AfterRekeyKeyPair event's handler function.
pub trait KMIPServerAfterRekeyKeyPairEvent {
  fn on_after_rekey_key_pair(&self, sender : KMIPServer, e : &mut KMIPServerAfterRekeyKeyPairEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_after_rekey_key_pair(&self) -> &'a dyn KMIPServerAfterRekeyKeyPairEvent;
  pub fn set_on_after_rekey_key_pair(&mut self, value : &'a dyn KMIPServerAfterRekeyKeyPairEvent);
  ...
}

Remarks

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

on_after_remove_object event (KMIPServer Struct)

Notifies the application about completion of the object removal request.

Syntax

// KMIPServerAfterRemoveObjectEventArgs carries the KMIPServer AfterRemoveObject event's parameters.
pub struct KMIPServerAfterRemoveObjectEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerAfterRemoveObjectEvent defines the signature of the KMIPServer AfterRemoveObject event's handler function.
pub trait KMIPServerAfterRemoveObjectEvent {
  fn on_after_remove_object(&self, sender : KMIPServer, e : &mut KMIPServerAfterRemoveObjectEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_after_remove_object(&self) -> &'a dyn KMIPServerAfterRemoveObjectEvent;
  pub fn set_on_after_remove_object(&mut self, value : &'a dyn KMIPServerAfterRemoveObjectEvent);
  ...
}

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 Three-step Virtualization article for more details about handling and virtualizing requests in SecureBlackbox servers.

on_after_sign event (KMIPServer Struct)

Notifies the application of completion of a signing operation.

Syntax

// KMIPServerAfterSignEventArgs carries the KMIPServer AfterSign event's parameters.
pub struct KMIPServerAfterSignEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn input_is_hash(&self) -> bool
  fn signature_data(&self) -> &[u8]
  fn correlation_value(&self) -> &String
  fn set_correlation_value(&self, value : &str)
  fn set_correlation_value_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerAfterSignEvent defines the signature of the KMIPServer AfterSign event's handler function.
pub trait KMIPServerAfterSignEvent {
  fn on_after_sign(&self, sender : KMIPServer, e : &mut KMIPServerAfterSignEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_after_sign(&self) -> &'a dyn KMIPServerAfterSignEvent;
  pub fn set_on_after_sign(&mut self, value : &'a dyn KMIPServerAfterSignEvent);
  ...
}

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 Three-step Virtualization article for more details about handling and virtualizing requests in SecureBlackbox servers.

on_after_verify event (KMIPServer Struct)

Notifies the application about completion of the Verify operation.

Syntax

// KMIPServerAfterVerifyEventArgs carries the KMIPServer AfterVerify event's parameters.
pub struct KMIPServerAfterVerifyEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn input_is_hash(&self) -> bool
  fn validation_result(&self) -> i32
  fn set_validation_result(&self, value : i32)
  fn correlation_value(&self) -> &String
  fn set_correlation_value(&self, value : &str)
  fn set_correlation_value_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerAfterVerifyEvent defines the signature of the KMIPServer AfterVerify event's handler function.
pub trait KMIPServerAfterVerifyEvent {
  fn on_after_verify(&self, sender : KMIPServer, e : &mut KMIPServerAfterVerifyEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_after_verify(&self) -> &'a dyn KMIPServerAfterVerifyEvent;
  pub fn set_on_after_verify(&mut self, value : &'a dyn KMIPServerAfterVerifyEvent);
  ...
}

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 Three-step Virtualization article for more details about handling and virtualizing requests in SecureBlackbox servers.

on_after_verify_hash event (KMIPServer Struct)

Notifies the application about completion of the hash verification.

Syntax

// KMIPServerAfterVerifyHashEventArgs carries the KMIPServer AfterVerifyHash event's parameters.
pub struct KMIPServerAfterVerifyHashEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn is_valid(&self) -> bool
  fn set_is_valid(&self, value : bool)
  fn correlation_value(&self) -> &String
  fn set_correlation_value(&self, value : &str)
  fn set_correlation_value_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerAfterVerifyHashEvent defines the signature of the KMIPServer AfterVerifyHash event's handler function.
pub trait KMIPServerAfterVerifyHashEvent {
  fn on_after_verify_hash(&self, sender : KMIPServer, e : &mut KMIPServerAfterVerifyHashEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_after_verify_hash(&self) -> &'a dyn KMIPServerAfterVerifyHashEvent;
  pub fn set_on_after_verify_hash(&mut self, value : &'a dyn KMIPServerAfterVerifyHashEvent);
  ...
}

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 Three-step Virtualization article for more details about handling and virtualizing requests in SecureBlackbox servers.

on_archive_object event (KMIPServer Struct)

Notifies the application about the received object archival request.

Syntax

// KMIPServerArchiveObjectEventArgs carries the KMIPServer ArchiveObject event's parameters.
pub struct KMIPServerArchiveObjectEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerArchiveObjectEvent defines the signature of the KMIPServer ArchiveObject event's handler function.
pub trait KMIPServerArchiveObjectEvent {
  fn on_archive_object(&self, sender : KMIPServer, e : &mut KMIPServerArchiveObjectEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_archive_object(&self) -> &'a dyn KMIPServerArchiveObjectEvent;
  pub fn set_on_archive_object(&mut self, value : &'a dyn KMIPServerArchiveObjectEvent);
  ...
}

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.

on_auth_attempt event (KMIPServer Struct)

Fires when a connected client makes an authentication attempt.

Syntax

// KMIPServerAuthAttemptEventArgs carries the KMIPServer AuthAttempt event's parameters.
pub struct KMIPServerAuthAttemptEventArgs {
  fn connection_id(&self) -> i64
  fn http_method(&self) -> &String
  fn uri(&self) -> &String
  fn auth_method(&self) -> &String
  fn username(&self) -> &String
  fn password(&self) -> &String
  fn allow(&self) -> bool
  fn set_allow(&self, value : bool)
}

// KMIPServerAuthAttemptEvent defines the signature of the KMIPServer AuthAttempt event's handler function.
pub trait KMIPServerAuthAttemptEvent {
  fn on_auth_attempt(&self, sender : KMIPServer, e : &mut KMIPServerAuthAttemptEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_auth_attempt(&self) -> &'a dyn KMIPServerAuthAttemptEvent;
  pub fn set_on_auth_attempt(&mut self, value : &'a dyn KMIPServerAuthAttemptEvent);
  ...
}

Remarks

The struct 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.

on_before_add event (KMIPServer Struct)

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

Syntax

// KMIPServerBeforeAddEventArgs carries the KMIPServer BeforeAdd event's parameters.
pub struct KMIPServerBeforeAddEventArgs {
  fn connection_id(&self) -> i64
  fn group(&self) -> &String
  fn set_group(&self, value : &str)
  fn set_group_ref(&self, value : &String)
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// KMIPServerBeforeAddEvent defines the signature of the KMIPServer BeforeAdd event's handler function.
pub trait KMIPServerBeforeAddEvent {
  fn on_before_add(&self, sender : KMIPServer, e : &mut KMIPServerBeforeAddEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_before_add(&self) -> &'a dyn KMIPServerBeforeAddEvent;
  pub fn set_on_before_add(&mut self, value : &'a dyn KMIPServerBeforeAddEvent);
  ...
}

Remarks

The struct 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.

on_before_add_key event (KMIPServer Struct)

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

Syntax

// KMIPServerBeforeAddKeyEventArgs carries the KMIPServer BeforeAddKey event's parameters.
pub struct KMIPServerBeforeAddKeyEventArgs {
  fn connection_id(&self) -> i64
  fn group(&self) -> &String
  fn set_group(&self, value : &str)
  fn set_group_ref(&self, value : &String)
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// KMIPServerBeforeAddKeyEvent defines the signature of the KMIPServer BeforeAddKey event's handler function.
pub trait KMIPServerBeforeAddKeyEvent {
  fn on_before_add_key(&self, sender : KMIPServer, e : &mut KMIPServerBeforeAddKeyEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_before_add_key(&self) -> &'a dyn KMIPServerBeforeAddKeyEvent;
  pub fn set_on_before_add_key(&mut self, value : &'a dyn KMIPServerBeforeAddKeyEvent);
  ...
}

Remarks

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

on_before_browse event (KMIPServer Struct)

Notifies the application about the browse request being received.

Syntax

// KMIPServerBeforeBrowseEventArgs carries the KMIPServer BeforeBrowse event's parameters.
pub struct KMIPServerBeforeBrowseEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// KMIPServerBeforeBrowseEvent defines the signature of the KMIPServer BeforeBrowse event's handler function.
pub trait KMIPServerBeforeBrowseEvent {
  fn on_before_browse(&self, sender : KMIPServer, e : &mut KMIPServerBeforeBrowseEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_before_browse(&self) -> &'a dyn KMIPServerBeforeBrowseEvent;
  pub fn set_on_before_browse(&mut self, value : &'a dyn KMIPServerBeforeBrowseEvent);
  ...
}

Remarks

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

on_before_decrypt event (KMIPServer Struct)

Notifies the application about the initiation of the decryption operation.

Syntax

// KMIPServerBeforeDecryptEventArgs carries the KMIPServer BeforeDecrypt event's parameters.
pub struct KMIPServerBeforeDecryptEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn correlation_value(&self) -> &String
  fn set_correlation_value(&self, value : &str)
  fn set_correlation_value_ref(&self, value : &String)
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// KMIPServerBeforeDecryptEvent defines the signature of the KMIPServer BeforeDecrypt event's handler function.
pub trait KMIPServerBeforeDecryptEvent {
  fn on_before_decrypt(&self, sender : KMIPServer, e : &mut KMIPServerBeforeDecryptEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_before_decrypt(&self) -> &'a dyn KMIPServerBeforeDecryptEvent;
  pub fn set_on_before_decrypt(&mut self, value : &'a dyn KMIPServerBeforeDecryptEvent);
  ...
}

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 Three-step Virtualization article for more details about handling and virtualizing requests in SecureBlackbox servers.

on_before_derive_key event (KMIPServer Struct)

Fires when a derive key request is received.

Syntax

// KMIPServerBeforeDeriveKeyEventArgs carries the KMIPServer BeforeDeriveKey event's parameters.
pub struct KMIPServerBeforeDeriveKeyEventArgs {
  fn connection_id(&self) -> i64
  fn object_type(&self) -> i32
  fn object_ids(&self) -> &String
  fn derivation_method(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// KMIPServerBeforeDeriveKeyEvent defines the signature of the KMIPServer BeforeDeriveKey event's handler function.
pub trait KMIPServerBeforeDeriveKeyEvent {
  fn on_before_derive_key(&self, sender : KMIPServer, e : &mut KMIPServerBeforeDeriveKeyEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_before_derive_key(&self) -> &'a dyn KMIPServerBeforeDeriveKeyEvent;
  pub fn set_on_before_derive_key(&mut self, value : &'a dyn KMIPServerBeforeDeriveKeyEvent);
  ...
}

Remarks

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

on_before_edit event (KMIPServer Struct)

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

Syntax

// KMIPServerBeforeEditEventArgs carries the KMIPServer BeforeEdit event's parameters.
pub struct KMIPServerBeforeEditEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// KMIPServerBeforeEditEvent defines the signature of the KMIPServer BeforeEdit event's handler function.
pub trait KMIPServerBeforeEditEvent {
  fn on_before_edit(&self, sender : KMIPServer, e : &mut KMIPServerBeforeEditEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_before_edit(&self) -> &'a dyn KMIPServerBeforeEditEvent;
  pub fn set_on_before_edit(&mut self, value : &'a dyn KMIPServerBeforeEditEvent);
  ...
}

Remarks

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

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

on_before_encrypt event (KMIPServer Struct)

Notifies the application about the initiation of an encryption operation.

Syntax

// KMIPServerBeforeEncryptEventArgs carries the KMIPServer BeforeEncrypt event's parameters.
pub struct KMIPServerBeforeEncryptEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn correlation_value(&self) -> &String
  fn set_correlation_value(&self, value : &str)
  fn set_correlation_value_ref(&self, value : &String)
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// KMIPServerBeforeEncryptEvent defines the signature of the KMIPServer BeforeEncrypt event's handler function.
pub trait KMIPServerBeforeEncryptEvent {
  fn on_before_encrypt(&self, sender : KMIPServer, e : &mut KMIPServerBeforeEncryptEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_before_encrypt(&self) -> &'a dyn KMIPServerBeforeEncryptEvent;
  pub fn set_on_before_encrypt(&mut self, value : &'a dyn KMIPServerBeforeEncryptEvent);
  ...
}

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 Three-step Virtualization article for more details about handling and virtualizing requests in SecureBlackbox servers.

on_before_generate event (KMIPServer Struct)

Fires when a certificate generation request is received.

Syntax

// KMIPServerBeforeGenerateEventArgs carries the KMIPServer BeforeGenerate event's parameters.
pub struct KMIPServerBeforeGenerateEventArgs {
  fn connection_id(&self) -> i64
  fn public_key_id(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// KMIPServerBeforeGenerateEvent defines the signature of the KMIPServer BeforeGenerate event's handler function.
pub trait KMIPServerBeforeGenerateEvent {
  fn on_before_generate(&self, sender : KMIPServer, e : &mut KMIPServerBeforeGenerateEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_before_generate(&self) -> &'a dyn KMIPServerBeforeGenerateEvent;
  pub fn set_on_before_generate(&mut self, value : &'a dyn KMIPServerBeforeGenerateEvent);
  ...
}

Remarks

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

on_before_generate_key event (KMIPServer Struct)

Fires when a key generation request is received.

Syntax

// KMIPServerBeforeGenerateKeyEventArgs carries the KMIPServer BeforeGenerateKey event's parameters.
pub struct KMIPServerBeforeGenerateKeyEventArgs {
  fn connection_id(&self) -> i64
  fn key_algorithm(&self) -> &String
  fn set_key_algorithm(&self, value : &str)
  fn set_key_algorithm_ref(&self, value : &String)
  fn key_length(&self) -> i32
  fn set_key_length(&self, value : i32)
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// KMIPServerBeforeGenerateKeyEvent defines the signature of the KMIPServer BeforeGenerateKey event's handler function.
pub trait KMIPServerBeforeGenerateKeyEvent {
  fn on_before_generate_key(&self, sender : KMIPServer, e : &mut KMIPServerBeforeGenerateKeyEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_before_generate_key(&self) -> &'a dyn KMIPServerBeforeGenerateKeyEvent;
  pub fn set_on_before_generate_key(&mut self, value : &'a dyn KMIPServerBeforeGenerateKeyEvent);
  ...
}

Remarks

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

on_before_generate_key_pair event (KMIPServer Struct)

Fires when a key generation request is received.

Syntax

// KMIPServerBeforeGenerateKeyPairEventArgs carries the KMIPServer BeforeGenerateKeyPair event's parameters.
pub struct KMIPServerBeforeGenerateKeyPairEventArgs {
  fn connection_id(&self) -> i64
  fn key_algorithm(&self) -> &String
  fn set_key_algorithm(&self, value : &str)
  fn set_key_algorithm_ref(&self, value : &String)
  fn key_length(&self) -> i32
  fn set_key_length(&self, value : i32)
  fn scheme(&self) -> &String
  fn set_scheme(&self, value : &str)
  fn set_scheme_ref(&self, value : &String)
  fn scheme_params(&self) -> &String
  fn set_scheme_params(&self, value : &str)
  fn set_scheme_params_ref(&self, value : &String)
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// KMIPServerBeforeGenerateKeyPairEvent defines the signature of the KMIPServer BeforeGenerateKeyPair event's handler function.
pub trait KMIPServerBeforeGenerateKeyPairEvent {
  fn on_before_generate_key_pair(&self, sender : KMIPServer, e : &mut KMIPServerBeforeGenerateKeyPairEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_before_generate_key_pair(&self) -> &'a dyn KMIPServerBeforeGenerateKeyPairEvent;
  pub fn set_on_before_generate_key_pair(&mut self, value : &'a dyn KMIPServerBeforeGenerateKeyPairEvent);
  ...
}

Remarks

The struct 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.

on_before_hash event (KMIPServer Struct)

Notifies the application about the initiation of the hashing operation.

Syntax

// KMIPServerBeforeHashEventArgs carries the KMIPServer BeforeHash event's parameters.
pub struct KMIPServerBeforeHashEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn hash_algorithm(&self) -> &String
  fn correlation_value(&self) -> &String
  fn set_correlation_value(&self, value : &str)
  fn set_correlation_value_ref(&self, value : &String)
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// KMIPServerBeforeHashEvent defines the signature of the KMIPServer BeforeHash event's handler function.
pub trait KMIPServerBeforeHashEvent {
  fn on_before_hash(&self, sender : KMIPServer, e : &mut KMIPServerBeforeHashEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_before_hash(&self) -> &'a dyn KMIPServerBeforeHashEvent;
  pub fn set_on_before_hash(&mut self, value : &'a dyn KMIPServerBeforeHashEvent);
  ...
}

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 Three-step Virtualization article for more details about handling and virtualizing requests in SecureBlackbox servers.

on_before_list event (KMIPServer Struct)

Notifies the application about the initiation of the list operation.

Syntax

// KMIPServerBeforeListEventArgs carries the KMIPServer BeforeList event's parameters.
pub struct KMIPServerBeforeListEventArgs {
  fn connection_id(&self) -> i64
  fn object_type(&self) -> i32
  fn object_status(&self) -> i32
  fn only_fresh_objects(&self) -> bool
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// KMIPServerBeforeListEvent defines the signature of the KMIPServer BeforeList event's handler function.
pub trait KMIPServerBeforeListEvent {
  fn on_before_list(&self, sender : KMIPServer, e : &mut KMIPServerBeforeListEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_before_list(&self) -> &'a dyn KMIPServerBeforeListEvent;
  pub fn set_on_before_list(&mut self, value : &'a dyn KMIPServerBeforeListEvent);
  ...
}

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.

on_before_obtain_lease event (KMIPServer Struct)

Notifies the application about the client requesting an object lease.

Syntax

// KMIPServerBeforeObtainLeaseEventArgs carries the KMIPServer BeforeObtainLease event's parameters.
pub struct KMIPServerBeforeObtainLeaseEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// KMIPServerBeforeObtainLeaseEvent defines the signature of the KMIPServer BeforeObtainLease event's handler function.
pub trait KMIPServerBeforeObtainLeaseEvent {
  fn on_before_obtain_lease(&self, sender : KMIPServer, e : &mut KMIPServerBeforeObtainLeaseEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_before_obtain_lease(&self) -> &'a dyn KMIPServerBeforeObtainLeaseEvent;
  pub fn set_on_before_obtain_lease(&mut self, value : &'a dyn KMIPServerBeforeObtainLeaseEvent);
  ...
}

Remarks

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

on_before_read_object event (KMIPServer Struct)

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

Syntax

// KMIPServerBeforeReadObjectEventArgs carries the KMIPServer BeforeReadObject event's parameters.
pub struct KMIPServerBeforeReadObjectEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// KMIPServerBeforeReadObjectEvent defines the signature of the KMIPServer BeforeReadObject event's handler function.
pub trait KMIPServerBeforeReadObjectEvent {
  fn on_before_read_object(&self, sender : KMIPServer, e : &mut KMIPServerBeforeReadObjectEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_before_read_object(&self) -> &'a dyn KMIPServerBeforeReadObjectEvent;
  pub fn set_on_before_read_object(&mut self, value : &'a dyn KMIPServerBeforeReadObjectEvent);
  ...
}

Remarks

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

on_before_re_certify event (KMIPServer Struct)

Notifies the application about a re-certification request.

Syntax

// KMIPServerBeforeReCertifyEventArgs carries the KMIPServer BeforeReCertify event's parameters.
pub struct KMIPServerBeforeReCertifyEventArgs {
  fn connection_id(&self) -> i64
  fn old_cert_id(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// KMIPServerBeforeReCertifyEvent defines the signature of the KMIPServer BeforeReCertify event's handler function.
pub trait KMIPServerBeforeReCertifyEvent {
  fn on_before_re_certify(&self, sender : KMIPServer, e : &mut KMIPServerBeforeReCertifyEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_before_re_certify(&self) -> &'a dyn KMIPServerBeforeReCertifyEvent;
  pub fn set_on_before_re_certify(&mut self, value : &'a dyn KMIPServerBeforeReCertifyEvent);
  ...
}

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 on_re_certify call that will let you handle the actual request as required.

on_before_re_key event (KMIPServer Struct)

Notifies the application about a re-key request received.

Syntax

// KMIPServerBeforeReKeyEventArgs carries the KMIPServer BeforeReKey event's parameters.
pub struct KMIPServerBeforeReKeyEventArgs {
  fn connection_id(&self) -> i64
  fn old_key_id(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// KMIPServerBeforeReKeyEvent defines the signature of the KMIPServer BeforeReKey event's handler function.
pub trait KMIPServerBeforeReKeyEvent {
  fn on_before_re_key(&self, sender : KMIPServer, e : &mut KMIPServerBeforeReKeyEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_before_re_key(&self) -> &'a dyn KMIPServerBeforeReKeyEvent;
  pub fn set_on_before_re_key(&mut self, value : &'a dyn KMIPServerBeforeReKeyEvent);
  ...
}

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.

on_before_rekey_key_pair event (KMIPServer Struct)

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

Syntax

// KMIPServerBeforeRekeyKeyPairEventArgs carries the KMIPServer BeforeRekeyKeyPair event's parameters.
pub struct KMIPServerBeforeRekeyKeyPairEventArgs {
  fn connection_id(&self) -> i64
  fn old_private_key_id(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// KMIPServerBeforeRekeyKeyPairEvent defines the signature of the KMIPServer BeforeRekeyKeyPair event's handler function.
pub trait KMIPServerBeforeRekeyKeyPairEvent {
  fn on_before_rekey_key_pair(&self, sender : KMIPServer, e : &mut KMIPServerBeforeRekeyKeyPairEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_before_rekey_key_pair(&self) -> &'a dyn KMIPServerBeforeRekeyKeyPairEvent;
  pub fn set_on_before_rekey_key_pair(&mut self, value : &'a dyn KMIPServerBeforeRekeyKeyPairEvent);
  ...
}

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.

on_before_remove_object event (KMIPServer Struct)

Notifies the application about an incoming Remove Object request.

Syntax

// KMIPServerBeforeRemoveObjectEventArgs carries the KMIPServer BeforeRemoveObject event's parameters.
pub struct KMIPServerBeforeRemoveObjectEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// KMIPServerBeforeRemoveObjectEvent defines the signature of the KMIPServer BeforeRemoveObject event's handler function.
pub trait KMIPServerBeforeRemoveObjectEvent {
  fn on_before_remove_object(&self, sender : KMIPServer, e : &mut KMIPServerBeforeRemoveObjectEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_before_remove_object(&self) -> &'a dyn KMIPServerBeforeRemoveObjectEvent;
  pub fn set_on_before_remove_object(&mut self, value : &'a dyn KMIPServerBeforeRemoveObjectEvent);
  ...
}

Remarks

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

on_before_sign event (KMIPServer Struct)

Notifies the application about the initiation of a signing operation.

Syntax

// KMIPServerBeforeSignEventArgs carries the KMIPServer BeforeSign event's parameters.
pub struct KMIPServerBeforeSignEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn algorithm(&self) -> &String
  fn hash_algorithm(&self) -> &String
  fn input_is_hash(&self) -> bool
  fn correlation_value(&self) -> &String
  fn set_correlation_value(&self, value : &str)
  fn set_correlation_value_ref(&self, value : &String)
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// KMIPServerBeforeSignEvent defines the signature of the KMIPServer BeforeSign event's handler function.
pub trait KMIPServerBeforeSignEvent {
  fn on_before_sign(&self, sender : KMIPServer, e : &mut KMIPServerBeforeSignEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_before_sign(&self) -> &'a dyn KMIPServerBeforeSignEvent;
  pub fn set_on_before_sign(&mut self, value : &'a dyn KMIPServerBeforeSignEvent);
  ...
}

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 Three-step Virtualization article for more details about handling and virtualizing requests in SecureBlackbox servers.

on_before_verify event (KMIPServer Struct)

Notifies the application about the initiation of the verify operation.

Syntax

// KMIPServerBeforeVerifyEventArgs carries the KMIPServer BeforeVerify event's parameters.
pub struct KMIPServerBeforeVerifyEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn hash_algorithm(&self) -> &String
  fn input_is_hash(&self) -> bool
  fn correlation_value(&self) -> &String
  fn set_correlation_value(&self, value : &str)
  fn set_correlation_value_ref(&self, value : &String)
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// KMIPServerBeforeVerifyEvent defines the signature of the KMIPServer BeforeVerify event's handler function.
pub trait KMIPServerBeforeVerifyEvent {
  fn on_before_verify(&self, sender : KMIPServer, e : &mut KMIPServerBeforeVerifyEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_before_verify(&self) -> &'a dyn KMIPServerBeforeVerifyEvent;
  pub fn set_on_before_verify(&mut self, value : &'a dyn KMIPServerBeforeVerifyEvent);
  ...
}

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 Three-step Virtualization article for more details about handling and virtualizing requests in SecureBlackbox servers.

on_before_verify_hash event (KMIPServer Struct)

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

Syntax

// KMIPServerBeforeVerifyHashEventArgs carries the KMIPServer BeforeVerifyHash event's parameters.
pub struct KMIPServerBeforeVerifyHashEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn hash_algorithm(&self) -> &String
  fn correlation_value(&self) -> &String
  fn set_correlation_value(&self, value : &str)
  fn set_correlation_value_ref(&self, value : &String)
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// KMIPServerBeforeVerifyHashEvent defines the signature of the KMIPServer BeforeVerifyHash event's handler function.
pub trait KMIPServerBeforeVerifyHashEvent {
  fn on_before_verify_hash(&self, sender : KMIPServer, e : &mut KMIPServerBeforeVerifyHashEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_before_verify_hash(&self) -> &'a dyn KMIPServerBeforeVerifyHashEvent;
  pub fn set_on_before_verify_hash(&mut self, value : &'a dyn KMIPServerBeforeVerifyHashEvent);
  ...
}

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 Three-step Virtualization article for more details about handling and virtualizing requests in SecureBlackbox servers.

on_cancel event (KMIPServer Struct)

Reports a cancellation request received from the client.

Syntax

// KMIPServerCancelEventArgs carries the KMIPServer Cancel event's parameters.
pub struct KMIPServerCancelEventArgs {
  fn connection_id(&self) -> i64
  fn async_correlation_value(&self) -> &String
  fn cancellation_result(&self) -> i32
  fn set_cancellation_result(&self, value : i32)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerCancelEvent defines the signature of the KMIPServer Cancel event's handler function.
pub trait KMIPServerCancelEvent {
  fn on_cancel(&self, sender : KMIPServer, e : &mut KMIPServerCancelEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_cancel(&self) -> &'a dyn KMIPServerCancelEvent;
  pub fn set_on_cancel(&mut self, value : &'a dyn KMIPServerCancelEvent);
  ...
}

Remarks

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

on_check event (KMIPServer Struct)

Notifies the application about a Check request received.

Syntax

// KMIPServerCheckEventArgs carries the KMIPServer Check event's parameters.
pub struct KMIPServerCheckEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn usage_limits_count(&self) -> i64
  fn set_usage_limits_count(&self, value : i64)
  fn cryptographic_usage_mask(&self) -> i32
  fn set_cryptographic_usage_mask(&self, value : i32)
  fn lease_time(&self) -> i32
  fn set_lease_time(&self, value : i32)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerCheckEvent defines the signature of the KMIPServer Check event's handler function.
pub trait KMIPServerCheckEvent {
  fn on_check(&self, sender : KMIPServer, e : &mut KMIPServerCheckEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_check(&self) -> &'a dyn KMIPServerCheckEvent;
  pub fn set_on_check(&mut self, value : &'a dyn KMIPServerCheckEvent);
  ...
}

Remarks

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

on_connect event (KMIPServer Struct)

Reports an accepted connection.

Syntax

// KMIPServerConnectEventArgs carries the KMIPServer Connect event's parameters.
pub struct KMIPServerConnectEventArgs {
  fn connection_id(&self) -> i64
  fn remote_address(&self) -> &String
  fn remote_port(&self) -> i32
}

// KMIPServerConnectEvent defines the signature of the KMIPServer Connect event's handler function.
pub trait KMIPServerConnectEvent {
  fn on_connect(&self, sender : KMIPServer, e : &mut KMIPServerConnectEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_connect(&self) -> &'a dyn KMIPServerConnectEvent;
  pub fn set_on_connect(&mut self, value : &'a dyn KMIPServerConnectEvent);
  ...
}

Remarks

The struct 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 on_get_request or on_auth_attempt.

on_decrypt event (KMIPServer Struct)

Instructs the application to decrypt a chunk of data.

Syntax

// KMIPServerDecryptEventArgs carries the KMIPServer Decrypt event's parameters.
pub struct KMIPServerDecryptEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn data(&self) -> &[u8]
  fn iv(&self) -> &String
  fn init_indicator(&self) -> bool
  fn final_indicator(&self) -> bool
  fn block_cipher_mode(&self) -> &String
  fn tag_length(&self) -> i32
  fn padding_method(&self) -> &String
  fn correlation_value(&self) -> &String
  fn set_correlation_value(&self, value : &str)
  fn set_correlation_value_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerDecryptEvent defines the signature of the KMIPServer Decrypt event's handler function.
pub trait KMIPServerDecryptEvent {
  fn on_decrypt(&self, sender : KMIPServer, e : &mut KMIPServerDecryptEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_decrypt(&self) -> &'a dyn KMIPServerDecryptEvent;
  pub fn set_on_decrypt(&mut self, value : &'a dyn KMIPServerDecryptEvent);
  ...
}

Remarks

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

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

on_delete_attribute event (KMIPServer Struct)

Instructs the application to delete an object attribute.

Syntax

// KMIPServerDeleteAttributeEventArgs carries the KMIPServer DeleteAttribute event's parameters.
pub struct KMIPServerDeleteAttributeEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn attribute_name(&self) -> &String
  fn attribute_value(&self) -> &String
  fn set_attribute_value(&self, value : &str)
  fn set_attribute_value_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerDeleteAttributeEvent defines the signature of the KMIPServer DeleteAttribute event's handler function.
pub trait KMIPServerDeleteAttributeEvent {
  fn on_delete_attribute(&self, sender : KMIPServer, e : &mut KMIPServerDeleteAttributeEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_delete_attribute(&self) -> &'a dyn KMIPServerDeleteAttributeEvent;
  pub fn set_on_delete_attribute(&mut self, value : &'a dyn KMIPServerDeleteAttributeEvent);
  ...
}

Remarks

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

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

on_derive_key event (KMIPServer Struct)

Notifies the application of key derivation request.

Syntax

// KMIPServerDeriveKeyEventArgs carries the KMIPServer DeriveKey event's parameters.
pub struct KMIPServerDeriveKeyEventArgs {
  fn connection_id(&self) -> i64
  fn object_type(&self) -> i32
  fn object_ids(&self) -> &String
  fn derivation_method(&self) -> &String
  fn initialization_vector(&self) -> &[u8]
  fn derivation_data(&self) -> &[u8]
  fn new_key_id(&self) -> &String
  fn set_new_key_id(&self, value : &str)
  fn set_new_key_id_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerDeriveKeyEvent defines the signature of the KMIPServer DeriveKey event's handler function.
pub trait KMIPServerDeriveKeyEvent {
  fn on_derive_key(&self, sender : KMIPServer, e : &mut KMIPServerDeriveKeyEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_derive_key(&self) -> &'a dyn KMIPServerDeriveKeyEvent;
  pub fn set_on_derive_key(&mut self, value : &'a dyn KMIPServerDeriveKeyEvent);
  ...
}

Remarks

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

on_disconnect event (KMIPServer Struct)

Fires to report a disconnected client.

Syntax

// KMIPServerDisconnectEventArgs carries the KMIPServer Disconnect event's parameters.
pub struct KMIPServerDisconnectEventArgs {
  fn connection_id(&self) -> i64
}

// KMIPServerDisconnectEvent defines the signature of the KMIPServer Disconnect event's handler function.
pub trait KMIPServerDisconnectEvent {
  fn on_disconnect(&self, sender : KMIPServer, e : &mut KMIPServerDisconnectEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_disconnect(&self) -> &'a dyn KMIPServerDisconnectEvent;
  pub fn set_on_disconnect(&mut self, value : &'a dyn KMIPServerDisconnectEvent);
  ...
}

Remarks

The struct fires this event when a connected client disconnects.

on_encrypt event (KMIPServer Struct)

Instructs the application to encrypt a chunk of data.

Syntax

// KMIPServerEncryptEventArgs carries the KMIPServer Encrypt event's parameters.
pub struct KMIPServerEncryptEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn data(&self) -> &[u8]
  fn init_indicator(&self) -> bool
  fn final_indicator(&self) -> bool
  fn block_cipher_mode(&self) -> &String
  fn tag_length(&self) -> i32
  fn padding_method(&self) -> &String
  fn random_iv(&self) -> bool
  fn iv(&self) -> &String
  fn set_iv(&self, value : &str)
  fn set_iv_ref(&self, value : &String)
  fn correlation_value(&self) -> &String
  fn set_correlation_value(&self, value : &str)
  fn set_correlation_value_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerEncryptEvent defines the signature of the KMIPServer Encrypt event's handler function.
pub trait KMIPServerEncryptEvent {
  fn on_encrypt(&self, sender : KMIPServer, e : &mut KMIPServerEncryptEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_encrypt(&self) -> &'a dyn KMIPServerEncryptEvent;
  pub fn set_on_encrypt(&mut self, value : &'a dyn KMIPServerEncryptEvent);
  ...
}

Remarks

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

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

on_error event (KMIPServer Struct)

Information about errors during data delivery.

Syntax

// KMIPServerErrorEventArgs carries the KMIPServer Error event's parameters.
pub struct KMIPServerErrorEventArgs {
  fn connection_id(&self) -> i64
  fn error_code(&self) -> i32
  fn fatal(&self) -> bool
  fn remote(&self) -> bool
  fn description(&self) -> &String
}

// KMIPServerErrorEvent defines the signature of the KMIPServer Error event's handler function.
pub trait KMIPServerErrorEvent {
  fn on_error(&self, sender : KMIPServer, e : &mut KMIPServerErrorEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_error(&self) -> &'a dyn KMIPServerErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn KMIPServerErrorEvent);
  ...
}

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.

on_external_sign event (KMIPServer Struct)

Handles remote or external signing initiated by the server protocol.

Syntax

// KMIPServerExternalSignEventArgs carries the KMIPServer ExternalSign event's parameters.
pub struct KMIPServerExternalSignEventArgs {
  fn connection_id(&self) -> i64
  fn operation_id(&self) -> &String
  fn hash_algorithm(&self) -> &String
  fn pars(&self) -> &String
  fn data(&self) -> &String
  fn signed_data(&self) -> &String
  fn set_signed_data(&self, value : &str)
  fn set_signed_data_ref(&self, value : &String)
}

// KMIPServerExternalSignEvent defines the signature of the KMIPServer ExternalSign event's handler function.
pub trait KMIPServerExternalSignEvent {
  fn on_external_sign(&self, sender : KMIPServer, e : &mut KMIPServerExternalSignEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_external_sign(&self) -> &'a dyn KMIPServerExternalSignEvent;
  pub fn set_on_external_sign(&mut self, value : &'a dyn KMIPServerExternalSignEvent);
  ...
}

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

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

The struct 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(); };

on_generate event (KMIPServer Struct)

Notifies the application about an incoming Generate request.

Syntax

// KMIPServerGenerateEventArgs carries the KMIPServer Generate event's parameters.
pub struct KMIPServerGenerateEventArgs {
  fn connection_id(&self) -> i64
  fn public_key_id(&self) -> &String
  fn cert_id(&self) -> &String
  fn set_cert_id(&self, value : &str)
  fn set_cert_id_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerGenerateEvent defines the signature of the KMIPServer Generate event's handler function.
pub trait KMIPServerGenerateEvent {
  fn on_generate(&self, sender : KMIPServer, e : &mut KMIPServerGenerateEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_generate(&self) -> &'a dyn KMIPServerGenerateEvent;
  pub fn set_on_generate(&mut self, value : &'a dyn KMIPServerGenerateEvent);
  ...
}

Remarks

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

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

on_generate_key event (KMIPServer Struct)

Notifies the application about an incoming Generate request.

Syntax

// KMIPServerGenerateKeyEventArgs carries the KMIPServer GenerateKey event's parameters.
pub struct KMIPServerGenerateKeyEventArgs {
  fn connection_id(&self) -> i64
  fn key_algorithm(&self) -> &String
  fn key_length(&self) -> i32
  fn group(&self) -> &String
  fn key_id(&self) -> &String
  fn set_key_id(&self, value : &str)
  fn set_key_id_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerGenerateKeyEvent defines the signature of the KMIPServer GenerateKey event's handler function.
pub trait KMIPServerGenerateKeyEvent {
  fn on_generate_key(&self, sender : KMIPServer, e : &mut KMIPServerGenerateKeyEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_generate_key(&self) -> &'a dyn KMIPServerGenerateKeyEvent;
  pub fn set_on_generate_key(&mut self, value : &'a dyn KMIPServerGenerateKeyEvent);
  ...
}

Remarks

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

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

on_generate_key_pair event (KMIPServer Struct)

Notifies the application about an incoming Generate request.

Syntax

// KMIPServerGenerateKeyPairEventArgs carries the KMIPServer GenerateKeyPair event's parameters.
pub struct KMIPServerGenerateKeyPairEventArgs {
  fn connection_id(&self) -> i64
  fn key_algorithm(&self) -> &String
  fn key_length(&self) -> i32
  fn scheme(&self) -> &String
  fn scheme_params(&self) -> &String
  fn group(&self) -> &String
  fn private_key_id(&self) -> &String
  fn set_private_key_id(&self, value : &str)
  fn set_private_key_id_ref(&self, value : &String)
  fn public_key_id(&self) -> &String
  fn set_public_key_id(&self, value : &str)
  fn set_public_key_id_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerGenerateKeyPairEvent defines the signature of the KMIPServer GenerateKeyPair event's handler function.
pub trait KMIPServerGenerateKeyPairEvent {
  fn on_generate_key_pair(&self, sender : KMIPServer, e : &mut KMIPServerGenerateKeyPairEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_generate_key_pair(&self) -> &'a dyn KMIPServerGenerateKeyPairEvent;
  pub fn set_on_generate_key_pair(&mut self, value : &'a dyn KMIPServerGenerateKeyPairEvent);
  ...
}

Remarks

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

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

on_get_usage_allocation event (KMIPServer Struct)

Notifies the application about an incoming Get Usage Allocation request.

Syntax

// KMIPServerGetUsageAllocationEventArgs carries the KMIPServer GetUsageAllocation event's parameters.
pub struct KMIPServerGetUsageAllocationEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn usage_limits_count(&self) -> i32
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerGetUsageAllocationEvent defines the signature of the KMIPServer GetUsageAllocation event's handler function.
pub trait KMIPServerGetUsageAllocationEvent {
  fn on_get_usage_allocation(&self, sender : KMIPServer, e : &mut KMIPServerGetUsageAllocationEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_get_usage_allocation(&self) -> &'a dyn KMIPServerGetUsageAllocationEvent;
  pub fn set_on_get_usage_allocation(&mut self, value : &'a dyn KMIPServerGetUsageAllocationEvent);
  ...
}

Remarks

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

on_hash event (KMIPServer Struct)

Instructs the application to update the current hashing operation.

Syntax

// KMIPServerHashEventArgs carries the KMIPServer Hash event's parameters.
pub struct KMIPServerHashEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn hash_algorithm(&self) -> &String
  fn data(&self) -> &[u8]
  fn init_indicator(&self) -> bool
  fn final_indicator(&self) -> bool
  fn correlation_value(&self) -> &String
  fn set_correlation_value(&self, value : &str)
  fn set_correlation_value_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerHashEvent defines the signature of the KMIPServer Hash event's handler function.
pub trait KMIPServerHashEvent {
  fn on_hash(&self, sender : KMIPServer, e : &mut KMIPServerHashEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_hash(&self) -> &'a dyn KMIPServerHashEvent;
  pub fn set_on_hash(&mut self, value : &'a dyn KMIPServerHashEvent);
  ...
}

Remarks

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

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

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

on_headers_prepared event (KMIPServer Struct)

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

Syntax

// KMIPServerHeadersPreparedEventArgs carries the KMIPServer HeadersPrepared event's parameters.
pub struct KMIPServerHeadersPreparedEventArgs {
  fn connection_id(&self) -> i64
}

// KMIPServerHeadersPreparedEvent defines the signature of the KMIPServer HeadersPrepared event's handler function.
pub trait KMIPServerHeadersPreparedEvent {
  fn on_headers_prepared(&self, sender : KMIPServer, e : &mut KMIPServerHeadersPreparedEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_headers_prepared(&self) -> &'a dyn KMIPServerHeadersPreparedEvent;
  pub fn set_on_headers_prepared(&mut self, value : &'a dyn KMIPServerHeadersPreparedEvent);
  ...
}

Remarks

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

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

on_kmip_auth_attempt event (KMIPServer Struct)

Fires when a connected client makes an authentication attempt.

Syntax

// KMIPServerKMIPAuthAttemptEventArgs carries the KMIPServer KMIPAuthAttempt event's parameters.
pub struct KMIPServerKMIPAuthAttemptEventArgs {
  fn connection_id(&self) -> i64
  fn username(&self) -> &String
  fn password(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// KMIPServerKMIPAuthAttemptEvent defines the signature of the KMIPServer KMIPAuthAttempt event's handler function.
pub trait KMIPServerKMIPAuthAttemptEvent {
  fn on_kmip_auth_attempt(&self, sender : KMIPServer, e : &mut KMIPServerKMIPAuthAttemptEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_kmip_auth_attempt(&self) -> &'a dyn KMIPServerKMIPAuthAttemptEvent;
  pub fn set_on_kmip_auth_attempt(&mut self, value : &'a dyn KMIPServerKMIPAuthAttemptEvent);
  ...
}

Remarks

The struct 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.

on_list event (KMIPServer Struct)

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

Syntax

// KMIPServerListEventArgs carries the KMIPServer List event's parameters.
pub struct KMIPServerListEventArgs {
  fn connection_id(&self) -> i64
  fn object_type(&self) -> i32
  fn object_status(&self) -> i32
  fn only_fresh_objects(&self) -> bool
  fn offset_items(&self) -> i32
  fn maximum_items(&self) -> i32
  fn object_ids(&self) -> &String
  fn set_object_ids(&self, value : &str)
  fn set_object_ids_ref(&self, value : &String)
  fn located_items(&self) -> i32
  fn set_located_items(&self, value : i32)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerListEvent defines the signature of the KMIPServer List event's handler function.
pub trait KMIPServerListEvent {
  fn on_list(&self, sender : KMIPServer, e : &mut KMIPServerListEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_list(&self) -> &'a dyn KMIPServerListEvent;
  pub fn set_on_list(&mut self, value : &'a dyn KMIPServerListEvent);
  ...
}

Remarks

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

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

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

on_list_attributes event (KMIPServer Struct)

Requests a list of object attribute names from the application.

Syntax

// KMIPServerListAttributesEventArgs carries the KMIPServer ListAttributes event's parameters.
pub struct KMIPServerListAttributesEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn attribute_names(&self) -> &String
  fn set_attribute_names(&self, value : &str)
  fn set_attribute_names_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerListAttributesEvent defines the signature of the KMIPServer ListAttributes event's handler function.
pub trait KMIPServerListAttributesEvent {
  fn on_list_attributes(&self, sender : KMIPServer, e : &mut KMIPServerListAttributesEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_list_attributes(&self) -> &'a dyn KMIPServerListAttributesEvent;
  pub fn set_on_list_attributes(&mut self, value : &'a dyn KMIPServerListAttributesEvent);
  ...
}

Remarks

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

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

on_notification event (KMIPServer Struct)

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

Syntax

// KMIPServerNotificationEventArgs carries the KMIPServer Notification event's parameters.
pub struct KMIPServerNotificationEventArgs {
  fn event_id(&self) -> &String
  fn event_param(&self) -> &String
}

// KMIPServerNotificationEvent defines the signature of the KMIPServer Notification event's handler function.
pub trait KMIPServerNotificationEvent {
  fn on_notification(&self, sender : KMIPServer, e : &mut KMIPServerNotificationEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_notification(&self) -> &'a dyn KMIPServerNotificationEvent;
  pub fn set_on_notification(&mut self, value : &'a dyn KMIPServerNotificationEvent);
  ...
}

Remarks

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

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

on_obtain_lease event (KMIPServer Struct)

Lets the application handle the lease request.

Syntax

// KMIPServerObtainLeaseEventArgs carries the KMIPServer ObtainLease event's parameters.
pub struct KMIPServerObtainLeaseEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn lease_time(&self) -> i32
  fn set_lease_time(&self, value : i32)
  fn last_change_date(&self) -> &String
  fn set_last_change_date(&self, value : &str)
  fn set_last_change_date_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerObtainLeaseEvent defines the signature of the KMIPServer ObtainLease event's handler function.
pub trait KMIPServerObtainLeaseEvent {
  fn on_obtain_lease(&self, sender : KMIPServer, e : &mut KMIPServerObtainLeaseEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_obtain_lease(&self) -> &'a dyn KMIPServerObtainLeaseEvent;
  pub fn set_on_obtain_lease(&mut self, value : &'a dyn KMIPServerObtainLeaseEvent);
  ...
}

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.

on_operation_attempt event (KMIPServer Struct)

Fires when a request is received from the client.

Syntax

// KMIPServerOperationAttemptEventArgs carries the KMIPServer OperationAttempt event's parameters.
pub struct KMIPServerOperationAttemptEventArgs {
  fn connection_id(&self) -> i64
  fn operation(&self) -> &String
  fn username(&self) -> &String
  fn reject(&self) -> bool
  fn set_reject(&self, value : bool)
}

// KMIPServerOperationAttemptEvent defines the signature of the KMIPServer OperationAttempt event's handler function.
pub trait KMIPServerOperationAttemptEvent {
  fn on_operation_attempt(&self, sender : KMIPServer, e : &mut KMIPServerOperationAttemptEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_operation_attempt(&self) -> &'a dyn KMIPServerOperationAttemptEvent;
  pub fn set_on_operation_attempt(&mut self, value : &'a dyn KMIPServerOperationAttemptEvent);
  ...
}

Remarks

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

on_poll event (KMIPServer Struct)

Notifies the application about the received Poll request.

Syntax

// KMIPServerPollEventArgs carries the KMIPServer Poll event's parameters.
pub struct KMIPServerPollEventArgs {
  fn connection_id(&self) -> i64
  fn async_correlation_value(&self) -> &String
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerPollEvent defines the signature of the KMIPServer Poll event's handler function.
pub trait KMIPServerPollEvent {
  fn on_poll(&self, sender : KMIPServer, e : &mut KMIPServerPollEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_poll(&self) -> &'a dyn KMIPServerPollEvent;
  pub fn set_on_poll(&mut self, value : &'a dyn KMIPServerPollEvent);
  ...
}

Remarks

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

on_read_attribute event (KMIPServer Struct)

Requests an object attribute value from the application.

Syntax

// KMIPServerReadAttributeEventArgs carries the KMIPServer ReadAttribute event's parameters.
pub struct KMIPServerReadAttributeEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn attribute_name(&self) -> &String
  fn attribute_value(&self) -> &String
  fn set_attribute_value(&self, value : &str)
  fn set_attribute_value_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerReadAttributeEvent defines the signature of the KMIPServer ReadAttribute event's handler function.
pub trait KMIPServerReadAttributeEvent {
  fn on_read_attribute(&self, sender : KMIPServer, e : &mut KMIPServerReadAttributeEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_read_attribute(&self) -> &'a dyn KMIPServerReadAttributeEvent;
  pub fn set_on_read_attribute(&mut self, value : &'a dyn KMIPServerReadAttributeEvent);
  ...
}

Remarks

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

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

on_read_object event (KMIPServer Struct)

Requests the details of the object from the application.

Syntax

// KMIPServerReadObjectEventArgs carries the KMIPServer ReadObject event's parameters.
pub struct KMIPServerReadObjectEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn object_type(&self) -> i32
  fn set_object_type(&self, value : i32)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerReadObjectEvent defines the signature of the KMIPServer ReadObject event's handler function.
pub trait KMIPServerReadObjectEvent {
  fn on_read_object(&self, sender : KMIPServer, e : &mut KMIPServerReadObjectEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_read_object(&self) -> &'a dyn KMIPServerReadObjectEvent;
  pub fn set_on_read_object(&mut self, value : &'a dyn KMIPServerReadObjectEvent);
  ...
}

Remarks

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

The event handler should set the ObjectType and OperationStatus as required, and provide the relevant object via the certificate or key property and committing it using set_client_cert or set_client_key respectively.

on_re_certify event (KMIPServer Struct)

Notifies the application about an incoming re-certification request.

Syntax

// KMIPServerReCertifyEventArgs carries the KMIPServer ReCertify event's parameters.
pub struct KMIPServerReCertifyEventArgs {
  fn connection_id(&self) -> i64
  fn old_cert_id(&self) -> &String
  fn offset(&self) -> i32
  fn group(&self) -> &String
  fn new_cert_id(&self) -> &String
  fn set_new_cert_id(&self, value : &str)
  fn set_new_cert_id_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerReCertifyEvent defines the signature of the KMIPServer ReCertify event's handler function.
pub trait KMIPServerReCertifyEvent {
  fn on_re_certify(&self, sender : KMIPServer, e : &mut KMIPServerReCertifyEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_re_certify(&self) -> &'a dyn KMIPServerReCertifyEvent;
  pub fn set_on_re_certify(&mut self, value : &'a dyn KMIPServerReCertifyEvent);
  ...
}

Remarks

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

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

on_recover_object event (KMIPServer Struct)

Notifies the application about an incoming Recover Object request.

Syntax

// KMIPServerRecoverObjectEventArgs carries the KMIPServer RecoverObject event's parameters.
pub struct KMIPServerRecoverObjectEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerRecoverObjectEvent defines the signature of the KMIPServer RecoverObject event's handler function.
pub trait KMIPServerRecoverObjectEvent {
  fn on_recover_object(&self, sender : KMIPServer, e : &mut KMIPServerRecoverObjectEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_recover_object(&self) -> &'a dyn KMIPServerRecoverObjectEvent;
  pub fn set_on_recover_object(&mut self, value : &'a dyn KMIPServerRecoverObjectEvent);
  ...
}

Remarks

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

on_re_key event (KMIPServer Struct)

Notifies the application about an incoming re-key request.

Syntax

// KMIPServerReKeyEventArgs carries the KMIPServer ReKey event's parameters.
pub struct KMIPServerReKeyEventArgs {
  fn connection_id(&self) -> i64
  fn old_key_id(&self) -> &String
  fn offset(&self) -> i32
  fn group(&self) -> &String
  fn new_key_id(&self) -> &String
  fn set_new_key_id(&self, value : &str)
  fn set_new_key_id_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerReKeyEvent defines the signature of the KMIPServer ReKey event's handler function.
pub trait KMIPServerReKeyEvent {
  fn on_re_key(&self, sender : KMIPServer, e : &mut KMIPServerReKeyEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_re_key(&self) -> &'a dyn KMIPServerReKeyEvent;
  pub fn set_on_re_key(&mut self, value : &'a dyn KMIPServerReKeyEvent);
  ...
}

Remarks

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

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

on_rekey_key_pair event (KMIPServer Struct)

Notifies the application about an incoming re-key request.

Syntax

// KMIPServerRekeyKeyPairEventArgs carries the KMIPServer RekeyKeyPair event's parameters.
pub struct KMIPServerRekeyKeyPairEventArgs {
  fn connection_id(&self) -> i64
  fn old_private_key_id(&self) -> &String
  fn offset(&self) -> i32
  fn group(&self) -> &String
  fn new_private_key_id(&self) -> &String
  fn set_new_private_key_id(&self, value : &str)
  fn set_new_private_key_id_ref(&self, value : &String)
  fn new_public_key_id(&self) -> &String
  fn set_new_public_key_id(&self, value : &str)
  fn set_new_public_key_id_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerRekeyKeyPairEvent defines the signature of the KMIPServer RekeyKeyPair event's handler function.
pub trait KMIPServerRekeyKeyPairEvent {
  fn on_rekey_key_pair(&self, sender : KMIPServer, e : &mut KMIPServerRekeyKeyPairEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_rekey_key_pair(&self) -> &'a dyn KMIPServerRekeyKeyPairEvent;
  pub fn set_on_rekey_key_pair(&mut self, value : &'a dyn KMIPServerRekeyKeyPairEvent);
  ...
}

Remarks

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

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

on_remove_object event (KMIPServer Struct)

Notifies the application about the object deletion request.

Syntax

// KMIPServerRemoveObjectEventArgs carries the KMIPServer RemoveObject event's parameters.
pub struct KMIPServerRemoveObjectEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerRemoveObjectEvent defines the signature of the KMIPServer RemoveObject event's handler function.
pub trait KMIPServerRemoveObjectEvent {
  fn on_remove_object(&self, sender : KMIPServer, e : &mut KMIPServerRemoveObjectEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_remove_object(&self) -> &'a dyn KMIPServerRemoveObjectEvent;
  pub fn set_on_remove_object(&mut self, value : &'a dyn KMIPServerRemoveObjectEvent);
  ...
}

Remarks

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

on_request event (KMIPServer Struct)

Notifies the application about KMIP requests being received.

Syntax

// KMIPServerRequestEventArgs carries the KMIPServer Request event's parameters.
pub struct KMIPServerRequestEventArgs {
  fn connection_id(&self) -> i64
  fn request_data(&self) -> &[u8]
}

// KMIPServerRequestEvent defines the signature of the KMIPServer Request event's handler function.
pub trait KMIPServerRequestEvent {
  fn on_request(&self, sender : KMIPServer, e : &mut KMIPServerRequestEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_request(&self) -> &'a dyn KMIPServerRequestEvent;
  pub fn set_on_request(&mut self, value : &'a dyn KMIPServerRequestEvent);
  ...
}

Remarks

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

on_response event (KMIPServer Struct)

Notifies the application about KMIP responses being sent back.

Syntax

// KMIPServerResponseEventArgs carries the KMIPServer Response event's parameters.
pub struct KMIPServerResponseEventArgs {
  fn connection_id(&self) -> i64
  fn response_data(&self) -> &[u8]
}

// KMIPServerResponseEvent defines the signature of the KMIPServer Response event's handler function.
pub trait KMIPServerResponseEvent {
  fn on_response(&self, sender : KMIPServer, e : &mut KMIPServerResponseEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_response(&self) -> &'a dyn KMIPServerResponseEvent;
  pub fn set_on_response(&mut self, value : &'a dyn KMIPServerResponseEvent);
  ...
}

Remarks

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

on_revoke_object event (KMIPServer Struct)

Instructs the application to revoke an object.

Syntax

// KMIPServerRevokeObjectEventArgs carries the KMIPServer RevokeObject event's parameters.
pub struct KMIPServerRevokeObjectEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn reason_code(&self) -> i32
  fn reason_message(&self) -> &String
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerRevokeObjectEvent defines the signature of the KMIPServer RevokeObject event's handler function.
pub trait KMIPServerRevokeObjectEvent {
  fn on_revoke_object(&self, sender : KMIPServer, e : &mut KMIPServerRevokeObjectEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_revoke_object(&self) -> &'a dyn KMIPServerRevokeObjectEvent;
  pub fn set_on_revoke_object(&mut self, value : &'a dyn KMIPServerRevokeObjectEvent);
  ...
}

Remarks

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

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

on_rng_generate event (KMIPServer Struct)

Asks the application for another block of random numbers.

Syntax

// KMIPServerRNGGenerateEventArgs carries the KMIPServer RNGGenerate event's parameters.
pub struct KMIPServerRNGGenerateEventArgs {
  fn connection_id(&self) -> i64
  fn data_length(&self) -> i32
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerRNGGenerateEvent defines the signature of the KMIPServer RNGGenerate event's handler function.
pub trait KMIPServerRNGGenerateEvent {
  fn on_rng_generate(&self, sender : KMIPServer, e : &mut KMIPServerRNGGenerateEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_rng_generate(&self) -> &'a dyn KMIPServerRNGGenerateEvent;
  pub fn set_on_rng_generate(&mut self, value : &'a dyn KMIPServerRNGGenerateEvent);
  ...
}

Remarks

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

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

on_rng_seed event (KMIPServer Struct)

Tells the application to seed the random number generator.

Syntax

// KMIPServerRNGSeedEventArgs carries the KMIPServer RNGSeed event's parameters.
pub struct KMIPServerRNGSeedEventArgs {
  fn connection_id(&self) -> i64
  fn data(&self) -> &[u8]
  fn bytes_used(&self) -> i32
  fn set_bytes_used(&self, value : i32)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerRNGSeedEvent defines the signature of the KMIPServer RNGSeed event's handler function.
pub trait KMIPServerRNGSeedEvent {
  fn on_rng_seed(&self, sender : KMIPServer, e : &mut KMIPServerRNGSeedEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_rng_seed(&self) -> &'a dyn KMIPServerRNGSeedEvent;
  pub fn set_on_rng_seed(&mut self, value : &'a dyn KMIPServerRNGSeedEvent);
  ...
}

Remarks

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

on_set_attribute event (KMIPServer Struct)

Passes a set-attribute request to the application.

Syntax

// KMIPServerSetAttributeEventArgs carries the KMIPServer SetAttribute event's parameters.
pub struct KMIPServerSetAttributeEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn attribute_name(&self) -> &String
  fn attribute_value(&self) -> &String
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerSetAttributeEvent defines the signature of the KMIPServer SetAttribute event's handler function.
pub trait KMIPServerSetAttributeEvent {
  fn on_set_attribute(&self, sender : KMIPServer, e : &mut KMIPServerSetAttributeEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_set_attribute(&self) -> &'a dyn KMIPServerSetAttributeEvent;
  pub fn set_on_set_attribute(&mut self, value : &'a dyn KMIPServerSetAttributeEvent);
  ...
}

Remarks

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

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

on_sign event (KMIPServer Struct)

Instructs the application to sign data with a private key.

Syntax

// KMIPServerSignEventArgs carries the KMIPServer Sign event's parameters.
pub struct KMIPServerSignEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn algorithm(&self) -> &String
  fn hash_algorithm(&self) -> &String
  fn input_is_hash(&self) -> bool
  fn data(&self) -> &[u8]
  fn init_indicator(&self) -> bool
  fn final_indicator(&self) -> bool
  fn correlation_value(&self) -> &String
  fn set_correlation_value(&self, value : &str)
  fn set_correlation_value_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerSignEvent defines the signature of the KMIPServer Sign event's handler function.
pub trait KMIPServerSignEvent {
  fn on_sign(&self, sender : KMIPServer, e : &mut KMIPServerSignEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_sign(&self) -> &'a dyn KMIPServerSignEvent;
  pub fn set_on_sign(&mut self, value : &'a dyn KMIPServerSignEvent);
  ...
}

Remarks

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

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

on_tls_cert_validate event (KMIPServer Struct)

Fires when a client certificate needs to be validated.

Syntax

// KMIPServerTLSCertValidateEventArgs carries the KMIPServer TLSCertValidate event's parameters.
pub struct KMIPServerTLSCertValidateEventArgs {
  fn connection_id(&self) -> i64
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// KMIPServerTLSCertValidateEvent defines the signature of the KMIPServer TLSCertValidate event's handler function.
pub trait KMIPServerTLSCertValidateEvent {
  fn on_tls_cert_validate(&self, sender : KMIPServer, e : &mut KMIPServerTLSCertValidateEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_tls_cert_validate(&self) -> &'a dyn KMIPServerTLSCertValidateEvent;
  pub fn set_on_tls_cert_validate(&mut self, value : &'a dyn KMIPServerTLSCertValidateEvent);
  ...
}

Remarks

The struct 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.

on_tls_established event (KMIPServer Struct)

Reports the setup of a TLS session.

Syntax

// KMIPServerTLSEstablishedEventArgs carries the KMIPServer TLSEstablished event's parameters.
pub struct KMIPServerTLSEstablishedEventArgs {
  fn connection_id(&self) -> i64
}

// KMIPServerTLSEstablishedEvent defines the signature of the KMIPServer TLSEstablished event's handler function.
pub trait KMIPServerTLSEstablishedEvent {
  fn on_tls_established(&self, sender : KMIPServer, e : &mut KMIPServerTLSEstablishedEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_tls_established(&self) -> &'a dyn KMIPServerTLSEstablishedEvent;
  pub fn set_on_tls_established(&mut self, value : &'a dyn KMIPServerTLSEstablishedEvent);
  ...
}

Remarks

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

on_tls_handshake event (KMIPServer Struct)

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

Syntax

// KMIPServerTLSHandshakeEventArgs carries the KMIPServer TLSHandshake event's parameters.
pub struct KMIPServerTLSHandshakeEventArgs {
  fn connection_id(&self) -> i64
  fn server_name(&self) -> &String
  fn abort(&self) -> bool
  fn set_abort(&self, value : bool)
}

// KMIPServerTLSHandshakeEvent defines the signature of the KMIPServer TLSHandshake event's handler function.
pub trait KMIPServerTLSHandshakeEvent {
  fn on_tls_handshake(&self, sender : KMIPServer, e : &mut KMIPServerTLSHandshakeEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_tls_handshake(&self) -> &'a dyn KMIPServerTLSHandshakeEvent;
  pub fn set_on_tls_handshake(&mut self, value : &'a dyn KMIPServerTLSHandshakeEvent);
  ...
}

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.

on_tls_psk event (KMIPServer Struct)

Requests a pre-shared key for TLS-PSK.

Syntax

// KMIPServerTLSPSKEventArgs carries the KMIPServer TLSPSK event's parameters.
pub struct KMIPServerTLSPSKEventArgs {
  fn connection_id(&self) -> i64
  fn identity(&self) -> &String
  fn psk(&self) -> &String
  fn set_psk(&self, value : &str)
  fn set_psk_ref(&self, value : &String)
  fn ciphersuite(&self) -> &String
  fn set_ciphersuite(&self, value : &str)
  fn set_ciphersuite_ref(&self, value : &String)
}

// KMIPServerTLSPSKEvent defines the signature of the KMIPServer TLSPSK event's handler function.
pub trait KMIPServerTLSPSKEvent {
  fn on_tls_psk(&self, sender : KMIPServer, e : &mut KMIPServerTLSPSKEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_tls_psk(&self) -> &'a dyn KMIPServerTLSPSKEvent;
  pub fn set_on_tls_psk(&mut self, value : &'a dyn KMIPServerTLSPSKEvent);
  ...
}

Remarks

The struct 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.

on_tls_shutdown event (KMIPServer Struct)

Reports closure of a TLS session.

Syntax

// KMIPServerTLSShutdownEventArgs carries the KMIPServer TLSShutdown event's parameters.
pub struct KMIPServerTLSShutdownEventArgs {
  fn connection_id(&self) -> i64
}

// KMIPServerTLSShutdownEvent defines the signature of the KMIPServer TLSShutdown event's handler function.
pub trait KMIPServerTLSShutdownEvent {
  fn on_tls_shutdown(&self, sender : KMIPServer, e : &mut KMIPServerTLSShutdownEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_tls_shutdown(&self) -> &'a dyn KMIPServerTLSShutdownEvent;
  pub fn set_on_tls_shutdown(&mut self, value : &'a dyn KMIPServerTLSShutdownEvent);
  ...
}

Remarks

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

on_validate_chain event (KMIPServer Struct)

Passes the chain validation request to the application.

Syntax

// KMIPServerValidateChainEventArgs carries the KMIPServer ValidateChain event's parameters.
pub struct KMIPServerValidateChainEventArgs {
  fn connection_id(&self) -> i64
  fn object_ids(&self) -> &String
  fn validity(&self) -> i32
  fn set_validity(&self, value : i32)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerValidateChainEvent defines the signature of the KMIPServer ValidateChain event's handler function.
pub trait KMIPServerValidateChainEvent {
  fn on_validate_chain(&self, sender : KMIPServer, e : &mut KMIPServerValidateChainEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_validate_chain(&self) -> &'a dyn KMIPServerValidateChainEvent;
  pub fn set_on_validate_chain(&mut self, value : &'a dyn KMIPServerValidateChainEvent);
  ...
}

Remarks

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

on_verify event (KMIPServer Struct)

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

Syntax

// KMIPServerVerifyEventArgs carries the KMIPServer Verify event's parameters.
pub struct KMIPServerVerifyEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn hash_algorithm(&self) -> &String
  fn input_is_hash(&self) -> bool
  fn data(&self) -> &[u8]
  fn signature_data(&self) -> &[u8]
  fn init_indicator(&self) -> bool
  fn final_indicator(&self) -> bool
  fn validation_result(&self) -> i32
  fn set_validation_result(&self, value : i32)
  fn correlation_value(&self) -> &String
  fn set_correlation_value(&self, value : &str)
  fn set_correlation_value_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerVerifyEvent defines the signature of the KMIPServer Verify event's handler function.
pub trait KMIPServerVerifyEvent {
  fn on_verify(&self, sender : KMIPServer, e : &mut KMIPServerVerifyEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_verify(&self) -> &'a dyn KMIPServerVerifyEvent;
  pub fn set_on_verify(&mut self, value : &'a dyn KMIPServerVerifyEvent);
  ...
}

Remarks

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

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

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

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

See the Three-step Virtualization article for more details about handling and virtualizing requests in SecureBlackbox servers.

on_verify_hash event (KMIPServer Struct)

Delegates the hash verification operation to a custom handler.

Syntax

// KMIPServerVerifyHashEventArgs carries the KMIPServer VerifyHash event's parameters.
pub struct KMIPServerVerifyHashEventArgs {
  fn connection_id(&self) -> i64
  fn object_id(&self) -> &String
  fn hash_algorithm(&self) -> &String
  fn data(&self) -> &[u8]
  fn hash(&self) -> &[u8]
  fn init_indicator(&self) -> bool
  fn final_indicator(&self) -> bool
  fn is_valid(&self) -> bool
  fn set_is_valid(&self, value : bool)
  fn correlation_value(&self) -> &String
  fn set_correlation_value(&self, value : &str)
  fn set_correlation_value_ref(&self, value : &String)
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// KMIPServerVerifyHashEvent defines the signature of the KMIPServer VerifyHash event's handler function.
pub trait KMIPServerVerifyHashEvent {
  fn on_verify_hash(&self, sender : KMIPServer, e : &mut KMIPServerVerifyHashEventArgs);
}

impl <'a> KMIPServer<'a> {
  pub fn on_verify_hash(&self) -> &'a dyn KMIPServerVerifyHashEvent;
  pub fn set_on_verify_hash(&mut self, value : &'a dyn KMIPServerVerifyHashEvent);
  ...
}

Remarks

This event allows the application to wiretap into the server's verification procedure. It is invoked if the Action parameter in the preceding on_before_verify 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.

Config Settings (KMIPServer Struct)

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

KMIPServer Config Settings

Base Config Settings

Trappable Errors (KMIPServer Struct)

KMIPServer Errors