SFTPServer Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

SFTPServer

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.

ActiveSpecifies whether the SFTP server has started and ready to accept connections.
AuthTypesDefines allowed authentication types.
BaseDirSpecifies the server's base (root) directory.
CapabilitiesSpecifies which elements of the SSH ecosystem the class must support/enable.
ClientFileEntryA container for file entry details.
CompressionLevelSpecifies the preferable compression level.
ExternalCryptoProvides access to external signing and DC parameters.
FIPSModeReserved.
ForceCompressionThis property specifies whether server explicitly requires data compression.
HostSpecifies server's host name.
KeyContains client's public key.
MaxSFTPVersionMaximum SFTP version supported.
MinSFTPVersionMinimum SFTP version supported.
PinnedClientPopulates the pinned client details.
PortSpecifies the listening port number.
ReadOnlySpecifies whether files on the server are read-only.
ServerKeysThe server's SSH keys.
SocketSettingsManages network connection settings.
SSHSettingsThe SSH connection settings.
UsersA collection of known users.
UseUTF8Specifies whether UTF8 conversion is to be used when parsing file names.

Method List


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

CleanupCleans up the server environment by purging expired sessions and cleaning caches.
ConfigSets or retrieves a configuration setting.
DoActionPerforms an additional action.
DropClientTerminates a client connection.
GetClientBufferAcquires a piece of operation data.
GetClientFileEntryAcquires file entry details from the class.
ListClientsEnumerates the connected clients.
PinClientTakes a snapshot of the connection's properties.
ResetResets the class settings.
SetClientBufferCommits a data buffer to the server class.
SetClientFileEntryCommits the file entry details to the class.
StartStarts SFTP server operation.
StopStops SFTP server.

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.

AcceptThis event is fired when new incoming connection is accepted.
AfterCreateDirectoryThis event indicates completion of directory creation request.
AfterRemoveThis event indicates completion of file removal request.
AfterRenameFileThis event indicates completion of a file rename operation.
AfterRequestAttributesThis event indicates completion of file attributes request.
AfterSetAttributesThis event indicates completion of a set attributes request.
AuthAttemptReports a user authentication attempt.
AuthFailedReports user authentication failure.
AuthPasswordThis event is fired on password authentication attempt from a client.
AuthPublicKeyThis event is fired on public key authentication attempt from a client.
AuthSucceededReports a successful user authentication.
BeforeCreateDirectoryThis event is fired when a client requests to create a directory.
BeforeDownloadFileThis event is fired when a download file request is received.
BeforeFindThis event is fired when a client requests to find files and folders in Path.
BeforeOpenClientForwardingThis event is fired when a client requests to set up client-side (local) forwarding channel.
BeforeOpenCommandThis event is fired when a client requests a command channel.
BeforeOpenServerForwardingThis event is fired when the server has received an incoming connection and needs to set up server-side (remote) forwarding channel.
BeforeOpenShellThis event is fired when a client requests a shell channel.
BeforeRemoveThis event is fired when a client requests to delete a file or directory.
BeforeRenameFileThis event is fired when a client requests to rename a file.
BeforeRequestAttributesThis event is fired when a client requests to get file attributes.
BeforeSetAttributesThis event is fired when a client requests to set file attributes.
BeforeUploadFileThis event is fired when an upload file request is received.
CloseClientForwardingThis event is fired when a client has closed a previously opened forwarding channel.
CloseCommandThis event is fired when a client has closed a previously opened SSH command channel.
CloseFileThis event instructs the application to close an opened file.
CloseServerForwardingThis event is fired when a client has closed a previously opened forwarding channel.
CloseShellThis event is fired when a client has closed a previously opened shell channel.
ConnectThis event is fired when a remote connection has been established.
CreateDirectoryThis event instructs the application to create a directory.
DisconnectThis event is fired when a client has disconnected.
ErrorInformation about errors during data delivery.
ExternalSignHandles remote or external signing initiated by the server protocol.
FindCloseThis event signifies the completion of a custom file listing operation.
FindFirstThis event signifies the start of the custom file listing retrieval mechanism.
FindNextThis event retrieves the next entry of a custom file listing.
ListeningStartedFires when the server has started accepting connections on a local port.
ListeningStoppedFires when the server has stopped accepting connections on a local port.
NotificationThis event notifies the application about an underlying control flow event.
OpenClientForwardingThis event is fired when a client opens a client-side (local) forwarding channel.
OpenCommandThis event is fired when a client has opened an SSH command channel.
OpenFileThis event instructs the application to handle the file open request.
OpenServerForwardingThis event is fired when the server opens a server-side (remote) forwarding channel.
OpenShellThis event is fired when a client has opened a shell channel.
ReadFileThis event is fired when a file read request is received.
RemoveThis event is fired when a client requests to delete a file or directory.
RenameFileThis event is fired when a client requests to rename a file.
RequestAttributesThis event is fired when a get file attributes request is received.
ServerForwardingCancelThis event is fired when the client cancels a previously negotiated server-side (remote) forwarding.
ServerForwardingOpenFailedThis event is fired when the client rejects the server request to establish a server forwarding channel.
ServerForwardingRequestThis event is fired when the client requests the server to set up server-side (remote) forwarding.
SessionClosedReports session closure.
SessionEstablishedThis event is fired when a new session is established.
SetAttributesThis event is fired when an set file attributes request is received.
TranslatePathThis event is fired when a client requests the server to translate a path to its absolute form.
WriteFileThis event is fired when a file write request is received.

Config Settings


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

AllAlgorithmsReturns the list of algorithms enabled in the class.
AsyncDataWindowManagementTBD.
AuthModeControls dual/multi-type authentication mode.
AutoGenerateLongNamesTBD.
Banner[i]TBD.
BannerSendStageTBD.
CloseIfNoActiveTunnelsTBD.
CommandModeEnabledTBD.
CompressionAlgorithmsReturns the list of compression algorithms enabled in the class.
CustomDHGroupIndexSets a specific Diffie-Hellman group index to enforce.
DefBannerTBD.
DefLanguageTagTBD.
DualStackAllows the use of ip4 and ip6 simultaneously.
EncryptionAlgorithmsReturns the list of encryption algorithms enabled in the class.
KexAlgorithmsReturns the list of key exchange algorithms enabled in the class.
LanguageTag[i]TBD.
MacAlgorithmsReturns the list of MAC algorithms enabled in the class.
MaxDHGroupSizeSets the maximal Diffie-Hellman group size.
MinDHGroupSizeSets the minimal Diffie-Hellman group size.
NotifyOnFileOperationsEnables low-level file operation notifications.
PublicKeyAlgorithmsReturns the list of public key algorithms enabled in the class.
RefreshUsersEnables or disables real-time propagation of user information.
SFTPModeEnabledTBD.
ShellModeEnabledTBD.
UseStrictKeyExchangeSpecifies how strict key exchange is supported.
ASN1UseGlobalTagCacheControls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPinsSpecifies whether CSP-level PINs should be assigned to CNG keys.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
DNSLocalSuffixThe suffix to assign for TLD names.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicyThe hardware crypto usage policy.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
HttpVersionThe HTTP version to use in any inner HTTP client classes created.
IgnoreExpiredMSCTLSigningCertWhether to tolerate the expired Windows Update signing certificate.
ListDelimiterThe delimiter character for multi-element lists.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
OldClientSideRSAFallbackSpecifies whether the SSH client should use a SHA1 fallback.
ProductVersionReturns the version of the SecureBlackbox library.
ServerSSLDHKeyLengthSets the size of the TLS DHE key exchange group.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseInternalRandomSwitches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidationEnables legacy AdES validation mode.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculationAn internal CryptoAPI access tweak.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

Active Property (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
int GetActive();

Unicode (Windows)
BOOL GetActive();
int secureblackbox_sftpserver_getactive(void* lpObj);
bool GetActive();

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 (SFTPServer Class)

Defines allowed authentication types.

Syntax

ANSI (Cross Platform)
int GetAuthTypes();
int SetAuthTypes(int iAuthTypes); Unicode (Windows) INT GetAuthTypes();
INT SetAuthTypes(INT iAuthTypes);
int secureblackbox_sftpserver_getauthtypes(void* lpObj);
int secureblackbox_sftpserver_setauthtypes(void* lpObj, int iAuthTypes);
int GetAuthTypes();
int SetAuthTypes(int iAuthTypes);

Default Value

30

Remarks

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

atRhosts0x01RHOSTS file authentication. Rarely used today.

atPublicKey0x02Public key (sometimes called private key) authentication

atPassword0x04Password-based authentication

atHostbased0x08Hostbased authentication

atKeyboard0x10Keyboard-interactive authentication. This is often used in place of generic password authentication.

atGssWithMic0x20GSS authentication

atGssKeyex0x40GSS authentication with key exchange

atPublicKeyAgent0x80Public key agent authentication

Data Type

Integer

BaseDir Property (SFTPServer Class)

Specifies the server's base (root) directory.

Syntax

ANSI (Cross Platform)
char* GetBaseDir();
int SetBaseDir(const char* lpszBaseDir); Unicode (Windows) LPWSTR GetBaseDir();
INT SetBaseDir(LPCWSTR lpszBaseDir);
char* secureblackbox_sftpserver_getbasedir(void* lpObj);
int secureblackbox_sftpserver_setbasedir(void* lpObj, const char* lpszBaseDir);
QString GetBaseDir();
int SetBaseDir(QString qsBaseDir);

Default Value

""

Remarks

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

Data Type

String

Capabilities Property (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
int GetCapabilities();
int SetCapabilities(int iCapabilities); Unicode (Windows) INT GetCapabilities();
INT SetCapabilities(INT iCapabilities);
int secureblackbox_sftpserver_getcapabilities(void* lpObj);
int secureblackbox_sftpserver_setcapabilities(void* lpObj, int iCapabilities);
int GetCapabilities();
int SetCapabilities(int iCapabilities);

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:

scSFTP0x01SFTP (secure file transfer)

scShell0x02Remote shell access

scCommand0x04Remote command execution

scClientForwarding0x08Local (client-side) forwarding

scServerForwarding0x10Remote (server-side) forwarding

Data Type

Integer

ClientFileEntry Property (SFTPServer Class)

A container for file entry details.

Syntax

SecureBlackboxFTPListEntry* GetClientFileEntry();
int SetClientFileEntry(SecureBlackboxFTPListEntry* val);
char* secureblackbox_sftpserver_getclientfileentryaccesstime(void* lpObj);
int secureblackbox_sftpserver_setclientfileentryaccesstime(void* lpObj, const char* lpszClientFileEntryAccessTime);
char* secureblackbox_sftpserver_getclientfileentrycreationtime(void* lpObj);
int secureblackbox_sftpserver_setclientfileentrycreationtime(void* lpObj, const char* lpszClientFileEntryCreationTime);
int secureblackbox_sftpserver_getclientfileentryentryformat(void* lpObj);
int secureblackbox_sftpserver_setclientfileentryentryformat(void* lpObj, int iClientFileEntryEntryFormat);
int secureblackbox_sftpserver_getclientfileentryfiletype(void* lpObj);
int secureblackbox_sftpserver_setclientfileentryfiletype(void* lpObj, int iClientFileEntryFileType);
int64 secureblackbox_sftpserver_getclientfileentryhandle(void* lpObj);
int secureblackbox_sftpserver_setclientfileentryhandle(void* lpObj, int64 lClientFileEntryHandle);
char* secureblackbox_sftpserver_getclientfileentrymodificationtime(void* lpObj);
int secureblackbox_sftpserver_setclientfileentrymodificationtime(void* lpObj, const char* lpszClientFileEntryModificationTime);
char* secureblackbox_sftpserver_getclientfileentryname(void* lpObj);
int secureblackbox_sftpserver_setclientfileentryname(void* lpObj, const char* lpszClientFileEntryName);
char* secureblackbox_sftpserver_getclientfileentrypath(void* lpObj);
int secureblackbox_sftpserver_setclientfileentrypath(void* lpObj, const char* lpszClientFileEntryPath);
char* secureblackbox_sftpserver_getclientfileentryprincipal(void* lpObj);
int secureblackbox_sftpserver_setclientfileentryprincipal(void* lpObj, const char* lpszClientFileEntryPrincipal);
int64 secureblackbox_sftpserver_getclientfileentrysize(void* lpObj);
int secureblackbox_sftpserver_setclientfileentrysize(void* lpObj, int64 lClientFileEntrySize);
int secureblackbox_sftpserver_getclientfileentryunixperms(void* lpObj);
int secureblackbox_sftpserver_setclientfileentryunixperms(void* lpObj, int iClientFileEntryUnixPerms);
char* secureblackbox_sftpserver_getclientfileentryunparsedname(void* lpObj);
int secureblackbox_sftpserver_setclientfileentryunparsedname(void* lpObj, const char* lpszClientFileEntryUnparsedName);
QString GetClientFileEntryAccessTime();
int SetClientFileEntryAccessTime(QString qsClientFileEntryAccessTime); QString GetClientFileEntryCreationTime();
int SetClientFileEntryCreationTime(QString qsClientFileEntryCreationTime); int GetClientFileEntryEntryFormat();
int SetClientFileEntryEntryFormat(int iClientFileEntryEntryFormat); int GetClientFileEntryFileType();
int SetClientFileEntryFileType(int iClientFileEntryFileType); qint64 GetClientFileEntryHandle();
int SetClientFileEntryHandle(qint64 lClientFileEntryHandle); QString GetClientFileEntryModificationTime();
int SetClientFileEntryModificationTime(QString qsClientFileEntryModificationTime); QString GetClientFileEntryName();
int SetClientFileEntryName(QString qsClientFileEntryName); QString GetClientFileEntryPath();
int SetClientFileEntryPath(QString qsClientFileEntryPath); QString GetClientFileEntryPrincipal();
int SetClientFileEntryPrincipal(QString qsClientFileEntryPrincipal); qint64 GetClientFileEntrySize();
int SetClientFileEntrySize(qint64 lClientFileEntrySize); int GetClientFileEntryUnixPerms();
int SetClientFileEntryUnixPerms(int iClientFileEntryUnixPerms); QString GetClientFileEntryUnparsedName();
int SetClientFileEntryUnparsedName(QString qsClientFileEntryUnparsedName);

Remarks

This property is a placeholder for file entry details. Use it communicate file details from your code to the server component and back. Pass the contents of ClientFileEntry to the server with SetClientFileEntry method, and retrieve them with GetClientFileEntry method.

This property may come handy when customizing file system operations, such as file listings or attribute requests.

This property is not available at design time.

Data Type

SecureBlackboxFTPListEntry

CompressionLevel Property (SFTPServer Class)

Specifies the preferable compression level.

Syntax

ANSI (Cross Platform)
int GetCompressionLevel();
int SetCompressionLevel(int iCompressionLevel); Unicode (Windows) INT GetCompressionLevel();
INT SetCompressionLevel(INT iCompressionLevel);
int secureblackbox_sftpserver_getcompressionlevel(void* lpObj);
int secureblackbox_sftpserver_setcompressionlevel(void* lpObj, int iCompressionLevel);
int GetCompressionLevel();
int SetCompressionLevel(int iCompressionLevel);

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

ExternalCrypto Property (SFTPServer Class)

Provides access to external signing and DC parameters.

Syntax

SecureBlackboxExternalCrypto* GetExternalCrypto();

char* secureblackbox_sftpserver_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_sftpserver_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);
char* secureblackbox_sftpserver_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_sftpserver_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);
char* secureblackbox_sftpserver_getexternalcryptodata(void* lpObj);
int secureblackbox_sftpserver_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);
int secureblackbox_sftpserver_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_sftpserver_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);
char* secureblackbox_sftpserver_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_sftpserver_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);
char* secureblackbox_sftpserver_getexternalcryptokeyid(void* lpObj);
int secureblackbox_sftpserver_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);
char* secureblackbox_sftpserver_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_sftpserver_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);
int secureblackbox_sftpserver_getexternalcryptomethod(void* lpObj);
int secureblackbox_sftpserver_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);
int secureblackbox_sftpserver_getexternalcryptomode(void* lpObj);
int secureblackbox_sftpserver_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);
char* secureblackbox_sftpserver_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_sftpserver_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);
QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID); QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams); QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData); bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation); QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm); QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID); QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret); int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod); int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode); QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);

Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).

This property is read-only.

Data Type

SecureBlackboxExternalCrypto

FIPSMode Property (SFTPServer Class)

Reserved.

Syntax

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);
int secureblackbox_sftpserver_getfipsmode(void* lpObj);
int secureblackbox_sftpserver_setfipsmode(void* lpObj, int bFIPSMode);
bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

FALSE

Remarks

This property is reserved for future use.

Data Type

Boolean

ForceCompression Property (SFTPServer Class)

This property specifies whether server explicitly requires data compression.

Syntax

ANSI (Cross Platform)
int GetForceCompression();
int SetForceCompression(int bForceCompression); Unicode (Windows) BOOL GetForceCompression();
INT SetForceCompression(BOOL bForceCompression);
int secureblackbox_sftpserver_getforcecompression(void* lpObj);
int secureblackbox_sftpserver_setforcecompression(void* lpObj, int bForceCompression);
bool GetForceCompression();
int SetForceCompression(bool bForceCompression);

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 (SFTPServer Class)

Specifies server's host name.

Syntax

ANSI (Cross Platform)
char* GetHost();
int SetHost(const char* lpszHost); Unicode (Windows) LPWSTR GetHost();
INT SetHost(LPCWSTR lpszHost);
char* secureblackbox_sftpserver_gethost(void* lpObj);
int secureblackbox_sftpserver_sethost(void* lpObj, const char* lpszHost);
QString GetHost();
int SetHost(QString qsHost);

Default Value

""

Remarks

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

Data Type

String

Key Property (SFTPServer Class)

Contains client's public key.

Syntax

char* secureblackbox_sftpserver_getkeyfingerprintsha1(void* lpObj);
char* secureblackbox_sftpserver_getkeyfingerprintsha256(void* lpObj);
int64 secureblackbox_sftpserver_getkeyhandle(void* lpObj);
QString GetKeyFingerprintSHA1();

QString GetKeyFingerprintSHA256();

qint64 GetKeyHandle();

Remarks

This property returns the current client's public key. Check this property inside your AuthPublicKey event handler.

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

Data Type

SecureBlackboxSSHKey

MaxSFTPVersion Property (SFTPServer Class)

Maximum SFTP version supported.

Syntax

ANSI (Cross Platform)
int GetMaxSFTPVersion();
int SetMaxSFTPVersion(int iMaxSFTPVersion); Unicode (Windows) INT GetMaxSFTPVersion();
INT SetMaxSFTPVersion(INT iMaxSFTPVersion);
int secureblackbox_sftpserver_getmaxsftpversion(void* lpObj);
int secureblackbox_sftpserver_setmaxsftpversion(void* lpObj, int iMaxSFTPVersion);
int GetMaxSFTPVersion();
int SetMaxSFTPVersion(int iMaxSFTPVersion);

Default Value

6

Remarks

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

Data Type

Integer

MinSFTPVersion Property (SFTPServer Class)

Minimum SFTP version supported.

Syntax

ANSI (Cross Platform)
int GetMinSFTPVersion();
int SetMinSFTPVersion(int iMinSFTPVersion); Unicode (Windows) INT GetMinSFTPVersion();
INT SetMinSFTPVersion(INT iMinSFTPVersion);
int secureblackbox_sftpserver_getminsftpversion(void* lpObj);
int secureblackbox_sftpserver_setminsftpversion(void* lpObj, int iMinSFTPVersion);
int GetMinSFTPVersion();
int SetMinSFTPVersion(int iMinSFTPVersion);

Default Value

0

Remarks

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

Data Type

Integer

PinnedClient Property (SFTPServer Class)

Populates the pinned client details.

Syntax

SecureBlackboxSSHConnectionInfo* GetPinnedClient();

char* secureblackbox_sftpserver_getpinnedclientclientkeyalgorithm(void* lpObj);
int secureblackbox_sftpserver_getpinnedclientclientkeybits(void* lpObj);
char* secureblackbox_sftpserver_getpinnedclientclientkeyfingerprint(void* lpObj);
char* secureblackbox_sftpserver_getpinnedclientclosereason(void* lpObj);
char* secureblackbox_sftpserver_getpinnedclientcompressionalgorithminbound(void* lpObj);
char* secureblackbox_sftpserver_getpinnedclientcompressionalgorithmoutbound(void* lpObj);
char* secureblackbox_sftpserver_getpinnedclientencryptionalgorithminbound(void* lpObj);
char* secureblackbox_sftpserver_getpinnedclientencryptionalgorithmoutbound(void* lpObj);
int secureblackbox_sftpserver_getpinnedclientinboundencryptionkeybits(void* lpObj);
char* secureblackbox_sftpserver_getpinnedclientkexalgorithm(void* lpObj);
int secureblackbox_sftpserver_getpinnedclientkexbits(void* lpObj);
char* secureblackbox_sftpserver_getpinnedclientkexlines(void* lpObj);
char* secureblackbox_sftpserver_getpinnedclientmacalgorithminbound(void* lpObj);
char* secureblackbox_sftpserver_getpinnedclientmacalgorithmoutbound(void* lpObj);
int secureblackbox_sftpserver_getpinnedclientoutboundencryptionkeybits(void* lpObj);
char* secureblackbox_sftpserver_getpinnedclientpublickeyalgorithm(void* lpObj);
char* secureblackbox_sftpserver_getpinnedclientremoteaddress(void* lpObj);
int secureblackbox_sftpserver_getpinnedclientremoteport(void* lpObj);
char* secureblackbox_sftpserver_getpinnedclientserverkeyalgorithm(void* lpObj);
int secureblackbox_sftpserver_getpinnedclientserverkeybits(void* lpObj);
char* secureblackbox_sftpserver_getpinnedclientserverkeyfingerprint(void* lpObj);
char* secureblackbox_sftpserver_getpinnedclientserversoftwarename(void* lpObj);
int64 secureblackbox_sftpserver_getpinnedclienttotalbytesreceived(void* lpObj);
int64 secureblackbox_sftpserver_getpinnedclienttotalbytessent(void* lpObj);
int secureblackbox_sftpserver_getpinnedclientversion(void* lpObj);
QString GetPinnedClientClientKeyAlgorithm();

int GetPinnedClientClientKeyBits();

QString GetPinnedClientClientKeyFingerprint();

QString GetPinnedClientCloseReason();

QString GetPinnedClientCompressionAlgorithmInbound();

QString GetPinnedClientCompressionAlgorithmOutbound();

QString GetPinnedClientEncryptionAlgorithmInbound();

QString GetPinnedClientEncryptionAlgorithmOutbound();

int GetPinnedClientInboundEncryptionKeyBits();

QString GetPinnedClientKexAlgorithm();

int GetPinnedClientKexBits();

QString GetPinnedClientKexLines();

QString GetPinnedClientMacAlgorithmInbound();

QString GetPinnedClientMacAlgorithmOutbound();

int GetPinnedClientOutboundEncryptionKeyBits();

QString GetPinnedClientPublicKeyAlgorithm();

QString GetPinnedClientRemoteAddress();

int GetPinnedClientRemotePort();

QString GetPinnedClientServerKeyAlgorithm();

int GetPinnedClientServerKeyBits();

QString GetPinnedClientServerKeyFingerprint();

QString GetPinnedClientServerSoftwareName();

qint64 GetPinnedClientTotalBytesReceived();

qint64 GetPinnedClientTotalBytesSent();

int GetPinnedClientVersion();

Remarks

Use this property to access the details of the client connection previously pinned with PinClient method.

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

Data Type

SecureBlackboxSSHConnectionInfo

Port Property (SFTPServer Class)

Specifies the listening port number.

Syntax

ANSI (Cross Platform)
int GetPort();
int SetPort(int iPort); Unicode (Windows) INT GetPort();
INT SetPort(INT iPort);
int secureblackbox_sftpserver_getport(void* lpObj);
int secureblackbox_sftpserver_setport(void* lpObj, int iPort);
int GetPort();
int SetPort(int iPort);

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 (SFTPServer Class)

Specifies whether files on the server are read-only.

Syntax

ANSI (Cross Platform)
int GetReadOnly();
int SetReadOnly(int bReadOnly); Unicode (Windows) BOOL GetReadOnly();
INT SetReadOnly(BOOL bReadOnly);
int secureblackbox_sftpserver_getreadonly(void* lpObj);
int secureblackbox_sftpserver_setreadonly(void* lpObj, int bReadOnly);
bool GetReadOnly();
int SetReadOnly(bool bReadOnly);

Default Value

FALSE

Remarks

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

Data Type

Boolean

ServerKeys Property (SFTPServer Class)

The server's SSH keys.

Syntax

int secureblackbox_sftpserver_getserverkeycount(void* lpObj);
int secureblackbox_sftpserver_setserverkeycount(void* lpObj, int iServerKeyCount);
char* secureblackbox_sftpserver_getserverkeyalgorithm(void* lpObj, int serverkeyindex);
int secureblackbox_sftpserver_getserverkeybits(void* lpObj, int serverkeyindex);
char* secureblackbox_sftpserver_getserverkeyfingerprintmd5(void* lpObj, int serverkeyindex);
char* secureblackbox_sftpserver_getserverkeyfingerprintsha1(void* lpObj, int serverkeyindex);
int64 secureblackbox_sftpserver_getserverkeyhandle(void* lpObj, int serverkeyindex);
int secureblackbox_sftpserver_setserverkeyhandle(void* lpObj, int serverkeyindex, int64 lServerKeyHandle);
int GetServerKeyCount();
int SetServerKeyCount(int iServerKeyCount); QString GetServerKeyAlgorithm(int iServerKeyIndex); int GetServerKeyBits(int iServerKeyIndex); QString GetServerKeyFingerprintMD5(int iServerKeyIndex); QString GetServerKeyFingerprintSHA1(int iServerKeyIndex); qint64 GetServerKeyHandle(int iServerKeyIndex);
int SetServerKeyHandle(int iServerKeyIndex, qint64 lServerKeyHandle);

Remarks

Use this property to provide a list of SSH private keys for the server endpoint.

An SSH endpoint needs a private key to be able to accept secure connections. Apart from being employed for the handshake, the key is also used as a unique server identifier.

The collection may include more than one endpoint key. A typical usage scenario is to include two or three keys (ECDSA, RSA, and DSS), to cater for clients with different algorithm preferences.

This property is not available at design time.

Data Type

SecureBlackboxSSHKey

SocketSettings Property (SFTPServer Class)

Manages network connection settings.

Syntax

SecureBlackboxSocketSettings* GetSocketSettings();

int secureblackbox_sftpserver_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_sftpserver_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);
char* secureblackbox_sftpserver_getsocketlocaladdress(void* lpObj);
int secureblackbox_sftpserver_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);
int secureblackbox_sftpserver_getsocketlocalport(void* lpObj);
int secureblackbox_sftpserver_setsocketlocalport(void* lpObj, int iSocketLocalPort);
int secureblackbox_sftpserver_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_sftpserver_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);
int secureblackbox_sftpserver_getsockettimeout(void* lpObj);
int secureblackbox_sftpserver_setsockettimeout(void* lpObj, int iSocketTimeout);
int secureblackbox_sftpserver_getsocketuseipv6(void* lpObj);
int secureblackbox_sftpserver_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);
int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit); QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress); int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort); int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit); int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout); bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

Data Type

SecureBlackboxSocketSettings

SSHSettings Property (SFTPServer Class)

The SSH connection settings.

Syntax

SecureBlackboxSSHSettings* GetSSHSettings();

int secureblackbox_sftpserver_getsshsettingsautoadjustciphers(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsautoadjustciphers(void* lpObj, int bSSHSettingsAutoAdjustCiphers);
int secureblackbox_sftpserver_getsshsettingsbaseconfiguration(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsbaseconfiguration(void* lpObj, int iSSHSettingsBaseConfiguration);
char* secureblackbox_sftpserver_getsshsettingscompressionalgorithms(void* lpObj);
int secureblackbox_sftpserver_setsshsettingscompressionalgorithms(void* lpObj, const char* lpszSSHSettingsCompressionAlgorithms);
int secureblackbox_sftpserver_getsshsettingscompressionlevel(void* lpObj);
int secureblackbox_sftpserver_setsshsettingscompressionlevel(void* lpObj, int iSSHSettingsCompressionLevel);
int secureblackbox_sftpserver_getsshsettingsdefaultwindowsize(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsdefaultwindowsize(void* lpObj, int iSSHSettingsDefaultWindowSize);
char* secureblackbox_sftpserver_getsshsettingsencryptionalgorithms(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsencryptionalgorithms(void* lpObj, const char* lpszSSHSettingsEncryptionAlgorithms);
int secureblackbox_sftpserver_getsshsettingsforcecompression(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsforcecompression(void* lpObj, int bSSHSettingsForceCompression);
int secureblackbox_sftpserver_getsshsettingsforwardauthagent(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsforwardauthagent(void* lpObj, int bSSHSettingsForwardAuthAgent);
char* secureblackbox_sftpserver_getsshsettingsgssauthtypes(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsgssauthtypes(void* lpObj, const char* lpszSSHSettingsGSSAuthTypes);
int secureblackbox_sftpserver_getsshsettingsgssdelegatecreds(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsgssdelegatecreds(void* lpObj, int bSSHSettingsGSSDelegateCreds);
char* secureblackbox_sftpserver_getsshsettingsgsshostname(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsgsshostname(void* lpObj, const char* lpszSSHSettingsGSSHostname);
char* secureblackbox_sftpserver_getsshsettingsgsslib(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsgsslib(void* lpObj, const char* lpszSSHSettingsGSSLib);
char* secureblackbox_sftpserver_getsshsettingsgssmechanisms(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsgssmechanisms(void* lpObj, const char* lpszSSHSettingsGSSMechanisms);
char* secureblackbox_sftpserver_getsshsettingsgssprotocols(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsgssprotocols(void* lpObj, const char* lpszSSHSettingsGSSProtocols);
int secureblackbox_sftpserver_getsshsettingshandshaketimeout(void* lpObj);
int secureblackbox_sftpserver_setsshsettingshandshaketimeout(void* lpObj, int iSSHSettingsHandshakeTimeout);
char* secureblackbox_sftpserver_getsshsettingskexalgorithms(void* lpObj);
int secureblackbox_sftpserver_setsshsettingskexalgorithms(void* lpObj, const char* lpszSSHSettingsKexAlgorithms);
char* secureblackbox_sftpserver_getsshsettingsmacalgorithms(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsmacalgorithms(void* lpObj, const char* lpszSSHSettingsMacAlgorithms);
int secureblackbox_sftpserver_getsshsettingsmaxsshpacketsize(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsmaxsshpacketsize(void* lpObj, int iSSHSettingsMaxSSHPacketSize);
int secureblackbox_sftpserver_getsshsettingsminwindowsize(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsminwindowsize(void* lpObj, int iSSHSettingsMinWindowSize);
int secureblackbox_sftpserver_getsshsettingsobfuscatehandshake(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsobfuscatehandshake(void* lpObj, int bSSHSettingsObfuscateHandshake);
char* secureblackbox_sftpserver_getsshsettingsobfuscationpassword(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsobfuscationpassword(void* lpObj, const char* lpszSSHSettingsObfuscationPassword);
char* secureblackbox_sftpserver_getsshsettingspublickeyalgorithms(void* lpObj);
int secureblackbox_sftpserver_setsshsettingspublickeyalgorithms(void* lpObj, const char* lpszSSHSettingsPublicKeyAlgorithms);
int secureblackbox_sftpserver_getsshsettingsrequestpasswordchange(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsrequestpasswordchange(void* lpObj, int bSSHSettingsRequestPasswordChange);
char* secureblackbox_sftpserver_getsshsettingssoftwarename(void* lpObj);
int secureblackbox_sftpserver_setsshsettingssoftwarename(void* lpObj, const char* lpszSSHSettingsSoftwareName);
int secureblackbox_sftpserver_getsshsettingstrustallkeys(void* lpObj);
int secureblackbox_sftpserver_setsshsettingstrustallkeys(void* lpObj, int bSSHSettingsTrustAllKeys);
int secureblackbox_sftpserver_getsshsettingsuseauthagent(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsuseauthagent(void* lpObj, int bSSHSettingsUseAuthAgent);
int secureblackbox_sftpserver_getsshsettingsversions(void* lpObj);
int secureblackbox_sftpserver_setsshsettingsversions(void* lpObj, int iSSHSettingsVersions);
bool GetSSHSettingsAutoAdjustCiphers();
int SetSSHSettingsAutoAdjustCiphers(bool bSSHSettingsAutoAdjustCiphers); int GetSSHSettingsBaseConfiguration();
int SetSSHSettingsBaseConfiguration(int iSSHSettingsBaseConfiguration); QString GetSSHSettingsCompressionAlgorithms();
int SetSSHSettingsCompressionAlgorithms(QString qsSSHSettingsCompressionAlgorithms); int GetSSHSettingsCompressionLevel();
int SetSSHSettingsCompressionLevel(int iSSHSettingsCompressionLevel); int GetSSHSettingsDefaultWindowSize();
int SetSSHSettingsDefaultWindowSize(int iSSHSettingsDefaultWindowSize); QString GetSSHSettingsEncryptionAlgorithms();
int SetSSHSettingsEncryptionAlgorithms(QString qsSSHSettingsEncryptionAlgorithms); bool GetSSHSettingsForceCompression();
int SetSSHSettingsForceCompression(bool bSSHSettingsForceCompression); bool GetSSHSettingsForwardAuthAgent();
int SetSSHSettingsForwardAuthAgent(bool bSSHSettingsForwardAuthAgent); QString GetSSHSettingsGSSAuthTypes();
int SetSSHSettingsGSSAuthTypes(QString qsSSHSettingsGSSAuthTypes); bool GetSSHSettingsGSSDelegateCreds();
int SetSSHSettingsGSSDelegateCreds(bool bSSHSettingsGSSDelegateCreds); QString GetSSHSettingsGSSHostname();
int SetSSHSettingsGSSHostname(QString qsSSHSettingsGSSHostname); QString GetSSHSettingsGSSLib();
int SetSSHSettingsGSSLib(QString qsSSHSettingsGSSLib); QString GetSSHSettingsGSSMechanisms();
int SetSSHSettingsGSSMechanisms(QString qsSSHSettingsGSSMechanisms); QString GetSSHSettingsGSSProtocols();
int SetSSHSettingsGSSProtocols(QString qsSSHSettingsGSSProtocols); int GetSSHSettingsHandshakeTimeout();
int SetSSHSettingsHandshakeTimeout(int iSSHSettingsHandshakeTimeout); QString GetSSHSettingsKexAlgorithms();
int SetSSHSettingsKexAlgorithms(QString qsSSHSettingsKexAlgorithms); QString GetSSHSettingsMacAlgorithms();
int SetSSHSettingsMacAlgorithms(QString qsSSHSettingsMacAlgorithms); int GetSSHSettingsMaxSSHPacketSize();
int SetSSHSettingsMaxSSHPacketSize(int iSSHSettingsMaxSSHPacketSize); int GetSSHSettingsMinWindowSize();
int SetSSHSettingsMinWindowSize(int iSSHSettingsMinWindowSize); bool GetSSHSettingsObfuscateHandshake();
int SetSSHSettingsObfuscateHandshake(bool bSSHSettingsObfuscateHandshake); QString GetSSHSettingsObfuscationPassword();
int SetSSHSettingsObfuscationPassword(QString qsSSHSettingsObfuscationPassword); QString GetSSHSettingsPublicKeyAlgorithms();
int SetSSHSettingsPublicKeyAlgorithms(QString qsSSHSettingsPublicKeyAlgorithms); bool GetSSHSettingsRequestPasswordChange();
int SetSSHSettingsRequestPasswordChange(bool bSSHSettingsRequestPasswordChange); QString GetSSHSettingsSoftwareName();
int SetSSHSettingsSoftwareName(QString qsSSHSettingsSoftwareName); bool GetSSHSettingsTrustAllKeys();
int SetSSHSettingsTrustAllKeys(bool bSSHSettingsTrustAllKeys); bool GetSSHSettingsUseAuthAgent();
int SetSSHSettingsUseAuthAgent(bool bSSHSettingsUseAuthAgent); int GetSSHSettingsVersions();
int SetSSHSettingsVersions(int iSSHSettingsVersions);

Remarks

Use this property to access and tune-up the SSH layer settings.

This property is read-only.

Data Type

SecureBlackboxSSHSettings

Users Property (SFTPServer Class)

A collection of known users.

Syntax

int secureblackbox_sftpserver_getusercount(void* lpObj);
int secureblackbox_sftpserver_setusercount(void* lpObj, int iUserCount);
int secureblackbox_sftpserver_getuserassociateddata(void* lpObj, int userindex, char** lpUserAssociatedData, int* lenUserAssociatedData);
int secureblackbox_sftpserver_setuserassociateddata(void* lpObj, int userindex, const char* lpUserAssociatedData, int lenUserAssociatedData);
char* secureblackbox_sftpserver_getuserbasepath(void* lpObj, int userindex);
int secureblackbox_sftpserver_setuserbasepath(void* lpObj, int userindex, const char* lpszUserBasePath);
int secureblackbox_sftpserver_getusercertificate(void* lpObj, int userindex, char** lpUserCertificate, int* lenUserCertificate);
int secureblackbox_sftpserver_setusercertificate(void* lpObj, int userindex, const char* lpUserCertificate, int lenUserCertificate);
char* secureblackbox_sftpserver_getuserdata(void* lpObj, int userindex);
int secureblackbox_sftpserver_setuserdata(void* lpObj, int userindex, const char* lpszUserData);
char* secureblackbox_sftpserver_getuseremail(void* lpObj, int userindex);
int secureblackbox_sftpserver_setuseremail(void* lpObj, int userindex, const char* lpszUserEmail);
int64 secureblackbox_sftpserver_getuserhandle(void* lpObj, int userindex);
int secureblackbox_sftpserver_setuserhandle(void* lpObj, int userindex, int64 lUserHandle);
char* secureblackbox_sftpserver_getuserhashalgorithm(void* lpObj, int userindex);
int secureblackbox_sftpserver_setuserhashalgorithm(void* lpObj, int userindex, const char* lpszUserHashAlgorithm);
int secureblackbox_sftpserver_getuserincomingspeedlimit(void* lpObj, int userindex);
int secureblackbox_sftpserver_setuserincomingspeedlimit(void* lpObj, int userindex, int iUserIncomingSpeedLimit);
int secureblackbox_sftpserver_getuserotpalgorithm(void* lpObj, int userindex);
int secureblackbox_sftpserver_setuserotpalgorithm(void* lpObj, int userindex, int iUserOtpAlgorithm);
int secureblackbox_sftpserver_getuserotplen(void* lpObj, int userindex);
int secureblackbox_sftpserver_setuserotplen(void* lpObj, int userindex, int iUserOTPLen);
int secureblackbox_sftpserver_getuserotpvalue(void* lpObj, int userindex);
int secureblackbox_sftpserver_setuserotpvalue(void* lpObj, int userindex, int iUserOtpValue);
int secureblackbox_sftpserver_getuseroutgoingspeedlimit(void* lpObj, int userindex);
int secureblackbox_sftpserver_setuseroutgoingspeedlimit(void* lpObj, int userindex, int iUserOutgoingSpeedLimit);
char* secureblackbox_sftpserver_getuserpassword(void* lpObj, int userindex);
int secureblackbox_sftpserver_setuserpassword(void* lpObj, int userindex, const char* lpszUserPassword);
int secureblackbox_sftpserver_getusersharedsecret(void* lpObj, int userindex, char** lpUserSharedSecret, int* lenUserSharedSecret);
int secureblackbox_sftpserver_setusersharedsecret(void* lpObj, int userindex, const char* lpUserSharedSecret, int lenUserSharedSecret);
int secureblackbox_sftpserver_getusersshkey(void* lpObj, int userindex, char** lpUserSSHKey, int* lenUserSSHKey);
int secureblackbox_sftpserver_setusersshkey(void* lpObj, int userindex, const char* lpUserSSHKey, int lenUserSSHKey);
char* secureblackbox_sftpserver_getuserusername(void* lpObj, int userindex);
int secureblackbox_sftpserver_setuserusername(void* lpObj, int userindex, const char* lpszUserUsername);
int GetUserCount();
int SetUserCount(int iUserCount); QByteArray GetUserAssociatedData(int iUserIndex);
int SetUserAssociatedData(int iUserIndex, QByteArray qbaUserAssociatedData); QString GetUserBasePath(int iUserIndex);
int SetUserBasePath(int iUserIndex, QString qsUserBasePath); QByteArray GetUserCertificate(int iUserIndex);
int SetUserCertificate(int iUserIndex, QByteArray qbaUserCertificate); QString GetUserData(int iUserIndex);
int SetUserData(int iUserIndex, QString qsUserData); QString GetUserEmail(int iUserIndex);
int SetUserEmail(int iUserIndex, QString qsUserEmail); qint64 GetUserHandle(int iUserIndex);
int SetUserHandle(int iUserIndex, qint64 lUserHandle); QString GetUserHashAlgorithm(int iUserIndex);
int SetUserHashAlgorithm(int iUserIndex, QString qsUserHashAlgorithm); int GetUserIncomingSpeedLimit(int iUserIndex);
int SetUserIncomingSpeedLimit(int iUserIndex, int iUserIncomingSpeedLimit); int GetUserOtpAlgorithm(int iUserIndex);
int SetUserOtpAlgorithm(int iUserIndex, int iUserOtpAlgorithm); int GetUserOTPLen(int iUserIndex);
int SetUserOTPLen(int iUserIndex, int iUserOTPLen); int GetUserOtpValue(int iUserIndex);
int SetUserOtpValue(int iUserIndex, int iUserOtpValue); int GetUserOutgoingSpeedLimit(int iUserIndex);
int SetUserOutgoingSpeedLimit(int iUserIndex, int iUserOutgoingSpeedLimit); QString GetUserPassword(int iUserIndex);
int SetUserPassword(int iUserIndex, QString qsUserPassword); QByteArray GetUserSharedSecret(int iUserIndex);
int SetUserSharedSecret(int iUserIndex, QByteArray qbaUserSharedSecret); QByteArray GetUserSSHKey(int iUserIndex);
int SetUserSSHKey(int iUserIndex, QByteArray qbaUserSSHKey); QString GetUserUsername(int iUserIndex);
int SetUserUsername(int iUserIndex, QString qsUserUsername);

Remarks

This property provides access to registered user database.

This property is not available at design time.

Data Type

SecureBlackboxUserAccount

UseUTF8 Property (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
int GetUseUTF8();
int SetUseUTF8(int bUseUTF8); Unicode (Windows) BOOL GetUseUTF8();
INT SetUseUTF8(BOOL bUseUTF8);
int secureblackbox_sftpserver_getuseutf8(void* lpObj);
int secureblackbox_sftpserver_setuseutf8(void* lpObj, int bUseUTF8);
bool GetUseUTF8();
int SetUseUTF8(bool bUseUTF8);

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 (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
int Cleanup();

Unicode (Windows)
INT Cleanup();
int secureblackbox_sftpserver_cleanup(void* lpObj);
int Cleanup();

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (SFTPServer Class)

Sets or retrieves a configuration setting.

Syntax

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_sftpserver_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DoAction Method (SFTPServer Class)

Performs an additional action.

Syntax

ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);
char* secureblackbox_sftpserver_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);
QString DoAction(const QString& qsActionID, const QString& qsActionParams);

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DropClient Method (SFTPServer Class)

Terminates a client connection.

Syntax

ANSI (Cross Platform)
int DropClient(int64 lConnectionId, int bForced);

Unicode (Windows)
INT DropClient(LONG64 lConnectionId, BOOL bForced);
int secureblackbox_sftpserver_dropclient(void* lpObj, int64 lConnectionId, int bForced);
int DropClient(qint64 lConnectionId, bool bForced);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetClientBuffer Method (SFTPServer Class)

Acquires a piece of operation data.

Syntax

ANSI (Cross Platform)
char* GetClientBuffer(int64 lConnectionID, const char* lpszHandle, int *lpSize = NULL);

Unicode (Windows)
LPSTR GetClientBuffer(LONG64 lConnectionID, LPCWSTR lpszHandle, LPINT lpSize = NULL);
char* secureblackbox_sftpserver_getclientbuffer(void* lpObj, int64 lConnectionID, const char* lpszHandle, int *lpSize);
QByteArray GetClientBuffer(qint64 lConnectionID, const QString& qsHandle);

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.

Error Handling (C++)

This method returns a Byte Array value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetClientFileEntry Method (SFTPServer Class)

Acquires file entry details from the class.

Syntax

ANSI (Cross Platform)
int GetClientFileEntry(int64 lConnectionID, const char* lpszHandle);

Unicode (Windows)
INT GetClientFileEntry(LONG64 lConnectionID, LPCWSTR lpszHandle);
int secureblackbox_sftpserver_getclientfileentry(void* lpObj, int64 lConnectionID, const char* lpszHandle);
int GetClientFileEntry(qint64 lConnectionID, const QString& qsHandle);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListClients Method (SFTPServer Class)

Enumerates the connected clients.

Syntax

ANSI (Cross Platform)
char* ListClients();

Unicode (Windows)
LPWSTR ListClients();
char* secureblackbox_sftpserver_listclients(void* lpObj);
QString ListClients();

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

PinClient Method (SFTPServer Class)

Takes a snapshot of the connection's properties.

Syntax

ANSI (Cross Platform)
int PinClient(int64 lConnectionId);

Unicode (Windows)
INT PinClient(LONG64 lConnectionId);
int secureblackbox_sftpserver_pinclient(void* lpObj, int64 lConnectionId);
int PinClient(qint64 lConnectionId);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (SFTPServer Class)

Resets the class settings.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
int secureblackbox_sftpserver_reset(void* lpObj);
int Reset();

Remarks

Reset is a generic method available in every class.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetClientBuffer Method (SFTPServer Class)

Commits a data buffer to the server class.

Syntax

ANSI (Cross Platform)
int SetClientBuffer(int64 lConnectionID, const char* lpszHandle, const char* lpValue, int lenValue);

Unicode (Windows)
INT SetClientBuffer(LONG64 lConnectionID, LPCWSTR lpszHandle, LPCSTR lpValue, INT lenValue);
int secureblackbox_sftpserver_setclientbuffer(void* lpObj, int64 lConnectionID, const char* lpszHandle, const char* lpValue, int lenValue);
int SetClientBuffer(qint64 lConnectionID, const QString& qsHandle, QByteArray qbaValue);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetClientFileEntry Method (SFTPServer Class)

Commits the file entry details to the class.

Syntax

ANSI (Cross Platform)
int SetClientFileEntry(int64 lConnectionID, const char* lpszHandle);

Unicode (Windows)
INT SetClientFileEntry(LONG64 lConnectionID, LPCWSTR lpszHandle);
int secureblackbox_sftpserver_setclientfileentry(void* lpObj, int64 lConnectionID, const char* lpszHandle);
int SetClientFileEntry(qint64 lConnectionID, const QString& qsHandle);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Start Method (SFTPServer Class)

Starts SFTP server operation.

Syntax

ANSI (Cross Platform)
int Start();

Unicode (Windows)
INT Start();
int secureblackbox_sftpserver_start(void* lpObj);
int Start();

Remarks

Call this method to start listening to incoming connections.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Stop Method (SFTPServer Class)

Stops SFTP server.

Syntax

ANSI (Cross Platform)
int Stop();

Unicode (Windows)
INT Stop();
int secureblackbox_sftpserver_stop(void* lpObj);
int Stop();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Accept Event (SFTPServer Class)

This event is fired when new incoming connection is accepted.

Syntax

ANSI (Cross Platform)
virtual int FireAccept(SFTPServerAcceptEventParams *e);
typedef struct {
const char *RemoteAddress;
int RemotePort;
int Accept; int reserved; } SFTPServerAcceptEventParams;
Unicode (Windows) virtual INT FireAccept(SFTPServerAcceptEventParams *e);
typedef struct {
LPCWSTR RemoteAddress;
INT RemotePort;
BOOL Accept; INT reserved; } SFTPServerAcceptEventParams;
#define EID_SFTPSERVER_ACCEPT 1

virtual INT SECUREBLACKBOX_CALL FireAccept(LPSTR &lpszRemoteAddress, INT &iRemotePort, BOOL &bAccept);
class SFTPServerAcceptEventParams {
public:
  const QString &RemoteAddress();

  int RemotePort();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Accept(SFTPServerAcceptEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireAccept(SFTPServerAcceptEventParams *e) {...}

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 (SFTPServer Class)

This event indicates completion of directory creation request.

Syntax

ANSI (Cross Platform)
virtual int FireAfterCreateDirectory(SFTPServerAfterCreateDirectoryEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path;
int OperationStatus; int reserved; } SFTPServerAfterCreateDirectoryEventParams;
Unicode (Windows) virtual INT FireAfterCreateDirectory(SFTPServerAfterCreateDirectoryEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path;
INT OperationStatus; INT reserved; } SFTPServerAfterCreateDirectoryEventParams;
#define EID_SFTPSERVER_AFTERCREATEDIRECTORY 2

virtual INT SECUREBLACKBOX_CALL FireAfterCreateDirectory(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iOperationStatus);
class SFTPServerAfterCreateDirectoryEventParams {
public:
  qint64 ConnectionID();

  const QString &Path();

  int OperationStatus();
  void SetOperationStatus(int iOperationStatus);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void AfterCreateDirectory(SFTPServerAfterCreateDirectoryEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireAfterCreateDirectory(SFTPServerAfterCreateDirectoryEventParams *e) {...}

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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

AfterRemove Event (SFTPServer Class)

This event indicates completion of file removal request.

Syntax

ANSI (Cross Platform)
virtual int FireAfterRemove(SFTPServerAfterRemoveEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path;
int OperationStatus; int reserved; } SFTPServerAfterRemoveEventParams;
Unicode (Windows) virtual INT FireAfterRemove(SFTPServerAfterRemoveEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path;
INT OperationStatus; INT reserved; } SFTPServerAfterRemoveEventParams;
#define EID_SFTPSERVER_AFTERREMOVE 3

virtual INT SECUREBLACKBOX_CALL FireAfterRemove(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iOperationStatus);
class SFTPServerAfterRemoveEventParams {
public:
  qint64 ConnectionID();

  const QString &Path();

  int OperationStatus();
  void SetOperationStatus(int iOperationStatus);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void AfterRemove(SFTPServerAfterRemoveEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireAfterRemove(SFTPServerAfterRemoveEventParams *e) {...}

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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

AfterRenameFile Event (SFTPServer Class)

This event indicates completion of a file rename operation.

Syntax

ANSI (Cross Platform)
virtual int FireAfterRenameFile(SFTPServerAfterRenameFileEventParams *e);
typedef struct {
int64 ConnectionID;
const char *OldPath;
const char *NewPath;
int OperationStatus; int reserved; } SFTPServerAfterRenameFileEventParams;
Unicode (Windows) virtual INT FireAfterRenameFile(SFTPServerAfterRenameFileEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR OldPath;
LPCWSTR NewPath;
INT OperationStatus; INT reserved; } SFTPServerAfterRenameFileEventParams;
#define EID_SFTPSERVER_AFTERRENAMEFILE 4

virtual INT SECUREBLACKBOX_CALL FireAfterRenameFile(LONG64 &lConnectionID, LPSTR &lpszOldPath, LPSTR &lpszNewPath, INT &iOperationStatus);
class SFTPServerAfterRenameFileEventParams {
public:
  qint64 ConnectionID();

  const QString &OldPath();

  const QString &NewPath();

  int OperationStatus();
  void SetOperationStatus(int iOperationStatus);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void AfterRenameFile(SFTPServerAfterRenameFileEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireAfterRenameFile(SFTPServerAfterRenameFileEventParams *e) {...}

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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

AfterRequestAttributes Event (SFTPServer Class)

This event indicates completion of file attributes request.

Syntax

ANSI (Cross Platform)
virtual int FireAfterRequestAttributes(SFTPServerAfterRequestAttributesEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path;
int OperationStatus; int reserved; } SFTPServerAfterRequestAttributesEventParams;
Unicode (Windows) virtual INT FireAfterRequestAttributes(SFTPServerAfterRequestAttributesEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path;
INT OperationStatus; INT reserved; } SFTPServerAfterRequestAttributesEventParams;
#define EID_SFTPSERVER_AFTERREQUESTATTRIBUTES 5

virtual INT SECUREBLACKBOX_CALL FireAfterRequestAttributes(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iOperationStatus);
class SFTPServerAfterRequestAttributesEventParams {
public:
  qint64 ConnectionID();

  const QString &Path();

  int OperationStatus();
  void SetOperationStatus(int iOperationStatus);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void AfterRequestAttributes(SFTPServerAfterRequestAttributesEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireAfterRequestAttributes(SFTPServerAfterRequestAttributesEventParams *e) {...}

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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

AfterSetAttributes Event (SFTPServer Class)

This event indicates completion of a set attributes request.

Syntax

ANSI (Cross Platform)
virtual int FireAfterSetAttributes(SFTPServerAfterSetAttributesEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path;
int OperationStatus; int reserved; } SFTPServerAfterSetAttributesEventParams;
Unicode (Windows) virtual INT FireAfterSetAttributes(SFTPServerAfterSetAttributesEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path;
INT OperationStatus; INT reserved; } SFTPServerAfterSetAttributesEventParams;
#define EID_SFTPSERVER_AFTERSETATTRIBUTES 6

virtual INT SECUREBLACKBOX_CALL FireAfterSetAttributes(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iOperationStatus);
class SFTPServerAfterSetAttributesEventParams {
public:
  qint64 ConnectionID();

  const QString &Path();

  int OperationStatus();
  void SetOperationStatus(int iOperationStatus);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void AfterSetAttributes(SFTPServerAfterSetAttributesEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireAfterSetAttributes(SFTPServerAfterSetAttributesEventParams *e) {...}

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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

AuthAttempt Event (SFTPServer Class)

Reports a user authentication attempt.

Syntax

ANSI (Cross Platform)
virtual int FireAuthAttempt(SFTPServerAuthAttemptEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Username;
int AuthType;
int Accept; int reserved; } SFTPServerAuthAttemptEventParams;
Unicode (Windows) virtual INT FireAuthAttempt(SFTPServerAuthAttemptEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Username;
INT AuthType;
BOOL Accept; INT reserved; } SFTPServerAuthAttemptEventParams;
#define EID_SFTPSERVER_AUTHATTEMPT 7

virtual INT SECUREBLACKBOX_CALL FireAuthAttempt(LONG64 &lConnectionID, LPSTR &lpszUsername, INT &iAuthType, BOOL &bAccept);
class SFTPServerAuthAttemptEventParams {
public:
  qint64 ConnectionID();

  const QString &Username();

  int AuthType();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void AuthAttempt(SFTPServerAuthAttemptEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireAuthAttempt(SFTPServerAuthAttemptEventParams *e) {...}

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:

atRhosts0x01RHOSTS file authentication. Rarely used today.

atPublicKey0x02Public key (sometimes called private key) authentication

atPassword0x04Password-based authentication

atHostbased0x08Hostbased authentication

atKeyboard0x10Keyboard-interactive authentication. This is often used in place of generic password authentication.

atGssWithMic0x20GSS authentication

atGssKeyex0x40GSS authentication with key exchange

atPublicKeyAgent0x80Public key agent authentication

AuthFailed Event (SFTPServer Class)

Reports user authentication failure.

Syntax

ANSI (Cross Platform)
virtual int FireAuthFailed(SFTPServerAuthFailedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Username;
int AuthType; int reserved; } SFTPServerAuthFailedEventParams;
Unicode (Windows) virtual INT FireAuthFailed(SFTPServerAuthFailedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Username;
INT AuthType; INT reserved; } SFTPServerAuthFailedEventParams;
#define EID_SFTPSERVER_AUTHFAILED 8

virtual INT SECUREBLACKBOX_CALL FireAuthFailed(LONG64 &lConnectionID, LPSTR &lpszUsername, INT &iAuthType);
class SFTPServerAuthFailedEventParams {
public:
  qint64 ConnectionID();

  const QString &Username();

  int AuthType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void AuthFailed(SFTPServerAuthFailedEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireAuthFailed(SFTPServerAuthFailedEventParams *e) {...}

Remarks

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

Supported authentication types:

atRhosts0x01RHOSTS file authentication. Rarely used today.

atPublicKey0x02Public key (sometimes called private key) authentication

atPassword0x04Password-based authentication

atHostbased0x08Hostbased authentication

atKeyboard0x10Keyboard-interactive authentication. This is often used in place of generic password authentication.

atGssWithMic0x20GSS authentication

atGssKeyex0x40GSS authentication with key exchange

atPublicKeyAgent0x80Public key agent authentication

AuthPassword Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireAuthPassword(SFTPServerAuthPasswordEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Username;
const char *Password;
int Accept;
int ForceChangePassword; int reserved; } SFTPServerAuthPasswordEventParams;
Unicode (Windows) virtual INT FireAuthPassword(SFTPServerAuthPasswordEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Username;
LPCWSTR Password;
BOOL Accept;
BOOL ForceChangePassword; INT reserved; } SFTPServerAuthPasswordEventParams;
#define EID_SFTPSERVER_AUTHPASSWORD 9

virtual INT SECUREBLACKBOX_CALL FireAuthPassword(LONG64 &lConnectionID, LPSTR &lpszUsername, LPSTR &lpszPassword, BOOL &bAccept, BOOL &bForceChangePassword);
class SFTPServerAuthPasswordEventParams {
public:
  qint64 ConnectionID();

  const QString &Username();

  const QString &Password();

  bool Accept();
  void SetAccept(bool bAccept);

  bool ForceChangePassword();
  void SetForceChangePassword(bool bForceChangePassword);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void AuthPassword(SFTPServerAuthPasswordEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireAuthPassword(SFTPServerAuthPasswordEventParams *e) {...}

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 (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireAuthPublicKey(SFTPServerAuthPublicKeyEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Username;
int Accept; int reserved; } SFTPServerAuthPublicKeyEventParams;
Unicode (Windows) virtual INT FireAuthPublicKey(SFTPServerAuthPublicKeyEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Username;
BOOL Accept; INT reserved; } SFTPServerAuthPublicKeyEventParams;
#define EID_SFTPSERVER_AUTHPUBLICKEY 10

virtual INT SECUREBLACKBOX_CALL FireAuthPublicKey(LONG64 &lConnectionID, LPSTR &lpszUsername, BOOL &bAccept);
class SFTPServerAuthPublicKeyEventParams {
public:
  qint64 ConnectionID();

  const QString &Username();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void AuthPublicKey(SFTPServerAuthPublicKeyEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireAuthPublicKey(SFTPServerAuthPublicKeyEventParams *e) {...}

Remarks

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

AuthSucceeded Event (SFTPServer Class)

Reports a successful user authentication.

Syntax

ANSI (Cross Platform)
virtual int FireAuthSucceeded(SFTPServerAuthSucceededEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Username;
int AuthType; int reserved; } SFTPServerAuthSucceededEventParams;
Unicode (Windows) virtual INT FireAuthSucceeded(SFTPServerAuthSucceededEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Username;
INT AuthType; INT reserved; } SFTPServerAuthSucceededEventParams;
#define EID_SFTPSERVER_AUTHSUCCEEDED 11

virtual INT SECUREBLACKBOX_CALL FireAuthSucceeded(LONG64 &lConnectionID, LPSTR &lpszUsername, INT &iAuthType);
class SFTPServerAuthSucceededEventParams {
public:
  qint64 ConnectionID();

  const QString &Username();

  int AuthType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void AuthSucceeded(SFTPServerAuthSucceededEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireAuthSucceeded(SFTPServerAuthSucceededEventParams *e) {...}

Remarks

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

Supported authentication types:

atRhosts0x01RHOSTS file authentication. Rarely used today.

atPublicKey0x02Public key (sometimes called private key) authentication

atPassword0x04Password-based authentication

atHostbased0x08Hostbased authentication

atKeyboard0x10Keyboard-interactive authentication. This is often used in place of generic password authentication.

atGssWithMic0x20GSS authentication

atGssKeyex0x40GSS authentication with key exchange

atPublicKeyAgent0x80Public key agent authentication

BeforeCreateDirectory Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireBeforeCreateDirectory(SFTPServerBeforeCreateDirectoryEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path;
int Action; int reserved; } SFTPServerBeforeCreateDirectoryEventParams;
Unicode (Windows) virtual INT FireBeforeCreateDirectory(SFTPServerBeforeCreateDirectoryEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path;
INT Action; INT reserved; } SFTPServerBeforeCreateDirectoryEventParams;
#define EID_SFTPSERVER_BEFORECREATEDIRECTORY 12

virtual INT SECUREBLACKBOX_CALL FireBeforeCreateDirectory(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iAction);
class SFTPServerBeforeCreateDirectoryEventParams {
public:
  qint64 ConnectionID();

  const QString &Path();

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void BeforeCreateDirectory(SFTPServerBeforeCreateDirectoryEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireBeforeCreateDirectory(SFTPServerBeforeCreateDirectoryEventParams *e) {...}

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:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

BeforeDownloadFile Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireBeforeDownloadFile(SFTPServerBeforeDownloadFileEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path;
int Action; int reserved; } SFTPServerBeforeDownloadFileEventParams;
Unicode (Windows) virtual INT FireBeforeDownloadFile(SFTPServerBeforeDownloadFileEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path;
INT Action; INT reserved; } SFTPServerBeforeDownloadFileEventParams;
#define EID_SFTPSERVER_BEFOREDOWNLOADFILE 13

virtual INT SECUREBLACKBOX_CALL FireBeforeDownloadFile(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iAction);
class SFTPServerBeforeDownloadFileEventParams {
public:
  qint64 ConnectionID();

  const QString &Path();

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void BeforeDownloadFile(SFTPServerBeforeDownloadFileEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireBeforeDownloadFile(SFTPServerBeforeDownloadFileEventParams *e) {...}

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:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

BeforeFind Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireBeforeFind(SFTPServerBeforeFindEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path;
int Action; int reserved; } SFTPServerBeforeFindEventParams;
Unicode (Windows) virtual INT FireBeforeFind(SFTPServerBeforeFindEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path;
INT Action; INT reserved; } SFTPServerBeforeFindEventParams;
#define EID_SFTPSERVER_BEFOREFIND 14

virtual INT SECUREBLACKBOX_CALL FireBeforeFind(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iAction);
class SFTPServerBeforeFindEventParams {
public:
  qint64 ConnectionID();

  const QString &Path();

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void BeforeFind(SFTPServerBeforeFindEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireBeforeFind(SFTPServerBeforeFindEventParams *e) {...}

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:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

BeforeOpenClientForwarding Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireBeforeOpenClientForwarding(SFTPServerBeforeOpenClientForwardingEventParams *e);
typedef struct {
int64 ConnectionID;
char *DestHost;
int DestPort;
const char *SrcHost;
int SrcPort;
int Action; int reserved; } SFTPServerBeforeOpenClientForwardingEventParams;
Unicode (Windows) virtual INT FireBeforeOpenClientForwarding(SFTPServerBeforeOpenClientForwardingEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPWSTR DestHost;
INT DestPort;
LPCWSTR SrcHost;
INT SrcPort;
INT Action; INT reserved; } SFTPServerBeforeOpenClientForwardingEventParams;
#define EID_SFTPSERVER_BEFOREOPENCLIENTFORWARDING 15

virtual INT SECUREBLACKBOX_CALL FireBeforeOpenClientForwarding(LONG64 &lConnectionID, LPSTR &lpszDestHost, INT &iDestPort, LPSTR &lpszSrcHost, INT &iSrcPort, INT &iAction);
class SFTPServerBeforeOpenClientForwardingEventParams {
public:
  qint64 ConnectionID();

  const QString &DestHost();
  void SetDestHost(const QString &qsDestHost);

  int DestPort();
  void SetDestPort(int iDestPort);

  const QString &SrcHost();

  int SrcPort();

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void BeforeOpenClientForwarding(SFTPServerBeforeOpenClientForwardingEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireBeforeOpenClientForwarding(SFTPServerBeforeOpenClientForwardingEventParams *e) {...}

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:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

BeforeOpenCommand Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireBeforeOpenCommand(SFTPServerBeforeOpenCommandEventParams *e);
typedef struct {
int64 ConnectionID;
char *Command;
int Action; int reserved; } SFTPServerBeforeOpenCommandEventParams;
Unicode (Windows) virtual INT FireBeforeOpenCommand(SFTPServerBeforeOpenCommandEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPWSTR Command;
INT Action; INT reserved; } SFTPServerBeforeOpenCommandEventParams;
#define EID_SFTPSERVER_BEFOREOPENCOMMAND 16

virtual INT SECUREBLACKBOX_CALL FireBeforeOpenCommand(LONG64 &lConnectionID, LPSTR &lpszCommand, INT &iAction);
class SFTPServerBeforeOpenCommandEventParams {
public:
  qint64 ConnectionID();

  const QString &Command();
  void SetCommand(const QString &qsCommand);

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void BeforeOpenCommand(SFTPServerBeforeOpenCommandEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireBeforeOpenCommand(SFTPServerBeforeOpenCommandEventParams *e) {...}

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:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

BeforeOpenServerForwarding Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireBeforeOpenServerForwarding(SFTPServerBeforeOpenServerForwardingEventParams *e);
typedef struct {
int64 ConnectionID;
const char *LocalHost;
int LocalPort;
const char *SrcHost;
int SrcPort;
int Action; int reserved; } SFTPServerBeforeOpenServerForwardingEventParams;
Unicode (Windows) virtual INT FireBeforeOpenServerForwarding(SFTPServerBeforeOpenServerForwardingEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR LocalHost;
INT LocalPort;
LPCWSTR SrcHost;
INT SrcPort;
INT Action; INT reserved; } SFTPServerBeforeOpenServerForwardingEventParams;
#define EID_SFTPSERVER_BEFOREOPENSERVERFORWARDING 17

virtual INT SECUREBLACKBOX_CALL FireBeforeOpenServerForwarding(LONG64 &lConnectionID, LPSTR &lpszLocalHost, INT &iLocalPort, LPSTR &lpszSrcHost, INT &iSrcPort, INT &iAction);
class SFTPServerBeforeOpenServerForwardingEventParams {
public:
  qint64 ConnectionID();

  const QString &LocalHost();

  int LocalPort();

  const QString &SrcHost();

  int SrcPort();

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void BeforeOpenServerForwarding(SFTPServerBeforeOpenServerForwardingEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireBeforeOpenServerForwarding(SFTPServerBeforeOpenServerForwardingEventParams *e) {...}

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:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

BeforeOpenShell Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireBeforeOpenShell(SFTPServerBeforeOpenShellEventParams *e);
typedef struct {
int64 ConnectionID;
int Action; int reserved; } SFTPServerBeforeOpenShellEventParams;
Unicode (Windows) virtual INT FireBeforeOpenShell(SFTPServerBeforeOpenShellEventParams *e);
typedef struct {
LONG64 ConnectionID;
INT Action; INT reserved; } SFTPServerBeforeOpenShellEventParams;
#define EID_SFTPSERVER_BEFOREOPENSHELL 18

virtual INT SECUREBLACKBOX_CALL FireBeforeOpenShell(LONG64 &lConnectionID, INT &iAction);
class SFTPServerBeforeOpenShellEventParams {
public:
  qint64 ConnectionID();

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void BeforeOpenShell(SFTPServerBeforeOpenShellEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireBeforeOpenShell(SFTPServerBeforeOpenShellEventParams *e) {...}

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:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

BeforeRemove Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireBeforeRemove(SFTPServerBeforeRemoveEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path;
int Action; int reserved; } SFTPServerBeforeRemoveEventParams;
Unicode (Windows) virtual INT FireBeforeRemove(SFTPServerBeforeRemoveEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path;
INT Action; INT reserved; } SFTPServerBeforeRemoveEventParams;
#define EID_SFTPSERVER_BEFOREREMOVE 19

virtual INT SECUREBLACKBOX_CALL FireBeforeRemove(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iAction);
class SFTPServerBeforeRemoveEventParams {
public:
  qint64 ConnectionID();

  const QString &Path();

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void BeforeRemove(SFTPServerBeforeRemoveEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireBeforeRemove(SFTPServerBeforeRemoveEventParams *e) {...}

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:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

BeforeRenameFile Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireBeforeRenameFile(SFTPServerBeforeRenameFileEventParams *e);
typedef struct {
int64 ConnectionID;
const char *OldPath;
const char *NewPath;
int Action; int reserved; } SFTPServerBeforeRenameFileEventParams;
Unicode (Windows) virtual INT FireBeforeRenameFile(SFTPServerBeforeRenameFileEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR OldPath;
LPCWSTR NewPath;
INT Action; INT reserved; } SFTPServerBeforeRenameFileEventParams;
#define EID_SFTPSERVER_BEFORERENAMEFILE 20

virtual INT SECUREBLACKBOX_CALL FireBeforeRenameFile(LONG64 &lConnectionID, LPSTR &lpszOldPath, LPSTR &lpszNewPath, INT &iAction);
class SFTPServerBeforeRenameFileEventParams {
public:
  qint64 ConnectionID();

  const QString &OldPath();

  const QString &NewPath();

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void BeforeRenameFile(SFTPServerBeforeRenameFileEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireBeforeRenameFile(SFTPServerBeforeRenameFileEventParams *e) {...}

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:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

BeforeRequestAttributes Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireBeforeRequestAttributes(SFTPServerBeforeRequestAttributesEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path;
int Action; int reserved; } SFTPServerBeforeRequestAttributesEventParams;
Unicode (Windows) virtual INT FireBeforeRequestAttributes(SFTPServerBeforeRequestAttributesEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path;
INT Action; INT reserved; } SFTPServerBeforeRequestAttributesEventParams;
#define EID_SFTPSERVER_BEFOREREQUESTATTRIBUTES 21

virtual INT SECUREBLACKBOX_CALL FireBeforeRequestAttributes(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iAction);
class SFTPServerBeforeRequestAttributesEventParams {
public:
  qint64 ConnectionID();

  const QString &Path();

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void BeforeRequestAttributes(SFTPServerBeforeRequestAttributesEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireBeforeRequestAttributes(SFTPServerBeforeRequestAttributesEventParams *e) {...}

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:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

BeforeSetAttributes Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireBeforeSetAttributes(SFTPServerBeforeSetAttributesEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path;
int Action; int reserved; } SFTPServerBeforeSetAttributesEventParams;
Unicode (Windows) virtual INT FireBeforeSetAttributes(SFTPServerBeforeSetAttributesEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path;
INT Action; INT reserved; } SFTPServerBeforeSetAttributesEventParams;
#define EID_SFTPSERVER_BEFORESETATTRIBUTES 22

virtual INT SECUREBLACKBOX_CALL FireBeforeSetAttributes(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iAction);
class SFTPServerBeforeSetAttributesEventParams {
public:
  qint64 ConnectionID();

  const QString &Path();

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void BeforeSetAttributes(SFTPServerBeforeSetAttributesEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireBeforeSetAttributes(SFTPServerBeforeSetAttributesEventParams *e) {...}

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:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

BeforeUploadFile Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireBeforeUploadFile(SFTPServerBeforeUploadFileEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path;
int Action; int reserved; } SFTPServerBeforeUploadFileEventParams;
Unicode (Windows) virtual INT FireBeforeUploadFile(SFTPServerBeforeUploadFileEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path;
INT Action; INT reserved; } SFTPServerBeforeUploadFileEventParams;
#define EID_SFTPSERVER_BEFOREUPLOADFILE 23

virtual INT SECUREBLACKBOX_CALL FireBeforeUploadFile(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iAction);
class SFTPServerBeforeUploadFileEventParams {
public:
  qint64 ConnectionID();

  const QString &Path();

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void BeforeUploadFile(SFTPServerBeforeUploadFileEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireBeforeUploadFile(SFTPServerBeforeUploadFileEventParams *e) {...}

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:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

CloseClientForwarding Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireCloseClientForwarding(SFTPServerCloseClientForwardingEventParams *e);
typedef struct {
int64 ConnectionID;
const char *DestHost;
int DestPort;
const char *SrcHost;
int SrcPort; int reserved; } SFTPServerCloseClientForwardingEventParams;
Unicode (Windows) virtual INT FireCloseClientForwarding(SFTPServerCloseClientForwardingEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR DestHost;
INT DestPort;
LPCWSTR SrcHost;
INT SrcPort; INT reserved; } SFTPServerCloseClientForwardingEventParams;
#define EID_SFTPSERVER_CLOSECLIENTFORWARDING 24

virtual INT SECUREBLACKBOX_CALL FireCloseClientForwarding(LONG64 &lConnectionID, LPSTR &lpszDestHost, INT &iDestPort, LPSTR &lpszSrcHost, INT &iSrcPort);
class SFTPServerCloseClientForwardingEventParams {
public:
  qint64 ConnectionID();

  const QString &DestHost();

  int DestPort();

  const QString &SrcHost();

  int SrcPort();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void CloseClientForwarding(SFTPServerCloseClientForwardingEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireCloseClientForwarding(SFTPServerCloseClientForwardingEventParams *e) {...}

Remarks

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

CloseCommand Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireCloseCommand(SFTPServerCloseCommandEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Command; int reserved; } SFTPServerCloseCommandEventParams;
Unicode (Windows) virtual INT FireCloseCommand(SFTPServerCloseCommandEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Command; INT reserved; } SFTPServerCloseCommandEventParams;
#define EID_SFTPSERVER_CLOSECOMMAND 25

virtual INT SECUREBLACKBOX_CALL FireCloseCommand(LONG64 &lConnectionID, LPSTR &lpszCommand);
class SFTPServerCloseCommandEventParams {
public:
  qint64 ConnectionID();

  const QString &Command();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void CloseCommand(SFTPServerCloseCommandEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireCloseCommand(SFTPServerCloseCommandEventParams *e) {...}

Remarks

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

CloseFile Event (SFTPServer Class)

This event instructs the application to close an opened file.

Syntax

ANSI (Cross Platform)
virtual int FireCloseFile(SFTPServerCloseFileEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Handle;
int OperationStatus; int reserved; } SFTPServerCloseFileEventParams;
Unicode (Windows) virtual INT FireCloseFile(SFTPServerCloseFileEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Handle;
INT OperationStatus; INT reserved; } SFTPServerCloseFileEventParams;
#define EID_SFTPSERVER_CLOSEFILE 26

virtual INT SECUREBLACKBOX_CALL FireCloseFile(LONG64 &lConnectionID, LPSTR &lpszHandle, INT &iOperationStatus);
class SFTPServerCloseFileEventParams {
public:
  qint64 ConnectionID();

  const QString &Handle();

  int OperationStatus();
  void SetOperationStatus(int iOperationStatus);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void CloseFile(SFTPServerCloseFileEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireCloseFile(SFTPServerCloseFileEventParams *e) {...}

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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

CloseServerForwarding Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireCloseServerForwarding(SFTPServerCloseServerForwardingEventParams *e);
typedef struct {
int64 ConnectionID;
const char *LocalHost;
int LocalPort;
const char *SrcHost;
int SrcPort; int reserved; } SFTPServerCloseServerForwardingEventParams;
Unicode (Windows) virtual INT FireCloseServerForwarding(SFTPServerCloseServerForwardingEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR LocalHost;
INT LocalPort;
LPCWSTR SrcHost;
INT SrcPort; INT reserved; } SFTPServerCloseServerForwardingEventParams;
#define EID_SFTPSERVER_CLOSESERVERFORWARDING 27

virtual INT SECUREBLACKBOX_CALL FireCloseServerForwarding(LONG64 &lConnectionID, LPSTR &lpszLocalHost, INT &iLocalPort, LPSTR &lpszSrcHost, INT &iSrcPort);
class SFTPServerCloseServerForwardingEventParams {
public:
  qint64 ConnectionID();

  const QString &LocalHost();

  int LocalPort();

  const QString &SrcHost();

  int SrcPort();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void CloseServerForwarding(SFTPServerCloseServerForwardingEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireCloseServerForwarding(SFTPServerCloseServerForwardingEventParams *e) {...}

Remarks

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

CloseShell Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireCloseShell(SFTPServerCloseShellEventParams *e);
typedef struct {
int64 ConnectionID; int reserved; } SFTPServerCloseShellEventParams;
Unicode (Windows) virtual INT FireCloseShell(SFTPServerCloseShellEventParams *e);
typedef struct {
LONG64 ConnectionID; INT reserved; } SFTPServerCloseShellEventParams;
#define EID_SFTPSERVER_CLOSESHELL 28

virtual INT SECUREBLACKBOX_CALL FireCloseShell(LONG64 &lConnectionID);
class SFTPServerCloseShellEventParams {
public:
  qint64 ConnectionID();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void CloseShell(SFTPServerCloseShellEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireCloseShell(SFTPServerCloseShellEventParams *e) {...}

Remarks

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

Connect Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireConnect(SFTPServerConnectEventParams *e);
typedef struct {
int64 ConnectionID;
const char *RemoteAddress;
int RemotePort; int reserved; } SFTPServerConnectEventParams;
Unicode (Windows) virtual INT FireConnect(SFTPServerConnectEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR RemoteAddress;
INT RemotePort; INT reserved; } SFTPServerConnectEventParams;
#define EID_SFTPSERVER_CONNECT 29

virtual INT SECUREBLACKBOX_CALL FireConnect(LONG64 &lConnectionID, LPSTR &lpszRemoteAddress, INT &iRemotePort);
class SFTPServerConnectEventParams {
public:
  qint64 ConnectionID();

  const QString &RemoteAddress();

  int RemotePort();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Connect(SFTPServerConnectEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireConnect(SFTPServerConnectEventParams *e) {...}

Remarks

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

CreateDirectory Event (SFTPServer Class)

This event instructs the application to create a directory.

Syntax

ANSI (Cross Platform)
virtual int FireCreateDirectory(SFTPServerCreateDirectoryEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path;
int OperationStatus; int reserved; } SFTPServerCreateDirectoryEventParams;
Unicode (Windows) virtual INT FireCreateDirectory(SFTPServerCreateDirectoryEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path;
INT OperationStatus; INT reserved; } SFTPServerCreateDirectoryEventParams;
#define EID_SFTPSERVER_CREATEDIRECTORY 30

virtual INT SECUREBLACKBOX_CALL FireCreateDirectory(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iOperationStatus);
class SFTPServerCreateDirectoryEventParams {
public:
  qint64 ConnectionID();

  const QString &Path();

  int OperationStatus();
  void SetOperationStatus(int iOperationStatus);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void CreateDirectory(SFTPServerCreateDirectoryEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireCreateDirectory(SFTPServerCreateDirectoryEventParams *e) {...}

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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

Disconnect Event (SFTPServer Class)

This event is fired when a client has disconnected.

Syntax

ANSI (Cross Platform)
virtual int FireDisconnect(SFTPServerDisconnectEventParams *e);
typedef struct {
int64 ConnectionID; int reserved; } SFTPServerDisconnectEventParams;
Unicode (Windows) virtual INT FireDisconnect(SFTPServerDisconnectEventParams *e);
typedef struct {
LONG64 ConnectionID; INT reserved; } SFTPServerDisconnectEventParams;
#define EID_SFTPSERVER_DISCONNECT 31

virtual INT SECUREBLACKBOX_CALL FireDisconnect(LONG64 &lConnectionID);
class SFTPServerDisconnectEventParams {
public:
  qint64 ConnectionID();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Disconnect(SFTPServerDisconnectEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireDisconnect(SFTPServerDisconnectEventParams *e) {...}

Remarks

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

Error Event (SFTPServer Class)

Information about errors during data delivery.

Syntax

ANSI (Cross Platform)
virtual int FireError(SFTPServerErrorEventParams *e);
typedef struct {
int64 ConnectionID;
int ErrorCode;
int Fatal;
int Remote;
const char *Description; int reserved; } SFTPServerErrorEventParams;
Unicode (Windows) virtual INT FireError(SFTPServerErrorEventParams *e);
typedef struct {
LONG64 ConnectionID;
INT ErrorCode;
BOOL Fatal;
BOOL Remote;
LPCWSTR Description; INT reserved; } SFTPServerErrorEventParams;
#define EID_SFTPSERVER_ERROR 32

virtual INT SECUREBLACKBOX_CALL FireError(LONG64 &lConnectionID, INT &iErrorCode, BOOL &bFatal, BOOL &bRemote, LPSTR &lpszDescription);
class SFTPServerErrorEventParams {
public:
  qint64 ConnectionID();

  int ErrorCode();

  bool Fatal();

  bool Remote();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Error(SFTPServerErrorEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireError(SFTPServerErrorEventParams *e) {...}

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 (SFTPServer Class)

Handles remote or external signing initiated by the server protocol.

Syntax

ANSI (Cross Platform)
virtual int FireExternalSign(SFTPServerExternalSignEventParams *e);
typedef struct {
int64 ConnectionID;
const char *OperationId;
const char *HashAlgorithm;
const char *Pars;
const char *Data;
char *SignedData; int reserved; } SFTPServerExternalSignEventParams;
Unicode (Windows) virtual INT FireExternalSign(SFTPServerExternalSignEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR OperationId;
LPCWSTR HashAlgorithm;
LPCWSTR Pars;
LPCWSTR Data;
LPWSTR SignedData; INT reserved; } SFTPServerExternalSignEventParams;
#define EID_SFTPSERVER_EXTERNALSIGN 33

virtual INT SECUREBLACKBOX_CALL FireExternalSign(LONG64 &lConnectionID, LPSTR &lpszOperationId, LPSTR &lpszHashAlgorithm, LPSTR &lpszPars, LPSTR &lpszData, LPSTR &lpszSignedData);
class SFTPServerExternalSignEventParams {
public:
  qint64 ConnectionID();

  const QString &OperationId();

  const QString &HashAlgorithm();

  const QString &Pars();

  const QString &Data();

  const QString &SignedData();
  void SetSignedData(const QString &qsSignedData);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ExternalSign(SFTPServerExternalSignEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireExternalSign(SFTPServerExternalSignEventParams *e) {...}

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 (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireFindClose(SFTPServerFindCloseEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Handle;
int OperationStatus; int reserved; } SFTPServerFindCloseEventParams;
Unicode (Windows) virtual INT FireFindClose(SFTPServerFindCloseEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Handle;
INT OperationStatus; INT reserved; } SFTPServerFindCloseEventParams;
#define EID_SFTPSERVER_FINDCLOSE 34

virtual INT SECUREBLACKBOX_CALL FireFindClose(LONG64 &lConnectionID, LPSTR &lpszHandle, INT &iOperationStatus);
class SFTPServerFindCloseEventParams {
public:
  qint64 ConnectionID();

  const QString &Handle();

  int OperationStatus();
  void SetOperationStatus(int iOperationStatus);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void FindClose(SFTPServerFindCloseEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireFindClose(SFTPServerFindCloseEventParams *e) {...}

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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

FindFirst Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireFindFirst(SFTPServerFindFirstEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path;
int OperationStatus;
char *Handle; int reserved; } SFTPServerFindFirstEventParams;
Unicode (Windows) virtual INT FireFindFirst(SFTPServerFindFirstEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path;
INT OperationStatus;
LPWSTR Handle; INT reserved; } SFTPServerFindFirstEventParams;
#define EID_SFTPSERVER_FINDFIRST 35

virtual INT SECUREBLACKBOX_CALL FireFindFirst(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iOperationStatus, LPSTR &lpszHandle);
class SFTPServerFindFirstEventParams {
public:
  qint64 ConnectionID();

  const QString &Path();

  int OperationStatus();
  void SetOperationStatus(int iOperationStatus);

  const QString &Handle();
  void SetHandle(const QString &qsHandle);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void FindFirst(SFTPServerFindFirstEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireFindFirst(SFTPServerFindFirstEventParams *e) {...}

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,

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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

FindNext Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireFindNext(SFTPServerFindNextEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Handle;
int OperationStatus; int reserved; } SFTPServerFindNextEventParams;
Unicode (Windows) virtual INT FireFindNext(SFTPServerFindNextEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Handle;
INT OperationStatus; INT reserved; } SFTPServerFindNextEventParams;
#define EID_SFTPSERVER_FINDNEXT 36

virtual INT SECUREBLACKBOX_CALL FireFindNext(LONG64 &lConnectionID, LPSTR &lpszHandle, INT &iOperationStatus);
class SFTPServerFindNextEventParams {
public:
  qint64 ConnectionID();

  const QString &Handle();

  int OperationStatus();
  void SetOperationStatus(int iOperationStatus);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void FindNext(SFTPServerFindNextEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireFindNext(SFTPServerFindNextEventParams *e) {...}

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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

ListeningStarted Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireListeningStarted(SFTPServerListeningStartedEventParams *e);
typedef struct {
const char *Host;
int Port; int reserved; } SFTPServerListeningStartedEventParams;
Unicode (Windows) virtual INT FireListeningStarted(SFTPServerListeningStartedEventParams *e);
typedef struct {
LPCWSTR Host;
INT Port; INT reserved; } SFTPServerListeningStartedEventParams;
#define EID_SFTPSERVER_LISTENINGSTARTED 37

virtual INT SECUREBLACKBOX_CALL FireListeningStarted(LPSTR &lpszHost, INT &iPort);
class SFTPServerListeningStartedEventParams {
public:
  const QString &Host();

  int Port();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ListeningStarted(SFTPServerListeningStartedEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireListeningStarted(SFTPServerListeningStartedEventParams *e) {...}

Remarks

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

ListeningStopped Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireListeningStopped(SFTPServerListeningStoppedEventParams *e);
typedef struct {
const char *Host;
int Port; int reserved; } SFTPServerListeningStoppedEventParams;
Unicode (Windows) virtual INT FireListeningStopped(SFTPServerListeningStoppedEventParams *e);
typedef struct {
LPCWSTR Host;
INT Port; INT reserved; } SFTPServerListeningStoppedEventParams;
#define EID_SFTPSERVER_LISTENINGSTOPPED 38

virtual INT SECUREBLACKBOX_CALL FireListeningStopped(LPSTR &lpszHost, INT &iPort);
class SFTPServerListeningStoppedEventParams {
public:
  const QString &Host();

  int Port();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ListeningStopped(SFTPServerListeningStoppedEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireListeningStopped(SFTPServerListeningStoppedEventParams *e) {...}

Remarks

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

Notification Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireNotification(SFTPServerNotificationEventParams *e);
typedef struct {
const char *EventID;
const char *EventParam; int reserved; } SFTPServerNotificationEventParams;
Unicode (Windows) virtual INT FireNotification(SFTPServerNotificationEventParams *e);
typedef struct {
LPCWSTR EventID;
LPCWSTR EventParam; INT reserved; } SFTPServerNotificationEventParams;
#define EID_SFTPSERVER_NOTIFICATION 39

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
class SFTPServerNotificationEventParams {
public:
  const QString &EventID();

  const QString &EventParam();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Notification(SFTPServerNotificationEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireNotification(SFTPServerNotificationEventParams *e) {...}

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:

FileOpenNotifies your code about the file being opened, which is typically an indicator of the initiation of the transfer operation. The EventParam value passed with this EventID is a string of the following format:

ConnectionID=3;Path=/dir/file;Handle=x5DshAk8;Modes=48;Access=0;DesiredAccess=8

This EventID only fires if the NotifyOnFileOperations configuration property is set to true.

FileReadNotifies your code about the file chunk being requested. The EventParam value passed with this EventID is a string of the following format:

ConnectionID=7;Handle=x5DshAk8;Offset=2048;Count=1024;Read=1021

This EventID only fires if the NotifyOnFileOperations configuration property is set to true.

FileWriteNotifies your code about the file chunk being received. The EventParam value passed with this EventID is a string of the following format:

ConnectionID=7;Handle=x5DshAk8;Offset=2048;Count=1024

This EventID only fires if the NotifyOnFileOperations configuration property is set to true.

FileCloseNotifies your code about the closure of an opened file. The EventParam value passed with this EventID is a string of the following format:

ConnectionID=7;Handle=x5DshAk8;Modes=48

This EventID only fires if the NotifyOnFileOperations configuration property is set to true.

OpenShellNotifies your code about an opened shell tunnel. The EventParam has the following format: ConnectionID=9;LocalChannel=1;RemoteChannel=2
OpenCommandNotifies your code about an opened command tunnel. The EventParam value has the following format:

ConnectionID=8;LocalChannel=3;RemoteChannel=3;Command=ls -l

CloseShellIndicates the closure of a shell tunnel. The EventParam format is the same as with the OpenShell event ID.
CloseCommandIndicates the closure of a command tunnel. The EventParam format is the same as with the OpenCommand event ID.
BannerNotifies the application that the banner has been prepared and is about to be sent to the other side. The application can adjust the content of the banner by using Banner[ConnID] and Lang[ConnID] configuration settings.
ListeningStartedNotifies the application that the server has started listening for incoming connections.
ListeningStoppedNotifies the application that the server has stopped listening to incoming connections.

OpenClientForwarding Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireOpenClientForwarding(SFTPServerOpenClientForwardingEventParams *e);
typedef struct {
int64 ConnectionID;
const char *DestHost;
int DestPort;
const char *SrcHost;
int SrcPort; int reserved; } SFTPServerOpenClientForwardingEventParams;
Unicode (Windows) virtual INT FireOpenClientForwarding(SFTPServerOpenClientForwardingEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR DestHost;
INT DestPort;
LPCWSTR SrcHost;
INT SrcPort; INT reserved; } SFTPServerOpenClientForwardingEventParams;
#define EID_SFTPSERVER_OPENCLIENTFORWARDING 40

virtual INT SECUREBLACKBOX_CALL FireOpenClientForwarding(LONG64 &lConnectionID, LPSTR &lpszDestHost, INT &iDestPort, LPSTR &lpszSrcHost, INT &iSrcPort);
class SFTPServerOpenClientForwardingEventParams {
public:
  qint64 ConnectionID();

  const QString &DestHost();

  int DestPort();

  const QString &SrcHost();

  int SrcPort();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void OpenClientForwarding(SFTPServerOpenClientForwardingEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireOpenClientForwarding(SFTPServerOpenClientForwardingEventParams *e) {...}

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 (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireOpenCommand(SFTPServerOpenCommandEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Command; int reserved; } SFTPServerOpenCommandEventParams;
Unicode (Windows) virtual INT FireOpenCommand(SFTPServerOpenCommandEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Command; INT reserved; } SFTPServerOpenCommandEventParams;
#define EID_SFTPSERVER_OPENCOMMAND 41

virtual INT SECUREBLACKBOX_CALL FireOpenCommand(LONG64 &lConnectionID, LPSTR &lpszCommand);
class SFTPServerOpenCommandEventParams {
public:
  qint64 ConnectionID();

  const QString &Command();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void OpenCommand(SFTPServerOpenCommandEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireOpenCommand(SFTPServerOpenCommandEventParams *e) {...}

Remarks

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

The component fires CloseCommand when the command channel is closed.

OpenFile Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireOpenFile(SFTPServerOpenFileEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path;
int Modes;
int Access;
int OperationStatus;
char *Handle; int reserved; } SFTPServerOpenFileEventParams;
Unicode (Windows) virtual INT FireOpenFile(SFTPServerOpenFileEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path;
INT Modes;
INT Access;
INT OperationStatus;
LPWSTR Handle; INT reserved; } SFTPServerOpenFileEventParams;
#define EID_SFTPSERVER_OPENFILE 42

virtual INT SECUREBLACKBOX_CALL FireOpenFile(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iModes, INT &iAccess, INT &iOperationStatus, LPSTR &lpszHandle);
class SFTPServerOpenFileEventParams {
public:
  qint64 ConnectionID();

  const QString &Path();

  int Modes();

  int Access();

  int OperationStatus();
  void SetOperationStatus(int iOperationStatus);

  const QString &Handle();
  void SetHandle(const QString &qsHandle);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void OpenFile(SFTPServerOpenFileEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireOpenFile(SFTPServerOpenFileEventParams *e) {...}

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:

cfmRead1
cfmWrite2
cfmAppend4
cfmCreate8
cfmTruncate16
cfmExcl32
cfmText64
cfmOpenOrCreate128
cfmAppendAtomic256
cfmNoFollow512
cfmDeleteOnClose1024

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:

cfaReadLock1
cfaWriteLock2
cfaDeleteLock4
cfaBlockAdvisory8
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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

OpenServerForwarding Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireOpenServerForwarding(SFTPServerOpenServerForwardingEventParams *e);
typedef struct {
int64 ConnectionID;
const char *LocalHost;
int LocalPort;
const char *SrcHost;
int SrcPort; int reserved; } SFTPServerOpenServerForwardingEventParams;
Unicode (Windows) virtual INT FireOpenServerForwarding(SFTPServerOpenServerForwardingEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR LocalHost;
INT LocalPort;
LPCWSTR SrcHost;
INT SrcPort; INT reserved; } SFTPServerOpenServerForwardingEventParams;
#define EID_SFTPSERVER_OPENSERVERFORWARDING 43

virtual INT SECUREBLACKBOX_CALL FireOpenServerForwarding(LONG64 &lConnectionID, LPSTR &lpszLocalHost, INT &iLocalPort, LPSTR &lpszSrcHost, INT &iSrcPort);
class SFTPServerOpenServerForwardingEventParams {
public:
  qint64 ConnectionID();

  const QString &LocalHost();

  int LocalPort();

  const QString &SrcHost();

  int SrcPort();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void OpenServerForwarding(SFTPServerOpenServerForwardingEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireOpenServerForwarding(SFTPServerOpenServerForwardingEventParams *e) {...}

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 (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireOpenShell(SFTPServerOpenShellEventParams *e);
typedef struct {
int64 ConnectionID; int reserved; } SFTPServerOpenShellEventParams;
Unicode (Windows) virtual INT FireOpenShell(SFTPServerOpenShellEventParams *e);
typedef struct {
LONG64 ConnectionID; INT reserved; } SFTPServerOpenShellEventParams;
#define EID_SFTPSERVER_OPENSHELL 44

virtual INT SECUREBLACKBOX_CALL FireOpenShell(LONG64 &lConnectionID);
class SFTPServerOpenShellEventParams {
public:
  qint64 ConnectionID();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void OpenShell(SFTPServerOpenShellEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireOpenShell(SFTPServerOpenShellEventParams *e) {...}

Remarks

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

The component fires CloseShell when the shell channel is closed.

ReadFile Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireReadFile(SFTPServerReadFileEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Handle;
int64 Offset;
int Size;
int OperationStatus; int reserved; } SFTPServerReadFileEventParams;
Unicode (Windows) virtual INT FireReadFile(SFTPServerReadFileEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Handle;
LONG64 Offset;
INT Size;
INT OperationStatus; INT reserved; } SFTPServerReadFileEventParams;
#define EID_SFTPSERVER_READFILE 45

virtual INT SECUREBLACKBOX_CALL FireReadFile(LONG64 &lConnectionID, LPSTR &lpszHandle, LONG64 &lOffset, INT &iSize, INT &iOperationStatus);
class SFTPServerReadFileEventParams {
public:
  qint64 ConnectionID();

  const QString &Handle();

  qint64 Offset();

  int Size();

  int OperationStatus();
  void SetOperationStatus(int iOperationStatus);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ReadFile(SFTPServerReadFileEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireReadFile(SFTPServerReadFileEventParams *e) {...}

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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

Remove Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireRemove(SFTPServerRemoveEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path;
int OperationStatus; int reserved; } SFTPServerRemoveEventParams;
Unicode (Windows) virtual INT FireRemove(SFTPServerRemoveEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path;
INT OperationStatus; INT reserved; } SFTPServerRemoveEventParams;
#define EID_SFTPSERVER_REMOVE 46

virtual INT SECUREBLACKBOX_CALL FireRemove(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iOperationStatus);
class SFTPServerRemoveEventParams {
public:
  qint64 ConnectionID();

  const QString &Path();

  int OperationStatus();
  void SetOperationStatus(int iOperationStatus);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Remove(SFTPServerRemoveEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireRemove(SFTPServerRemoveEventParams *e) {...}

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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

RenameFile Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireRenameFile(SFTPServerRenameFileEventParams *e);
typedef struct {
int64 ConnectionID;
const char *OldPath;
const char *NewPath;
int OperationStatus; int reserved; } SFTPServerRenameFileEventParams;
Unicode (Windows) virtual INT FireRenameFile(SFTPServerRenameFileEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR OldPath;
LPCWSTR NewPath;
INT OperationStatus; INT reserved; } SFTPServerRenameFileEventParams;
#define EID_SFTPSERVER_RENAMEFILE 47

virtual INT SECUREBLACKBOX_CALL FireRenameFile(LONG64 &lConnectionID, LPSTR &lpszOldPath, LPSTR &lpszNewPath, INT &iOperationStatus);
class SFTPServerRenameFileEventParams {
public:
  qint64 ConnectionID();

  const QString &OldPath();

  const QString &NewPath();

  int OperationStatus();
  void SetOperationStatus(int iOperationStatus);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void RenameFile(SFTPServerRenameFileEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireRenameFile(SFTPServerRenameFileEventParams *e) {...}

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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

RequestAttributes Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireRequestAttributes(SFTPServerRequestAttributesEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path;
const char *Handle;
int OperationStatus; int reserved; } SFTPServerRequestAttributesEventParams;
Unicode (Windows) virtual INT FireRequestAttributes(SFTPServerRequestAttributesEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path;
LPCWSTR Handle;
INT OperationStatus; INT reserved; } SFTPServerRequestAttributesEventParams;
#define EID_SFTPSERVER_REQUESTATTRIBUTES 48

virtual INT SECUREBLACKBOX_CALL FireRequestAttributes(LONG64 &lConnectionID, LPSTR &lpszPath, LPSTR &lpszHandle, INT &iOperationStatus);
class SFTPServerRequestAttributesEventParams {
public:
  qint64 ConnectionID();

  const QString &Path();

  const QString &Handle();

  int OperationStatus();
  void SetOperationStatus(int iOperationStatus);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void RequestAttributes(SFTPServerRequestAttributesEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireRequestAttributes(SFTPServerRequestAttributesEventParams *e) {...}

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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

ServerForwardingCancel Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireServerForwardingCancel(SFTPServerServerForwardingCancelEventParams *e);
typedef struct {
int64 ConnectionID;
const char *LocalHost;
int LocalPort; int reserved; } SFTPServerServerForwardingCancelEventParams;
Unicode (Windows) virtual INT FireServerForwardingCancel(SFTPServerServerForwardingCancelEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR LocalHost;
INT LocalPort; INT reserved; } SFTPServerServerForwardingCancelEventParams;
#define EID_SFTPSERVER_SERVERFORWARDINGCANCEL 49

virtual INT SECUREBLACKBOX_CALL FireServerForwardingCancel(LONG64 &lConnectionID, LPSTR &lpszLocalHost, INT &iLocalPort);
class SFTPServerServerForwardingCancelEventParams {
public:
  qint64 ConnectionID();

  const QString &LocalHost();

  int LocalPort();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ServerForwardingCancel(SFTPServerServerForwardingCancelEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireServerForwardingCancel(SFTPServerServerForwardingCancelEventParams *e) {...}

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:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

ServerForwardingOpenFailed Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireServerForwardingOpenFailed(SFTPServerServerForwardingOpenFailedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *LocalHost;
int LocalPort;
const char *SrcHost;
int SrcPort; int reserved; } SFTPServerServerForwardingOpenFailedEventParams;
Unicode (Windows) virtual INT FireServerForwardingOpenFailed(SFTPServerServerForwardingOpenFailedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR LocalHost;
INT LocalPort;
LPCWSTR SrcHost;
INT SrcPort; INT reserved; } SFTPServerServerForwardingOpenFailedEventParams;
#define EID_SFTPSERVER_SERVERFORWARDINGOPENFAILED 50

virtual INT SECUREBLACKBOX_CALL FireServerForwardingOpenFailed(LONG64 &lConnectionID, LPSTR &lpszLocalHost, INT &iLocalPort, LPSTR &lpszSrcHost, INT &iSrcPort);
class SFTPServerServerForwardingOpenFailedEventParams {
public:
  qint64 ConnectionID();

  const QString &LocalHost();

  int LocalPort();

  const QString &SrcHost();

  int SrcPort();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ServerForwardingOpenFailed(SFTPServerServerForwardingOpenFailedEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireServerForwardingOpenFailed(SFTPServerServerForwardingOpenFailedEventParams *e) {...}

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 (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireServerForwardingRequest(SFTPServerServerForwardingRequestEventParams *e);
typedef struct {
int64 ConnectionID;
const char *LocalHost;
int LocalPort;
int Action; int reserved; } SFTPServerServerForwardingRequestEventParams;
Unicode (Windows) virtual INT FireServerForwardingRequest(SFTPServerServerForwardingRequestEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR LocalHost;
INT LocalPort;
INT Action; INT reserved; } SFTPServerServerForwardingRequestEventParams;
#define EID_SFTPSERVER_SERVERFORWARDINGREQUEST 51

virtual INT SECUREBLACKBOX_CALL FireServerForwardingRequest(LONG64 &lConnectionID, LPSTR &lpszLocalHost, INT &iLocalPort, INT &iAction);
class SFTPServerServerForwardingRequestEventParams {
public:
  qint64 ConnectionID();

  const QString &LocalHost();

  int LocalPort();
  void SetLocalPort(int iLocalPort);

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ServerForwardingRequest(SFTPServerServerForwardingRequestEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireServerForwardingRequest(SFTPServerServerForwardingRequestEventParams *e) {...}

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:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

SessionClosed Event (SFTPServer Class)

Reports session closure.

Syntax

ANSI (Cross Platform)
virtual int FireSessionClosed(SFTPServerSessionClosedEventParams *e);
typedef struct {
int64 ConnectionID; int reserved; } SFTPServerSessionClosedEventParams;
Unicode (Windows) virtual INT FireSessionClosed(SFTPServerSessionClosedEventParams *e);
typedef struct {
LONG64 ConnectionID; INT reserved; } SFTPServerSessionClosedEventParams;
#define EID_SFTPSERVER_SESSIONCLOSED 52

virtual INT SECUREBLACKBOX_CALL FireSessionClosed(LONG64 &lConnectionID);
class SFTPServerSessionClosedEventParams {
public:
  qint64 ConnectionID();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SessionClosed(SFTPServerSessionClosedEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireSessionClosed(SFTPServerSessionClosedEventParams *e) {...}

Remarks

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

SessionEstablished Event (SFTPServer Class)

This event is fired when a new session is established.

Syntax

ANSI (Cross Platform)
virtual int FireSessionEstablished(SFTPServerSessionEstablishedEventParams *e);
typedef struct {
int64 ConnectionID; int reserved; } SFTPServerSessionEstablishedEventParams;
Unicode (Windows) virtual INT FireSessionEstablished(SFTPServerSessionEstablishedEventParams *e);
typedef struct {
LONG64 ConnectionID; INT reserved; } SFTPServerSessionEstablishedEventParams;
#define EID_SFTPSERVER_SESSIONESTABLISHED 53

virtual INT SECUREBLACKBOX_CALL FireSessionEstablished(LONG64 &lConnectionID);
class SFTPServerSessionEstablishedEventParams {
public:
  qint64 ConnectionID();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SessionEstablished(SFTPServerSessionEstablishedEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireSessionEstablished(SFTPServerSessionEstablishedEventParams *e) {...}

Remarks

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

SetAttributes Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireSetAttributes(SFTPServerSetAttributesEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path;
const char *Handle;
int OperationStatus; int reserved; } SFTPServerSetAttributesEventParams;
Unicode (Windows) virtual INT FireSetAttributes(SFTPServerSetAttributesEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path;
LPCWSTR Handle;
INT OperationStatus; INT reserved; } SFTPServerSetAttributesEventParams;
#define EID_SFTPSERVER_SETATTRIBUTES 54

virtual INT SECUREBLACKBOX_CALL FireSetAttributes(LONG64 &lConnectionID, LPSTR &lpszPath, LPSTR &lpszHandle, INT &iOperationStatus);
class SFTPServerSetAttributesEventParams {
public:
  qint64 ConnectionID();

  const QString &Path();

  const QString &Handle();

  int OperationStatus();
  void SetOperationStatus(int iOperationStatus);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SetAttributes(SFTPServerSetAttributesEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireSetAttributes(SFTPServerSetAttributesEventParams *e) {...}

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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

TranslatePath Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireTranslatePath(SFTPServerTranslatePathEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path;
char *AbsolutePath;
int Action; int reserved; } SFTPServerTranslatePathEventParams;
Unicode (Windows) virtual INT FireTranslatePath(SFTPServerTranslatePathEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path;
LPWSTR AbsolutePath;
INT Action; INT reserved; } SFTPServerTranslatePathEventParams;
#define EID_SFTPSERVER_TRANSLATEPATH 55

virtual INT SECUREBLACKBOX_CALL FireTranslatePath(LONG64 &lConnectionID, LPSTR &lpszPath, LPSTR &lpszAbsolutePath, INT &iAction);
class SFTPServerTranslatePathEventParams {
public:
  qint64 ConnectionID();

  const QString &Path();

  const QString &AbsolutePath();
  void SetAbsolutePath(const QString &qsAbsolutePath);

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TranslatePath(SFTPServerTranslatePathEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireTranslatePath(SFTPServerTranslatePathEventParams *e) {...}

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:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

WriteFile Event (SFTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireWriteFile(SFTPServerWriteFileEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Handle;
int64 Offset;
int OperationStatus; int reserved; } SFTPServerWriteFileEventParams;
Unicode (Windows) virtual INT FireWriteFile(SFTPServerWriteFileEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Handle;
LONG64 Offset;
INT OperationStatus; INT reserved; } SFTPServerWriteFileEventParams;
#define EID_SFTPSERVER_WRITEFILE 56

virtual INT SECUREBLACKBOX_CALL FireWriteFile(LONG64 &lConnectionID, LPSTR &lpszHandle, LONG64 &lOffset, INT &iOperationStatus);
class SFTPServerWriteFileEventParams {
public:
  qint64 ConnectionID();

  const QString &Handle();

  qint64 Offset();

  int OperationStatus();
  void SetOperationStatus(int iOperationStatus);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void WriteFile(SFTPServerWriteFileEventParams *e);
// Or, subclass SFTPServer and override this emitter function. virtual int FireWriteFile(SFTPServerWriteFileEventParams *e) {...}

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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Syntax

SecureBlackboxExternalCrypto (declared in secureblackbox.h)

Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

The following fields are available:

Fields

AsyncDocumentID
char*

Default Value: ""

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.

CustomParams
char*

Default Value: ""

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

Data
char*

Default Value: ""

Additional data to be included in the async state and mirrored back by the requestor.

ExternalHashCalculation
int

Default Value: FALSE

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.

HashAlgorithm
char*

Default Value: "SHA256"

Specifies the request's signature hash algorithm.

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

KeyID
char*

Default Value: ""

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 KeySecret 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";

KeySecret
char*

Default Value: ""

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 KeyID topic.

Method
int

Default Value: 0

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

asmdPKCS10
asmdPKCS71

Mode
int

Default Value: 0

Specifies the external cryptography mode.

Available options:

ecmDefaultThe default value (0)
ecmDisabledDo not use DC or external signing (1)
ecmGenericGeneric external signing with the OnExternalSign event (2)
ecmDCAuthDCAuth signing (3)
ecmDCAuthJSONDCAuth signing in JSON format (4)

PublicKeyAlgorithm
char*

Default Value: ""

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

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

Constructors

ExternalCrypto()

Creates a new ExternalCrypto object with default field values.

FTPListEntry Type

Represents a basic container for the remote file details.

Syntax

SecureBlackboxFTPListEntry (declared in secureblackbox.h)

Remarks

The class represents the details of a file entry returned by the FTP server.

The following fields are available:

Fields

AccessTime
char*

Default Value: ""

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

CreationTime
char*

Default Value: ""

Contains this file's creation time, in UTC.

EntryFormat
int

Default Value: 0

The file listing format:

cfefUnknown0
cfefUnix1
cfefWindows2
cfefMLSD3

FileType
int

Default Value: 0

The type of the entry:

fetUnknown0
fetDirectory1
fetFile2
fetSymlink3
fetSpecial4
fetCurrentDirectory5
fetParentDirectory6
fetSocket7
fetCharDevice8
fetBlockDevice9
fetFIFO10

Handle
int64

Default Value: 0

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());

ModificationTime
char*

Default Value: ""

File last modification date/time.

Name
char*

Default Value: ""

The file or directory name.

Path
char*

Default Value: ""

The full path to the file or directory.

Principal
char*

Default Value: ""

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.

Size
int64

Default Value: 0

File size in bytes.

UnixPerms
int

Default Value: 511

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

UnparsedName
char*

Default Value: ""

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

Constructors

FTPListEntry()

Creates a new FTPListEntry object.

SocketSettings Type

A container for the socket settings.

Syntax

SecureBlackboxSocketSettings (declared in secureblackbox.h)

Remarks

This type is a container for socket-layer parameters.

The following fields are available:

Fields

DNSMode
int

Default Value: 0

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

dmAuto0
dmPlatform1
dmOwn2
dmOwnSecure3

DNSPort
int

Default Value: 0

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

DNSQueryTimeout
int

Default Value: 0

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

DNSServers
char*

Default Value: ""

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

DNSTotalTimeout
int

Default Value: 0

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

IncomingSpeedLimit
int

Default Value: 0

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

LocalAddress
char*

Default Value: ""

The local network interface to bind the socket to.

LocalPort
int

Default Value: 0

The local port number to bind the socket to.

OutgoingSpeedLimit
int

Default Value: 0

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

Timeout
int

Default Value: 60000

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

UseIPv6
int

Default Value: FALSE

Enables or disables IP protocol version 6.

Constructors

SocketSettings()

Creates a new SocketSettings object.

SSHConnectionInfo Type

Contains information about SSH connection.

Syntax

SecureBlackboxSSHConnectionInfo (declared in secureblackbox.h)

Remarks

SSHConnectionInfo object contains information about one SSH connection.

The following fields are available:

Fields

ClientKeyAlgorithm
char* (read-only)

Default Value: ""

Specifies the client's key algorithm.

ClientKeyBits
int (read-only)

Default Value: 0

Specifies the length of the client's key.

ClientKeyFingerprint
char* (read-only)

Default Value: ""

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

CloseReason
char* (read-only)

Default Value: ""

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.

CompressionAlgorithmInbound
char* (read-only)

Default Value: ""

Compression algorithm for the incoming traffic.

CompressionAlgorithmOutbound
char* (read-only)

Default Value: ""

Compression algorithm for the outgoing traffic.

EncryptionAlgorithmInbound
char* (read-only)

Default Value: ""

Encryption algorithm for the incoming traffic.

EncryptionAlgorithmOutbound
char* (read-only)

Default Value: ""

Encryption algorithm for the outgoing traffic.

InboundEncryptionKeyBits
int (read-only)

Default Value: 0

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

KexAlgorithm
char* (read-only)

Default Value: ""

The key exchange algorithm used during the SSH handshake.

KexBits
int (read-only)

Default Value: 0

The number of bits used by the key exchange algorithm.

KexLines
char* (read-only)

Default Value: ""

The contents of the received KexInit packet.

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

MacAlgorithmInbound
char* (read-only)

Default Value: ""

MAC algorithm used for the incoming connection.

MacAlgorithmOutbound
char* (read-only)

Default Value: ""

MAC algorithm used for outbound connection.

OutboundEncryptionKeyBits
int (read-only)

Default Value: 0

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

PublicKeyAlgorithm
char* (read-only)

Default Value: ""

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

RemoteAddress
char* (read-only)

Default Value: ""

The client's IP address.

RemotePort
int (read-only)

Default Value: 0

The remote port of the client connection.

ServerKeyAlgorithm
char* (read-only)

Default Value: ""

Specifies the server's key algorithm.

ServerKeyBits
int (read-only)

Default Value: 0

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

ServerKeyFingerprint
char* (read-only)

Default Value: ""

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

ServerSoftwareName
char* (read-only)

Default Value: ""

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

TotalBytesReceived
int64 (read-only)

Default Value: 0

Returns the total number of bytes received over this connection.

TotalBytesSent
int64 (read-only)

Default Value: 0

Returns the total number of bytes sent over this connection.

Version
int (read-only)

Default Value: 2

Specifies SSH protocol version.

Constructors

SSHConnectionInfo()

Creates an empty object representing a SSH connection info.

SSHKey Type

SSHKey is used to store information about single compound public-key algorithm (such as RSA or DSA) key.

Syntax

SecureBlackboxSSHKey (declared in secureblackbox.h)

Remarks

SSH keys are used to secure the SSH protocol flow. They support different algorithms and key lengths, a very typical example being RSA-2048 bits.

The following fields are available:

Fields

Algorithm
char* (read-only)

Default Value: ""

Specifies the key algorithm.

Bits
int (read-only)

Default Value: 0

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

Comment
char*

Default Value: ""

The comment for the public key.

Curve
char* (read-only)

Default Value: ""

Specifies the elliptical curve when EC cryptography is used.

DSSG
char* (read-only)

Default Value:

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

DSSP
char* (read-only)

Default Value:

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

DSSQ
char* (read-only)

Default Value:

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

DSSX
char* (read-only)

Default Value:

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

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

DSSY
char* (read-only)

Default Value:

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

ECCD
char* (read-only)

Default Value:

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

ECCQX
char* (read-only)

Default Value:

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

ECCQY
char* (read-only)

Default Value:

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

EdPrivate
char* (read-only)

Default Value:

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

EdPublic
char* (read-only)

Default Value:

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

FingerprintMD5
char* (read-only)

Default Value: ""

Contains the MD5 fingerprint (hash) of the key.

FingerprintSHA1
char* (read-only)

Default Value: ""

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

FingerprintSHA256
char* (read-only)

Default Value: ""

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

Handle
int64

Default Value: 0

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());

IsExtractable
int (read-only)

Default Value: FALSE

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

IsPrivate
int (read-only)

Default Value: FALSE

Whether this key is a private key or not.

IsPublic
int (read-only)

Default Value: FALSE

Whether this key is a public key or not.

KDFRounds
int (read-only)

Default Value: 0

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

KDFSalt
char* (read-only)

Default Value:

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

KeyFormat
int (read-only)

Default Value: 0

Specifies the format in which the key is stored.

ckfOpenSSH0
ckfOpenSSH21
ckfIETF2
ckfPuTTY3
ckfX5094
ckfBinary5
ckfSSH16
ckfPGP7
ckfPKCS88
ckfPuTTY39

KeyProtectionAlgorithm
char* (read-only)

Default Value: ""

Specifies the key protection algorithm.

RSAExponent
char* (read-only)

Default Value:

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

RSAIQMP
char* (read-only)

Default Value:

Returns the iqmp parameter of the RSA key.

RSAModulus
char* (read-only)

Default Value:

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

RSAP
char* (read-only)

Default Value:

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

RSAPrivateExponent
char* (read-only)

Default Value:

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

RSAQ
char* (read-only)

Default Value:

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

Subject
char*

Default Value: ""

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

Constructors

SSHKey()

Creates a new key.

SSHSettings Type

A container for various SSH protocol settings.

Syntax

SecureBlackboxSSHSettings (declared in secureblackbox.h)

Remarks

SSHSettings stores various settings of SSH client or server.

The following fields are available:

Fields

AutoAdjustCiphers
int

Default Value: TRUE

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

BaseConfiguration
int

Default Value: 0

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

CompressionAlgorithms
char*

Default Value: ""

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

CompressionLevel
int

Default Value: 6

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

DefaultWindowSize
int

Default Value: 2048000

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.

EncryptionAlgorithms
char*

Default Value: ""

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

ForceCompression
int

Default Value: FALSE

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.

ForwardAuthAgent
int

Default Value: FALSE

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.

GSSAuthTypes
char*

Default Value: ""

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

GSSDelegateCreds
int

Default Value: FALSE

Switches credential delegation on or off.

GSSHostname
char*

Default Value: ""

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

GSSLib
char*

Default Value: ""

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

GSSMechanisms
char*

Default Value: ""

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

GSSProtocols
char*

Default Value: ""

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

HandshakeTimeout
int

Default Value: 45

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.

KexAlgorithms
char*

Default Value: ""

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

MacAlgorithms
char*

Default Value: ""

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

MaxSSHPacketSize
int

Default Value: 262144

Specifies the maximum length of one SSH packet in bytes.

MinWindowSize
int

Default Value: 2048

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.

ObfuscateHandshake
int

Default Value: FALSE

Enables or disables handshake obfuscation.

ObfuscationPassword
char*

Default Value: ""

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

PublicKeyAlgorithms
char*

Default Value: ""

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

RequestPasswordChange
int

Default Value: FALSE

Whether to request a password change when connecting.

SoftwareName
char*

Default Value: "SecureBlackbox"

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

TrustAllKeys
int

Default Value: FALSE

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

UseAuthAgent
int

Default Value: FALSE

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

Versions
int

Default Value: 1

Specifies enabled SSH protocol versions (1 or 2).

Constructors

SSHSettings()

Creates a new object with default settings.

UserAccount Type

A container for user account information.

Syntax

SecureBlackboxUserAccount (declared in secureblackbox.h)

Remarks

UserAccount objects are used to store user account information, such as logins and passwords.

The following fields are available:

Fields

AssociatedData
char*

Default Value:

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

BasePath
char*

Default Value: ""

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

Certificate
char*

Default Value:

Contains the user's certificate.

Data
char*

Default Value: ""

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

Email
char*

Default Value: ""

The user's email address.

Handle
int64

Default Value: 0

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());

HashAlgorithm
char*

Default Value: ""

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:

SB_MAC_ALGORITHM_HMAC_SHA1SHA1
SB_MAC_ALGORITHM_HMAC_SHA256SHA256
SB_MAC_ALGORITHM_HMAC_SHA512SHA512

IncomingSpeedLimit
int

Default Value: 0

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

OtpAlgorithm
int

Default Value: 0

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.

oaHmac0
oaTime1

OTPLen
int

Default Value: 0

Specifies the length of the user's OTP password.

OtpValue
int

Default Value: 0

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

OutgoingSpeedLimit
int

Default Value: 0

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

Password
char*

Default Value: ""

The user's authentication password.

SharedSecret
char*

Default Value:

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.

SSHKey
char*

Default Value:

Contains the user's SSH key.

Username
char*

Default Value: ""

The registered name (login) of the user.

Constructors

UserAccount()

Creates a new UserAccount object

SecureBlackboxList Type

Syntax

SecureBlackboxList<T> (declared in secureblackbox.h)

Remarks

SecureBlackboxList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the SFTPServer class.

Methods

GetCount This method returns the current size of the collection.

int GetCount() {}

SetCount This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection.

int SetCount(int count) {}

Get This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified.

T* Get(int index) {}

Set This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class.

T* Set(int index, T* value) {}

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

AllAlgorithms:   Returns the list of algorithms enabled in the component.

Use this configuration setting to obtain the list of algorithms currently enabled in the component in the kexinit format.

AuthMode:   Controls dual/multi-type authentication mode.

Use this setting to adjust dual/multi-step authentication mode. The value of 0 indicates that either of supported authentication methods is sufficient to authenticate the user ("any of"). The value of 1 specifies that the user should pass all the enabled methods to authenticate themselves (MFA, or "all of").

AutoGenerateLongNames:   TBD.

TBD

Banner[i]:   TBD.

TBD

BannerSendStage:   TBD.

TBD

CommandModeEnabled:   TBD.

TBD

CompressionAlgorithms:   Returns the list of compression algorithms enabled in the component.

Use this configuration setting to get the list of compression algorithms currently enabled in the component, as a respective kexinit block line.

CustomDHGroupIndex:   Sets a specific Diffie-Hellman group index to enforce.

Use this property to specify a specific DH group index to enforce for key exchange. The value of -1 enables automatic group selection, and any value between 0 and 227 specifies a particular DH group supported by SecureBlackbox. This is largely a debug setting, use it with extreme care.

DefBanner:   TBD.

TBD

DefLanguageTag:   TBD.

TBD

DualStack:   Allows the use of ip4 and ip6 simultaneously.

This setting specifies a socket can use ip4 and ip6 simultaneously.

EncryptionAlgorithms:   Returns the list of encryption algorithms enabled in the component.

Use this configuration setting to get the list of symmetric encryption algorithms currently enabled in the component, as a respective kexinit block line.

KexAlgorithms:   Returns the list of key exchange algorithms enabled in the component.

Use this configuration setting to get the list of key exchange algorithms currently enabled in the component, as a respective kexinit block line.

LanguageTag[i]:   TBD.

TBD

MacAlgorithms:   Returns the list of MAC algorithms enabled in the component.

Use this configuration setting to get the list of MAC algorithms currently enabled in the component, as a respective kexinit block line.

MaxDHGroupSize:   Sets the maximal Diffie-Hellman group size.

This property specifies the maximal DH group size, in bits. The larger the group size, the strong the key, however, longer groups put extra burden on the computational resources. SecureBlackbox supports groups between 1024 and 8192 bits. The default value is 8192.

MinDHGroupSize:   Sets the minimal Diffie-Hellman group size.

This property specifies the minimal DH group size, in bits. The larger the group size, the strong the key, however, longer groups put extra burden on the computational resources. SecureBlackbox supports groups between 1024 and 8192 bits. The default value is 2048.

NotifyOnFileOperations:   Enables low-level file operation notifications.

If set, the component will report low-level file operations, such as Open, Read, Write, and Close, via its Notification event.

PublicKeyAlgorithms:   Returns the list of public key algorithms enabled in the component.

Use this configuration setting to get the list of public key algorithms currently enabled in the component, as a respective kexinit block line.

RefreshUsers:   Enables or disables real-time propagation of user information.

Set this property to true to make the content of the Users property propagate to the server immediately. The default setting is false, which delays the effect of any changes in the Users setting until the server is restarted.

SFTPModeEnabled:   TBD.

TBD

ShellModeEnabled:   TBD.

TBD

UseStrictKeyExchange:   Specifies how strict key exchange is supported.

This setting controls whether strict key exchange (strict kex) is enabled to mitigate the Terrapin attack. When enabled, the class will indicate support for strict key exchange by automatically including the pseudo-algorithm kex-strict-c-v00@openssh.com for client classes and kex-strict-s-v00@openssh.com for server classes in the list of supported key exchange algorithms.

Since both client and server must implement strict key exchange to effectively mitigate the Terrapin attack, the class provides options to further control the behavior in different scenarios. Possible values for this setting are:

0Disabled. Strict key exchange is not supported in the class.
1 (default)Enabled, but not enforced. This setting enables strict key exchange, but if the remote host does not support strict key exchange the connection is still allowed to continue.
2Enabled, but reject affected algorithms if the remote host does not support strict key exchange. If the remote host supports strict key exchange all algorithms may be used. If the remote host does not support strict key exchange the connection will only continue if the selected encryption and MAC algorithms are not affected by the Terrapin attack.
3Required. If the remote host does not support strict key exchange the connection will fail.

Base Config Settings

ASN1UseGlobalTagCache:   Controls whether ASN.1 module should use a global object cache.

This is a performance setting. It is unlikely that you will ever need to adjust it.

AssignSystemSmartCardPins:   Specifies whether CSP-level PINs should be assigned to CNG keys.

This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

CheckKeyIntegrityBeforeUse:   Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching:   Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the class.

Supported values are:

offNo caching (default)
localLocal caching
globalGlobal caching

Cookies:   Gets or sets local cookies for the class.

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations:   Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

DNSLocalSuffix:   The suffix to assign for TLD names.

Use this global setting to adjust the default suffix to assign to top-level domain names. The default is .local.

EnableClientSideSSLFFDHE:   Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies:   Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global".

HardwareCryptoUsePolicy:   The hardware crypto usage policy.

This global setting controls the hardware cryptography usage policy: auto, enable, or disable.

HttpUserAgent:   Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.

HttpVersion:   The HTTP version to use in any inner HTTP client components created.

Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

IgnoreExpiredMSCTLSigningCert:   Whether to tolerate the expired Windows Update signing certificate.

It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

ListDelimiter:   The delimiter character for multi-element lists.

Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

LogDestination:   Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (supported for VCL for Windows and .Net)

LogDetails:   Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll details

LogFile:   Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters:   Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

exclude-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude a method specified in the value

LogFlushMode:   Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel:   Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore detailed information.

LogMaxEventCount:   Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode:   Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength:   Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth:   Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm:   Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

OldClientSideRSAFallback:   Specifies whether the SSH client should use a SHA1 fallback.

Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

ProductVersion:   Returns the version of the SecureBlackbox library.

This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

ServerSSLDHKeyLength:   Sets the size of the TLS DHE key exchange group.

Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

StaticDNS:   Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.

Supported values are:

noneNo static DNS rules (default)
localLocal static DNS rules
globalGlobal static DNS rules

StaticIPAddress[domain]:   Gets or sets an IP address for the specified domain name.

Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character.

StaticIPAddresses:   Gets or sets all the static DNS rules.

Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

Tag:   Allows to store any custom data.

Use this config property to store any custom data.

TLSSessionGroup:   Specifies the group name of TLS sessions to be used for session resumption.

Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

TLSSessionLifetime:   Specifies lifetime in seconds of the cached TLS session.

Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

TLSSessionPurgeInterval:   Specifies how often the session cache should remove the expired TLS sessions.

Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

UseInternalRandom:   Switches between SecureBlackbox-own and platform PRNGs.

Allows to switch between internal/native PRNG implementation and the one provided by the platform.

UseLegacyAdESValidation:   Enables legacy AdES validation mode.

Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

UseOwnDNSResolver:   Specifies whether the client components should use own DNS resolver.

Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

UseSharedSystemStorages:   Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemNativeSizeCalculation:   An internal CryptoAPI access tweak.

This is an internal setting. Please do not use it unless instructed by the support team.

UseSystemOAEPAndPSS:   Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom:   Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

Trappable Errors (SFTPServer Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

SFTPServer Errors

1048577   Invalid parameter (SB_ERROR_INVALID_PARAMETER)
1048578   Invalid configuration (SB_ERROR_INVALID_SETUP)
1048579   Invalid state (SB_ERROR_INVALID_STATE)
1048580   Invalid value (SB_ERROR_INVALID_VALUE)
1048581   Private key not found (SB_ERROR_NO_PRIVATE_KEY)
1048582   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)
1048583   The file was not found (SB_ERROR_NO_SUCH_FILE)
1048584   Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE)
1048585   General error (SB_ERROR_GENERAL_ERROR)
31457281   Unsupported file operation (SB_ERROR_SFTP_UNSUPPORTED_FILE_OPERATION)
31457282   Invalid authentication type (SB_ERROR_SFTP_INVALID_AUTH_TYPE)