FTPServer Class

Properties   Methods   Events   Config Settings   Errors  

The FTPServer class provides server-side functionality for FTP and FTPS protocols.

Class Name

SecureBlackbox_FTPServer

Procedural Interface

 secureblackbox_ftpserver_open();
 secureblackbox_ftpserver_close($res);
 secureblackbox_ftpserver_register_callback($res, $id, $function);
 secureblackbox_ftpserver_get_last_error($res);
 secureblackbox_ftpserver_get_last_error_code($res);
 secureblackbox_ftpserver_set($res, $id, $index, $value);
 secureblackbox_ftpserver_get($res, $id, $index);
 secureblackbox_ftpserver_do_config($res, $configurationstring);
 secureblackbox_ftpserver_do_doaction($res, $actionid, $actionparams);
 secureblackbox_ftpserver_do_dropclient($res, $connectionid, $forced);
 secureblackbox_ftpserver_do_getclientbuffer($res, $connectionid);
 secureblackbox_ftpserver_do_listclients($res);
 secureblackbox_ftpserver_do_pinclient($res, $connectionid);
 secureblackbox_ftpserver_do_setclientbuffer($res, $connectionid, $value);
 secureblackbox_ftpserver_do_setclientfileentry($res, $connectionid);
 secureblackbox_ftpserver_do_start($res);
 secureblackbox_ftpserver_do_stop($res);

Remarks

FTPServer supports FTP (File Transfer Protocol) and FTPS (FTP-over-SSL) protocols. The FTPS protocol allows you to securely perform file transfer operations on the server over Transport Layer Security (TLS). TLS is a successor to the now deprecated SSL protocol, although the latter abbreviation is still widely used.

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

Whether the server is active and can accept incoming connections.

Object Oriented Interface

public function getActive();

Procedural Interface

secureblackbox_ftpserver_get($res, 1 );

Default Value

false

Remarks

This read-only property returns True if the FTPS server is running and listening for incoming connections, and False otherwise.

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

Data Type

Boolean

AllowAnonymous Property (SecureBlackbox_FTPServer Class)

Allows and disallows anonymous connections.

Object Oriented Interface

public function getAllowAnonymous();


public function setAllowAnonymous($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 2 );


secureblackbox_ftpserver_set($res, 2, $value );

Default Value

false

Remarks

Use this property to enable and disable support for anonymous connections.

Data Type

Boolean

ClientFileEntryEntryFormat Property (SecureBlackbox_FTPServer Class)

The file listing format: cfefUnknown 0 cfefUnix 1 cfefWindows 2 cfefMLSD 3 .

Object Oriented Interface

public function getClientFileEntryEntryFormat();


public function setClientFileEntryEntryFormat($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 3 );


secureblackbox_ftpserver_set($res, 3, $value );

Default Value

0

Remarks

The file listing format:

This property is not available at design time.

Data Type

Integer

ClientFileEntryFileDate Property (SecureBlackbox_FTPServer Class)

Specifies the creation and/or last modification times for the file entry.

Object Oriented Interface

public function getClientFileEntryFileDate();


public function setClientFileEntryFileDate($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 4 );


secureblackbox_ftpserver_set($res, 4, $value );

Default Value

''

Remarks

Specifies the creation and/or last modification times for the file entry.

When used on the server side, you can provide both the creation and last modification times by separating the two values with a semicolon:

Entry.FileDate = "2023-01-01 12:34:56.789;2023-06-30 11:15:15.123";

Where only one entry is provided, it specifies the creation time of the file:

Entry.FileDate = "2023-01-01 12:34:56.789";

This property is not available at design time.

Data Type

String

ClientFileEntryFileType Property (SecureBlackbox_FTPServer Class)

The type of the entry: cfetUnknown 0 cfetDirectory 1 cfetFile 2 cfetSymlink 3 cfetSpecial 4 cfetCurrentDirectory 5 cfetParentDirectory 6 .

Object Oriented Interface

public function getClientFileEntryFileType();


public function setClientFileEntryFileType($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 5 );


secureblackbox_ftpserver_set($res, 5, $value );

Default Value

0

Remarks

The type of the entry:

This property is not available at design time.

Data Type

Integer

ClientFileEntryHandle Property (SecureBlackbox_FTPServer Class)

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

Object Oriented Interface

public function getClientFileEntryHandle();


public function setClientFileEntryHandle($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 6 );


secureblackbox_ftpserver_set($res, 6, $value );

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Long64

ClientFileEntryName Property (SecureBlackbox_FTPServer Class)

The file or directory name.

Object Oriented Interface

public function getClientFileEntryName();


public function setClientFileEntryName($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 7 );


secureblackbox_ftpserver_set($res, 7, $value );

Default Value

''

Remarks

The file or directory name.

This property is not available at design time.

Data Type

String

ClientFileEntryPath Property (SecureBlackbox_FTPServer Class)

The full path to the file or directory.

Object Oriented Interface

public function getClientFileEntryPath();


public function setClientFileEntryPath($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 8 );


secureblackbox_ftpserver_set($res, 8, $value );

Default Value

''

Remarks

The full path to the file or directory.

This property is not available at design time.

Data Type

String

ClientFileEntryRawData Property (SecureBlackbox_FTPServer Class)

The unparsed entry as returned by the server.

Object Oriented Interface

public function getClientFileEntryRawData();


public function setClientFileEntryRawData($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 9 );


secureblackbox_ftpserver_set($res, 9, $value );

Default Value

''

Remarks

The unparsed entry as returned by the server.

This property is not available at design time.

Data Type

String

ClientFileEntrySize Property (SecureBlackbox_FTPServer Class)

File size in bytes.

Object Oriented Interface

public function getClientFileEntrySize();


public function setClientFileEntrySize($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 10 );


secureblackbox_ftpserver_set($res, 10, $value );

Default Value

0

Remarks

File size in bytes.

This property is not available at design time.

Data Type

Long64

DataHost Property (SecureBlackbox_FTPServer Class)

Host address for incoming data channel connections.

Object Oriented Interface

public function getDataHost();


public function setDataHost($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 11 );


secureblackbox_ftpserver_set($res, 11, $value );

Default Value

''

Remarks

Use this property to specify the address for incoming data channel connections, if it is different to Host.

In some network environments, in particular, where the server is behind a NAT, there may be a requirement to use a different host address for data connections.

Data Type

String

DataPortRangeFrom Property (SecureBlackbox_FTPServer Class)

Specifies the lower port range bound for passive mode data connections.

Object Oriented Interface

public function getDataPortRangeFrom();


public function setDataPortRangeFrom($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 12 );


secureblackbox_ftpserver_set($res, 12, $value );

Default Value

0

Remarks

Use this property in combination with DataPortRangeT to limit the port range for passive mode data connections. The value of 0 (zero) stands for no lower bound.

Data Type

Integer

DataPortRangeTo Property (SecureBlackbox_FTPServer Class)

Specifies the upper port range bound for passive mode data connections.

Object Oriented Interface

public function getDataPortRangeTo();


public function setDataPortRangeTo($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 13 );


secureblackbox_ftpserver_set($res, 13, $value );

Default Value

0

Remarks

Use this property in combination with DataPortRangeFrom to limit the port range for passive mode data connections. The value of 0 (zero) stands for no upper bound.

Data Type

Integer

ExternalCryptoAsyncDocumentID Property (SecureBlackbox_FTPServer Class)

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

Object Oriented Interface

public function getExternalCryptoAsyncDocumentID();


public function setExternalCryptoAsyncDocumentID($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 14 );


secureblackbox_ftpserver_set($res, 14, $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_FTPServer Class)

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

Object Oriented Interface

public function getExternalCryptoCustomParams();


public function setExternalCryptoCustomParams($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 15 );


secureblackbox_ftpserver_set($res, 15, $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_FTPServer 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_ftpserver_get($res, 16 );


secureblackbox_ftpserver_set($res, 16, $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_FTPServer 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_ftpserver_get($res, 17 );


secureblackbox_ftpserver_set($res, 17, $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_FTPServer Class)

Specifies the request's signature hash algorithm.

Object Oriented Interface

public function getExternalCryptoHashAlgorithm();


public function setExternalCryptoHashAlgorithm($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 18 );


secureblackbox_ftpserver_set($res, 18, $value );

Default Value

'SHA256'

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SecureBlackbox_FTPServer 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_ftpserver_get($res, 19 );


secureblackbox_ftpserver_set($res, 19, $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_FTPServer Class)

The pre-shared key used for DC request authentication.

Object Oriented Interface

public function getExternalCryptoKeySecret();


public function setExternalCryptoKeySecret($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 20 );


secureblackbox_ftpserver_set($res, 20, $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_FTPServer Class)

Specifies the asynchronous signing method.

Object Oriented Interface

public function getExternalCryptoMethod();


public function setExternalCryptoMethod($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 21 );


secureblackbox_ftpserver_set($res, 21, $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_FTPServer Class)

Specifies the external cryptography mode.

Object Oriented Interface

public function getExternalCryptoMode();


public function setExternalCryptoMode($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 22 );


secureblackbox_ftpserver_set($res, 22, $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_FTPServer 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_ftpserver_get($res, 23 );


secureblackbox_ftpserver_set($res, 23, $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_FTPServer Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 24 );


secureblackbox_ftpserver_set($res, 24, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

HandshakeTimeout Property (SecureBlackbox_FTPServer Class)

Specifies the handshake timeout in milliseconds.

Object Oriented Interface

public function getHandshakeTimeout();


public function setHandshakeTimeout($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 25 );


secureblackbox_ftpserver_set($res, 25, $value );

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Data Type

Integer

Host Property (SecureBlackbox_FTPServer Class)

Specifies the server host.

Object Oriented Interface

public function getHost();


public function setHost($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 26 );


secureblackbox_ftpserver_set($res, 26, $value );

Default Value

''

Remarks

Use this property to specify the IP address on which to listen for incoming FTP connections. Use Port to specify the listening port number.

Data Type

String

ImplicitSSL Property (SecureBlackbox_FTPServer Class)

Enables or disables implicit SSL mode.

Object Oriented Interface

public function getImplicitSSL();


public function setImplicitSSL($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 27 );


secureblackbox_ftpserver_set($res, 27, $value );

Default Value

false

Remarks

The server can only work in one mode, explicit or implicit. Explicit mode, also called AUTH TLS, supports both TLS and plain connections. Implicit mode, also called 'dedicated port mode,' only supports TLS connections.

Data Type

Boolean

PassiveModeHost Property (SecureBlackbox_FTPServer Class)

The IP address of the passive mode host.

Object Oriented Interface

public function getPassiveModeHost();


public function setPassiveModeHost($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 28 );


secureblackbox_ftpserver_set($res, 28, $value );

Default Value

''

Remarks

Use this property to specify the address on which to listen for passive mode connections.

Data Type

String

PinnedClientAddress Property (SecureBlackbox_FTPServer Class)

The client's IP address.

Object Oriented Interface

public function getPinnedClientAddress();

Procedural Interface

secureblackbox_ftpserver_get($res, 29 );

Default Value

''

Remarks

The client's IP address.

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

Data Type

String

PinnedClientChainValidationDetails Property (SecureBlackbox_FTPServer Class)

The details of a certificate chain validation outcome.

Object Oriented Interface

public function getPinnedClientChainValidationDetails();

Procedural Interface

secureblackbox_ftpserver_get($res, 30 );

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

The outcome of a certificate chain validation routine.

Object Oriented Interface

public function getPinnedClientChainValidationResult();

Procedural Interface

secureblackbox_ftpserver_get($res, 31 );

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

The cipher suite employed by this connection.

Object Oriented Interface

public function getPinnedClientCiphersuite();

Procedural Interface

secureblackbox_ftpserver_get($res, 32 );

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

Specifies whether client authentication was performed during this connection.

Object Oriented Interface

public function getPinnedClientClientAuthenticated();

Procedural Interface

secureblackbox_ftpserver_get($res, 33 );

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

PinnedClientDigestAlgorithm Property (SecureBlackbox_FTPServer Class)

The digest algorithm used in a TLS-enabled connection.

Object Oriented Interface

public function getPinnedClientDigestAlgorithm();

Procedural Interface

secureblackbox_ftpserver_get($res, 34 );

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

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

Object Oriented Interface

public function getPinnedClientEncryptionAlgorithm();

Procedural Interface

secureblackbox_ftpserver_get($res, 35 );

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

PinnedClientID Property (SecureBlackbox_FTPServer Class)

The client connection's unique identifier.

Object Oriented Interface

public function getPinnedClientID();

Procedural Interface

secureblackbox_ftpserver_get($res, 36 );

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

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

Object Oriented Interface

public function getPinnedClientKeyExchangeAlgorithm();

Procedural Interface

secureblackbox_ftpserver_get($res, 37 );

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

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

Object Oriented Interface

public function getPinnedClientKeyExchangeKeyBits();

Procedural Interface

secureblackbox_ftpserver_get($res, 38 );

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

The elliptic curve used in this connection.

Object Oriented Interface

public function getPinnedClientNamedECCurve();

Procedural Interface

secureblackbox_ftpserver_get($res, 39 );

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

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

Object Oriented Interface

public function getPinnedClientPFSCipher();

Procedural Interface

secureblackbox_ftpserver_get($res, 40 );

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

PinnedClientPort Property (SecureBlackbox_FTPServer Class)

The remote port of the client connection.

Object Oriented Interface

public function getPinnedClientPort();

Procedural Interface

secureblackbox_ftpserver_get($res, 41 );

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

PinnedClientPreSharedIdentity Property (SecureBlackbox_FTPServer 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_ftpserver_get($res, 42 );

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

PinnedClientPublicKeyBits Property (SecureBlackbox_FTPServer Class)

The length of the public key.

Object Oriented Interface

public function getPinnedClientPublicKeyBits();

Procedural Interface

secureblackbox_ftpserver_get($res, 43 );

Default Value

0

Remarks

The length of the public key.

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

Data Type

Integer

PinnedClientResumedSession Property (SecureBlackbox_FTPServer Class)

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

Object Oriented Interface

public function getPinnedClientResumedSession();

Procedural Interface

secureblackbox_ftpserver_get($res, 44 );

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

Indicates whether TLS or SSL is enabled for this connection.

Object Oriented Interface

public function getPinnedClientSecureConnection();

Procedural Interface

secureblackbox_ftpserver_get($res, 45 );

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

PinnedClientSignatureAlgorithm Property (SecureBlackbox_FTPServer Class)

The signature algorithm used in a TLS handshake.

Object Oriented Interface

public function getPinnedClientSignatureAlgorithm();

Procedural Interface

secureblackbox_ftpserver_get($res, 46 );

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

The block size of the symmetric algorithm used.

Object Oriented Interface

public function getPinnedClientSymmetricBlockSize();

Procedural Interface

secureblackbox_ftpserver_get($res, 47 );

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

The key length of the symmetric algorithm used.

Object Oriented Interface

public function getPinnedClientSymmetricKeyBits();

Procedural Interface

secureblackbox_ftpserver_get($res, 48 );

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

The total number of bytes received over this connection.

Object Oriented Interface

public function getPinnedClientTotalBytesReceived();

Procedural Interface

secureblackbox_ftpserver_get($res, 49 );

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

The total number of bytes sent over this connection.

Object Oriented Interface

public function getPinnedClientTotalBytesSent();

Procedural Interface

secureblackbox_ftpserver_get($res, 50 );

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

Contains the server certificate's chain validation log.

Object Oriented Interface

public function getPinnedClientValidationLog();

Procedural Interface

secureblackbox_ftpserver_get($res, 51 );

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

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

Object Oriented Interface

public function getPinnedClientVersion();

Procedural Interface

secureblackbox_ftpserver_get($res, 52 );

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

The number of records in the PinnedClientCert arrays.

Object Oriented Interface

public function getPinnedClientCertCount();

Procedural Interface

secureblackbox_ftpserver_get($res, 53 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• PinnedClientCertBytes
• PinnedClientCertCAKeyID
• PinnedClientCertFingerprint
• PinnedClientCertHandle
• PinnedClientCertIssuer
• PinnedClientCertIssuerRDN
• PinnedClientCertKeyAlgorithm
• PinnedClientCertKeyBits
• PinnedClientCertKeyFingerprint
• PinnedClientCertKeyUsage
• PinnedClientCertPublicKeyBytes
• PinnedClientCertSelfSigned
• PinnedClientCertSerialNumber
• PinnedClientCertSigAlgorithm
• PinnedClientCertSubject
• PinnedClientCertSubjectKeyID
• PinnedClientCertSubjectRDN
• 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_FTPServer Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getPinnedClientCertBytes($pinnedclientcertindex);

Procedural Interface

secureblackbox_ftpserver_get($res, 54 , $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

PinnedClientCertCAKeyID Property (SecureBlackbox_FTPServer Class)

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

Object Oriented Interface

public function getPinnedClientCertCAKeyID($pinnedclientcertindex);

Procedural Interface

secureblackbox_ftpserver_get($res, 56 , $pinnedclientcertindex);

Remarks

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

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

The $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

PinnedClientCertFingerprint Property (SecureBlackbox_FTPServer Class)

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

Object Oriented Interface

public function getPinnedClientCertFingerprint($pinnedclientcertindex);

Procedural Interface

secureblackbox_ftpserver_get($res, 59 , $pinnedclientcertindex);

Remarks

Contains the fingerprint (a hash imprint) of this 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

PinnedClientCertHandle Property (SecureBlackbox_FTPServer 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_ftpserver_get($res, 61 , $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

PinnedClientCertIssuer Property (SecureBlackbox_FTPServer Class)

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

Object Oriented Interface

public function getPinnedClientCertIssuer($pinnedclientcertindex);

Procedural Interface

secureblackbox_ftpserver_get($res, 63 , $pinnedclientcertindex);

Default Value

''

Remarks

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

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

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

Object Oriented Interface

public function getPinnedClientCertIssuerRDN($pinnedclientcertindex);

Procedural Interface

secureblackbox_ftpserver_get($res, 64 , $pinnedclientcertindex);

Default Value

''

Remarks

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

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

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getPinnedClientCertKeyAlgorithm($pinnedclientcertindex);

Procedural Interface

secureblackbox_ftpserver_get($res, 65 , $pinnedclientcertindex);

Default Value

'0'

Remarks

Specifies the public key algorithm of this 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

String

PinnedClientCertKeyBits Property (SecureBlackbox_FTPServer Class)

Returns the length of the public key.

Object Oriented Interface

public function getPinnedClientCertKeyBits($pinnedclientcertindex);

Procedural Interface

secureblackbox_ftpserver_get($res, 66 , $pinnedclientcertindex);

Default Value

0

Remarks

Returns the length of the public 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

Integer

PinnedClientCertKeyFingerprint Property (SecureBlackbox_FTPServer Class)

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

Object Oriented Interface

public function getPinnedClientCertKeyFingerprint($pinnedclientcertindex);

Procedural Interface

secureblackbox_ftpserver_get($res, 67 , $pinnedclientcertindex);

Remarks

Returns a fingerprint 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

PinnedClientCertKeyUsage Property (SecureBlackbox_FTPServer 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_ftpserver_get($res, 68 , $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:

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

PinnedClientCertPublicKeyBytes Property (SecureBlackbox_FTPServer Class)

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getPinnedClientCertPublicKeyBytes($pinnedclientcertindex);

Procedural Interface

secureblackbox_ftpserver_get($res, 77 , $pinnedclientcertindex);

Remarks

Contains the certificate's public key 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

PinnedClientCertSelfSigned Property (SecureBlackbox_FTPServer 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_ftpserver_get($res, 79 , $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_FTPServer Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getPinnedClientCertSerialNumber($pinnedclientcertindex);

Procedural Interface

secureblackbox_ftpserver_get($res, 80 , $pinnedclientcertindex);

Remarks

Returns the certificate's serial number.

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

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

Object Oriented Interface

public function getPinnedClientCertSigAlgorithm($pinnedclientcertindex);

Procedural Interface

secureblackbox_ftpserver_get($res, 81 , $pinnedclientcertindex);

Default Value

''

Remarks

Indicates the algorithm that was used by the CA to sign this 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

String

PinnedClientCertSubject Property (SecureBlackbox_FTPServer 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_ftpserver_get($res, 82 , $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.

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

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

Object Oriented Interface

public function getPinnedClientCertSubjectKeyID($pinnedclientcertindex);

Procedural Interface

secureblackbox_ftpserver_get($res, 84 , $pinnedclientcertindex);

Remarks

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

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

The $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_FTPServer Class)

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

Object Oriented Interface

public function getPinnedClientCertSubjectRDN($pinnedclientcertindex);

Procedural Interface

secureblackbox_ftpserver_get($res, 85 , $pinnedclientcertindex);

Default Value

''

Remarks

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

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

PinnedClientCertValidFrom Property (SecureBlackbox_FTPServer Class)

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

Object Oriented Interface

public function getPinnedClientCertValidFrom($pinnedclientcertindex);

Procedural Interface

secureblackbox_ftpserver_get($res, 86 , $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_FTPServer Class)

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

Object Oriented Interface

public function getPinnedClientCertValidTo($pinnedclientcertindex);

Procedural Interface

secureblackbox_ftpserver_get($res, 87 , $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_FTPServer Class)

The port number to listen for incoming connections on.

Object Oriented Interface

public function getPort();


public function setPort($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 88 );


secureblackbox_ftpserver_set($res, 88, $value );

Default Value

21

Remarks

Use this property to specify the port number to listen for incoming connections on.

Data Type

Integer

ReadOnly Property (SecureBlackbox_FTPServer Class)

Makes the server's file system read-only for all users.

Object Oriented Interface

public function getReadOnly();


public function setReadOnly($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 89 );


secureblackbox_ftpserver_set($res, 89, $value );

Default Value

false

Remarks

Set this property to true to present the server's file system as read-only for all connecting users.

Data Type

Boolean

RootDirectory Property (SecureBlackbox_FTPServer Class)

Specifies the server's root directory.

Object Oriented Interface

public function getRootDirectory();


public function setRootDirectory($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 90 );


secureblackbox_ftpserver_set($res, 90, $value );

Default Value

''

Remarks

Use this property to specify the shared root directory for all client sessions.

Data Type

String

SecurityOptions Property (SecureBlackbox_FTPServer Class)

Various options of the secure connection.

Object Oriented Interface

public function getSecurityOptions();


public function setSecurityOptions($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 91 );


secureblackbox_ftpserver_set($res, 91, $value );

Default Value

63

Remarks

Various options of the secure connection:

Data Type

Integer

ServerCertCount Property (SecureBlackbox_FTPServer Class)

The number of records in the ServerCert arrays.

Object Oriented Interface

public function getServerCertCount();


public function setServerCertCount($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 92 );


secureblackbox_ftpserver_set($res, 92, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ServerCertBytes
• ServerCertHandle

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

This property is not available at design time.

Data Type

Integer

ServerCertBytes Property (SecureBlackbox_FTPServer Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getServerCertBytes($servercertindex);

Procedural Interface

secureblackbox_ftpserver_get($res, 93 , $servercertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

ServerCertHandle Property (SecureBlackbox_FTPServer Class)

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

Object Oriented Interface

public function getServerCertHandle($servercertindex);


public function setServerCertHandle($servercertindex, $value);

Procedural Interface

secureblackbox_ftpserver_get($res, 100 , $servercertindex);


secureblackbox_ftpserver_set($res, 100, $value , $servercertindex);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

SessionTimeout Property (SecureBlackbox_FTPServer Class)

Specifies the session timeout in milliseconds.

Object Oriented Interface

public function getSessionTimeout();


public function setSessionTimeout($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 127 );


secureblackbox_ftpserver_set($res, 127, $value );

Default Value

360000

Remarks

Specifies the maximum inactivity time (in milliseconds) after which the session will be forcebly closed.

Data Type

Integer

SocketIncomingSpeedLimit Property (SecureBlackbox_FTPServer 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_ftpserver_get($res, 133 );


secureblackbox_ftpserver_set($res, 133, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (SecureBlackbox_FTPServer Class)

The local network interface to bind the socket to.

Object Oriented Interface

public function getSocketLocalAddress();


public function setSocketLocalAddress($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 134 );


secureblackbox_ftpserver_set($res, 134, $value );

Default Value

''

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SecureBlackbox_FTPServer Class)

The local port number to bind the socket to.

Object Oriented Interface

public function getSocketLocalPort();


public function setSocketLocalPort($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 135 );


secureblackbox_ftpserver_set($res, 135, $value );

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SecureBlackbox_FTPServer 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_ftpserver_get($res, 136 );


secureblackbox_ftpserver_set($res, 136, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (SecureBlackbox_FTPServer 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_ftpserver_get($res, 137 );


secureblackbox_ftpserver_set($res, 137, $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_FTPServer Class)

Enables or disables IP protocol version 6.

Object Oriented Interface

public function getSocketUseIPv6();


public function setSocketUseIPv6($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 138 );


secureblackbox_ftpserver_set($res, 138, $value );

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

TLSAutoValidateCertificates Property (SecureBlackbox_FTPServer 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_ftpserver_get($res, 139 );


secureblackbox_ftpserver_set($res, 139, $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_FTPServer Class)

Selects the base configuration for the TLS settings.

Object Oriented Interface

public function getTLSBaseConfiguration();


public function setTLSBaseConfiguration($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 140 );


secureblackbox_ftpserver_set($res, 140, $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_FTPServer Class)

A list of ciphersuites separated with commas or semicolons.

Object Oriented Interface

public function getTLSCiphersuites();


public function setTLSCiphersuites($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 141 );


secureblackbox_ftpserver_set($res, 141, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

TLSECCurves Property (SecureBlackbox_FTPServer Class)

Defines the elliptic curves to enable.

Object Oriented Interface

public function getTLSECCurves();


public function setTLSECCurves($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 142 );


secureblackbox_ftpserver_set($res, 142, $value );

Default Value

''

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (SecureBlackbox_FTPServer Class)

Provides access to TLS extensions.

Object Oriented Interface

public function getTLSExtensions();


public function setTLSExtensions($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 143 );


secureblackbox_ftpserver_set($res, 143, $value );

Default Value

''

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (SecureBlackbox_FTPServer 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_ftpserver_get($res, 144 );


secureblackbox_ftpserver_set($res, 144, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSPreSharedIdentity Property (SecureBlackbox_FTPServer 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_ftpserver_get($res, 145 );


secureblackbox_ftpserver_set($res, 145, $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_FTPServer 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_ftpserver_get($res, 146 );


secureblackbox_ftpserver_set($res, 146, $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_FTPServer Class)

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

Object Oriented Interface

public function getTLSPreSharedKeyCiphersuite();


public function setTLSPreSharedKeyCiphersuite($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 147 );


secureblackbox_ftpserver_set($res, 147, $value );

Default Value

''

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (SecureBlackbox_FTPServer Class)

Selects the renegotiation attack prevention mechanism.

Object Oriented Interface

public function getTLSRenegotiationAttackPreventionMode();


public function setTLSRenegotiationAttackPreventionMode($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 148 );


secureblackbox_ftpserver_set($res, 148, $value );

Default Value

0

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (SecureBlackbox_FTPServer Class)

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

Object Oriented Interface

public function getTLSRevocationCheck();


public function setTLSRevocationCheck($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 149 );


secureblackbox_ftpserver_set($res, 149, $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_FTPServer 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_ftpserver_get($res, 150 );


secureblackbox_ftpserver_set($res, 150, $value );

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (SecureBlackbox_FTPServer Class)

Specifies the TLS mode to use.

Object Oriented Interface

public function getTLSTLSMode();


public function setTLSTLSMode($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 151 );


secureblackbox_ftpserver_set($res, 151, $value );

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (SecureBlackbox_FTPServer 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_ftpserver_get($res, 152 );


secureblackbox_ftpserver_set($res, 152, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (SecureBlackbox_FTPServer Class)

Enables or disables the TLS session resumption capability.

Object Oriented Interface

public function getTLSUseSessionResumption();


public function setTLSUseSessionResumption($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 153 );


secureblackbox_ftpserver_set($res, 153, $value );

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (SecureBlackbox_FTPServer Class)

The SSL/TLS versions to enable by default.

Object Oriented Interface

public function getTLSVersions();


public function setTLSVersions($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 154 );


secureblackbox_ftpserver_set($res, 154, $value );

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

UserCount Property (SecureBlackbox_FTPServer Class)

The number of records in the User arrays.

Object Oriented Interface

public function getUserCount();


public function setUserCount($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 155 );


secureblackbox_ftpserver_set($res, 155, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• UserAssociatedData
• UserBasePath
• UserCert
• UserData
• UserHandle
• UserHashAlgorithm
• UserIncomingSpeedLimit
• UserOutgoingSpeedLimit
• UserPassword
• UserSharedSecret
• 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_FTPServer 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_ftpserver_get($res, 156 , $userindex);


secureblackbox_ftpserver_set($res, 156, $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_FTPServer 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_ftpserver_get($res, 157 , $userindex);


secureblackbox_ftpserver_set($res, 157, $value , $userindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

UserCert Property (SecureBlackbox_FTPServer Class)

Contains the user's certificate.

Object Oriented Interface

public function getUserCert($userindex);


public function setUserCert($userindex, $value);

Procedural Interface

secureblackbox_ftpserver_get($res, 158 , $userindex);


secureblackbox_ftpserver_set($res, 158, $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_FTPServer 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_ftpserver_get($res, 159 , $userindex);


secureblackbox_ftpserver_set($res, 159, $value , $userindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

UserHandle Property (SecureBlackbox_FTPServer 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_ftpserver_get($res, 160 , $userindex);


secureblackbox_ftpserver_set($res, 160, $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_FTPServer 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_ftpserver_get($res, 161 , $userindex);


secureblackbox_ftpserver_set($res, 161, $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_FTPServer Class)

Specifies the incoming speed limit for this user.

Object Oriented Interface

public function getUserIncomingSpeedLimit($userindex);


public function setUserIncomingSpeedLimit($userindex, $value);

Procedural Interface

secureblackbox_ftpserver_get($res, 162 , $userindex);


secureblackbox_ftpserver_set($res, 162, $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

UserOutgoingSpeedLimit Property (SecureBlackbox_FTPServer Class)

Specifies the outgoing speed limit for this user.

Object Oriented Interface

public function getUserOutgoingSpeedLimit($userindex);


public function setUserOutgoingSpeedLimit($userindex, $value);

Procedural Interface

secureblackbox_ftpserver_get($res, 165 , $userindex);


secureblackbox_ftpserver_set($res, 165, $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_FTPServer Class)

The user's authentication password.

Object Oriented Interface

public function getUserPassword($userindex);


public function setUserPassword($userindex, $value);

Procedural Interface

secureblackbox_ftpserver_get($res, 166 , $userindex);


secureblackbox_ftpserver_set($res, 166, $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_FTPServer 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_ftpserver_get($res, 168 , $userindex);


secureblackbox_ftpserver_set($res, 168, $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

UserUsername Property (SecureBlackbox_FTPServer Class)

The registered name (login) of the user.

Object Oriented Interface

public function getUserUsername($userindex);


public function setUserUsername($userindex, $value);

Procedural Interface

secureblackbox_ftpserver_get($res, 170 , $userindex);


secureblackbox_ftpserver_set($res, 170, $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

UseUTF8 Property (SecureBlackbox_FTPServer Class)

Enables or disables UTF8 file name conversions.

Object Oriented Interface

public function getUseUTF8();


public function setUseUTF8($value);

Procedural Interface

secureblackbox_ftpserver_get($res, 171 );


secureblackbox_ftpserver_set($res, 171, $value );

Default Value

true

Remarks

Use this property to enable and disable UTF8 file name conversion. The server typically adjusts to the right setting automatically, but you may use this property to enforce the needed behaviour.

Data Type

Boolean

Config Method (SecureBlackbox_FTPServer Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_ftpserver_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_FTPServer Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

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

DropClient Method (SecureBlackbox_FTPServer Class)

Terminates a client connection.

Object Oriented Interface

public function doDropClient($connectionid, $forced);

Procedural Interface

secureblackbox_ftpserver_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_FTPServer Class)

Obtains a pending connection buffer.

Object Oriented Interface

public function doGetClientBuffer($connectionid);

Procedural Interface

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

ListClients Method (SecureBlackbox_FTPServer Class)

Enumerates the connected clients.

Object Oriented Interface

public function doListClients();

Procedural Interface

secureblackbox_ftpserver_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_FTPServer Class)

Takes a snapshot of the connection's properties.

Object Oriented Interface

public function doPinClient($connectionid);

Procedural Interface

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

SetClientBuffer Method (SecureBlackbox_FTPServer Class)

Commits a data buffer to the connection.

Object Oriented Interface

public function doSetClientBuffer($connectionid, $value);

Procedural Interface

secureblackbox_ftpserver_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_FTPServer Class)

Commits a file entry to the connection.

Object Oriented Interface

public function doSetClientFileEntry($connectionid);

Procedural Interface

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

Start Method (SecureBlackbox_FTPServer Class)

Starts the server.

Object Oriented Interface

public function doStart();

Procedural Interface

secureblackbox_ftpserver_do_start($res);

Remarks

Call this method to start listening for incoming connections on port Port. Call Stop to deactivate the server.

Stop Method (SecureBlackbox_FTPServer Class)

Stops the server.

Object Oriented Interface

public function doStop();

Procedural Interface

secureblackbox_ftpserver_do_stop($res);

Remarks

Call this method to terminate all active sessions and stop listening for new incoming connections.

Accept Event (SecureBlackbox_FTPServer Class)

Reports an incoming connection.

Object Oriented Interface

public function fireAccept($param);

Procedural Interface

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

AfterChangeDirectory Event (SecureBlackbox_FTPServer Class)

Signals the completion of a directory change operation.

Object Oriented Interface

public function fireAfterChangeDirectory($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 2, array($this, 'fireAfterChangeDirectory'));

Parameter List

 'connectionid'
 'directory'
 'operationstatus'

Remarks

The class fires this event upon completion of a directory change operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterCreateDirectory Event (SecureBlackbox_FTPServer Class)

Signals the completion of a directory creation operation.

Object Oriented Interface

public function fireAfterCreateDirectory($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 3, array($this, 'fireAfterCreateDirectory'));

Parameter List

 'connectionid'
 'directory'
 'operationstatus'

Remarks

The class fires this event upon completion of a directory creation operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterRemoveDirectory Event (SecureBlackbox_FTPServer Class)

Signals the completion of a directory removal operation.

Object Oriented Interface

public function fireAfterRemoveDirectory($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 4, array($this, 'fireAfterRemoveDirectory'));

Parameter List

 'connectionid'
 'directory'
 'operationstatus'

Remarks

The class fires this event upon completion of a directory removal operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterRemoveFile Event (SecureBlackbox_FTPServer Class)

Signals the completion of a file removal operation.

Object Oriented Interface

public function fireAfterRemoveFile($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 5, array($this, 'fireAfterRemoveFile'));

Parameter List

 'connectionid'
 'path'
 'operationstatus'

Remarks

The class fires this event upon completion of a file removal operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterRenameFile Event (SecureBlackbox_FTPServer Class)

Signals the completion of a file renaming operation.

Object Oriented Interface

public function fireAfterRenameFile($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 6, array($this, 'fireAfterRenameFile'));

Parameter List

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

Remarks

The class fires this event upon completion of a file renaming operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterRequestAttributes Event (SecureBlackbox_FTPServer Class)

Signals the completion of an attribute request.

Object Oriented Interface

public function fireAfterRequestAttributes($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 7, array($this, 'fireAfterRequestAttributes'));

Parameter List

 'connectionid'
 'path'
 'operationstatus'

Remarks

The class fires this event upon completion of an attribute request. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AuthAttempt Event (SecureBlackbox_FTPServer Class)

Fires when a connected client makes an authentication attempt.

Object Oriented Interface

public function fireAuthAttempt($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 8, array($this, 'fireAuthAttempt'));

Parameter List

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

Remarks

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

ConnectionID contains the unique session identifier for that client, and Username and Password contain the professed credentials.

BeforeChangeDirectory Event (SecureBlackbox_FTPServer Class)

Notifies about an incoming change directory request.

Object Oriented Interface

public function fireBeforeChangeDirectory($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 9, array($this, 'fireBeforeChangeDirectory'));

Parameter List

 'connectionid'
 'directory'
 'action'

Remarks

The class fires this event to notify the application about a received directory change 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. Subscribe to ChangeDirectory to be notified when to perform the request. It is the ChangeDirectory event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the AfterChangeDirectory event will be fired.

Choose Action as one of the following values:

BeforeCreateDirectory Event (SecureBlackbox_FTPServer Class)

Notifies about an incoming create directory request.

Object Oriented Interface

public function fireBeforeCreateDirectory($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 10, array($this, 'fireBeforeCreateDirectory'));

Parameter List

 'connectionid'
 'directory'
 'action'

Remarks

The class fires this event to notify the application about a received MKDIR 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. Subscribe to CreateDirectory to be notified when to perform the request. It is the CreateDirectory event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the AfterCreateDirectory event will be fired.

Choose Action as one of the following values:

BeforeDownloadFile Event (SecureBlackbox_FTPServer Class)

Notifies about an incoming file download request.

Object Oriented Interface

public function fireBeforeDownloadFile($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 11, array($this, 'fireBeforeDownloadFile'));

Parameter List

 'connectionid'
 'path'
 'restartat'
 'action'

Remarks

The class fires this event to notify the application about a received download 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. Subscribe to DownloadFile to be notified when to perform the request. It is the DownloadFile event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the TransferCompleted event will be fired.

Choose Action as one of the following values:

BeforeFind Event (SecureBlackbox_FTPServer Class)

Notifies about an incoming file listing request.

Object Oriented Interface

public function fireBeforeFind($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 12, array($this, 'fireBeforeFind'));

Parameter List

 'connectionid'
 'directory'
 'action'

Remarks

The class fires this event to notify the application about a received file listing 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. Subscribe to FindInit, FindNext, and FindClose to be notified when to perform the request. It is the FindInit and FindNext events handler where you should perform the overridden listing actions.

Upon completion of the request, either in manual or override mode, the FindClose event will be fired.

Choose Action as one of the following values:

BeforeRemoveDirectory Event (SecureBlackbox_FTPServer Class)

Notifies about an incoming directory removal request.

Object Oriented Interface

public function fireBeforeRemoveDirectory($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 13, array($this, 'fireBeforeRemoveDirectory'));

Parameter List

 'connectionid'
 'directory'
 'action'

Remarks

The class fires this event to notify the application about a received directory removal 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. Subscribe to RemoveDirectory to be notified when to perform the request. It is the RemoveDirectory event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the AfterRemoveDirectory event will be fired.

Choose Action as one of the following values:

BeforeRemoveFile Event (SecureBlackbox_FTPServer Class)

Notifies about an incoming file removal request.

Object Oriented Interface

public function fireBeforeRemoveFile($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 14, array($this, 'fireBeforeRemoveFile'));

Parameter List

 'connectionid'
 'path'
 'action'

Remarks

The class fires this event to notify the application about a received file deletion 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. Subscribe to RemoveFile to be notified when to perform the request. It is the RemoveFile event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the AfterRemoveFile event will be fired.

Choose Action as one of the following values:

Note that you must subscribe to BeforeRequestAttributes and RequestAttributes events to be able to use this event in an FTP server attached to a virtual file system. This is because the server checks the existence of the source file before commencing the deletion procedure. In the virtualized case, you can confirm the existence of the file by returning its details from RequestAttributes call.

BeforeRenameFile Event (SecureBlackbox_FTPServer Class)

Notifies about an incoming file rename request.

Object Oriented Interface

public function fireBeforeRenameFile($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 15, array($this, 'fireBeforeRenameFile'));

Parameter List

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

Remarks

The class fires this event to notify the application about a received file rename 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. Subscribe to RenameFile to be notified when to perform the request. It is the RenameFile event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the AfterRenameFile event will be fired.

Choose Action as one of the following values:

Note that you must subscribe to BeforeRequestAttributes and RequestAttributes events to be able to use this event in an FTP server attached to a virtual file system. This is because the server checks the existence of the source file before commencing the renaming procedure. In the virtualized case, you can confirm the existence of the file by returning its details from RequestAttributes call.

BeforeRequestAttributes Event (SecureBlackbox_FTPServer Class)

Notifies about an incoming attributes request.

Object Oriented Interface

public function fireBeforeRequestAttributes($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 16, array($this, 'fireBeforeRequestAttributes'));

Parameter List

 'connectionid'
 'path'
 'action'

Remarks

The class fires this event to notify the application about a received attributes 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. Subscribe to RequestAttributes to be notified when to perform the request. It is the RequestAttributes event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the AfterRequestAttributes event will be fired.

Choose Action as one of the following values:

BeforeSendReply Event (SecureBlackbox_FTPServer Class)

Notifies the application of a command reply being sent.

Object Oriented Interface

public function fireBeforeSendReply($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 17, array($this, 'fireBeforeSendReply'));

Parameter List

 'connectionid'
 'code'
 'reply'
 'command'

Remarks

The class fires this event to tell the application that a command reply is about to be sent. The Command parameter indicates the command that induced the reply, and Code and Reply indicate the pre-generated response.

You can alter the response parameters in your code to send bespoke replies.

BeforeUploadFile Event (SecureBlackbox_FTPServer Class)

Notifies about an incoming file upload request.

Object Oriented Interface

public function fireBeforeUploadFile($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 18, array($this, 'fireBeforeUploadFile'));

Parameter List

 'connectionid'
 'path'
 'restartat'
 'append'
 'action'

Remarks

The class fires this event to notify the application about a received upload 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. Subscribe to UploadFile to be notified when to perform the request. It is the UploadFile event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the TransferCompleted event will be fired.

Choose Action as one of the following values:

ChangeDirectory Event (SecureBlackbox_FTPServer Class)

An override for a directory change operation.

Object Oriented Interface

public function fireChangeDirectory($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 19, array($this, 'fireChangeDirectory'));

Parameter List

 'connectionid'
 'directory'
 'operationstatus'

Remarks

The class fires this event to let the application perform an overridden directory change operation.

This event only fires if Action = fraCustom was passed back from BeforeChangeDirectory event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

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

This event will be followed by AfterChangeDirectory call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

CommandProcessed Event (SecureBlackbox_FTPServer Class)

Signals that a command has been processed by the server.

Object Oriented Interface

public function fireCommandProcessed($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 20, array($this, 'fireCommandProcessed'));

Parameter List

 'connectionid'
 'currentdirectory'
 'command'
 'replycode'

Remarks

The class fires this event to signal that a command has been processed by the server, and a reply code has been generated.

You can adjust the reply code and the textual comment associated with it in BeforeSendReply event handler.

CommandReceived Event (SecureBlackbox_FTPServer Class)

Signals that a command has been received from the client.

Object Oriented Interface

public function fireCommandReceived($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 21, array($this, 'fireCommandReceived'));

Parameter List

 'connectionid'
 'command'
 'parameters'
 'ignore'

Remarks

The class fires this event to notify the application of an incoming command. Set Ignore to True to stop the server from handling the command.

When the command has been processed, the server will report it via the CommandProcessed call.

Connect Event (SecureBlackbox_FTPServer Class)

Reports an accepted connection.

Object Oriented Interface

public function fireConnect($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 22, array($this, 'fireConnect'));

Parameter List

 'connectionid'
 'remoteaddress'
 'port'

Remarks

The 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 AuthAttempt or BeforeUploadFile.

CreateDirectory Event (SecureBlackbox_FTPServer Class)

An override for a directory creation operation.

Object Oriented Interface

public function fireCreateDirectory($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 23, array($this, 'fireCreateDirectory'));

Parameter List

 'connectionid'
 'directory'
 'operationstatus'

Remarks

The class fires this event to let the application perform an overridden directory creation operation.

This event only fires if Action = fraCustom was passed back from BeforeCreateDirectory event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

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

This event will be followed by AfterCreateDirectory call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

Disconnect Event (SecureBlackbox_FTPServer Class)

Fires to report a disconnected client.

Object Oriented Interface

public function fireDisconnect($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 24, array($this, 'fireDisconnect'));

Parameter List

 'connectionid'

Remarks

The class fires this event when a connected client disconnects.

DownloadBegin Event (SecureBlackbox_FTPServer Class)

The class fires this event to notify the application about the start of a file download.

Object Oriented Interface

public function fireDownloadBegin($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 25, array($this, 'fireDownloadBegin'));

Parameter List

 'connectionid'
 'path'

Remarks

Subscribe to this event to get notified about the beginning of a file download operation. The requested file is specified via the Path property.

DownloadEnd Event (SecureBlackbox_FTPServer Class)

Reports the completion of the download operation.

Object Oriented Interface

public function fireDownloadEnd($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 26, array($this, 'fireDownloadEnd'));

Parameter List

 'connectionid'
 'path'

Remarks

Use this event to get notified about completion of the early initiated file download operation.

DownloadFile Event (SecureBlackbox_FTPServer Class)

An override for a file download initiation operation.

Object Oriented Interface

public function fireDownloadFile($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 27, array($this, 'fireDownloadFile'));

Parameter List

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

Remarks

The class fires this event to let the application perform an overridden file download initiation operation.

This event only fires if Action = fraCustom was passed back from BeforeDownloadFile event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

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

This event will be followed by a number of ReadFile calls, requesting the file data from your code, followed by a single TransferCompleted call.

Set OperationStatus to one of the following values:

DownloadProgress Event (SecureBlackbox_FTPServer Class)

Reports the progress of an active download operation.

Object Oriented Interface

public function fireDownloadProgress($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 28, array($this, 'fireDownloadProgress'));

Parameter List

 'connectionid'
 'path'
 'progress'
 'total'

Remarks

Subscribe to this event to be notified about the progress of an active download operation.

The Path parameter contains the path to the file being downloaded, and Progress and Total reflect the operation progress. Note that the Total parameter may be set to -1 if the size of the downloaded file is not known.

Error Event (SecureBlackbox_FTPServer Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 29, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

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

ExternalSign Event (SecureBlackbox_FTPServer Class)

Handles remote or external signing initiated by the server protocol.

Object Oriented Interface

public function fireExternalSign($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 30, 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(); };

FindClose Event (SecureBlackbox_FTPServer Class)

Signals the completion of a directory listing request.

Object Oriented Interface

public function fireFindClose($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 31, array($this, 'fireFindClose'));

Parameter List

 'connectionid'
 'operationstatus'

Remarks

The class fires this event upon completion of a directory listing request. Check the operation status, and alter it, if needed, through the OperationStatus parameter.

FindInit Event (SecureBlackbox_FTPServer Class)

An override for a directory listing initiation operation.

Object Oriented Interface

public function fireFindInit($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 32, array($this, 'fireFindInit'));

Parameter List

 'connectionid'
 'directory'
 'operationstatus'

Remarks

The class fires this event to let the application prepare for directory listing retrieval.

This event only fires if Action = fraCustom was passed back from BeforeFind event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

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

This event will be followed by a number of FindNext calls, requesting the directory listing entry by entry from your code, followed by a FindClose call.

Set OperationStatus to one of the following values:

FindNext Event (SecureBlackbox_FTPServer Class)

An override for a directory listing entry request operation.

Object Oriented Interface

public function fireFindNext($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 33, array($this, 'fireFindNext'));

Parameter List

 'connectionid'
 'operationstatus'

Remarks

The class fires this event in a loop after calling FindInit to request one directory entry from the application.

This event only fires if Action = fraCustom was passed back from BeforeFind event. No default listing operation will be performed by the server component.

Inside the handler, pass the entry details to the server component by tuning up the ClientFileEntry object to contain the details of the requested entry, and committing those details to the component with SetClientFileEntry method.

Use the OperationStatus parameter to return the operation result back to the server. After submitting all the directory entries to the component, set OperationStatus to ostEOF to tell the components that no more entries are left.

This event will be followed by FindClose call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

Notification Event (SecureBlackbox_FTPServer Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 34, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

Remarks

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

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

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

ReadFile Event (SecureBlackbox_FTPServer Class)

Requests a piece of file data from the application.

Object Oriented Interface

public function fireReadFile($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 35, array($this, 'fireReadFile'));

Parameter List

 'connectionid'
 'size'
 'operationstatus'

Remarks

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

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

Use the OperationStatus parameter to return the operation result back to the server. When the file has been read up to its end, set OperationStatus to ostEOF to tell the components that no more ReadFile calls are needed.

Set OperationStatus to one of the following values:

RemoveDirectory Event (SecureBlackbox_FTPServer Class)

An override for a directory removal operation.

Object Oriented Interface

public function fireRemoveDirectory($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 36, array($this, 'fireRemoveDirectory'));

Parameter List

 'connectionid'
 'directory'
 'operationstatus'

Remarks

The class fires this event to let the application perform an overridden directory removal operation.

This event only fires if Action = fraCustom was passed back from BeforeRemoveDirectory event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

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

This event will be followed by AfterRemoveDirectory call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

RemoveFile Event (SecureBlackbox_FTPServer Class)

An override for a file remove operation.

Object Oriented Interface

public function fireRemoveFile($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 37, array($this, 'fireRemoveFile'));

Parameter List

 'connectionid'
 'path'
 'operationstatus'

Remarks

The class fires this event to let the application perform an overridden file removal operation.

This event only fires if Action = fraCustom was passed back from BeforeRemoveFile event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

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

This event will be followed by AfterRemoveFile call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

Please see a remark about virtualizing file removals in the BeforeRemoveFile topic.

RenameFile Event (SecureBlackbox_FTPServer Class)

An override for a file rename operation.

Object Oriented Interface

public function fireRenameFile($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 38, array($this, 'fireRenameFile'));

Parameter List

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

Remarks

The class fires this event to let the application perform an overridden file rename operation.

This event only fires if Action = fraCustom was passed back from BeforeRenameFile event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

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

This event will be followed by AfterRenameFile call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

Please see a remark about virtualizing file renamings in the BeforeRenameFile topic.

RequestAttributes Event (SecureBlackbox_FTPServer Class)

An override for an attribute request.

Object Oriented Interface

public function fireRequestAttributes($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 39, array($this, 'fireRequestAttributes'));

Parameter List

 'connectionid'
 'path'
 'operationstatus'

Remarks

The class fires this event to let the application handle an overridden attribute request operation.

This event only fires if Action = fraCustom was passed back from BeforeRequestAttributes event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

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

This event will be followed by AfterRequestAttributes call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

TLSCertValidate Event (SecureBlackbox_FTPServer Class)

Fires when a client certificate needs to be validated.

Object Oriented Interface

public function fireTLSCertValidate($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 40, array($this, 'fireTLSCertValidate'));

Parameter List

 'connectionid'
 'accept'

Remarks

The 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_FTPServer Class)

Reports the setup of a TLS session.

Object Oriented Interface

public function fireTLSEstablished($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 41, 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_FTPServer Class)

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

Object Oriented Interface

public function fireTLSHandshake($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 42, 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_FTPServer Class)

Requests a pre-shared key for TLS-PSK.

Object Oriented Interface

public function fireTLSPSK($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 43, 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_FTPServer Class)

Reports closure of a TLS session.

Object Oriented Interface

public function fireTLSShutdown($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 44, 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.

TransferCompleted Event (SecureBlackbox_FTPServer Class)

This event is fired when a customized upload or download operation completes.

Object Oriented Interface

public function fireTransferCompleted($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 45, array($this, 'fireTransferCompleted'));

Parameter List

 'connectionid'
 'operationstatus'

Remarks

This event is fired when a customized transfer operation completes. This event is only fired for operations handled by the user code, i.e. those intercepted with BeforeUploadFile or 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.

UploadBegin Event (SecureBlackbox_FTPServer Class)

The server fires this event to notify the application about the start of a file upload operation.

Object Oriented Interface

public function fireUploadBegin($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 46, array($this, 'fireUploadBegin'));

Parameter List

 'connectionid'
 'path'

Remarks

Use this event to get notified about the beginning of a file upload operation. The file that is about to be uploaded is specified via the Path property.

UploadEnd Event (SecureBlackbox_FTPServer Class)

Reports the completion of the upload operation.

Object Oriented Interface

public function fireUploadEnd($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 47, array($this, 'fireUploadEnd'));

Parameter List

 'connectionid'
 'path'

Remarks

Use this event to receive notifications about completion of file upload operations.

UploadFile Event (SecureBlackbox_FTPServer Class)

An override for a file upload initiation operation.

Object Oriented Interface

public function fireUploadFile($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 48, array($this, 'fireUploadFile'));

Parameter List

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

Remarks

The class fires this event to let the application perform an overridden file upload initiation operation.

This event only fires if Action = fraCustom was passed back from BeforeUploadFile event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

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

This event will be followed by a number of WriteFile calls, passing the file data to your code, followed by a single TransferCompleted call.

Set OperationStatus to one of the following values:

UploadProgress Event (SecureBlackbox_FTPServer Class)

Reports the progress of an active upload operation.

Object Oriented Interface

public function fireUploadProgress($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 49, array($this, 'fireUploadProgress'));

Parameter List

 'connectionid'
 'path'
 'progress'
 'total'

Remarks

Subscribe to this event to be notified about the progress of an active upload operation.

The Path parameter specifies the path to the file being uploaded, and Progress and Total reflect the operation progress. The Total parameter may be set to -1 if the size of the uploaded file is not known.

WriteFile Event (SecureBlackbox_FTPServer Class)

Hands a piece of file data to the application.

Object Oriented Interface

public function fireWriteFile($param);

Procedural Interface

secureblackbox_ftpserver_register_callback($res, 50, array($this, 'fireWriteFile'));

Parameter List

 'connectionid'
 'operationstatus'

Remarks

The class fires this event repeatedly during an overridden upload operation to pass file 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 file 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 (FTPServer 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.

FTPServer Config Settings

Base Config Settings

Trappable Errors (FTPServer Class)

FTPServer Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
	1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
	1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
	1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
	1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) 
	18874368   Unsupported file operation (SB_ERROR_FTP_UNSUPPORTED_FILEOPERATION)