SFtp Python Reference Documentation

SFtp

Current Version: 10.0.0

Requires Chilkat Bundle License

SFTP implementation for file transfer and remote file management over SSH.

Object Creation

obj = chilkat2.SFtp()

Properties

AbortCurrent

bool AbortCurrent

Introduced in version 9.5.0.58

When set to True, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to False when the next method is called. When the abort occurs, this property is reset to False. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

AccumulateBuffer

memoryview AccumulateBuffer (read-only)

Contains the bytes downloaded from a remote file via the AccumulateBytes method call. Each call to AccumulateBytes appends to this buffer. To clear this buffer, call the ClearAccumulateBuffer method.

AuthFailReason

int AuthFailReason (read-only)

Introduced in version 9.5.0.52

Set to one of the following values if a call to AuthenticatePw, AuthenticatePk, or AuthenticatePwPk returns a failed status.

1: Transport failure. This is a failure to communicate with the server (i.e. the connection was lost, or a read or write failed or timed out).
2: Invalid key for public key authentication. The key was not a valid format, not a valid key, not a private key, or not the right type of key.
3: No matching authentication methods were available.
4: SSH authentication protocol error - an unexpected or invalid message was received.
5: The incorrect password or private key was provided.
6: Already authenticated. The SSH session is already authenticated.
7: Password change request: The server requires the password to be changed.

BandwidthThrottleDown

int BandwidthThrottleDown

Introduced in version 9.5.0.49

If non-zero, limits (throttles) the download bandwidth to approximately this maximum number of bytes per second. The default value of this property is 0.

BandwidthThrottleUp

int BandwidthThrottleUp

Introduced in version 9.5.0.49

If non-zero, limits (throttles) the upload bandwidth to approximately this maximum number of bytes per second. The default value of this property is 0.

More Information and Examples

SFTP Upload with Bandwidth Throttling

ClientIdentifier

string ClientIdentifier

The client-identifier string to be used when connecting to an SSH/SFTP server. Starting in Chilkat v9.5.0.99, the default is "SSH-2.0-Chilkat_" + the Chilkat version number, such as "SSH-2.0-Chilkat_9.5.0.99".

Note: The client identifier should always begin with "SSH-2.0-". SSH servers may disconnect if it does not.

ClientIpAddress

string ClientIpAddress

The IP address to use for computers with multiple network interfaces or IP addresses. For computers with a single network interface (i.e. most computers), this property should not be set. For multihoming computers, the default IP address is automatically used if this property is not set.

The IP address is a string such as in dotted notation using numbers, not domain names, such as "165.164.55.124".

ConnectTimeoutMs

int ConnectTimeoutMs

Maximum number of milliseconds to wait when connecting to an SSH server.

To clarify: This property determines how long to wait for the SSH server to accept the TCP connection. Once the connection is made, it is the IdleTimeoutMs property that applies to receiving data and responses.

DebugLogFilePath

string DebugLogFilePath

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
there is an internal problem (bug) in the Chilkat code that causes the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

DisconnectCode

int DisconnectCode (read-only)

If the SSH/SFTP server sent a DISCONNECT message when closing the connection, this property contains the "reason code" as specified in RFC 4253:

           Symbolic name                                reason code
           -------------                                -----------
      SSH_DISCONNECT_HOST_NOT_ALLOWED_TO_CONNECT             1
      SSH_DISCONNECT_PROTOCOL_ERROR                          2
      SSH_DISCONNECT_KEY_EXCHANGE_FAILED                     3
      SSH_DISCONNECT_RESERVED                                4
      SSH_DISCONNECT_MAC_ERROR                               5
      SSH_DISCONNECT_COMPRESSION_ERROR                       6
      SSH_DISCONNECT_SERVICE_NOT_AVAILABLE                   7
      SSH_DISCONNECT_PROTOCOL_VERSION_NOT_SUPPORTED          8
      SSH_DISCONNECT_HOST_KEY_NOT_VERIFIABLE                 9
      SSH_DISCONNECT_CONNECTION_LOST                        10
      SSH_DISCONNECT_BY_APPLICATION                         11
      SSH_DISCONNECT_TOO_MANY_CONNECTIONS                   12
      SSH_DISCONNECT_AUTH_CANCELLED_BY_USER                 13
      SSH_DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE         14
      SSH_DISCONNECT_ILLEGAL_USER_NAME                      15

DisconnectReason

string DisconnectReason (read-only)

If the SSH/SFTP server sent a DISCONNECT message when closing the connection, this property contains a descriptive string for the "reason code" as specified in RFC 4253.

EnableCache

bool EnableCache

Controls whether the component keeps an internal file size & attribute cache. The cache affects the following methods: GetFileSize32, GetFileSize64, GetFileSizeStr, GetFileCreateTime, GetFileLastAccess, GetFileLastModified, GetFileOwner, GetFileGroup, and GetFilePermissions.

The file attribute cache exists to minimize communications with the SFTP server. If the cache is enabled, then a request for any single attribute will cause all of the attributes to be cached. A subsequent request for a different attribute of the same file will be fulfilled from cache, eliminating the need for a message to be sent to the SFTP server.

Note: Caching only occurs when filenames are used, not handles.

The default value is _False_

EnableCompression

bool EnableCompression

Introduced in version 9.5.0.56

Enables or disables the use of compression w/ the SSH connection. The default value is False.

Some older SSH servers have been found that claim to support compression, but actually fail when compression is used. PuTTY does not enable compression by default. If trouble is encountered where the SSH server disconnects immediately after the connection is seemingly established (i.e. during authentication), then check to see if disabling compression resolves the problem.

FilenameCharset

string FilenameCharset

Automatically set during the InitializeSftp method if the server sends a filename-charset name-value extension. Otherwise, may be set directly to the name of a charset, such as "utf-8", "iso-8859-1", "windows-1252", etc. ("ansi" is also a valid choice.) Incoming filenames are interpreted as utf-8 if no FilenameCharset is set. Outgoing filenames are sent using utf-8 by default. Otherwise, incoming and outgoing filenames use the charset specified by this property.

ForceCipher

string ForceCipher

Set to one of the following encryption algorithms to force that cipher to be used. By default, the component will automatically choose the first cipher supported by the server in the order listed here: "aes256-ctr", "aes128-ctr", "aes256-cbc", "aes128-cbc", "twofish256-cbc", "twofish128-cbc", "blowfish-cbc", "3des-cbc", "arcfour128", "arcfour256". (If blowfish is chosen, the encryption strength is 128 bits.)

Important: If this is property is set and the server does NOT support then encryption algorithm, then the Connect will fail.

ForceV3

bool ForceV3

If set to True, forces the client to choose version 3 of the SFTP protocol, even if the server supports a higher version. The default value of this property is True.

HostKeyAlg

string HostKeyAlg

Indicates the preferred host key algorithm to be used in establishing the SSH secure connection. The default is "DSS". It may be changed to "RSA" if needed. Chilkat recommends not changing this unless a problem warrants the change.

HostKeyFingerprint

string HostKeyFingerprint (read-only)

Returns the MD5 host key fingerprint of the server, which is automatically set after connecting to an SSH/SFTP server. Depending on the host key type, the format of the MD5 fingerprint looks like this:

ssh-rsa 2048 68:ff:d1:4e:6c:ff:d7:b0:d6:58:73:85:07:bc:2e:d5
ssh-dss 2048 68:ff:d1:4e:6c:ff:d7:b0:d6:58:73:85:07:bc:2e:d5
ssh-ed25519 68:ff:d1:4e:6c:ff:d7:b0:d6:58:73:85:07:bc:2e:d5
ecdsa-sha2-nistp256 256 a3:09:05:b5:81:79:5d:33:e1:1a:82:c7:cb:ba:93:ea

Note: To get the SHA256 host key fingerprint, use the GetHostKeyFP method (added in v9.5.0.92)

More Information and Examples

SFTP Host Key Fingerprint

HttpProxyAuthMethod

string HttpProxyAuthMethod

If an HTTP proxy requiring authentication is to be used, set this property to the HTTP proxy authentication method name. Valid choices are "Basic" or "NTLM".

HttpProxyDomain

string HttpProxyDomain

The NTLM authentication domain (optional) if NTLM authentication is used w/ the HTTP proxy.

HttpProxyHostname

string HttpProxyHostname

If an HTTP proxy is to be used, set this property to the HTTP proxy hostname or IPv4 address (in dotted decimal notation).

HttpProxyPassword

string HttpProxyPassword

If an HTTP proxy requiring authentication is to be used, set this property to the HTTP proxy password.

HttpProxyPort

int HttpProxyPort

If an HTTP proxy is to be used, set this property to the HTTP proxy port number. (Two commonly used HTTP proxy ports are 8080 and 3128.)

HttpProxyUsername

string HttpProxyUsername

If an HTTP proxy requiring authentication is to be used, set this property to the HTTP proxy login name.

IdleTimeoutMs

int IdleTimeoutMs

Causes SFTP operations to fail when progress for sending or receiving data halts for more than this number of milliseconds. Setting IdleTimeoutMs = 0 allows the application to wait indefinitely. The default value of this property is 30000 (which equals 30 seconds).

IncludeDotDirs

bool IncludeDotDirs

If True, then the ReadDir method will include the "." and ".." directories in its results. The default value of this property is False.

InitializeFailCode

int InitializeFailCode (read-only)

The InitializeSftp method call opens a channel for the SFTP session. If the request to open a channel fails, this property contains a code that identifies the reason for failure. The reason codes are defined in RFC 4254 and are reproduced here:

             Symbolic name                           reason code
             -------------                           -----------
            SSH_OPEN_ADMINISTRATIVELY_PROHIBITED          1
            SSH_OPEN_CONNECT_FAILED                       2
            SSH_OPEN_UNKNOWN_CHANNEL_TYPE                 3
            SSH_OPEN_RESOURCE_SHORTAGE                    4

InitializeFailReason

string InitializeFailReason (read-only)

The InitializeSftp method call opens a channel for the SFTP session. If the request to open a channel fails, this property contains a description of the reason for failure. (It contains descriptive text matching the InitializeFailCode property.)

IsConnected

bool IsConnected (read-only)

Returns True if connected to the SSH server. Note: This does not mean authentication has happened or InitializeSftp has already succeeded. It only means that the connection has been established by calling Connect.

Understanding the IsConnected property: The IsConnected property is the last known state of the TCP connection (either connected or disconnected). This requires some explanation because most developer have incorrect assumptions about TCP connections.

If a TCP connection is established, and neither side is reading or writing the socket (i.e. both sides are doing nothing), then you can disconnect the network cable from the computer for any length of time, and then re-connect, and the TCP connection is not affected.
A TCP connection only becomes disconnected when an attempt is made to read/write while a network problem exists. If no attempts to read/write occur, a network problem may arise and then become resolved without affecting the TCP connection.
If the peer chooses to close its side of the TCP connection, your application won't magically know about it until you try to do something with the TCP socket (such as read or write).
A Chilkat API property (as opposed to a method) CANNOT and should not do something that would cause an application to timeout, hang, etc. Therefore, it is not appropriate for the IsConnected property to attempt any kind of socket operation (read/write/peek) on the socket. It simply returns the last known state of the connection. It may very well be that your network cable is unplugged and IsConnected returns True because technically, if neither peer is trying to read/write, the network cable could be plugged back in without affecting the connection. IsConnected could also return True if the peer has already closed its side of the connection, because the state of the connection is only updated after trying to read/write/peek.
To truly know the current connected state (as opposed to the last known connection state), your application should attempt a network operation that is appropriate to the protocol. For SFTP, an application could call SendIgnore, and then check IsConnected.

KeepSessionLog

bool KeepSessionLog

Controls whether communications to/from the SFTP server are saved to the SessionLog property. The default value is False. If this property is set to True, the contents of the SessionLog property will continuously grow as SFTP activity transpires. The purpose of the KeepSessionLog / SessionLog properties is to help in debugging any future problems that may arise.

LastErrorHtml

string LastErrorHtml (read-only)

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

LastErrorText

string LastErrorText (read-only)

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

string LastErrorXml (read-only)

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

LastMethodSuccess

bool LastMethodSuccess

Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

Any method that returns a string.
Any method returning a Chilkat object, binary bytes, or a date/time.
Any method returning a standard boolean status value where success = True and failure = False.
Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

LastStatusCode

int LastStatusCode (read-only)

Introduced in version 9.5.0.85

Contains the numeric last status code received in an SSH_FXP_STATUS message received from the SFTP server. Status codes are defined in the SFTP protocol specification as follows:

(See https://tools.ietf.org/id/draft-ietf-secsh-filexfer-13.txt)

SSH_FX_OK                            0
SSH_FX_EOF                           1
SSH_FX_NO_SUCH_FILE                  2
SSH_FX_PERMISSION_DENIED             3
SSH_FX_FAILURE                       4
SSH_FX_BAD_MESSAGE                   5
SSH_FX_NO_CONNECTION                 6
SSH_FX_CONNECTION_LOST               7
SSH_FX_OP_UNSUPPORTED                8
SSH_FX_INVALID_HANDLE                9
SSH_FX_NO_SUCH_PATH                  10
SSH_FX_FILE_ALREADY_EXISTS           11
SSH_FX_WRITE_PROTECT                 12
SSH_FX_NO_MEDIA                      13
SSH_FX_NO_SPACE_ON_FILESYSTEM        14
SSH_FX_QUOTA_EXCEEDED                15
SSH_FX_UNKNOWN_PRINCIPAL             16
SSH_FX_LOCK_CONFLICT                 17
SSH_FX_DIR_NOT_EMPTY                 18
SSH_FX_NOT_A_DIRECTORY               19
SSH_FX_INVALID_FILENAME              20
SSH_FX_LINK_LOOP                     21
SSH_FX_CANNOT_DELETE                 22
SSH_FX_INVALID_PARAMETER             23
SSH_FX_FILE_IS_A_DIRECTORY           24
SSH_FX_BYTE_RANGE_LOCK_CONFLICT      25
SSH_FX_BYTE_RANGE_LOCK_REFUSED       26
SSH_FX_DELETE_PENDING                27
SSH_FX_FILE_CORRUPT                  28
SSH_FX_OWNER_INVALID                 29
SSH_FX_GROUP_INVALID                 30
SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK       31

LastStatusMessage

string LastStatusMessage (read-only)

Introduced in version 9.5.0.85

Contains the message text received in the last SSH_FXP_STATUS message received from the SFTP server. The actual text of the message can vary depending on the SFTP server implementation. The integer status code is available in the LastStatusCode property.

MaxPacketSize

int MaxPacketSize

The maximum packet length to be used in the underlying SSH transport protocol. The default value is 32768. (This should generally be left unchanged.)

PasswordChangeRequested

bool PasswordChangeRequested (read-only)

Set by the AuthenticatePw and AuthenticatePwPk methods. If the authenticate method returns a failed status, and this property is set to True, then it indicates the server requested a password change. In this case, re-call the authenticate method, but provide both the old and new passwords in the following format, where vertical bar characters encapsulate the old and new passwords:

|oldPassword|newPassword|

PreferIpv6

bool PreferIpv6

If True, then use IPv6 over IPv4 when both are supported for a particular domain. The default value of this property is False, which will choose IPv4 over IPv6.

PreserveDate

bool PreserveDate

If True, then the file last-modified and create date/time will be preserved for downloaded and uploaded files. The default value is False.

Note: It does not apply to uploads or downloads where the remote file is opened to obtain a handle, the data is uploaded/downloaded, and then the handle is closed.

ProtocolVersion

int ProtocolVersion (read-only)

The negotiated SFTP protocol version, which should be a value between 3 and 6 inclusive. When the InitializeSftp method is called, the Chilkat SFTP client sends it's highest supported protocol version to the server, and the server sends it's SFTP protocol version in response. The negotiated protocol (i.e. the protocol version used for the session) is the lower of the two numbers. If the SFTP server's protocol version is lower than 6, some file date/attributes are not supported because they are not supported by the earlier protocol version. These exceptions are noted throughout the reference documentation.

ReadDirMustMatch

string ReadDirMustMatch

Introduced in version 9.5.0.53

Can contain a wildcarded list of file patterns separated by semicolons. For example, "*.xml; *.txt; *.csv". If set, the ReadDir method will only return files that match any one of these patterns.

ReadDirMustNotMatch

string ReadDirMustNotMatch

Introduced in version 9.5.0.53

Can contain a wildcarded list of file patterns separated by semicolons. For example, "*.xml; *.txt; *.csv". If set, the ReadDir method will only return files that do not match any of these patterns.

ServerIdentifier

string ServerIdentifier (read-only)

Introduced in version 9.5.0.71

The server-identifier string received from the server during connection establishment. For example, a typical value would be similar to "SSH-2.0-OpenSSH_7.2p2 Ubuntu-4ubuntu2.2".

SessionLog

string SessionLog (read-only)

Contains a log of the messages sent to/from the SFTP server. To enable session logging, set the KeepSessionLog property = True. Note: This property is not a filename -- it is a string property that contains the session log data.

SocksHostname

string SocksHostname

The SOCKS4/SOCKS5 hostname or IPv4 address (in dotted decimal notation). This property is only used if the SocksVersion property is set to 4 or 5).

SocksPassword

string SocksPassword

The SOCKS5 password (if required). The SOCKS4 protocol does not include the use of a password, so this does not apply to SOCKS4.

SocksPort

int SocksPort

The SOCKS4/SOCKS5 proxy port. The default value is 1080. This property only applies if a SOCKS proxy is used (if the SocksVersion property is set to 4 or 5).

SocksUsername

string SocksUsername

The SOCKS4/SOCKS5 proxy username. This property is only used if the SocksVersion property is set to 4 or 5).

SocksVersion

int SocksVersion

SocksVersion May be set to one of the following integer values:

0 - No SOCKS proxy is used. This is the default.
4 - Connect via a SOCKS4 proxy.
5 - Connect via a SOCKS5 proxy.

SoRcvBuf

int SoRcvBuf

Sets the receive buffer size socket option. Normally, this property should be left unchanged. The default value is 4194304.

This property can be increased if download performance seems slow. It is recommended to be a multiple of 4096.

More Information and Examples

More Information about TCP performance and Buffer Sizes

SoSndBuf

int SoSndBuf

Sets the send buffer size socket option. Normally, this property should be left unchanged. The default value is 262144.

This property can be increased if upload performance seems slow. It is recommended to be a multiple of 4096. Testing with sizes such as 512K and 1MB is reasonable.

More Information and Examples

More Information about TCP performance and Buffer Sizes

SyncCreateAllLocalDirs

bool SyncCreateAllLocalDirs

Introduced in version 9.5.0.76

If True, then empty directories on the server are created locally when doing a download synchronization. If False, then only directories containing files that are downloaded are auto-created.

The default value of this property is True.

More Information and Examples

SFTP Sync Download Tree w/ Must-Match Filename Constraints

SyncDirectives

string SyncDirectives

Introduced in version 9.5.0.58

A property that can contain a list of comma-separated keywords to control certain aspects of an upload or download synchronization (for the SyncTreeUpload and SyncTreeDownload methods). At this time there is only one possible directive, but others may be added in the future.

Set this property to "UploadIgnoreLocalOpenFailures" to skip local files that cannot be opened. A common reason for this would be if another process on the system has the file open for exclusive access.

SyncedFiles

string SyncedFiles

Introduced in version 9.5.0.51

The paths of the files uploaded or downloaded in the last call to SyncTreeUpload or SyncTreeDownload. The paths are listed one per line. In both cases (for upload and download) each line contains the paths relative to the root synced directory.

Note: For SyncTreeDownload, some of entires can be the paths of local directories that were created. Local directory paths will be terminated with a "/" char to disinguish a directory from an actual file.

More Information and Examples

SFTP SyncTreeDownload - Find out what files were downloaded

SyncMustMatch

string SyncMustMatch

Can contain a wildcarded list of file patterns separated by semicolons. For example, "*.xml; *.txt; *.csv". If set, the SyncTreeUpload and SyncTreeDownload methods will only transfer files that match any one of these patterns. This property only applies to files. It does not apply to sub-directory names when recursively traversing a directory tree.

More Information and Examples

SFTP Sync Download Tree w/ Must-Match Filename Constraints

SyncMustMatchDir

string SyncMustMatchDir

Introduced in version 9.5.0.76

Can contain a wildcarded list of file patterns separated by semicolons. For example, "xml; txt; data_*". If set, the SyncTreeUpload and SyncTreeDownload methods will only enter directories that match any one of these patterns.

More Information and Examples

SFTP Sync Download Tree w/ Must-Match Directory Constraints

SyncMustNotMatch

string SyncMustNotMatch

Can contain a wildcarded list of file patterns separated by semicolons. For example, "*.xml; *.txt; *.csv". If set, the SyncTreeUpload and SyncTreeDownload methods will not transfer files that match any one of these patterns. This property only applies to files. It does not apply to sub-directory names when recursively traversing a directory tree.

SyncMustNotMatchDir

string SyncMustNotMatchDir

Introduced in version 9.5.0.76

Can contain a wildcarded list of file patterns separated by semicolons. For example, "xml; txt; data_*". If set, the SyncTreeUpload and SyncTreeDownload methods will not enter directories that match any one of these patterns.

TcpNoDelay

bool TcpNoDelay

This property controls the use of the internal TCP_NODELAY socket option (which disables the Nagle algorithm). The default value of this property is False. Setting this value to True disables the delay of sending successive small packets on the network.

UncommonOptions

string UncommonOptions

Introduced in version 9.5.0.73

This is a catch-all property to be used for uncommon needs. This property defaults to the empty string, and should typically remain empty.

Can be set to a list of the following comma separated keywords:

ForceUserAuthRsaSha1 - Introduced in v9.5.0.98. When doing public-key authentication, forces rsa-sha1 to be used for the userauth algorithm even if the server supports rsa-sha2-256, rsa-sha2-512, but still requires SHA1 for the userauth algorithm. Make sure to set this option before connecting to the server.
ProtectFromVpn - Introduced in v9.5.0.80. On Android systems, will bypass any VPN that may be installed or active.
NoSyncDownloadEmptyFiles - Introduced in v9.5.0.80. Prevents empty files from being downloaded in SyncTreeDownload.
no-weak-mac-algs - Introduced in v9.5.0.98. Removes all weaker MAC algorithms from the list offered to the SSH server when negotiating the connection parameters during a Connect. Specifically, removes hmac-sha1-96, hmac-sha1, hmac-md5, and hmac-ripemd160. Note: Stronger algorithms such as hmac-sha2-256, hmac-sha2-512, etc., will already be automatically chosen because they are given higher preference. The only way a weaker algorithm is chosen is if the SSH server ONLY supports weaker algorithms. This option would only be set if you explicitly want to avoid connecting to older SSH servers, or servers configured in some unusual way where only weaker algorithms are supported on the server (which is rare).
+ssh-hmac-etm - Introduced in v9.5.0.97. Version 9.5.0.97 disabled the *-etm MAC algorithms to mitigate the Terrapin attack. Use this keyword to include the etm MAC algorithms.
+chacha20-poly1305@openssh.com - Introduced in v9.5.0.97. To mitigate the Terrapin attack, chacha20-poly1305@openssh.com is no longer included by default. It can be re-added by adding this keyword.

UploadChunkSize

int UploadChunkSize

The chunk size to use when uploading files via the UploadFile or UploadFileByName methods. The default value is 32000. If an upload fails because "WSAECONNABORTED An established connection was aborted by the software in your host machine.", then try setting this property to a smaller value, such as 4096. A smaller value will result in slower transfer rates, but may help avoid this problem.

UserAuthBanner

string UserAuthBanner

Introduced in version 9.5.0.88

If a user authentication banner message is received during authentication, it will be made available here. An application can check to see if this property contains a banner string after calling StartKeyboardAuth. It is only possible for an application to display this message if it is doing keyboard-interactive authentication via the StartKeyboardAuth and ContinueKeyboardAuth methods.

UtcMode

bool UtcMode

If True, then date/times are returned as UTC times. If False (the default) then date/times are returned as local times.

VerboseLogging

bool VerboseLogging

If set to True, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is False. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version

string Version (read-only)

Version of the component/library, such as "9.5.0.94"

More Information and Examples

How to get the Chilkat version at runtime.

XferByteCount

unsigned longXferByteCount (read-only)

Introduced in version 9.5.0.71

The current transfer byte count for an ongoing upload or download. Programs doing asynchronous uploads or downloads can read this property in real time during the upload. For SyncTreeUpload and SyncTreeDownload operations, this is the real-time cumulative number of bytes for all files uploaded or downloaded.

XferByteCount64

int XferByteCount64 (read-only)

Introduced in version 9.5.0.71

The current transfer byte count for an ongoing upload or download. Programs doing asynchronous uploads or downloads can read this property in real time during the upload. For SyncTreeUpload and SyncTreeDownload operations, this is the real-time cumulative number of bytes for all files uploaded or downloaded.

Methods

AccumulateBytes

int AccumulateBytes(string handle, int maxBytes)

Downloads bytes from an open file and appends them to the AccumulateBuffer. The handle is a file handle returned by the OpenFile method. The maxBytes is the maximum number of bytes to read. If the end-of-file is reached prior to reading the number of requested bytes, then fewer bytes may be returned.

Returns the number of bytes downloaded and appended to AccumulateBuffer. Returns -1 on error.

AccumulateBytesAsync ⁽¹⁾

Task AccumulateBytesAsync(string handle, int maxBytes)

Creates an asynchronous task to call the AccumulateBytes method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

Add64

string Add64(string n1, string n2)

Convenience method for 64-bit addition. Allows for two 64-bit integers to be passed as decimal strings and returns the sum in a decimal sting.

Returns None on failure

AuthenticatePk

bool AuthenticatePk(string username, SshKey privateKey)

Authenticates with the SSH server using public-key authentication. The corresponding public key must have been installed on the SSH server for the username. Authentication will succeed if the matching privateKey is provided.

Important: When reporting problems, please send the full contents of the LastErrorText property to support@chilkatsoft.com.

Returns True for success, False for failure.

More Information and Examples

Use PuTTY Key for SFTP Authentication AWS Transfer for SFTP (Amazon S3)Generate RSA Key for SFTP

AuthenticatePkAsync ⁽¹⁾

Task AuthenticatePkAsync(string username, SshKey privateKey)

Creates an asynchronous task to call the AuthenticatePk method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

AuthenticatePw

bool AuthenticatePw(string login, string password)

Authenticates with the SSH server using a login and password.

An SFTP session always begins by first calling Connect to connect to the SSH server, then calling either AuthenticatePw or AuthenticatePk to login, and finally calling InitializeSftp.

Important: When reporting problems, please send the full contents of the LastErrorText property to support@chilkatsoft.com.

Note: To learn about how to handle password change requests, see the PasswordChangeRequested property (above).

Returns True for success, False for failure.

AuthenticatePwAsync ⁽¹⁾

Task AuthenticatePwAsync(string login, string password)

Creates an asynchronous task to call the AuthenticatePw method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

AuthenticatePwPk

bool AuthenticatePwPk(string username, string password, SshKey privateKey)

Authentication for SSH servers that require both a password and private key. (Most SSH servers are configured to require one or the other, but not both.)

Important: When reporting problems, please send the full contents of the LastErrorText property to support@chilkatsoft.com.

Returns True for success, False for failure.

More Information and Examples

SFTP Auth Failure Reason (AuthenticatePwPk)

AuthenticatePwPkAsync ⁽¹⁾

Task AuthenticatePwPkAsync(string username, string password, SshKey privateKey)

Creates an asynchronous task to call the AuthenticatePwPk method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

AuthenticateSecPw

bool AuthenticateSecPw(SecureString login, SecureString password)

Introduced in version 9.5.0.71

The same as AuthenticatePw, but the login and password are passed in secure string objects.

Returns True for success, False for failure.

More Information and Examples

SFTP Authenticate Secure

AuthenticateSecPwAsync ⁽¹⁾

Task AuthenticateSecPwAsync(SecureString login, SecureString password)

Introduced in version 9.5.0.71

Creates an asynchronous task to call the AuthenticateSecPw method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

AuthenticateSecPwPk

bool AuthenticateSecPwPk(SecureString username, SecureString password, SshKey privateKey)

Introduced in version 9.5.0.71

The same as AuthenticatePwPk, but the login and password are passed in secure string objects.

Returns True for success, False for failure.

AuthenticateSecPwPkAsync ⁽¹⁾

Task AuthenticateSecPwPkAsync(SecureString username, SecureString password, SshKey privateKey)

Introduced in version 9.5.0.71

Creates an asynchronous task to call the AuthenticateSecPwPk method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

ClearAccumulateBuffer

void ClearAccumulateBuffer()

Clears the contents of the AccumulateBuffer property.

ClearCache

void ClearCache()

Clears the internal file attribute cache. (Please refer to the EnableCache property for more information about the file attribute cache.)

ClearSessionLog

void ClearSessionLog()

Clears the contents of the SessionLog property.

CloseHandle

bool CloseHandle(string handle)

Closes a file on the SSH/SFTP server. handle is a file handle returned from a previous call to OpenFile or OpenDir.

Returns True for success, False for failure.

More Information and Examples

SFTP Upload from Local Filesystem

CloseHandleAsync ⁽¹⁾

Task CloseHandleAsync(string handle)

Creates an asynchronous task to call the CloseHandle method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

Connect

bool Connect(string domainName, int port)

Connects to an SSH/SFTP server. The domainName may be a domain name or an IP address (example: 192.168.1.10). Both IPv4 and IPv6 addresses are supported. The port is typically 22, which is the standard port for SSH servers.

An SFTP session always begins by first calling Connect to connect to the SSH server, then calling either AuthenticatePw or AuthenticatePk to login, and finally calling InitializeSftp.

Important: When reporting problems, please send the full contents of the LastErrorText property to support@chilkatsoft.com.

Important: All TCP-based Internet communications, regardless of the protocol (such as HTTP, FTP, SSH, IMAP, POP3, SMTP, etc.), and regardless of SSL/TLS, begin with establishing a TCP connection to a remote host:port. External security-related infrastructure such as software firewalls (Windows Firewall), hardware firewalls, anti-virus, at either source or destination (or both) can block the connection. If the connection fails, make sure to check all potential external causes of blockage.

The following algorithms are supported by Chilkat SSH/SFTP:

Hostkey:
1. ssh-ed25519
2. rsa-sha2-256
3. rsa-sha2-512
4. ecdsa-sha2-nistp256
5. ecdsa-sha2-nistp384
6. ecdsa-sha2-nistp521
7. ssh-rsa
8. ssh-dss
Key Exchange:
1. curve25519-sha256
2. curve25519-sha256@libssh.org
3. ecdh-sha2-nistp256
4. ecdh-sha2-nistp384
5. ecdh-sha2-nistp521
6. diffie-hellman-group14-sha256
7. diffie-hellman-group1-sha1
8. diffie-hellman-group14-sha1
9. diffie-hellman-group16-sha512
10. diffie-hellman-group18-sha512
11. diffie-hellman-group-exchange-sha256
12. diffie-hellman-group-exchange-sha1
Ciphers:
1. aes128-ctr
2. aes256-ctr
3. aes192-ctr
4. aes128-cbc
5. aes256-cbc
6. aes192-cbc
7. aes128-gcm@openssh.com
8. aes256-gcm@openssh.com
9. twofish256-cbc
10. twofish128-cbc
11. blowfish-cbc
12. (also chacha20-poly1305@openssh.com if explicitly allowed by the application)
MAC Algorithms:
1. hmac-sha2-256
2. hmac-sha2-512
3. hmac-sha1
4. hmac-ripemd160
5. hmac-sha1-96
6. hmac-md5
7. (also the following etm algorithms if explicitly allowed)
8. hmac-sha1-etm@openssh.com
9. hmac-sha2-256-etm@openssh.com
10. hmac-sha2-512-etm@openssh.com
Compression:
1. none
2. zlib
3. zlib@openssh.com

Returns True for success, False for failure.

ConnectAsync ⁽¹⁾

Task ConnectAsync(string domainName, int port)

Creates an asynchronous task to call the Connect method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

ConnectThroughSsh

bool ConnectThroughSsh(Ssh sshConn, string hostname, int port)

Introduced in version 9.5.0.55

Connects to an SSH/SFTP server through an existing SSH connection. The sshConn is an existing connected and authenticated SSH object. The connection to hostname:port is made through the existing SSH connection via port-forwarding. If successful, the connection is as follows: application => ServerSSH1 => ServerSSH2. (where ServerSSH1 is the sshConn and ServerSSH2 is the SSH server at hostname:port) Once connected in this way, all communications are routed through ServerSSH1 to ServerSSH2. This includes authentication -- which means the application must still call one of the Authenticate* methods to authenticate with ServerSSH2.

Returns True for success, False for failure.

More Information and Examples

Multiple Hop SSH to SFTP

ConnectThroughSshAsync ⁽¹⁾

Task ConnectThroughSshAsync(Ssh sshConn, string hostname, int port)

Introduced in version 9.5.0.55

Creates an asynchronous task to call the ConnectThroughSsh method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

ContinueKeyboardAuth

string ContinueKeyboardAuth(string response)

Introduced in version 9.5.0.88

Continues keyboard-interactive authentication with the SSH server. The response is typically the password. If multiple responses are required (because there were multiple prompts in the infoRequest XML returned by StartKeyboardAuth), then the response should be formatted as XML (as shown below) otherwise the response simply contains the single response string.

<response>
    <response1>response to first prompt</response1>
    <response2>response to second prompt</response2>
    ...
    <responseN>response to Nth prompt</responseN>
</response>

If the interactive authentication completed with success or failure, the XML response will be:

<success>success_message</success>

or

<error>error_message</error>

If additional steps are required to complete the interactive authentication, then an XML string that provides the name, instruction, and prompts is returned. The XML has the following format:

 	<infoRequest numPrompts="N">
	    <name>name_string</name>
	    <instruction>instruction_string</instruction>
	    <prompt1 echo="1_or_0">prompt_string</prompt1>
	    ...
	    <promptN echo="1_or_0">prompt_string</promptN>
	</infoRequest>

Returns None on failure

ContinueKeyboardAuthAsync ⁽¹⁾

Task ContinueKeyboardAuthAsync(string response)

Introduced in version 9.5.0.88

Creates an asynchronous task to call the ContinueKeyboardAuth method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

CopyFileAttr

bool CopyFileAttr(string localFilename, string remoteFilename, bool isHandle)

Sets the date/time and other attributes of a remote file to be equal to that of a local file.

The attributes copied depend on the SFTP version of the server:

<b>SFTP v3 (and below)</b>
    Last-Modified Date/Time
    Last-Access Date/Time

<b>SFTP v4, v5</b>
    Last-Modified Date/Time
    Last-Access Date/Time
    Create Date/Time

<b>SFTP v6 (and above)</b>
    Last-Modified Date/Time
    Last-Access Date/Time
    Create Date/Time
    Read-Only Flag
    Hidden Flag
    Archive Flag
    Compressed Flag
    Encrypted Flag

Notes:
(1) The Last-Access date/time may or may not be set. Chilkat has found that the Last-Access time is set to the current date/time, which is probably a result of the operating system setting it based on when the SFTP server is touching the file.
(2) At the time of this writing, it is unknown whether the compressed/encryption settings for a local file are transferred to the remote file. For example, does the remote file become compressed and/or encrypted just by setting the flags? It may depend on the SFTP server and/or the remote filesystem.
(3) Dates/times are sent in GMT. SFTP servers should convert GMT times to local time zones.

Returns True for success, False for failure.

CopyFileAttrAsync ⁽¹⁾

Task CopyFileAttrAsync(string localFilename, string remoteFilename, bool isHandle)

Creates an asynchronous task to call the CopyFileAttr method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

CreateDir

bool CreateDir(string path)

Creates a directory on the SFTP server.

Returns True for success, False for failure.

CreateDirAsync ⁽¹⁾

Task CreateDirAsync(string path)

Creates an asynchronous task to call the CreateDir method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

Disconnect

void Disconnect()

Disconnects from the SSH server.

DownloadBd

bool DownloadBd(string remoteFilePath, BinData binData)

Introduced in version 9.5.0.62

Downloads the contents of a remote file to a BinData object. (Appends to the BinData.)

Returns True for success, False for failure.

More Information and Examples

SFTP Upload and Download to a BinData Object

DownloadBdAsync ⁽¹⁾

Task DownloadBdAsync(string remoteFilePath, BinData binData)

Introduced in version 9.5.0.62

Creates an asynchronous task to call the DownloadBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

DownloadFile

bool DownloadFile(string handle, string toFilename)

Downloads a file from the SSH server to the local filesystem. There are no limitations on file size and the data is streamed from SSH server to the local file. handle is a file handle returned by a previous call to OpenFile.

Returns True for success, False for failure.

DownloadFileAsync ⁽¹⁾

Task DownloadFileAsync(string handle, string toFilename)

Creates an asynchronous task to call the DownloadFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

DownloadFileByName

bool DownloadFileByName(string remoteFilePath, string localFilePath)

Simplified method for downloading files.

The last-modified date/time is only preserved when the PreserveDate property is set to True. (The default value of PreserveDate is False.)

Important: If the remoteFilePath is an absolute path, then it is a path from the root of the server's filesystem. For example, "/home/joe/someFile.txt". Use a relative path to specify a directory relative to the $HOME directory of the SSH user account. For example, "./someFile.txt".

Returns True for success, False for failure.

More Information and Examples

Understanding SFTP Absolute FilePaths Async SFTP Progress Info Change Remote Directory in SFTP

DownloadFileByNameAsync ⁽¹⁾

Task DownloadFileByNameAsync(string remoteFilePath, string localFilePath)

Creates an asynchronous task to call the DownloadFileByName method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

DownloadSb

bool DownloadSb(string remoteFilePath, string charset, StringBuilder sb)

Introduced in version 9.5.0.62

Downloads the contents of a remote file to a StringBuilder object. (Appends to the StringBuilder.)

Returns True for success, False for failure.

More Information and Examples

SFTP Upload and Download to a StringBuilder Object

DownloadSbAsync ⁽¹⁾

Task DownloadSbAsync(string remoteFilePath, string charset, StringBuilder sb)

Introduced in version 9.5.0.62

Creates an asynchronous task to call the DownloadSb method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

Eof

bool Eof(string handle)

Returns True if the last read operation for a handle reached the end of file. Otherwise returns False. If an invalid handle is passed, a value of True is returned.

FileExists

int FileExists(string remotePath, bool followLinks)

Introduced in version 9.5.0.67

Returns a value to indicate whether the remote file exists or not. remotePath is the path of the remote file. If followLinks is True, then symbolic links will be followed on the server.

This method returns one of the following possible values:

-1: Unable to check. Examine the LastErrorText to determine the reason for failure.
0: File does not exist.
1: The regular file exists.
2: It exists, but it is a directory.
3: It exists, but it is a symlink (only possible if followLinks is False)
4: It exists, but it is a special filesystem entry type.
5: It exists, but it is an unkown filesystem entry type.
6: It exists, but it is an socket filesystem entry type.
7: It exists, but it is an char device entry type.
8: It exists, but it is an block device entry type.
9: It exists, but it is an FIFO entry type.

Note: The values greater than zero correspond to the possible values as specified in the SFTP protocol specification. A given value may not make sense on all operating systems.

More Information and Examples

Check if File Exists

FileExistsAsync ⁽¹⁾

Task FileExistsAsync(string remotePath, bool followLinks)

Introduced in version 9.5.0.67

Creates an asynchronous task to call the FileExists method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

Fsync

bool Fsync(string handle)

Introduced in version 9.5.0.71

Causes the SFTP server to do an fsync on the open file. Specifically, this is directing the SFTP server to call fsync (https://linux.die.net/man/2/fsync) on the open file.

This method uses the fsync@openssh.com and only works for servers supporting the fsync@openssh.com extension.

Returns True for success, False for failure.

More Information and Examples

SFTP Fsync -- Flush an Open File on the Server

FsyncAsync ⁽¹⁾

Task FsyncAsync(string handle)

Introduced in version 9.5.0.71

Creates an asynchronous task to call the Fsync method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

GetFileCreateDt

CkDateTime GetFileCreateDt(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Returns the create date/time for a file. pathOrHandle may be a remote filepath or an open handle string as returned by OpenFile. If pathOrHandle is a handle, then bIsHandle must be set to True, otherwise it should be False. If bFollowLinks is True, then symbolic links will be followed on the server.

Note: Servers running the SFTP v3 protocol or lower do not have the ability to return a file's creation date/time.

Returns None on failure

GetFileCreateDtAsync ^{(1) (2)}

Task GetFileCreateDtAsync(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Creates an asynchronous task to call the GetFileCreateDt method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

GetFileCreateTimeStr

string GetFileCreateTimeStr(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

The same as GetFileCreateTime, except the date/time is returned as an RFC822 formatted string.

Returns None on failure

GetFileCreateTimeStrAsync ⁽¹⁾

Task GetFileCreateTimeStrAsync(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Creates an asynchronous task to call the GetFileCreateTimeStr method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

GetFileGroup

string GetFileGroup(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Returns the group of a file. pathOrHandle may be a remote filepath or an open handle string as returned by OpenFile. If pathOrHandle is a handle, then bIsHandle must be set to True, otherwise it should be False. If bFollowLinks is True, then symbolic links will be followed on the server.

Note: Servers running the SFTP v3 protocol or lower do not have the ability to return a file's group name. Instead, the decimal GID of the file is returned.

Returns None on failure

GetFileGroupAsync ⁽¹⁾

Task GetFileGroupAsync(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Creates an asynchronous task to call the GetFileGroup method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

GetFileLastAccessDt

CkDateTime GetFileLastAccessDt(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Returns the last-access date/time for a file. pathOrHandle may be a remote filepath or an open handle string as returned by OpenFile. If pathOrHandle is a handle, then bIsHandle must be set to True, otherwise it should be False. If bFollowLinks is True, then symbolic links will be followed on the server.

Returns None on failure

GetFileLastAccessDtAsync ^{(1) (2)}

Task GetFileLastAccessDtAsync(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Creates an asynchronous task to call the GetFileLastAccessDt method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

GetFileLastAccessStr

string GetFileLastAccessStr(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

The same as GetFileLastAccess, except the date/time is returned as an RFC822 formatted string.

Returns None on failure

GetFileLastAccessStrAsync ⁽¹⁾

Task GetFileLastAccessStrAsync(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Creates an asynchronous task to call the GetFileLastAccessStr method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

GetFileLastModifiedDt

CkDateTime GetFileLastModifiedDt(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Returns the last-modified date/time for a file. pathOrHandle may be a remote filepath or an open handle string as returned by OpenFile. If pathOrHandle is a handle, then bIsHandle must be set to True, otherwise it should be False. If bFollowLinks is True, then symbolic links will be followed on the server.

Returns None on failure

GetFileLastModifiedDtAsync ^{(1) (2)}

Task GetFileLastModifiedDtAsync(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Creates an asynchronous task to call the GetFileLastModifiedDt method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

GetFileLastModifiedStr

string GetFileLastModifiedStr(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

The same as GetFileLastModified, except the date/time is returned as an RFC822 formatted string.

Returns None on failure

GetFileLastModifiedStrAsync ⁽¹⁾

Task GetFileLastModifiedStrAsync(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Creates an asynchronous task to call the GetFileLastModifiedStr method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

GetFileOwner

string GetFileOwner(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Returns the owner of a file. pathOrHandle may be a remote filepath or an open handle string as returned by OpenFile. If pathOrHandle is a handle, then bIsHandle must be set to True, otherwise it should be False. If bFollowLinks is True, then symbolic links will be followed on the server.

Note: Servers running the SFTP v3 protocol or lower do not have the ability to return a file's owner name. Instead, the decimal UID of the file is returned.

Returns None on failure

GetFileOwnerAsync ⁽¹⁾

Task GetFileOwnerAsync(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Creates an asynchronous task to call the GetFileOwner method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

GetFilePermissions

int GetFilePermissions(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Returns the access permisssions flags of a file. pathOrHandle may be a remote filepath or an open handle string as returned by OpenFile. If pathOrHandle is a handle, then bIsHandle must be set to True, otherwise it should be False. If bFollowLinks is True, then symbolic links will be followed on the server.

More Information and Examples

SFTP Get/Set File Permission

GetFilePermissionsAsync ⁽¹⁾

Task GetFilePermissionsAsync(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Creates an asynchronous task to call the GetFilePermissions method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

GetFileSize32

int GetFileSize32(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Returns the size in bytes of a file on the SSH server. If the file size exceeds what can be represented in 32-bits, a value of -1 is returned. pathOrHandle may be a remote filepath or an open handle string as returned by OpenFile. If pathOrHandle is a handle, then bIsHandle must be set to True, otherwise it should be False. If bFollowLinks is True, then symbolic links will be followed on the server.

More Information and Examples

SFTP Get Size of File on Server

GetFileSize32Async ⁽¹⁾

Task GetFileSize32Async(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Creates an asynchronous task to call the GetFileSize32 method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

GetFileSize64

int GetFileSize64(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Returns a 64-bit integer containing the size (in bytes) of a file on the SSH server. pathOrHandle may be a remote filepath or an open handle string as returned by OpenFile. If pathOrHandle is a handle, then bIsHandle must be set to True, otherwise it should be False. If bFollowLinks is True, then symbolic links will be followed on the server.

GetFileSize64Async ⁽¹⁾

Task GetFileSize64Async(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Creates an asynchronous task to call the GetFileSize64 method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

GetFileSizeStr

string GetFileSizeStr(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Returns the size in bytes (in decimal string form) of a file on the SSH server. pathOrHandle may be a remote filepath or an open handle string as returned by OpenFile. If pathOrHandle is a handle, then bIsHandle must be set to True, otherwise it should be False. If bFollowLinks is True, then symbolic links will be followed on the server.

Note: This method exists for environments that do not have 64-bit integer support. The Add64 method is provided for 64-bit addition, and other methods such as ReadFileBytes64s allow for 64-bit values to be passed as strings.

Returns None on failure

More Information and Examples

SFTP Get Size of File on Server

GetFileSizeStrAsync ⁽¹⁾

Task GetFileSizeStrAsync(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Creates an asynchronous task to call the GetFileSizeStr method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

GetHostKeyFP

string GetHostKeyFP(string hashAlg, bool includeKeyType, bool includeHashName)

Introduced in version 9.5.0.92

Returns the host key fingerprint of the server, which is automatically set after connecting to an SSH/SFTP server. The hashAlg can be any hash algorithm supported by Chilkat, such as "SHA256", "SHA384", "SHA512", "SHA1", "MD5", "SHA3-224", "SHA3-256", "SHA3-384", "SHA3-512", etc.

If both includeKeyType and includeHashName are True, then the fingerprint string is formatted like this:

ssh-rsa SHA256:L7sQgnpnoBwRoyIYXAFBs8SdSnwtyYmhXs1p/mQDK...

If includeKeyType is True and includeHashName is False:

ssh-rsa L7sQgnpnoBwRoyIYXAFBs8SdSnwtyYmhXs1p/mQDK...

If includeKeyType is False and includeHashName is True:

SHA256:L7sQgnpnoBwRoyIYXAFBs8SdSnwtyYmhXs1p/mQDK...

If includeKeyType is False and includeHashName is False:

L7sQgnpnoBwRoyIYXAFBs8SdSnwtyYmhXs1p/mQDK...

SSH host key types can be: ssh-rsa, ecdsa-*-* (such as ecdsa-sha2-nistp256), ssh-ed25519, and ssh-dss.

Returns None on failure

More Information and Examples

SFTP Host Key Fingerprint

GetSyncedFiles

void GetSyncedFiles(StringTable strTab)

Introduced in version 10.0.0

Appends to strTab the paths of the files uploaded or downloaded in the last call to SyncTreeUpload or SyncTreeDownload. In both cases (for upload and download) each path is relative to the root synced directory.

Note: For SyncTreeDownload, some of entires can be the paths of local directories that were created. Local directory paths will be terminated with a "/" char to disinguish a directory from an actual file.

HardLink

bool HardLink(string oldPath, string newPath)

Introduced in version 9.5.0.71

Creates a hard link on the server using the hardlink@openssh.com extension. This only works for SFTP servers that support the hardlink@openssh.com extension.

Returns True for success, False for failure.

More Information and Examples

SFTP HardLink - Create a Hard Link using the hardlink@openssh.com Extension

HardLinkAsync ⁽¹⁾

Task HardLinkAsync(string oldPath, string newPath)

Introduced in version 9.5.0.71

Creates an asynchronous task to call the HardLink method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

InitializeSftp

bool InitializeSftp()

Intializes the SFTP subsystem. This should be called after connecting and authenticating. An SFTP session always begins by first calling Connect to connect to the SSH server, then calling either AuthenticatePw or AuthenticatePk to login, and finally calling InitializeSftp.

Important: When reporting problems, please send the full contents of the LastErrorText property to support@chilkatsoft.com.

If this method fails, the reason may be present in the InitializeFailCode and InitializeFailReason properties (assuming the failure occurred when trying to open the SFTP session channel).

Returns True for success, False for failure.

More Information and Examples

Error Explained: Received FAILURE response to subsystem request.

InitializeSftpAsync ⁽¹⁾

Task InitializeSftpAsync()

Creates an asynchronous task to call the InitializeSftp method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

LastJsonData

JsonObject LastJsonData()

Introduced in version 9.5.0.79

Provides information about what transpired in the last method called. For many methods, there is no information. For some methods, details about what transpired can be obtained via LastJsonData.

Returns None on failure

LastReadFailed

bool LastReadFailed(string handle)

Returns True if the last read on the specified handle failed. Otherwise returns False.

LastReadNumBytes

int LastReadNumBytes(string handle)

Returns the number of bytes received by the last read on a specified channel.

LoadTaskCaller

bool LoadTaskCaller(Task task)

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns True for success, False for failure.

OpenDir

string OpenDir(string path)

Opens a directory for reading. To get a directory listing, first open the directory by calling this method, then call ReadDir to read the directory, and finally call CloseHandle to close the directory.

The SFTP protocol represents file names as strings. File names are assumed to use the slash ('/') character as a directory separator.

File names starting with a slash are "absolute", and are relative to the root of the file system. Names starting with any other character are relative to the user's default directory (home directory). Note that identifying the user is assumed to take place outside of this protocol.

Servers SHOULD interpret a path name component ".." as referring to the parent directory, and "." as referring to the current directory.

An empty path name is valid, and it refers to the user's default directory (usually the user's home directory).

Please note: This method does NOT "change" the remote working directory. It is only a method for opening a directory for the purpose of reading the directory listing.

SFTP is Secure File Transfer over SSH. It is not the FTP protocol. There is no similarity or relationship between FTP and SFTP. Therefore, concepts such as "current remote directory" that exist in FTP do not exist with SFTP. With the SFTP protocol, the current directory will always be the home directory of the user account used during SSH/SFTP authentication. You may pass relative or absolute directory/file paths. A relative path is always relative to the home directory of the SSH user account.

Returns None on failure

More Information and Examples

Understanding SFTP Absolute FilePaths SFTP Read Directory Listing

OpenDirAsync ⁽¹⁾

Task OpenDirAsync(string path)

Creates an asynchronous task to call the OpenDir method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

OpenFile

string OpenFile(string remotePath, string access, string createDisposition)

Opens or creates a file on the remote system. Returns a handle which may be passed to methods for reading and/or writing the file. The remotePath is the remote file path (the path to the file on the server). When the application is finished with the handle, it should call CloseHandle(remotePath).

Important: If the remotePath is an absolute path, then it is a path from the root of the server's filesystem. For example, "/home/joe/someFile.txt". Use a relative path to specify a directory relative to the $HOME directory of the SSH user account. For example, "./someFile.txt".

access should be one of the following strings: "readOnly", "writeOnly", or "readWrite".

createDisposition is a comma-separated list of keywords to provide more control over how the file is opened or created. One of the following keywords must be present: "createNew", "createTruncate", "openExisting", "openOrCreate", or "truncateExisting". All other keywords are optional. The list of keywords and their meanings are shown here:

createNew
A new file is created; if the file already exists the method fails.

createTruncate
A new file is created; if the file already exists, it is opened and truncated.

openExisting
An existing file is opened. If the file does not exist the method fails.

openOrCreate
If the file exists, it is opened. If the file does not exist, it is created.

truncateExisting
An existing file is opened and truncated. If the file does not exist the method fails.

appendData
Data is always written at the end of the file. Data is not required to be appended atomically. This means that if multiple writers attempt to append data simultaneously, data from the first may be lost.

appendDataAtomic
Data is always written at the end of the file. Data MUST be written atomically so that there is no chance that multiple appenders can collide and result in data being lost.
(Only supported in SFTP protocol versions 5 and later. See the note below.)

textMode
Indicates that the server should treat the file as text and convert it to the canonical newline convention in use. When a file is opened with this flag, data is always appended to the end of the file. Servers MUST process multiple, parallel reads and writes correctly in this mode.
(Only supported in SFTP protocol versions 5 and later. See the note below.)

blockRead
The server MUST guarantee that no other handle has been opened with read access, and that no other handle will be opened with read access until the client closes the handle. (This MUST apply both to other clients and to other processes on the server.) In a nutshell, this opens the file in non-sharing mode.
(Only supported in SFTP protocol versions 5 and later. See the note below.)

blockWrite
The server MUST guarantee that no other handle has been opened with write access, and that no other handle will be opened with write access until the client closes the handle. (This MUST apply both to other clients and to other processes on the server.) In a nutshell, this opens the file in non-sharing mode.
(Only supported in SFTP protocol versions 5 and later. See the note below.)

blockDelete
The server MUST guarantee that the file itself is not deleted in any other way until the client closes the handle. No other client or process is allowed to open the file with delete access.
(Only supported in SFTP protocol versions 5 and later. See the note below.)

blockAdvisory
If set, the above "block" modes are advisory. In advisory mode, only other accesses that specify a "block" mode need be considered when determining whether the "block" can be granted, and the server need not prevent I/O operations that violate the block mode. The server MAY perform mandatory locking even if the blockAdvisory flag is set.
(Only supported in SFTP protocol versions 5 and later. See the note below.)

noFollow
If the final component of the path is a symlink, then the open MUST fail.
(Only supported in SFTP protocol versions 5 and later. See the note below.)

deleteOnClose
The file should be deleted when the last handle to it is closed. (The last handle may not be an sftp-handle.) This MAY be emulated by a server if the OS doesn't support it by deleting the file when this handle is closed.
(Only supported in SFTP protocol versions 5 and later. See the note below.)

accessAuditAlarmInfo
The client wishes the server to enable any privileges or extra capabilities that the user may have in to allow the reading and writing of AUDIT or ALARM access control entries.
(Only supported in SFTP protocol versions 5 and later. See the note below.)

accessBackup
The client wishes the server to enable any privileges or extra capabilities that the user may have in order to bypass normal access checks for the purpose of backing up or restoring files.
(Only supported in SFTP protocol versions 5 and later. See the note below.)

backupStream
This flag indicates that the client wishes to read or write a backup stream. A backup stream is a system dependent structured data stream that encodes all the information that must be preserved in order to restore the file from backup medium. The only well defined use for backup stream data read in this fashion is to write it to the same server to a file also opened using the backupStream flag. However, if the server has a well defined backup stream format, there may be other uses for this data outside the scope of this protocol.
(Only supported in SFTP protocol versions 5 and later. See the note below.)

IMPORANT: If remotePath is a filename with no path, such as "test.txt", and the server responds with a "Folder not found" error, then try prepending "./" to the remotePath. For example, instead of passing "test.txt", try "./test.txt".

IMPORTANT note about createDisposition: Many of the options, such as textMode, are not implemented in the SFTP protocol versions 3 and 4. Only SFTP servers at protocol version 5 or later support these options. You can find out the protocol version of your server by examining the value of the ProtocolVersion property after calling InitializeSftp. Also, make sure the ForceV3 property is set to False (the default value is True)

Returns None on failure

More Information and Examples

SFTP Upload from Local Filesystem Understanding SFTP Absolute FilePaths SFTP Where Did My Upload Go?Change Remote Directory in SFTP SFTP Upload Large File in Parts SFTP Server Responds with SSH_FX_NO_SUCH_FILE

OpenFileAsync ⁽¹⁾

Task OpenFileAsync(string remotePath, string access, string createDisposition)

Creates an asynchronous task to call the OpenFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

ReadDir

SFtpDir ReadDir(string handle)

Reads the contents of a directory and returns the directory listing (as an object). The handle returned by OpenDir should be passed to this method.

Returns None on failure

More Information and Examples

SFTP Read Directory Listing

ReadDirAsync ^{(1) (2)}

Task ReadDirAsync(string handle)

Creates an asynchronous task to call the ReadDir method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

ReadFileBd

bool ReadFileBd(string handle, int numBytes, BinData bd)

Introduced in version 9.5.0.77

Reads file data from a remote file on the SSH server. The handle is a file handle returned by the OpenFile method. The numBytes is the maximum number of bytes to read. If the end-of-file is reached prior to reading the number of requested bytes, then fewer bytes may be returned. The received bytes are appended to the contents of bd.

To read an entire file, one may call ReadFileBd repeatedly until Eof(handle) returns True.

ReadFileBdAsync ⁽¹⁾

Task ReadFileBdAsync(string handle, int numBytes, BinData bd)

Introduced in version 9.5.0.77

Creates an asynchronous task to call the ReadFileBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

ReadFileBytes

memoryview ReadFileBytes(string handle, int numBytes)

Reads file data from a remote file on the SSH server. The handle is a file handle returned by the OpenFile method. The numBytes is the maximum number of bytes to read. If the end-of-file is reached prior to reading the number of requested bytes, then fewer bytes may be returned.

To read an entire file, one may call ReadFileBytes repeatedly until Eof(handle) returns True.

Returns None on failure

ReadFileBytesAsync ⁽¹⁾

Task ReadFileBytesAsync(string handle, int numBytes)

Creates an asynchronous task to call the ReadFileBytes method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

ReadFileBytes32

memoryview ReadFileBytes32(string handle, int offset, int numBytes)

Reads file data from a remote file on the SSH server. The handle is a file handle returned by the OpenFile method. The offset is measured in bytes relative to the beginning of the file. (64-bit offsets are supported via the ReadFileBytes64 and ReadFileBytes64s methods.) The offset is ignored if the "textMode" flag was specified during the OpenFile. The numBytes is the maximum number of bytes to read. If the end-of-file is reached prior to reading the number of requested bytes, then fewer bytes may be returned.

Returns None on failure

ReadFileBytes32Async ⁽¹⁾

Task ReadFileBytes32Async(string handle, int offset, int numBytes)

Creates an asynchronous task to call the ReadFileBytes32 method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

ReadFileBytes64

memoryview ReadFileBytes64(string handle, int offset, int numBytes)

Reads file data from a remote file on the SSH server. The handle is a file handle returned by the OpenFile method. The offset is a 64-bit integer measured in bytes relative to the beginning of the file. The offset is ignored if the "textMode" flag was specified during the OpenFile. The numBytes is the maximum number of bytes to read. If the end-of-file is reached prior to reading the number of requested bytes, then fewer bytes may be returned.

Returns None on failure

ReadFileBytes64Async ⁽¹⁾

Task ReadFileBytes64Async(string handle, int offset, int numBytes)

Creates an asynchronous task to call the ReadFileBytes64 method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

ReadFileBytes64s

memoryview ReadFileBytes64s(string handle, string offset, int numBytes)

(This method exists for systems that do not support 64-bit integers. The 64-bit integer offset is passed as a decimal string instead.)

Reads file data from a remote file on the SSH server. The handle is a file handle returned by the OpenFile method. The offset is a 64-bit integer represented as a decimal string. It represents an offset in bytes from the beginning of the file. The offset is ignored if the "textMode" flag was specified during the OpenFile. The numBytes is the maximum number of bytes to read. If the end-of-file is reached prior to reading the number of requested bytes, then fewer bytes may be returned.

Returns None on failure

ReadFileBytes64sAsync ⁽¹⁾

Task ReadFileBytes64sAsync(string handle, string offset, int numBytes)

Creates an asynchronous task to call the ReadFileBytes64s method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

ReadFileText

string ReadFileText(string handle, int numBytes, string charset)

This method is identical to ReadFileBytes except for one thing: The bytes are interpreted according to the specified charset (i.e. the character encoding) and returned as a string. A list of supported charset values may be found on this page: Supported Charsets.

Note: If the charset is an encoding where a single character might be represented in multiple bytes (such as utf-8, Shift_JIS, etc.) then there is a risk that the very last character may be partially read. This is because the method specifies the number of bytes to read, not the number of characters. This is never a problem with character encodings that use a single byte per character, such as all of the iso-8859-* encodings, or the Windows-* encodings.

To read an entire file, one may call ReadFileText repeatedly until Eof(handle) returns True.

Returns None on failure

ReadFileTextAsync ⁽¹⁾

Task ReadFileTextAsync(string handle, int numBytes, string charset)

Creates an asynchronous task to call the ReadFileText method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

ReadFileText32

string ReadFileText32(string handle, int offset, int numBytes, string charset)

This method is identical to ReadFileBytes32 except for one thing: The bytes are interpreted according to the specified charset (i.e. the character encoding) and returned as a string. A list of supported charset values may be found on this page: Supported Charsets.

Note: If the charset is an encoding where a single character might be represented in multiple bytes (such as utf-8, Shift_JIS, etc.) then there is a risk that the very last character may be partially read. This is because the method specifies the number of bytes to read, not the number of characters. This is never a problem with character encodings that use a single byte per character, such as all of the iso-8859-* encodings, or the Windows-* encodings.

Returns None on failure

ReadFileText32Async ⁽¹⁾

Task ReadFileText32Async(string handle, int offset, int numBytes, string charset)

Creates an asynchronous task to call the ReadFileText32 method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

ReadFileText64

string ReadFileText64(string handle, int offset, int numBytes, string charset)

This method is identical to ReadFileBytes64 except for one thing: The bytes are interpreted according to the specified charset (i.e. the character encoding) and returned as a string. A list of supported charset values may be found on this page: Supported Charsets.

Note: If the charset is an encoding where a single character might be represented in multiple bytes (such as utf-8, Shift_JIS, etc.) then there is a risk that the very last character may be partially read. This is because the method specifies the number of bytes to read, not the number of characters. This is never a problem with character encodings that use a single byte per character, such as all of the iso-8859-* encodings, or the Windows-* encodings.

Returns None on failure

ReadFileText64Async ⁽¹⁾

Task ReadFileText64Async(string handle, int offset, int numBytes, string charset)

Creates an asynchronous task to call the ReadFileText64 method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

ReadFileText64s

string ReadFileText64s(string handle, string offset, int numBytes, string charset)

This method is identical to ReadFileBytes64s except for one thing: The bytes are interpreted according to the specified charset (i.e. the character encoding) and returned as a string. A list of supported charset values may be found on this page: Supported Charsets.

Note: If the charset is an encoding where a single character might be represented in multiple bytes (such as utf-8, Shift_JIS, etc.) then there is a risk that the very last character may be partially read. This is because the method specifies the number of bytes to read, not the number of characters. This is never a problem with character encodings that use a single byte per character, such as all of the iso-8859-* encodings, or the Windows-* encodings.

Returns None on failure

ReadFileText64sAsync ⁽¹⁾

Task ReadFileText64sAsync(string handle, string offset, int numBytes, string charset)

Creates an asynchronous task to call the ReadFileText64s method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

ReadLink

string ReadLink(string path)

Introduced in version 9.5.0.71

Returns the target of a symbolic link on the server. The path is the path of the symbolic link on the server.

Returns None on failure

More Information and Examples

SFTP ReadLink - Get the Target of a Symbolic Link on the Server

ReadLinkAsync ⁽¹⁾

Task ReadLinkAsync(string path)

Introduced in version 9.5.0.71

Creates an asynchronous task to call the ReadLink method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

RealPath

string RealPath(string originalPath, string composePath)

This method can be used to have the server canonicalize any given path name to an absolute path. This is useful for converting path names containing ".." components or relative pathnames without a leading slash into absolute paths. The absolute path is returned by this method.

originalPath is the first component of the path which the client wishes resolved into a absolute canonical path. This may be the entire path.

The composePath is a path which the client wishes the server to compose with the original path to form the new path. This field is optional and may be set to a zero-length string.

The server will take the originalPath and apply the composePath as a modification to it. composePath may be relative to originalPath or may be an absolute path, in which case originalPath will be discarded. The composePath may be zero length.

Note: Servers running SFTP v4 and below do not support composePath.

Returns None on failure

RealPathAsync ⁽¹⁾

Task RealPathAsync(string originalPath, string composePath)

Creates an asynchronous task to call the RealPath method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

RemoveDir

bool RemoveDir(string path)

Deletes a directory on the remote server. Most (if not all) SFTP servers require that the directorybe empty of files before it may be deleted.

Returns True for success, False for failure.

RemoveDirAsync ⁽¹⁾

Task RemoveDirAsync(string path)

Creates an asynchronous task to call the RemoveDir method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

RemoveFile

bool RemoveFile(string filename)

Deletes a file on the SFTP server.

Returns True for success, False for failure.

More Information and Examples

Understanding SFTP Absolute FilePaths

RemoveFileAsync ⁽¹⁾

Task RemoveFileAsync(string filename)

Creates an asynchronous task to call the RemoveFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

RenameFileOrDir

bool RenameFileOrDir(string oldPath, string newPath)

Renames a file or directory on the SFTP server. This is the equivalent of moving a file. To move a file from one directory to another, call this method where oldPath is the path of the existing file, and newPath is the path where the file is to be moved. For example, rename a file from "someDirA/filename" to "someDirB/abc/xyz/filename".

Returns True for success, False for failure.

RenameFileOrDirAsync ⁽¹⁾

Task RenameFileOrDirAsync(string oldPath, string newPath)

Creates an asynchronous task to call the RenameFileOrDir method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

ResumeDownloadFileByName

bool ResumeDownloadFileByName(string remoteFilePath, string localFilePath)

Resumes an SFTP download. The size of the localFilePath is checked and the download begins at the appropriate position in the remoteFilePath. If localFilePath is empty or non-existent, then this method is identical to DownloadFileByName. If the localFilePath is already fully downloaded, then no additional data is downloaded and the method will return True.

Returns True for success, False for failure.

More Information and Examples

SFTP Resume Download Example

ResumeDownloadFileByNameAsync ⁽¹⁾

Task ResumeDownloadFileByNameAsync(string remoteFilePath, string localFilePath)

Creates an asynchronous task to call the ResumeDownloadFileByName method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

ResumeUploadFileByName

bool ResumeUploadFileByName(string remoteFilePath, string localFilePath)

Resumes a file upload to the SFTP/SSH server. The size of the remoteFilePath is first checked to determine the starting offset for the upload. If remoteFilePath is empty or does not exist, this method is equivalent to UploadFileByName. If remoteFilePath is already fully uploaded (i.e. it's size is equal to localFilePath), then no additional bytes are uploaded and True is returned.

Returns True for success, False for failure.

More Information and Examples

SFTP Resume Upload Example

ResumeUploadFileByNameAsync ⁽¹⁾

Task ResumeUploadFileByNameAsync(string remoteFilePath, string localFilePath)

Creates an asynchronous task to call the ResumeUploadFileByName method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

SendIgnore

bool SendIgnore()

Introduced in version 9.5.0.66

Sends an IGNORE message to the SSH server. This is one way of verifying that the connection to the SSH server is open and valid. The SSH server does not respond to an IGNORE message. It simply ignores it. IGNORE messages are not associated with a channel (i.e., you do not need to first open a channel prior to sending an IGNORE message).

Returns True for success, False for failure.

SendIgnoreAsync ⁽¹⁾

Task SendIgnoreAsync()

Introduced in version 9.5.0.66

Creates an asynchronous task to call the SendIgnore method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

SetAllowedAlgorithms

bool SetAllowedAlgorithms(JsonObject json)

Introduced in version 9.5.0.99

Provides a way to specific the exact set of algorithms allowed for the connection.

Returns True for success, False for failure.

More Information and Examples

SFTP Set Allowed Algorithms

SetCreateDt

bool SetCreateDt(string pathOrHandle, bool isHandle, CkDateTime createDateTime)

Sets the create date/time for a file on the server. The pathOrHandle may be a filepath or the handle of a currently open file. isHandle should be set to True if the pathOrHandle is a handle, otherwise set isHandle to False.

Note: Servers running version 3 or lower of the SFTP protocol do not support setting the create date/time.

Returns True for success, False for failure.

SetCreateDtAsync ⁽¹⁾

Task SetCreateDtAsync(string pathOrHandle, bool isHandle, CkDateTime createDateTime)

Creates an asynchronous task to call the SetCreateDt method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

SetCreateTimeStr

bool SetCreateTimeStr(string pathOrHandle, bool bIsHandle, string dateTimeStr)

The same as SetCreateTime, except the date/time is passed as an RFC822 formatted string.

Returns True for success, False for failure.

SetCreateTimeStrAsync ⁽¹⁾

Task SetCreateTimeStrAsync(string pathOrHandle, bool bIsHandle, string dateTimeStr)

Creates an asynchronous task to call the SetCreateTimeStr method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

SetLastAccessDt

bool SetLastAccessDt(string pathOrHandle, bool isHandle, CkDateTime accessDateTime)

Sets the last-access date/time for a file on the server. The pathOrHandle may be a filepath or the handle of a currently open file. isHandle should be set to True if the pathOrHandle is a handle, otherwise set isHandle to False.

Returns True for success, False for failure.

SetLastAccessDtAsync ⁽¹⁾

Task SetLastAccessDtAsync(string pathOrHandle, bool isHandle, CkDateTime accessDateTime)

Creates an asynchronous task to call the SetLastAccessDt method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

SetLastAccessTimeStr

bool SetLastAccessTimeStr(string pathOrHandle, bool bIsHandle, string dateTimeStr)

The same as SetLastAccessTime, except the date/time is passed as an RFC822 formatted string.

Returns True for success, False for failure.

SetLastAccessTimeStrAsync ⁽¹⁾

Task SetLastAccessTimeStrAsync(string pathOrHandle, bool bIsHandle, string dateTimeStr)

Creates an asynchronous task to call the SetLastAccessTimeStr method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

SetLastModifiedDt

bool SetLastModifiedDt(string pathOrHandle, bool isHandle, CkDateTime modifiedDateTime)

Sets the last-modified date/time for a file on the server. The pathOrHandle may be a filepath or the handle of a currently open file. isHandle should be set to True if the pathOrHandle is a handle, otherwise set isHandle to False.

Returns True for success, False for failure.

SetLastModifiedDtAsync ⁽¹⁾

Task SetLastModifiedDtAsync(string pathOrHandle, bool isHandle, CkDateTime modifiedDateTime)

Creates an asynchronous task to call the SetLastModifiedDt method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

SetLastModifiedTimeStr

bool SetLastModifiedTimeStr(string pathOrHandle, bool bIsHandle, string dateTimeStr)

The same as SetLastModifiedTime, except the date/time is passed as an RFC822 formatted string.

Returns True for success, False for failure.

SetLastModifiedTimeStrAsync ⁽¹⁾

Task SetLastModifiedTimeStrAsync(string pathOrHandle, bool bIsHandle, string dateTimeStr)

Creates an asynchronous task to call the SetLastModifiedTimeStr method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

SetOwnerAndGroup

bool SetOwnerAndGroup(string pathOrHandle, bool isHandle, string owner, string group)

Sets the owner and group for a file on the server. The pathOrHandle may be a filepath or the handle of a currently open file. isHandle should be set to True if the pathOrHandle is a handle, otherwise set isHandle to False.

Note: Servers running version 3 or lower of the SFTP protocol do not support setting the owner and group.

Returns True for success, False for failure.

SetOwnerAndGroupAsync ⁽¹⁾

Task SetOwnerAndGroupAsync(string pathOrHandle, bool isHandle, string owner, string group)

Creates an asynchronous task to call the SetOwnerAndGroup method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

SetPermissions

bool SetPermissions(string pathOrHandle, bool isHandle, int permissions)

Sets the permissions for a file on the server. The pathOrHandle may be a filepath or the handle of a currently open file. isHandle should be set to True if the pathOrHandle is a handle, otherwise set isHandle to False.

Returns True for success, False for failure.

More Information and Examples

SFTP Get/Set File Permission

SetPermissionsAsync ⁽¹⁾

Task SetPermissionsAsync(string pathOrHandle, bool isHandle, int permissions)

Creates an asynchronous task to call the SetPermissions method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

StartKeyboardAuth

string StartKeyboardAuth(string login)

Introduced in version 9.5.0.88

Begins keyboard-interactive authentication with the SSH server. Returns an XML string providing the name, instruction, and prompts. The XML has the following format:

 	<infoRequest numPrompts="N">
	    <name>name_string</name>
	    <instruction>instruction_string</instruction>
	    <prompt1 echo="1_or_0">prompt_string</prompt1>
	    ...
	    <promptN echo="1_or_0">prompt_string</promptN>
	</infoRequest>

If the authentication immediately succeeds because no password is required, or immediately fails, the XML response can be:

<success>success_message</success>

or

<error>error_message</error>

Returns None on failure

StartKeyboardAuthAsync ⁽¹⁾

Task StartKeyboardAuthAsync(string login)

Introduced in version 9.5.0.88

Creates an asynchronous task to call the StartKeyboardAuth method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

SymLink

bool SymLink(string oldPath, string newPath)

Introduced in version 9.5.0.71

Create a symbolic link from oldpath to newpath on the server filesystem.

Returns True for success, False for failure.

More Information and Examples

SFTP SymLink - Create Symbolic Link on Server

SymLinkAsync ⁽¹⁾

Task SymLinkAsync(string oldPath, string newPath)

Introduced in version 9.5.0.71

Creates an asynchronous task to call the SymLink method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

SyncTreeDownload

bool SyncTreeDownload(string remoteRoot, string localRoot, int mode, bool recurse)

Downloads files from the SFTP server to a local directory tree. Synchronization modes include:

mode=0: Download all files
mode=1: Download all files that do not exist on the local filesystem.
mode=2: Download newer or non-existant files.
mode=3: Download only newer files. If a file does not already exist on the local filesystem, it is not downloaded from the server.
mode=5: Download only missing files or files with size differences.
mode=6: Same as mode 5, but also download newer files.
mode=99: Do not download files, but instead delete remote files that do not exist locally.

If recurse is False, then the remotel directory tree is not recursively descended.

Important: If the remoteRoot is an absolute path, then it is a path from the root of the server's filesystem. For example, "/home/joe/sourceDir". Use a relative path to specify a directory relative to the $HOME directory of the SSH user account. For example, "./sourceDir".

Note: After this method returns, the paths of the downloaded files are available in the SyncedFiles property.

Returns True for success, False for failure.

More Information and Examples

SFTP Download all Files in a Directory SFTP Synchronize Directory Tree - Download

SyncTreeDownloadAsync ⁽¹⁾

Task SyncTreeDownloadAsync(string remoteRoot, string localRoot, int mode, bool recurse)

Creates an asynchronous task to call the SyncTreeDownload method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

SyncTreeUpload

bool SyncTreeUpload(string localBaseDir, string remoteBaseDir, int mode, bool bRecurse)

Uploads a directory tree from the local filesystem to the SFTP server. Synchronization modes include:

mode=0: Upload all files
mode=1: Upload all files that do not exist on the server.
mode=2: Upload newer or non-existant files.
mode=3: Upload only newer files. If a file does not already exist on the server, it is not uploaded.
mode=4: transfer missing files or files with size differences.
mode=5: same as mode 4, but also newer files.

If bRecurse is False, then the local directory tree is not recursively descended.

Important: If the remoteBaseDir is an absolute path, then it is a path from the root of the server's filesystem. For example, "/home/joe/targetDir". Use a relative path to specify a directory relative to the $HOME directory of the SSH user account. For example, "./targetDir".

Note: After this method returns, the paths of the downloaded files are available in the SyncedFiles property.

Returns True for success, False for failure.

More Information and Examples

SFTP Upload - Synchronize Directory Tree

SyncTreeUploadAsync ⁽¹⁾

Task SyncTreeUploadAsync(string localBaseDir, string remoteBaseDir, int mode, bool bRecurse)

Creates an asynchronous task to call the SyncTreeUpload method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

UploadBd

bool UploadBd(BinData binData, string remoteFilePath)

Introduced in version 9.5.0.62

Uploads the contents of a BinData to a remote file.

Returns True for success, False for failure.

More Information and Examples

SFTP Upload and Download to a BinData Object

UploadBdAsync ⁽¹⁾

Task UploadBdAsync(BinData binData, string remoteFilePath)

Introduced in version 9.5.0.62

Creates an asynchronous task to call the UploadBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

UploadFile

bool UploadFile(string handle, string fromLocalFilePath)

Uploads a file from the local filesystem to the SFTP server. handle is a handle of a currently open file (obtained by calling the OpenFile method). fromLocalFilePath is the local file path of the file to be uploaded.

Returns True for success, False for failure.

More Information and Examples

SFTP Upload from Local Filesystem

UploadFileAsync ⁽¹⁾

Task UploadFileAsync(string handle, string fromLocalFilePath)

Creates an asynchronous task to call the UploadFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

UploadFileByName

bool UploadFileByName(string remoteFilePath, string localFilePath)

Simplified method for uploading a file to the SFTP/SSH server.

The last-modified date/time is only preserved if the PreserveDate property is set to True. This behavior of maintaining the last-mod date/time was introduced in v9.5.0.40.

Important: If the remoteFilePath is an absolute path, then it is a path from the root of the server's filesystem. For example, "/home/joe/someFile.txt". Use a relative path to specify a directory relative to the $HOME directory of the SSH user account. For example, "./someFile.txt".

Returns True for success, False for failure.

More Information and Examples

SFTP Simplified Upload Example Change Remote Directory in SFTP

UploadFileByNameAsync ⁽¹⁾

Task UploadFileByNameAsync(string remoteFilePath, string localFilePath)

Creates an asynchronous task to call the UploadFileByName method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

UploadSb

bool UploadSb(StringBuilder sb, string remoteFilePath, string charset, bool includeBom)

Introduced in version 9.5.0.62

Uploads the contents of a StringBuilder to a remote file.

Returns True for success, False for failure.

More Information and Examples

SFTP Upload and Download to a StringBuilder Object

UploadSbAsync ⁽¹⁾

Task UploadSbAsync(StringBuilder sb, string remoteFilePath, string charset, bool includeBom)

Introduced in version 9.5.0.62

Creates an asynchronous task to call the UploadSb method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

WriteFileBd

bool WriteFileBd(string handle, BinData bd)

Introduced in version 9.5.0.77

Appends the contents of bd to an open file. The handle is a file handle returned by the OpenFile method.

Returns True for success, False for failure.

More Information and Examples

SFTP Upload Large File in Parts

WriteFileBdAsync ⁽¹⁾

Task WriteFileBdAsync(string handle, BinData bd)

Introduced in version 9.5.0.77

Creates an asynchronous task to call the WriteFileBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

WriteFileBytes

bool WriteFileBytes(string handle, memoryview byteData)

Appends byte data to an open file. The handle is a file handle returned by the OpenFile method.

Returns True for success, False for failure.

WriteFileBytesAsync ⁽¹⁾

Task WriteFileBytesAsync(string handle, memoryview byteData)

Creates an asynchronous task to call the WriteFileBytes method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

WriteFileBytes32

bool WriteFileBytes32(string handle, int offset, memoryview data)

Writes data to an open file at a specific offset from the beginning of the file. The handle is a file handle returned by the OpenFile method. The offset is an offset from the beginning of the file.

Returns True for success, False for failure.

WriteFileBytes32Async ⁽¹⁾

Task WriteFileBytes32Async(string handle, int offset, memoryview data)

Creates an asynchronous task to call the WriteFileBytes32 method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

WriteFileBytes64

bool WriteFileBytes64(string handle, int offset64, memoryview data)

Writes data to an open file at a specific offset from the beginning of the file. The handle is a file handle returned by the OpenFile method. The offset64 is an offset from the beginning of the file.

Returns True for success, False for failure.

WriteFileBytes64Async ⁽¹⁾

Task WriteFileBytes64Async(string handle, int offset64, memoryview data)

Creates an asynchronous task to call the WriteFileBytes64 method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

WriteFileBytes64s

bool WriteFileBytes64s(string handle, string offset64, memoryview data)

Writes data to an open file at a specific offset from the beginning of the file. The handle is a file handle returned by the OpenFile method. The offset64 is an offset (in decimal string format) from the beginning of the file.

Returns True for success, False for failure.

WriteFileBytes64sAsync ⁽¹⁾

Task WriteFileBytes64sAsync(string handle, string offset64, memoryview data)

Creates an asynchronous task to call the WriteFileBytes64s method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

WriteFileText

bool WriteFileText(string handle, string charset, string textData)

Appends character data to an open file. The handle is a file handle returned by the OpenFile method. charset is a character encoding and is typically set to values such as "ansi", "utf-8", "windows-1252", etc. A list of supported character encodings is found on this page: Supported Charsets.

Note: It is necessary to specify the character encoding because in many programming languages, strings are represented as Unicode (2 bytes/char) and in most cases one does not wish to write Unicode chars to a text file (although it is possible by setting charset = "Unicode").

Returns True for success, False for failure.

WriteFileTextAsync ⁽¹⁾

Task WriteFileTextAsync(string handle, string charset, string textData)

Creates an asynchronous task to call the WriteFileText method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

WriteFileText32

bool WriteFileText32(string handle, int offset32, string charset, string textData)

Writes character data to an open file at a specific offset from the beginning of the file. The handle is a file handle returned by the OpenFile method. charset is a character encoding and is typically set to values such as "ansi", "utf-8", "windows-1252", etc. A list of supported character encodings is found on this page: Supported Charsets.

Returns True for success, False for failure.

WriteFileText32Async ⁽¹⁾

Task WriteFileText32Async(string handle, int offset32, string charset, string textData)

Creates an asynchronous task to call the WriteFileText32 method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

WriteFileText64

bool WriteFileText64(string handle, int offset64, string charset, string textData)

Writes character data to an open file at a specific offset from the beginning of the file. The handle is a file handle returned by the OpenFile method. charset is a character encoding and is typically set to values such as "ansi", "utf-8", "windows-1252", etc. A list of supported character encodings is found on this page: Supported Charsets.

Returns True for success, False for failure.

WriteFileText64Async ⁽¹⁾

Task WriteFileText64Async(string handle, int offset64, string charset, string textData)

Creates an asynchronous task to call the WriteFileText64 method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

WriteFileText64s

bool WriteFileText64s(string handle, string offset64, string charset, string textData)

Writes character data to an open file at a specific offset from the beginning of the file. The handle is a file handle returned by the OpenFile method. The offset64 is an offset (in decimal string format) from the beginning of the file. charset is a character encoding and is typically set to values such as "ansi", "utf-8", "windows-1252", etc. A list of supported character encodings is found on this page: Supported Charsets.

Returns True for success, False for failure.

WriteFileText64sAsync ⁽¹⁾

Task WriteFileText64sAsync(string handle, string offset64, string charset, string textData)

Creates an asynchronous task to call the WriteFileText64s method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure