IP*Works! SSH V9 - Online Help
IP*Works! SSH V9
Questions / Feedback?

SFTPServer Control

Properties   Methods   Events   Configuration Settings   Errors  

The SFTPServer component is used to create a SFTP Server.

Syntax

SFTPServer

Remarks

The SFTPServer control 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 control with short descriptions. Click on the links for further details.

ConnectionBacklogThe maximum number of pending connections maintained by the TCP/IP subsystem.
SFTPConnectionCountThe number of records in the SFTPConnection arrays.
SFTPConnectionConnectedUsed to disconnect individual connections and/or show their status.
SFTPConnectionErrorMessageErrorMessage is used together with status codes returned from events to send informative errors back to the SFTP client through the SSH_FXP_STATUS message.
SFTPConnectionFileDataThe FileData should be set or read when processing read/write file events.
SFTPConnectionLocalAddressThis property shows the IP address of the interface through which the connection is passing.
SFTPConnectionProtocolVersionThe ProtocolVersion shows the SFTP protocol version negotiated with the client when the SFTP connection was established.
SFTPConnectionRemoteHostThe RemoteHost shows the IP address of the remote host through which the connection is coming.
SFTPConnectionRemotePortThe RemotePort shows the TCP port on the remote host through which the connection is coming.
SFTPConnectionTimeoutA timeout for the component.
DefaultAuthMethodsSpecifies the supported authentication methods.
DefaultTimeoutAn initial timeout value to be used by incoming connections.
KeyboardInteractiveMessageThe instructions to send to the client during keyboard-interactive authentication.
KeyboardInteractivePromptCountThe number of records in the KeyboardInteractivePrompt arrays.
KeyboardInteractivePromptEchoSpecifies if the client should echo the value entered by the user or not.
KeyboardInteractivePromptPromptThe prompt label/text the client should present to the user.
ListeningIf True, the component accepts incoming connections on LocalPort.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component listens.
RootDirectoryThe root directory for the entire SFTP server.
SSHCertEncodedThe certificate (PEM/base64 encoded).
SSHCertStoreThe name of the certificate store for the client certificate.
SSHCertStorePasswordIf 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.
SSHCertStoreTypeThe type of certificate store for this certificate.
SSHCertSubjectThe subject of the certificate used for client authentication.
SSHCompressionAlgorithmsA comma-separated list containing all allowable compression algorithms.
SSHEncryptionAlgorithmsA comma-separated list containing all allowable compression algorithms.

Method List


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

ConfigSets or retrieves a configuration setting .
DisconnectDisconnect the specified client.
DoEventsProcesses events from the internal message queue.
ExchangeKeysCauses the component to exchange a new set of session keys on the specified connection.
SetFileListSets the file list for a connection during a directory listing request.
ShutdownShuts down the server.

Event List


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

ConnectedFired immediately after a connection completes (or fails).
ConnectionRequestFired when a request for connection comes from a remote host.
DirCreateFires when a client wants to create a new directory.
DirListFires when a client attempts to open a directory for listing.
DirRemoveFires when a client wants to delete a directory.
DisconnectedFired when a connection is closed.
ErrorInformation about errors during data delivery.
FileCloseFires when a client attempts to close an open file or directory handle.
FileOpenFires when a client wants to open or create a file.
FileReadFires when a client wants to read from an open file.
FileRemoveFires when a client wants to delete a file.
FileRenameFires when a client wants to rename a file.
FileWriteFires when a client wants to write to an open file.
GetAttributesFires when a client needs to get file information.
ResolvePathFires when a client attempts to canonicalize a path.
SetAttributesFires when a client attempts to set file or directory attributes.
SSHStatusShows the progress of the secure connection.
SSHUserAuthRequestFires when a client attempts to authenticate a connection.

Configuration Settings


The following is a list of configuration settings for the control 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.
ProtocolVersionThe highest allowable SFTP version to use.
RestrictUserToHomeDir[ConnectionId]Whether to restrict the user to their HomeDir.
ServerEOLSpecifies the line endings used in files on the server.
SFTPErrorMessage[ConnectionId]Specifies the error message to be returned to the client.
MaxAuthAttemptsThe maximum authentication attempts allowed before forcing a disconnect.
ServerSSHVersionStringThe SSH version string sent to connecting clients.
UserAuthBanner[ConnectionId]A custom user authentication banner.
KeyRenegotiationThresholdSets the threshold for the SSH Key Renegotiation.
SSHKeyExchangeAlgorithmsSpecifies the supported key exchange algorithms.
SSHMacAlgorithmsSpecifies the supported Mac algorithms.
BindExclusivelyWhether or not the component considers a local port reserved for exclusive use.
InBufferSizeThe size in bytes of the incoming queue of the socket.
MaxConnectionsThe maximum number of connections available.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe 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.
TcpNoDelayWhether or not to delay when sending packets.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 9.0.6240.0