Struct secureblackbox::KMIPClient

Properties Methods Events Config Settings Errors

The KMIPClient struct provides client-side functionality for KMIP protocol.

Syntax

secureblackbox::KMIPClient

Remarks

The KMIPClient component implements the client-side counterpart of the KMIP environment. KMIP, or the Key Management Interoperability Protocol, is an OASIS standard of communication between applications that need to use or manage cryptographic keys over the network. A typical example of a KMIP client is an application that needs to access a remotely stored cryptographic key (shared by a KMIP server) - for example, to solicit a digital signature or decrypt an encrypted document.

Capabilities

KMIPClient supports the majority of the features defined by the KMIP specification, both on the key management and cryptographic operations fronts. While the KMIP version implemented in KMIPClient is 1.3, the KMIP approach to version sequencing allows KMIPClient to communicate equally efficiently with implementations supporting earlier and newer protocol versions. All the three encoding types (TTLV, JSON, and XML) are supported, which can be used over TCP, TLS, or HTTP(S) transports.

Working with KMIPClient

Setting up the component

KMIP servers can come in a variety of configurations, many of which cannot be detected or applied automatically. That's why the first stage is about configuring the component in such way that it knows how to talk to a specific server that you need to work with. Below are the key settings that you need to tune up. You can get most or all of this information from the administrator of the KMIP server:

Network access parameters

This is the network address and port that the KMIP server is listening on - for example, 10.0.1.110:5696 or kmip.server.com:25696.

The transport type

This could be one of TCP (unencrypted low-level connection), TLS (encrypted low-level connection), HTTP (unencrypted HTTP), HTTPS (encrypted HTTP). Transport type is not negotiable: the client must use exactly the same transport as the server expects. You specify the transport by applying the appropriate transport-specific prefix to the server address that you are passing to base_url:

kmip:// for plain TCP (e.g. kmip://10.0.1.110:5696)
kmips:// for TLS (e.g. kmips://kmip.server.com:25696)
http:// for HTTP (e.g. http://kmip.server.com:80)
https:// for HTTPS (e.g. https://10.0.1.110:5697)

KMIP servers accessible over HTTP(S) may reside either at a root (/) or a deeper-level web server endpoint (for example, /services/kmip). Append this path to the network parameters as you would normally do when working with HTTP endpoints. Having done that, combine the transport prefix, the network parameters, and the HTTP path (if used) together to obtain the value to assign to base_url:

client.BaseURL = "https://kmip.server.com:25696/services/kmip"; // TLS-secured HTTP connection to kmip.server.com running on port 25696

The encoding type

KMIP offers three encoding types: TTLV ("tag, type, length, value"), JSON, and XML. Depending on configuration and scenarios used installation may prefer one over the others. Plain TCP and TLS KMIP setups normally use TTLV encoding. The client and server must use the same encoding to understand each other.

TLS configuration

TLS-protected connections require additional setup of the TLS parameters. Those are not part of KMIP, but, rather, are intended to supply expected security configuration. The principal security setting here concerns the way the server's TLS certificate is validated. You will find more details about configuring TLS on the client side in the Validating TLS Certificates article.

Once the connection and protocol parameters are configured, you can go ahead and start making requests to the KMIP server. A KMIP server can serve requests which generally fall into one of the two categories:

Key management requests - such as importing a certificate, generating a keypair, or obtaining a list of keys stored on the server.
Cryptographic operation requests - such as signing or encrypting data.

Depending on your specific setup, the server may support a subset of operations from one or both categories.

Managing keys and certificates

The common key management operations are:

Importing a keypair or certificate to the server

Use add_key to import an asymmetric keypair or its part, or a secret symmetric key, to the KMIP server. Use add to import a certificate. Both methods return a unique object identifier that you can use to identify the object on the server.

Listing server objects

Use list to request a criteria-based list of objects from the server. The objects returned by the server will be published in the objects collection.

Reading object properties

KMIPClient offers a few methods to read object properties. You can choose the method that fits your scenario best. Use read and read_key methods to read certificates and keys directly into the certificate and key properties. You can then pass the received objects to other components that support them (such as CertificateManager). Use read_object to read the object into the objects list. Use read_attribute to read a specific attribute of an object.

Generating server-side objects

KMIP supports server-side object generation, which allows for secure cryptographic material setup. Among objects you can generate are certificates (generate) and generic keys (generate_key).

Making cryptographic calls

The common cryptographic calls are:

Signing data

Use the sign method to sign the data using a server-side private key.

Encrypting and decrypting data

Use the encrypt and decrypt methods to encrypt or decrypt data using a server-side key. This method can be used with both symmetric and asymmetric keys.

Providing data for the operations

You can provide input for the cryptographic operations in one of the following forms:

as a byte array - use input_bytes property.
as a stream - use input_stream.
in a file - use input_file.

The processed (e.g. signed) data can be retrieved from an equivalent set of output properties (output_bytes, output_stream, output_file). You can mix and match input and output data sources as you need: for example, you can provide the input in a file, but read the output as a byte array from output_bytes.

Note that the output_bytes is only populated if neither of output_file and output_stream is set.

Referencing server objects

Every object residing on a KMIP server is referenced by its unique object identifier. Your code is expected to pass the identifier of the object that you want to use or read to the relevant method, such as sign or read_object. If you do not know the identifier of the object that you need to use, use the list method to solicit the list of the server-side objects first. Locate the required object in the list and pass its unique identifier to the needed method.

Object Lifetime

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

Property List

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


auth_types	Defines allowed HTTP authentication types.
aux_result	Contains the auxiliary result of the last performed operation.
base_url	Specifies the url of the KMIP server.
blocked_cert_count	The number of records in the BlockedCert arrays.
blocked_cert_bytes	Returns the raw certificate data in DER format.
blocked_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
certificate_bytes	Returns the raw certificate data in DER format.
certificate_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
conn_info_aead_cipher	Indicates whether the encryption algorithm used is an AEAD cipher.
conn_info_chain_validation_details	The details of a certificate chain validation outcome.
conn_info_chain_validation_result	The outcome of a certificate chain validation routine.
conn_info_ciphersuite	The cipher suite employed by this connection.
conn_info_client_authenticated	Specifies whether client authentication was performed during this connection.
conn_info_client_auth_requested	Specifies whether client authentication was requested during this connection.
conn_info_connection_established	Indicates whether the connection has been established fully.
conn_info_connection_id	The unique identifier assigned to this connection.
conn_info_digest_algorithm	The digest algorithm used in a TLS-enabled connection.
conn_info_encryption_algorithm	The symmetric encryption algorithm used in a TLS-enabled connection.
conn_info_exportable	Indicates whether a TLS connection uses a reduced-strength exportable cipher.
conn_info_group	The elliptic curve used in this connection.
conn_info_id	The client connection's unique identifier.
conn_info_key_exchange_algorithm	The key exchange algorithm used in a TLS-enabled connection.
conn_info_key_exchange_key_bits	The length of the key exchange key of a TLS-enabled connection.
conn_info_pfs_cipher	Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
conn_info_pre_shared_identity	Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
conn_info_pre_shared_identity_hint	A hint professed by the server to help the client select the PSK identity to use.
conn_info_public_key_bits	The length of the public key.
conn_info_remote_address	The client's IP address.
conn_info_remote_port	The remote port of the client connection.
conn_info_resumed_session	Indicates whether a TLS-enabled connection was spawned from another TLS connection.
conn_info_secure_connection	Indicates whether TLS or SSL is enabled for this connection.
conn_info_server_authenticated	Indicates whether server authentication was performed during a TLS-enabled connection.
conn_info_signature_algorithm	The signature algorithm used in a TLS handshake.
conn_info_symmetric_block_size	The block size of the symmetric algorithm used.
conn_info_symmetric_key_bits	The key length of the symmetric algorithm used.
conn_info_total_bytes_received	The total number of bytes received over this connection.
conn_info_total_bytes_sent	The total number of bytes sent over this connection.
conn_info_validation_log	Contains the server certificate's chain validation log.
conn_info_version	Indicates the version of SSL/TLS protocol negotiated during this connection.
data_bytes	Use this property to pass the secondary input to the struct in the byte array form.
data_file	Use this property to pass the secondary input to the struct from a file.
encoding	Specifies the KMIP encoding type.
external_crypto_async_document_id	Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
external_crypto_custom_params	Custom parameters to be passed to the signing service (uninterpreted).
external_crypto_data	Additional data to be included in the async state and mirrored back by the requestor.
external_crypto_external_hash_calculation	Specifies whether the message hash is to be calculated at the external endpoint.
external_crypto_hash_algorithm	Specifies the request's signature hash algorithm.
external_crypto_key_id	The ID of the pre-shared key used for DC request authentication.
external_crypto_key_secret	The pre-shared key used for DC request authentication.
external_crypto_method	Specifies the asynchronous signing method.
external_crypto_mode	Specifies the external cryptography mode.
external_crypto_public_key_algorithm	Provide the public key algorithm here if the certificate is not available on the pre-signing stage.
fips_mode	Reserved.
input_bytes	Use this property to pass the input to struct in byte array form.
input_file	A path to the file containing the data to be passed as input to a cryptographic operation.
key_algorithm	The algorithm of the cryptographic key.
key_bits	The length of the key in bits.
key_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
key_subject	Returns the key subject.
known_cert_count	The number of records in the KnownCert arrays.
known_cert_bytes	Returns the raw certificate data in DER format.
known_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
known_crl_count	The number of records in the KnownCRL arrays.
known_crl_bytes	Returns the raw CRL data in DER format.
known_crl_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
known_ocsp_count	The number of records in the KnownOCSP arrays.
known_ocsp_bytes	A buffer containing the raw OCSP response data.
known_ocsp_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
object_count	The number of records in the Object arrays.
object_bytes	This property is an accessor to the object's binary representation (the certificate body, the key data, the data object contents).
object_extractable	Specifies the extractable attribute of the object.
object_fingerprint	Returns or sets the fingerprint attribute of the object.
object_key_algorithm	Specifies the cryptographic algorithm of the object.
object_key_bits	Returns or sets the length of the cryptographic key, in bits.
object_key_usage	Returns or sets the key usage flags of the certificate or key object.
object_group	Specifies the object group identifier.
object_id	ObjectId is a unique identifier of the object assigned by the server-side key management system.
object_type	The type of this object.
object_sensitive	Contains the Sensitive attribute of this object.
object_size	Returns the amount of memory or space that this object occupies on the server.
object_subject	Specifies the subject attribute of the object.
object_timestamp	Returns the time value associated with this object.
output_bytes	Use this property to read the output the struct object has produced.
output_file	Specifies the file where the signed, encrypted, or decrypted data should be saved.
password	Specifies a password to authenticate to the KMIP server.
proxy_address	The IP address of the proxy server.
proxy_authentication	The authentication type used by the proxy server.
proxy_password	The password to authenticate to the proxy server.
proxy_port	The port on the proxy server to connect to.
proxy_type	The type of the proxy server.
proxy_request_headers	Contains HTTP request headers for WebTunnel and HTTP proxy.
proxy_response_body	Contains the HTTP or HTTPS (WebTunnel) proxy response body.
proxy_response_headers	Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
proxy_use_ipv6	Specifies whether IPv6 should be used when connecting through the proxy.
proxy_username	Specifies the username credential for proxy authentication.
signature_validation_result	The signature validation result.
socket_dns_mode	Selects the DNS resolver to use: the struct's (secure) built-in one, or the one provided by the system.
socket_dns_port	Specifies the port number to be used for sending queries to the DNS server.
socket_dns_query_timeout	The timeout (in milliseconds) for each DNS query.
socket_dns_servers	The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
socket_dns_total_timeout	The timeout (in milliseconds) for the whole resolution process.
socket_incoming_speed_limit	The maximum number of bytes to read from the socket, per second.
socket_local_address	The local network interface to bind the socket to.
socket_local_port	The local port number to bind the socket to.
socket_outgoing_speed_limit	The maximum number of bytes to write to the socket, per second.
socket_timeout	The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
socket_use_ipv6	Enables or disables IP protocol version 6.
tls_client_cert_count	The number of records in the TLSClientCert arrays.
tls_client_cert_bytes	Returns the raw certificate data in DER format.
tls_client_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
tls_server_cert_count	The number of records in the TLSServerCert arrays.
tls_server_cert_bytes	Returns the raw certificate data in DER format.
tls_server_cert_fingerprint	Contains the fingerprint (a hash imprint) of this certificate.
tls_server_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
tls_server_cert_issuer	The common name of the certificate issuer (CA), typically a company name.
tls_server_cert_issuer_rdn	A list of Property=Value pairs that uniquely identify the certificate issuer.
tls_server_cert_key_algorithm	Specifies the public key algorithm of this certificate.
tls_server_cert_key_bits	Returns the length of the public key in bits.
tls_server_cert_key_usage	Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
tls_server_cert_self_signed	Indicates whether the certificate is self-signed (root) or signed by an external CA.
tls_server_cert_serial_number	Returns the certificate's serial number.
tls_server_cert_sig_algorithm	Indicates the algorithm that was used by the CA to sign this certificate.
tls_server_cert_subject	The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
tls_server_cert_subject_rdn	A list of Property=Value pairs that uniquely identify the certificate holder (subject).
tls_server_cert_valid_from	The time point at which the certificate becomes valid, in UTC.
tls_server_cert_valid_to	The time point at which the certificate expires, in UTC.
tls_auto_validate_certificates	Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
tls_base_configuration	Selects the base configuration for the TLS settings.
tls_ciphersuites	A list of ciphersuites separated with commas or semicolons.
tls_client_auth	Enables or disables certificate-based client authentication.
tls_extensions	Provides access to TLS extensions.
tls_force_resume_if_destination_changes	Whether to force TLS session resumption when the destination address changes.
tls_groups	Specifies a list of key exchange groups to attempt during the TLS key exchange.
tls_pre_shared_identity	Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
tls_pre_shared_key	Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
tls_pre_shared_key_ciphersuite	Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
tls_renegotiation_attack_prevention_mode	Selects the renegotiation attack prevention mechanism.
tls_revocation_check	Specifies the kind(s) of revocation check to perform.
tls_ssl_options	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.
tls_mode	Specifies the TLS mode to use.
tls_use_extended_master_secret	Enables the Extended Master Secret Extension, as defined in RFC 7627.
tls_use_session_resumption	Enables or disables the TLS session resumption capability.
tls_versions	The SSL/TLS versions to enable by default.
trusted_cert_count	The number of records in the TrustedCert arrays.
trusted_cert_bytes	Returns the raw certificate data in DER format.
trusted_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
username	The username to authenticate to the KMIP server.

Method List

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


activate	Activates the specified server object.
add	Imports a certificate to the KMIP server.
add_key	Imports a key or keypair to the KMIP server.
config	Sets or retrieves a configuration setting.
custom_request	Performs a custom request to the server.
deactivate	Deactivates the specified server object.
decrypt	Decrypts the provided data using a key stored on the KMIP server.
do_action	Performs an additional action.
encrypt	Encrypts the provided data using a key stored on the KMIP server.
generate	Generates a new certificate on the KMIP server.
generate_key	Generates a symmetric key or an asymmetric key pair on the KMIP server.
list	Retrieves the list of objects of selected types from the server.
read	Downloads a certificate from the KMIP server.
read_attribute	Requests an attribute from an object.
read_key	Downloads a key object from the KMIP server.
read_object	Requests object information from the KMIP server.
remove	Removes the specified object from the server.
reset	Resets the struct settings.
set_attribute	Sets an attribute of an existing server-side object.
set_request_bytes	Replaces the data that has been prepared for sending out.
set_response_bytes	Alters the data received from the server in a response.
sign	Signs the data using a key on the KMIP server.
verify	Verifies digitally signed data.

Event List

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


on_error	Provides information about errors during KMIP operations.
on_external_sign	Handles remote or external signing initiated by the SignExternal method or other source.
on_notification	This event notifies the application about an underlying control flow event.
on_request	KMIPClient fires this event to notify the user about the request being sent to the KMIP server.
on_response	KMIPClient uses this event to notify the user about the response being received.
on_tls_cert_needed	Fires when a remote TLS party requests a client certificate.
on_tls_cert_validate	This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
on_tls_established	Fires when a TLS handshake with Host successfully completes.
on_tls_handshake	Fires when a new TLS handshake is initiated, before the handshake commences.
on_tls_psk	Notifies the application about the PSK key exchange.
on_tls_shutdown	Reports the graceful closure of a TLS connection.

Config Settings

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


BlockSize	Block size of data for encrypting, decrypting or signing.
CachedCRLMaxAge	Specifies the maximum age of a cached CRL.
CachedCRLMaxAgeRatio	Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime.
CachedCRLOverlapTime	Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed.
CachedOCSPResponseMaxAge	Specifies the maximum age of a cached OCSP response.
CachedOCSPResponseMaxAgeRatio	Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime.
CachedOCSPResponseOverlapTime	Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed.
DeltaCRLPreference	Specifies whether complete or delta CRLs are preferred.
EvaluateSystemTrust	Enables or disables usage of the platform's built-in trust validation facilities.
IgnoreSystemTrust	Whether trusted Windows Certificate Stores should be treated as trusted.
MajorProtocolVersion	Major protocol version of the KMIP server.
MinorProtocolVersion	Minor protocol version of the KMIP server.
RevocationCacheAgePolicy	Specifies a preset policy for cached CRL and OCSP response freshness settings.
StaticDNS	Specifies whether static DNS rules should be used.
StaticIPAddress[domain]	Gets or sets an IP address for the specified domain name.
StaticIPAddresses	Gets or sets all the static DNS rules.
TempPath	Path for storing temporary files.
TLSCiphersuites	Returns the list of ciphersuites activated in the struct for the current session.
TLSExtensions	TBD.
TLSGroups	Returns the list of TLS key exchange groups enabled in the struct.
TLSPeerExtensions	TBD.
TLSSessionGroup	Specifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetime	Specifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeInterval	Specifies how often the session cache should remove the expired TLS sessions.
TLSVersions	Returns the list of TLS versions enabled in the struct.
TolerateMinorChainIssues	Whether to tolerate minor chain issues.
UseEnvStorages	Enables or disables use of the environment storages.
UseMicrosoftCTL	Enables or disables the automatic use of the Microsoft online certificate trust list.
UseSystemCertificates	Enables or disables the use of the system certificates.
ASN1UseGlobalTagCache	Controls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPins	Specifies whether CSP-level PINs should be assigned to CNG keys.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the struct.
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
DNSLocalSuffix	The suffix to assign for TLD names.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
EnableSSHMLKEM	Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server structs.
EnableTLSMLKEM	Enables support for ML-KEM and hybrid groups in TLS client and server structs.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicy	The hardware crypto usage policy.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
HttpVersion	The HTTP version to use in any inner HTTP client structs created.
IgnoreExpiredMSCTLSigningCert	Whether to tolerate the expired Windows Update signing certificate.
ListDelimiter	The delimiter character for multi-element lists.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
OldClientSideRSAFallback	Specifies whether the SSH client should use a SHA1 fallback.
PKICache	Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.
PKICachePath	Specifies the file system path where cached PKI data is stored.
ProductVersion	Returns the version of the SecureBlackbox library.
ServerSSLDHKeyLength	Sets the size of the TLS DHE key exchange group.
StaticDNS	Specifies whether static DNS rules should be used.
StaticIPAddress[domain]	Gets or sets an IP address for the specified domain name.
StaticIPAddresses	Gets or sets all the static DNS rules.
Tag	Allows to store any custom data.
TLSSessionGroup	Specifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetime	Specifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeInterval	Specifies how often the session cache should remove the expired TLS sessions.
UseCRLObjectCaching	Specifies whether reuse of loaded CRL objects is enabled.
UseInternalRandom	Switches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidation	Enables legacy AdES validation mode.
UseOCSPResponseObjectCaching	Specifies whether reuse of loaded OCSP response objects is enabled.
UseOwnDNSResolver	Specifies whether the client structs should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculation	An internal CryptoAPI access tweak.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.
XMLRDNDescriptorName[OID]	Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.
XMLRDNDescriptorPriority[OID]	Specifies the priority of descriptor names associated with a specific OID.
XMLRDNDescriptorReverseOrder	Specifies whether to reverse the order of descriptors in RDN.
XMLRDNDescriptorSeparator	Specifies the separator used between descriptors in RDN.

auth_types property (KMIPClient Struct)

Defines allowed HTTP authentication types.

Syntax

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

Default Value

Remarks

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


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

Data Type

i32

aux_result property (KMIPClient Struct)

Contains the auxiliary result of the last performed operation.

Syntax

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

Default Value

Remarks

Use this property to obtain an auxiliary result of the last performed operation. One of such results is the new Counter/Nonce value after an encryption operation.

This property is read-only.

Data Type

String

base_url property (KMIPClient Struct)

Specifies the url of the KMIP server.

Syntax

fn base_url(&self ) -> Result<String, SecureBlackboxError> 
fn set_base_url(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_base_url_ref(&self, value : &String) ->  Option<SecureBlackboxError>

Default Value

Remarks

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

The address to assign to this property needs to be in the standard URI-like notation:

protocol://username:password@address:port/path

The protocol token must be based on the transport that you want to use (which is largely defined by the server setup) and can be one of the following:

kmip:// - KMIP over TCP (unencrypted)
kmips:// - KMIP over TLS (encrypted)
http:// - KMIP over HTTP (unencrypted)
https:// - KMIP over HTTPS (encrypted)

The address and port are network credentials that the server can be accessed at, such as 192.168.5.101:5696 for a server residing in a local network, or kmip.server.com:25696 for a server residing on the Internet. The path part can be used for KMIP servers accessible via HTTP(S) endpoints.

Examples

kmip://10.25.0.61:5696
kmips://10.0.1.10:11111
kmips://kmip.server.com:11111
http://user:password123@www.server.com:3128/services/kmip
https://kmip.server.com:19991

Note that you need to take extra steps to prepare the component for secure connections when using TLS-enabled endpoints. One factor to be considered is the need to validate the server's TLS certificates. This article provides insights into the validation routine: Validating TLS Certificates.

The credentials used within the HTTP and HTTPS values are used for HTTP basic or digest authentication only. If your KMIP server expects you to use KMIP-level authentication, use username and password properties to provide your credentials.

Data Type

String

blocked_cert_count property (KMIPClient Struct)

The number of records in the BlockedCert arrays.

Syntax

fn blocked_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_blocked_cert_count(&self, value : i32) ->  Option<SecureBlackboxError>

Default Value

Remarks

This property controls the size of the following arrays:

blocked_cert_bytes
blocked_cert_handle

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

Data Type

i32

blocked_cert_bytes property (KMIPClient Struct)

Returns the raw certificate data in DER format.

Syntax

fn blocked_cert_bytes(&self , BlockedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>

Remarks

Returns the raw certificate data in DER format.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

Vec

blocked_cert_handle property (KMIPClient Struct)

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

Syntax

fn blocked_cert_handle(&self , BlockedCertIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_blocked_cert_handle(&self, BlockedCertIndex : i32, value : i64) ->  Option<SecureBlackboxError>

Default Value

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

Data Type

i64

certificate_bytes property (KMIPClient Struct)

Returns the raw certificate data in DER format.

Syntax

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

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

Vec

certificate_handle property (KMIPClient Struct)

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

Syntax

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

Default Value

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.

Data Type

i64

conn_info_aead_cipher property (KMIPClient Struct)

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

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

Default Value

false

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

This property is read-only.

Data Type

bool

conn_info_chain_validation_details property (KMIPClient Struct)

The details of a certificate chain validation outcome.

Syntax

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

Default Value

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:


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

This property is read-only.

Data Type

i32

conn_info_chain_validation_result property (KMIPClient Struct)

The outcome of a certificate chain validation routine.

Syntax

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

Possible Values

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

Default Value

Remarks

The outcome of a certificate chain validation routine.

Available options:


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

Use the ValidationLog property to access the detailed validation log.

This property is read-only.

Data Type

i32

conn_info_ciphersuite property (KMIPClient Struct)

The cipher suite employed by this connection.

Syntax

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

Default Value

Remarks

The cipher suite employed by this connection.

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

This property is read-only.

Data Type

String

conn_info_client_authenticated property (KMIPClient Struct)

Specifies whether client authentication was performed during this connection.

Syntax

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

Default Value

false

Remarks

Specifies whether client authentication was performed during this connection.

This property is read-only.

Data Type

bool

conn_info_client_auth_requested property (KMIPClient Struct)

Specifies whether client authentication was requested during this connection.

Syntax

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

Default Value

false

Remarks

Specifies whether client authentication was requested during this connection.

This property is read-only.

Data Type

bool

conn_info_connection_established property (KMIPClient Struct)

Indicates whether the connection has been established fully.

Syntax

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

Default Value

false

Remarks

Indicates whether the connection has been established fully.

This property is read-only.

Data Type

bool

conn_info_connection_id property (KMIPClient Struct)

The unique identifier assigned to this connection.

Syntax

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

Remarks

The unique identifier assigned to this connection.

This property is read-only.

Data Type

Vec

conn_info_digest_algorithm property (KMIPClient Struct)

The digest algorithm used in a TLS-enabled connection.

Syntax

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

Default Value

Remarks

The digest algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

String

conn_info_encryption_algorithm property (KMIPClient Struct)

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

Syntax

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

Default Value

Remarks

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

This property is read-only.

Data Type

String

conn_info_exportable property (KMIPClient Struct)

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

Syntax

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

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

conn_info_group property (KMIPClient Struct)

The elliptic curve used in this connection.

Syntax

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

Default Value

Remarks

The elliptic curve used in this connection.

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

This property is read-only.

Data Type

String

conn_info_id property (KMIPClient Struct)

The client connection's unique identifier.

Syntax

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

Default Value

-1

Remarks

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

This property is read-only.

Data Type

i64

conn_info_key_exchange_algorithm property (KMIPClient Struct)

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

Syntax

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

Default Value

Remarks

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

This property is read-only.

Data Type

String

conn_info_key_exchange_key_bits property (KMIPClient Struct)

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

Syntax

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

Default Value

Remarks

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

This property is read-only.

Data Type

i32

conn_info_pfs_cipher property (KMIPClient Struct)

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

Syntax

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

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

conn_info_pre_shared_identity property (KMIPClient Struct)

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

Syntax

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

Default Value

Remarks

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

This property is read-only.

Data Type

String

conn_info_pre_shared_identity_hint property (KMIPClient Struct)

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

Syntax

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

Default Value

Remarks

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

This property is read-only.

Data Type

String

conn_info_public_key_bits property (KMIPClient Struct)

The length of the public key.

Syntax

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

Default Value

Remarks

The length of the public key.

This property is read-only.

Data Type

i32

conn_info_remote_address property (KMIPClient Struct)

The client's IP address.

Syntax

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

Default Value

Remarks

The client's IP address.

This property is read-only.

Data Type

String

conn_info_remote_port property (KMIPClient Struct)

The remote port of the client connection.

Syntax

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

Default Value

Remarks

The remote port of the client connection.

This property is read-only.

Data Type

i32

conn_info_resumed_session property (KMIPClient Struct)

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

Syntax

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

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

conn_info_secure_connection property (KMIPClient Struct)

Indicates whether TLS or SSL is enabled for this connection.

Syntax

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

Default Value

false

Remarks

Indicates whether TLS or SSL is enabled for this connection.

This property is read-only.

Data Type

bool

conn_info_server_authenticated property (KMIPClient Struct)

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

Syntax

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

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

conn_info_signature_algorithm property (KMIPClient Struct)

The signature algorithm used in a TLS handshake.

Syntax

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

Default Value

Remarks

The signature algorithm used in a TLS handshake.

This property is read-only.

Data Type

String

conn_info_symmetric_block_size property (KMIPClient Struct)

The block size of the symmetric algorithm used.

Syntax

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

Default Value

Remarks

The block size of the symmetric algorithm used.

This property is read-only.

Data Type

i32

conn_info_symmetric_key_bits property (KMIPClient Struct)

The key length of the symmetric algorithm used.

Syntax

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

Default Value

Remarks

The key length of the symmetric algorithm used.

This property is read-only.

Data Type

i32

conn_info_total_bytes_received property (KMIPClient Struct)

The total number of bytes received over this connection.

Syntax

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

Default Value

Remarks

The total number of bytes received over this connection.

This property is read-only.

Data Type

i64

conn_info_total_bytes_sent property (KMIPClient Struct)

The total number of bytes sent over this connection.

Syntax

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

Default Value

Remarks

The total number of bytes sent over this connection.

This property is read-only.

Data Type

i64

conn_info_validation_log property (KMIPClient Struct)

Contains the server certificate's chain validation log.

Syntax

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

Default Value

Remarks

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

This property is read-only.

Data Type

String

conn_info_version property (KMIPClient Struct)

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

Syntax

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

Default Value

Remarks

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

This property is read-only.

Data Type

String

data_bytes property (KMIPClient Struct)

Use this property to pass the secondary input to the struct in the byte array form.

Syntax

fn data_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_data_bytes(&self, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_data_bytes_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError>

Remarks

Some cryptographic operations require more than one inputs. One example is the verify operation, which expects you to provide the signature and the data being authenticated as separate data pieces. This property lets you provide that secondary data piece (the data being authenticated). The primary data piece (the signature in this case) should be provided via one of the Input* properties, such as input_bytes.

This property is one of three ways in which you can provide the data to the component. The other two are data_file and data_stream. Choose the data source type that fits your circumstances best.

Data Type

Vec

data_file property (KMIPClient Struct)

Use this property to pass the secondary input to the struct from a file.

Syntax

fn data_file(&self ) -> Result<String, SecureBlackboxError> 
fn set_data_file(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_data_file_ref(&self, value : &String) ->  Option<SecureBlackboxError>

Default Value

Remarks

This property is one of three ways in which you can provide the data to the component. The other two are data_bytes and data_stream. Choose the data source type that fits your circumstances best.

Data Type

String

encoding property (KMIPClient Struct)

Specifies the KMIP encoding type.

Syntax

fn encoding(&self ) -> Result<i32, SecureBlackboxError> 
fn set_encoding(&self, value : i32) ->  Option<SecureBlackboxError>

Possible Values

0   // TTLV
1   // XML
2   // JSON

Default Value

Remarks

Use this property to specify the KMIP message encoding to be used in the communications with the server.

The following encodings are available:


etTTLV	`0`
etXML	`1`
etJSON	`2`

You need to know the right encoding for your KMIP server before accessing it. This is something you can get from the administrator of the server. KMIP servers accessible via plain TCP or TLS transports typically use the TTLV encoding.

Data Type

i32

external_crypto_async_document_id property (KMIPClient Struct)

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

Syntax

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

Default Value

Remarks

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

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

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

Data Type

String

external_crypto_custom_params property (KMIPClient Struct)

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

Syntax

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

Default Value

Remarks

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

Data Type

String

external_crypto_data property (KMIPClient Struct)

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

Syntax

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

Default Value

Remarks

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

Data Type

String

external_crypto_external_hash_calculation property (KMIPClient Struct)

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

Syntax

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

Default Value

false

Remarks

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

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

Data Type

bool

external_crypto_hash_algorithm property (KMIPClient Struct)

Specifies the request's signature hash algorithm.

Syntax

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

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

Data Type

String

external_crypto_key_id property (KMIPClient Struct)

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

Syntax

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

Default Value

Remarks

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

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

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

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

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

Data Type

String

external_crypto_key_secret property (KMIPClient Struct)

The pre-shared key used for DC request authentication.

Syntax

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

Default Value

Remarks

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

Read more about configuring authentication in the external_crypto_key_id topic.

Data Type

String

external_crypto_method property (KMIPClient Struct)

Specifies the asynchronous signing method.

Syntax

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

Possible Values

0   // PKCS1
1   // PKCS7

Default Value

Remarks

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

Available options:


asmdPKCS1	`0`
asmdPKCS7	`1`

Data Type

i32

external_crypto_mode property (KMIPClient Struct)

Specifies the external cryptography mode.

Syntax

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

Possible Values

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

Default Value

Remarks

Specifies the external cryptography mode.

Available options:


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

Data Type

i32

external_crypto_public_key_algorithm property (KMIPClient Struct)

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

Syntax

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

Default Value

Remarks

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


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

Data Type

String

fips_mode property (KMIPClient Struct)

Reserved.

Syntax

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

Default Value

false

Remarks

This property is reserved for future use.

Data Type

bool

input_bytes property (KMIPClient Struct)

Use this property to pass the input to struct in byte array form.

Syntax

fn input_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_input_bytes(&self, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_input_bytes_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError>

Remarks

Assign a byte array containing the data to be processed to this property.

Data Type

Vec

input_file property (KMIPClient Struct)

A path to the file containing the data to be passed as input to a cryptographic operation.

Syntax

fn input_file(&self ) -> Result<String, SecureBlackboxError> 
fn set_input_file(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_input_file_ref(&self, value : &String) ->  Option<SecureBlackboxError>

Default Value

Remarks

Provide the full path to the file containing data to be signed, verified, encrypted or decrypted.

This property is one of the three ways that you can provide the input data to KMIPClient, with input_bytes and input_stream being the other two.

Data Type

String

key_algorithm property (KMIPClient Struct)

The algorithm of the cryptographic key.

Syntax

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

Default Value

Remarks

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


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


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

Data Type

String

key_bits property (KMIPClient Struct)

The length of the key in bits.

Syntax

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

Default Value

Remarks

The length of the key in bits.

This property is read-only.

Data Type

i32

key_handle property (KMIPClient Struct)

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

Syntax

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

Default Value

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.

Data Type

i64

key_subject property (KMIPClient Struct)

Returns the key subject.

Syntax

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

Remarks

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

Data Type

Vec

known_cert_count property (KMIPClient Struct)

The number of records in the KnownCert arrays.

Syntax

fn known_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_known_cert_count(&self, value : i32) ->  Option<SecureBlackboxError>

Default Value

Remarks

This property controls the size of the following arrays:

known_cert_bytes
known_cert_handle

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

Data Type

i32

known_cert_bytes property (KMIPClient Struct)

Returns the raw certificate data in DER format.

Syntax

fn known_cert_bytes(&self , KnownCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>

Remarks

Returns the raw certificate data in DER format.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

Vec

known_cert_handle property (KMIPClient Struct)

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

Syntax

fn known_cert_handle(&self , KnownCertIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_known_cert_handle(&self, KnownCertIndex : i32, value : i64) ->  Option<SecureBlackboxError>

Default Value

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.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

Data Type

i64

known_crl_count property (KMIPClient Struct)

The number of records in the KnownCRL arrays.

Syntax

fn known_crl_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_known_crl_count(&self, value : i32) ->  Option<SecureBlackboxError>

Default Value

Remarks

This property controls the size of the following arrays:

known_crl_bytes
known_crl_handle

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

Data Type

i32

known_crl_bytes property (KMIPClient Struct)

Returns the raw CRL data in DER format.

Syntax

fn known_crl_bytes(&self , KnownCRLIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>

Remarks

Returns the raw CRL data in DER format.

The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.

This property is read-only.

Data Type

Vec

known_crl_handle property (KMIPClient Struct)

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

Syntax

fn known_crl_handle(&self , KnownCRLIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_known_crl_handle(&self, KnownCRLIndex : i32, value : i64) ->  Option<SecureBlackboxError>

Default Value

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.

The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.

Data Type

i64

known_ocsp_count property (KMIPClient Struct)

The number of records in the KnownOCSP arrays.

Syntax

fn known_ocsp_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_known_ocsp_count(&self, value : i32) ->  Option<SecureBlackboxError>

Default Value

Remarks

This property controls the size of the following arrays:

known_ocsp_bytes
known_ocsp_handle

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

Data Type

i32

known_ocsp_bytes property (KMIPClient Struct)

A buffer containing the raw OCSP response data.

Syntax

fn known_ocsp_bytes(&self , KnownOCSPIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>

Remarks

A buffer containing the raw OCSP response data.

The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.

This property is read-only.

Data Type

Vec

known_ocsp_handle property (KMIPClient Struct)

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

Syntax

fn known_ocsp_handle(&self , KnownOCSPIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_known_ocsp_handle(&self, KnownOCSPIndex : i32, value : i64) ->  Option<SecureBlackboxError>

Default Value

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.

The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.

Data Type

i64

object_count property (KMIPClient Struct)

The number of records in the Object arrays.

Syntax

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

Default Value

Remarks

This property controls the size of the following arrays:

object_bytes
object_extractable
object_fingerprint
object_group
object_id
object_key_algorithm
object_key_bits
object_key_usage
object_sensitive
object_size
object_subject
object_timestamp
object_type

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

This property is read-only.

Data Type

i32

object_bytes property (KMIPClient Struct)

This property is an accessor to the object's binary representation (the certificate body, the key data, the data object contents).

Syntax

fn object_bytes(&self , ObjectIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>

Remarks

This property is an accessor to the object's binary representation (the certificate body, the key data, the data object contents).

Use this setting to access the object data after reading it from the server or set it before committing the object to the server.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only.

Data Type

Vec

object_extractable property (KMIPClient Struct)

Specifies the extractable attribute of the object.

Syntax

fn object_extractable(&self , ObjectIndex : i32) -> Result<bool, SecureBlackboxError>

Default Value

false

Remarks

Specifies the extractable attribute of the object.

Check this property after retrieving an object from the server or before committing an object to the server.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only.

Data Type

bool

object_fingerprint property (KMIPClient Struct)

Returns or sets the fingerprint attribute of the object.

Syntax

fn object_fingerprint(&self , ObjectIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>

Remarks

Returns or sets the fingerprint attribute of the object.

Check this property after retrieving an object from the KMIP server or before sending it to the server.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only.

Data Type

Vec

object_key_algorithm property (KMIPClient Struct)

Specifies the cryptographic algorithm of the object.

Syntax

fn object_key_algorithm(&self , ObjectIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

Remarks

Specifies the cryptographic algorithm of the object.

Check or set the algorithm after receiving the object from the server or before uploading it.

The following algorithms are supported: RSA, DSA, EC, ECDSA, DH, ECDH, DES, 3DES, AES, RC2, RC4, Idea, Blowfish, Camellia, Twofish. Note that only key objects support this attribute.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only.

Data Type

String

object_key_bits property (KMIPClient Struct)

Returns or sets the length of the cryptographic key, in bits.

Syntax

fn object_key_bits(&self , ObjectIndex : i32) -> Result<i32, SecureBlackboxError>

Default Value

Remarks

Returns or sets the length of the cryptographic key, in bits.

Please note that not all types of objects support this attribute.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only.

Data Type

i32

object_key_usage property (KMIPClient Struct)

Returns or sets the key usage flags of the certificate or key object.

Syntax

fn object_key_usage(&self , ObjectIndex : i32) -> Result<i32, SecureBlackboxError>

Default Value

Remarks

Returns or sets the key usage flags of the certificate or key object. Please note only certain objects support this attribute.

Key usage flags


kuSign	`0x00001`	The object can be used for signing
kuVerify	`0x00002`	The object can be used for verifying signatures
kuEncrypt	`0x00004`	The object has an encryption capability
kuDecrypt	`0x00008`	The object has a decryption capability
kuWrapKey	`0x00010`	The object supports key wrapping
kuUnwrapKey	`0x00020`	The object supports key unwrapping
kuExport	`0x00040`	The object supports exports
kuMacGenerate	`0x00080`	The object can be used for generating MAC imprints
kuMacVerify	`0x00100`	The object can be used for verifying MAC imprints
kuDeriveKey	`0x00200`	The object supports key derivation
kuContentCommitment	`0x00400`	The object has content commitment capability
kuKeyAgreement	`0x00800`	The object can be used for key agreement
kuCertificateSign	`0x01000`	The object can be used for signing certificates
kuCrlSign	`0x02000`	The object can be used for signing CRLs
kuGenerateCryptogram	`0x04000`	The object can be used for generating cryptograms
kuValidateCryptogram	`0x08000`	The object can be used for validation of cryptograms
kuTranslateEncrypt	`0x10000`	The object supports encryption key translation
kuTranslateDecrypt	`0x20000`	The object supports decryption key translation
kuTranslateWrap	`0x40000`	The object supports wrapping key translation
kuTranslateUnwrap	`0x80000`	The object supports unwrapping key translation

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only.

Data Type

i32

object_group property (KMIPClient Struct)

Specifies the object group identifier.

Syntax

fn object_group(&self , ObjectIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

Remarks

Specifies the object group identifier. Object groups are used to match related objects, such as certificates and their public and private key, to each other.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only.

Data Type

String

object_id property (KMIPClient Struct)

ObjectId is a unique identifier of the object assigned by the server-side key management system.

Syntax

fn object_id(&self , ObjectIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

Remarks

ObjectId is a unique identifier of the object assigned by the server-side key management system.

KMIP objects are addressed and accessed by their IDs. The identifier is required to be unique within the specific server.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only.

Data Type

String

object_type property (KMIPClient Struct)

The type of this object.

Syntax

fn object_type(&self , ObjectIndex : i32) -> Result<i32, SecureBlackboxError>

Possible Values

0   // Unknown
1   // Certificate
2   // SymmetricKey
4   // PublicKey
8   // PrivateKey

Default Value

Remarks

The type of this object.


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

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only.

Data Type

i32

object_sensitive property (KMIPClient Struct)

Contains the Sensitive attribute of this object.

Syntax

fn object_sensitive(&self , ObjectIndex : i32) -> Result<bool, SecureBlackboxError>

Default Value

false

Remarks

Contains the Sensitive attribute of this object.

Check or set this property to learn or apply the value to the Sensitive attribute.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only.

Data Type

bool

object_size property (KMIPClient Struct)

Returns the amount of memory or space that this object occupies on the server.

Syntax

fn object_size(&self , ObjectIndex : i32) -> Result<i32, SecureBlackboxError>

Default Value

Remarks

Returns the amount of memory or space that this object occupies on the server.

Check this property to find out the amount of bytes this object consumes.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only.

Data Type

i32

object_subject property (KMIPClient Struct)

Specifies the subject attribute of the object.

Syntax

fn object_subject(&self , ObjectIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

Remarks

Specifies the subject attribute of the object.

Use this object to get or set the subject (owner) attribute of a KMIP object.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only.

Data Type

String

object_timestamp property (KMIPClient Struct)

Returns the time value associated with this object.

Syntax

fn object_timestamp(&self , ObjectIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

Remarks

Returns the time value associated with this object.

Use this setting to learn the time value associated with this object.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only.

Data Type

String

output_bytes property (KMIPClient Struct)

Use this property to read the output the struct object has produced.

Syntax

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

Remarks

Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the output_file and output_stream properties had not been assigned.

This property is read-only.

Data Type

Vec

output_file property (KMIPClient Struct)

Specifies the file where the signed, encrypted, or decrypted data should be saved.

Syntax

fn output_file(&self ) -> Result<String, SecureBlackboxError> 
fn set_output_file(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_output_file_ref(&self, value : &String) ->  Option<SecureBlackboxError>

Default Value

Remarks

Provide a full path to the file where the signed, encrypted, or decrypted data should be saved.

This property is one of the three ways that you can receive the output data from KMIPClient, with output_bytes and output_stream being the other two.

Data Type

String

password property (KMIPClient Struct)

Specifies a password to authenticate to the KMIP server.

Syntax

fn password(&self ) -> Result<String, SecureBlackboxError> 
fn set_password(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_password_ref(&self, value : &String) ->  Option<SecureBlackboxError>

Default Value

Remarks

Use this property to provide a password for authentication on the KMIP server.

The value assigned to this property is used for built-in user authentication provided by KMIP. If the KMIP server you are connecting to expects you to use HTTP basic or digest authentication, provide the credentials via the base_url property.

Data Type

String

proxy_address property (KMIPClient Struct)

The IP address of the proxy server.

Syntax

fn proxy_address(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_address(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_address_ref(&self, value : &String) ->  Option<SecureBlackboxError>

Default Value

Remarks

The IP address of the proxy server.

Data Type

String

proxy_authentication property (KMIPClient Struct)

The authentication type used by the proxy server.

Syntax

fn proxy_authentication(&self ) -> Result<i32, SecureBlackboxError> 
fn set_proxy_authentication(&self, value : i32) ->  Option<SecureBlackboxError>

Possible Values

0   // NoAuthentication
1   // Basic
2   // Digest
3   // NTLM

Default Value

Remarks

The authentication type used by the proxy server.


patNoAuthentication	`0`
patBasic	`1`
patDigest	`2`
patNTLM	`3`

Data Type

i32

proxy_password property (KMIPClient Struct)

The password to authenticate to the proxy server.

Syntax

fn proxy_password(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_password(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_password_ref(&self, value : &String) ->  Option<SecureBlackboxError>

Default Value

Remarks

The password to authenticate to the proxy server.

Data Type

String

proxy_port property (KMIPClient Struct)

The port on the proxy server to connect to.

Syntax

fn proxy_port(&self ) -> Result<i32, SecureBlackboxError> 
fn set_proxy_port(&self, value : i32) ->  Option<SecureBlackboxError>

Default Value

Remarks

The port on the proxy server to connect to.

Data Type

i32

proxy_type property (KMIPClient Struct)

The type of the proxy server.

Syntax

fn proxy_type(&self ) -> Result<i32, SecureBlackboxError> 
fn set_proxy_type(&self, value : i32) ->  Option<SecureBlackboxError>

Possible Values

0   // None
1   // Socks4
2   // Socks5
3   // WebTunnel
4   // HTTP

Default Value

Remarks

The type of the proxy server.


cptNone	`0`
cptSocks4	`1`
cptSocks5	`2`
cptWebTunnel	`3`
cptHTTP	`4`

Data Type

i32

proxy_request_headers property (KMIPClient Struct)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

fn proxy_request_headers(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_request_headers(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_request_headers_ref(&self, value : &String) ->  Option<SecureBlackboxError>

Default Value

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

proxy_response_body property (KMIPClient Struct)

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Syntax

fn proxy_response_body(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_response_body(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_response_body_ref(&self, value : &String) ->  Option<SecureBlackboxError>

Default Value

Remarks

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Data Type

String

proxy_response_headers property (KMIPClient Struct)

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Syntax

fn proxy_response_headers(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_response_headers(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_response_headers_ref(&self, value : &String) ->  Option<SecureBlackboxError>

Default Value

Remarks

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Data Type

String

proxy_use_ipv6 property (KMIPClient Struct)

Specifies whether IPv6 should be used when connecting through the proxy.

Syntax

fn proxy_use_ipv6(&self ) -> Result<bool, SecureBlackboxError> 
fn set_proxy_use_ipv6(&self, value : bool) ->  Option<SecureBlackboxError>

Default Value

false

Remarks

Specifies whether IPv6 should be used when connecting through the proxy.

Data Type

bool

proxy_username property (KMIPClient Struct)

Specifies the username credential for proxy authentication.

Syntax

fn proxy_username(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_username(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_username_ref(&self, value : &String) ->  Option<SecureBlackboxError>

Default Value

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

signature_validation_result property (KMIPClient Struct)

The signature validation result.

Syntax

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

Possible Values

0   // Valid
1   // Unknown
2   // Corrupted
3   // SignerNotFound
4   // Failure
5   // ReferenceCorrupted

Default Value

Remarks

Use this property to check the result of the most recent signature validation.


svtValid	`0`	The signature is valid
svtUnknown	`1`	Signature validity is unknown
svtCorrupted	`2`	The signature is corrupted
svtSignerNotFound	`3`	Failed to acquire the signing certificate. The signature cannot be validated.
svtFailure	`4`	General failure
svtReferenceCorrupted	`5`	Reference corrupted (XML-based signatures only)

This property is read-only.

Data Type

i32

socket_dns_mode property (KMIPClient Struct)

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

Syntax

fn socket_dns_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_mode(&self, value : i32) ->  Option<SecureBlackboxError>

Possible Values

0   // Auto
1   // Platform
2   // Own
3   // OwnSecure

Default Value

Remarks

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


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

Data Type

i32

socket_dns_port property (KMIPClient Struct)

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

Syntax

fn socket_dns_port(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_port(&self, value : i32) ->  Option<SecureBlackboxError>

Default Value

Remarks

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

Data Type

i32

socket_dns_query_timeout property (KMIPClient Struct)

The timeout (in milliseconds) for each DNS query.

Syntax

fn socket_dns_query_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_query_timeout(&self, value : i32) ->  Option<SecureBlackboxError>

Default Value

Remarks

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

Data Type

i32

socket_dns_servers property (KMIPClient Struct)

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

Syntax

fn socket_dns_servers(&self ) -> Result<String, SecureBlackboxError> 
fn set_socket_dns_servers(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_socket_dns_servers_ref(&self, value : &String) ->  Option<SecureBlackboxError>

Default Value

Remarks

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

Data Type

String

socket_dns_total_timeout property (KMIPClient Struct)

The timeout (in milliseconds) for the whole resolution process.

Syntax

fn socket_dns_total_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_total_timeout(&self, value : i32) ->  Option<SecureBlackboxError>

Default Value

Remarks

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

Data Type

i32

socket_incoming_speed_limit property (KMIPClient Struct)

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

Syntax

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

Default Value

Remarks

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

Data Type

i32

socket_local_address property (KMIPClient Struct)

The local network interface to bind the socket to.

Syntax

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

Default Value

Remarks

The local network interface to bind the socket to.

Data Type

String

socket_local_port property (KMIPClient Struct)

The local port number to bind the socket to.

Syntax

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

Default Value

Remarks

The local port number to bind the socket to.

Data Type

i32

socket_outgoing_speed_limit property (KMIPClient Struct)

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

Syntax

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

Default Value

Remarks

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

Data Type

i32

socket_timeout property (KMIPClient Struct)

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

Syntax

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

Default Value

60000

Remarks

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

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

Data Type

i32

socket_use_ipv6 property (KMIPClient Struct)

Enables or disables IP protocol version 6.

Syntax

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

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

bool

tls_client_cert_count property (KMIPClient Struct)

The number of records in the TLSClientCert arrays.

Syntax

fn tls_client_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_client_cert_count(&self, value : i32) ->  Option<SecureBlackboxError>

Default Value

Remarks

This property controls the size of the following arrays:

tls_client_cert_bytes
tls_client_cert_handle

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

Data Type

i32

tls_client_cert_bytes property (KMIPClient Struct)

Returns the raw certificate data in DER format.

Syntax

fn tls_client_cert_bytes(&self , TLSClientCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>

Remarks

Returns the raw certificate data in DER format.

The TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.

This property is read-only.

Data Type

Vec

tls_client_cert_handle property (KMIPClient Struct)

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

Syntax

fn tls_client_cert_handle(&self , TLSClientCertIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_tls_client_cert_handle(&self, TLSClientCertIndex : i32, value : i64) ->  Option<SecureBlackboxError>

Default Value

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.

The TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.

Data Type

i64

tls_server_cert_count property (KMIPClient Struct)

The number of records in the TLSServerCert arrays.

Syntax

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

Default Value

Remarks

This property controls the size of the following arrays:

tls_server_cert_bytes
tls_server_cert_fingerprint
tls_server_cert_handle
tls_server_cert_issuer
tls_server_cert_issuer_rdn
tls_server_cert_key_algorithm
tls_server_cert_key_bits
tls_server_cert_key_usage
tls_server_cert_self_signed
tls_server_cert_serial_number
tls_server_cert_sig_algorithm
tls_server_cert_subject
tls_server_cert_subject_rdn
tls_server_cert_valid_from
tls_server_cert_valid_to

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

This property is read-only.

Data Type

i32

tls_server_cert_bytes property (KMIPClient Struct)

Returns the raw certificate data in DER format.

Syntax

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

Remarks

Returns the raw certificate data in DER format.

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

This property is read-only.

Data Type

Vec

tls_server_cert_fingerprint property (KMIPClient Struct)

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

Syntax

fn tls_server_cert_fingerprint(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

Remarks

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

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

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

This property is read-only.

Data Type

String

tls_server_cert_handle property (KMIPClient Struct)

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

Syntax

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

Default Value

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.

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

This property is read-only.

Data Type

i64

tls_server_cert_issuer property (KMIPClient Struct)

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

Syntax

fn tls_server_cert_issuer(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

Remarks

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

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

This property is read-only.

Data Type

String

tls_server_cert_issuer_rdn property (KMIPClient Struct)

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

Syntax

fn tls_server_cert_issuer_rdn(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

Remarks

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

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

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

This property is read-only.

Data Type

String

tls_server_cert_key_algorithm property (KMIPClient Struct)

Specifies the public key algorithm of this certificate.

Syntax

fn tls_server_cert_key_algorithm(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.


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

Use the tls_key_bits, tls_curve, and tls_public_key_bytes properties to get more details about the key the certificate contains.

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

This property is read-only.

Data Type

String

tls_server_cert_key_bits property (KMIPClient Struct)

Returns the length of the public key in bits.

Syntax

fn tls_server_cert_key_bits(&self , TLSServerCertIndex : i32) -> Result<i32, SecureBlackboxError>

Default Value

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 tls_public_key_bytes or tls_private_key_bytes property would typically contain auxiliary values, and therefore be longer.

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

This property is read-only.

Data Type

i32

tls_server_cert_key_usage property (KMIPClient Struct)

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

Syntax

fn tls_server_cert_key_usage(&self , TLSServerCertIndex : i32) -> Result<i32, SecureBlackboxError>

Default Value

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:


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

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

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

This property is read-only.

Data Type

i32

tls_server_cert_self_signed property (KMIPClient Struct)

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

Syntax

fn tls_server_cert_self_signed(&self , TLSServerCertIndex : i32) -> Result<bool, SecureBlackboxError>

Default Value

false

Remarks

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

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

This property is read-only.

Data Type

bool

tls_server_cert_serial_number property (KMIPClient Struct)

Returns the certificate's serial number.

Syntax

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

Remarks

Returns the certificate's serial number.

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

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

This property is read-only.

Data Type

Vec

tls_server_cert_sig_algorithm property (KMIPClient Struct)

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

Syntax

fn tls_server_cert_sig_algorithm(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

Remarks

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

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

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

This property is read-only.

Data Type

String

tls_server_cert_subject property (KMIPClient Struct)

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

Syntax

fn tls_server_cert_subject(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

Remarks

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

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

This property is read-only.

Data Type

String

tls_server_cert_subject_rdn property (KMIPClient Struct)

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

Syntax

fn tls_server_cert_subject_rdn(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

Remarks

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

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

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

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

This property is read-only.

Data Type

String

tls_server_cert_valid_from property (KMIPClient Struct)

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

Syntax

fn tls_server_cert_valid_from(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

Remarks

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

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

This property is read-only.

Data Type

String

tls_server_cert_valid_to property (KMIPClient Struct)

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

Syntax

fn tls_server_cert_valid_to(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

Remarks

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

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

This property is read-only.

Data Type

String

tls_auto_validate_certificates property (KMIPClient Struct)

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

Syntax

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

Default Value

true

Remarks

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

Data Type

bool

tls_base_configuration property (KMIPClient Struct)

Selects the base configuration for the TLS settings.

Syntax

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

Possible Values

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

Default Value

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.


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

Data Type

i32

tls_ciphersuites property (KMIPClient Struct)

A list of ciphersuites separated with commas or semicolons.

Syntax

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

Default Value

Remarks

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

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

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

Data Type

String

tls_client_auth property (KMIPClient Struct)

Enables or disables certificate-based client authentication.

Syntax

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

Possible Values

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

Default Value

Remarks

Enables or disables certificate-based client authentication.

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


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

Data Type

i32

tls_extensions property (KMIPClient Struct)

Provides access to TLS extensions.

Syntax

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

Default Value

Remarks

Provides access to TLS extensions.

Data Type

String

tls_force_resume_if_destination_changes property (KMIPClient Struct)

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

Syntax

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

Default Value

false

Remarks

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

Data Type

bool

tls_groups property (KMIPClient Struct)

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

Syntax

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

Default Value

Remarks

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

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

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

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

Elliptic curve-based groups:

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

Finite field-based groups:

FFDHE2048
FFDHE3072
FFDHE4096
FFDHE6144
FFDHE8192

Post-Quantum and Hybrid groups:

MLKEM512
MLKEM768
MLKEM1024
SECP256R1MLKEM768
X25519MLKEM768
SECP384R1MLKEM1024

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

Data Type

String

tls_pre_shared_identity property (KMIPClient Struct)

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

Syntax

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

Default Value

Remarks

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

Data Type

String

tls_pre_shared_key property (KMIPClient Struct)

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

Syntax

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

Default Value

Remarks

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

Data Type

String

tls_pre_shared_key_ciphersuite property (KMIPClient Struct)

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

Syntax

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

Default Value

Remarks

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

Data Type

String

tls_renegotiation_attack_prevention_mode property (KMIPClient Struct)

Selects the renegotiation attack prevention mechanism.

Syntax

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

Possible Values

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

Default Value

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:


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

Data Type

i32

tls_revocation_check property (KMIPClient Struct)

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

Syntax

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

Possible Values

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

Default Value

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.


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

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

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

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

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

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

Data Type

i32

tls_ssl_options property (KMIPClient Struct)

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

Syntax

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

Default Value

Remarks

Various SSL (TLS) protocol options, set of


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

Data Type

i32

tls_mode property (KMIPClient Struct)

Specifies the TLS mode to use.

Syntax

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

Possible Values

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

Default Value

Remarks

Specifies the TLS mode to use.


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

Data Type

i32

tls_use_extended_master_secret property (KMIPClient Struct)

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

Syntax

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

Default Value

true

Remarks

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

Data Type

bool

tls_use_session_resumption property (KMIPClient Struct)

Enables or disables the TLS session resumption capability.

Syntax

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

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

bool

tls_versions property (KMIPClient Struct)

The SSL/TLS versions to enable by default.

Syntax

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

Default Value

Remarks

The SSL/TLS versions to enable by default.


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

Data Type

i32

trusted_cert_count property (KMIPClient Struct)

The number of records in the TrustedCert arrays.

Syntax

fn trusted_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_trusted_cert_count(&self, value : i32) ->  Option<SecureBlackboxError>

Default Value

Remarks

This property controls the size of the following arrays:

trusted_cert_bytes
trusted_cert_handle

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

Data Type

i32

trusted_cert_bytes property (KMIPClient Struct)

Returns the raw certificate data in DER format.

Syntax

fn trusted_cert_bytes(&self , TrustedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>

Remarks

Returns the raw certificate data in DER format.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

Vec

trusted_cert_handle property (KMIPClient Struct)

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

Syntax

fn trusted_cert_handle(&self , TrustedCertIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_trusted_cert_handle(&self, TrustedCertIndex : i32, value : i64) ->  Option<SecureBlackboxError>

Default Value

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.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

Data Type

i64

username property (KMIPClient Struct)

The username to authenticate to the KMIP server.

Syntax

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

Default Value

Remarks

Use this property to provide a username for authentication on the KMIP server.

Data Type

String

activate method (KMIPClient Struct)

Activates the specified server object.

Syntax

fn activate(&self, object_id : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to activate the object using its ObjectId. Activating the object makes it available for cryptographic operations.

This method is complementary to deactivate that can be used to disable server-side objects.

add method (KMIPClient Struct)

Imports a certificate to the KMIP server.

Syntax

fn add(&self, add_private_key : bool, group : &str, activate : bool) ->  Result<String, SecureBlackboxError>

Remarks

Call this method to import a certificate to the KMIP server. Provide the certificate via certificate property.

Use the Group parameter to supply a unique identifier for objects associated with this certificate. A typical KMIP server would store two or three objects per certificate - the certificate, its public key, and, if provided, its private key. The shared group identifier will make it easy to establish correspondence between the objects.

Set the AddPrivateKey parameter to true to import the private key (and create a corresponding KMIP object) together with the certificate. Use the Activate parameter to instruct the server to activate the new certificate-related objects immediately.

The method returns the unique identifier of the created certificate object. Check the AuxResult property to read the ID of the associated key object.

add_key method (KMIPClient Struct)

Imports a key or keypair to the KMIP server.

Syntax

fn add_key(&self, group : &str, activate : bool) ->  Result<String, SecureBlackboxError>

Remarks

Use this method to import a key or an asymmetric keypair to the KMIP server. Provide the key via the key property.

Use the Group parameter to supply a unique identifier for objects associated with this key. Import of an asymmetric keypair may result in two objects being created on the server - the public key and the private key. The shared group identifier will make it easy to establish correspondence between the objects.

Use the Activate parameter to instruct the server to activate the new key objects immediately.

The method returns the unique identifier of the created key object. Check the AuxResult property to read the ID of the second object key component object, if expected.

config method (KMIPClient Struct)

Sets or retrieves a configuration setting.

Syntax

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

Remarks

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

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

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

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

custom_request method (KMIPClient Struct)

Performs a custom request to the server.

Syntax

fn custom_request(&self, data : &[u8]) ->  Result<Vec<u8>, SecureBlackboxError>

Remarks

Use this method to send a custom request to the KMIP server. Pass the serialized KMIP request data to the Data parameter. Any response returned back by the server is passed back to the application via the result of this method.

This method can be handy if you need to make a request of the kind that KMIPClient does not support at the moment.

deactivate method (KMIPClient Struct)

Deactivates the specified server object.

Syntax

fn deactivate(&self, object_id : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to deactivate the object using its ObjectId. Deactivated objects remain on the server but cannot be used for cryptographic operations. Use remove method to delete objects from the server permanently.

This method is complementary to activate that lets you enable ('activate') server objects.

decrypt method (KMIPClient Struct)

Decrypts the provided data using a key stored on the KMIP server.

Syntax

fn decrypt(&self, object_id : &str, algorithm : &str, iv : &[u8], block_mode : &str, padding_method : &str, tag_length : i32) -> Result<(), SecureBlackboxError>

Remarks

Use this method to decrypt data using the key with the specified ObjectId.

Provide the encrypted data via one of the Input* properties (input_file, input_stream, or input_bytes). The decrypted data will be saved to one of the output properties.

Use the Algorithm, IV, BlockMode, PaddingMethod, and TagLength parameters to provide adjustments to the decryption algorithm. Not every call will require all of the adjustments. Asymmetric decryption calls (such as RSA) do not typically require parameters.

do_action method (KMIPClient Struct)

Performs an additional action.

Syntax

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

Remarks

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

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

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

Common ActionIDs:


Action	Parameters	Returned value	Description
ResetTrustedListCache	none	none	Clears the cached list of trusted lists.
ResetCertificateCache	none	none	Clears the cached certificates.
ResetCRLCache	none	none	Clears the cached CRLs.
ResetOCSPResponseCache	none	none	Clears the cached OCSP responses.

encrypt method (KMIPClient Struct)

Encrypts the provided data using a key stored on the KMIP server.

Syntax

fn encrypt(&self, object_id : &str, algorithm : &str, iv : &[u8], block_mode : &str, padding_method : &str, tag_length : i32) -> Result<(), SecureBlackboxError>

Remarks

Use this method to encrypt data using the key with the specified ObjectId. Provide the data to be encrypted via input_file or input_stream. The encrypted data will be saved to output_file (or output_stream).

Use optional Algorithm, IV, BlockMode, Padding, and TagLength parameters to adjust encryption flow. The values to be passed as these parameters depend on the encryption algorithm being used. Public key algorithms typically do not require these parameters.

generate method (KMIPClient Struct)

Generates a new certificate on the KMIP server.

Syntax

fn generate(&self, public_key_id : &str, activate : bool) ->  Result<String, SecureBlackboxError>

Remarks

Use this method to generate a new certificate on the server. Set up the needed parameters of the certificate in the certificate property. This property may contain a prepared certificate request.

An optional PublicKeyId parameter specifies the ID of the server-side public key object to base the certificate on.

The method returns a unique ID assigned to the new certificate object. Note that the certificate itself is not populated in the certificate property: use read to request it from the server.

generate_key method (KMIPClient Struct)

Generates a symmetric key or an asymmetric key pair on the KMIP server.

Syntax

fn generate_key(&self, key_algorithm : &str, scheme : &str, scheme_params : &str, key_bits : i32, group : &str, activate : bool) ->  Result<String, SecureBlackboxError>

Remarks

Use KeyAlgorithm and KeyBits to indicate the desired algorithm and key length. Provide an group name of the new key via the Group parameter.

The method returns the ID assigned by the server to the new key object. This may differ from the one you supplied.

Note that the key itself is not populated in the key property: use read_key to request it from the server.

list method (KMIPClient Struct)

Retrieves the list of objects of selected types from the server.

Syntax

fn list(&self, object_types : i32, filter : &str, offset_items : i32, maximum_items : i32, fresh_only : bool) -> Result<(), SecureBlackboxError>

Remarks

ObjectTypes is expected to contain a bit mask according to which objects of one or more types can be selected. The ObjectTypes of 0 implies that there is no mask, and all objects should be returned. Possible values:


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

Use OffsetItems and MaximumItems to narrow down your search. Use Filter to specify the object properties that you would like to be requested: an empty value or an asterisk tells the client to request all the properties of the listed objects, whereas the objectid filter only results in the object IDs being returned.

read method (KMIPClient Struct)

Downloads a certificate from the KMIP server.

Syntax

fn read(&self, object_id : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to download a certificate object from the server. Specify the ID of the certificate object via the ObjectId parameter.

Upon completion, the certificate is populated in the certificate property.

read_attribute method (KMIPClient Struct)

Requests an attribute from an object.

Syntax

fn read_attribute(&self, object_id : &str, name : &str) ->  Result<String, SecureBlackboxError>

Remarks

Use this method to request an attribute defined by the Name parameter for a server-side object indicated by its ObjectId.

The list of attributes supported by KMIP is available here: KMIP v1.3, paragraph 3

read_key method (KMIPClient Struct)

Downloads a key object from the KMIP server.

Syntax

fn read_key(&self, object_id : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to retrieve a key object from the server. Public, private, and secret key IDs can be passed to this method, but only non-sensitive parameters of the private and secret keys will be returned.

The key data is populated in the key property.

read_object method (KMIPClient Struct)

Requests object information from the KMIP server.

Syntax

fn read_object(&self, object_id : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to request information about a server-side object by its unique ObjectId.

If ObjectId represents a valid certificate or key, the details of the object are populated in certificate or key object respectively.

remove method (KMIPClient Struct)

Removes the specified object from the server.

Syntax

fn remove(&self, object_id : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to delete the object specified by its ObjectId from the KMIP server permanently.

If you would like to disable the object but keep it on the server permanently, use deactivate method instead.

reset method (KMIPClient Struct)

Resets the struct settings.

Syntax

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

Remarks

reset is a generic method available in every struct.

set_attribute method (KMIPClient Struct)

Sets an attribute of an existing server-side object.

Syntax

fn set_attribute(&self, object_id : &str, name : &str, value : &str, delete : bool) -> Result<(), SecureBlackboxError>

Remarks

Use this method to set an attribute of a server-side object.

The list of attributes supported by KMIP is available here: KMIP v1.3, paragraph 3

Set Delete parameter to true to delete the attribute instead of setting it.

set_request_bytes method (KMIPClient Struct)

Replaces the data that has been prepared for sending out.

Syntax

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

Remarks

Call this method from your on_request event handler to alter the request data being sent to the server. This method method may be handy if you need to adjust the request data that the client has prepared manually before sending it out.

set_response_bytes method (KMIPClient Struct)

Alters the data received from the server in a response.

Syntax

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

Remarks

Call this method from your on_response event handler to alter the data received from the server before passing it for processing. This method may be handy if you would like to adjust data received from the server - for example, to fix an error in the server's response.

sign method (KMIPClient Struct)

Signs the data using a key on the KMIP server.

Syntax

fn sign(&self, object_id : &str, algorithm : &str, padding_method : &str, hash_algorithm : &str, input_is_hash : bool) -> Result<(), SecureBlackboxError>

Remarks

Use this method to sign the data using the key with the specified ObjectId. Pass the data to be signed via input_file (or input_stream) property. The resulting signed data will be written to output_file (or output_stream).

The Algorithm and HashAlgorithm parameters should specify the algorithms to be used for the cryptographic signing. Set InputIsHash to true to indicate that you are passing the hash of the data instead of the actual data.

If any of Algorithm or HashAlgorithm are omitted, the server will use the default algorithm associated with the key. Note that this is not always possible, so make sure your requests carry as much details as possible.

The following key algorithms are supported: RSA, EC, ECDSA, ECDH, EDDSA, DSA, ELGAMAL, DH, SRP.

The following hash algorithms are supported: SHA1, SHA256, SHA384, SHA512, SHA224, WHIRLPOOL, POLY1305, SHA3_224, SHA3_256, SHA3_384, SHA3_512. Note that servers may not support all of these algorithms.

verify method (KMIPClient Struct)

Verifies digitally signed data.

Syntax

fn verify(&self, object_id : &str, algorithm : &str, padding_method : &str, hash_algorithm : &str, input_is_hash : bool) -> Result<(), SecureBlackboxError>

Remarks

Use this method to verify the integrity of the signature using a server-side key.

Please provide the signature via input_file (or input_stream / input_bytes) property. For detached signatures, please also provide the data that was signed via data_file (or data_stream / data_bytes) property.

Provide additional parameters of the operation:

Algorithm: the signature algorithm (e.g. sha256WithRSAEncryption).
PaddingMethod: the padding method used (e.g. PSS).
HashAlgorithm: the hash algorithm to use for signature verification (e.g. SHA256).
InputIsHash: specifies whether the data provided via data_file or similar property contains the data or its message digest.

on_error event (KMIPClient Struct)

Provides information about errors during KMIP operations.

Syntax

// KMIPClientErrorEventArgs carries the KMIPClient Error event's parameters.
pub struct KMIPClientErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

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

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

Remarks

This event is fired in case of exceptional conditions occurred during KMIP operations.

ErrorCode contains an error code and Description contains a textual description of the error.

on_external_sign event (KMIPClient Struct)

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

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

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

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

Remarks

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

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

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

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

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

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

on_notification event (KMIPClient Struct)

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

Syntax

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

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

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

Remarks

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

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

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


TLSExtensions.CertificateStatus	TBD
TLSExtensions.PreSharedIdentityHint	TBD

on_request event (KMIPClient Struct)

KMIPClient fires this event to notify the user about the request being sent to the KMIP server.

Syntax

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

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

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

Remarks

Subscribe to this event to be notified about individual requests sent by the KMIP client to the server.

The RequestData parameter contains the encoded KMIP request. You can alter what is being sent by providing custom request bytes via the set_request_bytes method.

on_response event (KMIPClient Struct)

KMIPClient uses this event to notify the user about the response being received.

Syntax

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

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

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

Remarks

Subscribe to this event to be notified about KMIP protocol responses that the KMIP client receives from the server.

The ResponseData parameter contains the encoded body of the response. Use set_response_bytes to alter the response data received before it is processed by the client.

on_tls_cert_needed event (KMIPClient Struct)

Fires when a remote TLS party requests a client certificate.

Syntax

// KMIPClientTLSCertNeededEventArgs carries the KMIPClient TLSCertNeeded event's parameters.
pub struct KMIPClientTLSCertNeededEventArgs {
  fn host(&self) -> &String
  fn ca_names(&self) -> &String
}

// KMIPClientTLSCertNeededEvent defines the signature of the KMIPClient TLSCertNeeded event's handler function.
pub trait KMIPClientTLSCertNeededEvent {
  fn on_tls_cert_needed(&self, sender : KMIPClient, e : &mut KMIPClientTLSCertNeededEventArgs);
}

impl <'a> KMIPClient<'a> {
  pub fn on_tls_cert_needed(&self) -> &'a dyn KMIPClientTLSCertNeededEvent;
  pub fn set_on_tls_cert_needed(&mut self, value : &'a dyn KMIPClientTLSCertNeededEvent);
  ...
}

Remarks

This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames parameter (optional, according to the TLS spec) advises on the accepted issuing CAs.

Use the tls_client_chain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.

This event is preceded by the on_tls_handshake event for the given host and, if the certificate was accepted, succeeded by the on_tls_established event.

on_tls_cert_validate event (KMIPClient Struct)

This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

Syntax

// KMIPClientTLSCertValidateEventArgs carries the KMIPClient TLSCertValidate event's parameters.
pub struct KMIPClientTLSCertValidateEventArgs {
  fn server_host(&self) -> &String
  fn server_ip(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// KMIPClientTLSCertValidateEvent defines the signature of the KMIPClient TLSCertValidate event's handler function.
pub trait KMIPClientTLSCertValidateEvent {
  fn on_tls_cert_validate(&self, sender : KMIPClient, e : &mut KMIPClientTLSCertValidateEventArgs);
}

impl <'a> KMIPClient<'a> {
  pub fn on_tls_cert_validate(&self) -> &'a dyn KMIPClientTLSCertValidateEvent;
  pub fn set_on_tls_cert_validate(&mut self, value : &'a dyn KMIPClientTLSCertValidateEvent);
  ...
}

Remarks

This event is fired during a TLS handshake. Use the tls_server_chain property to access the certificate chain. In general, structs may contact a number of TLS endpoints during their work, depending on their configuration.

Accept is assigned in accordance with the outcome of the internal validation check performed by the struct, and can be adjusted if needed.

on_tls_established event (KMIPClient Struct)

Fires when a TLS handshake with Host successfully completes.

Syntax

// KMIPClientTLSEstablishedEventArgs carries the KMIPClient TLSEstablished event's parameters.
pub struct KMIPClientTLSEstablishedEventArgs {
  fn host(&self) -> &String
  fn version(&self) -> &String
  fn ciphersuite(&self) -> &String
  fn connection_id(&self) -> &[u8]
  fn abort(&self) -> bool
  fn set_abort(&self, value : bool)
}

// KMIPClientTLSEstablishedEvent defines the signature of the KMIPClient TLSEstablished event's handler function.
pub trait KMIPClientTLSEstablishedEvent {
  fn on_tls_established(&self, sender : KMIPClient, e : &mut KMIPClientTLSEstablishedEventArgs);
}

impl <'a> KMIPClient<'a> {
  pub fn on_tls_established(&self) -> &'a dyn KMIPClientTLSEstablishedEvent;
  pub fn set_on_tls_established(&mut self, value : &'a dyn KMIPClientTLSEstablishedEvent);
  ...
}

Remarks

The struct uses this event to notify the application about a successful completion of a TLS handshake.

The Version, Ciphersuite, and ConnectionId parameters indicate the security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.

on_tls_handshake event (KMIPClient Struct)

Fires when a new TLS handshake is initiated, before the handshake commences.

Syntax

// KMIPClientTLSHandshakeEventArgs carries the KMIPClient TLSHandshake event's parameters.
pub struct KMIPClientTLSHandshakeEventArgs {
  fn host(&self) -> &String
  fn abort(&self) -> bool
  fn set_abort(&self, value : bool)
}

// KMIPClientTLSHandshakeEvent defines the signature of the KMIPClient TLSHandshake event's handler function.
pub trait KMIPClientTLSHandshakeEvent {
  fn on_tls_handshake(&self, sender : KMIPClient, e : &mut KMIPClientTLSHandshakeEventArgs);
}

impl <'a> KMIPClient<'a> {
  pub fn on_tls_handshake(&self) -> &'a dyn KMIPClientTLSHandshakeEvent;
  pub fn set_on_tls_handshake(&mut self, value : &'a dyn KMIPClientTLSHandshakeEvent);
  ...
}

Remarks

The struct uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed by the on_tls_established event. If the server chooses to request a client certificate, the on_tls_cert_needed event will also be fired.

on_tls_psk event (KMIPClient Struct)

Notifies the application about the PSK key exchange.

Syntax

// KMIPClientTLSPSKEventArgs carries the KMIPClient TLSPSK event's parameters.
pub struct KMIPClientTLSPSKEventArgs {
  fn host(&self) -> &String
  fn hint(&self) -> &String
}

// KMIPClientTLSPSKEvent defines the signature of the KMIPClient TLSPSK event's handler function.
pub trait KMIPClientTLSPSKEvent {
  fn on_tls_psk(&self, sender : KMIPClient, e : &mut KMIPClientTLSPSKEventArgs);
}

impl <'a> KMIPClient<'a> {
  pub fn on_tls_psk(&self) -> &'a dyn KMIPClientTLSPSKEvent;
  pub fn set_on_tls_psk(&mut self, value : &'a dyn KMIPClientTLSPSKEvent);
  ...
}

Remarks

The struct fires this event to notify the application about the beginning of TLS-PSK key exchange with Host. The Hint parameter may be used by the server to identify the key or service to use. Use the PreSharedKey field of tls_settings to provide the pre-shared key to the component.

on_tls_shutdown event (KMIPClient Struct)

Reports the graceful closure of a TLS connection.

Syntax

// KMIPClientTLSShutdownEventArgs carries the KMIPClient TLSShutdown event's parameters.
pub struct KMIPClientTLSShutdownEventArgs {
  fn host(&self) -> &String
}

// KMIPClientTLSShutdownEvent defines the signature of the KMIPClient TLSShutdown event's handler function.
pub trait KMIPClientTLSShutdownEvent {
  fn on_tls_shutdown(&self, sender : KMIPClient, e : &mut KMIPClientTLSShutdownEventArgs);
}

impl <'a> KMIPClient<'a> {
  pub fn on_tls_shutdown(&self) -> &'a dyn KMIPClientTLSShutdownEvent;
  pub fn set_on_tls_shutdown(&mut self, value : &'a dyn KMIPClientTLSShutdownEvent);
  ...
}

Remarks

This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.

Config Settings (KMIPClient Struct)

The struct accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

KMIPClient Config Settings

BlockSize: Block size of data for encrypting, decrypting or signing.

Use this property to specify the Block size in bytes of data to use for send on encrypting, decrypting or signing.

CachedCRLMaxAge: Specifies the maximum age of a cached CRL.

Use this setting to specify the maximum number of seconds that may pass since a CRL was added to the global cache. When the cached CRL is older than this value, it is disregarded and a new CRL should be fetched.

The default value is 0, which disables the absolute CRL age check. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.

CachedCRLMaxAgeRatio: Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime.

Use this setting to specify the percentage of the CRL's remaining lifetime, measured from the time the CRL was added to the global cache to the CRL's NextUpdate. When this portion of the remaining lifetime has passed, the cached CRL is disregarded and a new CRL should be fetched.

The default value is 0, which disables the CRL ratio check. Values are interpreted in the 0..100 range. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.

CachedCRLOverlapTime: Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed.

Use this setting to specify the number of seconds before the NextUpdate time at which the cached CRL should be disregarded, and a new CRL should be fetched.

The default value is 0, which disables the CRL overlap check. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.

This setting is evaluated independently from CachedCRLMaxAge and CachedCRLMaxAgeRatio. If several cached CRL freshness settings are enabled, the cached CRL is used only if it satisfies all of them.

CachedOCSPResponseMaxAge: Specifies the maximum age of a cached OCSP response.

Use this setting to specify the maximum number of seconds that may pass since an OCSP response was added to the global cache. When the cached OCSP response is older than this value, it is disregarded and a new OCSP response should be fetched.

The default value is 0, which disables the absolute OCSP response age check. This setting is also used to limit open-ended OCSP responses that do not have NextUpdate. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.

CachedOCSPResponseMaxAgeRatio: Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime.

Use this setting to specify the percentage of the OCSP response's remaining lifetime, measured from the time the OCSP response was added to the global cache to the response's NextUpdate. When this portion of the remaining lifetime has passed, the cached OCSP response is disregarded and a new OCSP response should be fetched.

The default value is 0, which disables the OCSP response ratio check. Values are interpreted in the 0..100 range. Open-ended OCSP responses without NextUpdate ignore this setting; use CachedOCSPResponseMaxAge to limit their age. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.

CachedOCSPResponseOverlapTime: Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed.

Use this setting to specify the number of seconds before the NextUpdate time at which the cached OCSP response should be disregarded, and a new OCSP response should be fetched.

The default value is 0, which disables the OCSP response overlap check. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.

This setting is evaluated independently from CachedOCSPResponseMaxAge and CachedOCSPResponseMaxAgeRatio. If several cached OCSP response freshness settings are enabled, the cached OCSP response is used only if it satisfies all of them.

DeltaCRLPreference: Specifies whether complete or delta CRLs are preferred.

Use this setting to specify which CRL type should be preferred during TLS certificate revocation checks.

The default value is dcrlpPreferDelta (0).

Supported values:

dcrlpPreferDelta (0): retrieve and use delta CRLs when available, falling back to complete CRLs when needed.
dcrlpPreferComplete (1): try complete CRLs first, and use delta CRLs only if complete CRLs cannot be retrieved.

EvaluateSystemTrust: Enables or disables usage of the platform's built-in trust validation facilities.

Enable this property to delegate the chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms). This functionality is currently available on macOS and iOS systems only. This property is enabled by default.

IgnoreSystemTrust: Whether trusted Windows Certificate Stores should be treated as trusted.

Specifies whether, during chain validation, the struct should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the struct should trust the certificates residing in the Trusted Root Certification Authorities store.

If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as the trusted_certificates property) are considered trusted.

MajorProtocolVersion: Major protocol version of the KMIP server.

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

MinorProtocolVersion: Minor protocol version of the KMIP server.

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

RevocationCacheAgePolicy: Specifies a preset policy for cached CRL and OCSP response freshness settings.

Use this setting to configure all cached revocation freshness settings at once. The default value is Disabled.

Supported values are case-insensitive:


Disabled	Sets CachedCRLOverlapTime, CachedOCSPResponseOverlapTime, CachedCRLMaxAge, CachedOCSPResponseMaxAge, CachedCRLMaxAgeRatio, and CachedOCSPResponseMaxAgeRatio to 0. This value is the default. It only disables the cache-age freshness policy; it does not disable revocation checking or use of the revocation cache.
Default	Applies the component default freshness settings. For this component, Default is equivalent to Disabled.
Short	Uses crl:43200;50;300,ocsp:1800;50;300. This means: CRL maximum age 12 hours, CRL age ratio 50%, CRL overlap 5 minutes; OCSP response maximum age 30 minutes, OCSP response age ratio 50%, OCSP response overlap 5 minutes.
Long	Uses crl:518400;50;3600,ocsp:21600;50;3600. This means: CRL maximum age 6 days, CRL age ratio 50%, CRL overlap 1 hour; OCSP response maximum age 6 hours, OCSP response age ratio 50%, OCSP response overlap 1 hour.
N	Interprets N as an integer number of seconds. The overlap settings are set to N seconds, CRL maximum age is set to N * 144, OCSP response maximum age is set to N * 6, and both ratio settings are set to 50.
crl:<maxAge>;<ratio>;<overlap>,ocsp:<maxAge>;<ratio>;<overlap>	Sets the CRL and OCSP response freshness values explicitly.

Ratios must be in the 0..100 range. Maximum age and overlap values must be non-negative. Short and Long are time-scale profiles: Long allows older cached revocation information by increasing maximum ages, but also uses a larger pre-expiry safety margin by increasing overlap times. For individual CachedCRLOverlapTime, CachedOCSPResponseOverlapTime, CachedCRLMaxAge, CachedOCSPResponseMaxAge, CachedCRLMaxAgeRatio, and CachedOCSPResponseMaxAgeRatio settings, a value of 0 disables the corresponding freshness check. The individual settings remain available for advanced configuration and can be used after this setting to override specific values.

StaticDNS: Specifies whether static DNS rules should be used.

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

Supported values are:


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

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

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

StaticIPAddresses: Gets or sets all the static DNS rules.

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

TempPath: Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except PDFSigner, where this limitation does not apply.

TLSCiphersuites: Returns the list of ciphersuites activated in the component for the current session.

Check this property to enumerate the list of TLS ciphersuites enabled in the component. A good place to do that is OnTLSHandshake event handler.

TLSExtensions: TBD.

TBD

TLSGroups: Returns the list of TLS key exchange groups enabled in the component.

Check this property to enumerate the list of TLS key exchange groups enabled in the component.

TLSPeerExtensions: TBD.

TBD

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

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

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

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

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

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

TLSVersions: Returns the list of TLS versions enabled in the component.

Check this property to obtain the list of TLS versions enabled in the component, as an integer bitmask.

TolerateMinorChainIssues: Whether to tolerate minor chain issues.

This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are:

CA, revocation source, TLS key usage requirements are not mandated
Violation of OCSP issuer requirements are ignored
The AuthorityKeyID extension in CRL- and certificate-issuing CAs are ignored (helps with incorrectly renewed certificates)
Basic constraints and name constraints of CA certificates are ignored
Some weaker algorithms are tolerated

UseEnvStorages: Enables or disables use of the environment storages.

Enable this property to make the chain validation module automatically look up missing CA and intermediate certificates in the environment storages.

UseMicrosoftCTL: Enables or disables the automatic use of the Microsoft online certificate trust list.

Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository.

UseSystemCertificates: Enables or disables the use of the system certificates.

Use this property to tell the chain validation module to automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework.

Base Config Settings

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

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

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

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

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

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

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

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

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

Supported values are:


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

Cookies: Gets or sets local cookies for the struct.

Use this property to get cookies from the internal cookie storage of the struct and/or restore them back between application sessions.

DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

DNSLocalSuffix: The suffix to assign for TLD names.

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

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

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

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

EnableSSHMLKEM: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.

Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components.

EnableTLSMLKEM: Enables support for ML-KEM and hybrid groups in TLS client and server components.

Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components.

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

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

HardwareCryptoUsePolicy: The hardware crypto usage policy.

This global setting controls the hardware cryptography usage policy.

Supported Values:


auto	Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default).
enable	Always attempt to use hardware cryptography. If unavailable, exception will be thrown.
disable	Do not use hardware cryptography.

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

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

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

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

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

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

ListDelimiter: The delimiter character for multi-element lists.

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

LogDestination: Specifies the debug log destination.

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

Supported values are:


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

LogDetails: Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:


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

LogFile: Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters: Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:


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

LogFlushMode: Specifies the log flush mode.

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


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

LogLevel: Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:


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

LogMaxEventCount: Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode: Specifies the log rotation mode.

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


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

MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

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

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

PKICache: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.

The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached.

Supported Values:


certificate	Enables caching of certificates.
crl	Enables caching of Certificate Revocation Lists (CRLs).
ocsp	Enables caching of OCSP (Online Certificate Status Protocol) responses.

Example (default value): PKICache=certificate,crl,ocsp In this example, the component caches certificates, CRLs, and OCSP responses.

PKICachePath: Specifies the file system path where cached PKI data is stored.

The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts.

The default value is an empty string - no cached PKI data is stored on disk.

Example: PKICachePath=C:\Temp\cache In this example, the cached PKI data is stored in the C:\Temp\cache directory.

ProductVersion: Returns the version of the SecureBlackbox library.

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

ServerSSLDHKeyLength: Sets the size of the TLS DHE key exchange group.

Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

StaticDNS: Specifies whether static DNS rules should be used.

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

Supported values are:


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

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

StaticIPAddresses: Gets or sets all the static DNS rules.

Tag: Allows to store any custom data.

Use this config property to store any custom data.

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

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

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

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

UseCRLObjectCaching: Specifies whether reuse of loaded CRL objects is enabled.

This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used.

UseInternalRandom: Switches between SecureBlackbox-own and platform PRNGs.

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

UseLegacyAdESValidation: Enables legacy AdES validation mode.

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

UseOCSPResponseObjectCaching: Specifies whether reuse of loaded OCSP response objects is enabled.

This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used.

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

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

UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemNativeSizeCalculation: An internal CryptoAPI access tweak.

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

UseSystemOAEPAndPSS: Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom: Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

XMLRDNDescriptorName[OID]: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.

This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.

The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.

Syntax: Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");

Where:

OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.

PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.

Alias1, Alias2, ...: Optional alternative names recognized during parsing.

Usage Examples:

Map OID 2.5.4.5 to SERIALNUMBER: Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");

Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");

XMLRDNDescriptorPriority[OID]: Specifies the priority of descriptor names associated with a specific OID.

This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing.

XMLRDNDescriptorReverseOrder: Specifies whether to reverse the order of descriptors in RDN.

Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1).

XMLRDNDescriptorSeparator: Specifies the separator used between descriptors in RDN.

Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value.

Trappable Errors (KMIPClient Struct)

KMIPClient Errors

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