OAuthClient Class

Properties   Methods   Events   Config Settings   Errors  

The OAuthClient class implements interaction between the client, the resource owner (end-user), and the authorization server via OAuth 2.0 protocol.

Class Name

SecureBlackbox_OAuthClient

Procedural Interface

 secureblackbox_oauthclient_open();
 secureblackbox_oauthclient_close($res);
 secureblackbox_oauthclient_register_callback($res, $id, $function);
 secureblackbox_oauthclient_get_last_error($res);
 secureblackbox_oauthclient_get_last_error_code($res);
 secureblackbox_oauthclient_set($res, $id, $index, $value);
 secureblackbox_oauthclient_get($res, $id, $index);
 secureblackbox_oauthclient_do_authorize($res);
 secureblackbox_oauthclient_do_config($res, $configurationstring);
 secureblackbox_oauthclient_do_doaction($res, $actionid, $actionparams);

Remarks

OAuthClient implements interaction between the client (an application that needs access to a protected resource), the resource owner (end-user), and the authorization server via OAuth 2.0 (RFC 6749) protocol.

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.

AccessToken Property (SecureBlackbox_OAuthClient Class)

Contains the access token.

Object Oriented Interface

public function getAccessToken();


public function setAccessToken($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 1 );


secureblackbox_oauthclient_set($res, 1, $value );

Default Value

''

Remarks

Use this property to check or set the authorization access token.

This property is not available at design time.

Data Type

String

AuthURL Property (SecureBlackbox_OAuthClient Class)

Specifies the URL of the authorization server.

Object Oriented Interface

public function getAuthURL();


public function setAuthURL($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 2 );


secureblackbox_oauthclient_set($res, 2, $value );

Default Value

''

Remarks

Use this property to set the URL of the authorization server.

Data Type

String

AutoRefresh Property (SecureBlackbox_OAuthClient Class)

Specifies whether access token should be automatically refreshed.

Object Oriented Interface

public function getAutoRefresh();


public function setAutoRefresh($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 3 );


secureblackbox_oauthclient_set($res, 3, $value );

Default Value

true

Remarks

Set this property to true to let the class automatically refresh AccessToken. If available, RefreshToken is used to renew access token. Otherwise the authorization process is initiated from the beginning, with user authentication and so on.

Data Type

Boolean

BlockedCertCount Property (SecureBlackbox_OAuthClient Class)

The number of records in the BlockedCert arrays.

Object Oriented Interface

public function getBlockedCertCount();


public function setBlockedCertCount($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 4 );


secureblackbox_oauthclient_set($res, 4, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• BlockedCertBytes
• BlockedCertHandle

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

This property is not available at design time.

Data Type

Integer

BlockedCertBytes Property (SecureBlackbox_OAuthClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getBlockedCertBytes($blockedcertindex);

Procedural Interface

secureblackbox_oauthclient_get($res, 5 , $blockedcertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

BlockedCertHandle Property (SecureBlackbox_OAuthClient 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_oauthclient_get($res, 12 , $blockedcertindex);


secureblackbox_oauthclient_set($res, 12, $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

ClientCertCount Property (SecureBlackbox_OAuthClient Class)

The number of records in the ClientCert arrays.

Object Oriented Interface

public function getClientCertCount();


public function setClientCertCount($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 39 );


secureblackbox_oauthclient_set($res, 39, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ClientCertBytes
• ClientCertHandle

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

This property is not available at design time.

Data Type

Integer

ClientCertBytes Property (SecureBlackbox_OAuthClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getClientCertBytes($clientcertindex);

Procedural Interface

secureblackbox_oauthclient_get($res, 40 , $clientcertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

ClientCertHandle Property (SecureBlackbox_OAuthClient Class)

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

Object Oriented Interface

public function getClientCertHandle($clientcertindex);


public function setClientCertHandle($clientcertindex, $value);

Procedural Interface

secureblackbox_oauthclient_get($res, 47 , $clientcertindex);


secureblackbox_oauthclient_set($res, 47, $value , $clientcertindex);

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

This property is not available at design time.

Data Type

Long64

ClientID Property (SecureBlackbox_OAuthClient Class)

Client ID of the application which needs access to the protected resource.

Object Oriented Interface

public function getClientID();


public function setClientID($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 74 );


secureblackbox_oauthclient_set($res, 74, $value );

Default Value

''

Remarks

Use this property to specify the client ID of the application.

Data Type

String

ClientSecret Property (SecureBlackbox_OAuthClient Class)

Client secret of the application which needs access to the protected resource.

Object Oriented Interface

public function getClientSecret();


public function setClientSecret($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 75 );


secureblackbox_oauthclient_set($res, 75, $value );

Default Value

''

Remarks

Use this property to specify client secret of the application.

Data Type

String

ConnInfoAEADCipher Property (SecureBlackbox_OAuthClient Class)

Indicates whether the encryption algorithm used is an AEAD cipher.

Object Oriented Interface

public function getConnInfoAEADCipher();

Procedural Interface

secureblackbox_oauthclient_get($res, 76 );

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

The details of a certificate chain validation outcome.

Object Oriented Interface

public function getConnInfoChainValidationDetails();

Procedural Interface

secureblackbox_oauthclient_get($res, 77 );

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

The outcome of a certificate chain validation routine.

Object Oriented Interface

public function getConnInfoChainValidationResult();

Procedural Interface

secureblackbox_oauthclient_get($res, 78 );

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

The cipher suite employed by this connection.

Object Oriented Interface

public function getConnInfoCiphersuite();

Procedural Interface

secureblackbox_oauthclient_get($res, 79 );

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

Specifies whether client authentication was performed during this connection.

Object Oriented Interface

public function getConnInfoClientAuthenticated();

Procedural Interface

secureblackbox_oauthclient_get($res, 80 );

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

Specifies whether client authentication was requested during this connection.

Object Oriented Interface

public function getConnInfoClientAuthRequested();

Procedural Interface

secureblackbox_oauthclient_get($res, 81 );

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

Indicates whether the connection has been established fully.

Object Oriented Interface

public function getConnInfoConnectionEstablished();

Procedural Interface

secureblackbox_oauthclient_get($res, 82 );

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

The unique identifier assigned to this connection.

Object Oriented Interface

public function getConnInfoConnectionID();

Procedural Interface

secureblackbox_oauthclient_get($res, 83 );

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

The digest algorithm used in a TLS-enabled connection.

Object Oriented Interface

public function getConnInfoDigestAlgorithm();

Procedural Interface

secureblackbox_oauthclient_get($res, 84 );

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

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

Object Oriented Interface

public function getConnInfoEncryptionAlgorithm();

Procedural Interface

secureblackbox_oauthclient_get($res, 85 );

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

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

Object Oriented Interface

public function getConnInfoExportable();

Procedural Interface

secureblackbox_oauthclient_get($res, 86 );

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

ConnInfoKeyExchangeAlgorithm Property (SecureBlackbox_OAuthClient Class)

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

Object Oriented Interface

public function getConnInfoKeyExchangeAlgorithm();

Procedural Interface

secureblackbox_oauthclient_get($res, 87 );

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

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

Object Oriented Interface

public function getConnInfoKeyExchangeKeyBits();

Procedural Interface

secureblackbox_oauthclient_get($res, 88 );

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

The elliptic curve used in this connection.

Object Oriented Interface

public function getConnInfoNamedECCurve();

Procedural Interface

secureblackbox_oauthclient_get($res, 89 );

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

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

Object Oriented Interface

public function getConnInfoPFSCipher();

Procedural Interface

secureblackbox_oauthclient_get($res, 90 );

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

ConnInfoPreSharedIdentityHint Property (SecureBlackbox_OAuthClient 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_oauthclient_get($res, 91 );

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

The length of the public key.

Object Oriented Interface

public function getConnInfoPublicKeyBits();

Procedural Interface

secureblackbox_oauthclient_get($res, 92 );

Default Value

0

Remarks

The length of the public key.

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

Data Type

Integer

ConnInfoResumedSession Property (SecureBlackbox_OAuthClient Class)

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

Object Oriented Interface

public function getConnInfoResumedSession();

Procedural Interface

secureblackbox_oauthclient_get($res, 93 );

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

Indicates whether TLS or SSL is enabled for this connection.

Object Oriented Interface

public function getConnInfoSecureConnection();

Procedural Interface

secureblackbox_oauthclient_get($res, 94 );

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

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

Object Oriented Interface

public function getConnInfoServerAuthenticated();

Procedural Interface

secureblackbox_oauthclient_get($res, 95 );

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

The signature algorithm used in a TLS handshake.

Object Oriented Interface

public function getConnInfoSignatureAlgorithm();

Procedural Interface

secureblackbox_oauthclient_get($res, 96 );

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

The block size of the symmetric algorithm used.

Object Oriented Interface

public function getConnInfoSymmetricBlockSize();

Procedural Interface

secureblackbox_oauthclient_get($res, 97 );

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

The key length of the symmetric algorithm used.

Object Oriented Interface

public function getConnInfoSymmetricKeyBits();

Procedural Interface

secureblackbox_oauthclient_get($res, 98 );

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

The total number of bytes received over this connection.

Object Oriented Interface

public function getConnInfoTotalBytesReceived();

Procedural Interface

secureblackbox_oauthclient_get($res, 99 );

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

The total number of bytes sent over this connection.

Object Oriented Interface

public function getConnInfoTotalBytesSent();

Procedural Interface

secureblackbox_oauthclient_get($res, 100 );

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

Contains the server certificate's chain validation log.

Object Oriented Interface

public function getConnInfoValidationLog();

Procedural Interface

secureblackbox_oauthclient_get($res, 101 );

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

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

Object Oriented Interface

public function getConnInfoVersion();

Procedural Interface

secureblackbox_oauthclient_get($res, 102 );

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

CustomParamCount Property (SecureBlackbox_OAuthClient Class)

The number of records in the CustomParams arrays.

Object Oriented Interface

public function getCustomParamCount();


public function setCustomParamCount($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 103 );


secureblackbox_oauthclient_set($res, 103, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• CustomParamsCategory
• CustomParamsFormat
• CustomParamsName
• CustomParamsValue

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

This property is not available at design time.

Data Type

Integer

CustomParamsCategory Property (SecureBlackbox_OAuthClient Class)

Specifies the string category of the contained value.

Object Oriented Interface

public function getCustomParamsCategory($customparamindex);


public function setCustomParamsCategory($customparamindex, $value);

Procedural Interface

secureblackbox_oauthclient_get($res, 104 , $customparamindex);


secureblackbox_oauthclient_set($res, 104, $value , $customparamindex);

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

This property is not available at design time.

Data Type

String

CustomParamsFormat Property (SecureBlackbox_OAuthClient Class)

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

Object Oriented Interface

public function getCustomParamsFormat($customparamindex);


public function setCustomParamsFormat($customparamindex, $value);

Procedural Interface

secureblackbox_oauthclient_get($res, 105 , $customparamindex);


secureblackbox_oauthclient_set($res, 105, $value , $customparamindex);

Default Value

0

Remarks

Specifies the format (encoding) of the value contained in the CustomParamsValue 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 $customparamindex parameter specifies the index of the item in the array. The size of the array is controlled by the CustomParamCount property.

This property is not available at design time.

Data Type

Integer

CustomParamsName Property (SecureBlackbox_OAuthClient Class)

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

Object Oriented Interface

public function getCustomParamsName($customparamindex);


public function setCustomParamsName($customparamindex, $value);

Procedural Interface

secureblackbox_oauthclient_get($res, 106 , $customparamindex);


secureblackbox_oauthclient_set($res, 106, $value , $customparamindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

CustomParamsValue Property (SecureBlackbox_OAuthClient Class)

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

Object Oriented Interface

public function getCustomParamsValue($customparamindex);


public function setCustomParamsValue($customparamindex, $value);

Procedural Interface

secureblackbox_oauthclient_get($res, 107 , $customparamindex);


secureblackbox_oauthclient_set($res, 107, $value , $customparamindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

ExpiresAt Property (SecureBlackbox_OAuthClient Class)

The expiration time of access token.

Object Oriented Interface

public function getExpiresAt();


public function setExpiresAt($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 108 );


secureblackbox_oauthclient_set($res, 108, $value );

Default Value

''

Remarks

Use this property to check the expiration time of AccessToken.

Data Type

String

ExpiresIn Property (SecureBlackbox_OAuthClient Class)

Returns access token lifetime in seconds.

Object Oriented Interface

public function getExpiresIn();

Procedural Interface

secureblackbox_oauthclient_get($res, 109 );

Default Value

0

Remarks

Use this property to get the AccessToken lifetime in seconds. This value is returned by the authorization server together with the access token. To check the token's expiration moment, use ExpiresAt property.

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

Data Type

Integer

ExternalCryptoAsyncDocumentID Property (SecureBlackbox_OAuthClient Class)

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

Object Oriented Interface

public function getExternalCryptoAsyncDocumentID();


public function setExternalCryptoAsyncDocumentID($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 110 );


secureblackbox_oauthclient_set($res, 110, $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_OAuthClient Class)

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

Object Oriented Interface

public function getExternalCryptoCustomParams();


public function setExternalCryptoCustomParams($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 111 );


secureblackbox_oauthclient_set($res, 111, $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_OAuthClient 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_oauthclient_get($res, 112 );


secureblackbox_oauthclient_set($res, 112, $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_OAuthClient 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_oauthclient_get($res, 113 );


secureblackbox_oauthclient_set($res, 113, $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_OAuthClient Class)

Specifies the request's signature hash algorithm.

Object Oriented Interface

public function getExternalCryptoHashAlgorithm();


public function setExternalCryptoHashAlgorithm($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 114 );


secureblackbox_oauthclient_set($res, 114, $value );

Default Value

'SHA256'

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SecureBlackbox_OAuthClient 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_oauthclient_get($res, 115 );


secureblackbox_oauthclient_set($res, 115, $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_OAuthClient Class)

The pre-shared key used for DC request authentication.

Object Oriented Interface

public function getExternalCryptoKeySecret();


public function setExternalCryptoKeySecret($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 116 );


secureblackbox_oauthclient_set($res, 116, $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_OAuthClient Class)

Specifies the asynchronous signing method.

Object Oriented Interface

public function getExternalCryptoMethod();


public function setExternalCryptoMethod($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 117 );


secureblackbox_oauthclient_set($res, 117, $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_OAuthClient Class)

Specifies the external cryptography mode.

Object Oriented Interface

public function getExternalCryptoMode();


public function setExternalCryptoMode($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 118 );


secureblackbox_oauthclient_set($res, 118, $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_OAuthClient 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_oauthclient_get($res, 119 );


secureblackbox_oauthclient_set($res, 119, $value );

Default Value

''

Remarks

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

Data Type

String

FailureResponse Property (SecureBlackbox_OAuthClient Class)

The web page showed to the user by the class on authorization failure.

Object Oriented Interface

public function getFailureResponse();


public function setFailureResponse($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 120 );


secureblackbox_oauthclient_set($res, 120, $value );

Default Value

''

Remarks

This property contains the html of the web page to be shown on authorization failure.

Data Type

String

FIPSMode Property (SecureBlackbox_OAuthClient Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 121 );


secureblackbox_oauthclient_set($res, 121, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

GrantType Property (SecureBlackbox_OAuthClient Class)

Specifies which protocol flow should be used to authorize the user.

Object Oriented Interface

public function getGrantType();


public function setGrantType($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 122 );


secureblackbox_oauthclient_set($res, 122, $value );

Default Value

0

Remarks

Use this property to specify the authorization protocol to use.

Data Type

Integer

IDToken Property (SecureBlackbox_OAuthClient Class)

Contains the ID Token parameter for JWT.

Object Oriented Interface

public function getIDToken();

Procedural Interface

secureblackbox_oauthclient_get($res, 123 );

Default Value

''

Remarks

Use this property to get the id_token parameter (if any) than can be used for JWT operations.

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

Data Type

String

KeepAlivePolicy Property (SecureBlackbox_OAuthClient Class)

Defines the keep-alive handling policy.

Object Oriented Interface

public function getKeepAlivePolicy();


public function setKeepAlivePolicy($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 124 );


secureblackbox_oauthclient_set($res, 124, $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_OAuthClient Class)

The number of records in the KnownCert arrays.

Object Oriented Interface

public function getKnownCertCount();


public function setKnownCertCount($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 125 );


secureblackbox_oauthclient_set($res, 125, $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_OAuthClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getKnownCertBytes($knowncertindex);

Procedural Interface

secureblackbox_oauthclient_get($res, 126 , $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_OAuthClient 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_oauthclient_get($res, 133 , $knowncertindex);


secureblackbox_oauthclient_set($res, 133, $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_OAuthClient Class)

The number of records in the KnownCRL arrays.

Object Oriented Interface

public function getKnownCRLCount();


public function setKnownCRLCount($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 160 );


secureblackbox_oauthclient_set($res, 160, $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_OAuthClient Class)

Returns the raw CRL data in DER format.

Object Oriented Interface

public function getKnownCRLBytes($knowncrlindex);

Procedural Interface

secureblackbox_oauthclient_get($res, 161 , $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_OAuthClient 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_oauthclient_get($res, 164 , $knowncrlindex);


secureblackbox_oauthclient_set($res, 164, $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_OAuthClient Class)

The number of records in the KnownOCSP arrays.

Object Oriented Interface

public function getKnownOCSPCount();


public function setKnownOCSPCount($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 172 );


secureblackbox_oauthclient_set($res, 172, $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_OAuthClient Class)

A buffer containing the raw OCSP response data.

Object Oriented Interface

public function getKnownOCSPBytes($knownocspindex);

Procedural Interface

secureblackbox_oauthclient_get($res, 173 , $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_OAuthClient 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_oauthclient_get($res, 175 , $knownocspindex);


secureblackbox_oauthclient_set($res, 175, $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

Password Property (SecureBlackbox_OAuthClient Class)

The connecting user's authentication password.

Object Oriented Interface

public function getPassword();


public function setPassword($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 180 );


secureblackbox_oauthclient_set($res, 180, $value );

Default Value

''

Remarks

Assign the user's authentication password to this property. Use Username for username/login. The Username and Password properties are used only when GrantType is oauthPasswordCredentials.

Data Type

String

ProxyAddress Property (SecureBlackbox_OAuthClient Class)

The IP address of the proxy server.

Object Oriented Interface

public function getProxyAddress();


public function setProxyAddress($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 181 );


secureblackbox_oauthclient_set($res, 181, $value );

Default Value

''

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (SecureBlackbox_OAuthClient Class)

The authentication type used by the proxy server.

Object Oriented Interface

public function getProxyAuthentication();


public function setProxyAuthentication($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 182 );


secureblackbox_oauthclient_set($res, 182, $value );

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxyPassword Property (SecureBlackbox_OAuthClient Class)

The password to authenticate to the proxy server.

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 183 );


secureblackbox_oauthclient_set($res, 183, $value );

Default Value

''

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (SecureBlackbox_OAuthClient Class)

The port on the proxy server to connect to.

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 184 );


secureblackbox_oauthclient_set($res, 184, $value );

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (SecureBlackbox_OAuthClient Class)

The type of the proxy server.

Object Oriented Interface

public function getProxyProxyType();


public function setProxyProxyType($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 185 );


secureblackbox_oauthclient_set($res, 185, $value );

Default Value

0

Remarks

The type of the proxy server.

The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.

Data Type

Integer

ProxyRequestHeaders Property (SecureBlackbox_OAuthClient Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Object Oriented Interface

public function getProxyRequestHeaders();


public function setProxyRequestHeaders($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 186 );


secureblackbox_oauthclient_set($res, 186, $value );

Default Value

''

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (SecureBlackbox_OAuthClient Class)

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

Object Oriented Interface

public function getProxyResponseBody();


public function setProxyResponseBody($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 187 );


secureblackbox_oauthclient_set($res, 187, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyResponseHeaders Property (SecureBlackbox_OAuthClient 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_oauthclient_get($res, 188 );


secureblackbox_oauthclient_set($res, 188, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyUseIPv6 Property (SecureBlackbox_OAuthClient 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_oauthclient_get($res, 189 );


secureblackbox_oauthclient_set($res, 189, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyUseProxy Property (SecureBlackbox_OAuthClient Class)

Enables or disables proxy-driven connection.

Object Oriented Interface

public function getProxyUseProxy();


public function setProxyUseProxy($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 190 );


secureblackbox_oauthclient_set($res, 190, $value );

Default Value

false

Remarks

Enables or disables proxy-driven connection.

Data Type

Boolean

ProxyUsername Property (SecureBlackbox_OAuthClient Class)

Specifies the username credential for proxy authentication.

Object Oriented Interface

public function getProxyUsername();


public function setProxyUsername($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 191 );


secureblackbox_oauthclient_set($res, 191, $value );

Default Value

''

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

RedirectURL Property (SecureBlackbox_OAuthClient Class)

The URL where the user is redirected after authorization.

Object Oriented Interface

public function getRedirectURL();


public function setRedirectURL($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 192 );


secureblackbox_oauthclient_set($res, 192, $value );

Default Value

''

Remarks

Use this property to specify the URL on which the local HTTP server should open the listening port and wait for response from the authorization server. When the port number is explicitly specified, e.g., "http://localhost:5050/", the application has to be allowed to open a listening socket on that port.

HTTPS redirects support

Services increasingly require that redirects are made to HTTPS-enabled endpoints (e.g. "https://localhost:5050/"). OAuthClient does support them, but you are expected to do a little tuneup to be able to handle them.

What you need to do is set up the TLS server certificate that the OAuth receiver will be presenting to the user's web browser. The certificate is an integral part of the TLS handshake process. You can provide the certificate to the component using the AddLocalServerCertificate or AddLocalServerCertificateFromFile actions. See DoAction for the details.

The provided TLS certificate must contain a matching private key. You can generate the certificate using the CertificateManager component, or third-party software such as OpenSSL. Note that some browsers no longer accept self-signed TLS certificates, which typically means that you need to generate and set up a pair of certificates (the self-signed root certificate and the subordinate web server certificate) to make your receiver work with such browsers.

Data Type

String

RefreshToken Property (SecureBlackbox_OAuthClient Class)

The refresh token, to be used to automatically obtain new access token.

Object Oriented Interface

public function getRefreshToken();


public function setRefreshToken($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 193 );


secureblackbox_oauthclient_set($res, 193, $value );

Default Value

''

Remarks

The refresh token is used to obtain new AccessToken without user authentication.

Data Type

String

Scope Property (SecureBlackbox_OAuthClient Class)

The scope of the request to be authorized.

Object Oriented Interface

public function getScope();


public function setScope($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 194 );


secureblackbox_oauthclient_set($res, 194, $value );

Default Value

''

Remarks

Use this property to specify the scope of the request to the protected resource.

Data Type

String

ServerCertCount Property (SecureBlackbox_OAuthClient Class)

The number of records in the ServerCert arrays.

Object Oriented Interface

public function getServerCertCount();

Procedural Interface

secureblackbox_oauthclient_get($res, 195 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ServerCertBytes
• ServerCertCAKeyID
• ServerCertFingerprint
• ServerCertHandle
• ServerCertIssuer
• ServerCertIssuerRDN
• ServerCertKeyAlgorithm
• ServerCertKeyBits
• ServerCertKeyFingerprint
• ServerCertKeyUsage
• ServerCertPublicKeyBytes
• ServerCertSelfSigned
• ServerCertSerialNumber
• ServerCertSigAlgorithm
• ServerCertSubject
• ServerCertSubjectKeyID
• ServerCertSubjectRDN
• ServerCertValidFrom
• ServerCertValidTo

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

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

Data Type

Integer

ServerCertBytes Property (SecureBlackbox_OAuthClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getServerCertBytes($servercertindex);

Procedural Interface

secureblackbox_oauthclient_get($res, 196 , $servercertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

ServerCertCAKeyID Property (SecureBlackbox_OAuthClient Class)

A unique identifier (fingerprint) of the CA certificate's private key.

Object Oriented Interface

public function getServerCertCAKeyID($servercertindex);

Procedural Interface

secureblackbox_oauthclient_get($res, 198 , $servercertindex);

Remarks

A unique identifier (fingerprint) of the CA certificate's private key.

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

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

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

Data Type

Byte Array

ServerCertFingerprint Property (SecureBlackbox_OAuthClient Class)

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

Object Oriented Interface

public function getServerCertFingerprint($servercertindex);

Procedural Interface

secureblackbox_oauthclient_get($res, 201 , $servercertindex);

Remarks

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

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

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

Data Type

Byte Array

ServerCertHandle Property (SecureBlackbox_OAuthClient Class)

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

Object Oriented Interface

public function getServerCertHandle($servercertindex);

Procedural Interface

secureblackbox_oauthclient_get($res, 203 , $servercertindex);

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

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

Data Type

Long64

ServerCertIssuer Property (SecureBlackbox_OAuthClient Class)

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

Object Oriented Interface

public function getServerCertIssuer($servercertindex);

Procedural Interface

secureblackbox_oauthclient_get($res, 205 , $servercertindex);

Default Value

''

Remarks

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

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

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

Data Type

String

ServerCertIssuerRDN Property (SecureBlackbox_OAuthClient Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

Object Oriented Interface

public function getServerCertIssuerRDN($servercertindex);

Procedural Interface

secureblackbox_oauthclient_get($res, 206 , $servercertindex);

Default Value

''

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

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

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

Data Type

String

ServerCertKeyAlgorithm Property (SecureBlackbox_OAuthClient Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getServerCertKeyAlgorithm($servercertindex);

Procedural Interface

secureblackbox_oauthclient_get($res, 207 , $servercertindex);

Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

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

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

Data Type

String

ServerCertKeyBits Property (SecureBlackbox_OAuthClient Class)

Returns the length of the public key.

Object Oriented Interface

public function getServerCertKeyBits($servercertindex);

Procedural Interface

secureblackbox_oauthclient_get($res, 208 , $servercertindex);

Default Value

0

Remarks

Returns the length of the public key.

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

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

Data Type

Integer

ServerCertKeyFingerprint Property (SecureBlackbox_OAuthClient Class)

Returns a fingerprint of the public key contained in the certificate.

Object Oriented Interface

public function getServerCertKeyFingerprint($servercertindex);

Procedural Interface

secureblackbox_oauthclient_get($res, 209 , $servercertindex);

Remarks

Returns a fingerprint of the public key contained in the certificate.

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

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

Data Type

Byte Array

ServerCertKeyUsage Property (SecureBlackbox_OAuthClient 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 getServerCertKeyUsage($servercertindex);

Procedural Interface

secureblackbox_oauthclient_get($res, 210 , $servercertindex);

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:

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

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

Data Type

Integer

ServerCertPublicKeyBytes Property (SecureBlackbox_OAuthClient Class)

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getServerCertPublicKeyBytes($servercertindex);

Procedural Interface

secureblackbox_oauthclient_get($res, 219 , $servercertindex);

Remarks

Contains the certificate's public key in DER format.

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

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

Data Type

Byte Array

ServerCertSelfSigned Property (SecureBlackbox_OAuthClient Class)

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

Object Oriented Interface

public function getServerCertSelfSigned($servercertindex);

Procedural Interface

secureblackbox_oauthclient_get($res, 221 , $servercertindex);

Default Value

false

Remarks

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

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

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

Data Type

Boolean

ServerCertSerialNumber Property (SecureBlackbox_OAuthClient Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getServerCertSerialNumber($servercertindex);

Procedural Interface

secureblackbox_oauthclient_get($res, 222 , $servercertindex);

Remarks

Returns the certificate's serial number.

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

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

Data Type

Byte Array

ServerCertSigAlgorithm Property (SecureBlackbox_OAuthClient Class)

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

Object Oriented Interface

public function getServerCertSigAlgorithm($servercertindex);

Procedural Interface

secureblackbox_oauthclient_get($res, 223 , $servercertindex);

Default Value

''

Remarks

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

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

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

Data Type

String

ServerCertSubject Property (SecureBlackbox_OAuthClient 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 getServerCertSubject($servercertindex);

Procedural Interface

secureblackbox_oauthclient_get($res, 224 , $servercertindex);

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.

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

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

Data Type

String

ServerCertSubjectKeyID Property (SecureBlackbox_OAuthClient Class)

Contains a unique identifier (fingerprint) of the certificate's private key.

Object Oriented Interface

public function getServerCertSubjectKeyID($servercertindex);

Procedural Interface

secureblackbox_oauthclient_get($res, 226 , $servercertindex);

Remarks

Contains a unique identifier (fingerprint) of the certificate's private key.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.

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

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

Data Type

Byte Array

ServerCertSubjectRDN Property (SecureBlackbox_OAuthClient Class)

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

Object Oriented Interface

public function getServerCertSubjectRDN($servercertindex);

Procedural Interface

secureblackbox_oauthclient_get($res, 227 , $servercertindex);

Default Value

''

Remarks

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

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

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

Data Type

String

ServerCertValidFrom Property (SecureBlackbox_OAuthClient Class)

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

Object Oriented Interface

public function getServerCertValidFrom($servercertindex);

Procedural Interface

secureblackbox_oauthclient_get($res, 228 , $servercertindex);

Default Value

''

Remarks

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

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

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

Data Type

String

ServerCertValidTo Property (SecureBlackbox_OAuthClient Class)

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

Object Oriented Interface

public function getServerCertValidTo($servercertindex);

Procedural Interface

secureblackbox_oauthclient_get($res, 229 , $servercertindex);

Default Value

''

Remarks

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

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

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

Data Type

String

SocketDNSMode Property (SecureBlackbox_OAuthClient 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_oauthclient_get($res, 230 );


secureblackbox_oauthclient_set($res, 230, $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_OAuthClient 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_oauthclient_get($res, 231 );


secureblackbox_oauthclient_set($res, 231, $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_OAuthClient Class)

The timeout (in milliseconds) for each DNS query.

Object Oriented Interface

public function getSocketDNSQueryTimeout();


public function setSocketDNSQueryTimeout($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 232 );


secureblackbox_oauthclient_set($res, 232, $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_OAuthClient 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_oauthclient_get($res, 233 );


secureblackbox_oauthclient_set($res, 233, $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_OAuthClient Class)

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

Object Oriented Interface

public function getSocketDNSTotalTimeout();


public function setSocketDNSTotalTimeout($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 234 );


secureblackbox_oauthclient_set($res, 234, $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_OAuthClient 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_oauthclient_get($res, 235 );


secureblackbox_oauthclient_set($res, 235, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (SecureBlackbox_OAuthClient Class)

The local network interface to bind the socket to.

Object Oriented Interface

public function getSocketLocalAddress();


public function setSocketLocalAddress($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 236 );


secureblackbox_oauthclient_set($res, 236, $value );

Default Value

''

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SecureBlackbox_OAuthClient Class)

The local port number to bind the socket to.

Object Oriented Interface

public function getSocketLocalPort();


public function setSocketLocalPort($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 237 );


secureblackbox_oauthclient_set($res, 237, $value );

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SecureBlackbox_OAuthClient 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_oauthclient_get($res, 238 );


secureblackbox_oauthclient_set($res, 238, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (SecureBlackbox_OAuthClient 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_oauthclient_get($res, 239 );


secureblackbox_oauthclient_set($res, 239, $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_OAuthClient Class)

Enables or disables IP protocol version 6.

Object Oriented Interface

public function getSocketUseIPv6();


public function setSocketUseIPv6($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 240 );


secureblackbox_oauthclient_set($res, 240, $value );

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

State Property (SecureBlackbox_OAuthClient Class)

Specifies the state parameter of the authorization request or response.

Object Oriented Interface

public function getState();


public function setState($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 241 );


secureblackbox_oauthclient_set($res, 241, $value );

Default Value

''

Remarks

This parameter contains an opaque value used by the client to maintain state between the request and callback. If this parameter was present in the authorization request, the server should include the same value in its response.

Data Type

String

SuccessResponse Property (SecureBlackbox_OAuthClient Class)

The web page showed to the user by the class on authorization success.

Object Oriented Interface

public function getSuccessResponse();


public function setSuccessResponse($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 242 );


secureblackbox_oauthclient_set($res, 242, $value );

Default Value

''

Remarks

This property contains the html of the web page to be shown on authorization success.

Data Type

String

Timeout Property (SecureBlackbox_OAuthClient Class)

Specifies waiting timeout (in milliseconds).

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 243 );


secureblackbox_oauthclient_set($res, 243, $value );

Default Value

120000

Remarks

This property specifies the timeout (in milliseconds) to wait for server's response.

Data Type

Integer

TLSAutoValidateCertificates Property (SecureBlackbox_OAuthClient 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_oauthclient_get($res, 244 );


secureblackbox_oauthclient_set($res, 244, $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_OAuthClient Class)

Selects the base configuration for the TLS settings.

Object Oriented Interface

public function getTLSBaseConfiguration();


public function setTLSBaseConfiguration($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 245 );


secureblackbox_oauthclient_set($res, 245, $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_OAuthClient Class)

A list of ciphersuites separated with commas or semicolons.

Object Oriented Interface

public function getTLSCiphersuites();


public function setTLSCiphersuites($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 246 );


secureblackbox_oauthclient_set($res, 246, $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

TLSECCurves Property (SecureBlackbox_OAuthClient Class)

Defines the elliptic curves to enable.

Object Oriented Interface

public function getTLSECCurves();


public function setTLSECCurves($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 247 );


secureblackbox_oauthclient_set($res, 247, $value );

Default Value

''

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (SecureBlackbox_OAuthClient Class)

Provides access to TLS extensions.

Object Oriented Interface

public function getTLSExtensions();


public function setTLSExtensions($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 248 );


secureblackbox_oauthclient_set($res, 248, $value );

Default Value

''

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (SecureBlackbox_OAuthClient 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_oauthclient_get($res, 249 );


secureblackbox_oauthclient_set($res, 249, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSPreSharedIdentity Property (SecureBlackbox_OAuthClient 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_oauthclient_get($res, 250 );


secureblackbox_oauthclient_set($res, 250, $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_OAuthClient 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_oauthclient_get($res, 251 );


secureblackbox_oauthclient_set($res, 251, $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_OAuthClient Class)

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

Object Oriented Interface

public function getTLSPreSharedKeyCiphersuite();


public function setTLSPreSharedKeyCiphersuite($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 252 );


secureblackbox_oauthclient_set($res, 252, $value );

Default Value

''

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (SecureBlackbox_OAuthClient Class)

Selects the renegotiation attack prevention mechanism.

Object Oriented Interface

public function getTLSRenegotiationAttackPreventionMode();


public function setTLSRenegotiationAttackPreventionMode($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 253 );


secureblackbox_oauthclient_set($res, 253, $value );

Default Value

0

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (SecureBlackbox_OAuthClient Class)

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

Object Oriented Interface

public function getTLSRevocationCheck();


public function setTLSRevocationCheck($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 254 );


secureblackbox_oauthclient_set($res, 254, $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_OAuthClient 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_oauthclient_get($res, 255 );


secureblackbox_oauthclient_set($res, 255, $value );

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (SecureBlackbox_OAuthClient Class)

Specifies the TLS mode to use.

Object Oriented Interface

public function getTLSTLSMode();


public function setTLSTLSMode($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 256 );


secureblackbox_oauthclient_set($res, 256, $value );

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (SecureBlackbox_OAuthClient 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_oauthclient_get($res, 257 );


secureblackbox_oauthclient_set($res, 257, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (SecureBlackbox_OAuthClient Class)

Enables or disables the TLS session resumption capability.

Object Oriented Interface

public function getTLSUseSessionResumption();


public function setTLSUseSessionResumption($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 258 );


secureblackbox_oauthclient_set($res, 258, $value );

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (SecureBlackbox_OAuthClient Class)

The SSL/TLS versions to enable by default.

Object Oriented Interface

public function getTLSVersions();


public function setTLSVersions($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 259 );


secureblackbox_oauthclient_set($res, 259, $value );

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

TokenType Property (SecureBlackbox_OAuthClient Class)

Returns the access token type.

Object Oriented Interface

public function getTokenType();

Procedural Interface

secureblackbox_oauthclient_get($res, 260 );

Default Value

''

Remarks

The access token type provides a client with the information on how to use the AccessToken. The understanding of token type is the client's responsibility. Some token types are described, for instance, in RFC 6750 and OAuth-HTTP-MAC specifications.

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

Data Type

String

TokenURL Property (SecureBlackbox_OAuthClient Class)

Specifies the URL of the token endpoint.

Object Oriented Interface

public function getTokenURL();


public function setTokenURL($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 261 );


secureblackbox_oauthclient_set($res, 261, $value );

Default Value

''

Remarks

The token endpoint is used by the client, which needs access to protected resource, to obtain access token from the authorization server.

Data Type

String

TrustedCertCount Property (SecureBlackbox_OAuthClient Class)

The number of records in the TrustedCert arrays.

Object Oriented Interface

public function getTrustedCertCount();


public function setTrustedCertCount($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 262 );


secureblackbox_oauthclient_set($res, 262, $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_OAuthClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTrustedCertBytes($trustedcertindex);

Procedural Interface

secureblackbox_oauthclient_get($res, 263 , $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_OAuthClient 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_oauthclient_get($res, 270 , $trustedcertindex);


secureblackbox_oauthclient_set($res, 270, $value , $trustedcertindex);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

Username Property (SecureBlackbox_OAuthClient Class)

The connecting user's username (login name).

Object Oriented Interface

public function getUsername();


public function setUsername($value);

Procedural Interface

secureblackbox_oauthclient_get($res, 297 );


secureblackbox_oauthclient_set($res, 297, $value );

Default Value

''

Remarks

Assign the user's login name to this property. Use Password to provide the password. The Username and Password properties are used only when GrantType is oauthPasswordCredentials.

Data Type

String

Authorize Method (SecureBlackbox_OAuthClient Class)

Performs user authorization and gets an access token.

Object Oriented Interface

public function doAuthorize();

Procedural Interface

secureblackbox_oauthclient_do_authorize($res);

Remarks

Call this method to perform user authorization and get an access token. When the user completes authorization and its data is sent to the server, OAuthClient will fire the Wait event periodically, to show how much waiting time is left. Upon successful authorization, the AccessToken and ExpiresAt properties are filled.

Returns true if the authorization was granted, and false otherwise.

Config Method (SecureBlackbox_OAuthClient Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_oauthclient_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoAction Method (SecureBlackbox_OAuthClient Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

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

Error Event (SecureBlackbox_OAuthClient Class)

Provides information about errors during authorization operations.

Object Oriented Interface

public function fireError($param);

Procedural Interface

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

Parameter List

 'errorcode'
 'description'

Remarks

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

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

ExternalSign Event (SecureBlackbox_OAuthClient Class)

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

Object Oriented Interface

public function fireExternalSign($param);

Procedural Interface

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

Parameter List

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

Remarks

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

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

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

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

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

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

LaunchBrowser Event (SecureBlackbox_OAuthClient Class)

Fires to show the login page to the end-user.

Object Oriented Interface

public function fireLaunchBrowser($param);

Procedural Interface

secureblackbox_oauthclient_register_callback($res, 3, array($this, 'fireLaunchBrowser'));

Parameter List

 'url'
 'handled'

Remarks

Subscribe to this event to respond to requests from the component to open the URL in the browser. Set Handled to true to report that the URL has been opened in the browser.

TLSCertNeeded Event (SecureBlackbox_OAuthClient Class)

Fires when a remote TLS party requests a client certificate.

Object Oriented Interface

public function fireTLSCertNeeded($param);

Procedural Interface

secureblackbox_oauthclient_register_callback($res, 4, 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_OAuthClient 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_oauthclient_register_callback($res, 5, 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_OAuthClient Class)

Fires when a TLS handshake with Host successfully completes.

Object Oriented Interface

public function fireTLSEstablished($param);

Procedural Interface

secureblackbox_oauthclient_register_callback($res, 6, 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_OAuthClient Class)

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

Object Oriented Interface

public function fireTLSHandshake($param);

Procedural Interface

secureblackbox_oauthclient_register_callback($res, 7, 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_OAuthClient Class)

Notifies the application about the PSK key exchange.

Object Oriented Interface

public function fireTLSPSK($param);

Procedural Interface

secureblackbox_oauthclient_register_callback($res, 8, 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_OAuthClient Class)

Reports the graceful closure of a TLS connection.

Object Oriented Interface

public function fireTLSShutdown($param);

Procedural Interface

secureblackbox_oauthclient_register_callback($res, 9, 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.

Wait Event (SecureBlackbox_OAuthClient Class)

Fired periodically to show how much waiting time is left.

Object Oriented Interface

public function fireWait($param);

Procedural Interface

secureblackbox_oauthclient_register_callback($res, 10, array($this, 'fireWait'));

Parameter List

 'timeleft'
 'stop'

Remarks

This event is fired after authorization is started, to show how much time is left to wait for server's response. Waiting can be cancelled by setting the Stop parameter to true, which will result in authorization failure.

Config Settings (OAuthClient 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.

OAuthClient Config Settings

Base Config Settings

Trappable Errors (OAuthClient Class)