FTPClient Class

Properties   Methods   Events   Config Settings   Errors  

The FTPClient class provides client-side functionality for FTP and FTPS protocols.

Class Name

SecureBlackbox_FTPClient

Procedural Interface

 secureblackbox_ftpclient_open();
 secureblackbox_ftpclient_close($res);
 secureblackbox_ftpclient_register_callback($res, $id, $function);
 secureblackbox_ftpclient_get_last_error($res);
 secureblackbox_ftpclient_get_last_error_code($res);
 secureblackbox_ftpclient_set($res, $id, $index, $value);
 secureblackbox_ftpclient_get($res, $id, $index);
 secureblackbox_ftpclient_do_abort($res);
 secureblackbox_ftpclient_do_acct($res, $acctinfo);
 secureblackbox_ftpclient_do_appendbytes($res, $bytes, $remotefile);
 secureblackbox_ftpclient_do_appendfile($res, $localfile, $remotefile);
 secureblackbox_ftpclient_do_changedir($res, $remotedir);
 secureblackbox_ftpclient_do_clearcommandchannel($res, $gracefulsslclosure);
 secureblackbox_ftpclient_do_config($res, $configurationstring);
 secureblackbox_ftpclient_do_connect($res, $address, $port);
 secureblackbox_ftpclient_do_deletedir($res, $remotedir);
 secureblackbox_ftpclient_do_deletefile($res, $remotefile);
 secureblackbox_ftpclient_do_direxists($res, $remotedir);
 secureblackbox_ftpclient_do_disconnect($res);
 secureblackbox_ftpclient_do_doaction($res, $actionid, $actionparams);
 secureblackbox_ftpclient_do_downloadbytes($res, $remotefile);
 secureblackbox_ftpclient_do_downloadfile($res, $remotefile, $localfile);
 secureblackbox_ftpclient_do_downloadfiles($res, $remotepath, $localdir);
 secureblackbox_ftpclient_do_fileexists($res, $remotefile);
 secureblackbox_ftpclient_do_getcurrentdir($res);
 secureblackbox_ftpclient_do_getfilesize($res, $remotefile);
 secureblackbox_ftpclient_do_listdir($res, $includefiles, $includedirectories);
 secureblackbox_ftpclient_do_makedir($res, $remotedir);
 secureblackbox_ftpclient_do_noop($res);
 secureblackbox_ftpclient_do_rename($res, $sourcefile, $destfile);
 secureblackbox_ftpclient_do_sendcommand($res, $command);
 secureblackbox_ftpclient_do_uploadbytes($res, $bytes, $remotefile);
 secureblackbox_ftpclient_do_uploadfile($res, $localfile, $remotefile);
 secureblackbox_ftpclient_do_uploadfiles($res, $localpath, $remotedir);

Remarks

FTPClient provides client-side support for the FTP (File Transfer Protocol) and FTPS (FTP-over-SSL) protocols. The FTPS protocol allows you to securely perform file transfer operations with a remote server over Transport Layer Security (TLS).

Note: TLS is a successor to the now deprecated SSL protocol, although the latter abbreviation is still widely used.

FTPClient is typically used in the following scenario:

• Setting up the connection parameters
• Connecting to the server and signing in
• Performing file transfer operations
• Closing the connection

Setting up the parameters

When working with FTP or FTP-over-TLS service you will often need to tune up several classes of settings:

• Login credentials: these can be tuned up via the Username and Password properties.
• TLS settings: these includes the TLS mode: explicit, implicit, or no TLS. You must get this setting right; otherwise you may not be able to connect. Use TLSSettings property to adjust this setting.
• If your server requires you to authenticate with a certificate, you can provide one via the ClientChain property.
• FTPClient validates the server certificate against the local security settings. If your server uses a custom or non-public PKI, you may need to provide the required trust anchors and CA certificates via the TrustedCertificates and KnownCertificates collections.
• FTP protocol includes its own set of settings, such as PassiveMode, EncryptDataChannel, or AdjustPasvAddress. These may be configured on this stage, or later into the connection.
• In some network environments, you may also need to make adjustments to SocketSettings and Proxy.

Connecting to the server and signing in

Call Connect to open the connection to the server. The component will use the provided credentials to sign you in automatically.

Performing file transfer operations

FTPClient offers the full set of FTP operations. These include file uploads (UploadFile or UploadBytes), file downloads (DownloadFile, DownloadBytes), and directory operations (ListDir, MakeDir).

Note that unlike SFTP, FTP only supports one transfer operation at a time. An ongoing operation should be completed or aborted before a new one can be started.

Closing the connection

Use Disconnect to close the FTP connection.

Useful info

During its work FTPClient communicates back via events. Progress event fires periodically during the transfer operation to let you know of the operation progress. ControlSend and ControlReceive report the protocol communication log. FileOperation and FileOperationResult report the start and completion of an individual transfer operation within a multi-file transfer call (such as UploadFiles).

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.

AccountInfo Property (SecureBlackbox_FTPClient Class)

Parameters for the ACCT command.

Object Oriented Interface

public function getAccountInfo();


public function setAccountInfo($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 1 );


secureblackbox_ftpclient_set($res, 1, $value );

Default Value

''

Remarks

Specifies the parameter for ACCT command. If AccountInfo is set, the client automatically sends ACCT command to the server during authentication.

Data Type

String

AdjustPasvAddress Property (SecureBlackbox_FTPClient Class)

Enables or disables automatic adjustment of passive-mode addresses.

Object Oriented Interface

public function getAdjustPasvAddress();


public function setAdjustPasvAddress($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 2 );


secureblackbox_ftpclient_set($res, 2, $value );

Default Value

true

Remarks

Occasional NAT'ed servers misbehave by returning local IP addresses in their PASV mode offers, which are not reachable from the outer network. Set this property to true to make the class enforce data connections to the same address as the control connection uses.

Note that sometimes (typically, with multi-faced FTP services aka FTP Clouds) you may need to disable this property to make the transfers work right.

Data Type

Boolean

BlockedCertCount Property (SecureBlackbox_FTPClient Class)

The number of records in the BlockedCert arrays.

Object Oriented Interface

public function getBlockedCertCount();


public function setBlockedCertCount($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 3 );


secureblackbox_ftpclient_set($res, 3, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• BlockedCertBytes
• BlockedCertHandle

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

This property is not available at design time.

Data Type

Integer

BlockedCertBytes Property (SecureBlackbox_FTPClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getBlockedCertBytes($blockedcertindex);

Procedural Interface

secureblackbox_ftpclient_get($res, 4 , $blockedcertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

BlockedCertHandle Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getBlockedCertHandle($blockedcertindex);


public function setBlockedCertHandle($blockedcertindex, $value);

Procedural Interface

secureblackbox_ftpclient_get($res, 11 , $blockedcertindex);


secureblackbox_ftpclient_set($res, 11, $value , $blockedcertindex);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

ClientCertCount Property (SecureBlackbox_FTPClient Class)

The number of records in the ClientCert arrays.

Object Oriented Interface

public function getClientCertCount();


public function setClientCertCount($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 38 );


secureblackbox_ftpclient_set($res, 38, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ClientCertBytes
• ClientCertHandle

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

This property is not available at design time.

Data Type

Integer

ClientCertBytes Property (SecureBlackbox_FTPClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getClientCertBytes($clientcertindex);

Procedural Interface

secureblackbox_ftpclient_get($res, 39 , $clientcertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

ClientCertHandle Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getClientCertHandle($clientcertindex);


public function setClientCertHandle($clientcertindex, $value);

Procedural Interface

secureblackbox_ftpclient_get($res, 46 , $clientcertindex);


secureblackbox_ftpclient_set($res, 46, $value , $clientcertindex);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

Connected Property (SecureBlackbox_FTPClient Class)

Indicates whether the class is connected to the server.

Object Oriented Interface

public function getConnected();

Procedural Interface

secureblackbox_ftpclient_get($res, 73 );

Default Value

false

Remarks

Use this property to check if the connection to server is active.

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

Data Type

Boolean

ControlChannelLog Property (SecureBlackbox_FTPClient Class)

Contains the control channel log of the FTP session.

Object Oriented Interface

public function getControlChannelLog();

Procedural Interface

secureblackbox_ftpclient_get($res, 74 );

Default Value

''

Remarks

Use this property to access the FTP protocol log (client commands followed by server responses).

This property is read-only.

Data Type

String

CtlConnInfoAEADCipher Property (SecureBlackbox_FTPClient Class)

Indicates whether the encryption algorithm used is an AEAD cipher.

Object Oriented Interface

public function getCtlConnInfoAEADCipher();

Procedural Interface

secureblackbox_ftpclient_get($res, 75 );

Default Value

false

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

This property is read-only.

Data Type

Boolean

CtlConnInfoChainValidationDetails Property (SecureBlackbox_FTPClient Class)

The details of a certificate chain validation outcome.

Object Oriented Interface

public function getCtlConnInfoChainValidationDetails();

Procedural Interface

secureblackbox_ftpclient_get($res, 76 );

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

CtlConnInfoChainValidationResult Property (SecureBlackbox_FTPClient Class)

The outcome of a certificate chain validation routine.

Object Oriented Interface

public function getCtlConnInfoChainValidationResult();

Procedural Interface

secureblackbox_ftpclient_get($res, 77 );

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

CtlConnInfoCiphersuite Property (SecureBlackbox_FTPClient Class)

The cipher suite employed by this connection.

Object Oriented Interface

public function getCtlConnInfoCiphersuite();

Procedural Interface

secureblackbox_ftpclient_get($res, 78 );

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.

Data Type

String

CtlConnInfoClientAuthenticated Property (SecureBlackbox_FTPClient Class)

Specifies whether client authentication was performed during this connection.

Object Oriented Interface

public function getCtlConnInfoClientAuthenticated();

Procedural Interface

secureblackbox_ftpclient_get($res, 79 );

Default Value

false

Remarks

Specifies whether client authentication was performed during this connection.

This property is read-only.

Data Type

Boolean

CtlConnInfoClientAuthRequested Property (SecureBlackbox_FTPClient Class)

Specifies whether client authentication was requested during this connection.

Object Oriented Interface

public function getCtlConnInfoClientAuthRequested();

Procedural Interface

secureblackbox_ftpclient_get($res, 80 );

Default Value

false

Remarks

Specifies whether client authentication was requested during this connection.

This property is read-only.

Data Type

Boolean

CtlConnInfoConnectionEstablished Property (SecureBlackbox_FTPClient Class)

Indicates whether the connection has been established fully.

Object Oriented Interface

public function getCtlConnInfoConnectionEstablished();

Procedural Interface

secureblackbox_ftpclient_get($res, 81 );

Default Value

false

Remarks

Indicates whether the connection has been established fully.

This property is read-only.

Data Type

Boolean

CtlConnInfoConnectionID Property (SecureBlackbox_FTPClient Class)

The unique identifier assigned to this connection.

Object Oriented Interface

public function getCtlConnInfoConnectionID();

Procedural Interface

secureblackbox_ftpclient_get($res, 82 );

Remarks

The unique identifier assigned to this connection.

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

Data Type

Byte Array

CtlConnInfoDigestAlgorithm Property (SecureBlackbox_FTPClient Class)

The digest algorithm used in a TLS-enabled connection.

Object Oriented Interface

public function getCtlConnInfoDigestAlgorithm();

Procedural Interface

secureblackbox_ftpclient_get($res, 83 );

Default Value

''

Remarks

The digest algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

String

CtlConnInfoEncryptionAlgorithm Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getCtlConnInfoEncryptionAlgorithm();

Procedural Interface

secureblackbox_ftpclient_get($res, 84 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

CtlConnInfoExportable Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getCtlConnInfoExportable();

Procedural Interface

secureblackbox_ftpclient_get($res, 85 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

CtlConnInfoKeyExchangeAlgorithm Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getCtlConnInfoKeyExchangeAlgorithm();

Procedural Interface

secureblackbox_ftpclient_get($res, 86 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

CtlConnInfoKeyExchangeKeyBits Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getCtlConnInfoKeyExchangeKeyBits();

Procedural Interface

secureblackbox_ftpclient_get($res, 87 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

CtlConnInfoNamedECCurve Property (SecureBlackbox_FTPClient Class)

The elliptic curve used in this connection.

Object Oriented Interface

public function getCtlConnInfoNamedECCurve();

Procedural Interface

secureblackbox_ftpclient_get($res, 88 );

Default Value

''

Remarks

The elliptic curve used in this connection.

This property is read-only.

Data Type

String

CtlConnInfoPFSCipher Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getCtlConnInfoPFSCipher();

Procedural Interface

secureblackbox_ftpclient_get($res, 89 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

CtlConnInfoPreSharedIdentityHint Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getCtlConnInfoPreSharedIdentityHint();

Procedural Interface

secureblackbox_ftpclient_get($res, 90 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

CtlConnInfoPublicKeyBits Property (SecureBlackbox_FTPClient Class)

The length of the public key.

Object Oriented Interface

public function getCtlConnInfoPublicKeyBits();

Procedural Interface

secureblackbox_ftpclient_get($res, 91 );

Default Value

0

Remarks

The length of the public key.

This property is read-only.

Data Type

Integer

CtlConnInfoResumedSession Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getCtlConnInfoResumedSession();

Procedural Interface

secureblackbox_ftpclient_get($res, 92 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

CtlConnInfoSecureConnection Property (SecureBlackbox_FTPClient Class)

Indicates whether TLS or SSL is enabled for this connection.

Object Oriented Interface

public function getCtlConnInfoSecureConnection();

Procedural Interface

secureblackbox_ftpclient_get($res, 93 );

Default Value

false

Remarks

Indicates whether TLS or SSL is enabled for this connection.

This property is read-only.

Data Type

Boolean

CtlConnInfoServerAuthenticated Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getCtlConnInfoServerAuthenticated();

Procedural Interface

secureblackbox_ftpclient_get($res, 94 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

CtlConnInfoSignatureAlgorithm Property (SecureBlackbox_FTPClient Class)

The signature algorithm used in a TLS handshake.

Object Oriented Interface

public function getCtlConnInfoSignatureAlgorithm();

Procedural Interface

secureblackbox_ftpclient_get($res, 95 );

Default Value

''

Remarks

The signature algorithm used in a TLS handshake.

This property is read-only.

Data Type

String

CtlConnInfoSymmetricBlockSize Property (SecureBlackbox_FTPClient Class)

The block size of the symmetric algorithm used.

Object Oriented Interface

public function getCtlConnInfoSymmetricBlockSize();

Procedural Interface

secureblackbox_ftpclient_get($res, 96 );

Default Value

0

Remarks

The block size of the symmetric algorithm used.

This property is read-only.

Data Type

Integer

CtlConnInfoSymmetricKeyBits Property (SecureBlackbox_FTPClient Class)

The key length of the symmetric algorithm used.

Object Oriented Interface

public function getCtlConnInfoSymmetricKeyBits();

Procedural Interface

secureblackbox_ftpclient_get($res, 97 );

Default Value

0

Remarks

The key length of the symmetric algorithm used.

This property is read-only.

Data Type

Integer

CtlConnInfoTotalBytesReceived Property (SecureBlackbox_FTPClient Class)

The total number of bytes received over this connection.

Object Oriented Interface

public function getCtlConnInfoTotalBytesReceived();

Procedural Interface

secureblackbox_ftpclient_get($res, 98 );

Default Value

0

Remarks

The total number of bytes received over this connection.

This property is read-only.

Data Type

Long64

CtlConnInfoTotalBytesSent Property (SecureBlackbox_FTPClient Class)

The total number of bytes sent over this connection.

Object Oriented Interface

public function getCtlConnInfoTotalBytesSent();

Procedural Interface

secureblackbox_ftpclient_get($res, 99 );

Default Value

0

Remarks

The total number of bytes sent over this connection.

This property is read-only.

Data Type

Long64

CtlConnInfoValidationLog Property (SecureBlackbox_FTPClient Class)

Contains the server certificate's chain validation log.

Object Oriented Interface

public function getCtlConnInfoValidationLog();

Procedural Interface

secureblackbox_ftpclient_get($res, 100 );

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.

Data Type

String

CtlConnInfoVersion Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getCtlConnInfoVersion();

Procedural Interface

secureblackbox_ftpclient_get($res, 101 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

CurrListEntryEntryFormat Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getCurrListEntryEntryFormat();

Procedural Interface

secureblackbox_ftpclient_get($res, 102 );

Default Value

0

Remarks

The file listing format:

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

Data Type

Integer

CurrListEntryFileDate Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getCurrListEntryFileDate();

Procedural Interface

secureblackbox_ftpclient_get($res, 103 );

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 read-only and not available at design time.

Data Type

String

CurrListEntryFileType Property (SecureBlackbox_FTPClient 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 getCurrListEntryFileType();

Procedural Interface

secureblackbox_ftpclient_get($res, 104 );

Default Value

0

Remarks

The type of the entry:

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

Data Type

Integer

CurrListEntryHandle Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getCurrListEntryHandle();

Procedural Interface

secureblackbox_ftpclient_get($res, 105 );

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 read-only and not available at design time.

Data Type

Long64

CurrListEntryName Property (SecureBlackbox_FTPClient Class)

The file or directory name.

Object Oriented Interface

public function getCurrListEntryName();

Procedural Interface

secureblackbox_ftpclient_get($res, 106 );

Default Value

''

Remarks

The file or directory name.

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

Data Type

String

CurrListEntryPath Property (SecureBlackbox_FTPClient Class)

The full path to the file or directory.

Object Oriented Interface

public function getCurrListEntryPath();

Procedural Interface

secureblackbox_ftpclient_get($res, 107 );

Default Value

''

Remarks

The full path to the file or directory.

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

Data Type

String

CurrListEntryRawData Property (SecureBlackbox_FTPClient Class)

The unparsed entry as returned by the server.

Object Oriented Interface

public function getCurrListEntryRawData();

Procedural Interface

secureblackbox_ftpclient_get($res, 108 );

Default Value

''

Remarks

The unparsed entry as returned by the server.

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

Data Type

String

CurrListEntrySize Property (SecureBlackbox_FTPClient Class)

File size in bytes.

Object Oriented Interface

public function getCurrListEntrySize();

Procedural Interface

secureblackbox_ftpclient_get($res, 109 );

Default Value

0

Remarks

File size in bytes.

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

Data Type

Long64

DataConnInfoAEADCipher Property (SecureBlackbox_FTPClient Class)

Indicates whether the encryption algorithm used is an AEAD cipher.

Object Oriented Interface

public function getDataConnInfoAEADCipher();

Procedural Interface

secureblackbox_ftpclient_get($res, 110 );

Default Value

false

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

This property is read-only.

Data Type

Boolean

DataConnInfoChainValidationDetails Property (SecureBlackbox_FTPClient Class)

The details of a certificate chain validation outcome.

Object Oriented Interface

public function getDataConnInfoChainValidationDetails();

Procedural Interface

secureblackbox_ftpclient_get($res, 111 );

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

DataConnInfoChainValidationResult Property (SecureBlackbox_FTPClient Class)

The outcome of a certificate chain validation routine.

Object Oriented Interface

public function getDataConnInfoChainValidationResult();

Procedural Interface

secureblackbox_ftpclient_get($res, 112 );

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

DataConnInfoCiphersuite Property (SecureBlackbox_FTPClient Class)

The cipher suite employed by this connection.

Object Oriented Interface

public function getDataConnInfoCiphersuite();

Procedural Interface

secureblackbox_ftpclient_get($res, 113 );

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.

Data Type

String

DataConnInfoClientAuthenticated Property (SecureBlackbox_FTPClient Class)

Specifies whether client authentication was performed during this connection.

Object Oriented Interface

public function getDataConnInfoClientAuthenticated();

Procedural Interface

secureblackbox_ftpclient_get($res, 114 );

Default Value

false

Remarks

Specifies whether client authentication was performed during this connection.

This property is read-only.

Data Type

Boolean

DataConnInfoClientAuthRequested Property (SecureBlackbox_FTPClient Class)

Specifies whether client authentication was requested during this connection.

Object Oriented Interface

public function getDataConnInfoClientAuthRequested();

Procedural Interface

secureblackbox_ftpclient_get($res, 115 );

Default Value

false

Remarks

Specifies whether client authentication was requested during this connection.

This property is read-only.

Data Type

Boolean

DataConnInfoConnectionEstablished Property (SecureBlackbox_FTPClient Class)

Indicates whether the connection has been established fully.

Object Oriented Interface

public function getDataConnInfoConnectionEstablished();

Procedural Interface

secureblackbox_ftpclient_get($res, 116 );

Default Value

false

Remarks

Indicates whether the connection has been established fully.

This property is read-only.

Data Type

Boolean

DataConnInfoConnectionID Property (SecureBlackbox_FTPClient Class)

The unique identifier assigned to this connection.

Object Oriented Interface

public function getDataConnInfoConnectionID();

Procedural Interface

secureblackbox_ftpclient_get($res, 117 );

Remarks

The unique identifier assigned to this connection.

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

Data Type

Byte Array

DataConnInfoDigestAlgorithm Property (SecureBlackbox_FTPClient Class)

The digest algorithm used in a TLS-enabled connection.

Object Oriented Interface

public function getDataConnInfoDigestAlgorithm();

Procedural Interface

secureblackbox_ftpclient_get($res, 118 );

Default Value

''

Remarks

The digest algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

String

DataConnInfoEncryptionAlgorithm Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getDataConnInfoEncryptionAlgorithm();

Procedural Interface

secureblackbox_ftpclient_get($res, 119 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

DataConnInfoExportable Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getDataConnInfoExportable();

Procedural Interface

secureblackbox_ftpclient_get($res, 120 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

DataConnInfoKeyExchangeAlgorithm Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getDataConnInfoKeyExchangeAlgorithm();

Procedural Interface

secureblackbox_ftpclient_get($res, 121 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

DataConnInfoKeyExchangeKeyBits Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getDataConnInfoKeyExchangeKeyBits();

Procedural Interface

secureblackbox_ftpclient_get($res, 122 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

DataConnInfoNamedECCurve Property (SecureBlackbox_FTPClient Class)

The elliptic curve used in this connection.

Object Oriented Interface

public function getDataConnInfoNamedECCurve();

Procedural Interface

secureblackbox_ftpclient_get($res, 123 );

Default Value

''

Remarks

The elliptic curve used in this connection.

This property is read-only.

Data Type

String

DataConnInfoPFSCipher Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getDataConnInfoPFSCipher();

Procedural Interface

secureblackbox_ftpclient_get($res, 124 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

DataConnInfoPreSharedIdentityHint Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getDataConnInfoPreSharedIdentityHint();

Procedural Interface

secureblackbox_ftpclient_get($res, 125 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

DataConnInfoPublicKeyBits Property (SecureBlackbox_FTPClient Class)

The length of the public key.

Object Oriented Interface

public function getDataConnInfoPublicKeyBits();

Procedural Interface

secureblackbox_ftpclient_get($res, 126 );

Default Value

0

Remarks

The length of the public key.

This property is read-only.

Data Type

Integer

DataConnInfoResumedSession Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getDataConnInfoResumedSession();

Procedural Interface

secureblackbox_ftpclient_get($res, 127 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

DataConnInfoSecureConnection Property (SecureBlackbox_FTPClient Class)

Indicates whether TLS or SSL is enabled for this connection.

Object Oriented Interface

public function getDataConnInfoSecureConnection();

Procedural Interface

secureblackbox_ftpclient_get($res, 128 );

Default Value

false

Remarks

Indicates whether TLS or SSL is enabled for this connection.

This property is read-only.

Data Type

Boolean

DataConnInfoServerAuthenticated Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getDataConnInfoServerAuthenticated();

Procedural Interface

secureblackbox_ftpclient_get($res, 129 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

DataConnInfoSignatureAlgorithm Property (SecureBlackbox_FTPClient Class)

The signature algorithm used in a TLS handshake.

Object Oriented Interface

public function getDataConnInfoSignatureAlgorithm();

Procedural Interface

secureblackbox_ftpclient_get($res, 130 );

Default Value

''

Remarks

The signature algorithm used in a TLS handshake.

This property is read-only.

Data Type

String

DataConnInfoSymmetricBlockSize Property (SecureBlackbox_FTPClient Class)

The block size of the symmetric algorithm used.

Object Oriented Interface

public function getDataConnInfoSymmetricBlockSize();

Procedural Interface

secureblackbox_ftpclient_get($res, 131 );

Default Value

0

Remarks

The block size of the symmetric algorithm used.

This property is read-only.

Data Type

Integer

DataConnInfoSymmetricKeyBits Property (SecureBlackbox_FTPClient Class)

The key length of the symmetric algorithm used.

Object Oriented Interface

public function getDataConnInfoSymmetricKeyBits();

Procedural Interface

secureblackbox_ftpclient_get($res, 132 );

Default Value

0

Remarks

The key length of the symmetric algorithm used.

This property is read-only.

Data Type

Integer

DataConnInfoTotalBytesReceived Property (SecureBlackbox_FTPClient Class)

The total number of bytes received over this connection.

Object Oriented Interface

public function getDataConnInfoTotalBytesReceived();

Procedural Interface

secureblackbox_ftpclient_get($res, 133 );

Default Value

0

Remarks

The total number of bytes received over this connection.

This property is read-only.

Data Type

Long64

DataConnInfoTotalBytesSent Property (SecureBlackbox_FTPClient Class)

The total number of bytes sent over this connection.

Object Oriented Interface

public function getDataConnInfoTotalBytesSent();

Procedural Interface

secureblackbox_ftpclient_get($res, 134 );

Default Value

0

Remarks

The total number of bytes sent over this connection.

This property is read-only.

Data Type

Long64

DataConnInfoValidationLog Property (SecureBlackbox_FTPClient Class)

Contains the server certificate's chain validation log.

Object Oriented Interface

public function getDataConnInfoValidationLog();

Procedural Interface

secureblackbox_ftpclient_get($res, 135 );

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.

Data Type

String

DataConnInfoVersion Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getDataConnInfoVersion();

Procedural Interface

secureblackbox_ftpclient_get($res, 136 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

EncryptDataChannel Property (SecureBlackbox_FTPClient Class)

Enables or disables data channel encryption.

Object Oriented Interface

public function getEncryptDataChannel();


public function setEncryptDataChannel($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 137 );


secureblackbox_ftpclient_set($res, 137, $value );

Default Value

true

Remarks

Use this property to enable or disable data channel encryption. This property should be configured before Connect method is called.

Data Type

Boolean

ExternalCryptoAsyncDocumentID Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getExternalCryptoAsyncDocumentID();


public function setExternalCryptoAsyncDocumentID($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 138 );


secureblackbox_ftpclient_set($res, 138, $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_FTPClient Class)

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

Object Oriented Interface

public function getExternalCryptoCustomParams();


public function setExternalCryptoCustomParams($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 139 );


secureblackbox_ftpclient_set($res, 139, $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_FTPClient 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_ftpclient_get($res, 140 );


secureblackbox_ftpclient_set($res, 140, $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_FTPClient 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_ftpclient_get($res, 141 );


secureblackbox_ftpclient_set($res, 141, $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_FTPClient Class)

Specifies the request's signature hash algorithm.

Object Oriented Interface

public function getExternalCryptoHashAlgorithm();


public function setExternalCryptoHashAlgorithm($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 142 );


secureblackbox_ftpclient_set($res, 142, $value );

Default Value

'SHA256'

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SecureBlackbox_FTPClient 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_ftpclient_get($res, 143 );


secureblackbox_ftpclient_set($res, 143, $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_FTPClient Class)

The pre-shared key used for DC request authentication.

Object Oriented Interface

public function getExternalCryptoKeySecret();


public function setExternalCryptoKeySecret($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 144 );


secureblackbox_ftpclient_set($res, 144, $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_FTPClient Class)

Specifies the asynchronous signing method.

Object Oriented Interface

public function getExternalCryptoMethod();


public function setExternalCryptoMethod($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 145 );


secureblackbox_ftpclient_set($res, 145, $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_FTPClient Class)

Specifies the external cryptography mode.

Object Oriented Interface

public function getExternalCryptoMode();


public function setExternalCryptoMode($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 146 );


secureblackbox_ftpclient_set($res, 146, $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_FTPClient 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_ftpclient_get($res, 147 );


secureblackbox_ftpclient_set($res, 147, $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_FTPClient Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 148 );


secureblackbox_ftpclient_set($res, 148, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

KnownCertCount Property (SecureBlackbox_FTPClient Class)

The number of records in the KnownCert arrays.

Object Oriented Interface

public function getKnownCertCount();


public function setKnownCertCount($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 149 );


secureblackbox_ftpclient_set($res, 149, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCertBytes
• KnownCertHandle

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

This property is not available at design time.

Data Type

Integer

KnownCertBytes Property (SecureBlackbox_FTPClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getKnownCertBytes($knowncertindex);

Procedural Interface

secureblackbox_ftpclient_get($res, 150 , $knowncertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

KnownCertHandle Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getKnownCertHandle($knowncertindex);


public function setKnownCertHandle($knowncertindex, $value);

Procedural Interface

secureblackbox_ftpclient_get($res, 157 , $knowncertindex);


secureblackbox_ftpclient_set($res, 157, $value , $knowncertindex);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

KnownCRLCount Property (SecureBlackbox_FTPClient Class)

The number of records in the KnownCRL arrays.

Object Oriented Interface

public function getKnownCRLCount();


public function setKnownCRLCount($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 184 );


secureblackbox_ftpclient_set($res, 184, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCRLBytes
• KnownCRLHandle

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

This property is not available at design time.

Data Type

Integer

KnownCRLBytes Property (SecureBlackbox_FTPClient Class)

Returns the raw CRL data in DER format.

Object Oriented Interface

public function getKnownCRLBytes($knowncrlindex);

Procedural Interface

secureblackbox_ftpclient_get($res, 185 , $knowncrlindex);

Remarks

Returns the raw CRL data in DER format.

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

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

Data Type

Byte Array

KnownCRLHandle Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getKnownCRLHandle($knowncrlindex);


public function setKnownCRLHandle($knowncrlindex, $value);

Procedural Interface

secureblackbox_ftpclient_get($res, 188 , $knowncrlindex);


secureblackbox_ftpclient_set($res, 188, $value , $knowncrlindex);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

KnownOCSPCount Property (SecureBlackbox_FTPClient Class)

The number of records in the KnownOCSP arrays.

Object Oriented Interface

public function getKnownOCSPCount();


public function setKnownOCSPCount($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 196 );


secureblackbox_ftpclient_set($res, 196, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownOCSPBytes
• KnownOCSPHandle

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

This property is not available at design time.

Data Type

Integer

KnownOCSPBytes Property (SecureBlackbox_FTPClient Class)

A buffer containing the raw OCSP response data.

Object Oriented Interface

public function getKnownOCSPBytes($knownocspindex);

Procedural Interface

secureblackbox_ftpclient_get($res, 197 , $knownocspindex);

Remarks

A buffer containing the raw OCSP response data.

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

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

Data Type

Byte Array

KnownOCSPHandle Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getKnownOCSPHandle($knownocspindex);


public function setKnownOCSPHandle($knownocspindex, $value);

Procedural Interface

secureblackbox_ftpclient_get($res, 199 , $knownocspindex);


secureblackbox_ftpclient_set($res, 199, $value , $knownocspindex);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

ModeZ Property (SecureBlackbox_FTPClient Class)

Switches on data compression.

Object Oriented Interface

public function getModeZ();


public function setModeZ($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 204 );


secureblackbox_ftpclient_set($res, 204, $value );

Default Value

true

Remarks

Switches the in-flight data compression on/off.

Data Type

Boolean

PassiveMode Property (SecureBlackbox_FTPClient Class)

Enables or disables passive transfer mode.

Object Oriented Interface

public function getPassiveMode();


public function setPassiveMode($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 205 );


secureblackbox_ftpclient_set($res, 205, $value );

Default Value

true

Remarks

The transfer mode (active or passive) regulates which party is responsible for opening a listening port for data connections. Where passive mode is used, the FTP server is responsible for listening for data connections. In active mode, the listening port is opened by the client.

In today's Internet of firewalls it is a de-facto standard to use the passive mode for FTP transfers.

Data Type

Boolean

Password Property (SecureBlackbox_FTPClient Class)

The connecting user's authentication password.

Object Oriented Interface

public function getPassword();


public function setPassword($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 206 );


secureblackbox_ftpclient_set($res, 206, $value );

Default Value

''

Remarks

Assign the user's authentication password to this property. Use Username for username/login.

Data Type

String

ProxyAddress Property (SecureBlackbox_FTPClient Class)

The IP address of the proxy server.

Object Oriented Interface

public function getProxyAddress();


public function setProxyAddress($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 207 );


secureblackbox_ftpclient_set($res, 207, $value );

Default Value

''

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (SecureBlackbox_FTPClient Class)

The authentication type used by the proxy server.

Object Oriented Interface

public function getProxyAuthentication();


public function setProxyAuthentication($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 208 );


secureblackbox_ftpclient_set($res, 208, $value );

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxyPassword Property (SecureBlackbox_FTPClient Class)

The password to authenticate to the proxy server.

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 209 );


secureblackbox_ftpclient_set($res, 209, $value );

Default Value

''

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (SecureBlackbox_FTPClient Class)

The port on the proxy server to connect to.

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 210 );


secureblackbox_ftpclient_set($res, 210, $value );

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (SecureBlackbox_FTPClient Class)

The type of the proxy server.

Object Oriented Interface

public function getProxyProxyType();


public function setProxyProxyType($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 211 );


secureblackbox_ftpclient_set($res, 211, $value );

Default Value

0

Remarks

The type of the proxy server.

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

Data Type

Integer

ProxyRequestHeaders Property (SecureBlackbox_FTPClient Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Object Oriented Interface

public function getProxyRequestHeaders();


public function setProxyRequestHeaders($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 212 );


secureblackbox_ftpclient_set($res, 212, $value );

Default Value

''

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getProxyResponseBody();


public function setProxyResponseBody($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 213 );


secureblackbox_ftpclient_set($res, 213, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyResponseHeaders Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getProxyResponseHeaders();


public function setProxyResponseHeaders($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 214 );


secureblackbox_ftpclient_set($res, 214, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyUseIPv6 Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getProxyUseIPv6();


public function setProxyUseIPv6($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 215 );


secureblackbox_ftpclient_set($res, 215, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyUseProxy Property (SecureBlackbox_FTPClient Class)

Enables or disables proxy-driven connection.

Object Oriented Interface

public function getProxyUseProxy();


public function setProxyUseProxy($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 216 );


secureblackbox_ftpclient_set($res, 216, $value );

Default Value

false

Remarks

Enables or disables proxy-driven connection.

Data Type

Boolean

ProxyUsername Property (SecureBlackbox_FTPClient Class)

Specifies the username credential for proxy authentication.

Object Oriented Interface

public function getProxyUsername();


public function setProxyUsername($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 217 );


secureblackbox_ftpclient_set($res, 217, $value );

Default Value

''

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

RestartAt Property (SecureBlackbox_FTPClient Class)

The offset to restart the file transfer from.

Object Oriented Interface

public function getRestartAt();


public function setRestartAt($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 218 );


secureblackbox_ftpclient_set($res, 218, $value );

Default Value

-1

Remarks

If non-zero, tells the component to restart the file transfer operation at the specified position, rather than transfer the file in full.

Data Type

Long64

ServerCertCount Property (SecureBlackbox_FTPClient Class)

The number of records in the ServerCert arrays.

Object Oriented Interface

public function getServerCertCount();

Procedural Interface

secureblackbox_ftpclient_get($res, 219 );

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

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

Data Type

Integer

ServerCertBytes Property (SecureBlackbox_FTPClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getServerCertBytes($servercertindex);

Procedural Interface

secureblackbox_ftpclient_get($res, 220 , $servercertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

ServerCertCAKeyID Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getServerCertCAKeyID($servercertindex);

Procedural Interface

secureblackbox_ftpclient_get($res, 222 , $servercertindex);

Remarks

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

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

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

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

Data Type

Byte Array

ServerCertFingerprint Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getServerCertFingerprint($servercertindex);

Procedural Interface

secureblackbox_ftpclient_get($res, 225 , $servercertindex);

Remarks

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

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

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

Data Type

Byte Array

ServerCertHandle Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getServerCertHandle($servercertindex);

Procedural Interface

secureblackbox_ftpclient_get($res, 227 , $servercertindex);

Default Value

0

Remarks

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

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

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

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

Data Type

Long64

ServerCertIssuer Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getServerCertIssuer($servercertindex);

Procedural Interface

secureblackbox_ftpclient_get($res, 229 , $servercertindex);

Default Value

''

Remarks

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

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

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

Data Type

String

ServerCertIssuerRDN Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getServerCertIssuerRDN($servercertindex);

Procedural Interface

secureblackbox_ftpclient_get($res, 230 , $servercertindex);

Default Value

''

Remarks

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

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

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

Data Type

String

ServerCertKeyAlgorithm Property (SecureBlackbox_FTPClient Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getServerCertKeyAlgorithm($servercertindex);

Procedural Interface

secureblackbox_ftpclient_get($res, 231 , $servercertindex);

Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

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

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

Data Type

String

ServerCertKeyBits Property (SecureBlackbox_FTPClient Class)

Returns the length of the public key.

Object Oriented Interface

public function getServerCertKeyBits($servercertindex);

Procedural Interface

secureblackbox_ftpclient_get($res, 232 , $servercertindex);

Default Value

0

Remarks

Returns the length of the public key.

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

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

Data Type

Integer

ServerCertKeyFingerprint Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getServerCertKeyFingerprint($servercertindex);

Procedural Interface

secureblackbox_ftpclient_get($res, 233 , $servercertindex);

Remarks

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

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

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

Data Type

Byte Array

ServerCertKeyUsage Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getServerCertKeyUsage($servercertindex);

Procedural Interface

secureblackbox_ftpclient_get($res, 234 , $servercertindex);

Default Value

0

Remarks

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

This value is a bit mask of the following values:

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

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

Data Type

Integer

ServerCertPublicKeyBytes Property (SecureBlackbox_FTPClient Class)

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getServerCertPublicKeyBytes($servercertindex);

Procedural Interface

secureblackbox_ftpclient_get($res, 243 , $servercertindex);

Remarks

Contains the certificate's public key in DER format.

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

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

Data Type

Byte Array

ServerCertSelfSigned Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getServerCertSelfSigned($servercertindex);

Procedural Interface

secureblackbox_ftpclient_get($res, 245 , $servercertindex);

Default Value

false

Remarks

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

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

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

Data Type

Boolean

ServerCertSerialNumber Property (SecureBlackbox_FTPClient Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getServerCertSerialNumber($servercertindex);

Procedural Interface

secureblackbox_ftpclient_get($res, 246 , $servercertindex);

Remarks

Returns the certificate's serial number.

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

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

Data Type

Byte Array

ServerCertSigAlgorithm Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getServerCertSigAlgorithm($servercertindex);

Procedural Interface

secureblackbox_ftpclient_get($res, 247 , $servercertindex);

Default Value

''

Remarks

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

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

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

Data Type

String

ServerCertSubject Property (SecureBlackbox_FTPClient Class)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Object Oriented Interface

public function getServerCertSubject($servercertindex);

Procedural Interface

secureblackbox_ftpclient_get($res, 248 , $servercertindex);

Default Value

''

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

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

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

Data Type

String

ServerCertSubjectKeyID Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getServerCertSubjectKeyID($servercertindex);

Procedural Interface

secureblackbox_ftpclient_get($res, 250 , $servercertindex);

Remarks

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

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

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

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

Data Type

Byte Array

ServerCertSubjectRDN Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getServerCertSubjectRDN($servercertindex);

Procedural Interface

secureblackbox_ftpclient_get($res, 251 , $servercertindex);

Default Value

''

Remarks

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

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

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

Data Type

String

ServerCertValidFrom Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getServerCertValidFrom($servercertindex);

Procedural Interface

secureblackbox_ftpclient_get($res, 252 , $servercertindex);

Default Value

''

Remarks

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

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

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

Data Type

String

ServerCertValidTo Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getServerCertValidTo($servercertindex);

Procedural Interface

secureblackbox_ftpclient_get($res, 253 , $servercertindex);

Default Value

''

Remarks

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

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

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

Data Type

String

SocketDNSMode Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getSocketDNSMode();


public function setSocketDNSMode($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 254 );


secureblackbox_ftpclient_set($res, 254, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketDNSPort Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getSocketDNSPort();


public function setSocketDNSPort($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 255 );


secureblackbox_ftpclient_set($res, 255, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketDNSQueryTimeout Property (SecureBlackbox_FTPClient Class)

The timeout (in milliseconds) for each DNS query.

Object Oriented Interface

public function getSocketDNSQueryTimeout();


public function setSocketDNSQueryTimeout($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 256 );


secureblackbox_ftpclient_set($res, 256, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketDNSServers Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getSocketDNSServers();


public function setSocketDNSServers($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 257 );


secureblackbox_ftpclient_set($res, 257, $value );

Default Value

''

Remarks

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

Data Type

String

SocketDNSTotalTimeout Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getSocketDNSTotalTimeout();


public function setSocketDNSTotalTimeout($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 258 );


secureblackbox_ftpclient_set($res, 258, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketIncomingSpeedLimit Property (SecureBlackbox_FTPClient 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_ftpclient_get($res, 259 );


secureblackbox_ftpclient_set($res, 259, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (SecureBlackbox_FTPClient Class)

The local network interface to bind the socket to.

Object Oriented Interface

public function getSocketLocalAddress();


public function setSocketLocalAddress($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 260 );


secureblackbox_ftpclient_set($res, 260, $value );

Default Value

''

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SecureBlackbox_FTPClient Class)

The local port number to bind the socket to.

Object Oriented Interface

public function getSocketLocalPort();


public function setSocketLocalPort($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 261 );


secureblackbox_ftpclient_set($res, 261, $value );

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SecureBlackbox_FTPClient 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_ftpclient_get($res, 262 );


secureblackbox_ftpclient_set($res, 262, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (SecureBlackbox_FTPClient 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_ftpclient_get($res, 263 );


secureblackbox_ftpclient_set($res, 263, $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_FTPClient Class)

Enables or disables IP protocol version 6.

Object Oriented Interface

public function getSocketUseIPv6();


public function setSocketUseIPv6($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 264 );


secureblackbox_ftpclient_set($res, 264, $value );

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

TLSAutoValidateCertificates Property (SecureBlackbox_FTPClient 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_ftpclient_get($res, 265 );


secureblackbox_ftpclient_set($res, 265, $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_FTPClient Class)

Selects the base configuration for the TLS settings.

Object Oriented Interface

public function getTLSBaseConfiguration();


public function setTLSBaseConfiguration($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 266 );


secureblackbox_ftpclient_set($res, 266, $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_FTPClient Class)

A list of ciphersuites separated with commas or semicolons.

Object Oriented Interface

public function getTLSCiphersuites();


public function setTLSCiphersuites($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 267 );


secureblackbox_ftpclient_set($res, 267, $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_FTPClient Class)

Defines the elliptic curves to enable.

Object Oriented Interface

public function getTLSECCurves();


public function setTLSECCurves($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 268 );


secureblackbox_ftpclient_set($res, 268, $value );

Default Value

''

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (SecureBlackbox_FTPClient Class)

Provides access to TLS extensions.

Object Oriented Interface

public function getTLSExtensions();


public function setTLSExtensions($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 269 );


secureblackbox_ftpclient_set($res, 269, $value );

Default Value

''

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (SecureBlackbox_FTPClient 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_ftpclient_get($res, 270 );


secureblackbox_ftpclient_set($res, 270, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSPreSharedIdentity Property (SecureBlackbox_FTPClient 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_ftpclient_get($res, 271 );


secureblackbox_ftpclient_set($res, 271, $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_FTPClient 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_ftpclient_get($res, 272 );


secureblackbox_ftpclient_set($res, 272, $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_FTPClient Class)

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

Object Oriented Interface

public function getTLSPreSharedKeyCiphersuite();


public function setTLSPreSharedKeyCiphersuite($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 273 );


secureblackbox_ftpclient_set($res, 273, $value );

Default Value

''

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (SecureBlackbox_FTPClient Class)

Selects the renegotiation attack prevention mechanism.

Object Oriented Interface

public function getTLSRenegotiationAttackPreventionMode();


public function setTLSRenegotiationAttackPreventionMode($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 274 );


secureblackbox_ftpclient_set($res, 274, $value );

Default Value

0

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getTLSRevocationCheck();


public function setTLSRevocationCheck($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 275 );


secureblackbox_ftpclient_set($res, 275, $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_FTPClient 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_ftpclient_get($res, 276 );


secureblackbox_ftpclient_set($res, 276, $value );

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (SecureBlackbox_FTPClient Class)

Specifies the TLS mode to use.

Object Oriented Interface

public function getTLSTLSMode();


public function setTLSTLSMode($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 277 );


secureblackbox_ftpclient_set($res, 277, $value );

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (SecureBlackbox_FTPClient 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_ftpclient_get($res, 278 );


secureblackbox_ftpclient_set($res, 278, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (SecureBlackbox_FTPClient Class)

Enables or disables the TLS session resumption capability.

Object Oriented Interface

public function getTLSUseSessionResumption();


public function setTLSUseSessionResumption($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 279 );


secureblackbox_ftpclient_set($res, 279, $value );

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (SecureBlackbox_FTPClient Class)

The SSL/TLS versions to enable by default.

Object Oriented Interface

public function getTLSVersions();


public function setTLSVersions($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 280 );


secureblackbox_ftpclient_set($res, 280, $value );

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

TransferType Property (SecureBlackbox_FTPClient Class)

Sets the file transfer mode.

Object Oriented Interface

public function getTransferType();


public function setTransferType($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 281 );


secureblackbox_ftpclient_set($res, 281, $value );

Default Value

1

Remarks

Use this property to switch between binary and text transfer modes.

Data Type

Integer

TrustedCertCount Property (SecureBlackbox_FTPClient Class)

The number of records in the TrustedCert arrays.

Object Oriented Interface

public function getTrustedCertCount();


public function setTrustedCertCount($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 282 );


secureblackbox_ftpclient_set($res, 282, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• TrustedCertBytes
• TrustedCertHandle

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

This property is not available at design time.

Data Type

Integer

TrustedCertBytes Property (SecureBlackbox_FTPClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTrustedCertBytes($trustedcertindex);

Procedural Interface

secureblackbox_ftpclient_get($res, 283 , $trustedcertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

TrustedCertHandle Property (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function getTrustedCertHandle($trustedcertindex);


public function setTrustedCertHandle($trustedcertindex, $value);

Procedural Interface

secureblackbox_ftpclient_get($res, 290 , $trustedcertindex);


secureblackbox_ftpclient_set($res, 290, $value , $trustedcertindex);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

Username Property (SecureBlackbox_FTPClient Class)

The connecting user's username (login name).

Object Oriented Interface

public function getUsername();


public function setUsername($value);

Procedural Interface

secureblackbox_ftpclient_get($res, 317 );


secureblackbox_ftpclient_set($res, 317, $value );

Default Value

''

Remarks

Assign the user's login name to this property. Use Password to provide the password.

Data Type

String

Abort Method (SecureBlackbox_FTPClient Class)

Aborts the previous FTP service command and any associated transfer of data.

Object Oriented Interface

public function doAbort();

Procedural Interface

secureblackbox_ftpclient_do_abort($res);

Remarks

Use this method to abort the previous FTP service command and any associated data transfer.

Acct Method (SecureBlackbox_FTPClient Class)

Sends an Account command.

Object Oriented Interface

public function doAcct($acctinfo);

Procedural Interface

secureblackbox_ftpclient_do_acct($res, $acctinfo);

Remarks

Some servers require the ACCT command to be sent after signing in to grant access to specific server resources.

Reply codes sometimes allow to differentiate the handling of ACCT command:

• when account information is required for login, the response to a successful PASSword command is reply code 332;
• if account information is NOT required for login, the reply to a successful PASSword command is 230;
• if account information is needed for a command issued later in the dialogue, the server should return a 332 or 532 reply depending on whether it stores (pending receipt of the ACCounT command) or discards the command, respectively.

AppendBytes Method (SecureBlackbox_FTPClient Class)

Appends a byte array to a server-side file.

Object Oriented Interface

public function doAppendBytes($bytes, $remotefile);

Procedural Interface

secureblackbox_ftpclient_do_appendbytes($res, $bytes, $remotefile);

Remarks

Use this method to append Bytes to RemoteFile on the server.

AppendFile Method (SecureBlackbox_FTPClient Class)

Uploads a file to the server.

Object Oriented Interface

public function doAppendFile($localfile, $remotefile);

Procedural Interface

secureblackbox_ftpclient_do_appendfile($res, $localfile, $remotefile);

Remarks

Use this method to upload LocalFile or its part to RemoteFile on the server.

ChangeDir Method (SecureBlackbox_FTPClient Class)

Changes the current directory.

Object Oriented Interface

public function doChangeDir($remotedir);

Procedural Interface

secureblackbox_ftpclient_do_changedir($res, $remotedir);

Remarks

Call this method to change the current server directory to RemoteDir.

ClearCommandChannel Method (SecureBlackbox_FTPClient Class)

Sends CCC (Clear Command Channel) command to the server.

Object Oriented Interface

public function doClearCommandChannel($gracefulsslclosure);

Procedural Interface

secureblackbox_ftpclient_do_clearcommandchannel($res, $gracefulsslclosure);

Remarks

Use this method to send a CCC command. CCC clears command channel encryption state, turning off TLS encryption.

Some servers expect this command to allow for the control channel to be properly handled by NATs.

Config Method (SecureBlackbox_FTPClient Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

Connect Method (SecureBlackbox_FTPClient Class)

Connects to the FTP server.

Object Oriented Interface

public function doConnect($address, $port);

Procedural Interface

secureblackbox_ftpclient_do_connect($res, $address, $port);

Remarks

Call this method to connect to the FTP server residing at Address:Port.

The component will connect to the server using the connection settings provided. If the connection is successful, it will also authenticate using the provided Username and Password.

DeleteDir Method (SecureBlackbox_FTPClient Class)

Deletes a directory on the server.

Object Oriented Interface

public function doDeleteDir($remotedir);

Procedural Interface

secureblackbox_ftpclient_do_deletedir($res, $remotedir);

Remarks

This method sends an RMD command to the server to request deletion of a remote directory.

DeleteFile Method (SecureBlackbox_FTPClient Class)

Deletes a file on the server.

Object Oriented Interface

public function doDeleteFile($remotefile);

Procedural Interface

secureblackbox_ftpclient_do_deletefile($res, $remotefile);

Remarks

This method sends a DELE command to the server to request deletion of a remote file.

DirExists Method (SecureBlackbox_FTPClient Class)

Checks if a directory exists on the server.

Object Oriented Interface

public function doDirExists($remotedir);

Procedural Interface

secureblackbox_ftpclient_do_direxists($res, $remotedir);

Remarks

Use this method to check if the RemoteDir exists on the server.

The test is performed by attempting to change the current directory to RemoteDir, and checking the response code returned by the server.

Note that this method will return false if the directory does exist but is not accessible for the client (e.g. due to a permission issue).

Disconnect Method (SecureBlackbox_FTPClient Class)

Disconnects from the server.

Object Oriented Interface

public function doDisconnect();

Procedural Interface

secureblackbox_ftpclient_do_disconnect($res);

Remarks

Call this method to disconnect from the server.

DoAction Method (SecureBlackbox_FTPClient Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

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

DownloadBytes Method (SecureBlackbox_FTPClient Class)

Downloads a file from the server into an array of bytes.

Object Oriented Interface

public function doDownloadBytes($remotefile);

Procedural Interface

secureblackbox_ftpclient_do_downloadbytes($res, $remotefile);

Remarks

Use this method to download RemoteFile into a byte array.

DownloadFile Method (SecureBlackbox_FTPClient Class)

Downloads a file from the server.

Object Oriented Interface

public function doDownloadFile($remotefile, $localfile);

Procedural Interface

secureblackbox_ftpclient_do_downloadfile($res, $remotefile, $localfile);

Remarks

Use this method to download RemoteFile into LocalFile.

DownloadFiles Method (SecureBlackbox_FTPClient Class)

Downloads multiple files from the server.

Object Oriented Interface

public function doDownloadFiles($remotepath, $localdir);

Procedural Interface

secureblackbox_ftpclient_do_downloadfiles($res, $remotepath, $localdir);

Remarks

Use this method do download a collection of files from the server.

RemotePath can contain a simple mask, a set of masks, or a regular expression. All the files that match the provided rule will be downloaded to LocalDir.

FileExists Method (SecureBlackbox_FTPClient Class)

Checks if a file exists on the server.

Object Oriented Interface

public function doFileExists($remotefile);

Procedural Interface

secureblackbox_ftpclient_do_fileexists($res, $remotefile);

Remarks

Use this method to check if RemoteFile exists in the current remote directory. This method attempts to detect file existence using SIZE and MLST commands first, and falls back to LIST command if they are not available.

Please note that this command only looks for the file in the current directory. To check for existence of a file in a different directory, change to it with ChangeDir command first, then call this method.

GetCurrentDir Method (SecureBlackbox_FTPClient Class)

Returns the server-side current directory.

Object Oriented Interface

public function doGetCurrentDir();

Procedural Interface

secureblackbox_ftpclient_do_getcurrentdir($res);

Remarks

Use this method to find out the current directory on the server.

GetFileSize Method (SecureBlackbox_FTPClient Class)

Returns the size of a remote file.

Object Oriented Interface

public function doGetFileSize($remotefile);

Procedural Interface

secureblackbox_ftpclient_do_getfilesize($res, $remotefile);

Remarks

Use this method to retrieve the size of a remote file. This method attempts to use SIZE and MLST commands if available, and resorts to LIST command otherwise.

Please note that this command only looks for the file in the current directory. To check for existence of a file in a different directory, change to it with ChangeDir command first, then call this method.

ListDir Method (SecureBlackbox_FTPClient Class)

Lists the contents of a remote directory.

Object Oriented Interface

public function doListDir($includefiles, $includedirectories);

Procedural Interface

secureblackbox_ftpclient_do_listdir($res, $includefiles, $includedirectories);

Remarks

Use the IncludeFiles and IncludeDirectories parameters to tune up the output. The output of IncludeFiles also includes symbolic links.

This method returns a human-readable string containing the requested list. It also fires ListEntry for each entry in the list, propagating its details in CurrentListEntry.

This method uses some heuristics internally by choosing the most appropriate listing method among MLSD, NLST, and LIST.

MakeDir Method (SecureBlackbox_FTPClient Class)

Creates a new directory on the server.

Object Oriented Interface

public function doMakeDir($remotedir);

Procedural Interface

secureblackbox_ftpclient_do_makedir($res, $remotedir);

Remarks

This method creates a directory. The path provided via RemoteDir can either be absolute or relative.

Depending on the server, the directory structure up to the innermost element might need to exist.

Noop Method (SecureBlackbox_FTPClient Class)

Sends a NOOP command to the server.

Object Oriented Interface

public function doNoop();

Procedural Interface

secureblackbox_ftpclient_do_noop($res);

Remarks

Call this method to send a NOOP (No Operation) command to the server.

Rename Method (SecureBlackbox_FTPClient Class)

Renames a file.

Object Oriented Interface

public function doRename($sourcefile, $destfile);

Procedural Interface

secureblackbox_ftpclient_do_rename($res, $sourcefile, $destfile);

Remarks

Use this method to rename a server-side SourceFile to DestFile.

SendCommand Method (SecureBlackbox_FTPClient Class)

Sends a custom command to the server.

Object Oriented Interface

public function doSendCommand($command);

Procedural Interface

secureblackbox_ftpclient_do_sendcommand($res, $command);

Remarks

This method sends an arbitrary command to the server and returns the status code received. Use it to send custom or non-standard commands, or tune up the session flow as required by the server.

UploadBytes Method (SecureBlackbox_FTPClient Class)

Uploads a byte array to the server.

Object Oriented Interface

public function doUploadBytes($bytes, $remotefile);

Procedural Interface

secureblackbox_ftpclient_do_uploadbytes($res, $bytes, $remotefile);

Remarks

Use this method to upload Bytes or its part to RemoteFile on the server.

UploadFile Method (SecureBlackbox_FTPClient Class)

Uploads a file to the server.

Object Oriented Interface

public function doUploadFile($localfile, $remotefile);

Procedural Interface

secureblackbox_ftpclient_do_uploadfile($res, $localfile, $remotefile);

Remarks

Use this method to upload LocalFile or its part to RemoteFile on the server.

UploadFiles Method (SecureBlackbox_FTPClient Class)

Uploads multiple files to the server.

Object Oriented Interface

public function doUploadFiles($localpath, $remotedir);

Procedural Interface

secureblackbox_ftpclient_do_uploadfiles($res, $localpath, $remotedir);

Remarks

This method uploads all the files that match the LocalPath criteria to RemoteDir directory on the server. LocalPath accepts a simple mask, a set of masks, or a regular expression.

For each file being uploaded a pair of FileOperation and FileOperationResult events are invoked.

ControlReceive Event (SecureBlackbox_FTPClient Class)

Fires when data is received via the control channel.

Object Oriented Interface

public function fireControlReceive($param);

Procedural Interface

secureblackbox_ftpclient_register_callback($res, 1, array($this, 'fireControlReceive'));

Parameter List

 'textline'

Remarks

TextLine contains the data that was received, which would typically contain a reply to a command (e.g. 200 Command OK).

ControlSend Event (SecureBlackbox_FTPClient Class)

Fires when data is about to be set via the control channel.

Object Oriented Interface

public function fireControlSend($param);

Procedural Interface

secureblackbox_ftpclient_register_callback($res, 2, array($this, 'fireControlSend'));

Parameter List

 'textline'

Remarks

TextLine contains the data to be sent, which would typically contain a command issued by the client (e.g. CWD dir).

Error Event (SecureBlackbox_FTPClient Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_ftpclient_register_callback($res, 3, 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_FTPClient Class)

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

Object Oriented Interface

public function fireExternalSign($param);

Procedural Interface

secureblackbox_ftpclient_register_callback($res, 4, array($this, 'fireExternalSign'));

Parameter List

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

Remarks

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

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

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

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

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

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

FileOperation Event (SecureBlackbox_FTPClient Class)

Marks the start of a file transfer.

Object Oriented Interface

public function fireFileOperation($param);

Procedural Interface

secureblackbox_ftpclient_register_callback($res, 5, array($this, 'fireFileOperation'));

Parameter List

 'operation'
 'remotepath'
 'localpath'
 'skip'
 'cancel'

Remarks

The class fires this event from DownloadFiles and UploadFiles to notify the application that the transfer of the next file in the list is about to start.

Use the Skip parameter to skip this particular file, or Cancel to cancel the whole multi-file operation.

Operations:

FileOperationResult Event (SecureBlackbox_FTPClient Class)

Reports the result of a file transfer operation.

Object Oriented Interface

public function fireFileOperationResult($param);

Procedural Interface

secureblackbox_ftpclient_register_callback($res, 6, array($this, 'fireFileOperationResult'));

Parameter List

 'operation'
 'remotepath'
 'localpath'
 'errorcode'
 'comment'
 'cancel'

Remarks

The class fires this event from DownloadFiles and UploadFiles to notify the application of the completion of a file operation.

ErrorCode and Comment provide the details of the operation. Use the Cancel parameter to terminate the whole multi-file operation if needed.

Operations:

ListEntry Event (SecureBlackbox_FTPClient Class)

Reports a single entry from the requested directory listing.

Object Oriented Interface

public function fireListEntry($param);

Procedural Interface

secureblackbox_ftpclient_register_callback($res, 7, array($this, 'fireListEntry'));

Parameter List

 'filename'

Remarks

FileName contains the filename of the reported entry. Read the details of the entry from CurrentListEntry property.

Notification Event (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_ftpclient_register_callback($res, 8, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

Remarks

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

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

Progress Event (SecureBlackbox_FTPClient Class)

Reports the data transfer progress.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

secureblackbox_ftpclient_register_callback($res, 9, array($this, 'fireProgress'));

Parameter List

 'total'
 'current'
 'cancel'

Remarks

This event fires periodically during a file transfer operation to report its progress.

Use the Cancel parameter to terminate the transfer if needed.

TextDataLine Event (SecureBlackbox_FTPClient Class)

Reports next transferred data line.

Object Oriented Interface

public function fireTextDataLine($param);

Procedural Interface

secureblackbox_ftpclient_register_callback($res, 10, array($this, 'fireTextDataLine'));

Parameter List

 'textline'

Remarks

The class fires this event in series when transferring a file in ASCII mode to report each line being transferred.

TLSCertNeeded Event (SecureBlackbox_FTPClient Class)

Fires when a remote TLS party requests a client certificate.

Object Oriented Interface

public function fireTLSCertNeeded($param);

Procedural Interface

secureblackbox_ftpclient_register_callback($res, 11, array($this, 'fireTLSCertNeeded'));

Parameter List

 'host'
 'canames'

Remarks

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

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

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

TLSCertValidate Event (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function fireTLSCertValidate($param);

Procedural Interface

secureblackbox_ftpclient_register_callback($res, 12, array($this, 'fireTLSCertValidate'));

Parameter List

 'serverhost'
 'serverip'
 'accept'

Remarks

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

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

TLSEstablished Event (SecureBlackbox_FTPClient Class)

Fires when a TLS handshake with Host successfully completes.

Object Oriented Interface

public function fireTLSEstablished($param);

Procedural Interface

secureblackbox_ftpclient_register_callback($res, 13, array($this, 'fireTLSEstablished'));

Parameter List

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

Remarks

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

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

TLSHandshake Event (SecureBlackbox_FTPClient Class)

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

Object Oriented Interface

public function fireTLSHandshake($param);

Procedural Interface

secureblackbox_ftpclient_register_callback($res, 14, array($this, 'fireTLSHandshake'));

Parameter List

 'host'
 'abort'

Remarks

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

TLSPSK Event (SecureBlackbox_FTPClient Class)

Notifies the application about the PSK key exchange.

Object Oriented Interface

public function fireTLSPSK($param);

Procedural Interface

secureblackbox_ftpclient_register_callback($res, 15, array($this, 'fireTLSPSK'));

Parameter List

 'host'
 'hint'

Remarks

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

TLSShutdown Event (SecureBlackbox_FTPClient Class)

Reports the graceful closure of a TLS connection.

Object Oriented Interface

public function fireTLSShutdown($param);

Procedural Interface

secureblackbox_ftpclient_register_callback($res, 16, array($this, 'fireTLSShutdown'));

Parameter List

 'host'

Remarks

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

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

FTPClient Config Settings

Base Config Settings

Trappable Errors (FTPClient Class)

FTPClient 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)