KMIPClient Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

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

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 BaseURL:

• 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 BaseURL:

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.

Managing keys and certificates

The common key management operations are:

Importing a keypair or certificate to the server

Use AddKey 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 ReadKey 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 ReadObject to read the object into the Objects list. Use ReadAttribute 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 (GenerateKey).

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 InputBytes property.
• as a stream - use InputStream.
• in a file - use InputFile.

Note that the OutputBytes is only populated if neither of OutputFile and OutputStream 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 ReadObject. 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.

Property List

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

Method List

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

Event List

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

Config Settings

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

AuthTypes Property (KMIPClient Class)

Defines allowed HTTP authentication types.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthTypes();
int SetAuthTypes(int iAuthTypes);

Unicode (Windows)
INT GetAuthTypes();
INT SetAuthTypes(INT iAuthTypes);

int secureblackbox_kmipclient_getauthtypes(void* lpObj);
int secureblackbox_kmipclient_setauthtypes(void* lpObj, int iAuthTypes);

int GetAuthTypes();
int SetAuthTypes(int iAuthTypes);

Default Value

0

Remarks

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

Data Type

Integer

AuxResult Property (KMIPClient Class)

Contains the auxiliary result of the last performed operation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuxResult();

Unicode (Windows)
LPWSTR GetAuxResult();

char* secureblackbox_kmipclient_getauxresult(void* lpObj);

QString GetAuxResult();

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

BaseURL Property (KMIPClient Class)

Specifies the url of the KMIP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBaseURL();
int SetBaseURL(const char* lpszBaseURL);

Unicode (Windows)
LPWSTR GetBaseURL();
INT SetBaseURL(LPCWSTR lpszBaseURL);

char* secureblackbox_kmipclient_getbaseurl(void* lpObj);
int secureblackbox_kmipclient_setbaseurl(void* lpObj, const char* lpszBaseURL);

QString GetBaseURL();
int SetBaseURL(QString qsBaseURL);

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

BlockedCertificates Property (KMIPClient Class)

The certificates that must be rejected as trust anchors.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxCertificate>* GetBlockedCertificates();
int SetBlockedCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);

int secureblackbox_kmipclient_getblockedcertcount(void* lpObj);
int secureblackbox_kmipclient_setblockedcertcount(void* lpObj, int iBlockedCertCount);

int secureblackbox_kmipclient_getblockedcertbytes(void* lpObj, int blockedcertindex, char** lpBlockedCertBytes, int* lenBlockedCertBytes);

int64 secureblackbox_kmipclient_getblockedcerthandle(void* lpObj, int blockedcertindex);
int secureblackbox_kmipclient_setblockedcerthandle(void* lpObj, int blockedcertindex, int64 lBlockedCertHandle);

int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount);

QByteArray GetBlockedCertBytes(int iBlockedCertIndex);

qint64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, qint64 lBlockedCertHandle);

Remarks

Use this property to provide a list of compromised or blocked certificates. Any chain containing a blocked certificate will fail validation.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

Certificate Property (KMIPClient Class)

The certificate or request object to perform operations on.

Syntax

• C++
• C
• Qt

SecureBlackboxCertificate* GetCertificate();
int SetCertificate(SecureBlackboxCertificate* val);

int secureblackbox_kmipclient_getcertificatebytes(void* lpObj, char** lpCertificateBytes, int* lenCertificateBytes);

int64 secureblackbox_kmipclient_getcertificatehandle(void* lpObj);
int secureblackbox_kmipclient_setcertificatehandle(void* lpObj, int64 lCertificateHandle);

QByteArray GetCertificateBytes();

qint64 GetCertificateHandle();
int SetCertificateHandle(qint64 lCertificateHandle);

Remarks

Use this property to provide the certificate or CSR object on which a subsequent operation (such as Add or Generate) should be performed.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

ConnectionInfo Property (KMIPClient Class)

Returns the details of the underlying network connection.

Syntax

• C++
• C
• Qt

SecureBlackboxTLSConnectionInfo* GetConnectionInfo();

int secureblackbox_kmipclient_getconninfoaeadcipher(void* lpObj);

int secureblackbox_kmipclient_getconninfochainvalidationdetails(void* lpObj);

int secureblackbox_kmipclient_getconninfochainvalidationresult(void* lpObj);

char* secureblackbox_kmipclient_getconninfociphersuite(void* lpObj);

int secureblackbox_kmipclient_getconninfoclientauthenticated(void* lpObj);

int secureblackbox_kmipclient_getconninfoclientauthrequested(void* lpObj);

int secureblackbox_kmipclient_getconninfoconnectionestablished(void* lpObj);

int secureblackbox_kmipclient_getconninfoconnectionid(void* lpObj, char** lpConnInfoConnectionID, int* lenConnInfoConnectionID);

char* secureblackbox_kmipclient_getconninfodigestalgorithm(void* lpObj);

char* secureblackbox_kmipclient_getconninfoencryptionalgorithm(void* lpObj);

int secureblackbox_kmipclient_getconninfoexportable(void* lpObj);

int64 secureblackbox_kmipclient_getconninfoid(void* lpObj);

char* secureblackbox_kmipclient_getconninfokeyexchangealgorithm(void* lpObj);

int secureblackbox_kmipclient_getconninfokeyexchangekeybits(void* lpObj);

char* secureblackbox_kmipclient_getconninfonamedeccurve(void* lpObj);

int secureblackbox_kmipclient_getconninfopfscipher(void* lpObj);

char* secureblackbox_kmipclient_getconninfopresharedidentity(void* lpObj);

char* secureblackbox_kmipclient_getconninfopresharedidentityhint(void* lpObj);

int secureblackbox_kmipclient_getconninfopublickeybits(void* lpObj);

char* secureblackbox_kmipclient_getconninforemoteaddress(void* lpObj);

int secureblackbox_kmipclient_getconninforemoteport(void* lpObj);

int secureblackbox_kmipclient_getconninforesumedsession(void* lpObj);

int secureblackbox_kmipclient_getconninfosecureconnection(void* lpObj);

int secureblackbox_kmipclient_getconninfoserverauthenticated(void* lpObj);

char* secureblackbox_kmipclient_getconninfosignaturealgorithm(void* lpObj);

int secureblackbox_kmipclient_getconninfosymmetricblocksize(void* lpObj);

int secureblackbox_kmipclient_getconninfosymmetrickeybits(void* lpObj);

int64 secureblackbox_kmipclient_getconninfototalbytesreceived(void* lpObj);

int64 secureblackbox_kmipclient_getconninfototalbytessent(void* lpObj);

char* secureblackbox_kmipclient_getconninfovalidationlog(void* lpObj);

char* secureblackbox_kmipclient_getconninfoversion(void* lpObj);

bool GetConnInfoAEADCipher();

int GetConnInfoChainValidationDetails();

int GetConnInfoChainValidationResult();

QString GetConnInfoCiphersuite();

bool GetConnInfoClientAuthenticated();

bool GetConnInfoClientAuthRequested();

bool GetConnInfoConnectionEstablished();

QByteArray GetConnInfoConnectionID();

QString GetConnInfoDigestAlgorithm();

QString GetConnInfoEncryptionAlgorithm();

bool GetConnInfoExportable();

qint64 GetConnInfoID();

QString GetConnInfoKeyExchangeAlgorithm();

int GetConnInfoKeyExchangeKeyBits();

QString GetConnInfoNamedECCurve();

bool GetConnInfoPFSCipher();

QString GetConnInfoPreSharedIdentity();

QString GetConnInfoPreSharedIdentityHint();

int GetConnInfoPublicKeyBits();

QString GetConnInfoRemoteAddress();

int GetConnInfoRemotePort();

bool GetConnInfoResumedSession();

bool GetConnInfoSecureConnection();

bool GetConnInfoServerAuthenticated();

QString GetConnInfoSignatureAlgorithm();

int GetConnInfoSymmetricBlockSize();

int GetConnInfoSymmetricKeyBits();

qint64 GetConnInfoTotalBytesReceived();

qint64 GetConnInfoTotalBytesSent();

QString GetConnInfoValidationLog();

QString GetConnInfoVersion();

Remarks

Use this property to learn about the connection setup, such as the protocol security details and amounts of data transferred each way.

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

Data Type

SecureBlackboxTLSConnectionInfo

DataBytes Property (KMIPClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDataBytes(char* &lpDataBytes, int &lenDataBytes);
int SetDataBytes(const char* lpDataBytes, int lenDataBytes);

Unicode (Windows)
INT GetDataBytes(LPSTR &lpDataBytes, INT &lenDataBytes);
INT SetDataBytes(LPCSTR lpDataBytes, INT lenDataBytes);

int secureblackbox_kmipclient_getdatabytes(void* lpObj, char** lpDataBytes, int* lenDataBytes);
int secureblackbox_kmipclient_setdatabytes(void* lpObj, const char* lpDataBytes, int lenDataBytes);

QByteArray GetDataBytes();
int SetDataBytes(QByteArray qbaDataBytes);

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

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

This property is not available at design time.

Data Type

Byte Array

DataFile Property (KMIPClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDataFile();
int SetDataFile(const char* lpszDataFile);

Unicode (Windows)
LPWSTR GetDataFile();
INT SetDataFile(LPCWSTR lpszDataFile);

char* secureblackbox_kmipclient_getdatafile(void* lpObj);
int secureblackbox_kmipclient_setdatafile(void* lpObj, const char* lpszDataFile);

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

Default Value

""

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

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

Data Type

String

Encoding Property (KMIPClient Class)

Specifies the KMIP encoding type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncoding();
int SetEncoding(int iEncoding);

Unicode (Windows)
INT GetEncoding();
INT SetEncoding(INT iEncoding);

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

int secureblackbox_kmipclient_getencoding(void* lpObj);
int secureblackbox_kmipclient_setencoding(void* lpObj, int iEncoding);

int GetEncoding();
int SetEncoding(int iEncoding);

Default Value

0

Remarks

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

The following encodings are available:

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

Integer

ExternalCrypto Property (KMIPClient Class)

Provides access to external signing and DC parameters.

Syntax

• C++
• C
• Qt

SecureBlackboxExternalCrypto* GetExternalCrypto();

char* secureblackbox_kmipclient_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_kmipclient_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);

char* secureblackbox_kmipclient_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_kmipclient_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);

char* secureblackbox_kmipclient_getexternalcryptodata(void* lpObj);
int secureblackbox_kmipclient_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);

int secureblackbox_kmipclient_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_kmipclient_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);

char* secureblackbox_kmipclient_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_kmipclient_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);

char* secureblackbox_kmipclient_getexternalcryptokeyid(void* lpObj);
int secureblackbox_kmipclient_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);

char* secureblackbox_kmipclient_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_kmipclient_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);

int secureblackbox_kmipclient_getexternalcryptomethod(void* lpObj);
int secureblackbox_kmipclient_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);

int secureblackbox_kmipclient_getexternalcryptomode(void* lpObj);
int secureblackbox_kmipclient_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);

char* secureblackbox_kmipclient_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_kmipclient_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);

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

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

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

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

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

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

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

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

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

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

Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).

This property is read-only.

Data Type

SecureBlackboxExternalCrypto

FIPSMode Property (KMIPClient Class)

Reserved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode);

Unicode (Windows)
BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);

int secureblackbox_kmipclient_getfipsmode(void* lpObj);
int secureblackbox_kmipclient_setfipsmode(void* lpObj, int bFIPSMode);

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

Default Value

FALSE

Remarks

This property is reserved for future use.

Data Type

Boolean

InputBytes Property (KMIPClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInputBytes(char* &lpInputBytes, int &lenInputBytes);
int SetInputBytes(const char* lpInputBytes, int lenInputBytes);

Unicode (Windows)
INT GetInputBytes(LPSTR &lpInputBytes, INT &lenInputBytes);
INT SetInputBytes(LPCSTR lpInputBytes, INT lenInputBytes);

int secureblackbox_kmipclient_getinputbytes(void* lpObj, char** lpInputBytes, int* lenInputBytes);
int secureblackbox_kmipclient_setinputbytes(void* lpObj, const char* lpInputBytes, int lenInputBytes);

QByteArray GetInputBytes();
int SetInputBytes(QByteArray qbaInputBytes);

Remarks

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

This property is not available at design time.

Data Type

Byte Array

InputFile Property (KMIPClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile);

Unicode (Windows)
LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);

char* secureblackbox_kmipclient_getinputfile(void* lpObj);
int secureblackbox_kmipclient_setinputfile(void* lpObj, const char* lpszInputFile);

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.

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

Data Type

String

Key Property (KMIPClient Class)

The key to perform the operations on.

Syntax

• C++
• C
• Qt

SecureBlackboxCryptoKey* GetKey();
int SetKey(SecureBlackboxCryptoKey* val);

char* secureblackbox_kmipclient_getkeyalgorithm(void* lpObj);
int secureblackbox_kmipclient_setkeyalgorithm(void* lpObj, const char* lpszKeyAlgorithm);

int secureblackbox_kmipclient_getkeybits(void* lpObj);

int64 secureblackbox_kmipclient_getkeyhandle(void* lpObj);
int secureblackbox_kmipclient_setkeyhandle(void* lpObj, int64 lKeyHandle);

int secureblackbox_kmipclient_getkeysubject(void* lpObj, char** lpKeySubject, int* lenKeySubject);
int secureblackbox_kmipclient_setkeysubject(void* lpObj, const char* lpKeySubject, int lenKeySubject);

QString GetKeyAlgorithm();
int SetKeyAlgorithm(QString qsKeyAlgorithm);

int GetKeyBits();

qint64 GetKeyHandle();
int SetKeyHandle(qint64 lKeyHandle);

QByteArray GetKeySubject();
int SetKeySubject(QByteArray qbaKeySubject);

Remarks

Use this property to provide the key object on which a subsequent operation - such as AddKey - should be performed.

This property is not available at design time.

Data Type

SecureBlackboxCryptoKey

KnownCertificates Property (KMIPClient Class)

Additional certificates for chain validation.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxCertificate>* GetKnownCertificates();
int SetKnownCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);

int secureblackbox_kmipclient_getknowncertcount(void* lpObj);
int secureblackbox_kmipclient_setknowncertcount(void* lpObj, int iKnownCertCount);

int secureblackbox_kmipclient_getknowncertbytes(void* lpObj, int knowncertindex, char** lpKnownCertBytes, int* lenKnownCertBytes);

int64 secureblackbox_kmipclient_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_kmipclient_setknowncerthandle(void* lpObj, int knowncertindex, int64 lKnownCertHandle);

int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);

QByteArray GetKnownCertBytes(int iKnownCertIndex);

qint64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, qint64 lKnownCertHandle);

Remarks

Use this property to supply a list of additional certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when intermediary CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the class manually.

The purpose of the certificates to be added to this collection is roughly equivalent to that of the Intermediate Certification Authorities system store in Windows.

Do not add trust anchors or root certificates to this collection: add them to TrustedCertificates instead.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

KnownCRLs Property (KMIPClient Class)

Additional CRLs for chain validation.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxCRL>* GetKnownCRLs();
int SetKnownCRLs(SecureBlackboxList<SecureBlackboxCRL>* val);

int secureblackbox_kmipclient_getknowncrlcount(void* lpObj);
int secureblackbox_kmipclient_setknowncrlcount(void* lpObj, int iKnownCRLCount);

int secureblackbox_kmipclient_getknowncrlbytes(void* lpObj, int knowncrlindex, char** lpKnownCRLBytes, int* lenKnownCRLBytes);

int64 secureblackbox_kmipclient_getknowncrlhandle(void* lpObj, int knowncrlindex);
int secureblackbox_kmipclient_setknowncrlhandle(void* lpObj, int knowncrlindex, int64 lKnownCRLHandle);

int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount);

QByteArray GetKnownCRLBytes(int iKnownCRLIndex);

qint64 GetKnownCRLHandle(int iKnownCRLIndex);
int SetKnownCRLHandle(int iKnownCRLIndex, qint64 lKnownCRLHandle);

Remarks

Use this property to supply additional CRLs that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated CRLs are stored separately from the signed message or document.

This property is not available at design time.

Data Type

SecureBlackboxCRL

KnownOCSPs Property (KMIPClient Class)

Additional OCSP responses for chain validation.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxOCSPResponse>* GetKnownOCSPs();
int SetKnownOCSPs(SecureBlackboxList<SecureBlackboxOCSPResponse>* val);

int secureblackbox_kmipclient_getknownocspcount(void* lpObj);
int secureblackbox_kmipclient_setknownocspcount(void* lpObj, int iKnownOCSPCount);

int secureblackbox_kmipclient_getknownocspbytes(void* lpObj, int knownocspindex, char** lpKnownOCSPBytes, int* lenKnownOCSPBytes);

int64 secureblackbox_kmipclient_getknownocsphandle(void* lpObj, int knownocspindex);
int secureblackbox_kmipclient_setknownocsphandle(void* lpObj, int knownocspindex, int64 lKnownOCSPHandle);

int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount);

QByteArray GetKnownOCSPBytes(int iKnownOCSPIndex);

qint64 GetKnownOCSPHandle(int iKnownOCSPIndex);
int SetKnownOCSPHandle(int iKnownOCSPIndex, qint64 lKnownOCSPHandle);

Remarks

Use this property to supply additional OCSP responses that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated OCSP responses are stored separately from the signed message or document.

This property is not available at design time.

Data Type

SecureBlackboxOCSPResponse

Objects Property (KMIPClient Class)

A list of objects returned by List .

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxKMIPObject>* GetObjects();

int secureblackbox_kmipclient_getobjectcount(void* lpObj);

int secureblackbox_kmipclient_getobjectbytes(void* lpObj, int objectindex, char** lpObjectBytes, int* lenObjectBytes);

int secureblackbox_kmipclient_getobjectextractable(void* lpObj, int objectindex);

int secureblackbox_kmipclient_getobjectfingerprint(void* lpObj, int objectindex, char** lpObjectFingerprint, int* lenObjectFingerprint);

char* secureblackbox_kmipclient_getobjectkeyalgorithm(void* lpObj, int objectindex);

int secureblackbox_kmipclient_getobjectkeybits(void* lpObj, int objectindex);

int secureblackbox_kmipclient_getobjectkeyusage(void* lpObj, int objectindex);

char* secureblackbox_kmipclient_getobjectobjectgroup(void* lpObj, int objectindex);

char* secureblackbox_kmipclient_getobjectobjectid(void* lpObj, int objectindex);

int secureblackbox_kmipclient_getobjectobjecttype(void* lpObj, int objectindex);

int secureblackbox_kmipclient_getobjectsensitive(void* lpObj, int objectindex);

int secureblackbox_kmipclient_getobjectsize(void* lpObj, int objectindex);

char* secureblackbox_kmipclient_getobjectsubject(void* lpObj, int objectindex);

char* secureblackbox_kmipclient_getobjecttimestamp(void* lpObj, int objectindex);

int GetObjectCount();

QByteArray GetObjectBytes(int iObjectIndex);

bool GetObjectExtractable(int iObjectIndex);

QByteArray GetObjectFingerprint(int iObjectIndex);

QString GetObjectKeyAlgorithm(int iObjectIndex);

int GetObjectKeyBits(int iObjectIndex);

int GetObjectKeyUsage(int iObjectIndex);

QString GetObjectObjectGroup(int iObjectIndex);

QString GetObjectObjectId(int iObjectIndex);

int GetObjectObjectType(int iObjectIndex);

bool GetObjectSensitive(int iObjectIndex);

int GetObjectSize(int iObjectIndex);

QString GetObjectSubject(int iObjectIndex);

QString GetObjectTimestamp(int iObjectIndex);

Remarks

This property provides access to the list of objects returned by List.

All, some, or just the ObjectType property of each object will be populated, depending on the value of the Filter parameter that was passed to the List call.

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

Data Type

SecureBlackboxKMIPObject

OutputBytes Property (KMIPClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutputBytes(char* &lpOutputBytes, int &lenOutputBytes);

Unicode (Windows)
INT GetOutputBytes(LPSTR &lpOutputBytes, INT &lenOutputBytes);

int secureblackbox_kmipclient_getoutputbytes(void* lpObj, char** lpOutputBytes, int* lenOutputBytes);

QByteArray GetOutputBytes();

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 OutputFile and OutputStream properties had not been assigned.

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

Data Type

Byte Array

OutputFile Property (KMIPClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile);

Unicode (Windows)
LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);

char* secureblackbox_kmipclient_getoutputfile(void* lpObj);
int secureblackbox_kmipclient_setoutputfile(void* lpObj, const char* lpszOutputFile);

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.

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

Data Type

String

Password Property (KMIPClient Class)

Specifies a password to authenticate to the KMIP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* secureblackbox_kmipclient_getpassword(void* lpObj);
int secureblackbox_kmipclient_setpassword(void* lpObj, const char* lpszPassword);

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

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 BaseURL property.

Data Type

String

Proxy Property (KMIPClient Class)

The proxy server settings.

Syntax

• C++
• C
• Qt

SecureBlackboxProxySettings* GetProxy();

char* secureblackbox_kmipclient_getproxyaddress(void* lpObj);
int secureblackbox_kmipclient_setproxyaddress(void* lpObj, const char* lpszProxyAddress);

int secureblackbox_kmipclient_getproxyauthentication(void* lpObj);
int secureblackbox_kmipclient_setproxyauthentication(void* lpObj, int iProxyAuthentication);

char* secureblackbox_kmipclient_getproxypassword(void* lpObj);
int secureblackbox_kmipclient_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int secureblackbox_kmipclient_getproxyport(void* lpObj);
int secureblackbox_kmipclient_setproxyport(void* lpObj, int iProxyPort);

int secureblackbox_kmipclient_getproxyproxytype(void* lpObj);
int secureblackbox_kmipclient_setproxyproxytype(void* lpObj, int iProxyProxyType);

char* secureblackbox_kmipclient_getproxyrequestheaders(void* lpObj);
int secureblackbox_kmipclient_setproxyrequestheaders(void* lpObj, const char* lpszProxyRequestHeaders);

char* secureblackbox_kmipclient_getproxyresponsebody(void* lpObj);
int secureblackbox_kmipclient_setproxyresponsebody(void* lpObj, const char* lpszProxyResponseBody);

char* secureblackbox_kmipclient_getproxyresponseheaders(void* lpObj);
int secureblackbox_kmipclient_setproxyresponseheaders(void* lpObj, const char* lpszProxyResponseHeaders);

int secureblackbox_kmipclient_getproxyuseipv6(void* lpObj);
int secureblackbox_kmipclient_setproxyuseipv6(void* lpObj, int bProxyUseIPv6);

char* secureblackbox_kmipclient_getproxyusername(void* lpObj);
int secureblackbox_kmipclient_setproxyusername(void* lpObj, const char* lpszProxyUsername);

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

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

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

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

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

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

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

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

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

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

Remarks

Use this property to tune up the proxy server settings.

This property is read-only.

Data Type

SecureBlackboxProxySettings

SignatureValidationResult Property (KMIPClient Class)

The signature validation result.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignatureValidationResult();

Unicode (Windows)
INT GetSignatureValidationResult();

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

int secureblackbox_kmipclient_getsignaturevalidationresult(void* lpObj);

int GetSignatureValidationResult();

Default Value

0

Remarks

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

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

Data Type

Integer

SocketSettings Property (KMIPClient Class)

Manages network connection settings.

Syntax

• C++
• C
• Qt

SecureBlackboxSocketSettings* GetSocketSettings();

int secureblackbox_kmipclient_getsocketdnsmode(void* lpObj);
int secureblackbox_kmipclient_setsocketdnsmode(void* lpObj, int iSocketDNSMode);

int secureblackbox_kmipclient_getsocketdnsport(void* lpObj);
int secureblackbox_kmipclient_setsocketdnsport(void* lpObj, int iSocketDNSPort);

int secureblackbox_kmipclient_getsocketdnsquerytimeout(void* lpObj);
int secureblackbox_kmipclient_setsocketdnsquerytimeout(void* lpObj, int iSocketDNSQueryTimeout);

char* secureblackbox_kmipclient_getsocketdnsservers(void* lpObj);
int secureblackbox_kmipclient_setsocketdnsservers(void* lpObj, const char* lpszSocketDNSServers);

int secureblackbox_kmipclient_getsocketdnstotaltimeout(void* lpObj);
int secureblackbox_kmipclient_setsocketdnstotaltimeout(void* lpObj, int iSocketDNSTotalTimeout);

int secureblackbox_kmipclient_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_kmipclient_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);

char* secureblackbox_kmipclient_getsocketlocaladdress(void* lpObj);
int secureblackbox_kmipclient_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);

int secureblackbox_kmipclient_getsocketlocalport(void* lpObj);
int secureblackbox_kmipclient_setsocketlocalport(void* lpObj, int iSocketLocalPort);

int secureblackbox_kmipclient_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_kmipclient_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);

int secureblackbox_kmipclient_getsockettimeout(void* lpObj);
int secureblackbox_kmipclient_setsockettimeout(void* lpObj, int iSocketTimeout);

int secureblackbox_kmipclient_getsocketuseipv6(void* lpObj);
int secureblackbox_kmipclient_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);

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

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

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

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

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

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

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

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

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

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

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

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

Data Type

SecureBlackboxSocketSettings

TLSClientChain Property (KMIPClient Class)

The TLS client certificate chain.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxCertificate>* GetTLSClientChain();
int SetTLSClientChain(SecureBlackboxList<SecureBlackboxCertificate>* val);

int secureblackbox_kmipclient_gettlsclientcertcount(void* lpObj);
int secureblackbox_kmipclient_settlsclientcertcount(void* lpObj, int iTLSClientCertCount);

int secureblackbox_kmipclient_gettlsclientcertbytes(void* lpObj, int tlsclientcertindex, char** lpTLSClientCertBytes, int* lenTLSClientCertBytes);

int64 secureblackbox_kmipclient_gettlsclientcerthandle(void* lpObj, int tlsclientcertindex);
int secureblackbox_kmipclient_settlsclientcerthandle(void* lpObj, int tlsclientcertindex, int64 lTLSClientCertHandle);

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

QByteArray GetTLSClientCertBytes(int iTLSClientCertIndex);

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

Remarks

Assign a certificate chain to this property to enable TLS client authentication in the class. Note that the client's end-entity certificate should have a private key associated with it.

Use the CertificateStorage or CertificateManager components to import the certificate from a file, system store, or PKCS11 device.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

TLSServerChain Property (KMIPClient Class)

The TLS server's certificate chain.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxCertificate>* GetTLSServerChain();

int secureblackbox_kmipclient_gettlsservercertcount(void* lpObj);

int secureblackbox_kmipclient_gettlsservercertbytes(void* lpObj, int tlsservercertindex, char** lpTLSServerCertBytes, int* lenTLSServerCertBytes);

char* secureblackbox_kmipclient_gettlsservercertfingerprint(void* lpObj, int tlsservercertindex);

int64 secureblackbox_kmipclient_gettlsservercerthandle(void* lpObj, int tlsservercertindex);

char* secureblackbox_kmipclient_gettlsservercertissuer(void* lpObj, int tlsservercertindex);

char* secureblackbox_kmipclient_gettlsservercertissuerrdn(void* lpObj, int tlsservercertindex);

char* secureblackbox_kmipclient_gettlsservercertkeyalgorithm(void* lpObj, int tlsservercertindex);

int secureblackbox_kmipclient_gettlsservercertkeybits(void* lpObj, int tlsservercertindex);

int secureblackbox_kmipclient_gettlsservercertkeyusage(void* lpObj, int tlsservercertindex);

int secureblackbox_kmipclient_gettlsservercertselfsigned(void* lpObj, int tlsservercertindex);

int secureblackbox_kmipclient_gettlsservercertserialnumber(void* lpObj, int tlsservercertindex, char** lpTLSServerCertSerialNumber, int* lenTLSServerCertSerialNumber);

char* secureblackbox_kmipclient_gettlsservercertsigalgorithm(void* lpObj, int tlsservercertindex);

char* secureblackbox_kmipclient_gettlsservercertsubject(void* lpObj, int tlsservercertindex);

char* secureblackbox_kmipclient_gettlsservercertsubjectrdn(void* lpObj, int tlsservercertindex);

char* secureblackbox_kmipclient_gettlsservercertvalidfrom(void* lpObj, int tlsservercertindex);

char* secureblackbox_kmipclient_gettlsservercertvalidto(void* lpObj, int tlsservercertindex);

int GetTLSServerCertCount();

QByteArray GetTLSServerCertBytes(int iTLSServerCertIndex);

QString GetTLSServerCertFingerprint(int iTLSServerCertIndex);

qint64 GetTLSServerCertHandle(int iTLSServerCertIndex);

QString GetTLSServerCertIssuer(int iTLSServerCertIndex);

QString GetTLSServerCertIssuerRDN(int iTLSServerCertIndex);

QString GetTLSServerCertKeyAlgorithm(int iTLSServerCertIndex);

int GetTLSServerCertKeyBits(int iTLSServerCertIndex);

int GetTLSServerCertKeyUsage(int iTLSServerCertIndex);

bool GetTLSServerCertSelfSigned(int iTLSServerCertIndex);

QByteArray GetTLSServerCertSerialNumber(int iTLSServerCertIndex);

QString GetTLSServerCertSigAlgorithm(int iTLSServerCertIndex);

QString GetTLSServerCertSubject(int iTLSServerCertIndex);

QString GetTLSServerCertSubjectRDN(int iTLSServerCertIndex);

QString GetTLSServerCertValidFrom(int iTLSServerCertIndex);

QString GetTLSServerCertValidTo(int iTLSServerCertIndex);

Remarks

Use this property to access the certificate chain sent by the TLS server. This property is ready to read when the TLSCertValidate event is fired by the client component.

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

Data Type

SecureBlackboxCertificate

TLSSettings Property (KMIPClient Class)

Manages TLS layer settings.

Syntax

• C++
• C
• Qt

SecureBlackboxTLSSettings* GetTLSSettings();

int secureblackbox_kmipclient_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_kmipclient_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);

int secureblackbox_kmipclient_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_kmipclient_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);

char* secureblackbox_kmipclient_gettlsciphersuites(void* lpObj);
int secureblackbox_kmipclient_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);

int secureblackbox_kmipclient_gettlsclientauth(void* lpObj);
int secureblackbox_kmipclient_settlsclientauth(void* lpObj, int iTLSClientAuth);

char* secureblackbox_kmipclient_gettlseccurves(void* lpObj);
int secureblackbox_kmipclient_settlseccurves(void* lpObj, const char* lpszTLSECCurves);

char* secureblackbox_kmipclient_gettlsextensions(void* lpObj);
int secureblackbox_kmipclient_settlsextensions(void* lpObj, const char* lpszTLSExtensions);

int secureblackbox_kmipclient_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_kmipclient_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);

char* secureblackbox_kmipclient_gettlspresharedidentity(void* lpObj);
int secureblackbox_kmipclient_settlspresharedidentity(void* lpObj, const char* lpszTLSPreSharedIdentity);

char* secureblackbox_kmipclient_gettlspresharedkey(void* lpObj);
int secureblackbox_kmipclient_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);

char* secureblackbox_kmipclient_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_kmipclient_settlspresharedkeyciphersuite(void* lpObj, const char* lpszTLSPreSharedKeyCiphersuite);

int secureblackbox_kmipclient_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_kmipclient_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);

int secureblackbox_kmipclient_gettlsrevocationcheck(void* lpObj);
int secureblackbox_kmipclient_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);

int secureblackbox_kmipclient_gettlsssloptions(void* lpObj);
int secureblackbox_kmipclient_settlsssloptions(void* lpObj, int iTLSSSLOptions);

int secureblackbox_kmipclient_gettlstlsmode(void* lpObj);
int secureblackbox_kmipclient_settlstlsmode(void* lpObj, int iTLSTLSMode);

int secureblackbox_kmipclient_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_kmipclient_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);

int secureblackbox_kmipclient_gettlsusesessionresumption(void* lpObj);
int secureblackbox_kmipclient_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);

int secureblackbox_kmipclient_gettlsversions(void* lpObj);
int secureblackbox_kmipclient_settlsversions(void* lpObj, int iTLSVersions);

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

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

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

int GetTLSClientAuth();
int SetTLSClientAuth(int iTLSClientAuth);

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

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

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

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

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

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

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

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

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

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

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

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

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

Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

Data Type

SecureBlackboxTLSSettings

TrustedCertificates Property (KMIPClient Class)

A list of trusted certificates for chain validation.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxCertificate>* GetTrustedCertificates();
int SetTrustedCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);

int secureblackbox_kmipclient_gettrustedcertcount(void* lpObj);
int secureblackbox_kmipclient_settrustedcertcount(void* lpObj, int iTrustedCertCount);

int secureblackbox_kmipclient_gettrustedcertbytes(void* lpObj, int trustedcertindex, char** lpTrustedCertBytes, int* lenTrustedCertBytes);

int64 secureblackbox_kmipclient_gettrustedcerthandle(void* lpObj, int trustedcertindex);
int secureblackbox_kmipclient_settrustedcerthandle(void* lpObj, int trustedcertindex, int64 lTrustedCertHandle);

int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount);

QByteArray GetTrustedCertBytes(int iTrustedCertIndex);

qint64 GetTrustedCertHandle(int iTrustedCertIndex);
int SetTrustedCertHandle(int iTrustedCertIndex, qint64 lTrustedCertHandle);

Remarks

Use this property to supply a list of trusted certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when root CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually.

The purpose of this certificate collection is largely the same as that of the Windows Trusted Root Certification Authorities system store.

Use this property with extreme care as it directly affects chain verifiability; a wrong certificate added to the trusted list may result in bad chains being accepted, and forfeited signatures being recognized as genuine. Only add certificates that originate from the parties that you know and trust.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

Username Property (KMIPClient Class)

The username to authenticate to the KMIP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUsername();
int SetUsername(const char* lpszUsername);

Unicode (Windows)
LPWSTR GetUsername();
INT SetUsername(LPCWSTR lpszUsername);

char* secureblackbox_kmipclient_getusername(void* lpObj);
int secureblackbox_kmipclient_setusername(void* lpObj, const char* lpszUsername);

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

Default Value

""

Remarks

Use this property to provide a username 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 BaseURL property.

Data Type

String

Activate Method (KMIPClient Class)

Activates the specified server object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Activate(const char* lpszObjectId);

Unicode (Windows)
INT Activate(LPCWSTR lpszObjectId);

int secureblackbox_kmipclient_activate(void* lpObj, const char* lpszObjectId);

int Activate(const QString& qsObjectId);

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.

Error Handling (C++)

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

Add Method (KMIPClient Class)

Imports a certificate to the KMIP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Add(int bAddPrivateKey, const char* lpszGroup, int bActivate);

Unicode (Windows)
LPWSTR Add(BOOL bAddPrivateKey, LPCWSTR lpszGroup, BOOL bActivate);

char* secureblackbox_kmipclient_add(void* lpObj, int bAddPrivateKey, const char* lpszGroup, int bActivate);

QString Add(bool bAddPrivateKey, const QString& qsGroup, bool bActivate);

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.

Error Handling (C++)

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 or keypair to the KMIP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* AddKey(const char* lpszGroup, int bActivate);

Unicode (Windows)
LPWSTR AddKey(LPCWSTR lpszGroup, BOOL bActivate);

char* secureblackbox_kmipclient_addkey(void* lpObj, const char* lpszGroup, int bActivate);

QString AddKey(const QString& qsGroup, bool bActivate);

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.

Error Handling (C++)

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.

Config Method (KMIPClient Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* secureblackbox_kmipclient_config(void* lpObj, const char* lpszConfigurationString);

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 (C++)

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.

CustomRequest Method (KMIPClient Class)

Performs a custom request to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CustomRequest(const char* lpData, int lenData, int *lpSize = NULL);

Unicode (Windows)
LPSTR CustomRequest(LPCSTR lpData, INT lenData, LPINT lpSize = NULL);

char* secureblackbox_kmipclient_customrequest(void* lpObj, const char* lpData, int lenData, int *lpSize);

QByteArray CustomRequest(QByteArray qbaData);

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.

Error Handling (C++)

This method returns a Byte Array value (with length lpSize); 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.

Deactivate Method (KMIPClient Class)

Deactivates the specified server object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Deactivate(const char* lpszObjectId);

Unicode (Windows)
INT Deactivate(LPCWSTR lpszObjectId);

int secureblackbox_kmipclient_deactivate(void* lpObj, const char* lpszObjectId);

int Deactivate(const QString& qsObjectId);

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.

Error Handling (C++)

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

Decrypt Method (KMIPClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Decrypt(const char* lpszObjectId, const char* lpszAlgorithm, const char* lpIV, int lenIV, const char* lpszBlockMode, const char* lpszPaddingMethod, int iTagLength);

Unicode (Windows)
INT Decrypt(LPCWSTR lpszObjectId, LPCWSTR lpszAlgorithm, LPCSTR lpIV, INT lenIV, LPCWSTR lpszBlockMode, LPCWSTR lpszPaddingMethod, INT iTagLength);

int secureblackbox_kmipclient_decrypt(void* lpObj, const char* lpszObjectId, const char* lpszAlgorithm, const char* lpIV, int lenIV, const char* lpszBlockMode, const char* lpszPaddingMethod, int iTagLength);

int Decrypt(const QString& qsObjectId, const QString& qsAlgorithm, QByteArray qbaIV, const QString& qsBlockMode, const QString& qsPaddingMethod, int iTagLength);

Remarks

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

Provide the encrypted data via one of the Input* properties (InputFile, InputStream, or InputBytes). 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.

Error Handling (C++)

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);

char* secureblackbox_kmipclient_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);

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 (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:

Error Handling (C++)

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.

Encrypt Method (KMIPClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Encrypt(const char* lpszObjectId, const char* lpszAlgorithm, const char* lpIV, int lenIV, const char* lpszBlockMode, const char* lpszPaddingMethod, int iTagLength);

Unicode (Windows)
INT Encrypt(LPCWSTR lpszObjectId, LPCWSTR lpszAlgorithm, LPCSTR lpIV, INT lenIV, LPCWSTR lpszBlockMode, LPCWSTR lpszPaddingMethod, INT iTagLength);

int secureblackbox_kmipclient_encrypt(void* lpObj, const char* lpszObjectId, const char* lpszAlgorithm, const char* lpIV, int lenIV, const char* lpszBlockMode, const char* lpszPaddingMethod, int iTagLength);

int Encrypt(const QString& qsObjectId, const QString& qsAlgorithm, QByteArray qbaIV, const QString& qsBlockMode, const QString& qsPaddingMethod, int iTagLength);

Remarks

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

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.

Error Handling (C++)

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

Generate Method (KMIPClient Class)

Generates a new certificate on the KMIP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Generate(const char* lpszPublicKeyId, int bActivate);

Unicode (Windows)
LPWSTR Generate(LPCWSTR lpszPublicKeyId, BOOL bActivate);

char* secureblackbox_kmipclient_generate(void* lpObj, const char* lpszPublicKeyId, int bActivate);

QString Generate(const QString& qsPublicKeyId, bool bActivate);

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.

Error Handling (C++)

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.

GenerateKey Method (KMIPClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GenerateKey(const char* lpszKeyAlgorithm, const char* lpszScheme, const char* lpszSchemeParams, int iKeyBits, const char* lpszGroup, int bActivate);

Unicode (Windows)
LPWSTR GenerateKey(LPCWSTR lpszKeyAlgorithm, LPCWSTR lpszScheme, LPCWSTR lpszSchemeParams, INT iKeyBits, LPCWSTR lpszGroup, BOOL bActivate);

char* secureblackbox_kmipclient_generatekey(void* lpObj, const char* lpszKeyAlgorithm, const char* lpszScheme, const char* lpszSchemeParams, int iKeyBits, const char* lpszGroup, int bActivate);

QString GenerateKey(const QString& qsKeyAlgorithm, const QString& qsScheme, const QString& qsSchemeParams, int iKeyBits, const QString& qsGroup, bool bActivate);

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 ReadKey to request it from the server.

Error Handling (C++)

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.

List Method (KMIPClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int List(int iObjectTypes, const char* lpszFilter, int iOffsetItems, int iMaximumItems, int bFreshOnly);

Unicode (Windows)
INT List(INT iObjectTypes, LPCWSTR lpszFilter, INT iOffsetItems, INT iMaximumItems, BOOL bFreshOnly);

int secureblackbox_kmipclient_list(void* lpObj, int iObjectTypes, const char* lpszFilter, int iOffsetItems, int iMaximumItems, int bFreshOnly);

int List(int iObjectTypes, const QString& qsFilter, int iOffsetItems, int iMaximumItems, bool bFreshOnly);

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:

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.

Error Handling (C++)

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

Read Method (KMIPClient Class)

Downloads a certificate from the KMIP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Read(const char* lpszObjectId);

Unicode (Windows)
INT Read(LPCWSTR lpszObjectId);

int secureblackbox_kmipclient_read(void* lpObj, const char* lpszObjectId);

int Read(const QString& qsObjectId);

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.

Error Handling (C++)

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

ReadAttribute Method (KMIPClient Class)

Requests an attribute from an object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* ReadAttribute(const char* lpszObjectId, const char* lpszName);

Unicode (Windows)
LPWSTR ReadAttribute(LPCWSTR lpszObjectId, LPCWSTR lpszName);

char* secureblackbox_kmipclient_readattribute(void* lpObj, const char* lpszObjectId, const char* lpszName);

QString ReadAttribute(const QString& qsObjectId, const QString& qsName);

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

Error Handling (C++)

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.

ReadKey Method (KMIPClient Class)

Downloads a key object from the KMIP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ReadKey(const char* lpszObjectId);

Unicode (Windows)
INT ReadKey(LPCWSTR lpszObjectId);

int secureblackbox_kmipclient_readkey(void* lpObj, const char* lpszObjectId);

int ReadKey(const QString& qsObjectId);

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.

Error Handling (C++)

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

ReadObject Method (KMIPClient Class)

Requests object information from the KMIP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ReadObject(const char* lpszObjectId);

Unicode (Windows)
INT ReadObject(LPCWSTR lpszObjectId);

int secureblackbox_kmipclient_readobject(void* lpObj, const char* lpszObjectId);

int ReadObject(const QString& qsObjectId);

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.

Error Handling (C++)

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

Remove Method (KMIPClient Class)

Removes the specified object from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Remove(const char* lpszObjectId);

Unicode (Windows)
INT Remove(LPCWSTR lpszObjectId);

int secureblackbox_kmipclient_remove(void* lpObj, const char* lpszObjectId);

int Remove(const QString& qsObjectId);

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.

Error Handling (C++)

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

Reset Method (KMIPClient Class)

Resets the class settings.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int secureblackbox_kmipclient_reset(void* lpObj);

int Reset();

Remarks

Reset is a generic method available in every class.

Error Handling (C++)

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

SetAttribute Method (KMIPClient Class)

Sets an attribute of an existing server-side object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetAttribute(const char* lpszObjectId, const char* lpszName, const char* lpszValue, int bDelete);

Unicode (Windows)
INT SetAttribute(LPCWSTR lpszObjectId, LPCWSTR lpszName, LPCWSTR lpszValue, BOOL bDelete);

int secureblackbox_kmipclient_setattribute(void* lpObj, const char* lpszObjectId, const char* lpszName, const char* lpszValue, int bDelete);

int SetAttribute(const QString& qsObjectId, const QString& qsName, const QString& qsValue, bool bDelete);

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.

Error Handling (C++)

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

SetRequestBytes Method (KMIPClient Class)

Replaces the data that has been prepared for sending out.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetRequestBytes(const char* lpValue, int lenValue);

Unicode (Windows)
INT SetRequestBytes(LPCSTR lpValue, INT lenValue);

int secureblackbox_kmipclient_setrequestbytes(void* lpObj, const char* lpValue, int lenValue);

int SetRequestBytes(QByteArray qbaValue);

Remarks

Call this method from your 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.

Error Handling (C++)

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

SetResponseBytes Method (KMIPClient Class)

Alters the data received from the server in a response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetResponseBytes(const char* lpValue, int lenValue);

Unicode (Windows)
INT SetResponseBytes(LPCSTR lpValue, INT lenValue);

int secureblackbox_kmipclient_setresponsebytes(void* lpObj, const char* lpValue, int lenValue);

int SetResponseBytes(QByteArray qbaValue);

Remarks

Call this method from your 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.

Error Handling (C++)

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

Sign Method (KMIPClient Class)

Signs the data using a key on the KMIP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Sign(const char* lpszObjectId, const char* lpszAlgorithm, const char* lpszPaddingMethod, const char* lpszHashAlgorithm, int bInputIsHash);

Unicode (Windows)
INT Sign(LPCWSTR lpszObjectId, LPCWSTR lpszAlgorithm, LPCWSTR lpszPaddingMethod, LPCWSTR lpszHashAlgorithm, BOOL bInputIsHash);

int secureblackbox_kmipclient_sign(void* lpObj, const char* lpszObjectId, const char* lpszAlgorithm, const char* lpszPaddingMethod, const char* lpszHashAlgorithm, int bInputIsHash);

int Sign(const QString& qsObjectId, const QString& qsAlgorithm, const QString& qsPaddingMethod, const QString& qsHashAlgorithm, bool bInputIsHash);

Remarks

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

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.

Error Handling (C++)

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

Verify Method (KMIPClient Class)

Verifies digitally signed data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Verify(const char* lpszObjectId, const char* lpszAlgorithm, const char* lpszPaddingMethod, const char* lpszHashAlgorithm, int bInputIsHash);

Unicode (Windows)
INT Verify(LPCWSTR lpszObjectId, LPCWSTR lpszAlgorithm, LPCWSTR lpszPaddingMethod, LPCWSTR lpszHashAlgorithm, BOOL bInputIsHash);

int secureblackbox_kmipclient_verify(void* lpObj, const char* lpszObjectId, const char* lpszAlgorithm, const char* lpszPaddingMethod, const char* lpszHashAlgorithm, int bInputIsHash);

int Verify(const QString& qsObjectId, const QString& qsAlgorithm, const QString& qsPaddingMethod, const QString& qsHashAlgorithm, bool bInputIsHash);

Remarks

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

Please provide the signature via InputFile (or InputStream / InputBytes) property. For detached signatures, please also provide the data that was signed via DataFile (or DataStream / DataBytes) 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 DataFile or similar property contains the data or its message digest.

Error Handling (C++)

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

Error Event (KMIPClient Class)

Provides information about errors during KMIP operations.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(KMIPClientErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} KMIPClientErrorEventParams;


Unicode (Windows)
virtual INT FireError(KMIPClientErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} KMIPClientErrorEventParams;

#define EID_KMIPCLIENT_ERROR 1

virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

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

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireExternalSign(KMIPClientExternalSignEventParams *e);

typedef struct {
  const char *OperationId;
  const char *HashAlgorithm;
  const char *Pars;
  const char *Data;
  char *SignedData;
  int reserved;
} KMIPClientExternalSignEventParams;


Unicode (Windows)
virtual INT FireExternalSign(KMIPClientExternalSignEventParams *e);

typedef struct {
  LPCWSTR OperationId;
  LPCWSTR HashAlgorithm;
  LPCWSTR Pars;
  LPCWSTR Data;
  LPWSTR SignedData;
  INT reserved;
} KMIPClientExternalSignEventParams;

#define EID_KMIPCLIENT_EXTERNALSIGN 2

virtual INT SECUREBLACKBOX_CALL FireExternalSign(LPSTR &lpszOperationId, LPSTR &lpszHashAlgorithm, LPSTR &lpszPars, LPSTR &lpszData, LPSTR &lpszSignedData);

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

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

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

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

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

Notification Event (KMIPClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireNotification(KMIPClientNotificationEventParams *e);

typedef struct {
  const char *EventID;
  const char *EventParam;
  int reserved;
} KMIPClientNotificationEventParams;


Unicode (Windows)
virtual INT FireNotification(KMIPClientNotificationEventParams *e);

typedef struct {
  LPCWSTR EventID;
  LPCWSTR EventParam;
  INT reserved;
} KMIPClientNotificationEventParams;

#define EID_KMIPCLIENT_NOTIFICATION 3

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);

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 class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

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

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

Request Event (KMIPClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireRequest(KMIPClientRequestEventParams *e);

typedef struct {
  const char *RequestData;
  int lenRequestData;
  int reserved;
} KMIPClientRequestEventParams;


Unicode (Windows)
virtual INT FireRequest(KMIPClientRequestEventParams *e);

typedef struct {
  LPCSTR RequestData;
  INT lenRequestData;
  INT reserved;
} KMIPClientRequestEventParams;

#define EID_KMIPCLIENT_REQUEST 4

virtual INT SECUREBLACKBOX_CALL FireRequest(LPSTR &lpRequestData, INT &lenRequestData);

class KMIPClientRequestEventParams {
public:
  const QByteArray &RequestData();

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

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

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

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 SetRequestBytes method.

Response Event (KMIPClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireResponse(KMIPClientResponseEventParams *e);

typedef struct {
  const char *ResponseData;
  int lenResponseData;
  int reserved;
} KMIPClientResponseEventParams;


Unicode (Windows)
virtual INT FireResponse(KMIPClientResponseEventParams *e);

typedef struct {
  LPCSTR ResponseData;
  INT lenResponseData;
  INT reserved;
} KMIPClientResponseEventParams;

#define EID_KMIPCLIENT_RESPONSE 5

virtual INT SECUREBLACKBOX_CALL FireResponse(LPSTR &lpResponseData, INT &lenResponseData);

class KMIPClientResponseEventParams {
public:
  const QByteArray &ResponseData();

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

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

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

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 SetResponseBytes to alter the response data received before it is processed by the client.

TLSCertNeeded Event (KMIPClient Class)

Fires when a remote TLS party requests a client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTLSCertNeeded(KMIPClientTLSCertNeededEventParams *e);

typedef struct {
  const char *Host;
  const char *CANames;
  int reserved;
} KMIPClientTLSCertNeededEventParams;


Unicode (Windows)
virtual INT FireTLSCertNeeded(KMIPClientTLSCertNeededEventParams *e);

typedef struct {
  LPCWSTR Host;
  LPCWSTR CANames;
  INT reserved;
} KMIPClientTLSCertNeededEventParams;

#define EID_KMIPCLIENT_TLSCERTNEEDED 6

virtual INT SECUREBLACKBOX_CALL FireTLSCertNeeded(LPSTR &lpszHost, LPSTR &lpszCANames);

class KMIPClientTLSCertNeededEventParams {
public:
  const QString &Host();

  const QString &CANames();

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

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

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

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 TLSClientChain 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 TLSHandshake event for the given host and, if the certificate was accepted, succeeded by the TLSEstablished event.

TLSCertValidate Event (KMIPClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTLSCertValidate(KMIPClientTLSCertValidateEventParams *e);

typedef struct {
  const char *ServerHost;
  const char *ServerIP;
  int Accept;
  int reserved;
} KMIPClientTLSCertValidateEventParams;


Unicode (Windows)
virtual INT FireTLSCertValidate(KMIPClientTLSCertValidateEventParams *e);

typedef struct {
  LPCWSTR ServerHost;
  LPCWSTR ServerIP;
  BOOL Accept;
  INT reserved;
} KMIPClientTLSCertValidateEventParams;

#define EID_KMIPCLIENT_TLSCERTVALIDATE 7

virtual INT SECUREBLACKBOX_CALL FireTLSCertValidate(LPSTR &lpszServerHost, LPSTR &lpszServerIP, BOOL &bAccept);

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

  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 the TLSServerChain property to access the certificate chain. In general, classes 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 class, and can be adjusted if needed.

TLSEstablished Event (KMIPClient Class)

Fires when a TLS handshake with Host successfully completes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTLSEstablished(KMIPClientTLSEstablishedEventParams *e);

typedef struct {
  const char *Host;
  const char *Version;
  const char *Ciphersuite;
  const char *ConnectionId;
  int lenConnectionId;
  int Abort;
  int reserved;
} KMIPClientTLSEstablishedEventParams;


Unicode (Windows)
virtual INT FireTLSEstablished(KMIPClientTLSEstablishedEventParams *e);

typedef struct {
  LPCWSTR Host;
  LPCWSTR Version;
  LPCWSTR Ciphersuite;
  LPCSTR ConnectionId;
  INT lenConnectionId;
  BOOL Abort;
  INT reserved;
} KMIPClientTLSEstablishedEventParams;

#define EID_KMIPCLIENT_TLSESTABLISHED 8

virtual INT SECUREBLACKBOX_CALL FireTLSEstablished(LPSTR &lpszHost, LPSTR &lpszVersion, LPSTR &lpszCiphersuite, LPSTR &lpConnectionId, INT &lenConnectionId, BOOL &bAbort);

class KMIPClientTLSEstablishedEventParams {
public:
  const QString &Host();

  const QString &Version();

  const QString &Ciphersuite();

  const QByteArray &ConnectionId();

  bool Abort();
  void SetAbort(bool bAbort);

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

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

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

Remarks

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

TLSHandshake Event (KMIPClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTLSHandshake(KMIPClientTLSHandshakeEventParams *e);

typedef struct {
  const char *Host;
  int Abort;
  int reserved;
} KMIPClientTLSHandshakeEventParams;


Unicode (Windows)
virtual INT FireTLSHandshake(KMIPClientTLSHandshakeEventParams *e);

typedef struct {
  LPCWSTR Host;
  BOOL Abort;
  INT reserved;
} KMIPClientTLSHandshakeEventParams;

#define EID_KMIPCLIENT_TLSHANDSHAKE 9

virtual INT SECUREBLACKBOX_CALL FireTLSHandshake(LPSTR &lpszHost, BOOL &bAbort);

class KMIPClientTLSHandshakeEventParams {
public:
  const QString &Host();

  bool Abort();
  void SetAbort(bool bAbort);

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

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

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

Remarks

The class 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 TLSEstablished event. If the server chooses to request a client certificate, the TLSCertNeeded event will also be fired.

TLSPSK Event (KMIPClient Class)

Notifies the application about the PSK key exchange.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTLSPSK(KMIPClientTLSPSKEventParams *e);

typedef struct {
  const char *Host;
  const char *Hint;
  int reserved;
} KMIPClientTLSPSKEventParams;


Unicode (Windows)
virtual INT FireTLSPSK(KMIPClientTLSPSKEventParams *e);

typedef struct {
  LPCWSTR Host;
  LPCWSTR Hint;
  INT reserved;
} KMIPClientTLSPSKEventParams;

#define EID_KMIPCLIENT_TLSPSK 10

virtual INT SECUREBLACKBOX_CALL FireTLSPSK(LPSTR &lpszHost, LPSTR &lpszHint);

class KMIPClientTLSPSKEventParams {
public:
  const QString &Host();

  const QString &Hint();

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

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

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

Remarks

The class 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 TLSSettings to provide the pre-shared key to the component.

TLSShutdown Event (KMIPClient Class)

Reports the graceful closure of a TLS connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTLSShutdown(KMIPClientTLSShutdownEventParams *e);

typedef struct {
  const char *Host;
  int reserved;
} KMIPClientTLSShutdownEventParams;


Unicode (Windows)
virtual INT FireTLSShutdown(KMIPClientTLSShutdownEventParams *e);

typedef struct {
  LPCWSTR Host;
  INT reserved;
} KMIPClientTLSShutdownEventParams;

#define EID_KMIPCLIENT_TLSSHUTDOWN 11

virtual INT SECUREBLACKBOX_CALL FireTLSShutdown(LPSTR &lpszHost);

class KMIPClientTLSShutdownEventParams {
public:
  const QString &Host();

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

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

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

Remarks

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

Certificate Type

Encapsulates an individual X.509 certificate.

Syntax

SecureBlackboxCertificate (declared in secureblackbox.h)

Remarks

This type keeps and provides access to X.509 certificate details.

Fields

Constructors

Certificate()

CRL Type

Represents a Certificate Revocation List.

Syntax

SecureBlackboxCRL (declared in secureblackbox.h)

Remarks

CRLs store information about revoked certificates, i.e., certificates that have been identified as invalid by their issuing certificate authority (CA) for any number of reasons.

Each CRL object lists certificates from a single CA and identifies them by their serial numbers. A CA may or may not publish a CRL, may publish several CRLs, or may publish the same CRL in multiple locations.

Unlike OCSP responses, CRLs only list certificates that have been revoked. They do not list certificates that are still valid.

Fields

Constructors

CRL()

CryptoKey Type

This container represents a cryptographic key.

Syntax

SecureBlackboxCryptoKey (declared in secureblackbox.h)

Remarks

This type is a universal placeholder for cryptographic keys.

Fields

Constructors

CryptoKey()

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Syntax

SecureBlackboxExternalCrypto (declared in secureblackbox.h)

Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

Fields