KMIPServer Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

class secureblackbox.KMIPServer

Remarks

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

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

active Property

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

Syntax

def get_active() -> bool: ...

active = property(get_active, None)

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.

allow_keep_alive Property

Enables or disables keep-alive mode.

Syntax

def get_allow_keep_alive() -> bool: ...
def set_allow_keep_alive(value: bool) -> None: ...

allow_keep_alive = property(get_allow_keep_alive, set_allow_keep_alive)

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.

auth_realm Property

Specifies authentication realm for digest and NTLM authentication.

Syntax

def get_auth_realm() -> str: ...
def set_auth_realm(value: str) -> None: ...

auth_realm = property(get_auth_realm, set_auth_realm)

Default Value

"SecureBlackbox"

Remarks

Specifies authentication realm for digest and NTLM authentication types.

auth_types Property

Defines allowed HTTP authentication types.

Syntax

def get_auth_types() -> int: ...
def set_auth_types(value: int) -> None: ...

auth_types = property(get_auth_types, set_auth_types)

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:

bound_port Property

Indicates the bound listening port.

Syntax

def get_bound_port() -> int: ...

bound_port = property(get_bound_port, None)

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.

ca_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_ca_cert_bytes() -> bytes: ...

ca_cert_bytes = property(get_ca_cert_bytes, None)

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

ca_cert_handle Property

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

Syntax

def get_ca_cert_handle() -> int: ...
def set_ca_cert_handle(value: int) -> None: ...

ca_cert_handle = property(get_ca_cert_handle, set_ca_cert_handle)

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());

certificate_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_certificate_bytes() -> bytes: ...

certificate_bytes = property(get_certificate_bytes, None)

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

certificate_handle Property

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

Syntax

def get_certificate_handle() -> int: ...
def set_certificate_handle(value: int) -> None: ...

certificate_handle = property(get_certificate_handle, set_certificate_handle)

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());

compression_level Property

The default compression level to use.

Syntax

def get_compression_level() -> int: ...
def set_compression_level(value: int) -> None: ...

compression_level = property(get_compression_level, set_compression_level)

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.

external_crypto_async_document_id Property

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

Syntax

def get_external_crypto_async_document_id() -> str: ...
def set_external_crypto_async_document_id(value: str) -> None: ...

external_crypto_async_document_id = property(get_external_crypto_async_document_id, set_external_crypto_async_document_id)

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.

external_crypto_custom_params Property

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

Syntax

def get_external_crypto_custom_params() -> str: ...
def set_external_crypto_custom_params(value: str) -> None: ...

external_crypto_custom_params = property(get_external_crypto_custom_params, set_external_crypto_custom_params)

Default Value

""

Remarks

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

external_crypto_data Property

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

Syntax

def get_external_crypto_data() -> str: ...
def set_external_crypto_data(value: str) -> None: ...

external_crypto_data = property(get_external_crypto_data, set_external_crypto_data)

Default Value

""

Remarks

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

external_crypto_external_hash_calculation Property

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

Syntax

def get_external_crypto_external_hash_calculation() -> bool: ...
def set_external_crypto_external_hash_calculation(value: bool) -> None: ...

external_crypto_external_hash_calculation = property(get_external_crypto_external_hash_calculation, set_external_crypto_external_hash_calculation)

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

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

external_crypto_hash_algorithm Property

Specifies the request's signature hash algorithm.

Syntax

def get_external_crypto_hash_algorithm() -> str: ...
def set_external_crypto_hash_algorithm(value: str) -> None: ...

external_crypto_hash_algorithm = property(get_external_crypto_hash_algorithm, set_external_crypto_hash_algorithm)

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

external_crypto_key_id Property

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

Syntax

def get_external_crypto_key_id() -> str: ...
def set_external_crypto_key_id(value: str) -> None: ...

external_crypto_key_id = property(get_external_crypto_key_id, set_external_crypto_key_id)

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

external_crypto_key_secret Property

The pre-shared key used for DC request authentication.

Syntax

def get_external_crypto_key_secret() -> str: ...
def set_external_crypto_key_secret(value: str) -> None: ...

external_crypto_key_secret = property(get_external_crypto_key_secret, set_external_crypto_key_secret)

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.

external_crypto_method Property

Specifies the asynchronous signing method.

Syntax

def get_external_crypto_method() -> int: ...
def set_external_crypto_method(value: int) -> None: ...

external_crypto_method = property(get_external_crypto_method, set_external_crypto_method)

Default Value

0

Remarks

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

Available options:

external_crypto_mode Property

Specifies the external cryptography mode.

Syntax

def get_external_crypto_mode() -> int: ...
def set_external_crypto_mode(value: int) -> None: ...

external_crypto_mode = property(get_external_crypto_mode, set_external_crypto_mode)

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

external_crypto_public_key_algorithm Property

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

Syntax

def get_external_crypto_public_key_algorithm() -> str: ...
def set_external_crypto_public_key_algorithm(value: str) -> None: ...

external_crypto_public_key_algorithm = property(get_external_crypto_public_key_algorithm, set_external_crypto_public_key_algorithm)

Default Value

""

Remarks

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

fips_mode Property

Reserved.

Syntax

def get_fips_mode() -> bool: ...
def set_fips_mode(value: bool) -> None: ...

fips_mode = property(get_fips_mode, set_fips_mode)

Default Value

FALSE

Remarks

This property is reserved for future use.

handshake_timeout Property

Specifies the handshake timeout in milliseconds.

Syntax

def get_handshake_timeout() -> int: ...
def set_handshake_timeout(value: int) -> None: ...

handshake_timeout = property(get_handshake_timeout, set_handshake_timeout)

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

host Property

Specifies the host name of the KMIP server.

Syntax

def get_host() -> str: ...
def set_host(value: str) -> None: ...

host = property(get_host, set_host)

Default Value

""

Remarks

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

key_algorithm Property

The algorithm of the cryptographic key.

Syntax

def get_key_algorithm() -> str: ...
def set_key_algorithm(value: str) -> None: ...

key_algorithm = property(get_key_algorithm, set_key_algorithm)

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.

key_bits Property

The length of the key in bits.

Syntax

def get_key_bits() -> int: ...

key_bits = property(get_key_bits, None)

Default Value

0

Remarks

The length of the key in bits.

This property is read-only.

key_curve Property

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

Syntax

def get_key_curve() -> str: ...
def set_key_curve(value: str) -> None: ...

key_curve = property(get_key_curve, set_key_curve)

Default Value

""

Remarks

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

key_exportable Property

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

Syntax

def get_key_exportable() -> bool: ...

key_exportable = property(get_key_exportable, None)

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.

key_fingerprint Property

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

Syntax

def get_key_fingerprint() -> str: ...

key_fingerprint = property(get_key_fingerprint, None)

Default Value

""

Remarks

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

This property is read-only.

key_handle Property

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

Syntax

def get_key_handle() -> int: ...
def set_key_handle(value: int) -> None: ...

key_handle = property(get_key_handle, set_key_handle)

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());

key_id Property

Provides access to a storage-specific key identifier.

Syntax

def get_key_id() -> bytes: ...
def set_key_id(value: bytes) -> None: ...

key_id = property(get_key_id, set_key_id)

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

key_iv Property

The initialization vector (IV) of a symmetric key.

Syntax

def get_key_iv() -> bytes: ...
def set_key_iv(value: bytes) -> None: ...

key_iv = property(get_key_iv, set_key_iv)

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.

key_key Property

The byte array representation of the key.

Syntax

def get_key_key() -> bytes: ...

key_key = property(get_key_key, None)

Remarks

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

This property is read-only.

key_nonce Property

A nonce value associated with a key.

Syntax

def get_key_nonce() -> bytes: ...
def set_key_nonce(value: bytes) -> None: ...

key_nonce = property(get_key_nonce, set_key_nonce)

Remarks

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

key_private Property

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

Syntax

def get_key_private() -> bool: ...

key_private = property(get_key_private, None)

Default Value

FALSE

Remarks

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

This property is read-only.

key_public Property

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

Syntax

def get_key_public() -> bool: ...

key_public = property(get_key_public, None)

Default Value

FALSE

Remarks

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

This property is read-only.

key_subject Property

Returns the key subject.

Syntax

def get_key_subject() -> bytes: ...
def set_key_subject(value: bytes) -> None: ...

key_subject = property(get_key_subject, set_key_subject)

Remarks

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

key_symmetric Property

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

Syntax

def get_key_symmetric() -> bool: ...

key_symmetric = property(get_key_symmetric, None)

Default Value

FALSE

Remarks

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

This property is read-only.

key_valid Property

Returns True if this key is valid.

Syntax

def get_key_valid() -> bool: ...

key_valid = property(get_key_valid, None)

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.

pinned_client_aead_cipher Property

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

def get_pinned_client_aead_cipher() -> bool: ...

pinned_client_aead_cipher = property(get_pinned_client_aead_cipher, None)

Default Value

FALSE

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

This property is read-only.

pinned_client_chain_validation_details Property

The details of a certificate chain validation outcome.

Syntax

def get_pinned_client_chain_validation_details() -> int: ...

pinned_client_chain_validation_details = property(get_pinned_client_chain_validation_details, None)

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.

pinned_client_chain_validation_result Property

The outcome of a certificate chain validation routine.

Syntax

def get_pinned_client_chain_validation_result() -> int: ...

pinned_client_chain_validation_result = property(get_pinned_client_chain_validation_result, None)

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.

pinned_client_ciphersuite Property

The cipher suite employed by this connection.

Syntax

def get_pinned_client_ciphersuite() -> str: ...

pinned_client_ciphersuite = property(get_pinned_client_ciphersuite, None)

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.

pinned_client_client_authenticated Property

Specifies whether client authentication was performed during this connection.

Syntax

def get_pinned_client_client_authenticated() -> bool: ...

pinned_client_client_authenticated = property(get_pinned_client_client_authenticated, None)

Default Value

FALSE

Remarks

Specifies whether client authentication was performed during this connection.

This property is read-only.

pinned_client_client_auth_requested Property

Specifies whether client authentication was requested during this connection.

Syntax

def get_pinned_client_client_auth_requested() -> bool: ...

pinned_client_client_auth_requested = property(get_pinned_client_client_auth_requested, None)

Default Value

FALSE

Remarks

Specifies whether client authentication was requested during this connection.

This property is read-only.

pinned_client_connection_established Property

Indicates whether the connection has been established fully.

Syntax

def get_pinned_client_connection_established() -> bool: ...

pinned_client_connection_established = property(get_pinned_client_connection_established, None)

Default Value

FALSE

Remarks

Indicates whether the connection has been established fully.

This property is read-only.

pinned_client_connection_id Property

The unique identifier assigned to this connection.

Syntax

def get_pinned_client_connection_id() -> bytes: ...

pinned_client_connection_id = property(get_pinned_client_connection_id, None)

Remarks

The unique identifier assigned to this connection.

This property is read-only.

pinned_client_digest_algorithm Property

The digest algorithm used in a TLS-enabled connection.

Syntax

def get_pinned_client_digest_algorithm() -> str: ...

pinned_client_digest_algorithm = property(get_pinned_client_digest_algorithm, None)

Default Value

""

Remarks

The digest algorithm used in a TLS-enabled connection.

This property is read-only.

pinned_client_encryption_algorithm Property

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

Syntax

def get_pinned_client_encryption_algorithm() -> str: ...

pinned_client_encryption_algorithm = property(get_pinned_client_encryption_algorithm, None)

Default Value

""

Remarks

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

This property is read-only.

pinned_client_exportable Property

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

Syntax

def get_pinned_client_exportable() -> bool: ...

pinned_client_exportable = property(get_pinned_client_exportable, None)

Default Value

FALSE

Remarks

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

This property is read-only.

pinned_client_id Property

The client connection's unique identifier.

Syntax

def get_pinned_client_id() -> int: ...

pinned_client_id = property(get_pinned_client_id, None)

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.

pinned_client_key_exchange_algorithm Property

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

Syntax

def get_pinned_client_key_exchange_algorithm() -> str: ...

pinned_client_key_exchange_algorithm = property(get_pinned_client_key_exchange_algorithm, None)

Default Value

""

Remarks

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

This property is read-only.

pinned_client_key_exchange_key_bits Property

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

Syntax

def get_pinned_client_key_exchange_key_bits() -> int: ...

pinned_client_key_exchange_key_bits = property(get_pinned_client_key_exchange_key_bits, None)

Default Value

0

Remarks

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

This property is read-only.

pinned_client_named_ec_curve Property

The elliptic curve used in this connection.

Syntax

def get_pinned_client_named_ec_curve() -> str: ...

pinned_client_named_ec_curve = property(get_pinned_client_named_ec_curve, None)

Default Value

""

Remarks

The elliptic curve used in this connection.

This property is read-only.

pinned_client_pfs_cipher Property

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

Syntax

def get_pinned_client_pfs_cipher() -> bool: ...

pinned_client_pfs_cipher = property(get_pinned_client_pfs_cipher, None)

Default Value

FALSE

Remarks

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

This property is read-only.

pinned_client_pre_shared_identity Property

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

Syntax

def get_pinned_client_pre_shared_identity() -> str: ...

pinned_client_pre_shared_identity = property(get_pinned_client_pre_shared_identity, None)

Default Value

""

Remarks

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

This property is read-only.

pinned_client_pre_shared_identity_hint Property

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

Syntax

def get_pinned_client_pre_shared_identity_hint() -> str: ...

pinned_client_pre_shared_identity_hint = property(get_pinned_client_pre_shared_identity_hint, None)

Default Value

""

Remarks

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

This property is read-only.

pinned_client_public_key_bits Property

The length of the public key.

Syntax

def get_pinned_client_public_key_bits() -> int: ...

pinned_client_public_key_bits = property(get_pinned_client_public_key_bits, None)

Default Value

0

Remarks

The length of the public key.

This property is read-only.

pinned_client_remote_address Property

The client's IP address.

Syntax

def get_pinned_client_remote_address() -> str: ...

pinned_client_remote_address = property(get_pinned_client_remote_address, None)

Default Value

""

Remarks

The client's IP address.

This property is read-only.

pinned_client_remote_port Property

The remote port of the client connection.

Syntax

def get_pinned_client_remote_port() -> int: ...

pinned_client_remote_port = property(get_pinned_client_remote_port, None)

Default Value

0

Remarks

The remote port of the client connection.

This property is read-only.

pinned_client_resumed_session Property

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

Syntax

def get_pinned_client_resumed_session() -> bool: ...

pinned_client_resumed_session = property(get_pinned_client_resumed_session, None)

Default Value

FALSE

Remarks

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

This property is read-only.

pinned_client_secure_connection Property

Indicates whether TLS or SSL is enabled for this connection.

Syntax

def get_pinned_client_secure_connection() -> bool: ...

pinned_client_secure_connection = property(get_pinned_client_secure_connection, None)

Default Value

FALSE

Remarks

Indicates whether TLS or SSL is enabled for this connection.

This property is read-only.

pinned_client_server_authenticated Property

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

Syntax

def get_pinned_client_server_authenticated() -> bool: ...

pinned_client_server_authenticated = property(get_pinned_client_server_authenticated, None)

Default Value

FALSE

Remarks

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

This property is read-only.

pinned_client_signature_algorithm Property

The signature algorithm used in a TLS handshake.

Syntax

def get_pinned_client_signature_algorithm() -> str: ...

pinned_client_signature_algorithm = property(get_pinned_client_signature_algorithm, None)

Default Value

""

Remarks

The signature algorithm used in a TLS handshake.

This property is read-only.

pinned_client_symmetric_block_size Property

The block size of the symmetric algorithm used.

Syntax

def get_pinned_client_symmetric_block_size() -> int: ...

pinned_client_symmetric_block_size = property(get_pinned_client_symmetric_block_size, None)

Default Value

0

Remarks

The block size of the symmetric algorithm used.

This property is read-only.

pinned_client_symmetric_key_bits Property

The key length of the symmetric algorithm used.

Syntax

def get_pinned_client_symmetric_key_bits() -> int: ...

pinned_client_symmetric_key_bits = property(get_pinned_client_symmetric_key_bits, None)

Default Value

0

Remarks

The key length of the symmetric algorithm used.

This property is read-only.

pinned_client_total_bytes_received Property

The total number of bytes received over this connection.

Syntax

def get_pinned_client_total_bytes_received() -> int: ...

pinned_client_total_bytes_received = property(get_pinned_client_total_bytes_received, None)

Default Value

0

Remarks

The total number of bytes received over this connection.

This property is read-only.

pinned_client_total_bytes_sent Property

The total number of bytes sent over this connection.

Syntax

def get_pinned_client_total_bytes_sent() -> int: ...

pinned_client_total_bytes_sent = property(get_pinned_client_total_bytes_sent, None)

Default Value

0

Remarks

The total number of bytes sent over this connection.

This property is read-only.

pinned_client_validation_log Property

Contains the server certificate's chain validation log.

Syntax

def get_pinned_client_validation_log() -> str: ...

pinned_client_validation_log = property(get_pinned_client_validation_log, None)

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.

pinned_client_version Property

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

Syntax

def get_pinned_client_version() -> str: ...

pinned_client_version = property(get_pinned_client_version, None)

Default Value

""

Remarks

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

This property is read-only.

pinned_client_cert_count Property

The number of records in the PinnedClientCert arrays.

Syntax

def get_pinned_client_cert_count() -> int: ...

pinned_client_cert_count = property(get_pinned_client_cert_count, None)

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.

pinned_client_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_pinned_client_cert_bytes(pinned_client_cert_index: int) -> bytes: ...

Remarks

Returns the raw certificate data in DER format.

The pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_ca_key_id Property

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

Syntax

def get_pinned_client_cert_ca_key_id(pinned_client_cert_index: int) -> bytes: ...

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 pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_fingerprint Property

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

Syntax

def get_pinned_client_cert_fingerprint(pinned_client_cert_index: int) -> str: ...

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 pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_handle Property

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

Syntax

def get_pinned_client_cert_handle(pinned_client_cert_index: int) -> int: ...

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 pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_issuer Property

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

Syntax

def get_pinned_client_cert_issuer(pinned_client_cert_index: int) -> str: ...

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 pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_issuer_rdn Property

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

Syntax

def get_pinned_client_cert_issuer_rdn(pinned_client_cert_index: int) -> str: ...

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 pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_key_algorithm Property

Specifies the public key algorithm of this certificate.

Syntax

def get_pinned_client_cert_key_algorithm(pinned_client_cert_index: int) -> str: ...

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 pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_key_bits Property

Returns the length of the public key in bits.

Syntax

def get_pinned_client_cert_key_bits(pinned_client_cert_index: int) -> int: ...

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 pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_key_fingerprint Property

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

Syntax

def get_pinned_client_cert_key_fingerprint(pinned_client_cert_index: int) -> str: ...

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

The pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_key_usage Property

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

Syntax

def get_pinned_client_cert_key_usage(pinned_client_cert_index: int) -> int: ...

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 pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_public_key_bytes Property

Contains the certificate's public key in DER format.

Syntax

def get_pinned_client_cert_public_key_bytes(pinned_client_cert_index: int) -> bytes: ...

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 pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_self_signed Property

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

Syntax

def get_pinned_client_cert_self_signed(pinned_client_cert_index: int) -> bool: ...

Default Value

FALSE

Remarks

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

The pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_serial_number Property

Returns the certificate's serial number.

Syntax

def get_pinned_client_cert_serial_number(pinned_client_cert_index: int) -> bytes: ...

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 pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_sig_algorithm Property

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

Syntax

def get_pinned_client_cert_sig_algorithm(pinned_client_cert_index: int) -> str: ...

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 pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_subject Property

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

Syntax

def get_pinned_client_cert_subject(pinned_client_cert_index: int) -> str: ...

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 pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_subject_key_id Property

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

Syntax

def get_pinned_client_cert_subject_key_id(pinned_client_cert_index: int) -> bytes: ...

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 pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_subject_rdn Property

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

Syntax

def get_pinned_client_cert_subject_rdn(pinned_client_cert_index: int) -> str: ...

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 pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_valid_from Property

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

Syntax

def get_pinned_client_cert_valid_from(pinned_client_cert_index: int) -> str: ...

Default Value

""

Remarks

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

The pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_valid_to Property

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

Syntax

def get_pinned_client_cert_valid_to(pinned_client_cert_index: int) -> str: ...

Default Value

""

Remarks

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

The pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

port Property

A port to listen for connections on.

Syntax

def get_port() -> int: ...
def set_port(value: int) -> None: ...

port = property(get_port, set_port)

Default Value

5696

Remarks

Use this property to specify the listening port.

read_only Property

Controls whether the server works in read-only mode.

Syntax

def get_read_only() -> bool: ...
def set_read_only(value: bool) -> None: ...

read_only = property(get_read_only, set_read_only)

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.

session_timeout Property

Specifies the default session timeout value in milliseconds.

Syntax

def get_session_timeout() -> int: ...
def set_session_timeout(value: int) -> None: ...

session_timeout = property(get_session_timeout, set_session_timeout)

Default Value

360000

Remarks

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

socket_incoming_speed_limit Property

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

Syntax

def get_socket_incoming_speed_limit() -> int: ...
def set_socket_incoming_speed_limit(value: int) -> None: ...

socket_incoming_speed_limit = property(get_socket_incoming_speed_limit, set_socket_incoming_speed_limit)

Default Value

0

Remarks

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

socket_local_address Property

The local network interface to bind the socket to.

Syntax

def get_socket_local_address() -> str: ...
def set_socket_local_address(value: str) -> None: ...

socket_local_address = property(get_socket_local_address, set_socket_local_address)

Default Value

""

Remarks

The local network interface to bind the socket to.

socket_local_port Property

The local port number to bind the socket to.

Syntax

def get_socket_local_port() -> int: ...
def set_socket_local_port(value: int) -> None: ...

socket_local_port = property(get_socket_local_port, set_socket_local_port)

Default Value

0

Remarks

The local port number to bind the socket to.

socket_outgoing_speed_limit Property

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

Syntax

def get_socket_outgoing_speed_limit() -> int: ...
def set_socket_outgoing_speed_limit(value: int) -> None: ...

socket_outgoing_speed_limit = property(get_socket_outgoing_speed_limit, set_socket_outgoing_speed_limit)

Default Value

0

Remarks

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

socket_timeout Property

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

Syntax

def get_socket_timeout() -> int: ...
def set_socket_timeout(value: int) -> None: ...

socket_timeout = property(get_socket_timeout, set_socket_timeout)

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

socket_use_ipv6 Property

Enables or disables IP protocol version 6.

Syntax

def get_socket_use_ipv6() -> bool: ...
def set_socket_use_ipv6(value: bool) -> None: ...

socket_use_ipv6 = property(get_socket_use_ipv6, set_socket_use_ipv6)

Default Value

FALSE

Remarks

Enables or disables IP protocol version 6.

storage_file_name Property

A path to the KMIP object database.

Syntax

def get_storage_file_name() -> str: ...
def set_storage_file_name(value: str) -> None: ...

storage_file_name = property(get_storage_file_name, set_storage_file_name)

Default Value

""

Remarks

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

tls_server_cert_count Property

The number of records in the TLSServerCert arrays.

Syntax

def get_tls_server_cert_count() -> int: ...
def set_tls_server_cert_count(value: int) -> None: ...

tls_server_cert_count = property(get_tls_server_cert_count, set_tls_server_cert_count)

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.

tls_server_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_tls_server_cert_bytes(tls_server_cert_index: int) -> bytes: ...

Remarks

Returns the raw certificate data in DER format.

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_handle Property

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

Syntax

def get_tls_server_cert_handle(tls_server_cert_index: int) -> int: ...
def set_tls_server_cert_handle(tls_server_cert_index: int, value: int) -> None: ...

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 tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

tls_auto_validate_certificates Property

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

Syntax

def get_tls_auto_validate_certificates() -> bool: ...
def set_tls_auto_validate_certificates(value: bool) -> None: ...

tls_auto_validate_certificates = property(get_tls_auto_validate_certificates, set_tls_auto_validate_certificates)

Default Value

TRUE

Remarks

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

tls_base_configuration Property

Selects the base configuration for the TLS settings.

Syntax

def get_tls_base_configuration() -> int: ...
def set_tls_base_configuration(value: int) -> None: ...

tls_base_configuration = property(get_tls_base_configuration, set_tls_base_configuration)

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.

tls_ciphersuites Property

A list of ciphersuites separated with commas or semicolons.

Syntax

def get_tls_ciphersuites() -> str: ...
def set_tls_ciphersuites(value: str) -> None: ...

tls_ciphersuites = property(get_tls_ciphersuites, set_tls_ciphersuites)

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

tls_client_auth Property

Enables or disables certificate-based client authentication.

Syntax

def get_tls_client_auth() -> int: ...
def set_tls_client_auth(value: int) -> None: ...

tls_client_auth = property(get_tls_client_auth, set_tls_client_auth)

Default Value

0

Remarks

Enables or disables certificate-based client authentication.

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

tls_ec_curves Property

Defines the elliptic curves to enable.

Syntax

def get_tls_ec_curves() -> str: ...
def set_tls_ec_curves(value: str) -> None: ...

tls_ec_curves = property(get_tls_ec_curves, set_tls_ec_curves)

Default Value

""

Remarks

Defines the elliptic curves to enable.

tls_extensions Property

Provides access to TLS extensions.

Syntax

def get_tls_extensions() -> str: ...
def set_tls_extensions(value: str) -> None: ...

tls_extensions = property(get_tls_extensions, set_tls_extensions)

Default Value

""

Remarks

Provides access to TLS extensions.

tls_force_resume_if_destination_changes Property

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

Syntax

def get_tls_force_resume_if_destination_changes() -> bool: ...
def set_tls_force_resume_if_destination_changes(value: bool) -> None: ...

tls_force_resume_if_destination_changes = property(get_tls_force_resume_if_destination_changes, set_tls_force_resume_if_destination_changes)

Default Value

FALSE

Remarks

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

tls_pre_shared_identity Property

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

Syntax

def get_tls_pre_shared_identity() -> str: ...
def set_tls_pre_shared_identity(value: str) -> None: ...

tls_pre_shared_identity = property(get_tls_pre_shared_identity, set_tls_pre_shared_identity)

Default Value

""

Remarks

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

tls_pre_shared_key Property

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

Syntax

def get_tls_pre_shared_key() -> str: ...
def set_tls_pre_shared_key(value: str) -> None: ...

tls_pre_shared_key = property(get_tls_pre_shared_key, set_tls_pre_shared_key)

Default Value

""

Remarks

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

tls_pre_shared_key_ciphersuite Property

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

Syntax

def get_tls_pre_shared_key_ciphersuite() -> str: ...
def set_tls_pre_shared_key_ciphersuite(value: str) -> None: ...

tls_pre_shared_key_ciphersuite = property(get_tls_pre_shared_key_ciphersuite, set_tls_pre_shared_key_ciphersuite)

Default Value

""

Remarks

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

tls_renegotiation_attack_prevention_mode Property

Selects the renegotiation attack prevention mechanism.

Syntax

def get_tls_renegotiation_attack_prevention_mode() -> int: ...
def set_tls_renegotiation_attack_prevention_mode(value: int) -> None: ...

tls_renegotiation_attack_prevention_mode = property(get_tls_renegotiation_attack_prevention_mode, set_tls_renegotiation_attack_prevention_mode)

Default Value

2

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

tls_revocation_check Property

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

Syntax

def get_tls_revocation_check() -> int: ...
def set_tls_revocation_check(value: int) -> None: ...

tls_revocation_check = property(get_tls_revocation_check, set_tls_revocation_check)

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.

tls_ssl_options Property

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

def get_tls_ssl_options() -> int: ...
def set_tls_ssl_options(value: int) -> None: ...

tls_ssl_options = property(get_tls_ssl_options, set_tls_ssl_options)

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

tls_tls_mode Property

Specifies the TLS mode to use.

Syntax

def get_tls_tls_mode() -> int: ...
def set_tls_tls_mode(value: int) -> None: ...

tls_tls_mode = property(get_tls_tls_mode, set_tls_tls_mode)

Default Value

0

Remarks

Specifies the TLS mode to use.

tls_use_extended_master_secret Property

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

Syntax

def get_tls_use_extended_master_secret() -> bool: ...
def set_tls_use_extended_master_secret(value: bool) -> None: ...

tls_use_extended_master_secret = property(get_tls_use_extended_master_secret, set_tls_use_extended_master_secret)

Default Value

FALSE

Remarks

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

tls_use_session_resumption Property

Enables or disables the TLS session resumption capability.

Syntax

def get_tls_use_session_resumption() -> bool: ...
def set_tls_use_session_resumption(value: bool) -> None: ...

tls_use_session_resumption = property(get_tls_use_session_resumption, set_tls_use_session_resumption)

Default Value

FALSE

Remarks

Enables or disables the TLS session resumption capability.

tls_versions Property

The SSL/TLS versions to enable by default.

Syntax

def get_tls_versions() -> int: ...
def set_tls_versions(value: int) -> None: ...

tls_versions = property(get_tls_versions, set_tls_versions)

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

use_chunked_transfer Property

Enables chunked transfer.

Syntax

def get_use_chunked_transfer() -> bool: ...
def set_use_chunked_transfer(value: bool) -> None: ...

use_chunked_transfer = property(get_use_chunked_transfer, set_use_chunked_transfer)

Default Value

FALSE

Remarks

Use this property to enable chunked content encoding.

use_compression Property

Enables or disables server-side compression.

Syntax

def get_use_compression() -> bool: ...
def set_use_compression(value: bool) -> None: ...

use_compression = property(get_use_compression, set_use_compression)

Default Value

FALSE

Remarks

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

use_http Property

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

Syntax

def get_use_http() -> bool: ...
def set_use_http(value: bool) -> None: ...

use_http = property(get_use_http, set_use_http)

Default Value

FALSE

Remarks

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

user_count Property

The number of records in the User arrays.

Syntax

def get_user_count() -> int: ...
def set_user_count(value: int) -> None: ...

user_count = property(get_user_count, set_user_count)

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
• user_otp_algorithm
• user_otp_len
• user_otp_value
• user_outgoing_speed_limit
• user_password
• user_shared_secret
• user_ssh_key
• user_username

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

user_associated_data Property

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

Syntax

def get_user_associated_data(user_index: int) -> bytes: ...
def set_user_associated_data(user_index: int, value: bytes) -> None: ...

Remarks

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

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_base_path Property

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

Syntax

def get_user_base_path(user_index: int) -> str: ...
def set_user_base_path(user_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_certificate Property

Contains the user's certificate.

Syntax

def get_user_certificate(user_index: int) -> bytes: ...
def set_user_certificate(user_index: int, value: bytes) -> None: ...

Remarks

Contains the user's certificate.

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_data Property

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

Syntax

def get_user_data(user_index: int) -> str: ...
def set_user_data(user_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_email Property

The user's email address.

Syntax

def get_user_email(user_index: int) -> str: ...
def set_user_email(user_index: int, value: str) -> None: ...

Default Value

""

Remarks

The user's email address.

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_handle Property

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

Syntax

def get_user_handle(user_index: int) -> int: ...
def set_user_handle(user_index: int, value: int) -> None: ...

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 user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_hash_algorithm Property

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

Syntax

def get_user_hash_algorithm(user_index: int) -> str: ...
def set_user_hash_algorithm(user_index: int, value: str) -> None: ...

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 user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_incoming_speed_limit Property

Specifies the incoming speed limit for this user.

Syntax

def get_user_incoming_speed_limit(user_index: int) -> int: ...
def set_user_incoming_speed_limit(user_index: int, value: int) -> None: ...

Default Value

0

Remarks

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

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_otp_algorithm Property

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

Syntax

def get_user_otp_algorithm(user_index: int) -> int: ...
def set_user_otp_algorithm(user_index: int, value: int) -> None: ...

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 user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_otp_len Property

Specifies the length of the user's OTP password.

Syntax

def get_user_otp_len(user_index: int) -> int: ...
def set_user_otp_len(user_index: int, value: int) -> None: ...

Default Value

0

Remarks

Specifies the length of the user's OTP password.

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_otp_value Property

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

Syntax

def get_user_otp_value(user_index: int) -> int: ...
def set_user_otp_value(user_index: int, value: int) -> None: ...

Default Value

0

Remarks

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

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_outgoing_speed_limit Property

Specifies the outgoing speed limit for this user.

Syntax

def get_user_outgoing_speed_limit(user_index: int) -> int: ...
def set_user_outgoing_speed_limit(user_index: int, value: int) -> None: ...

Default Value

0

Remarks

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

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_password Property

The user's authentication password.

Syntax

def get_user_password(user_index: int) -> str: ...
def set_user_password(user_index: int, value: str) -> None: ...

Default Value

""

Remarks

The user's authentication password.

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_shared_secret Property

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

Syntax

def get_user_shared_secret(user_index: int) -> bytes: ...
def set_user_shared_secret(user_index: int, value: bytes) -> None: ...

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 user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_ssh_key Property

Contains the user's SSH key.

Syntax

def get_user_ssh_key(user_index: int) -> bytes: ...
def set_user_ssh_key(user_index: int, value: bytes) -> None: ...

Remarks

Contains the user's SSH key.

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_username Property

The registered name (login) of the user.

Syntax

def get_user_username(user_index: int) -> str: ...
def set_user_username(user_index: int, value: str) -> None: ...

Default Value

""

Remarks

The registered name (login) of the user.

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

cleanup Method

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

Syntax

def cleanup() -> None: ...

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

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

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

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

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

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

do_action Method

Performs an additional action.

Syntax

def do_action(action_id: str, action_params: str) -> str: ...

Remarks

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

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

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

Common ActionIDs:

drop_client Method

Terminates a client connection.

Syntax

def drop_client(connection_id: int, forced: bool) -> None: ...

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

Populates the per-connection certificate object.

Syntax

def get_client_cert(connection_id: int) -> None: ...

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

Populates the per-connection key object.

Syntax

def get_client_key(connection_id: int) -> None: ...

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

Returns a request header value.

Syntax

def get_request_header(connection_id: int, header_name: str) -> str: ...

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

Returns a response header value.

Syntax

def get_response_header(connection_id: int, header_name: str) -> str: ...

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

Enumerates the connected clients.

Syntax

def list_clients() -> str: ...

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

Takes a snapshot of the connection's properties.

Syntax

def pin_client(connection_id: int) -> None: ...

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

Processes a generic HTTP request.

Syntax

def process_generic_request(connection_id: int, request_bytes: bytes) -> bytes: ...

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

Resets the class settings.

Syntax

def reset() -> None: ...

Remarks

reset is a generic method available in every class.

set_client_bytes Method

Commits a data buffer to the connection.

Syntax

def set_client_bytes(connection_id: int, value: bytes) -> None: ...

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

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

Syntax

def set_client_cert(connection_id: int) -> None: ...

Remarks

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

set_client_key Method

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

Syntax

def set_client_key(connection_id: int) -> None: ...

Remarks

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

set_response_header Method

Sets a response header.

Syntax

def set_response_header(connection_id: int, header_name: str, value: str) -> None: ...

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

Start the KMIP server.

Syntax

def start() -> None: ...

Remarks

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

stop Method

Stops the KMIP server.

Syntax

def stop() -> None: ...

Remarks

Call this method to stop the KMIP server.

on_accept Event

Reports an incoming connection.

Syntax

class KMIPServerAcceptEventParams(object):
  @property
  def remote_address() -> str: ...

  @property
  def remote_port() -> int: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class KMIPServer:
@property
def on_accept() -> Callable[[KMIPServerAcceptEventParams], None]: ...
@on_accept.setter
def on_accept(event_hook: Callable[[KMIPServerAcceptEventParams], None]) -> None: ...

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

Notifies the application about the object activation request.

Syntax

class KMIPServerActivateObjectEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_activate_object() -> Callable[[KMIPServerActivateObjectEventParams], None]: ...
@on_activate_object.setter
def on_activate_object(event_hook: Callable[[KMIPServerActivateObjectEventParams], None]) -> None: ...

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

Passes the certificate import request to the application.

Syntax

class KMIPServerAddEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def group() -> str: ...
  @group.setter
  def group(value) -> None: ...

  @property
  def cert_id() -> str: ...
  @cert_id.setter
  def cert_id(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_add() -> Callable[[KMIPServerAddEventParams], None]: ...
@on_add.setter
def on_add(event_hook: Callable[[KMIPServerAddEventParams], None]) -> None: ...

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

Expects the application to handle the key import request.

Syntax

class KMIPServerAddKeyEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def group() -> str: ...
  @group.setter
  def group(value) -> None: ...

  @property
  def key_id() -> str: ...
  @key_id.setter
  def key_id(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_add_key() -> Callable[[KMIPServerAddKeyEventParams], None]: ...
@on_add_key.setter
def on_add_key(event_hook: Callable[[KMIPServerAddKeyEventParams], None]) -> None: ...

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

Handling and overriding server operations using the Three-Step Virtualization

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

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

• BeforeRenameFile
• RenameFile
• AfterRenameFile

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

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

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

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

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

To summarize:

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

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

on_after_add Event

Notifies the application about completion of the certificate import operation.

Syntax

class KMIPServerAfterAddEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def group() -> str: ...
  @group.setter
  def group(value) -> None: ...

  @property
  def cert_id() -> str: ...
  @cert_id.setter
  def cert_id(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_after_add() -> Callable[[KMIPServerAfterAddEventParams], None]: ...
@on_after_add.setter
def on_after_add(event_hook: Callable[[KMIPServerAfterAddEventParams], None]) -> None: ...

Remarks

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

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

on_after_add_key Event

Reports the completion of the key import procedure.

Syntax

class KMIPServerAfterAddKeyEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def group() -> str: ...
  @group.setter
  def group(value) -> None: ...

  @property
  def key_id() -> str: ...
  @key_id.setter
  def key_id(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_after_add_key() -> Callable[[KMIPServerAfterAddKeyEventParams], None]: ...
@on_after_add_key.setter
def on_after_add_key(event_hook: Callable[[KMIPServerAfterAddKeyEventParams], None]) -> None: ...

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

Handling and overriding server operations using the Three-Step Virtualization

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

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

• BeforeRenameFile
• RenameFile
• AfterRenameFile

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

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

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

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

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

To summarize:

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

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

on_after_browse Event

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

Syntax

class KMIPServerAfterBrowseEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_after_browse() -> Callable[[KMIPServerAfterBrowseEventParams], None]: ...
@on_after_browse.setter
def on_after_browse(event_hook: Callable[[KMIPServerAfterBrowseEventParams], None]) -> None: ...

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

Handling and overriding server operations using the Three-Step Virtualization

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

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

• BeforeRenameFile
• RenameFile
• AfterRenameFile

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

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

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

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

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

To summarize:

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

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

on_after_decrypt Event

Notifies the application about completion of the decryption call.

Syntax

class KMIPServerAfterDecryptEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def decrypted_data() -> bytes: ...

  @property
  def correlation_value() -> str: ...
  @correlation_value.setter
  def correlation_value(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_after_decrypt() -> Callable[[KMIPServerAfterDecryptEventParams], None]: ...
@on_after_decrypt.setter
def on_after_decrypt(event_hook: Callable[[KMIPServerAfterDecryptEventParams], None]) -> None: ...

Remarks

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

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

See the

Handling and overriding server operations using the Three-Step Virtualization

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

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

• BeforeRenameFile
• RenameFile
• AfterRenameFile

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

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

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

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

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

To summarize:

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

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

on_after_derive_key Event

Notifies the application about completion of the key derivation request.

Syntax

class KMIPServerAfterDeriveKeyEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def new_key_id() -> str: ...
  @new_key_id.setter
  def new_key_id(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_after_derive_key() -> Callable[[KMIPServerAfterDeriveKeyEventParams], None]: ...
@on_after_derive_key.setter
def on_after_derive_key(event_hook: Callable[[KMIPServerAfterDeriveKeyEventParams], None]) -> None: ...

Remarks

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

See the

Handling and overriding server operations using the Three-Step Virtualization

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

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

• BeforeRenameFile
• RenameFile
• AfterRenameFile

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

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

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

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

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

To summarize:

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

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

on_after_edit Event

Notifies the application of completion of the object editing operation.

Syntax

class KMIPServerAfterEditEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_after_edit() -> Callable[[KMIPServerAfterEditEventParams], None]: ...
@on_after_edit.setter
def on_after_edit(event_hook: Callable[[KMIPServerAfterEditEventParams], None]) -> None: ...

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

Notifies the application about the completion of the encryption call.

Syntax

class KMIPServerAfterEncryptEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def encrypted_data() -> bytes: ...

  @property
  def correlation_value() -> str: ...
  @correlation_value.setter
  def correlation_value(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_after_encrypt() -> Callable[[KMIPServerAfterEncryptEventParams], None]: ...
@on_after_encrypt.setter
def on_after_encrypt(event_hook: Callable[[KMIPServerAfterEncryptEventParams], None]) -> None: ...

Remarks

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

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

See the

Handling and overriding server operations using the Three-Step Virtualization

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

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

• BeforeRenameFile
• RenameFile
• AfterRenameFile

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

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

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

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

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

To summarize:

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

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

on_after_generate Event

Signifies completion of certificate generation.

Syntax

class KMIPServerAfterGenerateEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def cert_id() -> str: ...
  @cert_id.setter
  def cert_id(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_after_generate() -> Callable[[KMIPServerAfterGenerateEventParams], None]: ...
@on_after_generate.setter
def on_after_generate(event_hook: Callable[[KMIPServerAfterGenerateEventParams], None]) -> None: ...

Remarks

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

on_after_generate_key Event

Notifies the application of the completion of key generation procedure.

Syntax

class KMIPServerAfterGenerateKeyEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def key_id() -> str: ...
  @key_id.setter
  def key_id(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_after_generate_key() -> Callable[[KMIPServerAfterGenerateKeyEventParams], None]: ...
@on_after_generate_key.setter
def on_after_generate_key(event_hook: Callable[[KMIPServerAfterGenerateKeyEventParams], None]) -> None: ...

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

Handling and overriding server operations using the Three-Step Virtualization

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

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

• BeforeRenameFile
• RenameFile
• AfterRenameFile

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

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

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

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

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

To summarize:

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

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

on_after_generate_key_pair Event

Notifies the application of the completion of keypair generation.

Syntax

class KMIPServerAfterGenerateKeyPairEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def private_key_id() -> str: ...
  @private_key_id.setter
  def private_key_id(value) -> None: ...

  @property
  def public_key_id() -> str: ...
  @public_key_id.setter
  def public_key_id(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_after_generate_key_pair() -> Callable[[KMIPServerAfterGenerateKeyPairEventParams], None]: ...
@on_after_generate_key_pair.setter
def on_after_generate_key_pair(event_hook: Callable[[KMIPServerAfterGenerateKeyPairEventParams], None]) -> None: ...

Remarks

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

See the

Handling and overriding server operations using the Three-Step Virtualization

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

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

• BeforeRenameFile
• RenameFile
• AfterRenameFile

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

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

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

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

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

To summarize:

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

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

on_after_hash Event

Notifies the application about completion of the hashing call.

Syntax

class KMIPServerAfterHashEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def hash_data() -> bytes: ...

  @property
  def correlation_value() -> str: ...
  @correlation_value.setter
  def correlation_value(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_after_hash() -> Callable[[KMIPServerAfterHashEventParams], None]: ...
@on_after_hash.setter
def on_after_hash(event_hook: Callable[[KMIPServerAfterHashEventParams], None]) -> None: ...

Remarks

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

See the

Handling and overriding server operations using the Three-Step Virtualization

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

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

• BeforeRenameFile
• RenameFile
• AfterRenameFile

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

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

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

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

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

To summarize:

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

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

on_after_list Event

Notifies the application about completion of the list command.

Syntax

class KMIPServerAfterListEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_type() -> int: ...

  @property
  def object_status() -> int: ...

  @property
  def only_fresh_objects() -> bool: ...

  @property
  def object_ids() -> str: ...
  @object_ids.setter
  def object_ids(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_after_list() -> Callable[[KMIPServerAfterListEventParams], None]: ...
@on_after_list.setter
def on_after_list(event_hook: Callable[[KMIPServerAfterListEventParams], None]) -> None: ...

Remarks

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

See the

Handling and overriding server operations using the Three-Step Virtualization

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

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

• BeforeRenameFile
• RenameFile
• AfterRenameFile

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

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

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

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

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

To summarize:

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

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

on_after_obtain_lease Event

Reports the completion of lease allocation operation.

Syntax

class KMIPServerAfterObtainLeaseEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def lease_time() -> int: ...
  @lease_time.setter
  def lease_time(value) -> None: ...

  @property
  def last_change_date() -> str: ...
  @last_change_date.setter
  def last_change_date(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_after_obtain_lease() -> Callable[[KMIPServerAfterObtainLeaseEventParams], None]: ...
@on_after_obtain_lease.setter
def on_after_obtain_lease(event_hook: Callable[[KMIPServerAfterObtainLeaseEventParams], None]) -> None: ...

Remarks

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

See the

Handling and overriding server operations using the Three-Step Virtualization

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

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

• BeforeRenameFile
• RenameFile
• AfterRenameFile

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

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

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

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

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

To summarize:

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

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

on_after_read_object Event

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

Syntax

class KMIPServerAfterReadObjectEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def object_type() -> int: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_after_read_object() -> Callable[[KMIPServerAfterReadObjectEventParams], None]: ...
@on_after_read_object.setter
def on_after_read_object(event_hook: Callable[[KMIPServerAfterReadObjectEventParams], None]) -> None: ...

Remarks

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

See the

Handling and overriding server operations using the Three-Step Virtualization

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

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

• BeforeRenameFile
• RenameFile
• AfterRenameFile

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

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

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

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

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

To summarize:

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

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

on_after_re_certify Event

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

Syntax

class KMIPServerAfterReCertifyEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def new_cert_id() -> str: ...
  @new_cert_id.setter
  def new_cert_id(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_after_re_certify() -> Callable[[KMIPServerAfterReCertifyEventParams], None]: ...
@on_after_re_certify.setter
def on_after_re_certify(event_hook: Callable[[KMIPServerAfterReCertifyEventParams], None]) -> None: ...

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

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

Syntax

class KMIPServerAfterReKeyEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def new_key_id() -> str: ...
  @new_key_id.setter
  def new_key_id(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_after_re_key() -> Callable[[KMIPServerAfterReKeyEventParams], None]: ...
@on_after_re_key.setter
def on_after_re_key(event_hook: Callable[[KMIPServerAfterReKeyEventParams], None]) -> None: ...

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

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

Syntax

class KMIPServerAfterRekeyKeyPairEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def new_private_key_id() -> str: ...
  @new_private_key_id.setter
  def new_private_key_id(value) -> None: ...

  @property
  def new_public_key_id() -> str: ...
  @new_public_key_id.setter
  def new_public_key_id(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_after_rekey_key_pair() -> Callable[[KMIPServerAfterRekeyKeyPairEventParams], None]: ...
@on_after_rekey_key_pair.setter
def on_after_rekey_key_pair(event_hook: Callable[[KMIPServerAfterRekeyKeyPairEventParams], None]) -> None: ...

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

Notifies the application about completion of the object removal request.

Syntax

class KMIPServerAfterRemoveObjectEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_after_remove_object() -> Callable[[KMIPServerAfterRemoveObjectEventParams], None]: ...
@on_after_remove_object.setter
def on_after_remove_object(event_hook: Callable[[KMIPServerAfterRemoveObjectEventParams], None]) -> None: ...

Remarks

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

See the

Handling and overriding server operations using the Three-Step Virtualization

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

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

• BeforeRenameFile
• RenameFile
• AfterRenameFile

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

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

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

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

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

To summarize:

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

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

on_after_sign Event

Notifies the application of completion of a signing operation.

Syntax

class KMIPServerAfterSignEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def input_is_hash() -> bool: ...

  @property
  def signature_data() -> bytes: ...

  @property
  def correlation_value() -> str: ...
  @correlation_value.setter
  def correlation_value(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_after_sign() -> Callable[[KMIPServerAfterSignEventParams], None]: ...
@on_after_sign.setter
def on_after_sign(event_hook: Callable[[KMIPServerAfterSignEventParams], None]) -> None: ...

Remarks

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

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

See the

Handling and overriding server operations using the Three-Step Virtualization

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

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

• BeforeRenameFile
• RenameFile
• AfterRenameFile

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

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

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

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

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

To summarize:

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

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

on_after_verify Event

Notifies the application about completion of the Verify operation.

Syntax

class KMIPServerAfterVerifyEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def input_is_hash() -> bool: ...

  @property
  def validation_result() -> int: ...
  @validation_result.setter
  def validation_result(value) -> None: ...

  @property
  def correlation_value() -> str: ...
  @correlation_value.setter
  def correlation_value(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_after_verify() -> Callable[[KMIPServerAfterVerifyEventParams], None]: ...
@on_after_verify.setter
def on_after_verify(event_hook: Callable[[KMIPServerAfterVerifyEventParams], None]) -> None: ...

Remarks

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

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

See the

Handling and overriding server operations using the Three-Step Virtualization

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

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

• BeforeRenameFile
• RenameFile
• AfterRenameFile

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

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

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

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

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

To summarize:

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

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

on_after_verify_hash Event

Notifies the application about completion of the hash verification.

Syntax

class KMIPServerAfterVerifyHashEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def is_valid() -> bool: ...
  @is_valid.setter
  def is_valid(value) -> None: ...

  @property
  def correlation_value() -> str: ...
  @correlation_value.setter
  def correlation_value(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_after_verify_hash() -> Callable[[KMIPServerAfterVerifyHashEventParams], None]: ...
@on_after_verify_hash.setter
def on_after_verify_hash(event_hook: Callable[[KMIPServerAfterVerifyHashEventParams], None]) -> None: ...

Remarks

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

The IsValid parameter contains the validity factor of the hash.

See the

Handling and overriding server operations using the Three-Step Virtualization

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

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

• BeforeRenameFile
• RenameFile
• AfterRenameFile

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

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

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

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

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

To summarize:

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

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

on_archive_object Event

Notifies the application about the received object archival request.

Syntax

class KMIPServerArchiveObjectEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_archive_object() -> Callable[[KMIPServerArchiveObjectEventParams], None]: ...
@on_archive_object.setter
def on_archive_object(event_hook: Callable[[KMIPServerArchiveObjectEventParams], None]) -> None: ...

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

Fires when a connected client makes an authentication attempt.

Syntax

class KMIPServerAuthAttemptEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def http_method() -> str: ...

  @property
  def uri() -> str: ...

  @property
  def auth_method() -> str: ...

  @property
  def username() -> str: ...

  @property
  def password() -> str: ...

  @property
  def allow() -> bool: ...
  @allow.setter
  def allow(value) -> None: ...

# In class KMIPServer:
@property
def on_auth_attempt() -> Callable[[KMIPServerAuthAttemptEventParams], None]: ...
@on_auth_attempt.setter
def on_auth_attempt(event_hook: Callable[[KMIPServerAuthAttemptEventParams], None]) -> None: ...

Remarks

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

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

on_before_add Event

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

Syntax

class KMIPServerBeforeAddEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def group() -> str: ...
  @group.setter
  def group(value) -> None: ...

  @property
  def action() -> int: ...
  @action.setter
  def action(value) -> None: ...

# In class KMIPServer:
@property
def on_before_add() -> Callable[[KMIPServerBeforeAddEventParams], None]: ...
@on_before_add.setter
def on_before_add(event_hook: Callable[[KMIPServerBeforeAddEventParams], None]) -> None: ...

Remarks

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

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

on_before_add_key Event

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

Syntax

class KMIPServerBeforeAddKeyEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def group() -> str: ...
  @group.setter
  def group(value) -> None: ...

  @property
  def action() -> int: ...
  @action.setter
  def action(value) -> None: ...

# In class KMIPServer:
@property
def on_before_add_key() -> Callable[[KMIPServerBeforeAddKeyEventParams], None]: ...
@on_before_add_key.setter
def on_before_add_key(event_hook: Callable[[KMIPServerBeforeAddKeyEventParams], None]) -> None: ...

Remarks

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

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

on_before_browse Event

Notifies the application about the browse request being received.

Syntax

class KMIPServerBeforeBrowseEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def action() -> int: ...
  @action.setter
  def action(value) -> None: ...

# In class KMIPServer:
@property
def on_before_browse() -> Callable[[KMIPServerBeforeBrowseEventParams], None]: ...
@on_before_browse.setter
def on_before_browse(event_hook: Callable[[KMIPServerBeforeBrowseEventParams], None]) -> None: ...

Remarks

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

on_before_decrypt Event

Notifies the application about the initiation of the decryption operation.

Syntax

class KMIPServerBeforeDecryptEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def correlation_value() -> str: ...
  @correlation_value.setter
  def correlation_value(value) -> None: ...

  @property
  def action() -> int: ...
  @action.setter
  def action(value) -> None: ...

# In class KMIPServer:
@property
def on_before_decrypt() -> Callable[[KMIPServerBeforeDecryptEventParams], None]: ...
@on_before_decrypt.setter
def on_before_decrypt(event_hook: Callable[[KMIPServerBeforeDecryptEventParams], None]) -> None: ...

Remarks

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

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

Handling and overriding server operations using the Three-Step Virtualization

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

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

• BeforeRenameFile
• RenameFile
• AfterRenameFile

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

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

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

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

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

To summarize:

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

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

on_before_derive_key Event

Fires when a derive key request is received.

Syntax

class KMIPServerBeforeDeriveKeyEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_type() -> int: ...

  @property
  def object_ids() -> str: ...

  @property
  def derivation_method() -> str: ...

  @property
  def action() -> int: ...
  @action.setter
  def action(value) -> None: ...

# In class KMIPServer:
@property
def on_before_derive_key() -> Callable[[KMIPServerBeforeDeriveKeyEventParams], None]: ...
@on_before_derive_key.setter
def on_before_derive_key(event_hook: Callable[[KMIPServerBeforeDeriveKeyEventParams], None]) -> None: ...

Remarks

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

on_before_edit Event

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

Syntax

class KMIPServerBeforeEditEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def action() -> int: ...
  @action.setter
  def action(value) -> None: ...

# In class KMIPServer:
@property
def on_before_edit() -> Callable[[KMIPServerBeforeEditEventParams], None]: ...
@on_before_edit.setter
def on_before_edit(event_hook: Callable[[KMIPServerBeforeEditEventParams], None]) -> None: ...

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

Notifies the application about the initiation of an encryption operation.

Syntax

class KMIPServerBeforeEncryptEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def correlation_value() -> str: ...
  @correlation_value.setter
  def correlation_value(value) -> None: ...

  @property
  def action() -> int: ...
  @action.setter
  def action(value) -> None: ...

# In class KMIPServer:
@property
def on_before_encrypt() -> Callable[[KMIPServerBeforeEncryptEventParams], None]: ...
@on_before_encrypt.setter
def on_before_encrypt(event_hook: Callable[[KMIPServerBeforeEncryptEventParams], None]) -> None: ...

Remarks

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

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

Handling and overriding server operations using the Three-Step Virtualization

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

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

• BeforeRenameFile
• RenameFile
• AfterRenameFile

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

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

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

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

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

To summarize:

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

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

on_before_generate Event

Fires when a certificate generation request is received.

Syntax

class KMIPServerBeforeGenerateEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def public_key_id() -> str: ...

  @property
  def action() -> int: ...
  @action.setter
  def action(value) -> None: ...

# In class KMIPServer:
@property
def on_before_generate() -> Callable[[KMIPServerBeforeGenerateEventParams], None]: ...
@on_before_generate.setter
def on_before_generate(event_hook: Callable[[KMIPServerBeforeGenerateEventParams], None]) -> None: ...

Remarks

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

on_before_generate_key Event

Fires when a key generation request is received.

Syntax

class KMIPServerBeforeGenerateKeyEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def key_algorithm() -> str: ...
  @key_algorithm.setter
  def key_algorithm(value) -> None: ...

  @property
  def key_length() -> int: ...
  @key_length.setter
  def key_length(value) -> None: ...

  @property
  def action() -> int: ...
  @action.setter
  def action(value) -> None: ...

# In class KMIPServer:
@property
def on_before_generate_key() -> Callable[[KMIPServerBeforeGenerateKeyEventParams], None]: ...
@on_before_generate_key.setter
def on_before_generate_key(event_hook: Callable[[KMIPServerBeforeGenerateKeyEventParams], None]) -> None: ...

Remarks

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

on_before_generate_key_pair Event

Fires when a key generation request is received.

Syntax

class KMIPServerBeforeGenerateKeyPairEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def key_algorithm() -> str: ...
  @key_algorithm.setter
  def key_algorithm(value) -> None: ...

  @property
  def key_length() -> int: ...
  @key_length.setter
  def key_length(value) -> None: ...

  @property
  def scheme() -> str: ...
  @scheme.setter
  def scheme(value) -> None: ...

  @property
  def scheme_params() -> str: ...
  @scheme_params.setter
  def scheme_params(value) -> None: ...

  @property
  def action() -> int: ...
  @action.setter
  def action(value) -> None: ...

# In class KMIPServer:
@property
def on_before_generate_key_pair() -> Callable[[KMIPServerBeforeGenerateKeyPairEventParams], None]: ...
@on_before_generate_key_pair.setter
def on_before_generate_key_pair(event_hook: Callable[[KMIPServerBeforeGenerateKeyPairEventParams], None]) -> None: ...

Remarks

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

on_before_hash Event

Notifies the application about the initiation of the hashing operation.

Syntax

class KMIPServerBeforeHashEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def hash_algorithm() -> str: ...

  @property
  def correlation_value() -> str: ...
  @correlation_value.setter
  def correlation_value(value) -> None: ...

  @property
  def action() -> int: ...
  @action.setter
  def action(value) -> None: ...

# In class KMIPServer:
@property
def on_before_hash() -> Callable[[KMIPServerBeforeHashEventParams], None]: ...
@on_before_hash.setter
def on_before_hash(event_hook: Callable[[KMIPServerBeforeHashEventParams], None]) -> None: ...

Remarks

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

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

Handling and overriding server operations using the Three-Step Virtualization

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

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

• BeforeRenameFile
• RenameFile
• AfterRenameFile

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

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

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

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

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

To summarize:

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

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

on_before_list Event

Notifies the application about the initiation of the list operation.

Syntax

class KMIPServerBeforeListEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_type() -> int: ...

  @property
  def object_status() -> int: ...

  @property
  def only_fresh_objects() -> bool: ...

  @property
  def action() -> int: ...
  @action.setter
  def action(value) -> None: ...

# In class KMIPServer:
@property
def on_before_list() -> Callable[[KMIPServerBeforeListEventParams], None]: ...
@on_before_list.setter
def on_before_list(event_hook: Callable[[KMIPServerBeforeListEventParams], None]) -> None: ...

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

Notifies the application about the client requesting an object lease.

Syntax

class KMIPServerBeforeObtainLeaseEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def action() -> int: ...
  @action.setter
  def action(value) -> None: ...

# In class KMIPServer:
@property
def on_before_obtain_lease() -> Callable[[KMIPServerBeforeObtainLeaseEventParams], None]: ...
@on_before_obtain_lease.setter
def on_before_obtain_lease(event_hook: Callable[[KMIPServerBeforeObtainLeaseEventParams], None]) -> None: ...

Remarks

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

on_before_read_object Event

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

Syntax

class KMIPServerBeforeReadObjectEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def action() -> int: ...
  @action.setter
  def action(value) -> None: ...

# In class KMIPServer:
@property
def on_before_read_object() -> Callable[[KMIPServerBeforeReadObjectEventParams], None]: ...
@on_before_read_object.setter
def on_before_read_object(event_hook: Callable[[KMIPServerBeforeReadObjectEventParams], None]) -> None: ...

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

Notifies the application about a re-certification request.

Syntax

class KMIPServerBeforeReCertifyEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def old_cert_id() -> str: ...

  @property
  def action() -> int: ...
  @action.setter
  def action(value) -> None: ...

# In class KMIPServer:
@property
def on_before_re_certify() -> Callable[[KMIPServerBeforeReCertifyEventParams], None]: ...
@on_before_re_certify.setter
def on_before_re_certify(event_hook: Callable[[KMIPServerBeforeReCertifyEventParams], None]) -> None: ...

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

Notifies the application about a re-key request received.

Syntax

class KMIPServerBeforeReKeyEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def old_key_id() -> str: ...

  @property
  def action() -> int: ...
  @action.setter
  def action(value) -> None: ...

# In class KMIPServer:
@property
def on_before_re_key() -> Callable[[KMIPServerBeforeReKeyEventParams], None]: ...
@on_before_re_key.setter
def on_before_re_key(event_hook: Callable[[KMIPServerBeforeReKeyEventParams], None]) -> None: ...

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

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

Syntax

class KMIPServerBeforeRekeyKeyPairEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def old_private_key_id() -> str: ...

  @property
  def action() -> int: ...
  @action.setter
  def action(value) -> None: ...

# In class KMIPServer:
@property
def on_before_rekey_key_pair() -> Callable[[KMIPServerBeforeRekeyKeyPairEventParams], None]: ...
@on_before_rekey_key_pair.setter
def on_before_rekey_key_pair(event_hook: Callable[[KMIPServerBeforeRekeyKeyPairEventParams], None]) -> None: ...

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

Notifies the application about an incoming Remove Object request.

Syntax

class KMIPServerBeforeRemoveObjectEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def action() -> int: ...
  @action.setter
  def action(value) -> None: ...

# In class KMIPServer:
@property
def on_before_remove_object() -> Callable[[KMIPServerBeforeRemoveObjectEventParams], None]: ...
@on_before_remove_object.setter
def on_before_remove_object(event_hook: Callable[[KMIPServerBeforeRemoveObjectEventParams], None]) -> None: ...

Remarks

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

on_before_sign Event

Notifies the application about the initiation of a signing operation.

Syntax

class KMIPServerBeforeSignEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def algorithm() -> str: ...

  @property
  def hash_algorithm() -> str: ...

  @property
  def input_is_hash() -> bool: ...

  @property
  def correlation_value() -> str: ...
  @correlation_value.setter
  def correlation_value(value) -> None: ...

  @property
  def action() -> int: ...
  @action.setter
  def action(value) -> None: ...

# In class KMIPServer:
@property
def on_before_sign() -> Callable[[KMIPServerBeforeSignEventParams], None]: ...
@on_before_sign.setter
def on_before_sign(event_hook: Callable[[KMIPServerBeforeSignEventParams], None]) -> None: ...

Remarks

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

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

Handling and overriding server operations using the Three-Step Virtualization

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

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

• BeforeRenameFile
• RenameFile
• AfterRenameFile

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

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

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

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

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

To summarize:

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

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

on_before_verify Event

Notifies the application about the initiation of the verify operation.

Syntax

class KMIPServerBeforeVerifyEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def hash_algorithm() -> str: ...

  @property
  def input_is_hash() -> bool: ...

  @property
  def correlation_value() -> str: ...
  @correlation_value.setter
  def correlation_value(value) -> None: ...

  @property
  def action() -> int: ...
  @action.setter
  def action(value) -> None: ...

# In class KMIPServer:
@property
def on_before_verify() -> Callable[[KMIPServerBeforeVerifyEventParams], None]: ...
@on_before_verify.setter
def on_before_verify(event_hook: Callable[[KMIPServerBeforeVerifyEventParams], None]) -> None: ...

Remarks

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

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

Handling and overriding server operations using the Three-Step Virtualization

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

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

• BeforeRenameFile
• RenameFile
• AfterRenameFile

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

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

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

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

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

To summarize:

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

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

on_before_verify_hash Event

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

Syntax

class KMIPServerBeforeVerifyHashEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def hash_algorithm() -> str: ...

  @property
  def correlation_value() -> str: ...
  @correlation_value.setter
  def correlation_value(value) -> None: ...

  @property
  def action() -> int: ...
  @action.setter
  def action(value) -> None: ...

# In class KMIPServer:
@property
def on_before_verify_hash() -> Callable[[KMIPServerBeforeVerifyHashEventParams], None]: ...
@on_before_verify_hash.setter
def on_before_verify_hash(event_hook: Callable[[KMIPServerBeforeVerifyHashEventParams], None]) -> None: ...

Remarks

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

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

Handling and overriding server operations using the Three-Step Virtualization

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

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

• BeforeRenameFile
• RenameFile
• AfterRenameFile

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

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

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

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

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

To summarize:

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

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

on_cancel Event

Reports a cancellation request received from the client.

Syntax

class KMIPServerCancelEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def async_correlation_value() -> str: ...

  @property
  def cancellation_result() -> int: ...
  @cancellation_result.setter
  def cancellation_result(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_cancel() -> Callable[[KMIPServerCancelEventParams], None]: ...
@on_cancel.setter
def on_cancel(event_hook: Callable[[KMIPServerCancelEventParams], None]) -> None: ...

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

Notifies the application about a Check request received.

Syntax

class KMIPServerCheckEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def usage_limits_count() -> int: ...
  @usage_limits_count.setter
  def usage_limits_count(value) -> None: ...

  @property
  def cryptographic_usage_mask() -> int: ...
  @cryptographic_usage_mask.setter
  def cryptographic_usage_mask(value) -> None: ...

  @property
  def lease_time() -> int: ...
  @lease_time.setter
  def lease_time(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_check() -> Callable[[KMIPServerCheckEventParams], None]: ...
@on_check.setter
def on_check(event_hook: Callable[[KMIPServerCheckEventParams], None]) -> None: ...

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

Reports an accepted connection.

Syntax

class KMIPServerConnectEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def remote_address() -> str: ...

  @property
  def remote_port() -> int: ...

# In class KMIPServer:
@property
def on_connect() -> Callable[[KMIPServerConnectEventParams], None]: ...
@on_connect.setter
def on_connect(event_hook: Callable[[KMIPServerConnectEventParams], None]) -> None: ...

Remarks

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

on_decrypt Event

Instructs the application to decrypt a chunk of data.

Syntax

class KMIPServerDecryptEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def data() -> bytes: ...

  @property
  def iv() -> str: ...

  @property
  def init_indicator() -> bool: ...

  @property
  def final_indicator() -> bool: ...

  @property
  def block_cipher_mode() -> str: ...

  @property
  def tag_length() -> int: ...

  @property
  def padding_method() -> str: ...

  @property
  def correlation_value() -> str: ...
  @correlation_value.setter
  def correlation_value(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_decrypt() -> Callable[[KMIPServerDecryptEventParams], None]: ...
@on_decrypt.setter
def on_decrypt(event_hook: Callable[[KMIPServerDecryptEventParams], None]) -> None: ...

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

Instructs the application to delete an object attribute.

Syntax

class KMIPServerDeleteAttributeEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def attribute_name() -> str: ...

  @property
  def attribute_value() -> str: ...
  @attribute_value.setter
  def attribute_value(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_delete_attribute() -> Callable[[KMIPServerDeleteAttributeEventParams], None]: ...
@on_delete_attribute.setter
def on_delete_attribute(event_hook: Callable[[KMIPServerDeleteAttributeEventParams], None]) -> None: ...

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

Notifies the application of key derivation request.

Syntax

class KMIPServerDeriveKeyEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_type() -> int: ...

  @property
  def object_ids() -> str: ...

  @property
  def derivation_method() -> str: ...

  @property
  def initialization_vector() -> bytes: ...

  @property
  def derivation_data() -> bytes: ...

  @property
  def new_key_id() -> str: ...
  @new_key_id.setter
  def new_key_id(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_derive_key() -> Callable[[KMIPServerDeriveKeyEventParams], None]: ...
@on_derive_key.setter
def on_derive_key(event_hook: Callable[[KMIPServerDeriveKeyEventParams], None]) -> None: ...

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

Fires to report a disconnected client.

Syntax

class KMIPServerDisconnectEventParams(object):
  @property
  def connection_id() -> int: ...

# In class KMIPServer:
@property
def on_disconnect() -> Callable[[KMIPServerDisconnectEventParams], None]: ...
@on_disconnect.setter
def on_disconnect(event_hook: Callable[[KMIPServerDisconnectEventParams], None]) -> None: ...

Remarks

The class fires this event when a connected client disconnects.

on_encrypt Event

Instructs the application to encrypt a chunk of data.

Syntax

class KMIPServerEncryptEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def data() -> bytes: ...

  @property
  def init_indicator() -> bool: ...

  @property
  def final_indicator() -> bool: ...

  @property
  def block_cipher_mode() -> str: ...

  @property
  def tag_length() -> int: ...

  @property
  def padding_method() -> str: ...

  @property
  def random_iv() -> bool: ...

  @property
  def iv() -> str: ...
  @iv.setter
  def iv(value) -> None: ...

  @property
  def correlation_value() -> str: ...
  @correlation_value.setter
  def correlation_value(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_encrypt() -> Callable[[KMIPServerEncryptEventParams], None]: ...
@on_encrypt.setter
def on_encrypt(event_hook: Callable[[KMIPServerEncryptEventParams], None]) -> None: ...

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

Information about errors during data delivery.

Syntax

class KMIPServerErrorEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def error_code() -> int: ...

  @property
  def fatal() -> bool: ...

  @property
  def remote() -> bool: ...

  @property
  def description() -> str: ...

# In class KMIPServer:
@property
def on_error() -> Callable[[KMIPServerErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[KMIPServerErrorEventParams], None]) -> None: ...

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

Handles remote or external signing initiated by the server protocol.

Syntax

class KMIPServerExternalSignEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def operation_id() -> str: ...

  @property
  def hash_algorithm() -> str: ...

  @property
  def pars() -> str: ...

  @property
  def data() -> str: ...

  @property
  def signed_data() -> str: ...
  @signed_data.setter
  def signed_data(value) -> None: ...

# In class KMIPServer:
@property
def on_external_sign() -> Callable[[KMIPServerExternalSignEventParams], None]: ...
@on_external_sign.setter
def on_external_sign(event_hook: Callable[[KMIPServerExternalSignEventParams], None]) -> None: ...

Remarks

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

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

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

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

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

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

on_generate Event

Notifies the application about an incoming Generate request.

Syntax

class KMIPServerGenerateEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def public_key_id() -> str: ...

  @property
  def cert_id() -> str: ...
  @cert_id.setter
  def cert_id(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_generate() -> Callable[[KMIPServerGenerateEventParams], None]: ...
@on_generate.setter
def on_generate(event_hook: Callable[[KMIPServerGenerateEventParams], None]) -> None: ...

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

Notifies the application about an incoming Generate request.

Syntax

class KMIPServerGenerateKeyEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def key_algorithm() -> str: ...

  @property
  def key_length() -> int: ...

  @property
  def group() -> str: ...

  @property
  def key_id() -> str: ...
  @key_id.setter
  def key_id(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_generate_key() -> Callable[[KMIPServerGenerateKeyEventParams], None]: ...
@on_generate_key.setter
def on_generate_key(event_hook: Callable[[KMIPServerGenerateKeyEventParams], None]) -> None: ...

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

Notifies the application about an incoming Generate request.

Syntax

class KMIPServerGenerateKeyPairEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def key_algorithm() -> str: ...

  @property
  def key_length() -> int: ...

  @property
  def scheme() -> str: ...

  @property
  def scheme_params() -> str: ...

  @property
  def group() -> str: ...

  @property
  def private_key_id() -> str: ...
  @private_key_id.setter
  def private_key_id(value) -> None: ...

  @property
  def public_key_id() -> str: ...
  @public_key_id.setter
  def public_key_id(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_generate_key_pair() -> Callable[[KMIPServerGenerateKeyPairEventParams], None]: ...
@on_generate_key_pair.setter
def on_generate_key_pair(event_hook: Callable[[KMIPServerGenerateKeyPairEventParams], None]) -> None: ...

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

Notifies the application about an incoming Get Usage Allocation request.

Syntax

class KMIPServerGetUsageAllocationEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def usage_limits_count() -> int: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_get_usage_allocation() -> Callable[[KMIPServerGetUsageAllocationEventParams], None]: ...
@on_get_usage_allocation.setter
def on_get_usage_allocation(event_hook: Callable[[KMIPServerGetUsageAllocationEventParams], None]) -> None: ...

Remarks

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

on_hash Event

Instructs the application to update the current hashing operation.

Syntax

class KMIPServerHashEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def hash_algorithm() -> str: ...

  @property
  def data() -> bytes: ...

  @property
  def init_indicator() -> bool: ...

  @property
  def final_indicator() -> bool: ...

  @property
  def correlation_value() -> str: ...
  @correlation_value.setter
  def correlation_value(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_hash() -> Callable[[KMIPServerHashEventParams], None]: ...
@on_hash.setter
def on_hash(event_hook: Callable[[KMIPServerHashEventParams], None]) -> None: ...

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

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

Syntax

class KMIPServerHeadersPreparedEventParams(object):
  @property
  def connection_id() -> int: ...

# In class KMIPServer:
@property
def on_headers_prepared() -> Callable[[KMIPServerHeadersPreparedEventParams], None]: ...
@on_headers_prepared.setter
def on_headers_prepared(event_hook: Callable[[KMIPServerHeadersPreparedEventParams], None]) -> None: ...

Remarks

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

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

on_kmip_auth_attempt Event

Fires when a connected client makes an authentication attempt.

Syntax

class KMIPServerKMIPAuthAttemptEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def username() -> str: ...

  @property
  def password() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class KMIPServer:
@property
def on_kmip_auth_attempt() -> Callable[[KMIPServerKMIPAuthAttemptEventParams], None]: ...
@on_kmip_auth_attempt.setter
def on_kmip_auth_attempt(event_hook: Callable[[KMIPServerKMIPAuthAttemptEventParams], None]) -> None: ...

Remarks

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

Username and Password contain the professed credentials.

on_list Event

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

Syntax

class KMIPServerListEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_type() -> int: ...

  @property
  def object_status() -> int: ...

  @property
  def only_fresh_objects() -> bool: ...

  @property
  def offset_items() -> int: ...

  @property
  def maximum_items() -> int: ...

  @property
  def object_ids() -> str: ...
  @object_ids.setter
  def object_ids(value) -> None: ...

  @property
  def located_items() -> int: ...
  @located_items.setter
  def located_items(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_list() -> Callable[[KMIPServerListEventParams], None]: ...
@on_list.setter
def on_list(event_hook: Callable[[KMIPServerListEventParams], None]) -> None: ...

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

Requests a list of object attribute names from the application.

Syntax

class KMIPServerListAttributesEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def attribute_names() -> str: ...
  @attribute_names.setter
  def attribute_names(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_list_attributes() -> Callable[[KMIPServerListAttributesEventParams], None]: ...
@on_list_attributes.setter
def on_list_attributes(event_hook: Callable[[KMIPServerListAttributesEventParams], None]) -> None: ...

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

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

Syntax

class KMIPServerNotificationEventParams(object):
  @property
  def event_id() -> str: ...

  @property
  def event_param() -> str: ...

# In class KMIPServer:
@property
def on_notification() -> Callable[[KMIPServerNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[KMIPServerNotificationEventParams], None]) -> None: ...

Remarks

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

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

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

on_obtain_lease Event

Lets the application handle the lease request.

Syntax

class KMIPServerObtainLeaseEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def lease_time() -> int: ...
  @lease_time.setter
  def lease_time(value) -> None: ...

  @property
  def last_change_date() -> str: ...
  @last_change_date.setter
  def last_change_date(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_obtain_lease() -> Callable[[KMIPServerObtainLeaseEventParams], None]: ...
@on_obtain_lease.setter
def on_obtain_lease(event_hook: Callable[[KMIPServerObtainLeaseEventParams], None]) -> None: ...

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

Fires when a request is received from the client.

Syntax

class KMIPServerOperationAttemptEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def operation() -> str: ...

  @property
  def username() -> str: ...

  @property
  def reject() -> bool: ...
  @reject.setter
  def reject(value) -> None: ...

# In class KMIPServer:
@property
def on_operation_attempt() -> Callable[[KMIPServerOperationAttemptEventParams], None]: ...
@on_operation_attempt.setter
def on_operation_attempt(event_hook: Callable[[KMIPServerOperationAttemptEventParams], None]) -> None: ...

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

Notifies the application about the received Poll request.

Syntax

class KMIPServerPollEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def async_correlation_value() -> str: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_poll() -> Callable[[KMIPServerPollEventParams], None]: ...
@on_poll.setter
def on_poll(event_hook: Callable[[KMIPServerPollEventParams], None]) -> None: ...

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

Requests an object attribute value from the application.

Syntax

class KMIPServerReadAttributeEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def attribute_name() -> str: ...

  @property
  def attribute_value() -> str: ...
  @attribute_value.setter
  def attribute_value(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_read_attribute() -> Callable[[KMIPServerReadAttributeEventParams], None]: ...
@on_read_attribute.setter
def on_read_attribute(event_hook: Callable[[KMIPServerReadAttributeEventParams], None]) -> None: ...

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

Requests the details of the object from the application.

Syntax

class KMIPServerReadObjectEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def object_type() -> int: ...
  @object_type.setter
  def object_type(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_read_object() -> Callable[[KMIPServerReadObjectEventParams], None]: ...
@on_read_object.setter
def on_read_object(event_hook: Callable[[KMIPServerReadObjectEventParams], None]) -> None: ...

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 commiting it using set_client_cert or set_client_key respectively.

on_re_certify Event

Notifies the application about an incoming re-certification request.

Syntax

class KMIPServerReCertifyEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def old_cert_id() -> str: ...

  @property
  def offset() -> int: ...

  @property
  def group() -> str: ...

  @property
  def new_cert_id() -> str: ...
  @new_cert_id.setter
  def new_cert_id(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_re_certify() -> Callable[[KMIPServerReCertifyEventParams], None]: ...
@on_re_certify.setter
def on_re_certify(event_hook: Callable[[KMIPServerReCertifyEventParams], None]) -> None: ...

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

Notifies the application about an incoming Recover Object request.

Syntax

class KMIPServerRecoverObjectEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_recover_object() -> Callable[[KMIPServerRecoverObjectEventParams], None]: ...
@on_recover_object.setter
def on_recover_object(event_hook: Callable[[KMIPServerRecoverObjectEventParams], None]) -> None: ...

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

Notifies the application about an incoming re-key request.

Syntax

class KMIPServerReKeyEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def old_key_id() -> str: ...

  @property
  def offset() -> int: ...

  @property
  def group() -> str: ...

  @property
  def new_key_id() -> str: ...
  @new_key_id.setter
  def new_key_id(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_re_key() -> Callable[[KMIPServerReKeyEventParams], None]: ...
@on_re_key.setter
def on_re_key(event_hook: Callable[[KMIPServerReKeyEventParams], None]) -> None: ...

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

Notifies the application about an incoming re-key request.

Syntax

class KMIPServerRekeyKeyPairEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def old_private_key_id() -> str: ...

  @property
  def offset() -> int: ...

  @property
  def group() -> str: ...

  @property
  def new_private_key_id() -> str: ...
  @new_private_key_id.setter
  def new_private_key_id(value) -> None: ...

  @property
  def new_public_key_id() -> str: ...
  @new_public_key_id.setter
  def new_public_key_id(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_rekey_key_pair() -> Callable[[KMIPServerRekeyKeyPairEventParams], None]: ...
@on_rekey_key_pair.setter
def on_rekey_key_pair(event_hook: Callable[[KMIPServerRekeyKeyPairEventParams], None]) -> None: ...

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

Notifies the application about the object deletion request.

Syntax

class KMIPServerRemoveObjectEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_remove_object() -> Callable[[KMIPServerRemoveObjectEventParams], None]: ...
@on_remove_object.setter
def on_remove_object(event_hook: Callable[[KMIPServerRemoveObjectEventParams], None]) -> None: ...

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

Notifies the application about KMIP requests being received.

Syntax

class KMIPServerRequestEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def request_data() -> bytes: ...

# In class KMIPServer:
@property
def on_request() -> Callable[[KMIPServerRequestEventParams], None]: ...
@on_request.setter
def on_request(event_hook: Callable[[KMIPServerRequestEventParams], None]) -> None: ...

Remarks

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

on_response Event

Notifies the application about KMIP responses being sent back.

Syntax

class KMIPServerResponseEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def response_data() -> bytes: ...

# In class KMIPServer:
@property
def on_response() -> Callable[[KMIPServerResponseEventParams], None]: ...
@on_response.setter
def on_response(event_hook: Callable[[KMIPServerResponseEventParams], None]) -> None: ...

Remarks

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

on_revoke_object Event

Instructs the application to revoke an object.

Syntax

class KMIPServerRevokeObjectEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def reason_code() -> int: ...

  @property
  def reason_message() -> str: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_revoke_object() -> Callable[[KMIPServerRevokeObjectEventParams], None]: ...
@on_revoke_object.setter
def on_revoke_object(event_hook: Callable[[KMIPServerRevokeObjectEventParams], None]) -> None: ...

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

Asks the application for another block of random numbers.

Syntax

class KMIPServerRNGGenerateEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def data_length() -> int: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_rng_generate() -> Callable[[KMIPServerRNGGenerateEventParams], None]: ...
@on_rng_generate.setter
def on_rng_generate(event_hook: Callable[[KMIPServerRNGGenerateEventParams], None]) -> None: ...

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

Tells the application to seed the random number generator.

Syntax

class KMIPServerRNGSeedEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def data() -> bytes: ...

  @property
  def bytes_used() -> int: ...
  @bytes_used.setter
  def bytes_used(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_rng_seed() -> Callable[[KMIPServerRNGSeedEventParams], None]: ...
@on_rng_seed.setter
def on_rng_seed(event_hook: Callable[[KMIPServerRNGSeedEventParams], None]) -> None: ...

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

Passes a set-attribute request to the application.

Syntax

class KMIPServerSetAttributeEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def attribute_name() -> str: ...

  @property
  def attribute_value() -> str: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_set_attribute() -> Callable[[KMIPServerSetAttributeEventParams], None]: ...
@on_set_attribute.setter
def on_set_attribute(event_hook: Callable[[KMIPServerSetAttributeEventParams], None]) -> None: ...

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

Instructs the application to sign data with a private key.

Syntax

class KMIPServerSignEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def algorithm() -> str: ...

  @property
  def hash_algorithm() -> str: ...

  @property
  def input_is_hash() -> bool: ...

  @property
  def data() -> bytes: ...

  @property
  def init_indicator() -> bool: ...

  @property
  def final_indicator() -> bool: ...

  @property
  def correlation_value() -> str: ...
  @correlation_value.setter
  def correlation_value(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_sign() -> Callable[[KMIPServerSignEventParams], None]: ...
@on_sign.setter
def on_sign(event_hook: Callable[[KMIPServerSignEventParams], None]) -> None: ...

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

Fires when a client certificate needs to be validated.

Syntax

class KMIPServerTLSCertValidateEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class KMIPServer:
@property
def on_tls_cert_validate() -> Callable[[KMIPServerTLSCertValidateEventParams], None]: ...
@on_tls_cert_validate.setter
def on_tls_cert_validate(event_hook: Callable[[KMIPServerTLSCertValidateEventParams], None]) -> None: ...

Remarks

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

on_tls_established Event

Reports the setup of a TLS session.

Syntax

class KMIPServerTLSEstablishedEventParams(object):
  @property
  def connection_id() -> int: ...

# In class KMIPServer:
@property
def on_tls_established() -> Callable[[KMIPServerTLSEstablishedEventParams], None]: ...
@on_tls_established.setter
def on_tls_established(event_hook: Callable[[KMIPServerTLSEstablishedEventParams], None]) -> None: ...

Remarks

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

on_tls_handshake Event

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

Syntax

class KMIPServerTLSHandshakeEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def server_name() -> str: ...

  @property
  def abort() -> bool: ...
  @abort.setter
  def abort(value) -> None: ...

# In class KMIPServer:
@property
def on_tls_handshake() -> Callable[[KMIPServerTLSHandshakeEventParams], None]: ...
@on_tls_handshake.setter
def on_tls_handshake(event_hook: Callable[[KMIPServerTLSHandshakeEventParams], None]) -> None: ...

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

Requests a pre-shared key for TLS-PSK.

Syntax

class KMIPServerTLSPSKEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def identity() -> str: ...

  @property
  def psk() -> str: ...
  @psk.setter
  def psk(value) -> None: ...

  @property
  def ciphersuite() -> str: ...
  @ciphersuite.setter
  def ciphersuite(value) -> None: ...

# In class KMIPServer:
@property
def on_tls_psk() -> Callable[[KMIPServerTLSPSKEventParams], None]: ...
@on_tls_psk.setter
def on_tls_psk(event_hook: Callable[[KMIPServerTLSPSKEventParams], None]) -> None: ...

Remarks

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

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

on_tls_shutdown Event

Reports closure of a TLS session.

Syntax

class KMIPServerTLSShutdownEventParams(object):
  @property
  def connection_id() -> int: ...

# In class KMIPServer:
@property
def on_tls_shutdown() -> Callable[[KMIPServerTLSShutdownEventParams], None]: ...
@on_tls_shutdown.setter
def on_tls_shutdown(event_hook: Callable[[KMIPServerTLSShutdownEventParams], None]) -> None: ...

Remarks

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

Passes the chain validation request to the application.

Syntax

class KMIPServerValidateChainEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_ids() -> str: ...

  @property
  def validity() -> int: ...
  @validity.setter
  def validity(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_validate_chain() -> Callable[[KMIPServerValidateChainEventParams], None]: ...
@on_validate_chain.setter
def on_validate_chain(event_hook: Callable[[KMIPServerValidateChainEventParams], None]) -> None: ...

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 fires this event to notify the application about a verification operation request, and expects the application to perform it.

Syntax

class KMIPServerVerifyEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def hash_algorithm() -> str: ...

  @property
  def input_is_hash() -> bool: ...

  @property
  def data() -> bytes: ...

  @property
  def signature_data() -> bytes: ...

  @property
  def init_indicator() -> bool: ...

  @property
  def final_indicator() -> bool: ...

  @property
  def validation_result() -> int: ...
  @validation_result.setter
  def validation_result(value) -> None: ...

  @property
  def correlation_value() -> str: ...
  @correlation_value.setter
  def correlation_value(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_verify() -> Callable[[KMIPServerVerifyEventParams], None]: ...
@on_verify.setter
def on_verify(event_hook: Callable[[KMIPServerVerifyEventParams], None]) -> None: ...

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

Handling and overriding server operations using the Three-Step Virtualization

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

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

• BeforeRenameFile
• RenameFile
• AfterRenameFile

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

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

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

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

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

To summarize:

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

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

on_verify_hash Event

Delegates the hash verification operation to a custom handler.

Syntax

class KMIPServerVerifyHashEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def object_id() -> str: ...

  @property
  def hash_algorithm() -> str: ...

  @property
  def data() -> bytes: ...

  @property
  def hash() -> bytes: ...

  @property
  def init_indicator() -> bool: ...

  @property
  def final_indicator() -> bool: ...

  @property
  def is_valid() -> bool: ...
  @is_valid.setter
  def is_valid(value) -> None: ...

  @property
  def correlation_value() -> str: ...
  @correlation_value.setter
  def correlation_value(value) -> None: ...

  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class KMIPServer:
@property
def on_verify_hash() -> Callable[[KMIPServerVerifyHashEventParams], None]: ...
@on_verify_hash.setter
def on_verify_hash(event_hook: Callable[[KMIPServerVerifyHashEventParams], None]) -> None: ...

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.

KMIPServer Config Settings

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

KMIPServer Config Settings

Base Config Settings

KMIPServer Errors

KMIPServer Errors