FTPServer Component
Properties Methods Events Configuration Settings Errors
The FTPServer component provides server-side functionality for FTP and FTPS protocols.
Syntax
SecureBlackbox.Ftpserver
Remarks
FTPServer supports FTP (File Transfer Protocol) and FTPS (FTP-over-SSL) protocols. The FTPS protocol allows you to securely perform file transfer operations on the server over Transport Layer Security (TLS). TLS is a successor to the now deprecated SSL protocol, although the latter abbreviation is still widely used.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| Active | Whether the server is active and can accept incoming connections. |
| AllowAnonymous | Allows and disallows anonymous connections. |
| ClientFileEntry | A container for current file entry details. |
| DataHost | Host address for incoming data channel connections. |
| DataPortRangeFrom | Specifies the lower port range bound for passive mode data connections. |
| DataPortRangeTo | Specifies the upper port range bound for passive mode data connections. |
| ExternalCrypto | Provides access to external signing and DC parameters. |
| HandshakeTimeout | Specifies the handshake timeout in milliseconds. |
| Host | Specifies the server host. |
| ImplicitSSL | Enables or disables implicit SSL mode. |
| PassiveModeHost | The IP address of the passive mode host. |
| PinnedClient | Populates the pinned client details. |
| PinnedClientChain | Contains the certificate chain of the pinned client. |
| Port | The port number to listen for incoming connections on. |
| ReadOnly | Makes the server's file system read-only for all users. |
| RootDirectory | Specifies the server's root directory. |
| ServerCertificates | The server's TLS certificates. |
| SessionTimeout | Specifies the session timeout in milliseconds. |
| SocketSettings | Manages network connection settings. |
| TLSSettings | Manages TLS layer settings. |
| Users | Provides a list of registered users. |
| UseUTF8 | Enables or disables UTF8 file name conversions. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| config | Sets or retrieves a configuration setting. |
| dropClient | Terminates a client connection. |
| getClientBuffer | Obtains a pending connection buffer. |
| listClients | Enumerates the connected clients. |
| pinClient | Takes a snapshot of the connection's properties. |
| setClientBuffer | Commits a data buffer to the connection. |
| setClientFileEntry | Commits a file entry to the connection. |
| start | Starts the server. |
| stop | Stops the server. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
| Accept | Reports an incoming connection. |
| AfterChangeDirectory | Signals the completion of a directory change operation. |
| AfterCreateDirectory | Signals the completion of a directory creation operation. |
| AfterRemoveDirectory | Signals the completion of a directory removal operation. |
| AfterRemoveFile | Signals the completion of a file removal operation. |
| AfterRenameFile | Signals the completion of a file renaming operation. |
| AfterRequestAttributes | Signals the completion of an attribute request. |
| AuthAttempt | Fires when a connected client makes an authentication attempt. |
| BeforeChangeDirectory | Notifies about an incoming change directory request. |
| BeforeCreateDirectory | Notifies about an incoming create directory request. |
| BeforeDownloadFile | Notifies about an incoming file download request. |
| BeforeFind | Notifies about an incoming file listing request. |
| BeforeRemoveDirectory | Notifies about an incoming directory removal request. |
| BeforeRemoveFile | Notifies about an incoming file removal request. |
| BeforeRenameFile | Notifies about an incoming file rename request. |
| BeforeRequestAttributes | Notifies about an incoming attributes request. |
| BeforeSendReply | Notifies the application of a command reply being sent. |
| BeforeUploadFile | Notifies about an incoming file upload request. |
| CertificateValidate | Fires when a client certificate needs to be validated. |
| ChangeDirectory | An override for a directory change operation. |
| CommandProcessed | Signals that a command has been processed by the server. |
| CommandReceived | Signals that a command has been received from the client. |
| Connect | Reports an accepted connection. |
| CreateDirectory | An override for a directory creation operation. |
| Disconnect | Fires to report a disconnected client. |
| DownloadFile | An override for a file download initiation operation. |
| Error | Information about errors during data delivery. |
| ExternalSign | Handles remote or external signing initiated by the server protocol. |
| FindClose | Signals the completion of a directory listing request. |
| FindInit | An override for a directory listing initiation operation. |
| FindNext | An override for a directory listing entry request operation. |
| Notification | This event notifies the application about an underlying control flow event. |
| ReadFile | Requests a piece of file data from the application. |
| RemoveDirectory | An override for a directory removal operation. |
| RemoveFile | An override for a file remove operation. |
| RenameFile | An override for a file rename operation. |
| RequestAttributes | An override for an attribute request. |
| TransferCompleted | This event is fired when a customized upload or download operation completes. |
| UploadFile | An override for a file upload initiation operation. |
| WriteFile | Hands a piece of file data to the application. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| ActiveChannel | The channel to which the event that is being invoked corresponds. |
| ClientAuth | Enables or disables certificate-based client authentication. |
| DualStack | Allows the use of IPv4 and IPv6 simultaneously. |
| RefreshUsers | Enables or disables real-time propagation of user information. |
| SecurityOptions | Various options of the secure connection. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| UseOwnDNSResolver | Specifies whether the client components should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |