WebDAVServer Class

Properties   Methods   Events   Config Settings   Errors  

The WebDAVServer class offers server-side functionality for the WebDAV protocol.

Class Name

SecureBlackbox_WebDAVServer

Procedural Interface

 secureblackbox_webdavserver_open();
 secureblackbox_webdavserver_close($res);
 secureblackbox_webdavserver_register_callback($res, $id, $function);
 secureblackbox_webdavserver_get_last_error($res);
 secureblackbox_webdavserver_get_last_error_code($res);
 secureblackbox_webdavserver_set($res, $id, $index, $value);
 secureblackbox_webdavserver_get($res, $id, $index);
 secureblackbox_webdavserver_do_cleanup($res);
 secureblackbox_webdavserver_do_config($res, $configurationstring);
 secureblackbox_webdavserver_do_doaction($res, $actionid, $actionparams);
 secureblackbox_webdavserver_do_dropclient($res, $connectionid, $forced);
 secureblackbox_webdavserver_do_getclientbuffer($res, $connectionid);
 secureblackbox_webdavserver_do_getrequestbytes($res, $connectionid, $requestfilter);
 secureblackbox_webdavserver_do_getrequestheader($res, $connectionid, $headername);
 secureblackbox_webdavserver_do_getrequeststring($res, $connectionid, $requestfilter);
 secureblackbox_webdavserver_do_getrequestusername($res, $connectionid);
 secureblackbox_webdavserver_do_getresponseheader($res, $connectionid, $headername);
 secureblackbox_webdavserver_do_listclients($res);
 secureblackbox_webdavserver_do_pinclient($res, $connectionid);
 secureblackbox_webdavserver_do_processgenericrequest($res, $connectionid, $requestbytes);
 secureblackbox_webdavserver_do_reset($res);
 secureblackbox_webdavserver_do_setclientbuffer($res, $connectionid, $value);
 secureblackbox_webdavserver_do_setclientfileentry($res, $connectionid);
 secureblackbox_webdavserver_do_setresponsebytes($res, $connectionid, $bytes, $contenttype, $responsefilter);
 secureblackbox_webdavserver_do_setresponsefile($res, $connectionid, $filename, $contenttype, $responsefilter);
 secureblackbox_webdavserver_do_setresponseheader($res, $connectionid, $headername, $value);
 secureblackbox_webdavserver_do_setresponsestatus($res, $connectionid, $statuscode);
 secureblackbox_webdavserver_do_setresponsestring($res, $connectionid, $datastr, $contenttype, $responsefilter);
 secureblackbox_webdavserver_do_start($res);
 secureblackbox_webdavserver_do_stop($res);

Remarks

Both plain (HTTP) and secure (HTTPS) connection types are supported.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

Active Property (SecureBlackbox_WebDAVServer Class)

Indicates whether the server is active and is listening to new connections.

Object Oriented Interface

public function getActive();

Procedural Interface

secureblackbox_webdavserver_get($res, 1 );

Default Value

false

Remarks

This read-only property returns True if the server is listening to incoming connections.

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

Data Type

Boolean

AuthRealm Property (SecureBlackbox_WebDAVServer Class)

Specifies authentication realm for digest and NTLM authentication.

Object Oriented Interface

public function getAuthRealm();
public function setAuthRealm($value);

Procedural Interface

secureblackbox_webdavserver_get($res, 2 );
secureblackbox_webdavserver_set($res, 2, $value );

Default Value

'SecureBlackbox'

Remarks

Specifies authentication realm for digest and NTLM authentication types.

Data Type

String

AuthTypes Property (SecureBlackbox_WebDAVServer Class)

Defines allowed HTTP authentication types.

Object Oriented Interface

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

Procedural Interface

secureblackbox_webdavserver_get($res, 3 );
secureblackbox_webdavserver_set($res, 3, $value );

Default Value

0

Remarks

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

Data Type

Integer

BoundPort Property (SecureBlackbox_WebDAVServer Class)

Indicates the bound listening port.

Object Oriented Interface

public function getBoundPort();

Procedural Interface

secureblackbox_webdavserver_get($res, 4 );

Default Value

0

Remarks

Check this property to find out the port that has been allocated to the server by the system. The bound port always equals Port if it is provided, or is allocated dynamically if configured to fall in the range between PortRangeFrom and PortRangeTo constraints.

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

Data Type

Integer

ClientFileEntryATime Property (SecureBlackbox_WebDAVServer Class)

Contains the last access time for this object, in UTC.

Object Oriented Interface

public function getClientFileEntryATime();
public function setClientFileEntryATime($value);

Procedural Interface

secureblackbox_webdavserver_get($res, 5 );
secureblackbox_webdavserver_set($res, 5, $value );

Default Value

''

Remarks

Contains the last access time for this object, in UTC.

This property is not available at design time.

Data Type

String

ClientFileEntryContentType Property (SecureBlackbox_WebDAVServer Class)

The object's content type.

Object Oriented Interface

public function getClientFileEntryContentType();
public function setClientFileEntryContentType($value);

Procedural Interface

secureblackbox_webdavserver_get($res, 6 );
secureblackbox_webdavserver_set($res, 6, $value );

Default Value

''

Remarks

The object's content type.

This property is not available at design time.

Data Type

String

ClientFileEntryCTime Property (SecureBlackbox_WebDAVServer Class)

Contains this object's creation time, in UTC.

Object Oriented Interface

public function getClientFileEntryCTime();
public function setClientFileEntryCTime($value);

Procedural Interface

secureblackbox_webdavserver_get($res, 7 );
secureblackbox_webdavserver_set($res, 7, $value );

Default Value

''

Remarks

Contains this object's creation time, in UTC.

This property is not available at design time.

Data Type

String

ClientFileEntryDirectory Property (SecureBlackbox_WebDAVServer Class)

Specifies whether this object is a directory.

Object Oriented Interface

public function getClientFileEntryDirectory();
public function setClientFileEntryDirectory($value);

Procedural Interface

secureblackbox_webdavserver_get($res, 8 );
secureblackbox_webdavserver_set($res, 8, $value );

Default Value

false

Remarks

Specifies whether this object is a directory.

This property is not available at design time.

Data Type

Boolean

ClientFileEntryDisplayName Property (SecureBlackbox_WebDAVServer Class)

Contains the display name of the object.

Object Oriented Interface

public function getClientFileEntryDisplayName();
public function setClientFileEntryDisplayName($value);

Procedural Interface

secureblackbox_webdavserver_get($res, 9 );
secureblackbox_webdavserver_set($res, 9, $value );

Default Value

''

Remarks

Contains the display name of the object.

This property is not available at design time.

Data Type

String

ClientFileEntryETag Property (SecureBlackbox_WebDAVServer Class)

An e-tag of the object.

Object Oriented Interface

public function getClientFileEntryETag();
public function setClientFileEntryETag($value);

Procedural Interface

secureblackbox_webdavserver_get($res, 10 );
secureblackbox_webdavserver_set($res, 10, $value );

Default Value

''

Remarks

An e-tag of the object.

This property is not available at design time.

Data Type

String

ClientFileEntryFullURL Property (SecureBlackbox_WebDAVServer Class)

A full path to the object.

Object Oriented Interface

public function getClientFileEntryFullURL();
public function setClientFileEntryFullURL($value);

Procedural Interface

secureblackbox_webdavserver_get($res, 11 );
secureblackbox_webdavserver_set($res, 11, $value );

Default Value

''

Remarks

A full path to the object.

This property is not available at design time.

Data Type

String

ClientFileEntryMTime Property (SecureBlackbox_WebDAVServer Class)

The last modification time of the object, in UTC.

Object Oriented Interface

public function getClientFileEntryMTime();
public function setClientFileEntryMTime($value);

Procedural Interface

secureblackbox_webdavserver_get($res, 12 );
secureblackbox_webdavserver_set($res, 12, $value );

Default Value

''

Remarks

The last modification time of the object, in UTC.

This property is not available at design time.

Data Type

String

ClientFileEntryParentURL Property (SecureBlackbox_WebDAVServer Class)

Specifies the object's parent URL.

Object Oriented Interface

public function getClientFileEntryParentURL();
public function setClientFileEntryParentURL($value);

Procedural Interface

secureblackbox_webdavserver_get($res, 13 );
secureblackbox_webdavserver_set($res, 13, $value );

Default Value

''

Remarks

Specifies the object's parent URL.

This property is not available at design time.

Data Type

String

ClientFileEntrySize Property (SecureBlackbox_WebDAVServer Class)

The size of the object in bytes.

Object Oriented Interface

public function getClientFileEntrySize();
public function setClientFileEntrySize($value);

Procedural Interface

secureblackbox_webdavserver_get($res, 14 );
secureblackbox_webdavserver_set($res, 14, $value );

Default Value

0

Remarks

The size of the object in bytes.

This property is not available at design time.

Data Type

Long64

ClientFileEntrySupportsExclusiveLock Property (SecureBlackbox_WebDAVServer Class)

Indicates whether the entry supports exclusive locking.

Object Oriented Interface

public function getClientFileEntrySupportsExclusiveLock();
public function setClientFileEntrySupportsExclusiveLock($value);

Procedural Interface

secureblackbox_webdavserver_get($res, 15 );
secureblackbox_webdavserver_set($res, 15, $value );

Default Value

false

Remarks

Indicates whether the entry supports exclusive locking.

This property is not available at design time.

Data Type

Boolean

ClientFileEntrySupportsSharedLock Property (SecureBlackbox_WebDAVServer Class)

Indicates whether the entry supports shared lock.

Object Oriented Interface

public function getClientFileEntrySupportsSharedLock();
public function setClientFileEntrySupportsSharedLock($value);

Procedural Interface

secureblackbox_webdavserver_get($res, 16 );
secureblackbox_webdavserver_set($res, 16, $value );

Default Value

false

Remarks

Indicates whether the entry supports shared lock.

This property is not available at design time.

Data Type

Boolean

ClientFileEntryURL Property (SecureBlackbox_WebDAVServer Class)

A URL of the object.

Object Oriented Interface

public function getClientFileEntryURL();
public function setClientFileEntryURL($value);

Procedural Interface

secureblackbox_webdavserver_get($res, 17 );
secureblackbox_webdavserver_set($res, 17, $value );

Default Value

''

Remarks

A URL of the object.

This property is not available at design time.

Data Type

String

DocumentRoot Property (SecureBlackbox_WebDAVServer Class)

The document root of the server.

Object Oriented Interface

public function getDocumentRoot();
public function setDocumentRoot($value);

Procedural Interface

secureblackbox_webdavserver_get($res, 18 );
secureblackbox_webdavserver_set($res, 18, $value );

Default Value

''

Remarks

Use this property to specify a local folder which is going to be the server's document root (the mount point of the virtual home directory).

Data Type

String

ExternalCryptoAsyncDocumentID Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

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

Procedural Interface

secureblackbox_webdavserver_get($res, 19 );
secureblackbox_webdavserver_set($res, 19, $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_WebDAVServer Class)

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

Object Oriented Interface

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

Procedural Interface

secureblackbox_webdavserver_get($res, 20 );
secureblackbox_webdavserver_set($res, 20, $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_WebDAVServer 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_webdavserver_get($res, 21 );
secureblackbox_webdavserver_set($res, 21, $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_WebDAVServer 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_webdavserver_get($res, 22 );
secureblackbox_webdavserver_set($res, 22, $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_WebDAVServer Class)

Specifies the request's signature hash algorithm.

Object Oriented Interface

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

Procedural Interface

secureblackbox_webdavserver_get($res, 23 );
secureblackbox_webdavserver_set($res, 23, $value );

Default Value

'SHA256'

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SecureBlackbox_WebDAVServer 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_webdavserver_get($res, 24 );
secureblackbox_webdavserver_set($res, 24, $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_WebDAVServer Class)

The pre-shared key used for DC request authentication.

Object Oriented Interface

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

Procedural Interface

secureblackbox_webdavserver_get($res, 25 );
secureblackbox_webdavserver_set($res, 25, $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_WebDAVServer Class)

Specifies the asynchronous signing method.

Object Oriented Interface

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

Procedural Interface

secureblackbox_webdavserver_get($res, 26 );
secureblackbox_webdavserver_set($res, 26, $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_WebDAVServer Class)

Specifies the external cryptography mode.

Object Oriented Interface

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

Procedural Interface

secureblackbox_webdavserver_get($res, 27 );
secureblackbox_webdavserver_set($res, 27, $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_WebDAVServer 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_webdavserver_get($res, 28 );
secureblackbox_webdavserver_set($res, 28, $value );

Default Value

''

Remarks

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

Data Type

String

FIPSMode Property (SecureBlackbox_WebDAVServer Class)

Reserved.

Object Oriented Interface

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

Procedural Interface

secureblackbox_webdavserver_get($res, 29 );
secureblackbox_webdavserver_set($res, 29, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

Host Property (SecureBlackbox_WebDAVServer Class)

The host to bind the listening port to.

Object Oriented Interface

public function getHost();
public function setHost($value);

Procedural Interface

secureblackbox_webdavserver_get($res, 30 );
secureblackbox_webdavserver_set($res, 30, $value );

Default Value

''

Remarks

Use this property to specify the IP address on which to listen to incoming connections.

Data Type

String

MetadataFlushTimeout Property (SecureBlackbox_WebDAVServer Class)

Specifies metadata flush timeout.

Object Oriented Interface

public function getMetadataFlushTimeout();
public function setMetadataFlushTimeout($value);

Procedural Interface

secureblackbox_webdavserver_get($res, 31 );
secureblackbox_webdavserver_set($res, 31, $value );

Default Value

600

Remarks

Use this property to specify metadata flush timeout in seconds.

Data Type

Integer

MetadataRoot Property (SecureBlackbox_WebDAVServer Class)

The metadata directory root.

Object Oriented Interface

public function getMetadataRoot();
public function setMetadataRoot($value);

Procedural Interface

secureblackbox_webdavserver_get($res, 32 );
secureblackbox_webdavserver_set($res, 32, $value );

Default Value

''

Remarks

The metadata directory is a dedicated location for storing properties of the files served by the WebDAVServer.

Data Type

String

PinnedClientAEADCipher Property (SecureBlackbox_WebDAVServer Class)

Indicates whether the encryption algorithm used is an AEAD cipher.

Object Oriented Interface

public function getPinnedClientAEADCipher();

Procedural Interface

secureblackbox_webdavserver_get($res, 33 );

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

PinnedClientChainValidationDetails Property (SecureBlackbox_WebDAVServer Class)

The details of a certificate chain validation outcome.

Object Oriented Interface

public function getPinnedClientChainValidationDetails();

Procedural Interface

secureblackbox_webdavserver_get($res, 34 );

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

PinnedClientChainValidationResult Property (SecureBlackbox_WebDAVServer Class)

The outcome of a certificate chain validation routine.

Object Oriented Interface

public function getPinnedClientChainValidationResult();

Procedural Interface

secureblackbox_webdavserver_get($res, 35 );

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

PinnedClientCiphersuite Property (SecureBlackbox_WebDAVServer Class)

The cipher suite employed by this connection.

Object Oriented Interface

public function getPinnedClientCiphersuite();

Procedural Interface

secureblackbox_webdavserver_get($res, 36 );

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

PinnedClientClientAuthenticated Property (SecureBlackbox_WebDAVServer Class)

Specifies whether client authentication was performed during this connection.

Object Oriented Interface

public function getPinnedClientClientAuthenticated();

Procedural Interface

secureblackbox_webdavserver_get($res, 37 );

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

PinnedClientClientAuthRequested Property (SecureBlackbox_WebDAVServer Class)

Specifies whether client authentication was requested during this connection.

Object Oriented Interface

public function getPinnedClientClientAuthRequested();

Procedural Interface

secureblackbox_webdavserver_get($res, 38 );

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

PinnedClientConnectionEstablished Property (SecureBlackbox_WebDAVServer Class)

Indicates whether the connection has been established fully.

Object Oriented Interface

public function getPinnedClientConnectionEstablished();

Procedural Interface

secureblackbox_webdavserver_get($res, 39 );

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

PinnedClientConnectionID Property (SecureBlackbox_WebDAVServer Class)

The unique identifier assigned to this connection.

Object Oriented Interface

public function getPinnedClientConnectionID();

Procedural Interface

secureblackbox_webdavserver_get($res, 40 );

Remarks

The unique identifier assigned to this connection.

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

Data Type

Byte Array

PinnedClientDigestAlgorithm Property (SecureBlackbox_WebDAVServer Class)

The digest algorithm used in a TLS-enabled connection.

Object Oriented Interface

public function getPinnedClientDigestAlgorithm();

Procedural Interface

secureblackbox_webdavserver_get($res, 41 );

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

PinnedClientEncryptionAlgorithm Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getPinnedClientEncryptionAlgorithm();

Procedural Interface

secureblackbox_webdavserver_get($res, 42 );

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

PinnedClientExportable Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getPinnedClientExportable();

Procedural Interface

secureblackbox_webdavserver_get($res, 43 );

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

PinnedClientID Property (SecureBlackbox_WebDAVServer Class)

The client connection's unique identifier.

Object Oriented Interface

public function getPinnedClientID();

Procedural Interface

secureblackbox_webdavserver_get($res, 44 );

Default Value

-1

Remarks

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

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

Data Type

Long64

PinnedClientKeyExchangeAlgorithm Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getPinnedClientKeyExchangeAlgorithm();

Procedural Interface

secureblackbox_webdavserver_get($res, 45 );

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

PinnedClientKeyExchangeKeyBits Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getPinnedClientKeyExchangeKeyBits();

Procedural Interface

secureblackbox_webdavserver_get($res, 46 );

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

PinnedClientNamedECCurve Property (SecureBlackbox_WebDAVServer Class)

The elliptic curve used in this connection.

Object Oriented Interface

public function getPinnedClientNamedECCurve();

Procedural Interface

secureblackbox_webdavserver_get($res, 47 );

Default Value

''

Remarks

The elliptic curve used in this connection.

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

Data Type

String

PinnedClientPFSCipher Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getPinnedClientPFSCipher();

Procedural Interface

secureblackbox_webdavserver_get($res, 48 );

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

PinnedClientPreSharedIdentity Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getPinnedClientPreSharedIdentity();

Procedural Interface

secureblackbox_webdavserver_get($res, 49 );

Default Value

''

Remarks

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

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

Data Type

String

PinnedClientPreSharedIdentityHint Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getPinnedClientPreSharedIdentityHint();

Procedural Interface

secureblackbox_webdavserver_get($res, 50 );

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

PinnedClientPublicKeyBits Property (SecureBlackbox_WebDAVServer Class)

The length of the public key.

Object Oriented Interface

public function getPinnedClientPublicKeyBits();

Procedural Interface

secureblackbox_webdavserver_get($res, 51 );

Default Value

0

Remarks

The length of the public key.

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

Data Type

Integer

PinnedClientRemoteAddress Property (SecureBlackbox_WebDAVServer Class)

The client's IP address.

Object Oriented Interface

public function getPinnedClientRemoteAddress();

Procedural Interface

secureblackbox_webdavserver_get($res, 52 );

Default Value

''

Remarks

The client's IP address.

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

Data Type

String

PinnedClientRemotePort Property (SecureBlackbox_WebDAVServer Class)

The remote port of the client connection.

Object Oriented Interface

public function getPinnedClientRemotePort();

Procedural Interface

secureblackbox_webdavserver_get($res, 53 );

Default Value

0

Remarks

The remote port of the client connection.

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

Data Type

Integer

PinnedClientResumedSession Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getPinnedClientResumedSession();

Procedural Interface

secureblackbox_webdavserver_get($res, 54 );

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

PinnedClientSecureConnection Property (SecureBlackbox_WebDAVServer Class)

Indicates whether TLS or SSL is enabled for this connection.

Object Oriented Interface

public function getPinnedClientSecureConnection();

Procedural Interface

secureblackbox_webdavserver_get($res, 55 );

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

PinnedClientServerAuthenticated Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getPinnedClientServerAuthenticated();

Procedural Interface

secureblackbox_webdavserver_get($res, 56 );

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

PinnedClientSignatureAlgorithm Property (SecureBlackbox_WebDAVServer Class)

The signature algorithm used in a TLS handshake.

Object Oriented Interface

public function getPinnedClientSignatureAlgorithm();

Procedural Interface

secureblackbox_webdavserver_get($res, 57 );

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

PinnedClientSymmetricBlockSize Property (SecureBlackbox_WebDAVServer Class)

The block size of the symmetric algorithm used.

Object Oriented Interface

public function getPinnedClientSymmetricBlockSize();

Procedural Interface

secureblackbox_webdavserver_get($res, 58 );

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

PinnedClientSymmetricKeyBits Property (SecureBlackbox_WebDAVServer Class)

The key length of the symmetric algorithm used.

Object Oriented Interface

public function getPinnedClientSymmetricKeyBits();

Procedural Interface

secureblackbox_webdavserver_get($res, 59 );

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

PinnedClientTotalBytesReceived Property (SecureBlackbox_WebDAVServer Class)

The total number of bytes received over this connection.

Object Oriented Interface

public function getPinnedClientTotalBytesReceived();

Procedural Interface

secureblackbox_webdavserver_get($res, 60 );

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

PinnedClientTotalBytesSent Property (SecureBlackbox_WebDAVServer Class)

The total number of bytes sent over this connection.

Object Oriented Interface

public function getPinnedClientTotalBytesSent();

Procedural Interface

secureblackbox_webdavserver_get($res, 61 );

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

PinnedClientValidationLog Property (SecureBlackbox_WebDAVServer Class)

Contains the server certificate's chain validation log.

Object Oriented Interface

public function getPinnedClientValidationLog();

Procedural Interface

secureblackbox_webdavserver_get($res, 62 );

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

PinnedClientVersion Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getPinnedClientVersion();

Procedural Interface

secureblackbox_webdavserver_get($res, 63 );

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

PinnedClientCertCount Property (SecureBlackbox_WebDAVServer Class)

The number of records in the PinnedClientCert arrays.

Object Oriented Interface

public function getPinnedClientCertCount();

Procedural Interface

secureblackbox_webdavserver_get($res, 64 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• PinnedClientCertBytes
• PinnedClientCertCA
• PinnedClientCertCAKeyID
• PinnedClientCertCertType
• PinnedClientCertCRLDistributionPoints
• PinnedClientCertCurve
• PinnedClientCertFingerprint
• PinnedClientCertFriendlyName
• PinnedClientCertHandle
• PinnedClientCertHashAlgorithm
• PinnedClientCertIssuer
• PinnedClientCertIssuerRDN
• PinnedClientCertKeyAlgorithm
• PinnedClientCertKeyBits
• PinnedClientCertKeyFingerprint
• PinnedClientCertKeyUsage
• PinnedClientCertKeyValid
• PinnedClientCertOCSPLocations
• PinnedClientCertOCSPNoCheck
• PinnedClientCertOrigin
• PinnedClientCertPolicyIDs
• PinnedClientCertPrivateKeyBytes
• PinnedClientCertPrivateKeyExists
• PinnedClientCertPrivateKeyExtractable
• PinnedClientCertPublicKeyBytes
• PinnedClientCertQualified
• PinnedClientCertQualifiedStatements
• PinnedClientCertQualifiers
• PinnedClientCertSelfSigned
• PinnedClientCertSerialNumber
• PinnedClientCertSigAlgorithm
• PinnedClientCertSource
• PinnedClientCertSubject
• PinnedClientCertSubjectAlternativeName
• PinnedClientCertSubjectKeyID
• PinnedClientCertSubjectRDN
• PinnedClientCertValid
• PinnedClientCertValidFrom
• PinnedClientCertValidTo

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

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

Data Type

Integer

PinnedClientCertBytes Property (SecureBlackbox_WebDAVServer Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getPinnedClientCertBytes($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 65 , $pinnedclientcertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

PinnedClientCertCA Property (SecureBlackbox_WebDAVServer Class)

Indicates whether the certificate has a CA capability.

Object Oriented Interface

public function getPinnedClientCertCA($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 66 , $pinnedclientcertindex);

Default Value

false

Remarks

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.

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

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

Data Type

Boolean

PinnedClientCertCAKeyID Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getPinnedClientCertCAKeyID($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 67 , $pinnedclientcertindex);

Remarks

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

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the PinnedClientCertSubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

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

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

Data Type

Byte Array

PinnedClientCertCertType Property (SecureBlackbox_WebDAVServer Class)

Returns the type of the entity contained in the Certificate object.

Object Oriented Interface

public function getPinnedClientCertCertType($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 68 , $pinnedclientcertindex);

Default Value

0

Remarks

Returns the type of the entity contained in the Certificate object.

A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the CertificateManager class to load or create new certificate and certificate requests objects.

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

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

Data Type

Integer

PinnedClientCertCRLDistributionPoints Property (SecureBlackbox_WebDAVServer Class)

Contains a list of locations of CRL distribution points used to check this certificate's validity.

Object Oriented Interface

public function getPinnedClientCertCRLDistributionPoints($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 69 , $pinnedclientcertindex);

Default Value

''

Remarks

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

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

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

Data Type

String

PinnedClientCertCurve Property (SecureBlackbox_WebDAVServer Class)

Specifies the elliptic curve associated with the certificate's public key.

Object Oriented Interface

public function getPinnedClientCertCurve($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 70 , $pinnedclientcertindex);

Default Value

''

Remarks

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.

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

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

Data Type

String

PinnedClientCertFingerprint Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getPinnedClientCertFingerprint($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 71 , $pinnedclientcertindex);

Default Value

''

Remarks

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

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

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

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

Data Type

String

PinnedClientCertFriendlyName Property (SecureBlackbox_WebDAVServer Class)

Contains an associated alias (friendly name) of the certificate.

Object Oriented Interface

public function getPinnedClientCertFriendlyName($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 72 , $pinnedclientcertindex);

Default Value

''

Remarks

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

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

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

Data Type

String

PinnedClientCertHandle Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getPinnedClientCertHandle($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 73 , $pinnedclientcertindex);

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

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

Data Type

Long64

PinnedClientCertHashAlgorithm Property (SecureBlackbox_WebDAVServer Class)

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).

Object Oriented Interface

public function getPinnedClientCertHashAlgorithm($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 74 , $pinnedclientcertindex);

Default Value

''

Remarks

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use PinnedClientCertSigAlgorithm to find out the hash algorithm that is part of the certificate signature.

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

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

Data Type

String

PinnedClientCertIssuer Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getPinnedClientCertIssuer($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 75 , $pinnedclientcertindex);

Default Value

''

Remarks

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

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

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

Data Type

String

PinnedClientCertIssuerRDN Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getPinnedClientCertIssuerRDN($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 76 , $pinnedclientcertindex);

Default Value

''

Remarks

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

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

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

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

Data Type

String

PinnedClientCertKeyAlgorithm Property (SecureBlackbox_WebDAVServer Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getPinnedClientCertKeyAlgorithm($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 77 , $pinnedclientcertindex);

Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

Use the PinnedClientCertKeyBits, PinnedClientCertCurve, and PinnedClientCertPublicKeyBytes properties to get more details about the key the certificate contains.

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

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

Data Type

String

PinnedClientCertKeyBits Property (SecureBlackbox_WebDAVServer Class)

Returns the length of the public key in bits.

Object Oriented Interface

public function getPinnedClientCertKeyBits($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 78 , $pinnedclientcertindex);

Default Value

0

Remarks

Returns the length of the public key in bits.

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

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

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

Data Type

Integer

PinnedClientCertKeyFingerprint Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getPinnedClientCertKeyFingerprint($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 79 , $pinnedclientcertindex);

Default Value

''

Remarks

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

Note that the key fingerprint is different from the certificate fingerprint accessible via the PinnedClientCertFingerprint property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

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

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

Data Type

String

PinnedClientCertKeyUsage Property (SecureBlackbox_WebDAVServer 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 getPinnedClientCertKeyUsage($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 80 , $pinnedclientcertindex);

Default Value

0

Remarks

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

This value is a bit mask of the following values:

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

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

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

Data Type

Integer

PinnedClientCertKeyValid Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getPinnedClientCertKeyValid($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 81 , $pinnedclientcertindex);

Default Value

false

Remarks

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

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

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

Data Type

Boolean

PinnedClientCertOCSPLocations Property (SecureBlackbox_WebDAVServer Class)

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Object Oriented Interface

public function getPinnedClientCertOCSPLocations($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 82 , $pinnedclientcertindex);

Default Value

''

Remarks

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this property before calling the certificate manager's Generate method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

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

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

Data Type

String

PinnedClientCertOCSPNoCheck Property (SecureBlackbox_WebDAVServer Class)

Accessor to the value of the certificate's ocsp-no-check extension.

Object Oriented Interface

public function getPinnedClientCertOCSPNoCheck($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 83 , $pinnedclientcertindex);

Default Value

false

Remarks

Accessor to the value of the certificate's ocsp-no-check extension.

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

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

Data Type

Boolean

PinnedClientCertOrigin Property (SecureBlackbox_WebDAVServer Class)

Returns the location that the certificate was taken or loaded from.

Object Oriented Interface

public function getPinnedClientCertOrigin($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 84 , $pinnedclientcertindex);

Default Value

0

Remarks

Returns the location that the certificate was taken or loaded from.

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

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

Data Type

Integer

PinnedClientCertPolicyIDs Property (SecureBlackbox_WebDAVServer Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface

public function getPinnedClientCertPolicyIDs($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 85 , $pinnedclientcertindex);

Default Value

''

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

Set this property when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

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

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

Data Type

String

PinnedClientCertPrivateKeyBytes Property (SecureBlackbox_WebDAVServer Class)

Returns the certificate's private key in DER-encoded format.

Object Oriented Interface

public function getPinnedClientCertPrivateKeyBytes($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 86 , $pinnedclientcertindex);

Remarks

Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.

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

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

Data Type

Byte Array

PinnedClientCertPrivateKeyExists Property (SecureBlackbox_WebDAVServer Class)

Indicates whether the certificate has a usable private key associated with it.

Object Oriented Interface

public function getPinnedClientCertPrivateKeyExists($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 87 , $pinnedclientcertindex);

Default Value

false

Remarks

Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.

This property is independent from PinnedClientCertPrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

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

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

Data Type

Boolean

PinnedClientCertPrivateKeyExtractable Property (SecureBlackbox_WebDAVServer Class)

Indicates whether the private key is extractable (exportable).

Object Oriented Interface

public function getPinnedClientCertPrivateKeyExtractable($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 88 , $pinnedclientcertindex);

Default Value

false

Remarks

Indicates whether the private key is extractable (exportable).

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

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

Data Type

Boolean

PinnedClientCertPublicKeyBytes Property (SecureBlackbox_WebDAVServer Class)

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getPinnedClientCertPublicKeyBytes($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 89 , $pinnedclientcertindex);

Remarks

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

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

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

Data Type

Byte Array

PinnedClientCertQualified Property (SecureBlackbox_WebDAVServer Class)

Indicates whether the certificate is qualified.

Object Oriented Interface

public function getPinnedClientCertQualified($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 90 , $pinnedclientcertindex);

Default Value

false

Remarks

Indicates whether the certificate is qualified.

This property is set to True if the certificate is confirmed by a Trusted List to be qualified.

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

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

Data Type

Boolean

PinnedClientCertQualifiedStatements Property (SecureBlackbox_WebDAVServer Class)

Returns a simplified qualified status of the certificate.

Object Oriented Interface

public function getPinnedClientCertQualifiedStatements($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 91 , $pinnedclientcertindex);

Default Value

0

Remarks

Returns a simplified qualified status of the certificate.

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

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

Data Type

Integer

PinnedClientCertQualifiers Property (SecureBlackbox_WebDAVServer Class)

A list of qualifiers.

Object Oriented Interface

public function getPinnedClientCertQualifiers($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 92 , $pinnedclientcertindex);

Default Value

''

Remarks

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.

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

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

Data Type

String

PinnedClientCertSelfSigned Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getPinnedClientCertSelfSigned($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 93 , $pinnedclientcertindex);

Default Value

false

Remarks

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

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

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

Data Type

Boolean

PinnedClientCertSerialNumber Property (SecureBlackbox_WebDAVServer Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getPinnedClientCertSerialNumber($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 94 , $pinnedclientcertindex);

Remarks

Returns the certificate's serial number.

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

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

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

Data Type

Byte Array

PinnedClientCertSigAlgorithm Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getPinnedClientCertSigAlgorithm($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 95 , $pinnedclientcertindex);

Default Value

''

Remarks

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

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

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

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

Data Type

String

PinnedClientCertSource Property (SecureBlackbox_WebDAVServer Class)

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Object Oriented Interface

public function getPinnedClientCertSource($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 96 , $pinnedclientcertindex);

Default Value

0

Remarks

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

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

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

Data Type

Integer

PinnedClientCertSubject Property (SecureBlackbox_WebDAVServer 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 getPinnedClientCertSubject($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 97 , $pinnedclientcertindex);

Default Value

''

Remarks

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

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

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

Data Type

String

PinnedClientCertSubjectAlternativeName Property (SecureBlackbox_WebDAVServer Class)

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Object Oriented Interface

public function getPinnedClientCertSubjectAlternativeName($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 98 , $pinnedclientcertindex);

Default Value

''

Remarks

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Subject alternative names are used to provide additional names that are impractical to store in the main PinnedClientCertSubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.

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

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

Data Type

String

PinnedClientCertSubjectKeyID Property (SecureBlackbox_WebDAVServer Class)

Contains a unique identifier of the certificate's cryptographic key.

Object Oriented Interface

public function getPinnedClientCertSubjectKeyID($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 99 , $pinnedclientcertindex);

Remarks

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The PinnedClientCertSubjectKeyID and PinnedClientCertCAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

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

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

Data Type

Byte Array

PinnedClientCertSubjectRDN Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getPinnedClientCertSubjectRDN($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 100 , $pinnedclientcertindex);

Default Value

''

Remarks

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

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

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

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

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

Data Type

String

PinnedClientCertValid Property (SecureBlackbox_WebDAVServer Class)

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

Object Oriented Interface

public function getPinnedClientCertValid($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 101 , $pinnedclientcertindex);

Default Value

false

Remarks

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

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

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

Data Type

Boolean

PinnedClientCertValidFrom Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getPinnedClientCertValidFrom($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 102 , $pinnedclientcertindex);

Default Value

''

Remarks

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

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

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

Data Type

String

PinnedClientCertValidTo Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getPinnedClientCertValidTo($pinnedclientcertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 103 , $pinnedclientcertindex);

Default Value

''

Remarks

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

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

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

Data Type

String

Port Property (SecureBlackbox_WebDAVServer Class)

Specifies the port number to listen for connections on.

Object Oriented Interface

public function getPort();
public function setPort($value);

Procedural Interface

secureblackbox_webdavserver_get($res, 104 );
secureblackbox_webdavserver_set($res, 104, $value );

Default Value

80

Remarks

Use this property to specify the port number to listen to connections on. Standard port numbers are 80 for an HTTP server, and 443 for an HTTPS server.

Alternatively, you may specify the acceptable range of listening ports via PortRangeFrom and PortRangeTo properties. In this case the port will be allocated within the requested range by the operating system, and repored in BoundPort.

Data Type

Integer

PortRangeFrom Property (SecureBlackbox_WebDAVServer Class)

Specifies the lower limit of the listening port range for incoming connections.

Object Oriented Interface

public function getPortRangeFrom();
public function setPortRangeFrom($value);

Procedural Interface

secureblackbox_webdavserver_get($res, 105 );
secureblackbox_webdavserver_set($res, 105, $value );

Default Value

0

Remarks

Use this property to specify the lower limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via Port), the port will be allocated within the requested range by the operating system, and repored in BoundPort.

Data Type

Integer

PortRangeTo Property (SecureBlackbox_WebDAVServer Class)

Specifies the upper limit of the listening port range for incoming connections.

Object Oriented Interface

public function getPortRangeTo();
public function setPortRangeTo($value);

Procedural Interface

secureblackbox_webdavserver_get($res, 106 );
secureblackbox_webdavserver_set($res, 106, $value );

Default Value

0

Remarks

Use this property to specify the upper limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via Port), the port will be allocated within the requested range by the operating system, and repored in BoundPort.

Data Type

Integer

SocketIncomingSpeedLimit Property (SecureBlackbox_WebDAVServer 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_webdavserver_get($res, 112 );
secureblackbox_webdavserver_set($res, 112, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (SecureBlackbox_WebDAVServer Class)

The local network interface to bind the socket to.

Object Oriented Interface

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

Procedural Interface

secureblackbox_webdavserver_get($res, 113 );
secureblackbox_webdavserver_set($res, 113, $value );

Default Value

''

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SecureBlackbox_WebDAVServer Class)

The local port number to bind the socket to.

Object Oriented Interface

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

Procedural Interface

secureblackbox_webdavserver_get($res, 114 );
secureblackbox_webdavserver_set($res, 114, $value );

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SecureBlackbox_WebDAVServer 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_webdavserver_get($res, 115 );
secureblackbox_webdavserver_set($res, 115, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (SecureBlackbox_WebDAVServer 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_webdavserver_get($res, 116 );
secureblackbox_webdavserver_set($res, 116, $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_WebDAVServer Class)

Enables or disables IP protocol version 6.

Object Oriented Interface

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

Procedural Interface

secureblackbox_webdavserver_get($res, 117 );
secureblackbox_webdavserver_set($res, 117, $value );

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

TLSServerCertCount Property (SecureBlackbox_WebDAVServer Class)

The number of records in the TLSServerCert arrays.

Object Oriented Interface

public function getTLSServerCertCount();
public function setTLSServerCertCount($value);

Procedural Interface

secureblackbox_webdavserver_get($res, 118 );
secureblackbox_webdavserver_set($res, 118, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• TLSServerCertBytes
• TLSServerCertHandle

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

This property is not available at design time.

Data Type

Integer

TLSServerCertBytes Property (SecureBlackbox_WebDAVServer Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTLSServerCertBytes($tlsservercertindex);

Procedural Interface

secureblackbox_webdavserver_get($res, 119 , $tlsservercertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

TLSServerCertHandle Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getTLSServerCertHandle($tlsservercertindex);
public function setTLSServerCertHandle($tlsservercertindex, $value);

Procedural Interface

secureblackbox_webdavserver_get($res, 127 , $tlsservercertindex);
secureblackbox_webdavserver_set($res, 127, $value , $tlsservercertindex);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

TLSAutoValidateCertificates Property (SecureBlackbox_WebDAVServer 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_webdavserver_get($res, 158 );
secureblackbox_webdavserver_set($res, 158, $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_WebDAVServer Class)

Selects the base configuration for the TLS settings.

Object Oriented Interface

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

Procedural Interface

secureblackbox_webdavserver_get($res, 159 );
secureblackbox_webdavserver_set($res, 159, $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_WebDAVServer Class)

A list of ciphersuites separated with commas or semicolons.

Object Oriented Interface

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

Procedural Interface

secureblackbox_webdavserver_get($res, 160 );
secureblackbox_webdavserver_set($res, 160, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

TLSClientAuth Property (SecureBlackbox_WebDAVServer Class)

Enables or disables certificate-based client authentication.

Object Oriented Interface

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

Procedural Interface

secureblackbox_webdavserver_get($res, 161 );
secureblackbox_webdavserver_set($res, 161, $value );

Default Value

0

Remarks

Enables or disables certificate-based client authentication.

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

Data Type

Integer

TLSECCurves Property (SecureBlackbox_WebDAVServer Class)

Defines the elliptic curves to enable.

Object Oriented Interface

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

Procedural Interface

secureblackbox_webdavserver_get($res, 162 );
secureblackbox_webdavserver_set($res, 162, $value );

Default Value

''

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (SecureBlackbox_WebDAVServer Class)

Provides access to TLS extensions.

Object Oriented Interface

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

Procedural Interface

secureblackbox_webdavserver_get($res, 163 );
secureblackbox_webdavserver_set($res, 163, $value );

Default Value

''

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (SecureBlackbox_WebDAVServer 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_webdavserver_get($res, 164 );
secureblackbox_webdavserver_set($res, 164, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSPreSharedIdentity Property (SecureBlackbox_WebDAVServer 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_webdavserver_get($res, 165 );
secureblackbox_webdavserver_set($res, 165, $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_WebDAVServer 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_webdavserver_get($res, 166 );
secureblackbox_webdavserver_set($res, 166, $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_WebDAVServer Class)

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

Object Oriented Interface

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

Procedural Interface

secureblackbox_webdavserver_get($res, 167 );
secureblackbox_webdavserver_set($res, 167, $value );

Default Value

''

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (SecureBlackbox_WebDAVServer Class)

Selects the renegotiation attack prevention mechanism.

Object Oriented Interface

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

Procedural Interface

secureblackbox_webdavserver_get($res, 168 );
secureblackbox_webdavserver_set($res, 168, $value );

Default Value

2

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

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

Procedural Interface

secureblackbox_webdavserver_get($res, 169 );
secureblackbox_webdavserver_set($res, 169, $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_WebDAVServer 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_webdavserver_get($res, 170 );
secureblackbox_webdavserver_set($res, 170, $value );

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (SecureBlackbox_WebDAVServer Class)

Specifies the TLS mode to use.

Object Oriented Interface

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

Procedural Interface

secureblackbox_webdavserver_get($res, 171 );
secureblackbox_webdavserver_set($res, 171, $value );

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (SecureBlackbox_WebDAVServer 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_webdavserver_get($res, 172 );
secureblackbox_webdavserver_set($res, 172, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (SecureBlackbox_WebDAVServer Class)

Enables or disables the TLS session resumption capability.

Object Oriented Interface

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

Procedural Interface

secureblackbox_webdavserver_get($res, 173 );
secureblackbox_webdavserver_set($res, 173, $value );

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (SecureBlackbox_WebDAVServer Class)

The SSL/TLS versions to enable by default.

Object Oriented Interface

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

Procedural Interface

secureblackbox_webdavserver_get($res, 174 );
secureblackbox_webdavserver_set($res, 174, $value );

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

UserCount Property (SecureBlackbox_WebDAVServer Class)

The number of records in the User arrays.

Object Oriented Interface

public function getUserCount();
public function setUserCount($value);

Procedural Interface

secureblackbox_webdavserver_get($res, 175 );
secureblackbox_webdavserver_set($res, 175, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• UserAssociatedData
• UserBasePath
• UserCertificate
• UserData
• UserEmail
• UserHandle
• UserHashAlgorithm
• UserIncomingSpeedLimit
• UserOtpAlgorithm
• UserOTPLen
• UserOtpValue
• UserOutgoingSpeedLimit
• UserPassword
• UserSharedSecret
• UserSSHKey
• UserUsername

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

This property is not available at design time.

Data Type

Integer

UserAssociatedData Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getUserAssociatedData($userindex);
public function setUserAssociatedData($userindex, $value);

Procedural Interface

secureblackbox_webdavserver_get($res, 176 , $userindex);
secureblackbox_webdavserver_set($res, 176, $value , $userindex);

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

UserBasePath Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getUserBasePath($userindex);
public function setUserBasePath($userindex, $value);

Procedural Interface

secureblackbox_webdavserver_get($res, 177 , $userindex);
secureblackbox_webdavserver_set($res, 177, $value , $userindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

UserCertificate Property (SecureBlackbox_WebDAVServer Class)

Contains the user's certificate.

Object Oriented Interface

public function getUserCertificate($userindex);
public function setUserCertificate($userindex, $value);

Procedural Interface

secureblackbox_webdavserver_get($res, 178 , $userindex);
secureblackbox_webdavserver_set($res, 178, $value , $userindex);

Remarks

Contains the user's certificate.

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

This property is not available at design time.

Data Type

Byte Array

UserData Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getUserData($userindex);
public function setUserData($userindex, $value);

Procedural Interface

secureblackbox_webdavserver_get($res, 179 , $userindex);
secureblackbox_webdavserver_set($res, 179, $value , $userindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

UserEmail Property (SecureBlackbox_WebDAVServer Class)

The user's email address.

Object Oriented Interface

public function getUserEmail($userindex);
public function setUserEmail($userindex, $value);

Procedural Interface

secureblackbox_webdavserver_get($res, 180 , $userindex);
secureblackbox_webdavserver_set($res, 180, $value , $userindex);

Default Value

''

Remarks

The user's email address.

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

This property is not available at design time.

Data Type

String

UserHandle Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getUserHandle($userindex);
public function setUserHandle($userindex, $value);

Procedural Interface

secureblackbox_webdavserver_get($res, 181 , $userindex);
secureblackbox_webdavserver_set($res, 181, $value , $userindex);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

UserHashAlgorithm Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getUserHashAlgorithm($userindex);
public function setUserHashAlgorithm($userindex, $value);

Procedural Interface

secureblackbox_webdavserver_get($res, 182 , $userindex);
secureblackbox_webdavserver_set($res, 182, $value , $userindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

UserIncomingSpeedLimit Property (SecureBlackbox_WebDAVServer Class)

Specifies the incoming speed limit for this user.

Object Oriented Interface

public function getUserIncomingSpeedLimit($userindex);
public function setUserIncomingSpeedLimit($userindex, $value);

Procedural Interface

secureblackbox_webdavserver_get($res, 183 , $userindex);
secureblackbox_webdavserver_set($res, 183, $value , $userindex);

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Integer

UserOtpAlgorithm Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getUserOtpAlgorithm($userindex);
public function setUserOtpAlgorithm($userindex, $value);

Procedural Interface

secureblackbox_webdavserver_get($res, 184 , $userindex);
secureblackbox_webdavserver_set($res, 184, $value , $userindex);

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Integer

UserOTPLen Property (SecureBlackbox_WebDAVServer Class)

Specifies the length of the user's OTP password.

Object Oriented Interface

public function getUserOTPLen($userindex);
public function setUserOTPLen($userindex, $value);

Procedural Interface

secureblackbox_webdavserver_get($res, 185 , $userindex);
secureblackbox_webdavserver_set($res, 185, $value , $userindex);

Default Value

0

Remarks

Specifies the length of the user's OTP password.

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

This property is not available at design time.

Data Type

Integer

UserOtpValue Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getUserOtpValue($userindex);
public function setUserOtpValue($userindex, $value);

Procedural Interface

secureblackbox_webdavserver_get($res, 186 , $userindex);
secureblackbox_webdavserver_set($res, 186, $value , $userindex);

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Integer

UserOutgoingSpeedLimit Property (SecureBlackbox_WebDAVServer Class)

Specifies the outgoing speed limit for this user.

Object Oriented Interface

public function getUserOutgoingSpeedLimit($userindex);
public function setUserOutgoingSpeedLimit($userindex, $value);

Procedural Interface

secureblackbox_webdavserver_get($res, 187 , $userindex);
secureblackbox_webdavserver_set($res, 187, $value , $userindex);

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Integer

UserPassword Property (SecureBlackbox_WebDAVServer Class)

The user's authentication password.

Object Oriented Interface

public function getUserPassword($userindex);
public function setUserPassword($userindex, $value);

Procedural Interface

secureblackbox_webdavserver_get($res, 188 , $userindex);
secureblackbox_webdavserver_set($res, 188, $value , $userindex);

Default Value

''

Remarks

The user's authentication password.

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

This property is not available at design time.

Data Type

String

UserSharedSecret Property (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function getUserSharedSecret($userindex);
public function setUserSharedSecret($userindex, $value);

Procedural Interface

secureblackbox_webdavserver_get($res, 189 , $userindex);
secureblackbox_webdavserver_set($res, 189, $value , $userindex);

Remarks

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

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

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

This property is not available at design time.

Data Type

Byte Array

UserSSHKey Property (SecureBlackbox_WebDAVServer Class)

Contains the user's SSH key.

Object Oriented Interface

public function getUserSSHKey($userindex);
public function setUserSSHKey($userindex, $value);

Procedural Interface

secureblackbox_webdavserver_get($res, 190 , $userindex);
secureblackbox_webdavserver_set($res, 190, $value , $userindex);

Remarks

Contains the user's SSH key.

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

This property is not available at design time.

Data Type

Byte Array

UserUsername Property (SecureBlackbox_WebDAVServer Class)

The registered name (login) of the user.

Object Oriented Interface

public function getUserUsername($userindex);
public function setUserUsername($userindex, $value);

Procedural Interface

secureblackbox_webdavserver_get($res, 191 , $userindex);
secureblackbox_webdavserver_set($res, 191, $value , $userindex);

Default Value

''

Remarks

The registered name (login) of the user.

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

This property is not available at design time.

Data Type

String

WebsiteName Property (SecureBlackbox_WebDAVServer Class)

Specifies the web site name to use in the certificate.

Object Oriented Interface

public function getWebsiteName();
public function setWebsiteName($value);

Procedural Interface

secureblackbox_webdavserver_get($res, 192 );
secureblackbox_webdavserver_set($res, 192, $value );

Default Value

'SecureBlackbox'

Remarks

If using an internally-generated certificate, use this property to specify the web site name to be included as a common name. A typical common name consists of the host name, such as '192.168.10.10' or 'domain.com'.

Data Type

String

Cleanup Method (SecureBlackbox_WebDAVServer Class)

Cleans up the server environment by purging expired sessions and cleaning caches.

Object Oriented Interface

public function doCleanup();

Procedural Interface

secureblackbox_webdavserver_do_cleanup($res);

Remarks

Call this method while the server is active to clean up the environment allocated for the server by releasing unused resources and cleaning caches.

Config Method (SecureBlackbox_WebDAVServer Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_webdavserver_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_WebDAVServer Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

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

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

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

Common ActionIDs:

DropClient Method (SecureBlackbox_WebDAVServer Class)

Terminates a client connection.

Object Oriented Interface

public function doDropClient($connectionid, $forced);

Procedural Interface

secureblackbox_webdavserver_do_dropclient($res, $connectionid, $forced);

Remarks

Call this method to shut down a connected client. Forced indicates whether the connection should be closed in a graceful manner.

GetClientBuffer Method (SecureBlackbox_WebDAVServer Class)

Obtains a pending connection buffer.

Object Oriented Interface

public function doGetClientBuffer($connectionid);

Procedural Interface

secureblackbox_webdavserver_do_getclientbuffer($res, $connectionid);

Remarks

Use this method to obtain a pending connection buffer from your WriteFile event handler. The connection buffer contains data that have been received from the client but has not been written to the file yet.

GetRequestBytes Method (SecureBlackbox_WebDAVServer Class)

Returns the contents of the client's HTTP request.

Object Oriented Interface

public function doGetRequestBytes($connectionid, $requestfilter);

Procedural Interface

secureblackbox_webdavserver_do_getrequestbytes($res, $connectionid, $requestfilter);

Remarks

Use this method to get the body of the client's HTTP request in your CustomRequest event handler. Note that the body of GET and HEAD requests is empty. The method returns the requested content.

The RequestFilter parameter allows you to select the element(s) that you would like to get. An empty request filter makes the whole body to be returned. The following request filters are currently supported:

GetRequestHeader Method (SecureBlackbox_WebDAVServer Class)

Returns a request header value.

Object Oriented Interface

public function doGetRequestHeader($connectionid, $headername);

Procedural Interface

secureblackbox_webdavserver_do_getrequestheader($res, $connectionid, $headername);

Remarks

Use this method to get the value of a request header. A good place to call this method is a request-marking event, such as BeforeLockObject or CustomRequest.

GetRequestString Method (SecureBlackbox_WebDAVServer Class)

Returns the contents of the client's HTTP request.

Object Oriented Interface

public function doGetRequestString($connectionid, $requestfilter);

Procedural Interface

secureblackbox_webdavserver_do_getrequeststring($res, $connectionid, $requestfilter);

Remarks

Use this method to get the body of the client's HTTP request to a string. Note that the body of GET and HEAD requests is empty.

The RequestFilter parameter allows you to select the element(s) of the requests that you would like to get. An empty request filter makes the whole body to be returned. The following request filters are currently supported:

GetRequestUsername Method (SecureBlackbox_WebDAVServer Class)

Returns the username for a connection.

Object Oriented Interface

public function doGetRequestUsername($connectionid);

Procedural Interface

secureblackbox_webdavserver_do_getrequestusername($res, $connectionid);

Remarks

Use this method to obtain a username for an active connection. The method will return an empty string if no authentication has been performed on the connection.

GetResponseHeader Method (SecureBlackbox_WebDAVServer Class)

Returns a response header value.

Object Oriented Interface

public function doGetResponseHeader($connectionid, $headername);

Procedural Interface

secureblackbox_webdavserver_do_getresponseheader($res, $connectionid, $headername);

Remarks

Use this method to get the value of a response header. A good place to call this method is HeadersPrepared event. Call the method with empty HeaderName to get the whole response header.

ListClients Method (SecureBlackbox_WebDAVServer Class)

Enumerates the connected clients.

Object Oriented Interface

public function doListClients();

Procedural Interface

secureblackbox_webdavserver_do_listclients($res);

Remarks

This method enumerates the connected clients. It returns a list of strings, with each string being of 'ConnectionID|Address|Port' format, and representing a single connection.

PinClient Method (SecureBlackbox_WebDAVServer Class)

Takes a snapshot of the connection's properties.

Object Oriented Interface

public function doPinClient($connectionid);

Procedural Interface

secureblackbox_webdavserver_do_pinclient($res, $connectionid);

Remarks

Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient and PinnedClientChain properties.

ProcessGenericRequest Method (SecureBlackbox_WebDAVServer Class)

Processes a generic HTTP request.

Object Oriented Interface

public function doProcessGenericRequest($connectionid, $requestbytes);

Procedural Interface

secureblackbox_webdavserver_do_processgenericrequest($res, $connectionid, $requestbytes);

Remarks

This method processes a generic HTTP request and produces a response. Use it to generate HTTP responses for requests obtained externally, out of the default HTTP channel.

This method respects all current settings of the server object, and invokes the corresponding events to consult about the request and response details with the application. ConnectionId allows to identify the request in the events.

The method returns the complete HTTP response including HTTP headers.

Reset Method (SecureBlackbox_WebDAVServer Class)

Resets the class settings.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_webdavserver_do_reset($res);

Remarks

Reset is a generic method available in every class.

SetClientBuffer Method (SecureBlackbox_WebDAVServer Class)

Commits a data buffer to the connection.

Object Oriented Interface

public function doSetClientBuffer($connectionid, $value);

Procedural Interface

secureblackbox_webdavserver_do_setclientbuffer($res, $connectionid, $value);

Remarks

Use this method from your ReadFile event handler to commit a chunk of file data to the server component.

SetClientFileEntry Method (SecureBlackbox_WebDAVServer Class)

Commits a file entry to the connection.

Object Oriented Interface

public function doSetClientFileEntry($connectionid);

Procedural Interface

secureblackbox_webdavserver_do_setclientfileentry($res, $connectionid);

Remarks

Use this method to commit a file details entry provided in ClientFileEntry property to ConnectionID connection. This method is supposed to be used from a FindNext event handler.

Please note that events like FindNext may be invoked concurrently for several connection threads. Please make sure you use a locking mechanism to avoid mixing up details in ClientFileEntry.

SetResponseBytes Method (SecureBlackbox_WebDAVServer Class)

Sets a byte array to be served as a response.

Object Oriented Interface

public function doSetResponseBytes($connectionid, $bytes, $contenttype, $responsefilter);

Procedural Interface

secureblackbox_webdavserver_do_setresponsebytes($res, $connectionid, $bytes, $contenttype, $responsefilter);

Remarks

Use this property to provide the response content in a byte array when serving custom requests in your CustomRequest handler. The ResponseFilter parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is parts:

SetResponseFile Method (SecureBlackbox_WebDAVServer Class)

Sets a file to be served as a response.

Object Oriented Interface

public function doSetResponseFile($connectionid, $filename, $contenttype, $responsefilter);

Procedural Interface

secureblackbox_webdavserver_do_setresponsefile($res, $connectionid, $filename, $contenttype, $responsefilter);

Remarks

Use this property to provide the response content in a file. The ResponseFilter parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is parts:

SetResponseHeader Method (SecureBlackbox_WebDAVServer Class)

Sets a response header.

Object Oriented Interface

public function doSetResponseHeader($connectionid, $headername, $value);

Procedural Interface

secureblackbox_webdavserver_do_setresponseheader($res, $connectionid, $headername, $value);

Remarks

Use this method to set a response header. A good place to call this method is a request-marking event, such as LockObject or CustomRequest.

SetResponseStatus Method (SecureBlackbox_WebDAVServer Class)

Sets an HTTP status to be sent with the response.

Object Oriented Interface

public function doSetResponseStatus($connectionid, $statuscode);

Procedural Interface

secureblackbox_webdavserver_do_setresponsestatus($res, $connectionid, $statuscode);

Remarks

Use this method to set an HTTP status for the request. A good place to call this method is a request-marking event, such as CustomRequest.

SetResponseString Method (SecureBlackbox_WebDAVServer Class)

Sets a string to be served as a response.

Object Oriented Interface

public function doSetResponseString($connectionid, $datastr, $contenttype, $responsefilter);

Procedural Interface

secureblackbox_webdavserver_do_setresponsestring($res, $connectionid, $datastr, $contenttype, $responsefilter);

Remarks

Use this property to provide the response content in a string. The ResponseFilter parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is parts:

Start Method (SecureBlackbox_WebDAVServer Class)

Starts the server.

Object Oriented Interface

public function doStart();

Procedural Interface

secureblackbox_webdavserver_do_start($res);

Remarks

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

Stop Method (SecureBlackbox_WebDAVServer Class)

Stops the server.

Object Oriented Interface

public function doStop();

Procedural Interface

secureblackbox_webdavserver_do_stop($res);

Remarks

Call this method to stop listening to incoming connections and deactivate the server.

Accept Event (SecureBlackbox_WebDAVServer Class)

Reports an incoming connection.

Object Oriented Interface

public function fireAccept($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 1, array($this, 'fireAccept'));

Parameter List

 'remoteaddress'
 'remoteport'
 'accept'

Remarks

This event is fired when a new connection from RemoteAddress:RemotePort is ready to be accepted. Use the Accept parameter to accept or decline it.

Subscribe to Connect event to be notified of every connection that has been set up.

AfterBrowse Event (SecureBlackbox_WebDAVServer Class)

WebDAVServer uses this event to notify the application about the completion of the browsing operation.

Object Oriented Interface

public function fireAfterBrowse($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 2, array($this, 'fireAfterBrowse'));

Parameter List

 'connectionid'
 'path'
 'operationstatus'

Remarks

The ConnectionID parameter identifies the client connection, and the Path parameter specifies the browsing path.

This event is typically fired after the BeforeBrowse event.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterCopyObject Event (SecureBlackbox_WebDAVServer Class)

This event notifies the application about the completion of the copy operation.

Object Oriented Interface

public function fireAfterCopyObject($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 3, array($this, 'fireAfterCopyObject'));

Parameter List

 'connectionid'
 'oldpath'
 'newpath'
 'operationstatus'

Remarks

AfterCopyObject is typically preceded by BeforeCopyObject and CopyObject events. The OldPath and NewPath parameters contain the origin and destination names of the copied object.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterCreateCalendar Event (SecureBlackbox_WebDAVServer Class)

This event reports the completion of calendar creation request.

Object Oriented Interface

public function fireAfterCreateCalendar($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 4, array($this, 'fireAfterCreateCalendar'));

Parameter List

 'connectionid'
 'path'
 'operationstatus'

Remarks

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterCreateCollection Event (SecureBlackbox_WebDAVServer Class)

WebDAVServer uses this event to report completion of the collection creation operation.

Object Oriented Interface

public function fireAfterCreateCollection($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 5, array($this, 'fireAfterCreateCollection'));

Parameter List

 'connectionid'
 'path'
 'operationstatus'

Remarks

This event is preceded by BeforeCreateCollection and CreateCollection events. It lets you alter the operation status passed back to the client.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterCustomRequest Event (SecureBlackbox_WebDAVServer Class)

This event reports the completion of the custom request.

Object Oriented Interface

public function fireAfterCustomRequest($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 6, array($this, 'fireAfterCustomRequest'));

Parameter List

 'connectionid'
 'requestmethod'
 'path'
 'operationstatus'

Remarks

Use this event to track the completion of an earlier reported custom request and adjust the operation status through the OperationStatus parameter as required.

AfterLockObject Event (SecureBlackbox_WebDAVServer Class)

Reports the completion of the object locking operation.

Object Oriented Interface

public function fireAfterLockObject($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 7, array($this, 'fireAfterLockObject'));

Parameter List

 'connectionid'
 'path'
 'operationstatus'

Remarks

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterRefreshLock Event (SecureBlackbox_WebDAVServer Class)

Reports the completion of the lock refresh operation.

Object Oriented Interface

public function fireAfterRefreshLock($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 8, array($this, 'fireAfterRefreshLock'));

Parameter List

 'connectionid'
 'path'
 'operationstatus'

Remarks

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterRemoveObject Event (SecureBlackbox_WebDAVServer Class)

This event notifies the application about the completion of object deletion operation.

Object Oriented Interface

public function fireAfterRemoveObject($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 9, array($this, 'fireAfterRemoveObject'));

Parameter List

 'connectionid'
 'path'
 'operationstatus'

Remarks

This event follows BeforeRemoveObject and RemoveObject events. It is fired upon completion of the operation and lets you adjust the operation status if required:

AfterRenameObject Event (SecureBlackbox_WebDAVServer Class)

The class uses this event to notify the application about the completion of the object rename operation.

Object Oriented Interface

public function fireAfterRenameObject($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 10, array($this, 'fireAfterRenameObject'));

Parameter List

 'connectionid'
 'oldpath'
 'newpath'
 'operationstatus'

Remarks

The OldPath and NewPath provide the old and new path of the renamed object respectively.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterSetAttributes Event (SecureBlackbox_WebDAVServer Class)

WebDAVServer fires this event to notify the application of the completion of the attribute assignment operation.

Object Oriented Interface

public function fireAfterSetAttributes($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 11, array($this, 'fireAfterSetAttributes'));

Parameter List

 'connectionid'
 'path'
 'operationstatus'

Remarks

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterUnlockObject Event (SecureBlackbox_WebDAVServer Class)

Notifies the application about the completion of the object unlocking operation.

Object Oriented Interface

public function fireAfterUnlockObject($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 12, array($this, 'fireAfterUnlockObject'));

Parameter List

 'connectionid'
 'path'
 'operationstatus'

Remarks

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AuthAttempt Event (SecureBlackbox_WebDAVServer Class)

Fires when a connected client makes an authentication attempt.

Object Oriented Interface

public function fireAuthAttempt($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 13, array($this, 'fireAuthAttempt'));

Parameter List

 'connectionid'
 'httpmethod'
 'uri'
 'authmethod'
 'username'
 'password'
 'allow'

Remarks

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

ConnectionID contains the unique session identifier for that client, HTTPMethod specifies the HTTP method (GET, POST, etc.) used to access the URI resource, AuthMethod specifies the authentication method, and Username and Password contain the professed credentials.

BeforeBrowse Event (SecureBlackbox_WebDAVServer Class)

Fires when a Browse request is received.

Object Oriented Interface

public function fireBeforeBrowse($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 14, array($this, 'fireBeforeBrowse'));

Parameter List

 'connectionid'
 'path'
 'action'

Remarks

The class uses this event to notify the application that a Browse request has been received from the client. The Path parameter contains the path parameter from the request. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

If fraCustom Action is chosen, this event will be followed by a series of events that request the details of the object residing at Path: ListAttributes, ListSubObjects, and ReadAttribute.

BeforeCopyObject Event (SecureBlackbox_WebDAVServer Class)

Fires when a Copy Object request is received.

Object Oriented Interface

public function fireBeforeCopyObject($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 15, array($this, 'fireBeforeCopyObject'));

Parameter List

 'connectionid'
 'oldpath'
 'newpath'
 'action'

Remarks

The class fires this event to notify the application that a Copy Object request was received. The OldPath and NewPath parameters specify the source and destination paths for the object to be copied. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

If fraCustom Action is chosen, this event will be followed by a CopyObject call, allowing you to virtualize the copy operation.

BeforeCreateCalendar Event (SecureBlackbox_WebDAVServer Class)

Fires when a Create Calendar request is received from a client.

Object Oriented Interface

public function fireBeforeCreateCalendar($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 16, array($this, 'fireBeforeCreateCalendar'));

Parameter List

 'connectionid'
 'path'
 'action'

Remarks

The class fires this event to notify the application about a received Create Calendar request. The Path parameter specifies the location of the new calendar. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

If fraCustom Action is chosen, this event will be followed by a CreateCalendar call, allowing you to virtualize the calendar creation operation.

BeforeCreateCollection Event (SecureBlackbox_WebDAVServer Class)

Fires when a Create Collection request is received from a client.

Object Oriented Interface

public function fireBeforeCreateCollection($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 17, array($this, 'fireBeforeCreateCollection'));

Parameter List

 'connectionid'
 'path'
 'action'

Remarks

The class uses this event to notify the application about an incoming collection creation request. The Path parameter advises on the location of the new collection. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

If fraCustom Action is chosen, this event will be followed by a CreateCollection call.

BeforeCustomRequest Event (SecureBlackbox_WebDAVServer Class)

Notifies the application about an incoming custom request.

Object Oriented Interface

public function fireBeforeCustomRequest($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 18, array($this, 'fireBeforeCustomRequest'));

Parameter List

 'connectionid'
 'requestmethod'
 'path'
 'action'

Remarks

The class uses this event to notify the user code about an incoming custom request (a generic request, unknown to the server, and not covered by the other handlers). The RequestMethod parameter specifies the HTTP request method used (GET, POST, PUT, ...), and Path indicates the requested path. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

If fraCustom Action is chosen, this event will be followed by a CustomRequest call, allowing you to respond to the request.

BeforeDownloadObject Event (SecureBlackbox_WebDAVServer Class)

Fires when an object download request is received.

Object Oriented Interface

public function fireBeforeDownloadObject($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 19, array($this, 'fireBeforeDownloadObject'));

Parameter List

 'connectionid'
 'path'
 'action'

Remarks

The class fires this event to notify the application about an incoming object download request. The Path parameter contains the path of the requested object. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

If fraCustom Action is chosen, this event will be followed by DownloadObject, ReadObject, and DownloadObjectCompleted calls, allowing you to supply the object data to the client.

BeforeLockObject Event (SecureBlackbox_WebDAVServer Class)

Fires when a lock request is received.

Object Oriented Interface

public function fireBeforeLockObject($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 20, array($this, 'fireBeforeLockObject'));

Parameter List

 'connectionid'
 'path'
 'action'

Remarks

The class uses this event to notify the application that an object lock request was received. The Path parameter contains the path to be locked. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

If fraCustom Action is chosen, this event will be followed by a LockObject call which expects you to perform the locking as required.

BeforeRefreshLock Event (SecureBlackbox_WebDAVServer Class)

Reports the receipt of lock refresh request.

Object Oriented Interface

public function fireBeforeRefreshLock($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 21, array($this, 'fireBeforeRefreshLock'));

Parameter List

 'connectionid'
 'path'
 'action'

Remarks

Use this event to be notified about refresh requests for existing locks. The Path parameter contains the path on which to refresh the lock. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

If fraCustom Action is chosen, this event will be followed by a RefreshLock call, allowing you to virtualize the operation.

BeforeRemoveObject Event (SecureBlackbox_WebDAVServer Class)

Fires when an object deletion request is received.

Object Oriented Interface

public function fireBeforeRemoveObject($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 22, array($this, 'fireBeforeRemoveObject'));

Parameter List

 'connectionid'
 'path'
 'action'

Remarks

Use this event to track object deletion requests. The Path parameter contains the path of the object to be deleted. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

If fraCustom Action is chosen, this event will be followed by a RemoveObject call, allowing you to virtualize the deletion operation.

BeforeRenameObject Event (SecureBlackbox_WebDAVServer Class)

Reports object renaming requests.

Object Oriented Interface

public function fireBeforeRenameObject($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 23, array($this, 'fireBeforeRenameObject'));

Parameter List

 'connectionid'
 'oldpath'
 'newpath'
 'action'

Remarks

The server uses this event to notify the application about incoming object rename requests. OldPath and NewPath contain the existing and the new path for the object. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

If fraCustom Action is chosen, this event will be followed by a RenameObject call, where your code is expected to perform the renaming operation.

BeforeRequest Event (SecureBlackbox_WebDAVServer Class)

Fires before a DAV request is processed.

Object Oriented Interface

public function fireBeforeRequest($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 24, array($this, 'fireBeforeRequest'));

Parameter List

 'connectionid'
 'httpmethod'
 'url'
 'accept'

Remarks

This event fires before an incoming request is processed. ConnectionID indicates the client's unique connection ID; HTTPMethod specifies the HTTP method being used to submit the request, and URL signifies the object's URL.

Use Accept parameter to accept or reject the request.

BeforeSetAttributes Event (SecureBlackbox_WebDAVServer Class)

Notifies the application about attribute change request.

Object Oriented Interface

public function fireBeforeSetAttributes($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 25, array($this, 'fireBeforeSetAttributes'));

Parameter List

 'connectionid'
 'path'
 'action'

Remarks

Use this event to react to object attributes change requests. The Path parameter contains the object path. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

If fraCustom Action is chosen, this event will be followed by a series of SetAttribute and/or ClearAttribute calls, for each attribute to be set or cleared.

BeforeUnlockObject Event (SecureBlackbox_WebDAVServer Class)

Fires when an unlock request is received.

Object Oriented Interface

public function fireBeforeUnlockObject($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 26, array($this, 'fireBeforeUnlockObject'));

Parameter List

 'connectionid'
 'path'
 'action'

Remarks

The class uses this event to notify the application about the received unlock request. The Path parameter contains the path to be unlocked. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

If fraCustom Action is chosen, this event will be followed by a UnlockObject call.

BeforeUploadObject Event (SecureBlackbox_WebDAVServer Class)

Fires when an object upload request is received.

Object Oriented Interface

public function fireBeforeUploadObject($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 27, array($this, 'fireBeforeUploadObject'));

Parameter List

 'connectionid'
 'path'
 'action'

Remarks

The class fires this event to notify the application about an incoming object upload request. The Path parameter contains the path of the requested object. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

If fraCustom Action is chosen, this event will be followed by UploadObject, WriteObject, and UploadObjectCompleted calls, allowing your code to process/store the object data.

ClearAttribute Event (SecureBlackbox_WebDAVServer Class)

Reports an attribute clearance request.

Object Oriented Interface

public function fireClearAttribute($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 28, array($this, 'fireClearAttribute'));

Parameter List

 'connectionid'
 'path'
 'ns'
 'name'
 'operationstatus'

Remarks

This event fires to notify the application about an attribute clearance (removal) request. Use this handler to respond to this request by making the necessary changes to the locally stored resource attributes. The ConnectionID specifies the unique client ID, Path contains the resource path, and the NS:Name pair specifies the attribute to be cleared.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

Connect Event (SecureBlackbox_WebDAVServer Class)

Reports an accepted connection.

Object Oriented Interface

public function fireConnect($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 29, array($this, 'fireConnect'));

Parameter List

 'connectionid'
 'remoteaddress'
 'remoteport'

Remarks

class fires this event to report that a new connection has been established. ConnectionId indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as GetRequest or AuthAttempt.

CopyObject Event (SecureBlackbox_WebDAVServer Class)

Lets the application handle the Copy Object request.

Object Oriented Interface

public function fireCopyObject($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 30, array($this, 'fireCopyObject'));

Parameter List

 'connectionid'
 'oldpath'
 'newpath'
 'overwrite'
 'depth'
 'operationstatus'

Remarks

Use this event handler to respond to the received Copy Object request by creating a copy of OldPath resource at NewPath.

ConnectionID specifies the unique client connection identifier, Overwrite indicates whether any existing resource(s) should be overwritten, and Depth specifies the depth of the resource tree to be copied.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

CreateCalendar Event (SecureBlackbox_WebDAVServer Class)

Lets the application handle a calendar creation request.

Object Oriented Interface

public function fireCreateCalendar($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 31, array($this, 'fireCreateCalendar'));

Parameter List

 'connectionid'
 'path'
 'operationstatus'

Remarks

Use this method to respond to a calendar creation request with a custom action. This event fires if fraCustom action was returned from the preceding BeforeCreateCalendar call.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

CreateCollection Event (SecureBlackbox_WebDAVServer Class)

Lets the application respond to collection creation request.

Object Oriented Interface

public function fireCreateCollection($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 32, array($this, 'fireCreateCollection'));

Parameter List

 'connectionid'
 'path'
 'operationstatus'

Remarks

The class uses this event to let the application respond to collection creation requests. This event fires if fraCustom action was returned from the preceding BeforeCreateCollection call. The handler of this event is expected to create a new collection at Path.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

CustomRequest Event (SecureBlackbox_WebDAVServer Class)

Use this event to respond to non-standard DAV requests.

Object Oriented Interface

public function fireCustomRequest($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 33, array($this, 'fireCustomRequest'));

Parameter List

 'connectionid'
 'requestmethod'
 'path'
 'operationstatus'

Remarks

This event allows the application to respond in a virtualized manner to non-standard DAV requests. It will fire if fraCustom action was selected in the earlier BeforeCustomRequest call.

The RequestMethod specifies the HTTP method used for this request (GET, PUT, POST etc.), and the Path contains the requested path.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

Data Event (SecureBlackbox_WebDAVServer Class)

Supplies a data chunk received from a client.

Object Oriented Interface

public function fireData($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 34, array($this, 'fireData'));

Parameter List

 'connectionid'
 'buffer'

Remarks

This event is fired to supply another piece of data received from a client. This event may fire multiple times.

Disconnect Event (SecureBlackbox_WebDAVServer Class)

Fires to report a disconnected client.

Object Oriented Interface

public function fireDisconnect($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 35, array($this, 'fireDisconnect'));

Parameter List

 'connectionid'

Remarks

class fires this event when a connected client disconnects.

DownloadObject Event (SecureBlackbox_WebDAVServer Class)

Allows the application respond to Download Object request.

Object Oriented Interface

public function fireDownloadObject($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 36, array($this, 'fireDownloadObject'));

Parameter List

 'connectionid'
 'path'
 'restartat'
 'operationstatus'

Remarks

Use this event to implement custom handler of the Download operation. This event is followed by a series of ReadObject calls, which are then followed by DownloadObjectCompleted that signifies completion of the transfer operation.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

DownloadObjectCompleted Event (SecureBlackbox_WebDAVServer Class)

This event is fired when a download operation completes.

Object Oriented Interface

public function fireDownloadObjectCompleted($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 37, array($this, 'fireDownloadObjectCompleted'));

Parameter List

 'connectionid'
 'path'
 'operationstatus'

Remarks

This event is fired when a download operation completes. This event is only fired for operations handled by the user code, i.e. those intercepted with BeforeDownloadFile event, and with Action parameter set to fraCustom.

The ConnectionID parameter specifies the session to which the event belongs, and OperationStatus reports the outcome of the transfer operation.

Error Event (SecureBlackbox_WebDAVServer Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 38, array($this, 'fireError'));

Parameter List

 'connectionid'
 'errorcode'
 'fatal'
 'remote'
 'description'

Remarks

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

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

ExternalSign Event (SecureBlackbox_WebDAVServer Class)

Handles remote or external signing initiated by the server protocol.

Object Oriented Interface

public function fireExternalSign($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 39, array($this, 'fireExternalSign'));

Parameter List

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

Remarks

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

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the 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(); };

FileError Event (SecureBlackbox_WebDAVServer Class)

Reports a file access error to the application.

Object Oriented Interface

public function fireFileError($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 40, array($this, 'fireFileError'));

Parameter List

 'connectionid'
 'filename'
 'errorcode'

Remarks

class uses this event to report a file access errors. FileName and ErrorCode contain the file path and the error code respectively.

HeadersPrepared Event (SecureBlackbox_WebDAVServer Class)

Fires when the response headers have been formed and are ready to be sent to the server.

Object Oriented Interface

public function fireHeadersPrepared($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 41, array($this, 'fireHeadersPrepared'));

Parameter List

 'connectionid'

Remarks

The class fires this event when the response headers are ready to be sent to the server. ConnectionID indicates the connection that processed the request.

Use GetResponseHeader method with an empty header name to get the whole response header.

ListAttributes Event (SecureBlackbox_WebDAVServer Class)

Requests object attributes from the application in fraCustom handling mode.

Object Oriented Interface

public function fireListAttributes($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 42, array($this, 'fireListAttributes'));

Parameter List

 'connectionid'
 'path'
 'attributes'

Remarks

The class uses this event to request a set of attributes supported/kept for the object at Path. Return the list via the Attributes parameter as a string of CRLF-separated attribute names.

After firing this event, the class may request values for individual attributes via a series of ReadAttribute calls.

This event only fires if fraCustom action type was returned from the preceding BeforeBrowse event call.

ListSubObjects Event (SecureBlackbox_WebDAVServer Class)

Requests a list of sub-objects of an object. The class uses this event to request a list of sub-objects of the object residing at Path . The Recursive parameter specifies whether the sub-objects should be browsed and returned recursively. Return the requested list via the Objects parameter by separating individual entries with CRLF.

Object Oriented Interface

public function fireListSubObjects($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 43, array($this, 'fireListSubObjects'));

Parameter List

 'connectionid'
 'path'
 'recursive'
 'objects'
 'operationstatus'

Remarks

Set the status of the operation through the OperationStatus parameter as required:

LockObject Event (SecureBlackbox_WebDAVServer Class)

Virtualizes the object locking operation.

Object Oriented Interface

public function fireLockObject($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 44, array($this, 'fireLockObject'));

Parameter List

 'connectionid'
 'path'
 'owner'
 'exclusive'
 'depth'
 'timeout'
 'token'

Remarks

The class uses this event to request a lock on the object at Path from the application. This event is only fired if fraCustom action was returned from the preceding BeforeLockObject call.

The Owner, Exclusive, Depth, and Timeout parameters specify the respective parameters of the requested lock. In response to this event, generate a lock token and return it via the Token parameter.

Notification Event (SecureBlackbox_WebDAVServer Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 45, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

Remarks

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

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

QueryQuota Event (SecureBlackbox_WebDAVServer Class)

Reflects a quota enquiry by a client.

Object Oriented Interface

public function fireQueryQuota($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 46, array($this, 'fireQueryQuota'));

Parameter List

 'connectionid'
 'username'
 'available'
 'used'

Remarks

This event fires in response to a client's enquire about their quota status. Subscribe to this event to react to such enquiries in a customized manner. Use Available and Used properties to report the respective amounts back to the client.

ReadAttribute Event (SecureBlackbox_WebDAVServer Class)

Requests value of an attribute from the application in fraCustom mode.

Object Oriented Interface

public function fireReadAttribute($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 47, array($this, 'fireReadAttribute'));

Parameter List

 'connectionid'
 'path'
 'ns'
 'name'
 'value'
 'operationstatus'

Remarks

The class fires this event to request value of the NS:Name attribute of the object residing at Path. In the event handler, pass the attribute value via the Value parameter and set OperationStatus as required.

This event only fires if fraCustom action type was returned from the preceding BeforeBrowse event call.

ReadObject Event (SecureBlackbox_WebDAVServer Class)

Requests a piece of object data from the application.

Object Oriented Interface

public function fireReadObject($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 48, array($this, 'fireReadObject'));

Parameter List

 'connectionid'
 'size'
 'operationstatus'

Remarks

The class fires this event repeatedly during an overridden download operation to request object data from the application.

The handler of this event should read up to Size bytes from the downloaded object, and pass them to the component with a SetClientBuffer call.

Use the OperationStatus parameter to return the operation result back to the server.

Set OperationStatus to one of the following values:

RefreshLock Event (SecureBlackbox_WebDAVServer Class)

Notifies the application about a lock refresh request.

Object Oriented Interface

public function fireRefreshLock($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 49, array($this, 'fireRefreshLock'));

Parameter List

 'connectionid'
 'path'
 'token'
 'timeout'
 'lockfound'

Remarks

The class uses this event to request extension of a lock on the object at Path. This event only fires if fraCustom action was returned from the preceding BeforeRefreshLock call.

In response to this event, check the validity of the provided Token for the object at Path, and extend the lock by Timeout milliseconds if the values match. Set the LockFound result as required.

RemoveObject Event (SecureBlackbox_WebDAVServer Class)

Notifies the application about object deletion requests.

Object Oriented Interface

public function fireRemoveObject($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 50, array($this, 'fireRemoveObject'));

Parameter List

 'connectionid'
 'path'
 'operationstatus'

Remarks

The class uses this event to notify the application about an incoming deletion request for the object at Path. This event only fires if fraCustom action was returned from the preceding BeforeRemoveObject call.

The handler of this event should remove the object, if appropriate, and set the OperationStatus parameter to signify the actual operation result.

RenameObject Event (SecureBlackbox_WebDAVServer Class)

Notifies the application about object name change requests.

Object Oriented Interface

public function fireRenameObject($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 51, array($this, 'fireRenameObject'));

Parameter List

 'connectionid'
 'oldpath'
 'newpath'
 'overwrite'
 'operationstatus'

Remarks

The class uses this event to notify the application about an incoming rename request for the object at OldPath. The Overwrite parameter advises whether any objects currently existing at NewPath should be overwritten. This event only fires if fraCustom action was returned from the preceding BeforeRenameObject call.

The handler of this event should rename the object to NewPath (if appropriate) and set the OperationStatus parameter to signify the actual operation result.

ResourceAccess Event (SecureBlackbox_WebDAVServer Class)

Reports an attempt to access a resource.

Object Oriented Interface

public function fireResourceAccess($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 52, array($this, 'fireResourceAccess'));

Parameter List

 'connectionid'
 'httpmethod'
 'uri'
 'allow'
 'redirecturi'

Remarks

The class fires this event to notify the application about a request received from the client. The HTTPMethod parameter indicates the HTTP method used (GET, POST, etc.)

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Allow to false to prevent the client from accessing the resource. The class will automatically send a "forbidden" status code (403).

Set a non-empty value to RedirectURI to notify the client that the resource has moved to another place. The class will automatically send a "found" status code (302). If Allow is set to false, the value of RedirectURI is ignored.

SetAttribute Event (SecureBlackbox_WebDAVServer Class)

Lets the application customize attribute assignment requests.

Object Oriented Interface

public function fireSetAttribute($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 53, array($this, 'fireSetAttribute'));

Parameter List

 'connectionid'
 'path'
 'ns'
 'name'
 'value'
 'operationstatus'

Remarks

The class uses this event to pass attribute assignment requests to the application. This event may fire multiple times after a BeforeSetAttributes call, one for each attribute, if fraCustom action was chosen.

In the handler of this event, assign Value to the attribute NS:Name of the object at Path. Set OperationStatus in accordance with the outcome of the operation.

TLSCertValidate Event (SecureBlackbox_WebDAVServer Class)

Fires when a client certificate needs to be validated.

Object Oriented Interface

public function fireTLSCertValidate($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 54, array($this, 'fireTLSCertValidate'));

Parameter List

 'connectionid'
 'accept'

Remarks

class fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the Accept parameter.

TLSEstablished Event (SecureBlackbox_WebDAVServer Class)

Reports the setup of a TLS session.

Object Oriented Interface

public function fireTLSEstablished($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 55, array($this, 'fireTLSEstablished'));

Parameter List

 'connectionid'

Remarks

Subscribe to this event to be notified about the setup of a TLS connection by a connected client.

TLSHandshake Event (SecureBlackbox_WebDAVServer Class)

Fires when a newly established client connection initiates a TLS handshake.

Object Oriented Interface

public function fireTLSHandshake($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 56, array($this, 'fireTLSHandshake'));

Parameter List

 'connectionid'
 'servername'
 'abort'

Remarks

Use this event to get notified about the initiation of the TLS handshake by the remote client. The ServerName parameter specifies the requested host from the client hello message.

TLSPSK Event (SecureBlackbox_WebDAVServer Class)

Requests a pre-shared key for TLS-PSK.

Object Oriented Interface

public function fireTLSPSK($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 57, array($this, 'fireTLSPSK'));

Parameter List

 'connectionid'
 'identity'
 'psk'
 'ciphersuite'

Remarks

The class fires this event to report that a client has requested a TLS-PSK negotiation. ConnectionId indicates the unique connection ID that requested the PSK handshake.

Use Identity to look up for the corresponding pre-shared key in the server's database, then assign the key to the PSK parameter. If TLS 1.3 PSK is used, you will also need to assign the Ciphersuite parameter with the cipher suite associated with that identity and their key.

TLSShutdown Event (SecureBlackbox_WebDAVServer Class)

Reports closure of a TLS session.

Object Oriented Interface

public function fireTLSShutdown($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 58, array($this, 'fireTLSShutdown'));

Parameter List

 'connectionid'

Remarks

The class fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a Disconnect, which marks the closure of the underlying TCP session.

UnlockObject Event (SecureBlackbox_WebDAVServer Class)

Virtualizes the object unlocking operation.

Object Oriented Interface

public function fireUnlockObject($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 59, array($this, 'fireUnlockObject'));

Parameter List

 'connectionid'
 'path'
 'token'
 'lockfound'

Remarks

The class uses this event to notify the application of the incoming unlock request. This event only fires if fraCustom action was returned from the preceding BeforeUnlockObject call.

In response to this event, check the validity of the provided Token for the object at Path, and cancel the lock if the values match. Set the LockFound result as required.

UploadObject Event (SecureBlackbox_WebDAVServer Class)

Lets the application respond to the Upload Object request.

Object Oriented Interface

public function fireUploadObject($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 60, array($this, 'fireUploadObject'));

Parameter List

 'connectionid'
 'path'
 'restartat'
 'append'
 'operationstatus'

Remarks

Use this event handler to respond to the received Upload Object request by reserving a place for the new object at Path. This event, if OperationStatus allows, will be followed by a series of WriteObject calls, passing object data in chunks, before a UploadObjectCompleted call signals completion of the upload operation.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

UploadObjectCompleted Event (SecureBlackbox_WebDAVServer Class)

This event is fired when a upload operation completes.

Object Oriented Interface

public function fireUploadObjectCompleted($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 61, array($this, 'fireUploadObjectCompleted'));

Parameter List

 'connectionid'
 'path'
 'operationstatus'

Remarks

This event is fired when a upload operation completes. This event is only fired for operations handled by the user code, i.e. those intercepted with BeforeUploadFile event, and with Action parameter set to fraCustom.

The ConnectionID parameter specifies the session to which the event belongs, and OperationStatus reports the outcome of the transfer operation.

WriteObject Event (SecureBlackbox_WebDAVServer Class)

Hands a piece of object data to the application.

Object Oriented Interface

public function fireWriteObject($param);

Procedural Interface

secureblackbox_webdavserver_register_callback($res, 62, array($this, 'fireWriteObject'));

Parameter List

 'connectionid'
 'operationstatus'

Remarks

The class fires this event repeatedly during an overridden upload operation to pass object data to the application.

The handler of this event should retrieve the pending data buffer with a GetClientBuffer call, and write it to the end of the object that is being uploaded.

Use the OperationStatus parameter to return the operation result back to the server.

Set OperationStatus to one of the following values:

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

WebDAVServer Config Settings

Base Config Settings

Trappable Errors (WebDAVServer Class)

WebDAVServer Errors