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 Active: Boolean read get_Active;

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.

AllowAnonymous Property (FTPServer Component)

Allows and disallows anonymous connections.

Syntax

property AllowAnonymous: Boolean read get_AllowAnonymous write set_AllowAnonymous;

Default Value

false

Remarks

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

ClientFileEntry Property (FTPServer Component)

A container for current file entry details.

Syntax

property ClientFileEntry: TsbxFTPListEntry read get_ClientFileEntry write set_ClientFileEntry;

Remarks

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

This property is not available at design time.

Please refer to the FTPListEntry type for a complete list of fields.

DataHost Property (FTPServer Component)

Host address for incoming data channel connections.

Syntax

property DataHost: String read get_DataHost write set_DataHost;

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.

DataPortRangeFrom Property (FTPServer Component)

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

Syntax

property DataPortRangeFrom: Integer read get_DataPortRangeFrom write set_DataPortRangeFrom;

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.

DataPortRangeTo Property (FTPServer Component)

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

Syntax

property DataPortRangeTo: Integer read get_DataPortRangeTo write set_DataPortRangeTo;

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.

ExternalCrypto Property (FTPServer Component)

Provides access to external signing and DC parameters.

Syntax

property ExternalCrypto: TsbxExternalCrypto read get_ExternalCrypto;

Remarks

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

This property is read-only.

Please refer to the ExternalCrypto type for a complete list of fields.

FIPSMode Property (FTPServer Component)

Reserved.

Syntax

property FIPSMode: Boolean read get_FIPSMode write set_FIPSMode;

Default Value

false

Remarks

This property is reserved for future use.

HandshakeTimeout Property (FTPServer Component)

Specifies the handshake timeout in milliseconds.

Syntax

property HandshakeTimeout: Integer read get_HandshakeTimeout write set_HandshakeTimeout;

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Host Property (FTPServer Component)

Specifies the server host.

Syntax

property Host: String read get_Host write set_Host;

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.

ImplicitSSL Property (FTPServer Component)

Enables or disables implicit SSL mode.

Syntax

property ImplicitSSL: Boolean read get_ImplicitSSL write set_ImplicitSSL;

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.

PassiveModeHost Property (FTPServer Component)

The IP address of the passive mode host.

Syntax

property PassiveModeHost: String read get_PassiveModeHost write set_PassiveModeHost;

Default Value

''

Remarks

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

PinnedClient Property (FTPServer Component)

Populates the pinned client details.

Syntax

property PinnedClient: TsbxTLSConnectionInfo read get_PinnedClient;

Remarks

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

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

Please refer to the TLSConnectionInfo type for a complete list of fields.

PinnedClientChain Property (FTPServer Component)

Contains the certificate chain of the pinned client.

Syntax

property PinnedClientChain: TsbxCertificateList read get_PinnedClientChain;

Remarks

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

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

Please refer to the Certificate type for a complete list of fields.

Port Property (FTPServer Component)

The port number to listen for incoming connections on.

Syntax

property Port: Integer read get_Port write set_Port;

Default Value

21

Remarks

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

ReadOnly Property (FTPServer Component)

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

Syntax

property ReadOnly: Boolean read get_ReadOnly write set_ReadOnly;

Default Value

false

Remarks

Set this property to true to present the server's file system as read-only for all connecting users.

RootDirectory Property (FTPServer Component)

Specifies the server's root directory.

Syntax

property RootDirectory: String read get_RootDirectory write set_RootDirectory;

Default Value

''

Remarks

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

SecurityOptions Property (FTPServer Component)

Various options of the secure connection.

Syntax

property SecurityOptions: Integer read get_SecurityOptions write set_SecurityOptions;

Default Value

63

Remarks

Various options of the secure connection:

SessionTimeout Property (FTPServer Component)

Specifies the session timeout in milliseconds.

Syntax

property SessionTimeout: Integer read get_SessionTimeout write set_SessionTimeout;

Default Value

360000

Remarks

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

SocketSettings Property (FTPServer Component)

Manages network connection settings.

Syntax

property SocketSettings: TsbxSocketSettings read get_SocketSettings;

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

Please refer to the SocketSettings type for a complete list of fields.

TLSServerChain Property (FTPServer Component)

The server's TLS certificates.

Syntax

property TLSServerChain: TsbxCertificateList read get_TLSServerChain write set_TLSServerChain;

Remarks

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

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

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

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

TLSSettings Property (FTPServer Component)

Manages TLS layer settings.

Syntax

property TLSSettings: TsbxTLSSettings read get_TLSSettings;

Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

Please refer to the TLSSettings type for a complete list of fields.

Users Property (FTPServer Component)

Provides a list of registered users.

Syntax

property Users: TsbxUserAccountList read get_Users write set_Users;

Remarks

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

This property is not available at design time.

Please refer to the UserAccount type for a complete list of fields.

UseUTF8 Property (FTPServer Component)

Enables or disables UTF8 file name conversions.

Syntax

property UseUTF8: Boolean read get_UseUTF8 write set_UseUTF8;

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.

Cleanup Method (FTPServer Component)

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

Syntax

procedure 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

function Config(ConfigurationString: String): String;

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

function DoAction(ActionID: String; ActionParams: String): String;

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

procedure DropClient(ConnectionId: Int64; Forced: Boolean);

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

function GetClientBuffer(ConnectionID: Int64): TBytes;

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

function ListClients(): String;

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

procedure PinClient(ConnectionId: Int64);

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

procedure Reset();

Remarks

Reset is a generic method available in every component.

SetClientBuffer Method (FTPServer Component)

Commits a data buffer to the connection.

Syntax

procedure SetClientBuffer(ConnectionID: Int64; Value: TBytes);

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

procedure SetClientFileEntry(ConnectionID: Int64);

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

procedure 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

procedure 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

type TAcceptEvent = procedure (
  Sender: TObject;
  const RemoteAddress: String;
  RemotePort: Integer;
  var Accept: Boolean
) of Object;

property OnAccept: TAcceptEvent 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

type TAfterChangeDirectoryEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Directory: String;
  var OperationStatus: Integer
) of Object;

property OnAfterChangeDirectory: TAfterChangeDirectoryEvent 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

type TAfterCreateDirectoryEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Directory: String;
  var OperationStatus: Integer
) of Object;

property OnAfterCreateDirectory: TAfterCreateDirectoryEvent 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

type TAfterRemoveDirectoryEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Directory: String;
  var OperationStatus: Integer
) of Object;

property OnAfterRemoveDirectory: TAfterRemoveDirectoryEvent 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

type TAfterRemoveFileEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var OperationStatus: Integer
) of Object;

property OnAfterRemoveFile: TAfterRemoveFileEvent 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

type TAfterRenameFileEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const OldPath: String;
  const NewPath: String;
  var OperationStatus: Integer
) of Object;

property OnAfterRenameFile: TAfterRenameFileEvent 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

type TAfterRequestAttributesEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var OperationStatus: Integer
) of Object;

property OnAfterRequestAttributes: TAfterRequestAttributesEvent 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

type TAuthAttemptEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Username: String;
  const Password: String;
  var Allow: Boolean;
  var BasePath: String
) of Object;

property OnAuthAttempt: TAuthAttemptEvent 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

type TBeforeChangeDirectoryEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Directory: String;
  var Action: Integer
) of Object;

property OnBeforeChangeDirectory: TBeforeChangeDirectoryEvent 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

type TBeforeCreateDirectoryEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Directory: String;
  var Action: Integer
) of Object;

property OnBeforeCreateDirectory: TBeforeCreateDirectoryEvent 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

type TBeforeDownloadFileEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  RestartAt: Int64;
  var Action: Integer
) of Object;

property OnBeforeDownloadFile: TBeforeDownloadFileEvent 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

type TBeforeFindEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Directory: String;
  var Action: Integer
) of Object;

property OnBeforeFind: TBeforeFindEvent 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

type TBeforeRemoveDirectoryEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Directory: String;
  var Action: Integer
) of Object;

property OnBeforeRemoveDirectory: TBeforeRemoveDirectoryEvent 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

type TBeforeRemoveFileEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var Action: Integer
) of Object;

property OnBeforeRemoveFile: TBeforeRemoveFileEvent 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

type TBeforeRenameFileEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const OldPath: String;
  const NewPath: String;
  var Action: Integer
) of Object;

property OnBeforeRenameFile: TBeforeRenameFileEvent 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

type TBeforeRequestAttributesEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var Action: Integer
) of Object;

property OnBeforeRequestAttributes: TBeforeRequestAttributesEvent 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

type TBeforeSendReplyEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  var Code: Integer;
  var Reply: String;
  const Command: String
) of Object;

property OnBeforeSendReply: TBeforeSendReplyEvent 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

type TBeforeUploadFileEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  RestartAt: Int64;
  Append: Boolean;
  var Action: Integer
) of Object;

property OnBeforeUploadFile: TBeforeUploadFileEvent 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

type TChangeDirectoryEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  var Directory: String;
  var OperationStatus: Integer
) of Object;

property OnChangeDirectory: TChangeDirectoryEvent 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

type TCommandProcessedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const CurrentDirectory: String;
  const Command: String;
  ReplyCode: Integer
) of Object;

property OnCommandProcessed: TCommandProcessedEvent 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

type TCommandReceivedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Command: String;
  const Parameters: String;
  var Ignore: Boolean
) of Object;

property OnCommandReceived: TCommandReceivedEvent 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

type TConnectEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const RemoteAddress: String;
  Port: Integer
) of Object;

property OnConnect: TConnectEvent 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

type TCreateDirectoryEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  var Directory: String;
  var OperationStatus: Integer
) of Object;

property OnCreateDirectory: TCreateDirectoryEvent 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

type TDisconnectEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64
) of Object;

property OnDisconnect: TDisconnectEvent 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

type TDownloadBeginEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String
) of Object;

property OnDownloadBegin: TDownloadBeginEvent 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

type TDownloadEndEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String
) of Object;

property OnDownloadEnd: TDownloadEndEvent 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

type TDownloadFileEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  RestartAt: Int64;
  var OperationStatus: Integer
) of Object;

property OnDownloadFile: TDownloadFileEvent 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

type TDownloadProgressEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  Progress: Int64;
  Total: Int64
) of Object;

property OnDownloadProgress: TDownloadProgressEvent 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

type TErrorEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  ErrorCode: Integer;
  Fatal: Boolean;
  Remote: Boolean;
  const Description: String
) of Object;

property OnError: TErrorEvent 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

type TExternalSignEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const OperationId: String;
  const HashAlgorithm: String;
  const Pars: String;
  const Data: String;
  var SignedData: String
) of Object;

property OnExternalSign: TExternalSignEvent 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

type TFindCloseEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  var OperationStatus: Integer
) of Object;

property OnFindClose: TFindCloseEvent 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

type TFindInitEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  var Directory: String;
  var OperationStatus: Integer
) of Object;

property OnFindInit: TFindInitEvent 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

type TFindNextEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  var OperationStatus: Integer
) of Object;

property OnFindNext: TFindNextEvent 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

type TNotificationEvent = procedure (
  Sender: TObject;
  const EventID: String;
  const EventParam: String
) of Object;

property OnNotification: TNotificationEvent 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

type TReadFileEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  Size: Integer;
  var OperationStatus: Integer
) of Object;

property OnReadFile: TReadFileEvent 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

type TRemoveDirectoryEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  var Directory: String;
  var OperationStatus: Integer
) of Object;

property OnRemoveDirectory: TRemoveDirectoryEvent 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

type TRemoveFileEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var OperationStatus: Integer
) of Object;

property OnRemoveFile: TRemoveFileEvent 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

type TRenameFileEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const OldPath: String;
  const NewPath: String;
  var OperationStatus: Integer
) of Object;

property OnRenameFile: TRenameFileEvent 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

type TRequestAttributesEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var OperationStatus: Integer
) of Object;

property OnRequestAttributes: TRequestAttributesEvent 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

type TTLSCertValidateEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  var Accept: Boolean
) of Object;

property OnTLSCertValidate: TTLSCertValidateEvent 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

type TTLSEstablishedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64
) of Object;

property OnTLSEstablished: TTLSEstablishedEvent 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

type TTLSHandshakeEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const ServerName: String;
  var Abort: Boolean
) of Object;

property OnTLSHandshake: TTLSHandshakeEvent 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

type TTLSPSKEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Identity: String;
  var PSK: String;
  var Ciphersuite: String
) of Object;

property OnTLSPSK: TTLSPSKEvent 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

type TTLSShutdownEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64
) of Object;

property OnTLSShutdown: TTLSShutdownEvent 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

type TTransferCompletedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  var OperationStatus: Integer
) of Object;

property OnTransferCompleted: TTransferCompletedEvent 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

type TUploadBeginEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String
) of Object;

property OnUploadBegin: TUploadBeginEvent 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

type TUploadEndEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String
) of Object;

property OnUploadEnd: TUploadEndEvent 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

type TUploadFileEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  RestartAt: Int64;
  Append: Boolean;
  var OperationStatus: Integer
) of Object;

property OnUploadFile: TUploadFileEvent 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

type TUploadProgressEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  Progress: Int64;
  Total: Int64
) of Object;

property OnUploadProgress: TUploadProgressEvent 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

type TWriteFileEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  var OperationStatus: Integer
) of Object;

property OnWriteFile: TWriteFileEvent 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:

Certificate Type

Encapsulates an individual X.509 certificate.

Remarks

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

Fields

Constructors

>

constructor Create();

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Remarks

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

Fields

Constructors

>

constructor Create();

FTPListEntry Type

Represents a basic container for the remote file details.

Remarks

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

Fields

Constructors

>

constructor Create();

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

Constructors

>

constructor Create();

TLSConnectionInfo Type

Contains information about a network connection.

Remarks

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

Fields

Constructors

>

constructor Create();

TLSSettings Type

A container for TLS connection settings.

Remarks

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

Fields

Constructors

>

constructor Create();

UserAccount Type

A container for user account information.

Remarks

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

Fields

Constructors

>

constructor Create();

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