SFTPServer Class
Properties Methods Events Configuration Settings Errors
The SFTPServer component is used to create a SFTP Server.
Syntax
ipworksssh.sftpserver()
Remarks
The SFTPServer class provides a simple way to create a SFTP server. Any SFTP client will be able to connect and transfer files to and from the server.
To begin, first provide a valid certificate with private key in the SSHCert property.
Set the RootDirectory property to a valid local path. When clients connect they will see this as their initial directory.
To start the server set Listening to true.
When clients connect the SSHUserAuthRequest event is fired. This provides an opportunity to validate the client's credentials. Please see the help for SSHUserAuthRequest for more details.
This is all that is required to start the SFTP server and begin serving files.
During operation other events fire to provide further information and also to provide you an opportunity to override the default behavior and return errors if desired.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| ConnectionBacklog | The maximum number of pending connections maintained by the TCP/IP subsystem. |
| SFTPConnectionCount | The number of records in the SFTPConnection arrays. |
| SFTPConnectionConnected | Used to disconnect individual connections and/or show their status. |
| SFTPConnectionErrorMessage | ErrorMessage is used together with status codes returned from events to send informative errors back to the SFTP client through the SSH_FXP_STATUS message. |
| SFTPConnectionFileData | The FileData should be set or read when processing read/write file events. |
| SFTPConnectionLocalAddress | This property shows the IP address of the interface through which the connection is passing. |
| SFTPConnectionProtocolVersion | The ProtocolVersion shows the SFTP protocol version negotiated with the client when the SFTP connection was established. |
| SFTPConnectionRemoteHost | The RemoteHost shows the IP address of the remote host through which the connection is coming. |
| SFTPConnectionRemotePort | The RemotePort shows the TCP port on the remote host through which the connection is coming. |
| SFTPConnectionTimeout | A timeout for the component. |
| DefaultAuthMethods | Specifies the supported authentication methods. |
| DefaultTimeout | An initial timeout value to be used by incoming connections. |
| KeyboardInteractiveMessage | The instructions to send to the client during keyboard-interactive authentication. |
| KeyboardInteractivePromptCount | The number of records in the KeyboardInteractivePrompt arrays. |
| KeyboardInteractivePromptEcho | Specifies if the client should echo the value entered by the user or not. |
| KeyboardInteractivePromptPrompt | The prompt label/text the client should present to the user. |
| Listening | If True, the component accepts incoming connections on LocalPort. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| LocalPort | The TCP port in the local host where the component listens. |
| RootDirectory | The root directory for the entire SFTP server. |
| SSHCertEncoded | The certificate (PEM/base64 encoded). |
| SSHCertStore | The name of the certificate store for the client certificate. |
| SSHCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
| SSHCertStoreType | The type of certificate store for this certificate. |
| SSHCertSubject | The subject of the certificate used for client authentication. |
| SSHCompressionAlgorithms | A comma-separated list containing all allowable compression algorithms. |
| SSHEncryptionAlgorithms | A comma-separated list containing all allowable compression algorithms. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting . |
| Disconnect | Disconnect the specified client. |
| DoEvents | Processes events from the internal message queue. |
| ExchangeKeys | Causes the component to exchange a new set of session keys on the specified connection. |
| SetFileList | Sets the file list for a connection during a directory listing request. |
| Shutdown | Shuts down the server. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
| Connected | Fired immediately after a connection completes (or fails). |
| ConnectionRequest | Fired when a request for connection comes from a remote host. |
| DirCreate | Fires when a client wants to create a new directory. |
| DirList | Fires when a client attempts to open a directory for listing. |
| DirRemove | Fires when a client wants to delete a directory. |
| Disconnected | Fired when a connection is closed. |
| Error | Information about errors during data delivery. |
| FileClose | Fires when a client attempts to close an open file or directory handle. |
| FileOpen | Fires when a client wants to open or create a file. |
| FileRead | Fires when a client wants to read from an open file. |
| FileRemove | Fires when a client wants to delete a file. |
| FileRename | Fires when a client wants to rename a file. |
| FileWrite | Fires when a client wants to write to an open file. |
| GetAttributes | Fires when a client needs to get file information. |
| ResolvePath | Fires when a client attempts to canonicalize a path. |
| SetAttributes | Fires when a client attempts to set file or directory attributes. |
| SSHStatus | Shows the progress of the secure connection. |
| SSHUserAuthRequest | Fires when a client attempts to authenticate a connection. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| DirListBufferSize[ConnectionId] | The number of entries to be returned in one response to a request for a directory listing. |
| ProtocolVersion | The highest allowable SFTP version to use. |
| RestrictUserToHomeDir[ConnectionId] | Whether to restrict the user to their HomeDir. |
| ServerEOL | Specifies the line endings used in files on the server. |
| SFTPErrorMessage[ConnectionId] | Specifies the error message to be returned to the client. |
| MaxAuthAttempts | The maximum authentication attempts allowed before forcing a disconnect. |
| ServerSSHVersionString | The SSH version string sent to connecting clients. |
| UserAuthBanner[ConnectionId] | A custom user authentication banner. |
| KeyRenegotiationThreshold | Sets the threshold for the SSH Key Renegotiation. |
| SSHKeyExchangeAlgorithms | Specifies the supported key exchange algorithms. |
| SSHMacAlgorithms | Specifies the supported Mac algorithms. |
| BindExclusively | Whether or not the component considers a local port reserved for exclusive use. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| MaxConnections | The maximum number of connections available. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| RecordLength[ConnectionId] | The length of received data records. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| CodePage | The system code page used for Unicode to Multibyte translations. |