FTPServer Component

Properties   Methods   Events   Config Settings   Errors  

The FTPServer component provides server-side functionality for FTP and FTPS protocols.

Syntax

TsbxFTPServer

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 component with short descriptions. Click on the links for further details.

Method List

---

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

Event List

---

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

Config Settings

---

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

Active Property (FTPServer Component)

Whether the server is active and can accept incoming connections.

Syntax

__property bool Active = { read=FActive };

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

Allows and disallows anonymous connections.

Syntax

__property bool AllowAnonymous = { read=FAllowAnonymous, write=FSetAllowAnonymous };

Default Value

false

Remarks

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

Data Type

Boolean

ClientFileEntryAccessTime Property (FTPServer Component)

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

Syntax

__property String ClientFileEntryAccessTime = { read=FClientFileEntryAccessTime, write=FSetClientFileEntryAccessTime };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ClientFileEntryCreationTime Property (FTPServer Component)

Contains this file's creation time, in UTC.

Syntax

__property String ClientFileEntryCreationTime = { read=FClientFileEntryCreationTime, write=FSetClientFileEntryCreationTime };

Default Value

""

Remarks

Contains this file's creation time, in UTC.

This property is not available at design time.

Data Type

String

ClientFileEntryEntryFormat Property (FTPServer Component)

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

Syntax

__property TsbxFTPServerClientFileEntryEntryFormats ClientFileEntryEntryFormat = { read=FClientFileEntryEntryFormat, write=FSetClientFileEntryEntryFormat };

enum TsbxFTPServerClientFileEntryEntryFormats {
  cfefUnknown=0,
  cfefUnix=1,
  cfefWindows=2,
  cfefMLSD=3
};

Default Value

cfefUnknown

Remarks

The file listing format:

This property is not available at design time.

Data Type

Integer

ClientFileEntryFileType Property (FTPServer Component)

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

Syntax

__property TsbxFTPServerClientFileEntryFileTypes ClientFileEntryFileType = { read=FClientFileEntryFileType, write=FSetClientFileEntryFileType };

enum TsbxFTPServerClientFileEntryFileTypes {
  fetUnknown=0,
  fetDirectory=1,
  fetFile=2,
  fetSymlink=3,
  fetSpecial=4,
  fetCurrentDirectory=5,
  fetParentDirectory=6,
  fetSocket=7,
  fetCharDevice=8,
  fetBlockDevice=9,
  fetFIFO=10
};

Default Value

fetUnknown

Remarks

The type of the entry:

This property is not available at design time.

Data Type

Integer

ClientFileEntryHandle Property (FTPServer Component)

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

Syntax

__property __int64 ClientFileEntryHandle = { read=FClientFileEntryHandle, write=FSetClientFileEntryHandle };

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Long64

ClientFileEntryModificationTime Property (FTPServer Component)

File last modification date/time.

Syntax

__property String ClientFileEntryModificationTime = { read=FClientFileEntryModificationTime, write=FSetClientFileEntryModificationTime };

Default Value

""

Remarks

File last modification date/time.

This property is not available at design time.

Data Type

String

ClientFileEntryName Property (FTPServer Component)

The file or directory name.

Syntax

__property String ClientFileEntryName = { read=FClientFileEntryName, write=FSetClientFileEntryName };

Default Value

""

Remarks

The file or directory name.

This property is not available at design time.

Data Type

String

ClientFileEntryPath Property (FTPServer Component)

The full path to the file or directory.

Syntax

__property String ClientFileEntryPath = { read=FClientFileEntryPath, write=FSetClientFileEntryPath };

Default Value

""

Remarks

The full path to the file or directory.

This property is not available at design time.

Data Type

String

ClientFileEntryPrincipal Property (FTPServer Component)

Specifies the owner of the file/directory.

Syntax

__property String ClientFileEntryPrincipal = { read=FClientFileEntryPrincipal, write=FSetClientFileEntryPrincipal };

Default Value

""

Remarks

Specifies the owner of the file/directory.

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

This property is not available at design time.

Data Type

String

ClientFileEntrySize Property (FTPServer Component)

File size in bytes.

Syntax

__property __int64 ClientFileEntrySize = { read=FClientFileEntrySize, write=FSetClientFileEntrySize };

Default Value

0

Remarks

File size in bytes.

This property is not available at design time.

Data Type

Long64

ClientFileEntryUnixPerms Property (FTPServer Component)

The file Unix permissions bit mask (e.

Syntax

__property int ClientFileEntryUnixPerms = { read=FClientFileEntryUnixPerms, write=FSetClientFileEntryUnixPerms };

Default Value

511

Remarks

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

This property is not available at design time.

Data Type

Integer

ClientFileEntryUnparsedName Property (FTPServer Component)

The unparsed entry as returned by the server.

Syntax

__property String ClientFileEntryUnparsedName = { read=FClientFileEntryUnparsedName, write=FSetClientFileEntryUnparsedName };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

DataHost Property (FTPServer Component)

Host address for incoming data channel connections.

Syntax

__property String DataHost = { read=FDataHost, write=FSetDataHost };

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

Specifies the lower port range bound for passive mode data connections.

Syntax

__property int DataPortRangeFrom = { read=FDataPortRangeFrom, write=FSetDataPortRangeFrom };

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

Specifies the upper port range bound for passive mode data connections.

Syntax

__property int DataPortRangeTo = { read=FDataPortRangeTo, write=FSetDataPortRangeTo };

Default Value

0

Remarks

Use this property in combination with DataPortRangeFrom to limit the port range for passive mode data connections. The value of 0 (zero) stands for no upper bound.

Data Type

Integer

ExternalCryptoAsyncDocumentID Property (FTPServer Component)

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

Syntax

__property String ExternalCryptoAsyncDocumentID = { read=FExternalCryptoAsyncDocumentID, write=FSetExternalCryptoAsyncDocumentID };

Default Value

""

Remarks

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

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

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

Data Type

String

ExternalCryptoCustomParams Property (FTPServer Component)

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

Syntax

__property String ExternalCryptoCustomParams = { read=FExternalCryptoCustomParams, write=FSetExternalCryptoCustomParams };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (FTPServer Component)

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

Syntax

__property String ExternalCryptoData = { read=FExternalCryptoData, write=FSetExternalCryptoData };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (FTPServer Component)

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

__property bool ExternalCryptoExternalHashCalculation = { read=FExternalCryptoExternalHashCalculation, write=FSetExternalCryptoExternalHashCalculation };

Default Value

false

Remarks

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

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

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (FTPServer Component)

Specifies the request's signature hash algorithm.

Syntax

__property String ExternalCryptoHashAlgorithm = { read=FExternalCryptoHashAlgorithm, write=FSetExternalCryptoHashAlgorithm };

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (FTPServer Component)

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

Syntax

__property String ExternalCryptoKeyID = { read=FExternalCryptoKeyID, write=FSetExternalCryptoKeyID };

Default Value

""

Remarks

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

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

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

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

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

Data Type

String

ExternalCryptoKeySecret Property (FTPServer Component)

The pre-shared key used for DC request authentication.

Syntax

__property String ExternalCryptoKeySecret = { read=FExternalCryptoKeySecret, write=FSetExternalCryptoKeySecret };

Default Value

""

Remarks

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

Read more about configuring authentication in the ExternalCryptoKeyID topic.

Data Type

String

ExternalCryptoMethod Property (FTPServer Component)

Specifies the asynchronous signing method.

Syntax

__property TsbxFTPServerExternalCryptoMethods ExternalCryptoMethod = { read=FExternalCryptoMethod, write=FSetExternalCryptoMethod };

enum TsbxFTPServerExternalCryptoMethods {
  asmdPKCS1=0,
  asmdPKCS7=1
};

Default Value

asmdPKCS1

Remarks

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

Available options:

Data Type

Integer

ExternalCryptoMode Property (FTPServer Component)

Specifies the external cryptography mode.

Syntax

__property TsbxFTPServerExternalCryptoModes ExternalCryptoMode = { read=FExternalCryptoMode, write=FSetExternalCryptoMode };

enum TsbxFTPServerExternalCryptoModes {
  ecmDefault=0,
  ecmDisabled=1,
  ecmGeneric=2,
  ecmDCAuth=3,
  ecmDCAuthJSON=4
};

Default Value

ecmDefault

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (FTPServer Component)

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

Syntax

__property String ExternalCryptoPublicKeyAlgorithm = { read=FExternalCryptoPublicKeyAlgorithm, write=FSetExternalCryptoPublicKeyAlgorithm };

Default Value

""

Remarks

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

Data Type

String

FIPSMode Property (FTPServer Component)

Reserved.

Syntax

__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

HandshakeTimeout Property (FTPServer Component)

Specifies the handshake timeout in milliseconds.

Syntax

__property int HandshakeTimeout = { read=FHandshakeTimeout, write=FSetHandshakeTimeout };

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Data Type

Integer

Host Property (FTPServer Component)

Specifies the server host.

Syntax

__property String Host = { read=FHost, write=FSetHost };

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

Enables or disables implicit SSL mode.

Syntax

__property bool ImplicitSSL = { read=FImplicitSSL, write=FSetImplicitSSL };

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

The IP address of the passive mode host.

Syntax

__property String PassiveModeHost = { read=FPassiveModeHost, write=FSetPassiveModeHost };

Default Value

""

Remarks

Use this property to specify the address on which to listen for passive mode connections.

Data Type

String

PinnedClientAEADCipher Property (FTPServer Component)

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

__property bool PinnedClientAEADCipher = { read=FPinnedClientAEADCipher };

Default Value

false

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

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

Data Type

Boolean

PinnedClientChainValidationDetails Property (FTPServer Component)

The details of a certificate chain validation outcome.

Syntax

__property int PinnedClientChainValidationDetails = { read=FPinnedClientChainValidationDetails };

Default Value

0

Remarks

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:

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

Data Type

Integer

PinnedClientChainValidationResult Property (FTPServer Component)

The outcome of a certificate chain validation routine.

Syntax

__property TsbxFTPServerPinnedClientChainValidationResults PinnedClientChainValidationResult = { read=FPinnedClientChainValidationResult };

enum TsbxFTPServerPinnedClientChainValidationResults {
  cvtValid=0,
  cvtValidButUntrusted=1,
  cvtInvalid=2,
  cvtCantBeEstablished=3
};

Default Value

cvtValid

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

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

Data Type

Integer

PinnedClientCiphersuite Property (FTPServer Component)

The cipher suite employed by this connection.

Syntax

__property String PinnedClientCiphersuite = { read=FPinnedClientCiphersuite };

Default Value

""

Remarks

The cipher suite employed by this connection.

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

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

Data Type

String

PinnedClientClientAuthenticated Property (FTPServer Component)

Specifies whether client authentication was performed during this connection.

Syntax

__property bool PinnedClientClientAuthenticated = { read=FPinnedClientClientAuthenticated };

Default Value

false

Remarks

Specifies whether client authentication was performed during this connection.

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

Data Type

Boolean

PinnedClientClientAuthRequested Property (FTPServer Component)

Specifies whether client authentication was requested during this connection.

Syntax

__property bool PinnedClientClientAuthRequested = { read=FPinnedClientClientAuthRequested };

Default Value

false

Remarks

Specifies whether client authentication was requested during this connection.

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

Data Type

Boolean

PinnedClientConnectionEstablished Property (FTPServer Component)

Indicates whether the connection has been established fully.

Syntax

__property bool PinnedClientConnectionEstablished = { read=FPinnedClientConnectionEstablished };

Default Value

false

Remarks

Indicates whether the connection has been established fully.

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

Data Type

Boolean

PinnedClientConnectionID Property (FTPServer Component)

The unique identifier assigned to this connection.

Syntax

__property DynamicArray PinnedClientConnectionID = { read=FPinnedClientConnectionID };

Remarks

The unique identifier assigned to this connection.

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

Data Type

Byte Array

PinnedClientDigestAlgorithm Property (FTPServer Component)

The digest algorithm used in a TLS-enabled connection.

Syntax

__property String PinnedClientDigestAlgorithm = { read=FPinnedClientDigestAlgorithm };

Default Value

""

Remarks

The digest algorithm used in a TLS-enabled connection.

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

Data Type

String

PinnedClientEncryptionAlgorithm Property (FTPServer Component)

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

Syntax

__property String PinnedClientEncryptionAlgorithm = { read=FPinnedClientEncryptionAlgorithm };

Default Value

""

Remarks

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

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

Data Type

String

PinnedClientExportable Property (FTPServer Component)

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

Syntax

__property bool PinnedClientExportable = { read=FPinnedClientExportable };

Default Value

false

Remarks

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

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

Data Type

Boolean

PinnedClientID Property (FTPServer Component)

The client connection's unique identifier.

Syntax

__property __int64 PinnedClientID = { read=FPinnedClientID };

Default Value

-1

Remarks

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

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

Data Type

Long64

PinnedClientKeyExchangeAlgorithm Property (FTPServer Component)

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

Syntax

__property String PinnedClientKeyExchangeAlgorithm = { read=FPinnedClientKeyExchangeAlgorithm };

Default Value

""

Remarks

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

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

Data Type

String

PinnedClientKeyExchangeKeyBits Property (FTPServer Component)

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

Syntax

__property int PinnedClientKeyExchangeKeyBits = { read=FPinnedClientKeyExchangeKeyBits };

Default Value

0

Remarks

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

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

Data Type

Integer

PinnedClientNamedECCurve Property (FTPServer Component)

The elliptic curve used in this connection.

Syntax

__property String PinnedClientNamedECCurve = { read=FPinnedClientNamedECCurve };

Default Value

""

Remarks

The elliptic curve used in this connection.

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

Data Type

String

PinnedClientPFSCipher Property (FTPServer Component)

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

Syntax

__property bool PinnedClientPFSCipher = { read=FPinnedClientPFSCipher };

Default Value

false

Remarks

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

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

Data Type

Boolean

PinnedClientPreSharedIdentity Property (FTPServer Component)

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

Syntax

__property String PinnedClientPreSharedIdentity = { read=FPinnedClientPreSharedIdentity };

Default Value

""

Remarks

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

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

Data Type

String

PinnedClientPreSharedIdentityHint Property (FTPServer Component)

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

Syntax

__property String PinnedClientPreSharedIdentityHint = { read=FPinnedClientPreSharedIdentityHint };

Default Value

""

Remarks

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

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

Data Type

String

PinnedClientPublicKeyBits Property (FTPServer Component)

The length of the public key.

Syntax

__property int PinnedClientPublicKeyBits = { read=FPinnedClientPublicKeyBits };

Default Value

0

Remarks

The length of the public key.

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

Data Type

Integer

PinnedClientRemoteAddress Property (FTPServer Component)

The client's IP address.

Syntax

__property String PinnedClientRemoteAddress = { read=FPinnedClientRemoteAddress };

Default Value

""

Remarks

The client's IP address.

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

Data Type

String

PinnedClientRemotePort Property (FTPServer Component)

The remote port of the client connection.

Syntax

__property int PinnedClientRemotePort = { read=FPinnedClientRemotePort };

Default Value

0

Remarks

The remote port of the client connection.

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

Data Type

Integer

PinnedClientResumedSession Property (FTPServer Component)

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

Syntax

__property bool PinnedClientResumedSession = { read=FPinnedClientResumedSession };

Default Value

false

Remarks

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

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

Data Type

Boolean

PinnedClientSecureConnection Property (FTPServer Component)

Indicates whether TLS or SSL is enabled for this connection.

Syntax

__property bool PinnedClientSecureConnection = { read=FPinnedClientSecureConnection };

Default Value

false

Remarks

Indicates whether TLS or SSL is enabled for this connection.

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

Data Type

Boolean

PinnedClientServerAuthenticated Property (FTPServer Component)

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

Syntax

__property bool PinnedClientServerAuthenticated = { read=FPinnedClientServerAuthenticated };

Default Value

false

Remarks

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

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

Data Type

Boolean

PinnedClientSignatureAlgorithm Property (FTPServer Component)

The signature algorithm used in a TLS handshake.

Syntax

__property String PinnedClientSignatureAlgorithm = { read=FPinnedClientSignatureAlgorithm };

Default Value

""

Remarks

The signature algorithm used in a TLS handshake.

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

Data Type

String

PinnedClientSymmetricBlockSize Property (FTPServer Component)

The block size of the symmetric algorithm used.

Syntax

__property int PinnedClientSymmetricBlockSize = { read=FPinnedClientSymmetricBlockSize };

Default Value

0

Remarks

The block size of the symmetric algorithm used.

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

Data Type

Integer

PinnedClientSymmetricKeyBits Property (FTPServer Component)

The key length of the symmetric algorithm used.

Syntax

__property int PinnedClientSymmetricKeyBits = { read=FPinnedClientSymmetricKeyBits };

Default Value

0

Remarks

The key length of the symmetric algorithm used.

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

Data Type

Integer

PinnedClientTotalBytesReceived Property (FTPServer Component)

The total number of bytes received over this connection.

Syntax

__property __int64 PinnedClientTotalBytesReceived = { read=FPinnedClientTotalBytesReceived };

Default Value

0

Remarks

The total number of bytes received over this connection.

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

Data Type

Long64

PinnedClientTotalBytesSent Property (FTPServer Component)

The total number of bytes sent over this connection.

Syntax

__property __int64 PinnedClientTotalBytesSent = { read=FPinnedClientTotalBytesSent };

Default Value

0

Remarks

The total number of bytes sent over this connection.

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

Data Type

Long64

PinnedClientValidationLog Property (FTPServer Component)

Contains the server certificate's chain validation log.

Syntax

__property String PinnedClientValidationLog = { read=FPinnedClientValidationLog };

Default Value

""

Remarks

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

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

Data Type

String

PinnedClientVersion Property (FTPServer Component)

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

Syntax

__property String PinnedClientVersion = { read=FPinnedClientVersion };

Default Value

""

Remarks

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

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

Data Type

String

PinnedClientCertCount Property (FTPServer Component)

The number of records in the PinnedClientCert arrays.

Syntax

__property int PinnedClientCertCount = { read=FPinnedClientCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• PinnedClientCertBytes
• PinnedClientCertCAKeyID
• PinnedClientCertFingerprint
• PinnedClientCertHandle
• PinnedClientCertIssuer
• PinnedClientCertIssuerRDN
• PinnedClientCertKeyAlgorithm
• PinnedClientCertKeyBits
• PinnedClientCertKeyFingerprint
• PinnedClientCertKeyUsage
• PinnedClientCertPublicKeyBytes
• PinnedClientCertSelfSigned
• PinnedClientCertSerialNumber
• PinnedClientCertSigAlgorithm
• PinnedClientCertSubject
• PinnedClientCertSubjectKeyID
• PinnedClientCertSubjectRDN
• PinnedClientCertValidFrom
• PinnedClientCertValidTo

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

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

Data Type

Integer

PinnedClientCertBytes Property (FTPServer Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray PinnedClientCertBytes[int PinnedClientCertIndex] = { read=FPinnedClientCertBytes };

Remarks

Returns the raw certificate data in DER format.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Byte Array

PinnedClientCertCAKeyID Property (FTPServer Component)

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

Syntax

__property DynamicArray PinnedClientCertCAKeyID[int PinnedClientCertIndex] = { read=FPinnedClientCertCAKeyID };

Remarks

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 PinnedClientCertSubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Byte Array

PinnedClientCertFingerprint Property (FTPServer Component)

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

Syntax

__property String PinnedClientCertFingerprint[int PinnedClientCertIndex] = { read=FPinnedClientCertFingerprint };

Default Value

""

Remarks

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.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertHandle Property (FTPServer Component)

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

Syntax

__property __int64 PinnedClientCertHandle[int PinnedClientCertIndex] = { read=FPinnedClientCertHandle };

Default Value

0

Remarks

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

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Long64

PinnedClientCertIssuer Property (FTPServer Component)

The common name of the certificate issuer (CA), typically a company name.

Syntax

__property String PinnedClientCertIssuer[int PinnedClientCertIndex] = { read=FPinnedClientCertIssuer };

Default Value

""

Remarks

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertIssuerRDN Property (FTPServer Component)

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

Syntax

__property String PinnedClientCertIssuerRDN[int PinnedClientCertIndex] = { read=FPinnedClientCertIssuerRDN };

Default Value

""

Remarks

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

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertKeyAlgorithm Property (FTPServer Component)

Specifies the public key algorithm of this certificate.

Syntax

__property String PinnedClientCertKeyAlgorithm[int PinnedClientCertIndex] = { read=FPinnedClientCertKeyAlgorithm };

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the PinnedClientCertKeyBits, PinnedClientCertCurve, and PinnedClientCertPublicKeyBytes properties to get more details about the key the certificate contains.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertKeyBits Property (FTPServer Component)

Returns the length of the public key in bits.

Syntax

__property int PinnedClientCertKeyBits[int PinnedClientCertIndex] = { read=FPinnedClientCertKeyBits };

Default Value

0

Remarks

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 PinnedClientCertPublicKeyBytes or PinnedClientCertPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Integer

PinnedClientCertKeyFingerprint Property (FTPServer Component)

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

Syntax

__property String PinnedClientCertKeyFingerprint[int PinnedClientCertIndex] = { read=FPinnedClientCertKeyFingerprint };

Default Value

""

Remarks

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 PinnedClientCertFingerprint property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertKeyUsage Property (FTPServer Component)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

__property int PinnedClientCertKeyUsage[int PinnedClientCertIndex] = { read=FPinnedClientCertKeyUsage };

Default Value

0

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Integer

PinnedClientCertPublicKeyBytes Property (FTPServer Component)

Contains the certificate's public key in DER format.

Syntax

__property DynamicArray PinnedClientCertPublicKeyBytes[int PinnedClientCertIndex] = { read=FPinnedClientCertPublicKeyBytes };

Remarks

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.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Byte Array

PinnedClientCertSelfSigned Property (FTPServer Component)

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

Syntax

__property bool PinnedClientCertSelfSigned[int PinnedClientCertIndex] = { read=FPinnedClientCertSelfSigned };

Default Value

false

Remarks

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Boolean

PinnedClientCertSerialNumber Property (FTPServer Component)

Returns the certificate's serial number.

Syntax

__property DynamicArray PinnedClientCertSerialNumber[int PinnedClientCertIndex] = { read=FPinnedClientCertSerialNumber };

Remarks

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.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Byte Array

PinnedClientCertSigAlgorithm Property (FTPServer Component)

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

Syntax

__property String PinnedClientCertSigAlgorithm[int PinnedClientCertIndex] = { read=FPinnedClientCertSigAlgorithm };

Default Value

""

Remarks

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.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertSubject Property (FTPServer Component)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

__property String PinnedClientCertSubject[int PinnedClientCertIndex] = { read=FPinnedClientCertSubject };

Default Value

""

Remarks

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertSubjectKeyID Property (FTPServer Component)

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

Syntax

__property DynamicArray PinnedClientCertSubjectKeyID[int PinnedClientCertIndex] = { read=FPinnedClientCertSubjectKeyID };

Remarks

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 PinnedClientCertSubjectKeyID and PinnedClientCertCAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Byte Array

PinnedClientCertSubjectRDN Property (FTPServer Component)

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

Syntax

__property String PinnedClientCertSubjectRDN[int PinnedClientCertIndex] = { read=FPinnedClientCertSubjectRDN };

Default Value

""

Remarks

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.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertValidFrom Property (FTPServer Component)

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

Syntax

__property String PinnedClientCertValidFrom[int PinnedClientCertIndex] = { read=FPinnedClientCertValidFrom };

Default Value

""

Remarks

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertValidTo Property (FTPServer Component)

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

Syntax

__property String PinnedClientCertValidTo[int PinnedClientCertIndex] = { read=FPinnedClientCertValidTo };

Default Value

""

Remarks

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

Port Property (FTPServer Component)

The port number to listen for incoming connections on.

Syntax

__property int Port = { read=FPort, write=FSetPort };

Default Value

21

Remarks

Use this property to specify the port number to listen for incoming connections on.

Data Type

Integer

ReadOnly Property (FTPServer Component)

Makes the server's file system read-only for all users.

Syntax

__property bool ReadOnly = { read=FReadOnly, write=FSetReadOnly };

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

Specifies the server's root directory.

Syntax

__property String RootDirectory = { read=FRootDirectory, write=FSetRootDirectory };

Default Value

""

Remarks

Use this property to specify the shared root directory for all client sessions.

Data Type

String

SecurityOptions Property (FTPServer Component)

Various options of the secure connection.

Syntax

__property int SecurityOptions = { read=FSecurityOptions, write=FSetSecurityOptions };

Default Value

63

Remarks

Various options of the secure connection:

Data Type

Integer

SessionTimeout Property (FTPServer Component)

Specifies the session timeout in milliseconds.

Syntax

__property int SessionTimeout = { read=FSessionTimeout, write=FSetSessionTimeout };

Default Value

360000

Remarks

Specifies the maximum inactivity time (in milliseconds) after which the session will be forcebly closed.

Data Type

Integer

SocketIncomingSpeedLimit Property (FTPServer Component)

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

Syntax

__property int SocketIncomingSpeedLimit = { read=FSocketIncomingSpeedLimit, write=FSetSocketIncomingSpeedLimit };

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (FTPServer Component)

The local network interface to bind the socket to.

Syntax

__property String SocketLocalAddress = { read=FSocketLocalAddress, write=FSetSocketLocalAddress };

Default Value

""

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (FTPServer Component)

The local port number to bind the socket to.

Syntax

__property int SocketLocalPort = { read=FSocketLocalPort, write=FSetSocketLocalPort };

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (FTPServer Component)

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

Syntax

__property int SocketOutgoingSpeedLimit = { read=FSocketOutgoingSpeedLimit, write=FSetSocketOutgoingSpeedLimit };

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (FTPServer Component)

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

Syntax

__property int SocketTimeout = { read=FSocketTimeout, write=FSetSocketTimeout };

Default Value

60000

Remarks

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

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

Data Type

Integer

SocketUseIPv6 Property (FTPServer Component)

Enables or disables IP protocol version 6.

Syntax

__property bool SocketUseIPv6 = { read=FSocketUseIPv6, write=FSetSocketUseIPv6 };

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

TLSServerCertCount Property (FTPServer Component)

The number of records in the TLSServerCert arrays.

Syntax

__property int TLSServerCertCount = { read=FTLSServerCertCount, write=FSetTLSServerCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• TLSServerCertBytes
• TLSServerCertHandle

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

This property is not available at design time.

Data Type

Integer

TLSServerCertBytes Property (FTPServer Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray TLSServerCertBytes[int TLSServerCertIndex] = { read=FTLSServerCertBytes };

Remarks

Returns the raw certificate data in DER format.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

Byte Array

TLSServerCertHandle Property (FTPServer Component)

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

Syntax

__property __int64 TLSServerCertHandle[int TLSServerCertIndex] = { read=FTLSServerCertHandle, write=FSetTLSServerCertHandle };

Default Value

0

Remarks

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

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

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is not available at design time.

Data Type

Long64

TLSAutoValidateCertificates Property (FTPServer Component)

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

Syntax

__property bool TLSAutoValidateCertificates = { read=FTLSAutoValidateCertificates, write=FSetTLSAutoValidateCertificates };

Default Value

true

Remarks

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

Data Type

Boolean

TLSBaseConfiguration Property (FTPServer Component)

Selects the base configuration for the TLS settings.

Syntax

__property TsbxFTPServerTLSBaseConfigurations TLSBaseConfiguration = { read=FTLSBaseConfiguration, write=FSetTLSBaseConfiguration };

enum TsbxFTPServerTLSBaseConfigurations {
  stpcDefault=0,
  stpcCompatible=1,
  stpcComprehensiveInsecure=2,
  stpcHighlySecure=3
};

Default Value

stpcDefault

Remarks

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.

Data Type

Integer

TLSCiphersuites Property (FTPServer Component)

A list of ciphersuites separated with commas or semicolons.

Syntax

__property String TLSCiphersuites = { read=FTLSCiphersuites, write=FSetTLSCiphersuites };

Default Value

""

Remarks

A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, 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 TLSBaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

• NULL_NULL_NULL
• RSA_NULL_MD5
• RSA_NULL_SHA
• RSA_RC4_MD5
• RSA_RC4_SHA
• RSA_RC2_MD5
• RSA_IDEA_MD5
• RSA_IDEA_SHA
• RSA_DES_MD5
• RSA_DES_SHA
• RSA_3DES_MD5
• RSA_3DES_SHA
• RSA_AES128_SHA
• RSA_AES256_SHA
• DH_DSS_DES_SHA
• DH_DSS_3DES_SHA
• DH_DSS_AES128_SHA
• DH_DSS_AES256_SHA
• DH_RSA_DES_SHA
• DH_RSA_3DES_SHA
• DH_RSA_AES128_SHA
• DH_RSA_AES256_SHA
• DHE_DSS_DES_SHA
• DHE_DSS_3DES_SHA
• DHE_DSS_AES128_SHA
• DHE_DSS_AES256_SHA
• DHE_RSA_DES_SHA
• DHE_RSA_3DES_SHA
• DHE_RSA_AES128_SHA
• DHE_RSA_AES256_SHA
• DH_ANON_RC4_MD5
• DH_ANON_DES_SHA
• DH_ANON_3DES_SHA
• DH_ANON_AES128_SHA
• DH_ANON_AES256_SHA
• RSA_RC2_MD5_EXPORT
• RSA_RC4_MD5_EXPORT
• RSA_DES_SHA_EXPORT
• DH_DSS_DES_SHA_EXPORT
• DH_RSA_DES_SHA_EXPORT
• DHE_DSS_DES_SHA_EXPORT
• DHE_RSA_DES_SHA_EXPORT
• DH_ANON_RC4_MD5_EXPORT
• DH_ANON_DES_SHA_EXPORT
• RSA_CAMELLIA128_SHA
• DH_DSS_CAMELLIA128_SHA
• DH_RSA_CAMELLIA128_SHA
• DHE_DSS_CAMELLIA128_SHA
• DHE_RSA_CAMELLIA128_SHA
• DH_ANON_CAMELLIA128_SHA
• RSA_CAMELLIA256_SHA
• DH_DSS_CAMELLIA256_SHA
• DH_RSA_CAMELLIA256_SHA
• DHE_DSS_CAMELLIA256_SHA
• DHE_RSA_CAMELLIA256_SHA
• DH_ANON_CAMELLIA256_SHA
• PSK_RC4_SHA
• PSK_3DES_SHA
• PSK_AES128_SHA
• PSK_AES256_SHA
• DHE_PSK_RC4_SHA
• DHE_PSK_3DES_SHA
• DHE_PSK_AES128_SHA
• DHE_PSK_AES256_SHA
• RSA_PSK_RC4_SHA
• RSA_PSK_3DES_SHA
• RSA_PSK_AES128_SHA
• RSA_PSK_AES256_SHA
• RSA_SEED_SHA
• DH_DSS_SEED_SHA
• DH_RSA_SEED_SHA
• DHE_DSS_SEED_SHA
• DHE_RSA_SEED_SHA
• DH_ANON_SEED_SHA
• SRP_SHA_3DES_SHA
• SRP_SHA_RSA_3DES_SHA
• SRP_SHA_DSS_3DES_SHA
• SRP_SHA_AES128_SHA
• SRP_SHA_RSA_AES128_SHA
• SRP_SHA_DSS_AES128_SHA
• SRP_SHA_AES256_SHA
• SRP_SHA_RSA_AES256_SHA
• SRP_SHA_DSS_AES256_SHA
• ECDH_ECDSA_NULL_SHA
• ECDH_ECDSA_RC4_SHA
• ECDH_ECDSA_3DES_SHA
• ECDH_ECDSA_AES128_SHA
• ECDH_ECDSA_AES256_SHA
• ECDHE_ECDSA_NULL_SHA
• ECDHE_ECDSA_RC4_SHA
• ECDHE_ECDSA_3DES_SHA
• ECDHE_ECDSA_AES128_SHA
• ECDHE_ECDSA_AES256_SHA
• ECDH_RSA_NULL_SHA
• ECDH_RSA_RC4_SHA
• ECDH_RSA_3DES_SHA
• ECDH_RSA_AES128_SHA
• ECDH_RSA_AES256_SHA
• ECDHE_RSA_NULL_SHA
• ECDHE_RSA_RC4_SHA
• ECDHE_RSA_3DES_SHA
• ECDHE_RSA_AES128_SHA
• ECDHE_RSA_AES256_SHA
• ECDH_ANON_NULL_SHA
• ECDH_ANON_RC4_SHA
• ECDH_ANON_3DES_SHA
• ECDH_ANON_AES128_SHA
• ECDH_ANON_AES256_SHA
• RSA_NULL_SHA256
• RSA_AES128_SHA256
• RSA_AES256_SHA256
• DH_DSS_AES128_SHA256
• DH_RSA_AES128_SHA256
• DHE_DSS_AES128_SHA256
• DHE_RSA_AES128_SHA256
• DH_DSS_AES256_SHA256
• DH_RSA_AES256_SHA256
• DHE_DSS_AES256_SHA256
• DHE_RSA_AES256_SHA256
• DH_ANON_AES128_SHA256
• DH_ANON_AES256_SHA256
• RSA_AES128_GCM_SHA256
• RSA_AES256_GCM_SHA384
• DHE_RSA_AES128_GCM_SHA256
• DHE_RSA_AES256_GCM_SHA384
• DH_RSA_AES128_GCM_SHA256
• DH_RSA_AES256_GCM_SHA384
• DHE_DSS_AES128_GCM_SHA256
• DHE_DSS_AES256_GCM_SHA384
• DH_DSS_AES128_GCM_SHA256
• DH_DSS_AES256_GCM_SHA384
• DH_ANON_AES128_GCM_SHA256
• DH_ANON_AES256_GCM_SHA384
• ECDHE_ECDSA_AES128_SHA256
• ECDHE_ECDSA_AES256_SHA384
• ECDH_ECDSA_AES128_SHA256
• ECDH_ECDSA_AES256_SHA384
• ECDHE_RSA_AES128_SHA256
• ECDHE_RSA_AES256_SHA384
• ECDH_RSA_AES128_SHA256
• ECDH_RSA_AES256_SHA384
• ECDHE_ECDSA_AES128_GCM_SHA256
• ECDHE_ECDSA_AES256_GCM_SHA384
• ECDH_ECDSA_AES128_GCM_SHA256
• ECDH_ECDSA_AES256_GCM_SHA384
• ECDHE_RSA_AES128_GCM_SHA256
• ECDHE_RSA_AES256_GCM_SHA384
• ECDH_RSA_AES128_GCM_SHA256
• ECDH_RSA_AES256_GCM_SHA384
• PSK_AES128_GCM_SHA256
• PSK_AES256_GCM_SHA384
• DHE_PSK_AES128_GCM_SHA256
• DHE_PSK_AES256_GCM_SHA384
• RSA_PSK_AES128_GCM_SHA256
• RSA_PSK_AES256_GCM_SHA384
• PSK_AES128_SHA256
• PSK_AES256_SHA384
• PSK_NULL_SHA256
• PSK_NULL_SHA384
• DHE_PSK_AES128_SHA256
• DHE_PSK_AES256_SHA384
• DHE_PSK_NULL_SHA256
• DHE_PSK_NULL_SHA384
• RSA_PSK_AES128_SHA256
• RSA_PSK_AES256_SHA384
• RSA_PSK_NULL_SHA256
• RSA_PSK_NULL_SHA384
• RSA_CAMELLIA128_SHA256
• DH_DSS_CAMELLIA128_SHA256
• DH_RSA_CAMELLIA128_SHA256
• DHE_DSS_CAMELLIA128_SHA256
• DHE_RSA_CAMELLIA128_SHA256
• DH_ANON_CAMELLIA128_SHA256
• RSA_CAMELLIA256_SHA256
• DH_DSS_CAMELLIA256_SHA256
• DH_RSA_CAMELLIA256_SHA256
• DHE_DSS_CAMELLIA256_SHA256
• DHE_RSA_CAMELLIA256_SHA256
• DH_ANON_CAMELLIA256_SHA256
• ECDHE_ECDSA_CAMELLIA128_SHA256
• ECDHE_ECDSA_CAMELLIA256_SHA384
• ECDH_ECDSA_CAMELLIA128_SHA256
• ECDH_ECDSA_CAMELLIA256_SHA384
• ECDHE_RSA_CAMELLIA128_SHA256
• ECDHE_RSA_CAMELLIA256_SHA384
• ECDH_RSA_CAMELLIA128_SHA256
• ECDH_RSA_CAMELLIA256_SHA384
• RSA_CAMELLIA128_GCM_SHA256
• RSA_CAMELLIA256_GCM_SHA384
• DHE_RSA_CAMELLIA128_GCM_SHA256
• DHE_RSA_CAMELLIA256_GCM_SHA384
• DH_RSA_CAMELLIA128_GCM_SHA256
• DH_RSA_CAMELLIA256_GCM_SHA384
• DHE_DSS_CAMELLIA128_GCM_SHA256
• DHE_DSS_CAMELLIA256_GCM_SHA384
• DH_DSS_CAMELLIA128_GCM_SHA256
• DH_DSS_CAMELLIA256_GCM_SHA384
• DH_anon_CAMELLIA128_GCM_SHA256
• DH_anon_CAMELLIA256_GCM_SHA384
• ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
• ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
• ECDH_ECDSA_CAMELLIA128_GCM_SHA256
• ECDH_ECDSA_CAMELLIA256_GCM_SHA384
• ECDHE_RSA_CAMELLIA128_GCM_SHA256
• ECDHE_RSA_CAMELLIA256_GCM_SHA384
• ECDH_RSA_CAMELLIA128_GCM_SHA256
• ECDH_RSA_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_GCM_SHA256
• PSK_CAMELLIA256_GCM_SHA384
• DHE_PSK_CAMELLIA128_GCM_SHA256
• DHE_PSK_CAMELLIA256_GCM_SHA384
• RSA_PSK_CAMELLIA128_GCM_SHA256
• RSA_PSK_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_SHA256
• PSK_CAMELLIA256_SHA384
• DHE_PSK_CAMELLIA128_SHA256
• DHE_PSK_CAMELLIA256_SHA384
• RSA_PSK_CAMELLIA128_SHA256
• RSA_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_CAMELLIA128_SHA256
• ECDHE_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_RC4_SHA
• ECDHE_PSK_3DES_SHA
• ECDHE_PSK_AES128_SHA
• ECDHE_PSK_AES256_SHA
• ECDHE_PSK_AES128_SHA256
• ECDHE_PSK_AES256_SHA384
• ECDHE_PSK_NULL_SHA
• ECDHE_PSK_NULL_SHA256
• ECDHE_PSK_NULL_SHA384
• ECDHE_RSA_CHACHA20_POLY1305_SHA256
• ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
• DHE_RSA_CHACHA20_POLY1305_SHA256
• PSK_CHACHA20_POLY1305_SHA256
• ECDHE_PSK_CHACHA20_POLY1305_SHA256
• DHE_PSK_CHACHA20_POLY1305_SHA256
• RSA_PSK_CHACHA20_POLY1305_SHA256
• AES128_GCM_SHA256
• AES256_GCM_SHA384
• CHACHA20_POLY1305_SHA256
• AES128_CCM_SHA256
• AES128_CCM8_SHA256

Data Type

String

TLSClientAuth Property (FTPServer Component)

Enables or disables certificate-based client authentication.

Syntax

__property TsbxFTPServerTLSClientAuths TLSClientAuth = { read=FTLSClientAuth, write=FSetTLSClientAuth };

enum TsbxFTPServerTLSClientAuths {
  ccatNoAuth=0,
  ccatRequestCert=1,
  ccatRequireCert=2
};

Default Value

ccatNoAuth

Remarks

Enables or disables certificate-based client authentication.

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

Data Type

Integer

TLSECCurves Property (FTPServer Component)

Defines the elliptic curves to enable.

Syntax

__property String TLSECCurves = { read=FTLSECCurves, write=FSetTLSECCurves };

Default Value

""

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (FTPServer Component)

Provides access to TLS extensions.

Syntax

__property String TLSExtensions = { read=FTLSExtensions, write=FSetTLSExtensions };

Default Value

""

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (FTPServer Component)

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

Syntax

__property bool TLSForceResumeIfDestinationChanges = { read=FTLSForceResumeIfDestinationChanges, write=FSetTLSForceResumeIfDestinationChanges };

Default Value

false

Remarks

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

Data Type

Boolean

TLSPreSharedIdentity Property (FTPServer Component)

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

Syntax

__property String TLSPreSharedIdentity = { read=FTLSPreSharedIdentity, write=FSetTLSPreSharedIdentity };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

TLSPreSharedKey Property (FTPServer Component)

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

Syntax

__property String TLSPreSharedKey = { read=FTLSPreSharedKey, write=FSetTLSPreSharedKey };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

TLSPreSharedKeyCiphersuite Property (FTPServer Component)

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

Syntax

__property String TLSPreSharedKeyCiphersuite = { read=FTLSPreSharedKeyCiphersuite, write=FSetTLSPreSharedKeyCiphersuite };

Default Value

""

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (FTPServer Component)

Selects the renegotiation attack prevention mechanism.

Syntax

__property TsbxFTPServerTLSRenegotiationAttackPreventionModes TLSRenegotiationAttackPreventionMode = { read=FTLSRenegotiationAttackPreventionMode, write=FSetTLSRenegotiationAttackPreventionMode };

enum TsbxFTPServerTLSRenegotiationAttackPreventionModes {
  crapmCompatible=0,
  crapmStrict=1,
  crapmAuto=2
};

Default Value

crapmAuto

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (FTPServer Component)

Specifies the kind(s) of revocation check to perform.

Syntax

__property TsbxFTPServerTLSRevocationChecks TLSRevocationCheck = { read=FTLSRevocationCheck, write=FSetTLSRevocationCheck };

enum TsbxFTPServerTLSRevocationChecks {
  crcNone=0,
  crcAuto=1,
  crcAllCRL=2,
  crcAllOCSP=3,
  crcAllCRLAndOCSP=4,
  crcAnyCRL=5,
  crcAnyOCSP=6,
  crcAnyCRLOrOCSP=7,
  crcAnyOCSPOrCRL=8
};

Default Value

crcAuto

Remarks

Specifies the kind(s) of revocation check to perform.

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

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.

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (FTPServer Component)

Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.

Syntax

__property int TLSSSLOptions = { read=FTLSSSLOptions, write=FSetTLSSSLOptions };

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (FTPServer Component)

Specifies the TLS mode to use.

Syntax

__property TsbxFTPServerTLSTLSModes TLSTLSMode = { read=FTLSTLSMode, write=FSetTLSTLSMode };

enum TsbxFTPServerTLSTLSModes {
  smDefault=0,
  smNoTLS=1,
  smExplicitTLS=2,
  smImplicitTLS=3,
  smMixedTLS=4
};

Default Value

smDefault

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (FTPServer Component)

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

Syntax

__property bool TLSUseExtendedMasterSecret = { read=FTLSUseExtendedMasterSecret, write=FSetTLSUseExtendedMasterSecret };

Default Value

false

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (FTPServer Component)

Enables or disables the TLS session resumption capability.

Syntax

__property bool TLSUseSessionResumption = { read=FTLSUseSessionResumption, write=FSetTLSUseSessionResumption };

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (FTPServer Component)

The SSL/TLS versions to enable by default.

Syntax

__property int TLSVersions = { read=FTLSVersions, write=FSetTLSVersions };

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

UserCount Property (FTPServer Component)

The number of records in the User arrays.

Syntax

__property int UserCount = { read=FUserCount, write=FSetUserCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• UserAssociatedData
• UserBasePath
• UserData
• UserHandle
• UserHashAlgorithm
• UserIncomingSpeedLimit
• UserOutgoingSpeedLimit
• UserPassword
• UserSharedSecret
• UserUsername

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

This property is not available at design time.

Data Type

Integer

UserAssociatedData Property (FTPServer Component)

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

Syntax

__property DynamicArray UserAssociatedData[int UserIndex] = { read=FUserAssociatedData, write=FSetUserAssociatedData };

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

UserBasePath Property (FTPServer Component)

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

Syntax

__property String UserBasePath[int UserIndex] = { read=FUserBasePath, write=FSetUserBasePath };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

UserData Property (FTPServer Component)

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

Syntax

__property String UserData[int UserIndex] = { read=FUserData, write=FSetUserData };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

UserHandle Property (FTPServer Component)

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

Syntax

__property __int64 UserHandle[int UserIndex] = { read=FUserHandle, write=FSetUserHandle };

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

UserHashAlgorithm Property (FTPServer Component)

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

Syntax

__property String UserHashAlgorithm[int UserIndex] = { read=FUserHashAlgorithm, write=FSetUserHashAlgorithm };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

UserIncomingSpeedLimit Property (FTPServer Component)

Specifies the incoming speed limit for this user.

Syntax

__property int UserIncomingSpeedLimit[int UserIndex] = { read=FUserIncomingSpeedLimit, write=FSetUserIncomingSpeedLimit };

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Integer

UserOutgoingSpeedLimit Property (FTPServer Component)

Specifies the outgoing speed limit for this user.

Syntax

__property int UserOutgoingSpeedLimit[int UserIndex] = { read=FUserOutgoingSpeedLimit, write=FSetUserOutgoingSpeedLimit };

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Integer

UserPassword Property (FTPServer Component)

The user's authentication password.

Syntax

__property String UserPassword[int UserIndex] = { read=FUserPassword, write=FSetUserPassword };

Default Value

""

Remarks

The user's authentication password.

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

This property is not available at design time.

Data Type

String

UserSharedSecret Property (FTPServer Component)

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

Syntax

__property DynamicArray UserSharedSecret[int UserIndex] = { read=FUserSharedSecret, write=FSetUserSharedSecret };

Remarks

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

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

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

This property is not available at design time.

Data Type

Byte Array

UserUsername Property (FTPServer Component)

The registered name (login) of the user.

Syntax

__property String UserUsername[int UserIndex] = { read=FUserUsername, write=FSetUserUsername };

Default Value

""

Remarks

The registered name (login) of the user.

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

This property is not available at design time.

Data Type

String

UseUTF8 Property (FTPServer Component)

Enables or disables UTF8 file name conversions.

Syntax

__property bool UseUTF8 = { read=FUseUTF8, write=FSetUseUTF8 };

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

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

Syntax

void __fastcall 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.

Config Method (FTPServer Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

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

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

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

DoAction Method (FTPServer Component)

Performs an additional action.

Syntax

String __fastcall DoAction(String ActionID, String ActionParams);

Remarks

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

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

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

DropClient Method (FTPServer Component)

Terminates a client connection.

Syntax

void __fastcall DropClient(__int64 ConnectionId, bool Forced);

Remarks

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

GetClientBuffer Method (FTPServer Component)

Obtains a pending connection buffer.

Syntax

DynamicArray<Byte> __fastcall GetClientBuffer(__int64 ConnectionID);

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.

ListClients Method (FTPServer Component)

Enumerates the connected clients.

Syntax

String __fastcall 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.

PinClient Method (FTPServer Component)

Takes a snapshot of the connection's properties.

Syntax

void __fastcall PinClient(__int64 ConnectionId);

Remarks

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

Reset Method (FTPServer Component)

Resets the component settings.

Syntax

void __fastcall Reset();

Remarks

Reset is a generic method available in every component.

SetClientBuffer Method (FTPServer Component)

Commits a data buffer to the connection.

Syntax

void __fastcall SetClientBuffer(__int64 ConnectionID, DynamicArray<Byte> Value);

Remarks

Use this method from your ReadFile event handler to commit a chunk of file data to the server component.

SetClientFileEntry Method (FTPServer Component)

Commits a file entry to the connection.

Syntax

void __fastcall SetClientFileEntry(__int64 ConnectionID);

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.

Start Method (FTPServer Component)

Starts the server.

Syntax

void __fastcall Start();

Remarks

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

Stop Method (FTPServer Component)

Stops the server.

Syntax

void __fastcall Stop();

Remarks

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

Accept Event (FTPServer Component)

Reports an incoming connection.

Syntax

typedef struct {
  String RemoteAddress;
  int RemotePort;
  bool Accept;
} TsbxFTPServerAcceptEventParams;
typedef void __fastcall (__closure *TsbxFTPServerAcceptEvent)(System::TObject* Sender, TsbxFTPServerAcceptEventParams *e);
__property TsbxFTPServerAcceptEvent OnAccept = { read=FOnAccept, write=FOnAccept };

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

Signals the completion of a directory change operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Directory;
  int OperationStatus;
} TsbxFTPServerAfterChangeDirectoryEventParams;
typedef void __fastcall (__closure *TsbxFTPServerAfterChangeDirectoryEvent)(System::TObject* Sender, TsbxFTPServerAfterChangeDirectoryEventParams *e);
__property TsbxFTPServerAfterChangeDirectoryEvent OnAfterChangeDirectory = { read=FOnAfterChangeDirectory, write=FOnAfterChangeDirectory };

Remarks

The component fires this event upon completion of a directory change operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterCreateDirectory Event (FTPServer Component)

Signals the completion of a directory creation operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Directory;
  int OperationStatus;
} TsbxFTPServerAfterCreateDirectoryEventParams;
typedef void __fastcall (__closure *TsbxFTPServerAfterCreateDirectoryEvent)(System::TObject* Sender, TsbxFTPServerAfterCreateDirectoryEventParams *e);
__property TsbxFTPServerAfterCreateDirectoryEvent OnAfterCreateDirectory = { read=FOnAfterCreateDirectory, write=FOnAfterCreateDirectory };

Remarks

The component fires this event upon completion of a directory creation operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterRemoveDirectory Event (FTPServer Component)

Signals the completion of a directory removal operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Directory;
  int OperationStatus;
} TsbxFTPServerAfterRemoveDirectoryEventParams;
typedef void __fastcall (__closure *TsbxFTPServerAfterRemoveDirectoryEvent)(System::TObject* Sender, TsbxFTPServerAfterRemoveDirectoryEventParams *e);
__property TsbxFTPServerAfterRemoveDirectoryEvent OnAfterRemoveDirectory = { read=FOnAfterRemoveDirectory, write=FOnAfterRemoveDirectory };

Remarks

The component fires this event upon completion of a directory removal operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterRemoveFile Event (FTPServer Component)

Signals the completion of a file removal operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int OperationStatus;
} TsbxFTPServerAfterRemoveFileEventParams;
typedef void __fastcall (__closure *TsbxFTPServerAfterRemoveFileEvent)(System::TObject* Sender, TsbxFTPServerAfterRemoveFileEventParams *e);
__property TsbxFTPServerAfterRemoveFileEvent OnAfterRemoveFile = { read=FOnAfterRemoveFile, write=FOnAfterRemoveFile };

Remarks

The component fires this event upon completion of a file removal operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterRenameFile Event (FTPServer Component)

Signals the completion of a file renaming operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String OldPath;
  String NewPath;
  int OperationStatus;
} TsbxFTPServerAfterRenameFileEventParams;
typedef void __fastcall (__closure *TsbxFTPServerAfterRenameFileEvent)(System::TObject* Sender, TsbxFTPServerAfterRenameFileEventParams *e);
__property TsbxFTPServerAfterRenameFileEvent OnAfterRenameFile = { read=FOnAfterRenameFile, write=FOnAfterRenameFile };

Remarks

The component fires this event upon completion of a file renaming operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterRequestAttributes Event (FTPServer Component)

Signals the completion of an attribute request.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int OperationStatus;
} TsbxFTPServerAfterRequestAttributesEventParams;
typedef void __fastcall (__closure *TsbxFTPServerAfterRequestAttributesEvent)(System::TObject* Sender, TsbxFTPServerAfterRequestAttributesEventParams *e);
__property TsbxFTPServerAfterRequestAttributesEvent OnAfterRequestAttributes = { read=FOnAfterRequestAttributes, write=FOnAfterRequestAttributes };

Remarks

The component fires this event upon completion of an attribute request. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AuthAttempt Event (FTPServer Component)

Fires when a connected client makes an authentication attempt.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Username;
  String Password;
  bool Allow;
  String BasePath;
} TsbxFTPServerAuthAttemptEventParams;
typedef void __fastcall (__closure *TsbxFTPServerAuthAttemptEvent)(System::TObject* Sender, TsbxFTPServerAuthAttemptEventParams *e);
__property TsbxFTPServerAuthAttemptEvent OnAuthAttempt = { read=FOnAuthAttempt, write=FOnAuthAttempt };

Remarks

The component 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 Component)

Notifies about an incoming change directory request.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Directory;
  int Action;
} TsbxFTPServerBeforeChangeDirectoryEventParams;
typedef void __fastcall (__closure *TsbxFTPServerBeforeChangeDirectoryEvent)(System::TObject* Sender, TsbxFTPServerBeforeChangeDirectoryEventParams *e);
__property TsbxFTPServerBeforeChangeDirectoryEvent OnBeforeChangeDirectory = { read=FOnBeforeChangeDirectory, write=FOnBeforeChangeDirectory };

Remarks

The component 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:

BeforeCreateDirectory Event (FTPServer Component)

Notifies about an incoming create directory request.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Directory;
  int Action;
} TsbxFTPServerBeforeCreateDirectoryEventParams;
typedef void __fastcall (__closure *TsbxFTPServerBeforeCreateDirectoryEvent)(System::TObject* Sender, TsbxFTPServerBeforeCreateDirectoryEventParams *e);
__property TsbxFTPServerBeforeCreateDirectoryEvent OnBeforeCreateDirectory = { read=FOnBeforeCreateDirectory, write=FOnBeforeCreateDirectory };

Remarks

The component 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:

BeforeDownloadFile Event (FTPServer Component)

Notifies about an incoming file download request.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  __int64 RestartAt;
  int Action;
} TsbxFTPServerBeforeDownloadFileEventParams;
typedef void __fastcall (__closure *TsbxFTPServerBeforeDownloadFileEvent)(System::TObject* Sender, TsbxFTPServerBeforeDownloadFileEventParams *e);
__property TsbxFTPServerBeforeDownloadFileEvent OnBeforeDownloadFile = { read=FOnBeforeDownloadFile, write=FOnBeforeDownloadFile };

Remarks

The component 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:

BeforeFind Event (FTPServer Component)

Notifies about an incoming file listing request.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Directory;
  int Action;
} TsbxFTPServerBeforeFindEventParams;
typedef void __fastcall (__closure *TsbxFTPServerBeforeFindEvent)(System::TObject* Sender, TsbxFTPServerBeforeFindEventParams *e);
__property TsbxFTPServerBeforeFindEvent OnBeforeFind = { read=FOnBeforeFind, write=FOnBeforeFind };

Remarks

The component 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:

BeforeRemoveDirectory Event (FTPServer Component)

Notifies about an incoming directory removal request.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Directory;
  int Action;
} TsbxFTPServerBeforeRemoveDirectoryEventParams;
typedef void __fastcall (__closure *TsbxFTPServerBeforeRemoveDirectoryEvent)(System::TObject* Sender, TsbxFTPServerBeforeRemoveDirectoryEventParams *e);
__property TsbxFTPServerBeforeRemoveDirectoryEvent OnBeforeRemoveDirectory = { read=FOnBeforeRemoveDirectory, write=FOnBeforeRemoveDirectory };

Remarks

The component 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:

BeforeRemoveFile Event (FTPServer Component)

Notifies about an incoming file removal request.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int Action;
} TsbxFTPServerBeforeRemoveFileEventParams;
typedef void __fastcall (__closure *TsbxFTPServerBeforeRemoveFileEvent)(System::TObject* Sender, TsbxFTPServerBeforeRemoveFileEventParams *e);
__property TsbxFTPServerBeforeRemoveFileEvent OnBeforeRemoveFile = { read=FOnBeforeRemoveFile, write=FOnBeforeRemoveFile };

Remarks

The component 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:

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

Notifies about an incoming file rename request.

Syntax

typedef struct {
  __int64 ConnectionID;
  String OldPath;
  String NewPath;
  int Action;
} TsbxFTPServerBeforeRenameFileEventParams;
typedef void __fastcall (__closure *TsbxFTPServerBeforeRenameFileEvent)(System::TObject* Sender, TsbxFTPServerBeforeRenameFileEventParams *e);
__property TsbxFTPServerBeforeRenameFileEvent OnBeforeRenameFile = { read=FOnBeforeRenameFile, write=FOnBeforeRenameFile };

Remarks

The component 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:

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

Notifies about an incoming attributes request.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int Action;
} TsbxFTPServerBeforeRequestAttributesEventParams;
typedef void __fastcall (__closure *TsbxFTPServerBeforeRequestAttributesEvent)(System::TObject* Sender, TsbxFTPServerBeforeRequestAttributesEventParams *e);
__property TsbxFTPServerBeforeRequestAttributesEvent OnBeforeRequestAttributes = { read=FOnBeforeRequestAttributes, write=FOnBeforeRequestAttributes };

Remarks

The component 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:

BeforeSendReply Event (FTPServer Component)

Notifies the application of a command reply being sent.

Syntax

typedef struct {
  __int64 ConnectionID;
  int Code;
  String Reply;
  String Command;
} TsbxFTPServerBeforeSendReplyEventParams;
typedef void __fastcall (__closure *TsbxFTPServerBeforeSendReplyEvent)(System::TObject* Sender, TsbxFTPServerBeforeSendReplyEventParams *e);
__property TsbxFTPServerBeforeSendReplyEvent OnBeforeSendReply = { read=FOnBeforeSendReply, write=FOnBeforeSendReply };

Remarks

The component 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 Component)

Notifies about an incoming file upload request.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  __int64 RestartAt;
  bool Append;
  int Action;
} TsbxFTPServerBeforeUploadFileEventParams;
typedef void __fastcall (__closure *TsbxFTPServerBeforeUploadFileEvent)(System::TObject* Sender, TsbxFTPServerBeforeUploadFileEventParams *e);
__property TsbxFTPServerBeforeUploadFileEvent OnBeforeUploadFile = { read=FOnBeforeUploadFile, write=FOnBeforeUploadFile };

Remarks

The component 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:

ChangeDirectory Event (FTPServer Component)

An override for a directory change operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Directory;
  int OperationStatus;
} TsbxFTPServerChangeDirectoryEventParams;
typedef void __fastcall (__closure *TsbxFTPServerChangeDirectoryEvent)(System::TObject* Sender, TsbxFTPServerChangeDirectoryEventParams *e);
__property TsbxFTPServerChangeDirectoryEvent OnChangeDirectory = { read=FOnChangeDirectory, write=FOnChangeDirectory };

Remarks

The component 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:

CommandProcessed Event (FTPServer Component)

Signals that a command has been processed by the server.

Syntax

typedef struct {
  __int64 ConnectionID;
  String CurrentDirectory;
  String Command;
  int ReplyCode;
} TsbxFTPServerCommandProcessedEventParams;
typedef void __fastcall (__closure *TsbxFTPServerCommandProcessedEvent)(System::TObject* Sender, TsbxFTPServerCommandProcessedEventParams *e);
__property TsbxFTPServerCommandProcessedEvent OnCommandProcessed = { read=FOnCommandProcessed, write=FOnCommandProcessed };

Remarks

The component 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 Component)

Signals that a command has been received from the client.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Command;
  String Parameters;
  bool Ignore;
} TsbxFTPServerCommandReceivedEventParams;
typedef void __fastcall (__closure *TsbxFTPServerCommandReceivedEvent)(System::TObject* Sender, TsbxFTPServerCommandReceivedEventParams *e);
__property TsbxFTPServerCommandReceivedEvent OnCommandReceived = { read=FOnCommandReceived, write=FOnCommandReceived };

Remarks

The component 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 Component)

Reports an accepted connection.

Syntax

typedef struct {
  __int64 ConnectionID;
  String RemoteAddress;
  int Port;
} TsbxFTPServerConnectEventParams;
typedef void __fastcall (__closure *TsbxFTPServerConnectEvent)(System::TObject* Sender, TsbxFTPServerConnectEventParams *e);
__property TsbxFTPServerConnectEvent OnConnect = { read=FOnConnect, write=FOnConnect };

Remarks

The component 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 Component)

An override for a directory creation operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Directory;
  int OperationStatus;
} TsbxFTPServerCreateDirectoryEventParams;
typedef void __fastcall (__closure *TsbxFTPServerCreateDirectoryEvent)(System::TObject* Sender, TsbxFTPServerCreateDirectoryEventParams *e);
__property TsbxFTPServerCreateDirectoryEvent OnCreateDirectory = { read=FOnCreateDirectory, write=FOnCreateDirectory };

Remarks

The component 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:

Disconnect Event (FTPServer Component)

Fires to report a disconnected client.

Syntax

typedef struct {
  __int64 ConnectionID;
} TsbxFTPServerDisconnectEventParams;
typedef void __fastcall (__closure *TsbxFTPServerDisconnectEvent)(System::TObject* Sender, TsbxFTPServerDisconnectEventParams *e);
__property TsbxFTPServerDisconnectEvent OnDisconnect = { read=FOnDisconnect, write=FOnDisconnect };

Remarks

The component fires this event when a connected client disconnects.

DownloadBegin Event (FTPServer Component)

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

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
} TsbxFTPServerDownloadBeginEventParams;
typedef void __fastcall (__closure *TsbxFTPServerDownloadBeginEvent)(System::TObject* Sender, TsbxFTPServerDownloadBeginEventParams *e);
__property TsbxFTPServerDownloadBeginEvent OnDownloadBegin = { read=FOnDownloadBegin, write=FOnDownloadBegin };

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

Reports the completion of the download operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
} TsbxFTPServerDownloadEndEventParams;
typedef void __fastcall (__closure *TsbxFTPServerDownloadEndEvent)(System::TObject* Sender, TsbxFTPServerDownloadEndEventParams *e);
__property TsbxFTPServerDownloadEndEvent OnDownloadEnd = { read=FOnDownloadEnd, write=FOnDownloadEnd };

Remarks

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

DownloadFile Event (FTPServer Component)

An override for a file download initiation operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  __int64 RestartAt;
  int OperationStatus;
} TsbxFTPServerDownloadFileEventParams;
typedef void __fastcall (__closure *TsbxFTPServerDownloadFileEvent)(System::TObject* Sender, TsbxFTPServerDownloadFileEventParams *e);
__property TsbxFTPServerDownloadFileEvent OnDownloadFile = { read=FOnDownloadFile, write=FOnDownloadFile };

Remarks

The component 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:

DownloadProgress Event (FTPServer Component)

Reports the progress of an active download operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  __int64 Progress;
  __int64 Total;
} TsbxFTPServerDownloadProgressEventParams;
typedef void __fastcall (__closure *TsbxFTPServerDownloadProgressEvent)(System::TObject* Sender, TsbxFTPServerDownloadProgressEventParams *e);
__property TsbxFTPServerDownloadProgressEvent OnDownloadProgress = { read=FOnDownloadProgress, write=FOnDownloadProgress };

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

Information about errors during data delivery.

Syntax

typedef struct {
  __int64 ConnectionID;
  int ErrorCode;
  bool Fatal;
  bool Remote;
  String Description;
} TsbxFTPServerErrorEventParams;
typedef void __fastcall (__closure *TsbxFTPServerErrorEvent)(System::TObject* Sender, TsbxFTPServerErrorEventParams *e);
__property TsbxFTPServerErrorEvent OnError = { read=FOnError, write=FOnError };

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

Handles remote or external signing initiated by the server protocol.

Syntax

typedef struct {
  __int64 ConnectionID;
  String OperationId;
  String HashAlgorithm;
  String Pars;
  String Data;
  String SignedData;
} TsbxFTPServerExternalSignEventParams;
typedef void __fastcall (__closure *TsbxFTPServerExternalSignEvent)(System::TObject* Sender, TsbxFTPServerExternalSignEventParams *e);
__property TsbxFTPServerExternalSignEvent OnExternalSign = { read=FOnExternalSign, write=FOnExternalSign };

Remarks

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

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

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

The component 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 Component)

Signals the completion of a directory listing request.

Syntax

typedef struct {
  __int64 ConnectionID;
  int OperationStatus;
} TsbxFTPServerFindCloseEventParams;
typedef void __fastcall (__closure *TsbxFTPServerFindCloseEvent)(System::TObject* Sender, TsbxFTPServerFindCloseEventParams *e);
__property TsbxFTPServerFindCloseEvent OnFindClose = { read=FOnFindClose, write=FOnFindClose };

Remarks

The component 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 Component)

An override for a directory listing initiation operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Directory;
  int OperationStatus;
} TsbxFTPServerFindInitEventParams;
typedef void __fastcall (__closure *TsbxFTPServerFindInitEvent)(System::TObject* Sender, TsbxFTPServerFindInitEventParams *e);
__property TsbxFTPServerFindInitEvent OnFindInit = { read=FOnFindInit, write=FOnFindInit };

Remarks

The component 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:

FindNext Event (FTPServer Component)

An override for a directory listing entry request operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  int OperationStatus;
} TsbxFTPServerFindNextEventParams;
typedef void __fastcall (__closure *TsbxFTPServerFindNextEvent)(System::TObject* Sender, TsbxFTPServerFindNextEventParams *e);
__property TsbxFTPServerFindNextEvent OnFindNext = { read=FOnFindNext, write=FOnFindNext };

Remarks

The component 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:

Notification Event (FTPServer Component)

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

Syntax

typedef struct {
  String EventID;
  String EventParam;
} TsbxFTPServerNotificationEventParams;
typedef void __fastcall (__closure *TsbxFTPServerNotificationEvent)(System::TObject* Sender, TsbxFTPServerNotificationEventParams *e);
__property TsbxFTPServerNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };

Remarks

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

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

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

ReadFile Event (FTPServer Component)

Requests a piece of file data from the application.

Syntax

typedef struct {
  __int64 ConnectionID;
  int Size;
  int OperationStatus;
} TsbxFTPServerReadFileEventParams;
typedef void __fastcall (__closure *TsbxFTPServerReadFileEvent)(System::TObject* Sender, TsbxFTPServerReadFileEventParams *e);
__property TsbxFTPServerReadFileEvent OnReadFile = { read=FOnReadFile, write=FOnReadFile };

Remarks

The component 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:

RemoveDirectory Event (FTPServer Component)

An override for a directory removal operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Directory;
  int OperationStatus;
} TsbxFTPServerRemoveDirectoryEventParams;
typedef void __fastcall (__closure *TsbxFTPServerRemoveDirectoryEvent)(System::TObject* Sender, TsbxFTPServerRemoveDirectoryEventParams *e);
__property TsbxFTPServerRemoveDirectoryEvent OnRemoveDirectory = { read=FOnRemoveDirectory, write=FOnRemoveDirectory };

Remarks

The component 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:

RemoveFile Event (FTPServer Component)

An override for a file remove operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int OperationStatus;
} TsbxFTPServerRemoveFileEventParams;
typedef void __fastcall (__closure *TsbxFTPServerRemoveFileEvent)(System::TObject* Sender, TsbxFTPServerRemoveFileEventParams *e);
__property TsbxFTPServerRemoveFileEvent OnRemoveFile = { read=FOnRemoveFile, write=FOnRemoveFile };

Remarks

The component 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:

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

RenameFile Event (FTPServer Component)

An override for a file rename operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String OldPath;
  String NewPath;
  int OperationStatus;
} TsbxFTPServerRenameFileEventParams;
typedef void __fastcall (__closure *TsbxFTPServerRenameFileEvent)(System::TObject* Sender, TsbxFTPServerRenameFileEventParams *e);
__property TsbxFTPServerRenameFileEvent OnRenameFile = { read=FOnRenameFile, write=FOnRenameFile };

Remarks

The component 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:

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

RequestAttributes Event (FTPServer Component)

An override for an attribute request.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int OperationStatus;
} TsbxFTPServerRequestAttributesEventParams;
typedef void __fastcall (__closure *TsbxFTPServerRequestAttributesEvent)(System::TObject* Sender, TsbxFTPServerRequestAttributesEventParams *e);
__property TsbxFTPServerRequestAttributesEvent OnRequestAttributes = { read=FOnRequestAttributes, write=FOnRequestAttributes };

Remarks

The component 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:

TLSCertValidate Event (FTPServer Component)

Fires when a client certificate needs to be validated.

Syntax

typedef struct {
  __int64 ConnectionID;
  bool Accept;
} TsbxFTPServerTLSCertValidateEventParams;
typedef void __fastcall (__closure *TsbxFTPServerTLSCertValidateEvent)(System::TObject* Sender, TsbxFTPServerTLSCertValidateEventParams *e);
__property TsbxFTPServerTLSCertValidateEvent OnTLSCertValidate = { read=FOnTLSCertValidate, write=FOnTLSCertValidate };

Remarks

The component 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 Component)

Reports the setup of a TLS session.

Syntax

typedef struct {
  __int64 ConnectionID;
} TsbxFTPServerTLSEstablishedEventParams;
typedef void __fastcall (__closure *TsbxFTPServerTLSEstablishedEvent)(System::TObject* Sender, TsbxFTPServerTLSEstablishedEventParams *e);
__property TsbxFTPServerTLSEstablishedEvent OnTLSEstablished = { read=FOnTLSEstablished, write=FOnTLSEstablished };

Remarks

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

TLSHandshake Event (FTPServer Component)

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

Syntax

typedef struct {
  __int64 ConnectionID;
  String ServerName;
  bool Abort;
} TsbxFTPServerTLSHandshakeEventParams;
typedef void __fastcall (__closure *TsbxFTPServerTLSHandshakeEvent)(System::TObject* Sender, TsbxFTPServerTLSHandshakeEventParams *e);
__property TsbxFTPServerTLSHandshakeEvent OnTLSHandshake = { read=FOnTLSHandshake, write=FOnTLSHandshake };

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

Requests a pre-shared key for TLS-PSK.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Identity;
  String PSK;
  String Ciphersuite;
} TsbxFTPServerTLSPSKEventParams;
typedef void __fastcall (__closure *TsbxFTPServerTLSPSKEvent)(System::TObject* Sender, TsbxFTPServerTLSPSKEventParams *e);
__property TsbxFTPServerTLSPSKEvent OnTLSPSK = { read=FOnTLSPSK, write=FOnTLSPSK };

Remarks

The component 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 Component)

Reports closure of a TLS session.

Syntax

typedef struct {
  __int64 ConnectionID;
} TsbxFTPServerTLSShutdownEventParams;
typedef void __fastcall (__closure *TsbxFTPServerTLSShutdownEvent)(System::TObject* Sender, TsbxFTPServerTLSShutdownEventParams *e);
__property TsbxFTPServerTLSShutdownEvent OnTLSShutdown = { read=FOnTLSShutdown, write=FOnTLSShutdown };

Remarks

The component 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 Component)

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

Syntax

typedef struct {
  __int64 ConnectionID;
  int OperationStatus;
} TsbxFTPServerTransferCompletedEventParams;
typedef void __fastcall (__closure *TsbxFTPServerTransferCompletedEvent)(System::TObject* Sender, TsbxFTPServerTransferCompletedEventParams *e);
__property TsbxFTPServerTransferCompletedEvent OnTransferCompleted = { read=FOnTransferCompleted, write=FOnTransferCompleted };

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.

UploadBegin Event (FTPServer Component)

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

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
} TsbxFTPServerUploadBeginEventParams;
typedef void __fastcall (__closure *TsbxFTPServerUploadBeginEvent)(System::TObject* Sender, TsbxFTPServerUploadBeginEventParams *e);
__property TsbxFTPServerUploadBeginEvent OnUploadBegin = { read=FOnUploadBegin, write=FOnUploadBegin };

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

Reports the completion of the upload operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
} TsbxFTPServerUploadEndEventParams;
typedef void __fastcall (__closure *TsbxFTPServerUploadEndEvent)(System::TObject* Sender, TsbxFTPServerUploadEndEventParams *e);
__property TsbxFTPServerUploadEndEvent OnUploadEnd = { read=FOnUploadEnd, write=FOnUploadEnd };

Remarks

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

UploadFile Event (FTPServer Component)

An override for a file upload initiation operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  __int64 RestartAt;
  bool Append;
  int OperationStatus;
} TsbxFTPServerUploadFileEventParams;
typedef void __fastcall (__closure *TsbxFTPServerUploadFileEvent)(System::TObject* Sender, TsbxFTPServerUploadFileEventParams *e);
__property TsbxFTPServerUploadFileEvent OnUploadFile = { read=FOnUploadFile, write=FOnUploadFile };

Remarks

The component 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:

UploadProgress Event (FTPServer Component)

Reports the progress of an active upload operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  __int64 Progress;
  __int64 Total;
} TsbxFTPServerUploadProgressEventParams;
typedef void __fastcall (__closure *TsbxFTPServerUploadProgressEvent)(System::TObject* Sender, TsbxFTPServerUploadProgressEventParams *e);
__property TsbxFTPServerUploadProgressEvent OnUploadProgress = { read=FOnUploadProgress, write=FOnUploadProgress };

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

Hands a piece of file data to the application.

Syntax

typedef struct {
  __int64 ConnectionID;
  int OperationStatus;
} TsbxFTPServerWriteFileEventParams;
typedef void __fastcall (__closure *TsbxFTPServerWriteFileEvent)(System::TObject* Sender, TsbxFTPServerWriteFileEventParams *e);
__property TsbxFTPServerWriteFileEvent OnWriteFile = { read=FOnWriteFile, write=FOnWriteFile };

Remarks

The component 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:

Config Settings (FTPServer Component)

The component 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 component, access to these internal properties is provided through the Config method.

FTPServer Config Settings

Base Config Settings

Trappable Errors (FTPServer Component)

FTPServer Errors