SFTPClient Class

Properties   Methods   Events   Config Settings   Errors  

The SFTPClient class provides client-side functionality for SFTP (Secure File Transfer Protocol).

Class Name

SecureBlackbox_SFTPClient

Procedural Interface

 secureblackbox_sftpclient_open();
 secureblackbox_sftpclient_close($res);
 secureblackbox_sftpclient_register_callback($res, $id, $function);
 secureblackbox_sftpclient_get_last_error($res);
 secureblackbox_sftpclient_get_last_error_code($res);
 secureblackbox_sftpclient_set($res, $id, $index, $value);
 secureblackbox_sftpclient_get($res, $id, $index);
 secureblackbox_sftpclient_do_absolutepath($res, $remotepath);
 secureblackbox_sftpclient_do_changedir($res, $remotedir);
 secureblackbox_sftpclient_do_config($res, $configurationstring);
 secureblackbox_sftpclient_do_connect($res, $address, $port);
 secureblackbox_sftpclient_do_createlink($res, $linkpath, $targetpath, $hardlink);
 secureblackbox_sftpclient_do_deletedir($res, $remotedir);
 secureblackbox_sftpclient_do_deletefile($res, $remotefile);
 secureblackbox_sftpclient_do_deletefiles($res, $remotepath, $mask, $casesensitive, $recursive);
 secureblackbox_sftpclient_do_direxists($res, $remotedir);
 secureblackbox_sftpclient_do_disconnect($res);
 secureblackbox_sftpclient_do_doaction($res, $actionid, $actionparams);
 secureblackbox_sftpclient_do_downloadbytes($res, $remotefile);
 secureblackbox_sftpclient_do_downloadfile($res, $remotefile, $localfile);
 secureblackbox_sftpclient_do_downloadfiles($res, $remotepath, $localdir);
 secureblackbox_sftpclient_do_executesshcommand($res, $command);
 secureblackbox_sftpclient_do_extensioncmd($res, $extn, $databuffer);
 secureblackbox_sftpclient_do_fileexists($res, $remotefile);
 secureblackbox_sftpclient_do_getcurrentdir($res);
 secureblackbox_sftpclient_do_getfilesize($res, $remotefile);
 secureblackbox_sftpclient_do_listdir($res, $includefiles, $includedirectories);
 secureblackbox_sftpclient_do_makedir($res, $remotedir);
 secureblackbox_sftpclient_do_renamefile($res, $sourcefile, $destfile);
 secureblackbox_sftpclient_do_requestattributes($res, $remotepath, $followsymlinks);
 secureblackbox_sftpclient_do_setattributes($res, $remotepath, $attributes);
 secureblackbox_sftpclient_do_uploadbytes($res, $bytes, $remotefile);
 secureblackbox_sftpclient_do_uploadfile($res, $localfile, $remotefile);
 secureblackbox_sftpclient_do_uploadfiles($res, $localpath, $remotedir);

Remarks

SFTP is a file transfer subsystem that runs on top of secure shell (SSH) connection. This means that SFTP uses the whole strength of security provided by the SSH protocol, at the same time providing strong file transfer capabilities.

Please do keep in mind that there exist two protocols that offer similar secure file transfer features. SFTP works on top of SSH and normally uses port 22. FTPS works on top of TLS (or SSL) and normally uses ports 21 and 990. The protocols are very different, so please make sure you are after the right component. This component works with SFTP. Use the FTPClient component to connect to FTPS servers.

Below are the typical steps that let you integrate SFTPClient to your project:

• Set up your Username and Password. SSH uses mandatory client-side authentication, so in most cases you need to provide your username, your password, or, sometimes, your private key. Use Key property to provide your key, if needed.
• Be ready to handle server authentication, which is also mandatory in SSH. SSH operates a concept of a trusted keys file, where keys of known servers are stored. You can assign a path to your own trusted keys file to the TrustedKeysFile property. When a client receives a server key, it reports it to your code via its KnownKeyReceived or UnknownKeyReceived event, depending on whether the key was found in the trusted list. If you leave TrustedKeysFile empty, SFTPClient will only be able to fire the UnknownKeyReceived event, since there will be no known keys to report.
• If needed, customize Proxy parameters and SSHSettings.
• Consider interacting more with SFTPClient by subscribing to AuthAttempt, AuthFailed, and AuthSucceeded events to be notified about the client authentication progress.
• When you are ready to connect, call Connect, passing the details of the server as parameters. During the initial handshake, the following events will fire: UnknownKeyReceived (or KnownKeyReceived), and then one or more AuthAttempt, AuthFailed and AuthSucceeded.
• Upon completion of the Connect method, the component is ready for file operations. Use DownloadFile, UploadFile, ListDir, DeleteFile and other file transfer methods to work with the server file system.
• When you are done with your work, call Disconnect to close the connection.

Some SFTP servers, primarily older ones, may expose various transfer issues. If you come across a weird issue that you believe should not be happening (such as repeated connection closures in the middle of the transfer), please try adjusting the following properties:

• AutoAdjustTransferBlock to false,
• PipelineLength to 1,
• UploadBlockSize to 16384,
• DownloadBlockSize to 16384.

These adjustments will put SFTPClient in very conservative transfer setup. While this setup may be quite sluggish with modern servers, it should make SFTPClient interoperable with most older servers.

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.

AuthAttempts Property (SecureBlackbox_SFTPClient Class)

Specifies the number of SSH authentication attempts.

Object Oriented Interface

public function getAuthAttempts();


public function setAuthAttempts($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 1 );


secureblackbox_sftpclient_set($res, 1, $value );

Default Value

1

Remarks

Use this property to specify the number of authentication attempts to try. The AuthFailed event is fired for every failed attempt.

Data Type

Integer

AutoAdjustTransferBlock Property (SecureBlackbox_SFTPClient Class)

Specifies whether to adjust the send and receive buffer sizes automatically.

Object Oriented Interface

public function getAutoAdjustTransferBlock();


public function setAutoAdjustTransferBlock($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 2 );


secureblackbox_sftpclient_set($res, 2, $value );

Default Value

true

Remarks

Automatic transfer block size adjustment may be beneficial for maximizing interoperability and achieving the best transfer speeds.

Use DownloadBlockSize, UploadBlockSize, and PipelineLength properties to adjust the transfer settings manually.

Data Type

Boolean

Connected Property (SecureBlackbox_SFTPClient Class)

Indicates if the client is connected to the SFTP server.

Object Oriented Interface

public function getConnected();

Procedural Interface

secureblackbox_sftpclient_get($res, 3 );

Default Value

false

Remarks

Use this read-only property to check whether the client is connected to the server.

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

Data Type

Boolean

ConnInfoClientKeyAlgorithm Property (SecureBlackbox_SFTPClient Class)

Specifies the client's key algorithm.

Object Oriented Interface

public function getConnInfoClientKeyAlgorithm();

Procedural Interface

secureblackbox_sftpclient_get($res, 4 );

Default Value

''

Remarks

Specifies the client's key algorithm.

This property is read-only.

Data Type

String

ConnInfoClientKeyBits Property (SecureBlackbox_SFTPClient Class)

Specifies the length of the client's key.

Object Oriented Interface

public function getConnInfoClientKeyBits();

Procedural Interface

secureblackbox_sftpclient_get($res, 5 );

Default Value

0

Remarks

Specifies the length of the client's key.

This property is read-only.

Data Type

Integer

ConnInfoClientKeyFingerprint Property (SecureBlackbox_SFTPClient Class)

The fingerprint (hash value) of the client's public key.

Object Oriented Interface

public function getConnInfoClientKeyFingerprint();

Procedural Interface

secureblackbox_sftpclient_get($res, 6 );

Default Value

''

Remarks

The fingerprint (hash value) of the client's public key.

This property is read-only.

Data Type

String

ConnInfoCloseReason Property (SecureBlackbox_SFTPClient Class)

Contains the line sent by the server just before closing the connection.

Object Oriented Interface

public function getConnInfoCloseReason();

Procedural Interface

secureblackbox_sftpclient_get($res, 7 );

Default Value

''

Remarks

Contains the line sent by the server just before closing the connection. It might contain the error description if the connection was not closed gracefully.

This property is read-only.

Data Type

String

ConnInfoCompressionAlgorithmInbound Property (SecureBlackbox_SFTPClient Class)

Compression algorithm for the incoming traffic.

Object Oriented Interface

public function getConnInfoCompressionAlgorithmInbound();

Procedural Interface

secureblackbox_sftpclient_get($res, 8 );

Default Value

''

Remarks

Compression algorithm for the incoming traffic.

This property is read-only.

Data Type

String

ConnInfoCompressionAlgorithmOutbound Property (SecureBlackbox_SFTPClient Class)

Compression algorithm for the outgoing traffic.

Object Oriented Interface

public function getConnInfoCompressionAlgorithmOutbound();

Procedural Interface

secureblackbox_sftpclient_get($res, 9 );

Default Value

''

Remarks

Compression algorithm for the outgoing traffic.

This property is read-only.

Data Type

String

ConnInfoEncryptionAlgorithmInbound Property (SecureBlackbox_SFTPClient Class)

Encryption algorithm for the incoming traffic.

Object Oriented Interface

public function getConnInfoEncryptionAlgorithmInbound();

Procedural Interface

secureblackbox_sftpclient_get($res, 10 );

Default Value

''

Remarks

Encryption algorithm for the incoming traffic.

This property is read-only.

Data Type

String

ConnInfoEncryptionAlgorithmOutbound Property (SecureBlackbox_SFTPClient Class)

Encryption algorithm for the outgoing traffic.

Object Oriented Interface

public function getConnInfoEncryptionAlgorithmOutbound();

Procedural Interface

secureblackbox_sftpclient_get($res, 11 );

Default Value

''

Remarks

Encryption algorithm for the outgoing traffic.

This property is read-only.

Data Type

String

ConnInfoInboundEncryptionKeyBits Property (SecureBlackbox_SFTPClient Class)

Specifies the length of the key used to encrypt the incoming traffic.

Object Oriented Interface

public function getConnInfoInboundEncryptionKeyBits();

Procedural Interface

secureblackbox_sftpclient_get($res, 12 );

Default Value

0

Remarks

Specifies the length of the key used to encrypt the incoming traffic.

This property is read-only.

Data Type

Integer

ConnInfoKexAlgorithm Property (SecureBlackbox_SFTPClient Class)

The key exchange algorithm used during the SSH handshake.

Object Oriented Interface

public function getConnInfoKexAlgorithm();

Procedural Interface

secureblackbox_sftpclient_get($res, 13 );

Default Value

''

Remarks

The key exchange algorithm used during the SSH handshake.

This property is read-only.

Data Type

String

ConnInfoKexBits Property (SecureBlackbox_SFTPClient Class)

The number of bits used by the key exchange algorithm.

Object Oriented Interface

public function getConnInfoKexBits();

Procedural Interface

secureblackbox_sftpclient_get($res, 14 );

Default Value

0

Remarks

The number of bits used by the key exchange algorithm.

This property is read-only.

Data Type

Integer

ConnInfoKexLines Property (SecureBlackbox_SFTPClient Class)

The contents of the received KexInit packet.

Object Oriented Interface

public function getConnInfoKexLines();

Procedural Interface

secureblackbox_sftpclient_get($res, 15 );

Default Value

''

Remarks

The contents of the received KexInit packet.

KexInit packet contains the list of algorithms supported by the remote party.

This property is read-only.

Data Type

String

ConnInfoMacAlgorithmInbound Property (SecureBlackbox_SFTPClient Class)

MAC algorithm used for the incoming connection.

Object Oriented Interface

public function getConnInfoMacAlgorithmInbound();

Procedural Interface

secureblackbox_sftpclient_get($res, 16 );

Default Value

''

Remarks

MAC algorithm used for the incoming connection.

This property is read-only.

Data Type

String

ConnInfoMacAlgorithmOutbound Property (SecureBlackbox_SFTPClient Class)

MAC algorithm used for outbound connection.

Object Oriented Interface

public function getConnInfoMacAlgorithmOutbound();

Procedural Interface

secureblackbox_sftpclient_get($res, 17 );

Default Value

''

Remarks

MAC algorithm used for outbound connection.

This property is read-only.

Data Type

String

ConnInfoOutboundEncryptionKeyBits Property (SecureBlackbox_SFTPClient Class)

Specifies the length of the key used to encrypt the outgoing traffic.

Object Oriented Interface

public function getConnInfoOutboundEncryptionKeyBits();

Procedural Interface

secureblackbox_sftpclient_get($res, 18 );

Default Value

0

Remarks

Specifies the length of the key used to encrypt the outgoing traffic.

This property is read-only.

Data Type

Integer

ConnInfoPublicKeyAlgorithm Property (SecureBlackbox_SFTPClient Class)

Specifies the public key algorithm which was used during the SSH handshake.

Object Oriented Interface

public function getConnInfoPublicKeyAlgorithm();

Procedural Interface

secureblackbox_sftpclient_get($res, 19 );

Default Value

''

Remarks

Specifies the public key algorithm which was used during the SSH handshake.

This property is read-only.

Data Type

String

ConnInfoServerKeyBits Property (SecureBlackbox_SFTPClient Class)

Specifies the number of bits in the server's key.

Object Oriented Interface

public function getConnInfoServerKeyBits();

Procedural Interface

secureblackbox_sftpclient_get($res, 20 );

Default Value

0

Remarks

Specifies the number of bits in the server's key.

This property is read-only.

Data Type

Integer

ConnInfoServerKeyFingerprint Property (SecureBlackbox_SFTPClient Class)

The fingerprint (hash value) of the server's public key.

Object Oriented Interface

public function getConnInfoServerKeyFingerprint();

Procedural Interface

secureblackbox_sftpclient_get($res, 21 );

Default Value

''

Remarks

The fingerprint (hash value) of the server's public key.

This property is read-only.

Data Type

String

ConnInfoServerSoftwareName Property (SecureBlackbox_SFTPClient Class)

Returns the name of the SSH software running on the server side.

Object Oriented Interface

public function getConnInfoServerSoftwareName();

Procedural Interface

secureblackbox_sftpclient_get($res, 22 );

Default Value

''

Remarks

Returns the name of the SSH software running on the server side.

This property is read-only.

Data Type

String

ConnInfoTotalBytesReceived Property (SecureBlackbox_SFTPClient Class)

Returns the total number of bytes received over this connection.

Object Oriented Interface

public function getConnInfoTotalBytesReceived();

Procedural Interface

secureblackbox_sftpclient_get($res, 23 );

Default Value

0

Remarks

Returns the total number of bytes received over this connection.

This property is read-only.

Data Type

Long64

ConnInfoTotalBytesSent Property (SecureBlackbox_SFTPClient Class)

Returns the total number of bytes sent over this connection.

Object Oriented Interface

public function getConnInfoTotalBytesSent();

Procedural Interface

secureblackbox_sftpclient_get($res, 24 );

Default Value

0

Remarks

Returns the total number of bytes sent over this connection.

This property is read-only.

Data Type

Long64

ConnInfoVersion Property (SecureBlackbox_SFTPClient Class)

Specifies SSH protocol version.

Object Oriented Interface

public function getConnInfoVersion();

Procedural Interface

secureblackbox_sftpclient_get($res, 25 );

Default Value

2

Remarks

Specifies SSH protocol version.

This property is read-only.

Data Type

Integer

CurrListEntryATime Property (SecureBlackbox_SFTPClient Class)

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

Object Oriented Interface

public function getCurrListEntryATime();

Procedural Interface

secureblackbox_sftpclient_get($res, 26 );

Default Value

''

Remarks

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

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

Data Type

String

CurrListEntryCTime Property (SecureBlackbox_SFTPClient Class)

Contains this file's creation time, in UTC.

Object Oriented Interface

public function getCurrListEntryCTime();

Procedural Interface

secureblackbox_sftpclient_get($res, 27 );

Default Value

''

Remarks

Contains this file's creation time, in UTC.

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

Data Type

String

CurrListEntryDirectory Property (SecureBlackbox_SFTPClient Class)

Specifies whether this entry is a directory.

Object Oriented Interface

public function getCurrListEntryDirectory();

Procedural Interface

secureblackbox_sftpclient_get($res, 28 );

Default Value

false

Remarks

Specifies whether this entry is a directory.

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

Data Type

Boolean

CurrListEntryFileType Property (SecureBlackbox_SFTPClient Class)

Specifies the type of this entry, one of the following: cftFile 0 cftDirectory 1 cftSymblink 2 cftSpecial 3 cftUnknown 4 cftSocket 5 cftCharDevice 6 cftBlockDevice 7 cftFIFO 8 .

Object Oriented Interface

public function getCurrListEntryFileType();

Procedural Interface

secureblackbox_sftpclient_get($res, 29 );

Default Value

4

Remarks

Specifies the type of this entry, one of the following:

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

Data Type

Integer

CurrListEntryGroupExecute Property (SecureBlackbox_SFTPClient Class)

Controls file execution permission for the group users.

Object Oriented Interface

public function getCurrListEntryGroupExecute();

Procedural Interface

secureblackbox_sftpclient_get($res, 30 );

Default Value

false

Remarks

Controls file execution permission for the group users.

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

Data Type

Boolean

CurrListEntryGroupRead Property (SecureBlackbox_SFTPClient Class)

Controls file read permission for the group users.

Object Oriented Interface

public function getCurrListEntryGroupRead();

Procedural Interface

secureblackbox_sftpclient_get($res, 31 );

Default Value

false

Remarks

Controls file read permission for the group users.

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

Data Type

Boolean

CurrListEntryGroupWrite Property (SecureBlackbox_SFTPClient Class)

Controls file write permission for the group users.

Object Oriented Interface

public function getCurrListEntryGroupWrite();

Procedural Interface

secureblackbox_sftpclient_get($res, 32 );

Default Value

false

Remarks

Controls file write permission for the group users.

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

Data Type

Boolean

CurrListEntryHandle Property (SecureBlackbox_SFTPClient 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_sftpclient_get($res, 33 );

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

CurrListEntryLongName Property (SecureBlackbox_SFTPClient Class)

Contains the long name of the file (human-readable, ftp-like).

Object Oriented Interface

public function getCurrListEntryLongName();

Procedural Interface

secureblackbox_sftpclient_get($res, 34 );

Default Value

''

Remarks

Contains the long name of the file (human-readable, ftp-like).

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

Data Type

String

CurrListEntryMTime Property (SecureBlackbox_SFTPClient Class)

Specifies the last modification time, in UTC.

Object Oriented Interface

public function getCurrListEntryMTime();

Procedural Interface

secureblackbox_sftpclient_get($res, 35 );

Default Value

''

Remarks

Specifies the last modification time, in UTC.

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

Data Type

String

CurrListEntryName Property (SecureBlackbox_SFTPClient Class)

Specifies the file name.

Object Oriented Interface

public function getCurrListEntryName();

Procedural Interface

secureblackbox_sftpclient_get($res, 36 );

Default Value

''

Remarks

Specifies the file name.

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

Data Type

String

CurrListEntryOtherExecute Property (SecureBlackbox_SFTPClient Class)

Controls file execution permission for other users (users that are neither owners, nor belong to the same group).

Object Oriented Interface

public function getCurrListEntryOtherExecute();

Procedural Interface

secureblackbox_sftpclient_get($res, 37 );

Default Value

false

Remarks

Controls file execution permission for other users (users that are neither owners, nor belong to the same group).

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

Data Type

Boolean

CurrListEntryOtherRead Property (SecureBlackbox_SFTPClient Class)

Controls file read permission for other users (users that are neither owners, nor belong to the same group).

Object Oriented Interface

public function getCurrListEntryOtherRead();

Procedural Interface

secureblackbox_sftpclient_get($res, 38 );

Default Value

false

Remarks

Controls file read permission for other users (users that are neither owners, nor belong to the same group).

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

Data Type

Boolean

CurrListEntryOtherWrite Property (SecureBlackbox_SFTPClient Class)

Controls file write permission for other users (users that are neither owners, nor belong to the same group).

Object Oriented Interface

public function getCurrListEntryOtherWrite();

Procedural Interface

secureblackbox_sftpclient_get($res, 39 );

Default Value

false

Remarks

Controls file write permission for other users (users that are neither owners, nor belong to the same group).

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

Data Type

Boolean

CurrListEntryOwner Property (SecureBlackbox_SFTPClient Class)

Specifies the owner of the file/directory.

Object Oriented Interface

public function getCurrListEntryOwner();

Procedural Interface

secureblackbox_sftpclient_get($res, 40 );

Default Value

''

Remarks

Specifies the owner of the file/directory.

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

Data Type

String

CurrListEntryPath Property (SecureBlackbox_SFTPClient Class)

Contains the full path to the file.

Object Oriented Interface

public function getCurrListEntryPath();

Procedural Interface

secureblackbox_sftpclient_get($res, 41 );

Default Value

''

Remarks

Contains the full path to the file.

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

Data Type

String

CurrListEntrySize Property (SecureBlackbox_SFTPClient Class)

The size of the file in bytes.

Object Oriented Interface

public function getCurrListEntrySize();

Procedural Interface

secureblackbox_sftpclient_get($res, 42 );

Default Value

0

Remarks

The size of the file in bytes.

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

Data Type

Long64

CurrListEntryUserExecute Property (SecureBlackbox_SFTPClient Class)

Controls file execution permission for the file owner.

Object Oriented Interface

public function getCurrListEntryUserExecute();

Procedural Interface

secureblackbox_sftpclient_get($res, 43 );

Default Value

false

Remarks

Controls file execution permission for the file owner.

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

Data Type

Boolean

CurrListEntryUserRead Property (SecureBlackbox_SFTPClient Class)

Controls file read permission for the file owner.

Object Oriented Interface

public function getCurrListEntryUserRead();

Procedural Interface

secureblackbox_sftpclient_get($res, 44 );

Default Value

false

Remarks

Controls file read permission for the file owner.

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

Data Type

Boolean

CurrListEntryUserWrite Property (SecureBlackbox_SFTPClient Class)

Controls file write permission for the file owner.

Object Oriented Interface

public function getCurrListEntryUserWrite();

Procedural Interface

secureblackbox_sftpclient_get($res, 45 );

Default Value

false

Remarks

Controls file write permission for the file owner.

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

Data Type

Boolean

DownloadBlockSize Property (SecureBlackbox_SFTPClient Class)

The download block size in bytes.

Object Oriented Interface

public function getDownloadBlockSize();


public function setDownloadBlockSize($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 46 );


secureblackbox_sftpclient_set($res, 46, $value );

Default Value

65536

Remarks

Use this property to manually control the size of download blocks. Typically you will only need to adjust this property if the default transfer settings (AutoAdjustTransferBlock) don't work.

Data Type

Integer

ExternalCryptoAsyncDocumentID Property (SecureBlackbox_SFTPClient Class)

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

Object Oriented Interface

public function getExternalCryptoAsyncDocumentID();


public function setExternalCryptoAsyncDocumentID($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 47 );


secureblackbox_sftpclient_set($res, 47, $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 pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (SecureBlackbox_SFTPClient Class)

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

Object Oriented Interface

public function getExternalCryptoCustomParams();


public function setExternalCryptoCustomParams($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 48 );


secureblackbox_sftpclient_set($res, 48, $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_SFTPClient 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_sftpclient_get($res, 49 );


secureblackbox_sftpclient_set($res, 49, $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_SFTPClient 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_sftpclient_get($res, 50 );


secureblackbox_sftpclient_set($res, 50, $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 all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (SecureBlackbox_SFTPClient Class)

Specifies the request's signature hash algorithm.

Object Oriented Interface

public function getExternalCryptoHashAlgorithm();


public function setExternalCryptoHashAlgorithm($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 51 );


secureblackbox_sftpclient_set($res, 51, $value );

Default Value

'SHA256'

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SecureBlackbox_SFTPClient 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_sftpclient_get($res, 52 );


secureblackbox_sftpclient_set($res, 52, $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 extra protection layer for the protocol and diminishes the risk of 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_SFTPClient Class)

The pre-shared key used for DC request authentication.

Object Oriented Interface

public function getExternalCryptoKeySecret();


public function setExternalCryptoKeySecret($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 53 );


secureblackbox_sftpclient_set($res, 53, $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_SFTPClient Class)

Specifies the asynchronous signing method.

Object Oriented Interface

public function getExternalCryptoMethod();


public function setExternalCryptoMethod($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 54 );


secureblackbox_sftpclient_set($res, 54, $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_SFTPClient Class)

Specifies the external cryptography mode.

Object Oriented Interface

public function getExternalCryptoMode();


public function setExternalCryptoMode($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 55 );


secureblackbox_sftpclient_set($res, 55, $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_SFTPClient Class)

Provide 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_sftpclient_get($res, 56 );


secureblackbox_sftpclient_set($res, 56, $value );

Default Value

''

Remarks

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

Data Type

String

FIPSMode Property (SecureBlackbox_SFTPClient Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 57 );


secureblackbox_sftpclient_set($res, 57, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

ForceCompression Property (SecureBlackbox_SFTPClient Class)

Enforces compression for the SSH layer.

Object Oriented Interface

public function getForceCompression();


public function setForceCompression($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 58 );


secureblackbox_sftpclient_set($res, 58, $value );

Default Value

false

Remarks

Set this property before opening a connection to enforce compression of the SSH packets.

Data Type

Boolean

KeyFingerprintSHA1 Property (SecureBlackbox_SFTPClient Class)

Contains the SHA-1 fingerprint (hash) of the key.

Object Oriented Interface

public function getKeyFingerprintSHA1();

Procedural Interface

secureblackbox_sftpclient_get($res, 74 );

Default Value

''

Remarks

Contains the SHA-1 fingerprint (hash) of the key.

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

Data Type

String

KeyFingerprintSHA256 Property (SecureBlackbox_SFTPClient Class)

Contains the SHA-256 fingerprint (hash) of the key.

Object Oriented Interface

public function getKeyFingerprintSHA256();

Procedural Interface

secureblackbox_sftpclient_get($res, 75 );

Default Value

''

Remarks

Contains the SHA-256 fingerprint (hash) of the key.

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

Data Type

String

KeyHandle Property (SecureBlackbox_SFTPClient Class)

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

Object Oriented Interface

public function getKeyHandle();


public function setKeyHandle($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 76 );


secureblackbox_sftpclient_set($res, 76, $value );

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Long64

MaxSFTPVersion Property (SecureBlackbox_SFTPClient Class)

Higher SFTP version to support.

Object Oriented Interface

public function getMaxSFTPVersion();


public function setMaxSFTPVersion($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 91 );


secureblackbox_sftpclient_set($res, 91, $value );

Default Value

6

Remarks

MaxSFTPVersion and MinSFTPVersion properties control the range of SFTP protocol versions supported by this client.

Data Type

Integer

MinSFTPVersion Property (SecureBlackbox_SFTPClient Class)

Lower SFTP version to support.

Object Oriented Interface

public function getMinSFTPVersion();


public function setMinSFTPVersion($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 92 );


secureblackbox_sftpclient_set($res, 92, $value );

Default Value

0

Remarks

MaxSFTPVersion and MinSFTPVersion properties control the range of SFTP protocol versions to be supported by this client.

Data Type

Integer

Password Property (SecureBlackbox_SFTPClient Class)

Specifies user's authentication password.

Object Oriented Interface

public function getPassword();


public function setPassword($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 93 );


secureblackbox_sftpclient_set($res, 93, $value );

Default Value

''

Remarks

Use this property to provide an authentication password. This property is only applicable for password-based and keyboard-interactive authentication types.

Data Type

String

PipelineLength Property (SecureBlackbox_SFTPClient Class)

The number of parallelized transfer requests.

Object Oriented Interface

public function getPipelineLength();


public function setPipelineLength($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 94 );


secureblackbox_sftpclient_set($res, 94, $value );

Default Value

32

Remarks

This property controls the number of upload/download requests sent simultaneously. This speeds the transfer up, but may lead to issues with older/immature servers.

Typically you will only need to adjust this property if the default transfer settings (AutoAdjustTransferBlock) don't work.

Data Type

Integer

ProxyAddress Property (SecureBlackbox_SFTPClient Class)

The IP address of the proxy server.

Object Oriented Interface

public function getProxyAddress();


public function setProxyAddress($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 95 );


secureblackbox_sftpclient_set($res, 95, $value );

Default Value

''

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (SecureBlackbox_SFTPClient Class)

The authentication type used by the proxy server.

Object Oriented Interface

public function getProxyAuthentication();


public function setProxyAuthentication($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 96 );


secureblackbox_sftpclient_set($res, 96, $value );

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxyPassword Property (SecureBlackbox_SFTPClient Class)

The password to authenticate to the proxy server.

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 97 );


secureblackbox_sftpclient_set($res, 97, $value );

Default Value

''

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (SecureBlackbox_SFTPClient Class)

The port on the proxy server to connect to.

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 98 );


secureblackbox_sftpclient_set($res, 98, $value );

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (SecureBlackbox_SFTPClient Class)

The type of the proxy server.

Object Oriented Interface

public function getProxyProxyType();


public function setProxyProxyType($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 99 );


secureblackbox_sftpclient_set($res, 99, $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_SFTPClient Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Object Oriented Interface

public function getProxyRequestHeaders();


public function setProxyRequestHeaders($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 100 );


secureblackbox_sftpclient_set($res, 100, $value );

Default Value

''

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (SecureBlackbox_SFTPClient Class)

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

Object Oriented Interface

public function getProxyResponseBody();


public function setProxyResponseBody($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 101 );


secureblackbox_sftpclient_set($res, 101, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyResponseHeaders Property (SecureBlackbox_SFTPClient 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_sftpclient_get($res, 102 );


secureblackbox_sftpclient_set($res, 102, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyUseIPv6 Property (SecureBlackbox_SFTPClient 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_sftpclient_get($res, 103 );


secureblackbox_sftpclient_set($res, 103, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyUseProxy Property (SecureBlackbox_SFTPClient Class)

Enables or disables proxy-driven connection.

Object Oriented Interface

public function getProxyUseProxy();


public function setProxyUseProxy($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 104 );


secureblackbox_sftpclient_set($res, 104, $value );

Default Value

false

Remarks

Enables or disables proxy-driven connection.

Data Type

Boolean

ProxyUsername Property (SecureBlackbox_SFTPClient Class)

Specifies the username credential for proxy authentication.

Object Oriented Interface

public function getProxyUsername();


public function setProxyUsername($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 105 );


secureblackbox_sftpclient_set($res, 105, $value );

Default Value

''

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

ServerKeyAlgorithm Property (SecureBlackbox_SFTPClient Class)

Specifies the key algorithm.

Object Oriented Interface

public function getServerKeyAlgorithm();

Procedural Interface

secureblackbox_sftpclient_get($res, 106 );

Default Value

''

Remarks

Specifies the key algorithm.

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

Data Type

String

ServerKeyBits Property (SecureBlackbox_SFTPClient Class)

The number of bits in the key: the more the better, 2048 or 4096 are typical values.

Object Oriented Interface

public function getServerKeyBits();

Procedural Interface

secureblackbox_sftpclient_get($res, 107 );

Default Value

0

Remarks

The number of bits in the key: the more the better, 2048 or 4096 are typical values.

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

Data Type

Integer

ServerKeyComment Property (SecureBlackbox_SFTPClient Class)

The comment for the public key.

Object Oriented Interface

public function getServerKeyComment();

Procedural Interface

secureblackbox_sftpclient_get($res, 108 );

Default Value

''

Remarks

The comment for the public key.

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

Data Type

String

ServerKeyCurve Property (SecureBlackbox_SFTPClient Class)

Specifies the elliptical curve when EC cryptography is used.

Object Oriented Interface

public function getServerKeyCurve();

Procedural Interface

secureblackbox_sftpclient_get($res, 109 );

Default Value

''

Remarks

Specifies the elliptical curve when EC cryptography is used.

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

Data Type

String

ServerKeyDSSG Property (SecureBlackbox_SFTPClient Class)

The G (Generator) parameter of the DSS signature key.

Object Oriented Interface

public function getServerKeyDSSG();

Procedural Interface

secureblackbox_sftpclient_get($res, 110 );

Remarks

The G (Generator) parameter of the DSS signature key. The string should contain the binary data of G.

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

Data Type

Byte Array

ServerKeyDSSP Property (SecureBlackbox_SFTPClient Class)

The P (Prime) parameter of the DSS signature key.

Object Oriented Interface

public function getServerKeyDSSP();

Procedural Interface

secureblackbox_sftpclient_get($res, 111 );

Remarks

The P (Prime) parameter of the DSS signature key. The string should contain the binary data of P.

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

Data Type

Byte Array

ServerKeyDSSQ Property (SecureBlackbox_SFTPClient Class)

The Q (Prime Factor) parameter of the DSS signature key.

Object Oriented Interface

public function getServerKeyDSSQ();

Procedural Interface

secureblackbox_sftpclient_get($res, 112 );

Remarks

The Q (Prime Factor) parameter of the DSS signature key. The string should contain the binary data of Q.

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

Data Type

Byte Array

ServerKeyDSSX Property (SecureBlackbox_SFTPClient Class)

The X (Private key) parameter of the DSS signature key.

Object Oriented Interface

public function getServerKeyDSSX();

Procedural Interface

secureblackbox_sftpclient_get($res, 113 );

Remarks

The X (Private key) parameter of the DSS signature key. The string should contain the binary data of X.

This parameter may be empty if there's no need to sign data with this key (e.g. if the key is a server public key needed only to authenticate the server).

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

Data Type

Byte Array

ServerKeyDSSY Property (SecureBlackbox_SFTPClient Class)

The Y (Public key) parameter of the DSS signature key.

Object Oriented Interface

public function getServerKeyDSSY();

Procedural Interface

secureblackbox_sftpclient_get($res, 114 );

Remarks

The Y (Public key) parameter of the DSS signature key. The string should contain the binary data of Y.

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

Data Type

Byte Array

ServerKeyECCD Property (SecureBlackbox_SFTPClient Class)

The value of the secret key (the order of the public key, D) if elliptic curve (EC) cryptography is used.

Object Oriented Interface

public function getServerKeyECCD();

Procedural Interface

secureblackbox_sftpclient_get($res, 115 );

Remarks

The value of the secret key (the order of the public key, D) if elliptic curve (EC) cryptography is used. The string should contain the binary data of D.

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

Data Type

Byte Array

ServerKeyECCQX Property (SecureBlackbox_SFTPClient Class)

The value of the X coordinate of the public key if elliptic curve (EC) cryptography is used.

Object Oriented Interface

public function getServerKeyECCQX();

Procedural Interface

secureblackbox_sftpclient_get($res, 116 );

Remarks

The value of the X coordinate of the public key if elliptic curve (EC) cryptography is used. The string should contain the binary data of X.

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

Data Type

Byte Array

ServerKeyECCQY Property (SecureBlackbox_SFTPClient Class)

The value of the Y coordinate of the public key if elliptic curve (EC) cryptography is used.

Object Oriented Interface

public function getServerKeyECCQY();

Procedural Interface

secureblackbox_sftpclient_get($res, 117 );

Remarks

The value of the Y coordinate of the public key if elliptic curve (EC) cryptography is used. The string should contain the binary data of Y.

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

Data Type

Byte Array

ServerKeyEdPrivate Property (SecureBlackbox_SFTPClient Class)

The value of the private key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

Object Oriented Interface

public function getServerKeyEdPrivate();

Procedural Interface

secureblackbox_sftpclient_get($res, 118 );

Remarks

The value of the private key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

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

Data Type

Byte Array

ServerKeyEdPublic Property (SecureBlackbox_SFTPClient Class)

The value of the public key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

Object Oriented Interface

public function getServerKeyEdPublic();

Procedural Interface

secureblackbox_sftpclient_get($res, 119 );

Remarks

The value of the public key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

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

Data Type

Byte Array

ServerKeyFingerprintMD5 Property (SecureBlackbox_SFTPClient Class)

Contains the MD5 fingerprint (hash) of the key.

Object Oriented Interface

public function getServerKeyFingerprintMD5();

Procedural Interface

secureblackbox_sftpclient_get($res, 120 );

Default Value

''

Remarks

Contains the MD5 fingerprint (hash) of the key.

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

Data Type

String

ServerKeyFingerprintSHA1 Property (SecureBlackbox_SFTPClient Class)

Contains the SHA-1 fingerprint (hash) of the key.

Object Oriented Interface

public function getServerKeyFingerprintSHA1();

Procedural Interface

secureblackbox_sftpclient_get($res, 121 );

Default Value

''

Remarks

Contains the SHA-1 fingerprint (hash) of the key.

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

Data Type

String

ServerKeyFingerprintSHA256 Property (SecureBlackbox_SFTPClient Class)

Contains the SHA-256 fingerprint (hash) of the key.

Object Oriented Interface

public function getServerKeyFingerprintSHA256();

Procedural Interface

secureblackbox_sftpclient_get($res, 122 );

Default Value

''

Remarks

Contains the SHA-256 fingerprint (hash) of the key.

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

Data Type

String

ServerKeyHandle Property (SecureBlackbox_SFTPClient Class)

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

Object Oriented Interface

public function getServerKeyHandle();

Procedural Interface

secureblackbox_sftpclient_get($res, 123 );

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

ServerKeyIsExtractable Property (SecureBlackbox_SFTPClient Class)

Whether the key is extractable (e.

Object Oriented Interface

public function getServerKeyIsExtractable();

Procedural Interface

secureblackbox_sftpclient_get($res, 124 );

Default Value

false

Remarks

Whether the key is extractable (e.g., from a security token), or not.

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

Data Type

Boolean

ServerKeyIsPrivate Property (SecureBlackbox_SFTPClient Class)

Whether this key is a private key or not.

Object Oriented Interface

public function getServerKeyIsPrivate();

Procedural Interface

secureblackbox_sftpclient_get($res, 125 );

Default Value

false

Remarks

Whether this key is a private key or not.

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

Data Type

Boolean

ServerKeyIsPublic Property (SecureBlackbox_SFTPClient Class)

Whether this key is a public key or not.

Object Oriented Interface

public function getServerKeyIsPublic();

Procedural Interface

secureblackbox_sftpclient_get($res, 126 );

Default Value

false

Remarks

Whether this key is a public key or not.

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

Data Type

Boolean

ServerKeyKDFRounds Property (SecureBlackbox_SFTPClient Class)

Returns the number of iterations of the Key Derivation Function (KDF) used to generate this key.

Object Oriented Interface

public function getServerKeyKDFRounds();

Procedural Interface

secureblackbox_sftpclient_get($res, 127 );

Default Value

0

Remarks

Returns the number of iterations of the Key Derivation Function (KDF) used to generate this key.

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

Data Type

Integer

ServerKeyKDFSalt Property (SecureBlackbox_SFTPClient Class)

The salt value used by the Key Derivation Function (KDF) to generate this key.

Object Oriented Interface

public function getServerKeyKDFSalt();

Procedural Interface

secureblackbox_sftpclient_get($res, 128 );

Remarks

The salt value used by the Key Derivation Function (KDF) to generate this key.

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

Data Type

Byte Array

ServerKeyKeyFormat Property (SecureBlackbox_SFTPClient Class)

Specifies the format in which the key is stored.

Object Oriented Interface

public function getServerKeyKeyFormat();

Procedural Interface

secureblackbox_sftpclient_get($res, 129 );

Default Value

0

Remarks

Specifies the format in which the key is stored.

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

Data Type

Integer

ServerKeyKeyProtectionAlgorithm Property (SecureBlackbox_SFTPClient Class)

Specifies the key protection algorithm.

Object Oriented Interface

public function getServerKeyKeyProtectionAlgorithm();

Procedural Interface

secureblackbox_sftpclient_get($res, 130 );

Default Value

''

Remarks

Specifies the key protection algorithm.

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

Data Type

String

ServerKeyRSAExponent Property (SecureBlackbox_SFTPClient Class)

Returns the e parameter (public exponent) of the RSA key.

Object Oriented Interface

public function getServerKeyRSAExponent();

Procedural Interface

secureblackbox_sftpclient_get($res, 131 );

Remarks

Returns the e parameter (public exponent) of the RSA key.

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

Data Type

Byte Array

ServerKeyRSAIQMP Property (SecureBlackbox_SFTPClient Class)

Returns the iqmp parameter of the RSA key.

Object Oriented Interface

public function getServerKeyRSAIQMP();

Procedural Interface

secureblackbox_sftpclient_get($res, 132 );

Remarks

Returns the iqmp parameter of the RSA key.

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

Data Type

Byte Array

ServerKeyRSAModulus Property (SecureBlackbox_SFTPClient Class)

Returns the m parameter (public modulus) of the RSA key.

Object Oriented Interface

public function getServerKeyRSAModulus();

Procedural Interface

secureblackbox_sftpclient_get($res, 133 );

Remarks

Returns the m parameter (public modulus) of the RSA key.

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

Data Type

Byte Array

ServerKeyRSAP Property (SecureBlackbox_SFTPClient Class)

Returns the p parameter (first factor of the common modulus n) of the RSA key.

Object Oriented Interface

public function getServerKeyRSAP();

Procedural Interface

secureblackbox_sftpclient_get($res, 134 );

Remarks

Returns the p parameter (first factor of the common modulus n) of the RSA key.

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

Data Type

Byte Array

ServerKeyRSAPrivateExponent Property (SecureBlackbox_SFTPClient Class)

Returns the d parameter (private exponent) of the RSA key.

Object Oriented Interface

public function getServerKeyRSAPrivateExponent();

Procedural Interface

secureblackbox_sftpclient_get($res, 135 );

Remarks

Returns the d parameter (private exponent) of the RSA key.

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

Data Type

Byte Array

ServerKeyRSAQ Property (SecureBlackbox_SFTPClient Class)

Returns the q parameter (second factor of the common modulus n) of the RSA key.

Object Oriented Interface

public function getServerKeyRSAQ();

Procedural Interface

secureblackbox_sftpclient_get($res, 136 );

Remarks

Returns the q parameter (second factor of the common modulus n) of the RSA key.

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

Data Type

Byte Array

ServerKeySubject Property (SecureBlackbox_SFTPClient Class)

Specifies the public key owner (subject).

Object Oriented Interface

public function getServerKeySubject();

Procedural Interface

secureblackbox_sftpclient_get($res, 137 );

Default Value

''

Remarks

Specifies the public key owner (subject). This property is used only for IETF-keys.

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

Data Type

String

SocketDNSMode Property (SecureBlackbox_SFTPClient 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_sftpclient_get($res, 138 );


secureblackbox_sftpclient_set($res, 138, $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_SFTPClient 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_sftpclient_get($res, 139 );


secureblackbox_sftpclient_set($res, 139, $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_SFTPClient Class)

The timeout (in milliseconds) for each DNS query.

Object Oriented Interface

public function getSocketDNSQueryTimeout();


public function setSocketDNSQueryTimeout($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 140 );


secureblackbox_sftpclient_set($res, 140, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketDNSServers Property (SecureBlackbox_SFTPClient 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_sftpclient_get($res, 141 );


secureblackbox_sftpclient_set($res, 141, $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_SFTPClient Class)

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

Object Oriented Interface

public function getSocketDNSTotalTimeout();


public function setSocketDNSTotalTimeout($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 142 );


secureblackbox_sftpclient_set($res, 142, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketIncomingSpeedLimit Property (SecureBlackbox_SFTPClient 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_sftpclient_get($res, 143 );


secureblackbox_sftpclient_set($res, 143, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (SecureBlackbox_SFTPClient Class)

The local network interface to bind the socket to.

Object Oriented Interface

public function getSocketLocalAddress();


public function setSocketLocalAddress($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 144 );


secureblackbox_sftpclient_set($res, 144, $value );

Default Value

''

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SecureBlackbox_SFTPClient Class)

The local port number to bind the socket to.

Object Oriented Interface

public function getSocketLocalPort();


public function setSocketLocalPort($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 145 );


secureblackbox_sftpclient_set($res, 145, $value );

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SecureBlackbox_SFTPClient 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_sftpclient_get($res, 146 );


secureblackbox_sftpclient_set($res, 146, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (SecureBlackbox_SFTPClient 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_sftpclient_get($res, 147 );


secureblackbox_sftpclient_set($res, 147, $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_SFTPClient Class)

Enables or disables IP protocol version 6.

Object Oriented Interface

public function getSocketUseIPv6();


public function setSocketUseIPv6($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 148 );


secureblackbox_sftpclient_set($res, 148, $value );

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

SSHSettingsAutoAdjustCiphers Property (SecureBlackbox_SFTPClient Class)

Whether the SSH client should adjust its list of supported ciphers 'on-the-fly' for greater compatibility with the server it is connecting to.

Object Oriented Interface

public function getSSHSettingsAutoAdjustCiphers();


public function setSSHSettingsAutoAdjustCiphers($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 149 );


secureblackbox_sftpclient_set($res, 149, $value );

Default Value

true

Remarks

Whether the SSH client should adjust its list of supported ciphers 'on-the-fly' for greater compatibility with the server it is connecting to.

Data Type

Boolean

SSHSettingsBaseConfiguration Property (SecureBlackbox_SFTPClient Class)

Allows to choose base configuration of SSH settings, tuned up for different purposes such as high security or higher compatibility.

Object Oriented Interface

public function getSSHSettingsBaseConfiguration();


public function setSSHSettingsBaseConfiguration($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 150 );


secureblackbox_sftpclient_set($res, 150, $value );

Default Value

0

Remarks

Allows to choose base configuration of SSH settings, tuned up for different purposes such as high security or higher compatibility.

Data Type

Integer

SSHSettingsCompressionAlgorithms Property (SecureBlackbox_SFTPClient Class)

A list of session compression algorithms separated with commas or semicolons.

Object Oriented Interface

public function getSSHSettingsCompressionAlgorithms();


public function setSSHSettingsCompressionAlgorithms($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 151 );


secureblackbox_sftpclient_set($res, 151, $value );

Default Value

''

Remarks

A list of session compression algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all compression algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of compression algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported compression algorithms is provided below:

• none
• zlib
• zlib@openssh.com

Data Type

String

SSHSettingsCompressionLevel Property (SecureBlackbox_SFTPClient Class)

Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression).

Object Oriented Interface

public function getSSHSettingsCompressionLevel();


public function setSSHSettingsCompressionLevel($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 152 );


secureblackbox_sftpclient_set($res, 152, $value );

Default Value

6

Remarks

Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression). This setting is ignored if compression wasn't accepted.

Data Type

Integer

SSHSettingsDefaultWindowSize Property (SecureBlackbox_SFTPClient Class)

The SSH window size specifies how many bytes the client can send to the server in the command channel without obtaining pre-authorization for the further send from the server.

Object Oriented Interface

public function getSSHSettingsDefaultWindowSize();


public function setSSHSettingsDefaultWindowSize($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 153 );


secureblackbox_sftpclient_set($res, 153, $value );

Default Value

2048000

Remarks

The SSH window size specifies how many bytes the client can send to the server in the command channel without obtaining pre-authorization for the further send from the server.

Data Type

Integer

SSHSettingsEncryptionAlgorithms Property (SecureBlackbox_SFTPClient Class)

A list of session encryption algorithms separated with commas or semicolons.

Object Oriented Interface

public function getSSHSettingsEncryptionAlgorithms();


public function setSSHSettingsEncryptionAlgorithms($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 154 );


secureblackbox_sftpclient_set($res, 154, $value );

Default Value

''

Remarks

A list of session encryption algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all encryption algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of encryption algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported encryption algorithms is provided below:

• 3des-cbc
• blowfish-cbc
• twofish256-cbc
• twofish192-cbc
• twofish128-cbc
• aes256-cbc
• aes192-cbc
• aes128-cbc
• serpent256-cbc
• serpent192-cbc
• serpent128-cbc
• arcfour
• idea-cbc
• cast128-cbc
• none
• des-cbc
• aes128-ctr
• aes192-ctr
• aes256-ctr
• 3des-ctr
• blowfish-ctr
• twofish128-ctr
• twofish192-ctr
• twofish256-ctr
• serpent128-ctr
• serpent192-ctr
• serpent256-ctr
• idea-ctr
• cast128-ctr
• arcfour128
• arcfour256
• aes128-gcm
• aes256-gcm
• aes128-gcm@openssh.com
• aes256-gcm@openssh.com
• chacha20-poly1305
• chacha20-poly1305@openssh.com

Data Type

String

SSHSettingsForceCompression Property (SecureBlackbox_SFTPClient Class)

Whether the SSH client should explicitly request compression.

Object Oriented Interface

public function getSSHSettingsForceCompression();


public function setSSHSettingsForceCompression($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 155 );


secureblackbox_sftpclient_set($res, 155, $value );

Default Value

false

Remarks

Whether the SSH client should explicitly request compression.

If ForceCompression is False, compression will be used only if the server doesn't support algorithms without compression.

Data Type

Boolean

SSHSettingsGSSAuthTypes Property (SecureBlackbox_SFTPClient Class)

A comma-separated list of authentication types.

Object Oriented Interface

public function getSSHSettingsGSSAuthTypes();


public function setSSHSettingsGSSAuthTypes($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 156 );


secureblackbox_sftpclient_set($res, 156, $value );

Default Value

''

Remarks

A comma-separated list of authentication types. Two types are currently supported: gssapi-with-mic and gssapi-keyex.

Data Type

String

SSHSettingsGSSDelegateCreds Property (SecureBlackbox_SFTPClient Class)

Switches credential delegation on or off.

Object Oriented Interface

public function getSSHSettingsGSSDelegateCreds();


public function setSSHSettingsGSSDelegateCreds($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 157 );


secureblackbox_sftpclient_set($res, 157, $value );

Default Value

false

Remarks

Switches credential delegation on or off.

Data Type

Boolean

SSHSettingsGSSHostname Property (SecureBlackbox_SFTPClient Class)

The GSS host name, in form of a FQDN (e.

Object Oriented Interface

public function getSSHSettingsGSSHostname();


public function setSSHSettingsGSSHostname($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 158 );


secureblackbox_sftpclient_set($res, 158, $value );

Default Value

''

Remarks

The GSS host name, in form of a FQDN (e.g. hostname.com), a principal name (e.g. 'host@hostname.com), or a cross-real ticket-granting ticket (e.g. krbtgt/test.com@example.com).

Data Type

String

SSHSettingsGSSLib Property (SecureBlackbox_SFTPClient Class)

A path to the GSS-API library (DLL or SO).

Object Oriented Interface

public function getSSHSettingsGSSLib();


public function setSSHSettingsGSSLib($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 159 );


secureblackbox_sftpclient_set($res, 159, $value );

Default Value

''

Remarks

A path to the GSS-API library (DLL or SO).

Data Type

String

SSHSettingsGSSMechanisms Property (SecureBlackbox_SFTPClient Class)

A comma-separated list of GSS mechanisms to use.

Object Oriented Interface

public function getSSHSettingsGSSMechanisms();


public function setSSHSettingsGSSMechanisms($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 160 );


secureblackbox_sftpclient_set($res, 160, $value );

Default Value

''

Remarks

A comma-separated list of GSS mechanisms to use. Two values are currently supported: lib and SSPI.

Data Type

String

SSHSettingsGSSProtocols Property (SecureBlackbox_SFTPClient Class)

A comma-separated list of SSPI protocols.

Object Oriented Interface

public function getSSHSettingsGSSProtocols();


public function setSSHSettingsGSSProtocols($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 161 );


secureblackbox_sftpclient_set($res, 161, $value );

Default Value

''

Remarks

A comma-separated list of SSPI protocols. Two protocols are currently supported: kerberos and NTLM.

Data Type

String

SSHSettingsHandshakeTimeout Property (SecureBlackbox_SFTPClient Class)

Specifies the maximal time for the SSH handshake to proceed, in seconds.

Object Oriented Interface

public function getSSHSettingsHandshakeTimeout();


public function setSSHSettingsHandshakeTimeout($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 162 );


secureblackbox_sftpclient_set($res, 162, $value );

Default Value

45

Remarks

Specifies the maximal time for the SSH handshake to proceed, in seconds. If the handshake is not completed within this period, the session is aborted.

Data Type

Integer

SSHSettingsKexAlgorithms Property (SecureBlackbox_SFTPClient Class)

A list of key exchange algorithms separated with commas or semicolons.

Object Oriented Interface

public function getSSHSettingsKexAlgorithms();


public function setSSHSettingsKexAlgorithms($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 163 );


secureblackbox_sftpclient_set($res, 163, $value );

Default Value

''

Remarks

A list of key exchange algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all key exchange algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of key exchange algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported kex algorithms is provided below:

• diffie-hellman-group-exchange-sha1
• diffie-hellman-group1-sha1
• diffie-hellman-group14-sha1
• diffie-hellman-group-exchange-sha256
• rsa1024-sha1
• rsa2048-sha256
• ecdh-sha2-nistp256
• ecdh-sha2-nistp384
• ecdh-sha2-nistp521
• ecdh-sha2-nistk163
• ecdh-sha2-nistp192
• ecdh-sha2-nistp224
• ecdh-sha2-nistk233
• ecdh-sha2-nistb233
• ecdh-sha2-nistk283
• ecdh-sha2-nistk409
• ecdh-sha2-nistb409
• ecdh-sha2-nistt571
• ecdh-sha2-curve25519
• curve25519-sha256@libssh.org
• curve448-sha512@libssh.org
• diffie-hellman-group14-sha256
• diffie-hellman-group15-sha512
• diffie-hellman-group16-sha512
• diffie-hellman-group17-sha512
• diffie-hellman-group18-sha512

Data Type

String

SSHSettingsMacAlgorithms Property (SecureBlackbox_SFTPClient Class)

A list of MAC (for message authentication code ) algorithms separated with commas or semicolons.

Object Oriented Interface

public function getSSHSettingsMacAlgorithms();


public function setSSHSettingsMacAlgorithms($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 164 );


secureblackbox_sftpclient_set($res, 164, $value );

Default Value

''

Remarks

A list of MAC (for message authentication code) algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all MAC algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of MAC algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported MAC algorithms is provided below:

• hmac-sha1
• hmac-sha1-96
• hmac-md5
• hmac-md5-96
• none
• hmac-ripemd160
• hmac-ripemd
• hmac-ripemd160@openssh.com
• hmac-sha256@ssh.com
• hmac-sha256-96@ssh.com
• umac-32@openssh.com
• umac-64@openssh.com
• umac-96@openssh.com
• umac-128@openssh.com
• hmac-sha2-256
• hmac-sha2-512
• aes128-gcm
• aes256-gcm
• chacha20-poly1305@openssh.com
• hmac-sha2-256-etm@openssh.com
• hmac-sha2-512-etm@openssh.com

Data Type

String

SSHSettingsMaxSSHPacketSize Property (SecureBlackbox_SFTPClient Class)

Specifies the maximum length of one SSH packet in bytes.

Object Oriented Interface

public function getSSHSettingsMaxSSHPacketSize();


public function setSSHSettingsMaxSSHPacketSize($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 165 );


secureblackbox_sftpclient_set($res, 165, $value );

Default Value

262144

Remarks

Specifies the maximum length of one SSH packet in bytes.

Data Type

Integer

SSHSettingsMinWindowSize Property (SecureBlackbox_SFTPClient Class)

Specifies the minimal internal window size.

Object Oriented Interface

public function getSSHSettingsMinWindowSize();


public function setSSHSettingsMinWindowSize($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 166 );


secureblackbox_sftpclient_set($res, 166, $value );

Default Value

2048

Remarks

Specifies the minimal internal window size. When the minimal window size is reached, the 'window extension' request is sent to the server. This request notifies the server that the window was extended, and it can send more data.

Data Type

Integer

SSHSettingsObfuscateHandshake Property (SecureBlackbox_SFTPClient Class)

Enables or disables handshake obfuscation.

Object Oriented Interface

public function getSSHSettingsObfuscateHandshake();


public function setSSHSettingsObfuscateHandshake($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 167 );


secureblackbox_sftpclient_set($res, 167, $value );

Default Value

false

Remarks

Enables or disables handshake obfuscation.

Data Type

Boolean

SSHSettingsObfuscationPassword Property (SecureBlackbox_SFTPClient Class)

Specifies the password used to encrypt the handshake when ObfuscateHandshake is set.

Object Oriented Interface

public function getSSHSettingsObfuscationPassword();


public function setSSHSettingsObfuscationPassword($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 168 );


secureblackbox_sftpclient_set($res, 168, $value );

Default Value

''

Remarks

Specifies the password used to encrypt the handshake when ObfuscateHandshake is set.

Data Type

String

SSHSettingsPublicKeyAlgorithms Property (SecureBlackbox_SFTPClient Class)

A list of public key algorithms separated with commas or semicolons.

Object Oriented Interface

public function getSSHSettingsPublicKeyAlgorithms();


public function setSSHSettingsPublicKeyAlgorithms($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 169 );


secureblackbox_sftpclient_set($res, 169, $value );

Default Value

''

Remarks

A list of public key algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all public key algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of public key algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported public key algorithms is provided below:

• ssh-dss
• ssh-rsa
• x509v3-sign-rsa
• x509v3-sign-dss
• spki-sign-rsa,
• spki-sign-dss
• pgp-sign-rsa
• pgp-sign-dss
• ecdsa-sha2-nistp256
• ecdsa-sha2-nistp384
• ecdsa-sha2-nistp521
• ecdsa-sha2-nistk163
• ecdsa-sha2-nistp192
• ecdsa-sha2-nistp224
• ecdsa-sha2-nistk233
• ecdsa-sha2-nistb233
• ecdsa-sha2-nistk283
• ecdsa-sha2-nistk409
• ecdsa-sha2-nistb409
• ecdsa-sha2-nistt571,
• ecdsa-sha2-curve25519
• x509v3-ssh-rsa
• x509v3-ssh-dss
• x509v3-rsa2048-sha256
• x509v3-ecdsa-sha2-nistp256
• x509v3-ecdsa-sha2-nistp384
• x509v3-ecdsa-sha2-nistp521
• x509v3-ecdsa-sha2-nistk163
• x509v3-ecdsa-sha2-nistp192
• x509v3-ecdsa-sha2-nistp224
• x509v3-ecdsa-sha2-nistk233
• x509v3-ecdsa-sha2-nistb233
• x509v3-ecdsa-sha2-nistk283
• x509v3-ecdsa-sha2-nistk409
• x509v3-ecdsa-sha2-nistb409
• x509v3-ecdsa-sha2-nistt571
• x509v3-ecdsa-sha2-curve25519
• ssh-ed25519
• ssh-ed448
• rsa-sha2-256
• rsa-sha2-512

Data Type

String

SSHSettingsRequestPasswordChange Property (SecureBlackbox_SFTPClient Class)

Whether to request a password change when connecting.

Object Oriented Interface

public function getSSHSettingsRequestPasswordChange();


public function setSSHSettingsRequestPasswordChange($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 170 );


secureblackbox_sftpclient_set($res, 170, $value );

Default Value

false

Remarks

Whether to request a password change when connecting.

Data Type

Boolean

SSHSettingsSoftwareName Property (SecureBlackbox_SFTPClient Class)

The name to be used by the class to identify itself.

Object Oriented Interface

public function getSSHSettingsSoftwareName();


public function setSSHSettingsSoftwareName($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 171 );


secureblackbox_sftpclient_set($res, 171, $value );

Default Value

'SecureBlackbox'

Remarks

The name to be used by the component to identify itself.

Data Type

String

SSHSettingsTrustAllKeys Property (SecureBlackbox_SFTPClient Class)

Enables or disables explicit trust to all server keys.

Object Oriented Interface

public function getSSHSettingsTrustAllKeys();


public function setSSHSettingsTrustAllKeys($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 172 );


secureblackbox_sftpclient_set($res, 172, $value );

Default Value

false

Remarks

Enables or disables explicit trust to all server keys. Use with care.

Data Type

Boolean

SSHSettingsUseAuthAgent Property (SecureBlackbox_SFTPClient Class)

Enables or disables the use of external key agent, such as Putty key agent.

Object Oriented Interface

public function getSSHSettingsUseAuthAgent();


public function setSSHSettingsUseAuthAgent($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 173 );


secureblackbox_sftpclient_set($res, 173, $value );

Default Value

false

Remarks

Enables or disables the use of external key agent, such as Putty key agent.

Data Type

Boolean

SSHSettingsVersions Property (SecureBlackbox_SFTPClient Class)

Specifies enabled SSH protocol versions (1 or 2).

Object Oriented Interface

public function getSSHSettingsVersions();


public function setSSHSettingsVersions($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 174 );


secureblackbox_sftpclient_set($res, 174, $value );

Default Value

1

Remarks

Specifies enabled SSH protocol versions (1 or 2).

Data Type

Integer

TrustedKeysFile Property (SecureBlackbox_SFTPClient Class)

A file containing the keys of authorized servers.

Object Oriented Interface

public function getTrustedKeysFile();


public function setTrustedKeysFile($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 175 );


secureblackbox_sftpclient_set($res, 175, $value );

Default Value

''

Remarks

Use this property to provide a path to the 'authorized_keys' file to be used by the client.

Data Type

String

UploadBlockSize Property (SecureBlackbox_SFTPClient Class)

The upload block size in bytes.

Object Oriented Interface

public function getUploadBlockSize();


public function setUploadBlockSize($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 176 );


secureblackbox_sftpclient_set($res, 176, $value );

Default Value

32256

Remarks

Use this property to manually control the size of upload blocks. Typically you will only need to adjust this property if the default transfer settings (AutoAdjustTransferBlock) don't work.

Data Type

Integer

Username Property (SecureBlackbox_SFTPClient Class)

The client's username to authenticate to the server.

Object Oriented Interface

public function getUsername();


public function setUsername($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 177 );


secureblackbox_sftpclient_set($res, 177, $value );

Default Value

''

Remarks

Use this property to provide an authentication username (login). This property is only applicable for password-based and keyboard-interactive authentication types.

Data Type

String

UseUTF8 Property (SecureBlackbox_SFTPClient Class)

Enables UTF8 for all string content.

Object Oriented Interface

public function getUseUTF8();


public function setUseUTF8($value);

Procedural Interface

secureblackbox_sftpclient_get($res, 178 );


secureblackbox_sftpclient_set($res, 178, $value );

Default Value

false

Remarks

If UseUTF8 is true, the class expects all downloaded filenames to be encoded in UTF-8. Set UseUTF8 to false if you connect to a server that does not support UTF8 (e.g., OpenSSH). In this case the file names will be interpreted in the default character set.

Data Type

Boolean

Version Property (SecureBlackbox_SFTPClient Class)

The SFTP version negotiated.

Object Oriented Interface

public function getVersion();

Procedural Interface

secureblackbox_sftpclient_get($res, 179 );

Default Value

0

Remarks

Use this property to get the negotiated SFTP version.

This property is read-only.

Data Type

Integer

AbsolutePath Method (SecureBlackbox_SFTPClient Class)

Requests the absolute path for a relative path.

Object Oriented Interface

public function doAbsolutePath($remotepath);

Procedural Interface

secureblackbox_sftpclient_do_absolutepath($res, $remotepath);

Remarks

Use this method to ask the SFTP server to convert a relative path to an absolute.

ChangeDir Method (SecureBlackbox_SFTPClient Class)

Changes current working directory on the server.

Object Oriented Interface

public function doChangeDir($remotedir);

Procedural Interface

secureblackbox_sftpclient_do_changedir($res, $remotedir);

Remarks

Changes current working directory on the server to RemoteDir.

Config Method (SecureBlackbox_SFTPClient Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_sftpclient_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_SFTPClient Class)

Connects to an SFTP server.

Object Oriented Interface

public function doConnect($address, $port);

Procedural Interface

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

Remarks

Use this method to connect to the SFTP server identified via its Address and Port.

CreateLink Method (SecureBlackbox_SFTPClient Class)

Creates a symbolic or hard link to a remote file.

Object Oriented Interface

public function doCreateLink($linkpath, $targetpath, $hardlink);

Procedural Interface

secureblackbox_sftpclient_do_createlink($res, $linkpath, $targetpath, $hardlink);

Remarks

Use this method to create a symbolic or hard link on the server. Provide the name of the new link object via the LinkPath parameter, and the destinating file or directory path via the TargetPath parameter. HardLink specifies whether the new link should be hard (true) or symbolic (false).

DeleteDir Method (SecureBlackbox_SFTPClient Class)

Removes directory from the SFTP server.

Object Oriented Interface

public function doDeleteDir($remotedir);

Procedural Interface

secureblackbox_sftpclient_do_deletedir($res, $remotedir);

Remarks

Use RemoteDir to provide a path to the directory to be deleted.

DeleteFile Method (SecureBlackbox_SFTPClient Class)

Deletes a file from the SFTP server.

Object Oriented Interface

public function doDeleteFile($remotefile);

Procedural Interface

secureblackbox_sftpclient_do_deletefile($res, $remotefile);

Remarks

Use the RemoteFile parameter to specify the name of the file to delete.

DeleteFiles Method (SecureBlackbox_SFTPClient Class)

Deletes a group of files from the SFTP server.

Object Oriented Interface

public function doDeleteFiles($remotepath, $mask, $casesensitive, $recursive);

Procedural Interface

secureblackbox_sftpclient_do_deletefiles($res, $remotepath, $mask, $casesensitive, $recursive);

Remarks

Use this method to delete a group of files from the SFTP server. Specify the files to be deleted via RemotePath and Mask parameters. Use CaseSensitive and Recursive parameters to tune up the operation.

This method is a more efficient way to delete a group of files than deleting them one by one.

DirExists Method (SecureBlackbox_SFTPClient Class)

Checks if a directory exists on the SFTP server.

Object Oriented Interface

public function doDirExists($remotedir);

Procedural Interface

secureblackbox_sftpclient_do_direxists($res, $remotedir);

Remarks

RemoteDir specifies the name of the remote directory to check for existence.

Disconnect Method (SecureBlackbox_SFTPClient Class)

Disconnects from the SFTP server.

Object Oriented Interface

public function doDisconnect();

Procedural Interface

secureblackbox_sftpclient_do_disconnect($res);

Remarks

Call this method to disconnect from the SFTP server.

DoAction Method (SecureBlackbox_SFTPClient Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_sftpclient_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 insencitive) 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_SFTPClient Class)

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

Object Oriented Interface

public function doDownloadBytes($remotefile);

Procedural Interface

secureblackbox_sftpclient_do_downloadbytes($res, $remotefile);

Remarks

Use this method to download RemoteFile into a byte array.

DownloadFile Method (SecureBlackbox_SFTPClient Class)

Downloads a file from the SFTP server.

Object Oriented Interface

public function doDownloadFile($remotefile, $localfile);

Procedural Interface

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

Remarks

Use this method to download RemoteFile into the location specified by LocalFile.

DownloadFiles Method (SecureBlackbox_SFTPClient Class)

Downloads multiple files from the SFTP server.

Object Oriented Interface

public function doDownloadFiles($remotepath, $localdir);

Procedural Interface

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

Remarks

RemotePath contains a file mask or regular expression by which the files are selected for download.

LocalDir specifies the local folder where the files should be saved.

ExecuteSSHCommand Method (SecureBlackbox_SFTPClient Class)

Sends an SSH command to the server in the middle of SFTP session.

Object Oriented Interface

public function doExecuteSSHCommand($command);

Procedural Interface

secureblackbox_sftpclient_do_executesshcommand($res, $command);

Remarks

Use this command to send an SSH command to the server in the middle of an SFTP session. The command is executed in a secondary channel, so the SFTP connection is not affected.

This method is suitable for simple commands that do not require interaction with the user. The call returns the command output.

ExtensionCmd Method (SecureBlackbox_SFTPClient Class)

Sends an extension command to the server.

Object Oriented Interface

public function doExtensionCmd($extn, $databuffer);

Procedural Interface

secureblackbox_sftpclient_do_extensioncmd($res, $extn, $databuffer);

Remarks

Use this method to send an extension command to the SFTP server. Provide the extension type via the Extn parameter, and the request body via the DataBuffer parameter.

Upon completion of the command, the method returns the response as received from the server.

FileExists Method (SecureBlackbox_SFTPClient Class)

Checks whether a file exists on the server.

Object Oriented Interface

public function doFileExists($remotefile);

Procedural Interface

secureblackbox_sftpclient_do_fileexists($res, $remotefile);

Remarks

Use this method to check if a RemoteFile exists on the server.

GetCurrentDir Method (SecureBlackbox_SFTPClient Class)

Returns the current directory on the SFTP server.

Object Oriented Interface

public function doGetCurrentDir();

Procedural Interface

secureblackbox_sftpclient_do_getcurrentdir($res);

Remarks

Use this method to retrieve the current directory as stored by the class. This is a virtualized current directory, as SFTP protocol does not maintain a concept of the current directory.

GetFileSize Method (SecureBlackbox_SFTPClient Class)

Checks the size of a remote file.

Object Oriented Interface

public function doGetFileSize($remotefile);

Procedural Interface

secureblackbox_sftpclient_do_getfilesize($res, $remotefile);

Remarks

Returns the size of the RemoteFile.

ListDir Method (SecureBlackbox_SFTPClient Class)

Lists the content of the current remote directory.

Object Oriented Interface

public function doListDir($includefiles, $includedirectories);

Procedural Interface

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

Remarks

IncludeFiles specifies whether file names and symlinks should be included in the results. IncludeDirectories specifies whether directory names should be included in the result.

Upon receiving the listing, the component will report each entry in it via ListEntry event.

MakeDir Method (SecureBlackbox_SFTPClient Class)

Creates a new directory on the server.

Object Oriented Interface

public function doMakeDir($remotedir);

Procedural Interface

secureblackbox_sftpclient_do_makedir($res, $remotedir);

Remarks

RemoteDir specifies the name of the new directory.

RenameFile Method (SecureBlackbox_SFTPClient Class)

Renames a file.

Object Oriented Interface

public function doRenameFile($sourcefile, $destfile);

Procedural Interface

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

Remarks

Use this method to rename a remote file. Provide the old and the new name via SourceFile and DestFile parameters.

RequestAttributes Method (SecureBlackbox_SFTPClient Class)

Requests attributes of the remote file.

Object Oriented Interface

public function doRequestAttributes($remotepath, $followsymlinks);

Procedural Interface

secureblackbox_sftpclient_do_requestattributes($res, $remotepath, $followsymlinks);

Remarks

Use this method to request attributes of a remote file. Pass the name of the file via the RemotePath parameter, and use FollowSymLinks to specify whether symbolic links should be resolved.

The method returns the list of attributes as a line of semicolon-separated entries: Size=78220;Owner=user@system;Group=none@system;Permissions=432;ATime=2020-04-28 08:21:00.295;MTime=2020-04-28 08:21:00.302;CTime=2020-04-28 08:21:00.295;AttribBits=24;LinkCount=1.

SetAttributes Method (SecureBlackbox_SFTPClient Class)

Sets the attributes upon a remote file.

Object Oriented Interface

public function doSetAttributes($remotepath, $attributes);

Procedural Interface

secureblackbox_sftpclient_do_setattributes($res, $remotepath, $attributes);

Remarks

Use this method to set the attributes of a remote file.

UploadBytes Method (SecureBlackbox_SFTPClient Class)

Uploads a byte array to the server.

Object Oriented Interface

public function doUploadBytes($bytes, $remotefile);

Procedural Interface

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

Remarks

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

UploadFile Method (SecureBlackbox_SFTPClient Class)

Uploads a file to the server.

Object Oriented Interface

public function doUploadFile($localfile, $remotefile);

Procedural Interface

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

Remarks

Use this method to upload LocalFile to the RemoteFile location on the server.

UploadFiles Method (SecureBlackbox_SFTPClient Class)

Uploads multiple files to the server.

Object Oriented Interface

public function doUploadFiles($localpath, $remotedir);

Procedural Interface

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

Remarks

Use this property to upload a batch of files to the server.

LocalPath specifies a wildcard or regular expression by which the local files are picked for uploading. RemoteDir specifies the location on the server where these files should be saved.

AuthAttempt Event (SecureBlackbox_SFTPClient Class)

Fires when an authentication attempt is performed.

Object Oriented Interface

public function fireAuthAttempt($param);

Procedural Interface

secureblackbox_sftpclient_register_callback($res, 1, array($this, 'fireAuthAttempt'));

Parameter List

 'authtype'

Remarks

This event signals the start of an authentication attempt. The AuthType parameter specifies the authentication type. This event may be fired more than once if the client tries different authentication methods one after another.

Supported authentication types:

AuthFailed Event (SecureBlackbox_SFTPClient Class)

Fires if an authentication attempt fails.

Object Oriented Interface

public function fireAuthFailed($param);

Procedural Interface

secureblackbox_sftpclient_register_callback($res, 2, array($this, 'fireAuthFailed'));

Parameter List

 'authtype'

Remarks

This event fires if an authentication attempt fails (for example, if a bad password had been provided). AuthType parameter indicates the authentication type.

AuthFailed may be fired more than once, depending on the configured authentication parameters and the value assigned to the AuthAttempts property.

This event does not necessarily lead to connection abortion, as the client may still have a chance of authenticating with a different method.

Supported authentication types:

AuthSucceeded Event (SecureBlackbox_SFTPClient Class)

Reports a successful authentication.

Object Oriented Interface

public function fireAuthSucceeded($param);

Procedural Interface

secureblackbox_sftpclient_register_callback($res, 3, array($this, 'fireAuthSucceeded'));

Parameter List

Remarks

This event marks the completion of the authentication procedure, and signifies transition to the SSH connection subprotocol.

Banner Event (SecureBlackbox_SFTPClient Class)

Reports the receipt of the Welcome message from the server.

Object Oriented Interface

public function fireBanner($param);

Procedural Interface

secureblackbox_sftpclient_register_callback($res, 4, array($this, 'fireBanner'));

Parameter List

 'text'
 'language'

Remarks

The class fires this event when it receives a welcome message from the server. Use the Text parameter to access the encoded message.

Disconnect Event (SecureBlackbox_SFTPClient Class)

Reports SFTP connection closure.

Object Oriented Interface

public function fireDisconnect($param);

Procedural Interface

secureblackbox_sftpclient_register_callback($res, 5, array($this, 'fireDisconnect'));

Parameter List

 'closereason'

Remarks

The class fires this event to report connection closure. No more SFTP activity could be done after the disconnect.

Error Event (SecureBlackbox_SFTPClient Class)

Information about errors during SFTP connection.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_sftpclient_register_callback($res, 6, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The event is fired in case of exceptional conditions during data transfer.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of error codes please refer to SFTP.

ExternalSign Event (SecureBlackbox_SFTPClient Class)

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

Object Oriented Interface

public function fireExternalSign($param);

Procedural Interface

secureblackbox_sftpclient_register_callback($res, 7, 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 component via SignedData parameter.

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

The component uses base16 (hex) encoding for 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 a .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_SFTPClient Class)

Signifies the start of a file transfer operation.

Object Oriented Interface

public function fireFileOperation($param);

Procedural Interface

secureblackbox_sftpclient_register_callback($res, 8, array($this, 'fireFileOperation'));

Parameter List

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

Remarks

This event is fired each time the class starts an upload or download operation within a multi-file call. Operation defines the operation about to start, RemotePath specifies the name and path to the remote file, and LocalPath specifies the name and path to the local file.

If needed, set Skip to true to ignore the current file, or Cancel to abort the whole batch.

Supported operations:

FileOperationResult Event (SecureBlackbox_SFTPClient Class)

Signifies the completion of a file transfer operation.

Object Oriented Interface

public function fireFileOperationResult($param);

Procedural Interface

secureblackbox_sftpclient_register_callback($res, 9, array($this, 'fireFileOperationResult'));

Parameter List

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

Remarks

This event is fired each time the class completes a file transfer within a multi-file call. Operation defines the operation performed on the file, RemotePath specifies the name and path to the remote file, and LocalPath specifies the name and path to the local file.

ErrorCode and Comment return the code and textual description of the error, if it was encountered.

Set Cancel to True to cancel the multi-file operation.

Supported operations:

KnownKeyReceived Event (SecureBlackbox_SFTPClient Class)

Signals that the server has introduced itself with a known key.

Object Oriented Interface

public function fireKnownKeyReceived($param);

Procedural Interface

secureblackbox_sftpclient_register_callback($res, 10, array($this, 'fireKnownKeyReceived'));

Parameter List

 'algorithm'
 'bits'
 'fingerprintsha256'

Remarks

The class fires this event to tell the application that the server has introduced itself with a known key from TrustedKeysFile.

The details of the key are provided: Algorithm and Bits specify the key algorithm and the number of bits. FingerprintSHA256 contains the key's fingerprint.

Use ServerKey to access more key details.

ListEntry Event (SecureBlackbox_SFTPClient Class)

Reports a directory listing entry to the application.

Object Oriented Interface

public function fireListEntry($param);

Procedural Interface

secureblackbox_sftpclient_register_callback($res, 11, array($this, 'fireListEntry'));

Parameter List

 'filename'

Remarks

The class fires this event to report a directory listing entry to the application. FileName contains the entry name.

Use CurrentListEntry to access the details of the entry.

Notification Event (SecureBlackbox_SFTPClient Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_sftpclient_register_callback($res, 12, 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 component. 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 EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

PasswordChangeRequest Event (SecureBlackbox_SFTPClient Class)

Signals that the server requests a password change.

Object Oriented Interface

public function firePasswordChangeRequest($param);

Procedural Interface

secureblackbox_sftpclient_register_callback($res, 13, array($this, 'firePasswordChangeRequest'));

Parameter List

 'prompt'
 'newpassword'
 'cancel'

Remarks

The class fires this event to pass the password change request from the server to the application. This event is fired during the SSH handshake.

PrivateKeyNeeded Event (SecureBlackbox_SFTPClient Class)

Asks the application for the client's private key.

Object Oriented Interface

public function firePrivateKeyNeeded($param);

Procedural Interface

secureblackbox_sftpclient_register_callback($res, 14, array($this, 'firePrivateKeyNeeded'));

Parameter List

 'skip'

Remarks

The class fires this event if the public key provided in Key was accepted by the server, but no private key is available for it.

Use this event handler to attach the private key to your Key. The component will pick the key up and continue the authentication.

Progress Event (SecureBlackbox_SFTPClient Class)

Fires periodically during the data transfer.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

secureblackbox_sftpclient_register_callback($res, 15, array($this, 'fireProgress'));

Parameter List

 'total'
 'current'
 'cancel'

Remarks

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

UnknownKeyReceived Event (SecureBlackbox_SFTPClient Class)

Signals that the server has introduced itself with an unknown key.

Object Oriented Interface

public function fireUnknownKeyReceived($param);

Procedural Interface

secureblackbox_sftpclient_register_callback($res, 16, array($this, 'fireUnknownKeyReceived'));

Parameter List

 'algorithm'
 'bits'
 'fingerprintsha256'
 'action'

Remarks

The class fires this event to tell the application that the server has introduced itself with a key not present in TrustedKeysFile.

The details of the key are provided: Algorithm and Bits specify the key algorithm and the number of bits. FingerprintSHA256 contains the key's fingerprint.

In this event handler, you need to make a decision whether to proceed with the connection. Use Action to tell the class what it should do with the key:

Note that accepting an unknown and unchecked key may be risky.

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

SFTPClient Config Settings

Base Config Settings

Trappable Errors (SFTPClient Class)

SFTPClient 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) 
	31457281   Unsupported file operation (SB_ERROR_SFTP_UNSUPPORTED_FILEOPERATION)