SFTPClient Component

Properties   Methods   Events   Config Settings   Errors  

The SFTPClient class can be used to transfer files to and from secure file transfer protocol (SFTP) servers.

Syntax

ipworksedi.SFTPClient

Remarks

The SFTPClient struct is the Secure Shell (SSH)-enabled equivalent of the IPWorks FTP struct. The SSHHost and SSHPort properties specify which Secure Shell (SSH) server to use. The SSHUser and SSHPassword properties allow the client to authenticate itself with the server. The SSHServerAuthentication event or SSHAcceptServerHostKey property allow you to check the server identity. Finally, the SSHStatus event provides information about the SSH handshake.

The SFTPClient struct implements a standard SSH file transfer client.

The first step in using the struct is specifying the SSHHost, SSHUser, and SSHPassword. The file to upload to or download from is given by the RemoteFile property. The file to download to or upload from is specified by LocalFile. The current path in the server is specified by the RemotePath property.

If LocalFile is set to something other than an empty string, then files are received in LocalFile; otherwise, the data are received through the Transfer event. StartTransfer and EndTransfer are fired at the beginning and end of transmission.

Directory listings are received through the DirList event.

Property List

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

Method List

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

Event List

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

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

Connected Property (SFTPClient Component)

Whether the class is connected.

Syntax

func (obj *SFTPClient) Connected() (bool, error)

Default Value

false

Remarks

This property is used to determine whether or not the struct is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

This property is read-only.

Data Type

bool

DirListCount Property (SFTPClient Component)

The number of records in the DirList arrays.

Syntax

func (obj *SFTPClient) DirListCount() (int32, error)

Default Value

0

Remarks

This property controls the size of the following arrays:

• DirListEntry
• DirListFileName
• DirListFileSize
• DirListFileTime
• DirListIsDir
• DirListIsSymlink

The array indices start at 0 and end at DirListCount - 1.

This property is read-only.

Data Type

int32

DirListEntry Property (SFTPClient Component)

This property contains the raw entry as received from the server.

Syntax

func (obj *SFTPClient) DirListEntry(EntryIndex int32) (string, error)

Default Value

""

Remarks

This property contains the raw entry as received from the server. It is the complete unparsed entry in the directory listing.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

This property is read-only.

Data Type

string

DirListFileName Property (SFTPClient Component)

This property shows the file name in the last directory listing.

Syntax

func (obj *SFTPClient) DirListFileName(EntryIndex int32) (string, error)

Default Value

""

Remarks

This property shows the file name in the last directory listing. This also may be the directory name if a directory is being listed. You can tell whether it is a file or a directory by the Boolean DirListIsDir property.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

This property is read-only.

Data Type

string

DirListFileSize Property (SFTPClient Component)

This property shows the file size in the last directory listing.

Syntax

func (obj *SFTPClient) DirListFileSize(EntryIndex int32) (int64, error)

Default Value

0

Remarks

This property shows the file size in the last directory listing.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

This property is read-only.

Data Type

int64

DirListFileTime Property (SFTPClient Component)

This property shows the file time in the last directory listing.

Syntax

func (obj *SFTPClient) DirListFileTime(EntryIndex int32) (string, error)

Default Value

""

Remarks

This property shows the file time in the last directory listing. This contains the date/time stamp in which the file was created.

NOTE: In Unix systems, the date is given in two types of formats: If the date is in the past 12 months, the exact time is specified and the year is omitted. Otherwise, only the date and the year, but not hours or minutes, are given.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

This property is read-only.

Data Type

string

DirListIsDir Property (SFTPClient Component)

This property specifies whether entries in the last directory listing are directories.

Syntax

func (obj *SFTPClient) DirListIsDir(EntryIndex int32) (bool, error)

Default Value

false

Remarks

This property specifies whether entries in the last directory listing are directories. This Boolean value denotes whether or not the directory entry listed in DirListFileName is a file or a directory.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

This property is read-only.

Data Type

bool

DirListIsSymlink Property (SFTPClient Component)

This property indicates whether the entry is a symbolic link.

Syntax

func (obj *SFTPClient) DirListIsSymlink(EntryIndex int32) (bool, error)

Default Value

false

Remarks

This property indicates whether the entry is a symbolic link. When the entry is a symbolic link, the value of DirListIsDir will always be False because this information is not returned in the directory listing. To inspect a symlink to determine if it is a link to a file or a folder, set RemoteFile and query the FileAttributes.FileIsDir property.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

This property is read-only.

Data Type

bool

FileAccessTime Property (SFTPClient Component)

Contains the number of milliseconds since 12:00:00 AM, January 1, 1970, when this file was last accessed.

Syntax

func (obj *SFTPClient) FileAccessTime() (int64, error)
func (obj *SFTPClient) SetFileAccessTime(value int64) error

Default Value

0

Remarks

Contains the number of milliseconds since 12:00:00 AM, January 1, 1970, when this file was last accessed.

Data Type

int64

FileACL Property (SFTPClient Component)

Contains a string containing an access control list (ACL).

Syntax

func (obj *SFTPClient) FileACL() (string, error)
func (obj *SFTPClient) SetFileACL(value string) error

Default Value

""

Remarks

Contains a string containing an access control list (ACL).

Data Type

string

FileAllocationSize Property (SFTPClient Component)

Specifies the size, in bytes, that this file consumes on disk.

Syntax

func (obj *SFTPClient) FileAllocationSize() (int64, error)

Default Value

0

Remarks

Specifies the size, in bytes, that this file consumes on disk.

This property is read-only.

Data Type

int64

FileAttributeBits Property (SFTPClient Component)

AttributeBits and AttributeBitsValid each contain a bitmask representing attributes of the file on the secure file transfer protocol (SFTP) server.

Syntax

func (obj *SFTPClient) FileAttributeBits() (int32, error)

Default Value

0

Remarks

FileAttributeBits and FileAttributeBitsValid each contain a bitmask representing attributes of the file on the secure file transfer protocol (SFTP) server. These two values must be interpreted together. Any value present in FileAttributeBitsValid must be ignored in FileAttributeBits. This is done so that the server and client can communicate the attributes they know about without confusing any bits they do not understand.

This field can have one or more of the following values ORed together:

• 0x00000001 (SSH_FILEXFER_ATTR_FLAGS_READONLY)
• 0x00000002 (SSH_FILEXFER_ATTR_FLAGS_SYSTEM)
• 0x00000004 (SSH_FILEXFER_ATTR_FLAGS_HIDDEN)
• 0x00000008 (SSH_FILEXFER_ATTR_FLAGS_CASE_INSENSITIVE)
• 0x00000010 (SSH_FILEXFER_ATTR_FLAGS_ARCHIVE)
• 0x00000020 (SSH_FILEXFER_ATTR_FLAGS_ENCRYPTED)
• 0x00000040 (SSH_FILEXFER_ATTR_FLAGS_COMPRESSED)
• 0x00000080 (SSH_FILEXFER_ATTR_FLAGS_SPARSE)
• 0x00000100 (SSH_FILEXFER_ATTR_FLAGS_APPEND_ONLY)
• 0x00000200 (SSH_FILEXFER_ATTR_FLAGS_IMMUTABLE)
• 0x00000400 (SSH_FILEXFER_ATTR_FLAGS_SYNC)
• 0x00000800 (SSH_FILEXFER_ATTR_FLAGS_TRANSLATION_ERR)

This property is read-only.

Data Type

int32

FileAttributeBitsValid Property (SFTPClient Component)

AttributeBits and AttributeBitsValid each contain a bitmask representing attributes of the file on the secure file transfer protocol (SFTP) server.

Syntax

func (obj *SFTPClient) FileAttributeBitsValid() (int32, error)

Default Value

0

Remarks

FileAttributeBits and FileAttributeBitsValid each contain a bitmask representing attributes of the file on the secure file transfer protocol (SFTP) server. These two values must be interpreted together. Any value present in FileAttributeBitsValid must be ignored in FileAttributeBits. This is done so that the server and client can communicate the attributes they know about without confusing any bits they do not understand.

This field can have one or more of the following values ORed together:

• 0x00000001 (SSH_FILEXFER_ATTR_FLAGS_READONLY)
• 0x00000002 (SSH_FILEXFER_ATTR_FLAGS_SYSTEM)
• 0x00000004 (SSH_FILEXFER_ATTR_FLAGS_HIDDEN)
• 0x00000008 (SSH_FILEXFER_ATTR_FLAGS_CASE_INSENSITIVE)
• 0x00000010 (SSH_FILEXFER_ATTR_FLAGS_ARCHIVE)
• 0x00000020 (SSH_FILEXFER_ATTR_FLAGS_ENCRYPTED)
• 0x00000040 (SSH_FILEXFER_ATTR_FLAGS_COMPRESSED)
• 0x00000080 (SSH_FILEXFER_ATTR_FLAGS_SPARSE)
• 0x00000100 (SSH_FILEXFER_ATTR_FLAGS_APPEND_ONLY)
• 0x00000200 (SSH_FILEXFER_ATTR_FLAGS_IMMUTABLE)
• 0x00000400 (SSH_FILEXFER_ATTR_FLAGS_SYNC)
• 0x00000800 (SSH_FILEXFER_ATTR_FLAGS_TRANSLATION_ERR)

This property is read-only.

Data Type

int32

FileCreationTime Property (SFTPClient Component)

Specifies the number of milliseconds since 12:00:00 AM, January 1, 1970, when this file was created.

Syntax

func (obj *SFTPClient) FileCreationTime() (int64, error)
func (obj *SFTPClient) SetFileCreationTime(value int64) error

Default Value

0

Remarks

Specifies the number of milliseconds since 12:00:00 AM, January 1, 1970, when this file was created.

Data Type

int64

FileType Property (SFTPClient Component)

The type of file.

Syntax

func (obj *SFTPClient) FileType() (int32, error)

Possible Values

1   // Regular
2   // Directory
3   // SymLink
4   // Special
5   // Unknown
6   // Socket
7   // CharDevice
8   // BlockDevice
9   // FIFO

Default Value

0

Remarks

The type of file. FileType may be one of the following values:

This property is read-only.

Data Type

int32

FileGroupId Property (SFTPClient Component)

Specifies the Id of the group that has access rights this file.

Syntax

func (obj *SFTPClient) FileGroupId() (string, error)
func (obj *SFTPClient) SetFileGroupId(value string) error

Default Value

""

Remarks

Specifies the Id of the group that has access rights this file.

Data Type

string

FileIsDir Property (SFTPClient Component)

Specifies whether or not the file represented by these attributes is a directory.

Syntax

func (obj *SFTPClient) FileIsDir() (bool, error)

Default Value

false

Remarks

Specifies whether or not the file represented by these attributes is a directory.

This property is read-only.

Data Type

bool

FileIsSymlink Property (SFTPClient Component)

Specifies whether or not the file or directory represented by these attributes is a symbolic link.

Syntax

func (obj *SFTPClient) FileIsSymlink() (bool, error)

Default Value

false

Remarks

Specifies whether or not the file or directory represented by these attributes is a symbolic link. This setting is applicable only when GetSymlinkAttrs is set to True. By default, the attributes of the actual file referred to by the link (not the symbolic link) are returned and this property will always be False.

This property is read-only.

Data Type

bool

FileModifiedTime Property (SFTPClient Component)

Specifies the number of milliseconds since 12:00:00 AM, January 1, 1970, that this file was last modified.

Syntax

func (obj *SFTPClient) FileModifiedTime() (int64, error)
func (obj *SFTPClient) SetFileModifiedTime(value int64) error

Default Value

0

Remarks

Specifies the number of milliseconds since 12:00:00 AM, January 1, 1970, that this file was last modified.

Data Type

int64

FileOwnerId Property (SFTPClient Component)

Specifies the user Id of this file's owner.

Syntax

func (obj *SFTPClient) FileOwnerId() (string, error)
func (obj *SFTPClient) SetFileOwnerId(value string) error

Default Value

""

Remarks

Specifies the user Id of this file's owner.

Data Type

string

FilePermissions Property (SFTPClient Component)

Includes a 32-bit integer containing the a POSIX-compatible file permission bitmask.

Syntax

func (obj *SFTPClient) FilePermissions() (int32, error)
func (obj *SFTPClient) SetFilePermissions(value int32) error

Default Value

0

Remarks

Includes a 32-bit integer containing the a POSIX-compatible file permission bitmask.

The bitmask should be interpreted as a decimal value of a series of octal digits. For example, an octal permission value of "100644" would be "33188" in Base10, and "40755" in octal would be "16877" in Base10.

The last three octal digits are the most significant and represent, in order, the file access capabilities of the file's owner, the owner's group, and other users. Each of these octal digits is, on its own, a 3-bit bitmask with the following possible values:

An octal permission digit of 7 would have all three values set and would mean that the file can be read, written, and executed by that user class. For example, the octal permissions "100644" would have a value "6" for the owner, "4" for the group, and "4" for other users. This would be interpreted to mean that all users can read the file, no users can execute it, and only the owner can write it. The permissions "40755" would mean that all users can read and execute the file, but only the owner can write it.

The previous octal digit is another bitmask with the following values:

The previous two octal digits are used together as a bitmask to determine the type of file. This bitmask has the following values:

For example, the octal file permissions "100644" would indicate a regular file and octal "40755" would indicate a directory.

NOTE: You will need to convert the octal permissions bitmask into its decimal representation.

Data Type

int32

FilePermissionsOctal Property (SFTPClient Component)

Includes an octal string containing the a POSIX-compatible file permission bitmask.

Syntax

func (obj *SFTPClient) FilePermissionsOctal() (string, error)
func (obj *SFTPClient) SetFilePermissionsOctal(value string) error

Default Value

""

Remarks

Includes an octal string containing the a POSIX-compatible file permission bitmask.

The bitmask should be interpreted as a series of octal digits. For example, "100644" and "40755".

The last three octal digits are the most significant and represent, in order, the file access capabilities of the file's owner, the owner's group, and other users. Each of these octal digits is, on its own, a 3-bit bitmask with the following possible values:

An octal permission digit of 7 would have all three values set and would mean that the file can be read, written, and executed by that user class. For example, the octal permissions "100644" would have a value "6" for the owner, "4" for the group, and "4" for other users. This would be interpreted to mean that all users can read the file, no users can execute it, and only the owner can write it. The permissions "40755" would mean that all users can read and execute the file, but only the owner can write it.

The previous octal digit is another bitmask with the following values:

The previous two octal digits are used together as a bitmask to determine the type of file. This bitmask has the following values:

For example, the octal file permissions "100644" would indicate a regular file and octal "40755" would indicate a directory.

Data Type

string

FileSize Property (SFTPClient Component)

Specifies the total size, in bytes, of this file.

Syntax

func (obj *SFTPClient) FileSize() (int64, error)

Default Value

0

Remarks

Specifies the total size, in bytes, of this file.

This property is read-only.

Data Type

int64

FirewallAutoDetect Property (SFTPClient Component)

Whether to automatically detect and use firewall system settings, if available.

Syntax

func (obj *SFTPClient) FirewallAutoDetect() (bool, error)
func (obj *SFTPClient) SetFirewallAutoDetect(value bool) error

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

bool

FirewallType Property (SFTPClient Component)

The type of firewall to connect through.

Syntax

func (obj *SFTPClient) FirewallType() (int32, error)
func (obj *SFTPClient) SetFirewallType(value int32) error

Possible Values

0   // None
1   // Tunnel
2   // SOCKS4
3   // SOCKS5
10   // SOCKS4A

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

int32

FirewallHost Property (SFTPClient Component)

The name or IP address of the firewall (optional).

Syntax

func (obj *SFTPClient) FirewallHost() (string, error)
func (obj *SFTPClient) SetFirewallHost(value string) error

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the struct fails with an error.

Data Type

string

FirewallPassword Property (SFTPClient Component)

A password if authentication is to be used when connecting through the firewall.

Syntax

func (obj *SFTPClient) FirewallPassword() (string, error)
func (obj *SFTPClient) SetFirewallPassword(value string) error

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error.

Data Type

string

FirewallPort Property (SFTPClient Component)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

func (obj *SFTPClient) FirewallPort() (int32, error)
func (obj *SFTPClient) SetFirewallPort(value int32) error

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

NOTE: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

int32

FirewallUser Property (SFTPClient Component)

A username if authentication is to be used when connecting through a firewall.

Syntax

func (obj *SFTPClient) FirewallUser() (string, error)
func (obj *SFTPClient) SetFirewallUser(value string) error

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the struct fails with an error.

Data Type

string

Idle Property (SFTPClient Component)

The current status of the class.

Syntax

func (obj *SFTPClient) Idle() (bool, error)

Default Value

true

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

bool

LocalFile Property (SFTPClient Component)

The path to a local file for upload or download.

Syntax

func (obj *SFTPClient) LocalFile() (string, error)
func (obj *SFTPClient) SetLocalFile(value string) error

Default Value

""

Remarks

The LocalFile property is used by the Upload and Download methods. The file will be overwritten only if the Overwrite property is set to True.

Example. Setting LocalFile:

SFTPControl.Localfile = "C:\localfile.txt" SFTPControl.RemoteFile = "remotefile.txt" SFTPControl.Download() SFTPControl.Localfile = "C:\localfile2.txt" SFTPControl.RemoteFile = "folder/remotefile2.txt" SFTPControl.Download()

Data Type

string

LocalHost Property (SFTPClient Component)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

func (obj *SFTPClient) LocalHost() (string, error)
func (obj *SFTPClient) SetLocalHost(value string) error

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the struct is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

string

LocalPort Property (SFTPClient Component)

The TCP port in the local host where the class binds.

Syntax

func (obj *SFTPClient) LocalPort() (int32, error)
func (obj *SFTPClient) SetLocalPort(value int32) error

Default Value

0

Remarks

This property must be set before a connection is attempted. It instructs the struct to bind to a specific port (or communication endpoint) in the local machine.

Setting this property to 0 (default) enables the system to choose an open port at random. The chosen port will be returned by the LocalPort property after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error.

This property is useful when trying to connect to services that require a trusted port on the client side.

Data Type

int32

Overwrite Property (SFTPClient Component)

The value indicating whether or not the class should overwrite files during transfer.

Syntax

func (obj *SFTPClient) Overwrite() (bool, error)
func (obj *SFTPClient) SetOverwrite(value bool) error

Default Value

false

Remarks

This property is a value indicating whether or not the struct should overwrite LocalFile when downloading and RemoteFile when uploading. If Overwrite is False, an error will be thrown whenever LocalFile exists before a download operation.

Data Type

bool

RemoteFile Property (SFTPClient Component)

The name of the remote file for uploading or downloading.

Syntax

func (obj *SFTPClient) RemoteFile() (string, error)
func (obj *SFTPClient) SetRemoteFile(value string) error

Default Value

""

Remarks

The RemoteFile is either an absolute file path or a relative path based on RemotePath.

A number of methods use RemoteFile as an argument.

Example 1. Setting RemoteFile:

SFTPControl.Localfile = "C:\localfile.txt" SFTPControl.RemoteFile = "remotefile.txt" SFTPControl.Download() SFTPControl.Localfile = "C:\localfile2.txt" SFTPControl.RemoteFile = "folder/remotefile2.txt" SFTPControl.Download()

NOTE: This property will also act as a file mask when performing ListDirectory.

Example 2. Using RemoteFile as a File Mask: SFTPControl.RemoteFile = "*.txt" SFTPControl.ListDirectory()

The following special characters are supported for pattern matching:

If these characters need to be used as a literal in a pattern, then they must be escaped by surrounding them with brackets []. NOTE: "]" and "-" do not need to be escaped. See below for the escape sequences:

For example, to match the value [Something].txt, specify the pattern [[]Something].txt.

Data Type

string

RemotePath Property (SFTPClient Component)

The current path in the secure file transfer protocol (SFTP) server.

Syntax

func (obj *SFTPClient) RemotePath() (string, error)

Default Value

""

Remarks

The RemotePath shows the current working directory on the SFTP server. The ChangeRemotePath method can be used to change the working directory to an absolute directory path or to a relative path with respect to the current value of RemotePath.

Example. Changing Directory:

sftp1.SSHLogon("sftp.server.net", 22); sftp1.ChangeRemotePath("/home/user");

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyEffectiveDate Property (SFTPClient Component)

The date on which this certificate becomes valid.

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeyEffectiveDate() (string, error)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyExpirationDate Property (SFTPClient Component)

The date on which the certificate expires.

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeyExpirationDate() (string, error)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyExtendedKeyUsage Property (SFTPClient Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeyExtendedKeyUsage() (string, error)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyFingerprint Property (SFTPClient Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeyFingerprint() (string, error)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyFingerprintSHA1 Property (SFTPClient Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeyFingerprintSHA1() (string, error)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyFingerprintSHA256 Property (SFTPClient Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeyFingerprintSHA256() (string, error)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyIssuer Property (SFTPClient Component)

The issuer of the certificate.

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeyIssuer() (string, error)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyPrivateKey Property (SFTPClient Component)

The private key of the certificate (if available).

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeyPrivateKey() (string, error)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The SSHAcceptServerHostKeyPrivateKey may be available but not exportable. In this case, SSHAcceptServerHostKeyPrivateKey returns an empty string.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyPrivateKeyAvailable Property (SFTPClient Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeyPrivateKeyAvailable() (bool, error)

Default Value

false

Remarks

Whether a SSHAcceptServerHostKeyPrivateKey is available for the selected certificate. If SSHAcceptServerHostKeyPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

SSHAcceptServerHostKeyPrivateKeyContainer Property (SFTPClient Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeyPrivateKeyContainer() (string, error)

Default Value

""

Remarks

The name of the SSHAcceptServerHostKeyPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyPublicKey Property (SFTPClient Component)

The public key of the certificate.

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeyPublicKey() (string, error)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyPublicKeyAlgorithm Property (SFTPClient Component)

The textual description of the certificate's public key algorithm.

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeyPublicKeyAlgorithm() (string, error)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyPublicKeyLength Property (SFTPClient Component)

The length of the certificate's public key (in bits).

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeyPublicKeyLength() (int32, error)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

int32

SSHAcceptServerHostKeySerialNumber Property (SFTPClient Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeySerialNumber() (string, error)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeySignatureAlgorithm Property (SFTPClient Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeySignatureAlgorithm() (string, error)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyStore Property (SFTPClient Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeyStore() ([]byte, error)
func (obj *SFTPClient) SetSSHAcceptServerHostKeyStore(value []byte) error

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSHAcceptServerHostKeyStoreType property denotes the type of the certificate store specified by SSHAcceptServerHostKeyStore. If the store is password-protected, specify the password in SSHAcceptServerHostKeyStorePassword.

SSHAcceptServerHostKeyStore is used in conjunction with the SSHAcceptServerHostKeySubject property to specify client certificates. If SSHAcceptServerHostKeyStore has a value, and SSHAcceptServerHostKeySubject or SSHAcceptServerHostKeyEncoded is set, a search for a certificate is initiated. Please see the SSHAcceptServerHostKeySubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

[]byte

SSHAcceptServerHostKeyStorePassword Property (SFTPClient Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeyStorePassword() (string, error)
func (obj *SFTPClient) SetSSHAcceptServerHostKeyStorePassword(value string) error

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

string

SSHAcceptServerHostKeyStoreType Property (SFTPClient Component)

The type of certificate store for this certificate.

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeyStoreType() (int32, error)
func (obj *SFTPClient) SetSSHAcceptServerHostKeyStoreType(value int32) error

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

int32

SSHAcceptServerHostKeySubjectAltNames Property (SFTPClient Component)

Comma-separated lists of alternative subject names for the certificate.

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeySubjectAltNames() (string, error)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyThumbprintMD5 Property (SFTPClient Component)

The MD5 hash of the certificate.

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeyThumbprintMD5() (string, error)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyThumbprintSHA1 Property (SFTPClient Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeyThumbprintSHA1() (string, error)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyThumbprintSHA256 Property (SFTPClient Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeyThumbprintSHA256() (string, error)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyUsage Property (SFTPClient Component)

The text description of UsageFlags .

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeyUsage() (string, error)

Default Value

""

Remarks

The text description of SSHAcceptServerHostKeyUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyUsageFlags Property (SFTPClient Component)

The flags that show intended use for the certificate.

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeyUsageFlags() (int32, error)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSHAcceptServerHostKeyUsageFlags is a combination of the following flags:

Please see the SSHAcceptServerHostKeyUsage property for a text representation of SSHAcceptServerHostKeyUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

int32

SSHAcceptServerHostKeyVersion Property (SFTPClient Component)

The certificate's version number.

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeyVersion() (string, error)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

string

SSHAcceptServerHostKeySubject Property (SFTPClient Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeySubject() (string, error)
func (obj *SFTPClient) SetSSHAcceptServerHostKeySubject(value string) error

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

string

SSHAcceptServerHostKeyEncoded Property (SFTPClient Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *SFTPClient) SSHAcceptServerHostKeyEncoded() ([]byte, error)
func (obj *SFTPClient) SetSSHAcceptServerHostKeyEncoded(value []byte) error

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSHAcceptServerHostKeyStore and SSHAcceptServerHostKeySubject properties also may be used to specify a certificate.

When SSHAcceptServerHostKeyEncoded is set, a search is initiated in the current SSHAcceptServerHostKeyStore for the private key of the certificate. If the key is found, SSHAcceptServerHostKeySubject is updated to reflect the full subject of the selected certificate; otherwise, SSHAcceptServerHostKeySubject is set to an empty string.

Data Type

[]byte

SSHAuthMode Property (SFTPClient Component)

The authentication method to be used with the class when calling SSHLogon .

Syntax

func (obj *SFTPClient) SSHAuthMode() (int32, error)
func (obj *SFTPClient) SetSSHAuthMode(value int32) error

Possible Values

0   // None
1   // MultiFactor
2   // Password
3   // PublicKey
4   // KeyboardInteractive
5   // GSSAPIWithMic
6   // GSSAPIKeyex
99   // Custom

Default Value

2

Remarks

The Secure Shell (SSH) Authentication specification (RFC 4252) specifies multiple methods by which a user can be authenticated by an SSH server. When a call is made to SSHLogon, the struct will connect to the SSH server and establish the security layer. After the connection has been secured, the client will send an authentication request to the SSHHost containing the SSHUser. The server will respond containing a list of methods by which that user may be authenticated.

The struct will attempt to authenticate the user by one of those methods based on the value of SSHAuthMode and other property values supplied by the user. Currently, the struct supports the following authentication methods:

Example 1. User/Password Authentication: Control.SSHAuthMode = SftpSSHAuthModes.amPassword Control.SSHUser = "username" Control.SSHPassword = "password" Control.SSHLogon("server", 22) Example 2. Public Key Authentication: Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey Control.SSHUser = "username" Control.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile; Control.SSHCertStore = "cert.pfx"; Control.SSHCertStorePassword = "certpassword"; Control.SSHCertSubject = "*"; Control.SSHLogon("server", 22)

Data Type

int32

SSHCertEffectiveDate Property (SFTPClient Component)

The date on which this certificate becomes valid.

Syntax

func (obj *SFTPClient) SSHCertEffectiveDate() (string, error)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

string

SSHCertExpirationDate Property (SFTPClient Component)

The date on which the certificate expires.

Syntax

func (obj *SFTPClient) SSHCertExpirationDate() (string, error)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

string

SSHCertExtendedKeyUsage Property (SFTPClient Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *SFTPClient) SSHCertExtendedKeyUsage() (string, error)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

string

SSHCertFingerprint Property (SFTPClient Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

func (obj *SFTPClient) SSHCertFingerprint() (string, error)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

string

SSHCertFingerprintSHA1 Property (SFTPClient Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

func (obj *SFTPClient) SSHCertFingerprintSHA1() (string, error)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

string

SSHCertFingerprintSHA256 Property (SFTPClient Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

func (obj *SFTPClient) SSHCertFingerprintSHA256() (string, error)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

string

SSHCertIssuer Property (SFTPClient Component)

The issuer of the certificate.

Syntax

func (obj *SFTPClient) SSHCertIssuer() (string, error)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

string

SSHCertPrivateKey Property (SFTPClient Component)

The private key of the certificate (if available).

Syntax

func (obj *SFTPClient) SSHCertPrivateKey() (string, error)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The SSHCertPrivateKey may be available but not exportable. In this case, SSHCertPrivateKey returns an empty string.

This property is read-only.

Data Type

string

SSHCertPrivateKeyAvailable Property (SFTPClient Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *SFTPClient) SSHCertPrivateKeyAvailable() (bool, error)

Default Value

false

Remarks

Whether a SSHCertPrivateKey is available for the selected certificate. If SSHCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

SSHCertPrivateKeyContainer Property (SFTPClient Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

func (obj *SFTPClient) SSHCertPrivateKeyContainer() (string, error)

Default Value

""

Remarks

The name of the SSHCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

string

SSHCertPublicKey Property (SFTPClient Component)

The public key of the certificate.

Syntax

func (obj *SFTPClient) SSHCertPublicKey() (string, error)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

string

SSHCertPublicKeyAlgorithm Property (SFTPClient Component)

The textual description of the certificate's public key algorithm.

Syntax

func (obj *SFTPClient) SSHCertPublicKeyAlgorithm() (string, error)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SSHCertPublicKeyLength Property (SFTPClient Component)

The length of the certificate's public key (in bits).

Syntax

func (obj *SFTPClient) SSHCertPublicKeyLength() (int32, error)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

int32

SSHCertSerialNumber Property (SFTPClient Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *SFTPClient) SSHCertSerialNumber() (string, error)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

string

SSHCertSignatureAlgorithm Property (SFTPClient Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *SFTPClient) SSHCertSignatureAlgorithm() (string, error)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SSHCertStore Property (SFTPClient Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *SFTPClient) SSHCertStore() ([]byte, error)
func (obj *SFTPClient) SetSSHCertStore(value []byte) error

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSHCertStoreType property denotes the type of the certificate store specified by SSHCertStore. If the store is password-protected, specify the password in SSHCertStorePassword.

SSHCertStore is used in conjunction with the SSHCertSubject property to specify client certificates. If SSHCertStore has a value, and SSHCertSubject or SSHCertEncoded is set, a search for a certificate is initiated. Please see the SSHCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

[]byte

SSHCertStorePassword Property (SFTPClient Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

func (obj *SFTPClient) SSHCertStorePassword() (string, error)
func (obj *SFTPClient) SetSSHCertStorePassword(value string) error

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

string

SSHCertStoreType Property (SFTPClient Component)

The type of certificate store for this certificate.

Syntax

func (obj *SFTPClient) SSHCertStoreType() (int32, error)
func (obj *SFTPClient) SetSSHCertStoreType(value int32) error

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

int32

SSHCertSubjectAltNames Property (SFTPClient Component)

Comma-separated lists of alternative subject names for the certificate.

Syntax

func (obj *SFTPClient) SSHCertSubjectAltNames() (string, error)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

string

SSHCertThumbprintMD5 Property (SFTPClient Component)

The MD5 hash of the certificate.

Syntax

func (obj *SFTPClient) SSHCertThumbprintMD5() (string, error)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSHCertThumbprintSHA1 Property (SFTPClient Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *SFTPClient) SSHCertThumbprintSHA1() (string, error)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSHCertThumbprintSHA256 Property (SFTPClient Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *SFTPClient) SSHCertThumbprintSHA256() (string, error)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSHCertUsage Property (SFTPClient Component)

The text description of UsageFlags .

Syntax

func (obj *SFTPClient) SSHCertUsage() (string, error)

Default Value

""

Remarks

The text description of SSHCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

string

SSHCertUsageFlags Property (SFTPClient Component)

The flags that show intended use for the certificate.

Syntax

func (obj *SFTPClient) SSHCertUsageFlags() (int32, error)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSHCertUsageFlags is a combination of the following flags:

Please see the SSHCertUsage property for a text representation of SSHCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

int32

SSHCertVersion Property (SFTPClient Component)

The certificate's version number.

Syntax

func (obj *SFTPClient) SSHCertVersion() (string, error)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

string

SSHCertSubject Property (SFTPClient Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *SFTPClient) SSHCertSubject() (string, error)
func (obj *SFTPClient) SetSSHCertSubject(value string) error

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

string

SSHCertEncoded Property (SFTPClient Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *SFTPClient) SSHCertEncoded() ([]byte, error)
func (obj *SFTPClient) SetSSHCertEncoded(value []byte) error

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSHCertStore and SSHCertSubject properties also may be used to specify a certificate.

When SSHCertEncoded is set, a search is initiated in the current SSHCertStore for the private key of the certificate. If the key is found, SSHCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSHCertSubject is set to an empty string.

Data Type

[]byte

SSHCompressionAlgorithms Property (SFTPClient Component)

The comma-separated list containing all allowable compression algorithms.

Syntax

func (obj *SFTPClient) SSHCompressionAlgorithms() (string, error)
func (obj *SFTPClient) SetSSHCompressionAlgorithms(value string) error

Default Value

"none,zlib"

Remarks

During the Secure Shell (SSH) handshake, this list will be used to negotiate the compression algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports. Therefore, it is important to list multiple algorithms in preferential order. If no algorithm can be agreed on, the struct will raise an error and the connection will be aborted.

At least one supported algorithm must appear in this list. The following compression algorithms are supported by the struct:

• zlib
• zlib@openssh.com
• none

Data Type

string

SSHEncryptionAlgorithms Property (SFTPClient Component)

The comma-separated list containing all allowable encryption algorithms.

Syntax

func (obj *SFTPClient) SSHEncryptionAlgorithms() (string, error)
func (obj *SFTPClient) SetSSHEncryptionAlgorithms(value string) error

Default Value

"aes256-ctr,aes192-ctr,aes128-ctr,3des-ctr,aes256-gcm@openssh.com,aes128-gcm@openssh.com,chacha20-poly1305@openssh.com"

Remarks

During the Secure Shell (SSH) handshake, this list will be used to negotiate the encryption algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports. Therefore, it is important to list multiple algorithms in preferential order. If no algorithm can be agreed on, the struct will raise an error and the connection will be aborted.

At least one supported algorithm must appear in this list. The following encryption algorithms are supported by the struct:

• aes256-ctr
• aes256-cbc
• aes192-ctr
• aes192-cbc
• aes128-ctr
• aes128-cbc
• 3des-ctr
• 3des-cbc
• cast128-cbc
• blowfish-cbc
• arcfour
• arcfour128
• arcfour256
• aes256-gcm@openssh.com
• aes128-gcm@openssh.com
• chacha20-poly1305@openssh.com

Data Type

string

SSHHost Property (SFTPClient Component)

The address of the Secure Shell (SSH) host.

Syntax

func (obj *SFTPClient) SSHHost() (string, error)
func (obj *SFTPClient) SetSSHHost(value string) error

Default Value

""

Remarks

The SSHHost property specifies the IP address (IP number in dotted internet format) or domain name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established.

If the SSHHost property is set to a domain name, a DNS request is initiated, and upon successful termination of the request, the SSHHost property is set to the corresponding address. If the search is not successful, an error is returned.

The SSHHost must be the same host that will be assumed for SSH as for the remote service being connected to.

Data Type

string

SSHPassword Property (SFTPClient Component)

The password for Secure Shell (SSH) password-based authentication.

Syntax

func (obj *SFTPClient) SSHPassword() (string, error)
func (obj *SFTPClient) SetSSHPassword(value string) error

Default Value

""

Remarks

SSHPassword specifies the password that is used to authenticate the client to the SSH server.

Data Type

string

SSHPort Property (SFTPClient Component)

The port on the Secure Shell (SSH) server where the SSH service is running; by default, 22.

Syntax

func (obj *SFTPClient) SSHPort() (int32, error)
func (obj *SFTPClient) SetSSHPort(value int32) error

Default Value

22

Remarks

The SSHPort specifies a service port on the SSH host to connect to.

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

Data Type

int32

SSHUser Property (SFTPClient Component)

The username for Secure Shell (SSH) authentication.

Syntax

func (obj *SFTPClient) SSHUser() (string, error)
func (obj *SFTPClient) SetSSHUser(value string) error

Default Value

""

Remarks

SSHUser specifies the username that is used to authenticate the client to the SSH server. This property is required.

Example 1. User/Password Authentication: Control.SSHAuthMode = SftpSSHAuthModes.amPassword Control.SSHUser = "username" Control.SSHPassword = "password" Control.SSHLogon("server", 22) Example 2. Public Key Authentication: Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey Control.SSHUser = "username" Control.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile; Control.SSHCertStore = "cert.pfx"; Control.SSHCertStorePassword = "certpassword"; Control.SSHCertSubject = "*"; Control.SSHLogon("server", 22)

Data Type

string

StartByte Property (SFTPClient Component)

The offset in bytes at which to begin the upload or download.

Syntax

func (obj *SFTPClient) StartByte() (int64, error)
func (obj *SFTPClient) SetStartByte(value int64) error

Default Value

0

Remarks

The StartByte property is used by the Upload and Download methods to determine at what offset to begin the transfer. This allows for resuming both uploads and downloads. The value of this property is reset to 0 after a successful transfer. StartByte is not valid for use with Append.

When downloading, this property can be used in conjunction with the TransferredDataLimit configuration setting to download only a specific range of data from the current RemoteFile.

Data Type

int64

Timeout Property (SFTPClient Component)

The timeout for the class.

Syntax

func (obj *SFTPClient) Timeout() (int32, error)
func (obj *SFTPClient) SetTimeout(value int32) error

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the struct will wait for the operation to complete before returning control.

The struct will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the struct fails with an error.

NOTE: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

int32

Append Method (SFTPClient Component)

Appends data from LocalFile to a remote file RemoteFile on a secure file transfer protocol (SFTP) server.

Syntax

func (obj *SFTPClient) Append() error

Remarks

This method is similar to the Upload method, but the local file specified by LocalFile is appended to RemoteFile on the server as opposed to replacing it as with the Upload method. RemoteFile is either an absolute path on the server or a path relative to RemotePath. The server will create a file with that name if it does not already exist (similar to upload).

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

ChangeRemotePath Method (SFTPClient Component)

Changes the current path on the server.

Syntax

func (obj *SFTPClient) ChangeRemotePath(RemotePath string) error

Remarks

This method changes the current path on the server to the specified RemotePath. When called, the struct will issue a command to the server to change the directory. The RemotePath parameter may hold an absolute or relative path.

Absolute Paths

If the path begins with a /, it is considered an absolute path and must specify the entire path from the root of the server. For example:

component.ChangeRemotePath("/home/testuser/myfolder");

Relative Paths

If the path does not begin with a /, it is considered a relative path and is resolved in relation to the current directory. For instance, a value of myfolder will indicate a subfolder of the current directory. The special value .. refers to the parent directory of the current path. For example:

//Change to the 'myfolder' sub-directory component.ChangeRemotePath("myfolder"); //Navigate up two levels and then into the 'another/folder' path. component.ChangeRemotePath("../../another/folder");

CheckFileExists Method (SFTPClient Component)

Returns True if the file specified by RemoteFile exists on the remote server.

Syntax

func (obj *SFTPClient) CheckFileExists() (bool, error)

Remarks

This property returns true if the file exists on the remote server. It returns false if the file does not exist. You must specify the file you wish to check by setting the RemoteFile before calling this method.

If no session is in place, the value of this property will always be false.

Config Method (SFTPClient Component)

Sets or retrieves a configuration setting.

Syntax

func (obj *SFTPClient) Config(ConfigurationString string) (string, error)

Remarks

Config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Connect Method (SFTPClient Component)

Connects to the Secure Shell (SSH) host.

Syntax

func (obj *SFTPClient) Connect() error

Remarks

By default, this method establishes a connection with the SSHHost and performs a full SSH login (equivalent to calling the SSHLogon method with the current SSHHost and SSHPort).

This behavior is controlled by the ConnectAndLogin configuration setting, which defaults to true. When set to false, this method will only establish the TCP connection with the SSHHost without logging in. This may be useful in cases in which it is desirable to separate the connection and logon operations; for instance, confirming a host is available by first creating the connection. To complete the SSH login afterward, call SSHLogon with the same SSHHost and SSHPort that were used to connect.

CopyRemoteData Method (SFTPClient Component)

Copies a range of bytes from one remote file to another directly on the secure file transfer protocol (SFTP) server.

Syntax

func (obj *SFTPClient) CopyRemoteData(DestFile string, Length int64, WriteOffset int64) error

Remarks

This method uses the copy-data extension to copy data from the remote file specified by RemoteFile to the destination file specified by DestFile. The server must support the copy-data extension.

Set StartByte to indicate where in the source file to start reading. The Length parameter indicates the number of bytes to read, and the WriteOffset parameter indicates where in the destination file to start writing.

RemoteFile may be an absolute path on the server or a path relative to RemotePath. DestFile may also be absolute or relative to RemotePath.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

sftp.RemoteFile = "/my/source/file.txt"; sftp.StartByte = 6; sftp.CopyRemoteData("/my/destination/file.txt", 5, 14);

CopyRemoteFile Method (SFTPClient Component)

Copies a remote file directly on the secure file transfer protocol (SFTP) server.

Syntax

func (obj *SFTPClient) CopyRemoteFile(DestFile string) error

Remarks

This method uses the copy-file extension to copy the remote file specified by RemoteFile to the destination file specified by DestFile. The server must support the copy-file extension.

RemoteFile may be an absolute path on the server or a path relative to RemotePath. DestFile may also be absolute or relative to RemotePath. Overwrite controls whether an existing destination file will be overwritten.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

sftp.Overwrite = true; sftp.RemoteFile = "/my/source/file.txt"; sftp.CopyRemoteFile("/my/destination/file.txt");

CreateFile Method (SFTPClient Component)

Creates a file on the secure file transfer protocol (SFTP) server.

Syntax

func (obj *SFTPClient) CreateFile(FileName string) error

Remarks

This method creates an empty file on the server with the name specified by the FileName parameter.

To upload a file with content, use Upload instead.

DecodePacket Method (SFTPClient Component)

Decodes a hex-encoded Secure Shell (SSH) packet.

Syntax

func (obj *SFTPClient) DecodePacket(EncodedPacket string) ([]byte, error)

Remarks

This method is used to decode an SSH packet created by EncodePacket.

NOTE: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the SSHCustomAuth event.

DeleteFile Method (SFTPClient Component)

Deletes a file specified by FileName from a secure file transfer protocol (SFTP) server.

Syntax

func (obj *SFTPClient) DeleteFile(FileName string) error

Remarks

The remote file or directory specified by FileName is deleted. FileName is either an absolute path on the server or a path relative to RemotePath.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

Disconnect Method (SFTPClient Component)

Disconnects from the server without first logging off.

Syntax

func (obj *SFTPClient) Disconnect() error

Remarks

This method immediately disconnects from the server without first logging off.

In most cases, the SSHLogoff method should be used to log off and disconnect from the server. Call the Disconnect method in cases in which it is desirable to immediately disconnect without first logging off.

DoEvents Method (SFTPClient Component)

This method processes events from the internal message queue.

Syntax

func (obj *SFTPClient) DoEvents() error

Remarks

When DoEvents is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Download Method (SFTPClient Component)

Downloads a RemoteFile from a secure file transfer protocol (SFTP) server.

Syntax

func (obj *SFTPClient) Download() error

Remarks

The remote file specified by RemoteFile is downloaded to the local file specified by LocalFile, or it is retrieved through the Transfer event, if the LocalFile property is "" (empty string). RemoteFile is either an absolute path on the server or is a path relative to RemotePath.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

Example. Download a File:

SFTPControl.Localfile = "C:\localfile.txt" SFTPControl.RemoteFile = "remotefile.txt" SFTPControl.Download() SFTPControl.Localfile = "C:\localfile2.txt" SFTPControl.RemoteFile = "folder/remotefile2.txt" SFTPControl.Download()

DownloadRange Method (SFTPClient Component)

Facilitates the partial downloading of a remote file from a secure file transfer protocol (SFTP) server.

Syntax

func (obj *SFTPClient) DownloadRange(Path string, FileName string, StartByte int64, Count int32, Buffer []byte) (int32, error)

Remarks

This method enables downloading a specific segment of a remote file specified by Path and FileName. StartByte is the offset (in bytes) relative to the beginning of the file from where to start reading, and Count is the number of bytes to read into the specified Buffer.

This functionality is particularly useful for efficient management of large files and targeted data retrieval within them.

NOTE: If the requested range extends beyond the end of the file, only the available bytes will be returned.

EncodePacket Method (SFTPClient Component)

Hex encodes a Secure Shell (SSH) packet.

Syntax

func (obj *SFTPClient) EncodePacket(Packet []byte) (string, error)

Remarks

This method is used to encode a raw SSH packet created by SetSSHParam.

NOTE: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the SSHCustomAuth event.

GetSSHParam Method (SFTPClient Component)

Reads a field from a Secure Shell (SSH) packet's payload.

Syntax

func (obj *SFTPClient) GetSSHParam(Payload []byte, Field string) (string, error)

Remarks

This method is used to read the value of a particular field from an SSH packet's payload. Payload should contain the full payload of a packet received by an event such as SSHChannelRequest. Field is the name of a field to be read out of the packet.

The following is a list of the names of well-known channel request field names and their encodings:

The remaining fields that are available in the payload are dependent on the value of RequestType.

pty-req

Pty-req is a request to open a pseudo terminal on the specified channel. The following fields are available:

x11-req

X11-req is a request to forward x11 sessions over a channel. The following fields are available:

env

Env is a request to set an environment variable to be passed into a shell that may be started later. The following fields are available:

exec

Exec is a request to execute a command on the channel using the authenticated user's shell. The following field is available:

subsystem

Subsystem is a request to start a subsystem on the specified channel. The following field is available:

xon-xoff

Xon-xoff instructs the server to allow or disallow control-S/control-Q style flow control. The following field is available:

signal

Sends a signal to the remote process/service. The following field is available:

If the packet type is not well known, Field should start with the special character "%" and contain a comma-separated list of field types as defined in SetSSHParam. For example, reading out the X11AuthProtocol of an x11-req payload, you can use "%s,f".

NOTE: The return value is a string encoded the same way as the FieldValue param in SetSSHParam.

NOTE: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the SSHCustomAuth event.

GetSSHParamBytes Method (SFTPClient Component)

Reads a field from a Secure Shell (SSH) packet's payload.

Syntax

func (obj *SFTPClient) GetSSHParamBytes(Payload []byte, Field string) ([]byte, error)

Remarks

This method is the same as calling GetSSHParam, but it returns raw bytes instead of strings.

NOTE: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the SSHCustomAuth event.

Interrupt Method (SFTPClient Component)

This method interrupts the current method.

Syntax

func (obj *SFTPClient) Interrupt() error

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ListDirectory Method (SFTPClient Component)

Lists the current directory specified by RemotePath on a secure file transfer protocol (SFTP) server.

Syntax

func (obj *SFTPClient) ListDirectory() error

Remarks

A listing is requested for the directory (or file mask) specified in RemoteFile. RemoteFile is either an absolute path on the server or is a path relative to RemotePath. The file listing is received through the DirList event.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

MakeDirectory Method (SFTPClient Component)

Creates a directory on a secure file transfer protocol (SFTP) server.

Syntax

func (obj *SFTPClient) MakeDirectory(NewDir string) error

Remarks

A directory with a path specified by NewDir is created on the SFTP server. NewDir is either an absolute path on the server or is a path relative to RemotePath.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

QueryFileAttributes Method (SFTPClient Component)

Queries the server for the attributes of RemoteFile .

Syntax

func (obj *SFTPClient) QueryFileAttributes() error

Remarks

This method queries the server for attributes of RemoteFile. After calling this method, FileAttributes will be populated with the values returned by the server.

To update attributes, modify the desired values in FileAttributes and call UpdateFileAttributes.

QueueFile Method (SFTPClient Component)

Adds a file to the transfer queue.

Syntax

func (obj *SFTPClient) QueueFile(LocalFile string, RemoteFile string) error

Remarks

This method adds a file to the queue of files that will be transferred.

It is not required to use this method; however, this method extends the ability of the struct to allow for multiple simultaneous file transfers.

To simply transfer a file without using this method, you need only to set LocalFile and RemoteFile and to call Upload or Download, as appropriate. This method allows you to instead queue multiple files before beginning a transfer.

When a file is queued, it will not be transferred until the Upload or Download method is called. If multiple files are queued, the files will be transferred simultaneously. The SimultaneousTransferLimit setting controls the maximum number of simultaneous transfers.

The Upload or Download method will not return until the queue has been completely processed. This method may be called from within events to add additional files to the queue before processing is complete.

To clear the queue, call ResetQueue. This will not affect current transfers.

To cancel an individual file transfer, set the Cancel parameter of the Transfer event to True. The rest of the queue will continue to process as normal.

The Interrupt method may be called to immediately stop all current transfers.

In the event of a file-specific error, the Error event will fire and the LocalFile and RemoteFile event parameters can be used to identify the file to which the error applies.

RemoveDirectory Method (SFTPClient Component)

Removes a directory specified by DirName from a secure file transfer protocol (SFTP) server.

Syntax

func (obj *SFTPClient) RemoveDirectory(DirName string) error

Remarks

A directory with a path specified by DirName is deleted on the SFTP server. DirName is either an absolute path on the server or a path relative to RemotePath.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

RenameFile Method (SFTPClient Component)

Changes the name of RemoteFile to NewName .

Syntax

func (obj *SFTPClient) RenameFile(NewName string) error

Remarks

The name of the remote file or the folder specified by RemoteFile is changed to NewName. RemoteFile and NewName are either absolute paths on the server or a path relative to RemotePath.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

Reset Method (SFTPClient Component)

This method will reset the class.

Syntax

func (obj *SFTPClient) Reset() error

Remarks

This method will reset the struct's properties to their default values.

ResetQueue Method (SFTPClient Component)

Resets the queue of files to be transferred.

Syntax

func (obj *SFTPClient) ResetQueue() error

Remarks

This method will remove all files from the transfer queue.

Calling this method will clear all files that were queued by QueueFile. Calling this method will not affect current transfers.

SetSSHParam Method (SFTPClient Component)

Writes a field to the end of a payload.

Syntax

func (obj *SFTPClient) SetSSHParam(Payload []byte, FieldType string, FieldValue string) ([]byte, error)

Remarks

This method is used to build the payload portion of a Secure Shell (SSH) packet to be sent later by a call to SendSSHPacket. Payload should contain the result of a previous call to SetSSHParam. FieldType is a string defining the type of field to be written to the packet. FieldValue should be the string representation of the field to be written.

The following is a list of supported field types and a description of how FieldValue should be encoded:

NOTE: Integer values may be hexadecimal encoded by prefixing "0x" to the beginning of the string; otherwise, the value is assumed to be Base10.

NOTE: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the SSHCustomAuth event.

SSHLogoff Method (SFTPClient Component)

Logs off from the Secure Shell (SSH) server.

Syntax

func (obj *SFTPClient) SSHLogoff() error

Remarks

Logs off from the SSH server. If that fails, the connection is terminated by the local host.

SSHLogon Method (SFTPClient Component)

Logs on to the SSHHost using the current SSHUser and SSHPassword .

Syntax

func (obj *SFTPClient) SSHLogon(SSHHost string, SSHPort int32) error

Remarks

Logs on to the Secure Shell (SSH) server using the current SSHUser and SSHPassword. This will perform the SSH handshake and authentication.

Example. Logging On:

SSHClient.SSHUser = "username" SSHClient.SSHPassword = "password" SSHClient.SSHLogon("sshHost", sshPort)

UpdateFileAttributes Method (SFTPClient Component)

Instructs the class to send the FileAttributes to the server.

Syntax

func (obj *SFTPClient) UpdateFileAttributes() error

Remarks

When UpdateFileAttributes is called, the struct will send the values of the following properties to the server:

• FileAccessTime
• FileACL
• FileAllocationSize
• FileAttributeBits
• FileAttributeBitsValid
• FileCreationTime
• FileType
• FileGroupId
• FileIsDir
• FileModifiedTime
• FileOwnerId
• FilePermissions
• FileSize

Upload Method (SFTPClient Component)

Uploads a file specified by LocalFile to a secure file transfer protocol (SFTP) server.

Syntax

func (obj *SFTPClient) Upload() error

Remarks

The local file specified by LocalFile is uploaded to the remote file specified by RemoteFile. RemoteFile is either an absolute path on the server or a path relative to RemotePath.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

If you want to append to a server file, please refer to the Append method.

Example. Upload a File:

FTPControl.LocalFile = "C:\\localfile.txt" FTPControl.RemoteFile = "remotefile.txt" FTPControl.Upload() FTPControl.LocalFile = "C:\\localfile2.txt" FTPControl.RemoteFile = "folder/remotefile2.txt" FTPControl.Upload()

UploadRange Method (SFTPClient Component)

Inserts data into a remote file on a secure file transfer protocol (SFTP) server.

Syntax

func (obj *SFTPClient) UploadRange(Path string, FileName string, StartByte int64, Count int32, Buffer []byte) error

Remarks

This method enables uploading a buffer into the remote file specified by the Path and FileName. Count bytes will be updated from the provided Buffer starting in the remote file at the StartByte offset.

This functionality enables precise control over the insertion of data into a remote file, allowing for targeted modifications, overwriting, or additions starting from a specific position within the file.

NOTE: If the offset specified is beyond the file length, empty bytes will be created between the last file byte and the uploaded buffer.

Connected Event (SFTPClient Component)

Fired immediately after a connection completes (or fails).

Syntax

// SFTPClientConnectedEventArgs carries the SFTPClient Connected event's parameters.
type SFTPClientConnectedEventArgs struct {...}

func (args *SFTPClientConnectedEventArgs) StatusCode() int32
func (args *SFTPClientConnectedEventArgs) Description() string
// SFTPClientConnectedEvent defines the signature of the SFTPClient Connected event's handler function.
type SFTPClientConnectedEvent func(sender *SFTPClient, args *SFTPClientConnectedEventArgs)

func (obj *SFTPClient) GetOnConnectedHandler() SFTPClientConnectedEvent
func (obj *SFTPClient) SetOnConnectedHandler(handlerFunc SFTPClientConnectedEvent)

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (SFTPClient Component)

Fired to indicate changes in the connection state.

Syntax

// SFTPClientConnectionStatusEventArgs carries the SFTPClient ConnectionStatus event's parameters.
type SFTPClientConnectionStatusEventArgs struct {...}

func (args *SFTPClientConnectionStatusEventArgs) ConnectionEvent() string
func (args *SFTPClientConnectionStatusEventArgs) StatusCode() int32
func (args *SFTPClientConnectionStatusEventArgs) Description() string
// SFTPClientConnectionStatusEvent defines the signature of the SFTPClient ConnectionStatus event's handler function.
type SFTPClientConnectionStatusEvent func(sender *SFTPClient, args *SFTPClientConnectionStatusEventArgs)

func (obj *SFTPClient) GetOnConnectionStatusHandler() SFTPClientConnectionStatusEvent
func (obj *SFTPClient) SetOnConnectionStatusHandler(handlerFunc SFTPClientConnectionStatusEvent)

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

DirList Event (SFTPClient Component)

Fired when a directory entry is received.

Syntax

// SFTPClientDirListEventArgs carries the SFTPClient DirList event's parameters.
type SFTPClientDirListEventArgs struct {...}

func (args *SFTPClientDirListEventArgs) DirEntry() string
func (args *SFTPClientDirListEventArgs) FileName() string
func (args *SFTPClientDirListEventArgs) IsDir() bool
func (args *SFTPClientDirListEventArgs) FileSize() int64
func (args *SFTPClientDirListEventArgs) FileTime() string
func (args *SFTPClientDirListEventArgs) IsSymlink() bool
// SFTPClientDirListEvent defines the signature of the SFTPClient DirList event's handler function.
type SFTPClientDirListEvent func(sender *SFTPClient, args *SFTPClientDirListEventArgs)

func (obj *SFTPClient) GetOnDirListHandler() SFTPClientDirListEvent
func (obj *SFTPClient) SetOnDirListHandler(handlerFunc SFTPClientDirListEvent)

Remarks

The DirList events are fired when a directory listing is received as a response to a ListDirectory.

The StartTransfer and EndTransfer events mark the beginning and end of the event stream.

The DirEntry parameter contains the filename when ListDirectory is called.

The struct tries to fill out the FileName, IsDir, FileSize, and FileTime parameters when calling the ListDirectory method.

The format of the FileTime parameter returned by the struct can be controlled through the FileTimeFormat configuration setting. If no format is specified, the struct will format the date dependent on the year. If the filetime is in the same year, it will be formatted as "MMM dd HH:mm"; otherwise, it will be formatted as "MMM dd yyyy".

IsSymlink indicates whether the entry is a symbolic link. When the entry is a symbolic link, the value of IsDir will always be False because this information is not returned in the directory listing. To inspect a symlink to determine if it is a link to a file or a folder, set RemoteFile and query the FileIsDir property.

Disconnected Event (SFTPClient Component)

Fired when a connection is closed.

Syntax

// SFTPClientDisconnectedEventArgs carries the SFTPClient Disconnected event's parameters.
type SFTPClientDisconnectedEventArgs struct {...}

func (args *SFTPClientDisconnectedEventArgs) StatusCode() int32
func (args *SFTPClientDisconnectedEventArgs) Description() string
// SFTPClientDisconnectedEvent defines the signature of the SFTPClient Disconnected event's handler function.
type SFTPClientDisconnectedEvent func(sender *SFTPClient, args *SFTPClientDisconnectedEventArgs)

func (obj *SFTPClient) GetOnDisconnectedHandler() SFTPClientDisconnectedEvent
func (obj *SFTPClient) SetOnDisconnectedHandler(handlerFunc SFTPClientDisconnectedEvent)

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

EndTransfer Event (SFTPClient Component)

Fired when a file completes downloading or uploading.

Syntax

// SFTPClientEndTransferEventArgs carries the SFTPClient EndTransfer event's parameters.
type SFTPClientEndTransferEventArgs struct {...}

func (args *SFTPClientEndTransferEventArgs) Direction() int32
func (args *SFTPClientEndTransferEventArgs) LocalFile() string
func (args *SFTPClientEndTransferEventArgs) RemoteFile() string
// SFTPClientEndTransferEvent defines the signature of the SFTPClient EndTransfer event's handler function.
type SFTPClientEndTransferEvent func(sender *SFTPClient, args *SFTPClientEndTransferEventArgs)

func (obj *SFTPClient) GetOnEndTransferHandler() SFTPClientEndTransferEvent
func (obj *SFTPClient) SetOnEndTransferHandler(handlerFunc SFTPClientEndTransferEvent)

Remarks

The EndTransfer event fires when either an upload or a download operation completes. This occurs when the file finishes transferring or a directory listing is finished.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

LocalFile identifies the local file. RemoteFile is the remote file.

Error Event (SFTPClient Component)

Fired when errors occur during data delivery.

Syntax

// SFTPClientErrorEventArgs carries the SFTPClient Error event's parameters.
type SFTPClientErrorEventArgs struct {...}

func (args *SFTPClientErrorEventArgs) ErrorCode() int32
func (args *SFTPClientErrorEventArgs) Description() string
func (args *SFTPClientErrorEventArgs) LocalFile() string
func (args *SFTPClientErrorEventArgs) RemoteFile() string
// SFTPClientErrorEvent defines the signature of the SFTPClient Error event's handler function.
type SFTPClientErrorEvent func(sender *SFTPClient, args *SFTPClientErrorEventArgs)

func (obj *SFTPClient) GetOnErrorHandler() SFTPClientErrorEvent
func (obj *SFTPClient) SetOnErrorHandler(handlerFunc SFTPClientErrorEvent)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

LocalFile identifies the local file. RemoteFile is the remote file.

Log Event (SFTPClient Component)

Fired once for each log message.

Syntax

// SFTPClientLogEventArgs carries the SFTPClient Log event's parameters.
type SFTPClientLogEventArgs struct {...}

func (args *SFTPClientLogEventArgs) LogLevel() int32
func (args *SFTPClientLogEventArgs) Message() string
func (args *SFTPClientLogEventArgs) LogType() string
// SFTPClientLogEvent defines the signature of the SFTPClient Log event's handler function.
type SFTPClientLogEvent func(sender *SFTPClient, args *SFTPClientLogEventArgs)

func (obj *SFTPClient) GetOnLogHandler() SFTPClientLogEvent
func (obj *SFTPClient) SetOnLogHandler(handlerFunc SFTPClientLogEvent)

Remarks

Fired once for each log message generated by the struct. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the detail level of the message. Possible values are as follows:

Message is the log message.

LogType is reserved for future use.

SSHCustomAuth Event (SFTPClient Component)

Fired when the class is doing a custom authentication.

Syntax

// SFTPClientSSHCustomAuthEventArgs carries the SFTPClient SSHCustomAuth event's parameters.
type SFTPClientSSHCustomAuthEventArgs struct {...}

func (args *SFTPClientSSHCustomAuthEventArgs) Packet() string
func (args *SFTPClientSSHCustomAuthEventArgs) SetPacket(value string)

// SFTPClientSSHCustomAuthEvent defines the signature of the SFTPClient SSHCustomAuth event's handler function.
type SFTPClientSSHCustomAuthEvent func(sender *SFTPClient, args *SFTPClientSSHCustomAuthEventArgs)

func (obj *SFTPClient) GetOnSSHCustomAuthHandler() SFTPClientSSHCustomAuthEvent
func (obj *SFTPClient) SetOnSSHCustomAuthHandler(handlerFunc SFTPClientSSHCustomAuthEvent)

Remarks

SSHCustomAuth is fired during the user authentication stage of the Secure Shell (SSH) logon process if SSHAuthMode is set to amCustom. Packet contains the last raw SSH packet sent by the server, in HEX-encoded format.

The client should create a new raw SSH packet to send to the server and set Packet to the HEX-encoded representation of the packet to send.

In all cases, Packet will start with the message type field.

To read the incoming packet, call DecodePacket and then use the GetSSHParam and GetSSHParamBytes methods. To create a packet, use the SetSSHParam method and then call EncodePacket to obtain a HEX-encoded value and assign this to the Packet parameter.

SSHKeyboardInteractive Event (SFTPClient Component)

Fired when the class receives a request for user input from the server.

Syntax

// SFTPClientSSHKeyboardInteractiveEventArgs carries the SFTPClient SSHKeyboardInteractive event's parameters.
type SFTPClientSSHKeyboardInteractiveEventArgs struct {...}

func (args *SFTPClientSSHKeyboardInteractiveEventArgs) Name() string
func (args *SFTPClientSSHKeyboardInteractiveEventArgs) Instructions() string
func (args *SFTPClientSSHKeyboardInteractiveEventArgs) Prompt() string
func (args *SFTPClientSSHKeyboardInteractiveEventArgs) Response() string
func (args *SFTPClientSSHKeyboardInteractiveEventArgs) SetResponse(value string)

func (args *SFTPClientSSHKeyboardInteractiveEventArgs) EchoResponse() bool
// SFTPClientSSHKeyboardInteractiveEvent defines the signature of the SFTPClient SSHKeyboardInteractive event's handler function.
type SFTPClientSSHKeyboardInteractiveEvent func(sender *SFTPClient, args *SFTPClientSSHKeyboardInteractiveEventArgs)

func (obj *SFTPClient) GetOnSSHKeyboardInteractiveHandler() SFTPClientSSHKeyboardInteractiveEvent
func (obj *SFTPClient) SetOnSSHKeyboardInteractiveHandler(handlerFunc SFTPClientSSHKeyboardInteractiveEvent)

Remarks

SSHKeyboardInteractive is fired during the user authentication stage of the Secure Shell (SSH) logon process. During authentication, the struct will request a list of available authentication methods for the SSHUser. For example, if the SSHHost responds with "keyboard-interactive", the struct will fire this event to allow the client application to set the password.

During authentication, the SSH server may respond with a request for the user's authentication information. Name is a server-provided value associated with the authentication method such as "CRYPTOCard Authentication". Instructions will contain specific instructions, also supplied by the server, for how the user should respond.

Along with these values, the server will also send at least one input Prompt to be displayed to and filled out by the user. Response should be set to the user's input, and will be sent back in the user authentication information response. EchoResponse is a server recommendation for whether or not the user's response should be echoed back during input.

NOTE: The server may send several prompts in a single packet. The struct will fire the SSHKeyboardInteractive event once for each prompt.

SSHServerAuthentication Event (SFTPClient Component)

Fired after the server presents its public key to the client.

Syntax

// SFTPClientSSHServerAuthenticationEventArgs carries the SFTPClient SSHServerAuthentication event's parameters.
type SFTPClientSSHServerAuthenticationEventArgs struct {...}

func (args *SFTPClientSSHServerAuthenticationEventArgs) HostKey() []byte
func (args *SFTPClientSSHServerAuthenticationEventArgs) Fingerprint() string
func (args *SFTPClientSSHServerAuthenticationEventArgs) KeyAlgorithm() string
func (args *SFTPClientSSHServerAuthenticationEventArgs) CertSubject() string
func (args *SFTPClientSSHServerAuthenticationEventArgs) CertIssuer() string
func (args *SFTPClientSSHServerAuthenticationEventArgs) Status() string
func (args *SFTPClientSSHServerAuthenticationEventArgs) Accept() bool
func (args *SFTPClientSSHServerAuthenticationEventArgs) SetAccept(value bool)

// SFTPClientSSHServerAuthenticationEvent defines the signature of the SFTPClient SSHServerAuthentication event's handler function.
type SFTPClientSSHServerAuthenticationEvent func(sender *SFTPClient, args *SFTPClientSSHServerAuthenticationEventArgs)

func (obj *SFTPClient) GetOnSSHServerAuthenticationHandler() SFTPClientSSHServerAuthenticationEvent
func (obj *SFTPClient) SetOnSSHServerAuthenticationHandler(handlerFunc SFTPClientSSHServerAuthenticationEvent)

Remarks

This event is fired when the client can decide whether or not to continue with the connection process. If the public key is known to be a valid key for the Secure Shell (SSH) server, Accept should be set to True within the event. Otherwise, the server will not be authenticated and the connection will be broken.

Accept will be True only if either HostKey or Fingerprint is identical to the value of SSHAcceptServerHostKey.

Accept may be set to True manually to accept the server host key.

NOTE: SSH's security inherently relies on client verification of the host key. Ignoring the host key and always setting Accept to True is strongly discouraged, and could cause potentially serious security vulnerabilities in your application. It is recommended that clients maintain a list of known keys for each server and check HostKey against this list each time a connection is attempted.

Host Key contains the full binary text of the key, in the same format used internally by SSH.

Fingerprint holds the SHA-256 hash of HostKey in the hex-encoded form: 0a:1b:2c:3d. To configure the hash algorithm used to calculate this value, see SSHFingerprintHashAlgorithm. To configure the encoding format used when displaying this value, see SSHFingerprintEncoding.

KeyAlgorithm identifies the host key algorithm. The following values are supported:

• ssh-rsa
• ssh-dss
• rsa-sha2-256
• rsa-sha2-512
• x509v3-sign-rsa
• x509v3-sign-dss
• ecdsa-sha2-nistp256
• ecdsa-sha2-nistp384
• ecdsa-sha2-nistp521

CertSubject is the subject of the certificate. This is applicable only when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".

CertIssuer is the issuer of the certificate. This is applicable only when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".

Status is reserved for future use.

SSHStatus Event (SFTPClient Component)

Fired to track the progress of the secure connection.

Syntax

// SFTPClientSSHStatusEventArgs carries the SFTPClient SSHStatus event's parameters.
type SFTPClientSSHStatusEventArgs struct {...}

func (args *SFTPClientSSHStatusEventArgs) Message() string
// SFTPClientSSHStatusEvent defines the signature of the SFTPClient SSHStatus event's handler function.
type SFTPClientSSHStatusEvent func(sender *SFTPClient, args *SFTPClientSSHStatusEventArgs)

func (obj *SFTPClient) GetOnSSHStatusHandler() SFTPClientSSHStatusEvent
func (obj *SFTPClient) SetOnSSHStatusHandler(handlerFunc SFTPClientSSHStatusEvent)

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

StartTransfer Event (SFTPClient Component)

Fired when a file starts downloading or uploading.

Syntax

// SFTPClientStartTransferEventArgs carries the SFTPClient StartTransfer event's parameters.
type SFTPClientStartTransferEventArgs struct {...}

func (args *SFTPClientStartTransferEventArgs) Direction() int32
func (args *SFTPClientStartTransferEventArgs) LocalFile() string
func (args *SFTPClientStartTransferEventArgs) RemoteFile() string
// SFTPClientStartTransferEvent defines the signature of the SFTPClient StartTransfer event's handler function.
type SFTPClientStartTransferEvent func(sender *SFTPClient, args *SFTPClientStartTransferEventArgs)

func (obj *SFTPClient) GetOnStartTransferHandler() SFTPClientStartTransferEvent
func (obj *SFTPClient) SetOnStartTransferHandler(handlerFunc SFTPClientStartTransferEvent)

Remarks

The StartTransfer event fires when a data interface connection is created. This occurs when the file starts transferring or a directory listing is started.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

LocalFile identifies the local file. RemoteFile is the remote file.

Transfer Event (SFTPClient Component)

Fired during file download or upload.

Syntax

// SFTPClientTransferEventArgs carries the SFTPClient Transfer event's parameters.
type SFTPClientTransferEventArgs struct {...}

func (args *SFTPClientTransferEventArgs) Direction() int32
func (args *SFTPClientTransferEventArgs) LocalFile() string
func (args *SFTPClientTransferEventArgs) RemoteFile() string
func (args *SFTPClientTransferEventArgs) BytesTransferred() int64
func (args *SFTPClientTransferEventArgs) PercentDone() int32
func (args *SFTPClientTransferEventArgs) Text() []byte
func (args *SFTPClientTransferEventArgs) Cancel() bool
func (args *SFTPClientTransferEventArgs) SetCancel(value bool)

// SFTPClientTransferEvent defines the signature of the SFTPClient Transfer event's handler function.
type SFTPClientTransferEvent func(sender *SFTPClient, args *SFTPClientTransferEventArgs)

func (obj *SFTPClient) GetOnTransferHandler() SFTPClientTransferEvent
func (obj *SFTPClient) SetOnTransferHandler(handlerFunc SFTPClientTransferEvent)

Remarks

One or more Transfer events are fired during file transfer. The BytesTransferred parameter shows the number of bytes transferred since the beginning of the transfer.

Text contains the portion of the file data being delivered.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

LocalFile identifies the local file. RemoteFile is the remote file.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

To cancel the current transfer, set Cancel to True.

Config Settings (SFTPClient Component)

SFTPClient Config Settings

SSHClient Config Settings

*SSH-1.99-*,*SSH-2.0-*,*SSH-2.99-*

Base Config Settings

Trappable Errors (SFTPClient Component)

SFTPClient Errors

SSHClient Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

TCP/IP Errors