RESTClient Class

Properties   Methods   Events   Config Settings   Errors  

The RESTClient class implements client-side functionality for the REST protocol.

Class Name

SecureBlackbox_RESTClient

Procedural Interface

 secureblackbox_restclient_open();
 secureblackbox_restclient_close($res);
 secureblackbox_restclient_register_callback($res, $id, $function);
 secureblackbox_restclient_get_last_error($res);
 secureblackbox_restclient_get_last_error_code($res);
 secureblackbox_restclient_set($res, $id, $index, $value);
 secureblackbox_restclient_get($res, $id, $index);
 secureblackbox_restclient_do_config($res, $configurationstring);
 secureblackbox_restclient_do_delete($res, $url);
 secureblackbox_restclient_do_doaction($res, $actionid, $actionparams);
 secureblackbox_restclient_do_get($res, $url);
 secureblackbox_restclient_do_head($res, $url);
 secureblackbox_restclient_do_options($res, $url);
 secureblackbox_restclient_do_post($res, $url, $content);
 secureblackbox_restclient_do_postbytes($res, $url, $contentbytes);
 secureblackbox_restclient_do_postfile($res, $url, $filename);
 secureblackbox_restclient_do_postjson($res, $url, $content);
 secureblackbox_restclient_do_postwebform($res, $url, $fields, $filefield, $filename, $contenttype);
 secureblackbox_restclient_do_postxml($res, $url, $content);
 secureblackbox_restclient_do_put($res, $url, $content);
 secureblackbox_restclient_do_putbytes($res, $url, $contentbytes);
 secureblackbox_restclient_do_putfile($res, $url, $filename);
 secureblackbox_restclient_do_putjson($res, $url, $content);
 secureblackbox_restclient_do_putxml($res, $url, $content);
 secureblackbox_restclient_do_reset($res);
 secureblackbox_restclient_do_trace($res, $url);

Remarks

RESTClient allows you to send requests to a REST server and receive server responses. It supports both plain (HTTP) and secure (HTTPS) modes.

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_RESTClient Class)

Defines allowed HTTP authentication types.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 1 );
secureblackbox_restclient_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

BlockedCertCount Property (SecureBlackbox_RESTClient Class)

The number of records in the BlockedCert arrays.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 2 );
secureblackbox_restclient_set($res, 2, $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_RESTClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getBlockedCertBytes($blockedcertindex);

Procedural Interface

secureblackbox_restclient_get($res, 3 , $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_RESTClient 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_restclient_get($res, 11 , $blockedcertindex);
secureblackbox_restclient_set($res, 11, $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

ConnInfoAEADCipher Property (SecureBlackbox_RESTClient Class)

Indicates whether the encryption algorithm used is an AEAD cipher.

Object Oriented Interface

public function getConnInfoAEADCipher();

Procedural Interface

secureblackbox_restclient_get($res, 42 );

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_RESTClient Class)

The details of a certificate chain validation outcome.

Object Oriented Interface

public function getConnInfoChainValidationDetails();

Procedural Interface

secureblackbox_restclient_get($res, 43 );

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_RESTClient Class)

The outcome of a certificate chain validation routine.

Object Oriented Interface

public function getConnInfoChainValidationResult();

Procedural Interface

secureblackbox_restclient_get($res, 44 );

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_RESTClient Class)

The cipher suite employed by this connection.

Object Oriented Interface

public function getConnInfoCiphersuite();

Procedural Interface

secureblackbox_restclient_get($res, 45 );

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_RESTClient Class)

Specifies whether client authentication was performed during this connection.

Object Oriented Interface

public function getConnInfoClientAuthenticated();

Procedural Interface

secureblackbox_restclient_get($res, 46 );

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_RESTClient Class)

Specifies whether client authentication was requested during this connection.

Object Oriented Interface

public function getConnInfoClientAuthRequested();

Procedural Interface

secureblackbox_restclient_get($res, 47 );

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_RESTClient Class)

Indicates whether the connection has been established fully.

Object Oriented Interface

public function getConnInfoConnectionEstablished();

Procedural Interface

secureblackbox_restclient_get($res, 48 );

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_RESTClient Class)

The unique identifier assigned to this connection.

Object Oriented Interface

public function getConnInfoConnectionID();

Procedural Interface

secureblackbox_restclient_get($res, 49 );

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_RESTClient Class)

The digest algorithm used in a TLS-enabled connection.

Object Oriented Interface

public function getConnInfoDigestAlgorithm();

Procedural Interface

secureblackbox_restclient_get($res, 50 );

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_RESTClient Class)

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

Object Oriented Interface

public function getConnInfoEncryptionAlgorithm();

Procedural Interface

secureblackbox_restclient_get($res, 51 );

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_RESTClient Class)

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

Object Oriented Interface

public function getConnInfoExportable();

Procedural Interface

secureblackbox_restclient_get($res, 52 );

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_RESTClient Class)

The client connection's unique identifier.

Object Oriented Interface

public function getConnInfoID();

Procedural Interface

secureblackbox_restclient_get($res, 53 );

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_RESTClient Class)

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

Object Oriented Interface

public function getConnInfoKeyExchangeAlgorithm();

Procedural Interface

secureblackbox_restclient_get($res, 54 );

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_RESTClient Class)

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

Object Oriented Interface

public function getConnInfoKeyExchangeKeyBits();

Procedural Interface

secureblackbox_restclient_get($res, 55 );

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_RESTClient Class)

The elliptic curve used in this connection.

Object Oriented Interface

public function getConnInfoNamedECCurve();

Procedural Interface

secureblackbox_restclient_get($res, 56 );

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_RESTClient Class)

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

Object Oriented Interface

public function getConnInfoPFSCipher();

Procedural Interface

secureblackbox_restclient_get($res, 57 );

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_RESTClient 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_restclient_get($res, 58 );

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_RESTClient 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_restclient_get($res, 59 );

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_RESTClient Class)

The length of the public key.

Object Oriented Interface

public function getConnInfoPublicKeyBits();

Procedural Interface

secureblackbox_restclient_get($res, 60 );

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_RESTClient Class)

The client's IP address.

Object Oriented Interface

public function getConnInfoRemoteAddress();

Procedural Interface

secureblackbox_restclient_get($res, 61 );

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_RESTClient Class)

The remote port of the client connection.

Object Oriented Interface

public function getConnInfoRemotePort();

Procedural Interface

secureblackbox_restclient_get($res, 62 );

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_RESTClient Class)

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

Object Oriented Interface

public function getConnInfoResumedSession();

Procedural Interface

secureblackbox_restclient_get($res, 63 );

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_RESTClient Class)

Indicates whether TLS or SSL is enabled for this connection.

Object Oriented Interface

public function getConnInfoSecureConnection();

Procedural Interface

secureblackbox_restclient_get($res, 64 );

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_RESTClient Class)

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

Object Oriented Interface

public function getConnInfoServerAuthenticated();

Procedural Interface

secureblackbox_restclient_get($res, 65 );

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_RESTClient Class)

The signature algorithm used in a TLS handshake.

Object Oriented Interface

public function getConnInfoSignatureAlgorithm();

Procedural Interface

secureblackbox_restclient_get($res, 66 );

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_RESTClient Class)

The block size of the symmetric algorithm used.

Object Oriented Interface

public function getConnInfoSymmetricBlockSize();

Procedural Interface

secureblackbox_restclient_get($res, 67 );

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_RESTClient Class)

The key length of the symmetric algorithm used.

Object Oriented Interface

public function getConnInfoSymmetricKeyBits();

Procedural Interface

secureblackbox_restclient_get($res, 68 );

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_RESTClient Class)

The total number of bytes received over this connection.

Object Oriented Interface

public function getConnInfoTotalBytesReceived();

Procedural Interface

secureblackbox_restclient_get($res, 69 );

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_RESTClient Class)

The total number of bytes sent over this connection.

Object Oriented Interface

public function getConnInfoTotalBytesSent();

Procedural Interface

secureblackbox_restclient_get($res, 70 );

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_RESTClient Class)

Contains the server certificate's chain validation log.

Object Oriented Interface

public function getConnInfoValidationLog();

Procedural Interface

secureblackbox_restclient_get($res, 71 );

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_RESTClient Class)

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

Object Oriented Interface

public function getConnInfoVersion();

Procedural Interface

secureblackbox_restclient_get($res, 72 );

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

CustomRequest Property (SecureBlackbox_RESTClient Class)

Specifies a custom request verb.

Object Oriented Interface

public function getCustomRequest();
public function setCustomRequest($value);

Procedural Interface

secureblackbox_restclient_get($res, 73 );
secureblackbox_restclient_set($res, 73, $value );

Default Value

''

Remarks

Use this property to specify a custom HTTP method verb to use instead of the original method. PATCH is one of the commonly used custom verbs.

This property is not available at design time.

Data Type

String

DynamicData Property (SecureBlackbox_RESTClient Class)

Takes a piece of data to be sent to the server within a dynamic POST or PUT request.

Object Oriented Interface

public function getDynamicData();
public function setDynamicData($value);

Procedural Interface

secureblackbox_restclient_get($res, 74 );
secureblackbox_restclient_set($res, 74, $value );

Remarks

Assign the next chunk of data to this property from your DynamicDataNeeded event handler to pass it to the server. Leave it empty to tell the component that no more data is available.

This property is not available at design time.

Data Type

Byte Array

ExternalCryptoAsyncDocumentID Property (SecureBlackbox_RESTClient Class)

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

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 75 );
secureblackbox_restclient_set($res, 75, $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_RESTClient Class)

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

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 76 );
secureblackbox_restclient_set($res, 76, $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_RESTClient 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_restclient_get($res, 77 );
secureblackbox_restclient_set($res, 77, $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_RESTClient 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_restclient_get($res, 78 );
secureblackbox_restclient_set($res, 78, $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_RESTClient Class)

Specifies the request's signature hash algorithm.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 79 );
secureblackbox_restclient_set($res, 79, $value );

Default Value

'SHA256'

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SecureBlackbox_RESTClient 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_restclient_get($res, 80 );
secureblackbox_restclient_set($res, 80, $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_RESTClient Class)

The pre-shared key used for DC request authentication.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 81 );
secureblackbox_restclient_set($res, 81, $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_RESTClient Class)

Specifies the asynchronous signing method.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 82 );
secureblackbox_restclient_set($res, 82, $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_RESTClient Class)

Specifies the external cryptography mode.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 83 );
secureblackbox_restclient_set($res, 83, $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_RESTClient 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_restclient_get($res, 84 );
secureblackbox_restclient_set($res, 84, $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_RESTClient Class)

Reserved.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 85 );
secureblackbox_restclient_set($res, 85, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

KeepAlivePolicy Property (SecureBlackbox_RESTClient Class)

Defines the keep-alive handling policy.

Object Oriented Interface

public function getKeepAlivePolicy();
public function setKeepAlivePolicy($value);

Procedural Interface

secureblackbox_restclient_get($res, 86 );
secureblackbox_restclient_set($res, 86, $value );

Default Value

0

Remarks

Use this property to tune-up the keep-alive mechanism as per the needs of your application.

Data Type

Integer

KnownCertCount Property (SecureBlackbox_RESTClient Class)

The number of records in the KnownCert arrays.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 87 );
secureblackbox_restclient_set($res, 87, $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_RESTClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getKnownCertBytes($knowncertindex);

Procedural Interface

secureblackbox_restclient_get($res, 88 , $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_RESTClient 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_restclient_get($res, 96 , $knowncertindex);
secureblackbox_restclient_set($res, 96, $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_RESTClient Class)

The number of records in the KnownCRL arrays.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 127 );
secureblackbox_restclient_set($res, 127, $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_RESTClient Class)

Returns the raw CRL data in DER format.

Object Oriented Interface

public function getKnownCRLBytes($knowncrlindex);

Procedural Interface

secureblackbox_restclient_get($res, 128 , $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_RESTClient 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_restclient_get($res, 131 , $knowncrlindex);
secureblackbox_restclient_set($res, 131, $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_RESTClient Class)

The number of records in the KnownOCSP arrays.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 140 );
secureblackbox_restclient_set($res, 140, $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_RESTClient Class)

A buffer containing the raw OCSP response data.

Object Oriented Interface

public function getKnownOCSPBytes($knownocspindex);

Procedural Interface

secureblackbox_restclient_get($res, 141 , $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_RESTClient 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_restclient_get($res, 143 , $knownocspindex);
secureblackbox_restclient_set($res, 143, $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

OutputBytes Property (SecureBlackbox_RESTClient Class)

Contains the response content.

Object Oriented Interface

public function getOutputBytes();

Procedural Interface

secureblackbox_restclient_get($res, 150 );

Remarks

Use this property to access the content received from the server in response to a prior request.

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

Data Type

Byte Array

OutputFile Property (SecureBlackbox_RESTClient Class)

A path to the output file.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 151 );
secureblackbox_restclient_set($res, 151, $value );

Default Value

''

Remarks

Use this property to specify the file to store the content received from the server in response to a prior request.

Data Type

String

OutputString Property (SecureBlackbox_RESTClient Class)

Contains the response content.

Object Oriented Interface

public function getOutputString();

Procedural Interface

secureblackbox_restclient_get($res, 152 );

Default Value

''

Remarks

Use this property to access the content received from the server in response to a prior request, as a string.

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

Data Type

String

ProxyAddress Property (SecureBlackbox_RESTClient Class)

The IP address of the proxy server.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 153 );
secureblackbox_restclient_set($res, 153, $value );

Default Value

''

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (SecureBlackbox_RESTClient Class)

The authentication type used by the proxy server.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 154 );
secureblackbox_restclient_set($res, 154, $value );

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxyPassword Property (SecureBlackbox_RESTClient Class)

The password to authenticate to the proxy server.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 155 );
secureblackbox_restclient_set($res, 155, $value );

Default Value

''

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (SecureBlackbox_RESTClient Class)

The port on the proxy server to connect to.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 156 );
secureblackbox_restclient_set($res, 156, $value );

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (SecureBlackbox_RESTClient Class)

The type of the proxy server.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 157 );
secureblackbox_restclient_set($res, 157, $value );

Default Value

0

Remarks

The type of the proxy server.

Data Type

Integer

ProxyRequestHeaders Property (SecureBlackbox_RESTClient Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 158 );
secureblackbox_restclient_set($res, 158, $value );

Default Value

''

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (SecureBlackbox_RESTClient Class)

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

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 159 );
secureblackbox_restclient_set($res, 159, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyResponseHeaders Property (SecureBlackbox_RESTClient 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_restclient_get($res, 160 );
secureblackbox_restclient_set($res, 160, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyUseIPv6 Property (SecureBlackbox_RESTClient 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_restclient_get($res, 161 );
secureblackbox_restclient_set($res, 161, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyUsername Property (SecureBlackbox_RESTClient Class)

Specifies the username credential for proxy authentication.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 162 );
secureblackbox_restclient_set($res, 162, $value );

Default Value

''

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

ReasonPhrase Property (SecureBlackbox_RESTClient Class)

Contains the Reason Phrase element of the server's response.

Object Oriented Interface

public function getReasonPhrase();

Procedural Interface

secureblackbox_restclient_get($res, 163 );

Default Value

''

Remarks

Use this property to access the reason phrase supplied by the server in its response (such as OK in HTTP 200 OK).

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

Data Type

String

ReqHeaderCount Property (SecureBlackbox_RESTClient Class)

The number of records in the ReqHeader arrays.

Object Oriented Interface

public function getReqHeaderCount();
public function setReqHeaderCount($value);

Procedural Interface

secureblackbox_restclient_get($res, 164 );
secureblackbox_restclient_set($res, 164, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ReqHeaderCategory
• ReqHeaderFormat
• ReqHeaderName
• ReqHeaderValue

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

This property is not available at design time.

Data Type

Integer

ReqHeaderCategory Property (SecureBlackbox_RESTClient Class)

Specifies the string category of the contained value.

Object Oriented Interface

public function getReqHeaderCategory($reqheaderindex);
public function setReqHeaderCategory($reqheaderindex, $value);

Procedural Interface

secureblackbox_restclient_get($res, 165 , $reqheaderindex);
secureblackbox_restclient_set($res, 165, $value , $reqheaderindex);

Default Value

''

Remarks

Specifies the string category of the contained value.

This property allows to check or set the category (or type) associated with the contained value. Depending on the format used to load or save the string, the category parameter may or may not be used.

For example, for ASN.1 property lists the category contains the ASN.1 tag of the contained data (OCTETSTRING, UTF8STRING, INTEGER, ...). For basic (name, value) pairs, such as HTTP headers, the category parameter is not used.

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

This property is not available at design time.

Data Type

String

ReqHeaderFormat Property (SecureBlackbox_RESTClient Class)

Specifies the format (encoding) of the value contained in the Value property.

Object Oriented Interface

public function getReqHeaderFormat($reqheaderindex);
public function setReqHeaderFormat($reqheaderindex, $value);

Procedural Interface

secureblackbox_restclient_get($res, 166 , $reqheaderindex);
secureblackbox_restclient_set($res, 166, $value , $reqheaderindex);

Default Value

0

Remarks

Specifies the format (encoding) of the value contained in the ReqHeaderValue property.

Use this property to check or set the format of the contained value. Remember to provide the actual value in the appropriate format that matches this setting: utils.NameValuePairs[0].Name = "key"; utils.NameValuePairs[0].Format = svfBinary; utils.NameValuePairs[0].Name = "0a1b2c3d4e5f6071";

The following formats are currently supported:

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

This property is not available at design time.

Data Type

Integer

ReqHeaderName Property (SecureBlackbox_RESTClient Class)

The name element in a (name, value) pair.

Object Oriented Interface

public function getReqHeaderName($reqheaderindex);
public function setReqHeaderName($reqheaderindex, $value);

Procedural Interface

secureblackbox_restclient_get($res, 167 , $reqheaderindex);
secureblackbox_restclient_set($res, 167, $value , $reqheaderindex);

Default Value

''

Remarks

The name element in a (name, value) pair.

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

This property is not available at design time.

Data Type

String

ReqHeaderValue Property (SecureBlackbox_RESTClient Class)

The value element in a (name, value) pair.

Object Oriented Interface

public function getReqHeaderValue($reqheaderindex);
public function setReqHeaderValue($reqheaderindex, $value);

Procedural Interface

secureblackbox_restclient_get($res, 168 , $reqheaderindex);
secureblackbox_restclient_set($res, 168, $value , $reqheaderindex);

Default Value

''

Remarks

The value element in a (name, value) pair.

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

This property is not available at design time.

Data Type

String

ReqParamsAccept Property (SecureBlackbox_RESTClient Class)

Specifies the Accept header property of the HTTP request.

Object Oriented Interface

public function getReqParamsAccept();
public function setReqParamsAccept($value);

Procedural Interface

secureblackbox_restclient_get($res, 169 );
secureblackbox_restclient_set($res, 169, $value );

Default Value

''

Remarks

Specifies the Accept header field of the HTTP request. The Accept field defines which media types are accepted in the response.

This property is not available at design time.

Data Type

String

ReqParamsAcceptCharset Property (SecureBlackbox_RESTClient Class)

Specifies the Accept-Charset header property of the HTTP request.

Object Oriented Interface

public function getReqParamsAcceptCharset();
public function setReqParamsAcceptCharset($value);

Procedural Interface

secureblackbox_restclient_get($res, 170 );
secureblackbox_restclient_set($res, 170, $value );

Default Value

''

Remarks

Specifies the Accept-Charset header field of the HTTP request. The Accept-Charset field specifies the character set which the client can understand.

This property is not available at design time.

Data Type

String

ReqParamsAcceptLanguage Property (SecureBlackbox_RESTClient Class)

Specifies the Accept-Language header property of the HTTP request.

Object Oriented Interface

public function getReqParamsAcceptLanguage();
public function setReqParamsAcceptLanguage($value);

Procedural Interface

secureblackbox_restclient_get($res, 171 );
secureblackbox_restclient_set($res, 171, $value );

Default Value

''

Remarks

Specifies the Accept-Language header field of the HTTP request. The Accept-Language field specifies the language (and locale) which the client can understand.

This property is not available at design time.

Data Type

String

ReqParamsAcceptRangeEnd Property (SecureBlackbox_RESTClient Class)

This property, in combination with AcceptRangeStart, defines the media-range of the HTTP request.

Object Oriented Interface

public function getReqParamsAcceptRangeEnd();
public function setReqParamsAcceptRangeEnd($value);

Procedural Interface

secureblackbox_restclient_get($res, 172 );
secureblackbox_restclient_set($res, 172, $value );

Default Value

0

Remarks

This property, in combination with AcceptRangeStart, defines the media-range of the HTTP request.

This property is not available at design time.

Data Type

Long64

ReqParamsAcceptRangeStart Property (SecureBlackbox_RESTClient Class)

This property, in combination with AcceptRangeEnd, defines the media-range of the HTTP request.

Object Oriented Interface

public function getReqParamsAcceptRangeStart();
public function setReqParamsAcceptRangeStart($value);

Procedural Interface

secureblackbox_restclient_get($res, 173 );
secureblackbox_restclient_set($res, 173, $value );

Default Value

0

Remarks

This property, in combination with AcceptRangeEnd, defines the media-range of the HTTP request.

This property is not available at design time.

Data Type

Long64

ReqParamsAuthorization Property (SecureBlackbox_RESTClient Class)

Specifies the Authorization header of the HTTP request.

Object Oriented Interface

public function getReqParamsAuthorization();
public function setReqParamsAuthorization($value);

Procedural Interface

secureblackbox_restclient_get($res, 174 );
secureblackbox_restclient_set($res, 174, $value );

Default Value

''

Remarks

Specifies the Authorization header of the HTTP request. This header contains the credentials to authenticate a user with a server.

This property is not available at design time.

Data Type

String

ReqParamsConnection Property (SecureBlackbox_RESTClient Class)

Specifies the value to pass to the Connection header property of HTTP request.

Object Oriented Interface

public function getReqParamsConnection();
public function setReqParamsConnection($value);

Procedural Interface

secureblackbox_restclient_get($res, 175 );
secureblackbox_restclient_set($res, 175, $value );

Default Value

''

Remarks

Specifies the value to pass to the Connection header field of HTTP request.

This property is not available at design time.

Data Type

String

ReqParamsContentLength Property (SecureBlackbox_RESTClient Class)

Specifies the size of the entity-body of the HTTP request.

Object Oriented Interface

public function getReqParamsContentLength();
public function setReqParamsContentLength($value);

Procedural Interface

secureblackbox_restclient_get($res, 176 );
secureblackbox_restclient_set($res, 176, $value );

Default Value

0

Remarks

Specifies the size of the entity-body of the HTTP request. Leave this field set to 0 to make the class calculate it automatically.

This property is not available at design time.

Data Type

Long64

ReqParamsContentRangeEnd Property (SecureBlackbox_RESTClient Class)

Specifies the upper bound used in the Content-Range header of the HTTP request.

Object Oriented Interface

public function getReqParamsContentRangeEnd();
public function setReqParamsContentRangeEnd($value);

Procedural Interface

secureblackbox_restclient_get($res, 177 );
secureblackbox_restclient_set($res, 177, $value );

Default Value

0

Remarks

Specifies the upper bound used in the Content-Range header of the HTTP request.

This property is not available at design time.

Data Type

Long64

ReqParamsContentRangeFullSize Property (SecureBlackbox_RESTClient Class)

Specifies the total length of the full entity-body of the HTTP request.

Object Oriented Interface

public function getReqParamsContentRangeFullSize();
public function setReqParamsContentRangeFullSize($value);

Procedural Interface

secureblackbox_restclient_get($res, 178 );
secureblackbox_restclient_set($res, 178, $value );

Default Value

0

Remarks

Specifies the total length of the full entity-body of the HTTP request.

This property is not available at design time.

Data Type

Long64

ReqParamsContentRangeStart Property (SecureBlackbox_RESTClient Class)

Specifies the lower bound used in the Content-Range header of the HTTP request.

Object Oriented Interface

public function getReqParamsContentRangeStart();
public function setReqParamsContentRangeStart($value);

Procedural Interface

secureblackbox_restclient_get($res, 179 );
secureblackbox_restclient_set($res, 179, $value );

Default Value

0

Remarks

Specifies the lower bound used in the Content-Range header of the HTTP request.

This property is not available at design time.

Data Type

Long64

ReqParamsContentType Property (SecureBlackbox_RESTClient Class)

The Content-Type header property of the HTTP request.

Object Oriented Interface

public function getReqParamsContentType();
public function setReqParamsContentType($value);

Procedural Interface

secureblackbox_restclient_get($res, 180 );
secureblackbox_restclient_set($res, 180, $value );

Default Value

''

Remarks

The Content-Type header field of the HTTP request.

This property is not available at design time.

Data Type

String

ReqParamsCookie Property (SecureBlackbox_RESTClient Class)

This header is expected to be assigned with cookies previously received from the server and stored by the client.

Object Oriented Interface

public function getReqParamsCookie();
public function setReqParamsCookie($value);

Procedural Interface

secureblackbox_restclient_get($res, 181 );
secureblackbox_restclient_set($res, 181, $value );

Default Value

''

Remarks

This header is expected to be assigned with cookies previously received from the server and stored by the client.

This property is not available at design time.

Data Type

String

ReqParamsCustomHeaders Property (SecureBlackbox_RESTClient Class)

Assign any custom HTTP headers to be passed to the server to this property.

Object Oriented Interface

public function getReqParamsCustomHeaders();
public function setReqParamsCustomHeaders($value);

Procedural Interface

secureblackbox_restclient_get($res, 182 );
secureblackbox_restclient_set($res, 182, $value );

Default Value

''

Remarks

Assign any custom HTTP headers to be passed to the server to this property.

This property is not available at design time.

Data Type

String

ReqParamsDate Property (SecureBlackbox_RESTClient Class)

The date and time of the request.

Object Oriented Interface

public function getReqParamsDate();
public function setReqParamsDate($value);

Procedural Interface

secureblackbox_restclient_get($res, 183 );
secureblackbox_restclient_set($res, 183, $value );

Default Value

''

Remarks

The date and time of the request.

This property is not available at design time.

Data Type

String

ReqParamsFrom Property (SecureBlackbox_RESTClient Class)

Contains the From header property of the HTTP request.

Object Oriented Interface

public function getReqParamsFrom();
public function setReqParamsFrom($value);

Procedural Interface

secureblackbox_restclient_get($res, 184 );
secureblackbox_restclient_set($res, 184, $value );

Default Value

''

Remarks

Contains the From header field of the HTTP request. It specifies the e-mail address for the human user who controls the requesting user agent.

This property is not available at design time.

Data Type

String

ReqParamsHost Property (SecureBlackbox_RESTClient Class)

This property contains the Host header property of the HTTP request.

Object Oriented Interface

public function getReqParamsHost();
public function setReqParamsHost($value);

Procedural Interface

secureblackbox_restclient_get($res, 185 );
secureblackbox_restclient_set($res, 185, $value );

Default Value

''

Remarks

This property contains the Host header field of the HTTP request. It specifies the host and port number of the resource being requested.

This property is not available at design time.

Data Type

String

ReqParamsHTTPVersion Property (SecureBlackbox_RESTClient Class)

Specifies the version of HTTP protocol to use: 1.

Object Oriented Interface

public function getReqParamsHTTPVersion();
public function setReqParamsHTTPVersion($value);

Procedural Interface

secureblackbox_restclient_get($res, 186 );
secureblackbox_restclient_set($res, 186, $value );

Default Value

1

Remarks

Specifies the version of HTTP protocol to use: 1.0 or 1.1.

This property is not available at design time.

Data Type

Integer

ReqParamsIfMatch Property (SecureBlackbox_RESTClient Class)

Contains the If-Match request header property.

Object Oriented Interface

public function getReqParamsIfMatch();
public function setReqParamsIfMatch($value);

Procedural Interface

secureblackbox_restclient_get($res, 187 );
secureblackbox_restclient_set($res, 187, $value );

Default Value

''

Remarks

Contains the If-Match request header field. This property makes the requested method conditional: when If-Match field is set, only the entities matching the included entity tags will be returned by the server.

This property is not available at design time.

Data Type

String

ReqParamsIfModifiedSince Property (SecureBlackbox_RESTClient Class)

Contains the If-Modified-Since request header property.

Object Oriented Interface

public function getReqParamsIfModifiedSince();
public function setReqParamsIfModifiedSince($value);

Procedural Interface

secureblackbox_restclient_get($res, 188 );
secureblackbox_restclient_set($res, 188, $value );

Default Value

''

Remarks

Contains the If-Modified-Since request header field. This property makes the requested method conditional: when If-Modified-Since field is set, only the modified entities will be returned by the server.

This property is not available at design time.

Data Type

String

ReqParamsIfNoneMatch Property (SecureBlackbox_RESTClient Class)

Contains the If-None-Match request header property.

Object Oriented Interface

public function getReqParamsIfNoneMatch();
public function setReqParamsIfNoneMatch($value);

Procedural Interface

secureblackbox_restclient_get($res, 189 );
secureblackbox_restclient_set($res, 189, $value );

Default Value

''

Remarks

Contains the If-None-Match request header field. This property makes the requested method conditional: when If-None-Match field is set, only the entities which doesn't match the included entity tags will be returned by the server.

This property is not available at design time.

Data Type

String

ReqParamsIfUnmodifiedSince Property (SecureBlackbox_RESTClient Class)

Contains the If-Unmodified-Since request header property.

Object Oriented Interface

public function getReqParamsIfUnmodifiedSince();
public function setReqParamsIfUnmodifiedSince($value);

Procedural Interface

secureblackbox_restclient_get($res, 190 );
secureblackbox_restclient_set($res, 190, $value );

Default Value

''

Remarks

Contains the If-Unmodified-Since request header field. This property makes the requested method conditional: when If-Unmodified-Since field is set, only the unmodified entities will be returned by the server.

This property is not available at design time.

Data Type

String

ReqParamsPassword Property (SecureBlackbox_RESTClient Class)

Assign this property with the user's password.

Object Oriented Interface

public function getReqParamsPassword();
public function setReqParamsPassword($value);

Procedural Interface

secureblackbox_restclient_get($res, 191 );
secureblackbox_restclient_set($res, 191, $value );

Default Value

''

Remarks

Assign this property with the user's password.

This property is not available at design time.

Data Type

String

ReqParamsReferer Property (SecureBlackbox_RESTClient Class)

The Referer property of the HTTP request header specifies the address of the resource from which the Request-URI was obtained (the referrer).

Object Oriented Interface

public function getReqParamsReferer();
public function setReqParamsReferer($value);

Procedural Interface

secureblackbox_restclient_get($res, 192 );
secureblackbox_restclient_set($res, 192, $value );

Default Value

''

Remarks

The Referer field of the HTTP request header specifies the address of the resource from which the Request-URI was obtained (the referrer).

This property is not available at design time.

Data Type

String

ReqParamsUserAgent Property (SecureBlackbox_RESTClient Class)

The User-Agent property of the HTTP request provides information about the software that initiates the request.

Object Oriented Interface

public function getReqParamsUserAgent();
public function setReqParamsUserAgent($value);

Procedural Interface

secureblackbox_restclient_get($res, 193 );
secureblackbox_restclient_set($res, 193, $value );

Default Value

''

Remarks

The User-Agent field of the HTTP request provides information about the software that initiates the request.

This property is not available at design time.

Data Type

String

ReqParamsUsername Property (SecureBlackbox_RESTClient Class)

Assign this property with the user's login name.

Object Oriented Interface

public function getReqParamsUsername();
public function setReqParamsUsername($value);

Procedural Interface

secureblackbox_restclient_get($res, 194 );
secureblackbox_restclient_set($res, 194, $value );

Default Value

''

Remarks

Assign this property with the user's login name.

This property is not available at design time.

Data Type

String

RespHeaderCount Property (SecureBlackbox_RESTClient Class)

The number of records in the RespHeader arrays.

Object Oriented Interface

public function getRespHeaderCount();

Procedural Interface

secureblackbox_restclient_get($res, 195 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• RespHeaderCategory
• RespHeaderFormat
• RespHeaderName
• RespHeaderValue

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

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

Data Type

Integer

RespHeaderCategory Property (SecureBlackbox_RESTClient Class)

Specifies the string category of the contained value.

Object Oriented Interface

public function getRespHeaderCategory($respheaderindex);

Procedural Interface

secureblackbox_restclient_get($res, 196 , $respheaderindex);

Default Value

''

Remarks

Specifies the string category of the contained value.

This property allows to check or set the category (or type) associated with the contained value. Depending on the format used to load or save the string, the category parameter may or may not be used.

For example, for ASN.1 property lists the category contains the ASN.1 tag of the contained data (OCTETSTRING, UTF8STRING, INTEGER, ...). For basic (name, value) pairs, such as HTTP headers, the category parameter is not used.

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

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

Data Type

String

RespHeaderFormat Property (SecureBlackbox_RESTClient Class)

Specifies the format (encoding) of the value contained in the Value property.

Object Oriented Interface

public function getRespHeaderFormat($respheaderindex);

Procedural Interface

secureblackbox_restclient_get($res, 197 , $respheaderindex);

Default Value

0

Remarks

Specifies the format (encoding) of the value contained in the RespHeaderValue property.

Use this property to check or set the format of the contained value. Remember to provide the actual value in the appropriate format that matches this setting: utils.NameValuePairs[0].Name = "key"; utils.NameValuePairs[0].Format = svfBinary; utils.NameValuePairs[0].Name = "0a1b2c3d4e5f6071";

The following formats are currently supported:

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

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

Data Type

Integer

RespHeaderName Property (SecureBlackbox_RESTClient Class)

The name element in a (name, value) pair.

Object Oriented Interface

public function getRespHeaderName($respheaderindex);

Procedural Interface

secureblackbox_restclient_get($res, 198 , $respheaderindex);

Default Value

''

Remarks

The name element in a (name, value) pair.

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

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

Data Type

String

RespHeaderValue Property (SecureBlackbox_RESTClient Class)

The value element in a (name, value) pair.

Object Oriented Interface

public function getRespHeaderValue($respheaderindex);

Procedural Interface

secureblackbox_restclient_get($res, 199 , $respheaderindex);

Default Value

''

Remarks

The value element in a (name, value) pair.

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

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

Data Type

String

RespParamsContentLength Property (SecureBlackbox_RESTClient Class)

Indicates the length of the response content in bytes.

Object Oriented Interface

public function getRespParamsContentLength();

Procedural Interface

secureblackbox_restclient_get($res, 200 );

Default Value

0

Remarks

Indicates the length of the response content in bytes.

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

Data Type

Long64

RespParamsDate Property (SecureBlackbox_RESTClient Class)

The date and time at which the response was generated, in server time, in UTC.

Object Oriented Interface

public function getRespParamsDate();

Procedural Interface

secureblackbox_restclient_get($res, 201 );

Default Value

''

Remarks

The date and time at which the response was generated, in server time, in UTC.

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

Data Type

String

RespParamsReasonPhrase Property (SecureBlackbox_RESTClient Class)

Contains the reason phrase (a human-readable comment) of the request processing status, which corresponds to, and complements, the staus code.

Object Oriented Interface

public function getRespParamsReasonPhrase();

Procedural Interface

secureblackbox_restclient_get($res, 202 );

Default Value

''

Remarks

Contains the reason phrase (a human-readable comment) of the request processing status, which corresponds to, and complements, the staus code.

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

Data Type

String

RespParamsStatusCode Property (SecureBlackbox_RESTClient Class)

The server-generated status code of the request processing status.

Object Oriented Interface

public function getRespParamsStatusCode();

Procedural Interface

secureblackbox_restclient_get($res, 203 );

Default Value

0

Remarks

The server-generated status code of the request processing status.

The code is a 3-digit integer where the first digit defines the class of the response:

Common examples are 200 (page served succesfully), 404 (page not found), 302 (redirect), and 500 (internal server error).

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

Data Type

Integer

SocketDNSMode Property (SecureBlackbox_RESTClient 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_restclient_get($res, 204 );
secureblackbox_restclient_set($res, 204, $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_RESTClient 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_restclient_get($res, 205 );
secureblackbox_restclient_set($res, 205, $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_RESTClient Class)

The timeout (in milliseconds) for each DNS query.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 206 );
secureblackbox_restclient_set($res, 206, $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_RESTClient 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_restclient_get($res, 207 );
secureblackbox_restclient_set($res, 207, $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_RESTClient Class)

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

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 208 );
secureblackbox_restclient_set($res, 208, $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_RESTClient 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_restclient_get($res, 209 );
secureblackbox_restclient_set($res, 209, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (SecureBlackbox_RESTClient Class)

The local network interface to bind the socket to.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 210 );
secureblackbox_restclient_set($res, 210, $value );

Default Value

''

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SecureBlackbox_RESTClient Class)

The local port number to bind the socket to.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 211 );
secureblackbox_restclient_set($res, 211, $value );

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SecureBlackbox_RESTClient 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_restclient_get($res, 212 );
secureblackbox_restclient_set($res, 212, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (SecureBlackbox_RESTClient 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_restclient_get($res, 213 );
secureblackbox_restclient_set($res, 213, $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_RESTClient Class)

Enables or disables IP protocol version 6.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 214 );
secureblackbox_restclient_set($res, 214, $value );

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

StatusCode Property (SecureBlackbox_RESTClient Class)

Contains the Status Code element of the server's response.

Object Oriented Interface

public function getStatusCode();

Procedural Interface

secureblackbox_restclient_get($res, 215 );

Default Value

0

Remarks

Use this property to access the status code supplied by the server in its response (such as 200 in HTTP 200 OK).

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

Data Type

Integer

TLSClientCertCount Property (SecureBlackbox_RESTClient Class)

The number of records in the TLSClientCert arrays.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 216 );
secureblackbox_restclient_set($res, 216, $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_RESTClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTLSClientCertBytes($tlsclientcertindex);

Procedural Interface

secureblackbox_restclient_get($res, 217 , $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_RESTClient 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_restclient_get($res, 225 , $tlsclientcertindex);
secureblackbox_restclient_set($res, 225, $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_RESTClient Class)

The number of records in the TLSServerCert arrays.

Object Oriented Interface

public function getTLSServerCertCount();

Procedural Interface

secureblackbox_restclient_get($res, 256 );

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_RESTClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTLSServerCertBytes($tlsservercertindex);

Procedural Interface

secureblackbox_restclient_get($res, 257 , $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_RESTClient Class)

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

Object Oriented Interface

public function getTLSServerCertFingerprint($tlsservercertindex);

Procedural Interface

secureblackbox_restclient_get($res, 263 , $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_RESTClient 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_restclient_get($res, 265 , $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_RESTClient Class)

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

Object Oriented Interface

public function getTLSServerCertIssuer($tlsservercertindex);

Procedural Interface

secureblackbox_restclient_get($res, 267 , $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_RESTClient Class)

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

Object Oriented Interface

public function getTLSServerCertIssuerRDN($tlsservercertindex);

Procedural Interface

secureblackbox_restclient_get($res, 268 , $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_RESTClient Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getTLSServerCertKeyAlgorithm($tlsservercertindex);

Procedural Interface

secureblackbox_restclient_get($res, 269 , $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_RESTClient Class)

Returns the length of the public key in bits.

Object Oriented Interface

public function getTLSServerCertKeyBits($tlsservercertindex);

Procedural Interface

secureblackbox_restclient_get($res, 270 , $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_RESTClient 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_restclient_get($res, 272 , $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_RESTClient 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_restclient_get($res, 285 , $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_RESTClient Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getTLSServerCertSerialNumber($tlsservercertindex);

Procedural Interface

secureblackbox_restclient_get($res, 286 , $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_RESTClient Class)

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

Object Oriented Interface

public function getTLSServerCertSigAlgorithm($tlsservercertindex);

Procedural Interface

secureblackbox_restclient_get($res, 287 , $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_RESTClient 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_restclient_get($res, 289 , $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_RESTClient Class)

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

Object Oriented Interface

public function getTLSServerCertSubjectRDN($tlsservercertindex);

Procedural Interface

secureblackbox_restclient_get($res, 292 , $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_RESTClient Class)

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

Object Oriented Interface

public function getTLSServerCertValidFrom($tlsservercertindex);

Procedural Interface

secureblackbox_restclient_get($res, 294 , $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_RESTClient Class)

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

Object Oriented Interface

public function getTLSServerCertValidTo($tlsservercertindex);

Procedural Interface

secureblackbox_restclient_get($res, 295 , $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_RESTClient 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_restclient_get($res, 296 );
secureblackbox_restclient_set($res, 296, $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_RESTClient Class)

Selects the base configuration for the TLS settings.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 297 );
secureblackbox_restclient_set($res, 297, $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_RESTClient Class)

A list of ciphersuites separated with commas or semicolons.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 298 );
secureblackbox_restclient_set($res, 298, $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_RESTClient Class)

Enables or disables certificate-based client authentication.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 299 );
secureblackbox_restclient_set($res, 299, $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_RESTClient Class)

Defines the elliptic curves to enable.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 300 );
secureblackbox_restclient_set($res, 300, $value );

Default Value

''

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (SecureBlackbox_RESTClient Class)

Provides access to TLS extensions.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 301 );
secureblackbox_restclient_set($res, 301, $value );

Default Value

''

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (SecureBlackbox_RESTClient 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_restclient_get($res, 302 );
secureblackbox_restclient_set($res, 302, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSPreSharedIdentity Property (SecureBlackbox_RESTClient 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_restclient_get($res, 303 );
secureblackbox_restclient_set($res, 303, $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_RESTClient 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_restclient_get($res, 304 );
secureblackbox_restclient_set($res, 304, $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_RESTClient Class)

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

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 305 );
secureblackbox_restclient_set($res, 305, $value );

Default Value

''

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (SecureBlackbox_RESTClient Class)

Selects the renegotiation attack prevention mechanism.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 306 );
secureblackbox_restclient_set($res, 306, $value );

Default Value

2

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (SecureBlackbox_RESTClient Class)

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

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 307 );
secureblackbox_restclient_set($res, 307, $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_RESTClient 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_restclient_get($res, 308 );
secureblackbox_restclient_set($res, 308, $value );

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (SecureBlackbox_RESTClient Class)

Specifies the TLS mode to use.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 309 );
secureblackbox_restclient_set($res, 309, $value );

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (SecureBlackbox_RESTClient 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_restclient_get($res, 310 );
secureblackbox_restclient_set($res, 310, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (SecureBlackbox_RESTClient Class)

Enables or disables the TLS session resumption capability.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 311 );
secureblackbox_restclient_set($res, 311, $value );

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (SecureBlackbox_RESTClient Class)

The SSL/TLS versions to enable by default.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 312 );
secureblackbox_restclient_set($res, 312, $value );

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

TrustedCertCount Property (SecureBlackbox_RESTClient Class)

The number of records in the TrustedCert arrays.

Object Oriented Interface

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

Procedural Interface

secureblackbox_restclient_get($res, 313 );
secureblackbox_restclient_set($res, 313, $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_RESTClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTrustedCertBytes($trustedcertindex);

Procedural Interface

secureblackbox_restclient_get($res, 314 , $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_RESTClient 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_restclient_get($res, 322 , $trustedcertindex);
secureblackbox_restclient_set($res, 322, $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

Config Method (SecureBlackbox_RESTClient Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

Delete Method (SecureBlackbox_RESTClient Class)

Sends a DELETE request to the server.

Object Oriented Interface

public function doDelete($url);

Procedural Interface

secureblackbox_restclient_do_delete($res, $url);

Remarks

Use this method to send a DELETE request to server. In response to this request, the server may (without any guarantees) delete the resource specified in Url. Most of the servers disable DELETE requests.

If this request fails, an exception will be thrown, and the error details published in StatusCode and ReasonPhrase properties.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

DoAction Method (SecureBlackbox_RESTClient Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

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

Get Method (SecureBlackbox_RESTClient Class)

Sends a GET request to the server.

Object Oriented Interface

public function doGet($url);

Procedural Interface

secureblackbox_restclient_do_get($res, $url);

Remarks

GET is one of the most widely used HTTP requests. The server responds with the content of the resource specified in Url.

If the request is successful, the received content will be available in OutputBytes and OutputString properties. Otherwise an exception will be thrown, and the error details published in StatusCode and ReasonPhrase properties.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

Head Method (SecureBlackbox_RESTClient Class)

Sends a HEAD request to the server.

Object Oriented Interface

public function doHead($url);

Procedural Interface

secureblackbox_restclient_do_head($res, $url);

Remarks

HEAD is very similar to GET, with the only difference being that only the headers (but not the content) is returned.

HEAD is often use to retrieve the parameters of the resource, such as its size and modification date. If the request is successful, those details will be available via ResponseParameters and ResponseHeaders properties. Otherwise, an exception will be thrown, and the error details published in StatusCode and ReasonPhrase properties.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

Options Method (SecureBlackbox_RESTClient Class)

Sends an OPTIONS request to the server.

Object Oriented Interface

public function doOptions($url);

Procedural Interface

secureblackbox_restclient_do_options($res, $url);

Remarks

This request gets various information about the server such as supported HTTP methods. No content is included in the response.

Post Method (SecureBlackbox_RESTClient Class)

Sends a POST request to the server.

Object Oriented Interface

public function doPost($url, $content);

Procedural Interface

secureblackbox_restclient_do_post($res, $url, $content);

Remarks

POST is used to send data to the remote HTTP endpoint/script.

Provide the data you need to send via the Content parameter. If Content is omitted, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event.

To post a web form's data (including file attachments to the form) use PostWebForm method.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PostBytes Method (SecureBlackbox_RESTClient Class)

Sends a POST request to the server.

Object Oriented Interface

public function doPostBytes($url, $contentbytes);

Procedural Interface

secureblackbox_restclient_do_postbytes($res, $url, $contentbytes);

Remarks

POST is used to send data to the remote HTTP endpoint/script.

Provide the data you need to send via the ContentBytes parameter. If content is omitted, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event.

To post a web form's data (including file attachments to the form) use PostWebForm method.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PostFile Method (SecureBlackbox_RESTClient Class)

Sends a file to the server using a POST request.

Object Oriented Interface

public function doPostFile($url, $filename);

Procedural Interface

secureblackbox_restclient_do_postfile($res, $url, $filename);

Remarks

POST is used to send data to the remote HTTP endpoint/script. The content to send will be taken from FileName.

To post a web form's data (including file attachments to the form) use PostWebForm method.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PostJSON Method (SecureBlackbox_RESTClient Class)

Sends a JSON POST request to the server.

Object Oriented Interface

public function doPostJSON($url, $content);

Procedural Interface

secureblackbox_restclient_do_postjson($res, $url, $content);

Remarks

POST is used to send data to the remote HTTP endpoint/script.

Provide the JSON data you need to send via the Content parameter. If Content is omitted, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event.

To post a regular (non-JSON) data, use Post method. To post a web form's data (including file attachments to the form) use PostWebForm method.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PostWebForm Method (SecureBlackbox_RESTClient Class)

Posts a web form data to the server.

Object Oriented Interface

public function doPostWebForm($url, $fields, $filefield, $filename, $contenttype);

Procedural Interface

secureblackbox_restclient_do_postwebform($res, $url, $fields, $filefield, $filename, $contenttype);

Remarks

This variant of the POST method provides means to submit a form (as in a web browser) with an optional file attachment. Fields are expected to contain a list of field names and values in "Name=Value" format separated with EOLs. This list can be empty.

If including a file with your request, use the FileField and FileName properties to specify the file field name and the local filename for the uploaded file. Use ContentType to override the default content type chosen by the client, e.g., "application/x-www-form-urlencoded".

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PostXML Method (SecureBlackbox_RESTClient Class)

Posts an XML request to the server.

Object Oriented Interface

public function doPostXML($url, $content);

Procedural Interface

secureblackbox_restclient_do_postxml($res, $url, $content);

Remarks

POST is used to send data to the remote HTTP endpoint/script.

Provide the XML data you need to send via the Content parameter. If Content is omitted, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event.

To post a regular (non-XML) data, use Post method. To post a web form's data (including file attachments to the form) use PostWebForm method.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

Put Method (SecureBlackbox_RESTClient Class)

Sends a PUT request to the server.

Object Oriented Interface

public function doPut($url, $content);

Procedural Interface

secureblackbox_restclient_do_put($res, $url, $content);

Remarks

PUT method is used to write data to the server. This method is optional to support and is disabled on most of HTTP servers.

If Content is not present, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event. Note that some servers do not support streaming.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PutBytes Method (SecureBlackbox_RESTClient Class)

Sends a PUT request to the server.

Object Oriented Interface

public function doPutBytes($url, $contentbytes);

Procedural Interface

secureblackbox_restclient_do_putbytes($res, $url, $contentbytes);

Remarks

PUT method is used to write data to the server. This method is optional to support and is disabled on most of HTTP servers.

If ContentBytes is not present, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event. Note that some servers do not support streaming.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PutFile Method (SecureBlackbox_RESTClient Class)

Sends a file to the server using a PUT request.

Object Oriented Interface

public function doPutFile($url, $filename);

Procedural Interface

secureblackbox_restclient_do_putfile($res, $url, $filename);

Remarks

PUT is an alternative to POST and is used to send data to the remote HTTP endpoint/script. Many servers have this method switched off. The content to send will be taken from FileName.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PutJSON Method (SecureBlackbox_RESTClient Class)

PUTs a JSON to the server.

Object Oriented Interface

public function doPutJSON($url, $content);

Procedural Interface

secureblackbox_restclient_do_putjson($res, $url, $content);

Remarks

PUT method is used to write data to the server.

If Content is not present, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event. Note that some servers do not support streaming.

To PUT a regular (non-JSON) data, use Put method. To post JSON data, use PostJSON method.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PutXML Method (SecureBlackbox_RESTClient Class)

PUTs an XML to the server.

Object Oriented Interface

public function doPutXML($url, $content);

Procedural Interface

secureblackbox_restclient_do_putxml($res, $url, $content);

Remarks

PUT method is used to write data to the server.

If Content is not present, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event. Note that some servers do not support streaming.

To PUT a regular (non-XML) data, use Put method. To post XML data, use PostXML method.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

Reset Method (SecureBlackbox_RESTClient Class)

Resets the class settings.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_restclient_do_reset($res);

Remarks

Reset is a generic method available in every class.

Trace Method (SecureBlackbox_RESTClient Class)

Sends a TRACE request to the server.

Object Oriented Interface

public function doTrace($url);

Procedural Interface

secureblackbox_restclient_do_trace($res, $url);

Remarks

TRACE is a debug command and is typically switched off and/or not supported by web servers.

Cookie Event (SecureBlackbox_RESTClient Class)

Fired to report a received cookie.

Object Oriented Interface

public function fireCookie($param);

Procedural Interface

secureblackbox_restclient_register_callback($res, 1, array($this, 'fireCookie'));

Parameter List

 'cookietext'

Remarks

The CookieText parameter contains the text of the cookie.

DocumentBegin Event (SecureBlackbox_RESTClient Class)

Marks the start of the incoming HTML document or file.

Object Oriented Interface

public function fireDocumentBegin($param);

Procedural Interface

secureblackbox_restclient_register_callback($res, 2, array($this, 'fireDocumentBegin'));

Parameter List

Remarks

This event is followed by one or more Progress calls. When the document has been received in full, the DocumentEnd event is fired.

DocumentEnd Event (SecureBlackbox_RESTClient Class)

Marks the successful receipt of the incoming HTML document or file.

Object Oriented Interface

public function fireDocumentEnd($param);

Procedural Interface

secureblackbox_restclient_register_callback($res, 3, array($this, 'fireDocumentEnd'));

Parameter List

Remarks

This event fires when the document has been received in full.

DynamicDataNeeded Event (SecureBlackbox_RESTClient Class)

Requests a portion of data to be uploaded from the application.

Object Oriented Interface

public function fireDynamicDataNeeded($param);

Procedural Interface

secureblackbox_restclient_register_callback($res, 4, array($this, 'fireDynamicDataNeeded'));

Parameter List

 'bytesneeded'

Remarks

If dynamic ('streaming') variants of PUT or POST methods are used, this event is fired periodically to request portions of data to be sent to the server.

When handling this event, assign the next portion of data of BytesNeeded length (or less) to DynamicData. If no more data is available to upload (the whole document has been sent), leave DynamicData empty.

Error Event (SecureBlackbox_RESTClient Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_restclient_register_callback($res, 5, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the HTTPS section.

ExternalSign Event (SecureBlackbox_RESTClient Class)

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

Object Oriented Interface

public function fireExternalSign($param);

Procedural Interface

secureblackbox_restclient_register_callback($res, 6, 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(); };

HeadersPrepared Event (SecureBlackbox_RESTClient Class)

Fires when the request headers have been formed and are about to be sent to the server.

Object Oriented Interface

public function fireHeadersPrepared($param);

Procedural Interface

secureblackbox_restclient_register_callback($res, 7, array($this, 'fireHeadersPrepared'));

Parameter List

Remarks

The prepared headers are available in RequestHeaders property. This event provides you the last chance to review/alter them.

HeadersReceived Event (SecureBlackbox_RESTClient Class)

Fires when the HTTP response headers have just been received from the server.

Object Oriented Interface

public function fireHeadersReceived($param);

Procedural Interface

secureblackbox_restclient_register_callback($res, 8, array($this, 'fireHeadersReceived'));

Parameter List

Remarks

The received headers are available via the ResponseHeaders property.

Notification Event (SecureBlackbox_RESTClient Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

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

Parameter List

 'eventid'
 'eventparam'

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the 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.

Progress Event (SecureBlackbox_RESTClient Class)

Fires periodically during the data transfer.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

secureblackbox_restclient_register_callback($res, 10, array($this, 'fireProgress'));

Parameter List

 'total'
 'current'
 'cancel'

Remarks

Use this event to check the progress of an upload or download operation. Total indicates the total number of bytes to be transferred; Current specifies how much data has been transferred so far, and Cancel gives you a chance to cancel the operation.

Redirection Event (SecureBlackbox_RESTClient Class)

Fires when the server suggests a redirect.

Object Oriented Interface

public function fireRedirection($param);

Procedural Interface

secureblackbox_restclient_register_callback($res, 11, array($this, 'fireRedirection'));

Parameter List

 'oldurl'
 'newurl'
 'allowredirection'

Remarks

This event is fired when the server suggests a redirection request (typically via a 301 or 302 response). OldURL indicates the 'from' page, and NewURL indicates the 'to' one. The destination page can be altered by the application if needed. Use AllowRedirection to block undesirable redirects.

Generally, this is a notification event: the component handles redirections automatically. Use the MaxRedirections config property to limit the number of redirection hops.

TLSCertNeeded Event (SecureBlackbox_RESTClient Class)

Fires when a remote TLS party requests a client certificate.

Object Oriented Interface

public function fireTLSCertNeeded($param);

Procedural Interface

secureblackbox_restclient_register_callback($res, 12, 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_RESTClient 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_restclient_register_callback($res, 13, 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_RESTClient Class)

Fires when a TLS handshake with Host successfully completes.

Object Oriented Interface

public function fireTLSEstablished($param);

Procedural Interface

secureblackbox_restclient_register_callback($res, 14, 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_RESTClient Class)

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

Object Oriented Interface

public function fireTLSHandshake($param);

Procedural Interface

secureblackbox_restclient_register_callback($res, 15, 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_RESTClient Class)

Notifies the application about the PSK key exchange.

Object Oriented Interface

public function fireTLSPSK($param);

Procedural Interface

secureblackbox_restclient_register_callback($res, 16, 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_RESTClient Class)

Reports the graceful closure of a TLS connection.

Object Oriented Interface

public function fireTLSShutdown($param);

Procedural Interface

secureblackbox_restclient_register_callback($res, 17, 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 (RESTClient 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.

RESTClient Config Settings

Base Config Settings

Trappable Errors (RESTClient Class)

HTTPClient Errors