SFTPServer Class

Properties   Methods   Events   Config Settings   Errors  

The SFTPServer class provides server-side functionality for SFTP connections.

Class Name

SecureBlackbox_SFTPServer

Procedural Interface

 secureblackbox_sftpserver_open();
 secureblackbox_sftpserver_close($res);
 secureblackbox_sftpserver_register_callback($res, $id, $function);
 secureblackbox_sftpserver_get_last_error($res);
 secureblackbox_sftpserver_get_last_error_code($res);
 secureblackbox_sftpserver_set($res, $id, $index, $value);
 secureblackbox_sftpserver_get($res, $id, $index);
 secureblackbox_sftpserver_do_cleanup($res);
 secureblackbox_sftpserver_do_config($res, $configurationstring);
 secureblackbox_sftpserver_do_doaction($res, $actionid, $actionparams);
 secureblackbox_sftpserver_do_dropclient($res, $connectionid, $forced);
 secureblackbox_sftpserver_do_getclientbuffer($res, $connectionid, $handle);
 secureblackbox_sftpserver_do_getclientfileentry($res, $connectionid, $handle);
 secureblackbox_sftpserver_do_listclients($res);
 secureblackbox_sftpserver_do_pinclient($res, $connectionid);
 secureblackbox_sftpserver_do_reset($res);
 secureblackbox_sftpserver_do_setclientbuffer($res, $connectionid, $handle, $value);
 secureblackbox_sftpserver_do_setclientfileentry($res, $connectionid, $handle);
 secureblackbox_sftpserver_do_start($res);
 secureblackbox_sftpserver_do_stop($res);

Remarks

SFTPServer is an implementation for SSH File Transfer Protocol server. It works over a secure SSH channel, and should not be confused with the FTP/FTPS protocol.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

Active Property (SecureBlackbox_SFTPServer Class)

Specifies whether the SFTP server has started and ready to accept connections.

Object Oriented Interface

public function getActive();

Procedural Interface

secureblackbox_sftpserver_get($res, 1 );

Default Value

false

Remarks

Check this property to find out whether the SFTP server is in active mode. Use Start and Stop methods to activate or deactivate the server.

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

Data Type

Boolean

AuthTypes Property (SecureBlackbox_SFTPServer Class)

Defines allowed authentication types.

Object Oriented Interface

public function getAuthTypes();


public function setAuthTypes($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 2 );


secureblackbox_sftpserver_set($res, 2, $value );

Default Value

30

Remarks

Use this property to define which authentication types are allowed on the server, set of

Data Type

Integer

BaseDir Property (SecureBlackbox_SFTPServer Class)

Specifies the server's base (root) directory.

Object Oriented Interface

public function getBaseDir();


public function setBaseDir($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 3 );


secureblackbox_sftpserver_set($res, 3, $value );

Default Value

''

Remarks

Use this property to set the base (root) directory on the server.

Data Type

String

Capabilities Property (SecureBlackbox_SFTPServer Class)

Specifies which elements of the SSH ecosystem the class must support/enable.

Object Oriented Interface

public function getCapabilities();


public function setCapabilities($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 4 );


secureblackbox_sftpserver_set($res, 4, $value );

Default Value

1

Remarks

Use this property to specify the capabilities of the SSH framework the component must support by adjusting the following bit flags:

Data Type

Integer

ClientFileEntryAccessTime Property (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function getClientFileEntryAccessTime();


public function setClientFileEntryAccessTime($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 5 );


secureblackbox_sftpserver_set($res, 5, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

ClientFileEntryCreationTime Property (SecureBlackbox_SFTPServer Class)

Contains this file's creation time, in UTC.

Object Oriented Interface

public function getClientFileEntryCreationTime();


public function setClientFileEntryCreationTime($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 6 );


secureblackbox_sftpserver_set($res, 6, $value );

Default Value

''

Remarks

Contains this file's creation time, in UTC.

This property is not available at design time.

Data Type

String

ClientFileEntryEntryFormat Property (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function getClientFileEntryEntryFormat();


public function setClientFileEntryEntryFormat($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 7 );


secureblackbox_sftpserver_set($res, 7, $value );

Default Value

0

Remarks

The file listing format:

This property is not available at design time.

Data Type

Integer

ClientFileEntryFileType Property (SecureBlackbox_SFTPServer Class)

The type of the entry: fetUnknown 0 fetDirectory 1 fetFile 2 fetSymlink 3 fetSpecial 4 fetCurrentDirectory 5 fetParentDirectory 6 fetSocket 7 fetCharDevice 8 fetBlockDevice 9 fetFIFO 10 .

Object Oriented Interface

public function getClientFileEntryFileType();


public function setClientFileEntryFileType($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 8 );


secureblackbox_sftpserver_set($res, 8, $value );

Default Value

0

Remarks

The type of the entry:

This property is not available at design time.

Data Type

Integer

ClientFileEntryHandle Property (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function getClientFileEntryHandle();


public function setClientFileEntryHandle($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 9 );


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

ClientFileEntryModificationTime Property (SecureBlackbox_SFTPServer Class)

File last modification date/time.

Object Oriented Interface

public function getClientFileEntryModificationTime();


public function setClientFileEntryModificationTime($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 10 );


secureblackbox_sftpserver_set($res, 10, $value );

Default Value

''

Remarks

File last modification date/time.

This property is not available at design time.

Data Type

String

ClientFileEntryName Property (SecureBlackbox_SFTPServer Class)

The file or directory name.

Object Oriented Interface

public function getClientFileEntryName();


public function setClientFileEntryName($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 11 );


secureblackbox_sftpserver_set($res, 11, $value );

Default Value

''

Remarks

The file or directory name.

This property is not available at design time.

Data Type

String

ClientFileEntryPath Property (SecureBlackbox_SFTPServer Class)

The full path to the file or directory.

Object Oriented Interface

public function getClientFileEntryPath();


public function setClientFileEntryPath($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 12 );


secureblackbox_sftpserver_set($res, 12, $value );

Default Value

''

Remarks

The full path to the file or directory.

This property is not available at design time.

Data Type

String

ClientFileEntryPrincipal Property (SecureBlackbox_SFTPServer Class)

Specifies the owner of the file/directory.

Object Oriented Interface

public function getClientFileEntryPrincipal();


public function setClientFileEntryPrincipal($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 13 );


secureblackbox_sftpserver_set($res, 13, $value );

Default Value

''

Remarks

Specifies the owner of the file/directory.

Note: in earlier versions this property was called Owner. It was renamed to Principal to avoid clashes with certain SDK namings.

This property is not available at design time.

Data Type

String

ClientFileEntrySize Property (SecureBlackbox_SFTPServer Class)

File size in bytes.

Object Oriented Interface

public function getClientFileEntrySize();


public function setClientFileEntrySize($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 14 );


secureblackbox_sftpserver_set($res, 14, $value );

Default Value

0

Remarks

File size in bytes.

This property is not available at design time.

Data Type

Long64

ClientFileEntryUnixPerms Property (SecureBlackbox_SFTPServer Class)

The file Unix permissions bit mask (e.

Object Oriented Interface

public function getClientFileEntryUnixPerms();


public function setClientFileEntryUnixPerms($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 15 );


secureblackbox_sftpserver_set($res, 15, $value );

Default Value

511

Remarks

The file Unix permissions bit mask (e.g. rwxrwxrwx=511 (0777); rwxr--r--=484 (0744)).

This property is not available at design time.

Data Type

Integer

ClientFileEntryUnparsedName Property (SecureBlackbox_SFTPServer Class)

The unparsed entry as returned by the server.

Object Oriented Interface

public function getClientFileEntryUnparsedName();


public function setClientFileEntryUnparsedName($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 16 );


secureblackbox_sftpserver_set($res, 16, $value );

Default Value

''

Remarks

The unparsed entry as returned by the server. Sometimes this is also known as "long name".

This property is not available at design time.

Data Type

String

CompressionLevel Property (SecureBlackbox_SFTPServer Class)

Specifies the preferable compression level.

Object Oriented Interface

public function getCompressionLevel();


public function setCompressionLevel($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 17 );


secureblackbox_sftpserver_set($res, 17, $value );

Default Value

9

Remarks

Set this property before starting the server. Possible values range from 0 (lowest compression) to 9 (maximum compression). This property is ignored if compression wasn't accepted.

Data Type

Integer

ExternalCryptoAsyncDocumentID Property (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function getExternalCryptoAsyncDocumentID();


public function setExternalCryptoAsyncDocumentID($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 18 );


secureblackbox_sftpserver_set($res, 18, $value );

Default Value

''

Remarks

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

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function getExternalCryptoCustomParams();


public function setExternalCryptoCustomParams($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 19 );


secureblackbox_sftpserver_set($res, 19, $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_SFTPServer 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_sftpserver_get($res, 20 );


secureblackbox_sftpserver_set($res, 20, $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_SFTPServer 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_sftpserver_get($res, 21 );


secureblackbox_sftpserver_set($res, 21, $value );

Default Value

false

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.

If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (SecureBlackbox_SFTPServer Class)

Specifies the request's signature hash algorithm.

Object Oriented Interface

public function getExternalCryptoHashAlgorithm();


public function setExternalCryptoHashAlgorithm($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 22 );


secureblackbox_sftpserver_set($res, 22, $value );

Default Value

'SHA256'

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SecureBlackbox_SFTPServer 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_sftpserver_get($res, 23 );


secureblackbox_sftpserver_set($res, 23, $value );

Default Value

''

Remarks

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (SecureBlackbox_SFTPServer Class)

The pre-shared key used for DC request authentication.

Object Oriented Interface

public function getExternalCryptoKeySecret();


public function setExternalCryptoKeySecret($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 24 );


secureblackbox_sftpserver_set($res, 24, $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_SFTPServer Class)

Specifies the asynchronous signing method.

Object Oriented Interface

public function getExternalCryptoMethod();


public function setExternalCryptoMethod($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 25 );


secureblackbox_sftpserver_set($res, 25, $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_SFTPServer Class)

Specifies the external cryptography mode.

Object Oriented Interface

public function getExternalCryptoMode();


public function setExternalCryptoMode($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 26 );


secureblackbox_sftpserver_set($res, 26, $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_SFTPServer Class)

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

Object Oriented Interface

public function getExternalCryptoPublicKeyAlgorithm();


public function setExternalCryptoPublicKeyAlgorithm($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 27 );


secureblackbox_sftpserver_set($res, 27, $value );

Default Value

''

Remarks

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

Data Type

String

FIPSMode Property (SecureBlackbox_SFTPServer Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 28 );


secureblackbox_sftpserver_set($res, 28, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

ForceCompression Property (SecureBlackbox_SFTPServer Class)

This property specifies whether server explicitly requires data compression.

Object Oriented Interface

public function getForceCompression();


public function setForceCompression($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 29 );


secureblackbox_sftpserver_set($res, 29, $value );

Default Value

false

Remarks

Set this property before starting the server. If it is set to true, the class will explicitly request data compression. If it is set to False, the class will support compression, although compression will be used only if the remote party doesn't support algorithms without compression.

Data Type

Boolean

Host Property (SecureBlackbox_SFTPServer Class)

Specifies server's host name.

Object Oriented Interface

public function getHost();


public function setHost($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 30 );


secureblackbox_sftpserver_set($res, 30, $value );

Default Value

''

Remarks

Use this property to set the host name for this server.

Data Type

String

KeyFingerprintSHA1 Property (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function getKeyFingerprintSHA1();

Procedural Interface

secureblackbox_sftpserver_get($res, 46 );

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

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

Object Oriented Interface

public function getKeyFingerprintSHA256();

Procedural Interface

secureblackbox_sftpserver_get($res, 47 );

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

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

Object Oriented Interface

public function getKeyHandle();

Procedural Interface

secureblackbox_sftpserver_get($res, 48 );

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

MaxSFTPVersion Property (SecureBlackbox_SFTPServer Class)

Maximum SFTP version supported.

Object Oriented Interface

public function getMaxSFTPVersion();


public function setMaxSFTPVersion($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 63 );


secureblackbox_sftpserver_set($res, 63, $value );

Default Value

6

Remarks

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

Data Type

Integer

MinSFTPVersion Property (SecureBlackbox_SFTPServer Class)

Minimum SFTP version supported.

Object Oriented Interface

public function getMinSFTPVersion();


public function setMinSFTPVersion($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 64 );


secureblackbox_sftpserver_set($res, 64, $value );

Default Value

0

Remarks

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

Data Type

Integer

PinnedClientClientKeyAlgorithm Property (SecureBlackbox_SFTPServer Class)

Specifies the client's key algorithm.

Object Oriented Interface

public function getPinnedClientClientKeyAlgorithm();

Procedural Interface

secureblackbox_sftpserver_get($res, 65 );

Default Value

''

Remarks

Specifies the client's key algorithm.

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

Data Type

String

PinnedClientClientKeyBits Property (SecureBlackbox_SFTPServer Class)

Specifies the length of the client's key.

Object Oriented Interface

public function getPinnedClientClientKeyBits();

Procedural Interface

secureblackbox_sftpserver_get($res, 66 );

Default Value

0

Remarks

Specifies the length of the client's key.

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

Data Type

Integer

PinnedClientClientKeyFingerprint Property (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function getPinnedClientClientKeyFingerprint();

Procedural Interface

secureblackbox_sftpserver_get($res, 67 );

Default Value

''

Remarks

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

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

Data Type

String

PinnedClientCloseReason Property (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function getPinnedClientCloseReason();

Procedural Interface

secureblackbox_sftpserver_get($res, 68 );

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

Data Type

String

PinnedClientCompressionAlgorithmInbound Property (SecureBlackbox_SFTPServer Class)

Compression algorithm for the incoming traffic.

Object Oriented Interface

public function getPinnedClientCompressionAlgorithmInbound();

Procedural Interface

secureblackbox_sftpserver_get($res, 69 );

Default Value

''

Remarks

Compression algorithm for the incoming traffic.

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

Data Type

String

PinnedClientCompressionAlgorithmOutbound Property (SecureBlackbox_SFTPServer Class)

Compression algorithm for the outgoing traffic.

Object Oriented Interface

public function getPinnedClientCompressionAlgorithmOutbound();

Procedural Interface

secureblackbox_sftpserver_get($res, 70 );

Default Value

''

Remarks

Compression algorithm for the outgoing traffic.

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

Data Type

String

PinnedClientEncryptionAlgorithmInbound Property (SecureBlackbox_SFTPServer Class)

Encryption algorithm for the incoming traffic.

Object Oriented Interface

public function getPinnedClientEncryptionAlgorithmInbound();

Procedural Interface

secureblackbox_sftpserver_get($res, 71 );

Default Value

''

Remarks

Encryption algorithm for the incoming traffic.

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

Data Type

String

PinnedClientEncryptionAlgorithmOutbound Property (SecureBlackbox_SFTPServer Class)

Encryption algorithm for the outgoing traffic.

Object Oriented Interface

public function getPinnedClientEncryptionAlgorithmOutbound();

Procedural Interface

secureblackbox_sftpserver_get($res, 72 );

Default Value

''

Remarks

Encryption algorithm for the outgoing traffic.

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

Data Type

String

PinnedClientInboundEncryptionKeyBits Property (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function getPinnedClientInboundEncryptionKeyBits();

Procedural Interface

secureblackbox_sftpserver_get($res, 73 );

Default Value

0

Remarks

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

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

Data Type

Integer

PinnedClientKexAlgorithm Property (SecureBlackbox_SFTPServer Class)

The key exchange algorithm used during the SSH handshake.

Object Oriented Interface

public function getPinnedClientKexAlgorithm();

Procedural Interface

secureblackbox_sftpserver_get($res, 74 );

Default Value

''

Remarks

The key exchange algorithm used during the SSH handshake.

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

Data Type

String

PinnedClientKexBits Property (SecureBlackbox_SFTPServer Class)

The number of bits used by the key exchange algorithm.

Object Oriented Interface

public function getPinnedClientKexBits();

Procedural Interface

secureblackbox_sftpserver_get($res, 75 );

Default Value

0

Remarks

The number of bits used by the key exchange algorithm.

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

Data Type

Integer

PinnedClientKexLines Property (SecureBlackbox_SFTPServer Class)

The contents of the received KexInit packet.

Object Oriented Interface

public function getPinnedClientKexLines();

Procedural Interface

secureblackbox_sftpserver_get($res, 76 );

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

Data Type

String

PinnedClientMacAlgorithmInbound Property (SecureBlackbox_SFTPServer Class)

MAC algorithm used for the incoming connection.

Object Oriented Interface

public function getPinnedClientMacAlgorithmInbound();

Procedural Interface

secureblackbox_sftpserver_get($res, 77 );

Default Value

''

Remarks

MAC algorithm used for the incoming connection.

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

Data Type

String

PinnedClientMacAlgorithmOutbound Property (SecureBlackbox_SFTPServer Class)

MAC algorithm used for outbound connection.

Object Oriented Interface

public function getPinnedClientMacAlgorithmOutbound();

Procedural Interface

secureblackbox_sftpserver_get($res, 78 );

Default Value

''

Remarks

MAC algorithm used for outbound connection.

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

Data Type

String

PinnedClientOutboundEncryptionKeyBits Property (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function getPinnedClientOutboundEncryptionKeyBits();

Procedural Interface

secureblackbox_sftpserver_get($res, 79 );

Default Value

0

Remarks

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

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

Data Type

Integer

PinnedClientPublicKeyAlgorithm Property (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function getPinnedClientPublicKeyAlgorithm();

Procedural Interface

secureblackbox_sftpserver_get($res, 80 );

Default Value

''

Remarks

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

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

Data Type

String

PinnedClientRemoteAddress Property (SecureBlackbox_SFTPServer Class)

The client's IP address.

Object Oriented Interface

public function getPinnedClientRemoteAddress();

Procedural Interface

secureblackbox_sftpserver_get($res, 81 );

Default Value

''

Remarks

The client's IP address.

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

Data Type

String

PinnedClientRemotePort Property (SecureBlackbox_SFTPServer Class)

The remote port of the client connection.

Object Oriented Interface

public function getPinnedClientRemotePort();

Procedural Interface

secureblackbox_sftpserver_get($res, 82 );

Default Value

0

Remarks

The remote port of the client connection.

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

Data Type

Integer

PinnedClientServerKeyAlgorithm Property (SecureBlackbox_SFTPServer Class)

Specifies the server's key algorithm.

Object Oriented Interface

public function getPinnedClientServerKeyAlgorithm();

Procedural Interface

secureblackbox_sftpserver_get($res, 83 );

Default Value

''

Remarks

Specifies the server's key algorithm.

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

Data Type

String

PinnedClientServerKeyBits Property (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function getPinnedClientServerKeyBits();

Procedural Interface

secureblackbox_sftpserver_get($res, 84 );

Default Value

0

Remarks

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

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

Data Type

Integer

PinnedClientServerKeyFingerprint Property (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function getPinnedClientServerKeyFingerprint();

Procedural Interface

secureblackbox_sftpserver_get($res, 85 );

Default Value

''

Remarks

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

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

Data Type

String

PinnedClientServerSoftwareName Property (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function getPinnedClientServerSoftwareName();

Procedural Interface

secureblackbox_sftpserver_get($res, 86 );

Default Value

''

Remarks

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

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

Data Type

String

PinnedClientTotalBytesReceived Property (SecureBlackbox_SFTPServer Class)

Returns the total number of bytes received over this connection.

Object Oriented Interface

public function getPinnedClientTotalBytesReceived();

Procedural Interface

secureblackbox_sftpserver_get($res, 87 );

Default Value

0

Remarks

Returns the total number of bytes received over this connection.

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

Data Type

Long64

PinnedClientTotalBytesSent Property (SecureBlackbox_SFTPServer Class)

Returns the total number of bytes sent over this connection.

Object Oriented Interface

public function getPinnedClientTotalBytesSent();

Procedural Interface

secureblackbox_sftpserver_get($res, 88 );

Default Value

0

Remarks

Returns the total number of bytes sent over this connection.

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

Data Type

Long64

PinnedClientVersion Property (SecureBlackbox_SFTPServer Class)

Specifies SSH protocol version.

Object Oriented Interface

public function getPinnedClientVersion();

Procedural Interface

secureblackbox_sftpserver_get($res, 89 );

Default Value

2

Remarks

Specifies SSH protocol version.

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

Data Type

Integer

Port Property (SecureBlackbox_SFTPServer Class)

Specifies the listening port number.

Object Oriented Interface

public function getPort();


public function setPort($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 90 );


secureblackbox_sftpserver_set($res, 90, $value );

Default Value

22

Remarks

Use this property to specify on which port the class will be listening to client connections.

Data Type

Integer

ReadOnly Property (SecureBlackbox_SFTPServer Class)

Specifies whether files on the server are read-only.

Object Oriented Interface

public function getReadOnly();


public function setReadOnly($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 91 );


secureblackbox_sftpserver_set($res, 91, $value );

Default Value

false

Remarks

Set this property to true to deny all client requests to change files on the server.

Data Type

Boolean

ServerKeyCount Property (SecureBlackbox_SFTPServer Class)

The number of records in the ServerKey arrays.

Object Oriented Interface

public function getServerKeyCount();


public function setServerKeyCount($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 92 );


secureblackbox_sftpserver_set($res, 92, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ServerKeyAlgorithm
• ServerKeyBits
• ServerKeyFingerprintMD5
• ServerKeyFingerprintSHA1
• ServerKeyHandle

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

This property is not available at design time.

Data Type

Integer

ServerKeyAlgorithm Property (SecureBlackbox_SFTPServer Class)

Specifies the key algorithm.

Object Oriented Interface

public function getServerKeyAlgorithm($serverkeyindex);

Procedural Interface

secureblackbox_sftpserver_get($res, 93 , $serverkeyindex);

Default Value

''

Remarks

Specifies the key algorithm.

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

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

Data Type

String

ServerKeyBits Property (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function getServerKeyBits($serverkeyindex);

Procedural Interface

secureblackbox_sftpserver_get($res, 94 , $serverkeyindex);

Default Value

0

Remarks

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

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

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

Data Type

Integer

ServerKeyFingerprintMD5 Property (SecureBlackbox_SFTPServer Class)

Contains the MD5 fingerprint (hash) of the key.

Object Oriented Interface

public function getServerKeyFingerprintMD5($serverkeyindex);

Procedural Interface

secureblackbox_sftpserver_get($res, 107 , $serverkeyindex);

Default Value

''

Remarks

Contains the MD5 fingerprint (hash) of the key.

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

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

Data Type

String

ServerKeyFingerprintSHA1 Property (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function getServerKeyFingerprintSHA1($serverkeyindex);

Procedural Interface

secureblackbox_sftpserver_get($res, 108 , $serverkeyindex);

Default Value

''

Remarks

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

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

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

Data Type

String

ServerKeyHandle Property (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function getServerKeyHandle($serverkeyindex);


public function setServerKeyHandle($serverkeyindex, $value);

Procedural Interface

secureblackbox_sftpserver_get($res, 110 , $serverkeyindex);


secureblackbox_sftpserver_set($res, 110, $value , $serverkeyindex);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

SocketIncomingSpeedLimit Property (SecureBlackbox_SFTPServer 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_sftpserver_get($res, 130 );


secureblackbox_sftpserver_set($res, 130, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (SecureBlackbox_SFTPServer Class)

The local network interface to bind the socket to.

Object Oriented Interface

public function getSocketLocalAddress();


public function setSocketLocalAddress($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 131 );


secureblackbox_sftpserver_set($res, 131, $value );

Default Value

''

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SecureBlackbox_SFTPServer Class)

The local port number to bind the socket to.

Object Oriented Interface

public function getSocketLocalPort();


public function setSocketLocalPort($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 132 );


secureblackbox_sftpserver_set($res, 132, $value );

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SecureBlackbox_SFTPServer 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_sftpserver_get($res, 133 );


secureblackbox_sftpserver_set($res, 133, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (SecureBlackbox_SFTPServer 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_sftpserver_get($res, 134 );


secureblackbox_sftpserver_set($res, 134, $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_SFTPServer Class)

Enables or disables IP protocol version 6.

Object Oriented Interface

public function getSocketUseIPv6();


public function setSocketUseIPv6($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 135 );


secureblackbox_sftpserver_set($res, 135, $value );

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

SSHSettingsAutoAdjustCiphers Property (SecureBlackbox_SFTPServer 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_sftpserver_get($res, 136 );


secureblackbox_sftpserver_set($res, 136, $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_SFTPServer 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_sftpserver_get($res, 137 );


secureblackbox_sftpserver_set($res, 137, $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_SFTPServer 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_sftpserver_get($res, 138 );


secureblackbox_sftpserver_set($res, 138, $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_SFTPServer 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_sftpserver_get($res, 139 );


secureblackbox_sftpserver_set($res, 139, $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_SFTPServer 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_sftpserver_get($res, 140 );


secureblackbox_sftpserver_set($res, 140, $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_SFTPServer 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_sftpserver_get($res, 141 );


secureblackbox_sftpserver_set($res, 141, $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_SFTPServer Class)

Whether the SSH client should explicitly request compression.

Object Oriented Interface

public function getSSHSettingsForceCompression();


public function setSSHSettingsForceCompression($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 142 );


secureblackbox_sftpserver_set($res, 142, $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

SSHSettingsForwardAuthAgent Property (SecureBlackbox_SFTPServer Class)

Enables or disables auth agent forwarding.

Object Oriented Interface

public function getSSHSettingsForwardAuthAgent();


public function setSSHSettingsForwardAuthAgent($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 143 );


secureblackbox_sftpserver_set($res, 143, $value );

Default Value

false

Remarks

Enables or disables auth agent forwarding. This allows the class to connect to the second and subsequent servers in the chain with the key agent available on the client computer.

Data Type

Boolean

SSHSettingsGSSAuthTypes Property (SecureBlackbox_SFTPServer Class)

A comma-separated list of authentication types.

Object Oriented Interface

public function getSSHSettingsGSSAuthTypes();


public function setSSHSettingsGSSAuthTypes($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 144 );


secureblackbox_sftpserver_set($res, 144, $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_SFTPServer Class)

Switches credential delegation on or off.

Object Oriented Interface

public function getSSHSettingsGSSDelegateCreds();


public function setSSHSettingsGSSDelegateCreds($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 145 );


secureblackbox_sftpserver_set($res, 145, $value );

Default Value

false

Remarks

Switches credential delegation on or off.

Data Type

Boolean

SSHSettingsGSSHostname Property (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function getSSHSettingsGSSHostname();


public function setSSHSettingsGSSHostname($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 146 );


secureblackbox_sftpserver_set($res, 146, $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_SFTPServer Class)

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

Object Oriented Interface

public function getSSHSettingsGSSLib();


public function setSSHSettingsGSSLib($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 147 );


secureblackbox_sftpserver_set($res, 147, $value );

Default Value

''

Remarks

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

Data Type

String

SSHSettingsGSSMechanisms Property (SecureBlackbox_SFTPServer Class)

A comma-separated list of GSS mechanisms to use.

Object Oriented Interface

public function getSSHSettingsGSSMechanisms();


public function setSSHSettingsGSSMechanisms($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 148 );


secureblackbox_sftpserver_set($res, 148, $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_SFTPServer Class)

A comma-separated list of SSPI protocols.

Object Oriented Interface

public function getSSHSettingsGSSProtocols();


public function setSSHSettingsGSSProtocols($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 149 );


secureblackbox_sftpserver_set($res, 149, $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_SFTPServer 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_sftpserver_get($res, 150 );


secureblackbox_sftpserver_set($res, 150, $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_SFTPServer 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_sftpserver_get($res, 151 );


secureblackbox_sftpserver_set($res, 151, $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_SFTPServer 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_sftpserver_get($res, 152 );


secureblackbox_sftpserver_set($res, 152, $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_SFTPServer Class)

Specifies the maximum length of one SSH packet in bytes.

Object Oriented Interface

public function getSSHSettingsMaxSSHPacketSize();


public function setSSHSettingsMaxSSHPacketSize($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 153 );


secureblackbox_sftpserver_set($res, 153, $value );

Default Value

262144

Remarks

Specifies the maximum length of one SSH packet in bytes.

Data Type

Integer

SSHSettingsMinWindowSize Property (SecureBlackbox_SFTPServer Class)

Specifies the minimal internal window size.

Object Oriented Interface

public function getSSHSettingsMinWindowSize();


public function setSSHSettingsMinWindowSize($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 154 );


secureblackbox_sftpserver_set($res, 154, $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_SFTPServer Class)

Enables or disables handshake obfuscation.

Object Oriented Interface

public function getSSHSettingsObfuscateHandshake();


public function setSSHSettingsObfuscateHandshake($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 155 );


secureblackbox_sftpserver_set($res, 155, $value );

Default Value

false

Remarks

Enables or disables handshake obfuscation.

Data Type

Boolean

SSHSettingsObfuscationPassword Property (SecureBlackbox_SFTPServer 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_sftpserver_get($res, 156 );


secureblackbox_sftpserver_set($res, 156, $value );

Default Value

''

Remarks

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

Data Type

String

SSHSettingsPublicKeyAlgorithms Property (SecureBlackbox_SFTPServer 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_sftpserver_get($res, 157 );


secureblackbox_sftpserver_set($res, 157, $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_SFTPServer Class)

Whether to request a password change when connecting.

Object Oriented Interface

public function getSSHSettingsRequestPasswordChange();


public function setSSHSettingsRequestPasswordChange($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 158 );


secureblackbox_sftpserver_set($res, 158, $value );

Default Value

false

Remarks

Whether to request a password change when connecting.

Data Type

Boolean

SSHSettingsSoftwareName Property (SecureBlackbox_SFTPServer 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_sftpserver_get($res, 159 );


secureblackbox_sftpserver_set($res, 159, $value );

Default Value

'SecureBlackbox'

Remarks

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

Data Type

String

SSHSettingsTrustAllKeys Property (SecureBlackbox_SFTPServer Class)

Enables or disables explicit trust to all server keys.

Object Oriented Interface

public function getSSHSettingsTrustAllKeys();


public function setSSHSettingsTrustAllKeys($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 160 );


secureblackbox_sftpserver_set($res, 160, $value );

Default Value

false

Remarks

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

Data Type

Boolean

SSHSettingsUseAuthAgent Property (SecureBlackbox_SFTPServer 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_sftpserver_get($res, 161 );


secureblackbox_sftpserver_set($res, 161, $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_SFTPServer Class)

Specifies enabled SSH protocol versions (1 or 2).

Object Oriented Interface

public function getSSHSettingsVersions();


public function setSSHSettingsVersions($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 162 );


secureblackbox_sftpserver_set($res, 162, $value );

Default Value

1

Remarks

Specifies enabled SSH protocol versions (1 or 2).

Data Type

Integer

UserCount Property (SecureBlackbox_SFTPServer Class)

The number of records in the User arrays.

Object Oriented Interface

public function getUserCount();


public function setUserCount($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 163 );


secureblackbox_sftpserver_set($res, 163, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

This property is not available at design time.

Data Type

Integer

UserAssociatedData Property (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function getUserAssociatedData($userindex);


public function setUserAssociatedData($userindex, $value);

Procedural Interface

secureblackbox_sftpserver_get($res, 164 , $userindex);


secureblackbox_sftpserver_set($res, 164, $value , $userindex);

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

UserBasePath Property (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function getUserBasePath($userindex);


public function setUserBasePath($userindex, $value);

Procedural Interface

secureblackbox_sftpserver_get($res, 165 , $userindex);


secureblackbox_sftpserver_set($res, 165, $value , $userindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

UserCertificate Property (SecureBlackbox_SFTPServer Class)

Contains the user's certificate.

Object Oriented Interface

public function getUserCertificate($userindex);


public function setUserCertificate($userindex, $value);

Procedural Interface

secureblackbox_sftpserver_get($res, 166 , $userindex);


secureblackbox_sftpserver_set($res, 166, $value , $userindex);

Remarks

Contains the user's certificate.

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

This property is not available at design time.

Data Type

Byte Array

UserData Property (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function getUserData($userindex);


public function setUserData($userindex, $value);

Procedural Interface

secureblackbox_sftpserver_get($res, 167 , $userindex);


secureblackbox_sftpserver_set($res, 167, $value , $userindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

UserEmail Property (SecureBlackbox_SFTPServer Class)

The user's email address.

Object Oriented Interface

public function getUserEmail($userindex);


public function setUserEmail($userindex, $value);

Procedural Interface

secureblackbox_sftpserver_get($res, 168 , $userindex);


secureblackbox_sftpserver_set($res, 168, $value , $userindex);

Default Value

''

Remarks

The user's email address.

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

This property is not available at design time.

Data Type

String

UserHandle Property (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function getUserHandle($userindex);


public function setUserHandle($userindex, $value);

Procedural Interface

secureblackbox_sftpserver_get($res, 169 , $userindex);


secureblackbox_sftpserver_set($res, 169, $value , $userindex);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

UserHashAlgorithm Property (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function getUserHashAlgorithm($userindex);


public function setUserHashAlgorithm($userindex, $value);

Procedural Interface

secureblackbox_sftpserver_get($res, 170 , $userindex);


secureblackbox_sftpserver_set($res, 170, $value , $userindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

UserIncomingSpeedLimit Property (SecureBlackbox_SFTPServer Class)

Specifies the incoming speed limit for this user.

Object Oriented Interface

public function getUserIncomingSpeedLimit($userindex);


public function setUserIncomingSpeedLimit($userindex, $value);

Procedural Interface

secureblackbox_sftpserver_get($res, 171 , $userindex);


secureblackbox_sftpserver_set($res, 171, $value , $userindex);

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Integer

UserOtpAlgorithm Property (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function getUserOtpAlgorithm($userindex);


public function setUserOtpAlgorithm($userindex, $value);

Procedural Interface

secureblackbox_sftpserver_get($res, 172 , $userindex);


secureblackbox_sftpserver_set($res, 172, $value , $userindex);

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Integer

UserOTPLen Property (SecureBlackbox_SFTPServer Class)

Specifies the length of the user's OTP password.

Object Oriented Interface

public function getUserOTPLen($userindex);


public function setUserOTPLen($userindex, $value);

Procedural Interface

secureblackbox_sftpserver_get($res, 173 , $userindex);


secureblackbox_sftpserver_set($res, 173, $value , $userindex);

Default Value

0

Remarks

Specifies the length of the user's OTP password.

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

This property is not available at design time.

Data Type

Integer

UserOtpValue Property (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function getUserOtpValue($userindex);


public function setUserOtpValue($userindex, $value);

Procedural Interface

secureblackbox_sftpserver_get($res, 174 , $userindex);


secureblackbox_sftpserver_set($res, 174, $value , $userindex);

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Integer

UserOutgoingSpeedLimit Property (SecureBlackbox_SFTPServer Class)

Specifies the outgoing speed limit for this user.

Object Oriented Interface

public function getUserOutgoingSpeedLimit($userindex);


public function setUserOutgoingSpeedLimit($userindex, $value);

Procedural Interface

secureblackbox_sftpserver_get($res, 175 , $userindex);


secureblackbox_sftpserver_set($res, 175, $value , $userindex);

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Integer

UserPassword Property (SecureBlackbox_SFTPServer Class)

The user's authentication password.

Object Oriented Interface

public function getUserPassword($userindex);


public function setUserPassword($userindex, $value);

Procedural Interface

secureblackbox_sftpserver_get($res, 176 , $userindex);


secureblackbox_sftpserver_set($res, 176, $value , $userindex);

Default Value

''

Remarks

The user's authentication password.

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

This property is not available at design time.

Data Type

String

UserSharedSecret Property (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function getUserSharedSecret($userindex);


public function setUserSharedSecret($userindex, $value);

Procedural Interface

secureblackbox_sftpserver_get($res, 177 , $userindex);


secureblackbox_sftpserver_set($res, 177, $value , $userindex);

Remarks

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

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

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

This property is not available at design time.

Data Type

Byte Array

UserSSHKey Property (SecureBlackbox_SFTPServer Class)

Contains the user's SSH key.

Object Oriented Interface

public function getUserSSHKey($userindex);


public function setUserSSHKey($userindex, $value);

Procedural Interface

secureblackbox_sftpserver_get($res, 178 , $userindex);


secureblackbox_sftpserver_set($res, 178, $value , $userindex);

Remarks

Contains the user's SSH key.

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

This property is not available at design time.

Data Type

Byte Array

UserUsername Property (SecureBlackbox_SFTPServer Class)

The registered name (login) of the user.

Object Oriented Interface

public function getUserUsername($userindex);


public function setUserUsername($userindex, $value);

Procedural Interface

secureblackbox_sftpserver_get($res, 179 , $userindex);


secureblackbox_sftpserver_set($res, 179, $value , $userindex);

Default Value

''

Remarks

The registered name (login) of the user.

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

This property is not available at design time.

Data Type

String

UseUTF8 Property (SecureBlackbox_SFTPServer Class)

Specifies whether UTF8 conversion is to be used when parsing file names.

Object Oriented Interface

public function getUseUTF8();


public function setUseUTF8($value);

Procedural Interface

secureblackbox_sftpserver_get($res, 180 );


secureblackbox_sftpserver_set($res, 180, $value );

Default Value

false

Remarks

This property specifies whether UTF8 conversion of filenames is used by the server. It is set automatically according to protocol flow, but user could also set it to the desired value.

Data Type

Boolean

Cleanup Method (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function doCleanup();

Procedural Interface

secureblackbox_sftpserver_do_cleanup($res);

Remarks

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

Config Method (SecureBlackbox_SFTPServer Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_sftpserver_do_config($res, $configurationstring);

Remarks

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

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

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

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

DoAction Method (SecureBlackbox_SFTPServer Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

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

Remarks

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

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

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

DropClient Method (SecureBlackbox_SFTPServer Class)

Terminates a client connection.

Object Oriented Interface

public function doDropClient($connectionid, $forced);

Procedural Interface

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

Remarks

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

GetClientBuffer Method (SecureBlackbox_SFTPServer Class)

Acquires a piece of operation data.

Object Oriented Interface

public function doGetClientBuffer($connectionid, $handle);

Procedural Interface

secureblackbox_sftpserver_do_getclientbuffer($res, $connectionid, $handle);

Remarks

Use this method to obtain a piece of data relevant to a transfer operation in a thread-safe way.

A typical place to call this method is inside the WriteFile event handler, when implementing customized file transfers.

GetClientFileEntry Method (SecureBlackbox_SFTPServer Class)

Acquires file entry details from the class.

Object Oriented Interface

public function doGetClientFileEntry($connectionid, $handle);

Procedural Interface

secureblackbox_sftpserver_do_getclientfileentry($res, $connectionid, $handle);

Remarks

Use this method to acquire the details of a file entry from the server in atomic and thread-safe way. After this method completes, the entry details will be propagated in ClientFileEntry property.

When calling this method, pass the client connection ID in ConnectionID property, and the opened file handle (if needed) in Handle property.

ListClients Method (SecureBlackbox_SFTPServer Class)

Enumerates the connected clients.

Object Oriented Interface

public function doListClients();

Procedural Interface

secureblackbox_sftpserver_do_listclients($res);

Remarks

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

PinClient Method (SecureBlackbox_SFTPServer Class)

Takes a snapshot of the connection's properties.

Object Oriented Interface

public function doPinClient($connectionid);

Procedural Interface

secureblackbox_sftpserver_do_pinclient($res, $connectionid);

Remarks

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

Reset Method (SecureBlackbox_SFTPServer Class)

Resets the class settings.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_sftpserver_do_reset($res);

Remarks

Reset is a generic method available in every class.

SetClientBuffer Method (SecureBlackbox_SFTPServer Class)

Commits a data buffer to the server class.

Object Oriented Interface

public function doSetClientBuffer($connectionid, $handle, $value);

Procedural Interface

secureblackbox_sftpserver_do_setclientbuffer($res, $connectionid, $handle, $value);

Remarks

Use this method to commit a data buffer passed via the Value parameter to the server control in a thread-safe way.

One example where you might need to pass your buffer to the server is when customizing upload operations via ReadFile event.

SetClientFileEntry Method (SecureBlackbox_SFTPServer Class)

Commits the file entry details to the class.

Object Oriented Interface

public function doSetClientFileEntry($connectionid, $handle);

Procedural Interface

secureblackbox_sftpserver_do_setclientfileentry($res, $connectionid, $handle);

Remarks

Use this method to commit the file entry details configured in ClientFileEntry property to the server object in a thread-safe way. Pass the client's connection ID via ConnectionID property, and the file entry's handle via Handle.

Start Method (SecureBlackbox_SFTPServer Class)

Starts SFTP server operation.

Object Oriented Interface

public function doStart();

Procedural Interface

secureblackbox_sftpserver_do_start($res);

Remarks

Call this method to start listening to incoming connections.

Stop Method (SecureBlackbox_SFTPServer Class)

Stops SFTP server.

Object Oriented Interface

public function doStop();

Procedural Interface

secureblackbox_sftpserver_do_stop($res);

Remarks

Call this method to close all connections and stop listening to clients.

Accept Event (SecureBlackbox_SFTPServer Class)

This event is fired when new incoming connection is accepted.

Object Oriented Interface

public function fireAccept($param);

Procedural Interface

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

Parameter List

 'remoteaddress'
 'remoteport'
 'accept'

Remarks

This event is fired by the class before a new incoming connection is accepted. RemoteAddress contains the IP address of the connecting client. Use the Accept parameter to either accept, or reject the connection.

AfterCreateDirectory Event (SecureBlackbox_SFTPServer Class)

This event indicates completion of directory creation request.

Object Oriented Interface

public function fireAfterCreateDirectory($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 2, array($this, 'fireAfterCreateDirectory'));

Parameter List

 'connectionid'
 'path'
 'operationstatus'

Remarks

This event is fired to report completion of a directory creation request. The ConnectionID parameter specifies in which session the request was received, the Path specifies the directory path, and the OperationStatus contains the operation result.

If needed, you can amend the OperationStatus to return a different operation result:

AfterRemove Event (SecureBlackbox_SFTPServer Class)

This event indicates completion of file removal request.

Object Oriented Interface

public function fireAfterRemove($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 3, array($this, 'fireAfterRemove'));

Parameter List

 'connectionid'
 'path'
 'operationstatus'

Remarks

This event is fired when a request to delete a file or directory has been processed by the server. The ConnectionID parameter specifies the session in which the request was received. OperationStatus contains the operation result.

If needed, you can amend the OperationStatus to return a different operation result:

AfterRenameFile Event (SecureBlackbox_SFTPServer Class)

This event indicates completion of a file rename operation.

Object Oriented Interface

public function fireAfterRenameFile($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 4, array($this, 'fireAfterRenameFile'));

Parameter List

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

Remarks

This event is fired when a request to rename a file (from OldPath to NewPath) has been processed. The ConnectionID parameter specifies in which session the request was received, and OperationStatus contains the operation result.

If needed, you can amend the OperationStatus to return a different operation result:

AfterRequestAttributes Event (SecureBlackbox_SFTPServer Class)

This event indicates completion of file attributes request.

Object Oriented Interface

public function fireAfterRequestAttributes($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 5, array($this, 'fireAfterRequestAttributes'));

Parameter List

 'connectionid'
 'path'
 'operationstatus'

Remarks

This event is fired when a request for get file attributes has been processed by the server. The ConnectionID parameter specifies in which session the request was received. OperationStatus contains the result of the operation.

If needed, you can amend the OperationStatus to return a different operation result:

AfterSetAttributes Event (SecureBlackbox_SFTPServer Class)

This event indicates completion of a set attributes request.

Object Oriented Interface

public function fireAfterSetAttributes($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 6, array($this, 'fireAfterSetAttributes'));

Parameter List

 'connectionid'
 'path'
 'operationstatus'

Remarks

This event is fired when a request for set file attributes has been processed. The ConnectionID parameter specifies in which session the request was received. The OperationStatus parameter contains the operation result.

If needed, you can amend the OperationStatus to return a different operation result:

AuthAttempt Event (SecureBlackbox_SFTPServer Class)

Reports a user authentication attempt.

Object Oriented Interface

public function fireAuthAttempt($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 7, array($this, 'fireAuthAttempt'));

Parameter List

 'connectionid'
 'username'
 'authtype'
 'accept'

Remarks

ConnectionID identifies the session, Username specifies client's username, and AuthType specifies the authentication type. Use the Accept parameter to accept or decline the attempt.

Supported authentication types:

AuthFailed Event (SecureBlackbox_SFTPServer Class)

Reports user authentication failure.

Object Oriented Interface

public function fireAuthFailed($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 8, array($this, 'fireAuthFailed'));

Parameter List

 'connectionid'
 'username'
 'authtype'

Remarks

ConnectionID identifies the session, Username specify client's username, and AuthType specifies what authentication type was used.

Supported authentication types:

AuthPassword Event (SecureBlackbox_SFTPServer Class)

This event is fired on password authentication attempt from a client.

Object Oriented Interface

public function fireAuthPassword($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 9, array($this, 'fireAuthPassword'));

Parameter List

 'connectionid'
 'username'
 'password'
 'accept'
 'forcechangepassword'

Remarks

Parameters Username and Password contain user credentials. If they are correct, set Accept to true. You can request password change by setting ForceChangePassword to true.

AuthPublicKey Event (SecureBlackbox_SFTPServer Class)

This event is fired on public key authentication attempt from a client.

Object Oriented Interface

public function fireAuthPublicKey($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 10, array($this, 'fireAuthPublicKey'));

Parameter List

 'connectionid'
 'username'
 'accept'

Remarks

Username specifies client's username, and Accept is used to accept or reject authentication.

AuthSucceeded Event (SecureBlackbox_SFTPServer Class)

Reports a successful user authentication.

Object Oriented Interface

public function fireAuthSucceeded($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 11, array($this, 'fireAuthSucceeded'));

Parameter List

 'connectionid'
 'username'
 'authtype'

Remarks

ConnectionID identifies the session, Username specify client's username, and AuthType specifies what authentication type was used.

Supported authentication types:

BeforeCreateDirectory Event (SecureBlackbox_SFTPServer Class)

This event is fired when a client requests to create a directory.

Object Oriented Interface

public function fireBeforeCreateDirectory($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 12, array($this, 'fireBeforeCreateDirectory'));

Parameter List

 'connectionid'
 'path'
 'action'

Remarks

This event is fired when a request to create a directory has been received. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

BeforeDownloadFile Event (SecureBlackbox_SFTPServer Class)

This event is fired when a download file request is received.

Object Oriented Interface

public function fireBeforeDownloadFile($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 13, array($this, 'fireBeforeDownloadFile'));

Parameter List

 'connectionid'
 'path'
 'action'

Remarks

This event is fired when a request to download file is received from the client. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

BeforeFind Event (SecureBlackbox_SFTPServer Class)

This event is fired when a client requests to find files and folders in Path.

Object Oriented Interface

public function fireBeforeFind($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 14, array($this, 'fireBeforeFind'));

Parameter List

 'connectionid'
 'path'
 'action'

Remarks

This event is fired when a request to find files and folders in Path has been received. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

BeforeOpenClientForwarding Event (SecureBlackbox_SFTPServer Class)

This event is fired when a client requests to set up client-side (local) forwarding channel.

Object Oriented Interface

public function fireBeforeOpenClientForwarding($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 15, array($this, 'fireBeforeOpenClientForwarding'));

Parameter List

 'connectionid'
 'desthost'
 'destport'
 'srchost'
 'srcport'
 'action'

Remarks

This event is fired when a request to open a client forwarding has been received. The ConnectionID parameter specifies in which session the request was received.

If permitted, the server will open a connection to DestHost:DestPort and start forwarding any data received from the client to that endpoint. You can enable or disable client forwarding blanketly via the Capabilities property.

Choose Action as one of the following values:

BeforeOpenCommand Event (SecureBlackbox_SFTPServer Class)

This event is fired when a client requests a command channel.

Object Oriented Interface

public function fireBeforeOpenCommand($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 16, array($this, 'fireBeforeOpenCommand'));

Parameter List

 'connectionid'
 'command'
 'action'

Remarks

This event is fired when a request to open a command has been received. The ConnectionID parameter specifies in which session the request was received.

If permitted, the component will launch the command in a separate process. Note that allowing command access to all clients can be dangerous. You can enable or disable command support blanketly via the Capabilities property.

Choose Action as one of the following values:

BeforeOpenServerForwarding Event (SecureBlackbox_SFTPServer Class)

This event is fired when the server has received an incoming connection and needs to set up server-side (remote) forwarding channel.

Object Oriented Interface

public function fireBeforeOpenServerForwarding($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 17, array($this, 'fireBeforeOpenServerForwarding'));

Parameter List

 'connectionid'
 'localhost'
 'localport'
 'srchost'
 'srcport'
 'action'

Remarks

The ConnectionID parameter specifies in which session the request was received.

If permitted, the server will accept the connection and ask the client to confirm forwarding to DestHost:DestPort. If that is successful, the server will fire the OpenServerForwarding event.

You can enable or disable client forwarding blanketly via the Capabilities property.

Choose Action as one of the following values:

BeforeOpenShell Event (SecureBlackbox_SFTPServer Class)

This event is fired when a client requests a shell channel.

Object Oriented Interface

public function fireBeforeOpenShell($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 18, array($this, 'fireBeforeOpenShell'));

Parameter List

 'connectionid'
 'action'

Remarks

This event is fired when a request to open a shell has been received. The ConnectionID parameter specifies in which session the request was received.

If permitted, the client will be able to send commands to the shell. Note that allowing shell access to all clients can be dangerous. You can enable or disable shell access blanketly via the Capabilities property.

Choose Action as one of the following values:

BeforeRemove Event (SecureBlackbox_SFTPServer Class)

This event is fired when a client requests to delete a file or directory.

Object Oriented Interface

public function fireBeforeRemove($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 19, array($this, 'fireBeforeRemove'));

Parameter List

 'connectionid'
 'path'
 'action'

Remarks

This event is fired when a request to delete a file or directory is received from the client. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

BeforeRenameFile Event (SecureBlackbox_SFTPServer Class)

This event is fired when a client requests to rename a file.

Object Oriented Interface

public function fireBeforeRenameFile($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 20, array($this, 'fireBeforeRenameFile'));

Parameter List

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

Remarks

This event is fired when a request to rename a file (from OldPath to NewPath) is received from the client. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

BeforeRequestAttributes Event (SecureBlackbox_SFTPServer Class)

This event is fired when a client requests to get file attributes.

Object Oriented Interface

public function fireBeforeRequestAttributes($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 21, array($this, 'fireBeforeRequestAttributes'));

Parameter List

 'connectionid'
 'path'
 'action'

Remarks

This event is fired when a request to get file attributes has been received. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

BeforeSetAttributes Event (SecureBlackbox_SFTPServer Class)

This event is fired when a client requests to set file attributes.

Object Oriented Interface

public function fireBeforeSetAttributes($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 22, array($this, 'fireBeforeSetAttributes'));

Parameter List

 'connectionid'
 'path'
 'action'

Remarks

This event is fired when a request to set file attributes has been received. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

BeforeUploadFile Event (SecureBlackbox_SFTPServer Class)

This event is fired when an upload file request is received.

Object Oriented Interface

public function fireBeforeUploadFile($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 23, array($this, 'fireBeforeUploadFile'));

Parameter List

 'connectionid'
 'path'
 'action'

Remarks

This event is fired when an upload file request is received from the client. The ConnectionID parameter specifies in which session the request was received, and Path specifies the location on the server where the file needs to be saved.

Choose Action as one of the following values:

CloseClientForwarding Event (SecureBlackbox_SFTPServer Class)

This event is fired when a client has closed a previously opened forwarding channel.

Object Oriented Interface

public function fireCloseClientForwarding($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 24, array($this, 'fireCloseClientForwarding'));

Parameter List

 'connectionid'
 'desthost'
 'destport'
 'srchost'
 'srcport'

Remarks

The ConnectionID parameter specifies in which session the request was received.

CloseCommand Event (SecureBlackbox_SFTPServer Class)

This event is fired when a client has closed a previously opened SSH command channel.

Object Oriented Interface

public function fireCloseCommand($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 25, array($this, 'fireCloseCommand'));

Parameter List

 'connectionid'
 'command'

Remarks

The ConnectionID parameter specifies in which session the request was received.

CloseFile Event (SecureBlackbox_SFTPServer Class)

This event instructs the application to close an opened file.

Object Oriented Interface

public function fireCloseFile($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 26, array($this, 'fireCloseFile'));

Parameter List

 'connectionid'
 'handle'
 'operationstatus'

Remarks

This event is fired upon receipt of a close-file packet from a client. Servers implementing virtualized transfers must close the previously opened local file referenced by Handle in this event handler. No further operations are allowed with the closed file.

Set OperationStatus to one of the following values to report the result of this operation to the client:

CloseServerForwarding Event (SecureBlackbox_SFTPServer Class)

This event is fired when a client has closed a previously opened forwarding channel.

Object Oriented Interface

public function fireCloseServerForwarding($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 27, array($this, 'fireCloseServerForwarding'));

Parameter List

 'connectionid'
 'localhost'
 'localport'
 'srchost'
 'srcport'

Remarks

The ConnectionID parameter specifies in which session the request was received.

CloseShell Event (SecureBlackbox_SFTPServer Class)

This event is fired when a client has closed a previously opened shell channel.

Object Oriented Interface

public function fireCloseShell($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 28, array($this, 'fireCloseShell'));

Parameter List

 'connectionid'

Remarks

The ConnectionID parameter specifies in which session the request was received.

Connect Event (SecureBlackbox_SFTPServer Class)

This event is fired when a remote connection has been established.

Object Oriented Interface

public function fireConnect($param);

Procedural Interface

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

Parameter List

 'connectionid'
 'remoteaddress'
 'remoteport'

Remarks

ConnectionID contains a session identifier, and RemoteAddress specifies the client's IP address.

CreateDirectory Event (SecureBlackbox_SFTPServer Class)

This event instructs the application to create a directory.

Object Oriented Interface

public function fireCreateDirectory($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 30, array($this, 'fireCreateDirectory'));

Parameter List

 'connectionid'
 'path'
 'operationstatus'

Remarks

This event is fired when a request to create a directory has been received and needs to be served (virtualized) by the application. The ConnectionID parameter specifies the session that has communicated the request, and Path contains the name of the directory to be created.

Set OperationStatus to one of the below values according to the outcome of the request processing:

Disconnect Event (SecureBlackbox_SFTPServer Class)

This event is fired when a client has disconnected.

Object Oriented Interface

public function fireDisconnect($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 31, array($this, 'fireDisconnect'));

Parameter List

 'connectionid'

Remarks

This event reports loss of connection to the client within the session specified by ConnectionID.

Error Event (SecureBlackbox_SFTPServer Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 32, array($this, 'fireError'));

Parameter List

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

Remarks

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

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

ExternalSign Event (SecureBlackbox_SFTPServer Class)

Handles remote or external signing initiated by the server protocol.

Object Oriented Interface

public function fireExternalSign($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 33, array($this, 'fireExternalSign'));

Parameter List

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

Remarks

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

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

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

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

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

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

FindClose Event (SecureBlackbox_SFTPServer Class)

This event signifies the completion of a custom file listing operation.

Object Oriented Interface

public function fireFindClose($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 34, array($this, 'fireFindClose'));

Parameter List

 'connectionid'
 'handle'
 'operationstatus'

Remarks

FindClose notifies your code about the completion of a custom file listing request. Use it in conjunction with FindFirst and FindNext to handle file listing requests manually.

See FindFirst topic for the details on implementing customized file listing request processing.

Set OperationStatus to one of the below values according to the outcome of the request processing:

FindFirst Event (SecureBlackbox_SFTPServer Class)

This event signifies the start of the custom file listing retrieval mechanism.

Object Oriented Interface

public function fireFindFirst($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 35, array($this, 'fireFindFirst'));

Parameter List

 'connectionid'
 'path'
 'operationstatus'
 'handle'

Remarks

FindFirst, FindNext, and FindClose events represent a mechanism for providing customized file listings to class. They are only fired if Action parameter of the preceding BeforeFind event was set to fraCustom.

The behaviour of these events mimics that of the standard FindFirst/FindNext/FindClose functions found in many operating systems/frameworks. FindFirst fires once to request the first list entry; FindNext then fires continuously in a loop to request all subsequent entries. To indicate that the listing is over, set OperationStatus parameter to ostEOF. Not doing so may lead to an endless loop and session freeze, as the component would continue firing FindNext infinitely waiting for the EOF marker.

The handlers for both FindFirst and FindNext events should be implemented in the following way: if there are more entries in the directory to pass back to the server component,

• set OperationStatus to ostOK,
• fill in ClientFileEntry with the details of the next entry,
• commit the entry to the server using SetClientFileEntry method.

When all the entries from the requested directory have been passed to the server component, set OperationStatus to ostEOF. The server will then fire FindClose event to notify your code that the file listing is completed.

Use the by-ref Handle parameter to assign a handle (a unique identifier) to the file listing procedure inside the FindFirst event handler. This identifier will then be passed to all subsequent FindNext and FindClose calls to let your code chain the events together.

The ConnectionID parameter specifies in which SFTP session the request was received, and Path indicates the requested directory.

The following operation status constants are available, besides the ones referenced above:

FindNext Event (SecureBlackbox_SFTPServer Class)

This event retrieves the next entry of a custom file listing.

Object Oriented Interface

public function fireFindNext($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 36, array($this, 'fireFindNext'));

Parameter List

 'connectionid'
 'handle'
 'operationstatus'

Remarks

This event is fired repeatedly after FindFirst to retrieve the directory contents entry-by-entry. Please see the FindFirst topic for more details about implementing a handler of this event.

Remember to set OperationStatus to ostEOF when there are no more entries left to close the listing operation. If there are more entries to pass, set it to ostOK. Other possible values are given in the table below:

ListeningStarted Event (SecureBlackbox_SFTPServer Class)

Fires when the server has started accepting connections on a local port.

Object Oriented Interface

public function fireListeningStarted($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 37, array($this, 'fireListeningStarted'));

Parameter List

 'host'
 'port'

Remarks

This event is fired when the server is ready to accept incoming SSH/SFTP connections.

ListeningStopped Event (SecureBlackbox_SFTPServer Class)

Fires when the server has stopped accepting connections on a local port.

Object Oriented Interface

public function fireListeningStopped($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 38, array($this, 'fireListeningStopped'));

Parameter List

 'host'
 'port'

Remarks

This event is fired when the server has closed the listening socket and can no longer accept incoming SSH/SFTP connections.

Notification Event (SecureBlackbox_SFTPServer Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 39, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

Remarks

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

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

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

OpenClientForwarding Event (SecureBlackbox_SFTPServer Class)

This event is fired when a client opens a client-side (local) forwarding channel.

Object Oriented Interface

public function fireOpenClientForwarding($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 40, array($this, 'fireOpenClientForwarding'));

Parameter List

 'connectionid'
 'desthost'
 'destport'
 'srchost'
 'srcport'

Remarks

This event notifies the application that a client-side forwarding channel has been set up. The ConnectionID parameter specifies in which session the request was received.

The DestHost and DestPort parameters specify the address that the data received from the client will be forwarded to. The SrcHost and SrcPort specify the connection origin that is reported by the client. Note that the details of the origin cannot be verified.

OpenCommand Event (SecureBlackbox_SFTPServer Class)

This event is fired when a client has opened an SSH command channel.

Object Oriented Interface

public function fireOpenCommand($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 41, array($this, 'fireOpenCommand'));

Parameter List

 'connectionid'
 'command'

Remarks

The ConnectionID parameter specifies in which session the request was received.

The component fires CloseCommand when the command channel is closed.

OpenFile Event (SecureBlackbox_SFTPServer Class)

This event instructs the application to handle the file open request.

Object Oriented Interface

public function fireOpenFile($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 42, array($this, 'fireOpenFile'));

Parameter List

 'connectionid'
 'path'
 'modes'
 'access'
 'operationstatus'
 'handle'

Remarks

This event is fired when a file open request is received from the client and needs to be handled (virtualized) by the server. The ConnectionID parameter specifies in which session the request was received, and Path specifies the location of the file.

Modes can be a combination of one or several file open mode flags:

Different client applications may provide different selections of mode flags. For example, some clients specify (cfmCreate + cfmTruncate) when overwriting files, whereas others would specify cfmOpenOrCreate. Please make sure your code is prepared to receive different combinations of flags here and handles them gracefully.

The Access parameter provides additional file access modifiers:

These parameter may also contain a combination of the above flags. Access modifiers are only supported in SFTPv6, and in practice are rarely used by client applications.

The Handle string represents a unique identifier of the opened file, similar to file handles used in Windows or Unix APIs. Handles are unique across all files opened at the same time. Class generates handles automatically, but you can update the auto-generated values with your own in this event handler (just remember to keep them unique).

Set OperationStatus parameter in accordance with the outcome of the operation to one of the values given below:

OpenServerForwarding Event (SecureBlackbox_SFTPServer Class)

This event is fired when the server opens a server-side (remote) forwarding channel.

Object Oriented Interface

public function fireOpenServerForwarding($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 43, array($this, 'fireOpenServerForwarding'));

Parameter List

 'connectionid'
 'localhost'
 'localport'
 'srchost'
 'srcport'

Remarks

This event notifies the application that a server-side forwarding channel has been set up. The ConnectionID parameter specifies in which session the request was received.

The DestHost and DestPort parameters specify the address that the data received from the connection accepted by the server will be forwarded to, according to the client. The SrcHost and SrcPort specify the connection origin.

OpenShell Event (SecureBlackbox_SFTPServer Class)

This event is fired when a client has opened a shell channel.

Object Oriented Interface

public function fireOpenShell($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 44, array($this, 'fireOpenShell'));

Parameter List

 'connectionid'

Remarks

The ConnectionID parameter specifies in which session the request was received.

The component fires CloseShell when the shell channel is closed.

ReadFile Event (SecureBlackbox_SFTPServer Class)

This event is fired when a file read request is received.

Object Oriented Interface

public function fireReadFile($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 45, array($this, 'fireReadFile'));

Parameter List

 'connectionid'
 'handle'
 'offset'
 'size'
 'operationstatus'

Remarks

This event is fired when a request to read block from a file is received from the client. The ConnectionID parameter specifies in which session the request was received, and Handle indicates an opened file handle. Offset and Size denote the location and size of the file piece.

Inside the event handler, pass the appropriate file chunk to the component via SetClientBuffer method.

Set OperationStatus to one of the below values according to the outcome of the request processing:

Remove Event (SecureBlackbox_SFTPServer Class)

This event is fired when a client requests to delete a file or directory.

Object Oriented Interface

public function fireRemove($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 46, array($this, 'fireRemove'));

Parameter List

 'connectionid'
 'path'
 'operationstatus'

Remarks

This event is fired when a request to delete a file or directory is received from the client. The ConnectionID parameter specifies in which session the request was received.

Set OperationStatus to one of the below values according to the outcome of the request processing:

RenameFile Event (SecureBlackbox_SFTPServer Class)

This event is fired when a client requests to rename a file.

Object Oriented Interface

public function fireRenameFile($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 47, array($this, 'fireRenameFile'));

Parameter List

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

Remarks

This event is fired when a request to rename a file (from OldPath to NewPath) is received from the client. The ConnectionID parameter specifies in which session the request was received.

Set OperationStatus to one of the below values according to the outcome of the request processing:

RequestAttributes Event (SecureBlackbox_SFTPServer Class)

This event is fired when a get file attributes request is received.

Object Oriented Interface

public function fireRequestAttributes($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 48, array($this, 'fireRequestAttributes'));

Parameter List

 'connectionid'
 'path'
 'handle'
 'operationstatus'

Remarks

This event is fired when a request to get file attributes is received from the client. The ConnectionID parameter specifies in which session the request was received, and Path specifies the file location where the attributes need to be retrieved.

Set OperationStatus to one of the below values according to the outcome of the request processing:

ServerForwardingCancel Event (SecureBlackbox_SFTPServer Class)

This event is fired when the client cancels a previously negotiated server-side (remote) forwarding.

Object Oriented Interface

public function fireServerForwardingCancel($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 49, array($this, 'fireServerForwardingCancel'));

Parameter List

 'connectionid'
 'localhost'
 'localport'

Remarks

The ConnectionID parameter specifies in which session the request was received. The LocalHost:LocalPort specify the endpoint that the server is listening on.

After receiving the cancellation request the server will no longer listen to connections at the mentioned endpoint.

Choose Action as one of the following values:

ServerForwardingOpenFailed Event (SecureBlackbox_SFTPServer Class)

This event is fired when the client rejects the server request to establish a server forwarding channel.

Object Oriented Interface

public function fireServerForwardingOpenFailed($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 50, array($this, 'fireServerForwardingOpenFailed'));

Parameter List

 'connectionid'
 'localhost'
 'localport'
 'srchost'
 'srcport'

Remarks

This event can follow the BeforeOpenServerForwarding and OpenServerForwarding if the client rejects the server request to forward an accepted TCP connection.

The ConnectionID parameter specifies in which session the request was received. The LocalHost:LocalPort specify the endpoint that the server has received the connection on.

ServerForwardingRequest Event (SecureBlackbox_SFTPServer Class)

This event is fired when the client requests the server to set up server-side (remote) forwarding.

Object Oriented Interface

public function fireServerForwardingRequest($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 51, array($this, 'fireServerForwardingRequest'));

Parameter List

 'connectionid'
 'localhost'
 'localport'
 'action'

Remarks

The ConnectionID parameter specifies in which session the request was received. The LocalHost:LocalPort specify the endpoint that the client expects the server to listen on. The server may choose to use a different port, in which case please adjust the LocalPort in the event handler.

If permitted, the server will open the requested port and start listening to incoming connections. All such connections will be reported via BeforeOpenServerForwarding and OpenServerForwarding events.

You can enable or disable server forwarding blanketly via the Capabilities property.

Choose Action as one of the following values:

SessionClosed Event (SecureBlackbox_SFTPServer Class)

Reports session closure.

Object Oriented Interface

public function fireSessionClosed($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 52, array($this, 'fireSessionClosed'));

Parameter List

 'connectionid'

Remarks

This event is fired when a connection identified by ConnectionID has been gracefully closed.

SessionEstablished Event (SecureBlackbox_SFTPServer Class)

This event is fired when a new session is established.

Object Oriented Interface

public function fireSessionEstablished($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 53, array($this, 'fireSessionEstablished'));

Parameter List

 'connectionid'

Remarks

This event is fired when a new connection identified by ConnectionID has been established with a client.

SetAttributes Event (SecureBlackbox_SFTPServer Class)

This event is fired when an set file attributes request is received.

Object Oriented Interface

public function fireSetAttributes($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 54, array($this, 'fireSetAttributes'));

Parameter List

 'connectionid'
 'path'
 'handle'
 'operationstatus'

Remarks

This event is fired when a request to set file attributes is received from the client. The ConnectionID parameter specifies in which session the request was received, and Path specifies the file location which the attributes needs to be set.

Set OperationStatus to one of the below values according to the outcome of the request processing:

TranslatePath Event (SecureBlackbox_SFTPServer Class)

This event is fired when a client requests the server to translate a path to its absolute form.

Object Oriented Interface

public function fireTranslatePath($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 55, array($this, 'fireTranslatePath'));

Parameter List

 'connectionid'
 'path'
 'absolutepath'
 'action'

Remarks

This event is fired when a request to translate a relative path to the corresponding absolute path is received. The ConnectionID parameter specifies the session in which the request was received.

You can let the server do the translation automatically according to the default file system rules, or take care of it yourself. Use the Action parameter to specify who is responsible for the translation. If doing the translation manually, return the translated path via the AbsolutePath parameter. Action can take one of the following values:

WriteFile Event (SecureBlackbox_SFTPServer Class)

This event is fired when a file write request is received.

Object Oriented Interface

public function fireWriteFile($param);

Procedural Interface

secureblackbox_sftpserver_register_callback($res, 56, array($this, 'fireWriteFile'));

Parameter List

 'connectionid'
 'handle'
 'offset'
 'operationstatus'

Remarks

This event is fired when a request to write a data block to a file is received from the client. The ConnectionID parameter specifies the session the request originates from. The Handle parameter references the opened file where the block should be written to. Offset references the position in the file where the block of data should be written.

Use GetClientBuffer method to obtain the piece of data that should be written to the file.

Set OperationStatus to one of the below values according to the outcome of the request processing:

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

SFTPServer Config Settings

Base Config Settings

Trappable Errors (SFTPServer Class)

SFTPServer Errors