KMIPServer Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

KMIPServer

Remarks

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

Property List

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

Method List

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

Event List

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

Config Settings

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

Active Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetActive();

Unicode (Windows)
BOOL GetActive();

int secureblackbox_kmipserver_getactive(void* lpObj);

bool GetActive();

Default Value

FALSE

Remarks

Check this property to find out if the KMIP server is in an active state.

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

Data Type

Boolean

CACertBytes Property (KMIPServer Class)

Returns raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCACertBytes(char* &lpCACertBytes, int &lenCACertBytes);

Unicode (Windows)
INT GetCACertBytes(LPSTR &lpCACertBytes, INT &lenCACertBytes);

int secureblackbox_kmipserver_getcacertbytes(void* lpObj, char** lpCACertBytes, int* lenCACertBytes);

QByteArray GetCACertBytes();

Remarks

Returns raw certificate data in DER format.

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

Data Type

Byte Array

CACertHandle Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetCACertHandle();
int SetCACertHandle(int64 lCACertHandle);

Unicode (Windows)
LONG64 GetCACertHandle();
INT SetCACertHandle(LONG64 lCACertHandle);

int64 secureblackbox_kmipserver_getcacerthandle(void* lpObj);
int secureblackbox_kmipserver_setcacerthandle(void* lpObj, int64 lCACertHandle);

qint64 GetCACertHandle();
int SetCACertHandle(qint64 lCACertHandle);

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Long64

CertRequestBytes Property (KMIPServer Class)

Provides access to raw certificate request data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertRequestBytes(char* &lpCertRequestBytes, int &lenCertRequestBytes);

Unicode (Windows)
INT GetCertRequestBytes(LPSTR &lpCertRequestBytes, INT &lenCertRequestBytes);

int secureblackbox_kmipserver_getcertrequestbytes(void* lpObj, char** lpCertRequestBytes, int* lenCertRequestBytes);

QByteArray GetCertRequestBytes();

Remarks

Provides access to raw certificate request data in DER format.

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

Data Type

Byte Array

CertRequestCurve Property (KMIPServer Class)

Specifies the elliptic curve of the EC public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertRequestCurve();

Unicode (Windows)
LPWSTR GetCertRequestCurve();

char* secureblackbox_kmipserver_getcertrequestcurve(void* lpObj);

QString GetCertRequestCurve();

Default Value

""

Remarks

Specifies the elliptic curve of the EC public key.

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

Data Type

String

CertRequestHandle Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetCertRequestHandle();

Unicode (Windows)
LONG64 GetCertRequestHandle();

int64 secureblackbox_kmipserver_getcertrequesthandle(void* lpObj);

qint64 GetCertRequestHandle();

Default Value

0

Remarks

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

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

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

Data Type

Long64

CertRequestHashAlgorithm Property (KMIPServer Class)

Specifies the hash algorithm to be used in the operations on the certificate request (such as signing).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertRequestHashAlgorithm();

Unicode (Windows)
LPWSTR GetCertRequestHashAlgorithm();

char* secureblackbox_kmipserver_getcertrequesthashalgorithm(void* lpObj);

QString GetCertRequestHashAlgorithm();

Default Value

""

Remarks

Specifies the hash algorithm to be used in the operations on the certificate request (such as signing).

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

Data Type

String

CertRequestKeyAlgorithm Property (KMIPServer Class)

Specifies the public key algorithm of this certificate request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertRequestKeyAlgorithm();

Unicode (Windows)
LPWSTR GetCertRequestKeyAlgorithm();

char* secureblackbox_kmipserver_getcertrequestkeyalgorithm(void* lpObj);

QString GetCertRequestKeyAlgorithm();

Default Value

""

Remarks

Specifies the public key algorithm of this certificate request.

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

Data Type

String

CertRequestKeyBits Property (KMIPServer Class)

Returns the length of the public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertRequestKeyBits();

Unicode (Windows)
INT GetCertRequestKeyBits();

int secureblackbox_kmipserver_getcertrequestkeybits(void* lpObj);

int GetCertRequestKeyBits();

Default Value

0

Remarks

Returns the length of the public key.

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

Data Type

Integer

CertRequestKeyUsage Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertRequestKeyUsage();

Unicode (Windows)
INT GetCertRequestKeyUsage();

int secureblackbox_kmipserver_getcertrequestkeyusage(void* lpObj);

int GetCertRequestKeyUsage();

Default Value

0

Remarks

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

This value is a bit mask of the following values:

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

Data Type

Integer

CertRequestKeyValid Property (KMIPServer Class)

Returns True if the certificate's key is cryptographically valid, and False otherwise.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertRequestKeyValid();

Unicode (Windows)
BOOL GetCertRequestKeyValid();

int secureblackbox_kmipserver_getcertrequestkeyvalid(void* lpObj);

bool GetCertRequestKeyValid();

Default Value

FALSE

Remarks

Returns True if the certificate's key is cryptographically valid, and False otherwise.

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

Data Type

Boolean

CertRequestPrivateKeyBytes Property (KMIPServer Class)

Contains the certificate's private key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertRequestPrivateKeyBytes(char* &lpCertRequestPrivateKeyBytes, int &lenCertRequestPrivateKeyBytes);

Unicode (Windows)
INT GetCertRequestPrivateKeyBytes(LPSTR &lpCertRequestPrivateKeyBytes, INT &lenCertRequestPrivateKeyBytes);

int secureblackbox_kmipserver_getcertrequestprivatekeybytes(void* lpObj, char** lpCertRequestPrivateKeyBytes, int* lenCertRequestPrivateKeyBytes);

QByteArray GetCertRequestPrivateKeyBytes();

Remarks

Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.

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

Data Type

Byte Array

CertRequestPublicKeyBytes Property (KMIPServer Class)

Contains the public key incorporated in the request, in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertRequestPublicKeyBytes(char* &lpCertRequestPublicKeyBytes, int &lenCertRequestPublicKeyBytes);

Unicode (Windows)
INT GetCertRequestPublicKeyBytes(LPSTR &lpCertRequestPublicKeyBytes, INT &lenCertRequestPublicKeyBytes);

int secureblackbox_kmipserver_getcertrequestpublickeybytes(void* lpObj, char** lpCertRequestPublicKeyBytes, int* lenCertRequestPublicKeyBytes);

QByteArray GetCertRequestPublicKeyBytes();

Remarks

Contains the public key incorporated in the request, in DER format.

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

Data Type

Byte Array

CertRequestSigAlgorithm Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertRequestSigAlgorithm();

Unicode (Windows)
LPWSTR GetCertRequestSigAlgorithm();

char* secureblackbox_kmipserver_getcertrequestsigalgorithm(void* lpObj);

QString GetCertRequestSigAlgorithm();

Default Value

""

Remarks

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

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

Data Type

String

CertRequestSubject Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertRequestSubject();

Unicode (Windows)
LPWSTR GetCertRequestSubject();

char* secureblackbox_kmipserver_getcertrequestsubject(void* lpObj);

QString GetCertRequestSubject();

Default Value

""

Remarks

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

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

Data Type

String

CertRequestSubjectRDN Property (KMIPServer Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertRequestSubjectRDN();

Unicode (Windows)
LPWSTR GetCertRequestSubjectRDN();

char* secureblackbox_kmipserver_getcertrequestsubjectrdn(void* lpObj);

QString GetCertRequestSubjectRDN();

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

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

Data Type

String

CertRequestValid Property (KMIPServer Class)

Indicates whether or not the signature on the request is valid and matches the public key contained in the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertRequestValid();

Unicode (Windows)
BOOL GetCertRequestValid();

int secureblackbox_kmipserver_getcertrequestvalid(void* lpObj);

bool GetCertRequestValid();

Default Value

FALSE

Remarks

Indicates whether or not the signature on the request is valid and matches the public key contained in the request.

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

Data Type

Boolean

CertStorageCount Property (KMIPServer Class)

The number of records in the CertStorage arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertStorageCount();
int SetCertStorageCount(int iCertStorageCount);

Unicode (Windows)
INT GetCertStorageCount();
INT SetCertStorageCount(INT iCertStorageCount);

int secureblackbox_kmipserver_getcertstoragecount(void* lpObj);
int secureblackbox_kmipserver_setcertstoragecount(void* lpObj, int iCertStorageCount);

int GetCertStorageCount();
int SetCertStorageCount(int iCertStorageCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• CertStorageBytes
• CertStorageHandle

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

This property is not available at design time.

Data Type

Integer

CertStorageBytes Property (KMIPServer Class)

Returns raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertStorageBytes(int iCertStorageIndex, char* &lpCertStorageBytes, int &lenCertStorageBytes);

Unicode (Windows)
INT GetCertStorageBytes(INT iCertStorageIndex, LPSTR &lpCertStorageBytes, INT &lenCertStorageBytes);

int secureblackbox_kmipserver_getcertstoragebytes(void* lpObj, int certstorageindex, char** lpCertStorageBytes, int* lenCertStorageBytes);

QByteArray GetCertStorageBytes(int iCertStorageIndex);

Remarks

Returns raw certificate data in DER format.

The CertStorageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertStorageCount property.

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

Data Type

Byte Array

CertStorageHandle Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetCertStorageHandle(int iCertStorageIndex);
int SetCertStorageHandle(int iCertStorageIndex, int64 lCertStorageHandle);

Unicode (Windows)
LONG64 GetCertStorageHandle(INT iCertStorageIndex);
INT SetCertStorageHandle(INT iCertStorageIndex, LONG64 lCertStorageHandle);

int64 secureblackbox_kmipserver_getcertstoragehandle(void* lpObj, int certstorageindex);
int secureblackbox_kmipserver_setcertstoragehandle(void* lpObj, int certstorageindex, int64 lCertStorageHandle);

qint64 GetCertStorageHandle(int iCertStorageIndex);
int SetCertStorageHandle(int iCertStorageIndex, qint64 lCertStorageHandle);

Default Value

0

Remarks

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

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

The CertStorageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertStorageCount property.

This property is not available at design time.

Data Type

Long64

EncoderType Property (KMIPServer Class)

Specifies the KMIP encoder type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncoderType();
int SetEncoderType(int iEncoderType);

Unicode (Windows)
INT GetEncoderType();
INT SetEncoderType(INT iEncoderType);

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

int secureblackbox_kmipserver_getencodertype(void* lpObj);
int secureblackbox_kmipserver_setencodertype(void* lpObj, int iEncoderType);

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

Default Value

0

Remarks

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

Data Type

Integer

ExternalCryptoAsyncDocumentID Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(const char* lpszExternalCryptoAsyncDocumentID);

Unicode (Windows)
LPWSTR GetExternalCryptoAsyncDocumentID();
INT SetExternalCryptoAsyncDocumentID(LPCWSTR lpszExternalCryptoAsyncDocumentID);

char* secureblackbox_kmipserver_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_kmipserver_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);

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

Default Value

""

Remarks

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

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

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

Data Type

String

ExternalCryptoCustomParams Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(const char* lpszExternalCryptoCustomParams);

Unicode (Windows)
LPWSTR GetExternalCryptoCustomParams();
INT SetExternalCryptoCustomParams(LPCWSTR lpszExternalCryptoCustomParams);

char* secureblackbox_kmipserver_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_kmipserver_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);

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

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoData();
int SetExternalCryptoData(const char* lpszExternalCryptoData);

Unicode (Windows)
LPWSTR GetExternalCryptoData();
INT SetExternalCryptoData(LPCWSTR lpszExternalCryptoData);

char* secureblackbox_kmipserver_getexternalcryptodata(void* lpObj);
int secureblackbox_kmipserver_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);

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

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(int bExternalCryptoExternalHashCalculation);

Unicode (Windows)
BOOL GetExternalCryptoExternalHashCalculation();
INT SetExternalCryptoExternalHashCalculation(BOOL bExternalCryptoExternalHashCalculation);

int secureblackbox_kmipserver_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_kmipserver_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);

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

Default Value

FALSE

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (KMIPServer Class)

Specifies the request's signature hash algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(const char* lpszExternalCryptoHashAlgorithm);

Unicode (Windows)
LPWSTR GetExternalCryptoHashAlgorithm();
INT SetExternalCryptoHashAlgorithm(LPCWSTR lpszExternalCryptoHashAlgorithm);

char* secureblackbox_kmipserver_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_kmipserver_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);

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

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(const char* lpszExternalCryptoKeyID);

Unicode (Windows)
LPWSTR GetExternalCryptoKeyID();
INT SetExternalCryptoKeyID(LPCWSTR lpszExternalCryptoKeyID);

char* secureblackbox_kmipserver_getexternalcryptokeyid(void* lpObj);
int secureblackbox_kmipserver_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);

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

Default Value

""

Remarks

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

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

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

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

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

Data Type

String

ExternalCryptoKeySecret Property (KMIPServer Class)

The pre-shared key used for DC request authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(const char* lpszExternalCryptoKeySecret);

Unicode (Windows)
LPWSTR GetExternalCryptoKeySecret();
INT SetExternalCryptoKeySecret(LPCWSTR lpszExternalCryptoKeySecret);

char* secureblackbox_kmipserver_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_kmipserver_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);

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

Default Value

""

Remarks

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

Read more about configuring authentication in the ExternalCryptoKeyID topic.

Data Type

String

ExternalCryptoMethod Property (KMIPServer Class)

Specifies the asynchronous signing method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);

Unicode (Windows)
INT GetExternalCryptoMethod();
INT SetExternalCryptoMethod(INT iExternalCryptoMethod);

ASMD_PKCS1(0), 
ASMD_PKCS7(1)

int secureblackbox_kmipserver_getexternalcryptomethod(void* lpObj);
int secureblackbox_kmipserver_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);

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

Default Value

0

Remarks

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

Available options:

Data Type

Integer

ExternalCryptoMode Property (KMIPServer Class)

Specifies the external cryptography mode.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);

Unicode (Windows)
INT GetExternalCryptoMode();
INT SetExternalCryptoMode(INT iExternalCryptoMode);

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

int secureblackbox_kmipserver_getexternalcryptomode(void* lpObj);
int secureblackbox_kmipserver_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);

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

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(const char* lpszExternalCryptoPublicKeyAlgorithm);

Unicode (Windows)
LPWSTR GetExternalCryptoPublicKeyAlgorithm();
INT SetExternalCryptoPublicKeyAlgorithm(LPCWSTR lpszExternalCryptoPublicKeyAlgorithm);

char* secureblackbox_kmipserver_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_kmipserver_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);

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

Default Value

""

Remarks

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

Data Type

String

FIPSMode Property (KMIPServer 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_kmipserver_getfipsmode(void* lpObj);
int secureblackbox_kmipserver_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

GeneratedCertBytes Property (KMIPServer Class)

Returns raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetGeneratedCertBytes(char* &lpGeneratedCertBytes, int &lenGeneratedCertBytes);

Unicode (Windows)
INT GetGeneratedCertBytes(LPSTR &lpGeneratedCertBytes, INT &lenGeneratedCertBytes);

int secureblackbox_kmipserver_getgeneratedcertbytes(void* lpObj, char** lpGeneratedCertBytes, int* lenGeneratedCertBytes);

QByteArray GetGeneratedCertBytes();

Remarks

Returns raw certificate data in DER format.

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

Data Type

Byte Array

GeneratedCertHandle Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetGeneratedCertHandle();
int SetGeneratedCertHandle(int64 lGeneratedCertHandle);

Unicode (Windows)
LONG64 GetGeneratedCertHandle();
INT SetGeneratedCertHandle(LONG64 lGeneratedCertHandle);

int64 secureblackbox_kmipserver_getgeneratedcerthandle(void* lpObj);
int secureblackbox_kmipserver_setgeneratedcerthandle(void* lpObj, int64 lGeneratedCertHandle);

qint64 GetGeneratedCertHandle();
int SetGeneratedCertHandle(qint64 lGeneratedCertHandle);

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Long64

Port Property (KMIPServer Class)

A port to listen for connections on.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPort();
int SetPort(int iPort);

Unicode (Windows)
INT GetPort();
INT SetPort(INT iPort);

int secureblackbox_kmipserver_getport(void* lpObj);
int secureblackbox_kmipserver_setport(void* lpObj, int iPort);

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

Default Value

5696

Remarks

Use this property to specify the listening port.

Data Type

Integer

SocketIncomingSpeedLimit Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit);

Unicode (Windows)
INT GetSocketIncomingSpeedLimit();
INT SetSocketIncomingSpeedLimit(INT iSocketIncomingSpeedLimit);

int secureblackbox_kmipserver_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_kmipserver_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);

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

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (KMIPServer Class)

The local network interface to bind the socket to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSocketLocalAddress();
int SetSocketLocalAddress(const char* lpszSocketLocalAddress);

Unicode (Windows)
LPWSTR GetSocketLocalAddress();
INT SetSocketLocalAddress(LPCWSTR lpszSocketLocalAddress);

char* secureblackbox_kmipserver_getsocketlocaladdress(void* lpObj);
int secureblackbox_kmipserver_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);

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

Default Value

""

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (KMIPServer Class)

The local port number to bind the socket to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort);

Unicode (Windows)
INT GetSocketLocalPort();
INT SetSocketLocalPort(INT iSocketLocalPort);

int secureblackbox_kmipserver_getsocketlocalport(void* lpObj);
int secureblackbox_kmipserver_setsocketlocalport(void* lpObj, int iSocketLocalPort);

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

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit);

Unicode (Windows)
INT GetSocketOutgoingSpeedLimit();
INT SetSocketOutgoingSpeedLimit(INT iSocketOutgoingSpeedLimit);

int secureblackbox_kmipserver_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_kmipserver_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);

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

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout);

Unicode (Windows)
INT GetSocketTimeout();
INT SetSocketTimeout(INT iSocketTimeout);

int secureblackbox_kmipserver_getsockettimeout(void* lpObj);
int secureblackbox_kmipserver_setsockettimeout(void* lpObj, int iSocketTimeout);

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

Default Value

60000

Remarks

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

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

Data Type

Integer

SocketUseIPv6 Property (KMIPServer Class)

Enables or disables IP protocol version 6.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketUseIPv6();
int SetSocketUseIPv6(int bSocketUseIPv6);

Unicode (Windows)
BOOL GetSocketUseIPv6();
INT SetSocketUseIPv6(BOOL bSocketUseIPv6);

int secureblackbox_kmipserver_getsocketuseipv6(void* lpObj);
int secureblackbox_kmipserver_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);

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

Default Value

FALSE

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

StorageFileName Property (KMIPServer Class)

A path to the KMIP object database.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetStorageFileName();
int SetStorageFileName(const char* lpszStorageFileName);

Unicode (Windows)
LPWSTR GetStorageFileName();
INT SetStorageFileName(LPCWSTR lpszStorageFileName);

char* secureblackbox_kmipserver_getstoragefilename(void* lpObj);
int secureblackbox_kmipserver_setstoragefilename(void* lpObj, const char* lpszStorageFileName);

QString GetStorageFileName();
int SetStorageFileName(QString qsStorageFileName);

Default Value

""

Remarks

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

Data Type

String

TLSAutoValidateCertificates Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(int bTLSAutoValidateCertificates);

Unicode (Windows)
BOOL GetTLSAutoValidateCertificates();
INT SetTLSAutoValidateCertificates(BOOL bTLSAutoValidateCertificates);

int secureblackbox_kmipserver_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_kmipserver_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);

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

Default Value

TRUE

Remarks

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

Data Type

Boolean

TLSBaseConfiguration Property (KMIPServer Class)

Selects the base configuration for the TLS settings.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration);

Unicode (Windows)
INT GetTLSBaseConfiguration();
INT SetTLSBaseConfiguration(INT iTLSBaseConfiguration);

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

int secureblackbox_kmipserver_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_kmipserver_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);

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

Default Value

0

Remarks

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

Data Type

Integer

TLSCiphersuites Property (KMIPServer Class)

A list of ciphersuites separated with commas or semicolons.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTLSCiphersuites();
int SetTLSCiphersuites(const char* lpszTLSCiphersuites);

Unicode (Windows)
LPWSTR GetTLSCiphersuites();
INT SetTLSCiphersuites(LPCWSTR lpszTLSCiphersuites);

char* secureblackbox_kmipserver_gettlsciphersuites(void* lpObj);
int secureblackbox_kmipserver_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);

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

Default Value

""

Remarks

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

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

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

Data Type

String

TLSECCurves Property (KMIPServer Class)

Defines the elliptic curves to enable.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTLSECCurves();
int SetTLSECCurves(const char* lpszTLSECCurves);

Unicode (Windows)
LPWSTR GetTLSECCurves();
INT SetTLSECCurves(LPCWSTR lpszTLSECCurves);

char* secureblackbox_kmipserver_gettlseccurves(void* lpObj);
int secureblackbox_kmipserver_settlseccurves(void* lpObj, const char* lpszTLSECCurves);

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

Default Value

""

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (KMIPServer Class)

Provides access to TLS extensions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTLSExtensions();
int SetTLSExtensions(const char* lpszTLSExtensions);

Unicode (Windows)
LPWSTR GetTLSExtensions();
INT SetTLSExtensions(LPCWSTR lpszTLSExtensions);

char* secureblackbox_kmipserver_gettlsextensions(void* lpObj);
int secureblackbox_kmipserver_settlsextensions(void* lpObj, const char* lpszTLSExtensions);

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

Default Value

""

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(int bTLSForceResumeIfDestinationChanges);

Unicode (Windows)
BOOL GetTLSForceResumeIfDestinationChanges();
INT SetTLSForceResumeIfDestinationChanges(BOOL bTLSForceResumeIfDestinationChanges);

int secureblackbox_kmipserver_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_kmipserver_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);

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

Default Value

FALSE

Remarks

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

Data Type

Boolean

TLSPreSharedIdentity Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(const char* lpszTLSPreSharedIdentity);

Unicode (Windows)
LPWSTR GetTLSPreSharedIdentity();
INT SetTLSPreSharedIdentity(LPCWSTR lpszTLSPreSharedIdentity);

char* secureblackbox_kmipserver_gettlspresharedidentity(void* lpObj);
int secureblackbox_kmipserver_settlspresharedidentity(void* lpObj, const char* lpszTLSPreSharedIdentity);

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

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

TLSPreSharedKey Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTLSPreSharedKey();
int SetTLSPreSharedKey(const char* lpszTLSPreSharedKey);

Unicode (Windows)
LPWSTR GetTLSPreSharedKey();
INT SetTLSPreSharedKey(LPCWSTR lpszTLSPreSharedKey);

char* secureblackbox_kmipserver_gettlspresharedkey(void* lpObj);
int secureblackbox_kmipserver_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);

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

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

TLSPreSharedKeyCiphersuite Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(const char* lpszTLSPreSharedKeyCiphersuite);

Unicode (Windows)
LPWSTR GetTLSPreSharedKeyCiphersuite();
INT SetTLSPreSharedKeyCiphersuite(LPCWSTR lpszTLSPreSharedKeyCiphersuite);

char* secureblackbox_kmipserver_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_kmipserver_settlspresharedkeyciphersuite(void* lpObj, const char* lpszTLSPreSharedKeyCiphersuite);

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

Default Value

""

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (KMIPServer Class)

Selects renegotiation attack prevention mechanism.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode);

Unicode (Windows)
INT GetTLSRenegotiationAttackPreventionMode();
INT SetTLSRenegotiationAttackPreventionMode(INT iTLSRenegotiationAttackPreventionMode);

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

int secureblackbox_kmipserver_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_kmipserver_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);

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

Default Value

0

Remarks

Selects renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck);

Unicode (Windows)
INT GetTLSRevocationCheck();
INT SetTLSRevocationCheck(INT iTLSRevocationCheck);

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

int secureblackbox_kmipserver_gettlsrevocationcheck(void* lpObj);
int secureblackbox_kmipserver_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);

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

Default Value

1

Remarks

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

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

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

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

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

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions);

Unicode (Windows)
INT GetTLSSSLOptions();
INT SetTLSSSLOptions(INT iTLSSSLOptions);

int secureblackbox_kmipserver_gettlsssloptions(void* lpObj);
int secureblackbox_kmipserver_settlsssloptions(void* lpObj, int iTLSSSLOptions);

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

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (KMIPServer Class)

Specifies the TLS mode to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode);

Unicode (Windows)
INT GetTLSTLSMode();
INT SetTLSTLSMode(INT iTLSTLSMode);

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

int secureblackbox_kmipserver_gettlstlsmode(void* lpObj);
int secureblackbox_kmipserver_settlstlsmode(void* lpObj, int iTLSTLSMode);

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

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(int bTLSUseExtendedMasterSecret);

Unicode (Windows)
BOOL GetTLSUseExtendedMasterSecret();
INT SetTLSUseExtendedMasterSecret(BOOL bTLSUseExtendedMasterSecret);

int secureblackbox_kmipserver_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_kmipserver_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);

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

Default Value

FALSE

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (KMIPServer Class)

Enables or disables TLS session resumption capability.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(int bTLSUseSessionResumption);

Unicode (Windows)
BOOL GetTLSUseSessionResumption();
INT SetTLSUseSessionResumption(BOOL bTLSUseSessionResumption);

int secureblackbox_kmipserver_gettlsusesessionresumption(void* lpObj);
int secureblackbox_kmipserver_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);

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

Default Value

FALSE

Remarks

Enables or disables TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (KMIPServer Class)

The SSL/TLS versions to enable by default.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);

Unicode (Windows)
INT GetTLSVersions();
INT SetTLSVersions(INT iTLSVersions);

int secureblackbox_kmipserver_gettlsversions(void* lpObj);
int secureblackbox_kmipserver_settlsversions(void* lpObj, int iTLSVersions);

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

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

UserCount Property (KMIPServer Class)

The number of records in the User arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserCount();
int SetUserCount(int iUserCount);

Unicode (Windows)
INT GetUserCount();
INT SetUserCount(INT iUserCount);

int secureblackbox_kmipserver_getusercount(void* lpObj);
int secureblackbox_kmipserver_setusercount(void* lpObj, int iUserCount);

int GetUserCount();
int SetUserCount(int iUserCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• UserAssociatedData
• UserBasePath
• UserCert
• UserData
• UserHandle
• UserHashAlgorithm
• UserIncomingSpeedLimit
• UserOtpAlgorithm
• UserOtpValue
• UserOutgoingSpeedLimit
• UserPassword
• UserPasswordLen
• UserSharedSecret
• UserSSHKey
• UserUsername

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

This property is not available at design time.

Data Type

Integer

UserAssociatedData Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserAssociatedData(int iUserIndex, char* &lpUserAssociatedData, int &lenUserAssociatedData);
int SetUserAssociatedData(int iUserIndex, const char* lpUserAssociatedData, int lenUserAssociatedData);

Unicode (Windows)
INT GetUserAssociatedData(INT iUserIndex, LPSTR &lpUserAssociatedData, INT &lenUserAssociatedData);
INT SetUserAssociatedData(INT iUserIndex, LPCSTR lpUserAssociatedData, INT lenUserAssociatedData);

int secureblackbox_kmipserver_getuserassociateddata(void* lpObj, int userindex, char** lpUserAssociatedData, int* lenUserAssociatedData);
int secureblackbox_kmipserver_setuserassociateddata(void* lpObj, int userindex, const char* lpUserAssociatedData, int lenUserAssociatedData);

QByteArray GetUserAssociatedData(int iUserIndex);
int SetUserAssociatedData(int iUserIndex, QByteArray qbaUserAssociatedData);

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

UserBasePath Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserBasePath(int iUserIndex);
int SetUserBasePath(int iUserIndex, const char* lpszUserBasePath);

Unicode (Windows)
LPWSTR GetUserBasePath(INT iUserIndex);
INT SetUserBasePath(INT iUserIndex, LPCWSTR lpszUserBasePath);

char* secureblackbox_kmipserver_getuserbasepath(void* lpObj, int userindex);
int secureblackbox_kmipserver_setuserbasepath(void* lpObj, int userindex, const char* lpszUserBasePath);

QString GetUserBasePath(int iUserIndex);
int SetUserBasePath(int iUserIndex, QString qsUserBasePath);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

UserCert Property (KMIPServer Class)

Contains the user's certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserCert(int iUserIndex, char* &lpUserCert, int &lenUserCert);
int SetUserCert(int iUserIndex, const char* lpUserCert, int lenUserCert);

Unicode (Windows)
INT GetUserCert(INT iUserIndex, LPSTR &lpUserCert, INT &lenUserCert);
INT SetUserCert(INT iUserIndex, LPCSTR lpUserCert, INT lenUserCert);

int secureblackbox_kmipserver_getusercert(void* lpObj, int userindex, char** lpUserCert, int* lenUserCert);
int secureblackbox_kmipserver_setusercert(void* lpObj, int userindex, const char* lpUserCert, int lenUserCert);

QByteArray GetUserCert(int iUserIndex);
int SetUserCert(int iUserIndex, QByteArray qbaUserCert);

Remarks

Contains the user's certificate.

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

This property is not available at design time.

Data Type

Byte Array

UserData Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserData(int iUserIndex);
int SetUserData(int iUserIndex, const char* lpszUserData);

Unicode (Windows)
LPWSTR GetUserData(INT iUserIndex);
INT SetUserData(INT iUserIndex, LPCWSTR lpszUserData);

char* secureblackbox_kmipserver_getuserdata(void* lpObj, int userindex);
int secureblackbox_kmipserver_setuserdata(void* lpObj, int userindex, const char* lpszUserData);

QString GetUserData(int iUserIndex);
int SetUserData(int iUserIndex, QString qsUserData);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

UserHandle Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetUserHandle(int iUserIndex);
int SetUserHandle(int iUserIndex, int64 lUserHandle);

Unicode (Windows)
LONG64 GetUserHandle(INT iUserIndex);
INT SetUserHandle(INT iUserIndex, LONG64 lUserHandle);

int64 secureblackbox_kmipserver_getuserhandle(void* lpObj, int userindex);
int secureblackbox_kmipserver_setuserhandle(void* lpObj, int userindex, int64 lUserHandle);

qint64 GetUserHandle(int iUserIndex);
int SetUserHandle(int iUserIndex, qint64 lUserHandle);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

UserHashAlgorithm Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserHashAlgorithm(int iUserIndex);
int SetUserHashAlgorithm(int iUserIndex, const char* lpszUserHashAlgorithm);

Unicode (Windows)
LPWSTR GetUserHashAlgorithm(INT iUserIndex);
INT SetUserHashAlgorithm(INT iUserIndex, LPCWSTR lpszUserHashAlgorithm);

char* secureblackbox_kmipserver_getuserhashalgorithm(void* lpObj, int userindex);
int secureblackbox_kmipserver_setuserhashalgorithm(void* lpObj, int userindex, const char* lpszUserHashAlgorithm);

QString GetUserHashAlgorithm(int iUserIndex);
int SetUserHashAlgorithm(int iUserIndex, QString qsUserHashAlgorithm);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

UserIncomingSpeedLimit Property (KMIPServer Class)

Specifies the incoming speed limit for this user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserIncomingSpeedLimit(int iUserIndex);
int SetUserIncomingSpeedLimit(int iUserIndex, int iUserIncomingSpeedLimit);

Unicode (Windows)
INT GetUserIncomingSpeedLimit(INT iUserIndex);
INT SetUserIncomingSpeedLimit(INT iUserIndex, INT iUserIncomingSpeedLimit);

int secureblackbox_kmipserver_getuserincomingspeedlimit(void* lpObj, int userindex);
int secureblackbox_kmipserver_setuserincomingspeedlimit(void* lpObj, int userindex, int iUserIncomingSpeedLimit);

int GetUserIncomingSpeedLimit(int iUserIndex);
int SetUserIncomingSpeedLimit(int iUserIndex, int iUserIncomingSpeedLimit);

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Integer

UserOtpAlgorithm Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserOtpAlgorithm(int iUserIndex);
int SetUserOtpAlgorithm(int iUserIndex, int iUserOtpAlgorithm);

Unicode (Windows)
INT GetUserOtpAlgorithm(INT iUserIndex);
INT SetUserOtpAlgorithm(INT iUserIndex, INT iUserOtpAlgorithm);

OA_NONE(0), 
OA_HMAC(1), 
OA_TIME(2)

int secureblackbox_kmipserver_getuserotpalgorithm(void* lpObj, int userindex);
int secureblackbox_kmipserver_setuserotpalgorithm(void* lpObj, int userindex, int iUserOtpAlgorithm);

int GetUserOtpAlgorithm(int iUserIndex);
int SetUserOtpAlgorithm(int iUserIndex, int iUserOtpAlgorithm);

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Integer

UserOtpValue Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserOtpValue(int iUserIndex);
int SetUserOtpValue(int iUserIndex, int iUserOtpValue);

Unicode (Windows)
INT GetUserOtpValue(INT iUserIndex);
INT SetUserOtpValue(INT iUserIndex, INT iUserOtpValue);

int secureblackbox_kmipserver_getuserotpvalue(void* lpObj, int userindex);
int secureblackbox_kmipserver_setuserotpvalue(void* lpObj, int userindex, int iUserOtpValue);

int GetUserOtpValue(int iUserIndex);
int SetUserOtpValue(int iUserIndex, int iUserOtpValue);

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Integer

UserOutgoingSpeedLimit Property (KMIPServer Class)

Specifies the outgoing speed limit for this user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserOutgoingSpeedLimit(int iUserIndex);
int SetUserOutgoingSpeedLimit(int iUserIndex, int iUserOutgoingSpeedLimit);

Unicode (Windows)
INT GetUserOutgoingSpeedLimit(INT iUserIndex);
INT SetUserOutgoingSpeedLimit(INT iUserIndex, INT iUserOutgoingSpeedLimit);

int secureblackbox_kmipserver_getuseroutgoingspeedlimit(void* lpObj, int userindex);
int secureblackbox_kmipserver_setuseroutgoingspeedlimit(void* lpObj, int userindex, int iUserOutgoingSpeedLimit);

int GetUserOutgoingSpeedLimit(int iUserIndex);
int SetUserOutgoingSpeedLimit(int iUserIndex, int iUserOutgoingSpeedLimit);

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Integer

UserPassword Property (KMIPServer Class)

The user's authentication password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserPassword(int iUserIndex);
int SetUserPassword(int iUserIndex, const char* lpszUserPassword);

Unicode (Windows)
LPWSTR GetUserPassword(INT iUserIndex);
INT SetUserPassword(INT iUserIndex, LPCWSTR lpszUserPassword);

char* secureblackbox_kmipserver_getuserpassword(void* lpObj, int userindex);
int secureblackbox_kmipserver_setuserpassword(void* lpObj, int userindex, const char* lpszUserPassword);

QString GetUserPassword(int iUserIndex);
int SetUserPassword(int iUserIndex, QString qsUserPassword);

Default Value

""

Remarks

The user's authentication password.

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

This property is not available at design time.

Data Type

String

UserPasswordLen Property (KMIPServer Class)

Specifies the length of the user's OTP password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserPasswordLen(int iUserIndex);
int SetUserPasswordLen(int iUserIndex, int iUserPasswordLen);

Unicode (Windows)
INT GetUserPasswordLen(INT iUserIndex);
INT SetUserPasswordLen(INT iUserIndex, INT iUserPasswordLen);

int secureblackbox_kmipserver_getuserpasswordlen(void* lpObj, int userindex);
int secureblackbox_kmipserver_setuserpasswordlen(void* lpObj, int userindex, int iUserPasswordLen);

int GetUserPasswordLen(int iUserIndex);
int SetUserPasswordLen(int iUserIndex, int iUserPasswordLen);

Default Value

0

Remarks

Specifies the length of the user's OTP password.

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

This property is not available at design time.

Data Type

Integer

UserSharedSecret Property (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserSharedSecret(int iUserIndex, char* &lpUserSharedSecret, int &lenUserSharedSecret);
int SetUserSharedSecret(int iUserIndex, const char* lpUserSharedSecret, int lenUserSharedSecret);

Unicode (Windows)
INT GetUserSharedSecret(INT iUserIndex, LPSTR &lpUserSharedSecret, INT &lenUserSharedSecret);
INT SetUserSharedSecret(INT iUserIndex, LPCSTR lpUserSharedSecret, INT lenUserSharedSecret);

int secureblackbox_kmipserver_getusersharedsecret(void* lpObj, int userindex, char** lpUserSharedSecret, int* lenUserSharedSecret);
int secureblackbox_kmipserver_setusersharedsecret(void* lpObj, int userindex, const char* lpUserSharedSecret, int lenUserSharedSecret);

QByteArray GetUserSharedSecret(int iUserIndex);
int SetUserSharedSecret(int iUserIndex, QByteArray qbaUserSharedSecret);

Remarks

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

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

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

This property is not available at design time.

Data Type

Byte Array

UserSSHKey Property (KMIPServer Class)

Contains the user's SSH key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserSSHKey(int iUserIndex, char* &lpUserSSHKey, int &lenUserSSHKey);
int SetUserSSHKey(int iUserIndex, const char* lpUserSSHKey, int lenUserSSHKey);

Unicode (Windows)
INT GetUserSSHKey(INT iUserIndex, LPSTR &lpUserSSHKey, INT &lenUserSSHKey);
INT SetUserSSHKey(INT iUserIndex, LPCSTR lpUserSSHKey, INT lenUserSSHKey);

int secureblackbox_kmipserver_getusersshkey(void* lpObj, int userindex, char** lpUserSSHKey, int* lenUserSSHKey);
int secureblackbox_kmipserver_setusersshkey(void* lpObj, int userindex, const char* lpUserSSHKey, int lenUserSSHKey);

QByteArray GetUserSSHKey(int iUserIndex);
int SetUserSSHKey(int iUserIndex, QByteArray qbaUserSSHKey);

Remarks

Contains the user's SSH key.

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

This property is not available at design time.

Data Type

Byte Array

UserUsername Property (KMIPServer Class)

The registered name (login) of the user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserUsername(int iUserIndex);
int SetUserUsername(int iUserIndex, const char* lpszUserUsername);

Unicode (Windows)
LPWSTR GetUserUsername(INT iUserIndex);
INT SetUserUsername(INT iUserIndex, LPCWSTR lpszUserUsername);

char* secureblackbox_kmipserver_getuserusername(void* lpObj, int userindex);
int secureblackbox_kmipserver_setuserusername(void* lpObj, int userindex, const char* lpszUserUsername);

QString GetUserUsername(int iUserIndex);
int SetUserUsername(int iUserIndex, QString qsUserUsername);

Default Value

""

Remarks

The registered name (login) of the user.

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

This property is not available at design time.

Data Type

String

Config Method (KMIPServer 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_kmipserver_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.

DoAction Method (KMIPServer 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_kmipserver_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 insencitive) 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;....

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.

GetClientCert Method (KMIPServer Class)

Populates the per-connection certificate object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientCert(int64 lConnectionID);

Unicode (Windows)
INT GetClientCert(LONG64 lConnectionID);

int secureblackbox_kmipserver_getclientcert(void* lpObj, int64 lConnectionID);

int GetClientCert(qint64 lConnectionID);

Remarks

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

Call this method from your BeforeGenerateCert event handler to populate the certificate template, as received in the request. It is still not late to alter the details of the certificate on this stage.

Call it from your AfterGenerateCert event handler to populate the certificate that has been generated.

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

GetClientCertRequest Method (KMIPServer Class)

Populates the per-connection certificate request object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientCertRequest(int64 lConnectionID);

Unicode (Windows)
INT GetClientCertRequest(LONG64 lConnectionID);

int secureblackbox_kmipserver_getclientcertrequest(void* lpObj, int64 lConnectionID);

int GetClientCertRequest(qint64 lConnectionID);

Remarks

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

Call this method from your BeforeGenerateCert event handler to populate the certificate request. You can alter the details of the certificate to be generated on this stage.

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

SetClientCert Method (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetClientCert(int64 lConnectionID);

Unicode (Windows)
INT SetClientCert(LONG64 lConnectionID);

int secureblackbox_kmipserver_setclientcert(void* lpObj, int64 lConnectionID);

int SetClientCert(qint64 lConnectionID);

Remarks

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

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

Start Method (KMIPServer Class)

Start the KMIP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Start();

Unicode (Windows)
INT Start();

int secureblackbox_kmipserver_start(void* lpObj);

int Start();

Remarks

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

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

Stop Method (KMIPServer Class)

Stops the KMIP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Stop();

Unicode (Windows)
INT Stop();

int secureblackbox_kmipserver_stop(void* lpObj);

int Stop();

Remarks

Call this method to stop the KMIP server.

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

AfterGenerateCert Event (KMIPServer Class)

Signifies completion of certificate generation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireAfterGenerateCert(KMIPServerAfterGenerateCertEventParams *e);

typedef struct {
  int64 ConnectionId;
  const char *UniqueIdentifier;
  int reserved;
} KMIPServerAfterGenerateCertEventParams;


Unicode (Windows)
virtual INT FireAfterGenerateCert(KMIPServerAfterGenerateCertEventParams *e);

typedef struct {
  LONG64 ConnectionId;
  LPCWSTR UniqueIdentifier;
  INT reserved;
} KMIPServerAfterGenerateCertEventParams;

#define EID_KMIPSERVER_AFTERGENERATECERT 1

virtual INT SECUREBLACKBOX_CALL FireAfterGenerateCert(LONG64 &lConnectionId, LPSTR &lpszUniqueIdentifier);

class KMIPServerAfterGenerateCertEventParams {
public:
  qint64 ConnectionId();

  const QString &UniqueIdentifier();

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

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

// Or, subclass KMIPServer and override this emitter function.
virtual int FireAfterGenerateCert(KMIPServerAfterGenerateCertEventParams *e) {...}

Remarks

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

AfterGenerateKey Event (KMIPServer Class)

Signifies completion of key generation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireAfterGenerateKey(KMIPServerAfterGenerateKeyEventParams *e);

typedef struct {
  int64 ConnectionId;
  const char *UniqueIdentifier;
  int reserved;
} KMIPServerAfterGenerateKeyEventParams;


Unicode (Windows)
virtual INT FireAfterGenerateKey(KMIPServerAfterGenerateKeyEventParams *e);

typedef struct {
  LONG64 ConnectionId;
  LPCWSTR UniqueIdentifier;
  INT reserved;
} KMIPServerAfterGenerateKeyEventParams;

#define EID_KMIPSERVER_AFTERGENERATEKEY 2

virtual INT SECUREBLACKBOX_CALL FireAfterGenerateKey(LONG64 &lConnectionId, LPSTR &lpszUniqueIdentifier);

class KMIPServerAfterGenerateKeyEventParams {
public:
  qint64 ConnectionId();

  const QString &UniqueIdentifier();

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

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

// Or, subclass KMIPServer and override this emitter function.
virtual int FireAfterGenerateKey(KMIPServerAfterGenerateKeyEventParams *e) {...}

Remarks

The class fires this event upon completion of key generation routine.

AuthAttempt Event (KMIPServer Class)

Fires when a connected client makes an authentication attempt.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireAuthAttempt(KMIPServerAuthAttemptEventParams *e);

typedef struct {
  int64 ConnectionId;
  const char *Username;
  const char *Password;
  int Allow;
  int reserved;
} KMIPServerAuthAttemptEventParams;


Unicode (Windows)
virtual INT FireAuthAttempt(KMIPServerAuthAttemptEventParams *e);

typedef struct {
  LONG64 ConnectionId;
  LPCWSTR Username;
  LPCWSTR Password;
  BOOL Allow;
  INT reserved;
} KMIPServerAuthAttemptEventParams;

#define EID_KMIPSERVER_AUTHATTEMPT 3

virtual INT SECUREBLACKBOX_CALL FireAuthAttempt(LONG64 &lConnectionId, LPSTR &lpszUsername, LPSTR &lpszPassword, BOOL &bAllow);

class KMIPServerAuthAttemptEventParams {
public:
  qint64 ConnectionId();

  const QString &Username();

  const QString &Password();

  bool Allow();
  void SetAllow(bool bAllow);

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

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

// Or, subclass KMIPServer and override this emitter function.
virtual int FireAuthAttempt(KMIPServerAuthAttemptEventParams *e) {...}

Remarks

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

Username and Password contain the professed credentials.

BeforeGenerateCert Event (KMIPServer Class)

Fires when a certificate generation request is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireBeforeGenerateCert(KMIPServerBeforeGenerateCertEventParams *e);

typedef struct {
  int64 ConnectionId;
  int reserved;
} KMIPServerBeforeGenerateCertEventParams;


Unicode (Windows)
virtual INT FireBeforeGenerateCert(KMIPServerBeforeGenerateCertEventParams *e);

typedef struct {
  LONG64 ConnectionId;
  INT reserved;
} KMIPServerBeforeGenerateCertEventParams;

#define EID_KMIPSERVER_BEFOREGENERATECERT 4

virtual INT SECUREBLACKBOX_CALL FireBeforeGenerateCert(LONG64 &lConnectionId);

class KMIPServerBeforeGenerateCertEventParams {
public:
  qint64 ConnectionId();

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

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

// Or, subclass KMIPServer and override this emitter function.
virtual int FireBeforeGenerateCert(KMIPServerBeforeGenerateCertEventParams *e) {...}

Remarks

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

BeforeGenerateKey Event (KMIPServer Class)

Fires when a key generation request is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireBeforeGenerateKey(KMIPServerBeforeGenerateKeyEventParams *e);

typedef struct {
  int64 ConnectionId;
  char *KeyAlgorithm;
  int KeyLength;
  char *DefaultECCurve;
  int reserved;
} KMIPServerBeforeGenerateKeyEventParams;


Unicode (Windows)
virtual INT FireBeforeGenerateKey(KMIPServerBeforeGenerateKeyEventParams *e);

typedef struct {
  LONG64 ConnectionId;
  LPWSTR KeyAlgorithm;
  INT KeyLength;
  LPWSTR DefaultECCurve;
  INT reserved;
} KMIPServerBeforeGenerateKeyEventParams;

#define EID_KMIPSERVER_BEFOREGENERATEKEY 5

virtual INT SECUREBLACKBOX_CALL FireBeforeGenerateKey(LONG64 &lConnectionId, LPSTR &lpszKeyAlgorithm, INT &iKeyLength, LPSTR &lpszDefaultECCurve);

class KMIPServerBeforeGenerateKeyEventParams {
public:
  qint64 ConnectionId();

  const QString &KeyAlgorithm();
  void SetKeyAlgorithm(const QString &qsKeyAlgorithm);

  int KeyLength();
  void SetKeyLength(int iKeyLength);

  const QString &DefaultECCurve();
  void SetDefaultECCurve(const QString &qsDefaultECCurve);

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

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

// Or, subclass KMIPServer and override this emitter function.
virtual int FireBeforeGenerateKey(KMIPServerBeforeGenerateKeyEventParams *e) {...}

Remarks

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

DestroyAction Event (KMIPServer Class)

Fires when an object destruction request is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDestroyAction(KMIPServerDestroyActionEventParams *e);

typedef struct {
  int64 ConnectionId;
  const char *UniqueIdentifier;
  int ObjectType;
  int ObjectState;
  int Remove;
  int reserved;
} KMIPServerDestroyActionEventParams;


Unicode (Windows)
virtual INT FireDestroyAction(KMIPServerDestroyActionEventParams *e);

typedef struct {
  LONG64 ConnectionId;
  LPCWSTR UniqueIdentifier;
  INT ObjectType;
  INT ObjectState;
  BOOL Remove;
  INT reserved;
} KMIPServerDestroyActionEventParams;

#define EID_KMIPSERVER_DESTROYACTION 6

virtual INT SECUREBLACKBOX_CALL FireDestroyAction(LONG64 &lConnectionId, LPSTR &lpszUniqueIdentifier, INT &iObjectType, INT &iObjectState, BOOL &bRemove);

class KMIPServerDestroyActionEventParams {
public:
  qint64 ConnectionId();

  const QString &UniqueIdentifier();

  int ObjectType();

  int ObjectState();

  bool Remove();
  void SetRemove(bool bRemove);

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

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

// Or, subclass KMIPServer and override this emitter function.
virtual int FireDestroyAction(KMIPServerDestroyActionEventParams *e) {...}

Remarks

The class fires this event when it receives a request from the client to destroy and existing object. Set Remove to true to proceed with the destruction, or to false to reject the request.

Error Event (KMIPServer Class)

Information about any errors that occur during KMIP operations.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_KMIPSERVER_ERROR 7

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

class KMIPServerErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

This event fires in case of exceptional conditions that occur during KMIP operations.

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

ExternalSign Event (KMIPServer Class)

Handles remote or external signing initiated by the server protocol.

Syntax

• C++
• C
• Qt

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

typedef struct {
  int64 ConnectionID;
  const char *OperationId;
  const char *HashAlgorithm;
  const char *Pars;
  const char *Data;
  char *SignedData;
  int reserved;
} KMIPServerExternalSignEventParams;


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

typedef struct {
  LONG64 ConnectionID;
  LPCWSTR OperationId;
  LPCWSTR HashAlgorithm;
  LPCWSTR Pars;
  LPCWSTR Data;
  LPWSTR SignedData;
  INT reserved;
} KMIPServerExternalSignEventParams;

#define EID_KMIPSERVER_EXTERNALSIGN 8

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

class KMIPServerExternalSignEventParams {
public:
  qint64 ConnectionID();

  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(KMIPServerExternalSignEventParams *e);

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

Remarks

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

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

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

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

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

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

Notification Event (KMIPServer Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_KMIPSERVER_NOTIFICATION 9

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

class KMIPServerNotificationEventParams {
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(KMIPServerNotificationEventParams *e);

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

Remarks

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

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

Request Event (KMIPServer Class)

Fires when a request is received from the client.

Syntax

• C++
• C
• Qt

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

typedef struct {
  int64 ConnectionId;
  const char *Operation;
  const char *Username;
  int Reject;
  int reserved;
} KMIPServerRequestEventParams;


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

typedef struct {
  LONG64 ConnectionId;
  LPCWSTR Operation;
  LPCWSTR Username;
  BOOL Reject;
  INT reserved;
} KMIPServerRequestEventParams;

#define EID_KMIPSERVER_REQUEST 10

virtual INT SECUREBLACKBOX_CALL FireRequest(LONG64 &lConnectionId, LPSTR &lpszOperation, LPSTR &lpszUsername, BOOL &bReject);

class KMIPServerRequestEventParams {
public:
  qint64 ConnectionId();

  const QString &Operation();

  const QString &Username();

  bool Reject();
  void SetReject(bool bReject);

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

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

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

Remarks

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

Config Settings (KMIPServer Class)

KMIPServer Config Settings

Base Config Settings