SFTPServer Class
Properties Methods Events Configuration Settings Errors
The SFTPServer class provides server-side functionality for SFTP connections.
Syntax
SFTPServer
Remarks
TElSFTPServer 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.
Active | Specifies whether the SFTP server has started and ready to accept connections. |
AuthTypes | Defines allowed authentication types. |
BaseDir | Specifies the server's base (root) directory. |
ClientFileEntryATime | Contains the last access time for this file, in UTC. |
ClientFileEntryCTime | Contains this file's creation time, in UTC. |
ClientFileEntryDirectory | Specifies whether this entry is a directory. |
ClientFileEntryFileType | Specifies the type of this entry, one of the following: cftFile 0 cftDirectory 1 cftSymblink 2 cftSpecial 3 cftUnknown 4 cftSocket 5 cftCharDevice 6 cftBlockDevice 7 cftFIFO 8 . |
ClientFileEntryGroupExecute | Controls file execution permission for the group users. |
ClientFileEntryGroupRead | Controls file read permission for the group users. |
ClientFileEntryGroupWrite | Controls file write permission for the group users. |
ClientFileEntryHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
ClientFileEntryLongName | Contains the long name of the file (human-readable, ftp-like). |
ClientFileEntryMTime | Specifies the last modification time, in UTC. |
ClientFileEntryName | Specifies the file name. |
ClientFileEntryOtherExecute | Controls file execution permission for other users (users that are neither owners, nor belong to the same group). |
ClientFileEntryOtherRead | Controls file read permission for other users (users that are neither owners, nor belong to the same group). |
ClientFileEntryOtherWrite | Controls file write permission for other users (users that are neither owners, nor belong to the same group). |
ClientFileEntryOwner | Specifies the owner of the file/directory. |
ClientFileEntryPath | Contains the full path to the file. |
ClientFileEntrySize | The size of the file in bytes. |
ClientFileEntryUserExecute | Controls file execution permission for the file owner. |
ClientFileEntryUserRead | Controls file read permission for the file owner. |
ClientFileEntryUserWrite | Controls file write permission for the file owner. |
CompressionLevel | Specifies the preferable compression level. |
ExternalCryptoAsyncDocumentID | Specifies the document ID for SignAsyncEnd() call Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. |
ExternalCryptoCustomParams | Custom parameters to be passed to the signing service (uninterpreted). |
ExternalCryptoData | Additional data to be included in the async state and mirrored back by the requestor. |
ExternalCryptoExternalHashCalculation | Specifies whether the message hash is to be calculated at the external endpoint. |
ExternalCryptoHashAlgorithm | Specifies the request's signature hash algorithm. |
ExternalCryptoKeyID | The ID of the pre-shared key used for DC request authentication. |
ExternalCryptoKeySecret | The pre-shared key used for DC request authentication. |
ExternalCryptoMethod | Specifies the asynchronous signing method. |
ExternalCryptoMode | Specifies the external cryptography mode. |
ExternalCryptoPublicKeyAlgorithm | Provide public key algorithm here if the certificate is not available on the pre-signing stage. |
FIPSMode | Reserved. |
ForceCompression | This property specifies whether server explicitly requires data compression. |
Host | Specifies server's host name. |
KeyFingerprintSHA1 | Contains the SHA-1 fingerprint (hash) of the key. |
KeyFingerprintSHA256 | Contains the SHA-256 fingerprint (hash) of the key. |
KeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
MaxSFTPVersion | Maximum SFTP version supported. |
MinSFTPVersion | Minimum SFTP version supported. |
PinnedClientAddress | The client's IP address. |
PinnedClientClientKeyAlgorithm | Specifies the client's key algorithm. |
PinnedClientClientKeyBits | Specifies the length of the client's key. |
PinnedClientClientKeyFingerprint | The fingerprint (hash value) of the client's public key. |
PinnedClientClientSoftwareName | Returns the name of the SSH software running on the client side. |
PinnedClientCloseReason | Contains the line sent by the client just before closing the connection. |
PinnedClientCompressionAlgorithmInbound | Compression algorithm for the incoming traffic. |
PinnedClientCompressionAlgorithmOutbound | Compression algorithm for the outgoing traffic. |
PinnedClientEncryptionAlgorithmInbound | Encryption algorithm for the incoming traffic. |
PinnedClientEncryptionAlgorithmOutbound | Encryption algorithm for the outgoing traffic. |
PinnedClientID | The client connection's unique identifier. |
PinnedClientInboundEncryptionKeyBits | Specifies the length of the key used to encrypt the incoming traffic. |
PinnedClientKexAlgorithm | The key exchange algorithm used during the SSH handshake. |
PinnedClientKexBits | The number of bits used by the key exchange algorithm. |
PinnedClientKexLines | The contents of the received KexInit packet. |
PinnedClientMacAlgorithmInbound | MAC algorithm used for the incoming connection. |
PinnedClientMacAlgorithmOutbound | MAC algorithm used for outbound connection. |
PinnedClientOutboundEncryptionKeyBits | Specifies the length of the key used to encrypt the outgoing traffic. |
PinnedClientPort | The remote port of the client connection. |
PinnedClientPublicKeyAlgorithm | Specifies the public key algorithm which was used during the SSH handshake. |
PinnedClientServerKeyBits | Specifies the number of bits in the server's key. |
PinnedClientServerKeyFingerprint | The fingerprint (hash value) of the server's public key. |
PinnedClientTotalBytesReceived | Returns the total number of bytes received over this connection. |
PinnedClientTotalBytesSent | Returns the total number of bytes sent over this connection. |
PinnedClientVersion | Specifies SSH protocol version. |
Port | Specifies the listening port number. |
ReadOnly | Specifies whether files on the server are read-only. |
ServerKeyCount | The number of records in the ServerKey arrays. |
ServerKeyAlgorithm | Specifies the key algorithm. |
ServerKeyBits | The number of bits in the key: the more the better, 2048 or 4096 are typical values. |
ServerKeyFingerprintMD5 | Contains the MD5 fingerprint (hash) of the key. |
ServerKeyFingerprintSHA1 | Contains the SHA-1 fingerprint (hash) of the key. |
ServerKeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
SocketIncomingSpeedLimit | The maximum number of bytes to read from the socket, per second. |
SocketLocalAddress | The local network interface to bind the socket to. |
SocketLocalPort | The local port number to bind the socket to. |
SocketOutgoingSpeedLimit | The maximum number of bytes to write to the socket, per second. |
SocketTimeout | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
SocketUseIPv6 | Enables or disables IP protocol version 6. |
SSHSettingsAutoAdjustCiphers | Whether the SSH client should adjust its list of supported ciphers 'on-the-fly' for greater compatibility with the server it is connecting to. |
SSHSettingsBaseConfiguration | Allows to choose base configuration of SSH settings, tuned up for different purposes such as high security or higher compatibility. |
SSHSettingsCompressionAlgorithms | A list of session compression algorithms separated with commas or semicolons. |
SSHSettingsCompressionLevel | Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression). |
SSHSettingsDefaultWindowSize | 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. |
SSHSettingsEncryptionAlgorithms | A list of session encryption algorithms separated with commas or semicolons. |
SSHSettingsForceCompression | Whether the SSH client should explicitly request compression. |
SSHSettingsGSSAuthTypes | A comma-separated list of authentication types. |
SSHSettingsGSSDelegateCreds | Switches credential delegation on or off. |
SSHSettingsGSSHostname | The GSS host name, in form of a FQDN (e. |
SSHSettingsGSSLib | A path to the GSS-API library (DLL or SO). |
SSHSettingsGSSMechanisms | A comma-separated list of GSS mechanisms to use. |
SSHSettingsGSSProtocols | A comma-separated list of SSPI protocols. |
SSHSettingsHandshakeTimeout | Specifies the maximal time for the SSH handshake to proceed, in seconds. |
SSHSettingsKexAlgorithms | A list of key exchange algorithms separated with commas or semicolons. |
SSHSettingsMacAlgorithms | A list of MAC (for message authentication code ) algorithms separated with commas or semicolons. |
SSHSettingsMaxSSHPacketSize | Specifies the maximum length of one SSH packet in bytes. |
SSHSettingsMinWindowSize | Specifies the minimal internal window size. |
SSHSettingsObfuscateHandshake | Enables or disables handshake obfuscation. |
SSHSettingsObfuscationPassword | Specifies the password used to encrypt the handshake when ObfuscateHandshake is set. |
SSHSettingsPublicKeyAlgorithms | A list of public key algorithms separated with commas or semicolons. |
SSHSettingsRequestPasswordChange | Whether to request a password change when connecting. |
SSHSettingsSoftwareName | The name to be used by the class to identify itself. |
SSHSettingsTrustAllKeys | Enables or disables explicit trust to all server keys. |
SSHSettingsUseAuthAgent | Enables or disables the use of external key agent, such as Putty key agent. |
SSHSettingsVersions | Specifies enabled SSH protocol versions (1 or 2). |
UserCount | The number of records in the User arrays. |
UserAssociatedData | Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used. |
UserBasePath | Base path for this user in the server's file system. |
UserCert | Contains the user's certificate. |
UserData | Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings. |
UserHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
UserHashAlgorithm | Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. |
UserIncomingSpeedLimit | Specifies the incoming speed limit for this user. |
UserOtpAlgorithm | The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). |
UserOtpValue | The user's time interval (TOTP) or Counter (HOTP). |
UserOutgoingSpeedLimit | Specifies the outgoing speed limit for this user. |
UserPassword | The user's authentication password. |
UserPasswordLen | Specifies the length of the user's OTP password. |
UserSharedSecret | Contains the user's secret key, which is essentially a shared secret between the client and server. |
UserSSHKey | Contains the user's SSH key. |
UserUsername | The registered name (login) of the user. |
UseUTF8 | Specifies 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.
Config | Sets or retrieves a configuration setting. |
DoAction | Performs an additional action. |
DropClient | Terminates a client connection. |
GetClientBuffer | Acquires a piece of operation data. |
GetClientFileEntry | Acquires file entry details from the class. |
ListClients | Enumerates the connected clients. |
PinClient | Takes a snapshot of the connection's properties. |
SetClientBuffer | Commits a data buffer to the server class. |
SetClientFileEntry | Commits the file entry details to the class. |
Start | Starts SFTP server operation. |
Stop | Stops 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.
Accept | This event is fired when new incoming connection is accepted. |
AfterCreateDirectory | This event indicates completion of directory creation request. |
AfterRemove | This event indicates completion of file removal request. |
AfterRenameFile | This event indicates completion of a file rename operation. |
AfterRequestAttributes | This event indicates completion of file attributes request. |
AfterSetAttributes | This event indicates completion of a set attributes request. |
AuthAttempt | Reports a user authentication attempt. |
AuthFailed | Reports user authentication failure. |
AuthPassword | This event is fired on password authentication attempt from a client. |
AuthPublicKey | This event is fired on public key authentication attempt from a client. |
AuthSucceeded | Reports a successful user authentication. |
BeforeCreateDirectory | This event is fired when a client requests to create a directory. |
BeforeDownloadFile | This event is fired when a download file request is received. |
BeforeFind | This event is fired when a client requests to find files and folders in Path. |
BeforeRemove | This event is fired when a client requests to delete a file or directory. |
BeforeRenameFile | This event is fired when a client requests to rename a file. |
BeforeRequestAttributes | This event is fired when a client requests to get file attributes. |
BeforeSetAttributes | This event is fired when a client requests to set file attributes. |
BeforeUploadFile | This event is fired when an upload file request is received. |
CloseFile | This event instructs the application to close an opened file. |
Connect | This event is fired when a remote connection has been established. |
CreateDirectory | This event instructs the application to create a directory. |
Disconnect | This event is fired when a client has disconnected. |
Error | Information about errors during data delivery. |
ExternalSign | Handles remote or external signing initiated by the server protocol. |
FindClose | This event signifies the completion of a custom file listing operation. |
FindFirst | This event signifies the start of the custom file listing retrieval mechanism. |
FindNext | This event retrieves the next entry of a custom file listing. |
Notification | This event notifies the application about an underlying control flow event. |
OpenFile | This event instructs the application to handle the file open request. |
ReadFile | This event is fired when a file read request is received. |
Remove | This event is fired when a client requests to delete a file or directory. |
RenameFile | This event is fired when a client requests to rename a file. |
RequestAttributes | This event is fired when a get file attributes request is received. |
SessionClosed | Reports session closure. |
SessionEstablished | This event is fired when a new session is established. |
SetAttributes | This event is fired when an set file attributes request is received. |
WriteFile | This event is fired when a file write request is received. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
CustomDHGroupIndex | Sets a specific Diffie-Hellman group index to enforce. |
DualStack | Allows the use of ip4 and ip6 simultaneously. |
MaxDHGroupSize | Sets the maximal Diffie-Hellman group size. |
MinDHGroupSize | Sets the minimal Diffie-Hellman group size. |
NotifyOnFileOperations | Enables low-level file operation notifications. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only). |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
Tag | Allows to store any custom data. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables 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
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
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
atRhosts | 0x01 | RHOSTS file authentication. Rarely used today. |
atPublicKey | 0x02 | Public key (sometimes called private key) authentication |
atPassword | 0x04 | Password-based authentication |
atHostbased | 0x08 | Hostbased authentication |
atKeyboard | 0x10 | Keyboard-interactive authentication. This is often used in place of generic password authentication. |
atGssWithMic | 0x20 | GSS authentication |
atGssKeyex | 0x40 | GSS authentication with key exchange |
atPublicKeyAgent | 0x80 | Public key agent authentication |
Data Type
Integer
BaseDir Property (SFTPServer Class)
Specifies the server's base (root) directory.
Syntax
QString GetBaseDir();
int SetBaseDir(QString qsBaseDir);
Default Value
""
Remarks
Use this property to set the base (root) directory on the server.
Data Type
String
ClientFileEntryATime Property (SFTPServer Class)
Contains the last access time for this file, in UTC.
Syntax
QString GetClientFileEntryATime();
int SetClientFileEntryATime(QString qsClientFileEntryATime);
Default Value
""
Remarks
Contains the last access time for this file, in UTC.
This property is not available at design time.
Data Type
String
ClientFileEntryCTime Property (SFTPServer Class)
Contains this file's creation time, in UTC.
Syntax
QString GetClientFileEntryCTime();
int SetClientFileEntryCTime(QString qsClientFileEntryCTime);
Default Value
""
Remarks
Contains this file's creation time, in UTC.
This property is not available at design time.
Data Type
String
ClientFileEntryDirectory Property (SFTPServer Class)
Specifies whether this entry is a directory.
Syntax
bool GetClientFileEntryDirectory();
int SetClientFileEntryDirectory(bool bClientFileEntryDirectory);
Default Value
false
Remarks
Specifies whether this entry is a directory.
This property is not available at design time.
Data Type
Boolean
ClientFileEntryFileType Property (SFTPServer Class)
Specifies the type of this entry, one of the following: cftFile 0 cftDirectory 1 cftSymblink 2 cftSpecial 3 cftUnknown 4 cftSocket 5 cftCharDevice 6 cftBlockDevice 7 cftFIFO 8 .
Syntax
int GetClientFileEntryFileType();
int SetClientFileEntryFileType(int iClientFileEntryFileType);
Possible Values
CFT_FILE(0),
CFT_DIRECTORY(1),
CFT_SYMBLINK(2),
CFT_SPECIAL(3),
CFT_UNKNOWN(4),
CFT_SOCKET(5),
CFT_CHAR_DEVICE(6),
CFT_BLOCK_DEVICE(7),
CFT_FIFO(8)
Default Value
4
Remarks
Specifies the type of this entry, one of the following:
cftFile | 0 | |
cftDirectory | 1 | |
cftSymblink | 2 | |
cftSpecial | 3 | |
cftUnknown | 4 | |
cftSocket | 5 | |
cftCharDevice | 6 | |
cftBlockDevice | 7 | |
cftFIFO | 8 |
This property is not available at design time.
Data Type
Integer
ClientFileEntryGroupExecute Property (SFTPServer Class)
Controls file execution permission for the group users.
Syntax
bool GetClientFileEntryGroupExecute();
int SetClientFileEntryGroupExecute(bool bClientFileEntryGroupExecute);
Default Value
false
Remarks
Controls file execution permission for the group users.
This property is not available at design time.
Data Type
Boolean
ClientFileEntryGroupRead Property (SFTPServer Class)
Controls file read permission for the group users.
Syntax
bool GetClientFileEntryGroupRead();
int SetClientFileEntryGroupRead(bool bClientFileEntryGroupRead);
Default Value
false
Remarks
Controls file read permission for the group users.
This property is not available at design time.
Data Type
Boolean
ClientFileEntryGroupWrite Property (SFTPServer Class)
Controls file write permission for the group users.
Syntax
bool GetClientFileEntryGroupWrite();
int SetClientFileEntryGroupWrite(bool bClientFileEntryGroupWrite);
Default Value
false
Remarks
Controls file write permission for the group users.
This property is not available at design time.
Data Type
Boolean
ClientFileEntryHandle Property (SFTPServer Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetClientFileEntryHandle();
int SetClientFileEntryHandle(qint64 lClientFileEntryHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is not available at design time.
Data Type
Long64
ClientFileEntryLongName Property (SFTPServer Class)
Contains the long name of the file (human-readable, ftp-like).
Syntax
QString GetClientFileEntryLongName();
int SetClientFileEntryLongName(QString qsClientFileEntryLongName);
Default Value
""
Remarks
Contains the long name of the file (human-readable, ftp-like).
This property is not available at design time.
Data Type
String
ClientFileEntryMTime Property (SFTPServer Class)
Specifies the last modification time, in UTC.
Syntax
QString GetClientFileEntryMTime();
int SetClientFileEntryMTime(QString qsClientFileEntryMTime);
Default Value
""
Remarks
Specifies the last modification time, in UTC.
This property is not available at design time.
Data Type
String
ClientFileEntryName Property (SFTPServer Class)
Specifies the file name.
Syntax
QString GetClientFileEntryName();
int SetClientFileEntryName(QString qsClientFileEntryName);
Default Value
""
Remarks
Specifies the file name.
This property is not available at design time.
Data Type
String
ClientFileEntryOtherExecute Property (SFTPServer Class)
Controls file execution permission for other users (users that are neither owners, nor belong to the same group).
Syntax
bool GetClientFileEntryOtherExecute();
int SetClientFileEntryOtherExecute(bool bClientFileEntryOtherExecute);
Default Value
false
Remarks
Controls file execution permission for other users (users that are neither owners, nor belong to the same group).
This property is not available at design time.
Data Type
Boolean
ClientFileEntryOtherRead Property (SFTPServer Class)
Controls file read permission for other users (users that are neither owners, nor belong to the same group).
Syntax
bool GetClientFileEntryOtherRead();
int SetClientFileEntryOtherRead(bool bClientFileEntryOtherRead);
Default Value
false
Remarks
Controls file read permission for other users (users that are neither owners, nor belong to the same group).
This property is not available at design time.
Data Type
Boolean
ClientFileEntryOtherWrite Property (SFTPServer Class)
Controls file write permission for other users (users that are neither owners, nor belong to the same group).
Syntax
bool GetClientFileEntryOtherWrite();
int SetClientFileEntryOtherWrite(bool bClientFileEntryOtherWrite);
Default Value
false
Remarks
Controls file write permission for other users (users that are neither owners, nor belong to the same group).
This property is not available at design time.
Data Type
Boolean
ClientFileEntryOwner Property (SFTPServer Class)
Specifies the owner of the file/directory.
Syntax
QString GetClientFileEntryOwner();
int SetClientFileEntryOwner(QString qsClientFileEntryOwner);
Default Value
""
Remarks
Specifies the owner of the file/directory.
This property is not available at design time.
Data Type
String
ClientFileEntryPath Property (SFTPServer Class)
Contains the full path to the file.
Syntax
QString GetClientFileEntryPath();
int SetClientFileEntryPath(QString qsClientFileEntryPath);
Default Value
""
Remarks
Contains the full path to the file.
This property is not available at design time.
Data Type
String
ClientFileEntrySize Property (SFTPServer Class)
The size of the file in bytes.
Syntax
qint64 GetClientFileEntrySize();
int SetClientFileEntrySize(qint64 lClientFileEntrySize);
Default Value
0
Remarks
The size of the file in bytes.
This property is not available at design time.
Data Type
Long64
ClientFileEntryUserExecute Property (SFTPServer Class)
Controls file execution permission for the file owner.
Syntax
bool GetClientFileEntryUserExecute();
int SetClientFileEntryUserExecute(bool bClientFileEntryUserExecute);
Default Value
false
Remarks
Controls file execution permission for the file owner.
This property is not available at design time.
Data Type
Boolean
ClientFileEntryUserRead Property (SFTPServer Class)
Controls file read permission for the file owner.
Syntax
bool GetClientFileEntryUserRead();
int SetClientFileEntryUserRead(bool bClientFileEntryUserRead);
Default Value
false
Remarks
Controls file read permission for the file owner.
This property is not available at design time.
Data Type
Boolean
ClientFileEntryUserWrite Property (SFTPServer Class)
Controls file write permission for the file owner.
Syntax
bool GetClientFileEntryUserWrite();
int SetClientFileEntryUserWrite(bool bClientFileEntryUserWrite);
Default Value
false
Remarks
Controls file write permission for the file owner.
This property is not available at design time.
Data Type
Boolean
CompressionLevel Property (SFTPServer Class)
Specifies the preferable compression level.
Syntax
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
ExternalCryptoAsyncDocumentID Property (SFTPServer Class)
Specifies the document ID for SignAsyncEnd() call Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch.
Syntax
QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID);
Default Value
""
Remarks
Specifies the document ID for SignAsyncEnd() call
Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. This value helps ASiCSigner identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.
Data Type
String
ExternalCryptoCustomParams Property (SFTPServer Class)
Custom parameters to be passed to the signing service (uninterpreted).
Syntax
QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams);
Default Value
""
Remarks
Custom parameters to be passed to the signing service (uninterpreted).
This property is not available at design time.
Data Type
String
ExternalCryptoData Property (SFTPServer Class)
Additional data to be included in the async state and mirrored back by the requestor.
Syntax
QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData);
Default Value
""
Remarks
Additional data to be included in the async state and mirrored back by the requestor
This property is not available at design time.
Data Type
String
ExternalCryptoExternalHashCalculation Property (SFTPServer Class)
Specifies whether the message hash is to be calculated at the external endpoint.
Syntax
bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation);
Default Value
false
Remarks
Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it.
Data Type
Boolean
ExternalCryptoHashAlgorithm Property (SFTPServer Class)
Specifies the request's signature hash algorithm.
Syntax
QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm);
Default Value
"SHA256"
Remarks
Specifies the request's signature hash algorithm.
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
Data Type
String
ExternalCryptoKeyID Property (SFTPServer Class)
The ID of the pre-shared key used for DC request authentication.
Syntax
QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID);
Default Value
""
Remarks
The ID of the pre-shared key used for DC request authentication.
Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides extra protection layer for the protocol and diminishes the risk of private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret to pass the key itself.
The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.
Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.
Example:
signer.ExternalCrypto.KeyID = "MainSigningKey";
signer.ExternalCrypto.KeySecret = "abcdef0123456789";
Data Type
String
ExternalCryptoKeySecret Property (SFTPServer Class)
The pre-shared key used for DC request authentication.
Syntax
QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret);
Default Value
""
Remarks
The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.
Read more about configuring authentication in the ExternalCryptoKeyID topic.
Data Type
String
ExternalCryptoMethod Property (SFTPServer Class)
Specifies the asynchronous signing method.
Syntax
int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);
Possible Values
ASMD_PKCS1(0),
ASMD_PKCS7(1)
Default Value
0
Remarks
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.
Available options:
asmdPKCS1 | 0 |
asmdPKCS7 | 1 |
Data Type
Integer
ExternalCryptoMode Property (SFTPServer Class)
Specifies the external cryptography mode.
Syntax
int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);
Possible Values
ECM_DEFAULT(0),
ECM_DISABLED(1),
ECM_GENERIC(2),
ECM_DCAUTH(3),
ECM_DCAUTH_JSON(4)
Default Value
0
Remarks
Specifies the external cryptography mode.
Available options:
ecmDefault | The default value (0) |
ecmDisabled | Do not use DC or external signing (1) |
ecmGeneric | Generic external signing with OnExternalSign event (2) |
ecmDCAuth | DCAuth signing (3) |
ecmDCAuthJSON | DCAuth signing in JSON format (4) |
This property is not available at design time.
Data Type
Integer
ExternalCryptoPublicKeyAlgorithm Property (SFTPServer Class)
Provide public key algorithm here if the certificate is not available on the pre-signing stage.
Syntax
QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);
Default Value
""
Remarks
Provide public key algorithm here if the certificate is not available on the pre-signing stage.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
Data Type
String
FIPSMode Property (SFTPServer Class)
Reserved.
Syntax
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
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
QString GetHost();
int SetHost(QString qsHost);
Default Value
""
Remarks
Use this property to set the host name for this server.
Data Type
String
KeyFingerprintSHA1 Property (SFTPServer Class)
Contains the SHA-1 fingerprint (hash) of the key.
Syntax
QString GetKeyFingerprintSHA1();
Default Value
""
Remarks
Contains the SHA-1 fingerprint (hash) of the key.
This property is read-only and not available at design time.
Data Type
String
KeyFingerprintSHA256 Property (SFTPServer Class)
Contains the SHA-256 fingerprint (hash) of the key.
Syntax
QString GetKeyFingerprintSHA256();
Default Value
""
Remarks
Contains the SHA-256 fingerprint (hash) of the key.
This property is read-only and not available at design time.
Data Type
String
KeyHandle Property (SFTPServer Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetKeyHandle();
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is read-only and not available at design time.
Data Type
Long64
MaxSFTPVersion Property (SFTPServer Class)
Maximum SFTP version supported.
Syntax
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
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
PinnedClientAddress Property (SFTPServer Class)
The client's IP address.
Syntax
QString GetPinnedClientAddress();
Default Value
""
Remarks
The client's IP address.
This property is read-only and not available at design time.
Data Type
String
PinnedClientClientKeyAlgorithm Property (SFTPServer Class)
Specifies the client's key algorithm.
Syntax
QString GetPinnedClientClientKeyAlgorithm();
Default Value
""
Remarks
Specifies the client's key algorithm.
This property is read-only and not available at design time.
Data Type
String
PinnedClientClientKeyBits Property (SFTPServer Class)
Specifies the length of the client's key.
Syntax
int GetPinnedClientClientKeyBits();
Default Value
0
Remarks
Specifies the length of the client's key.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientClientKeyFingerprint Property (SFTPServer Class)
The fingerprint (hash value) of the client's public key.
Syntax
QString GetPinnedClientClientKeyFingerprint();
Default Value
""
Remarks
The fingerprint (hash value) of the client's public key.
This property is read-only and not available at design time.
Data Type
String
PinnedClientClientSoftwareName Property (SFTPServer Class)
Returns the name of the SSH software running on the client side.
Syntax
QString GetPinnedClientClientSoftwareName();
Default Value
""
Remarks
Returns the name of the SSH software running on the client side.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCloseReason Property (SFTPServer Class)
Contains the line sent by the client just before closing the connection.
Syntax
QString GetPinnedClientCloseReason();
Default Value
""
Remarks
Contains the line sent by the client just before closing the connection. It might contain the error description if the connection was not closed gracefully.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCompressionAlgorithmInbound Property (SFTPServer Class)
Compression algorithm for the incoming traffic.
Syntax
QString GetPinnedClientCompressionAlgorithmInbound();
Default Value
""
Remarks
Compression algorithm for the incoming traffic.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCompressionAlgorithmOutbound Property (SFTPServer Class)
Compression algorithm for the outgoing traffic.
Syntax
QString GetPinnedClientCompressionAlgorithmOutbound();
Default Value
""
Remarks
Compression algorithm for the outgoing traffic.
This property is read-only and not available at design time.
Data Type
String
PinnedClientEncryptionAlgorithmInbound Property (SFTPServer Class)
Encryption algorithm for the incoming traffic.
Syntax
QString GetPinnedClientEncryptionAlgorithmInbound();
Default Value
""
Remarks
Encryption algorithm for the incoming traffic.
This property is read-only and not available at design time.
Data Type
String
PinnedClientEncryptionAlgorithmOutbound Property (SFTPServer Class)
Encryption algorithm for the outgoing traffic.
Syntax
QString GetPinnedClientEncryptionAlgorithmOutbound();
Default Value
""
Remarks
Encryption algorithm for the outgoing traffic.
This property is read-only and not available at design time.
Data Type
String
PinnedClientID Property (SFTPServer Class)
The client connection's unique identifier.
Syntax
qint64 GetPinnedClientID();
Default Value
-1
Remarks
The client connection's unique identifier. This value is used throughout to refer to a particular client connection.
This property is read-only and not available at design time.
Data Type
Long64
PinnedClientInboundEncryptionKeyBits Property (SFTPServer Class)
Specifies the length of the key used to encrypt the incoming traffic.
Syntax
int GetPinnedClientInboundEncryptionKeyBits();
Default Value
0
Remarks
Specifies the length of the key used to encrypt the incoming traffic.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientKexAlgorithm Property (SFTPServer Class)
The key exchange algorithm used during the SSH handshake.
Syntax
QString GetPinnedClientKexAlgorithm();
Default Value
""
Remarks
The key exchange algorithm used during the SSH handshake.
This property is read-only and not available at design time.
Data Type
String
PinnedClientKexBits Property (SFTPServer Class)
The number of bits used by the key exchange algorithm.
Syntax
int GetPinnedClientKexBits();
Default Value
0
Remarks
The number of bits used by the key exchange algorithm.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientKexLines Property (SFTPServer Class)
The contents of the received KexInit packet.
Syntax
QString GetPinnedClientKexLines();
Default Value
""
Remarks
The contents of the received KexInit packet.
KexInit packet contains the list of algorithms supported by the remote party.
This property is read-only and not available at design time.
Data Type
String
PinnedClientMacAlgorithmInbound Property (SFTPServer Class)
MAC algorithm used for the incoming connection.
Syntax
QString GetPinnedClientMacAlgorithmInbound();
Default Value
""
Remarks
MAC algorithm used for the incoming connection.
This property is read-only and not available at design time.
Data Type
String
PinnedClientMacAlgorithmOutbound Property (SFTPServer Class)
MAC algorithm used for outbound connection.
Syntax
QString GetPinnedClientMacAlgorithmOutbound();
Default Value
""
Remarks
MAC algorithm used for outbound connection.
This property is read-only and not available at design time.
Data Type
String
PinnedClientOutboundEncryptionKeyBits Property (SFTPServer Class)
Specifies the length of the key used to encrypt the outgoing traffic.
Syntax
int GetPinnedClientOutboundEncryptionKeyBits();
Default Value
0
Remarks
Specifies the length of the key used to encrypt the outgoing traffic.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientPort Property (SFTPServer Class)
The remote port of the client connection.
Syntax
int GetPinnedClientPort();
Default Value
0
Remarks
The remote port of the client connection.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientPublicKeyAlgorithm Property (SFTPServer Class)
Specifies the public key algorithm which was used during the SSH handshake.
Syntax
QString GetPinnedClientPublicKeyAlgorithm();
Default Value
""
Remarks
Specifies the public key algorithm which was used during the SSH handshake.
This property is read-only and not available at design time.
Data Type
String
PinnedClientServerKeyBits Property (SFTPServer Class)
Specifies the number of bits in the server's key.
Syntax
int GetPinnedClientServerKeyBits();
Default Value
0
Remarks
Specifies the number of bits in the server's key.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientServerKeyFingerprint Property (SFTPServer Class)
The fingerprint (hash value) of the server's public key.
Syntax
QString GetPinnedClientServerKeyFingerprint();
Default Value
""
Remarks
The fingerprint (hash value) of the server's public key.
This property is read-only and not available at design time.
Data Type
String
PinnedClientTotalBytesReceived Property (SFTPServer Class)
Returns the total number of bytes received over this connection.
Syntax
qint64 GetPinnedClientTotalBytesReceived();
Default Value
0
Remarks
Returns the total number of bytes received over this connection.
This property is read-only and not available at design time.
Data Type
Long64
PinnedClientTotalBytesSent Property (SFTPServer Class)
Returns the total number of bytes sent over this connection.
Syntax
qint64 GetPinnedClientTotalBytesSent();
Default Value
0
Remarks
Returns the total number of bytes sent over this connection.
This property is read-only and not available at design time.
Data Type
Long64
PinnedClientVersion Property (SFTPServer Class)
Specifies SSH protocol version.
Syntax
int GetPinnedClientVersion();
Default Value
2
Remarks
Specifies SSH protocol version.
This property is read-only and not available at design time.
Data Type
Integer
Port Property (SFTPServer Class)
Specifies the listening port number.
Syntax
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
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
ServerKeyCount Property (SFTPServer Class)
The number of records in the ServerKey arrays.
Syntax
int GetServerKeyCount();
int SetServerKeyCount(int iServerKeyCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ServerKeyCount - 1.This property is not available at design time.
Data Type
Integer
ServerKeyAlgorithm Property (SFTPServer Class)
Specifies the key algorithm.
Syntax
QString GetServerKeyAlgorithm(int iServerKeyIndex);
Default Value
""
Remarks
Specifies the key algorithm.
The ServerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerKeyCount property.
This property is read-only and not available at design time.
Data Type
String
ServerKeyBits Property (SFTPServer Class)
The number of bits in the key: the more the better, 2048 or 4096 are typical values.
Syntax
int GetServerKeyBits(int iServerKeyIndex);
Default Value
0
Remarks
The number of bits in the key: the more the better, 2048 or 4096 are typical values.
The ServerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
ServerKeyFingerprintMD5 Property (SFTPServer Class)
Contains the MD5 fingerprint (hash) of the key.
Syntax
QString GetServerKeyFingerprintMD5(int iServerKeyIndex);
Default Value
""
Remarks
Contains the MD5 fingerprint (hash) of the key.
The ServerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerKeyCount property.
This property is read-only and not available at design time.
Data Type
String
ServerKeyFingerprintSHA1 Property (SFTPServer Class)
Contains the SHA-1 fingerprint (hash) of the key.
Syntax
QString GetServerKeyFingerprintSHA1(int iServerKeyIndex);
Default Value
""
Remarks
Contains the SHA-1 fingerprint (hash) of the key.
The ServerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerKeyCount property.
This property is read-only and not available at design time.
Data Type
String
ServerKeyHandle Property (SFTPServer Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetServerKeyHandle(int iServerKeyIndex);
int SetServerKeyHandle(int iServerKeyIndex, qint64 lServerKeyHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The ServerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerKeyCount property.
This property is not available at design time.
Data Type
Long64
SocketIncomingSpeedLimit Property (SFTPServer Class)
The maximum number of bytes to read from the socket, per second.
Syntax
int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit);
Default Value
0
Remarks
The maximum number of bytes to read from the socket, per second.
Data Type
Integer
SocketLocalAddress Property (SFTPServer Class)
The local network interface to bind the socket to.
Syntax
QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress);
Default Value
""
Remarks
The local network interface to bind the socket to.
Data Type
String
SocketLocalPort Property (SFTPServer Class)
The local port number to bind the socket to.
Syntax
int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort);
Default Value
0
Remarks
The local port number to bind the socket to.
Data Type
Integer
SocketOutgoingSpeedLimit Property (SFTPServer Class)
The maximum number of bytes to write to the socket, per second.
Syntax
int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit);
Default Value
0
Remarks
The maximum number of bytes to write to the socket, per second.
Data Type
Integer
SocketTimeout Property (SFTPServer Class)
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
Syntax
int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout);
Default Value
60000
Remarks
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).
Data Type
Integer
SocketUseIPv6 Property (SFTPServer Class)
Enables or disables IP protocol version 6.
Syntax
bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);
Default Value
false
Remarks
Enables or disables IP protocol version 6.
Data Type
Boolean
SSHSettingsAutoAdjustCiphers Property (SFTPServer Class)
Whether the SSH client should adjust its list of supported ciphers 'on-the-fly' for greater compatibility with the server it is connecting to.
Syntax
bool GetSSHSettingsAutoAdjustCiphers();
int SetSSHSettingsAutoAdjustCiphers(bool bSSHSettingsAutoAdjustCiphers);
Default Value
true
Remarks
Whether the SSH client should adjust its list of supported ciphers 'on-the-fly' for greater compatibility with the server it is connecting to.
Data Type
Boolean
SSHSettingsBaseConfiguration Property (SFTPServer Class)
Allows to choose base configuration of SSH settings, tuned up for different purposes such as high security or higher compatibility.
Syntax
int GetSSHSettingsBaseConfiguration();
int SetSSHSettingsBaseConfiguration(int iSSHSettingsBaseConfiguration);
Possible Values
STPC_DEFAULT(0),
STPC_COMPATIBLE(1),
STPC_COMPREHENSIVE_INSECURE(2),
STPC_HIGHLY_SECURE(3)
Default Value
0
Remarks
Allows to choose base configuration of SSH settings, tuned up for different purposes such as high security or higher compatibility.
Data Type
Integer
SSHSettingsCompressionAlgorithms Property (SFTPServer Class)
A list of session compression algorithms separated with commas or semicolons.
Syntax
QString GetSSHSettingsCompressionAlgorithms();
int SetSSHSettingsCompressionAlgorithms(QString qsSSHSettingsCompressionAlgorithms);
Default Value
""
Remarks
A list of session compression algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all compression algorithms at once.
Note: the list of algorithms provided to this property alters the baseline list of compression algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported compression algorithms is provided below:
- none
- zlib
- zlib@openssh.com
Data Type
String
SSHSettingsCompressionLevel Property (SFTPServer Class)
Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression).
Syntax
int GetSSHSettingsCompressionLevel();
int SetSSHSettingsCompressionLevel(int iSSHSettingsCompressionLevel);
Default Value
6
Remarks
Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression). This setting is ignored if compression wasn't accepted.
Data Type
Integer
SSHSettingsDefaultWindowSize Property (SFTPServer Class)
The SSH window size specifies how many bytes the client can send to the server in the command channel without obtaining pre-authorization for the further send from the server.
Syntax
int GetSSHSettingsDefaultWindowSize();
int SetSSHSettingsDefaultWindowSize(int iSSHSettingsDefaultWindowSize);
Default Value
2048000
Remarks
The SSH window size specifies how many bytes the client can send to the server in the command channel without obtaining pre-authorization for the further send from the server.
Data Type
Integer
SSHSettingsEncryptionAlgorithms Property (SFTPServer Class)
A list of session encryption algorithms separated with commas or semicolons.
Syntax
QString GetSSHSettingsEncryptionAlgorithms();
int SetSSHSettingsEncryptionAlgorithms(QString qsSSHSettingsEncryptionAlgorithms);
Default Value
""
Remarks
A list of session encryption algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all encryption algorithms at once.
Note: the list of algorithms provided to this property alters the baseline list of encryption algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported encryption algorithms is provided below:
- 3des-cbc
- blowfish-cbc
- twofish256-cbc
- twofish192-cbc
- twofish128-cbc
- aes256-cbc
- aes192-cbc
- aes128-cbc
- serpent256-cbc
- serpent192-cbc
- serpent128-cbc
- arcfour
- idea-cbc
- cast128-cbc
- none
- des-cbc
- aes128-ctr
- aes192-ctr
- aes256-ctr
- 3des-ctr
- blowfish-ctr
- twofish128-ctr
- twofish192-ctr
- twofish256-ctr
- serpent128-ctr
- serpent192-ctr
- serpent256-ctr
- idea-ctr
- cast128-ctr
- arcfour128
- arcfour256
- aes128-gcm
- aes256-gcm
- aes128-gcm@openssh.com
- aes256-gcm@openssh.com
- chacha20-poly1305
- chacha20-poly1305@openssh.com
Data Type
String
SSHSettingsForceCompression Property (SFTPServer Class)
Whether the SSH client should explicitly request compression.
Syntax
bool GetSSHSettingsForceCompression();
int SetSSHSettingsForceCompression(bool bSSHSettingsForceCompression);
Default Value
false
Remarks
Whether the SSH client should explicitly request compression.
If ForceCompression is False, compression will be used only if the server doesn't support algorithms without compression.
Data Type
Boolean
SSHSettingsGSSAuthTypes Property (SFTPServer Class)
A comma-separated list of authentication types.
Syntax
QString GetSSHSettingsGSSAuthTypes();
int SetSSHSettingsGSSAuthTypes(QString qsSSHSettingsGSSAuthTypes);
Default Value
""
Remarks
A comma-separated list of authentication types. Two types are currently supported: gssapi-with-mic and gssapi-keyex.
Data Type
String
SSHSettingsGSSDelegateCreds Property (SFTPServer Class)
Switches credential delegation on or off.
Syntax
bool GetSSHSettingsGSSDelegateCreds();
int SetSSHSettingsGSSDelegateCreds(bool bSSHSettingsGSSDelegateCreds);
Default Value
false
Remarks
Switches credential delegation on or off.
Data Type
Boolean
SSHSettingsGSSHostname Property (SFTPServer Class)
The GSS host name, in form of a FQDN (e.
Syntax
QString GetSSHSettingsGSSHostname();
int SetSSHSettingsGSSHostname(QString qsSSHSettingsGSSHostname);
Default Value
""
Remarks
The GSS host name, in form of a FQDN (e.g. hostname.com), a principal name (e.g. 'host@hostname.com), or a cross-real ticket-granting ticket (e.g. krbtgt/test.com@example.com).
Data Type
String
SSHSettingsGSSLib Property (SFTPServer Class)
A path to the GSS-API library (DLL or SO).
Syntax
QString GetSSHSettingsGSSLib();
int SetSSHSettingsGSSLib(QString qsSSHSettingsGSSLib);
Default Value
""
Remarks
A path to the GSS-API library (DLL or SO).
Data Type
String
SSHSettingsGSSMechanisms Property (SFTPServer Class)
A comma-separated list of GSS mechanisms to use.
Syntax
QString GetSSHSettingsGSSMechanisms();
int SetSSHSettingsGSSMechanisms(QString qsSSHSettingsGSSMechanisms);
Default Value
""
Remarks
A comma-separated list of GSS mechanisms to use. Two values are currently supported: lib and SSPI.
Data Type
String
SSHSettingsGSSProtocols Property (SFTPServer Class)
A comma-separated list of SSPI protocols.
Syntax
QString GetSSHSettingsGSSProtocols();
int SetSSHSettingsGSSProtocols(QString qsSSHSettingsGSSProtocols);
Default Value
""
Remarks
A comma-separated list of SSPI protocols. Two protocols are currently supported: kerberos and NTLM.
Data Type
String
SSHSettingsHandshakeTimeout Property (SFTPServer Class)
Specifies the maximal time for the SSH handshake to proceed, in seconds.
Syntax
int GetSSHSettingsHandshakeTimeout();
int SetSSHSettingsHandshakeTimeout(int iSSHSettingsHandshakeTimeout);
Default Value
45
Remarks
Specifies the maximal time for the SSH handshake to proceed, in seconds. If the handshake is not completed within this period, the session is aborted.
Data Type
Integer
SSHSettingsKexAlgorithms Property (SFTPServer Class)
A list of key exchange algorithms separated with commas or semicolons.
Syntax
QString GetSSHSettingsKexAlgorithms();
int SetSSHSettingsKexAlgorithms(QString qsSSHSettingsKexAlgorithms);
Default Value
""
Remarks
A list of key exchange algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all key exchange algorithms at once.
Note: the list of algorithms provided to this property alters the baseline list of key exchange algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported kex algorithms is provided below:
- diffie-hellman-group-exchange-sha1
- diffie-hellman-group1-sha1
- diffie-hellman-group14-sha1
- diffie-hellman-group-exchange-sha256
- rsa1024-sha1
- rsa2048-sha256
- ecdh-sha2-nistp256
- ecdh-sha2-nistp384
- ecdh-sha2-nistp521
- ecdh-sha2-nistk163
- ecdh-sha2-nistp192
- ecdh-sha2-nistp224
- ecdh-sha2-nistk233
- ecdh-sha2-nistb233
- ecdh-sha2-nistk283
- ecdh-sha2-nistk409
- ecdh-sha2-nistb409
- ecdh-sha2-nistt571
- ecdh-sha2-curve25519
- curve25519-sha256@libssh.org
- curve448-sha512@libssh.org
Data Type
String
SSHSettingsMacAlgorithms Property (SFTPServer Class)
A list of MAC (for message authentication code ) algorithms separated with commas or semicolons.
Syntax
QString GetSSHSettingsMacAlgorithms();
int SetSSHSettingsMacAlgorithms(QString qsSSHSettingsMacAlgorithms);
Default Value
""
Remarks
A list of MAC (for message authentication code) algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all MAC algorithms at once.
Note: the list of algorithms provided to this property alters the baseline list of MAC algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported MAC algorithms is provided below:
- hmac-sha1
- hmac-sha1-96
- hmac-md5
- hmac-md5-96
- none
- hmac-ripemd160
- hmac-ripemd
- hmac-ripemd160@openssh.com
- hmac-sha256@ssh.com
- hmac-sha256-96@ssh.com
- umac-32@openssh.com
- umac-64@openssh.com
- umac-96@openssh.com
- umac-128@openssh.com
- hmac-sha2-256
- hmac-sha2-512
- aes128-gcm
- aes256-gcm
- chacha20-poly1305@openssh.com
- hmac-sha2-256-etm@openssh.com
- hmac-sha2-512-etm@openssh.com
Data Type
String
SSHSettingsMaxSSHPacketSize Property (SFTPServer Class)
Specifies the maximum length of one SSH packet in bytes.
Syntax
int GetSSHSettingsMaxSSHPacketSize();
int SetSSHSettingsMaxSSHPacketSize(int iSSHSettingsMaxSSHPacketSize);
Default Value
262144
Remarks
Specifies the maximum length of one SSH packet in bytes.
Data Type
Integer
SSHSettingsMinWindowSize Property (SFTPServer Class)
Specifies the minimal internal window size.
Syntax
int GetSSHSettingsMinWindowSize();
int SetSSHSettingsMinWindowSize(int iSSHSettingsMinWindowSize);
Default Value
2048
Remarks
Specifies the minimal internal window size. When the minimal window size is reached, the 'window extension' request is sent to the server. This request notifies the server that the window was extended, and it can send more data.
Data Type
Integer
SSHSettingsObfuscateHandshake Property (SFTPServer Class)
Enables or disables handshake obfuscation.
Syntax
bool GetSSHSettingsObfuscateHandshake();
int SetSSHSettingsObfuscateHandshake(bool bSSHSettingsObfuscateHandshake);
Default Value
false
Remarks
Enables or disables handshake obfuscation.
Data Type
Boolean
SSHSettingsObfuscationPassword Property (SFTPServer Class)
Specifies the password used to encrypt the handshake when ObfuscateHandshake is set.
Syntax
QString GetSSHSettingsObfuscationPassword();
int SetSSHSettingsObfuscationPassword(QString qsSSHSettingsObfuscationPassword);
Default Value
""
Remarks
Specifies the password used to encrypt the handshake when ObfuscateHandshake is set.
Data Type
String
SSHSettingsPublicKeyAlgorithms Property (SFTPServer Class)
A list of public key algorithms separated with commas or semicolons.
Syntax
QString GetSSHSettingsPublicKeyAlgorithms();
int SetSSHSettingsPublicKeyAlgorithms(QString qsSSHSettingsPublicKeyAlgorithms);
Default Value
""
Remarks
A list of public key algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all public key algorithms at once.
Note: the list of algorithms provided to this property alters the baseline list of public key algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported public key algorithms is provided below:
- ssh-dss
- ssh-rsa
- x509v3-sign-rsa
- x509v3-sign-dss
- spki-sign-rsa,
- spki-sign-dss
- pgp-sign-rsa
- pgp-sign-dss
- ecdsa-sha2-nistp256
- ecdsa-sha2-nistp384
- ecdsa-sha2-nistp521
- ecdsa-sha2-nistk163
- ecdsa-sha2-nistp192
- ecdsa-sha2-nistp224
- ecdsa-sha2-nistk233
- ecdsa-sha2-nistb233
- ecdsa-sha2-nistk283
- ecdsa-sha2-nistk409
- ecdsa-sha2-nistb409
- ecdsa-sha2-nistt571,
- ecdsa-sha2-curve25519
- x509v3-ssh-rsa
- x509v3-ssh-dss
- x509v3-rsa2048-sha256
- x509v3-ecdsa-sha2-nistp256
- x509v3-ecdsa-sha2-nistp384
- x509v3-ecdsa-sha2-nistp521
- x509v3-ecdsa-sha2-nistk163
- x509v3-ecdsa-sha2-nistp192
- x509v3-ecdsa-sha2-nistp224
- x509v3-ecdsa-sha2-nistk233
- x509v3-ecdsa-sha2-nistb233
- x509v3-ecdsa-sha2-nistk283
- x509v3-ecdsa-sha2-nistk409
- x509v3-ecdsa-sha2-nistb409
- x509v3-ecdsa-sha2-nistt571
- x509v3-ecdsa-sha2-curve25519
- ssh-ed25519
- ssh-ed448
Data Type
String
SSHSettingsRequestPasswordChange Property (SFTPServer Class)
Whether to request a password change when connecting.
Syntax
bool GetSSHSettingsRequestPasswordChange();
int SetSSHSettingsRequestPasswordChange(bool bSSHSettingsRequestPasswordChange);
Default Value
false
Remarks
Whether to request a password change when connecting.
Data Type
Boolean
SSHSettingsSoftwareName Property (SFTPServer Class)
The name to be used by the class to identify itself.
Syntax
QString GetSSHSettingsSoftwareName();
int SetSSHSettingsSoftwareName(QString qsSSHSettingsSoftwareName);
Default Value
"SecureBlackbox"
Remarks
The name to be used by the component to identify itself.
Data Type
String
SSHSettingsTrustAllKeys Property (SFTPServer Class)
Enables or disables explicit trust to all server keys.
Syntax
bool GetSSHSettingsTrustAllKeys();
int SetSSHSettingsTrustAllKeys(bool bSSHSettingsTrustAllKeys);
Default Value
false
Remarks
Enables or disables explicit trust to all server keys. Use with care.
Data Type
Boolean
SSHSettingsUseAuthAgent Property (SFTPServer Class)
Enables or disables the use of external key agent, such as Putty key agent.
Syntax
bool GetSSHSettingsUseAuthAgent();
int SetSSHSettingsUseAuthAgent(bool bSSHSettingsUseAuthAgent);
Default Value
false
Remarks
Enables or disables the use of external key agent, such as Putty key agent.
Data Type
Boolean
SSHSettingsVersions Property (SFTPServer Class)
Specifies enabled SSH protocol versions (1 or 2).
Syntax
int GetSSHSettingsVersions();
int SetSSHSettingsVersions(int iSSHSettingsVersions);
Default Value
1
Remarks
Specifies enabled SSH protocol versions (1 or 2).
Data Type
Integer
UserCount Property (SFTPServer Class)
The number of records in the User arrays.
Syntax
int GetUserCount();
int SetUserCount(int iUserCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
- UserAssociatedData
- UserBasePath
- UserCert
- UserData
- UserHandle
- UserHashAlgorithm
- UserIncomingSpeedLimit
- UserOtpAlgorithm
- UserOtpValue
- UserOutgoingSpeedLimit
- UserPassword
- UserPasswordLen
- UserSharedSecret
- UserSSHKey
- UserUsername
This property is not available at design time.
Data Type
Integer
UserAssociatedData Property (SFTPServer Class)
Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.
Syntax
QByteArray GetUserAssociatedData(int iUserIndex);
int SetUserAssociatedData(int iUserIndex, QByteArray qbaUserAssociatedData);
Remarks
Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Byte Array
UserBasePath Property (SFTPServer Class)
Base path for this user in the server's file system.
Syntax
QString GetUserBasePath(int iUserIndex);
int SetUserBasePath(int iUserIndex, QString qsUserBasePath);
Default Value
""
Remarks
Base path for this user in the server's file system.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
String
UserCert Property (SFTPServer Class)
Contains the user's certificate.
Syntax
QByteArray GetUserCert(int iUserIndex);
int SetUserCert(int iUserIndex, QByteArray qbaUserCert);
Remarks
Contains the user's certificate.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Byte Array
UserData Property (SFTPServer Class)
Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.
Syntax
QString GetUserData(int iUserIndex);
int SetUserData(int iUserIndex, QString qsUserData);
Default Value
""
Remarks
Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
String
UserHandle Property (SFTPServer Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetUserHandle(int iUserIndex);
int SetUserHandle(int iUserIndex, qint64 lUserHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Long64
UserHashAlgorithm Property (SFTPServer Class)
Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user.
Syntax
QString GetUserHashAlgorithm(int iUserIndex);
int SetUserHashAlgorithm(int iUserIndex, QString qsUserHashAlgorithm);
Default Value
""
Remarks
Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests:
SB_MAC_ALGORITHM_HMAC_SHA1 | SHA1 | |
SB_MAC_ALGORITHM_HMAC_SHA256 | SHA256 | |
SB_MAC_ALGORITHM_HMAC_SHA512 | SHA512 |
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
String
UserIncomingSpeedLimit Property (SFTPServer Class)
Specifies the incoming speed limit for this user.
Syntax
int GetUserIncomingSpeedLimit(int iUserIndex);
int SetUserIncomingSpeedLimit(int iUserIndex, int iUserIncomingSpeedLimit);
Default Value
0
Remarks
Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Integer
UserOtpAlgorithm Property (SFTPServer Class)
The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP).
Syntax
int GetUserOtpAlgorithm(int iUserIndex);
int SetUserOtpAlgorithm(int iUserIndex, int iUserOtpAlgorithm);
Possible Values
OA_NONE(0),
OA_HMAC(1),
OA_TIME(2)
Default Value
0
Remarks
The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value.
oaHmac | 0 | |
oaTime | 1 |
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Integer
UserOtpValue Property (SFTPServer Class)
The user's time interval (TOTP) or Counter (HOTP).
Syntax
int GetUserOtpValue(int iUserIndex);
int SetUserOtpValue(int iUserIndex, int iUserOtpValue);
Default Value
0
Remarks
The user's time interval (TOTP) or Counter (HOTP).
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Integer
UserOutgoingSpeedLimit Property (SFTPServer Class)
Specifies the outgoing speed limit for this user.
Syntax
int GetUserOutgoingSpeedLimit(int iUserIndex);
int SetUserOutgoingSpeedLimit(int iUserIndex, int iUserOutgoingSpeedLimit);
Default Value
0
Remarks
Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Integer
UserPassword Property (SFTPServer Class)
The user's authentication password.
Syntax
QString GetUserPassword(int iUserIndex);
int SetUserPassword(int iUserIndex, QString qsUserPassword);
Default Value
""
Remarks
The user's authentication password.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
String
UserPasswordLen Property (SFTPServer Class)
Specifies the length of the user's OTP password.
Syntax
int GetUserPasswordLen(int iUserIndex);
int SetUserPasswordLen(int iUserIndex, int iUserPasswordLen);
Default Value
0
Remarks
Specifies the length of the user's OTP password.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Integer
UserSharedSecret Property (SFTPServer Class)
Contains the user's secret key, which is essentially a shared secret between the client and server.
Syntax
QByteArray GetUserSharedSecret(int iUserIndex);
int SetUserSharedSecret(int iUserIndex, QByteArray qbaUserSharedSecret);
Remarks
Contains the user's secret key, which is essentially a shared secret between the client and server.
Shared secrets can be used in TLS-driven protocols, as well as in OTP (where it is called a 'key secret') for generating one-time passwords on one side, and validate them on the other.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Byte Array
UserSSHKey Property (SFTPServer Class)
Contains the user's SSH key.
Syntax
QByteArray GetUserSSHKey(int iUserIndex);
int SetUserSSHKey(int iUserIndex, QByteArray qbaUserSSHKey);
Remarks
Contains the user's SSH key.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Byte Array
UserUsername Property (SFTPServer Class)
The registered name (login) of the user.
Syntax
QString GetUserUsername(int iUserIndex);
int SetUserUsername(int iUserIndex, QString qsUserUsername);
Default Value
""
Remarks
The registered name (login) of the user.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
String
UseUTF8 Property (SFTPServer Class)
Specifies whether UTF8 conversion is to be used when parsing file names.
Syntax
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
Config Method (SFTPServer Class)
Sets or retrieves a configuration setting.
Syntax
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
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
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 of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Error Handling
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
int DropClient(int iConnectionId, 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
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
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
This method returns a Byte Array 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.
GetClientFileEntry Method (SFTPServer Class)
Acquires file entry details from the class.
Syntax
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
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
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
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
int PinClient(int iConnectionId);
Remarks
Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient property.
Error Handling
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
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
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
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
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
int Start();
Remarks
Call this method to start listening to incoming connections.
Error Handling
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
int Stop();
Remarks
Call this method to close all connections and stop listening to clients.
Error Handling
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
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
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:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
AfterRemove Event (SFTPServer Class)
This event indicates completion of file removal request.
Syntax
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:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
AfterRenameFile Event (SFTPServer Class)
This event indicates completion of a file rename operation.
Syntax
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:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
AfterRequestAttributes Event (SFTPServer Class)
This event indicates completion of file attributes request.
Syntax
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:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
AfterSetAttributes Event (SFTPServer Class)
This event indicates completion of a set attributes request.
Syntax
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:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
AuthAttempt Event (SFTPServer Class)
Reports a user authentication attempt.
Syntax
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:
atRhosts | 0x01 | RHOSTS file authentication. Rarely used today. |
atPublicKey | 0x02 | Public key (sometimes called private key) authentication |
atPassword | 0x04 | Password-based authentication |
atHostbased | 0x08 | Hostbased authentication |
atKeyboard | 0x10 | Keyboard-interactive authentication. This is often used in place of generic password authentication. |
atGssWithMic | 0x20 | GSS authentication |
atGssKeyex | 0x40 | GSS authentication with key exchange |
atPublicKeyAgent | 0x80 | Public key agent authentication |
AuthFailed Event (SFTPServer Class)
Reports user authentication failure.
Syntax
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:
atRhosts | 0x01 | RHOSTS file authentication. Rarely used today. |
atPublicKey | 0x02 | Public key (sometimes called private key) authentication |
atPassword | 0x04 | Password-based authentication |
atHostbased | 0x08 | Hostbased authentication |
atKeyboard | 0x10 | Keyboard-interactive authentication. This is often used in place of generic password authentication. |
atGssWithMic | 0x20 | GSS authentication |
atGssKeyex | 0x40 | GSS authentication with key exchange |
atPublicKeyAgent | 0x80 | Public key agent authentication |
AuthPassword Event (SFTPServer Class)
This event is fired on password authentication attempt from a client.
Syntax
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
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
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:
atRhosts | 0x01 | RHOSTS file authentication. Rarely used today. |
atPublicKey | 0x02 | Public key (sometimes called private key) authentication |
atPassword | 0x04 | Password-based authentication |
atHostbased | 0x08 | Hostbased authentication |
atKeyboard | 0x10 | Keyboard-interactive authentication. This is often used in place of generic password authentication. |
atGssWithMic | 0x20 | GSS authentication |
atGssKeyex | 0x40 | GSS authentication with key exchange |
atPublicKeyAgent | 0x80 | Public key agent authentication |
BeforeCreateDirectory Event (SFTPServer Class)
This event is fired when a client requests to create a directory.
Syntax
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:
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
BeforeDownloadFile Event (SFTPServer Class)
This event is fired when a download file request is received.
Syntax
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:
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
BeforeFind Event (SFTPServer Class)
This event is fired when a client requests to find files and folders in Path.
Syntax
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:
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
BeforeRemove Event (SFTPServer Class)
This event is fired when a client requests to delete a file or directory.
Syntax
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:
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
BeforeRenameFile Event (SFTPServer Class)
This event is fired when a client requests to rename a file.
Syntax
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:
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
BeforeRequestAttributes Event (SFTPServer Class)
This event is fired when a client requests to get file attributes.
Syntax
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:
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
BeforeSetAttributes Event (SFTPServer Class)
This event is fired when a client requests to set file attributes.
Syntax
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:
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
BeforeUploadFile Event (SFTPServer Class)
This event is fired when an upload file request is received.
Syntax
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:
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
CloseFile Event (SFTPServer Class)
This event instructs the application to close an opened file.
Syntax
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:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
Connect Event (SFTPServer Class)
This event is fired when a remote connection has been established.
Syntax
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
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:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
Disconnect Event (SFTPServer Class)
This event is fired when a client has disconnected.
Syntax
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
class SFTPServerErrorEventParams { public: int ErrorCode(); 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
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 component via SignedData parameter.
OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contain algorithm-dependent parameters.
The component uses base16 (hex) encoding for Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.
A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16
FindClose Event (SFTPServer Class)
This event signifies the completion of a custom file listing operation.
Syntax
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:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
FindFirst Event (SFTPServer Class)
This event signifies the start of the custom file listing retrieval mechanism.
Syntax
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,
- set OperationStatus to ostOK,
- fill in ClientFileEntry with the details of the next entry,
- commit the entry to the server using SetClientFileEntry method.
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:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
FindNext Event (SFTPServer Class)
This event retrieves the next entry of a custom file listing.
Syntax
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:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
Notification Event (SFTPServer Class)
This event notifies the application about an underlying control flow event.
Syntax
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 component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
This class can fire this event with the following EventID values:
FileOpen | Notifies 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. |
FileRead | Notifies 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. |
FileWrite | Notifies 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. |
FileClose | Notifies 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. |
OpenShell | Notifies your code about an opened shell tunnel. The EventParam has the following format: ConnectionID=9;LocalChannel=1;RemoteChannel=2 |
OpenCommand | Notifies your code about an opened command tunnel. The
EventParam value has the following format:
ConnectionID=8;LocalChannel=3;RemoteChannel=3;Command=ls -l |
CloseShell | Indicates the closure of a shell tunnel. The EventParam format is the same as with the OpenShell event ID. |
CloseCommand | Indicates the closure of a command tunnel. The EventParam format is the same as with the OpenCommand event ID. |
OpenFile Event (SFTPServer Class)
This event instructs the application to handle the file open request.
Syntax
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:
cfmRead | 1 |
cfmWrite | 2 |
cfmAppend | 4 |
cfmCreate | 8 |
cfmTruncate | 16 |
cfmExcl | 32 |
cfmText | 64 |
cfmOpenOrCreate | 128 |
cfmAppendAtomic | 256 |
cfmNoFollow | 512 |
cfmDeleteOnClose | 1024 |
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:
cfaReadLock | 1 |
cfaWriteLock | 2 |
cfaDeleteLock | 4 |
cfaBlockAdvisory | 8 |
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:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
ReadFile Event (SFTPServer Class)
This event is fired when a file read request is received.
Syntax
class SFTPServerReadFileEventParams { public: qint64 ConnectionID(); const QString &Handle(); int 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:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
Remove Event (SFTPServer Class)
This event is fired when a client requests to delete a file or directory.
Syntax
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:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
RenameFile Event (SFTPServer Class)
This event is fired when a client requests to rename a file.
Syntax
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:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
RequestAttributes Event (SFTPServer Class)
This event is fired when a get file attributes request is received.
Syntax
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:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
SessionClosed Event (SFTPServer Class)
Reports session closure.
Syntax
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
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
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:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
WriteFile Event (SFTPServer Class)
This event is fired when a file write request is received.
Syntax
class SFTPServerWriteFileEventParams { public: qint64 ConnectionID(); const QString &Handle(); int 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:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
Configuration 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 Configuration Settings | ||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||
DualStack: Allows the use of ip4 and ip6 simultaneously.This setting specifies a socket can use ip4 and ip6 simultaneously. | ||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||
Base Configuration Settings | ||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||
Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).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. | ||||||||||||||||||||||||||||||
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". | ||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||
LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
||||||||||||||||||||||||||||||
LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||
Tag: Allows to store any custom data.Use this config property to store any custom data. | ||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||
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)
SFTPServer Errors
1048577 Invalid parameter value (SB_ERROR_INVALID_PARAMETER) | |
1048578 Class is configured incorrectly (SB_ERROR_INVALID_SETUP) | |
1048579 Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE) | |
1048580 Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE) | |
1048581 Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY) | |
1048581 Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) | |
31457281 Unsupported file operation (SB_ERROR_SFTP_UNSUPPORTED_FILEOPERATION) |