SFTPClient Class
Properties Methods Events Config Settings Errors
The SFTPClient class can be used to transfer files to and from Secure File Transfer Protocol (SFTP) servers.
Syntax
ipworkssftp.sftpclient()
Remarks
The SFTPClient class is the Secure Shell (SSH)-enabled equivalent of the IPWorks FTP class. The SSHHost and SSHPort properties specify which Secure Shell (SSH) server to use. The SSHUser and SSHPassword properties allow the client to authenticate itself with the server. The SSHServerAuthentication event or SSHAcceptServerHostKey property allow you to check the server identity. Finally, the SSHStatus event provides information about the SSH handshake.
The SFTPClient class implements a standard SSH file transfer client.
The first step in using the class is specifying the SSHHost, SSHUser, and SSHPassword. The file to upload to or download from is given by the RemoteFile property. The file to download to or upload from is specified by LocalFile. The current path in the server is specified by the RemotePath property.
If LocalFile is set to something other than an empty string, then files are received in LocalFile; otherwise, the data are received through the Transfer event. StartTransfer and EndTransfer are fired at the beginning and end of transmission.
Directory listings are received through the DirList event.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
Connected | This property shows whether the class is connected. |
DirList | Collection of entries resulting in the last directory listing. |
FileAttributes | The attributes of the RemoteFile . |
Firewall | A set of properties related to firewall access. |
Idle | This property specifies the current status of the class. |
LocalFile | The path to a local file for upload or download. |
LocalHost | This property includes 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 class binds. |
Overwrite | The value indicating whether or not the class should overwrite files during transfer. |
RemoteFile | The name of the remote file for uploading or downloading. |
RemotePath | The current path in the secure file transfer protocol (SFTP) server. |
SSHAcceptServerHostKey | Instructs the class to accept the server host key that matches the supplied key. |
SSHAuthMode | The authentication method to be used the class when calling SSHLogon . |
SSHCert | A certificate to be used for authenticating the SSHUser . |
SSHCompressionAlgorithms | A comma-separated list containing all allowable compression algorithms. |
SSHEncryptionAlgorithms | A comma-separated list containing all allowable encryption algorithms. |
SSHHost | The address of the SSH host. |
SSHPassword | The password for SSH password-based authentication. |
SSHPort | The port on the SSH server where the SSH service is running; by default, 22. |
SSHUser | The username for SSH authentication. |
StartByte | The offset in bytes at which to begin the upload or download. |
Timeout | This property includes the timeout for the class. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Append | Append data from LocalFile to a remote file RemoteFile on a Secure File Transfer Protocol (SFTP) server. |
ChangeRemotePath | Changes the current path on the server. |
CheckFileExists | Returns if the file specified by RemoteFile exists on the remote server. |
Config | Sets or retrieves a configuration setting. |
Connect | Connects to the SSH host without logging in. |
CreateFile | Creates a file on the Secure File Transfer Protocol (SFTP) server. |
DecodePacket | Decodes a hex-encoded SSH packet. |
DeleteFile | Delete a file specified by FileName from a Secure File Transfer Protocol (SFTP) server. |
Disconnect | This method disconnects from the server without first logging off. |
DoEvents | This method processes events from the internal message queue. |
Download | Download a RemoteFile from a Secure File Transfer Protocol (SFTP) server. |
DownloadRange | DownloadRange facilitates the partial downloading of a remote file from a Secure File Transfer Protocol (SFTP) server. |
EncodePacket | Hex encodes an SSH packet. |
GetSSHParam | Used to read a field from an SSH packet's payload. |
GetSSHParamBytes | Used to read a field from an SSH packet's payload. |
Interrupt | This method interrupts the current method. |
ListDirectory | List the current directory specified by RemotePath on a Secure File Transfer Protocol (SFTP) server. |
MakeDirectory | Creates a directory on a Secure File Transfer Protocol (SFTP) server. |
QueryFileAttributes | Queries the server for the attributes of RemoteFile . |
QueueFile | Adds a file to the transfer queue. |
RemoveDirectory | Remove a directory specified by DirName from a secure file transfer protocol (SFTP) server. |
RenameFile | Change the name of RemoteFile to NewName . |
Reset | This method will reset the class. |
ResetQueue | Resets the queue of files to be transferred. |
SetSSHParam | Used to write a field to the end of a payload. |
SSHLogoff | Logoff from the SSH server. |
SSHLogon | Logon to the SSHHost using the current SSHUser and SSHPassword . |
UpdateFileAttributes | Instructs the class to send the FileAttributes to the server. |
Upload | Upload a file specified by LocalFile to a secure file transfer protocol (SFTP) server. |
UploadRange | UploadRange inserts data into a remote file on a secure file transfer protocol (SFTP) 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 | This event is fired immediately after a connection completes (or fails). |
ConnectionStatus | This event is fired to indicate changes in the connection state. |
DirList | Fired when a directory entry is received. |
Disconnected | This event is fired when a connection is closed. |
EndTransfer | Fired when a file completes downloading or uploading. |
Error | Information about errors during data delivery. |
Log | Fires once for each log message. |
SSHCustomAuth | Fired when the class is doing custom authentication. |
SSHKeyboardInteractive | Fired when the class receives a request for user input from the server. |
SSHServerAuthentication | Fired after the server presents its public key to the client. |
SSHStatus | Shows the progress of the secure connection. |
StartTransfer | Fired when a file starts downloading or uploading. |
Transfer | Fired during file download or upload. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AllowBackslashInName | Whether backslashes are allowed in folder and file names. |
AsyncTransfer | Controls whether simultatenous requests are made to read or write files. |
AttrAccessTime | Can be queried for the AccessTime file attribute during the DirList event. |
AttrCreationTime | Can be queried for the CreationTime file attribute during the DirList event. |
AttrFileType | Can be queried for the FileType file attribute during the DirList event. |
AttrGroupId | Can be queried for the GroupId file attribute during the DirList event. |
AttrLinkCount | Can be queried for the LinkCount file attribute during the DirList event. |
AttrOwnerId | Can be queried for the OwnerId file attribute during the DirList event. |
AttrPermission | Can be queried for the Permissions file attribute during the DirList event. |
CheckFileHash | Compares a server-computed hash with a hash calculated locally. |
CopyRemoteData | Copies a specified range of bytes in one file to another. |
CopyRemoteFile | Copies a file from one location to another directly on the server. |
DisableRealPath | Controls whether or not the SSH_FXP_REALPATH request is sent. |
ExcludeFileMask | Specifies a file mask for excluding files in directory listings. |
FileMaskDelimiter | Specifies a delimiter to use for setting multiple file masks in the RemoteFile property. |
FiletimeFormat | Specifies the format to use when returning filetime strings. |
FreeSpace | The free space on the remote server in bytes. |
GetSpaceInfo | Queries the server for drive usage information. |
GetSymlinkAttrs | Whether to get the attributes of the symbolic link, or the resource pointed to by the link. |
IgnoreFileMaskCasing | Controls whether or not the file mask is case sensitive. |
LocalEOL | When TransferMode is set, this specifies the line ending for the local system. |
LogSFTPFileData | Whether SFTP file data is present in Debug logs. |
MaskSensitiveData | Masks passwords in logs. |
MaxFileData | Specifies the maximum payload size of an SFTP packet. |
MaxOutstandingPackets | Sets the maximum number of simultaneous read or write requests allowed. |
NegotiatedProtocolVersion | The negotiated SFTP version. |
NormalizeRemotePath | Whether to normalize the RemotePath. |
PreserveFileTime | Preserves the file's timestamps during transfer. |
ProtocolVersion | The highest allowable SFTP version to use. |
ReadLink | This settings returns the target of a specified symbolic link. |
RealTimeUpload | Enables real time uploading. |
RealTimeUploadAgeLimit | The age limit in seconds when using RealTimeUpload. |
ServerEOL | When TransferMode is set, this specifies the line ending for the remote system. |
SimultaneousTransferLimit | The maximum number of simultaneous file transfers. |
TotalSpace | The total space on the remote server in bytes. |
TransferMode | The transfer mode (ASCII or Binary). |
TransferredDataLimit | Specifies the maximum number of bytes to download from the remote file. |
UseFxpStat | Whether SSH_FXP_STAT is sent. |
UseServerFileTime | Controls if the file time returned from the server is converted to local time or not. |
UseServerFileTime | Controls if the file time returned from the server is converted to local time or not. |
ChannelDataEOL[ChannelId] | Used to break the incoming data stream into chunks. |
ChannelDataEOLFound[ChannelId] | Determines if ChannelDataEOL was found. |
ClientSSHVersionString | The SSH version string used by the class. |
EnablePageantAuth | Whether to use a key stored in Pageant to perform client authentication. |
KerberosDelegation | If true, asks for credentials with delegation enabled during authentication. |
KerberosRealm | The fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication. |
KerberosSPN | The Kerberos Service Principal Name of the SSH host. |
KeyRenegotiationThreshold | Sets the threshold for the SSH Key Renegotiation. |
LogLevel | Specifies the level of detail that is logged. |
MaxChannelDataLength[ChannelId] | The maximum amount of data to accumulate when no ChannelDataEOL is found. |
MaxPacketSize | The maximum packet size of the channel, in bytes. |
MaxWindowSize | The maximum window size allowed for the channel, in bytes. |
NegotiatedStrictKex | Returns whether strict key exchange was negotiated to be used. |
PasswordPrompt | The text of the password prompt used in keyboard-interactive authentication. |
PreferredDHGroupBits | The size (in bits) of the preferred modulus (p) to request from the server. |
RecordLength | The length of received data records. |
ServerSSHVersionString | The remote host's SSH version string. |
SignedSSHCert | The CA signed client public key used when authenticating. |
SSHAcceptAnyServerHostKey | If set the class will accept any key presented by the server. |
SSHAcceptServerCAKey | The CA public key that signed the server's host key. |
SSHAcceptServerHostKeyFingerPrint | The fingerprint of the server key to accept. |
SSHFingerprintHashAlgorithm | The algorithm used to calculate the fingerprint. |
SSHFingerprintMD5 | The server hostkey's MD5 fingerprint. |
SSHFingerprintSHA1 | The server hostkey's SHA1 fingerprint. |
SSHFingerprintSHA256 | The server hostkey's SHA256 fingerprint. |
SSHKeepAliveCountMax | The maximum number of keep alive packets to send without a response. |
SSHKeepAliveInterval | The interval between keep alive packets. |
SSHKeyExchangeAlgorithms | Specifies the supported key exchange algorithms. |
SSHKeyRenegotiate | Causes the class to renegotiate the SSH keys. |
SSHMacAlgorithms | Specifies the supported Mac algorithms. |
SSHPubKeyAuthSigAlgorithms | Specifies the enabled signature algorithms that may be used when attempting public key authentication. |
SSHPublicKeyAlgorithms | Specifies the supported public key algorithms for the server's public key. |
SSHVersionPattern | The pattern used to match the remote host's version string. |
TryAllAvailableAuthMethods | If set to true, the class will try all available authentication methods. |
UseStrictKeyExchange | Specifies how strict key exchange is supported. |
WaitForChannelClose | Whether to wait for channels to be closed before disconnected. |
WaitForServerDisconnect | Whether to wait for the server to close the connection. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
SFTPClient.Connected Property
This property shows whether the class is connected.
Syntax
isConnected(): boolean;
Default Value
FALSE
Remarks
This property is used to determine whether or not the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.
This property is read-only and not available at design time.
SFTPClient.DirList Property
Collection of entries resulting in the last directory listing.
Syntax
getDirList(): DirEntryList;
Default Value
Remarks
This collection of entries is returned after a response is received from the server after a call to ListDirectory. The collection is made up of entries for each listing in the current directory, which is specified by the RemotePath property.
MaxDirEntries can be used to control the number of directory listings saved.
This property is read-only and not available at design time.
Please refer to the DirEntry type for a complete list of fields.SFTPClient.FileAttributes Property
The attributes of the RemoteFile .
Syntax
getFileAttributes(): SFTPFileAttributes; setFileAttributes(fileAttributes: SFTPFileAttributes): void;
Default Value
Remarks
This property holds the attributes for the file specified by RemoteFile. Before querying this property, first call QueryFileAttributes to retrieve the attributes from the server.
To modify the attributes of the file, you may set FileAttributes and then call UpdateFileAttributes.
This property is not available at design time.
Please refer to the SFTPFileAttributes type for a complete list of fields.SFTPClient.Firewall Property
A set of properties related to firewall access.
Syntax
getFirewall(): Firewall; setFirewall(firewall: Firewall): void;
Default Value
Remarks
This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.
Please refer to the Firewall type for a complete list of fields.SFTPClient.Idle Property
This property specifies the current status of the class.
Syntax
isIdle(): boolean;
Default Value
TRUE
Remarks
Idle will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.
This property is read-only.
SFTPClient.LocalFile Property
The path to a local file for upload or download.
Syntax
getLocalFile(): string; setLocalFile(localFile: string): void;
Default Value
""
Remarks
The LocalFile property is used by the Upload and Download methods. The file will be overwritten only if the Overwrite property is set to True.
Example. Setting LocalFile:
SFTPControl.Localfile = "C:\localfile.txt"
SFTPControl.RemoteFile = "remotefile.txt"
SFTPControl.Download()
SFTPControl.Localfile = "C:\localfile2.txt"
SFTPControl.RemoteFile = "folder/remotefile2.txt"
SFTPControl.Download()
SFTPClient.LocalHost Property
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
getLocalHost(): string; setLocalHost(localHost: string): void;
Default Value
""
Remarks
The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.
If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Note: LocalHost is not persistent. You must always set it in code, and never in the property window.
SFTPClient.LocalPort Property
The TCP port in the local host where the class binds.
Syntax
getLocalPort(): number; setLocalPort(localPort: number): void;
Default Value
0
Remarks
This property must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.
Setting this property to 0 (default) enables the system to choose an open port at random. The chosen port will be returned by the LocalPort property after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error.
This property is useful when trying to connect to services that require a trusted port on the client side.
SFTPClient.Overwrite Property
The value indicating whether or not the class should overwrite files during transfer.
Syntax
isOverwrite(): boolean; setOverwrite(overwrite: boolean): void;
Default Value
FALSE
Remarks
This property is a value indicating whether or not the class should overwrite LocalFile when downloading and RemoteFile when uploading. If Overwrite is False, an error will be thrown whenever LocalFile exists before a download operation.
SFTPClient.RemoteFile Property
The name of the remote file for uploading or downloading.
Syntax
getRemoteFile(): string; setRemoteFile(remoteFile: string): void;
Default Value
""
Remarks
The RemoteFile is either an absolute file path or a relative path based on RemotePath.
A number of methods use RemoteFile as an argument.
Example 1. Setting RemoteFile:
SFTPControl.Localfile = "C:\localfile.txt"
SFTPControl.RemoteFile = "remotefile.txt"
SFTPControl.Download()
SFTPControl.Localfile = "C:\localfile2.txt"
SFTPControl.RemoteFile = "folder/remotefile2.txt"
SFTPControl.Download()
Note: This property will also act as a file mask when performing ListDirectory.
Example 2. Using RemoteFile as a File Mask:
SFTPControl.RemoteFile = "*.txt"
SFTPControl.ListDirectory()
The following special characters are supported for pattern matching:
? | Any single character. |
* | Any characters or no characters (e.g., C*t matches Cat, Cot, Coast, Ct). |
[,-] | A range of characters (e.g., [a-z], [a], [0-9], [0-9,a-d,f,r-z]). |
\ | The slash is ignored and exact matching is performed on the next character. |
If these characters need to be used as a literal in a pattern, then they must be escaped by surrounding them with brackets []. Note: "]" and "-" do not need to be escaped. See below for the escape sequences:
Character | Escape Sequence |
? | [?] |
* | [*] |
[ | [[] |
\ | [\] |
For example, to match the value [Something].txt, specify the pattern [[]Something].txt.
SFTPClient.RemotePath Property
The current path in the secure file transfer protocol (SFTP) server.
Syntax
getRemotePath(): string;
Default Value
""
Remarks
The RemotePath shows the current working directory on the SFTP server. The ChangeRemotePath method can be used to change the working directory to an absolute directory path or to a relative path with respect to the current value of RemotePath.
Example. Changing Directory:
sftp1.SSHLogon("sftp.server.net", 22);
sftp1.ChangeRemotePath("/home/user");
This property is read-only.
SFTPClient.SSHAcceptServerHostKey Property
Instructs the class to accept the server host key that matches the supplied key.
Syntax
getSSHAcceptServerHostKey(): Certificate; setSSHAcceptServerHostKey(SSHAcceptServerHostKey: Certificate): void;
Default Value
Remarks
If the host key that will be used by the server is known in advance, this property may be set to accept the expected key. Otherwise the SSHServerAuthentication event should be trapped, and the key should be accepted or refused in the event.
If this property is not set and the SSHServerAuthentication event is not trapped, the server will not be authenticated and the connection will be terminated by the client.
Please refer to the Certificate type for a complete list of fields.SFTPClient.SSHAuthMode Property
The authentication method to be used the class when calling SSHLogon .
Syntax
getSSHAuthMode(): SFTPClientSSHAuthModes; setSSHAuthMode(SSHAuthMode: SFTPClientSSHAuthModes): void;
enum SFTPClientSSHAuthModes { amNone, amMultiFactor, amPassword, amPublicKey, amKeyboardInteractive, amGSSAPIWithMic, amGSSAPIKeyex, amCustom }
Default Value
2
Remarks
The SSH Authentication specification (RFC 4252) specifies multiple methods by which a user can be authenticated by an SSH server. When a call is made to SSHLogon, the class will connect to the SSH server and establish the security layer. After the connection has been secured, the client will send an authentication request to the SSHHost containing the SSHUser. The server will respond containing a list of methods by which that user may be authenticated.
The class will attempt to authenticate the user by one of those methods based on the value of SSHAuthMode and other property values supplied by the user. Currently, the class supports the following authentication methods:
amNone (0) | No authentication will be performed. The current SSHUser value is ignored, and the connection will be logged in as anonymous. |
amMultiFactor (1) | This allows the class to attempt a multi-step authentication process. The class will send authentication data to the server based on the list of methods allowed for the current user and the authentication property values supplied. The class will continue to send authentication data until the server acknowledges authentication success. If the server rejects an authentication step, the class . |
amPassword (2) | The class will use the values of SSHUser and SSHPassword to authenticate the user. |
amPublicKey (3) | The class will use the values of SSHUser and the SSHCert* properties to authenticate the user. the SSHCert* properties must have a private key available for this authentication method to succeed. |
amKeyboardInteractive (4) | At the time of authentication, the class will fire the SSHKeyboardInteractive event containing instructions on how to complete the authentication step. (NOTE: amKeyboardInteractive is not supported in SSHTunnel). |
amGSSAPIWithMic (5) | This allows the class to attempt Kerberos authentication using the GSSAPI-WITH-MIC scheme. The client will try Kerberos authentication using the value of SSHUser (single sign-on), or if SSHPassword is specified as well, it will try Kerberos authentication with alternate credentials. This is currently supported only on Windows, unless using the Java edition, which also provides support for Linux and macOS. |
amGSSAPIKeyex (6) | This allows the class to attempt Kerberos authentication using the GSSAPIKeyex scheme. The client will try Kerberos authentication using the value of SSHUser (single sign-on), or if SSHPassword is specified as well, it will try Kerberos authentication with alternate credentials. This is currently supported only on Windows, unless using the Java edition, which also provides support for Linux and macOS. |
amCustom (99) | This allows the class caller to take over the authentication process completely. When amCustom is set, the class will fire the SSHCustomAuth event as necessary to complete the authentication process. |
Example (User/Password Auth):
Control.SSHAuthMode = SftpSSHAuthModes.amPassword
Control.SSHUser = "username"
Control.SSHPassword = "password"
Control.SSHLogon("server", 22)
Example (Public Key Auth):
Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey
Control.SSHUser = "username"
Control.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile;
Control.SSHCertStore = "cert.pfx";
Control.SSHCertStorePassword = "certpassword";
Control.SSHCertSubject = "*";
Control.SSHLogon("server", 22)
SFTPClient.SSHCert Property
A certificate to be used for authenticating the SSHUser .
Syntax
getSSHCert(): Certificate; setSSHCert(SSHCert: Certificate): void;
Default Value
Remarks
In order to use public key authentication, SSHCert must contain a Certificate with a valid private key. The certificate's public key value is sent to the server along with a signature produced using the private key. The server will first check to see if the public key values match what is known for the user, and then will attempt to use those values to verify the signature.
Example (User/Password Auth):
Control.SSHAuthMode = SftpSSHAuthModes.amPassword
Control.SSHUser = "username"
Control.SSHPassword = "password"
Control.SSHLogon("server", 22)
Example (Public Key Auth):
Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey
Control.SSHUser = "username"
Control.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile;
Control.SSHCertStore = "cert.pfx";
Control.SSHCertStorePassword = "certpassword";
Control.SSHCertSubject = "*";
Control.SSHLogon("server", 22)
SFTPClient.SSHCompressionAlgorithms Property
A comma-separated list containing all allowable compression algorithms.
Syntax
getSSHCompressionAlgorithms(): string; setSSHCompressionAlgorithms(SSHCompressionAlgorithms: string): void;
Default Value
"none,zlib"
Remarks
During the SSH handshake, this list will be used to negotiate the compression algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports, so it is important to list multiple algorithms in preferential order. If no algorithm can be agreed upon, the class will raise an error and the connection will be aborted.
At least one supported algorithm must appear in this list. The following compression algorithms are supported by the class:
- zlib
- zlib@openssh.com
- none
SFTPClient.SSHEncryptionAlgorithms Property
A comma-separated list containing all allowable encryption algorithms.
Syntax
getSSHEncryptionAlgorithms(): string; setSSHEncryptionAlgorithms(SSHEncryptionAlgorithms: string): void;
Default Value
"aes256-ctr,aes192-ctr,aes128-ctr,3des-ctr,arcfour256,arcfour128,arcfour,aes256-gcm@openssh.com,aes128-gcm@openssh.com,chacha20-poly1305@openssh.com"
Remarks
During the SSH handshake, this list will be used to negotiate the encryption algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports, so it is important to list multiple algorithms in preferential order. If no algorithm can be agreed upon, the class will raise an error and the connection will be aborted.
At least one supported algorithm must appear in this list. The following encryption algorithms are supported by the class:
aes256-ctr | 256-bit AES encryption in CTR mode |
aes256-cbc | 256-bit AES encryption in CBC mode |
aes192-ctr | 192-bit AES encryption in CTR mode |
aes192-cbc | 192-bit AES encryption in CBC mode |
aes128-ctr | 128-bit AES encryption in CTR mode |
aes128-cbc | 128-bit AES encryption in CBC mode |
3des-ctr | 192-bit (3-key) triple DES encryption in CTR mode |
3des-cbc | 192-bit (3-key) triple DES encryption in CBC mode |
cast128-cbc | CAST-128 encryption |
blowfish-cbc | Blowfish encryption |
arcfour | ARC4 encryption |
arcfour128 | 128-bit ARC4 encryption |
arcfour256 | 256-bit ARC4 encryption |
aes256-gcm@openssh.com | 256-bit AES encryption in GCM mode. |
aes128-gcm@openssh.com | 128-bit AES encryption in GCM mode. |
chacha20-poly1305@openssh.com | ChaCha20 with Poly1305-AES encryption. |
SFTPClient.SSHHost Property
The address of the SSH host.
Syntax
getSSHHost(): string; setSSHHost(SSHHost: string): void;
Default Value
""
Remarks
The SSHHost property specifies the IP address (IP number in dotted internet format) or Domain Name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established.
If the SSHHost property is set to a Domain Name, a DNS request is initiated, and upon successful termination of the request, the SSHHost property is set to the corresponding address. If the search is not successful, an error is returned.
The SSHHost must be the same host that will be assumed for SSH as for the remote service being connected to.
SFTPClient.SSHPassword Property
The password for SSH password-based authentication.
Syntax
getSSHPassword(): string; setSSHPassword(SSHPassword: string): void;
Default Value
""
Remarks
SSHPassword specifies the password which is used to authenticate the client to the SSH server.
SFTPClient.SSHPort Property
The port on the SSH server where the SSH service is running; by default, 22.
Syntax
getSSHPort(): number; setSSHPort(SSHPort: number): void;
Default Value
22
Remarks
The SSHPort specifies a service port on the SSH host to connect to.
A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.
SFTPClient.SSHUser Property
The username for SSH authentication.
Syntax
getSSHUser(): string; setSSHUser(SSHUser: string): void;
Default Value
""
Remarks
SSHUser specifies the username which is used to authenticate the client to the SSH server. This property is required.
Example (User/Password Auth):
Control.SSHAuthMode = SftpSSHAuthModes.amPassword
Control.SSHUser = "username"
Control.SSHPassword = "password"
Control.SSHLogon("server", 22)
Example (Public Key Auth):
Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey
Control.SSHUser = "username"
Control.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile;
Control.SSHCertStore = "cert.pfx";
Control.SSHCertStorePassword = "certpassword";
Control.SSHCertSubject = "*";
Control.SSHLogon("server", 22)
SFTPClient.StartByte Property
The offset in bytes at which to begin the upload or download.
Syntax
getStartByte(): number; setStartByte(startByte: number): void;
Default Value
0
Remarks
The StartByte property is used by the Upload and Download methods to determine at what offset to begin the transfer. This allows for resuming both uploads and downloads. The value of this property is reset to 0 after a successful transfer. StartByte is not valid for use with Append.
When downloading, this property can be used in conjunction with the TransferredDataLimit configuration setting to download only a specific range of data from the current RemoteFile.
SFTPClient.Timeout Property
This property includes the timeout for the class.
Syntax
getTimeout(): number; setTimeout(timeout: number): void;
Default Value
60
Remarks
If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.
If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.
The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.
If Timeout expires, and the operation is not yet complete, the class .
Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
SFTPClient.append Method
Append data from LocalFile to a remote file RemoteFile on a Secure File Transfer Protocol (SFTP) server.
Syntax
async sftpclient.append(): Promise<void>
Remarks
This method is similar to the Upload method, but the local file specified by LocalFile is appended to RemoteFile on the server as opposed to replacing it as with the Upload method. RemoteFile is either an absolute path on the server, or a path relative to RemotePath. The server will create a file with that name if it does not already exist (similar to upload).
If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.
SFTPClient.changeRemotePath Method
Changes the current path on the server.
Syntax
async sftpclient.changeRemotePath(remotePath : string): Promise<void>
Remarks
This method changes the current path on the server to the specified RemotePath. When called, the class will issue a command to the server to change the directory. The RemotePath parameter may hold an absolute or relative path.
Absolute Paths
If the path begins with a /, it is considered an absolute path and must specify the entire path from the root of the server. For example:
component.ChangeRemotePath("/home/testuser/myfolder");
Relative Paths
If the path does not begin with a /, it is considered a relative path and is resolved in relation to the current directory. For instance, a value of myfolder will indicate a subfolder of the current directory. The special value .. refers to the parent directory of the current path. For example:
//Change to the 'myfolder' sub-directory
component.ChangeRemotePath("myfolder");
//Navigate up two levels and then into the 'another/folder' path.
component.ChangeRemotePath("../../another/folder");
SFTPClient.checkFileExists Method
Returns if the file specified by RemoteFile exists on the remote server.
Syntax
async sftpclient.checkFileExists(): Promise<boolean>
Remarks
This property returns true if the file exists on the remote server. It returns false if the file does not exist. You must specify the file you wish to check by setting the RemoteFile before calling this method.
If no session is in place, the value of this property will always be false.
SFTPClient.config Method
Sets or retrieves a configuration setting.
Syntax
async sftpclient.config(configurationString : string): Promise<string>
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
SFTPClient.connect Method
Connects to the SSH host without logging in.
Syntax
async sftpclient.connect(): Promise<void>
Remarks
This method establishes a connection with the SSHHost but does not log in. In most cases it is recommended to use the SSHLogon method which will both establish a connection and log in to the server.
This method may be useful in cases where it is desirable to separate the connection and logon operations, for instance confirming a host is available by first creating the connection.
SFTPClient.createFile Method
Creates a file on the Secure File Transfer Protocol (SFTP) server.
Syntax
async sftpclient.createFile(fileName : string): Promise<void>
Remarks
This method creates an empty file on the server with the name specified by the FileName parameter.
To upload a file with content, use Upload instead.
SFTPClient.decodePacket Method
Decodes a hex-encoded SSH packet.
Syntax
sftpclient.decodePacket(encodedPacket : string): Uint8Array
Remarks
This method is used to decode an SSH packet created by EncodePacket.
Note: This method is only applicable for reading and creating SSH packets for use within the SSHCustomAuth event.
SFTPClient.deleteFile Method
Delete a file specified by FileName from a Secure File Transfer Protocol (SFTP) server.
Syntax
async sftpclient.deleteFile(fileName : string): Promise<void>
Remarks
The remote file or directory specified by FileName is deleted. FileName is either an absolute path on the server or a path relative to RemotePath.
If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.
SFTPClient.disconnect Method
This method disconnects from the server without first logging off.
Syntax
async sftpclient.disconnect(): Promise<void>
Remarks
This method immediately disconnects from the server without first logging off.
In most cases the SSHLogoff method should be used to logoff and disconnect from the server. Call the Disconnect method in cases where it is desirable to immediately disconnect without first logging off.
SFTPClient.doEvents Method
This method processes events from the internal message queue.
Syntax
async sftpclient.doEvents(): Promise<void>
Remarks
When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
SFTPClient.download Method
Download a RemoteFile from a Secure File Transfer Protocol (SFTP) server.
Syntax
async sftpclient.download(): Promise<void>
Remarks
The remote file specified by RemoteFile is downloaded to the local file specified by LocalFile, or it is retrieved through the Transfer event, if the LocalFile property is "" (empty string). RemoteFile is either an absolute path on the server or is a path relative to RemotePath.
If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.
Example. Download a File:
SFTPControl.Localfile = "C:\localfile.txt"
SFTPControl.RemoteFile = "remotefile.txt"
SFTPControl.Download()
SFTPControl.Localfile = "C:\localfile2.txt"
SFTPControl.RemoteFile = "folder/remotefile2.txt"
SFTPControl.Download()
SFTPClient.downloadRange Method
DownloadRange facilitates the partial downloading of a remote file from a Secure File Transfer Protocol (SFTP) server.
Syntax
async sftpclient.downloadRange(path : string, fileName : string, startByte : number, count : number, buffer : Uint8Array): Promise<number>
Remarks
This method enables downloading a specific segment of a remote file specified by Path and FileName. StartByte is the offset (in bytes) relative to the beginning of the file from where to start reading, and Count is the number of bytes to read into the specified Buffer.
This functionality is particularly useful for efficient management of large files and targeted data retrieval within them.
Note: If the requested range extends beyond the end of the file, only the available bytes will be returned.
SFTPClient.encodePacket Method
Hex encodes an SSH packet.
Syntax
sftpclient.encodePacket(packet : Uint8Array): string
Remarks
This method is used to encode a raw SSH packet created by SetSSHParam.
Note: This method is only applicable for reading and creating SSH packets for use within the SSHCustomAuth event.
SFTPClient.getSSHParam Method
Used to read a field from an SSH packet's payload.
Syntax
sftpclient.getSSHParam(payload : Uint8Array, field : string): string
Remarks
This method is used to read the value of a particular field from an SSH packet's payload. Payload should contain the full payload of a packet received by an event such as SSHChannelRequest. Field is the name of a field to be read out of the packet.
The following is a list of the names of well-known channel request field names and their encodings:
ChannelId (int32) | The id of the channel that received the packet. |
RequestType (string) | The type of channel request. |
WantsReply (boolean) | Whether or not the client wants a reply to the request. |
The remaining fields that are available in the payload are dependent upon the value of RequestType.
pty-req
Pty-req is a request to open a pseudo terminal on the specified channel. The following fields are available:
TerminalType (string) | The type of terminal being requested (eg: "vt100"). |
TerminalWidthCharacters (int32) | The width, in characters, of the terminal to be opened. |
TerminalHeightRows (int32) | The height, in rows, of the terminal to be opened. |
TerminalWidthPixels (int32) | The width, in pixels, of the terminal to be opened. |
TerminalHeightPixels (int32) | The height, in pixels, of the terminal to be opened. |
TerminalModes (string) | A list of op-val (int32-byte) encoded modes to be used by the terminal. |
x11-req
X11-req is a request to forward x11 sessions over a channel. The following fields are available:
SingleConnection (boolean) | Disallows more than one connection to be forwarded by the channel. |
X11AuthProtocol (string) | The authentication protocol to be used (eg: "MIT-MAGIC-COOKIE-1"). |
X11AuthCookie (string) | A hexadecimal-encoded cookie to be used for authentication. |
X11ScreenNumber (int32) | The x11 screen number to be used. |
env
Env is a request to set an environment variable to be passed into a shell that may be started later. The following fields are available:
VariableName (string) | The name of the variable to be set. |
VariableValue (string) | The value of the variable to be set. |
exec
Exec is a request to execute a command on the channel using the authenticated user's shell. The following field is available:
Command (string) | The command to be executed. |
subsystem
Subsystem is a request to start a subsystem on the specified channel. The following field is available:
Subsystem (string) | The name of the subsystem to be started (eg: "sftp"). |
xon-xoff
Instructs the server to allow or disallow control-S/control-Q style flow control. The following field is available:
ClientCanDo (boolean) | Whether or not the server should enable flow control. |
signal
Sends a signal to the remote process/service. The following field is available:
SignalName (string) | The name of the signal to be sent. |
If the packet type is not well known, Field should start with the special character "%" and contain a comma-separated list of field types as defined in SetSSHParam. For example, reading out the X11AuthProtocol of an x11-req payload, you can use "%s,f".
Note: the return value is a string encoded the same way as the FieldValue param in SetSSHParam.
Note: This method is only applicable for reading and creating SSH packets for use within the SSHCustomAuth event.
SFTPClient.getSSHParamBytes Method
Used to read a field from an SSH packet's payload.
Syntax
async sftpclient.getSSHParamBytes(payload : Uint8Array, field : string): Promise<Uint8Array>
Remarks
This method is the same as calling GetSSHParam, but returns raw bytes instead of strings.
Note: This method is only applicable for reading and creating SSH packets for use within the SSHCustomAuth event.
SFTPClient.interrupt Method
This method interrupts the current method.
Syntax
async sftpclient.interrupt(): Promise<void>
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
SFTPClient.listDirectory Method
List the current directory specified by RemotePath on a Secure File Transfer Protocol (SFTP) server.
Syntax
async sftpclient.listDirectory(): Promise<void>
Remarks
A listing is requested for the directory (or file mask) specified in RemoteFile. RemoteFile is either an absolute path on the server or is a path relative to RemotePath. The file listing is received through the DirList event.
If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.
SFTPClient.makeDirectory Method
Creates a directory on a Secure File Transfer Protocol (SFTP) server.
Syntax
async sftpclient.makeDirectory(newDir : string): Promise<void>
Remarks
A directory with a path specified by NewDir is created on the SFTP server. NewDir is either an absolute path on the server or is a path relative to RemotePath.
If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.
SFTPClient.queryFileAttributes Method
Queries the server for the attributes of RemoteFile .
Syntax
async sftpclient.queryFileAttributes(): Promise<void>
Remarks
This method queries the server for attributes of RemoteFile. After calling this method, FileAttributes will be populated with the values returned by the server.
To update attributes, modify the desired values in FileAttributes and call UpdateFileAttributes.
SFTPClient.queueFile Method
Adds a file to the transfer queue.
Syntax
async sftpclient.queueFile(localFile : string, remoteFile : string): Promise<void>
Remarks
This method adds a file to the queue of files that will be transferred.
It is not required to use this method; however, this method extends the ability of the class to allow for multiple simultaneous file transfers.
To simply transfer a file without using this method, you need only to set LocalFile and RemoteFile and to call Upload or Download, as appropriate. This method allows you to instead queue multiple files before beginning a transfer.
When a file is queued, it will not be transferred until the Upload or Download method is called. If multiple files are queued, the files will be transferred simultaneously. The SimultaneousTransferLimit setting controls the maximum number of simultaneous transfers.
The Upload or Download method will not return until the queue has been completely processed. This method may be called from within events to add additional files to the queue before processing is complete.
To clear the queue, call ResetQueue. This will not affect current transfers.
To cancel an individual file transfer, set the Cancel parameter of the Transfer event to True. The rest of the queue will continue to process as normal.
The Interrupt method may be called to immediately stop all current transfers.
In the event of a file-specific error, the Error event will fire and the LocalFile and RemoteFile event parameters can be used to identify the file to which the error applies.
SFTPClient.removeDirectory Method
Remove a directory specified by DirName from a secure file transfer protocol (SFTP) server.
Syntax
async sftpclient.removeDirectory(dirName : string): Promise<void>
Remarks
A directory with a path specified by DirName is deleted on the SFTP server. DirName is either an absolute path on the server or a path relative to RemotePath.
If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.
SFTPClient.renameFile Method
Change the name of RemoteFile to NewName .
Syntax
async sftpclient.renameFile(newName : string): Promise<void>
Remarks
The name of the remote file or the folder specified by RemoteFile is changed to NewName. RemoteFile and NewName are either absolute paths on the server or a path relative to RemotePath.
If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.
SFTPClient.reset Method
This method will reset the class.
Syntax
async sftpclient.reset(): Promise<void>
Remarks
This method will reset the class's properties to their default values.
SFTPClient.resetQueue Method
Resets the queue of files to be transferred.
Syntax
async sftpclient.resetQueue(): Promise<void>
Remarks
This method will remove all files from the transfer queue.
Calling this method will clear all files that were queued by QueueFile. Calling this method will not affect current transfers.
SFTPClient.setSSHParam Method
Used to write a field to the end of a payload.
Syntax
sftpclient.setSSHParam(payload : Uint8Array, fieldType : string, fieldValue : string): Uint8Array
Remarks
This method is used to build the payload portion of an SSH packet to be sent later by a call to SendSSHPacket. Payload should contain the result of a previous call to SetSSHParam. FieldType is a string defining the type of field to be written to the packet. FieldValue should be the string representation of the field to be written.
The following is a list of supported field types and a description of how FieldValue should be encoded:
s | A plaintext string containing the default system encoding of the data. |
sb | A string containing the hex encoded data. (eg: "A1B23C") |
m | A variable-length large integer, encoded as a textual representation of the value ("1234"). |
i | A 32-bit integer, encoded as a textual representation of the value (eg: "1234"). |
l | A 64-bit integer, encoded as a textual representation of the value (eg: "1234"). |
b | A single byte, encoded as a textual representation of the value (eg: "123"). |
f | A boolean flag, encoded as a textual representation of the value (eg: 'true' or 'false') |
Note: integer values may be encoded in hexadecimal by prefixing "0x" to the beginning of the string, otherwise the value is assumed to be base-10.
Note: This method is only applicable for reading and creating SSH packets for use within the SSHCustomAuth event.
SFTPClient.SSHLogoff Method
Logoff from the SSH server.
Syntax
async sftpclient.SSHLogoff(): Promise<void>
Remarks
Logoff from the SSH server. If that fails, the connection is terminated by the local host.
SFTPClient.SSHLogon Method
Logon to the SSHHost using the current SSHUser and SSHPassword .
Syntax
async sftpclient.SSHLogon(SSHHost : string, SSHPort : number): Promise<void>
Remarks
Logon to the SSH server using the current SSHUser and SSHPassword. This will perform the SSH handshake and authentication.
Example (Logging On)
SSHClient.SSHUser = "username"
SSHClient.SSHPassword = "password"
SSHClient.SSHLogon("sshHost", sshPort)
SFTPClient.updateFileAttributes Method
Instructs the class to send the FileAttributes to the server.
Syntax
async sftpclient.updateFileAttributes(): Promise<void>
Remarks
When UpdateFileAttributes is called, the class will send the values of the following properties to the server:
- FileAttributesAccessTime
- FileAttributesACL
- FileAttributesAllocationSize
- FileAttributesAttributeBits
- FileAttributesAttributeBitsValid
- FileAttributesCreationTime
- FileAttributesFileType
- FileAttributesGroupId
- FileAttributesIsDir
- FileAttributesModifiedTime
- FileAttributesOwnerId
- FileAttributesPermissions
- FileAttributesSize
SFTPClient.upload Method
Upload a file specified by LocalFile to a secure file transfer protocol (SFTP) server.
Syntax
async sftpclient.upload(): Promise<void>
Remarks
The local file specified by LocalFile is uploaded to the remote file specified by RemoteFile. RemoteFile is either an absolute path on the server or a path relative to RemotePath.
If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.
If you want to append to a server file, please refer to the Append method.
Example. Upload a File:
FTPControl.LocalFile = "C:\\localfile.txt"
FTPControl.RemoteFile = "remotefile.txt"
FTPControl.Upload()
FTPControl.LocalFile = "C:\\localfile2.txt"
FTPControl.RemoteFile = "folder/remotefile2.txt"
FTPControl.Upload()
SFTPClient.uploadRange Method
UploadRange inserts data into a remote file on a secure file transfer protocol (SFTP) server.
Syntax
async sftpclient.uploadRange(path : string, fileName : string, startByte : number, count : number, buffer : Uint8Array): Promise<void>
Remarks
This method enables uploading a buffer into the remote file specified by the Path and FileName. Count bytes will be updated from the provided Buffer starting in the remote file at the StartByte offset.
This functionality enables precise control over the insertion of data into a remote file, allowing for targeted modifications, overwriting, or additions starting from a specific position within the file.
Note: If the offset specified is beyond the file length, empty bytes will be created between the last file byte and the uploaded buffer.
SFTPClient.Connected Event
This event is fired immediately after a connection completes (or fails).
Syntax
sftpclient.on('Connected', listener: (e: {readonly statusCode: number, readonly description: string}) => void )
Remarks
If the connection is made normally, StatusCode is 0 and Description is "OK".
If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.
Please refer to the Error Codes section for more information.
SFTPClient.ConnectionStatus Event
This event is fired to indicate changes in the connection state.
Syntax
sftpclient.on('ConnectionStatus', listener: (e: {readonly connectionEvent: string, readonly statusCode: number, readonly description: string}) => void )
Remarks
The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.
The ConnectionEvent parameter indicates the type of connection event. Values may include the following:
Firewall connection complete. | |
Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). | |
Remote host connection complete. | |
Remote host disconnected. | |
SSL or S/Shell connection broken. | |
Firewall host disconnected. |
SFTPClient.DirList Event
Fired when a directory entry is received.
Syntax
sftpclient.on('DirList', listener: (e: {readonly dirEntry: string, readonly fileName: string, readonly isDir: boolean, readonly fileSize: number, readonly fileTime: string, readonly isSymlink: boolean}) => void )
Remarks
The DirList events are fired when a directory listing is received as a response to a ListDirectory.
The StartTransfer and EndTransfer events mark the beginning and end of the event stream.
The DirEntry parameter contains the filename when ListDirectory is called.
The class tries to fill out the FileName, IsDir, FileSize, and FileTime parameters when calling the ListDirectory method.
The format of the FileTime parameter returned by the class can be controlled through the FileTimeFormat configuration setting. If no format is specified, the class will format the date dependent on the year. If the filetime is in the same year, it will be formatted as "MMM dd HH:mm"; otherwise, it will be formatted as "MMM dd yyyy".
IsSymlink indicates whether the entry is a symbolic link. When the entry is a symbolic link, the value of IsDir will always be False because this information is not returned in the directory listing. To inspect a symlink to determine if it is a link to a file or a folder, set RemoteFile and query the FileAttributesIsDir property.
SFTPClient.Disconnected Event
This event is fired when a connection is closed.
Syntax
sftpclient.on('Disconnected', listener: (e: {readonly statusCode: number, readonly description: string}) => void )
Remarks
If the connection is broken normally, StatusCode is 0 and Description is "OK".
If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.
Please refer to the Error Codes section for more information.
SFTPClient.EndTransfer Event
Fired when a file completes downloading or uploading.
Syntax
sftpclient.on('EndTransfer', listener: (e: {readonly direction: number, readonly localFile: string, readonly remoteFile: string}) => void )
Remarks
The EndTransfer event fires when either an upload or a download operation completes. This occurs when the file finishes transferring or a directory listing is finished.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
LocalFile identifies the local file. RemoteFile is the remote file.
SFTPClient.Error Event
Information about errors during data delivery.
Syntax
sftpclient.on('Error', listener: (e: {readonly errorCode: number, readonly description: string, readonly localFile: string, readonly remoteFile: string}) => void )
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class .
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
LocalFile identifies the local file. RemoteFile is the remote file.
SFTPClient.Log Event
Fires once for each log message.
Syntax
sftpclient.on('Log', listener: (e: {readonly logLevel: number, readonly message: string, readonly logType: string}) => void )
Remarks
This event fires once for each log messages generated by the class. The verbosity is controlled by the LogLevel setting.
LogLevel indicates the detail level of the message. Possible values are:
0 (None) | No messages are logged. |
1 (Info - Default) | Informational events such as SSH handshake messages are logged. |
2 (Verbose) | Detailed data such as individual packet information is logged. |
3 (Debug) | Debug data including all relevant sent and received bytes are logged. |
Message is the log message.
LogType is reserved for future use.
SFTPClient.SSHCustomAuth Event
Fired when the class is doing custom authentication.
Syntax
sftpclient.on('SSHCustomAuth', listener: (e: {packet: string}) => void )
Remarks
SSHCustomAuth is fired during the user authentication stage of the SSH logon process if SSHAuthMode is set to amCustom. Packet contains the raw last SSH packet sent by the server, in HEX-encoded format.
The client should create a new raw SSH packet to send to the server and set Packet to the HEX-encoded representation of the packet to send.
In all cases, Packet will start with the message type field.
To read the incoming packet call DecodePacket and then use the GetSSHParam and GetSSHParamBytes methods. To create a packet use the SetSSHParam method and then call EncodePacket to obtain a HEX-encoded value and assign this to the Packet parameter.
SFTPClient.SSHKeyboardInteractive Event
Fired when the class receives a request for user input from the server.
Syntax
sftpclient.on('SSHKeyboardInteractive', listener: (e: {readonly name: string, readonly instructions: string, readonly prompt: string, response: string, readonly echoResponse: boolean}) => void )
Remarks
SSHKeyboardInteractive is fired during the user authentication stage of the SSH logon process. During authentication, the class will request a list of available authentication methods for the SSHUser. For example, if the SSHHost responds with "keyboard-interactive", the class will fire this event to allow the client application to set the password.
During authentication, the SSH server may respond with a request for the user's authentication information. Name is a server-provided value associated with the authentication method such as "CRYPTOCard Authentication". Instructions will contain specific instructions, also supplied by the server, for how the user should respond.
Along with these values, the server will also send at least one input Prompt to be displayed to and filled out by the user. Response should be set to the user's input, and will be sent back in the user authentication information response. EchoResponse is a server recommendation for whether or not the user's response should be echoed back during input.
Note: the server may send several prompts in a single packet. The class will fire the SSHKeyboardInteractive event once for each prompt.
SFTPClient.SSHServerAuthentication Event
Fired after the server presents its public key to the client.
Syntax
sftpclient.on('SSHServerAuthentication', listener: (e: {readonly hostKey: string, readonly hostKeyB: Uint8Array, readonly fingerprint: string, readonly keyAlgorithm: string, readonly certSubject: string, readonly certIssuer: string, readonly status: string, accept: boolean}) => void )
Remarks
This event is where the client can decide whether to continue with the connection process or not. If the public key is known to be a valid key for the SSH server, Accept should be set to True within the event. Otherwise, the server will not be authenticated and the connection will be broken.
Accept will be True only if either HostKey or Fingerprint is identical to the value of SSHAcceptServerHostKey.
Accept may be set to True manually to accept the server host key.
Note that SSH's security inherently relies on client verification of the host key. Ignoring the host key and always setting Accept to true is strongly discouraged, and could cause potentially serious security vulnerabilities in your application. It is recommended that clients maintain a list of known keys for each server and check HostKey against this list each time a connection is attempted.
Host Key contains the full binary text of the key, in the same format used internally by SSH.
Fingerprint holds the SHA-256 hash of HostKey in the hex-encoded form: 0a:1b:2c:3d. To configure the hash algorithm used to calculate this value see SSHFingerprintHashAlgorithm.
KeyAlgorithm identifies the host key algorithm. Supported values are:
- ssh-rsa
- ssh-dss
- rsa-sha2-256
- rsa-sha2-512
- x509v3-sign-rsa
- x509v3-sign-dss
- ecdsa-sha2-nistp256
- ecdsa-sha2-nistp384
- ecdsa-sha2-nistp521
CertSubject is the subject of the certificate. This is only applicable when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".
CertIssuer is the issuer of the certificate. This is only applicable when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".
Status is reserved for future use.
SFTPClient.SSHStatus Event
Shows the progress of the secure connection.
Syntax
sftpclient.on('SSHStatus', listener: (e: {readonly message: string}) => void )
Remarks
The event is fired for informational and logging purposes only. Used to track the progress of the connection.
SFTPClient.StartTransfer Event
Fired when a file starts downloading or uploading.
Syntax
sftpclient.on('StartTransfer', listener: (e: {readonly direction: number, readonly localFile: string, readonly remoteFile: string}) => void )
Remarks
The StartTransfer event fires when a data interface connection is created. This occurs when the file starts transferring or a directory listing is started.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
LocalFile identifies the local file. RemoteFile is the remote file.
SFTPClient.Transfer Event
Fired during file download or upload.
Syntax
sftpclient.on('Transfer', listener: (e: {readonly direction: number, readonly localFile: string, readonly remoteFile: string, readonly bytesTransferred: number, readonly percentDone: number, readonly text: string, readonly textB: Uint8Array, cancel: boolean}) => void )
Remarks
One or more Transfer events are fired during file transfer. The BytesTransferred parameter shows the number of bytes transferred since the beginning of the transfer.
Text contains the portion of the file data being delivered.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
LocalFile identifies the local file. RemoteFile is the remote file.
The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.
To cancel the current transfer, set Cancel to True.
Certificate Type
This is the digital certificate being used.
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
Fields
EffectiveDate
string (read-only)
Default Value: ""
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
ExpirationDate
string (read-only)
Default Value: ""
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
ExtendedKeyUsage
string (read-only)
Default Value: ""
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint
string (read-only)
Default Value: ""
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
FingerprintSHA1
string (read-only)
Default Value: ""
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
FingerprintSHA256
string (read-only)
Default Value: ""
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
Issuer
string (read-only)
Default Value: ""
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
KeyPassword
string
Default Value: ""
This is the password for the certificate's private key (if any).
Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the . . This field can be used to read such password-protected private keys.
Note: this property defaults to the value of . To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling .
PrivateKey
string (read-only)
Default Value: ""
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The may be available but not exportable. In this case, returns an empty string.
PrivateKeyAvailable
boolean (read-only)
Default Value: False
This property shows whether a is available for the selected certificate. If is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer
string (read-only)
Default Value: ""
This is the name of the container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey
string (read-only)
Default Value: ""
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
string (read-only)
Default Value: ""
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
PublicKeyLength
number (read-only)
Default Value: 0
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber
string (read-only)
Default Value: ""
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
SignatureAlgorithm
string (read-only)
Default Value: ""
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
Store
string
Default Value: "MY"
This is the name of the certificate store for the client certificate.
The property denotes the type of the certificate store specified by . If the store is password protected, specify the password in .
is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StoreB
Uint8Array
Default Value: "MY"
This is the name of the certificate store for the client certificate.
The property denotes the type of the certificate store specified by . If the store is password protected, specify the password in .
is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StorePassword
string
Default Value: ""
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
StoreType
CertStoreTypes
Default Value: 0
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the and set to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
SubjectAltNames
string (read-only)
Default Value: ""
This property contains comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
string (read-only)
Default Value: ""
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA1
string (read-only)
Default Value: ""
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA256
string (read-only)
Default Value: ""
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
Usage
string (read-only)
Default Value: ""
This property contains the text description of .
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
UsageFlags
number (read-only)
Default Value: 0
This property contains the flags that show intended use for the certificate. The value of is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the property for a text representation of .
This functionality currently is not available when the provider is OpenSSL.
Version
string (read-only)
Default Value: ""
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Subject
string
Default Value: ""
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Encoded
string
Default Value: ""
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate.
When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string.
EncodedB
Uint8Array
Default Value: ""
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate.
When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string.
Constructors
public Certificate();
Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.
public Certificate(String certificateFile);
Opens CertificateFile and reads out the contents as an X.509 public key.
public Certificate(byte[] encoded);
Parses Encoded as an X.509 public key.
public Certificate(int storeType, String store, String storePassword, String subject);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(int storeType, String store, String storePassword, String subject, String configurationString);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(int storeType, String store, String storePassword, byte[] encoded);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
public Certificate(int storeType, byte[] store, String storePassword, String subject);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(int storeType, byte[] store, String storePassword, String subject, String configurationString);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(int storeType, byte[] store, String storePassword, byte[] encoded);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
DirEntry Type
This is a listing in a directory returned from the server.
Remarks
The DirEntry listings are filled out by the class when a directory listing is received as a response to a ListDirectory or ListDirectoryLong call. The server returns a listing for each directory and file at the current path that exists. This listing is parsed into a directory entry.
If ListDirectoryLong is called, all of the fields listed below are supplied by the server. When the ListDirectory method is called, however, the , , and fields all are left empty by the server. In this case, the only field it returns is the .
The full line for the directory entry is provided by the field.
Fields
Entry
string (read-only)
Default Value: ""
This property contains the raw entry as received from the server. It is the complete unparsed entry in the directory listing.
FileName
string (read-only)
Default Value: ""
This property shows the file name in the last directory listing. This also may be the directory name if a directory is being listed. You can tell whether it is a file or a directory by the Boolean property.
FileSize
number (read-only)
Default Value: 0
This property shows the file size in the last directory listing.
FileTime
string (read-only)
Default Value: ""
This property shows the file time in the last directory listing. This contains the date/time stamp in which the file was created.
Note: In Unix systems, the date is given in two types of formats: If the date is in the past 12 months, the exact time is specified and the year is omitted. Otherwise, only the date and the year, but not hours or minutes, are given.
IsDir
boolean (read-only)
Default Value: False
This property specifies whether entries in the last directory listing are directories. This Boolean value denotes whether or not the directory entry listed in is a file or a directory.
IsSymlink
boolean (read-only)
Default Value: False
This property indicates whether the entry is a symbolic link. When the entry is a symbolic link, the value of will always be False because this information is not returned in the directory listing. To inspect a symlink to determine if it is a link to a file or a folder, set RemoteFile and query the FileAttributes.FileAttributesIsDir property.
Constructors
public DirEntry();
Firewall Type
The firewall the class will connect through.
Remarks
When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the .
Fields
AutoDetect
boolean
Default Value: False
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallType
FirewallTypes
Default Value: 0
This property determines the type of firewall to connect through. The applicable values are as follows:
Host
string
Default Value: ""
This property contains the name or IP address of the firewall (optional). If a is given, the requested connections will be authenticated through the specified firewall when connecting.
If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class .
Password
string
Default Value: ""
This property contains a password if authentication is to be used when connecting through the firewall. If is specified, the and properties are used to connect and authenticate to the given firewall. If the authentication fails, the class .
Port
number
Default Value: 0
This property contains the Transmission Control Protocol (TCP) port for the firewall . See the description of the property for details.
Note: This property is set automatically when is set to a valid value. See the description of the property for details.
User
string
Default Value: ""
This property contains a username if authentication is to be used when connecting through a firewall. If is specified, this property and the property are used to connect and authenticate to the given Firewall. If the authentication fails, the class .
Constructors
public Firewall();
SFTPFileAttributes Type
A set of attributes for a file existing on an SFTP server..
Remarks
This type describes a file residing on an SFTP server.
Fields
AccessTime
number
Default Value: 0
The number of milliseconds since 12:00:00 AM January 1, 1970 when this file was last accessed.
AccessTimeNanos
number
Default Value: 0
ACL
string
Default Value: ""
A string containing an Access Control List (ACL).
AllocationSize
number (read-only)
Default Value: 0
The size, in bytes, that this file consumes on disk.
AttributeBits
number (read-only)
Default Value: 0
and each contain a bitmask representing attributes of the file on the SFTP server. These two values must be interpreted together. Any value present in must be ignored in . This is done so that the server and client can communicate the attributes they know about without confusing any bits they do not understand.
This field can have one or more of the following values OR'd together:
- 0x00000001 (SSH_FILEXFER_ATTR_FLAGS_READONLY)
- 0x00000002 (SSH_FILEXFER_ATTR_FLAGS_SYSTEM)
- 0x00000004 (SSH_FILEXFER_ATTR_FLAGS_HIDDEN)
- 0x00000008 (SSH_FILEXFER_ATTR_FLAGS_CASE_INSENSITIVE)
- 0x00000010 (SSH_FILEXFER_ATTR_FLAGS_ARCHIVE)
- 0x00000020 (SSH_FILEXFER_ATTR_FLAGS_ENCRYPTED)
- 0x00000040 (SSH_FILEXFER_ATTR_FLAGS_COMPRESSED)
- 0x00000080 (SSH_FILEXFER_ATTR_FLAGS_SPARSE)
- 0x00000100 (SSH_FILEXFER_ATTR_FLAGS_APPEND_ONLY)
- 0x00000200 (SSH_FILEXFER_ATTR_FLAGS_IMMUTABLE)
- 0x00000400 (SSH_FILEXFER_ATTR_FLAGS_SYNC)
- 0x00000800 (SSH_FILEXFER_ATTR_FLAGS_TRANSLATION_ERR)
AttributeBitsValid
number (read-only)
Default Value: 0
and each contain a bitmask representing attributes of the file on the SFTP server. These two values must be interpreted together. Any value present in must be ignored in . This is done so that the server and client can communicate the attributes they know about without confusing any bits they do not understand.
This field can have one or more of the following values OR'd together:
- 0x00000001 (SSH_FILEXFER_ATTR_FLAGS_READONLY)
- 0x00000002 (SSH_FILEXFER_ATTR_FLAGS_SYSTEM)
- 0x00000004 (SSH_FILEXFER_ATTR_FLAGS_HIDDEN)
- 0x00000008 (SSH_FILEXFER_ATTR_FLAGS_CASE_INSENSITIVE)
- 0x00000010 (SSH_FILEXFER_ATTR_FLAGS_ARCHIVE)
- 0x00000020 (SSH_FILEXFER_ATTR_FLAGS_ENCRYPTED)
- 0x00000040 (SSH_FILEXFER_ATTR_FLAGS_COMPRESSED)
- 0x00000080 (SSH_FILEXFER_ATTR_FLAGS_SPARSE)
- 0x00000100 (SSH_FILEXFER_ATTR_FLAGS_APPEND_ONLY)
- 0x00000200 (SSH_FILEXFER_ATTR_FLAGS_IMMUTABLE)
- 0x00000400 (SSH_FILEXFER_ATTR_FLAGS_SYNC)
- 0x00000800 (SSH_FILEXFER_ATTR_FLAGS_TRANSLATION_ERR)
CreationTime
number
Default Value: 0
The number of milliseconds since 12:00:00 AM January 1, 1970 when this file was created.
CreationTimeNanos
number
Default Value: 0
FileType
SFTPFileTypes (read-only)
Default Value: 0
The type of file. may be one of the following values:
1 (sftRegular - default) | A normal file. |
2 (sftDirectory) | A directory. |
3 (symlink) | The file is a Unix symbolic link. |
4 (sftSpecial) | The file type is a special system file. |
5 (sftUnknown) | The file type is unknown. |
6 (sftSocket) | The file handle is a socket handle. |
7 (sftCharDevice) | The file handle is a character input device. |
8 (sftBlockDevice) | The file handle is a block input device. |
9 (sftpFIFO) | The file handle is a buffering input device. |
Flags
number
Default Value: 0
is an integer containing a bitmask that indicates which properties are valid. When retrieving file attributes from an SFTP server, this property indicates which values were read by the class. When setting values, the property is used to determine which values get passed to the server.
may be bitwise-ORed with any of the following values:
GroupId
string
Default Value: ""
The id of the group that has access rights this file.
IsDir
boolean (read-only)
Default Value: False
Whether or not the file represented by these attributes is a directory.
IsSymlink
boolean (read-only)
Default Value: False
Whether or not the file or directory represented by these attributes is a symbolic link. This setting is only applicable when GetSymlinkAttrs is set to True. By default the attributes of the actual file referred to by the link (not the symbolic link itself) are returned and this property will always be False.
LinkCount
number (read-only)
Default Value: 0
The number of links that reference this file.
MIMEType
string
Default Value: ""
A value that can be used in the Content-Type header for a MIME entity part containing this file.
ModifiedTime
number
Default Value: 0
The number of milliseconds since 12:00:00 AM January 1, 1970 that this file was last modified.
ModifiedTimeNanos
number
Default Value: 0
OwnerId
string
Default Value: ""
The user id of this file's owner.
Permissions
number
Default Value: 0
A 32-bit integer containing the a POSIX-compatible file permission bitmask.
The bitmask should be interpreted as a decimal value of a series of octal digits. For example, an octal permission value of "100644" would be "33188" in base-10, and "40755" in octal would be "16877" in base-10.
The last three octal digits are the most significant and represent, in order, the file access capabilities of the file's owner, the owner's group and other users. Each of these octal digits is, on its own, a 3-bit bitmask with the following possible values:
1 (001) | Execute |
2 (010) | Write |
4 (100) | Read |
An octal permission digit of 7 would have all three values set and would mean that the file can be read, written and executed by that user class. For example, the octal permissions "100644" would have a value "6" for the owner, "4" for the group, and "4" for other users. This would be interpreted to mean that all users can read the file, no users can execute it and only the owner can write it. The permissions "40755" would mean that all users can read and execute the file, but only the owner can write it.
The previous octal digit is another bitmask with the following values:
1 (001) | Sticky Bit - retain the file in memory for performance |
2 (010) | Set GID - sets the group ID of the process to the file's group ID upon execution (only for executable files) |
4 (100) | Set UID - sets the user ID of the process to the file's user ID upon execution (only for executable files) |
The previous two octal digits are used together as a bitmask to determine the type of file. This bitmask has the following values:
01 (000001) | Named pipe |
02 (000010) | Character special |
04 (000100) | Directory |
06 (000110) | Block special |
10 (001000) | Regular |
12 (001010) | Symbolic link |
14 (001100) | Socket |
For example, the octal file permissions "100644" would indicate a regular file and octal "40755" would indicate a directory.
Please note that you will need to convert the octal permissions bitmask into its decimal representation
PermissionsOctal
string
Default Value: ""
An octal string containing the a POSIX-compatible file permission bitmask
The bitmask should be interpreted as a series of octal digits. For example, "100644" and "40755".
The last three octal digits are the most significant and represent, in order, the file access capabilities of the file's owner, the owner's group and other users. Each of these octal digits is, on its own, a 3-bit bitmask with the following possible values:
1 (001) | Execute |
2 (010) | Write |
4 (100) | Read |
An octal permission digit of 7 would have all three values set and would mean that the file can be read, written and executed by that user class. For example, the octal permissions "100644" would have a value "6" for the owner, "4" for the group, and "4" for other users. This would be interpreted to mean that all users can read the file, no users can execute it and only the owner can write it. The permissions "40755" would mean that all users can read and execute the file, but only the owner can write it.
The previous octal digit is another bitmask with the following values:
1 (001) | Sticky Bit - retain the file in memory for performance |
2 (010) | Set GID - sets the group ID of the process to the file's group ID upon execution (only for executable files) |
4 (100) | Set UID - sets the user ID of the process to the file's user ID upon execution (only for executable files) |
The previous two octal digits are used together as a bitmask to determine the type of file. This bitmask has the following values:
01 (000001) | Named pipe |
02 (000010) | Character special |
04 (000100) | Directory |
06 (000110) | Block special |
10 (001000) | Regular |
12 (001010) | Symbolic link |
14 (001100) | Socket |
For example, the octal file permissions "100644" would indicate a regular file and octal "40755" would indicate a directory.
Size
number (read-only)
Default Value: 0
The total size, in bytes, of this file.
TextHint
number (read-only)
Default Value: 0
Provides a hint for whether or not the file is a text file.
UntranslatedName
string (read-only)
Default Value: ""
The untranslated name of the file.
Config Settings (class ipworkssftp.sftpclient)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.SFTPClient Config Settings
The default value is False.
The server must support the check-file extension.
The class supports the following hash algorithms (in order of preference): sha256,sha224,sha384,sha512,sha1,md5. The server may choose to use any value from this list. No action is needed to configure the algorithm, the class will automatically use the same algorithm that the server users.
If the extension is unsupported or a mismatch in hashes is detected, the class . If the hashes match the value, True is returned.
try {
String flag = sftp.Config("CheckFileHash");
// flag will be equal to "True"
}
catch (Exception e) {
// mismatch
}
Set RemoteFile to the path of the source file. Optionally set StartByte to indicate from where in the source file to start reading.
Then set CopyRemoteData to a semicolon (;) delimited listed of Name=Value pairs. In this list, DestFile must be set to the path of the destination file. Length may be set to the number of bytes to read. WriteOffset may be set to the location in the destination file from where to start writing.
sftp.RemoteFile = "/my/source/file.txt";
sftp.Overwrite = true;
sftp.StartByte = 6;
sftp.Config("CopyRemoteData=DestFile=/my/destination/file.txt;Length=5;WriteOffset=14");
Set RemoteFile to the path of the source file, then set CopyRemoteFile to the path of the destination file. Overwrite controls whether an existing file will be overwritten.
sftp.Overwrite = true;
sftp.RemoteFile = "/my/source/file.txt";
sftp.Config("CopyRemoteFile=" + "/my/destination/file.txt");
Note: The server must understand either the "statvfs@openssh.com" or "space-available" extension for this operation to succeed.
If it is desired to retrieve the attributes of the symbolic link itself, set GetSymlinkAttrs to True before querying FileAttributes.
When uploading or downloading, this value will be compared to ServerEOL. If ServerEOL and LocalEOL are different, the line endings in the file being transferred will be converted to the line endings used by the destination. Line endings will be converted to the value in LocalEOL when downloading. Line endings will be converted to the value in ServerEOL when uploading. If ServerEOL and LocalEOL are the same, no conversion takes place.
The value supplied to this setting must be quoted. For example:
component.Config("LocalEOL=\"" + myEOLSequence + "\"");
Where myEOLSequence is a Cr, Lf, or CrLf character sequence.
Conversion will only happen when TransferMode is set to 1 (ASCII) and ServerEOL and LocalEOL are different.
Note: Setting this value to True will increase the amount of data that are logged.
Most servers that use smaller values will use a maximum SSH packet size of 16KB (16384). To most efficiently communicate with such servers, MaxFileData size should be set to 14745.
Note: Values larger than 64,000 (65,536) may not be respected by some servers (such as OpenSSH) and will result in unexpected behavior. If specifying a value, it is recommended to set a value less than or equal to 65,536.
The default value is 32,768.
string resolvedPath = component.Config("ReadLink=/home/test/mysymlink.txt");
When uploading or downloading, this value will be compared to LocalEOL. If ServerEOL and LocalEOL are different, the line endings in the file being transferred will be converted to the line endings used by the destination. Line endings will be converted to the value in LocalEOL when downloading. Line endings will be converted to the value in ServerEOL when uploading. If ServerEOL and LocalEOL are the same, no conversion takes place.
The value supplied to this setting must be quoted. For example:
component.Config("ServerEOL=\"" + myEOLSequence + "\"");
Where myEOLSequence is a Cr, Lf, or CrLf character sequence.
Conversion will happen only when TransferMode is set to 1 (ASCII) and ServerEOL and LocalEOL are different.
When this value is set to 1 (ASCII) the class will use the values specified in LocalEOL and ServerEOL to convert line endings as appropriate.
Note: When this value is set to 1 (ASCII) and ProtocolVersion is set to 4 or higher the class will automatically determine the value for ServerEOL if the server supports the newline protocol extension.
This configuration setting can be used in conjunction with the StartByte property to download a specific range of data from the current RemoteFile.
Set this to false to not send the packet. This will cause PreserveFileTime to not work and prevent PercentDone in Transfer from being calculated.
The default is true.
SSHClient Config Settings
If MaxChannelDataLength > 0 and ChannelDataEOL is a non-empty string the class will internally buffer data waiting to fire SSHChannelData until either MaxChannelDataLength is reached or ChannelDataEOL is found, whichever comes first. Query ChannelDataEOLFound to know which condition was met. The buffer is reset any time SSHChannelData fires.
ChannelDataEOL and MaxChannelDataLength MUST be set together or unexpected behavior could occur.
This config is only valid when queried inside SSHChannelData, MaxChannelDataLength > 0, and ChannelDataEOL is non-empty.
Most SSH servers expect the SSH version string to have the expected format "SSH-protocol version-software version". See above for an example.
Value | Description |
0 (Disabled - default) | No communication with Pageant is attempted. |
1 (Enabled) | Pageant authentication is used if available. If Pageant is not running, or does not contain the expected key no error is thrown. |
2 (Required) | Only Pageant authentication is used. If Pageant is not running, or does not contain the expected key an error is thrown. |
Example enabling Pageant:
component.Config("EnablePageantAuth=1");
component.SSHUser = "sshuser";
component.SSHLogon("localhost", 22);
Note: This functionality is only available on Windows.
Example (for setting the threshold to 500 MB):
SSHComponent.Config("KeyRenegotiationThreshold=524288000")
0 (None) | No messages are logged. |
1 (Info - Default) | Informational events such as SSH handshake messages are logged. |
2 (Verbose) | Detailed data such as individual packet information is logged. |
3 (Debug) | Debug data including all relevant sent and received bytes are logged. |
If MaxChannelDataLength > 0 and ChannelDataEOL is a non-empty string the class will internally buffer data waiting to fire SSHChannelData until either MaxChannelDataLength is reached or ChannelDataEOL is found, whichever comes first. Query ChannelDataEOLFound to know which condition was met. The buffer is reset any time SSHChannelData fires.
ChannelDataEOL and MaxChannelDataLength MUST be set together or unexpected behavior could occur.
component.Config("NegotiatedStrictKex")
This provides an easy way to automatically reply to prompts with the password if one is presented by the server. The password will be auto-filled in the Response parameter of the SSHKeyboardInteractive event in the case of a match.
The following special characters are supported for pattern matching:
? | Any single character. |
* | Any characters or no characters (e.g., C*t matches Cat, Cot, Coast, Ct). |
[,-] | A range of characters (e.g., [a-z], [a], [0-9], [0-9,a-d,f,r-z]). |
\ | The slash is ignored and exact matching is performed on the next character. |
If these characters need to be used as a literal in a pattern, then they must be escaped by surrounding them with brackets []. Note: "]" and "-" do not need to be escaped. See below for the escape sequences:
Character | Escape Sequence |
? | [?] |
* | [*] |
[ | [[] |
\ | [\] |
For example, to match the value [Something].txt, specify the pattern [[]Something].txt.
The default value is 0, meaning this setting is not used.
component.Config("SignedSSHCert=ssh-rsa-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...");
The algorithm such as ssh-rsa-cert-v01@openssh.com in the above string is used as part of the authentication process. To use a different algorithm simply change this value. For instance all of the following are acceptable with the same signed public key:
- ssh-rsa-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...
- rsa-sha2-256-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...
- rsa-sha2-512-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...
component.Config("SSHAcceptServerCAKey=ssh-rsa AAAAB3NzaC1yc2EAAAADAQAB...");
SSHClient.Config("SSHAcceptServerHostKeyFingerprint=0a:1b:2c:3d");
If the server's fingerprint matches one of the values supplied, the class will accept the host key.
- MD5
- SHA1
- SHA256 (default)
The default value is 0 meaning no keep alives will be sent.
Note: The SSHREVERSETUNNEL class uses a default value of 30.
- curve25519-sha256
- curve25519-sha256@libssh.org
- diffie-hellman-group1-sha1
- diffie-hellman-group14-sha1
- diffie-hellman-group14-sha256
- diffie-hellman-group16-sha512
- diffie-hellman-group18-sha512
- diffie-hellman-group-exchange-sha256
- diffie-hellman-group-exchange-sha1
- ecdh-sha2-nistp256
- ecdh-sha2-nistp384
- ecdh-sha2-nistp521
- gss-group14-sha256-toWM5Slw5Ew8Mqkay+al2g==
- gss-group16-sha512-toWM5Slw5Ew8Mqkay+al2g==
- gss-nistp256-sha256-toWM5Slw5Ew8Mqkay+al2g==
- gss-curve25519-sha256-toWM5Slw5Ew8Mqkay+al2g==
- gss-group14-sha1-toWM5Slw5Ew8Mqkay+al2g==
- gss-gex-sha1-toWM5Slw5Ew8Mqkay+al2g==
Example:
SSHClient.Config("SSHKeyRenegotiate")
- hmac-sha1
- hmac-md5
- hmac-sha1-96
- hmac-md5-96
- hmac-sha2-256
- hmac-sha2-256-96
- hmac-sha2-512
- hmac-sha2-512-96
- hmac-ripemd160
- hmac-ripemd160-96
- hmac-sha2-256-etm@openssh.com
- hmac-sha2-512-etm@openssh.com
- umac-64@openssh.com
- umac-64-etm@openssh.com
- umac-128@openssh.com
- umac-128-etm@openssh.com
The setting should be a comma separated list of algorithms. At runtime the class will evaluate the specified algorithms and if the algorithm is applicable to the certificate specified in SSHCert it will be used. If the algorithm is not applicable the class will evaluate the next algorithm. Possible values are:
- ssh-rsa
- rsa-sha2-256
- rsa-sha2-512
- ssh-dss
- ecdsa-sha2-nistp256
- ecdsa-sha2-nistp384
- ecdsa-sha2-nistp521
- ssh-ed25519
- x509v3-sign-rsa
- x509v3-sign-dss
The default value in Windows is ssh-rsa,rsa-sha2-256,rsa-sha2-512,ssh-dss,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,ssh-ed25519.
rsa-sha2-256 and rsa-sha2-512 notes
The class will query the server for supported algorithms when connecting. If the server indicates support for rsa-sha2-256 or rsa-sha2-512 and the algorithm is present in the list defined by this setting (as in the default value), that algorithm will be used instead of ssh-rsa even when ssh-rsa appears first in the list.
For the rsa-sha2-256 and rsa-sha2-512 algorithms to be automatically preferred the server must support the ext-info-c mechanism. In practice, older servers do not support this and in that case ssh-rsa will be used since it appears first in the list. Newer servers do support this mechanism and in that case rsa-sha2-256 or rsa-sha2-512 will be used even though it appears after ssh-rsa.
This behavior has been carefully designed to provide maximum compatibility while automatically using more secure algorithms when connecting to servers which support them.
*SSH-1.99-*,*SSH-2.0-*,*SSH-2.99-*
Since both client and server must implement strict key exchange to effectively mitigate the Terrapin attack, the class provides options to further control the behavior in different scenarios. Possible values for this setting are:
0 | Disabled. Strict key exchange is not supported in the class. |
1 (default) | Enabled, but not enforced. This setting enables strict key exchange, but if the remote host does not support strict key exchange the connection is still allowed to continue. |
2 | Enabled, but reject affected algorithms if the remote host does not support strict key exchange. If the remote host supports strict key exchange all algorithms may be used. If the remote host does not support strict key exchange the connection will only continue if the selected encryption and MAC algorithms are not affected by the Terrapin attack. |
3 | Required. If the remote host does not support strict key exchange the connection will fail. |
When True (default) the class will wait for a response to the channel close message until the responses have been received, the server closes the connection, or Timeout seconds is reached.
When False the class will still send the channel close messages but will not wait for a response and will proceed to close the connection.
When set to True the class will initiate the disconnection sequence by sending SSH_MSG_DISCONNECT but will not close the connection, and instead will wait for the server to close the connection. Setting this to True may be beneficial in circumstances where many connections are being established, to avoid port exhaustion when sockets are in a TIME_WAIT state. Allowing the server to close the connection avoids the TIME_WAIT state of socket on the client machine.
When set to False (default) the client will close the connection. It is recommended to use this value unless there is a specific need to change it.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
This setting is set to false by default on all platforms.
Trappable Errors (class ipworkssftp.sftpclient)
SFTPClient Errors
118 | Firewall error. Error description contains detailed information. |
1102 | The server's SFTP draft version is unsupported. |
1103 | SFTP command failed. Error description contains detailed information. |
1104 | Server does not support renaming. |
1105 | Received invalid response from server. Error description contains detailed information. |
1106 | Cannot resolve path: path does not exist. |
1107 | You must set LocalFile/RemoteFile before attempting to download/upload. |
1108 | Cannot download file: LocalFile exists and Overwrite is set to False. |
1109 | CheckFileHash failed because of hash value mismatch. |
SSHClient Errors
1001 | Server has disconnected. |
1002 | Protocol version unsupported or other issue with version string. |
1003 | Cannot negotiate algorithms. |
1005 | Selected algorithm unsupported. |
1006 | Cannot set keys. |
1010 | Unexpected algorithm. |
1011 | Cannot create exchange hash. |
1012 | Cannot make key. |
1013 | Cannot sign data. |
1014 | Cannot encrypt packet. |
1015 | Cannot decrypt packet. |
1016 | Cannot decompress packet. |
1020 | Failure to open channel. |
1021 | Invalid channel ID. |
1022 | Invalid channel data. |
1023 | Invalid channel message. |
1024 | SSH message unimplemented. |
1027 | Server message unsupported. |
1030 | Server's host key was rejected. The host key may be accepted within the SSHServerAuthentication event or using the SSHAcceptServerHostKey property. |
1031 | Cannot verify server's host key. |
1032 | Authentication failed. Check description for details. |
1033 | Channel request failed. |
1034 | Diffie-Hellman exchange failed. |
1036 | SSH connection failed. |
1037 | SSH reconnect limit reached. |
1038 | Elliptic Curve Diffie-Hellman exchange failed. |
1039 | SSH keep-alive limit reached. |
1098 | Request failure. |
1130 | Would block error. |
1133 | Would block, reason: key reExchange. |
TCPClient Errors
100 | You cannot change the RemotePort at this time. A connection is in progress. |
101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
102 | The RemoteHost address is invalid (0.0.0.0). |
104 | Already connected. If you want to reconnect, close the current connection first. |
106 | You cannot change the LocalPort at this time. A connection is in progress. |
107 | You cannot change the LocalHost at this time. A connection is in progress. |
112 | You cannot change MaxLineLength at this time. A connection is in progress. |
116 | RemotePort cannot be zero. Please specify a valid service port number. |
117 | You cannot change the UseConnection option while the class is active. |
135 | Operation would block. |
201 | Timeout. |
211 | Action impossible in control's present state. |
212 | Action impossible while not connected. |
213 | Action impossible while listening. |
301 | Timeout. |
302 | Could not open file. |
434 | Unable to convert string to selected CodePage. |
1105 | Already connecting. If you want to reconnect, close the current connection first. |
1117 | You need to connect first. |
1119 | You cannot change the LocalHost at this time. A connection is in progress. |
1120 | Connection dropped by remote host. |
TCP/IP Errors
10004 | [10004] Interrupted system call. |
10009 | [10009] Bad file number. |
10013 | [10013] Access denied. |
10014 | [10014] Bad address. |
10022 | [10022] Invalid argument. |
10024 | [10024] Too many open files. |
10035 | [10035] Operation would block. |
10036 | [10036] Operation now in progress. |
10037 | [10037] Operation already in progress. |
10038 | [10038] Socket operation on nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot assign requested address. |
10050 | [10050] Network is down. |
10051 | [10051] Network is unreachable. |
10052 | [10052] Net dropped connection or reset. |
10053 | [10053] Software caused connection abort. |
10054 | [10054] Connection reset by peer. |
10055 | [10055] No buffer space available. |
10056 | [10056] Socket is already connected. |
10057 | [10057] Socket is not connected. |
10058 | [10058] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is not empty |
10067 | [10067] Too many processes. |
10068 | [10068] Too many users. |
10069 | [10069] Disc Quota Exceeded. |
10070 | [10070] Stale NFS file handle. |
10071 | [10071] Too many levels of remote in path. |
10091 | [10091] Network subsystem is unavailable. |
10092 | [10092] WINSOCK DLL Version out of range. |
10093 | [10093] Winsock is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |