KMIPClient Class

Properties Methods Events Configuration Settings Errors

The KMIPClient class provides client-side functionality for KMIP.

Syntax

KMIPClient

Remarks

The Key Management Interoperability Protocol (KMIP) is an OASIS standard for communication between different key management servers and clients.

Property List

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


DataFile	A path to the file containing the unsigned data.
EncoderType	Specifies the KMIP encoder type.
ExternalCryptoAsyncDocumentID	Specifies the document ID for SignAsyncEnd() call Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch.
ExternalCryptoCustomParams	Custom parameters to be passed to the signing service (uninterpreted).
ExternalCryptoData	Additional data to be included in the async state and mirrored back by the requestor.
ExternalCryptoExternalHashCalculation	Specifies whether the message hash is to be calculated at the external endpoint.
ExternalCryptoHashAlgorithm	Specifies the request's signature hash algorithm.
ExternalCryptoKeyID	The ID of the pre-shared key used for DC request authentication.
ExternalCryptoKeySecret	The pre-shared key used for DC request authentication.
ExternalCryptoMethod	Specifies the asynchronous signing method.
ExternalCryptoMode	Specifies the external cryptography mode.
ExternalCryptoPublicKeyAlgorithm	Provide public key algorithm here if the certificate is not available on the pre-signing stage.
FIPSMode	Reserved.
Host	Specifies the host name of the KMIP server.
InputFile	Path to the file containing data to be signed, verified, encrypted or decrypted.
ObjectCount	The number of records in the Object arrays.
ObjectID	Contains the value currently stored in the ID Placeholder.
ObjectKeyAlgorithm	The cryptographic algorithm for this object.
ObjectKeyLength	The length of the cryptographic key.
ObjectObjectType	The type of this object.
ObjectSigAlgorithm	Digital signature algorithm for this object (only for certificates).
ObjectUniqueIdentifier	The unique identifier of the object generated by the key management system.
OutputFile	Specifies the file where the signed, encrypted, or decrypted data should be saved.
Password	Specifies a password to authenticate to the KMIP server.
PinnedCertBytes	Returns raw certificate data in DER format.
PinnedCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
PinnedCertRequestBytes	Provides access to raw certificate request data in DER format.
PinnedCertRequestHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
Port	Specifies the port on the KMIP server to connect to.
ProxyAddress	The IP address of the proxy server.
ProxyAuthentication	The authentication type used by the proxy server.
ProxyPassword	The password to authenticate to the proxy server.
ProxyPort	The port on the proxy server to connect to.
ProxyProxyType	The type of the proxy server.
ProxyRequestHeaders	Contains HTTP request headers for WebTunnel and HTTP proxy.
ProxyResponseBody	Contains the HTTP or HTTPS (WebTunnel) proxy response body.
ProxyResponseHeaders	Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
ProxyUseIPv6	Specifies whether IPv6 should be used when connecting through the proxy.
ProxyUseProxy	Enables or disables proxy-driven connection.
ProxyUsername	Specifies the username credential for proxy authentication.
SignatureValidationResult	The signature validation result.
SocketDNSMode	Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.
SocketDNSPort	Specifies the port number to be used for sending queries to the DNS server.
SocketDNSQueryTimeout	The timeout (in milliseconds) for each DNS query.
SocketDNSServers	The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
SocketDNSTotalTimeout	The timeout (in milliseconds) for the whole resolution process.
SocketIncomingSpeedLimit	The maximum number of bytes to read from the socket, per second.
SocketLocalAddress	The local network interface to bind the socket to.
SocketLocalPort	The local port number to bind the socket to.
SocketOutgoingSpeedLimit	The maximum number of bytes to write to the socket, per second.
SocketTimeout	The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
SocketUseIPv6	Enables or disables IP protocol version 6.
TLSClientCertCount	The number of records in the TLSClientCert arrays.
TLSClientCertBytes	Returns raw certificate data in DER format.
TLSClientCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
TLSServerCertCount	The number of records in the TLSServerCert arrays.
TLSServerCertBytes	Returns raw certificate data in DER format.
TLSServerCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
TLSAutoValidateCertificates	Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
TLSBaseConfiguration	Selects the base configuration for the TLS settings.
TLSCiphersuites	A list of ciphersuites separated with commas or semicolons.
TLSECCurves	Defines the elliptic curves to enable.
TLSExtensions	Provides access to TLS extensions.
TLSForceResumeIfDestinationChanges	Whether to force TLS session resumption when the destination address changes.
TLSPreSharedIdentity	Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
TLSPreSharedKey	Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
TLSPreSharedKeyCiphersuite	Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
TLSRenegotiationAttackPreventionMode	Selects renegotiation attack prevention mechanism.
TLSRevocationCheck	Specifies the kind(s) of revocation check to perform.
TLSSSLOptions	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.
TLSTLSMode	Specifies the TLS mode to use.
TLSUseExtendedMasterSecret	Enables Extended Master Secret Extension, as defined in RFC 7627.
TLSUseSessionResumption	Enables or disables TLS session resumption capability.
TLSVersions	Th SSL/TLS versions to enable by default.
Username	The username to authenticate to the KMIP server.

Method List

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


AddCertificate	Imports a certificate to the KMIP server.
AddKey	Imports a key to the KMIP server.
AddPinned	Imports a certificate to the KMIP server.
Config	Sets or retrieves a configuration setting.
Decrypt	Decrypts the provided data using a key stored on the KMIP server.
DoAction	Performs an additional action.
Encrypt	Encrypts the provided data using a key stored on the KMIP server.
GenerateCert	Generates a new certificate on the KMIP server.
GenerateCertFromPinned	Generates a new certificate on the KMIP server from the pinned certificate.
GenerateCertFromRequest	Generates a new certificate on the KMIP server from the certificate request.
GenerateKey	Generates a symmetric key or an asymmetric key pair on the KMIP server.
GetList	Retrieves the list of objects of a given type.
Remove	Removes the specified object from the server.
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 class with short descriptions. Click on the links for further details.


Error	Provides information about errors during KMIP operations.
ExternalSign	Handles remote or external signing initiated by the SignExternal method or other source.
Notification	This event notifies the application about an underlying control flow event.
TLSCertValidate	This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

Configuration Settings

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


BlockCipherMode	Block cipher mode to use for encrypting or decrypting.
BlockSize	Block size of data for encrypting, decrypting or signing.
Curve	Name of the curve of the newly added elliptic cryptography (EC) key.
HashAlgorithm	Hash algorithm to use for signing or verifying.
IVCounterNonce	Initialization vector, counter or nonce for encrypting or decrypting.
MajorProtocolVersion	Major protocol version of the KMIP server.
MaximumItems	The maximum number of items to be returned on getting the object list.
MinorProtocolVersion	Minor protocol version of the KMIP server.
OffsetItems	The number of items to skip on getting the object list.
PaddingMethod	Padding method to use for encrypting or decrypting.
RandomIV	Whether to generate the initialization vector automatically.
TagLength	Tag length to use for encrypting or decrypting.
TempPath	Path for storing temporary files.
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 class (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
Tag	Allows to store any custom data.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.

DataFile Property (KMIPClient Class)

A path to the file containing the unsigned data.

Syntax

QString GetDataFile();
int SetDataFile(QString qsDataFile);

Default Value

Remarks

When validating detached signatures, use this property to provide the unsigned data.

Data Type

String

EncoderType Property (KMIPClient Class)

Specifies the KMIP encoder type.

Syntax

int GetEncoderType();
int SetEncoderType(int iEncoderType);

Possible Values

ET_TTLV(0), 
ET_XML(1), 
ET_JSON(2)

Default Value

Remarks

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


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

Data Type

Integer

ExternalCryptoAsyncDocumentID Property (KMIPClient Class)

Specifies the document ID for SignAsyncEnd() call Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch.

Syntax

QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID);

Default Value

Remarks

Specifies the document ID for SignAsyncEnd() call

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. This value helps ASiCSigner 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 pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (KMIPClient Class)

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

Syntax

QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams);

Default Value

Remarks

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

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (KMIPClient Class)

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

Syntax

QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData);

Default Value

Remarks

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

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (KMIPClient Class)

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

Syntax

bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation);

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 all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (KMIPClient Class)

Specifies the request's signature hash algorithm.

Syntax

QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm);

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

ExternalCryptoKeyID Property (KMIPClient Class)

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

Syntax

QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID);

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 extra protection layer for the protocol and diminishes the risk of private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret 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

ExternalCryptoKeySecret Property (KMIPClient Class)

The pre-shared key used for DC request authentication.

Syntax

QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret);

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 ExternalCryptoKeyID topic.

Data Type

String

ExternalCryptoMethod Property (KMIPClient Class)

Specifies the asynchronous signing method.

Syntax

int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);

Possible Values

ASMD_PKCS1(0), 
ASMD_PKCS7(1)

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

Integer

ExternalCryptoMode Property (KMIPClient Class)

Specifies the external cryptography mode.

Syntax

int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);

Possible Values

ECM_DEFAULT(0), 
ECM_DISABLED(1), 
ECM_GENERIC(2), 
ECM_DCAUTH(3), 
ECM_DCAUTH_JSON(4)

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 OnExternalSign event (`2`)
ecmDCAuth	DCAuth signing (`3`)
ecmDCAuthJSON	DCAuth signing in JSON format (`4`)

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (KMIPClient Class)

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

Syntax

QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);

Default Value

Remarks

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

Data Type

String

FIPSMode Property (KMIPClient Class)

Reserved.

Syntax

bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

Host Property (KMIPClient Class)

Specifies the host name of the KMIP server.

Syntax

QString GetHost();
int SetHost(QString qsHost);

Default Value

Remarks

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

Data Type

String

InputFile Property (KMIPClient Class)

Path to the file containing data to be signed, verified, encrypted or decrypted.

Syntax

QString GetInputFile();
int SetInputFile(QString qsInputFile);

Default Value

Remarks

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

Data Type

String

ObjectCount Property (KMIPClient Class)

The number of records in the Object arrays.

Syntax

int GetObjectCount();

Default Value

Remarks

This property controls the size of the following arrays:

ObjectID
ObjectKeyAlgorithm
ObjectKeyLength
ObjectObjectType
ObjectSigAlgorithm
ObjectUniqueIdentifier

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

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

Data Type

Integer

ObjectID Property (KMIPClient Class)

Contains the value currently stored in the ID Placeholder.

Syntax

QString GetObjectID(int iObjectIndex);

Default Value

Remarks

Contains the value currently stored in the ID Placeholder. The ID Placeholder is a temporary variable which is used for storing a unique identifier temporarily during an operation.

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 and not available at design time.

Data Type

String

ObjectKeyAlgorithm Property (KMIPClient Class)

The cryptographic algorithm for this object.

Syntax

QString GetObjectKeyAlgorithm(int iObjectIndex);

Default Value

Remarks

The cryptographic algorithm for this object.

Supported values: RSA, DSA, EC, ECDSA, DH, ECDH, DES, 3DES, AES, RC2, RC4, Idea, Blowfish, Camellia, Twofish

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 and not available at design time.

Data Type

String

ObjectKeyLength Property (KMIPClient Class)

The length of the cryptographic key.

Syntax

int GetObjectKeyLength(int iObjectIndex);

Default Value

Remarks

The length of the cryptographic key.

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 and not available at design time.

Data Type

Integer

ObjectObjectType Property (KMIPClient Class)

The type of this object.

Syntax

int GetObjectObjectType(int iObjectIndex);

Possible Values

OT_UNKNOWN(0), 
OT_CERTIFICATE(1), 
OT_SYMMETRIC_KEY(2), 
OT_PUBLIC_KEY(4), 
OT_PRIVATE_KEY(8)

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 and not available at design time.

Data Type

Integer

ObjectSigAlgorithm Property (KMIPClient Class)

Digital signature algorithm for this object (only for certificates).

Syntax

QString GetObjectSigAlgorithm(int iObjectIndex);

Default Value

Remarks

Digital signature algorithm for this object (only for certificates).

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 and not available at design time.

Data Type

String

ObjectUniqueIdentifier Property (KMIPClient Class)

The unique identifier of the object generated by the key management system.

Syntax

QString GetObjectUniqueIdentifier(int iObjectIndex);

Default Value

Remarks

The unique identifier of the object generated by the key management system. 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 and not available at design time.

Data Type

String

OutputFile Property (KMIPClient Class)

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

Syntax

QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);

Default Value

Remarks

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

Data Type

String

Password Property (KMIPClient Class)

Specifies a password to authenticate to the KMIP server.

Syntax

QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

Remarks

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

Data Type

String

PinnedCertBytes Property (KMIPClient Class)

Returns raw certificate data in DER format.

Syntax

QByteArray GetPinnedCertBytes();

Remarks

Returns raw certificate data in DER format.

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

Data Type

Byte Array

PinnedCertHandle Property (KMIPClient Class)

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

Syntax

qint64 GetPinnedCertHandle();
int SetPinnedCertHandle(qint64 lPinnedCertHandle);

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

This property is not available at design time.

Data Type

Long64

PinnedCertRequestBytes Property (KMIPClient Class)

Provides access to raw certificate request data in DER format.

Syntax

QByteArray GetPinnedCertRequestBytes();

Remarks

Provides access to raw certificate request data in DER format.

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

Data Type

Byte Array

PinnedCertRequestHandle Property (KMIPClient Class)

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

Syntax

qint64 GetPinnedCertRequestHandle();
int SetPinnedCertRequestHandle(qint64 lPinnedCertRequestHandle);

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.

This property is not available at design time.

Data Type

Long64

Port Property (KMIPClient Class)

Specifies the port on the KMIP server to connect to.

Syntax

int GetPort();
int SetPort(int iPort);

Default Value

Remarks

Provide the port number on which the class should make requests to the KMIP server.

Data Type

Integer

ProxyAddress Property (KMIPClient Class)

The IP address of the proxy server.

Syntax

QString GetProxyAddress();
int SetProxyAddress(QString qsProxyAddress);

Default Value

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (KMIPClient Class)

The authentication type used by the proxy server.

Syntax

int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication);

Possible Values

PAT_NO_AUTHENTICATION(0), 
PAT_BASIC(1), 
PAT_DIGEST(2), 
PAT_NTLM(3)

Default Value

Remarks

The authentication type used by the proxy server.


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

Data Type

Integer

ProxyPassword Property (KMIPClient Class)

The password to authenticate to the proxy server.

Syntax

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

Default Value

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (KMIPClient Class)

The port on the proxy server to connect to.

Syntax

int GetProxyPort();
int SetProxyPort(int iProxyPort);

Default Value

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (KMIPClient Class)

The type of the proxy server.

Syntax

int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType);

Possible Values

CPT_NONE(0), 
CPT_SOCKS_4(1), 
CPT_SOCKS_5(2), 
CPT_WEB_TUNNEL(3), 
CPT_HTTP(4)

Default Value

Remarks

The type of the proxy server.

The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.


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

Data Type

Integer

ProxyRequestHeaders Property (KMIPClient Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

QString GetProxyRequestHeaders();
int SetProxyRequestHeaders(QString qsProxyRequestHeaders);

Default Value

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (KMIPClient Class)

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

Syntax

QString GetProxyResponseBody();
int SetProxyResponseBody(QString qsProxyResponseBody);

Default Value

Remarks

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

Data Type

String

ProxyResponseHeaders Property (KMIPClient Class)

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

Syntax

QString GetProxyResponseHeaders();
int SetProxyResponseHeaders(QString qsProxyResponseHeaders);

Default Value

Remarks

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

Data Type

String

ProxyUseIPv6 Property (KMIPClient Class)

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

Syntax

bool GetProxyUseIPv6();
int SetProxyUseIPv6(bool bProxyUseIPv6);

Default Value

false

Remarks

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

Data Type

Boolean

ProxyUseProxy Property (KMIPClient Class)

Enables or disables proxy-driven connection.

Syntax

bool GetProxyUseProxy();
int SetProxyUseProxy(bool bProxyUseProxy);

Default Value

false

Remarks

Enables or disables proxy-driven connection.

Data Type

Boolean

ProxyUsername Property (KMIPClient Class)

Specifies the username credential for proxy authentication.

Syntax

QString GetProxyUsername();
int SetProxyUsername(QString qsProxyUsername);

Default Value

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

SignatureValidationResult Property (KMIPClient Class)

The signature validation result.

Syntax

int GetSignatureValidationResult();

Possible Values

SVT_VALID(0), 
SVT_UNKNOWN(1), 
SVT_CORRUPTED(2), 
SVT_SIGNER_NOT_FOUND(3), 
SVT_FAILURE(4)

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

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

Data Type

Integer

SocketDNSMode Property (KMIPClient Class)

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

Syntax

int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode);

Possible Values

DM_AUTO(0), 
DM_PLATFORM(1), 
DM_OWN(2), 
DM_OWN_SECURE(3)

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

Integer

SocketDNSPort Property (KMIPClient Class)

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

Syntax

int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort);

Default Value

Remarks

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

Data Type

Integer

SocketDNSQueryTimeout Property (KMIPClient Class)

The timeout (in milliseconds) for each DNS query.

Syntax

int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout);

Default Value

Remarks

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

Data Type

Integer

SocketDNSServers Property (KMIPClient Class)

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

Syntax

QString GetSocketDNSServers();
int SetSocketDNSServers(QString qsSocketDNSServers);

Default Value

Remarks

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

Data Type

String

SocketDNSTotalTimeout Property (KMIPClient Class)

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

Syntax

int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout);

Default Value

Remarks

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

Data Type

Integer

SocketIncomingSpeedLimit Property (KMIPClient Class)

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

Syntax

int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit);

Default Value

Remarks

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

Data Type

Integer

SocketLocalAddress Property (KMIPClient Class)

The local network interface to bind the socket to.

Syntax

QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress);

Default Value

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (KMIPClient Class)

The local port number to bind the socket to.

Syntax

int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort);

Default Value

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (KMIPClient Class)

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

Syntax

int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit);

Default Value

Remarks

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

Data Type

Integer

SocketTimeout Property (KMIPClient Class)

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

Syntax

int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout);

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

Integer

SocketUseIPv6 Property (KMIPClient Class)

Enables or disables IP protocol version 6.

Syntax

bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

TLSClientCertCount Property (KMIPClient Class)

The number of records in the TLSClientCert arrays.

Syntax

int GetTLSClientCertCount();
int SetTLSClientCertCount(int iTLSClientCertCount);

Default Value

Remarks

This property controls the size of the following arrays:

TLSClientCertBytes
TLSClientCertHandle

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

This property is not available at design time.

Data Type

Integer

TLSClientCertBytes Property (KMIPClient Class)

Returns raw certificate data in DER format.

Syntax

QByteArray GetTLSClientCertBytes(int iTLSClientCertIndex);

Remarks

Returns 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 and not available at design time.

Data Type

Byte Array

TLSClientCertHandle Property (KMIPClient Class)

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

Syntax

qint64 GetTLSClientCertHandle(int iTLSClientCertIndex);
int SetTLSClientCertHandle(int iTLSClientCertIndex, qint64 lTLSClientCertHandle);

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.

This property is not available at design time.

Data Type

Long64

TLSServerCertCount Property (KMIPClient Class)

The number of records in the TLSServerCert arrays.

Syntax

int GetTLSServerCertCount();

Default Value

Remarks

This property controls the size of the following arrays:

TLSServerCertBytes
TLSServerCertHandle

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

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

Data Type

Integer

TLSServerCertBytes Property (KMIPClient Class)

Returns raw certificate data in DER format.

Syntax

QByteArray GetTLSServerCertBytes(int iTLSServerCertIndex);

Remarks

Returns 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 and not available at design time.

Data Type

Byte Array

TLSServerCertHandle Property (KMIPClient Class)

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

Syntax

qint64 GetTLSServerCertHandle(int iTLSServerCertIndex);

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 and not available at design time.

Data Type

Long64

TLSAutoValidateCertificates Property (KMIPClient Class)

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

Syntax

bool GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(bool bTLSAutoValidateCertificates);

Default Value

true

Remarks

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

Data Type

Boolean

TLSBaseConfiguration Property (KMIPClient Class)

Selects the base configuration for the TLS settings.

Syntax

int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration);

Possible Values

STPC_DEFAULT(0), 
STPC_COMPATIBLE(1), 
STPC_COMPREHENSIVE_INSECURE(2), 
STPC_HIGHLY_SECURE(3)

Default Value

Remarks

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


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

Data Type

Integer

TLSCiphersuites Property (KMIPClient Class)

A list of ciphersuites separated with commas or semicolons.

Syntax

QString GetTLSCiphersuites();
int SetTLSCiphersuites(QString qsTLSCiphersuites);

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 that allow to blanketly enable or disable all ciphersuites at once.

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

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

Data Type

String

TLSECCurves Property (KMIPClient Class)

Defines the elliptic curves to enable.

Syntax

QString GetTLSECCurves();
int SetTLSECCurves(QString qsTLSECCurves);

Default Value

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (KMIPClient Class)

Provides access to TLS extensions.

Syntax

QString GetTLSExtensions();
int SetTLSExtensions(QString qsTLSExtensions);

Default Value

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (KMIPClient Class)

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

Syntax

bool GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(bool bTLSForceResumeIfDestinationChanges);

Default Value

false

Remarks

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

Data Type

Boolean

TLSPreSharedIdentity Property (KMIPClient Class)

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

Syntax

QString GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(QString qsTLSPreSharedIdentity);

Default Value

Remarks

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

This property is not available at design time.

Data Type

String

TLSPreSharedKey Property (KMIPClient Class)

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

Syntax

QString GetTLSPreSharedKey();
int SetTLSPreSharedKey(QString qsTLSPreSharedKey);

Default Value

Remarks

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

This property is not available at design time.

Data Type

String

TLSPreSharedKeyCiphersuite Property (KMIPClient Class)

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

Syntax

QString GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(QString qsTLSPreSharedKeyCiphersuite);

Default Value

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (KMIPClient Class)

Selects renegotiation attack prevention mechanism.

Syntax

int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode);

Possible Values

CRAPM_COMPATIBLE(0), 
CRAPM_STRICT(1), 
CRAPM_AUTO(2)

Default Value

Remarks

Selects 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

Integer

TLSRevocationCheck Property (KMIPClient Class)

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

Syntax

int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck);

Possible Values

CRC_NONE(0), 
CRC_AUTO(1), 
CRC_ALL_CRL(2), 
CRC_ALL_OCSP(3), 
CRC_ALL_CRLAND_OCSP(4), 
CRC_ANY_CRL(5), 
CRC_ANY_OCSP(6), 
CRC_ANY_CRLOR_OCSP(7), 
CRC_ANY_OCSPOR_CRL(8)

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

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

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

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

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (KMIPClient Class)

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

int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions);

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 use of client certificate hash algorithm. It is unlikely that you will ever need to adjust it.
cssloAutoAddServerNameExtension	`0x010`	Automatically add server name extension when known
cssloAcceptTrustedSRPPrimesOnly	`0x020`	Accept trusted SRP primes only
cssloDisableSignatureAlgorithmsExtension	`0x040`	Disable (not send) 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 handshake message as large batches rather than individually

Data Type

Integer

TLSTLSMode Property (KMIPClient Class)

Specifies the TLS mode to use.

Syntax

int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode);

Possible Values

SM_DEFAULT(0), 
SM_NO_TLS(1), 
SM_EXPLICIT_TLS(2), 
SM_IMPLICIT_TLS(3), 
SM_MIXED_TLS(4)

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, allow plain data.

Data Type

Integer

TLSUseExtendedMasterSecret Property (KMIPClient Class)

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

Syntax

bool GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(bool bTLSUseExtendedMasterSecret);

Default Value

false

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (KMIPClient Class)

Enables or disables TLS session resumption capability.

Syntax

bool GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(bool bTLSUseSessionResumption);

Default Value

false

Remarks

Enables or disables TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (KMIPClient Class)

Th SSL/TLS versions to enable by default.

Syntax

int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);

Default Value

Remarks

Th 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

Integer

Username Property (KMIPClient Class)

The username to authenticate to the KMIP server.

Syntax

QString GetUsername();
int SetUsername(QString qsUsername);

Default Value

Remarks

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

Data Type

String

AddCertificate Method (KMIPClient Class)

Imports a certificate to the KMIP server.

Syntax

QString AddCertificate(const QString& qsCertPassword, bool bAddPrivateKey, const QString& qsId);

Remarks

Call this method to import a certificate to the KMIP server. Provide the key via InputFile or InputStream property.

Use the Id parameter to supply a unique certificate object identifier. AddPrivateKey instructs the component to import the private key as well. The method returns the actual ID of the new object, which may differ from the supplied one.

Error Handling

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

AddKey Method (KMIPClient Class)

Imports a key to the KMIP server.

Syntax

QString AddKey(const QString& qsId);

Remarks

Call this method to import a key to the KMIP server. Provide the key via InputFile or InputStream property.

Use the Id parameter to supply a unique certificate object identifier. The method returns the actual ID of the new object, which may differ from the supplied one.

Error Handling

AddPinned Method (KMIPClient Class)

Imports a certificate to the KMIP server.

Syntax

QString AddPinned(bool bAddPrivateKey, const QString& qsId);

Remarks

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

Error Handling

Config Method (KMIPClient Class)

Sets or retrieves a configuration setting.

Syntax

QString Config(const QString& qsConfigurationString);

Remarks

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

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

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

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

Error Handling

Decrypt Method (KMIPClient Class)

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

Syntax

int Decrypt(const QString& qsUniqueIdentifier);

Remarks

Use this method to decrypt the data using the key with the specified UniqueIdentifier. Provide the encrypted data via InputFile (or InputStream). The decrypted data will be saved to OutputFile (or OutputStream).

Error Handling

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DoAction Method (KMIPClient Class)

Performs an additional action.

Syntax

QString DoAction(const QString& qsActionID, const QString& qsActionParams);

Remarks

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

The unique identifier of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Error Handling

Encrypt Method (KMIPClient Class)

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

Syntax

int Encrypt(const QString& qsUniqueIdentifier);

Remarks

Use this method to encrypt the data using the key with the specified UniqueIdentifier. Provide the data to be encrypted via InputFile or InputStream. The encrypted data will be saved to OutputFile (or OutputStream).

Error Handling

GenerateCert Method (KMIPClient Class)

Generates a new certificate on the KMIP server.

Syntax

QString GenerateCert(const QString& qsPublicKeyUniqueIdentifier, const QString& qsKeyAlgorithm, const QString& qsHashAlgorithm, int iKeyLength, const QString& qsSubjectRDN, const QString& qsId);

Remarks

Use KeyAlgorithm, HashAlgorithm, and KeyLength to specify the desired algorithms and key length. SubjectRDN should identify the new certificate's owner.

Use the Id parameter to suggest a unique identifier for the certificate object. The method returns the actual Id assigned to the new certificate (it may differ from the one you supplied).

Error Handling

GenerateCertFromPinned Method (KMIPClient Class)

Generates a new certificate on the KMIP server from the pinned certificate.

Syntax

QString GenerateCertFromPinned(const QString& qsPublicKeyUniqueIdentifier, const QString& qsId);

Remarks

Use the Id parameter to provide a unique identifier for the new certificate. The method will return the actual Id assigned to the new certificate, which may differ from the one you provided.

Error Handling

GenerateCertFromRequest Method (KMIPClient Class)

Generates a new certificate on the KMIP server from the certificate request.

Syntax

QString GenerateCertFromRequest(const QString& qsId);

Remarks

Provide the certificate request via PinnedCertRequest property. The returned value contains the Id assigned to the certificate, which may differ from the one you supplied.

Error Handling

GenerateKey Method (KMIPClient Class)

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

Syntax

QString GenerateKey(const QString& qsKeyAlgorithm, int iKeyLength, const QString& qsId);

Remarks

Use KeyAlgorithm and KeyLength to indicate the desired algorithm and key length. Provide an identifier (name) of the new key via the Id parameter.

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

Error Handling

GetList Method (KMIPClient Class)

Retrieves the list of objects of a given type.

Syntax

int GetList(int iObjectTypes);

Remarks

ObjectTypes is a bit mask according to which objects of one or more types can be selected. Possible values:


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

If ObjectTypes of 0 is provided, all objects will be requested from the server.

Error Handling

Remove Method (KMIPClient Class)

Removes the specified object from the server.

Syntax

int Remove(const QString& qsUniqueIdentifier);

Remarks

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

Error Handling

Sign Method (KMIPClient Class)

Signs the data using a key on the KMIP server.

Syntax

int Sign(const QString& qsUniqueIdentifier);

Remarks

Use this method to sign the data using the key with the specified UniqueIdentifier. Pass the data to be signed via InputFile (or InputStream) property. The resulting signed data will be written to OutputFile (or OutputStream).

Error Handling

Verify Method (KMIPClient Class)

Verifies digitally signed data.

Syntax

int Verify(const QString& qsUniqueIdentifier);

Remarks

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

Please provide the signature via InputFile (or InputStream) property. For detached signatures, please also provide the data that was signed via DataFile (or DataStream) property.

Error Handling

Error Event (KMIPClient Class)

Provides information about errors during KMIP operations.

Syntax

class KMIPClientErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(KMIPClientErrorEventParams *e);

// Or, subclass KMIPClient and override this emitter function.
virtual int FireError(KMIPClientErrorEventParams *e) {...}

Remarks

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

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

ExternalSign Event (KMIPClient Class)

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

Syntax

class KMIPClientExternalSignEventParams {
public:
  const QString &OperationId();

  const QString &HashAlgorithm();

  const QString &Pars();

  const QString &Data();

  const QString &SignedData();
  void SetSignedData(const QString &qsSignedData);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ExternalSign(KMIPClientExternalSignEventParams *e);

// Or, subclass KMIPClient and override this emitter function.
virtual int FireExternalSign(KMIPClientExternalSignEventParams *e) {...}

Remarks

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

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

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

The component uses base16 (hex) encoding for 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 a .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(); };

Notification Event (KMIPClient Class)

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

Syntax

class KMIPClientNotificationEventParams {
public:
  const QString &EventID();

  const QString &EventParam();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Notification(KMIPClientNotificationEventParams *e);

// Or, subclass KMIPClient and override this emitter function.
virtual int FireNotification(KMIPClientNotificationEventParams *e) {...}

Remarks

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

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

TLSCertValidate Event (KMIPClient Class)

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

Syntax

class KMIPClientTLSCertValidateEventParams {
public:
  const QString &ServerHostname();

  const QString &ServerIP();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void TLSCertValidate(KMIPClientTLSCertValidateEventParams *e);

// Or, subclass KMIPClient and override this emitter function.
virtual int FireTLSCertValidate(KMIPClientTLSCertValidateEventParams *e) {...}

Remarks

This event is fired during a TLS handshake. Use TLSServerChain property to access the certificate chain. In general case, components 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 component, and can be adjusted if needed.

Configuration Settings (KMIPClient Class)

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

KMIPClient Configuration Settings

BlockCipherMode: Block cipher mode to use for encrypting or decrypting.

Use this property to specify the block cipher mode to use for encrypting or decrypting.

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.

Curve: Name of the curve of the newly added elliptic cryptography (EC) key.

This property specifies the name of the curve used by the EC key.

HashAlgorithm: Hash algorithm to use for signing or verifying.

Use this property to specify the hash algorithm to use for signing or verifying.

IVCounterNonce: Initialization vector, counter or nonce for encrypting or decrypting.

Depending on the setup, this property contains one of the following: initialization vector, counter, or nonce, to use for encrypting or decrypting.

MajorProtocolVersion: Major protocol version of the KMIP server.

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

MaximumItems: The maximum number of items to be returned on getting the object list.

Use this property to limit the maximum number of items returned in the object list.

MinorProtocolVersion: Minor protocol version of the KMIP server.

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

OffsetItems: The number of items to skip on getting the object list.

Defines how many items in the beginning of the object list should be omitted. Only the objects following OffsetItems will be returned upon requesting the objects list.

PaddingMethod: Padding method to use for encrypting or decrypting.

Use this property to specify the padding method to use for encrypting or decrypting.

RandomIV: Whether to generate the initialization vector automatically.

Set this property to true to tell the class to generate a random IV to be used in encryption or decryption.

TagLength: Tag length to use for encrypting or decrypting.

Use this property to specify the tag length to use for encrypting or decrypting.

TempPath: Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored.

Base Configuration Settings

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

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

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

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

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

Supported values are:


off		No caching (default)
local		Local caching (supported for HTTPClient, RESTClient and SOAPClient only)
global		Global caching

Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).

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

DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.

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

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

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

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

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

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

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

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

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.

Tag: Allows to store any custom data.

Use this config property to store any custom data.

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

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

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

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

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

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

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

Trappable Errors (KMIPClient Class)

KMIPClient Errors

1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)
20971521   Request failed (SB_ERROR_KMIP_REQUEST_FAILED)
20971522   Input file does not exist (SB_ERROR_KMIP_INPUTFILE_NOT_EXISTS)
20971523   Unsupported key algorithm (SB_ERROR_KMIP_UNSUPPORTED_KEY_ALGORITHM)
20971524   Unsupported extraction mode (SB_ERROR_KMIP_INVALID_KEY)


	1048577 Invalid parameter value (`SB_ERROR_INVALID_PARAMETER`)
	1048578 Class is configured incorrectly (`SB_ERROR_INVALID_SETUP`)
	1048579 Operation cannot be executed in the current state (`SB_ERROR_INVALID_STATE`)
	1048580 Attempt to set an invalid value to a property (`SB_ERROR_INVALID_VALUE`)
	1048581 Certificate does not have its private key loaded (`SB_ERROR_NO_PRIVATE_KEY`)
	1048581 Cancelled by the user (`SB_ERROR_CANCELLED_BY_USER`)
	20971521 Request failed (`SB_ERROR_KMIP_REQUEST_FAILED`)
	20971522 Input file does not exist (`SB_ERROR_KMIP_INPUTFILE_NOT_EXISTS`)
	20971523 Unsupported key algorithm (`SB_ERROR_KMIP_UNSUPPORTED_KEY_ALGORITHM`)
	20971524 Unsupported extraction mode (`SB_ERROR_KMIP_INVALID_KEY`)

SecureBlackbox 2022 Qt Edition

KMIPClient Class

Syntax

Remarks

Property List

Method List

Event List

Configuration Settings

DataFile Property (KMIPClient Class)

Syntax

Default Value

Remarks

Data Type

EncoderType Property (KMIPClient Class)

Syntax

Possible Values

Default Value

Remarks

Data Type

ExternalCryptoAsyncDocumentID Property (KMIPClient Class)

Syntax

Default Value

Remarks

Data Type

ExternalCryptoCustomParams Property (KMIPClient Class)

Syntax

Default Value

Remarks

Data Type

ExternalCryptoData Property (KMIPClient Class)

Syntax

Default Value

Remarks

Data Type

ExternalCryptoExternalHashCalculation Property (KMIPClient Class)

Syntax

Default Value

Remarks

Data Type

ExternalCryptoHashAlgorithm Property (KMIPClient Class)

Syntax

Default Value

Remarks

Data Type

ExternalCryptoKeyID Property (KMIPClient Class)

Syntax

Default Value

Remarks

Data Type

ExternalCryptoKeySecret Property (KMIPClient Class)

Syntax

Default Value

Remarks

Data Type

ExternalCryptoMethod Property (KMIPClient Class)

Syntax

Possible Values

Default Value

Remarks

Data Type

ExternalCryptoMode Property (KMIPClient Class)

Syntax

Possible Values

Default Value

Remarks

Data Type

ExternalCryptoPublicKeyAlgorithm Property (KMIPClient Class)

Syntax

Default Value

Remarks

Data Type

FIPSMode Property (KMIPClient Class)

Syntax

Default Value

Remarks

Data Type

Host Property (KMIPClient Class)

Syntax

Default Value

Remarks