KMIPServer Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

SecureBlackbox_KMIPServer

Procedural Interface

 secureblackbox_kmipserver_open();
 secureblackbox_kmipserver_close($res);
 secureblackbox_kmipserver_register_callback($res, $id, $function);
 secureblackbox_kmipserver_get_last_error($res);
 secureblackbox_kmipserver_get_last_error_code($res);
 secureblackbox_kmipserver_set($res, $id, $index, $value);
 secureblackbox_kmipserver_get($res, $id, $index);
 secureblackbox_kmipserver_do_config($res, $configurationstring);
 secureblackbox_kmipserver_do_doaction($res, $actionid, $actionparams);
 secureblackbox_kmipserver_do_getclientcert($res, $connectionid);
 secureblackbox_kmipserver_do_getclientcertrequest($res, $connectionid);
 secureblackbox_kmipserver_do_setclientcert($res, $connectionid);
 secureblackbox_kmipserver_do_start($res);
 secureblackbox_kmipserver_do_stop($res);

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getActive();

Procedural Interface

secureblackbox_kmipserver_get($res, 1 );

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 (SecureBlackbox_KMIPServer Class)

Returns raw certificate data in DER format.

Object Oriented Interface

public function getCACertBytes();

Procedural Interface

secureblackbox_kmipserver_get($res, 2 );

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getCACertHandle();


public function setCACertHandle($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 9 );


secureblackbox_kmipserver_set($res, 9, $value );

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 (SecureBlackbox_KMIPServer Class)

Provides access to raw certificate request data in DER format.

Object Oriented Interface

public function getCertRequestBytes();

Procedural Interface

secureblackbox_kmipserver_get($res, 36 );

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 (SecureBlackbox_KMIPServer Class)

Specifies the elliptic curve of the EC public key.

Object Oriented Interface

public function getCertRequestCurve();

Procedural Interface

secureblackbox_kmipserver_get($res, 37 );

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getCertRequestHandle();

Procedural Interface

secureblackbox_kmipserver_get($res, 38 );

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getCertRequestHashAlgorithm();

Procedural Interface

secureblackbox_kmipserver_get($res, 39 );

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 (SecureBlackbox_KMIPServer Class)

Specifies the public key algorithm of this certificate request.

Object Oriented Interface

public function getCertRequestKeyAlgorithm();

Procedural Interface

secureblackbox_kmipserver_get($res, 40 );

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 (SecureBlackbox_KMIPServer Class)

Returns the length of the public key.

Object Oriented Interface

public function getCertRequestKeyBits();

Procedural Interface

secureblackbox_kmipserver_get($res, 41 );

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getCertRequestKeyUsage();

Procedural Interface

secureblackbox_kmipserver_get($res, 42 );

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getCertRequestKeyValid();

Procedural Interface

secureblackbox_kmipserver_get($res, 43 );

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 (SecureBlackbox_KMIPServer Class)

Contains the certificate's private key.

Object Oriented Interface

public function getCertRequestPrivateKeyBytes();

Procedural Interface

secureblackbox_kmipserver_get($res, 44 );

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getCertRequestPublicKeyBytes();

Procedural Interface

secureblackbox_kmipserver_get($res, 45 );

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getCertRequestSigAlgorithm();

Procedural Interface

secureblackbox_kmipserver_get($res, 46 );

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getCertRequestSubject();

Procedural Interface

secureblackbox_kmipserver_get($res, 47 );

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getCertRequestSubjectRDN();

Procedural Interface

secureblackbox_kmipserver_get($res, 48 );

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getCertRequestValid();

Procedural Interface

secureblackbox_kmipserver_get($res, 49 );

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 (SecureBlackbox_KMIPServer Class)

The number of records in the CertStorage arrays.

Object Oriented Interface

public function getCertStorageCount();


public function setCertStorageCount($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 50 );


secureblackbox_kmipserver_set($res, 50, $value );

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 (SecureBlackbox_KMIPServer Class)

Returns raw certificate data in DER format.

Object Oriented Interface

public function getCertStorageBytes($certstorageindex);

Procedural Interface

secureblackbox_kmipserver_get($res, 51 , $certstorageindex);

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getCertStorageHandle($certstorageindex);


public function setCertStorageHandle($certstorageindex, $value);

Procedural Interface

secureblackbox_kmipserver_get($res, 58 , $certstorageindex);


secureblackbox_kmipserver_set($res, 58, $value , $certstorageindex);

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 (SecureBlackbox_KMIPServer Class)

Specifies the KMIP encoder type.

Object Oriented Interface

public function getEncoderType();


public function setEncoderType($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 85 );


secureblackbox_kmipserver_set($res, 85, $value );

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getExternalCryptoAsyncDocumentID();


public function setExternalCryptoAsyncDocumentID($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 86 );


secureblackbox_kmipserver_set($res, 86, $value );

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getExternalCryptoCustomParams();


public function setExternalCryptoCustomParams($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 87 );


secureblackbox_kmipserver_set($res, 87, $value );

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getExternalCryptoData();


public function setExternalCryptoData($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 88 );


secureblackbox_kmipserver_set($res, 88, $value );

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getExternalCryptoExternalHashCalculation();


public function setExternalCryptoExternalHashCalculation($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 89 );


secureblackbox_kmipserver_set($res, 89, $value );

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 (SecureBlackbox_KMIPServer Class)

Specifies the request's signature hash algorithm.

Object Oriented Interface

public function getExternalCryptoHashAlgorithm();


public function setExternalCryptoHashAlgorithm($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 90 );


secureblackbox_kmipserver_set($res, 90, $value );

Default Value

'SHA256'

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getExternalCryptoKeyID();


public function setExternalCryptoKeyID($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 91 );


secureblackbox_kmipserver_set($res, 91, $value );

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 (SecureBlackbox_KMIPServer Class)

The pre-shared key used for DC request authentication.

Object Oriented Interface

public function getExternalCryptoKeySecret();


public function setExternalCryptoKeySecret($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 92 );


secureblackbox_kmipserver_set($res, 92, $value );

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 (SecureBlackbox_KMIPServer Class)

Specifies the asynchronous signing method.

Object Oriented Interface

public function getExternalCryptoMethod();


public function setExternalCryptoMethod($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 93 );


secureblackbox_kmipserver_set($res, 93, $value );

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 (SecureBlackbox_KMIPServer Class)

Specifies the external cryptography mode.

Object Oriented Interface

public function getExternalCryptoMode();


public function setExternalCryptoMode($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 94 );


secureblackbox_kmipserver_set($res, 94, $value );

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getExternalCryptoPublicKeyAlgorithm();


public function setExternalCryptoPublicKeyAlgorithm($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 95 );


secureblackbox_kmipserver_set($res, 95, $value );

Default Value

''

Remarks

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

Data Type

String

FIPSMode Property (SecureBlackbox_KMIPServer Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 96 );


secureblackbox_kmipserver_set($res, 96, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

GeneratedCertBytes Property (SecureBlackbox_KMIPServer Class)

Returns raw certificate data in DER format.

Object Oriented Interface

public function getGeneratedCertBytes();

Procedural Interface

secureblackbox_kmipserver_get($res, 97 );

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getGeneratedCertHandle();


public function setGeneratedCertHandle($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 104 );


secureblackbox_kmipserver_set($res, 104, $value );

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 (SecureBlackbox_KMIPServer Class)

A port to listen for connections on.

Object Oriented Interface

public function getPort();


public function setPort($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 131 );


secureblackbox_kmipserver_set($res, 131, $value );

Default Value

5696

Remarks

Use this property to specify the listening port.

Data Type

Integer

SocketIncomingSpeedLimit Property (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getSocketIncomingSpeedLimit();


public function setSocketIncomingSpeedLimit($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 137 );


secureblackbox_kmipserver_set($res, 137, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (SecureBlackbox_KMIPServer Class)

The local network interface to bind the socket to.

Object Oriented Interface

public function getSocketLocalAddress();


public function setSocketLocalAddress($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 138 );


secureblackbox_kmipserver_set($res, 138, $value );

Default Value

''

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SecureBlackbox_KMIPServer Class)

The local port number to bind the socket to.

Object Oriented Interface

public function getSocketLocalPort();


public function setSocketLocalPort($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 139 );


secureblackbox_kmipserver_set($res, 139, $value );

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getSocketOutgoingSpeedLimit();


public function setSocketOutgoingSpeedLimit($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 140 );


secureblackbox_kmipserver_set($res, 140, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getSocketTimeout();


public function setSocketTimeout($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 141 );


secureblackbox_kmipserver_set($res, 141, $value );

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 (SecureBlackbox_KMIPServer Class)

Enables or disables IP protocol version 6.

Object Oriented Interface

public function getSocketUseIPv6();


public function setSocketUseIPv6($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 142 );


secureblackbox_kmipserver_set($res, 142, $value );

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

StorageFileName Property (SecureBlackbox_KMIPServer Class)

A path to the KMIP object database.

Object Oriented Interface

public function getStorageFileName();


public function setStorageFileName($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 143 );


secureblackbox_kmipserver_set($res, 143, $value );

Default Value

''

Remarks

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

Data Type

String

TLSAutoValidateCertificates Property (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getTLSAutoValidateCertificates();


public function setTLSAutoValidateCertificates($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 144 );


secureblackbox_kmipserver_set($res, 144, $value );

Default Value

true

Remarks

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

Data Type

Boolean

TLSBaseConfiguration Property (SecureBlackbox_KMIPServer Class)

Selects the base configuration for the TLS settings.

Object Oriented Interface

public function getTLSBaseConfiguration();


public function setTLSBaseConfiguration($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 145 );


secureblackbox_kmipserver_set($res, 145, $value );

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 (SecureBlackbox_KMIPServer Class)

A list of ciphersuites separated with commas or semicolons.

Object Oriented Interface

public function getTLSCiphersuites();


public function setTLSCiphersuites($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 146 );


secureblackbox_kmipserver_set($res, 146, $value );

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 (SecureBlackbox_KMIPServer Class)

Defines the elliptic curves to enable.

Object Oriented Interface

public function getTLSECCurves();


public function setTLSECCurves($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 147 );


secureblackbox_kmipserver_set($res, 147, $value );

Default Value

''

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (SecureBlackbox_KMIPServer Class)

Provides access to TLS extensions.

Object Oriented Interface

public function getTLSExtensions();


public function setTLSExtensions($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 148 );


secureblackbox_kmipserver_set($res, 148, $value );

Default Value

''

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getTLSForceResumeIfDestinationChanges();


public function setTLSForceResumeIfDestinationChanges($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 149 );


secureblackbox_kmipserver_set($res, 149, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSPreSharedIdentity Property (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getTLSPreSharedIdentity();


public function setTLSPreSharedIdentity($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 150 );


secureblackbox_kmipserver_set($res, 150, $value );

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getTLSPreSharedKey();


public function setTLSPreSharedKey($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 151 );


secureblackbox_kmipserver_set($res, 151, $value );

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getTLSPreSharedKeyCiphersuite();


public function setTLSPreSharedKeyCiphersuite($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 152 );


secureblackbox_kmipserver_set($res, 152, $value );

Default Value

''

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (SecureBlackbox_KMIPServer Class)

Selects renegotiation attack prevention mechanism.

Object Oriented Interface

public function getTLSRenegotiationAttackPreventionMode();


public function setTLSRenegotiationAttackPreventionMode($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 153 );


secureblackbox_kmipserver_set($res, 153, $value );

Default Value

0

Remarks

Selects renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getTLSRevocationCheck();


public function setTLSRevocationCheck($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 154 );


secureblackbox_kmipserver_set($res, 154, $value );

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 (SecureBlackbox_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.

Object Oriented Interface

public function getTLSSSLOptions();


public function setTLSSSLOptions($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 155 );


secureblackbox_kmipserver_set($res, 155, $value );

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (SecureBlackbox_KMIPServer Class)

Specifies the TLS mode to use.

Object Oriented Interface

public function getTLSTLSMode();


public function setTLSTLSMode($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 156 );


secureblackbox_kmipserver_set($res, 156, $value );

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getTLSUseExtendedMasterSecret();


public function setTLSUseExtendedMasterSecret($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 157 );


secureblackbox_kmipserver_set($res, 157, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (SecureBlackbox_KMIPServer Class)

Enables or disables TLS session resumption capability.

Object Oriented Interface

public function getTLSUseSessionResumption();


public function setTLSUseSessionResumption($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 158 );


secureblackbox_kmipserver_set($res, 158, $value );

Default Value

false

Remarks

Enables or disables TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (SecureBlackbox_KMIPServer Class)

The SSL/TLS versions to enable by default.

Object Oriented Interface

public function getTLSVersions();


public function setTLSVersions($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 159 );


secureblackbox_kmipserver_set($res, 159, $value );

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

UserCount Property (SecureBlackbox_KMIPServer Class)

The number of records in the User arrays.

Object Oriented Interface

public function getUserCount();


public function setUserCount($value);

Procedural Interface

secureblackbox_kmipserver_get($res, 160 );


secureblackbox_kmipserver_set($res, 160, $value );

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getUserAssociatedData($userindex);


public function setUserAssociatedData($userindex, $value);

Procedural Interface

secureblackbox_kmipserver_get($res, 161 , $userindex);


secureblackbox_kmipserver_set($res, 161, $value , $userindex);

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getUserBasePath($userindex);


public function setUserBasePath($userindex, $value);

Procedural Interface

secureblackbox_kmipserver_get($res, 162 , $userindex);


secureblackbox_kmipserver_set($res, 162, $value , $userindex);

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 (SecureBlackbox_KMIPServer Class)

Contains the user's certificate.

Object Oriented Interface

public function getUserCert($userindex);


public function setUserCert($userindex, $value);

Procedural Interface

secureblackbox_kmipserver_get($res, 163 , $userindex);


secureblackbox_kmipserver_set($res, 163, $value , $userindex);

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getUserData($userindex);


public function setUserData($userindex, $value);

Procedural Interface

secureblackbox_kmipserver_get($res, 164 , $userindex);


secureblackbox_kmipserver_set($res, 164, $value , $userindex);

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getUserHandle($userindex);


public function setUserHandle($userindex, $value);

Procedural Interface

secureblackbox_kmipserver_get($res, 165 , $userindex);


secureblackbox_kmipserver_set($res, 165, $value , $userindex);

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getUserHashAlgorithm($userindex);


public function setUserHashAlgorithm($userindex, $value);

Procedural Interface

secureblackbox_kmipserver_get($res, 166 , $userindex);


secureblackbox_kmipserver_set($res, 166, $value , $userindex);

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 (SecureBlackbox_KMIPServer Class)

Specifies the incoming speed limit for this user.

Object Oriented Interface

public function getUserIncomingSpeedLimit($userindex);


public function setUserIncomingSpeedLimit($userindex, $value);

Procedural Interface

secureblackbox_kmipserver_get($res, 167 , $userindex);


secureblackbox_kmipserver_set($res, 167, $value , $userindex);

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getUserOtpAlgorithm($userindex);


public function setUserOtpAlgorithm($userindex, $value);

Procedural Interface

secureblackbox_kmipserver_get($res, 168 , $userindex);


secureblackbox_kmipserver_set($res, 168, $value , $userindex);

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getUserOtpValue($userindex);


public function setUserOtpValue($userindex, $value);

Procedural Interface

secureblackbox_kmipserver_get($res, 169 , $userindex);


secureblackbox_kmipserver_set($res, 169, $value , $userindex);

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 (SecureBlackbox_KMIPServer Class)

Specifies the outgoing speed limit for this user.

Object Oriented Interface

public function getUserOutgoingSpeedLimit($userindex);


public function setUserOutgoingSpeedLimit($userindex, $value);

Procedural Interface

secureblackbox_kmipserver_get($res, 170 , $userindex);


secureblackbox_kmipserver_set($res, 170, $value , $userindex);

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 (SecureBlackbox_KMIPServer Class)

The user's authentication password.

Object Oriented Interface

public function getUserPassword($userindex);


public function setUserPassword($userindex, $value);

Procedural Interface

secureblackbox_kmipserver_get($res, 171 , $userindex);


secureblackbox_kmipserver_set($res, 171, $value , $userindex);

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 (SecureBlackbox_KMIPServer Class)

Specifies the length of the user's OTP password.

Object Oriented Interface

public function getUserPasswordLen($userindex);


public function setUserPasswordLen($userindex, $value);

Procedural Interface

secureblackbox_kmipserver_get($res, 172 , $userindex);


secureblackbox_kmipserver_set($res, 172, $value , $userindex);

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function getUserSharedSecret($userindex);


public function setUserSharedSecret($userindex, $value);

Procedural Interface

secureblackbox_kmipserver_get($res, 173 , $userindex);


secureblackbox_kmipserver_set($res, 173, $value , $userindex);

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 (SecureBlackbox_KMIPServer Class)

Contains the user's SSH key.

Object Oriented Interface

public function getUserSSHKey($userindex);


public function setUserSSHKey($userindex, $value);

Procedural Interface

secureblackbox_kmipserver_get($res, 174 , $userindex);


secureblackbox_kmipserver_set($res, 174, $value , $userindex);

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 (SecureBlackbox_KMIPServer Class)

The registered name (login) of the user.

Object Oriented Interface

public function getUserUsername($userindex);


public function setUserUsername($userindex, $value);

Procedural Interface

secureblackbox_kmipserver_get($res, 175 , $userindex);


secureblackbox_kmipserver_set($res, 175, $value , $userindex);

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 (SecureBlackbox_KMIPServer Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_kmipserver_do_config($res, $configurationstring);

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.

DoAction Method (SecureBlackbox_KMIPServer Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_kmipserver_do_doaction($res, $actionid, $actionparams);

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

GetClientCert Method (SecureBlackbox_KMIPServer Class)

Populates the per-connection certificate object.

Object Oriented Interface

public function doGetClientCert($connectionid);

Procedural Interface

secureblackbox_kmipserver_do_getclientcert($res, $connectionid);

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.

GetClientCertRequest Method (SecureBlackbox_KMIPServer Class)

Populates the per-connection certificate request object.

Object Oriented Interface

public function doGetClientCertRequest($connectionid);

Procedural Interface

secureblackbox_kmipserver_do_getclientcertrequest($res, $connectionid);

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.

SetClientCert Method (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function doSetClientCert($connectionid);

Procedural Interface

secureblackbox_kmipserver_do_setclientcert($res, $connectionid);

Remarks

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

Start Method (SecureBlackbox_KMIPServer Class)

Start the KMIP server.

Object Oriented Interface

public function doStart();

Procedural Interface

secureblackbox_kmipserver_do_start($res);

Remarks

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

Stop Method (SecureBlackbox_KMIPServer Class)

Stops the KMIP server.

Object Oriented Interface

public function doStop();

Procedural Interface

secureblackbox_kmipserver_do_stop($res);

Remarks

Call this method to stop the KMIP server.

AfterGenerateCert Event (SecureBlackbox_KMIPServer Class)

Signifies completion of certificate generation.

Object Oriented Interface

public function fireAfterGenerateCert($param);

Procedural Interface

secureblackbox_kmipserver_register_callback($res, 1, array($this, 'fireAfterGenerateCert'));

Parameter List

 'connectionid'
 'uniqueidentifier'

Remarks

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

AfterGenerateKey Event (SecureBlackbox_KMIPServer Class)

Signifies completion of key generation.

Object Oriented Interface

public function fireAfterGenerateKey($param);

Procedural Interface

secureblackbox_kmipserver_register_callback($res, 2, array($this, 'fireAfterGenerateKey'));

Parameter List

 'connectionid'
 'uniqueidentifier'

Remarks

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

AuthAttempt Event (SecureBlackbox_KMIPServer Class)

Fires when a connected client makes an authentication attempt.

Object Oriented Interface

public function fireAuthAttempt($param);

Procedural Interface

secureblackbox_kmipserver_register_callback($res, 3, array($this, 'fireAuthAttempt'));

Parameter List

 'connectionid'
 'username'
 'password'
 'allow'

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 (SecureBlackbox_KMIPServer Class)

Fires when a certificate generation request is received.

Object Oriented Interface

public function fireBeforeGenerateCert($param);

Procedural Interface

secureblackbox_kmipserver_register_callback($res, 4, array($this, 'fireBeforeGenerateCert'));

Parameter List

 'connectionid'

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 (SecureBlackbox_KMIPServer Class)

Fires when a key generation request is received.

Object Oriented Interface

public function fireBeforeGenerateKey($param);

Procedural Interface

secureblackbox_kmipserver_register_callback($res, 5, array($this, 'fireBeforeGenerateKey'));

Parameter List

 'connectionid'
 'keyalgorithm'
 'keylength'
 'defaulteccurve'

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 (SecureBlackbox_KMIPServer Class)

Fires when an object destruction request is received.

Object Oriented Interface

public function fireDestroyAction($param);

Procedural Interface

secureblackbox_kmipserver_register_callback($res, 6, array($this, 'fireDestroyAction'));

Parameter List

 'connectionid'
 'uniqueidentifier'
 'objecttype'
 'objectstate'
 'remove'

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 (SecureBlackbox_KMIPServer Class)

Information about any errors that occur during KMIP operations.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_kmipserver_register_callback($res, 7, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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 (SecureBlackbox_KMIPServer Class)

Handles remote or external signing initiated by the server protocol.

Object Oriented Interface

public function fireExternalSign($param);

Procedural Interface

secureblackbox_kmipserver_register_callback($res, 8, array($this, 'fireExternalSign'));

Parameter List

 'connectionid'
 'operationid'
 'hashalgorithm'
 'pars'
 'data'
 'signeddata'

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 (SecureBlackbox_KMIPServer Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_kmipserver_register_callback($res, 9, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

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 (SecureBlackbox_KMIPServer Class)

Fires when a request is received from the client.

Object Oriented Interface

public function fireRequest($param);

Procedural Interface

secureblackbox_kmipserver_register_callback($res, 10, array($this, 'fireRequest'));

Parameter List

 'connectionid'
 'operation'
 'username'
 'reject'

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)

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

KMIPServer Config Settings

Base Config Settings

Trappable Errors (KMIPServer Class)

KMIPServer Errors

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