SecureBlackbox 2020 macOS Edition

Questions / Feedback?

FTPServer Module

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

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

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

Method List


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

ConfigSets or retrieves a configuration setting.
DropClientTerminates a client connection.
GetClientBufferObtains a pending connection buffer.
ListClientsEnumerates the connected clients.
PinClientTakes a snapshot of the connection's properties.
SetClientBufferCommits a data buffer to the connection.
SetClientFileEntryCommits a file entry to the connection.
StartStarts the server.
StopStops the server.

Event List


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

AcceptReports an incoming connection.
AfterChangeDirectorySignals the completion of a directory change operation.
AfterCreateDirectorySignals the completion of a directory creation operation.
AfterRemoveDirectorySignals the completion of a directory removal operation.
AfterRemoveFileSignals the completion of a file removal operation.
AfterRenameFileSignals the completion of a file renaming operation.
AfterRequestAttributesSignals the completion of an attribute request.
AuthAttemptFires when a connected client makes an authentication attempt.
BeforeChangeDirectoryNotifies about an incoming change directory request.
BeforeCreateDirectoryNotifies about an incoming create directory request.
BeforeDownloadFileNotifies about an incoming file download request.
BeforeFindNotifies about an incoming file listing request.
BeforeRemoveDirectoryNotifies about an incoming directory removal request.
BeforeRemoveFileNotifies about an incoming file removal request.
BeforeRenameFileNotifies about an incoming file rename request.
BeforeRequestAttributesNotifies about an incoming attributes request.
BeforeSendReplyNotifies the application of a command reply being sent.
BeforeUploadFileNotifies about an incoming file upload request.
CertificateValidateFires when a client certificate needs to be validated.
ChangeDirectoryAn override for a directory change operation.
CommandProcessedSignals that a command has been processed by the server.
CommandReceivedSignals that a command has been received from the client.
ConnectReports an accepted connection.
CreateDirectoryAn override for a directory creation operation.
DisconnectFires to report a disconnected client.
DownloadFileAn override for a file download initiation operation.
ErrorInformation about errors during data delivery.
ExternalSignHandles remote or external signing initiated by the server protocol.
FindCloseSignals the completion of a directory listing request.
FindInitAn override for a directory listing initiation operation.
FindNextAn override for a directory listing entry request operation.
NotificationThis event notifies the application about an underlying control flow event.
ReadFileRequests a piece of file data from the application.
RemoveDirectoryAn override for a directory removal operation.
RemoveFileAn override for a file remove operation.
RenameFileAn override for a file rename operation.
RequestAttributesAn override for an attribute request.
TransferCompletedThis event is fired when a customized upload or download operation completes.
UploadFileAn override for a file upload initiation operation.
WriteFileHands a piece of file data to the application.

Configuration Settings


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

ActiveChannelThe channel to which the event that is being invoked corresponds.
ClientAuthEnables or disables certificate-based client authentication.
DualStackAllows the use of IPv4 and IPv6 simultaneously.
RefreshUsersEnables or disables real-time propagation of user information.
SecurityOptionsVarious options of the secure connection.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
UseOwnDNSResolverSpecifies whether the client components should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 macOS Edition - Version 20.0 [Build 8166]