IPWorks SSH 2022 macOS Edition
Version 22.0 [Build 8369]

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

The SSHHost and SSHPort properties specify the SSH server to use. The SSHUser and SSHPassword properties allow the client to authenticate itself with the server. The SSHServerAuthentication event and/or SSHAcceptServerHostKey property allow you to check the server identity. Finally, the SSHStatus event provides information about the SSH handshake.

Example (Logging On)

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

Channel Types

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

ChannelTypeDescriptionApplicable MethodsApplicable Properties
0 (cstSShell - default) An interactive shell for command execution
  • Command
  • Stdin
1 (cstSExec) Command execution using SExec
  • Command
  • Stdin
2 (cstScp) SCP File Transfer
3 (cstSftp) SFTP File Transfer

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.

ChannelTypeSpecifies the Channel Type to be used by the module.
ConnectedThis shows whether the module is connected.
DirListCollection of entries resulting in the last directory listing.
FileAttributesThe attributes of the RemoteFile .
FilePermissionsThe file permissions for the RemoteFile .
FirewallA set of properties related to firewall access.
LocalFileThe path to a local file for upload/download.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the module binds.
OperationsThis collection contains all running operations.
OverwriteWhether or not the module should overwrite files during transfer.
RemoteFileThe name of the remote file for uploading, downloading, etc.
SSHAcceptServerHostKeyEncodedThis is the certificate (PEM/base64 encoded).
SSHAuthModeThe authentication method to be used the module when calling SSHLogon .
SSHCertEncodedThis is the certificate (PEM/base64 encoded).
SSHCertStoreThis is the name of the certificate store for the client certificate.
SSHCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSHCertStoreTypeThis is the type of certificate store for this certificate.
SSHCertSubjectThis is the subject of the certificate used for client authentication.
SSHCompressionAlgorithmsA comma-separated list containing all allowable compression algorithms.
SSHEncryptionAlgorithmsA comma-separated list containing all allowable encryption algorithms.
SSHHostThe address of the SSH host.
SSHPasswordThe password for SSH password-based authentication.
SSHPortThe port on the SSH server where the SSH service is running; by default, 22.
SSHUserThe username for SSH authentication.
StartByteThe offset in bytes at which to begin the Upload or Download.
TimeoutA timeout for the module.

Method List


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

AppendAppend data from a local file; to a remote file using SFTP.
CancelOperationCancels the operation specified by OperationId .
ChangeRemotePathThis method changes the current path on the FTP server.
CheckFileExistsReturns if the file specified by RemoteFile exists on the remote server.
ConfigSets or retrieves a configuration setting.
CreateFileCreates a file on the remote server using SFTP.
DeleteFileDeletes a file on the remote server using SFTP.
DoEventsProcesses events from the internal message queue.
DownloadDownload a RemoteFile using SFTP or SCP.
ExecuteExecute a Command on the remote host.
InterruptInterrupt the current method.
ListDirectoryList the current directory specified by RemotePath on an server using SFTP.
MakeDirectoryCreates a directory on the remote server using SFTP.
QueryFileAttributesQueries the server for the attributes of RemoteFile .
QueryRemotePathThis queries the server for the current path.
RemoveDirectoryRemoves a directory on the remote server using SFTP.
RenameFileChanges the name of a file on the remote server using SFTP.
SSHLogoffLogoff from the SSH server.
SSHLogonLogon to the SSHHost using the current SSHUser and SSHPassword .
UpdateFileAttributesInstructs the module to send the FileAttributes to the server using SFTP.
UploadUpload a file specified by LocalFile using SCP or SFTP.

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.

AppendCompleteFired when an Append operation completes.
ConnectedThis event is fired immediately after a connection completes (or fails).
ConnectionStatusThis event is fired to indicate changes in the connection state.
CreateFileCompleteFired when a CreateFile operation completes (or fails).
DeleteFileCompleteFired when a DeleteFile operation completes (or fails).
DirListFired when a directory entry is received.
DisconnectedThis event is fired when a connection is closed.
DownloadCompleteFired when a Download operation completes (or fails).
EndTransferFired when a file completes downloading/uploading.
ErrorInformation about errors during data delivery.
ExecuteCompleteFired when an Execute operation completes (or fails).
ListDirectoryCompleteFired when a ListDirectory operation completes (or fails).
LogFires once for each log message.
MakeDirectoryCompleteFired when a MakeDirectory operation completes (or fails).
RemoveDirectoryCompleteFired when a RemoveDirectory operation completes (or fails).
RenameFileCompleteFired when a RenameFile operation completes (or fails).
SSHCustomAuthFired when the module is doing custom authentication.
SSHKeyboardInteractiveFired when the module receives a request for user input from the server.
SSHServerAuthenticationFired after the server presents its public key to the client.
SSHStatusShows the progress of the secure connection.
StartTransferFired when a file starts downloading/uploading.
StderrFired when data (complete lines) come in through stderr.
StdoutFired when data (complete lines) come in through stdout.
TransferFired during file download/upload.
UpdateFileAttributesCompleteFired when a UpdateFileAttributes operation completes (or fails).
UploadCompleteFired when an Upload operation completes (or fails).

Config Settings


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

AllowBackslashInNameWhether backslashes are allowed in folder and file names.
AsyncTransferControls whether simultatenous requests are made to read or write files.
AttrAccessTimeCan be queried for the AccessTime file attribute during the DirList event.
AttrCreationTimeCan be queried for the CreationTime file attribute during the DirList event.
AttrFileTypeCan be queried for the FileType file attribute during the DirList event.
AttrGroupIdCan be queried for the GroupId file attribute during the DirList event.
AttrLinkCountCan be queried for the LinkCount file attribute during the DirList event.
AttrOwnerIdCan be queried for the OwnerId file attribute during the DirList event.
AttrPermissionCan be queried for the Permissions file attribute during the DirList event.
CheckFileHashCompares a server-computed hash with a hash calculated locally.
DisableRealPathControls whether or not the SSH_FXP_REALPATH request is sent.
ExcludeFileMaskSpecifies a file mask for excluding files in directory listings.
FileMaskDelimiterSpecifies a delimiter to use for setting multiple file masks in the RemoteFile property.
FiletimeFormatSpecifies the format to use when returning filetime strings.
FreeSpaceThe free space on the remote server in bytes.
GetSpaceInfoQueries the server for drive usage information.
GetSymlinkAttrsWhether to get the attributes of the symbolic link, or the resource pointed to by the link.
IgnoreFileMaskCasingControls whether or not the file mask is case sensitive.
LocalEOLWhen TransferMode is set, this specifies the line ending for the local system.
LogSFTPFileDataWhether SFTP file data is present in Debug logs.
MaskSensitiveMasks passwords in logs.
MaxFileDataSpecifies the maximum payload size of an SFTP packet.
MaxOutstandingPacketsSets the maximum number of simultaneous read or write requests allowed.
NegotiatedProtocolVersionThe negotiated SFTP version.
NormalizeRemotePathWhether to normalize the RemotePath.
PreserveFileTimePreserves the file's timestamps during transfer.
ProtocolVersionThe highest allowable SFTP version to use.
ReadLinkThis settings returns the target of a specified symbolic link.
RealTimeUploadEnables real time uploading.
RealTimeUploadAgeLimitThe age limit in seconds when using RealTimeUpload.
ServerEOLWhen TransferMode is set, this specifies the line ending for the remote system.
SimultaneousTransferLimitThe maximum number of simultaneous file transfers.
TotalSpaceThe total space on the remote server in bytes.
TransferModeThe transfer mode (ASCII or Binary).
TransferredDataLimitSpecifies the maximum number of bytes to download from the remote file.
UseFxpStatWhether SSH_FXP_STAT is sent.
UseServerFileTimeControls if the file time returned from the server is converted to local time or not.
UseServerFileTimeControls if the file time returned from the server is converted to local time or not.
DirectoryPermissionsThe permissions of folders created on the remote host.
LastAccessedTimeThe last accessed time of the remote file.
LastModifiedTimeThe last modified time of the remote file.
PreserveFileTimePreserves the file's modified time during transfer.
RecursiveModeIf set to true the module will recursively upload or download files.
ServerResponseWindowThe time to wait for a server response in milliseconds.
DisconnectOnChannelCloseWhether to automatically close the connection when a channel is closed.
EncodedTerminalModesThe terminal mode to set when communicating with the SSH host.
FallbackKeyboardAuthWhether to attempt keyboard authorization after another authorization method has failed.
ShellPromptThe character sequence of the prompt on the SSH host to wait for.
StdInFileThe file to use as Stdin data.
StripANSIWhether to remove ANSI escape sequences.
TerminalHeightThe height of the terminal display.
TerminalModesThe terminal mode to set when communicating with the SSH host.
TerminalTypeThe terminal type the module will use when connecting to a server.
TerminalUsePixelWhether the terminal's dimensions are in columns/rows or pixels.
TerminalWidthThe width of the terminal display.
UpdateTerminalSizeUsed to update the terminal size.
DisconnectOnChannelCloseWhether to automatically close the connection when a channel is closed.
EncodedTerminalModesThe terminal mode to set when communicating with the SSH host.
StdInFileThe file to use as Stdin data.
TerminalHeightThe height of the terminal display.
TerminalModesThe terminal mode to set when communicating with the SSH host.
TerminalUsePixelWhether the terminal's dimensions are in columns/rows or pixels.
TerminalWidthThe width of the terminal display.
ClientSSHVersionStringThe SSH version string used by the module.
EnablePageantAuthWhether to use a key stored in Pageant to perform client authentication.
KerberosDelegationIf true, asks for credentials with delegation enabled during authentication.
KerberosRealmThe fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication.
KerberosSPNThe Kerberos Service Principal Name of the SSH host.
KeyRenegotiationThresholdSets the threshold for the SSH Key Renegotiation.
LogLevelSpecifies the level of detail that is logged.
MaxPacketSizeThe maximum packet size of the channel, in bytes.
MaxWindowSizeThe maximum window size allowed for the channel, in bytes.
PasswordPromptThe text of the password prompt used in keyboard-interactive authentication.
PreferredDHGroupBitsThe size (in bits) of the preferred modulus (p) to request from the server.
RecordLengthThe length of received data records.
ServerSSHVersionStringThe remote host's SSH version string.
SignedSSHCertThe CA signed client public key used when authenticating.
SSHAcceptAnyServerHostKeyIf set the module will accept any key presented by the server.
SSHAcceptServerCAKeyThe CA public key that signed the server's host key.
SSHAcceptServerHostKeyFingerPrintThe fingerprint of the server key to accept.
SSHFingerprintHashAlgorithmThe algorithm used to calculate the fingerprint.
SSHFingerprintMD5The server hostkey's MD5 fingerprint.
SSHFingerprintSHA1The server hostkey's SHA1 fingerprint.
SSHFingerprintSHA256The server hostkey's SHA256 fingerprint.
SSHKeepAliveCountMaxThe maximum number of keep alive packets to send without a response.
SSHKeepAliveIntervalThe interval between keep alive packets.
SSHKeyExchangeAlgorithmsSpecifies the supported key exchange algorithms.
SSHKeyRenegotiateCauses the module to renegotiate the SSH keys.
SSHMacAlgorithmsSpecifies the supported Mac algorithms.
SSHPubKeyAuthSigAlgorithmsSpecifies the enabled signature algorithms that may be used when attempting public key authentication.
SSHPublicKeyAlgorithmsSpecifies the supported public key algorithms for the server's public key.
SSHVersionPatternThe pattern used to match the remote host's version string.
TryAllAvailableAuthMethodsIf set to true, the module will try all available authentication methods.
WaitForChannelCloseWhether to wait for channels to be closed before disconnected.
WaitForServerDisconnectWhether to wait for the server to close the connection.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the module whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the module binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the module whether or not to use the system security libraries or an internal implementation.

ChannelType Property (SSHPlex Module)

Specifies the Channel Type to be used by the module.

Syntax

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:

ChannelTypeDescriptionApplicable MethodsApplicable Properties
0 (cstSShell - default) An interactive shell for command execution
  • Command
  • Stdin
1 (cstSExec) Command execution using SExec
  • Command
  • Stdin
2 (cstScp) SCP File Transfer
3 (cstSftp) SFTP File Transfer

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

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

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

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

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:

1 (001)Execute
2 (010)Write
4 (100)Read

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

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

1 (001)Sticky Bit - retain the file in memory for performance
2 (010)Set GID - sets the group ID of the process to the file's group ID upon execution (only for executable files)
4 (100)Set UID - sets the user ID of the process to the file's user ID upon execution (only for executable files)

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

Firewall Property (SSHPlex Module)

A set of properties related to firewall access.

Syntax

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

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

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

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

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

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

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:

? Any single character.
* Any characters or no characters (e.g., C*t matches Cat, Cot, Coast, Ct).
[,-] A range of characters (e.g., [a-z], [a], [0-9], [0-9,a-d,f,r-z]).
\ The slash is ignored and exact matching is performed on the next character.

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

CharacterEscape Sequence
? [?]
* [*]
[ [[]
\ [\]

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

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

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:

amNone (0)No authentication will be performed. The current SSHUser value is ignored, and the connection will be logged in as anonymous.
amMultiFactor (1)This allows the class to attempt a multi-step authentication process. The class will send authentication data to the server based on the list of methods allowed for the current user and the authentication property values supplied. The class will continue to send authentication data until the server acknowledges authentication success. If the server rejects an authentication step, the class .
amPassword (2)The class will use the values of SSHUser and SSHPassword to authenticate the user.
amPublicKey (3)The class will use the values of SSHUser and the SSHCert* properties to authenticate the user. the SSHCert* properties must have a private key available for this authentication method to succeed.
amKeyboardInteractive (4)At the time of authentication, the class will fire the SSHKeyboardInteractive event containing instructions on how to complete the authentication step. (NOTE: amKeyboardInteractive is not supported in SSHTunnel).
amGSSAPIWithMic (5)This allows the class to attempt Kerberos authentication using the GSSAPI-WITH-MIC scheme. The client will try Kerberos authentication using the value of SSHUser (single sign-on), or if SSHPassword is specified as well, it will try Kerberos authentication with alternate credentials. This is currently supported only in the .NET client.
amCustom (6)This allows the class caller to take over the authentication process completely. When amCustom is set, the class will fire the SSHCustomAuth event as necessary to complete the authentication process.

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

SSHCertEncoded Property (SSHPlex Module)

This is the certificate (PEM/base64 encoded).

Syntax

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

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:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. 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

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

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:

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
20 (cstSecurityKey)The certificate is present on a physical security key accessible via a PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstSecurityKey, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the SSHCertStore and set SSHCertStorePassword to the PIN.

Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstSecurityKey; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstSecurityKey, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

SSHCertSubject Property (SSHPlex Module)

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

Syntax

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.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

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

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:

aes256-ctr256-bit AES encryption in CTR mode
aes256-cbc256-bit AES encryption in CBC mode
aes192-ctr192-bit AES encryption in CTR mode
aes192-cbc192-bit AES encryption in CBC mode
aes128-ctr128-bit AES encryption in CTR mode
aes128-cbc128-bit AES encryption in CBC mode
3des-ctr192-bit (3-key) triple DES encryption in CTR mode
3des-cbc192-bit (3-key) triple DES encryption in CBC mode
cast128-cbcCAST-128 encryption
blowfish-cbcBlowfish encryption
arcfourARC4 encryption
arcfour128128-bit ARC4 encryption
arcfour256256-bit ARC4 encryption
aes256-gcm@openssh.com256-bit AES encryption in GCM mode.
aes128-gcm@openssh.com128-bit AES encryption in GCM mode.
chacha20-poly1305@openssh.comChaCha20 with Poly1305-AES encryption.

SSHHost Property (SSHPlex Module)

The address of the SSH host.

Syntax

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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:

Firewall connection complete.
Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable).
Remote host connection complete.
Remote host disconnected.
SSL or S/Shell connection broken.
Firewall host disconnected.

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

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

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

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

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

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

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

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

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

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

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:

0 (None) No messages are logged.
1 (Info - Default) Informational events such as SSH handshake messages are logged.
2 (Verbose) Detailed data such as individual packet information is logged.
3 (Debug) Debug data including all relevant sent and received bytes are logged.

Message is the log message.

LogType is reserved for future use.

MakeDirectoryComplete Event (SSHPlex Module)

Fired when a MakeDirectory operation completes (or fails).

Syntax

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

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

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

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

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

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
To limit the accepted host key algorithms refer to SSHPublicKeyAlgorithms.

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

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

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

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

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

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

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

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

entry
String

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

fileName
String

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

fileSize
Int64

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

fileTime
String

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

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

isDir
Bool

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

isSymlink
Bool

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

Constructors

public 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

autoDetect
Bool

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

firewallType
FirewallTypes

This property determines the type of firewall to connect through. The applicable values are as follows:

fwNone (0)No firewall (default setting).
fwTunnel (1)Connect through a tunneling proxy. is set to 80.
fwSOCKS4 (2)Connect through a SOCKS4 Proxy. is set to 1080.
fwSOCKS5 (3)Connect through a SOCKS5 Proxy. is set to 1080.
fwSOCKS4A (10)Connect through a SOCKS4A Proxy. is set to 1080.

host
String

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

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class .

password
String

This property contains a password if authentication is to be used when connecting through the firewall. If is specified, the and properties are used to connect and authenticate to the given firewall. If the authentication fails, the class .

port
Int32

This property contains the transmission control protocol (TCP) port for the firewall . See the description of the property for details.

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

user
String

This property contains a user name if authentication is to be used connecting through a firewall. If the is specified, this property and properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class .

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

accessTime
Int64

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

accessTimeNanos
Int32

A subsecond value associated with this file's .

acl
String

A string containing an Access Control List (ACL).

allocationSize
Int64

The size, in bytes, that this file consumes on disk.

attributeBits
Int32

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

This field can have one or more of the following values OR'd together:

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

attributeBitsValid
Int32

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

This field can have one or more of the following values OR'd together:

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

creationTime
Int64

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

creationTimeNanos
Int32

A subsecond value associated with this file's .

fileType
SFTPFileTypes

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

1 (sftRegular - default)A normal file.
2 (sftDirectory)A directory.
3 (symlink)The file is a Unix symbolic link.
4 (sftSpecial)The file type is a special system file.
5 (sftUnknown)The file type is unknown.
6 (sftSocket)The file handle is a socket handle.
7 (sftCharDevice)The file handle is a character input device.
8 (sftBlockDevice)The file handle is a block input device.
9 (sftpFIFO)The file handle is a buffering input device.

flags
Int32

is an integer containing a bitmask that indicates which properties are valid. When retrieving file attributes from an SFTP server, this property indicates which values were read by the class. When setting values, the property is used to determine which values get passed to the server.

may be bitwise-ORed with any of the following values:

0x00000001 (SSH_FILEXFER_ATTR_SIZE) is valid.
0x00000002 (SSH_FILXFER_ATTR_UIDGID) and are valid. Note: this attribute is only valid when using SFTP protocol version 3.
0x00000004 (SSH_FILEXFER_ATTR_PERMISSIONS) is valid.
0x00000008 (SSH_FILEXFER_ATTR_ACCESSTIME) is valid. Note: for protocol version 3, this also denotes that is valid.
0x00000010 (SSH_FILEXFER_ATTR_CREATETIME) is valid. Note: this attribute is only valid when using SFTP protocol version 4 and above.
0x00000020 (SSH_FILEXFER_ATTR_MODIFYTIME) is valid. Note: this attribute is only valid when using SFTP protocol version 4 and above.
0x00000040 (SSH_FILEXFER_ATTR_ACL) is valid. Note: this attribute is only valid when using SFTP protocol version 4 and above.
0x00000080 (SSH_FILEXFER_ATTR_OWNERGROUP) and are valid. Note: this attribute is only valid when using SFTP protocol version 4 and above.
0x00000100 (SSH_FILEXFER_ATTR_SUBSECOND_TIMES), and are valid. Note: this attribute is only valid when using SFTP protocol version 4 and above.
0x00000200 (SSH_FILEXFER_ATTR_BITS) is valid. Note: this attribute is only valid when using SFTP protocol version 5 and above. When using SFTP protocol version 6 and above, this also indicates that is valid.
0x00000400 (SSH_FILEXFER_ATTR_ALLOCATION_SIZE) is valid. Note: this attribute is only valid when using SFTP protocol version 6 and above.
0x00000800 (SSH_FILEXFER_ATTR_TEXT_HINT) is valid. Note: this attribute is only valid when using SFTP protocol version 6 and above.
0x00001000 (SSH_FILEXFER_ATTR_MIME_TYPE) is valid. Note: this attribute is only valid when using SFTP protocol version 6 and above.
0x00002000 (SSH_FILEXFER_ATTR_LINK_COUNT) is valid. Note: this attribute is only valid when using SFTP protocol version 6 and above.
0x00004000 (SSH_FILEXFER_ATTR_UNTRANSLATED_NAME) is valid. Note: this attribute is only valid when using SFTP protocol version 6 and above.
0x80000000 (SSH_FILEXFER_ATTR_EXTENDED)There are extended (vendor-specific) values associated with the file. This attribute is currently ignored by the class.

groupId
String

The id of the group that has access rights this file.

isDir
Bool

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

isSymlink
Bool

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

linkCount
Int32

The number of links that reference this file.

mimeType
String

A value that can be used in the Content-Type header for a MIME entity part containing this file.

modifiedTime
Int64

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

modifiedTimeNanos
Int32

A subsecond value associated with this file's .

ownerId
String

The user id of this file's owner.

permissions
Int32

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

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

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

1 (001)Execute
2 (010)Write
4 (100)Read

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

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

1 (001)Sticky Bit - retain the file in memory for performance
2 (010)Set GID - sets the group ID of the process to the file's group ID upon execution (only for executable files)
4 (100)Set UID - sets the user ID of the process to the file's user ID upon execution (only for executable files)

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

01 (000001)Named pipe
02 (000010)Character special
04 (000100)Directory
06 (000110)Block special
10 (001000)Regular
12 (001010)Symbolic link
14 (001100)Socket

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

Please note that you will need to convert the octal permissions bitmask into its decimal representation

permissionsOctal
String

An octal string containing the a POSIX-compatible file permission bitmask

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

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

1 (001)Execute
2 (010)Write
4 (100)Read

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

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

1 (001)Sticky Bit - retain the file in memory for performance
2 (010)Set GID - sets the group ID of the process to the file's group ID upon execution (only for executable files)
4 (100)Set UID - sets the user ID of the process to the file's user ID upon execution (only for executable files)

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

01 (000001)Named pipe
02 (000010)Character special
04 (000100)Directory
06 (000110)Block special
10 (001000)Regular
12 (001010)Symbolic link
14 (001100)Socket

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

size
Int64

The total size, in bytes, of this file.

textHint
Int32

Provides a hint for whether or not the file is a text file.

untranslatedName
String

The untranslated name of the file.

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

operationId
String

The Id of the currently running operation.

Config Settings (SSHPlex Module)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

SFTP Config Settings

AllowBackslashInName:   Whether backslashes are allowed in folder and file names.

By default the backslash character is treated as a path separator and is not allowed in file and folder names. When this configuration setting is set to True, backslashes "\" are allowed in file and folder names, and are not supported as path separators.

The default value is False.

AsyncTransfer:   Controls whether simultatenous requests are made to read or write files.

When set to true, the class will make several requests to read or write data before waiting for a response from the server. The maximum number of these requests that can be made is controlled by MaxOutstandingPackets. The default is true.

AttrAccessTime:   Can be queried for the AccessTime file attribute during the DirList event.

During DirList, this configuration setting can be queried to retrieve the value of the AccessTime file attribute if it is present in the response from the server.

AttrCreationTime:   Can be queried for the CreationTime file attribute during the DirList event.

During DirList, this configuration setting can be queried to retrieve the value of the CreationTime file attribute if it is present in the response from the server.

AttrFileType:   Can be queried for the FileType file attribute during the DirList event.

During DirList, this configuration setting can be queried to retrieve the value of the FileType file attribute if it is present in the response from the server.

AttrGroupId:   Can be queried for the GroupId file attribute during the DirList event.

During DirList, this configuration setting can be queried to retrieve the value of the GroupId file attribute if it is present in the response from the server.

AttrLinkCount:   Can be queried for the LinkCount file attribute during the DirList event.

During DirList, this configuration setting can be queried to retrieve the value of the LinkCount file attribute if it is present in the response from the server.

AttrOwnerId:   Can be queried for the OwnerId file attribute during the DirList event.

During DirList, this configuration setting can be queried to retrieve the value of the OwnerId file attribute if it is present in the response from the server.

AttrPermission:   Can be queried for the Permissions file attribute during the DirList event.

During DirList, this configuration setting can be queried to retrieve the value of the Permissions file attribute if it is present in the response from the server.

CheckFileHash:   Compares a server-computed hash with a hash calculated locally.

This setting may be queried to compare a hash of the file specified by RemoteFile with the hash calculated by the server. When queried the class will ask the server to calculate a hash of the file. It will then compute a hash locally and compare the values to confirm the content that exists in the file specified by RemoteFile is the same as the file specified by LocalFile.

The server must support the check-file extension.

The class supports the following hash algorithms (in order of preference): sha256,sha224,sha384,sha512,sha1,md5. The server may choose to use any value from this list. No action is needed to configure the algorithm, the class will automatically use the same algorithm that the server users.

If the extension is unsupported or a mismatch in hashes is detected the class . If the hashes match the value "True" is returned. try { String flag = sftp.Config("CheckFileHash"); // flag will be equal to "True" } catch (Exception e) { // mismatch }

DisableRealPath:   Controls whether or not the SSH_FXP_REALPATH request is sent.

This configuration setting can be used to skip sending the SSH_FXP_REALPATH request, which asks the server to canonicalize the value in RemotePath to an absolute path. The default value is false, which will cause the component to send the request normally. If set to true, component will not send the SSH_FXP_REALPATH packet and will use the value in RemotePath directly.

ExcludeFileMask:   Specifies a file mask for excluding files in directory listings.

This configuration setting specifies one or more file masks to be excluded during a directory listing. When using multiple masks, any files that match one or more of the masks will not be listed. For example, setting ExcludeFileMask to "*.txt", RemoteFile to "", and calling ListDirectory will list all files except those ending in .txt.

FileMaskDelimiter:   Specifies a delimiter to use for setting multiple file masks in the RemoteFile property.

If specified, the RemoteFile property will be split into separate masks based on the chosen delimiter. The default is "", which will cause the RemoteFile property to be treated as a single value. When using multiple masks, any files that match one or more of the masks will be listed. For example, setting FileMaskDelimiter to "," and setting RemoteFile to "*.txt, *.csv" will list all files ending in .txt or .csv.

FiletimeFormat:   Specifies the format to use when returning filetime strings.

If specified, the class will use this value to format the filetime string returned through the DirList event. 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".

FreeSpace:   The free space on the remote server in bytes.

This property is populated after calling the GetSpaceInfo configuration setting. This holds the total free space available on the drive on the remote server in bytes.

GetSpaceInfo:   Queries the server for drive usage information.

This setting queries the server for the total space and free space available on the remote drive. When querying this setting the class will immediately request the information from the server. After calling this setting the TotalSpace and FreeSpace configuration settings will be populated.

Note: The server must understand either the "statvfs@openssh.com" or "space-available" extension in order for this operation to succeed.

GetSymlinkAttrs:   Whether to get the attributes of the symbolic link, or the resource pointed to by the link.

When FileAttributes is queried the class will retrieve information about the RemoteFile. This setting controls the behavior when RemoteFile refers to a symbolic link on the server. By default the information returned by FileAttributes is that of the actual file pointed to by the symbolic link, not the symbolic link itself.

If it is desired to retrieve the attributes of the symbolic link itself, set GetSymlinkAttrs to True before querying FileAttributes.

IgnoreFileMaskCasing:   Controls whether or not the file mask is case sensitive.

This applies to the file mask value specified by the RemoteFile property. The default value is true. If set to false, the file mask will be case sensitive.

LocalEOL:   When TransferMode is set, this specifies the line ending for the local system.

This setting is only applicable when TransferMode is set to 1 (ASCII). The default value is a CrLf character sequence.

When uploading or downloading this value will be compared to ServerEOL. If ServerEOL and LocalEOL are different, the line endings in the file being transferred will be converted to the line endings used by the destination. Line endings will be converted to the value in LocalEOL when downloading. Line endings will be converted to the value in ServerEOL when uploading. If ServerEOL and LocalEOL are the same, no conversion takes place.

The value supplied to this setting must be quoted. For instance: component.Config("LocalEOL=\"" + myEOLSequence + "\""); Where myEOLSequence is a Cr, Lf, or CrLf character sequence.

Conversion will only happen when TransferMode is set to 1 (ASCII) and ServerEOL and LocalEOL are different.

LogSFTPFileData:   Whether SFTP file data is present in Debug logs.

This setting controls whether file data is logged when LogLevel is set to 3 (Debug). When False (default) the file data being transferred is not included. Set this value to True to include all traffic include file data. Note: setting this value to True will increase the amount of data that is logged.

MaskSensitive:   Masks passwords in logs.

The default value is False. When set to True, the class will mask passwords that otherwise would appear in its logs.

MaxFileData:   Specifies the maximum payload size of an SFTP packet.

While the SSH specification requires servers and clients to support SSH packets of at least 32000 bytes, some server implementations limit packet size to smaller values. MaxFileData provides a means by which the user can specify the maximum amount of data that can be put into an SFTP packet so that the class can communicate effectively with these servers. If you are having difficulty when uploading to a server, try setting MaxFileData size to a value smaller than 32000.

Most servers that use smaller values will use a maximum SSH packet size of 16KB (16384). In order to most efficiently communicate with such servers, MaxFileData size should be set to 14745.

Note: Values larger than 64K (65536) may not be respected by some servers (such as OpenSSH) and will result in unexpected behavior. If specifying a value, it is recommended to set a value less than or equal to 65536.

The default value is 32768.

MaxOutstandingPackets:   Sets the maximum number of simultaneous read or write requests allowed.

This sets the number of simultaneous read or write requests allowed. This setting only applies when AsyncTransfer is true. The default is 8.

NegotiatedProtocolVersion:   The negotiated SFTP version.

This returns the negotiated version of SFTP. Query this to ensure that the correct version was negotiated. This configuration setting is read-only.

NormalizeRemotePath:   Whether to normalize the RemotePath.

When set to true, the component will normalize the value in RemotePath by appending a forward slash (/) if one is not already present. "." and ".." are special cases and will not be affected. The default is true.

PreserveFileTime:   Preserves the file's timestamps during transfer.

If set to True, the class will preserve the file's timestamps during transfer. This is applicable to both uploads and downloads. The default value is False.

ProtocolVersion:   The highest allowable SFTP version to use.

This governs the highest allowable SFTP version to use when negotiating the version with the server. The default value is 3 as this is the most common version. The class supports values from 3 to 6. It is recommended to use the default value of 3 unless there is a specific reason a higher version is needed.

ReadLink:   This settings returns the target of a specified symbolic link.

This setting returns the target of the specified symbolic link. To use the setting, pass the remote path and file name of the symbolic link. For instance: string resolvedPath = component.Config("ReadLink=/home/test/mysymlink.txt");

RealTimeUpload:   Enables real time uploading.

When this value is set to "True" the class will upload the data in the file specified by LocalFile and continue monitoring LocalFile for additional data to upload until no new data is found for RealTimeUploadAgeLimit seconds. This allows you to start uploading a file immediately after the file is created and continue uploading as data is written to the file. The default value is "False".

RealTimeUploadAgeLimit:   The age limit in seconds when using RealTimeUpload.

This value is only applicable when RealTimeUpload is set to "True". This specifies the number of seconds for which the class will monitor LocalFile for new data to upload. If this limit is reached and no new data is found in LocalFile the upload will complete. The default value is "1".

ServerEOL:   When TransferMode is set, this specifies the line ending for the remote system.

This setting is only applicable when TransferMode is set to 1 (ASCII). The default value is a CrLf character sequence.

When uploading or downloading this value will be compared to LocalEOL. If ServerEOL and LocalEOL are different, the line endings in the file being transferred will be converted to the line endings used by the destination. Line endings will be converted to the value in LocalEOL when downloading. Line endings will be converted to the value in ServerEOL when uploading. If ServerEOL and LocalEOL are the same, no conversion takes place.

The value supplied to this setting must be quoted. For instance: component.Config("ServerEOL=\"" + myEOLSequence + "\""); Where myEOLSequence is a Cr, Lf, or CrLf character sequence.

Conversion will only happen when TransferMode is set to 1 (ASCII) and ServerEOL and LocalEOL are different.

SimultaneousTransferLimit:   The maximum number of simultaneous file transfers.

This setting specifies the maximum number of simultaneous file transfers. This is used when processing files added to the transfer queue by QueueFile. The default value is "5".

TotalSpace:   The total space on the remote server in bytes.

This property is populated after calling the GetSpaceInfo configuration setting. This holds the total space on the drive on the remote server in bytes.

TransferMode:   The transfer mode (ASCII or Binary).

The value 0 represents Binary and the value 1 represents ASCII. If the value is 0 (default), the initial server mode will be used.

When this value is set to 1 (ASCII) the class will use the values specified in LocalEOL and ServerEOL to convert line endings as appropriate.

Note: When this value is set to 1 (ASCII) and ProtocolVersion is set to 4 or higher the class will automatically determine the value for ServerEOL if the server supports the "newline" protocol extension.

TransferredDataLimit:   Specifies the maximum number of bytes to download from the remote file.

This setting specifies the maximum number of bytes which should be downloaded from the current RemoteFile when Download is called. The class will stop downloading data if it reaches the specified limit, or if there is no more data to download.

This setting can be used in conjunction with the StartByte property in order to download a specific range of data from the current RemoteFile.

UseFxpStat:   Whether SSH_FXP_STAT is sent.

For certain operations the class will send SSH_FXP_STAT to get a file's attributes. Some servers do not support this packet and will return an error.

Set this to to not send the packet. This will cause PreserveFileTime to not work and prevent PercentDone in Transfer from being calculated.

The default is .

UseServerFileTime:   Controls if the file time returned from the server is converted to local time or not.

If set to false the component will return the filetime as the system's local time, otherwise it will return with the time as it is reported by the server. Controls if the file time returned from the server is converted to local time or not.

If set to false the component will return the filetime as the system's local time, otherwise it will return with the time as it is reported by the server. The default is .

UseServerFileTime:   Controls if the file time returned from the server is converted to local time or not.

If set to false the component will return the filetime as the system's local time, otherwise it will return with the time as it is reported by the server. Controls if the file time returned from the server is converted to local time or not.

If set to false the component will return the filetime as the system's local time, otherwise it will return with the time as it is reported by the server. The default is .

SCP Config Settings

DirectoryPermissions:   The permissions of folders created on the remote host.

This is only applicable when RecursiveMode is set to true. If new folders are created on the remote host as a result of the Upload operation this setting specifies the permissions those new folders will be assigned. This is a four (4) digit octal value. See FilePermissions for more details on expected values. The default value is "0700".

LastAccessedTime:   The last accessed time of the remote file.

This returns the last accessed time of the remote file. It is only applicable for download when PreserveFileTime is set to True. This may be queried within the StartTransfer event.

LastModifiedTime:   The last modified time of the remote file.

This returns the last modified time of the remote file. It is only applicable for download when PreserveFileTime is set to True. This may be queried within the StartTransfer event.

PreserveFileTime:   Preserves the file's modified time during transfer.

If set to True, the class will preserve the file's modified time during transfer. This is applicable to both uploads and downloads. The default value is True.

When enabled, the class will also populate LastModifiedTime and LastAccessedTime configuration settings. These are only applicable during download and may be used to check the times of the remote file from within the StartTransfer event. To cancel a transfer call the Interrupt method.

RecursiveMode:   If set to true the class will recursively upload or download files.

When a filemask is specified in LocalFile or RemoteFile this setting specifies if sub-directories and files are transferred as well. By default this value is False and only files in the specified directory will be transferred. If set to true recursion will be used to transfer all child folders and files.

ServerResponseWindow:   The time to wait for a server response in milliseconds.

After an operation is complete the server may still return an error. This setting controls the amount of time the class will wait for an error to be returned. This value is specified in milliseconds. The default value is "20".

SShell Config Settings

DisconnectOnChannelClose:   Whether to automatically close the connection when a channel is closed.

If this is true, then any time a channel is closed the connection will close as well. When false, the connection will remain open any time a channel is closed.

Default is true.

EncodedTerminalModes:   The terminal mode to set when communicating with the SSH host.

This may be set to specify a terminal mode when communicating with the SSH host. This will automatically be set if TerminalModes is set. This is provided as an alternative to TerminalModes. For instance:

class.Config("EncodedTerminalModes=" + Encoding.Default.GetString(new byte[] { 53,0,0,0,0,0 })"); In the above example the first byte is the opcode (53 for echo). The next 4 bytes represent the opcode value which is a uint 32. The last byte is always a null character to end the string. This example sets echo to off just as in the example for TerminalModes.

FallbackKeyboardAuth:   Whether to attempt keyboard authorization after another authorization method has failed.

If this is true, then when an authentication attempt (that is not already using keyboard authentication) fails the SSHKeyboardInteractive event will fire. The Response from that event will then be used in a password authentication attempt. If that attempt also fails, the SSHKeyboardInteractive event will fire one more time for an actual keyboard authentication attempt.

Default is false.

ShellPrompt:   The character sequence of the prompt on the SSH host to wait for.

If set, when Execute is called the class will wait for the ShellPrompt value to be returned by the server.

StdInFile:   The file to use as Stdin data.

To provide the contents of a file as the Stdin input to the SSH server, set this to the full path and name of the target file. This is equivalent to reading the content of the file and providing that data to the Stdin property directly.

StripANSI:   Whether to remove ANSI escape sequences.

This setting specifies whether the component removes ANSI escape sequences from the data returned by the server. The default value is False, and the data will be provided exactly as it is returned by the server.

TerminalHeight:   The height of the terminal display.

When a connection to the SSH server is made, this option specifies the height of the terminal's display in rows.

TerminalModes:   The terminal mode to set when communicating with the SSH host.

This may be set to specify a terminal mode when communicating with the SSH host. The value passed to this setting is in the form opcode=value. For instance:

class.Config("TerminalModes=53=0"); In the above example 53 is the opcode (for echo) and the value is 0. So this sets echo to off.

TerminalType:   The terminal type the class will use when connecting to a server.

This specifies a terminal type when communicating with a SSH host. The default value is "vt100", additional supported terminal types will depend on the SSH host.

TerminalUsePixel:   Whether the terminal's dimensions are in columns/rows or pixels.

When this option is true the TerminalHeight and TerminalWidth configuration options are in pixels instead of columns/rows. The default is false.

TerminalWidth:   The width of the terminal display.

When a connection to the SSH server is made, this option specifies the width of the terminal's display in columns.

UpdateTerminalSize:   Used to update the terminal size.

This setting will send the updated terminal size to the SSHHost when it is called. Before calling this setting set TerminalHeight and TerminalWidth to the new values. Then simply call this setting, for instance: sshell.Config("UpdateTerminalSize");

SExec Config Settings

DisconnectOnChannelClose:   Whether to automatically close the connection when a channel is closed.

If this is true, then any time a channel is closed the connection will close as well. When false, the connection will remain open any time a channel is closed.

Default is false.

EncodedTerminalModes:   The terminal mode to set when communicating with the SSH host.

This may be set to specify a terminal mode when communicating with the SSH host. This will automatically be set if TerminalModes is set. This is provided as an alternative to TerminalModes. For instance:

class.Config("EncodedTerminalModes=" + Encoding.Default.GetString(new byte[] { 53,0,0,0,0,0 })"); In the above example the first byte is the opcode (53 for echo). The next 4 bytes represent the opcode value which is a uint 32. The last byte is always a null character to end the string. This example sets echo to off just as in the example for TerminalModes.

StdInFile:   The file to use as Stdin data.

To provide the contents of a file as the Stdin input to the SSH server, set this to the full path and name of the target file. This is equivalent to reading the content of the file and providing that data to the Stdin property directly.

TerminalHeight:   The height of the terminal display.

When a connection to the SSH server is made, this option specifies the height of the terminal's display in rows.

TerminalModes:   The terminal mode to set when communicating with the SSH host.

This may be set to specify a terminal mode when communicating with the SSH host. The value passed to this setting is in the form opcode=value. For instance:

class.Config("TerminalModes=53=0"); In the above example 53 is the opcode (for echo) and the value is 0. So this sets echo to off.

TerminalUsePixel:   Whether the terminal's dimensions are in columns/rows or pixels.

When this option is true the TerminalHeight and TerminalWidth configuration options are in pixels instead of columns/rows. The default is false.

TerminalWidth:   The width of the terminal display.

When a connection to the SSH server is made, this option specifies the width of the terminal's display in columns.

SSHClient Config Settings

ClientSSHVersionString:   The SSH version string used by the class.

This configuration setting specifies the SSH version string used by the class. The default value is "SSH-2.0-IPWorks SSH Client 2022".

EnablePageantAuth:   Whether to use a key stored in Pageant to perform client authentication.

This setting controls whether Pageant authentication is disabled, enabled, or required. When enabled or required, the class attempts to communicate with PuTTY's ssh-agent, called "Pageant", over shared memory to perform public key authentication. Possible values and the corresponding behavior is described below:

ValueDescription
0 (Disabled - default) No communication with Pageant is attempted.
1 (Enabled) Pageant authentication is used if available. If Pageant is not running, or does not contain the expected key no error is thrown.
2 (Required) Only Pageant authentication is used. If Pageant is not running, or does not contain the expected key an error is thrown.

Example enabling Pageant: component.Config("EnablePageantAuth=1"); component.SSHUser = "sshuser"; component.SSHLogon("localhost", 22);

Note: This functionality is only available on Windows.

KerberosDelegation:   If true, asks for credentials with delegation enabled during authentication.

The default value is "True". If set to "False", the client will not ask for credentials delegation support during authentication. Note that even if the client asks for delegation, the server/KDC might not grant it and authentication will still succeed.

KerberosRealm:   The fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication.

This property may be set to the fully qualified (DNS) name of the kerberos realm (or Windows Active Directory domain name) to use during GSSAPI authentication. This can be used to force authentication with a given realm if the client and server machines are not part of the same domain.

KerberosSPN:   The Kerberos Service Principal Name of the SSH host.

This property can be set to specify the Service Principal Name (SPN) associated with the SSH service on the remote host. This will usually be in the form "host/fqdn.of.sshhost[@REALM]". If not specified, the class will assume the SPN is based on the value of the SSHHost property and the kerberos realm used for authentication.

KeyRenegotiationThreshold:   Sets the threshold for the SSH Key Renegotiation.

This property allows you to specify the threshold, in the number of bytes, for the SSH Key Renegotiation. The default value for this property is set to 1 GB.

Example (for setting the threshold to 500 MB): SSHComponent.Config("KeyRenegotiationThreshold=524288000")

LogLevel:   Specifies the level of detail that is logged.

This setting controls the level of detail that is logged through the Log event. Possible values are:

0 (None) No messages are logged.
1 (Info - Default) Informational events such as SSH handshake messages are logged.
2 (Verbose) Detailed data such as individual packet information is logged.
3 (Debug) Debug data including all relevant sent and received bytes are logged.

MaxPacketSize:   The maximum packet size of the channel, in bytes.

This setting specifies the maximum size of an individual data packet, in bytes, that can be sent to the sender.

MaxWindowSize:   The maximum window size allowed for the channel, in bytes.

This setting specifies how many bytes of channel data can be sent to the sender of this message without adjusting the window. Note that this value may be changed during the connection, but the window size can only be increased, not decreased.

PasswordPrompt:   The text of the password prompt used in keyboard-interactive authentication.

This setting optionally specifies a pattern to be matched to the prompt received from the server during keyboard-interactive authentication. If a matching prompt is detected the class automatically responds to the prompt with the password specified by SSHPassword.

This provides an easy way to automatically reply to prompts with the password if one is presented by the server. The password will be auto-filled in the Response parameter of the SSHKeyboardInteractive event in the case of a match.

The following special characters are supported for pattern matching:

? Any single character.
* Any characters or no characters (e.g., C*t matches Cat, Cot, Coast, Ct).
[,-] A range of characters (e.g., [a-z], [a], [0-9], [0-9,a-d,f,r-z]).
\ The slash is ignored and exact matching is performed on the next character.

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

CharacterEscape Sequence
? [?]
* [*]
[ [[]
\ [\]

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

PreferredDHGroupBits:   The size (in bits) of the preferred modulus (p) to request from the server.

This may be when using the diffie-hellman-group-exchange-sha1 or diffie-hellman-group-exchange-sha256 key exchange algorithms to control the preferred size, in bits, of the modulus (p) prime number to request from the server. Acceptable values are between 1024 and 8192.

RecordLength:   The length of received data records.

If set to a positive value, this setting defines the length of data records to be received. The class will accumulate data until RecordLength is reached and only then fire the DataIn event with data of length RecordLength. This allows data to be received as records of known length. This value can be changed at any time, including within the DataIn event.

The default value is 0, meaning this setting is not used.

ServerSSHVersionString:   The remote host's SSH version string.

This will return the remote host's SSH version string, which can help when identifying problematic servers. This configuration setting is read-only.

SignedSSHCert:   The CA signed client public key used when authenticating.

When authenticating via public key authentication this setting may be set to the CA signed client's public key. This is useful when the server has been configured to trust client keys signed by a particular CA. For instance: component.Config("SignedSSHCert=ssh-rsa-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB..."); The algorithm such as ssh-rsa-cert-v01@openssh.com in the above string is used as part of the authentication process. To use a different algorithm simply change this value. For instance all of the following are acceptable with the same signed public key:

  • ssh-rsa-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...
  • rsa-sha2-256-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...
  • rsa-sha2-512-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...

SSHAcceptAnyServerHostKey:   If set the class will accept any key presented by the server.

The default value is "False". Set this to "True" to accept any key presented by the server.

SSHAcceptServerCAKey:   The CA public key that signed the server's host key.

If the server's host key was signed by a CA, this setting may be used to specify the CA's public key. If specified the class will trust any server's host key that was signed by the CA. For instance: component.Config("SSHAcceptServerCAKey=ssh-rsa AAAAB3NzaC1yc2EAAAADAQAB...");

SSHAcceptServerHostKeyFingerPrint:   The fingerprint of the server key to accept.

This may be set to a comma-delimited collection of 16-byte MD5 fingerprints that should be accepted as the host's key. You may supply it by HEX encoding the values in the form "0a:1b:2c:3d". Example: SSHClient.Config("SSHAcceptServerHostKeyFingerprint=0a:1b:2c:3d"); If the server's fingerprint matches one of the values supplied, the class will accept the host key.

SSHFingerprintHashAlgorithm:   The algorithm used to calculate the fingerprint.

This configuration setting controls which hash algorithm is used to calculate the hostkey's fingerprint, displayed when SSHServerAuthentication fires. Valid values are:

  • MD5
  • SHA1
  • SHA256 (default)
SSHFingerprintMD5:   The server hostkey's MD5 fingerprint.

This setting may be queried in SSHServerAuthentication to get the server hostkey's MD5 fingerprint.

SSHFingerprintSHA1:   The server hostkey's SHA1 fingerprint.

This setting may be queried in SSHServerAuthentication to get the server hostkey's SHA1 fingerprint.

SSHFingerprintSHA256:   The server hostkey's SHA256 fingerprint.

This setting may be queried in SSHServerAuthentication to get the server hostkey's SHA256 fingerprint.

SSHKeepAliveCountMax:   The maximum number of keep alive packets to send without a response.

This setting specifies the maximum number of keep alive packets to send when no response is received. Normally a response to a keep alive packet is received right away. If no response is received the class will continue to send keep alive packets until SSHKeepAliveCountMax is reached. If this is reached the class will assume the connection is broken and disconnect. The default value is 5.

SSHKeepAliveInterval:   The interval between keep alive packets.

This setting specifies the number of seconds between keep alive packets. If set to a positive value the class will send a SSH keep alive packet after KeepAliveInterval seconds of inactivity. This setting only takes effect when there is no activity, if any data is sent or received over the connection it will reset the timer.

The default value is 0 meaning no keep alives will be sent.

Note: The SSHReverseTunnel class uses a default value of 30.

SSHKeyExchangeAlgorithms:   Specifies the supported key exchange algorithms.

This may be used to specify the list of supported Key Exchange algorithms used during SSH negotiation. The value should contain a comma separated list of algorithms. Supported algorithms are:

  • curve25519-sha256
  • curve25519-sha256@libssh.org
  • diffie-hellman-group1-sha1
  • diffie-hellman-group14-sha1
  • diffie-hellman-group14-sha256
  • diffie-hellman-group16-sha512
  • diffie-hellman-group18-sha512
  • diffie-hellman-group-exchange-sha256
  • diffie-hellman-group-exchange-sha1
  • ecdh-sha2-nistp256
  • ecdh-sha2-nistp384
  • ecdh-sha2-nistp521
The default value is: curve25519-sha256,curve25519-sha256@libssh.org,diffie-hellman-group-exchange-sha256,diffie-hellman-group14-sha256,diffie-hellman-group16-sha512,diffie-hellman-group18-sha512,ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,diffie-hellman-group-exchange-sha1,diffie-hellman-group14-sha1,diffie-hellman-group1-sha1.
SSHKeyRenegotiate:   Causes the component to renegotiate the SSH keys.

Once this setting is set the component will renegotiate the SSH keys with the remote host.

Example: SSHClient.Config("SSHKeyRenegotiate")

SSHMacAlgorithms:   Specifies the supported Mac algorithms.

This may be used to specify an alternate list of supported Mac algorithms used during SSH negotiation. This also specifies the order in which the Mac algorithms are preferred. The value should contain a comma separated list of algorithms. Supported algorithms are:

  • hmac-sha1
  • hmac-md5
  • hmac-sha1-96
  • hmac-md5-96
  • hmac-sha2-256
  • hmac-sha2-256-96
  • hmac-sha2-512
  • hmac-sha2-512-96
  • hmac-ripemd160
  • hmac-ripemd160-96
  • hmac-sha2-256-etm@openssh.com
  • hmac-sha2-512-etm@openssh.com
The default value is hmac-sha2-256,hmac-sha2-512,hmac-sha1,hmac-md5,hmac-ripemd160,hmac-sha1-96,hmac-md5-96,hmac-sha2-256-96,hmac-sha2-512-96,hmac-ripemd160-96,hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com.
SSHPubKeyAuthSigAlgorithms:   Specifies the enabled signature algorithms that may be used when attempting public key authentication.

This setting specifies a list of signature algorithms that may be used when authenticating to the server using public key authentication. This applies only when public key authentication is performed by the client.

The setting should be a comma separated list of algorithms. At runtime the class will evaluate the specified algorithms and if the algorithm is applicable to the certificate specified in SSHCert it will be used. If the algorithm is not applicable the class will evaluate the next algorithm. Possible values are:

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

The default value in Windows is ssh-rsa,rsa-sha2-256,rsa-sha2-512,ssh-dss,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,ssh-ed25519.

rsa-sha2-256 and rsa-sha2-512 notes

The class will query the server for supported algorithms when connecting. If the server indicates support for rsa-sha2-256 or rsa-sha2-512 and the algorithm is present in the list defined by this setting (as in the default value), that algorithm will be used instead of ssh-rsa even when ssh-rsa appears first in the list.

For the rsa-sha2-256 and rsa-sha2-512 algorithms to be automatically preferred the server must support the ext-info-c mechanism. In practice, older servers do not support this and in that case ssh-rsa will be used since it appears first in the list. Newer servers do support this mechanism and in that case rsa-sha2-256 or rsa-sha2-512 will be used even though it appears after ssh-rsa.

This behavior has been carefully designed to provide maximum compatibility while automatically using more secure algorithms when connecting to servers which support them.

SSHPublicKeyAlgorithms:   Specifies the supported public key algorithms for the server's public key.

This setting specifies the allowed public key algorithms for the server's public key. This list controls only the public key algorithm used when authenticating the server's public key. This list has no bearing on the public key algorithms that can be used by the client when performing public key authentication to the server. The default value is ssh-ed25519,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,rsa-sha2-256,rsa-sha2-512,ssh-rsa,ssh-dss,x509v3-sign-rsa,x509v3-sign-dss.

SSHVersionPattern:   The pattern used to match the remote host's version string.

This configuration setting specifies the pattern used to accept or deny the remote host's SSH version string. It takes a comma-delimited list of patterns to match. The default value is "*SSH-1.99-*,*SSH-2.0-*" and will accept connections from SSH 1.99 and 2.0 hosts. As an example, the below value would accept connections for SSH 1.99, 2.0, and 2.99 hosts.

*SSH-1.99-*,*SSH-2.0-*,*SSH-2.99-*
TryAllAvailableAuthMethods:   If set to true, the class will try all available authentication methods.

The default value is . When set to , the class will try to authenticate using all methods that it has credentials for and the server supports.

WaitForChannelClose:   Whether to wait for channels to be closed before disconnected.

This setting controls whether the class will wait for a server response to the SSH_MSG_CHANNEL_CLOSE when disconnecting. When the class disconnects it will first attempt to close all open channels by sending a SSH_MSG_CHANNEL_CLOSE for each channel. This setting controls whether the class will wait for a server response after sending the messages.

When True (default) the class will wait for a response to the channel close message until the responses have been received, the server closes the connection, or Timeout seconds is reached.

When False the class will still send the channel close messages but will not wait for a response and will proceed to close the connection.

WaitForServerDisconnect:   Whether to wait for the server to close the connection.

This setting controls whether to wait for the server to close the connection when SSHLogoff is called.

When set to True the class will initiate the disconnection sequence by sending SSH_MSG_DISCONNECT but will not close the connection, and instead will wait for the server to close the connection. Setting this to True may be beneficial in circumstances where many connections are being established, to avoid port exhaustion when sockets are in a TIME_WAIT state. Allowing the server to close the connection avoids the TIME_WAIT state of socket on the client machine.

When set to False (default) the client will close the connection. It is recommended to use this value unless there is a specific need to change it.

TCPClient Config Settings

ConnectionTimeout:   Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect:   Tells the class whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class .

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser:   A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class .

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger:   When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime:   Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost:   The name of the local host through which connections are initiated or accepted.

The LocalHost setting 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 setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

LocalPort:   The port in the local host where the class binds.

This 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 to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

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

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate:   The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

Socket Config Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize:   The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

By default the class will use the system security libraries to perform cryptographic functions where applicable. Setting this to tells the class to use the internal implementation instead of using the system's security API.

Trappable Errors (SSHPlex Module)

SSHPlex Errors

1039   Invalid channel type.
1040   Operation has been canceled.

SFTP Errors

118   Firewall error. Error description contains detailed information.
1102   The server's SFTP draft version is unsupported.
1103   SFTP command failed. Error description contains detailed information.
1104   Server does not support renaming.
1105   Received invalid response from server. Error description contains detailed information.
1106   Cannot resolve path: path does not exist.
1107   You must set LocalFile/RemoteFile before attempt to download/upload.
1108   Cannot download file: LocalFile exists and Overwrite is set to false.
1109   CheckFileHash failed due to hash value mismatch.

SCP Errors

118   Firewall error. Error description contains detailed information.

SExec Errors

1050   Busy performing other action.

SShell Errors

1050   Busy performing other action.

SSHClient Errors

1001   Server has disconnected.
1002   Protocol version unsupported or other issue with version string.
1003   Cannot negotiate algorithms.
1005   Selected algorithm unsupported.
1006   Cannot set keys.
1010   Unexpected algorithm.
1011   Cannot create exchange hash.
1012   Cannot make key.
1013   Cannot sign data.
1014   Cannot encrypt packet.
1015   Cannot decrypt packet.
1016   Cannot decompress packet.
1020   Failure to open channel.
1021   Invalid channel ID.
1022   Invalid channel data.
1023   Invalid channel message.
1024   SSH message unimplemented.
1027   Server message unsupported.
1030   Server's host key was rejected. The host key may be accepted within the SSHServerAuthentication event or using the SSHAcceptServerHostKey property.
1031   Cannot verify server's host key.
1032   Authentication failed. Check description for details.
1033   Channel request failed.
1034   Diffie-Hellman exchange failed.
1036   SSH connection failed.
1037   SSH reconnect limit reached.
1038   Elliptic Curve Diffie-Hellman exchange failed.
1039   SSH keep-alive limit reached.
1098   Request failure.
1130   Would block error.
1133   Would block, reason: key reExchange.

TCPClient Errors

100   You cannot change the RemotePort at this time. A connection is in progress.
101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
102   The RemoteHost address is invalid (0.0.0.0).
104   Already connected. If you want to reconnect, close the current connection first.
106   You cannot change the LocalPort at this time. A connection is in progress.
107   You cannot change the LocalHost at this time. A connection is in progress.
112   You cannot change MaxLineLength at this time. A connection is in progress.
116   RemotePort cannot be zero. Please specify a valid service port number.
117   You cannot change the UseConnection option while the class is active.
135   Operation would block.
201   Timeout.
211   Action impossible in control's present state.
212   Action impossible while not connected.
213   Action impossible while listening.
301   Timeout.
302   Could not open file.
434   Unable to convert string to selected CodePage.
1105   Already connecting. If you want to reconnect, close the current connection first.
1117   You need to connect first.
1119   You cannot change the LocalHost at this time. A connection is in progress.
1120   Connection dropped by remote host.

TCP/IP Errors

10004   [10004] Interrupted system call.
10009   [10009] Bad file number.
10013   [10013] Access denied.
10014   [10014] Bad address.
10022   [10022] Invalid argument.
10024   [10024] Too many open files.
10035   [10035] Operation would block.
10036   [10036] Operation now in progress.
10037   [10037] Operation already in progress.
10038   [10038] Socket operation on non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't assign requested address.
10050   [10050] Network is down.
10051   [10051] Network is unreachable.
10052   [10052] Net dropped connection or reset.
10053   [10053] Software caused connection abort.
10054   [10054] Connection reset by peer.
10055   [10055] No buffer space available.
10056   [10056] Socket is already connected.
10057   [10057] Socket is not connected.
10058   [10058] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory not empty
10067   [10067] Too many processes.
10068   [10068] Too many users.
10069   [10069] Disc Quota Exceeded.
10070   [10070] Stale NFS file handle.
10071   [10071] Too many levels of remote in path.
10091   [10091] Network subsystem is unavailable.
10092   [10092] WINSOCK DLL Version out of range.
10093   [10093] Winsock not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks SSH 2022 macOS Edition - Version 22.0 [Build 8369]