FTPServer Class
Properties Methods Events Configuration Settings Errors
The FTPServer class provides server-side functionality for FTP and FTPS protocols.
Syntax
FTPServer
Remarks
FTPServer supports FTP (File Transfer Protocol) and FTPS (FTP-over-SSL) protocols. The FTPS protocol allows you to securely perform file transfer operations on the server over Transport Layer Security (TLS). TLS is a successor to the now deprecated SSL protocol, although the latter abbreviation is still widely used.
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 | Whether the server is active and can accept incoming connections. |
AllowAnonymous | Allows and disallows anonymous connections. |
ClientFileEntryEntryFormat | The file listing format: cfefUnknown 0 cfefUnix 1 cfefWindows 2 cfefMLSD 3 . |
ClientFileEntryFileDate | File last modification date. |
ClientFileEntryFileType | The type of the entry: cfetUnknown 0 cfetDirectory 1 cfetFile 2 cfetSymlink 3 cfetSpecial 4 cfetCurrentDirectory 5 cfetParentDirectory 6 . |
ClientFileEntryHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
ClientFileEntryName | The file or directory name. |
ClientFileEntryPath | The full path to the file or directory. |
ClientFileEntryRawData | The unparsed entry as returned by the server. |
ClientFileEntrySize | File size in bytes. |
DataHost | Host address for incoming data channel connections. |
DataPortRangeFrom | Specifies the lower port range bound for passive mode data connections. |
DataPortRangeTo | Specifies the upper port range bound for passive mode data connections. |
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. |
HandshakeTimeout | Specifies the handshake timeout in milliseconds. |
Host | Specifies the server host. |
ImplicitSSL | Enables or disables implicit SSL mode. |
PassiveModeHost | The IP address of the passive mode host. |
PinnedClientAddress | The client's IP address. |
PinnedClientChainValidationDetails | The details of a certificate chain validation outcome. |
PinnedClientChainValidationResult | The outcome of a certificate chain validation routine. |
PinnedClientCiphersuite | The cipher suite employed by this connection. |
PinnedClientClientAuthenticated | Specifies whether client authentication was performed during this connection. |
PinnedClientDigestAlgorithm | The digest algorithm used in a TLS-enabled connection. |
PinnedClientEncryptionAlgorithm | The symmetric encryption algorithm used in a TLS-enabled connection. |
PinnedClientID | The client connection's unique identifier. |
PinnedClientKeyExchangeAlgorithm | The key exchange algorithm used in a TLS-enabled connection. |
PinnedClientKeyExchangeKeyBits | The length of the key exchange key of a TLS-enabled connection. |
PinnedClientNamedECCurve | The elliptic curve used in this connection. |
PinnedClientPFSCipher | Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). |
PinnedClientPort | The remote port of the client connection. |
PinnedClientPreSharedIdentity | Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
PinnedClientPublicKeyBits | The length of the public key. |
PinnedClientResumedSession | Indicates whether a TLS-enabled connection was spawned from another TLS connection. |
PinnedClientSecureConnection | Indicates whether TLS or SSL is enabled for this connection. |
PinnedClientSignatureAlgorithm | The signature algorithm used in a TLS handshake. |
PinnedClientSymmetricBlockSize | The block size of the symmetric algorithm used. |
PinnedClientSymmetricKeyBits | The key length of the symmetric algorithm used. |
PinnedClientTotalBytesReceived | The total number of bytes received over this connection. |
PinnedClientTotalBytesSent | The total number of bytes sent over this connection. |
PinnedClientValidationLog | Contains the server certificate's chain validation log. |
PinnedClientVersion | Indicates the version of SSL/TLS protocol negotiated during this connection. |
PinnedClientCertCount | The number of records in the PinnedClientCert arrays. |
PinnedClientCertBytes | Returns raw certificate data in DER format. |
PinnedClientCertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
PinnedClientCertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
PinnedClientCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
PinnedClientCertIssuer | The common name of the certificate issuer (CA), typically a company name. |
PinnedClientCertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
PinnedClientCertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
PinnedClientCertKeyBits | Returns the length of the public key. |
PinnedClientCertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
PinnedClientCertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
PinnedClientCertPublicKeyBytes | Contains the certificate's public key in DER format. |
PinnedClientCertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
PinnedClientCertSerialNumber | Returns the certificate's serial number. |
PinnedClientCertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
PinnedClientCertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
PinnedClientCertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
PinnedClientCertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
PinnedClientCertValidFrom | The time point at which the certificate becomes valid, in UTC. |
PinnedClientCertValidTo | The time point at which the certificate expires, in UTC. |
Port | The port number to listen for incoming connections on. |
ReadOnly | Makes the server's file system read-only for all users. |
RootDirectory | Specifies the server's root directory. |
SecurityOptions | Various options of the secure connection. |
ServerCertCount | The number of records in the ServerCert arrays. |
ServerCertBytes | Returns raw certificate data in DER format. |
ServerCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
SessionTimeout | Specifies the session timeout in milliseconds. |
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. |
TLSAutoValidateCertificates | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
TLSBaseConfiguration | Selects the base configuration for the TLS settings. |
TLSCiphersuites | A list of ciphersuites separated with commas or semicolons. |
TLSECCurves | Defines the elliptic curves to enable. |
TLSExtensions | Provides access to TLS extensions. |
TLSForceResumeIfDestinationChanges | Whether to force TLS session resumption when the destination address changes. |
TLSPreSharedIdentity | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
TLSPreSharedKey | Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
TLSPreSharedKeyCiphersuite | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
TLSRenegotiationAttackPreventionMode | Selects renegotiation attack prevention mechanism. |
TLSRevocationCheck | Specifies the kind(s) of revocation check to perform. |
TLSSSLOptions | Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size. |
TLSTLSMode | Specifies the TLS mode to use. |
TLSUseExtendedMasterSecret | Enables Extended Master Secret Extension, as defined in RFC 7627. |
TLSUseSessionResumption | Enables or disables TLS session resumption capability. |
TLSVersions | Th SSL/TLS versions to enable by default. |
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. |
UserOutgoingSpeedLimit | Specifies the outgoing speed limit for this user. |
UserPassword | The user's authentication password. |
UserSharedSecret | Contains the user's secret key, which is essentially a shared secret between the client and server. |
UserUsername | The registered name (login) of the user. |
UseUTF8 | Enables or disables UTF8 file name conversions. |
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 | Obtains a pending connection buffer. |
ListClients | Enumerates the connected clients. |
PinClient | Takes a snapshot of the connection's properties. |
SetClientBuffer | Commits a data buffer to the connection. |
SetClientFileEntry | Commits a file entry to the connection. |
Start | Starts the server. |
Stop | Stops the 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 | Reports an incoming connection. |
AfterChangeDirectory | Signals the completion of a directory change operation. |
AfterCreateDirectory | Signals the completion of a directory creation operation. |
AfterRemoveDirectory | Signals the completion of a directory removal operation. |
AfterRemoveFile | Signals the completion of a file removal operation. |
AfterRenameFile | Signals the completion of a file renaming operation. |
AfterRequestAttributes | Signals the completion of an attribute request. |
AuthAttempt | Fires when a connected client makes an authentication attempt. |
BeforeChangeDirectory | Notifies about an incoming change directory request. |
BeforeCreateDirectory | Notifies about an incoming create directory request. |
BeforeDownloadFile | Notifies about an incoming file download request. |
BeforeFind | Notifies about an incoming file listing request. |
BeforeRemoveDirectory | Notifies about an incoming directory removal request. |
BeforeRemoveFile | Notifies about an incoming file removal request. |
BeforeRenameFile | Notifies about an incoming file rename request. |
BeforeRequestAttributes | Notifies about an incoming attributes request. |
BeforeSendReply | Notifies the application of a command reply being sent. |
BeforeUploadFile | Notifies about an incoming file upload request. |
CertificateValidate | Fires when a client certificate needs to be validated. |
ChangeDirectory | An override for a directory change operation. |
CommandProcessed | Signals that a command has been processed by the server. |
CommandReceived | Signals that a command has been received from the client. |
Connect | Reports an accepted connection. |
CreateDirectory | An override for a directory creation operation. |
Disconnect | Fires to report a disconnected client. |
DownloadBegin | TBD. |
DownloadEnd | TBD. |
DownloadFile | An override for a file download initiation operation. |
DownloadProgress | TBD. |
Error | Information about errors during data delivery. |
ExternalSign | Handles remote or external signing initiated by the server protocol. |
FindClose | Signals the completion of a directory listing request. |
FindInit | An override for a directory listing initiation operation. |
FindNext | An override for a directory listing entry request operation. |
Notification | This event notifies the application about an underlying control flow event. |
ReadFile | Requests a piece of file data from the application. |
RemoveDirectory | An override for a directory removal operation. |
RemoveFile | An override for a file remove operation. |
RenameFile | An override for a file rename operation. |
RequestAttributes | An override for an attribute request. |
TransferCompleted | This event is fired when a customized upload or download operation completes. |
UploadBegin | TBD. |
UploadEnd | TBD. |
UploadFile | An override for a file upload initiation operation. |
UploadProgress | TBD. |
WriteFile | Hands a piece of file data to the application. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
ActiveChannel | The channel to which the event that is being invoked corresponds. |
ClientAuth | Enables or disables certificate-based client authentication. |
DualStack | Allows the use of IPv4 and IPv6 simultaneously. |
RefreshUsers | Enables or disables real-time propagation of user information. |
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 (FTPServer Class)
Whether the server is active and can accept incoming connections.
Syntax
bool GetActive();
Default Value
false
Remarks
This read-only property returns True if the FTPS server is running and listening for incoming connections, and False otherwise.
This property is read-only and not available at design time.
Data Type
Boolean
AllowAnonymous Property (FTPServer Class)
Allows and disallows anonymous connections.
Syntax
bool GetAllowAnonymous();
int SetAllowAnonymous(bool bAllowAnonymous);
Default Value
false
Remarks
Use this property to enable and disable support for anonymous connections.
Data Type
Boolean
ClientFileEntryEntryFormat Property (FTPServer Class)
The file listing format: cfefUnknown 0 cfefUnix 1 cfefWindows 2 cfefMLSD 3 .
Syntax
int GetClientFileEntryEntryFormat();
int SetClientFileEntryEntryFormat(int iClientFileEntryEntryFormat);
Possible Values
CFEF_UNKNOWN(0),
CFEF_UNIX(1),
CFEF_WINDOWS(2),
CFEF_MLSD(3)
Default Value
0
Remarks
The file listing format:
cfefUnknown | 0 |
cfefUnix | 1 |
cfefWindows | 2 |
cfefMLSD | 3 |
This property is not available at design time.
Data Type
Integer
ClientFileEntryFileDate Property (FTPServer Class)
File last modification date.
Syntax
QString GetClientFileEntryFileDate();
int SetClientFileEntryFileDate(QString qsClientFileEntryFileDate);
Default Value
""
Remarks
File last modification date.
This property is not available at design time.
Data Type
String
ClientFileEntryFileType Property (FTPServer Class)
The type of the entry: cfetUnknown 0 cfetDirectory 1 cfetFile 2 cfetSymlink 3 cfetSpecial 4 cfetCurrentDirectory 5 cfetParentDirectory 6 .
Syntax
int GetClientFileEntryFileType();
int SetClientFileEntryFileType(int iClientFileEntryFileType);
Possible Values
CFET_UNKNOWN(0),
CFET_DIRECTORY(1),
CFET_FILE(2),
CFET_SYMLINK(3),
CFET_SPECIAL(4),
CFET_CURRENT_DIRECTORY(5),
CFET_PARENT_DIRECTORY(6)
Default Value
0
Remarks
The type of the entry:
cfetUnknown | 0 |
cfetDirectory | 1 |
cfetFile | 2 |
cfetSymlink | 3 |
cfetSpecial | 4 |
cfetCurrentDirectory | 5 |
cfetParentDirectory | 6 |
This property is not available at design time.
Data Type
Integer
ClientFileEntryHandle Property (FTPServer 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
ClientFileEntryName Property (FTPServer Class)
The file or directory name.
Syntax
QString GetClientFileEntryName();
int SetClientFileEntryName(QString qsClientFileEntryName);
Default Value
""
Remarks
The file or directory name.
This property is not available at design time.
Data Type
String
ClientFileEntryPath Property (FTPServer Class)
The full path to the file or directory.
Syntax
QString GetClientFileEntryPath();
int SetClientFileEntryPath(QString qsClientFileEntryPath);
Default Value
""
Remarks
The full path to the file or directory.
This property is not available at design time.
Data Type
String
ClientFileEntryRawData Property (FTPServer Class)
The unparsed entry as returned by the server.
Syntax
QString GetClientFileEntryRawData();
int SetClientFileEntryRawData(QString qsClientFileEntryRawData);
Default Value
""
Remarks
The unparsed entry as returned by the server.
This property is not available at design time.
Data Type
String
ClientFileEntrySize Property (FTPServer Class)
File size in bytes.
Syntax
qint64 GetClientFileEntrySize();
int SetClientFileEntrySize(qint64 lClientFileEntrySize);
Default Value
0
Remarks
File size in bytes.
This property is not available at design time.
Data Type
Long64
DataHost Property (FTPServer Class)
Host address for incoming data channel connections.
Syntax
QString GetDataHost();
int SetDataHost(QString qsDataHost);
Default Value
""
Remarks
Use this property to specify the address for incoming data channel connections, if it is different to Host.
In some network environments, in particular, where the server is behind a NAT, there may be a requirement to use a different host address for data connections.
Data Type
String
DataPortRangeFrom Property (FTPServer Class)
Specifies the lower port range bound for passive mode data connections.
Syntax
int GetDataPortRangeFrom();
int SetDataPortRangeFrom(int iDataPortRangeFrom);
Default Value
0
Remarks
Use this property in combination with DataPortRangeT to limit the port range for passive mode data connections. The value of 0 (zero) stands for no lower bound.
Data Type
Integer
DataPortRangeTo Property (FTPServer Class)
Specifies the upper port range bound for passive mode data connections.
Syntax
int GetDataPortRangeTo();
int SetDataPortRangeTo(int iDataPortRangeTo);
Default Value
0
Remarks
Use this property in combination with DataPortRangeFrom to limit the port range for passive mode data connections. The value of 0 (zero) stands for no upper bound.
Data Type
Integer
ExternalCryptoAsyncDocumentID Property (FTPServer 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 (FTPServer 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 (FTPServer 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 (FTPServer 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 (FTPServer 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 (FTPServer 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 (FTPServer 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 (FTPServer 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 (FTPServer 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 (FTPServer 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 (FTPServer Class)
Reserved.
Syntax
bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);
Default Value
false
Remarks
This property is reserved for future use.
Data Type
Boolean
HandshakeTimeout Property (FTPServer Class)
Specifies the handshake timeout in milliseconds.
Syntax
int GetHandshakeTimeout();
int SetHandshakeTimeout(int iHandshakeTimeout);
Default Value
20000
Remarks
Use this property to set the TLS handshake timeout.
Data Type
Integer
Host Property (FTPServer Class)
Specifies the server host.
Syntax
QString GetHost();
int SetHost(QString qsHost);
Default Value
""
Remarks
Use this property to specify the IP address on which to listen for incoming FTP connections. Use Port to specify the listening port number.
Data Type
String
ImplicitSSL Property (FTPServer Class)
Enables or disables implicit SSL mode.
Syntax
bool GetImplicitSSL();
int SetImplicitSSL(bool bImplicitSSL);
Default Value
false
Remarks
The server can only work in one mode, explicit or implicit. Explicit mode, also called AUTH TLS, supports both TLS and plain connections. Implicit mode, also called 'dedicated port mode,' only supports TLS connections.
Data Type
Boolean
PassiveModeHost Property (FTPServer Class)
The IP address of the passive mode host.
Syntax
QString GetPassiveModeHost();
int SetPassiveModeHost(QString qsPassiveModeHost);
Default Value
""
Remarks
Use this property to specify the address on which to listen for passive mode connections.
Data Type
String
PinnedClientAddress Property (FTPServer 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
PinnedClientChainValidationDetails Property (FTPServer Class)
The details of a certificate chain validation outcome.
Syntax
int GetPinnedClientChainValidationDetails();
Default Value
0
Remarks
The details of a certificate chain validation outcome. They may often suggest what reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientChainValidationResult Property (FTPServer Class)
The outcome of a certificate chain validation routine.
Syntax
int GetPinnedClientChainValidationResult();
Possible Values
CVT_VALID(0),
CVT_VALID_BUT_UNTRUSTED(1),
CVT_INVALID(2),
CVT_CANT_BE_ESTABLISHED(3)
Default Value
0
Remarks
The outcome of a certificate chain validation routine.
Available options:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientCiphersuite Property (FTPServer Class)
The cipher suite employed by this connection.
Syntax
QString GetPinnedClientCiphersuite();
Default Value
""
Remarks
The cipher suite employed by this connection.
For TLS connections, this property returns the ciphersuite that was/is employed by the connection.
This property is read-only and not available at design time.
Data Type
String
PinnedClientClientAuthenticated Property (FTPServer Class)
Specifies whether client authentication was performed during this connection.
Syntax
bool GetPinnedClientClientAuthenticated();
Default Value
false
Remarks
Specifies whether client authentication was performed during this connection.
This property is read-only and not available at design time.
Data Type
Boolean
PinnedClientDigestAlgorithm Property (FTPServer Class)
The digest algorithm used in a TLS-enabled connection.
Syntax
QString GetPinnedClientDigestAlgorithm();
Default Value
""
Remarks
The digest algorithm used in a TLS-enabled connection.
This property is read-only and not available at design time.
Data Type
String
PinnedClientEncryptionAlgorithm Property (FTPServer Class)
The symmetric encryption algorithm used in a TLS-enabled connection.
Syntax
QString GetPinnedClientEncryptionAlgorithm();
Default Value
""
Remarks
The symmetric encryption algorithm used in a TLS-enabled connection.
This property is read-only and not available at design time.
Data Type
String
PinnedClientID Property (FTPServer 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
PinnedClientKeyExchangeAlgorithm Property (FTPServer Class)
The key exchange algorithm used in a TLS-enabled connection.
Syntax
QString GetPinnedClientKeyExchangeAlgorithm();
Default Value
""
Remarks
The key exchange algorithm used in a TLS-enabled connection.
This property is read-only and not available at design time.
Data Type
String
PinnedClientKeyExchangeKeyBits Property (FTPServer Class)
The length of the key exchange key of a TLS-enabled connection.
Syntax
int GetPinnedClientKeyExchangeKeyBits();
Default Value
0
Remarks
The length of the key exchange key of a TLS-enabled connection.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientNamedECCurve Property (FTPServer Class)
The elliptic curve used in this connection.
Syntax
QString GetPinnedClientNamedECCurve();
Default Value
""
Remarks
The elliptic curve used in this connection.
This property is read-only and not available at design time.
Data Type
String
PinnedClientPFSCipher Property (FTPServer Class)
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
Syntax
bool GetPinnedClientPFSCipher();
Default Value
false
Remarks
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
This property is read-only and not available at design time.
Data Type
Boolean
PinnedClientPort Property (FTPServer 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
PinnedClientPreSharedIdentity Property (FTPServer Class)
Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Syntax
QString GetPinnedClientPreSharedIdentity();
Default Value
""
Remarks
Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
This property is read-only and not available at design time.
Data Type
String
PinnedClientPublicKeyBits Property (FTPServer Class)
The length of the public key.
Syntax
int GetPinnedClientPublicKeyBits();
Default Value
0
Remarks
The length of the public key.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientResumedSession Property (FTPServer Class)
Indicates whether a TLS-enabled connection was spawned from another TLS connection.
Syntax
bool GetPinnedClientResumedSession();
Default Value
false
Remarks
Indicates whether a TLS-enabled connection was spawned from another TLS connection
This property is read-only and not available at design time.
Data Type
Boolean
PinnedClientSecureConnection Property (FTPServer Class)
Indicates whether TLS or SSL is enabled for this connection.
Syntax
bool GetPinnedClientSecureConnection();
Default Value
false
Remarks
Indicates whether TLS or SSL is enabled for this connection.
This property is read-only and not available at design time.
Data Type
Boolean
PinnedClientSignatureAlgorithm Property (FTPServer Class)
The signature algorithm used in a TLS handshake.
Syntax
QString GetPinnedClientSignatureAlgorithm();
Default Value
""
Remarks
The signature algorithm used in a TLS handshake.
This property is read-only and not available at design time.
Data Type
String
PinnedClientSymmetricBlockSize Property (FTPServer Class)
The block size of the symmetric algorithm used.
Syntax
int GetPinnedClientSymmetricBlockSize();
Default Value
0
Remarks
The block size of the symmetric algorithm used.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientSymmetricKeyBits Property (FTPServer Class)
The key length of the symmetric algorithm used.
Syntax
int GetPinnedClientSymmetricKeyBits();
Default Value
0
Remarks
The key length of the symmetric algorithm used.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientTotalBytesReceived Property (FTPServer Class)
The total number of bytes received over this connection.
Syntax
qint64 GetPinnedClientTotalBytesReceived();
Default Value
0
Remarks
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 (FTPServer Class)
The total number of bytes sent over this connection.
Syntax
qint64 GetPinnedClientTotalBytesSent();
Default Value
0
Remarks
The total number of bytes sent over this connection.
This property is read-only and not available at design time.
Data Type
Long64
PinnedClientValidationLog Property (FTPServer Class)
Contains the server certificate's chain validation log.
Syntax
QString GetPinnedClientValidationLog();
Default Value
""
Remarks
Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.
This property is read-only and not available at design time.
Data Type
String
PinnedClientVersion Property (FTPServer Class)
Indicates the version of SSL/TLS protocol negotiated during this connection.
Syntax
QString GetPinnedClientVersion();
Default Value
""
Remarks
Indicates the version of SSL/TLS protocol negotiated during this connection.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertCount Property (FTPServer Class)
The number of records in the PinnedClientCert arrays.
Syntax
int GetPinnedClientCertCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- PinnedClientCertBytes
- PinnedClientCertCAKeyID
- PinnedClientCertFingerprint
- PinnedClientCertHandle
- PinnedClientCertIssuer
- PinnedClientCertIssuerRDN
- PinnedClientCertKeyAlgorithm
- PinnedClientCertKeyBits
- PinnedClientCertKeyFingerprint
- PinnedClientCertKeyUsage
- PinnedClientCertPublicKeyBytes
- PinnedClientCertSelfSigned
- PinnedClientCertSerialNumber
- PinnedClientCertSigAlgorithm
- PinnedClientCertSubject
- PinnedClientCertSubjectKeyID
- PinnedClientCertSubjectRDN
- PinnedClientCertValidFrom
- PinnedClientCertValidTo
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientCertBytes Property (FTPServer Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetPinnedClientCertBytes(int iPinnedClientCertIndex);
Remarks
Returns raw certificate data in DER format.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
PinnedClientCertCAKeyID Property (FTPServer Class)
A unique identifier (fingerprint) of the CA certificate's private key.
Syntax
QByteArray GetPinnedClientCertCAKeyID(int iPinnedClientCertIndex);
Remarks
A unique identifier (fingerprint) of the CA certificate's private key.
Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
PinnedClientCertFingerprint Property (FTPServer Class)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
QByteArray GetPinnedClientCertFingerprint(int iPinnedClientCertIndex);
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
PinnedClientCertHandle Property (FTPServer Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetPinnedClientCertHandle(int iPinnedClientCertIndex);
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 PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Long64
PinnedClientCertIssuer Property (FTPServer Class)
The common name of the certificate issuer (CA), typically a company name.
Syntax
QString GetPinnedClientCertIssuer(int iPinnedClientCertIndex);
Default Value
""
Remarks
The common name of the certificate issuer (CA), typically a company name.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertIssuerRDN Property (FTPServer Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
Syntax
QString GetPinnedClientCertIssuerRDN(int iPinnedClientCertIndex);
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertKeyAlgorithm Property (FTPServer Class)
Specifies the public key algorithm of this certificate.
Syntax
QString GetPinnedClientCertKeyAlgorithm(int iPinnedClientCertIndex);
Default Value
"0"
Remarks
Specifies the public key algorithm of this certificate.
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 |
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertKeyBits Property (FTPServer Class)
Returns the length of the public key.
Syntax
int GetPinnedClientCertKeyBits(int iPinnedClientCertIndex);
Default Value
0
Remarks
Returns the length of the public key.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientCertKeyFingerprint Property (FTPServer Class)
Returns a fingerprint of the public key contained in the certificate.
Syntax
QByteArray GetPinnedClientCertKeyFingerprint(int iPinnedClientCertIndex);
Remarks
Returns a fingerprint of the public key contained in the certificate.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
PinnedClientCertKeyUsage Property (FTPServer Class)
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
int GetPinnedClientCertKeyUsage(int iPinnedClientCertIndex);
Default Value
0
Remarks
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
ckuUnknown | 0x00000 | Unknown key usage |
ckuDigitalSignature | 0x00001 | Digital signature |
ckuNonRepudiation | 0x00002 | Non-repudiation |
ckuKeyEncipherment | 0x00004 | Key encipherment |
ckuDataEncipherment | 0x00008 | Data encipherment |
ckuKeyAgreement | 0x00010 | Key agreement |
ckuKeyCertSign | 0x00020 | Certificate signing |
ckuCRLSign | 0x00040 | Revocation signing |
ckuEncipherOnly | 0x00080 | Encipher only |
ckuDecipherOnly | 0x00100 | Decipher only |
ckuServerAuthentication | 0x00200 | Server authentication |
ckuClientAuthentication | 0x00400 | Client authentication |
ckuCodeSigning | 0x00800 | Code signing |
ckuEmailProtection | 0x01000 | Email protection |
ckuTimeStamping | 0x02000 | Timestamping |
ckuOCSPSigning | 0x04000 | OCSP signing |
ckuSmartCardLogon | 0x08000 | Smartcard logon |
ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientCertPublicKeyBytes Property (FTPServer Class)
Contains the certificate's public key in DER format.
Syntax
QByteArray GetPinnedClientCertPublicKeyBytes(int iPinnedClientCertIndex);
Remarks
Contains the certificate's public key in DER format.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
PinnedClientCertSelfSigned Property (FTPServer Class)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
bool GetPinnedClientCertSelfSigned(int iPinnedClientCertIndex);
Default Value
false
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
PinnedClientCertSerialNumber Property (FTPServer Class)
Returns the certificate's serial number.
Syntax
QByteArray GetPinnedClientCertSerialNumber(int iPinnedClientCertIndex);
Remarks
Returns the certificate's serial number.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
PinnedClientCertSigAlgorithm Property (FTPServer Class)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
QString GetPinnedClientCertSigAlgorithm(int iPinnedClientCertIndex);
Default Value
""
Remarks
Indicates the algorithm that was used by the CA to sign this certificate.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertSubject Property (FTPServer Class)
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
QString GetPinnedClientCertSubject(int iPinnedClientCertIndex);
Default Value
""
Remarks
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertSubjectKeyID Property (FTPServer Class)
Contains a unique identifier (fingerprint) of the certificate's private key.
Syntax
QByteArray GetPinnedClientCertSubjectKeyID(int iPinnedClientCertIndex);
Remarks
Contains a unique identifier (fingerprint) of the certificate's private key.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
PinnedClientCertSubjectRDN Property (FTPServer Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
Syntax
QString GetPinnedClientCertSubjectRDN(int iPinnedClientCertIndex);
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertValidFrom Property (FTPServer Class)
The time point at which the certificate becomes valid, in UTC.
Syntax
QString GetPinnedClientCertValidFrom(int iPinnedClientCertIndex);
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertValidTo Property (FTPServer Class)
The time point at which the certificate expires, in UTC.
Syntax
QString GetPinnedClientCertValidTo(int iPinnedClientCertIndex);
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
Port Property (FTPServer Class)
The port number to listen for incoming connections on.
Syntax
int GetPort();
int SetPort(int iPort);
Default Value
21
Remarks
Use this property to specify the port number to listen for incoming connections on.
Data Type
Integer
ReadOnly Property (FTPServer Class)
Makes the server's file system read-only for all users.
Syntax
bool GetReadOnly();
int SetReadOnly(bool bReadOnly);
Default Value
false
Remarks
Set this property to true to present the server's file system as read-only for all connecting users.
Data Type
Boolean
RootDirectory Property (FTPServer Class)
Specifies the server's root directory.
Syntax
QString GetRootDirectory();
int SetRootDirectory(QString qsRootDirectory);
Default Value
""
Remarks
Use this property to specify the shared root directory for all client sessions.
Data Type
String
SecurityOptions Property (FTPServer Class)
Various options of the secure connection.
Syntax
int GetSecurityOptions();
int SetSecurityOptions(int iSecurityOptions);
Default Value
0
Remarks
Various options of the secure connection: cfsoPlainLogin = 1; cfsoEncryption = 2; cfsoAuth = 4; cfsoClearControlChannel = 8; cfsoClearDataChannel = 16; cfsoEncryptedDataChannel = 32;
Data Type
Integer
ServerCertCount Property (FTPServer Class)
The number of records in the ServerCert arrays.
Syntax
int GetServerCertCount();
int SetServerCertCount(int iServerCertCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ServerCertCount - 1.This property is not available at design time.
Data Type
Integer
ServerCertBytes Property (FTPServer Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetServerCertBytes(int iServerCertIndex);
Remarks
Returns raw certificate data in DER format.
The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
ServerCertHandle Property (FTPServer Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetServerCertHandle(int iServerCertIndex);
int SetServerCertHandle(int iServerCertIndex, qint64 lServerCertHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.
This property is not available at design time.
Data Type
Long64
SessionTimeout Property (FTPServer Class)
Specifies the session timeout in milliseconds.
Syntax
int GetSessionTimeout();
int SetSessionTimeout(int iSessionTimeout);
Default Value
360000
Remarks
Specifies the maximum inactivity time (in milliseconds) after which the session will be forcebly closed.
Data Type
Integer
SocketIncomingSpeedLimit Property (FTPServer 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 (FTPServer 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 (FTPServer 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 (FTPServer 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 (FTPServer 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 (FTPServer 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
TLSAutoValidateCertificates Property (FTPServer Class)
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Syntax
bool GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(bool bTLSAutoValidateCertificates);
Default Value
true
Remarks
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Data Type
Boolean
TLSBaseConfiguration Property (FTPServer Class)
Selects the base configuration for the TLS settings.
Syntax
int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration);
Possible Values
STPC_DEFAULT(0),
STPC_COMPATIBLE(1),
STPC_COMPREHENSIVE_INSECURE(2),
STPC_HIGHLY_SECURE(3)
Default Value
0
Remarks
Selects the base configuration for the TLS settings. Several profiles are on offer, tuned up for different purposes, such as high security or higher compatibility.
stpcDefault | 0 | |
stpcCompatible | 1 | |
stpcComprehensiveInsecure | 2 | |
stpcHighlySecure | 3 |
Data Type
Integer
TLSCiphersuites Property (FTPServer Class)
A list of ciphersuites separated with commas or semicolons.
Syntax
QString GetTLSCiphersuites();
int SetTLSCiphersuites(QString qsTLSCiphersuites);
Default Value
""
Remarks
A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases that allow to blanketly enable or disable all ciphersuites at once.
Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
- NULL_NULL_NULL
- RSA_NULL_MD5
- RSA_NULL_SHA
- RSA_RC4_MD5
- RSA_RC4_SHA
- RSA_RC2_MD5
- RSA_IDEA_MD5
- RSA_IDEA_SHA
- RSA_DES_MD5
- RSA_DES_SHA
- RSA_3DES_MD5
- RSA_3DES_SHA
- RSA_AES128_SHA
- RSA_AES256_SHA
- DH_DSS_DES_SHA
- DH_DSS_3DES_SHA
- DH_DSS_AES128_SHA
- DH_DSS_AES256_SHA
- DH_RSA_DES_SHA
- DH_RSA_3DES_SHA
- DH_RSA_AES128_SHA
- DH_RSA_AES256_SHA
- DHE_DSS_DES_SHA
- DHE_DSS_3DES_SHA
- DHE_DSS_AES128_SHA
- DHE_DSS_AES256_SHA
- DHE_RSA_DES_SHA
- DHE_RSA_3DES_SHA
- DHE_RSA_AES128_SHA
- DHE_RSA_AES256_SHA
- DH_ANON_RC4_MD5
- DH_ANON_DES_SHA
- DH_ANON_3DES_SHA
- DH_ANON_AES128_SHA
- DH_ANON_AES256_SHA
- RSA_RC2_MD5_EXPORT
- RSA_RC4_MD5_EXPORT
- RSA_DES_SHA_EXPORT
- DH_DSS_DES_SHA_EXPORT
- DH_RSA_DES_SHA_EXPORT
- DHE_DSS_DES_SHA_EXPORT
- DHE_RSA_DES_SHA_EXPORT
- DH_ANON_RC4_MD5_EXPORT
- DH_ANON_DES_SHA_EXPORT
- RSA_CAMELLIA128_SHA
- DH_DSS_CAMELLIA128_SHA
- DH_RSA_CAMELLIA128_SHA
- DHE_DSS_CAMELLIA128_SHA
- DHE_RSA_CAMELLIA128_SHA
- DH_ANON_CAMELLIA128_SHA
- RSA_CAMELLIA256_SHA
- DH_DSS_CAMELLIA256_SHA
- DH_RSA_CAMELLIA256_SHA
- DHE_DSS_CAMELLIA256_SHA
- DHE_RSA_CAMELLIA256_SHA
- DH_ANON_CAMELLIA256_SHA
- PSK_RC4_SHA
- PSK_3DES_SHA
- PSK_AES128_SHA
- PSK_AES256_SHA
- DHE_PSK_RC4_SHA
- DHE_PSK_3DES_SHA
- DHE_PSK_AES128_SHA
- DHE_PSK_AES256_SHA
- RSA_PSK_RC4_SHA
- RSA_PSK_3DES_SHA
- RSA_PSK_AES128_SHA
- RSA_PSK_AES256_SHA
- RSA_SEED_SHA
- DH_DSS_SEED_SHA
- DH_RSA_SEED_SHA
- DHE_DSS_SEED_SHA
- DHE_RSA_SEED_SHA
- DH_ANON_SEED_SHA
- SRP_SHA_3DES_SHA
- SRP_SHA_RSA_3DES_SHA
- SRP_SHA_DSS_3DES_SHA
- SRP_SHA_AES128_SHA
- SRP_SHA_RSA_AES128_SHA
- SRP_SHA_DSS_AES128_SHA
- SRP_SHA_AES256_SHA
- SRP_SHA_RSA_AES256_SHA
- SRP_SHA_DSS_AES256_SHA
- ECDH_ECDSA_NULL_SHA
- ECDH_ECDSA_RC4_SHA
- ECDH_ECDSA_3DES_SHA
- ECDH_ECDSA_AES128_SHA
- ECDH_ECDSA_AES256_SHA
- ECDHE_ECDSA_NULL_SHA
- ECDHE_ECDSA_RC4_SHA
- ECDHE_ECDSA_3DES_SHA
- ECDHE_ECDSA_AES128_SHA
- ECDHE_ECDSA_AES256_SHA
- ECDH_RSA_NULL_SHA
- ECDH_RSA_RC4_SHA
- ECDH_RSA_3DES_SHA
- ECDH_RSA_AES128_SHA
- ECDH_RSA_AES256_SHA
- ECDHE_RSA_NULL_SHA
- ECDHE_RSA_RC4_SHA
- ECDHE_RSA_3DES_SHA
- ECDHE_RSA_AES128_SHA
- ECDHE_RSA_AES256_SHA
- ECDH_ANON_NULL_SHA
- ECDH_ANON_RC4_SHA
- ECDH_ANON_3DES_SHA
- ECDH_ANON_AES128_SHA
- ECDH_ANON_AES256_SHA
- RSA_NULL_SHA256
- RSA_AES128_SHA256
- RSA_AES256_SHA256
- DH_DSS_AES128_SHA256
- DH_RSA_AES128_SHA256
- DHE_DSS_AES128_SHA256
- DHE_RSA_AES128_SHA256
- DH_DSS_AES256_SHA256
- DH_RSA_AES256_SHA256
- DHE_DSS_AES256_SHA256
- DHE_RSA_AES256_SHA256
- DH_ANON_AES128_SHA256
- DH_ANON_AES256_SHA256
- RSA_AES128_GCM_SHA256
- RSA_AES256_GCM_SHA384
- DHE_RSA_AES128_GCM_SHA256
- DHE_RSA_AES256_GCM_SHA384
- DH_RSA_AES128_GCM_SHA256
- DH_RSA_AES256_GCM_SHA384
- DHE_DSS_AES128_GCM_SHA256
- DHE_DSS_AES256_GCM_SHA384
- DH_DSS_AES128_GCM_SHA256
- DH_DSS_AES256_GCM_SHA384
- DH_ANON_AES128_GCM_SHA256
- DH_ANON_AES256_GCM_SHA384
- ECDHE_ECDSA_AES128_SHA256
- ECDHE_ECDSA_AES256_SHA384
- ECDH_ECDSA_AES128_SHA256
- ECDH_ECDSA_AES256_SHA384
- ECDHE_RSA_AES128_SHA256
- ECDHE_RSA_AES256_SHA384
- ECDH_RSA_AES128_SHA256
- ECDH_RSA_AES256_SHA384
- ECDHE_ECDSA_AES128_GCM_SHA256
- ECDHE_ECDSA_AES256_GCM_SHA384
- ECDH_ECDSA_AES128_GCM_SHA256
- ECDH_ECDSA_AES256_GCM_SHA384
- ECDHE_RSA_AES128_GCM_SHA256
- ECDHE_RSA_AES256_GCM_SHA384
- ECDH_RSA_AES128_GCM_SHA256
- ECDH_RSA_AES256_GCM_SHA384
- PSK_AES128_GCM_SHA256
- PSK_AES256_GCM_SHA384
- DHE_PSK_AES128_GCM_SHA256
- DHE_PSK_AES256_GCM_SHA384
- RSA_PSK_AES128_GCM_SHA256
- RSA_PSK_AES256_GCM_SHA384
- PSK_AES128_SHA256
- PSK_AES256_SHA384
- PSK_NULL_SHA256
- PSK_NULL_SHA384
- DHE_PSK_AES128_SHA256
- DHE_PSK_AES256_SHA384
- DHE_PSK_NULL_SHA256
- DHE_PSK_NULL_SHA384
- RSA_PSK_AES128_SHA256
- RSA_PSK_AES256_SHA384
- RSA_PSK_NULL_SHA256
- RSA_PSK_NULL_SHA384
- RSA_CAMELLIA128_SHA256
- DH_DSS_CAMELLIA128_SHA256
- DH_RSA_CAMELLIA128_SHA256
- DHE_DSS_CAMELLIA128_SHA256
- DHE_RSA_CAMELLIA128_SHA256
- DH_ANON_CAMELLIA128_SHA256
- RSA_CAMELLIA256_SHA256
- DH_DSS_CAMELLIA256_SHA256
- DH_RSA_CAMELLIA256_SHA256
- DHE_DSS_CAMELLIA256_SHA256
- DHE_RSA_CAMELLIA256_SHA256
- DH_ANON_CAMELLIA256_SHA256
- ECDHE_ECDSA_CAMELLIA128_SHA256
- ECDHE_ECDSA_CAMELLIA256_SHA384
- ECDH_ECDSA_CAMELLIA128_SHA256
- ECDH_ECDSA_CAMELLIA256_SHA384
- ECDHE_RSA_CAMELLIA128_SHA256
- ECDHE_RSA_CAMELLIA256_SHA384
- ECDH_RSA_CAMELLIA128_SHA256
- ECDH_RSA_CAMELLIA256_SHA384
- RSA_CAMELLIA128_GCM_SHA256
- RSA_CAMELLIA256_GCM_SHA384
- DHE_RSA_CAMELLIA128_GCM_SHA256
- DHE_RSA_CAMELLIA256_GCM_SHA384
- DH_RSA_CAMELLIA128_GCM_SHA256
- DH_RSA_CAMELLIA256_GCM_SHA384
- DHE_DSS_CAMELLIA128_GCM_SHA256
- DHE_DSS_CAMELLIA256_GCM_SHA384
- DH_DSS_CAMELLIA128_GCM_SHA256
- DH_DSS_CAMELLIA256_GCM_SHA384
- DH_anon_CAMELLIA128_GCM_SHA256
- DH_anon_CAMELLIA256_GCM_SHA384
- ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
- ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
- ECDH_ECDSA_CAMELLIA128_GCM_SHA256
- ECDH_ECDSA_CAMELLIA256_GCM_SHA384
- ECDHE_RSA_CAMELLIA128_GCM_SHA256
- ECDHE_RSA_CAMELLIA256_GCM_SHA384
- ECDH_RSA_CAMELLIA128_GCM_SHA256
- ECDH_RSA_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_GCM_SHA256
- PSK_CAMELLIA256_GCM_SHA384
- DHE_PSK_CAMELLIA128_GCM_SHA256
- DHE_PSK_CAMELLIA256_GCM_SHA384
- RSA_PSK_CAMELLIA128_GCM_SHA256
- RSA_PSK_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_SHA256
- PSK_CAMELLIA256_SHA384
- DHE_PSK_CAMELLIA128_SHA256
- DHE_PSK_CAMELLIA256_SHA384
- RSA_PSK_CAMELLIA128_SHA256
- RSA_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_CAMELLIA128_SHA256
- ECDHE_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_RC4_SHA
- ECDHE_PSK_3DES_SHA
- ECDHE_PSK_AES128_SHA
- ECDHE_PSK_AES256_SHA
- ECDHE_PSK_AES128_SHA256
- ECDHE_PSK_AES256_SHA384
- ECDHE_PSK_NULL_SHA
- ECDHE_PSK_NULL_SHA256
- ECDHE_PSK_NULL_SHA384
- ECDHE_RSA_CHACHA20_POLY1305_SHA256
- ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
- DHE_RSA_CHACHA20_POLY1305_SHA256
- PSK_CHACHA20_POLY1305_SHA256
- ECDHE_PSK_CHACHA20_POLY1305_SHA256
- DHE_PSK_CHACHA20_POLY1305_SHA256
- RSA_PSK_CHACHA20_POLY1305_SHA256
- AES128_GCM_SHA256
- AES256_GCM_SHA384
- CHACHA20_POLY1305_SHA256
- AES128_CCM_SHA256
- AES128_CCM8_SHA256
Data Type
String
TLSECCurves Property (FTPServer Class)
Defines the elliptic curves to enable.
Syntax
QString GetTLSECCurves();
int SetTLSECCurves(QString qsTLSECCurves);
Default Value
""
Remarks
Defines the elliptic curves to enable.
Data Type
String
TLSExtensions Property (FTPServer Class)
Provides access to TLS extensions.
Syntax
QString GetTLSExtensions();
int SetTLSExtensions(QString qsTLSExtensions);
Default Value
""
Remarks
Provides access to TLS extensions.
Data Type
String
TLSForceResumeIfDestinationChanges Property (FTPServer Class)
Whether to force TLS session resumption when the destination address changes.
Syntax
bool GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(bool bTLSForceResumeIfDestinationChanges);
Default Value
false
Remarks
Whether to force TLS session resumption when the destination address changes.
Data Type
Boolean
TLSPreSharedIdentity Property (FTPServer Class)
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Syntax
QString GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(QString qsTLSPreSharedIdentity);
Default Value
""
Remarks
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
This property is not available at design time.
Data Type
String
TLSPreSharedKey Property (FTPServer Class)
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
Syntax
QString GetTLSPreSharedKey();
int SetTLSPreSharedKey(QString qsTLSPreSharedKey);
Default Value
""
Remarks
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
This property is not available at design time.
Data Type
String
TLSPreSharedKeyCiphersuite Property (FTPServer Class)
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Syntax
QString GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(QString qsTLSPreSharedKeyCiphersuite);
Default Value
""
Remarks
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Data Type
String
TLSRenegotiationAttackPreventionMode Property (FTPServer Class)
Selects renegotiation attack prevention mechanism.
Syntax
int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode);
Possible Values
CRAPM_COMPATIBLE(0),
CRAPM_STRICT(1),
CRAPM_AUTO(2)
Default Value
0
Remarks
Selects renegotiation attack prevention mechanism.
The following options are available:
crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). |
crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. |
crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. |
Data Type
Integer
TLSRevocationCheck Property (FTPServer Class)
Specifies the kind(s) of revocation check to perform.
Syntax
int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck);
Possible Values
CRC_NONE(0),
CRC_AUTO(1),
CRC_ALL_CRL(2),
CRC_ALL_OCSP(3),
CRC_ALL_CRLAND_OCSP(4),
CRC_ANY_CRL(5),
CRC_ANY_OCSP(6),
CRC_ANY_CRLOR_OCSP(7),
CRC_ANY_OCSPOR_CRL(8)
Default Value
1
Remarks
Specifies the kind(s) of revocation check to perform.
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
crcNone (0) | No revocation checking |
crcAuto (1) | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
crcAllCRL (2) | Check all provided CRL endpoints for all chain certificates. |
crcAllOCSP (3) | Check all provided OCSP endpoints for all chain certificates. |
crcAllCRLAndOCSP (4) | Check all CRL and OCSP endpoints for all chain certificates. |
crcAnyCRL (5) | At least one CRL check for every certificate in the chain must succeed. |
crcAnyOCSP (6) | At least one OCSP check for every certificate in the chain must succeed. |
crcAnyCRLOrOCSP (7) | At least one CRL or OCSP check for every certificate in the chain must succeed. CRL endpoints are checked first. |
crcAnyOCSPOrCRL (8) | At least one CRL or OCSP check for every certificate in the chain must succeed. OCSP endpoints are checked first. |
This setting controls the way the revocation checks are performed. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.
There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).
This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.
This property is not available at design time.
Data Type
Integer
TLSSSLOptions Property (FTPServer Class)
Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.
Syntax
int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions);
Default Value
16
Remarks
Various SSL (TLS) protocol options, set of
cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection |
cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions |
cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. |
cssloForceUseOfClientCertHashAlg | 0x008 | Enforce use of client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
cssloAutoAddServerNameExtension | 0x010 | Automatically add server name extension when known |
cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (not send) signature algorithms extension. It is unlikely that you will ever need to adjust it. |
cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled |
cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms |
cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks |
cssloUseHandshakeBatches | 0x400 | Send handshake message as large batches rather than individually |
Data Type
Integer
TLSTLSMode Property (FTPServer Class)
Specifies the TLS mode to use.
Syntax
int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode);
Possible Values
SM_DEFAULT(0),
SM_NO_TLS(1),
SM_EXPLICIT_TLS(2),
SM_IMPLICIT_TLS(3),
SM_MIXED_TLS(4)
Default Value
0
Remarks
Specifies the TLS mode to use.
smDefault | 0 | |
smNoTLS | 1 | Do not use TLS |
smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. |
smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. |
smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, allow plain data. |
Data Type
Integer
TLSUseExtendedMasterSecret Property (FTPServer Class)
Enables Extended Master Secret Extension, as defined in RFC 7627.
Syntax
bool GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(bool bTLSUseExtendedMasterSecret);
Default Value
false
Remarks
Enables Extended Master Secret Extension, as defined in RFC 7627.
Data Type
Boolean
TLSUseSessionResumption Property (FTPServer Class)
Enables or disables TLS session resumption capability.
Syntax
bool GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(bool bTLSUseSessionResumption);
Default Value
false
Remarks
Enables or disables TLS session resumption capability.
Data Type
Boolean
TLSVersions Property (FTPServer Class)
Th SSL/TLS versions to enable by default.
Syntax
int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);
Default Value
16
Remarks
Th SSL/TLS versions to enable by default.
csbSSL2 | 0x01 | SSL 2 |
csbSSL3 | 0x02 | SSL 3 |
csbTLS1 | 0x04 | TLS 1.0 |
csbTLS11 | 0x08 | TLS 1.1 |
csbTLS12 | 0x10 | TLS 1.2 |
csbTLS13 | 0x20 | TLS 1.3 |
Data Type
Integer
UserCount Property (FTPServer 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
- UserOutgoingSpeedLimit
- UserPassword
- UserSharedSecret
- UserUsername
This property is not available at design time.
Data Type
Integer
UserAssociatedData Property (FTPServer 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 (FTPServer 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 (FTPServer 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 (FTPServer 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 (FTPServer 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 (FTPServer 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 (FTPServer 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
UserOutgoingSpeedLimit Property (FTPServer 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 (FTPServer 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
UserSharedSecret Property (FTPServer 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
UserUsername Property (FTPServer 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 (FTPServer Class)
Enables or disables UTF8 file name conversions.
Syntax
bool GetUseUTF8();
int SetUseUTF8(bool bUseUTF8);
Default Value
true
Remarks
Use this property to enable and disable UTF8 file name conversion. The server typically adjusts to the right setting automatically, but you may use this property to enforce the needed behaviour.
Data Type
Boolean
Config Method (FTPServer 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 (FTPServer 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 (FTPServer 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 (FTPServer Class)
Obtains a pending connection buffer.
Syntax
QByteArray GetClientBuffer(qint64 lConnectionID);
Remarks
Use this method to obtain a pending connection buffer from your WriteFile event handler. The connection buffer contains data that have been received from the client but has not been written to the file yet.
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.
ListClients Method (FTPServer 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 (FTPServer 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 and PinnedClientChain properties.
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 (FTPServer Class)
Commits a data buffer to the connection.
Syntax
int SetClientBuffer(qint64 lConnectionID, QByteArray qbaValue);
Remarks
Use this method from your ReadFile event handler to commit a chunk of file data to the server component.
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 (FTPServer Class)
Commits a file entry to the connection.
Syntax
int SetClientFileEntry(qint64 lConnectionID);
Remarks
Use this method to commit a file details entry provided in ClientFileEntry property to ConnectionID connection. This method is supposed to be used from a FindNext event handler.
Please note that events like FindNext may be invoked concurrently for several connection threads. Please make sure you use a locking mechanism to avoid mixing up details in ClientFileEntry.
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 (FTPServer Class)
Starts the server.
Syntax
int Start();
Remarks
Call this method to start listening for incoming connections on port Port. Call Stop to deactivate the server.
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 (FTPServer Class)
Stops the server.
Syntax
int Stop();
Remarks
Call this method to terminate all active sessions and stop listening for new 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.)
Accept Event (FTPServer Class)
Reports an incoming connection.
Syntax
class FTPServerAcceptEventParams { 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(FTPServerAcceptEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireAccept(FTPServerAcceptEventParams *e) {...}
Remarks
This event is fired when a new connection from RemoteAddress:RemotePort is ready to be accepted. Use the Accept parameter to accept or decline it.
Subscribe to Connect event to be notified of every connection that has been set up.
AfterChangeDirectory Event (FTPServer Class)
Signals the completion of a directory change operation.
Syntax
class FTPServerAfterChangeDirectoryEventParams { public: qint64 ConnectionID(); const QString &Directory(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AfterChangeDirectory(FTPServerAfterChangeDirectoryEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireAfterChangeDirectory(FTPServerAfterChangeDirectoryEventParams *e) {...}
Remarks
The class fires this event upon completion of a directory change operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
AfterCreateDirectory Event (FTPServer Class)
Signals the completion of a directory creation operation.
Syntax
class FTPServerAfterCreateDirectoryEventParams { public: qint64 ConnectionID(); const QString &Directory(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AfterCreateDirectory(FTPServerAfterCreateDirectoryEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireAfterCreateDirectory(FTPServerAfterCreateDirectoryEventParams *e) {...}
Remarks
The class fires this event upon completion of a directory creation operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
AfterRemoveDirectory Event (FTPServer Class)
Signals the completion of a directory removal operation.
Syntax
class FTPServerAfterRemoveDirectoryEventParams { public: qint64 ConnectionID(); const QString &Directory(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AfterRemoveDirectory(FTPServerAfterRemoveDirectoryEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireAfterRemoveDirectory(FTPServerAfterRemoveDirectoryEventParams *e) {...}
Remarks
The class fires this event upon completion of a directory removal operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
AfterRemoveFile Event (FTPServer Class)
Signals the completion of a file removal operation.
Syntax
class FTPServerAfterRemoveFileEventParams { 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 AfterRemoveFile(FTPServerAfterRemoveFileEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireAfterRemoveFile(FTPServerAfterRemoveFileEventParams *e) {...}
Remarks
The class fires this event upon completion of a file removal operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
AfterRenameFile Event (FTPServer Class)
Signals the completion of a file renaming operation.
Syntax
class FTPServerAfterRenameFileEventParams { 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(FTPServerAfterRenameFileEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireAfterRenameFile(FTPServerAfterRenameFileEventParams *e) {...}
Remarks
The class fires this event upon completion of a file renaming operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
AfterRequestAttributes Event (FTPServer Class)
Signals the completion of an attribute request.
Syntax
class FTPServerAfterRequestAttributesEventParams { 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(FTPServerAfterRequestAttributesEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireAfterRequestAttributes(FTPServerAfterRequestAttributesEventParams *e) {...}
Remarks
The class fires this event upon completion of an attribute request. Check the operation status, and alter it, if needed, through the OperationStatus parameter:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
AuthAttempt Event (FTPServer Class)
Fires when a connected client makes an authentication attempt.
Syntax
class FTPServerAuthAttemptEventParams { public: qint64 ConnectionID(); const QString &Username(); const QString &Password(); bool Allow(); void SetAllow(bool bAllow); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AuthAttempt(FTPServerAuthAttemptEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireAuthAttempt(FTPServerAuthAttemptEventParams *e) {...}
Remarks
The class fires this event whenever a client attempts to authenticate itself. Use the Allow parameter to let the client through.
ConnectionID contains the unique session identifier for that client, and Username and Password contain the professed credentials.
BeforeChangeDirectory Event (FTPServer Class)
Notifies about an incoming change directory request.
Syntax
class FTPServerBeforeChangeDirectoryEventParams { public: qint64 ConnectionID(); const QString &Directory(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeChangeDirectory(FTPServerBeforeChangeDirectoryEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireBeforeChangeDirectory(FTPServerBeforeChangeDirectoryEventParams *e) {...}
Remarks
The class fires this event to notify the application about a received directory change request. ConnectionID identifies the connected client.
Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to ChangeDirectory to be notified when to perform the request. It is the ChangeDirectory event handler where you should perform the overridden action.
Upon completion of the request, either in manual or override mode, the AfterChangeDirectory event will be fired.
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 |
BeforeCreateDirectory Event (FTPServer Class)
Notifies about an incoming create directory request.
Syntax
class FTPServerBeforeCreateDirectoryEventParams { public: qint64 ConnectionID(); const QString &Directory(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeCreateDirectory(FTPServerBeforeCreateDirectoryEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireBeforeCreateDirectory(FTPServerBeforeCreateDirectoryEventParams *e) {...}
Remarks
The class fires this event to notify the application about a received MKDIR request. ConnectionID identifies the connected client.
Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to CreateDirectory to be notified when to perform the request. It is the CreateDirectory event handler where you should perform the overridden action.
Upon completion of the request, either in manual or override mode, the AfterCreateDirectory event will be fired.
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 (FTPServer Class)
Notifies about an incoming file download request.
Syntax
class FTPServerBeforeDownloadFileEventParams { public: qint64 ConnectionID(); const QString &Path(); qint64 RestartAt(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeDownloadFile(FTPServerBeforeDownloadFileEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireBeforeDownloadFile(FTPServerBeforeDownloadFileEventParams *e) {...}
Remarks
The class fires this event to notify the application about a received download request. ConnectionID identifies the connected client.
Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to DownloadFile to be notified when to perform the request. It is the DownloadFile event handler where you should perform the overridden action.
Upon completion of the request, either in manual or override mode, the TransferCompleted event will be fired.
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 (FTPServer Class)
Notifies about an incoming file listing request.
Syntax
class FTPServerBeforeFindEventParams { public: qint64 ConnectionID(); const QString &Directory(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeFind(FTPServerBeforeFindEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireBeforeFind(FTPServerBeforeFindEventParams *e) {...}
Remarks
The class fires this event to notify the application about a received file listing request. ConnectionID identifies the connected client.
Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to FindInit, FindNext, and FindClose to be notified when to perform the request. It is the FindInit and FindNext events handler where you should perform the overridden listing actions.
Upon completion of the request, either in manual or override mode, the FindClose event will be fired.
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 |
BeforeRemoveDirectory Event (FTPServer Class)
Notifies about an incoming directory removal request.
Syntax
class FTPServerBeforeRemoveDirectoryEventParams { public: qint64 ConnectionID(); const QString &Directory(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeRemoveDirectory(FTPServerBeforeRemoveDirectoryEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireBeforeRemoveDirectory(FTPServerBeforeRemoveDirectoryEventParams *e) {...}
Remarks
The class fires this event to notify the application about a received directory removal request. ConnectionID identifies the connected client.
Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to RemoveDirectory to be notified when to perform the request. It is the RemoveDirectory event handler where you should perform the overridden action.
Upon completion of the request, either in manual or override mode, the AfterRemoveDirectory event will be fired.
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 |
BeforeRemoveFile Event (FTPServer Class)
Notifies about an incoming file removal request.
Syntax
class FTPServerBeforeRemoveFileEventParams { 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 BeforeRemoveFile(FTPServerBeforeRemoveFileEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireBeforeRemoveFile(FTPServerBeforeRemoveFileEventParams *e) {...}
Remarks
The class fires this event to notify the application about a received file deletion request. ConnectionID identifies the connected client.
Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to RemoveFile to be notified when to perform the request. It is the RemoveFile event handler where you should perform the overridden action.
Upon completion of the request, either in manual or override mode, the AfterRemoveFile event will be fired.
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 (FTPServer Class)
Notifies about an incoming file rename request.
Syntax
class FTPServerBeforeRenameFileEventParams { 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(FTPServerBeforeRenameFileEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireBeforeRenameFile(FTPServerBeforeRenameFileEventParams *e) {...}
Remarks
The class fires this event to notify the application about a received file rename request. ConnectionID identifies the connected client.
Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to RenameFile to be notified when to perform the request. It is the RenameFile event handler where you should perform the overridden action.
Upon completion of the request, either in manual or override mode, the AfterRenameFile event will be fired.
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 (FTPServer Class)
Notifies about an incoming attributes request.
Syntax
class FTPServerBeforeRequestAttributesEventParams { 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(FTPServerBeforeRequestAttributesEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireBeforeRequestAttributes(FTPServerBeforeRequestAttributesEventParams *e) {...}
Remarks
The class fires this event to notify the application about a received attributes request. ConnectionID identifies the connected client.
Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to RequestAttributes to be notified when to perform the request. It is the RequestAttributes event handler where you should perform the overridden action.
Upon completion of the request, either in manual or override mode, the AfterRequestAttributes event will be fired.
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 |
BeforeSendReply Event (FTPServer Class)
Notifies the application of a command reply being sent.
Syntax
class FTPServerBeforeSendReplyEventParams { public: qint64 ConnectionID(); int Code(); void SetCode(int iCode); const QString &Reply(); void SetReply(const QString &qsReply); const QString &Command(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeSendReply(FTPServerBeforeSendReplyEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireBeforeSendReply(FTPServerBeforeSendReplyEventParams *e) {...}
Remarks
The class fires this event to tell the application that a command reply is about to be sent. The Command parameter indicates the command that induced the reply, and Code and Reply indicate the pre-generated response.
You can alter the response parameters in your code to send bespoke replies.
BeforeUploadFile Event (FTPServer Class)
Notifies about an incoming file upload request.
Syntax
class FTPServerBeforeUploadFileEventParams { public: qint64 ConnectionID(); const QString &Path(); qint64 RestartAt(); bool Append(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeUploadFile(FTPServerBeforeUploadFileEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireBeforeUploadFile(FTPServerBeforeUploadFileEventParams *e) {...}
Remarks
The class fires this event to notify the application about a received upload request. ConnectionID identifies the connected client.
Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to UploadFile to be notified when to perform the request. It is the UploadFile event handler where you should perform the overridden action.
Upon completion of the request, either in manual or override mode, the TransferCompleted event will be fired.
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 |
CertificateValidate Event (FTPServer Class)
Fires when a client certificate needs to be validated.
Syntax
class FTPServerCertificateValidateEventParams { public: qint64 ConnectionID(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void CertificateValidate(FTPServerCertificateValidateEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireCertificateValidate(FTPServerCertificateValidateEventParams *e) {...}
Remarks
The class fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the Accept parameter.
ChangeDirectory Event (FTPServer Class)
An override for a directory change operation.
Syntax
class FTPServerChangeDirectoryEventParams { public: qint64 ConnectionID(); const QString &Directory(); void SetDirectory(const QString &qsDirectory); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ChangeDirectory(FTPServerChangeDirectoryEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireChangeDirectory(FTPServerChangeDirectoryEventParams *e) {...}
Remarks
The class fires this event to let the application perform an overridden directory change operation.
This event only fires if Action = fraCustom was passed back from BeforeChangeDirectory event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.
Use the OperationStatus parameter to return the operation result back to the server.
This event will be followed by AfterChangeDirectory call which will let you make final adjustments to the returned code.
Set OperationStatus to one of the following values:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
CommandProcessed Event (FTPServer Class)
Signals that a command has been processed by the server.
Syntax
class FTPServerCommandProcessedEventParams { public: qint64 ConnectionID(); const QString &CurrentDirectory(); const QString &Command(); int ReplyCode(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void CommandProcessed(FTPServerCommandProcessedEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireCommandProcessed(FTPServerCommandProcessedEventParams *e) {...}
Remarks
The class fires this event to signal that a command has been processed by the server, and a reply code has been generated.
You can adjust the reply code and the textual comment associated with it in BeforeSendReply event handler.
CommandReceived Event (FTPServer Class)
Signals that a command has been received from the client.
Syntax
class FTPServerCommandReceivedEventParams { public: qint64 ConnectionID(); const QString &Command(); const QString &Parameters(); bool Ignore(); void SetIgnore(bool bIgnore); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void CommandReceived(FTPServerCommandReceivedEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireCommandReceived(FTPServerCommandReceivedEventParams *e) {...}
Remarks
The class fires this event to notify the application of an incoming command. Set Ignore to True to stop the server from handling the command.
When the command has been processed, the server will report it via the CommandProcessed call.
Connect Event (FTPServer Class)
Reports an accepted connection.
Syntax
class FTPServerConnectEventParams { public: qint64 ConnectionID(); const QString &RemoteAddress(); int Port(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Connect(FTPServerConnectEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireConnect(FTPServerConnectEventParams *e) {...}
Remarks
The class fires this event to report that a new connection has been established. ConnectionId indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as AuthAttempt or BeforeUploadFile.
CreateDirectory Event (FTPServer Class)
An override for a directory creation operation.
Syntax
class FTPServerCreateDirectoryEventParams { public: qint64 ConnectionID(); const QString &Directory(); void SetDirectory(const QString &qsDirectory); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void CreateDirectory(FTPServerCreateDirectoryEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireCreateDirectory(FTPServerCreateDirectoryEventParams *e) {...}
Remarks
The class fires this event to let the application perform an overridden directory creation operation.
This event only fires if Action = fraCustom was passed back from BeforeCreateDirectory event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.
Use the OperationStatus parameter to return the operation result back to the server.
This event will be followed by AfterCreateDirectory call which will let you make final adjustments to the returned code.
Set OperationStatus to one of the following values:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
Disconnect Event (FTPServer Class)
Fires to report a disconnected client.
Syntax
class FTPServerDisconnectEventParams { public: qint64 ConnectionID(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Disconnect(FTPServerDisconnectEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireDisconnect(FTPServerDisconnectEventParams *e) {...}
Remarks
The class fires this event when a connected client disconnects.
DownloadBegin Event (FTPServer Class)
TBD.
Syntax
class FTPServerDownloadBeginEventParams { public: qint64 ConnectionID(); const QString &Path(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void DownloadBegin(FTPServerDownloadBeginEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireDownloadBegin(FTPServerDownloadBeginEventParams *e) {...}
Remarks
TBD.
DownloadEnd Event (FTPServer Class)
TBD.
Syntax
class FTPServerDownloadEndEventParams { public: qint64 ConnectionID(); const QString &Path(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void DownloadEnd(FTPServerDownloadEndEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireDownloadEnd(FTPServerDownloadEndEventParams *e) {...}
Remarks
TBD.
DownloadFile Event (FTPServer Class)
An override for a file download initiation operation.
Syntax
class FTPServerDownloadFileEventParams { public: qint64 ConnectionID(); const QString &Path(); qint64 RestartAt(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void DownloadFile(FTPServerDownloadFileEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireDownloadFile(FTPServerDownloadFileEventParams *e) {...}
Remarks
The class fires this event to let the application perform an overridden file download initiation operation.
This event only fires if Action = fraCustom was passed back from BeforeDownloadFile event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.
Use the OperationStatus parameter to return the operation result back to the server.
This event will be followed by a number of ReadFile calls, requesting the file data from your code, followed by a single TransferCompleted call.
Set OperationStatus to one of the following values:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
DownloadProgress Event (FTPServer Class)
TBD.
Syntax
class FTPServerDownloadProgressEventParams { public: qint64 ConnectionID(); const QString &Path(); qint64 Progress(); qint64 Total(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void DownloadProgress(FTPServerDownloadProgressEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireDownloadProgress(FTPServerDownloadProgressEventParams *e) {...}
Remarks
TBD.
Error Event (FTPServer Class)
Information about errors during data delivery.
Syntax
class FTPServerErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(FTPServerErrorEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireError(FTPServerErrorEventParams *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 FTP section.
ExternalSign Event (FTPServer Class)
Handles remote or external signing initiated by the server protocol.
Syntax
class FTPServerExternalSignEventParams { 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(FTPServerExternalSignEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireExternalSign(FTPServerExternalSignEventParams *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 (FTPServer Class)
Signals the completion of a directory listing request.
Syntax
class FTPServerFindCloseEventParams { public: qint64 ConnectionID(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void FindClose(FTPServerFindCloseEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireFindClose(FTPServerFindCloseEventParams *e) {...}
Remarks
The class fires this event upon completion of a directory listing request. Check the operation status, and alter it, if needed, through the OperationStatus parameter.
FindInit Event (FTPServer Class)
An override for a directory listing initiation operation.
Syntax
class FTPServerFindInitEventParams { public: qint64 ConnectionID(); const QString &Directory(); void SetDirectory(const QString &qsDirectory); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void FindInit(FTPServerFindInitEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireFindInit(FTPServerFindInitEventParams *e) {...}
Remarks
The class fires this event to let the application prepare for directory listing retrieval.
This event only fires if Action = fraCustom was passed back from BeforeFind event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.
Use the OperationStatus parameter to return the operation result back to the server.
This event will be followed by a number of FindNext calls, requesting the directory listing entry by entry from your code, followed by a FindClose call.
Set OperationStatus to one of the following values:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
FindNext Event (FTPServer Class)
An override for a directory listing entry request operation.
Syntax
class FTPServerFindNextEventParams { public: qint64 ConnectionID(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void FindNext(FTPServerFindNextEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireFindNext(FTPServerFindNextEventParams *e) {...}
Remarks
The class fires this event in a loop after calling FindInit to request one directory entry from the application.
This event only fires if Action = fraCustom was passed back from BeforeFind event. No default listing operation will be performed by the server component.
Inside the handler, pass the entry details to the server component by tuning up the ClientFileEntry object to contain the details of the requested entry, and committing those details to the component with SetClientFileEntry method.
Use the OperationStatus parameter to return the operation result back to the server. After submitting all the directory entries to the component, set OperationStatus to ostEOF to tell the components that no more entries are left.
This event will be followed by FindClose call which will let you make final adjustments to the returned code.
Set OperationStatus to one of the following values:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
Notification Event (FTPServer Class)
This event notifies the application about an underlying control flow event.
Syntax
class FTPServerNotificationEventParams { 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(FTPServerNotificationEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireNotification(FTPServerNotificationEventParams *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:
DownloadProgress | Reports the progress of the current download operation.
The EventParam value passed with this EventID is a string of the
following format:
ConnectionID=3;Path=/dir/file;Progress=2048;Total=16000 |
UploadProgress | Reports the progress of the current upload operation. The format of EventParam is identical to the one used by the DownloadProgress. |
DownloadBegin | Indicates the start of the download operation. The
EventParam value has the following format:
ConnectionID=8;Path=/dir/file |
UploadBegin | Indicates the start of the upload operation. The EventParam format is the same as with the DownloadBegin event ID. |
DownloadEnd | Indicates the completion of the download operation. The
EventParam value has the following format:
ConnectionID=8;Path=/dir/file |
UploadEnd | Indicates the completion of the upload operation. The EventParam format is the same as with the DownloadEnd event ID. |
ReadFile Event (FTPServer Class)
Requests a piece of file data from the application.
Syntax
class FTPServerReadFileEventParams { public: qint64 ConnectionID(); 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(FTPServerReadFileEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireReadFile(FTPServerReadFileEventParams *e) {...}
Remarks
The class fires this event repeatedly during an overridden download operation to request file data from the application.
The handler of this event should read up to Size bytes from the downloaded file, and pass them to the component with a SetClientBuffer call.
Use the OperationStatus parameter to return the operation result back to the server. When the file has been read up to its end, set OperationStatus to ostEOF to tell the components that no more ReadFile calls are needed.
Set OperationStatus to one of the following values:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
RemoveDirectory Event (FTPServer Class)
An override for a directory removal operation.
Syntax
class FTPServerRemoveDirectoryEventParams { public: qint64 ConnectionID(); const QString &Directory(); void SetDirectory(const QString &qsDirectory); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void RemoveDirectory(FTPServerRemoveDirectoryEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireRemoveDirectory(FTPServerRemoveDirectoryEventParams *e) {...}
Remarks
The class fires this event to let the application perform an overridden directory removal operation.
This event only fires if Action = fraCustom was passed back from BeforeRemoveDirectory event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.
Use the OperationStatus parameter to return the operation result back to the server.
This event will be followed by AfterRemoveDirectory call which will let you make final adjustments to the returned code.
Set OperationStatus to one of the following values:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
RemoveFile Event (FTPServer Class)
An override for a file remove operation.
Syntax
class FTPServerRemoveFileEventParams { 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 RemoveFile(FTPServerRemoveFileEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireRemoveFile(FTPServerRemoveFileEventParams *e) {...}
Remarks
The class fires this event to let the application perform an overridden file removal operation.
This event only fires if Action = fraCustom was passed back from BeforeRemoveFile event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.
Use the OperationStatus parameter to return the operation result back to the server.
This event will be followed by AfterRemoveFile call which will let you make final adjustments to the returned code.
Set OperationStatus to one of the following values:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
RenameFile Event (FTPServer Class)
An override for a file rename operation.
Syntax
class FTPServerRenameFileEventParams { 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(FTPServerRenameFileEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireRenameFile(FTPServerRenameFileEventParams *e) {...}
Remarks
The class fires this event to let the application perform an overridden file rename operation.
This event only fires if Action = fraCustom was passed back from BeforeRenameFile event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.
Use the OperationStatus parameter to return the operation result back to the server.
This event will be followed by AfterRenameFile call which will let you make final adjustments to the returned code.
Set OperationStatus to one of the following values:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
RequestAttributes Event (FTPServer Class)
An override for an attribute request.
Syntax
class FTPServerRequestAttributesEventParams { 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 RequestAttributes(FTPServerRequestAttributesEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireRequestAttributes(FTPServerRequestAttributesEventParams *e) {...}
Remarks
The class fires this event to let the application handle an overridden attribute request operation.
This event only fires if Action = fraCustom was passed back from BeforeRequestAttributes event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.
Use the OperationStatus parameter to return the operation result back to the server.
This event will be followed by AfterRequestAttributes call which will let you make final adjustments to the returned code.
Set OperationStatus to one of the following values:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
TransferCompleted Event (FTPServer Class)
This event is fired when a customized upload or download operation completes.
Syntax
class FTPServerTransferCompletedEventParams { public: qint64 ConnectionID(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TransferCompleted(FTPServerTransferCompletedEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireTransferCompleted(FTPServerTransferCompletedEventParams *e) {...}
Remarks
This event is fired when a customized transfer operation completes. This event is only fired for operations handled by the user code, i.e. those intercepted with BeforeUploadFile or BeforeDownloadFile event, and with Action parameter set to fraCustom.
The ConnectionID parameter specifies the session to which the event belongs, and OperationStatus reports the outcome of the transfer operation.
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
UploadBegin Event (FTPServer Class)
TBD.
Syntax
class FTPServerUploadBeginEventParams { public: qint64 ConnectionID(); const QString &Path(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void UploadBegin(FTPServerUploadBeginEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireUploadBegin(FTPServerUploadBeginEventParams *e) {...}
Remarks
TBD.
UploadEnd Event (FTPServer Class)
TBD.
Syntax
class FTPServerUploadEndEventParams { public: qint64 ConnectionID(); const QString &Path(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void UploadEnd(FTPServerUploadEndEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireUploadEnd(FTPServerUploadEndEventParams *e) {...}
Remarks
TBD.
UploadFile Event (FTPServer Class)
An override for a file upload initiation operation.
Syntax
class FTPServerUploadFileEventParams { public: qint64 ConnectionID(); const QString &Path(); qint64 RestartAt(); bool Append(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void UploadFile(FTPServerUploadFileEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireUploadFile(FTPServerUploadFileEventParams *e) {...}
Remarks
The class fires this event to let the application perform an overridden file upload initiation operation.
This event only fires if Action = fraCustom was passed back from BeforeUploadFile event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.
Use the OperationStatus parameter to return the operation result back to the server.
This event will be followed by a number of WriteFile calls, passing the file data to your code, followed by a single TransferCompleted call.
Set OperationStatus to one of the following values:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
UploadProgress Event (FTPServer Class)
TBD.
Syntax
class FTPServerUploadProgressEventParams { public: qint64 ConnectionID(); const QString &Path(); qint64 Progress(); qint64 Total(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void UploadProgress(FTPServerUploadProgressEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireUploadProgress(FTPServerUploadProgressEventParams *e) {...}
Remarks
TBD.
WriteFile Event (FTPServer Class)
Hands a piece of file data to the application.
Syntax
class FTPServerWriteFileEventParams { public: qint64 ConnectionID(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void WriteFile(FTPServerWriteFileEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireWriteFile(FTPServerWriteFileEventParams *e) {...}
Remarks
The class fires this event repeatedly during an overridden upload operation to pass file data to the application.
The handler of this event should retrieve the pending data buffer with a GetClientBuffer call, and write it to the end of the file that is being uploaded.
Use the OperationStatus parameter to return the operation result back to the server.
Set OperationStatus to one of the following values:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
Configuration Settings (FTPServer 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.FTPServer Configuration Settings | ||||||||||||||||||||||||||||||
ActiveChannel: The channel to which the event that is being invoked corresponds.Use this property to find out which channel, command or data, has invoked the current event. This property returns reliable values and should only be checked while inside an event handler. facCmd = 0; facData = 1; | ||||||||||||||||||||||||||||||
ClientAuth: Enables or disables certificate-based client authentication.Set this property to true to tune up the client authentication type: ccatNoAuth = 0; ccatRequestCert = 1; ccatRequireCert = 2; | ||||||||||||||||||||||||||||||
DualStack: Allows the use of IPv4 and IPv6 simultaneously.This setting specifies a socket can use IPv4 and IPv6 simultaneously. | ||||||||||||||||||||||||||||||
RefreshUsers: Enables or disables real-time propagation of user information.Set this property to true to make the content of the Users property propagate to the server immediately. The default setting is false, which delays the effect of any changes in the Users setting until the server is restarted. | ||||||||||||||||||||||||||||||
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 (FTPServer Class)
FTPServer Errors
1048577 Invalid parameter value (SB_ERROR_INVALID_PARAMETER) | |
1048578 Class is configured incorrectly (SB_ERROR_INVALID_SETUP) | |
1048579 Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE) | |
1048580 Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE) | |
1048581 Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY) | |
1048581 Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) | |
18874368 Unsupported file operation (SB_ERROR_FTP_UNSUPPORTED_FILEOPERATION) |