SFTPServer Component
Properties Methods Events Configuration Settings Errors
The SFTPServer component provides server-side functionality for SFTP connections.
Syntax
SecureBlackbox.Sftpserver
Remarks
TElSFTPServer is an implementation for SSH File Transfer Protocol server. It works over a secure SSH channel, and should not be confused with the FTP/FTPS protocol.
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 | Specifies whether the SFTP server has started and ready to accept connections. |
| AuthTypes | Defines allowed authentication types. |
| BaseDir | Specifies the server's base (root) directory. |
| ClientFileEntry | A container for file entry details. |
| CompressionLevel | Specifies the preferable compression level. |
| ExternalCrypto | Provides access to external signing and DC parameters. |
| ForceCompression | This property specifies whether server explicitly requires data compression. |
| Host | Specifies server's host name. |
| Key | Contains client's public key. |
| MaxSFTPVersion | Maximum SFTP version supported. |
| MinSFTPVersion | Minimum SFTP version supported. |
| PinnedClient | Populates the pinned client details. |
| Port | Specifies the listening port number. |
| ReadOnly | Specifies whether files on the server are read-only. |
| ServerKeys | The server's SSH keys. |
| SocketSettings | Manages network connection settings. |
| SSHSettings | The SSH connection settings. |
| Users | A collection of known users. |
| UseUTF8 | Specifies whether UTF8 conversion is to be used when parsing file names. |
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 | Acquires a piece of operation data. |
| getClientFileEntry | Acquires file entry details from the component. |
| listClients | Enumerates the connected clients. |
| pinClient | Takes a snapshot of the connection's properties. |
| setClientBuffer | Commits a data buffer to the server component. |
| setClientFileEntry | Commits the file entry details to the component. |
| start | Starts SFTP server operation. |
| stop | Stops SFTP 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 | This event is fired when new incoming connection is accepted. |
| AfterCreateDirectory | This event indicates completion of directory creation request. |
| AfterRemove | This event indicates completion of file removal request. |
| AfterRenameFile | This event indicates completion of a file rename operation. |
| AfterRequestAttributes | This event indicates completion of file attributes request. |
| AfterSetAttributes | This event indicates completion of a set attributes request. |
| AuthAttempt | Reports a user authentication attempt. |
| AuthFailed | Reports user authentication failure. |
| AuthPassword | This event is fired on password authentication attempt from a client. |
| AuthPublicKey | This event is fired on public key authentication attempt from a client. |
| AuthSucceeded | Reports a successful user authentication. |
| BeforeCreateDirectory | This event is fired when a client requests to create a directory. |
| BeforeDownloadFile | This event is fired when a download file request is received. |
| BeforeFind | This event is fired when a client requests to find files and folders in Path. |
| BeforeRemove | This event is fired when a client requests to delete a file or directory. |
| BeforeRenameFile | This event is fired when a client requests to rename a file. |
| BeforeRequestAttributes | This event is fired when a client requests to get file attributes. |
| BeforeSetAttributes | This event is fired when a client requests to set file attributes. |
| BeforeUploadFile | This event is fired when an upload file request is received. |
| CloseFile | This event instructs the application to close an opened file. |
| Connect | This event is fired when a remote connection has been established. |
| CreateDirectory | This event instructs the application to create a directory. |
| Disconnect | This event is fired when a client has disconnected. |
| Error | Information about errors during data delivery. |
| ExternalSign | Handles remote or external signing initiated by the server protocol. |
| FindClose | This event signifies the completion of a custom file listing operation. |
| FindFirst | This event signifies the start of the custom file listing retrieval mechanism. |
| FindNext | This event retrieves the next entry of a custom file listing. |
| Notification | This event notifies the application about an underlying control flow event. |
| OpenFile | This event instructs the application to handle the file open request. |
| ReadFile | This event is fired when a file read request is received. |
| Remove | This event is fired when a client requests to delete a file or directory. |
| RenameFile | This event is fired when a client requests to rename a file. |
| RequestAttributes | This event is fired when a get file attributes request is received. |
| SessionClosed | Reports session closure. |
| SessionEstablished | This event is fired when a new session is established. |
| SetAttributes | This event is fired when an set file attributes request is received. |
| WriteFile | This event is fired when a file write request is received. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| AuthMode | Controls dual/multi-type authentication mode. |
| CustomDHGroupIndex | Sets a specific Diffie-Hellman group index to enforce. |
| DualStack | Allows the use of ip4 and ip6 simultaneously. |
| MaxDHGroupSize | Sets the maximal Diffie-Hellman group size. |
| MinDHGroupSize | Sets the minimal Diffie-Hellman group size. |
| NotifyOnFileOperations | Enables low-level file operation notifications. |
| 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. |