SSHPlex Module

Properties   Methods   Events   Config Settings   Errors  

SSHPlex is a multiplexed module that operates over a single SSH connection and allows file transfers using SFTP or SCP. It can also remotely execute commands using SExec or SShell.

Syntax

IPWorksSSH.Sshplex

Remarks

The SSHPlex class combines the functionality of the SCP class, the SFTP class, the SExec class, and the SShell class. All operations are performed over a single SSH connection.

The asynchronous design of the class allows multiple operations to be performed simultaneously. For example, several SFTP file transfers may be started, and while the files are still transferring commands may be executed over SExec. This is accomplished through the use of Operation Ids to track ongoing and complete operations, and ChannelType which allows switching between SFTP, SCP, SExec, and SShell usage.

After establishing a connection set ChannelType to the desired protocol and set any relevant properties for the operation. Calling the desired method will return an Operation Id (string) which identifies the operation in progress. A corresponding SSHPlexOperation will also be added to the Operations collection.

When the operation completes a corresponding event will fire indicating the success or failure of the operation. Examine the event parameters for further details. For instance, after calling Upload the UploadComplete event will fire.

Ongoing operations may be canceled at any time by passing the Operation Id to the CancelOperation method.

Note: The DoEvents method must be called frequently in order to process outstanding events. This is particularly important for SCP and SFTP operations. Call DoEvents in a loop for best results.

Authentication

Example (Logging On)

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

Channel Types

Note that CancelOperation and other methods not explicitly listed above are applicable to all channel types.

Listing Files and Folders

ListDirectory lists files and folders from the path specified by RemotePath.

The directory entries are provided through the DirList event and also via the DirList* properties. SSHPlexControl.RemoteFile = ""; //Clear filemask SSHPlexControl.RemotePath = "MyFolder"; string opId = SSHPlexControl.ListDirectory(); // ListDirectory operates async so we must wait for it to finish while (SSHPlexControl.Operations.Keys.Contains(opId)) { SSHPlexControl.DoEvents(); } for (int i = 0; i < SSHPlexControl.DirList.Count; i++) { Console.WriteLine(SSHPlexControl.DirList[i].FileName); Console.WriteLine(SSHPlexControl.DirList[i].FileSize); Console.WriteLine(SSHPlexControl.DirList[i].FileTime); Console.WriteLine(SSHPlexControl.DirList[i].IsDir); }

The RemoteFile property may also be used as a filemask when listing files. For instance: SSHPlexControl.RemoteFile = "*.txt"; SSHPlexControl.ListDirectory();

Note: Since RemoteFile is used as a filemask be sure to clear or reset this value before calling ListDirectory

Downloading Files

The Download method downloads a specific file.

Set RemoteFile to the name of the file to download before calling this method. If RemoteFile only specifies a filename it will be downloaded from the path specified by RemotePath. RemoteFile may also be set to an absolute path.

If LocalFile is set the file will be saved to the specified location.

Code Example

SSHPlexControl.Localfile = "C:\localfile.txt"; SSHPlexControl.RemoteFile = "remotefile.txt"; string operationId = SSHPlexControl.Download(); // Use Path in RemoteFile SSHPlexControl.Localfile = "C:\localfile2.txt"; SSHPlexControl.RemoteFile = "folder/remotefile2.txt"; string operationId = SSHPlexControl.Download();

Resuming Downloads

The class also supports resuming failed downloads by using the StartByte property. If a download is interrupted or canceled, set StartByte to the appropriate offset before calling this method to resume the download.

string localFile = "C:\localfile.txt"; SSHPlexControl.Localfile = localFile; SSHPlexControl.RemoteFile = "remotefile.txt"; string operationId = SSHPlexControl.Download(); // Cancel Download using the CancelOperation method SSHPlexControl.CancelOperation(operationId); // Get the size of the partially downloaded temp file and set StartByte SSHPlexControl.StartByte = new FileInfo(localFile).Length; // Resume download string operationId = SSHPlexControl.Download();

Uploading Files

The Upload method is used to upload files. Set LocalFile to the name of the file to upload before calling this method.

RemoteFile should be set to either a relative or absolute path. If RemoteFile is not an absolute path it will be uploaded relative to RemotePath.

Code Example

SSHPlexControl.Localfile = "C:\localfile.txt"; SSHPlexControl.RemoteFile = "remotefile.txt"; string operationId = SSHPlexControl.Upload(); // Use Path in RemoteFile SSHPlexControl.Localfile = "C:\localfile2.txt"; SSHPlexControl.RemoteFile = "folder/remotefile2.txt"; string operationId = SSHPlexControl.Upload();

Resuming Uploads

The class also supports resuming failed uploads by using the StartByte property. If an upload is interrupted or canceled, set StartByte to the appropriate offset before calling this method to resume the upload.

string localFile = "C:\localfile.txt"; SSHPlexControl.Localfile = localFile; SSHPlexControl.RemoteFile = "remotefile.txt"; string operationId = SSHPlexControl.Upload(); // Cancel Upload using the CancelOperation method SSHPlexControl.CancelOperation(operationId); // Get the size of the partially uploaded temp file and set StartByte SSHPlexControl.StartByte = SSHPlexControl.FileAttributes.Size; // Resume upload string operationId = SSHPlexControl.Upload();

Remote Execution

Executing commands on a remote host is done by using the cstSExec or cstSShell ChannelType.

To execute a command, simply call the Execute method or set the Command property with the command you wish to execute. Further input may be supplied via the Stdin property.

The output of the command is returned through the Stdout event. Errors during command execution (the stderr stream) are given by the Stderr event.

Property List

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

Method List

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

Event List

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

Config Settings

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

ChannelType Property (SSHPlex Module)

Specifies the Channel Type to be used by the module.

Syntax

• Swift
• Objective-C

public var channelType: SshplexChannelTypes {
  get {...}
  set {...}
}

public enum SshplexChannelTypes: Int32 {
  case cstSShell = 0
  case cstSExec = 1
  case cstScp = 2
  case cstSftp = 3
}

@property (nonatomic,readwrite,assign,getter=channelType,setter=setChannelType:) int channelType;

- (int)channelType;
- (void)setChannelType :(int)newChannelType;

Default Value

0

Remarks

The ChannelType property determines the protocol used by the component and therefore the applicable methods and properties for each channel. Valid values are:

Note that CancelOperation and other methods not explicitly listed above are applicable to all channel types.

Connected Property (SSHPlex Module)

This shows whether the module is connected.

Syntax

• Swift
• Objective-C

public var connected: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=connected,setter=setConnected:) BOOL connected;

- (BOOL)connected;
- (void)setConnected :(BOOL)newConnected;

Default Value

False

Remarks

This property is used to determine whether or not the class is connected to the remote host.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

DirList Property (SSHPlex Module)

Collection of entries resulting in the last directory listing.

Syntax

• Swift
• Objective-C

public var dirList: Array<DirEntry> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=dirListCount) int dirListCount;

- (int)dirListCount;

- (NSString*)dirListEntry:(int)entryIndex;

- (NSString*)dirListFileName:(int)entryIndex;

- (long long)dirListFileSize:(int)entryIndex;

- (NSString*)dirListFileTime:(int)entryIndex;

- (BOOL)dirListIsDir:(int)entryIndex;

- (BOOL)dirListIsSymlink:(int)entryIndex;

 

Default Value

60

Remarks

If the Timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If Timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

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

If Timeout expires, and the operation is not yet complete, the class .

Please note that by default, all timeouts are inactivity timeouts, i.e. 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.

FileAttributes Property (SSHPlex Module)

The attributes of the RemoteFile .

Syntax

• Swift
• Objective-C

public var fileAttributes: SFTPFileAttributes {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SFTPFileAccessTime,setter=setSFTPFileAccessTime:) long long SFTPFileAccessTime;

- (long long)SFTPFileAccessTime;
- (void)setSFTPFileAccessTime :(long long)newSFTPFileAccessTime;

@property (nonatomic,readwrite,assign,getter=SFTPFileACL,setter=setSFTPFileACL:) NSString* SFTPFileACL;

- (NSString*)SFTPFileACL;
- (void)setSFTPFileACL :(NSString*)newSFTPFileACL;

@property (nonatomic,readonly,assign,getter=SFTPFileAllocationSize) long long SFTPFileAllocationSize;

- (long long)SFTPFileAllocationSize;

@property (nonatomic,readonly,assign,getter=SFTPFileAttributeBits) int SFTPFileAttributeBits;

- (int)SFTPFileAttributeBits;

@property (nonatomic,readonly,assign,getter=SFTPFileAttributeBitsValid) int SFTPFileAttributeBitsValid;

- (int)SFTPFileAttributeBitsValid;

@property (nonatomic,readwrite,assign,getter=SFTPFileCreationTime,setter=setSFTPFileCreationTime:) long long SFTPFileCreationTime;

- (long long)SFTPFileCreationTime;
- (void)setSFTPFileCreationTime :(long long)newSFTPFileCreationTime;

@property (nonatomic,readonly,assign,getter=SFTPFileType) int SFTPFileType;

- (int)SFTPFileType;

@property (nonatomic,readwrite,assign,getter=SFTPFileGroupId,setter=setSFTPFileGroupId:) NSString* SFTPFileGroupId;

- (NSString*)SFTPFileGroupId;
- (void)setSFTPFileGroupId :(NSString*)newSFTPFileGroupId;

@property (nonatomic,readonly,assign,getter=SFTPFileIsDir) BOOL SFTPFileIsDir;

- (BOOL)SFTPFileIsDir;

@property (nonatomic,readonly,assign,getter=SFTPFileIsSymlink) BOOL SFTPFileIsSymlink;

- (BOOL)SFTPFileIsSymlink;

@property (nonatomic,readwrite,assign,getter=SFTPFileModifiedTime,setter=setSFTPFileModifiedTime:) long long SFTPFileModifiedTime;

- (long long)SFTPFileModifiedTime;
- (void)setSFTPFileModifiedTime :(long long)newSFTPFileModifiedTime;

@property (nonatomic,readwrite,assign,getter=SFTPFileOwnerId,setter=setSFTPFileOwnerId:) NSString* SFTPFileOwnerId;

- (NSString*)SFTPFileOwnerId;
- (void)setSFTPFileOwnerId :(NSString*)newSFTPFileOwnerId;

@property (nonatomic,readwrite,assign,getter=SFTPFilePermissions,setter=setSFTPFilePermissions:) int SFTPFilePermissions;

- (int)SFTPFilePermissions;
- (void)setSFTPFilePermissions :(int)newSFTPFilePermissions;

@property (nonatomic,readwrite,assign,getter=SFTPFilePermissionsOctal,setter=setSFTPFilePermissionsOctal:) NSString* SFTPFilePermissionsOctal;

- (NSString*)SFTPFilePermissionsOctal;
- (void)setSFTPFilePermissionsOctal :(NSString*)newSFTPFilePermissionsOctal;

@property (nonatomic,readonly,assign,getter=SFTPFileSize) long long SFTPFileSize;

- (long long)SFTPFileSize;

 

Default Value

60

Remarks

If the Timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If Timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

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

If Timeout expires, and the operation is not yet complete, the class .

Please note that by default, all timeouts are inactivity timeouts, i.e. 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.

FilePermissions Property (SSHPlex Module)

The file permissions for the RemoteFile .

Syntax

• Swift
• Objective-C

public var filePermissions: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=filePermissions,setter=setFilePermissions:) NSString* filePermissions;

- (NSString*)filePermissions;
- (void)setFilePermissions :(NSString*)newFilePermissions;

Default Value

"0600"

Remarks

This property defines the permissions that will be assigned to the RemoteFile after an upload. The value is a four digit octal value. This is the same format that is used with the Unix chmod command. The default value of "0600" gives read/write permissions to the file's owner.

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:

Note: Not all servers support setting permissions after an upload.

Firewall Property (SSHPlex Module)

A set of properties related to firewall access.

Syntax

• Swift
• Objective-C

public var firewall: Firewall {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=firewallAutoDetect,setter=setFirewallAutoDetect:) BOOL firewallAutoDetect;

- (BOOL)firewallAutoDetect;
- (void)setFirewallAutoDetect :(BOOL)newFirewallAutoDetect;

@property (nonatomic,readwrite,assign,getter=firewallType,setter=setFirewallType:) int firewallType;

- (int)firewallType;
- (void)setFirewallType :(int)newFirewallType;

@property (nonatomic,readwrite,assign,getter=firewallHost,setter=setFirewallHost:) NSString* firewallHost;

- (NSString*)firewallHost;
- (void)setFirewallHost :(NSString*)newFirewallHost;

@property (nonatomic,readwrite,assign,getter=firewallPassword,setter=setFirewallPassword:) NSString* firewallPassword;

- (NSString*)firewallPassword;
- (void)setFirewallPassword :(NSString*)newFirewallPassword;

@property (nonatomic,readwrite,assign,getter=firewallPort,setter=setFirewallPort:) int firewallPort;

- (int)firewallPort;
- (void)setFirewallPort :(int)newFirewallPort;

@property (nonatomic,readwrite,assign,getter=firewallUser,setter=setFirewallUser:) NSString* firewallUser;

- (NSString*)firewallUser;
- (void)setFirewallUser :(NSString*)newFirewallUser;

 

Default Value

60

Remarks

If the Timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If Timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

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

If Timeout expires, and the operation is not yet complete, the class .

Please note that by default, all timeouts are inactivity timeouts, i.e. 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.

LocalFile Property (SSHPlex Module)

The path to a local file for upload/download.

Syntax

• Swift
• Objective-C

public var localFile: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localFile,setter=setLocalFile:) NSString* localFile;

- (NSString*)localFile;
- (void)setLocalFile :(NSString*)newLocalFile;

Default Value

""

Remarks

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

Example (Setting LocalFile)

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

LocalHost Property (SSHPlex Module)

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

Syntax

• Swift
• Objective-C

public var localHost: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localHost,setter=setLocalHost:) NSString* localHost;

- (NSString*)localHost;
- (void)setLocalHost :(NSString*)newLocalHost;

Default Value

""

Remarks

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

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost 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 multi-homed 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.

LocalPort Property (SSHPlex Module)

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

Syntax

• Swift
• Objective-C

public var localPort: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localPort,setter=setLocalPort:) int localPort;

- (int)localPort;
- (void)setLocalPort :(int)newLocalPort;

Default Value

0

Remarks

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

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

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

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

Operations Property (SSHPlex Module)

This collection contains all running operations.

Syntax

• Swift
• Objective-C

public var operations: Array<SSHPlexOperation> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=operationCount) int operationCount;

- (int)operationCount;

- (NSString*)operationOperationId:(int)operationIndex;

 

Default Value

60

Remarks

If the Timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If Timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

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

If Timeout expires, and the operation is not yet complete, the class .

Please note that by default, all timeouts are inactivity timeouts, i.e. 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.

Overwrite Property (SSHPlex Module)

Whether or not the module should overwrite files during transfer.

Syntax

• Swift
• Objective-C

public var overwrite: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=overwrite,setter=setOverwrite:) BOOL overwrite;

- (BOOL)overwrite;
- (void)setOverwrite :(BOOL)newOverwrite;

Default Value

False

Remarks

When ChannelType is set to cstSFTP this property is a value indicating whether or not the class should overwrite LocalFile when downloading, and RemoteFile when uploading. If Overwrite is false, an error will be thrown whenever LocalFile exists before a download operation.

When ChannelType is set to cstSCP this property is a value indicating whether or not the class should overwrite LocalFile when downloading. If Overwrite is false, an error will be thrown whenever LocalFile exists before a download operation.

RemoteFile Property (SSHPlex Module)

The name of the remote file for uploading, downloading, etc.

Syntax

• Swift
• Objective-C

public var remoteFile: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=remoteFile,setter=setRemoteFile:) NSString* remoteFile;

- (NSString*)remoteFile;
- (void)setRemoteFile :(NSString*)newRemoteFile;

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 (Setting RemoteFile)

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

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

Example (Using RemoteFile as a file mask): SSHPlexControl.RemoteFile = "*.txt" SSHPlexControl.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.

SSHAcceptServerHostKeyEncoded Property (SSHPlex Module)

This is the certificate (PEM/base64 encoded).

Syntax

• Swift
• Objective-C

public var sshAcceptServerHostKeyEncoded: String {
  get {...}
  set {...}
}

public var sshAcceptServerHostKeyEncodedB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSHAcceptServerHostKeyEncoded,setter=setSSHAcceptServerHostKeyEncoded:) NSString* SSHAcceptServerHostKeyEncoded;

- (NSString*)SSHAcceptServerHostKeyEncoded;
- (void)setSSHAcceptServerHostKeyEncoded :(NSString*)newSSHAcceptServerHostKeyEncoded;

@property (nonatomic,readwrite,assign,getter=SSHAcceptServerHostKeyEncodedB,setter=setSSHAcceptServerHostKeyEncodedB:) NSData* SSHAcceptServerHostKeyEncodedB;

- (NSData*)SSHAcceptServerHostKeyEncodedB;
- (void)setSSHAcceptServerHostKeyEncodedB :(NSData*)newSSHAcceptServerHostKeyEncoded;

Default Value

""

Remarks

This is 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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSHAcceptServerHostKeyEncodedB(sshAcceptServerHostKeyEncoded: Data) throws
public func setSSHAcceptServerHostKeyEncoded(sshAcceptServerHostKeyEncoded: String) throws

SSHAuthMode Property (SSHPlex Module)

The authentication method to be used the module when calling SSHLogon .

Syntax

• Swift
• Objective-C

public var sshAuthMode: SshplexSSHAuthModes {
  get {...}
  set {...}
}

public enum SshplexSSHAuthModes: Int32 {
  case amNone = 0
  case amMultiFactor = 1
  case amPassword = 2
  case amPublicKey = 3
  case amKeyboardInteractive = 4
  case amGSSAPIWithMic = 5
  case amCustom = 6
}

@property (nonatomic,readwrite,assign,getter=SSHAuthMode,setter=setSSHAuthMode:) int SSHAuthMode;

- (int)SSHAuthMode;
- (void)setSSHAuthMode :(int)newSSHAuthMode;

Default Value

2

Remarks

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

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

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

SSHCertEncoded Property (SSHPlex Module)

This is the certificate (PEM/base64 encoded).

Syntax

• Swift
• Objective-C

public var sshCertEncoded: String {
  get {...}
  set {...}
}

public var sshCertEncodedB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSHCertEncoded,setter=setSSHCertEncoded:) NSString* SSHCertEncoded;

- (NSString*)SSHCertEncoded;
- (void)setSSHCertEncoded :(NSString*)newSSHCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSHCertEncodedB,setter=setSSHCertEncodedB:) NSData* SSHCertEncodedB;

- (NSData*)SSHCertEncodedB;
- (void)setSSHCertEncodedB :(NSData*)newSSHCertEncoded;

Default Value

""

Remarks

This is 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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSHCertEncodedB(sshCertEncoded: Data) throws
public func setSSHCertEncoded(sshCertEncoded: String) throws

SSHCertStore Property (SSHPlex Module)

This is the name of the certificate store for the client certificate.

Syntax

• Swift
• Objective-C

public var sshCertStore: String {
  get {...}
  set {...}
}

public var sshCertStoreB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSHCertStore,setter=setSSHCertStore:) NSString* SSHCertStore;

- (NSString*)SSHCertStore;
- (void)setSSHCertStore :(NSString*)newSSHCertStore;

@property (nonatomic,readwrite,assign,getter=SSHCertStoreB,setter=setSSHCertStoreB:) NSData* SSHCertStoreB;

- (NSData*)SSHCertStoreB;
- (void)setSSHCertStoreB :(NSData*)newSSHCertStore;

Default Value

"MY"

Remarks

This is 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 are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

SSHCertStorePassword Property (SSHPlex Module)

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

Syntax

• Swift
• Objective-C

public var sshCertStorePassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSHCertStorePassword,setter=setSSHCertStorePassword:) NSString* SSHCertStorePassword;

- (NSString*)SSHCertStorePassword;
- (void)setSSHCertStorePassword :(NSString*)newSSHCertStorePassword;

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.

SSHCertStoreType Property (SSHPlex Module)

This is the type of certificate store for this certificate.

Syntax

• Swift
• Objective-C

public var sshCertStoreType: SshplexSSHCertStoreTypes {
  get {...}
  set {...}
}

public enum SshplexSSHCertStoreTypes: Int32 {
  case cstUser = 0
  case cstMachine = 1
  case cstPFXFile = 2
  case cstPFXBlob = 3
  case cstJKSFile = 4
  case cstJKSBlob = 5
  case cstPEMKeyFile = 6
  case cstPEMKeyBlob = 7
  case cstPublicKeyFile = 8
  case cstPublicKeyBlob = 9
  case cstSSHPublicKeyBlob = 10
  case cstP7BFile = 11
  case cstP7BBlob = 12
  case cstSSHPublicKeyFile = 13
  case cstPPKFile = 14
  case cstPPKBlob = 15
  case cstXMLFile = 16
  case cstXMLBlob = 17
  case cstJWKFile = 18
  case cstJWKBlob = 19
  case cstSecurityKey = 20
  case cstBCFKSFile = 21
  case cstBCFKSBlob = 22
  case cstAuto = 99
}

@property (nonatomic,readwrite,assign,getter=SSHCertStoreType,setter=setSSHCertStoreType:) int SSHCertStoreType;

- (int)SSHCertStoreType;
- (void)setSSHCertStoreType :(int)newSSHCertStoreType;

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

SSHCertSubject Property (SSHPlex Module)

This is the subject of the certificate used for client authentication.

Syntax

• Swift
• Objective-C

public var sshCertSubject: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSHCertSubject,setter=setSSHCertSubject:) NSString* SSHCertSubject;

- (NSString*)SSHCertSubject;
- (void)setSSHCertSubject :(NSString*)newSSHCertSubject;

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

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

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

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

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

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

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

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

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSHCertSubject(sshCertSubject: String) throws

SSHCompressionAlgorithms Property (SSHPlex Module)

A comma-separated list containing all allowable compression algorithms.

Syntax

• Swift
• Objective-C

public var sshCompressionAlgorithms: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSHCompressionAlgorithms,setter=setSSHCompressionAlgorithms:) NSString* SSHCompressionAlgorithms;

- (NSString*)SSHCompressionAlgorithms;
- (void)setSSHCompressionAlgorithms :(NSString*)newSSHCompressionAlgorithms;

Default Value

"none,zlib"

Remarks

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

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

• zlib
• zlib@openssh.com
• none

SSHEncryptionAlgorithms Property (SSHPlex Module)

A comma-separated list containing all allowable encryption algorithms.

Syntax

• Swift
• Objective-C

public var sshEncryptionAlgorithms: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSHEncryptionAlgorithms,setter=setSSHEncryptionAlgorithms:) NSString* SSHEncryptionAlgorithms;

- (NSString*)SSHEncryptionAlgorithms;
- (void)setSSHEncryptionAlgorithms :(NSString*)newSSHEncryptionAlgorithms;

Default Value

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

Remarks

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

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

SSHHost Property (SSHPlex Module)

The address of the SSH host.

Syntax

• Swift
• Objective-C

public var sshHost: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSHHost,setter=setSSHHost:) NSString* SSHHost;

- (NSString*)SSHHost;
- (void)setSSHHost :(NSString*)newSSHHost;

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.

SSHPassword Property (SSHPlex Module)

The password for SSH password-based authentication.

Syntax

• Swift
• Objective-C

public var sshPassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSHPassword,setter=setSSHPassword:) NSString* SSHPassword;

- (NSString*)SSHPassword;
- (void)setSSHPassword :(NSString*)newSSHPassword;

Default Value

""

Remarks

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

SSHPort Property (SSHPlex Module)

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

Syntax

• Swift
• Objective-C

public var sshPort: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSHPort,setter=setSSHPort:) int SSHPort;

- (int)SSHPort;
- (void)setSSHPort :(int)newSSHPort;

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.

SSHUser Property (SSHPlex Module)

The username for SSH authentication.

Syntax

• Swift
• Objective-C

public var sshUser: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSHUser,setter=setSSHUser:) NSString* SSHUser;

- (NSString*)SSHUser;
- (void)setSSHUser :(NSString*)newSSHUser;

Default Value

""

Remarks

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

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

StartByte Property (SSHPlex Module)

The offset in bytes at which to begin the Upload or Download.

Syntax

• Swift
• Objective-C

public var startByte: Int64 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=startByte,setter=setStartByte:) long long startByte;

- (long long)startByte;
- (void)setStartByte :(long long)newStartByte;

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 in order to only download a specific range of data from the current RemoteFile.

Timeout Property (SSHPlex Module)

A timeout for the module.

Syntax

• Swift
• Objective-C

public var timeout: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;

- (int)timeout;
- (void)setTimeout :(int)newTimeout;

Default Value

60

Remarks

If the Timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If Timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

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

If Timeout expires, and the operation is not yet complete, the class .

Please note that by default, all timeouts are inactivity timeouts, i.e. 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.

Append Method (SSHPlex Module)

Append data from a local file; to a remote file using SFTP.

Syntax

• Swift
• Objective-C

public func append() throws -> String

- (NSString*)append;

Remarks

This method Appends the data from LocalFile to the RemoteFile. The StartTransfer, Transfer, and EndTransfer events provide details about the individual file transfers. If the LocalFile property is "" (empty string) then the file data will be available through the Transfer event.

This method returns an Operation Id which identifies the operation in progress. A corresponding SSHPlexOperation will also be added to the Operations collection. The operation can be canceled by passing the Operation Id to the CancelOperation method.

When the operation completes the AppendComplete event will fire, and the SSHPlexOperation associated with the completed operation will be removed from the Operations collection. Inspect the parameters of the AppendComplete event to determine the result.

If there is no SSH session in place, one is automatically created by the component first.

This method is only applicable when ChannelType is set to cstSftp.

Code Example

SSHPlexControl.Localfile = "C:\localfile.txt"; SSHPlexControl.RemoteFile = "remotefile.txt"; string operationId = SSHPlexControl.Append(); // Use Path in RemoteFile SSHPlexControl.Localfile = "C:\localfile2.txt"; SSHPlexControl.RemoteFile = "folder/remotefile2.txt"; string operationId = SSHPlexControl.Append();

CancelOperation Method (SSHPlex Module)

Cancels the operation specified by OperationId .

Syntax

• Swift
• Objective-C

public func cancelOperation(operationId: String) throws -> Void

- (void)cancelOperation:(NSString*)operationId;

Remarks

When this method is called the Error event will fire and the associated operation's completion event will fire.

For example, if CancelOperation is called for an upload that is in progress, both the Error event and the UploadComplete event will fire.

The SSHPlexOperation associated with the OperationId will be removed from the Operations collection.

ChangeRemotePath Method (SSHPlex Module)

This method changes the current path on the FTP server.

Syntax

• Swift
• Objective-C

public func changeRemotePath(remotePath: String) throws -> Void

- (void)changeRemotePath:(NSString*)remotePath;

Remarks

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

Absolute Paths

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

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 instance:

//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 (SSHPlex Module)

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

Syntax

• Swift
• Objective-C

public func checkFileExists() throws -> Bool

- (BOOL)checkFileExists;

Remarks

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

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

Config Method (SSHPlex Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

Remarks

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

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

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

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

CreateFile Method (SSHPlex Module)

Creates a file on the remote server using SFTP.

Syntax

• Swift
• Objective-C

public func createFile(fileName: String) throws -> String

- (NSString*)createFile:(NSString*)fileName;

Remarks

This method creates an empty file on the server with the name specified by the FileName parameter. FileName is either and absolute path on the server, or a path relative to RemotePath.

This method returns an Operation Id which identifies the operation in progress. A corresponding SSHPlexOperation will also be added to the Operations collection. The operation can be canceled by passing the Operation Id to the CancelOperation method.

When the operation completes the CreateFileComplete event will fire, and the SSHPlexOperation associated with the completed operation will be removed from the Operations collection. Inspect the parameters of the CreateFileComplete event to determine the result.

To upload a file with content use Upload instead.

If there is no SSH session in place, one is automatically created by the component first.

This method is only applicable when ChannelType is set to cstSftp.

DeleteFile Method (SSHPlex Module)

Deletes a file on the remote server using SFTP.

Syntax

• Swift
• Objective-C

public func deleteFile(fileName: String) throws -> String

- (NSString*)deleteFile:(NSString*)fileName;

Remarks

This method deletes a file on the server with the name specified by the FileName parameter. FileName is either and absolute path on the server, or a path relative to RemotePath.

This method returns an Operation Id which identifies the operation in progress. A corresponding SSHPlexOperation will also be added to the Operations collection. The operation can be canceled by passing the Operation Id to the CancelOperation method.

When the operation completes the DeleteFileComplete event will fire, and the SSHPlexOperation associated with the completed operation will be removed from the Operations collection. Inspect the parameters of the DeleteFileComplete event to determine the result.

If there is no SSH session in place, one is automatically created by the component first.

This method is only applicable when ChannelType is set to cstSftp.

DoEvents Method (SSHPlex Module)

Processes events from the internal message queue.

Syntax

• Swift
• Objective-C

public func doEvents() throws -> Void

- (void)doEvents;

Remarks

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

Download Method (SSHPlex Module)

Download a RemoteFile using SFTP or SCP.

Syntax

• Swift
• Objective-C

public func download() throws -> String

- (NSString*)download;

Remarks

This method downloads the remote file specified by RemoteFile to the local file specified by LocalFile. The StartTransfer, Transfer, and EndTransfer events provide details about the individual file transfers. If the LocalFile property is "" (empty string) then the file data will be available through the Transfer event.

This method returns an Operation Id which identifies the operation in progress. A corresponding SSHPlexOperation will also be added to the Operations collection. The operation can be canceled by passing the Operation Id to the CancelOperation method.

When the operation completes the DownloadComplete event will fire, and the SSHPlexOperation associated with the completed operation will be removed from the Operations collection. Inspect the parameters of the DownloadComplete event to determine the result.

If there is no SSH session in place, one is automatically created by the component first.

This method is only applicable when ChannelType is set to cstSftp or cstScp.

Set RemoteFile to the name of the file to download before calling this method. If RemoteFile only specifies a filename it will be downloaded from the path specified by RemotePath. RemoteFile may also be set to an absolute path.

If LocalFile is set the file will be saved to the specified location.

Code Example

SSHPlexControl.Localfile = "C:\localfile.txt"; SSHPlexControl.RemoteFile = "remotefile.txt"; string operationId = SSHPlexControl.Download(); // Use Path in RemoteFile SSHPlexControl.Localfile = "C:\localfile2.txt"; SSHPlexControl.RemoteFile = "folder/remotefile2.txt"; string operationId = SSHPlexControl.Download();

Resuming Downloads

The class also supports resuming failed downloads by using the StartByte property. If a download is interrupted or canceled, set StartByte to the appropriate offset before calling this method to resume the download.

string localFile = "C:\localfile.txt"; SSHPlexControl.Localfile = localFile; SSHPlexControl.RemoteFile = "remotefile.txt"; string operationId = SSHPlexControl.Download(); // Cancel Download using the CancelOperation method SSHPlexControl.CancelOperation(operationId); // Get the size of the partially downloaded temp file and set StartByte SSHPlexControl.StartByte = new FileInfo(localFile).Length; // Resume download string operationId = SSHPlexControl.Download();

Downloading Multiple Files Using a Filemask

Note: Using a filemask for downloads is only applicable when ChannelType is set to cstScp. To download files matching a filemask set RemoteFile to a filemask. The path may be specified as part of the value in RemoteFile or may be set separately in RemotePath. LocalFile should be set to a local directory where files will be downloaded. When Download is called all matching files are downloaded. See RemoteFile for more information.

Execute Method (SSHPlex Module)

Execute a Command on the remote host.

Syntax

• Swift
• Objective-C

public func execute(command: String) throws -> String

- (NSString*)execute:(NSString*)command;

Remarks

This method executes the specified Command on the remote host.

This method returns an Operation Id which identifies the operation in progress. A corresponding SSHPlexOperation will also be added to the Operations collection. The operation can be canceled by passing the Operation Id to the CancelOperation method.

When the operation completes the ExecuteComplete event will fire, and the SSHPlexOperation associated with the completed operation will be removed from the Operations collection. Inspect the parameters of the ExecuteComplete event to determine the result.

If there is no SSH session in place, one is automatically created by the component first.

This method is only applicable when ChannelType is set to cstSExec or cstSShell.

Interrupt Method (SSHPlex Module)

Interrupt the current method.

Syntax

• Swift
• Objective-C

public func interrupt() throws -> Void

- (void)interrupt;

Remarks

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

ListDirectory Method (SSHPlex Module)

List the current directory specified by RemotePath on an server using SFTP.

Syntax

• Swift
• Objective-C

public func listDirectory() throws -> String

- (NSString*)listDirectory;

Remarks

This method lists the directory specified by RemotePath. RemoteFile may also be set to a filemask to list associated files. The file listing is received through the DirList event.

This method returns an Operation Id which identifies the operation in progress. A corresponding SSHPlexOperation will also be added to the Operations collection. The operation can be canceled by passing the Operation Id to the CancelOperation method.

When the operation completes the ListDirectoryComplete event will fire, and the SSHPlexOperation associated with the completed operation will be removed from the Operations collection. Inspect the parameters of the ListDirectoryComplete event to determine the result.

If there is no SSH session in place, one is automatically created by the component first.

This method is only applicable when ChannelType is set to cstSftp.

The directory entries are provided through the DirList event and also via the DirList* properties. SSHPlexControl.RemoteFile = ""; //Clear filemask SSHPlexControl.RemotePath = "MyFolder"; string opId = SSHPlexControl.ListDirectory(); // ListDirectory operates async so we must wait for it to finish while (SSHPlexControl.Operations.Keys.Contains(opId)) { SSHPlexControl.DoEvents(); } for (int i = 0; i < SSHPlexControl.DirList.Count; i++) { Console.WriteLine(SSHPlexControl.DirList[i].FileName); Console.WriteLine(SSHPlexControl.DirList[i].FileSize); Console.WriteLine(SSHPlexControl.DirList[i].FileTime); Console.WriteLine(SSHPlexControl.DirList[i].IsDir); }

The RemoteFile property may also be used as a filemask when listing files. For instance: SSHPlexControl.RemoteFile = "*.txt"; SSHPlexControl.ListDirectory();

Note: Since RemoteFile is used as a filemask be sure to clear or reset this value before calling ListDirectory

MakeDirectory Method (SSHPlex Module)

Creates a directory on the remote server using SFTP.

Syntax

• Swift
• Objective-C

public func makeDirectory(newDir: String) throws -> String

- (NSString*)makeDirectory:(NSString*)newDir;

Remarks

This method creates an empty directory on the server with the name specified by the NewDir parameter. NewDir is either an absolute path on the server, or a path relative to RemotePath.

This method returns an Operation Id which identifies the operation in progress. A corresponding SSHPlexOperation will also be added to the Operations collection. The operation can be canceled by passing the Operation Id to the CancelOperation method.

When the operation completes the MakeDirectoryComplete event will fire, and the SSHPlexOperation associated with the completed operation will be removed from the Operations collection. Inspect the parameters of the MakeDirectoryComplete event to determine the result.

If there is no SSH session in place, one is automatically created by the component first.

This method is only applicable when ChannelType is set to cstSftp.

QueryFileAttributes Method (SSHPlex Module)

Queries the server for the attributes of RemoteFile .

Syntax

• Swift
• Objective-C

public func queryFileAttributes() throws -> Void

- (void)queryFileAttributes;

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.

QueryRemotePath Method (SSHPlex Module)

This queries the server for the current path.

Syntax

• Swift
• Objective-C

public func queryRemotePath() throws -> String

- (NSString*)queryRemotePath;

Remarks

This method queries the server for the current path. When called, the class will issue a command to the server to retrieve the current path value. The return value of this method is the path returned by the server. For instance:

string remotePath = component.QueryRemotePath();

RemoveDirectory Method (SSHPlex Module)

Removes a directory on the remote server using SFTP.

Syntax

• Swift
• Objective-C

public func removeDirectory(dirName: String) throws -> String

- (NSString*)removeDirectory:(NSString*)dirName;

Remarks

This method deletes a directory on the server with the name specified by the DirName parameter. DirName is either and absolute path on the server, or a path relative to RemotePath.

This method returns an Operation Id which identifies the operation in progress. A corresponding SSHPlexOperation will also be added to the Operations collection. The operation can be canceled by passing the Operation Id to the CancelOperation method.

When the operation completes the RemoveDirectoryComplete event will fire, and the SSHPlexOperation associated with the completed operation will be removed from the Operations collection. Inspect the parameters of the RemoveDirectoryComplete event to determine the result.

If there is no SSH session in place, one is automatically created by the component first.

This method is only applicable when ChannelType is set to cstSftp.

RenameFile Method (SSHPlex Module)

Changes the name of a file on the remote server using SFTP.

Syntax

• Swift
• Objective-C

public func renameFile(newName: String) throws -> String

- (NSString*)renameFile:(NSString*)newName;

Remarks

This method renames the file on the server specified by RemoteFile to the name specified by the NewName parameter. RemoteFile and NewName are either absolute paths on the server, or a path relative to RemotePath.

This method returns an Operation Id which identifies the operation in progress. A corresponding SSHPlexOperation will also be added to the Operations collection. The operation can be canceled by passing the Operation Id to the CancelOperation method.

When the operation completes the RenameFileComplete event will fire, and the SSHPlexOperation associated with the completed operation will be removed from the Operations collection. Inspect the parameters of the RenameFileComplete event to determine the result.

If there is no SSH session in place, one is automatically created by the component first.

This method is only applicable when ChannelType is set to cstSftp.

SSHLogoff Method (SSHPlex Module)

Logoff from the SSH server.

Syntax

• Swift
• Objective-C

public func SSHLogoff() throws -> Void

- (void)SSHLogoff;

Remarks

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

SSHLogon Method (SSHPlex Module)

Logon to the SSHHost using the current SSHUser and SSHPassword .

Syntax

• Swift
• Objective-C

public func SSHLogon(sshHost: String, sshPort: Int32) throws -> Void

- (void)SSHLogon:(NSString*)SSHHost :(int)SSHPort;

Remarks

Logon to the SSH server using the current SSHUser and SSHPassword. This will perform the SSH handshake and authentication.

Example (Logging On)

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

UpdateFileAttributes Method (SSHPlex Module)

Instructs the component to send the FileAttributes to the server using SFTP.

Syntax

• Swift
• Objective-C

public func updateFileAttributes() throws -> String

- (NSString*)updateFileAttributes;

Remarks

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

• FileAttributesAccessTime
• FileAttributesACL
• FileAttributesAllocationSize
• FileAttributesAttributeBits
• FileAttributesAttributeBitsValid
• FileAttributesCreationTime
• FileAttributesFileType
• FileAttributesGroupId
• FileAttributesIsDir
• FileAttributesModifiedTime
• FileAttributesOwnerId
• FileAttributesPermissions
• FileAttributesSize

This method returns an Operation Id which identifies the operation in progress. A corresponding SSHPlexOperation will also be added to the Operations collection. The operation can be canceled by passing the Operation Id to the CancelOperation method.

When the operation completes the UpdateFileAttributesComplete event will fire, and the SSHPlexOperation associated with the completed operation will be removed from the Operations collection. Inspect the parameters of the UpdateFileAttributesComplete event to determine the result.

If there is no SSH session in place, one is automatically created by the component first.

This method is only applicable when ChannelType is set to cstSftp.

Upload Method (SSHPlex Module)

Upload a file specified by LocalFile using SCP or SFTP.

Syntax

• Swift
• Objective-C

public func upload() throws -> String

- (NSString*)upload;

Remarks

This method Uploads the local file specified by LocalFile to the remote file specified by RemoteFile. The StartTransfer, Transfer, and EndTransfer events provide details about the individual file transfers. If the LocalFile property is "" (empty string) then the file data will be available through the Transfer event.

This method returns an Operation Id which identifies the operation in progress. A corresponding SSHPlexOperation will also be added to the Operations collection. The operation can be canceled by passing the Operation Id to the CancelOperation method.

When the operation completes the UploadComplete event will fire, and the SSHPlexOperation associated with the completed operation will be removed from the Operations collection. Inspect the parameters of the UploadComplete event to determine the result.

If there is no SSH session in place, one is automatically created by the component first.

This method is only applicable when ChannelType is set to cstSftp or cstScp.

Set LocalFile to the name of the file to upload before calling this method.

RemoteFile should be set to either a relative or absolute path. If RemoteFile is not an absolute path it will be uploaded relative to RemotePath.

Code Example

SSHPlexControl.Localfile = "C:\localfile.txt"; SSHPlexControl.RemoteFile = "remotefile.txt"; string operationId = SSHPlexControl.Upload(); // Use Path in RemoteFile SSHPlexControl.Localfile = "C:\localfile2.txt"; SSHPlexControl.RemoteFile = "folder/remotefile2.txt"; string operationId = SSHPlexControl.Upload();

Resuming Uploads

The class also supports resuming failed uploads by using the StartByte property. If an upload is interrupted or canceled, set StartByte to the appropriate offset before calling this method to resume the upload.

string localFile = "C:\localfile.txt"; SSHPlexControl.Localfile = localFile; SSHPlexControl.RemoteFile = "remotefile.txt"; string operationId = SSHPlexControl.Upload(); // Cancel Upload using the CancelOperation method SSHPlexControl.CancelOperation(operationId); // Get the size of the partially uploaded temp file and set StartByte SSHPlexControl.StartByte = SSHPlexControl.FileAttributes.Size; // Resume upload string operationId = SSHPlexControl.Upload();

AppendComplete Event (SSHPlex Module)

Fired when an Append operation completes.

Syntax

• Swift
• Objective-C

func onAppendComplete(operationId: String, errorCode: Int32, errorDescription: String, localFile: String, remoteFile: String, remotePath: String)

- (void)onAppendComplete:(NSString*)operationId :(int)errorCode :(NSString*)errorDescription :(NSString*)localFile :(NSString*)remoteFile :(NSString*)remotePath;

Remarks

This event fires when an Append operation completes either successfully or unsuccessfully. If the operation succeeded ErrorCode will be 0. If the operation failed or was canceled by CancelOperation ErrorCode will contain a non-zero value and ErrorDescription will contain a description of the error. Please refer to the Error Codes section for possible error codes.

OperationId is the Id of the completed operation. This value will match the Operation Id returned by the method which initiated the operation.

ErrorCode holds the error code (if any). A value of 0 indicates success. A positive value indicates failure.

ErrorDescription is a description of the error.

LocalFile is the local file that was specified when the operation was initiated.

RemoteFile is the remote file that was specified when the operation was initiated.

RemotePath is the remote path that was specified when the operation was initiated.

Connected Event (SSHPlex Module)

This event is fired immediately after a connection completes (or fails).

Syntax

• Swift
• Objective-C

func onConnected(statusCode: Int32, description: String)

- (void)onConnected:(int)statusCode :(NSString*)description;

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 (SSHPlex Module)

This event is fired to indicate changes in the connection state.

Syntax

• Swift
• Objective-C

func onConnectionStatus(connectionEvent: String, statusCode: Int32, description: String)

- (void)onConnectionStatus:(NSString*)connectionEvent :(int)statusCode :(NSString*)description;

Remarks

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

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

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.

CreateFileComplete Event (SSHPlex Module)

Fired when a CreateFile operation completes (or fails).

Syntax

• Swift
• Objective-C

func onCreateFileComplete(operationId: String, errorCode: Int32, errorDescription: String, remoteFile: String, remotePath: String)

- (void)onCreateFileComplete:(NSString*)operationId :(int)errorCode :(NSString*)errorDescription :(NSString*)remoteFile :(NSString*)remotePath;

Remarks

This event fires when a CreateFile operation completes either successfully or unsuccessfully. If the operation succeeded ErrorCode will be 0. If the operation failed or was canceled by CancelOperation ErrorCode will contain a non-zero value and ErrorDescription will contain a description of the error. Please refer to the Error Codes section for possible error codes.

OperationId is the Id of the completed operation. This value will match the Operation Id returned by the method which initiated the operation.

ErrorCode holds the error code (if any). A value of 0 indicates success. A positive value indicates failure.

ErrorDescription is a description of the error.

RemoteFile is the remote file that was specified when the operation was initiated.

RemotePath is the remote path that was specified when the operation was initiated.

DeleteFileComplete Event (SSHPlex Module)

Fired when a DeleteFile operation completes (or fails).

Syntax

• Swift
• Objective-C

func onDeleteFileComplete(operationId: String, errorCode: Int32, errorDescription: String, remoteFile: String, remotePath: String)

- (void)onDeleteFileComplete:(NSString*)operationId :(int)errorCode :(NSString*)errorDescription :(NSString*)remoteFile :(NSString*)remotePath;

Remarks

This event fires when a DeleteFile operation completes either successfully or unsuccessfully. If the operation succeeded ErrorCode will be 0. If the operation failed or was canceled by CancelOperation ErrorCode will contain a non-zero value and ErrorDescription will contain a description of the error. Please refer to the Error Codes section for possible error codes.

OperationId is the Id of the completed operation. This value will match the Operation Id returned by the method which initiated the operation.

ErrorCode holds the error code (if any). A value of 0 indicates success. A positive value indicates failure.

ErrorDescription is a description of the error.

RemoteFile is the remote file that was specified when the operation was initiated.

RemotePath is the remote path that was specified when the operation was initiated.

DirList Event (SSHPlex Module)

Fired when a directory entry is received.

Syntax

• Swift
• Objective-C

func onDirList(operationId: String, dirEntry: String, fileName: String, isDir: Bool, fileSize: Int64, fileTime: String, isSymlink: Bool)

- (void)onDirList:(NSString*)operationId :(NSString*)dirEntry :(NSString*)fileName :(BOOL)isDir :(long long)fileSize :(NSString*)fileTime :(BOOL)isSymlink;

Remarks

OperationId is associated with the operation that fired this event.

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

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

The DirEntry parameter contains the filename when ListDirectory is called.

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

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

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

Disconnected Event (SSHPlex Module)

This event is fired when a connection is closed.

Syntax

• Swift
• Objective-C

func onDisconnected(statusCode: Int32, description: String)

- (void)onDisconnected:(int)statusCode :(NSString*)description;

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.

DownloadComplete Event (SSHPlex Module)

Fired when a Download operation completes (or fails).

Syntax

• Swift
• Objective-C

func onDownloadComplete(operationId: String, errorCode: Int32, errorDescription: String, localFile: String, remoteFile: String, remotePath: String)

- (void)onDownloadComplete:(NSString*)operationId :(int)errorCode :(NSString*)errorDescription :(NSString*)localFile :(NSString*)remoteFile :(NSString*)remotePath;

Remarks

This event fires when a Download operation completes either successfully or unsuccessfully. If the operation succeeded ErrorCode will be 0. If the operation failed or was canceled by CancelOperation ErrorCode will contain a non-zero value and ErrorDescription will contain a description of the error. Please refer to the Error Codes section for possible error codes.

OperationId is the Id of the completed operation. This value will match the Operation Id returned by the method which initiated the operation.

ErrorCode holds the error code (if any). A value of 0 indicates success. A positive value indicates failure.

ErrorDescription is a description of the error.

LocalFile is the local file that was specified when the operation was initiated.

RemoteFile is the remote file that was specified when the operation was initiated.

RemotePath is the remote path that was specified when the operation was initiated.

EndTransfer Event (SSHPlex Module)

Fired when a file completes downloading/uploading.

Syntax

• Swift
• Objective-C

func onEndTransfer(operationId: String, direction: Int32, localFile: String, remoteFile: String, remotePath: String)

- (void)onEndTransfer:(NSString*)operationId :(int)direction :(NSString*)localFile :(NSString*)remoteFile :(NSString*)remotePath;

Remarks

This event is fired once per file when it finishes downloading/uploading.

OperationId is the string associated with operation fired this event.

Direction is 0 for Uploads and 1 for Downloads.

LocalFile, RemoteFile, and RemotePath are populated with values of LocalFile, RemoteFile, and RemotePath, respectively, that are associated with the method that triggered this event.

Error Event (SSHPlex Module)

Information about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(operationId: String, errorCode: Int32, description: String, localFile: String, remoteFile: String)

- (void)onError:(NSString*)operationId :(int)errorCode :(NSString*)description :(NSString*)localFile :(NSString*)remoteFile;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

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

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

ExecuteComplete Event (SSHPlex Module)

Fired when an Execute operation completes (or fails).

Syntax

• Swift
• Objective-C

func onExecuteComplete(operationId: String, errorCode: Int32, errorDescription: String, exitStatus: Int32)

- (void)onExecuteComplete:(NSString*)operationId :(int)errorCode :(NSString*)errorDescription :(int)exitStatus;

Remarks

This event fires when an Execute operation completes either successfully or unsuccessfully. If the operation succeeded ErrorCode will be 0. If the operation failed or was canceled by CancelOperation ErrorCode will contain a non-zero value and ErrorDescription will contain a description of the error. Please refer to the Error Codes section for possible error codes.

OperationId is the Id of the completed operation. This value will match the Operation Id returned by the method which initiated the operation.

ErrorCode holds the error code (if any). A value of 0 indicates success. A positive value indicates failure.

ErrorDescription is a description of the error.

ExitStatus is the exit code of the executed command. If an error message is returned it is present in ErrorDescription.

ListDirectoryComplete Event (SSHPlex Module)

Fired when a ListDirectory operation completes (or fails).

Syntax

• Swift
• Objective-C

func onListDirectoryComplete(operationId: String, errorCode: Int32, errorDescription: String, remotePath: String)

- (void)onListDirectoryComplete:(NSString*)operationId :(int)errorCode :(NSString*)errorDescription :(NSString*)remotePath;

Remarks

This event fires when a ListDirectory operation completes either successfully or unsuccessfully. If the operation succeeded ErrorCode will be 0. If the operation failed or was canceled by CancelOperation ErrorCode will contain a non-zero value and ErrorDescription will contain a description of the error. Please refer to the Error Codes section for possible error codes.

OperationId is the Id of the completed operation. This value will match the Operation Id returned by the method which initiated the operation.

ErrorCode holds the error code (if any). A value of 0 indicates success. A positive value indicates failure.

ErrorDescription is a description of the error.

RemotePath is the remote path that was specified when the operation was initiated.

Log Event (SSHPlex Module)

Fires once for each log message.

Syntax

• Swift
• Objective-C

func onLog(logLevel: Int32, message: String, logType: String)

- (void)onLog:(int)logLevel :(NSString*)message :(NSString*)logType;

Remarks

This event fires once for each log messages generated by the class. The verbosity is controlled by the LogLevel setting.

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

Message is the log message.

LogType is reserved for future use.

MakeDirectoryComplete Event (SSHPlex Module)

Fired when a MakeDirectory operation completes (or fails).

Syntax

• Swift
• Objective-C

func onMakeDirectoryComplete(operationId: String, errorCode: Int32, errorDescription: String, remotePath: String)

- (void)onMakeDirectoryComplete:(NSString*)operationId :(int)errorCode :(NSString*)errorDescription :(NSString*)remotePath;

Remarks

This event fires when a MakeDirectory operation completes either successfully or unsuccessfully. If the operation succeeded ErrorCode will be 0. If the operation failed or was canceled by CancelOperation ErrorCode will contain a non-zero value and ErrorDescription will contain a description of the error. Please refer to the Error Codes section for possible error codes.

OperationId is the Id of the completed operation. This value will match the Operation Id returned by the method which initiated the operation.

ErrorCode holds the error code (if any). A value of 0 indicates success. A positive value indicates failure.

ErrorDescription is a description of the error.

RemotePath is the remote path that was specified when the operation was initiated.

RemoveDirectoryComplete Event (SSHPlex Module)

Fired when a RemoveDirectory operation completes (or fails).

Syntax

• Swift
• Objective-C

func onRemoveDirectoryComplete(operationId: String, errorCode: Int32, errorDescription: String, directoryName: String, remotePath: String)

- (void)onRemoveDirectoryComplete:(NSString*)operationId :(int)errorCode :(NSString*)errorDescription :(NSString*)directoryName :(NSString*)remotePath;

Remarks

This event fires when a RemoveDirectory operation completes either successfully or unsuccessfully. If the operation succeeded ErrorCode will be 0. If the operation failed or was canceled by CancelOperation ErrorCode will contain a non-zero value and ErrorDescription will contain a description of the error. Please refer to the Error Codes section for possible error codes.

OperationId is the Id of the completed operation. This value will match the Operation Id returned by the method which initiated the operation.

ErrorCode holds the error code (if any). A value of 0 indicates success. A positive value indicates failure.

ErrorDescription is a description of the error.

DirectoryName is the name of the directory which was removed.

RemotePath is the remote path that was specified when the operation was initiated.

RenameFileComplete Event (SSHPlex Module)

Fired when a RenameFile operation completes (or fails).

Syntax

• Swift
• Objective-C

func onRenameFileComplete(operationId: String, errorCode: Int32, errorDescription: String, remoteFile: String, remotePath: String, newFileName: String)

- (void)onRenameFileComplete:(NSString*)operationId :(int)errorCode :(NSString*)errorDescription :(NSString*)remoteFile :(NSString*)remotePath :(NSString*)newFileName;

Remarks

This event fires when a RenameFile operation completes either successfully or unsuccessfully. If the operation succeeded ErrorCode will be 0. If the operation failed or was canceled by CancelOperation ErrorCode will contain a non-zero value and ErrorDescription will contain a description of the error. Please refer to the Error Codes section for possible error codes.

OperationId is the Id of the completed operation. This value will match the Operation Id returned by the method which initiated the operation.

ErrorCode holds the error code (if any). A value of 0 indicates success. A positive value indicates failure.

ErrorDescription is a description of the error.

RemoteFile is the remote file that was specified when the operation was initiated.

RemotePath is the remote path that was specified when the operation was initiated.

NewFileName is the name to which the file was renamed as provided when RenameFile was originally called.

SSHCustomAuth Event (SSHPlex Module)

Fired when the component is doing custom authentication.

Syntax

• Swift
• Objective-C

func onSSHCustomAuth(packet: inout String)

- (void)onSSHCustomAuth:(NSString**)packet;

Remarks

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

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

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

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

SSHKeyboardInteractive Event (SSHPlex Module)

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

Syntax

• Swift
• Objective-C

func onSSHKeyboardInteractive(name: String, instructions: String, prompt: String, response: inout String, echoResponse: Bool)

- (void)onSSHKeyboardInteractive:(NSString*)name :(NSString*)instructions :(NSString*)prompt :(NSString**)response :(BOOL)echoResponse;

Remarks

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

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

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

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

SSHServerAuthentication Event (SSHPlex Module)

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

Syntax

• Swift
• Objective-C

func onSSHServerAuthentication(hostKey: Data, fingerprint: String, keyAlgorithm: String, certSubject: String, certIssuer: String, status: String, accept: inout Bool)

- (void)onSSHServerAuthentication:(NSData*)hostKey :(NSString*)fingerprint :(NSString*)keyAlgorithm :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;

Remarks

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

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

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

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

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

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

KeyAlgorithm identifies the host key algorithm. Supported values are:

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

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

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

Status is reserved for future use.

SSHStatus Event (SSHPlex Module)

Shows the progress of the secure connection.

Syntax

• Swift
• Objective-C

func onSSHStatus(message: String)

- (void)onSSHStatus:(NSString*)message;

Remarks

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

StartTransfer Event (SSHPlex Module)

Fired when a file starts downloading/uploading.

Syntax

• Swift
• Objective-C

func onStartTransfer(operationId: String, direction: Int32, localFile: String, remoteFile: String, remotePath: String, filePermissions: inout String)

- (void)onStartTransfer:(NSString*)operationId :(int)direction :(NSString*)localFile :(NSString*)remoteFile :(NSString*)remotePath :(NSString**)filePermissions;

Remarks

This event is fired once per file when it starts downloading/uploading.

OperationId is the string associated with operation fired this event.

Direction is 0 for Uploads and 1 for Downloads.

LocalFile, RemoteFile, and RemotePath are populated with values of LocalFile, RemoteFile, and RemotePath, respectively, that are associated with the method that triggered this event.

FilePermissions includes information about the file that can be modified before finishing the upload/download.

Stderr Event (SSHPlex Module)

Fired when data (complete lines) come in through stderr.

Syntax

• Swift
• Objective-C

func onStderr(operationId: String, text: Data)

- (void)onStderr:(NSString*)operationId :(NSData*)text;

Remarks

The Stderr event is fired every time the process on the remote host outputs a line in its error output. The incoming data is provided through the Text parameter.

Stdout Event (SSHPlex Module)

Fired when data (complete lines) come in through stdout.

Syntax

• Swift
• Objective-C

func onStdout(operationId: String, text: Data)

- (void)onStdout:(NSString*)operationId :(NSData*)text;

Remarks

The Stdout event is fired every time the process on the remote host outputs a line in its standard output. The incoming data is provided through the Text parameter.

Transfer Event (SSHPlex Module)

Fired during file download/upload.

Syntax

• Swift
• Objective-C

func onTransfer(operationId: String, direction: Int32, localFile: String, remoteFile: String, remotePath: String, bytesTransferred: Int64, percentDone: Int32, text: Data, cancel: inout Bool)

- (void)onTransfer:(NSString*)operationId :(int)direction :(NSString*)localFile :(NSString*)remoteFile :(NSString*)remotePath :(long long)bytesTransferred :(int)percentDone :(NSData*)text :(int*)cancel;

Remarks

This event is fired once per file when it starts downloading/uploading.

OperationId is associated with the operation that fired this event. Direction is 0 for Uploads and 1 for Downloads. LocalFile, RemoteFile, and RemotePath are populated with values of LocalFile, RemoteFile, and RemotePath, respectively, that are associated with the operation that fired this event.

BytesTransferred shows the number of bytes transferred since the beginning of the transfer, and PercentDone contains the percentage (0-100) of bytes transferred based on the Direction being transferred. If PercentDone cannot be calculated the value will be -1.

Text contains the text of the file being transferred.

Setting Cancel to true will cancel the associated operation without firing a DownloadComplete or UploadComplete event. It is not equivalent to calling CancelOperation with the associated OperationId, which will fire the aforementioned events.

UpdateFileAttributesComplete Event (SSHPlex Module)

Fired when a UpdateFileAttributes operation completes (or fails).

Syntax

• Swift
• Objective-C

func onUpdateFileAttributesComplete(operationId: String, errorCode: Int32, errorDescription: String, remoteFile: String, remotePath: String)

- (void)onUpdateFileAttributesComplete:(NSString*)operationId :(int)errorCode :(NSString*)errorDescription :(NSString*)remoteFile :(NSString*)remotePath;

Remarks

This event fires when an UpdateFileAttributes operation completes either successfully or unsuccessfully. If the operation succeeded ErrorCode will be 0. If the operation failed or was canceled by CancelOperation ErrorCode will contain a non-zero value and ErrorDescription will contain a description of the error. Please refer to the Error Codes section for possible error codes.

OperationId is the Id of the completed operation. This value will match the Operation Id returned by the method which initiated the operation.

ErrorCode holds the error code (if any). A value of 0 indicates success. A positive value indicates failure.

ErrorDescription is a description of the error.

RemoteFile is the remote file that was specified when the operation was initiated.

RemotePath is the remote path that was specified when the operation was initiated.

UploadComplete Event (SSHPlex Module)

Fired when an Upload operation completes (or fails).

Syntax

• Swift
• Objective-C

func onUploadComplete(operationId: String, errorCode: Int32, errorDescription: String, localFile: String, remoteFile: String, remotePath: String)

- (void)onUploadComplete:(NSString*)operationId :(int)errorCode :(NSString*)errorDescription :(NSString*)localFile :(NSString*)remoteFile :(NSString*)remotePath;

Remarks

This event fires when an Upload operation completes either successfully or unsuccessfully. If the operation succeeded ErrorCode will be 0. If the operation failed or was canceled by CancelOperation ErrorCode will contain a non-zero value and ErrorDescription will contain a description of the error. Please refer to the Error Codes section for possible error codes.

OperationId is the Id of the completed operation. This value will match the Operation Id returned by the method which initiated the operation.

ErrorCode holds the error code (if any). A value of 0 indicates success. A positive value indicates failure.

ErrorDescription is a description of the error.

LocalFile is the local file that was specified when the operation was initiated.

RemoteFile is the remote file that was specified when the operation was initiated.

RemotePath is the remote path that was specified when the operation was initiated.

DirEntry Type

This is a listing in a directory returned from the server.

Remarks

The DirEntry listings are filled out by the class when a directory listing is received as a response to a ListDirectory or ListDirectoryLong call. The server returns a listing for each directory and file at the current path that exists. This listing is parsed into a directory entry.

If ListDirectoryLong is called, all of the fields listed below are supplied by the server. When the ListDirectory method is called, however, the , , and fields all are left empty by the server. In this case, the only field it returns is the .

The full line for the directory entry is provided by the field.

Fields

Constructors

public init()

Firewall Type

This is the firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the .

Fields

Constructors

public init()

SFTPFileAttributes Type

A set of attributes for a file existing on an SFTP server..

Remarks

This type describes a file residing on an SFTP server.

Fields

SSHPlexOperation Type

This object contains information about a currently running operation.

Remarks

A SSHPlexOperation object is created and added to the Operations collection each time a relevant method is called. The object will be removed from the Operations collection when the operation completes, fails, or is canceled by the CancelOperation method.

Fields

Config Settings (SSHPlex Module)

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