FTPServer Class

Properties   Methods   Events   Config 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.

ActiveWhether the server is active and can accept incoming connections.
AllowAnonymousAllows and disallows anonymous connections.
ClientFileEntryA container for current file entry details.
DataHostHost address for incoming data channel connections.
DataPortRangeFromSpecifies the lower port range bound for passive mode data connections.
DataPortRangeToSpecifies the upper port range bound for passive mode data connections.
ExternalCryptoProvides access to external signing and DC parameters.
FIPSModeReserved.
HandshakeTimeoutSpecifies the handshake timeout in milliseconds.
HostSpecifies the server host.
ImplicitSSLEnables or disables implicit SSL mode.
PassiveModeHostThe IP address of the passive mode host.
PinnedClientPopulates the pinned client details.
PinnedClientChainContains the certificate chain of the pinned client.
PortThe port number to listen for incoming connections on.
ReadOnlyMakes the server's file system read-only for all users.
RootDirectorySpecifies the server's root directory.
SecurityOptionsVarious options of the secure connection.
SessionTimeoutSpecifies the session timeout in milliseconds.
SocketSettingsManages network connection settings.
TLSServerChainThe server's TLS certificates.
TLSSettingsManages TLS layer settings.
UsersProvides a list of registered users.
UseUTF8Enables 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.

CleanupCleans up the server environment by purging expired sessions and cleaning caches.
ConfigSets or retrieves a configuration setting.
DoActionPerforms an additional action.
DropClientTerminates a client connection.
GetClientBufferObtains a pending connection buffer.
ListClientsEnumerates the connected clients.
PinClientTakes a snapshot of the connection's properties.
ResetResets the class settings.
SetClientBufferCommits a data buffer to the connection.
SetClientFileEntryCommits a file entry to the connection.
StartStarts the server.
StopStops 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.

AcceptReports an incoming connection.
AfterChangeDirectorySignals the completion of a directory change operation.
AfterCreateDirectorySignals the completion of a directory creation operation.
AfterRemoveDirectorySignals the completion of a directory removal operation.
AfterRemoveFileSignals the completion of a file removal operation.
AfterRenameFileSignals the completion of a file renaming operation.
AfterRequestAttributesSignals the completion of an attribute request.
AuthAttemptFires when a connected client makes an authentication attempt.
BeforeChangeDirectoryNotifies about an incoming change directory request.
BeforeCreateDirectoryNotifies about an incoming create directory request.
BeforeDownloadFileNotifies about an incoming file download request.
BeforeFindNotifies about an incoming file listing request.
BeforeRemoveDirectoryNotifies about an incoming directory removal request.
BeforeRemoveFileNotifies about an incoming file removal request.
BeforeRenameFileNotifies about an incoming file rename request.
BeforeRequestAttributesNotifies about an incoming attributes request.
BeforeSendReplyNotifies the application of a command reply being sent.
BeforeUploadFileNotifies about an incoming file upload request.
ChangeDirectoryAn override for a directory change operation.
CommandProcessedSignals that a command has been processed by the server.
CommandReceivedSignals that a command has been received from the client.
ConnectReports an accepted connection.
CreateDirectoryAn override for a directory creation operation.
DisconnectFires to report a disconnected client.
DownloadBeginThe class fires this event to notify the application about the start of a file download.
DownloadEndReports the completion of the download operation.
DownloadFileAn override for a file download initiation operation.
DownloadProgressReports the progress of an active download operation.
ErrorInformation about errors during data delivery.
ExternalSignHandles remote or external signing initiated by the server protocol.
FindCloseSignals the completion of a directory listing request.
FindInitAn override for a directory listing initiation operation.
FindNextAn override for a directory listing entry request operation.
NotificationThis event notifies the application about an underlying control flow event.
ReadFileRequests a piece of file data from the application.
RemoveDirectoryAn override for a directory removal operation.
RemoveFileAn override for a file remove operation.
RenameFileAn override for a file rename operation.
RequestAttributesAn override for an attribute request.
TLSCertValidateFires when a client certificate needs to be validated.
TLSEstablishedReports the setup of a TLS session.
TLSHandshakeFires when a newly established client connection initiates a TLS handshake.
TLSPSKRequests a pre-shared key for TLS-PSK.
TLSShutdownReports closure of a TLS session.
TransferCompletedThis event is fired when a customized upload or download operation completes.
UploadBeginThe server fires this event to notify the application about the start of a file upload operation.
UploadEndReports the completion of the upload operation.
UploadFileAn override for a file upload initiation operation.
UploadProgressReports the progress of an active upload operation.
WriteFileHands a piece of file data to the application.

Config Settings


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

ActiveChannelThe channel to which the event that is being invoked corresponds.
ClientAuthEnables or disables certificate-based client authentication.
ControlChannelLog[i]Returns the control channel log for a connection.
DualStackAllows the use of ip4 and ip6 simultaneously.
MessageTable[i]Provides access to error code descriptions.
RefreshUsersEnables or disables real-time propagation of user information.
SecurityOptionsFacilitates fine-tuning of lower-level security settings.
ASN1UseGlobalTagCacheControls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPinsSpecifies whether CSP-level PINs should be assigned to CNG keys.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
DNSLocalSuffixThe suffix to assign for TLD names.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicyThe hardware crypto usage policy.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
HttpVersionThe HTTP version to use in any inner HTTP client classes created.
IgnoreExpiredMSCTLSigningCertWhether to tolerate the expired Windows Update signing certificate.
ListDelimiterThe delimiter character for multi-element lists.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
OldClientSideRSAFallbackSpecifies whether the SSH client should use a SHA1 fallback.
PKICacheSpecifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.
PKICachePathSpecifies the file system path where cached PKI data is stored.
ProductVersionReturns the version of the SecureBlackbox library.
ServerSSLDHKeyLengthSets the size of the TLS DHE key exchange group.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseCRLObjectCachingSpecifies whether reuse of loaded CRL objects is enabled.
UseInternalRandomSwitches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidationEnables legacy AdES validation mode.
UseOCSPResponseObjectCachingSpecifies whether reuse of loaded OCSP response objects is enabled.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculationAn internal CryptoAPI access tweak.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.
XMLRDNDescriptorName[OID]Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.
XMLRDNDescriptorPriority[OID]Specifies the priority of descriptor names associated with a specific OID.
XMLRDNDescriptorReverseOrderSpecifies whether to reverse the order of descriptors in RDN.
XMLRDNDescriptorSeparatorSpecifies the separator used between descriptors in RDN.

Active Property (FTPServer Class)

Whether the server is active and can accept incoming connections.

Syntax

ANSI (Cross Platform)
int GetActive();

Unicode (Windows)
BOOL GetActive();
int secureblackbox_ftpserver_getactive(void* lpObj);
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

ANSI (Cross Platform)
int GetAllowAnonymous();
int SetAllowAnonymous(int bAllowAnonymous); Unicode (Windows) BOOL GetAllowAnonymous();
INT SetAllowAnonymous(BOOL bAllowAnonymous);
int secureblackbox_ftpserver_getallowanonymous(void* lpObj);
int secureblackbox_ftpserver_setallowanonymous(void* lpObj, int bAllowAnonymous);
bool GetAllowAnonymous();
int SetAllowAnonymous(bool bAllowAnonymous);

Default Value

FALSE

Remarks

Use this property to enable and disable support for anonymous connections.

Data Type

Boolean

ClientFileEntry Property (FTPServer Class)

A container for current file entry details.

Syntax

SecureBlackboxFTPListEntry* GetClientFileEntry();
int SetClientFileEntry(SecureBlackboxFTPListEntry* val);
char* secureblackbox_ftpserver_getclientfileentryaccesstime(void* lpObj);
int secureblackbox_ftpserver_setclientfileentryaccesstime(void* lpObj, const char* lpszClientFileEntryAccessTime);
char* secureblackbox_ftpserver_getclientfileentrycreationtime(void* lpObj);
int secureblackbox_ftpserver_setclientfileentrycreationtime(void* lpObj, const char* lpszClientFileEntryCreationTime);
int secureblackbox_ftpserver_getclientfileentryentryformat(void* lpObj);
int secureblackbox_ftpserver_setclientfileentryentryformat(void* lpObj, int iClientFileEntryEntryFormat);
int secureblackbox_ftpserver_getclientfileentryfiletype(void* lpObj);
int secureblackbox_ftpserver_setclientfileentryfiletype(void* lpObj, int iClientFileEntryFileType);
int64 secureblackbox_ftpserver_getclientfileentryhandle(void* lpObj);
int secureblackbox_ftpserver_setclientfileentryhandle(void* lpObj, int64 lClientFileEntryHandle);
char* secureblackbox_ftpserver_getclientfileentrymodificationtime(void* lpObj);
int secureblackbox_ftpserver_setclientfileentrymodificationtime(void* lpObj, const char* lpszClientFileEntryModificationTime);
char* secureblackbox_ftpserver_getclientfileentryname(void* lpObj);
int secureblackbox_ftpserver_setclientfileentryname(void* lpObj, const char* lpszClientFileEntryName);
char* secureblackbox_ftpserver_getclientfileentrypath(void* lpObj);
int secureblackbox_ftpserver_setclientfileentrypath(void* lpObj, const char* lpszClientFileEntryPath);
char* secureblackbox_ftpserver_getclientfileentryprincipal(void* lpObj);
int secureblackbox_ftpserver_setclientfileentryprincipal(void* lpObj, const char* lpszClientFileEntryPrincipal);
int64 secureblackbox_ftpserver_getclientfileentrysize(void* lpObj);
int secureblackbox_ftpserver_setclientfileentrysize(void* lpObj, int64 lClientFileEntrySize);
int secureblackbox_ftpserver_getclientfileentryunixperms(void* lpObj);
int secureblackbox_ftpserver_setclientfileentryunixperms(void* lpObj, int iClientFileEntryUnixPerms);
char* secureblackbox_ftpserver_getclientfileentryunparsedname(void* lpObj);
int secureblackbox_ftpserver_setclientfileentryunparsedname(void* lpObj, const char* lpszClientFileEntryUnparsedName);
QString GetClientFileEntryAccessTime();
int SetClientFileEntryAccessTime(QString qsClientFileEntryAccessTime); QString GetClientFileEntryCreationTime();
int SetClientFileEntryCreationTime(QString qsClientFileEntryCreationTime); int GetClientFileEntryEntryFormat();
int SetClientFileEntryEntryFormat(int iClientFileEntryEntryFormat); int GetClientFileEntryFileType();
int SetClientFileEntryFileType(int iClientFileEntryFileType); qint64 GetClientFileEntryHandle();
int SetClientFileEntryHandle(qint64 lClientFileEntryHandle); QString GetClientFileEntryModificationTime();
int SetClientFileEntryModificationTime(QString qsClientFileEntryModificationTime); QString GetClientFileEntryName();
int SetClientFileEntryName(QString qsClientFileEntryName); QString GetClientFileEntryPath();
int SetClientFileEntryPath(QString qsClientFileEntryPath); QString GetClientFileEntryPrincipal();
int SetClientFileEntryPrincipal(QString qsClientFileEntryPrincipal); qint64 GetClientFileEntrySize();
int SetClientFileEntrySize(qint64 lClientFileEntrySize); int GetClientFileEntryUnixPerms();
int SetClientFileEntryUnixPerms(int iClientFileEntryUnixPerms); QString GetClientFileEntryUnparsedName();
int SetClientFileEntryUnparsedName(QString qsClientFileEntryUnparsedName);

Remarks

Use this object to specify file entry details for a file listing or attributes request, before committing them to the server with SetClientFileEntry method.

This property is not available at design time.

Data Type

SecureBlackboxFTPListEntry

DataHost Property (FTPServer Class)

Host address for incoming data channel connections.

Syntax

ANSI (Cross Platform)
char* GetDataHost();
int SetDataHost(const char* lpszDataHost); Unicode (Windows) LPWSTR GetDataHost();
INT SetDataHost(LPCWSTR lpszDataHost);
char* secureblackbox_ftpserver_getdatahost(void* lpObj);
int secureblackbox_ftpserver_setdatahost(void* lpObj, const char* lpszDataHost);
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

ANSI (Cross Platform)
int GetDataPortRangeFrom();
int SetDataPortRangeFrom(int iDataPortRangeFrom); Unicode (Windows) INT GetDataPortRangeFrom();
INT SetDataPortRangeFrom(INT iDataPortRangeFrom);
int secureblackbox_ftpserver_getdataportrangefrom(void* lpObj);
int secureblackbox_ftpserver_setdataportrangefrom(void* lpObj, int iDataPortRangeFrom);
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

ANSI (Cross Platform)
int GetDataPortRangeTo();
int SetDataPortRangeTo(int iDataPortRangeTo); Unicode (Windows) INT GetDataPortRangeTo();
INT SetDataPortRangeTo(INT iDataPortRangeTo);
int secureblackbox_ftpserver_getdataportrangeto(void* lpObj);
int secureblackbox_ftpserver_setdataportrangeto(void* lpObj, int iDataPortRangeTo);
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

ExternalCrypto Property (FTPServer Class)

Provides access to external signing and DC parameters.

Syntax

SecureBlackboxExternalCrypto* GetExternalCrypto();

char* secureblackbox_ftpserver_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_ftpserver_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);
char* secureblackbox_ftpserver_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_ftpserver_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);
char* secureblackbox_ftpserver_getexternalcryptodata(void* lpObj);
int secureblackbox_ftpserver_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);
int secureblackbox_ftpserver_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_ftpserver_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);
char* secureblackbox_ftpserver_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_ftpserver_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);
char* secureblackbox_ftpserver_getexternalcryptokeyid(void* lpObj);
int secureblackbox_ftpserver_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);
char* secureblackbox_ftpserver_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_ftpserver_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);
int secureblackbox_ftpserver_getexternalcryptomethod(void* lpObj);
int secureblackbox_ftpserver_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);
int secureblackbox_ftpserver_getexternalcryptomode(void* lpObj);
int secureblackbox_ftpserver_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);
char* secureblackbox_ftpserver_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_ftpserver_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);
QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID); QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams); QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData); bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation); QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm); QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID); QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret); int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod); int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode); QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);

Remarks

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

This property is read-only.

Data Type

SecureBlackboxExternalCrypto

FIPSMode Property (FTPServer Class)

Reserved.

Syntax

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

Default Value

FALSE

Remarks

This property is reserved for future use.

Data Type

Boolean

HandshakeTimeout Property (FTPServer Class)

Specifies the handshake timeout in milliseconds.

Syntax

ANSI (Cross Platform)
int GetHandshakeTimeout();
int SetHandshakeTimeout(int iHandshakeTimeout); Unicode (Windows) INT GetHandshakeTimeout();
INT SetHandshakeTimeout(INT iHandshakeTimeout);
int secureblackbox_ftpserver_gethandshaketimeout(void* lpObj);
int secureblackbox_ftpserver_sethandshaketimeout(void* lpObj, int iHandshakeTimeout);
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

ANSI (Cross Platform)
char* GetHost();
int SetHost(const char* lpszHost); Unicode (Windows) LPWSTR GetHost();
INT SetHost(LPCWSTR lpszHost);
char* secureblackbox_ftpserver_gethost(void* lpObj);
int secureblackbox_ftpserver_sethost(void* lpObj, const char* lpszHost);
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

ANSI (Cross Platform)
int GetImplicitSSL();
int SetImplicitSSL(int bImplicitSSL); Unicode (Windows) BOOL GetImplicitSSL();
INT SetImplicitSSL(BOOL bImplicitSSL);
int secureblackbox_ftpserver_getimplicitssl(void* lpObj);
int secureblackbox_ftpserver_setimplicitssl(void* lpObj, int bImplicitSSL);
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

ANSI (Cross Platform)
char* GetPassiveModeHost();
int SetPassiveModeHost(const char* lpszPassiveModeHost); Unicode (Windows) LPWSTR GetPassiveModeHost();
INT SetPassiveModeHost(LPCWSTR lpszPassiveModeHost);
char* secureblackbox_ftpserver_getpassivemodehost(void* lpObj);
int secureblackbox_ftpserver_setpassivemodehost(void* lpObj, const char* lpszPassiveModeHost);
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

PinnedClient Property (FTPServer Class)

Populates the pinned client details.

Syntax

SecureBlackboxTLSConnectionInfo* GetPinnedClient();

int secureblackbox_ftpserver_getpinnedclientaeadcipher(void* lpObj);
int secureblackbox_ftpserver_getpinnedclientchainvalidationdetails(void* lpObj);
int secureblackbox_ftpserver_getpinnedclientchainvalidationresult(void* lpObj);
char* secureblackbox_ftpserver_getpinnedclientciphersuite(void* lpObj);
int secureblackbox_ftpserver_getpinnedclientclientauthenticated(void* lpObj);
int secureblackbox_ftpserver_getpinnedclientclientauthrequested(void* lpObj);
int secureblackbox_ftpserver_getpinnedclientconnectionestablished(void* lpObj);
int secureblackbox_ftpserver_getpinnedclientconnectionid(void* lpObj, char** lpPinnedClientConnectionID, int* lenPinnedClientConnectionID);
char* secureblackbox_ftpserver_getpinnedclientdigestalgorithm(void* lpObj);
char* secureblackbox_ftpserver_getpinnedclientencryptionalgorithm(void* lpObj);
int secureblackbox_ftpserver_getpinnedclientexportable(void* lpObj);
int64 secureblackbox_ftpserver_getpinnedclientid(void* lpObj);
char* secureblackbox_ftpserver_getpinnedclientkeyexchangealgorithm(void* lpObj);
int secureblackbox_ftpserver_getpinnedclientkeyexchangekeybits(void* lpObj);
char* secureblackbox_ftpserver_getpinnedclientnamedeccurve(void* lpObj);
int secureblackbox_ftpserver_getpinnedclientpfscipher(void* lpObj);
char* secureblackbox_ftpserver_getpinnedclientpresharedidentity(void* lpObj);
char* secureblackbox_ftpserver_getpinnedclientpresharedidentityhint(void* lpObj);
int secureblackbox_ftpserver_getpinnedclientpublickeybits(void* lpObj);
char* secureblackbox_ftpserver_getpinnedclientremoteaddress(void* lpObj);
int secureblackbox_ftpserver_getpinnedclientremoteport(void* lpObj);
int secureblackbox_ftpserver_getpinnedclientresumedsession(void* lpObj);
int secureblackbox_ftpserver_getpinnedclientsecureconnection(void* lpObj);
int secureblackbox_ftpserver_getpinnedclientserverauthenticated(void* lpObj);
char* secureblackbox_ftpserver_getpinnedclientsignaturealgorithm(void* lpObj);
int secureblackbox_ftpserver_getpinnedclientsymmetricblocksize(void* lpObj);
int secureblackbox_ftpserver_getpinnedclientsymmetrickeybits(void* lpObj);
int64 secureblackbox_ftpserver_getpinnedclienttotalbytesreceived(void* lpObj);
int64 secureblackbox_ftpserver_getpinnedclienttotalbytessent(void* lpObj);
char* secureblackbox_ftpserver_getpinnedclientvalidationlog(void* lpObj);
char* secureblackbox_ftpserver_getpinnedclientversion(void* lpObj);
bool GetPinnedClientAEADCipher();

int GetPinnedClientChainValidationDetails();

int GetPinnedClientChainValidationResult();

QString GetPinnedClientCiphersuite();

bool GetPinnedClientClientAuthenticated();

bool GetPinnedClientClientAuthRequested();

bool GetPinnedClientConnectionEstablished();

QByteArray GetPinnedClientConnectionID();

QString GetPinnedClientDigestAlgorithm();

QString GetPinnedClientEncryptionAlgorithm();

bool GetPinnedClientExportable();

qint64 GetPinnedClientID();

QString GetPinnedClientKeyExchangeAlgorithm();

int GetPinnedClientKeyExchangeKeyBits();

QString GetPinnedClientNamedECCurve();

bool GetPinnedClientPFSCipher();

QString GetPinnedClientPreSharedIdentity();

QString GetPinnedClientPreSharedIdentityHint();

int GetPinnedClientPublicKeyBits();

QString GetPinnedClientRemoteAddress();

int GetPinnedClientRemotePort();

bool GetPinnedClientResumedSession();

bool GetPinnedClientSecureConnection();

bool GetPinnedClientServerAuthenticated();

QString GetPinnedClientSignatureAlgorithm();

int GetPinnedClientSymmetricBlockSize();

int GetPinnedClientSymmetricKeyBits();

qint64 GetPinnedClientTotalBytesReceived();

qint64 GetPinnedClientTotalBytesSent();

QString GetPinnedClientValidationLog();

QString GetPinnedClientVersion();

Remarks

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

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

Data Type

SecureBlackboxTLSConnectionInfo

PinnedClientChain Property (FTPServer Class)

Contains the certificate chain of the pinned client.

Syntax

SecureBlackboxList<SecureBlackboxCertificate>* GetPinnedClientChain();

int secureblackbox_ftpserver_getpinnedclientcertcount(void* lpObj);
int secureblackbox_ftpserver_getpinnedclientcertbytes(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertBytes, int* lenPinnedClientCertBytes);
int secureblackbox_ftpserver_getpinnedclientcertcakeyid(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertCAKeyID, int* lenPinnedClientCertCAKeyID);
char* secureblackbox_ftpserver_getpinnedclientcertfingerprint(void* lpObj, int pinnedclientcertindex);
int64 secureblackbox_ftpserver_getpinnedclientcerthandle(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_ftpserver_getpinnedclientcertissuer(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_ftpserver_getpinnedclientcertissuerrdn(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_ftpserver_getpinnedclientcertkeyalgorithm(void* lpObj, int pinnedclientcertindex);
int secureblackbox_ftpserver_getpinnedclientcertkeybits(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_ftpserver_getpinnedclientcertkeyfingerprint(void* lpObj, int pinnedclientcertindex);
int secureblackbox_ftpserver_getpinnedclientcertkeyusage(void* lpObj, int pinnedclientcertindex);
int secureblackbox_ftpserver_getpinnedclientcertpublickeybytes(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertPublicKeyBytes, int* lenPinnedClientCertPublicKeyBytes);
int secureblackbox_ftpserver_getpinnedclientcertselfsigned(void* lpObj, int pinnedclientcertindex);
int secureblackbox_ftpserver_getpinnedclientcertserialnumber(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertSerialNumber, int* lenPinnedClientCertSerialNumber);
char* secureblackbox_ftpserver_getpinnedclientcertsigalgorithm(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_ftpserver_getpinnedclientcertsubject(void* lpObj, int pinnedclientcertindex);
int secureblackbox_ftpserver_getpinnedclientcertsubjectkeyid(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertSubjectKeyID, int* lenPinnedClientCertSubjectKeyID);
char* secureblackbox_ftpserver_getpinnedclientcertsubjectrdn(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_ftpserver_getpinnedclientcertvalidfrom(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_ftpserver_getpinnedclientcertvalidto(void* lpObj, int pinnedclientcertindex);
int GetPinnedClientCertCount();

QByteArray GetPinnedClientCertBytes(int iPinnedClientCertIndex);

QByteArray GetPinnedClientCertCAKeyID(int iPinnedClientCertIndex);

QString GetPinnedClientCertFingerprint(int iPinnedClientCertIndex);

qint64 GetPinnedClientCertHandle(int iPinnedClientCertIndex);

QString GetPinnedClientCertIssuer(int iPinnedClientCertIndex);

QString GetPinnedClientCertIssuerRDN(int iPinnedClientCertIndex);

QString GetPinnedClientCertKeyAlgorithm(int iPinnedClientCertIndex);

int GetPinnedClientCertKeyBits(int iPinnedClientCertIndex);

QString GetPinnedClientCertKeyFingerprint(int iPinnedClientCertIndex);

int GetPinnedClientCertKeyUsage(int iPinnedClientCertIndex);

QByteArray GetPinnedClientCertPublicKeyBytes(int iPinnedClientCertIndex);

bool GetPinnedClientCertSelfSigned(int iPinnedClientCertIndex);

QByteArray GetPinnedClientCertSerialNumber(int iPinnedClientCertIndex);

QString GetPinnedClientCertSigAlgorithm(int iPinnedClientCertIndex);

QString GetPinnedClientCertSubject(int iPinnedClientCertIndex);

QByteArray GetPinnedClientCertSubjectKeyID(int iPinnedClientCertIndex);

QString GetPinnedClientCertSubjectRDN(int iPinnedClientCertIndex);

QString GetPinnedClientCertValidFrom(int iPinnedClientCertIndex);

QString GetPinnedClientCertValidTo(int iPinnedClientCertIndex);

Remarks

Use this property to access the certificate chain of the client connection pinned previously with a PinClient call.

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

Data Type

SecureBlackboxCertificate

Port Property (FTPServer Class)

The port number to listen for incoming connections on.

Syntax

ANSI (Cross Platform)
int GetPort();
int SetPort(int iPort); Unicode (Windows) INT GetPort();
INT SetPort(INT iPort);
int secureblackbox_ftpserver_getport(void* lpObj);
int secureblackbox_ftpserver_setport(void* lpObj, int iPort);
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

ANSI (Cross Platform)
int GetReadOnly();
int SetReadOnly(int bReadOnly); Unicode (Windows) BOOL GetReadOnly();
INT SetReadOnly(BOOL bReadOnly);
int secureblackbox_ftpserver_getreadonly(void* lpObj);
int secureblackbox_ftpserver_setreadonly(void* lpObj, int bReadOnly);
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

ANSI (Cross Platform)
char* GetRootDirectory();
int SetRootDirectory(const char* lpszRootDirectory); Unicode (Windows) LPWSTR GetRootDirectory();
INT SetRootDirectory(LPCWSTR lpszRootDirectory);
char* secureblackbox_ftpserver_getrootdirectory(void* lpObj);
int secureblackbox_ftpserver_setrootdirectory(void* lpObj, const char* lpszRootDirectory);
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

ANSI (Cross Platform)
int GetSecurityOptions();
int SetSecurityOptions(int iSecurityOptions); Unicode (Windows) INT GetSecurityOptions();
INT SetSecurityOptions(INT iSecurityOptions);
int secureblackbox_ftpserver_getsecurityoptions(void* lpObj);
int secureblackbox_ftpserver_setsecurityoptions(void* lpObj, int iSecurityOptions);
int GetSecurityOptions();
int SetSecurityOptions(int iSecurityOptions);

Default Value

63

Remarks

Various options of the secure connection:

cfsoPlainLogin1Allow logins over insecure connections

cfsoEncryption2Enable encryption

cfsoAuth4Enable AUTH command (explicit TLS)

cfsoClearControlChannel8Allow clear control channel mode

cfsoClearDataChannel16Allow clear data channel TLS connections

cfsoEncryptedDataChannel32Allow encrypted data channel TLS connections

Data Type

Integer

SessionTimeout Property (FTPServer Class)

Specifies the session timeout in milliseconds.

Syntax

ANSI (Cross Platform)
int GetSessionTimeout();
int SetSessionTimeout(int iSessionTimeout); Unicode (Windows) INT GetSessionTimeout();
INT SetSessionTimeout(INT iSessionTimeout);
int secureblackbox_ftpserver_getsessiontimeout(void* lpObj);
int secureblackbox_ftpserver_setsessiontimeout(void* lpObj, int iSessionTimeout);
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

SocketSettings Property (FTPServer Class)

Manages network connection settings.

Syntax

SecureBlackboxSocketSettings* GetSocketSettings();

int secureblackbox_ftpserver_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_ftpserver_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);
char* secureblackbox_ftpserver_getsocketlocaladdress(void* lpObj);
int secureblackbox_ftpserver_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);
int secureblackbox_ftpserver_getsocketlocalport(void* lpObj);
int secureblackbox_ftpserver_setsocketlocalport(void* lpObj, int iSocketLocalPort);
int secureblackbox_ftpserver_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_ftpserver_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);
int secureblackbox_ftpserver_getsockettimeout(void* lpObj);
int secureblackbox_ftpserver_setsockettimeout(void* lpObj, int iSocketTimeout);
int secureblackbox_ftpserver_getsocketuseipv6(void* lpObj);
int secureblackbox_ftpserver_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);
int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit); QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress); int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort); int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit); int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout); bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

Data Type

SecureBlackboxSocketSettings

TLSServerChain Property (FTPServer Class)

The server's TLS certificates.

Syntax

SecureBlackboxList<SecureBlackboxCertificate>* GetTLSServerChain();
int SetTLSServerChain(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_ftpserver_gettlsservercertcount(void* lpObj);
int secureblackbox_ftpserver_settlsservercertcount(void* lpObj, int iTLSServerCertCount);
int secureblackbox_ftpserver_gettlsservercertbytes(void* lpObj, int tlsservercertindex, char** lpTLSServerCertBytes, int* lenTLSServerCertBytes);
int64 secureblackbox_ftpserver_gettlsservercerthandle(void* lpObj, int tlsservercertindex);
int secureblackbox_ftpserver_settlsservercerthandle(void* lpObj, int tlsservercertindex, int64 lTLSServerCertHandle);
int GetTLSServerCertCount();
int SetTLSServerCertCount(int iTLSServerCertCount); QByteArray GetTLSServerCertBytes(int iTLSServerCertIndex); qint64 GetTLSServerCertHandle(int iTLSServerCertIndex);
int SetTLSServerCertHandle(int iTLSServerCertIndex, qint64 lTLSServerCertHandle);

Remarks

Use this property to provide a list of TLS certificates for the server endpoint.

A TLS endpoint needs a certificate to be able to accept TLS connections. At least one of the certificates in the collection - the endpoint certificate - must have a private key associated with it.

The collection may include more than one endpoint certificate, and more than one chain. A typical usage scenario is to include two chains (ECDSA and RSA), to cater for clients with different cipher suite preferences.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

TLSSettings Property (FTPServer Class)

Manages TLS layer settings.

Syntax

SecureBlackboxTLSSettings* GetTLSSettings();

int secureblackbox_ftpserver_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_ftpserver_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);
int secureblackbox_ftpserver_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_ftpserver_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);
char* secureblackbox_ftpserver_gettlsciphersuites(void* lpObj);
int secureblackbox_ftpserver_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);
int secureblackbox_ftpserver_gettlsclientauth(void* lpObj);
int secureblackbox_ftpserver_settlsclientauth(void* lpObj, int iTLSClientAuth);
char* secureblackbox_ftpserver_gettlseccurves(void* lpObj);
int secureblackbox_ftpserver_settlseccurves(void* lpObj, const char* lpszTLSECCurves);
char* secureblackbox_ftpserver_gettlsextensions(void* lpObj);
int secureblackbox_ftpserver_settlsextensions(void* lpObj, const char* lpszTLSExtensions);
int secureblackbox_ftpserver_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_ftpserver_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);
char* secureblackbox_ftpserver_gettlspresharedidentity(void* lpObj);
int secureblackbox_ftpserver_settlspresharedidentity(void* lpObj, const char* lpszTLSPreSharedIdentity);
char* secureblackbox_ftpserver_gettlspresharedkey(void* lpObj);
int secureblackbox_ftpserver_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);
char* secureblackbox_ftpserver_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_ftpserver_settlspresharedkeyciphersuite(void* lpObj, const char* lpszTLSPreSharedKeyCiphersuite);
int secureblackbox_ftpserver_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_ftpserver_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);
int secureblackbox_ftpserver_gettlsrevocationcheck(void* lpObj);
int secureblackbox_ftpserver_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);
int secureblackbox_ftpserver_gettlsssloptions(void* lpObj);
int secureblackbox_ftpserver_settlsssloptions(void* lpObj, int iTLSSSLOptions);
int secureblackbox_ftpserver_gettlstlsmode(void* lpObj);
int secureblackbox_ftpserver_settlstlsmode(void* lpObj, int iTLSTLSMode);
int secureblackbox_ftpserver_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_ftpserver_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);
int secureblackbox_ftpserver_gettlsusesessionresumption(void* lpObj);
int secureblackbox_ftpserver_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);
int secureblackbox_ftpserver_gettlsversions(void* lpObj);
int secureblackbox_ftpserver_settlsversions(void* lpObj, int iTLSVersions);
bool GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(bool bTLSAutoValidateCertificates); int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration); QString GetTLSCiphersuites();
int SetTLSCiphersuites(QString qsTLSCiphersuites); int GetTLSClientAuth();
int SetTLSClientAuth(int iTLSClientAuth); QString GetTLSECCurves();
int SetTLSECCurves(QString qsTLSECCurves); QString GetTLSExtensions();
int SetTLSExtensions(QString qsTLSExtensions); bool GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(bool bTLSForceResumeIfDestinationChanges); QString GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(QString qsTLSPreSharedIdentity); QString GetTLSPreSharedKey();
int SetTLSPreSharedKey(QString qsTLSPreSharedKey); QString GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(QString qsTLSPreSharedKeyCiphersuite); int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode); int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck); int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions); int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode); bool GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(bool bTLSUseExtendedMasterSecret); bool GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(bool bTLSUseSessionResumption); int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);

Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

Data Type

SecureBlackboxTLSSettings

Users Property (FTPServer Class)

Provides a list of registered users.

Syntax

int secureblackbox_ftpserver_getusercount(void* lpObj);
int secureblackbox_ftpserver_setusercount(void* lpObj, int iUserCount);
int secureblackbox_ftpserver_getuserassociateddata(void* lpObj, int userindex, char** lpUserAssociatedData, int* lenUserAssociatedData);
int secureblackbox_ftpserver_setuserassociateddata(void* lpObj, int userindex, const char* lpUserAssociatedData, int lenUserAssociatedData);
char* secureblackbox_ftpserver_getuserbasepath(void* lpObj, int userindex);
int secureblackbox_ftpserver_setuserbasepath(void* lpObj, int userindex, const char* lpszUserBasePath);
char* secureblackbox_ftpserver_getuserdata(void* lpObj, int userindex);
int secureblackbox_ftpserver_setuserdata(void* lpObj, int userindex, const char* lpszUserData);
int64 secureblackbox_ftpserver_getuserhandle(void* lpObj, int userindex);
int secureblackbox_ftpserver_setuserhandle(void* lpObj, int userindex, int64 lUserHandle);
char* secureblackbox_ftpserver_getuserhashalgorithm(void* lpObj, int userindex);
int secureblackbox_ftpserver_setuserhashalgorithm(void* lpObj, int userindex, const char* lpszUserHashAlgorithm);
int secureblackbox_ftpserver_getuserincomingspeedlimit(void* lpObj, int userindex);
int secureblackbox_ftpserver_setuserincomingspeedlimit(void* lpObj, int userindex, int iUserIncomingSpeedLimit);
int secureblackbox_ftpserver_getuseroutgoingspeedlimit(void* lpObj, int userindex);
int secureblackbox_ftpserver_setuseroutgoingspeedlimit(void* lpObj, int userindex, int iUserOutgoingSpeedLimit);
char* secureblackbox_ftpserver_getuserpassword(void* lpObj, int userindex);
int secureblackbox_ftpserver_setuserpassword(void* lpObj, int userindex, const char* lpszUserPassword);
int secureblackbox_ftpserver_getusersharedsecret(void* lpObj, int userindex, char** lpUserSharedSecret, int* lenUserSharedSecret);
int secureblackbox_ftpserver_setusersharedsecret(void* lpObj, int userindex, const char* lpUserSharedSecret, int lenUserSharedSecret);
char* secureblackbox_ftpserver_getuserusername(void* lpObj, int userindex);
int secureblackbox_ftpserver_setuserusername(void* lpObj, int userindex, const char* lpszUserUsername);
int GetUserCount();
int SetUserCount(int iUserCount); QByteArray GetUserAssociatedData(int iUserIndex);
int SetUserAssociatedData(int iUserIndex, QByteArray qbaUserAssociatedData); QString GetUserBasePath(int iUserIndex);
int SetUserBasePath(int iUserIndex, QString qsUserBasePath); QString GetUserData(int iUserIndex);
int SetUserData(int iUserIndex, QString qsUserData); qint64 GetUserHandle(int iUserIndex);
int SetUserHandle(int iUserIndex, qint64 lUserHandle); QString GetUserHashAlgorithm(int iUserIndex);
int SetUserHashAlgorithm(int iUserIndex, QString qsUserHashAlgorithm); int GetUserIncomingSpeedLimit(int iUserIndex);
int SetUserIncomingSpeedLimit(int iUserIndex, int iUserIncomingSpeedLimit); int GetUserOutgoingSpeedLimit(int iUserIndex);
int SetUserOutgoingSpeedLimit(int iUserIndex, int iUserOutgoingSpeedLimit); QString GetUserPassword(int iUserIndex);
int SetUserPassword(int iUserIndex, QString qsUserPassword); QByteArray GetUserSharedSecret(int iUserIndex);
int SetUserSharedSecret(int iUserIndex, QByteArray qbaUserSharedSecret); QString GetUserUsername(int iUserIndex);
int SetUserUsername(int iUserIndex, QString qsUserUsername);

Remarks

Assign a list of 'known' users to this property to automate authentication handling by the class.

This property is not available at design time.

Data Type

SecureBlackboxUserAccount

UseUTF8 Property (FTPServer Class)

Enables or disables UTF8 file name conversions.

Syntax

ANSI (Cross Platform)
int GetUseUTF8();
int SetUseUTF8(int bUseUTF8); Unicode (Windows) BOOL GetUseUTF8();
INT SetUseUTF8(BOOL bUseUTF8);
int secureblackbox_ftpserver_getuseutf8(void* lpObj);
int secureblackbox_ftpserver_setuseutf8(void* lpObj, int bUseUTF8);
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

Cleanup Method (FTPServer Class)

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

Syntax

ANSI (Cross Platform)
int Cleanup();

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

Remarks

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

Error Handling (C++)

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

Config Method (FTPServer Class)

Sets or retrieves a configuration setting.

Syntax

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

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

Remarks

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

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

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

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

Error Handling (C++)

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

DoAction Method (FTPServer Class)

Performs an additional action.

Syntax

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

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

Remarks

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

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

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

Common ActionIDs:

ActionParametersReturned valueDescription
ResetTrustedListCachenonenoneClears the cached list of trusted lists.
ResetCertificateCachenonenoneClears the cached certificates.
ResetCRLCachenonenoneClears the cached CRLs.
ResetOCSPResponseCachenonenoneClears the cached OCSP responses.

Error Handling (C++)

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

DropClient Method (FTPServer Class)

Terminates a client connection.

Syntax

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

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

Remarks

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

Error Handling (C++)

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

GetClientBuffer Method (FTPServer Class)

Obtains a pending connection buffer.

Syntax

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

Unicode (Windows)
LPSTR GetClientBuffer(LONG64 lConnectionID, LPINT lpSize = NULL);
char* secureblackbox_ftpserver_getclientbuffer(void* lpObj, int64 lConnectionID, int *lpSize);
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 (C++)

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

ListClients Method (FTPServer Class)

Enumerates the connected clients.

Syntax

ANSI (Cross Platform)
char* ListClients();

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

Remarks

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

Error Handling (C++)

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

PinClient Method (FTPServer Class)

Takes a snapshot of the connection's properties.

Syntax

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

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

Remarks

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

Error Handling (C++)

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

Reset Method (FTPServer Class)

Resets the class settings.

Syntax

ANSI (Cross Platform)
int Reset();

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

Remarks

Reset is a generic method available in every class.

Error Handling (C++)

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

SetClientBuffer Method (FTPServer Class)

Commits a data buffer to the connection.

Syntax

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

Unicode (Windows)
INT SetClientBuffer(LONG64 lConnectionID, LPCSTR lpValue, INT lenValue);
int secureblackbox_ftpserver_setclientbuffer(void* lpObj, int64 lConnectionID, const char* lpValue, int lenValue);
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 (C++)

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

SetClientFileEntry Method (FTPServer Class)

Commits a file entry to the connection.

Syntax

ANSI (Cross Platform)
int SetClientFileEntry(int64 lConnectionID);

Unicode (Windows)
INT SetClientFileEntry(LONG64 lConnectionID);
int secureblackbox_ftpserver_setclientfileentry(void* lpObj, int64 lConnectionID);
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 (C++)

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

Start Method (FTPServer Class)

Starts the server.

Syntax

ANSI (Cross Platform)
int Start();

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

Remarks

Call this method to start listening for incoming connections on port Port. Call Stop to deactivate the server.

Error Handling (C++)

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

Stop Method (FTPServer Class)

Stops the server.

Syntax

ANSI (Cross Platform)
int Stop();

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

Remarks

Call this method to terminate all active sessions and stop listening for new incoming connections.

Error Handling (C++)

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

Accept Event (FTPServer Class)

Reports an incoming connection.

Syntax

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

virtual INT SECUREBLACKBOX_CALL FireAccept(LPSTR &lpszRemoteAddress, INT &iRemotePort, BOOL &bAccept);
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

ANSI (Cross Platform)
virtual int FireAfterChangeDirectory(FTPServerAfterChangeDirectoryEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Directory;
int OperationStatus; int reserved; } FTPServerAfterChangeDirectoryEventParams;
Unicode (Windows) virtual INT FireAfterChangeDirectory(FTPServerAfterChangeDirectoryEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Directory;
INT OperationStatus; INT reserved; } FTPServerAfterChangeDirectoryEventParams;
#define EID_FTPSERVER_AFTERCHANGEDIRECTORY 2

virtual INT SECUREBLACKBOX_CALL FireAfterChangeDirectory(LONG64 &lConnectionID, LPSTR &lpszDirectory, INT &iOperationStatus);
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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

AfterCreateDirectory Event (FTPServer Class)

Signals the completion of a directory creation operation.

Syntax

ANSI (Cross Platform)
virtual int FireAfterCreateDirectory(FTPServerAfterCreateDirectoryEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Directory;
int OperationStatus; int reserved; } FTPServerAfterCreateDirectoryEventParams;
Unicode (Windows) virtual INT FireAfterCreateDirectory(FTPServerAfterCreateDirectoryEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Directory;
INT OperationStatus; INT reserved; } FTPServerAfterCreateDirectoryEventParams;
#define EID_FTPSERVER_AFTERCREATEDIRECTORY 3

virtual INT SECUREBLACKBOX_CALL FireAfterCreateDirectory(LONG64 &lConnectionID, LPSTR &lpszDirectory, INT &iOperationStatus);
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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

AfterRemoveDirectory Event (FTPServer Class)

Signals the completion of a directory removal operation.

Syntax

ANSI (Cross Platform)
virtual int FireAfterRemoveDirectory(FTPServerAfterRemoveDirectoryEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Directory;
int OperationStatus; int reserved; } FTPServerAfterRemoveDirectoryEventParams;
Unicode (Windows) virtual INT FireAfterRemoveDirectory(FTPServerAfterRemoveDirectoryEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Directory;
INT OperationStatus; INT reserved; } FTPServerAfterRemoveDirectoryEventParams;
#define EID_FTPSERVER_AFTERREMOVEDIRECTORY 4

virtual INT SECUREBLACKBOX_CALL FireAfterRemoveDirectory(LONG64 &lConnectionID, LPSTR &lpszDirectory, INT &iOperationStatus);
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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

AfterRemoveFile Event (FTPServer Class)

Signals the completion of a file removal operation.

Syntax

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

virtual INT SECUREBLACKBOX_CALL FireAfterRemoveFile(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iOperationStatus);
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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

AfterRenameFile Event (FTPServer Class)

Signals the completion of a file renaming operation.

Syntax

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

virtual INT SECUREBLACKBOX_CALL FireAfterRenameFile(LONG64 &lConnectionID, LPSTR &lpszOldPath, LPSTR &lpszNewPath, INT &iOperationStatus);
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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

AfterRequestAttributes Event (FTPServer Class)

Signals the completion of an attribute request.

Syntax

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

virtual INT SECUREBLACKBOX_CALL FireAfterRequestAttributes(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iOperationStatus);
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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

AuthAttempt Event (FTPServer Class)

Fires when a connected client makes an authentication attempt.

Syntax

ANSI (Cross Platform)
virtual int FireAuthAttempt(FTPServerAuthAttemptEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Username;
const char *Password;
int Allow;
char *BasePath; int reserved; } FTPServerAuthAttemptEventParams;
Unicode (Windows) virtual INT FireAuthAttempt(FTPServerAuthAttemptEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Username;
LPCWSTR Password;
BOOL Allow;
LPWSTR BasePath; INT reserved; } FTPServerAuthAttemptEventParams;
#define EID_FTPSERVER_AUTHATTEMPT 8

virtual INT SECUREBLACKBOX_CALL FireAuthAttempt(LONG64 &lConnectionID, LPSTR &lpszUsername, LPSTR &lpszPassword, BOOL &bAllow, LPSTR &lpszBasePath);
class FTPServerAuthAttemptEventParams {
public:
  qint64 ConnectionID();

  const QString &Username();

  const QString &Password();

  bool Allow();
  void SetAllow(bool bAllow);

  const QString &BasePath();
  void SetBasePath(const QString &qsBasePath);

  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.

The BasePath parameter specifies the home directory that will be used for this client. This is taken from the client's record in Users, or from RootDirectory if the client is not present in the list. You can adjust it in the event handler if required.

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

ANSI (Cross Platform)
virtual int FireBeforeChangeDirectory(FTPServerBeforeChangeDirectoryEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Directory;
int Action; int reserved; } FTPServerBeforeChangeDirectoryEventParams;
Unicode (Windows) virtual INT FireBeforeChangeDirectory(FTPServerBeforeChangeDirectoryEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Directory;
INT Action; INT reserved; } FTPServerBeforeChangeDirectoryEventParams;
#define EID_FTPSERVER_BEFORECHANGEDIRECTORY 9

virtual INT SECUREBLACKBOX_CALL FireBeforeChangeDirectory(LONG64 &lConnectionID, LPSTR &lpszDirectory, INT &iAction);
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:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

BeforeCreateDirectory Event (FTPServer Class)

Notifies about an incoming create directory request.

Syntax

ANSI (Cross Platform)
virtual int FireBeforeCreateDirectory(FTPServerBeforeCreateDirectoryEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Directory;
int Action; int reserved; } FTPServerBeforeCreateDirectoryEventParams;
Unicode (Windows) virtual INT FireBeforeCreateDirectory(FTPServerBeforeCreateDirectoryEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Directory;
INT Action; INT reserved; } FTPServerBeforeCreateDirectoryEventParams;
#define EID_FTPSERVER_BEFORECREATEDIRECTORY 10

virtual INT SECUREBLACKBOX_CALL FireBeforeCreateDirectory(LONG64 &lConnectionID, LPSTR &lpszDirectory, INT &iAction);
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:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

BeforeDownloadFile Event (FTPServer Class)

Notifies about an incoming file download request.

Syntax

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

virtual INT SECUREBLACKBOX_CALL FireBeforeDownloadFile(LONG64 &lConnectionID, LPSTR &lpszPath, LONG64 &lRestartAt, INT &iAction);
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:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

BeforeFind Event (FTPServer Class)

Notifies about an incoming file listing request.

Syntax

ANSI (Cross Platform)
virtual int FireBeforeFind(FTPServerBeforeFindEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Directory;
int Action; int reserved; } FTPServerBeforeFindEventParams;
Unicode (Windows) virtual INT FireBeforeFind(FTPServerBeforeFindEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Directory;
INT Action; INT reserved; } FTPServerBeforeFindEventParams;
#define EID_FTPSERVER_BEFOREFIND 12

virtual INT SECUREBLACKBOX_CALL FireBeforeFind(LONG64 &lConnectionID, LPSTR &lpszDirectory, INT &iAction);
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:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

BeforeRemoveDirectory Event (FTPServer Class)

Notifies about an incoming directory removal request.

Syntax

ANSI (Cross Platform)
virtual int FireBeforeRemoveDirectory(FTPServerBeforeRemoveDirectoryEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Directory;
int Action; int reserved; } FTPServerBeforeRemoveDirectoryEventParams;
Unicode (Windows) virtual INT FireBeforeRemoveDirectory(FTPServerBeforeRemoveDirectoryEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Directory;
INT Action; INT reserved; } FTPServerBeforeRemoveDirectoryEventParams;
#define EID_FTPSERVER_BEFOREREMOVEDIRECTORY 13

virtual INT SECUREBLACKBOX_CALL FireBeforeRemoveDirectory(LONG64 &lConnectionID, LPSTR &lpszDirectory, INT &iAction);
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:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

BeforeRemoveFile Event (FTPServer Class)

Notifies about an incoming file removal request.

Syntax

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

virtual INT SECUREBLACKBOX_CALL FireBeforeRemoveFile(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iAction);
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:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

Note that you must subscribe to BeforeRequestAttributes and RequestAttributes events to be able to use this event in an FTP server attached to a virtual file system. This is because the server checks the existence of the source file before commencing the deletion procedure. In the virtualized case, you can confirm the existence of the file by returning its details from RequestAttributes call.

BeforeRenameFile Event (FTPServer Class)

Notifies about an incoming file rename request.

Syntax

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

virtual INT SECUREBLACKBOX_CALL FireBeforeRenameFile(LONG64 &lConnectionID, LPSTR &lpszOldPath, LPSTR &lpszNewPath, INT &iAction);
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:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

Note that you must subscribe to BeforeRequestAttributes and RequestAttributes events to be able to use this event in an FTP server attached to a virtual file system. This is because the server checks the existence of the source file before commencing the renaming procedure. In the virtualized case, you can confirm the existence of the file by returning its details from RequestAttributes call.

BeforeRequestAttributes Event (FTPServer Class)

Notifies about an incoming attributes request.

Syntax

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

virtual INT SECUREBLACKBOX_CALL FireBeforeRequestAttributes(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iAction);
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:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

BeforeSendReply Event (FTPServer Class)

Notifies the application of a command reply being sent.

Syntax

ANSI (Cross Platform)
virtual int FireBeforeSendReply(FTPServerBeforeSendReplyEventParams *e);
typedef struct {
int64 ConnectionID;
int Code;
char *Reply;
const char *Command; int reserved; } FTPServerBeforeSendReplyEventParams;
Unicode (Windows) virtual INT FireBeforeSendReply(FTPServerBeforeSendReplyEventParams *e);
typedef struct {
LONG64 ConnectionID;
INT Code;
LPWSTR Reply;
LPCWSTR Command; INT reserved; } FTPServerBeforeSendReplyEventParams;
#define EID_FTPSERVER_BEFORESENDREPLY 17

virtual INT SECUREBLACKBOX_CALL FireBeforeSendReply(LONG64 &lConnectionID, INT &iCode, LPSTR &lpszReply, LPSTR &lpszCommand);
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

ANSI (Cross Platform)
virtual int FireBeforeUploadFile(FTPServerBeforeUploadFileEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path;
int64 RestartAt;
int Append;
int Action; int reserved; } FTPServerBeforeUploadFileEventParams;
Unicode (Windows) virtual INT FireBeforeUploadFile(FTPServerBeforeUploadFileEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path;
LONG64 RestartAt;
BOOL Append;
INT Action; INT reserved; } FTPServerBeforeUploadFileEventParams;
#define EID_FTPSERVER_BEFOREUPLOADFILE 18

virtual INT SECUREBLACKBOX_CALL FireBeforeUploadFile(LONG64 &lConnectionID, LPSTR &lpszPath, LONG64 &lRestartAt, BOOL &bAppend, INT &iAction);
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:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

ChangeDirectory Event (FTPServer Class)

An override for a directory change operation.

Syntax

ANSI (Cross Platform)
virtual int FireChangeDirectory(FTPServerChangeDirectoryEventParams *e);
typedef struct {
int64 ConnectionID;
char *Directory;
int OperationStatus; int reserved; } FTPServerChangeDirectoryEventParams;
Unicode (Windows) virtual INT FireChangeDirectory(FTPServerChangeDirectoryEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPWSTR Directory;
INT OperationStatus; INT reserved; } FTPServerChangeDirectoryEventParams;
#define EID_FTPSERVER_CHANGEDIRECTORY 19

virtual INT SECUREBLACKBOX_CALL FireChangeDirectory(LONG64 &lConnectionID, LPSTR &lpszDirectory, INT &iOperationStatus);
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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

CommandProcessed Event (FTPServer Class)

Signals that a command has been processed by the server.

Syntax

ANSI (Cross Platform)
virtual int FireCommandProcessed(FTPServerCommandProcessedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *CurrentDirectory;
const char *Command;
int ReplyCode; int reserved; } FTPServerCommandProcessedEventParams;
Unicode (Windows) virtual INT FireCommandProcessed(FTPServerCommandProcessedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR CurrentDirectory;
LPCWSTR Command;
INT ReplyCode; INT reserved; } FTPServerCommandProcessedEventParams;
#define EID_FTPSERVER_COMMANDPROCESSED 20

virtual INT SECUREBLACKBOX_CALL FireCommandProcessed(LONG64 &lConnectionID, LPSTR &lpszCurrentDirectory, LPSTR &lpszCommand, INT &iReplyCode);
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

ANSI (Cross Platform)
virtual int FireCommandReceived(FTPServerCommandReceivedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Command;
const char *Parameters;
int Ignore; int reserved; } FTPServerCommandReceivedEventParams;
Unicode (Windows) virtual INT FireCommandReceived(FTPServerCommandReceivedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Command;
LPCWSTR Parameters;
BOOL Ignore; INT reserved; } FTPServerCommandReceivedEventParams;
#define EID_FTPSERVER_COMMANDRECEIVED 21

virtual INT SECUREBLACKBOX_CALL FireCommandReceived(LONG64 &lConnectionID, LPSTR &lpszCommand, LPSTR &lpszParameters, BOOL &bIgnore);
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

ANSI (Cross Platform)
virtual int FireConnect(FTPServerConnectEventParams *e);
typedef struct {
int64 ConnectionID;
const char *RemoteAddress;
int Port; int reserved; } FTPServerConnectEventParams;
Unicode (Windows) virtual INT FireConnect(FTPServerConnectEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR RemoteAddress;
INT Port; INT reserved; } FTPServerConnectEventParams;
#define EID_FTPSERVER_CONNECT 22

virtual INT SECUREBLACKBOX_CALL FireConnect(LONG64 &lConnectionID, LPSTR &lpszRemoteAddress, INT &iPort);
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

ANSI (Cross Platform)
virtual int FireCreateDirectory(FTPServerCreateDirectoryEventParams *e);
typedef struct {
int64 ConnectionID;
char *Directory;
int OperationStatus; int reserved; } FTPServerCreateDirectoryEventParams;
Unicode (Windows) virtual INT FireCreateDirectory(FTPServerCreateDirectoryEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPWSTR Directory;
INT OperationStatus; INT reserved; } FTPServerCreateDirectoryEventParams;
#define EID_FTPSERVER_CREATEDIRECTORY 23

virtual INT SECUREBLACKBOX_CALL FireCreateDirectory(LONG64 &lConnectionID, LPSTR &lpszDirectory, INT &iOperationStatus);
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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

Disconnect Event (FTPServer Class)

Fires to report a disconnected client.

Syntax

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

virtual INT SECUREBLACKBOX_CALL FireDisconnect(LONG64 &lConnectionID);
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)

The class fires this event to notify the application about the start of a file download.

Syntax

ANSI (Cross Platform)
virtual int FireDownloadBegin(FTPServerDownloadBeginEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path; int reserved; } FTPServerDownloadBeginEventParams;
Unicode (Windows) virtual INT FireDownloadBegin(FTPServerDownloadBeginEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path; INT reserved; } FTPServerDownloadBeginEventParams;
#define EID_FTPSERVER_DOWNLOADBEGIN 25

virtual INT SECUREBLACKBOX_CALL FireDownloadBegin(LONG64 &lConnectionID, LPSTR &lpszPath);
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

Subscribe to this event to get notified about the beginning of a file download operation. The requested file is specified via the Path property.

DownloadEnd Event (FTPServer Class)

Reports the completion of the download operation.

Syntax

ANSI (Cross Platform)
virtual int FireDownloadEnd(FTPServerDownloadEndEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path; int reserved; } FTPServerDownloadEndEventParams;
Unicode (Windows) virtual INT FireDownloadEnd(FTPServerDownloadEndEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path; INT reserved; } FTPServerDownloadEndEventParams;
#define EID_FTPSERVER_DOWNLOADEND 26

virtual INT SECUREBLACKBOX_CALL FireDownloadEnd(LONG64 &lConnectionID, LPSTR &lpszPath);
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

Use this event to get notified about completion of the early initiated file download operation.

DownloadFile Event (FTPServer Class)

An override for a file download initiation operation.

Syntax

ANSI (Cross Platform)
virtual int FireDownloadFile(FTPServerDownloadFileEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path;
int64 RestartAt;
int OperationStatus; int reserved; } FTPServerDownloadFileEventParams;
Unicode (Windows) virtual INT FireDownloadFile(FTPServerDownloadFileEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path;
LONG64 RestartAt;
INT OperationStatus; INT reserved; } FTPServerDownloadFileEventParams;
#define EID_FTPSERVER_DOWNLOADFILE 27

virtual INT SECUREBLACKBOX_CALL FireDownloadFile(LONG64 &lConnectionID, LPSTR &lpszPath, LONG64 &lRestartAt, INT &iOperationStatus);
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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

DownloadProgress Event (FTPServer Class)

Reports the progress of an active download operation.

Syntax

ANSI (Cross Platform)
virtual int FireDownloadProgress(FTPServerDownloadProgressEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path;
int64 Progress;
int64 Total; int reserved; } FTPServerDownloadProgressEventParams;
Unicode (Windows) virtual INT FireDownloadProgress(FTPServerDownloadProgressEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path;
LONG64 Progress;
LONG64 Total; INT reserved; } FTPServerDownloadProgressEventParams;
#define EID_FTPSERVER_DOWNLOADPROGRESS 28

virtual INT SECUREBLACKBOX_CALL FireDownloadProgress(LONG64 &lConnectionID, LPSTR &lpszPath, LONG64 &lProgress, LONG64 &lTotal);
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

Subscribe to this event to be notified about the progress of an active download operation.

The Path parameter contains the path to the file being downloaded, and Progress and Total reflect the operation progress. Note that the Total parameter may be set to -1 if the size of the downloaded file is not known.

Error Event (FTPServer Class)

Information about errors during data delivery.

Syntax

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

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

  int ErrorCode();

  bool Fatal();

  bool Remote();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Error(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

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

virtual INT SECUREBLACKBOX_CALL FireExternalSign(LONG64 &lConnectionID, LPSTR &lpszOperationId, LPSTR &lpszHashAlgorithm, LPSTR &lpszPars, LPSTR &lpszData, LPSTR &lpszSignedData);
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 class via the SignedData parameter.

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

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

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

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

FindClose Event (FTPServer Class)

Signals the completion of a directory listing request.

Syntax

ANSI (Cross Platform)
virtual int FireFindClose(FTPServerFindCloseEventParams *e);
typedef struct {
int64 ConnectionID;
int OperationStatus; int reserved; } FTPServerFindCloseEventParams;
Unicode (Windows) virtual INT FireFindClose(FTPServerFindCloseEventParams *e);
typedef struct {
LONG64 ConnectionID;
INT OperationStatus; INT reserved; } FTPServerFindCloseEventParams;
#define EID_FTPSERVER_FINDCLOSE 31

virtual INT SECUREBLACKBOX_CALL FireFindClose(LONG64 &lConnectionID, INT &iOperationStatus);
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

ANSI (Cross Platform)
virtual int FireFindInit(FTPServerFindInitEventParams *e);
typedef struct {
int64 ConnectionID;
char *Directory;
int OperationStatus; int reserved; } FTPServerFindInitEventParams;
Unicode (Windows) virtual INT FireFindInit(FTPServerFindInitEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPWSTR Directory;
INT OperationStatus; INT reserved; } FTPServerFindInitEventParams;
#define EID_FTPSERVER_FINDINIT 32

virtual INT SECUREBLACKBOX_CALL FireFindInit(LONG64 &lConnectionID, LPSTR &lpszDirectory, INT &iOperationStatus);
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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

FindNext Event (FTPServer Class)

An override for a directory listing entry request operation.

Syntax

ANSI (Cross Platform)
virtual int FireFindNext(FTPServerFindNextEventParams *e);
typedef struct {
int64 ConnectionID;
int OperationStatus; int reserved; } FTPServerFindNextEventParams;
Unicode (Windows) virtual INT FireFindNext(FTPServerFindNextEventParams *e);
typedef struct {
LONG64 ConnectionID;
INT OperationStatus; INT reserved; } FTPServerFindNextEventParams;
#define EID_FTPSERVER_FINDNEXT 33

virtual INT SECUREBLACKBOX_CALL FireFindNext(LONG64 &lConnectionID, INT &iOperationStatus);
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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

Notification Event (FTPServer Class)

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

Syntax

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

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
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 class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

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

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

DownloadProgressReports 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

UploadProgressReports the progress of the current upload operation. The format of EventParam is identical to the one used by the DownloadProgress.
DownloadBeginIndicates the start of the download operation. The EventParam value has the following format:

ConnectionID=8;Path=/dir/file

UploadBeginIndicates the start of the upload operation. The EventParam format is the same as with the DownloadBegin event ID.
DownloadEndIndicates the completion of the download operation. The EventParam value has the following format:

ConnectionID=8;Path=/dir/file

UploadEndIndicates the completion of the upload operation. The EventParam format is the same as with the DownloadEnd event ID.
ListeningStartedNotifies the application that the server has started listening for incoming connections.
ListeningStoppedNotifies the application that the server has stopped listening to incoming connections.

ReadFile Event (FTPServer Class)

Requests a piece of file data from the application.

Syntax

ANSI (Cross Platform)
virtual int FireReadFile(FTPServerReadFileEventParams *e);
typedef struct {
int64 ConnectionID;
int Size;
int OperationStatus; int reserved; } FTPServerReadFileEventParams;
Unicode (Windows) virtual INT FireReadFile(FTPServerReadFileEventParams *e);
typedef struct {
LONG64 ConnectionID;
INT Size;
INT OperationStatus; INT reserved; } FTPServerReadFileEventParams;
#define EID_FTPSERVER_READFILE 35

virtual INT SECUREBLACKBOX_CALL FireReadFile(LONG64 &lConnectionID, INT &iSize, INT &iOperationStatus);
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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

RemoveDirectory Event (FTPServer Class)

An override for a directory removal operation.

Syntax

ANSI (Cross Platform)
virtual int FireRemoveDirectory(FTPServerRemoveDirectoryEventParams *e);
typedef struct {
int64 ConnectionID;
char *Directory;
int OperationStatus; int reserved; } FTPServerRemoveDirectoryEventParams;
Unicode (Windows) virtual INT FireRemoveDirectory(FTPServerRemoveDirectoryEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPWSTR Directory;
INT OperationStatus; INT reserved; } FTPServerRemoveDirectoryEventParams;
#define EID_FTPSERVER_REMOVEDIRECTORY 36

virtual INT SECUREBLACKBOX_CALL FireRemoveDirectory(LONG64 &lConnectionID, LPSTR &lpszDirectory, INT &iOperationStatus);
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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

RemoveFile Event (FTPServer Class)

An override for a file remove operation.

Syntax

ANSI (Cross Platform)
virtual int FireRemoveFile(FTPServerRemoveFileEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path;
int OperationStatus; int reserved; } FTPServerRemoveFileEventParams;
Unicode (Windows) virtual INT FireRemoveFile(FTPServerRemoveFileEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path;
INT OperationStatus; INT reserved; } FTPServerRemoveFileEventParams;
#define EID_FTPSERVER_REMOVEFILE 37

virtual INT SECUREBLACKBOX_CALL FireRemoveFile(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iOperationStatus);
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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

Please see a remark about virtualizing file removals in the BeforeRemoveFile topic.

RenameFile Event (FTPServer Class)

An override for a file rename operation.

Syntax

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

virtual INT SECUREBLACKBOX_CALL FireRenameFile(LONG64 &lConnectionID, LPSTR &lpszOldPath, LPSTR &lpszNewPath, INT &iOperationStatus);
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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

Please see a remark about virtualizing file renamings in the BeforeRenameFile topic.

RequestAttributes Event (FTPServer Class)

An override for an attribute request.

Syntax

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

virtual INT SECUREBLACKBOX_CALL FireRequestAttributes(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iOperationStatus);
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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

TLSCertValidate Event (FTPServer Class)

Fires when a client certificate needs to be validated.

Syntax

ANSI (Cross Platform)
virtual int FireTLSCertValidate(FTPServerTLSCertValidateEventParams *e);
typedef struct {
int64 ConnectionID;
int Accept; int reserved; } FTPServerTLSCertValidateEventParams;
Unicode (Windows) virtual INT FireTLSCertValidate(FTPServerTLSCertValidateEventParams *e);
typedef struct {
LONG64 ConnectionID;
BOOL Accept; INT reserved; } FTPServerTLSCertValidateEventParams;
#define EID_FTPSERVER_TLSCERTVALIDATE 40

virtual INT SECUREBLACKBOX_CALL FireTLSCertValidate(LONG64 &lConnectionID, BOOL &bAccept);
class FTPServerTLSCertValidateEventParams {
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 TLSCertValidate(FTPServerTLSCertValidateEventParams *e);
// Or, subclass FTPServer and override this emitter function. virtual int FireTLSCertValidate(FTPServerTLSCertValidateEventParams *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.

TLSEstablished Event (FTPServer Class)

Reports the setup of a TLS session.

Syntax

ANSI (Cross Platform)
virtual int FireTLSEstablished(FTPServerTLSEstablishedEventParams *e);
typedef struct {
int64 ConnectionID; int reserved; } FTPServerTLSEstablishedEventParams;
Unicode (Windows) virtual INT FireTLSEstablished(FTPServerTLSEstablishedEventParams *e);
typedef struct {
LONG64 ConnectionID; INT reserved; } FTPServerTLSEstablishedEventParams;
#define EID_FTPSERVER_TLSESTABLISHED 41

virtual INT SECUREBLACKBOX_CALL FireTLSEstablished(LONG64 &lConnectionID);
class FTPServerTLSEstablishedEventParams {
public:
  qint64 ConnectionID();

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

Remarks

Subscribe to this event to be notified about the setup of a TLS connection by a connected client.

TLSHandshake Event (FTPServer Class)

Fires when a newly established client connection initiates a TLS handshake.

Syntax

ANSI (Cross Platform)
virtual int FireTLSHandshake(FTPServerTLSHandshakeEventParams *e);
typedef struct {
int64 ConnectionID;
const char *ServerName;
int Abort; int reserved; } FTPServerTLSHandshakeEventParams;
Unicode (Windows) virtual INT FireTLSHandshake(FTPServerTLSHandshakeEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR ServerName;
BOOL Abort; INT reserved; } FTPServerTLSHandshakeEventParams;
#define EID_FTPSERVER_TLSHANDSHAKE 42

virtual INT SECUREBLACKBOX_CALL FireTLSHandshake(LONG64 &lConnectionID, LPSTR &lpszServerName, BOOL &bAbort);
class FTPServerTLSHandshakeEventParams {
public:
  qint64 ConnectionID();

  const QString &ServerName();

  bool Abort();
  void SetAbort(bool bAbort);

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

Remarks

Use this event to get notified about the initiation of the TLS handshake by the remote client. The ServerName parameter specifies the requested host from the client hello message.

TLSPSK Event (FTPServer Class)

Requests a pre-shared key for TLS-PSK.

Syntax

ANSI (Cross Platform)
virtual int FireTLSPSK(FTPServerTLSPSKEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Identity;
char *PSK;
char *Ciphersuite; int reserved; } FTPServerTLSPSKEventParams;
Unicode (Windows) virtual INT FireTLSPSK(FTPServerTLSPSKEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Identity;
LPWSTR PSK;
LPWSTR Ciphersuite; INT reserved; } FTPServerTLSPSKEventParams;
#define EID_FTPSERVER_TLSPSK 43

virtual INT SECUREBLACKBOX_CALL FireTLSPSK(LONG64 &lConnectionID, LPSTR &lpszIdentity, LPSTR &lpszPSK, LPSTR &lpszCiphersuite);
class FTPServerTLSPSKEventParams {
public:
  qint64 ConnectionID();

  const QString &Identity();

  const QString &PSK();
  void SetPSK(const QString &qsPSK);

  const QString &Ciphersuite();
  void SetCiphersuite(const QString &qsCiphersuite);

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

Remarks

The class fires this event to report that a client has requested a TLS-PSK negotiation. ConnectionId indicates the unique connection ID that requested the PSK handshake.

Use Identity to look up for the corresponding pre-shared key in the server's database, then assign the key to the PSK parameter. If TLS 1.3 PSK is used, you will also need to assign the Ciphersuite parameter with the cipher suite associated with that identity and their key.

TLSShutdown Event (FTPServer Class)

Reports closure of a TLS session.

Syntax

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

virtual INT SECUREBLACKBOX_CALL FireTLSShutdown(LONG64 &lConnectionID);
class FTPServerTLSShutdownEventParams {
public:
  qint64 ConnectionID();

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

Remarks

The class fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a Disconnect, which marks the closure of the underlying TCP session.

TransferCompleted Event (FTPServer Class)

This event is fired when a customized upload or download operation completes.

Syntax

ANSI (Cross Platform)
virtual int FireTransferCompleted(FTPServerTransferCompletedEventParams *e);
typedef struct {
int64 ConnectionID;
int OperationStatus; int reserved; } FTPServerTransferCompletedEventParams;
Unicode (Windows) virtual INT FireTransferCompleted(FTPServerTransferCompletedEventParams *e);
typedef struct {
LONG64 ConnectionID;
INT OperationStatus; INT reserved; } FTPServerTransferCompletedEventParams;
#define EID_FTPSERVER_TRANSFERCOMPLETED 45

virtual INT SECUREBLACKBOX_CALL FireTransferCompleted(LONG64 &lConnectionID, INT &iOperationStatus);
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.

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

UploadBegin Event (FTPServer Class)

The server fires this event to notify the application about the start of a file upload operation.

Syntax

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

virtual INT SECUREBLACKBOX_CALL FireUploadBegin(LONG64 &lConnectionID, LPSTR &lpszPath);
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

Use this event to get notified about the beginning of a file upload operation. The file that is about to be uploaded is specified via the Path property.

UploadEnd Event (FTPServer Class)

Reports the completion of the upload operation.

Syntax

ANSI (Cross Platform)
virtual int FireUploadEnd(FTPServerUploadEndEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path; int reserved; } FTPServerUploadEndEventParams;
Unicode (Windows) virtual INT FireUploadEnd(FTPServerUploadEndEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path; INT reserved; } FTPServerUploadEndEventParams;
#define EID_FTPSERVER_UPLOADEND 47

virtual INT SECUREBLACKBOX_CALL FireUploadEnd(LONG64 &lConnectionID, LPSTR &lpszPath);
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

Use this event to receive notifications about completion of file upload operations.

UploadFile Event (FTPServer Class)

An override for a file upload initiation operation.

Syntax

ANSI (Cross Platform)
virtual int FireUploadFile(FTPServerUploadFileEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path;
int64 RestartAt;
int Append;
int OperationStatus; int reserved; } FTPServerUploadFileEventParams;
Unicode (Windows) virtual INT FireUploadFile(FTPServerUploadFileEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path;
LONG64 RestartAt;
BOOL Append;
INT OperationStatus; INT reserved; } FTPServerUploadFileEventParams;
#define EID_FTPSERVER_UPLOADFILE 48

virtual INT SECUREBLACKBOX_CALL FireUploadFile(LONG64 &lConnectionID, LPSTR &lpszPath, LONG64 &lRestartAt, BOOL &bAppend, INT &iOperationStatus);
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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

UploadProgress Event (FTPServer Class)

Reports the progress of an active upload operation.

Syntax

ANSI (Cross Platform)
virtual int FireUploadProgress(FTPServerUploadProgressEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Path;
int64 Progress;
int64 Total; int reserved; } FTPServerUploadProgressEventParams;
Unicode (Windows) virtual INT FireUploadProgress(FTPServerUploadProgressEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Path;
LONG64 Progress;
LONG64 Total; INT reserved; } FTPServerUploadProgressEventParams;
#define EID_FTPSERVER_UPLOADPROGRESS 49

virtual INT SECUREBLACKBOX_CALL FireUploadProgress(LONG64 &lConnectionID, LPSTR &lpszPath, LONG64 &lProgress, LONG64 &lTotal);
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

Subscribe to this event to be notified about the progress of an active upload operation.

The Path parameter specifies the path to the file being uploaded, and Progress and Total reflect the operation progress. The Total parameter may be set to -1 if the size of the uploaded file is not known.

WriteFile Event (FTPServer Class)

Hands a piece of file data to the application.

Syntax

ANSI (Cross Platform)
virtual int FireWriteFile(FTPServerWriteFileEventParams *e);
typedef struct {
int64 ConnectionID;
int OperationStatus; int reserved; } FTPServerWriteFileEventParams;
Unicode (Windows) virtual INT FireWriteFile(FTPServerWriteFileEventParams *e);
typedef struct {
LONG64 ConnectionID;
INT OperationStatus; INT reserved; } FTPServerWriteFileEventParams;
#define EID_FTPSERVER_WRITEFILE 50

virtual INT SECUREBLACKBOX_CALL FireWriteFile(LONG64 &lConnectionID, INT &iOperationStatus);
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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

Certificate Type

Encapsulates an individual X.509 certificate.

Syntax

SecureBlackboxCertificate (declared in secureblackbox.h)

Remarks

This type keeps and provides access to X.509 certificate details.

The following fields are available:

Fields

Bytes
char* (read-only)

Default Value:

Returns the raw certificate data in DER format.

CA
int

Default Value: FALSE

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this field when generating a new certificate to have its Basic Constraints extension generated automatically.

CAKeyID
char* (read-only)

Default Value:

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the SubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

CertType
int (read-only)

Default Value: 0

Returns the type of the entity contained in the Certificate object.

A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the CertificateManager class to load or create new certificate and certificate requests objects.

CRLDistributionPoints
char*

Default Value: ""

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this field when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

Curve
char*

Default Value: ""

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.

SB_EC_SECP112R1SECP112R1
SB_EC_SECP112R2SECP112R2
SB_EC_SECP128R1SECP128R1
SB_EC_SECP128R2SECP128R2
SB_EC_SECP160K1SECP160K1
SB_EC_SECP160R1SECP160R1
SB_EC_SECP160R2SECP160R2
SB_EC_SECP192K1SECP192K1
SB_EC_SECP192R1SECP192R1
SB_EC_SECP224K1SECP224K1
SB_EC_SECP224R1SECP224R1
SB_EC_SECP256K1SECP256K1
SB_EC_SECP256R1SECP256R1
SB_EC_SECP384R1SECP384R1
SB_EC_SECP521R1SECP521R1
SB_EC_SECT113R1SECT113R1
SB_EC_SECT113R2SECT113R2
SB_EC_SECT131R1SECT131R1
SB_EC_SECT131R2SECT131R2
SB_EC_SECT163K1SECT163K1
SB_EC_SECT163R1SECT163R1
SB_EC_SECT163R2SECT163R2
SB_EC_SECT193R1SECT193R1
SB_EC_SECT193R2SECT193R2
SB_EC_SECT233K1SECT233K1
SB_EC_SECT233R1SECT233R1
SB_EC_SECT239K1SECT239K1
SB_EC_SECT283K1SECT283K1
SB_EC_SECT283R1SECT283R1
SB_EC_SECT409K1SECT409K1
SB_EC_SECT409R1SECT409R1
SB_EC_SECT571K1SECT571K1
SB_EC_SECT571R1SECT571R1
SB_EC_PRIME192V1PRIME192V1
SB_EC_PRIME192V2PRIME192V2
SB_EC_PRIME192V3PRIME192V3
SB_EC_PRIME239V1PRIME239V1
SB_EC_PRIME239V2PRIME239V2
SB_EC_PRIME239V3PRIME239V3
SB_EC_PRIME256V1PRIME256V1
SB_EC_C2PNB163V1C2PNB163V1
SB_EC_C2PNB163V2C2PNB163V2
SB_EC_C2PNB163V3C2PNB163V3
SB_EC_C2PNB176W1C2PNB176W1
SB_EC_C2TNB191V1C2TNB191V1
SB_EC_C2TNB191V2C2TNB191V2
SB_EC_C2TNB191V3C2TNB191V3
SB_EC_C2ONB191V4C2ONB191V4
SB_EC_C2ONB191V5C2ONB191V5
SB_EC_C2PNB208W1C2PNB208W1
SB_EC_C2TNB239V1C2TNB239V1
SB_EC_C2TNB239V2C2TNB239V2
SB_EC_C2TNB239V3C2TNB239V3
SB_EC_C2ONB239V4C2ONB239V4
SB_EC_C2ONB239V5C2ONB239V5
SB_EC_C2PNB272W1C2PNB272W1
SB_EC_C2PNB304W1C2PNB304W1
SB_EC_C2TNB359V1C2TNB359V1
SB_EC_C2PNB368W1C2PNB368W1
SB_EC_C2TNB431R1C2TNB431R1
SB_EC_NISTP192NISTP192
SB_EC_NISTP224NISTP224
SB_EC_NISTP256NISTP256
SB_EC_NISTP384NISTP384
SB_EC_NISTP521NISTP521
SB_EC_NISTB163NISTB163
SB_EC_NISTB233NISTB233
SB_EC_NISTB283NISTB283
SB_EC_NISTB409NISTB409
SB_EC_NISTB571NISTB571
SB_EC_NISTK163NISTK163
SB_EC_NISTK233NISTK233
SB_EC_NISTK283NISTK283
SB_EC_NISTK409NISTK409
SB_EC_NISTK571NISTK571
SB_EC_GOSTCPTESTGOSTCPTEST
SB_EC_GOSTCPAGOSTCPA
SB_EC_GOSTCPBGOSTCPB
SB_EC_GOSTCPCGOSTCPC
SB_EC_GOSTCPXCHAGOSTCPXCHA
SB_EC_GOSTCPXCHBGOSTCPXCHB
SB_EC_BRAINPOOLP160R1BRAINPOOLP160R1
SB_EC_BRAINPOOLP160T1BRAINPOOLP160T1
SB_EC_BRAINPOOLP192R1BRAINPOOLP192R1
SB_EC_BRAINPOOLP192T1BRAINPOOLP192T1
SB_EC_BRAINPOOLP224R1BRAINPOOLP224R1
SB_EC_BRAINPOOLP224T1BRAINPOOLP224T1
SB_EC_BRAINPOOLP256R1BRAINPOOLP256R1
SB_EC_BRAINPOOLP256T1BRAINPOOLP256T1
SB_EC_BRAINPOOLP320R1BRAINPOOLP320R1
SB_EC_BRAINPOOLP320T1BRAINPOOLP320T1
SB_EC_BRAINPOOLP384R1BRAINPOOLP384R1
SB_EC_BRAINPOOLP384T1BRAINPOOLP384T1
SB_EC_BRAINPOOLP512R1BRAINPOOLP512R1
SB_EC_BRAINPOOLP512T1BRAINPOOLP512T1
SB_EC_CURVE25519CURVE25519
SB_EC_CURVE448CURVE448

Fingerprint
char* (read-only)

Default Value: ""

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

FriendlyName
char* (read-only)

Default Value: ""

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

Handle
int64

Default Value: 0

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

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

HashAlgorithm
char*

Default Value: ""

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use SigAlgorithm to find out the hash algorithm that is part of the certificate signature.

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

Issuer
char* (read-only)

Default Value: ""

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via IssuerRDN.

IssuerRDN
char*

Default Value: ""

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

KeyAlgorithm
char*

Default Value: "0"

Specifies the public key algorithm of this certificate.

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

Use the KeyBits, Curve, and PublicKeyBytes fields to get more details about the key the certificate contains.

KeyBits
int (read-only)

Default Value: 0

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the PublicKeyBytes or PrivateKeyBytes field would typically contain auxiliary values, and therefore be longer.

KeyFingerprint
char* (read-only)

Default Value: ""

Returns a SHA1 fingerprint of the public key contained in the certificate.

Note that the key fingerprint is different from the certificate fingerprint accessible via the Fingerprint field. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

KeyUsage
int

Default Value: 0

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:

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

Set this field before generating the certificate to propagate the key usage flags to the new certificate.

KeyValid
int (read-only)

Default Value: FALSE

Returns True if the certificate's key is cryptographically valid, and False otherwise.

OCSPLocations
char*

Default Value: ""

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this field before calling the certificate manager's Generate method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

OCSPNoCheck
int

Default Value: FALSE

Accessor to the value of the certificate's ocsp-no-check extension.

Origin
int (read-only)

Default Value: 0

Returns the location that the certificate was taken or loaded from.

PolicyIDs
char*

Default Value: ""

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

Set this field when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

PrivateKeyBytes
char* (read-only)

Default Value:

Returns the certificate's private key in DER-encoded format. It is normal for this field to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.

PrivateKeyExists
int (read-only)

Default Value: FALSE

Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.

This field is independent from PrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

PrivateKeyExtractable
int (read-only)

Default Value: FALSE

Indicates whether the private key is extractable (exportable).

PublicKeyBytes
char* (read-only)

Default Value:

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

Qualified
int (read-only)

Default Value: FALSE

Indicates whether the certificate is qualified.

This property is set to True if the certificate is confirmed by a Trusted List to be qualified.

QualifiedStatements
int

Default Value: 0

Returns a simplified qualified status of the certificate.

Qualifiers
char* (read-only)

Default Value: ""

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.

SelfSigned
int (read-only)

Default Value: FALSE

Indicates whether the certificate is self-signed (root) or signed by an external CA.

SerialNumber
char*

Default Value:

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

SigAlgorithm
char* (read-only)

Default Value: ""

Indicates the algorithm that was used by the CA to sign this certificate.

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

Source
int (read-only)

Default Value: 0

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Subject
char* (read-only)

Default Value: ""

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via SubjectRDN.

SubjectAlternativeName
char*

Default Value: ""

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Subject alternative names are used to provide additional names that are impractical to store in the main SubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.

SubjectKeyID
char*

Default Value:

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The SubjectKeyID and CAKeyID fields of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

SubjectRDN
char*

Default Value: ""

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

Valid
int (read-only)

Default Value: FALSE

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

ValidFrom
char*

Default Value: ""

The time point at which the certificate becomes valid, in UTC.

ValidTo
char*

Default Value: ""

The time point at which the certificate expires, in UTC.

Constructors

Certificate()

Creates a new object with default field values.

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Syntax

SecureBlackboxExternalCrypto (declared in secureblackbox.h)

Remarks

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

The following fields are available:

Fields

AsyncDocumentID
char*

Default Value: ""

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

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

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

CustomParams
char*

Default Value: ""

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

Data
char*

Default Value: ""

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

ExternalHashCalculation
int

Default Value: FALSE

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

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

HashAlgorithm
char*

Default Value: "SHA256"

Specifies the request's signature hash algorithm.

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

KeyID
char*

Default Value: ""

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

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

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

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

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

KeySecret
char*

Default Value: ""

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the KeyID topic.

Method
int

Default Value: 0

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

Available options:

asmdPKCS10
asmdPKCS71

Mode
int

Default Value: 0

Specifies the external cryptography mode.

Available options:

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

PublicKeyAlgorithm
char*

Default Value: ""

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

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

Constructors

ExternalCrypto()

Creates a new ExternalCrypto object with default field values.

FTPListEntry Type

Represents a basic container for the remote file details.

Syntax

SecureBlackboxFTPListEntry (declared in secureblackbox.h)

Remarks

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

The following fields are available:

Fields

AccessTime
char*

Default Value: ""

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

CreationTime
char*

Default Value: ""

Contains this file's creation time, in UTC.

EntryFormat
int

Default Value: 0

The file listing format:

cfefUnknown0
cfefUnix1
cfefWindows2
cfefMLSD3

FileType
int

Default Value: 0

The type of the entry:

fetUnknown0
fetDirectory1
fetFile2
fetSymlink3
fetSpecial4
fetCurrentDirectory5
fetParentDirectory6
fetSocket7
fetCharDevice8
fetBlockDevice9
fetFIFO10

Handle
int64

Default Value: 0

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

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

ModificationTime
char*

Default Value: ""

File last modification date/time.

Name
char*

Default Value: ""

The file or directory name.

Path
char*

Default Value: ""

The full path to the file or directory.

Principal
char*

Default Value: ""

Specifies the owner of the file/directory.

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

Size
int64

Default Value: 0

File size in bytes.

UnixPerms
int

Default Value: 511

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

UnparsedName
char*

Default Value: ""

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

Constructors

FTPListEntry()

Creates a new FTPListEntry object.

SocketSettings Type

A container for the socket settings.

Syntax

SecureBlackboxSocketSettings (declared in secureblackbox.h)

Remarks

This type is a container for socket-layer parameters.

The following fields are available:

Fields

DNSMode
int

Default Value: 0

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

dmAuto0
dmPlatform1
dmOwn2
dmOwnSecure3

DNSPort
int

Default Value: 0

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

DNSQueryTimeout
int

Default Value: 0

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

DNSServers
char*

Default Value: ""

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

DNSTotalTimeout
int

Default Value: 0

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

IncomingSpeedLimit
int

Default Value: 0

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

LocalAddress
char*

Default Value: ""

The local network interface to bind the socket to.

LocalPort
int

Default Value: 0

The local port number to bind the socket to.

OutgoingSpeedLimit
int

Default Value: 0

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

Timeout
int

Default Value: 60000

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

UseIPv6
int

Default Value: FALSE

Enables or disables IP protocol version 6.

Constructors

SocketSettings()

Creates a new SocketSettings object.

TLSConnectionInfo Type

Contains information about a network connection.

Syntax

SecureBlackboxTLSConnectionInfo (declared in secureblackbox.h)

Remarks

Use this property to check various details of the network connection. These include the total amounts of data transferred, the availability of TLS, and its parameters.

The following fields are available:

Fields

AEADCipher
int (read-only)

Default Value: FALSE

Indicates whether the encryption algorithm used is an AEAD cipher.

ChainValidationDetails
int (read-only)

Default Value: 0

The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

cvrBadData0x0001One or more certificates in the validation path are malformed

cvrRevoked0x0002One or more certificates are revoked

cvrNotYetValid0x0004One or more certificates are not yet valid

cvrExpired0x0008One or more certificates are expired

cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

cvrUnknownCA0x0020A CA certificate for one or more certificates has not been found (chain incomplete)

cvrCAUnauthorized0x0040One of the CA certificates are not authorized to act as CA

cvrCRLNotVerified0x0080One or more CRLs could not be verified

cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

cvrIdentityMismatch0x0200The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate

cvrNoKeyUsage0x0400A mandatory key usage is not enabled in one of the chain certificates

cvrBlocked0x0800One or more certificates are blocked

cvrFailure0x1000General validation failure

cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

cvrWeakAlgorithm0x4000A weak algorithm is used in one of certificates or revocation elements

cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

ChainValidationResult
int (read-only)

Default Value: 0

The outcome of a certificate chain validation routine.

Available options:

cvtValid0The chain is valid

cvtValidButUntrusted1The chain is valid, but the root certificate is not trusted

cvtInvalid2The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)

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

Ciphersuite
char* (read-only)

Default Value: ""

The cipher suite employed by this connection.

For TLS connections, this property returns the ciphersuite that was/is employed by the connection.

ClientAuthenticated
int (read-only)

Default Value: FALSE

Specifies whether client authentication was performed during this connection.

ClientAuthRequested
int (read-only)

Default Value: FALSE

Specifies whether client authentication was requested during this connection.

ConnectionEstablished
int (read-only)

Default Value: FALSE

Indicates whether the connection has been established fully.

ConnectionID
char* (read-only)

Default Value:

The unique identifier assigned to this connection.

DigestAlgorithm
char* (read-only)

Default Value: ""

The digest algorithm used in a TLS-enabled connection.

EncryptionAlgorithm
char* (read-only)

Default Value: ""

The symmetric encryption algorithm used in a TLS-enabled connection.

Exportable
int (read-only)

Default Value: FALSE

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

ID
int64 (read-only)

Default Value: -1

The client connection's unique identifier. This value is used throughout to refer to a particular client connection.

KeyExchangeAlgorithm
char* (read-only)

Default Value: ""

The key exchange algorithm used in a TLS-enabled connection.

KeyExchangeKeyBits
int (read-only)

Default Value: 0

The length of the key exchange key of a TLS-enabled connection.

NamedECCurve
char* (read-only)

Default Value: ""

The elliptic curve used in this connection.

PFSCipher
int (read-only)

Default Value: FALSE

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

PreSharedIdentity
char*

Default Value: ""

Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

PreSharedIdentityHint
char* (read-only)

Default Value: ""

A hint professed by the server to help the client select the PSK identity to use.

PublicKeyBits
int (read-only)

Default Value: 0

The length of the public key.

RemoteAddress
char* (read-only)

Default Value: ""

The client's IP address.

RemotePort
int (read-only)

Default Value: 0

The remote port of the client connection.

ResumedSession
int (read-only)

Default Value: FALSE

Indicates whether a TLS-enabled connection was spawned from another TLS connection

SecureConnection
int (read-only)

Default Value: FALSE

Indicates whether TLS or SSL is enabled for this connection.

ServerAuthenticated
int (read-only)

Default Value: FALSE

Indicates whether server authentication was performed during a TLS-enabled connection.

SignatureAlgorithm
char* (read-only)

Default Value: ""

The signature algorithm used in a TLS handshake.

SymmetricBlockSize
int (read-only)

Default Value: 0

The block size of the symmetric algorithm used.

SymmetricKeyBits
int (read-only)

Default Value: 0

The key length of the symmetric algorithm used.

TotalBytesReceived
int64 (read-only)

Default Value: 0

The total number of bytes received over this connection.

TotalBytesSent
int64 (read-only)

Default Value: 0

The total number of bytes sent over this connection.

ValidationLog
char* (read-only)

Default Value: ""

Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.

Version
char* (read-only)

Default Value: ""

Indicates the version of SSL/TLS protocol negotiated during this connection.

Constructors

TLSConnectionInfo()

Creates a new TLSConnectionInfo object.

TLSSettings Type

A container for TLS connection settings.

Syntax

SecureBlackboxTLSSettings (declared in secureblackbox.h)

Remarks

The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.

The following fields are available:

Fields

AutoValidateCertificates
int

Default Value: TRUE

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

BaseConfiguration
int

Default Value: 0

Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.

stpcDefault0
stpcCompatible1
stpcComprehensiveInsecure2
stpcHighlySecure3

Ciphersuites
char*

Default Value: ""

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, allowing all ciphersuites to be blanketly enabled or disabled 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

ClientAuth
int

Default Value: 0

Enables or disables certificate-based client authentication.

Set this property to true to tune up the client authentication type:

ccatNoAuth0
ccatRequestCert1
ccatRequireCert2

ECCurves
char*

Default Value: ""

Defines the elliptic curves to enable.

Extensions
char*

Default Value: ""

Provides access to TLS extensions.

ForceResumeIfDestinationChanges
int

Default Value: FALSE

Whether to force TLS session resumption when the destination address changes.

PreSharedIdentity
char*

Default Value: ""

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

PreSharedKey
char*

Default Value: ""

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

PreSharedKeyCiphersuite
char*

Default Value: ""

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

RenegotiationAttackPreventionMode
int

Default Value: 2

Selects the renegotiation attack prevention mechanism.

The following options are available:

crapmCompatible0TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled).
crapmStrict1Renegotiation attack prevention is enabled and enforced.
crapmAuto2Automatically choose whether to enable or disable renegotiation attack prevention.

RevocationCheck
int

Default Value: 1

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.

crcNone0No revocation checking.
crcAuto1Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future.
crcAllCRL2All provided CRL endpoints will be checked, and all checks must succeed.
crcAllOCSP3All provided OCSP endpoints will be checked, and all checks must succeed.
crcAllCRLAndOCSP4All provided CRL and OCSP endpoints will be checked, and all checks must succeed.
crcAnyCRL5All provided CRL endpoints will be checked, and at least one check must succeed.
crcAnyOCSP6All provided OCSP endpoints will be checked, and at least one check must succeed.
crcAnyCRLOrOCSP7All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL8All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first.

This setting controls the way the revocation checks are performed for every certificate in the chain. 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 the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

SSLOptions
int

Default Value: 16

Various SSL (TLS) protocol options, set of

cssloExpectShutdownMessage0x001Wait for the close-notify message when shutting down the connection

cssloOpenSSLDTLSWorkaround0x002(DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions

cssloDisableKexLengthAlignment0x004Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it.

cssloForceUseOfClientCertHashAlg0x008Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it.

cssloAutoAddServerNameExtension0x010Automatically add the server name extension when known

cssloAcceptTrustedSRPPrimesOnly0x020Accept trusted SRP primes only

cssloDisableSignatureAlgorithmsExtension0x040Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it.

cssloIntolerateHigherProtocolVersions0x080(server option) Do not allow fallback from TLS versions higher than currently enabled

cssloStickToPrefCertHashAlg0x100Stick to preferred certificate hash algorithms

cssloNoImplicitTLS12Fallback0x200Disable implicit TLS 1.3 to 1.2 fallbacks

cssloUseHandshakeBatches0x400Send the handshake message as large batches rather than individually

TLSMode
int

Default Value: 0

Specifies the TLS mode to use.

smDefault0
smNoTLS1Do not use TLS
smExplicitTLS2Connect to the server without any encryption and then request an SSL session.
smImplicitTLS3Connect to the specified port, and establish the SSL session at once.
smMixedTLS4Connect to the specified port, and establish the SSL session at once, but allow plain data.

UseExtendedMasterSecret
int

Default Value: FALSE

Enables the Extended Master Secret Extension, as defined in RFC 7627.

UseSessionResumption
int

Default Value: FALSE

Enables or disables the TLS session resumption capability.

Versions
int

Default Value: 16

The SSL/TLS versions to enable by default.

csbSSL20x01SSL 2

csbSSL30x02SSL 3

csbTLS10x04TLS 1.0

csbTLS110x08TLS 1.1

csbTLS120x10TLS 1.2

csbTLS130x20TLS 1.3

Constructors

TLSSettings()

Creates a new TLSSettings object.

UserAccount Type

A container for user account information.

Syntax

SecureBlackboxUserAccount (declared in secureblackbox.h)

Remarks

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

The following fields are available:

Fields

AssociatedData
char*

Default Value:

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

BasePath
char*

Default Value: ""

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

Certificate
char*

Default Value:

Contains the user's certificate.

Data
char*

Default Value: ""

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

Email
char*

Default Value: ""

The user's email address.

Handle
int64

Default Value: 0

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

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

HashAlgorithm
char*

Default Value: ""

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

SB_MAC_ALGORITHM_HMAC_SHA1SHA1
SB_MAC_ALGORITHM_HMAC_SHA256SHA256
SB_MAC_ALGORITHM_HMAC_SHA512SHA512

IncomingSpeedLimit
int

Default Value: 0

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

OtpAlgorithm
int

Default Value: 0

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

oaHmac0
oaTime1

OTPLen
int

Default Value: 0

Specifies the length of the user's OTP password.

OtpValue
int

Default Value: 0

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

OutgoingSpeedLimit
int

Default Value: 0

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

Password
char*

Default Value: ""

The user's authentication password.

SharedSecret
char*

Default Value:

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

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

SSHKey
char*

Default Value:

Contains the user's SSH key.

Username
char*

Default Value: ""

The registered name (login) of the user.

Constructors

UserAccount()

Creates a new UserAccount object

SecureBlackboxList Type

Syntax

SecureBlackboxList<T> (declared in secureblackbox.h)

Remarks

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

Methods

GetCount This method returns the current size of the collection.

int GetCount() {}

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

int SetCount(int count) {}

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

T* Get(int index) {}

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

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

Config Settings (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 Config 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 one of the below values to tune up the client authentication logic:

0No client authentication (the default setting)
1Request certificates. The server will ask connecting clients for their certificates. Non-authenticated client connections will be accepted anyway.
2Require certificates. The server will ask connecting clients for their certificates. If a client fails to provide a certificate, the server will terminate the connection.

If this property is set to 1 or 2, the component will request certificates from the connecting clients. Depending on the setting, the clients that fail to provide their certificate in response will be allowed or disallowed to proceed with the connection. The server signals about a received certificate by firing its CertificateValidate event. Use PinClient method in the event handler to pin the client details, and access the provided certificate chain via the PinnedClientChain property.

Note that this event is fired from the connecting clients threads, so please make sure you avoid bottlenecks in the event handler and put appropriate thread safety measures in place.

Unlike the client-side components, the server component does not perform automated certificate validation against the local security policy. You must perform appropriate certificate validation steps in your CertificateValidate event handler.

ControlChannelLog[i]:   Returns the control channel log for a connection.

Use this setting to retrieve the control channel log for a particular client connection. Any sensitive data, such as passwords, is returned masked.

DualStack:   Allows the use of ip4 and ip6 simultaneously.

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

MessageTable[i]:   Provides access to error code descriptions.

Use this property to get or set textual error code descriptions (e.g. 226 = Transfer Complete).

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.

SecurityOptions:   Facilitates fine-tuning of lower-level security settings.

This property is a bit mask offering the following individual parameters:

  • cfsoPlainLogin (1)
  • cfsoEncryption (2)
  • cfsoAuth (4);
  • cfsoClearControlChannel (8)
  • cfsoClearDataChannel (16)
  • cfsoEncryptedDataChannel (32)
Combine the above parameters to enable or disable certain security aspects of the server.

Base Config Settings

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

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

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

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

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

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

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

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

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

Supported values are:

offNo caching (default)
localLocal caching
globalGlobal caching

Cookies:   Gets or sets local cookies for the class.

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

DefDeriveKeyIterations:   Specifies the default key derivation algorithm iteration count.

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

DNSLocalSuffix:   The suffix to assign for TLD names.

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

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

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

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

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

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

HardwareCryptoUsePolicy:   The hardware crypto usage policy.

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

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

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

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

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

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

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

ListDelimiter:   The delimiter character for multi-element lists.

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

LogDestination:   Specifies the debug log destination.

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

Supported values are:

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

LogDetails:   Specifies the debug log details to dump.

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

Supported values are:

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

LogFile:   Specifies the debug log filename.

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

LogFilters:   Specifies the debug log filters.

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

Supported filter names are:

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

LogFlushMode:   Specifies the log flush mode.

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

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

LogLevel:   Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:

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

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

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

The default value of this setting is 100.

LogRotationMode:   Specifies the log rotation mode.

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

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

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

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

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

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

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

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

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

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

PKICache:   Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.

The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached.

Supported Values:

certificateEnables caching of certificates.
crlEnables caching of Certificate Revocation Lists (CRLs).
ocspEnables caching of OCSP (Online Certificate Status Protocol) responses.

Example (default value): PKICache=certificate,crl,ocsp In this example, the component caches certificates, CRLs, and OCSP responses.

PKICachePath:   Specifies the file system path where cached PKI data is stored.

The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts.

The default value is an empty string - no cached PKI data is stored on disk.

Example: PKICachePath=C:\Temp\cache In this example, the cached PKI data is stored in the C:\Temp\cache directory.

ProductVersion:   Returns the version of the SecureBlackbox library.

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

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

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

StaticDNS:   Specifies whether static DNS rules should be used.

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

Supported values are:

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

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

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

StaticIPAddresses:   Gets or sets all the static DNS rules.

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

Tag:   Allows to store any custom data.

Use this config property to store any custom data.

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

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

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

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

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

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

UseCRLObjectCaching:   Specifies whether reuse of loaded CRL objects is enabled.

This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used.

UseInternalRandom:   Switches between SecureBlackbox-own and platform PRNGs.

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

UseLegacyAdESValidation:   Enables legacy AdES validation mode.

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

UseOCSPResponseObjectCaching:   Specifies whether reuse of loaded OCSP response objects is enabled.

This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used.

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

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

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

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

UseSystemNativeSizeCalculation:   An internal CryptoAPI access tweak.

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

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

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

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

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

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

XMLRDNDescriptorName[OID]:   Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.

This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.

The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.

Syntax: Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");

Where:

OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.

PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.

Alias1, Alias2, ...: Optional alternative names recognized during parsing.

Usage Examples:

Map OID 2.5.4.5 to SERIALNUMBER: Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");

Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");

XMLRDNDescriptorPriority[OID]:   Specifies the priority of descriptor names associated with a specific OID.

This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing.

XMLRDNDescriptorReverseOrder:   Specifies whether to reverse the order of descriptors in RDN.

Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1).

XMLRDNDescriptorSeparator:   Specifies the separator used between descriptors in RDN.

Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value.

Trappable Errors (FTPServer Class)

Error Handling (C++)

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

FTPServer Errors

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