KMIPClient Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

SecureBlackbox_KMIPClient

Procedural Interface

 secureblackbox_kmipclient_open();
 secureblackbox_kmipclient_close($res);
 secureblackbox_kmipclient_register_callback($res, $id, $function);
 secureblackbox_kmipclient_get_last_error($res);
 secureblackbox_kmipclient_get_last_error_code($res);
 secureblackbox_kmipclient_set($res, $id, $index, $value);
 secureblackbox_kmipclient_get($res, $id, $index);
 secureblackbox_kmipclient_do_activate($res, $objectid);
 secureblackbox_kmipclient_do_add($res, $addprivatekey, $group, $activate);
 secureblackbox_kmipclient_do_addkey($res, $group, $activate);
 secureblackbox_kmipclient_do_config($res, $configurationstring);
 secureblackbox_kmipclient_do_customrequest($res, $data);
 secureblackbox_kmipclient_do_deactivate($res, $objectid);
 secureblackbox_kmipclient_do_decrypt($res, $objectid, $algorithm, $iv, $blockmode, $paddingmethod, $taglength);
 secureblackbox_kmipclient_do_doaction($res, $actionid, $actionparams);
 secureblackbox_kmipclient_do_encrypt($res, $objectid, $algorithm, $iv, $blockmode, $paddingmethod, $taglength);
 secureblackbox_kmipclient_do_generate($res, $publickeyid, $activate);
 secureblackbox_kmipclient_do_generatekey($res, $keyalgorithm, $scheme, $schemeparams, $keybits, $group, $activate);
 secureblackbox_kmipclient_do_list($res, $objecttypes, $filter, $offsetitems, $maximumitems, $freshonly);
 secureblackbox_kmipclient_do_read($res, $objectid);
 secureblackbox_kmipclient_do_readattribute($res, $objectid, $name);
 secureblackbox_kmipclient_do_readkey($res, $objectid);
 secureblackbox_kmipclient_do_readobject($res, $objectid);
 secureblackbox_kmipclient_do_remove($res, $objectid);
 secureblackbox_kmipclient_do_reset($res);
 secureblackbox_kmipclient_do_setattribute($res, $objectid, $name, $value, $delete);
 secureblackbox_kmipclient_do_setrequestbytes($res, $value);
 secureblackbox_kmipclient_do_setresponsebytes($res, $value);
 secureblackbox_kmipclient_do_sign($res, $objectid, $algorithm, $paddingmethod, $hashalgorithm, $inputishash);
 secureblackbox_kmipclient_do_verify($res, $objectid, $algorithm, $paddingmethod, $hashalgorithm, $inputishash);

Remarks

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

Capabilities

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

Working with KMIPClient

Setting up the component

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

Network access parameters

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

The transport type

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

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

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

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

The encoding type

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

TLS configuration

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

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

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

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

Managing keys and certificates

The common key management operations are:

Importing a keypair or certificate to the server

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

Listing server objects

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

Reading object properties

KMIPClient offers a few methods to read object properties. You can choose the method that fits your scenario best. Use Read and ReadKey methods to read certificates and keys directly into the Certificate and Key properties. You can then pass the received objects to other components that support them (such as CertificateManager). Use ReadObject to read the object into the Objects list. Use ReadAttribute to read a specific attribute of an object.

Generating server-side objects

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

Making cryptographic calls

The common cryptographic calls are:

Signing data

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

Encrypting and decrypting data

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

Providing data for the operations

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

• as a byte array - use InputBytes property.
• as a stream - use InputStream.
• in a file - use InputFile.

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

Note that the OutputBytes is only populated if neither of OutputFile and OutputStream is set.

Referencing server objects

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

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

AuthTypes Property (SecureBlackbox_KMIPClient Class)

Defines allowed HTTP authentication types.

Object Oriented Interface

public function getAuthTypes();
public function setAuthTypes($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 1 );
secureblackbox_kmipclient_set($res, 1, $value );

Default Value

0

Remarks

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

Data Type

Integer

AuxResult Property (SecureBlackbox_KMIPClient Class)

Contains the auxiliary result of the last performed operation.

Object Oriented Interface

public function getAuxResult();

Procedural Interface

secureblackbox_kmipclient_get($res, 2 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

BaseURL Property (SecureBlackbox_KMIPClient Class)

Specifies the url of the KMIP server.

Object Oriented Interface

public function getBaseURL();
public function setBaseURL($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 3 );
secureblackbox_kmipclient_set($res, 3, $value );

Default Value

''

Remarks

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

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

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

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

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

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

Examples

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

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

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

Data Type

String

BlockedCertCount Property (SecureBlackbox_KMIPClient Class)

The number of records in the BlockedCert arrays.

Object Oriented Interface

public function getBlockedCertCount();
public function setBlockedCertCount($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 4 );
secureblackbox_kmipclient_set($res, 4, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• BlockedCertBytes
• BlockedCertHandle

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

This property is not available at design time.

Data Type

Integer

BlockedCertBytes Property (SecureBlackbox_KMIPClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getBlockedCertBytes($blockedcertindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 5 , $blockedcertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

BlockedCertHandle Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getBlockedCertHandle($blockedcertindex);
public function setBlockedCertHandle($blockedcertindex, $value);

Procedural Interface

secureblackbox_kmipclient_get($res, 13 , $blockedcertindex);
secureblackbox_kmipclient_set($res, 13, $value , $blockedcertindex);

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

This property is not available at design time.

Data Type

Long64

CertificateBytes Property (SecureBlackbox_KMIPClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getCertificateBytes();

Procedural Interface

secureblackbox_kmipclient_get($res, 44 );

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

CertificateHandle Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getCertificateHandle();
public function setCertificateHandle($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 52 );
secureblackbox_kmipclient_set($res, 52, $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

ConnInfoAEADCipher Property (SecureBlackbox_KMIPClient Class)

Indicates whether the encryption algorithm used is an AEAD cipher.

Object Oriented Interface

public function getConnInfoAEADCipher();

Procedural Interface

secureblackbox_kmipclient_get($res, 83 );

Default Value

false

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

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

Data Type

Boolean

ConnInfoChainValidationDetails Property (SecureBlackbox_KMIPClient Class)

The details of a certificate chain validation outcome.

Object Oriented Interface

public function getConnInfoChainValidationDetails();

Procedural Interface

secureblackbox_kmipclient_get($res, 84 );

Default Value

0

Remarks

The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

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

Data Type

Integer

ConnInfoChainValidationResult Property (SecureBlackbox_KMIPClient Class)

The outcome of a certificate chain validation routine.

Object Oriented Interface

public function getConnInfoChainValidationResult();

Procedural Interface

secureblackbox_kmipclient_get($res, 85 );

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

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

Data Type

Integer

ConnInfoCiphersuite Property (SecureBlackbox_KMIPClient Class)

The cipher suite employed by this connection.

Object Oriented Interface

public function getConnInfoCiphersuite();

Procedural Interface

secureblackbox_kmipclient_get($res, 86 );

Default Value

''

Remarks

The cipher suite employed by this connection.

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

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

Data Type

String

ConnInfoClientAuthenticated Property (SecureBlackbox_KMIPClient Class)

Specifies whether client authentication was performed during this connection.

Object Oriented Interface

public function getConnInfoClientAuthenticated();

Procedural Interface

secureblackbox_kmipclient_get($res, 87 );

Default Value

false

Remarks

Specifies whether client authentication was performed during this connection.

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

Data Type

Boolean

ConnInfoClientAuthRequested Property (SecureBlackbox_KMIPClient Class)

Specifies whether client authentication was requested during this connection.

Object Oriented Interface

public function getConnInfoClientAuthRequested();

Procedural Interface

secureblackbox_kmipclient_get($res, 88 );

Default Value

false

Remarks

Specifies whether client authentication was requested during this connection.

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

Data Type

Boolean

ConnInfoConnectionEstablished Property (SecureBlackbox_KMIPClient Class)

Indicates whether the connection has been established fully.

Object Oriented Interface

public function getConnInfoConnectionEstablished();

Procedural Interface

secureblackbox_kmipclient_get($res, 89 );

Default Value

false

Remarks

Indicates whether the connection has been established fully.

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

Data Type

Boolean

ConnInfoConnectionID Property (SecureBlackbox_KMIPClient Class)

The unique identifier assigned to this connection.

Object Oriented Interface

public function getConnInfoConnectionID();

Procedural Interface

secureblackbox_kmipclient_get($res, 90 );

Remarks

The unique identifier assigned to this connection.

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

Data Type

Byte Array

ConnInfoDigestAlgorithm Property (SecureBlackbox_KMIPClient Class)

The digest algorithm used in a TLS-enabled connection.

Object Oriented Interface

public function getConnInfoDigestAlgorithm();

Procedural Interface

secureblackbox_kmipclient_get($res, 91 );

Default Value

''

Remarks

The digest algorithm used in a TLS-enabled connection.

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

Data Type

String

ConnInfoEncryptionAlgorithm Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getConnInfoEncryptionAlgorithm();

Procedural Interface

secureblackbox_kmipclient_get($res, 92 );

Default Value

''

Remarks

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

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

Data Type

String

ConnInfoExportable Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getConnInfoExportable();

Procedural Interface

secureblackbox_kmipclient_get($res, 93 );

Default Value

false

Remarks

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

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

Data Type

Boolean

ConnInfoID Property (SecureBlackbox_KMIPClient Class)

The client connection's unique identifier.

Object Oriented Interface

public function getConnInfoID();

Procedural Interface

secureblackbox_kmipclient_get($res, 94 );

Default Value

-1

Remarks

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

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

Data Type

Long64

ConnInfoKeyExchangeAlgorithm Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getConnInfoKeyExchangeAlgorithm();

Procedural Interface

secureblackbox_kmipclient_get($res, 95 );

Default Value

''

Remarks

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

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

Data Type

String

ConnInfoKeyExchangeKeyBits Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getConnInfoKeyExchangeKeyBits();

Procedural Interface

secureblackbox_kmipclient_get($res, 96 );

Default Value

0

Remarks

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

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

Data Type

Integer

ConnInfoNamedECCurve Property (SecureBlackbox_KMIPClient Class)

The elliptic curve used in this connection.

Object Oriented Interface

public function getConnInfoNamedECCurve();

Procedural Interface

secureblackbox_kmipclient_get($res, 97 );

Default Value

''

Remarks

The elliptic curve used in this connection.

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

Data Type

String

ConnInfoPFSCipher Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getConnInfoPFSCipher();

Procedural Interface

secureblackbox_kmipclient_get($res, 98 );

Default Value

false

Remarks

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

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

Data Type

Boolean

ConnInfoPreSharedIdentity Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getConnInfoPreSharedIdentity();

Procedural Interface

secureblackbox_kmipclient_get($res, 99 );

Default Value

''

Remarks

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

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

Data Type

String

ConnInfoPreSharedIdentityHint Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getConnInfoPreSharedIdentityHint();

Procedural Interface

secureblackbox_kmipclient_get($res, 100 );

Default Value

''

Remarks

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

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

Data Type

String

ConnInfoPublicKeyBits Property (SecureBlackbox_KMIPClient Class)

The length of the public key.

Object Oriented Interface

public function getConnInfoPublicKeyBits();

Procedural Interface

secureblackbox_kmipclient_get($res, 101 );

Default Value

0

Remarks

The length of the public key.

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

Data Type

Integer

ConnInfoRemoteAddress Property (SecureBlackbox_KMIPClient Class)

The client's IP address.

Object Oriented Interface

public function getConnInfoRemoteAddress();

Procedural Interface

secureblackbox_kmipclient_get($res, 102 );

Default Value

''

Remarks

The client's IP address.

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

Data Type

String

ConnInfoRemotePort Property (SecureBlackbox_KMIPClient Class)

The remote port of the client connection.

Object Oriented Interface

public function getConnInfoRemotePort();

Procedural Interface

secureblackbox_kmipclient_get($res, 103 );

Default Value

0

Remarks

The remote port of the client connection.

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

Data Type

Integer

ConnInfoResumedSession Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getConnInfoResumedSession();

Procedural Interface

secureblackbox_kmipclient_get($res, 104 );

Default Value

false

Remarks

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

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

Data Type

Boolean

ConnInfoSecureConnection Property (SecureBlackbox_KMIPClient Class)

Indicates whether TLS or SSL is enabled for this connection.

Object Oriented Interface

public function getConnInfoSecureConnection();

Procedural Interface

secureblackbox_kmipclient_get($res, 105 );

Default Value

false

Remarks

Indicates whether TLS or SSL is enabled for this connection.

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

Data Type

Boolean

ConnInfoServerAuthenticated Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getConnInfoServerAuthenticated();

Procedural Interface

secureblackbox_kmipclient_get($res, 106 );

Default Value

false

Remarks

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

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

Data Type

Boolean

ConnInfoSignatureAlgorithm Property (SecureBlackbox_KMIPClient Class)

The signature algorithm used in a TLS handshake.

Object Oriented Interface

public function getConnInfoSignatureAlgorithm();

Procedural Interface

secureblackbox_kmipclient_get($res, 107 );

Default Value

''

Remarks

The signature algorithm used in a TLS handshake.

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

Data Type

String

ConnInfoSymmetricBlockSize Property (SecureBlackbox_KMIPClient Class)

The block size of the symmetric algorithm used.

Object Oriented Interface

public function getConnInfoSymmetricBlockSize();

Procedural Interface

secureblackbox_kmipclient_get($res, 108 );

Default Value

0

Remarks

The block size of the symmetric algorithm used.

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

Data Type

Integer

ConnInfoSymmetricKeyBits Property (SecureBlackbox_KMIPClient Class)

The key length of the symmetric algorithm used.

Object Oriented Interface

public function getConnInfoSymmetricKeyBits();

Procedural Interface

secureblackbox_kmipclient_get($res, 109 );

Default Value

0

Remarks

The key length of the symmetric algorithm used.

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

Data Type

Integer

ConnInfoTotalBytesReceived Property (SecureBlackbox_KMIPClient Class)

The total number of bytes received over this connection.

Object Oriented Interface

public function getConnInfoTotalBytesReceived();

Procedural Interface

secureblackbox_kmipclient_get($res, 110 );

Default Value

0

Remarks

The total number of bytes received over this connection.

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

Data Type

Long64

ConnInfoTotalBytesSent Property (SecureBlackbox_KMIPClient Class)

The total number of bytes sent over this connection.

Object Oriented Interface

public function getConnInfoTotalBytesSent();

Procedural Interface

secureblackbox_kmipclient_get($res, 111 );

Default Value

0

Remarks

The total number of bytes sent over this connection.

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

Data Type

Long64

ConnInfoValidationLog Property (SecureBlackbox_KMIPClient Class)

Contains the server certificate's chain validation log.

Object Oriented Interface

public function getConnInfoValidationLog();

Procedural Interface

secureblackbox_kmipclient_get($res, 112 );

Default Value

''

Remarks

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

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

Data Type

String

ConnInfoVersion Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getConnInfoVersion();

Procedural Interface

secureblackbox_kmipclient_get($res, 113 );

Default Value

''

Remarks

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

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

Data Type

String

DataBytes Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getDataBytes();
public function setDataBytes($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 114 );
secureblackbox_kmipclient_set($res, 114, $value );

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

DataFile Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getDataFile();
public function setDataFile($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 115 );
secureblackbox_kmipclient_set($res, 115, $value );

Default Value

''

Remarks

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

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

Data Type

String

Encoding Property (SecureBlackbox_KMIPClient Class)

Specifies the KMIP encoding type.

Object Oriented Interface

public function getEncoding();
public function setEncoding($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 116 );
secureblackbox_kmipclient_set($res, 116, $value );

Default Value

0

Remarks

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

The following encodings are available:

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

Data Type

Integer

ExternalCryptoAsyncDocumentID Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getExternalCryptoAsyncDocumentID();
public function setExternalCryptoAsyncDocumentID($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 117 );
secureblackbox_kmipclient_set($res, 117, $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 the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getExternalCryptoCustomParams();
public function setExternalCryptoCustomParams($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 118 );
secureblackbox_kmipclient_set($res, 118, $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_KMIPClient 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_kmipclient_get($res, 119 );
secureblackbox_kmipclient_set($res, 119, $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_KMIPClient 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_kmipclient_get($res, 120 );
secureblackbox_kmipclient_set($res, 120, $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 the DCAuth class.

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

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (SecureBlackbox_KMIPClient Class)

Specifies the request's signature hash algorithm.

Object Oriented Interface

public function getExternalCryptoHashAlgorithm();
public function setExternalCryptoHashAlgorithm($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 121 );
secureblackbox_kmipclient_set($res, 121, $value );

Default Value

'SHA256'

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SecureBlackbox_KMIPClient 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_kmipclient_get($res, 122 );
secureblackbox_kmipclient_set($res, 122, $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 an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use 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_KMIPClient Class)

The pre-shared key used for DC request authentication.

Object Oriented Interface

public function getExternalCryptoKeySecret();
public function setExternalCryptoKeySecret($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 123 );
secureblackbox_kmipclient_set($res, 123, $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_KMIPClient Class)

Specifies the asynchronous signing method.

Object Oriented Interface

public function getExternalCryptoMethod();
public function setExternalCryptoMethod($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 124 );
secureblackbox_kmipclient_set($res, 124, $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_KMIPClient Class)

Specifies the external cryptography mode.

Object Oriented Interface

public function getExternalCryptoMode();
public function setExternalCryptoMode($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 125 );
secureblackbox_kmipclient_set($res, 125, $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_KMIPClient Class)

Provide the 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_kmipclient_get($res, 126 );
secureblackbox_kmipclient_set($res, 126, $value );

Default Value

''

Remarks

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

Data Type

String

FIPSMode Property (SecureBlackbox_KMIPClient Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();
public function setFIPSMode($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 127 );
secureblackbox_kmipclient_set($res, 127, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

InputBytes Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getInputBytes();
public function setInputBytes($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 128 );
secureblackbox_kmipclient_set($res, 128, $value );

Remarks

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

This property is not available at design time.

Data Type

Byte Array

InputFile Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getInputFile();
public function setInputFile($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 129 );
secureblackbox_kmipclient_set($res, 129, $value );

Default Value

''

Remarks

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

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

Data Type

String

KeyAlgorithm Property (SecureBlackbox_KMIPClient Class)

The algorithm of the cryptographic key.

Object Oriented Interface

public function getKeyAlgorithm();
public function setKeyAlgorithm($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 130 );
secureblackbox_kmipclient_set($res, 130, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

KeyBits Property (SecureBlackbox_KMIPClient Class)

The length of the key in bits.

Object Oriented Interface

public function getKeyBits();

Procedural Interface

secureblackbox_kmipclient_get($res, 131 );

Default Value

0

Remarks

The length of the key in bits.

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

Data Type

Integer

KeyHandle Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getKeyHandle();
public function setKeyHandle($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 135 );
secureblackbox_kmipclient_set($res, 135, $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

KeySubject Property (SecureBlackbox_KMIPClient Class)

Returns the key subject.

Object Oriented Interface

public function getKeySubject();
public function setKeySubject($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 142 );
secureblackbox_kmipclient_set($res, 142, $value );

Remarks

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

This property is not available at design time.

Data Type

Byte Array

KnownCertCount Property (SecureBlackbox_KMIPClient Class)

The number of records in the KnownCert arrays.

Object Oriented Interface

public function getKnownCertCount();
public function setKnownCertCount($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 145 );
secureblackbox_kmipclient_set($res, 145, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCertBytes
• KnownCertHandle

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

This property is not available at design time.

Data Type

Integer

KnownCertBytes Property (SecureBlackbox_KMIPClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getKnownCertBytes($knowncertindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 146 , $knowncertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

KnownCertHandle Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getKnownCertHandle($knowncertindex);
public function setKnownCertHandle($knowncertindex, $value);

Procedural Interface

secureblackbox_kmipclient_get($res, 154 , $knowncertindex);
secureblackbox_kmipclient_set($res, 154, $value , $knowncertindex);

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

This property is not available at design time.

Data Type

Long64

KnownCRLCount Property (SecureBlackbox_KMIPClient Class)

The number of records in the KnownCRL arrays.

Object Oriented Interface

public function getKnownCRLCount();
public function setKnownCRLCount($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 185 );
secureblackbox_kmipclient_set($res, 185, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCRLBytes
• KnownCRLHandle

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

This property is not available at design time.

Data Type

Integer

KnownCRLBytes Property (SecureBlackbox_KMIPClient Class)

Returns the raw CRL data in DER format.

Object Oriented Interface

public function getKnownCRLBytes($knowncrlindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 186 , $knowncrlindex);

Remarks

Returns the raw CRL data in DER format.

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

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

Data Type

Byte Array

KnownCRLHandle Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getKnownCRLHandle($knowncrlindex);
public function setKnownCRLHandle($knowncrlindex, $value);

Procedural Interface

secureblackbox_kmipclient_get($res, 189 , $knowncrlindex);
secureblackbox_kmipclient_set($res, 189, $value , $knowncrlindex);

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

This property is not available at design time.

Data Type

Long64

KnownOCSPCount Property (SecureBlackbox_KMIPClient Class)

The number of records in the KnownOCSP arrays.

Object Oriented Interface

public function getKnownOCSPCount();
public function setKnownOCSPCount($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 198 );
secureblackbox_kmipclient_set($res, 198, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownOCSPBytes
• KnownOCSPHandle

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

This property is not available at design time.

Data Type

Integer

KnownOCSPBytes Property (SecureBlackbox_KMIPClient Class)

A buffer containing the raw OCSP response data.

Object Oriented Interface

public function getKnownOCSPBytes($knownocspindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 199 , $knownocspindex);

Remarks

A buffer containing the raw OCSP response data.

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

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

Data Type

Byte Array

KnownOCSPHandle Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getKnownOCSPHandle($knownocspindex);
public function setKnownOCSPHandle($knownocspindex, $value);

Procedural Interface

secureblackbox_kmipclient_get($res, 201 , $knownocspindex);
secureblackbox_kmipclient_set($res, 201, $value , $knownocspindex);

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

This property is not available at design time.

Data Type

Long64

ObjectCount Property (SecureBlackbox_KMIPClient Class)

The number of records in the Object arrays.

Object Oriented Interface

public function getObjectCount();

Procedural Interface

secureblackbox_kmipclient_get($res, 208 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ObjectBytes
• ObjectExtractable
• ObjectFingerprint
• ObjectKeyAlgorithm
• ObjectKeyBits
• ObjectKeyUsage
• ObjectObjectGroup
• ObjectObjectId
• ObjectObjectType
• ObjectSensitive
• ObjectSize
• ObjectSubject
• ObjectTimestamp

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

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

Data Type

Integer

ObjectBytes Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getObjectBytes($objectindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 209 , $objectindex);

Remarks

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

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

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

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

Data Type

Byte Array

ObjectExtractable Property (SecureBlackbox_KMIPClient Class)

Specifies the extractable attribute of the object.

Object Oriented Interface

public function getObjectExtractable($objectindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 210 , $objectindex);

Default Value

false

Remarks

Specifies the extractable attribute of the object.

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

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

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

Data Type

Boolean

ObjectFingerprint Property (SecureBlackbox_KMIPClient Class)

Returns or sets the fingerprint attribute of the object.

Object Oriented Interface

public function getObjectFingerprint($objectindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 211 , $objectindex);

Remarks

Returns or sets the fingerprint attribute of the object.

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

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

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

Data Type

Byte Array

ObjectKeyAlgorithm Property (SecureBlackbox_KMIPClient Class)

Specifies the cryptographic algorithm of the object.

Object Oriented Interface

public function getObjectKeyAlgorithm($objectindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 212 , $objectindex);

Default Value

''

Remarks

Specifies the cryptographic algorithm of the object.

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

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

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

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

Data Type

String

ObjectKeyBits Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getObjectKeyBits($objectindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 213 , $objectindex);

Default Value

0

Remarks

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

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

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

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

Data Type

Integer

ObjectKeyUsage Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getObjectKeyUsage($objectindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 214 , $objectindex);

Default Value

0

Remarks

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

Key usage flags

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

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

Data Type

Integer

ObjectObjectGroup Property (SecureBlackbox_KMIPClient Class)

Specifies the object group identifier.

Object Oriented Interface

public function getObjectObjectGroup($objectindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 215 , $objectindex);

Default Value

''

Remarks

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

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

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

Data Type

String

ObjectObjectId Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getObjectObjectId($objectindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 216 , $objectindex);

Default Value

''

Remarks

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

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

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

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

Data Type

String

ObjectObjectType Property (SecureBlackbox_KMIPClient Class)

The type of this object.

Object Oriented Interface

public function getObjectObjectType($objectindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 217 , $objectindex);

Default Value

0

Remarks

The type of this object.

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

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

Data Type

Integer

ObjectSensitive Property (SecureBlackbox_KMIPClient Class)

Contains the Sensitive attribute of this object.

Object Oriented Interface

public function getObjectSensitive($objectindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 218 , $objectindex);

Default Value

false

Remarks

Contains the Sensitive attribute of this object.

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

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

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

Data Type

Boolean

ObjectSize Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getObjectSize($objectindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 219 , $objectindex);

Default Value

0

Remarks

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

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

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

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

Data Type

Integer

ObjectSubject Property (SecureBlackbox_KMIPClient Class)

Specifies the subject attribute of the object.

Object Oriented Interface

public function getObjectSubject($objectindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 220 , $objectindex);

Default Value

''

Remarks

Specifies the subject attribute of the object.

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

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

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

Data Type

String

ObjectTimestamp Property (SecureBlackbox_KMIPClient Class)

Returns the time value associated with this object.

Object Oriented Interface

public function getObjectTimestamp($objectindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 221 , $objectindex);

Default Value

''

Remarks

Returns the time value associated with this object.

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

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

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

Data Type

String

OutputBytes Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getOutputBytes();

Procedural Interface

secureblackbox_kmipclient_get($res, 222 );

Remarks

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

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

Data Type

Byte Array

OutputFile Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getOutputFile();
public function setOutputFile($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 223 );
secureblackbox_kmipclient_set($res, 223, $value );

Default Value

''

Remarks

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

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

Data Type

String

Password Property (SecureBlackbox_KMIPClient Class)

Specifies a password to authenticate to the KMIP server.

Object Oriented Interface

public function getPassword();
public function setPassword($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 224 );
secureblackbox_kmipclient_set($res, 224, $value );

Default Value

''

Remarks

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

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

Data Type

String

ProxyAddress Property (SecureBlackbox_KMIPClient Class)

The IP address of the proxy server.

Object Oriented Interface

public function getProxyAddress();
public function setProxyAddress($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 225 );
secureblackbox_kmipclient_set($res, 225, $value );

Default Value

''

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (SecureBlackbox_KMIPClient Class)

The authentication type used by the proxy server.

Object Oriented Interface

public function getProxyAuthentication();
public function setProxyAuthentication($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 226 );
secureblackbox_kmipclient_set($res, 226, $value );

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxyPassword Property (SecureBlackbox_KMIPClient Class)

The password to authenticate to the proxy server.

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 227 );
secureblackbox_kmipclient_set($res, 227, $value );

Default Value

''

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (SecureBlackbox_KMIPClient Class)

The port on the proxy server to connect to.

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 228 );
secureblackbox_kmipclient_set($res, 228, $value );

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (SecureBlackbox_KMIPClient Class)

The type of the proxy server.

Object Oriented Interface

public function getProxyProxyType();
public function setProxyProxyType($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 229 );
secureblackbox_kmipclient_set($res, 229, $value );

Default Value

0

Remarks

The type of the proxy server.

Data Type

Integer

ProxyRequestHeaders Property (SecureBlackbox_KMIPClient Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Object Oriented Interface

public function getProxyRequestHeaders();
public function setProxyRequestHeaders($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 230 );
secureblackbox_kmipclient_set($res, 230, $value );

Default Value

''

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getProxyResponseBody();
public function setProxyResponseBody($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 231 );
secureblackbox_kmipclient_set($res, 231, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyResponseHeaders Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getProxyResponseHeaders();
public function setProxyResponseHeaders($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 232 );
secureblackbox_kmipclient_set($res, 232, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyUseIPv6 Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getProxyUseIPv6();
public function setProxyUseIPv6($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 233 );
secureblackbox_kmipclient_set($res, 233, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyUsername Property (SecureBlackbox_KMIPClient Class)

Specifies the username credential for proxy authentication.

Object Oriented Interface

public function getProxyUsername();
public function setProxyUsername($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 234 );
secureblackbox_kmipclient_set($res, 234, $value );

Default Value

''

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

SignatureValidationResult Property (SecureBlackbox_KMIPClient Class)

The signature validation result.

Object Oriented Interface

public function getSignatureValidationResult();

Procedural Interface

secureblackbox_kmipclient_get($res, 235 );

Default Value

0

Remarks

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

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

Data Type

Integer

SocketDNSMode Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getSocketDNSMode();
public function setSocketDNSMode($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 236 );
secureblackbox_kmipclient_set($res, 236, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketDNSPort Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getSocketDNSPort();
public function setSocketDNSPort($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 237 );
secureblackbox_kmipclient_set($res, 237, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketDNSQueryTimeout Property (SecureBlackbox_KMIPClient Class)

The timeout (in milliseconds) for each DNS query.

Object Oriented Interface

public function getSocketDNSQueryTimeout();
public function setSocketDNSQueryTimeout($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 238 );
secureblackbox_kmipclient_set($res, 238, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketDNSServers Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getSocketDNSServers();
public function setSocketDNSServers($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 239 );
secureblackbox_kmipclient_set($res, 239, $value );

Default Value

''

Remarks

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

Data Type

String

SocketDNSTotalTimeout Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getSocketDNSTotalTimeout();
public function setSocketDNSTotalTimeout($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 240 );
secureblackbox_kmipclient_set($res, 240, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketIncomingSpeedLimit Property (SecureBlackbox_KMIPClient 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_kmipclient_get($res, 241 );
secureblackbox_kmipclient_set($res, 241, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (SecureBlackbox_KMIPClient Class)

The local network interface to bind the socket to.

Object Oriented Interface

public function getSocketLocalAddress();
public function setSocketLocalAddress($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 242 );
secureblackbox_kmipclient_set($res, 242, $value );

Default Value

''

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SecureBlackbox_KMIPClient Class)

The local port number to bind the socket to.

Object Oriented Interface

public function getSocketLocalPort();
public function setSocketLocalPort($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 243 );
secureblackbox_kmipclient_set($res, 243, $value );

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SecureBlackbox_KMIPClient 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_kmipclient_get($res, 244 );
secureblackbox_kmipclient_set($res, 244, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (SecureBlackbox_KMIPClient 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_kmipclient_get($res, 245 );
secureblackbox_kmipclient_set($res, 245, $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_KMIPClient Class)

Enables or disables IP protocol version 6.

Object Oriented Interface

public function getSocketUseIPv6();
public function setSocketUseIPv6($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 246 );
secureblackbox_kmipclient_set($res, 246, $value );

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

TLSClientCertCount Property (SecureBlackbox_KMIPClient Class)

The number of records in the TLSClientCert arrays.

Object Oriented Interface

public function getTLSClientCertCount();
public function setTLSClientCertCount($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 247 );
secureblackbox_kmipclient_set($res, 247, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• TLSClientCertBytes
• TLSClientCertHandle

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

This property is not available at design time.

Data Type

Integer

TLSClientCertBytes Property (SecureBlackbox_KMIPClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTLSClientCertBytes($tlsclientcertindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 248 , $tlsclientcertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

TLSClientCertHandle Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getTLSClientCertHandle($tlsclientcertindex);
public function setTLSClientCertHandle($tlsclientcertindex, $value);

Procedural Interface

secureblackbox_kmipclient_get($res, 256 , $tlsclientcertindex);
secureblackbox_kmipclient_set($res, 256, $value , $tlsclientcertindex);

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

This property is not available at design time.

Data Type

Long64

TLSServerCertCount Property (SecureBlackbox_KMIPClient Class)

The number of records in the TLSServerCert arrays.

Object Oriented Interface

public function getTLSServerCertCount();

Procedural Interface

secureblackbox_kmipclient_get($res, 287 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• TLSServerCertBytes
• TLSServerCertFingerprint
• TLSServerCertHandle
• TLSServerCertIssuer
• TLSServerCertIssuerRDN
• TLSServerCertKeyAlgorithm
• TLSServerCertKeyBits
• TLSServerCertKeyUsage
• TLSServerCertSelfSigned
• TLSServerCertSerialNumber
• TLSServerCertSigAlgorithm
• TLSServerCertSubject
• TLSServerCertSubjectRDN
• TLSServerCertValidFrom
• TLSServerCertValidTo

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

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

Data Type

Integer

TLSServerCertBytes Property (SecureBlackbox_KMIPClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTLSServerCertBytes($tlsservercertindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 288 , $tlsservercertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

TLSServerCertFingerprint Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getTLSServerCertFingerprint($tlsservercertindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 294 , $tlsservercertindex);

Default Value

''

Remarks

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

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

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

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

Data Type

String

TLSServerCertHandle Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getTLSServerCertHandle($tlsservercertindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 296 , $tlsservercertindex);

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

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

Data Type

Long64

TLSServerCertIssuer Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getTLSServerCertIssuer($tlsservercertindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 298 , $tlsservercertindex);

Default Value

''

Remarks

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

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

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

Data Type

String

TLSServerCertIssuerRDN Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getTLSServerCertIssuerRDN($tlsservercertindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 299 , $tlsservercertindex);

Default Value

''

Remarks

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

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

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

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

Data Type

String

TLSServerCertKeyAlgorithm Property (SecureBlackbox_KMIPClient Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getTLSServerCertKeyAlgorithm($tlsservercertindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 300 , $tlsservercertindex);

Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

Use the TLSKeyBits, TLSCurve, and TLSPublicKeyBytes properties to get more details about the key the certificate contains.

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

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

Data Type

String

TLSServerCertKeyBits Property (SecureBlackbox_KMIPClient Class)

Returns the length of the public key in bits.

Object Oriented Interface

public function getTLSServerCertKeyBits($tlsservercertindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 301 , $tlsservercertindex);

Default Value

0

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the TLSPublicKeyBytes or TLSPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

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

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

Data Type

Integer

TLSServerCertKeyUsage Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getTLSServerCertKeyUsage($tlsservercertindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 303 , $tlsservercertindex);

Default Value

0

Remarks

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

This value is a bit mask of the following values:

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

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

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

Data Type

Integer

TLSServerCertSelfSigned Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getTLSServerCertSelfSigned($tlsservercertindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 316 , $tlsservercertindex);

Default Value

false

Remarks

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

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

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

Data Type

Boolean

TLSServerCertSerialNumber Property (SecureBlackbox_KMIPClient Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getTLSServerCertSerialNumber($tlsservercertindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 317 , $tlsservercertindex);

Remarks

Returns the certificate's serial number.

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

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

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

Data Type

Byte Array

TLSServerCertSigAlgorithm Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getTLSServerCertSigAlgorithm($tlsservercertindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 318 , $tlsservercertindex);

Default Value

''

Remarks

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

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

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

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

Data Type

String

TLSServerCertSubject Property (SecureBlackbox_KMIPClient 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 getTLSServerCertSubject($tlsservercertindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 320 , $tlsservercertindex);

Default Value

''

Remarks

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

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

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

Data Type

String

TLSServerCertSubjectRDN Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getTLSServerCertSubjectRDN($tlsservercertindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 323 , $tlsservercertindex);

Default Value

''

Remarks

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

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

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

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

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

Data Type

String

TLSServerCertValidFrom Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getTLSServerCertValidFrom($tlsservercertindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 325 , $tlsservercertindex);

Default Value

''

Remarks

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

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

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

Data Type

String

TLSServerCertValidTo Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getTLSServerCertValidTo($tlsservercertindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 326 , $tlsservercertindex);

Default Value

''

Remarks

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

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

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

Data Type

String

TLSAutoValidateCertificates Property (SecureBlackbox_KMIPClient 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_kmipclient_get($res, 327 );
secureblackbox_kmipclient_set($res, 327, $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_KMIPClient Class)

Selects the base configuration for the TLS settings.

Object Oriented Interface

public function getTLSBaseConfiguration();
public function setTLSBaseConfiguration($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 328 );
secureblackbox_kmipclient_set($res, 328, $value );

Default Value

0

Remarks

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

Data Type

Integer

TLSCiphersuites Property (SecureBlackbox_KMIPClient Class)

A list of ciphersuites separated with commas or semicolons.

Object Oriented Interface

public function getTLSCiphersuites();
public function setTLSCiphersuites($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 329 );
secureblackbox_kmipclient_set($res, 329, $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, allowing all ciphersuites to be blanketly enabled or disabled at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by TLSBaseConfiguration. 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

TLSClientAuth Property (SecureBlackbox_KMIPClient Class)

Enables or disables certificate-based client authentication.

Object Oriented Interface

public function getTLSClientAuth();
public function setTLSClientAuth($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 330 );
secureblackbox_kmipclient_set($res, 330, $value );

Default Value

0

Remarks

Enables or disables certificate-based client authentication.

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

Data Type

Integer

TLSECCurves Property (SecureBlackbox_KMIPClient Class)

Defines the elliptic curves to enable.

Object Oriented Interface

public function getTLSECCurves();
public function setTLSECCurves($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 331 );
secureblackbox_kmipclient_set($res, 331, $value );

Default Value

''

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (SecureBlackbox_KMIPClient Class)

Provides access to TLS extensions.

Object Oriented Interface

public function getTLSExtensions();
public function setTLSExtensions($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 332 );
secureblackbox_kmipclient_set($res, 332, $value );

Default Value

''

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (SecureBlackbox_KMIPClient 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_kmipclient_get($res, 333 );
secureblackbox_kmipclient_set($res, 333, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSPreSharedIdentity Property (SecureBlackbox_KMIPClient 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_kmipclient_get($res, 334 );
secureblackbox_kmipclient_set($res, 334, $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_KMIPClient Class)

Contains the pre-shared key 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_kmipclient_get($res, 335 );
secureblackbox_kmipclient_set($res, 335, $value );

Default Value

''

Remarks

Contains the pre-shared key 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_KMIPClient Class)

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

Object Oriented Interface

public function getTLSPreSharedKeyCiphersuite();
public function setTLSPreSharedKeyCiphersuite($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 336 );
secureblackbox_kmipclient_set($res, 336, $value );

Default Value

''

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (SecureBlackbox_KMIPClient Class)

Selects the renegotiation attack prevention mechanism.

Object Oriented Interface

public function getTLSRenegotiationAttackPreventionMode();
public function setTLSRenegotiationAttackPreventionMode($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 337 );
secureblackbox_kmipclient_set($res, 337, $value );

Default Value

2

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getTLSRevocationCheck();
public function setTLSRevocationCheck($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 338 );
secureblackbox_kmipclient_set($res, 338, $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 for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

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

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

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

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

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getTLSSSLOptions();
public function setTLSSSLOptions($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 339 );
secureblackbox_kmipclient_set($res, 339, $value );

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (SecureBlackbox_KMIPClient Class)

Specifies the TLS mode to use.

Object Oriented Interface

public function getTLSTLSMode();
public function setTLSTLSMode($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 340 );
secureblackbox_kmipclient_set($res, 340, $value );

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getTLSUseExtendedMasterSecret();
public function setTLSUseExtendedMasterSecret($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 341 );
secureblackbox_kmipclient_set($res, 341, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (SecureBlackbox_KMIPClient Class)

Enables or disables the TLS session resumption capability.

Object Oriented Interface

public function getTLSUseSessionResumption();
public function setTLSUseSessionResumption($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 342 );
secureblackbox_kmipclient_set($res, 342, $value );

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (SecureBlackbox_KMIPClient Class)

The SSL/TLS versions to enable by default.

Object Oriented Interface

public function getTLSVersions();
public function setTLSVersions($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 343 );
secureblackbox_kmipclient_set($res, 343, $value );

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

TrustedCertCount Property (SecureBlackbox_KMIPClient Class)

The number of records in the TrustedCert arrays.

Object Oriented Interface

public function getTrustedCertCount();
public function setTrustedCertCount($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 344 );
secureblackbox_kmipclient_set($res, 344, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• TrustedCertBytes
• TrustedCertHandle

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

This property is not available at design time.

Data Type

Integer

TrustedCertBytes Property (SecureBlackbox_KMIPClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTrustedCertBytes($trustedcertindex);

Procedural Interface

secureblackbox_kmipclient_get($res, 345 , $trustedcertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

TrustedCertHandle Property (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function getTrustedCertHandle($trustedcertindex);
public function setTrustedCertHandle($trustedcertindex, $value);

Procedural Interface

secureblackbox_kmipclient_get($res, 353 , $trustedcertindex);
secureblackbox_kmipclient_set($res, 353, $value , $trustedcertindex);

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

This property is not available at design time.

Data Type

Long64

Username Property (SecureBlackbox_KMIPClient Class)

The username to authenticate to the KMIP server.

Object Oriented Interface

public function getUsername();
public function setUsername($value);

Procedural Interface

secureblackbox_kmipclient_get($res, 384 );
secureblackbox_kmipclient_set($res, 384, $value );

Default Value

''

Remarks

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

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

Data Type

String

Activate Method (SecureBlackbox_KMIPClient Class)

Activates the specified server object.

Object Oriented Interface

public function doActivate($objectid);

Procedural Interface

secureblackbox_kmipclient_do_activate($res, $objectid);

Remarks

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

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

Add Method (SecureBlackbox_KMIPClient Class)

Imports a certificate to the KMIP server.

Object Oriented Interface

public function doAdd($addprivatekey, $group, $activate);

Procedural Interface

secureblackbox_kmipclient_do_add($res, $addprivatekey, $group, $activate);

Remarks

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

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

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

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

AddKey Method (SecureBlackbox_KMIPClient Class)

Imports a key or keypair to the KMIP server.

Object Oriented Interface

public function doAddKey($group, $activate);

Procedural Interface

secureblackbox_kmipclient_do_addkey($res, $group, $activate);

Remarks

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

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

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

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

Config Method (SecureBlackbox_KMIPClient Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

CustomRequest Method (SecureBlackbox_KMIPClient Class)

Performs a custom request to the server.

Object Oriented Interface

public function doCustomRequest($data);

Procedural Interface

secureblackbox_kmipclient_do_customrequest($res, $data);

Remarks

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

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

Deactivate Method (SecureBlackbox_KMIPClient Class)

Deactivates the specified server object.

Object Oriented Interface

public function doDeactivate($objectid);

Procedural Interface

secureblackbox_kmipclient_do_deactivate($res, $objectid);

Remarks

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

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

Decrypt Method (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function doDecrypt($objectid, $algorithm, $iv, $blockmode, $paddingmethod, $taglength);

Procedural Interface

secureblackbox_kmipclient_do_decrypt($res, $objectid, $algorithm, $iv, $blockmode, $paddingmethod, $taglength);

Remarks

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

Provide the encrypted data via one of the Input* properties (InputFile, InputStream, or InputBytes). The decrypted data will be saved to one of the output properties.

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

DoAction Method (SecureBlackbox_KMIPClient Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_kmipclient_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 insensitive) of the action is provided in the ActionID parameter.

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

Common ActionIDs:

Encrypt Method (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function doEncrypt($objectid, $algorithm, $iv, $blockmode, $paddingmethod, $taglength);

Procedural Interface

secureblackbox_kmipclient_do_encrypt($res, $objectid, $algorithm, $iv, $blockmode, $paddingmethod, $taglength);

Remarks

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

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

Generate Method (SecureBlackbox_KMIPClient Class)

Generates a new certificate on the KMIP server.

Object Oriented Interface

public function doGenerate($publickeyid, $activate);

Procedural Interface

secureblackbox_kmipclient_do_generate($res, $publickeyid, $activate);

Remarks

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

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

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

GenerateKey Method (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function doGenerateKey($keyalgorithm, $scheme, $schemeparams, $keybits, $group, $activate);

Procedural Interface

secureblackbox_kmipclient_do_generatekey($res, $keyalgorithm, $scheme, $schemeparams, $keybits, $group, $activate);

Remarks

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

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

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

List Method (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function doList($objecttypes, $filter, $offsetitems, $maximumitems, $freshonly);

Procedural Interface

secureblackbox_kmipclient_do_list($res, $objecttypes, $filter, $offsetitems, $maximumitems, $freshonly);

Remarks

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

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

Read Method (SecureBlackbox_KMIPClient Class)

Downloads a certificate from the KMIP server.

Object Oriented Interface

public function doRead($objectid);

Procedural Interface

secureblackbox_kmipclient_do_read($res, $objectid);

Remarks

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

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

ReadAttribute Method (SecureBlackbox_KMIPClient Class)

Requests an attribute from an object.

Object Oriented Interface

public function doReadAttribute($objectid, $name);

Procedural Interface

secureblackbox_kmipclient_do_readattribute($res, $objectid, $name);

Remarks

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

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

ReadKey Method (SecureBlackbox_KMIPClient Class)

Downloads a key object from the KMIP server.

Object Oriented Interface

public function doReadKey($objectid);

Procedural Interface

secureblackbox_kmipclient_do_readkey($res, $objectid);

Remarks

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

The key data is populated in the Key property.

ReadObject Method (SecureBlackbox_KMIPClient Class)

Requests object information from the KMIP server.

Object Oriented Interface

public function doReadObject($objectid);

Procedural Interface

secureblackbox_kmipclient_do_readobject($res, $objectid);

Remarks

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

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

Remove Method (SecureBlackbox_KMIPClient Class)

Removes the specified object from the server.

Object Oriented Interface

public function doRemove($objectid);

Procedural Interface

secureblackbox_kmipclient_do_remove($res, $objectid);

Remarks

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

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

Reset Method (SecureBlackbox_KMIPClient Class)

Resets the class settings.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_kmipclient_do_reset($res);

Remarks

Reset is a generic method available in every class.

SetAttribute Method (SecureBlackbox_KMIPClient Class)

Sets an attribute of an existing server-side object.

Object Oriented Interface

public function doSetAttribute($objectid, $name, $value, $delete);

Procedural Interface

secureblackbox_kmipclient_do_setattribute($res, $objectid, $name, $value, $delete);

Remarks

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

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

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

SetRequestBytes Method (SecureBlackbox_KMIPClient Class)

Replaces the data that has been prepared for sending out.

Object Oriented Interface

public function doSetRequestBytes($value);

Procedural Interface

secureblackbox_kmipclient_do_setrequestbytes($res, $value);

Remarks

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

SetResponseBytes Method (SecureBlackbox_KMIPClient Class)

Alters the data received from the server in a response.

Object Oriented Interface

public function doSetResponseBytes($value);

Procedural Interface

secureblackbox_kmipclient_do_setresponsebytes($res, $value);

Remarks

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

Sign Method (SecureBlackbox_KMIPClient Class)

Signs the data using a key on the KMIP server.

Object Oriented Interface

public function doSign($objectid, $algorithm, $paddingmethod, $hashalgorithm, $inputishash);

Procedural Interface

secureblackbox_kmipclient_do_sign($res, $objectid, $algorithm, $paddingmethod, $hashalgorithm, $inputishash);

Remarks

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

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

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

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

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

Verify Method (SecureBlackbox_KMIPClient Class)

Verifies digitally signed data.

Object Oriented Interface

public function doVerify($objectid, $algorithm, $paddingmethod, $hashalgorithm, $inputishash);

Procedural Interface

secureblackbox_kmipclient_do_verify($res, $objectid, $algorithm, $paddingmethod, $hashalgorithm, $inputishash);

Remarks

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

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

Provide additional parameters of the operation:

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

Error Event (SecureBlackbox_KMIPClient Class)

Provides information about errors during KMIP operations.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_kmipclient_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

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

ExternalSign Event (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function fireExternalSign($param);

Procedural Interface

secureblackbox_kmipclient_register_callback($res, 2, array($this, 'fireExternalSign'));

Parameter List

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

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

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

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

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

Notification Event (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

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

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

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

Request Event (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function fireRequest($param);

Procedural Interface

secureblackbox_kmipclient_register_callback($res, 4, array($this, 'fireRequest'));

Parameter List

 'requestdata'

Remarks

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

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

Response Event (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function fireResponse($param);

Procedural Interface

secureblackbox_kmipclient_register_callback($res, 5, array($this, 'fireResponse'));

Parameter List

 'responsedata'

Remarks

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

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

TLSCertNeeded Event (SecureBlackbox_KMIPClient Class)

Fires when a remote TLS party requests a client certificate.

Object Oriented Interface

public function fireTLSCertNeeded($param);

Procedural Interface

secureblackbox_kmipclient_register_callback($res, 6, array($this, 'fireTLSCertNeeded'));

Parameter List

 'host'
 'canames'

Remarks

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

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

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

TLSCertValidate Event (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function fireTLSCertValidate($param);

Procedural Interface

secureblackbox_kmipclient_register_callback($res, 7, array($this, 'fireTLSCertValidate'));

Parameter List

 'serverhost'
 'serverip'
 'accept'

Remarks

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

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

TLSEstablished Event (SecureBlackbox_KMIPClient Class)

Fires when a TLS handshake with Host successfully completes.

Object Oriented Interface

public function fireTLSEstablished($param);

Procedural Interface

secureblackbox_kmipclient_register_callback($res, 8, array($this, 'fireTLSEstablished'));

Parameter List

 'host'
 'version'
 'ciphersuite'
 'connectionid'
 'abort'

Remarks

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

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

TLSHandshake Event (SecureBlackbox_KMIPClient Class)

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

Object Oriented Interface

public function fireTLSHandshake($param);

Procedural Interface

secureblackbox_kmipclient_register_callback($res, 9, array($this, 'fireTLSHandshake'));

Parameter List

 'host'
 'abort'

Remarks

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

TLSPSK Event (SecureBlackbox_KMIPClient Class)

Notifies the application about the PSK key exchange.

Object Oriented Interface

public function fireTLSPSK($param);

Procedural Interface

secureblackbox_kmipclient_register_callback($res, 10, array($this, 'fireTLSPSK'));

Parameter List

 'host'
 'hint'

Remarks

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

TLSShutdown Event (SecureBlackbox_KMIPClient Class)

Reports the graceful closure of a TLS connection.

Object Oriented Interface

public function fireTLSShutdown($param);

Procedural Interface

secureblackbox_kmipclient_register_callback($res, 11, array($this, 'fireTLSShutdown'));

Parameter List

 'host'

Remarks

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

Config Settings (KMIPClient Class)

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

KMIPClient Config Settings

Base Config Settings

Trappable Errors (KMIPClient Class)

KMIPClient Errors