SSHReverseTunnel Module

Properties   Methods   Events   Config Settings   Errors  

The SSHReverseTunnel module provides a simple way to establish a reverse tunnel with a Secure Shell (SSH) host.

Syntax

IPWorksSSH.SSHReverseTunnel

Remarks

The SSHReverseTunnel class may be used to establish a reverse tunnel with a Secure Shell (SSH) host. The SSH host will listen for incoming connections on the specified port and forward traffic to the class through the SSH tunnel.

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

To begin, call SSHLogon to connect to the SSH host. After this method returns, the connectionto the SSH server is successfully established. Call RequestForwarding to establish a reverse tunnel. This method takes parameters to tell the SSH host on which port to listen.

The class has two modes that allow data to be dealt with directly from the events, or automatically forwarded on to a different endpoint.

Event Based Operation

In this mode, any data received by the class over the tunnel causes the events of the class to fire. For instance:

SSHReverseTunnel.RequestForwarding("0.0.0.0", 777, "", 0);

In the above code, forwarding is requested from port 777 on the SSHHost. Any data received on port 777 by the SSHHost will be sent to the class. In the above code, the last two parameters are empty and 0, indicating to the class that no local forwarding is requested.

Once RequestForwarding returns, the Secure Shell (SSH) reverse tunnel is established. Any connection made to the SSH host on the specified port will then trigger the class's events to fire, allowing you to handle the connection request and data.

When a client connects to the SSH host on the specified port, the SSHChannelOpenRequest event will fire. Within this event, choose to accept or reject the connection by setting the Accept parameter. This event contains details about the connection that may be used when determining whether to accept the connection.

After the channel is established, data are received through the SSHChannelData event. Call the SendChannelData method to send data over the channel, and call the CloseChannel method to close the channel.

Local Forwarding

In this mode, any data received by the class is automatically forwarded to a separate endpoint. This allows the class to act as a sort of proxy. There is no need to handle data directly in this case. For instance: SSHReverseTunnel.RequestForwarding("0.0.0.0", 777, "nsoftware.com", 80);

In the above code, forwarding is requested from port 777 on SSHHost. The class is instructed to establish a connection to "nsoftware.com" on port 80 when a client connects to SSHHost on port 777. Any data received from the client connected to SSHHost on port 777 will automatically be forwarded to "nsoftware.com" on port 80. Any data received back from "nsoftware.com" on port 80 will be sent back to the connected client.

In this mode, data may flow freely from the client connected to the SSHHost to the endpoint specified in the RequestForwarding method without any additional code required.

Note: The following events are applicable when a connection is made to the SSH host:

• SSHChannelClosed
• SSHChannelData
• SSHChannelEOF
• SSHChannelOpened
• SSHChannelOpenRequest
• SSHChannelReadyToSend
• SSHChannelRequested

To stop a previously established reverse tunnel, call the CancelForwarding method.

Property List

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

Method List

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

Event List

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

Config Settings

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

Channels Property (SSHReverseTunnel Module)

A collection of currently open channels.

Syntax

• Swift
• Objective-C

public var channels: [String: SSHRTChannel] {
  get {...}
}

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

- (int)SSHChannelCount;

- (int)bytesSent:(int)sSHChannelId;

- (NSString*)channelId:(int)sSHChannelId;

- (NSString*)connectedAddress:(int)sSHChannelId;

- (int)connectedPort:(int)sSHChannelId;

- (NSString*)forwardingHost:(int)sSHChannelId;

- (int)forwardingPort:(int)sSHChannelId;

- (NSString*)originAddress:(int)sSHChannelId;

- (int)originPort:(int)sSHChannelId;

- (NSString*)service:(int)sSHChannelId;

Default Value

60

Remarks

This property is a collection of established channels. When a client connects to an existing reverse tunnel, a new channel is requested and added to this collection. This collection is a hashtable for which the channel's Id string is used as the key to the desired Secure Shell (SSH) channel object.

Example. Sending Data to a Channel

Connected Property (SSHReverseTunnel Module)

The module to be connected.

Syntax

• Swift
• Objective-C

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

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

- (BOOL)connected;

Default Value

False

Remarks

This property is used to determine whether or not the class is connected to the remote host. Use the SSHLogon and SSHLogoff methods to manage the connection.

This property is read-only.

Firewall Property (SSHReverseTunnel Module)

A set of properties related to firewall access.

Syntax

• Swift
• Objective-C

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

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

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

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

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

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

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

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

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

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

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

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

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

 

Default Value

60

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

LocalHost Property (SSHReverseTunnel Module)

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

Syntax

• Swift
• Objective-C

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

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

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

Default Value

""

Remarks

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

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

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

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

LocalPort Property (SSHReverseTunnel Module)

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

Syntax

• Swift
• Objective-C

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

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

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

Default Value

0

Remarks

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

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

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

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

SSHAcceptServerHostKey Property (SSHReverseTunnel Module)

Instructs the module to accept the server host key that matches the supplied key.

Syntax

• Swift
• Objective-C

public var sshAcceptServerHostKey: Certificate {
  get {...}
  set {...}
}

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyEffectiveDate) NSString* SSHAcceptServerHostKeyEffectiveDate;

- (NSString*)SSHAcceptServerHostKeyEffectiveDate;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyExpirationDate) NSString* SSHAcceptServerHostKeyExpirationDate;

- (NSString*)SSHAcceptServerHostKeyExpirationDate;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyExtendedKeyUsage) NSString* SSHAcceptServerHostKeyExtendedKeyUsage;

- (NSString*)SSHAcceptServerHostKeyExtendedKeyUsage;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyFingerprint) NSString* SSHAcceptServerHostKeyFingerprint;

- (NSString*)SSHAcceptServerHostKeyFingerprint;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyFingerprintSHA1) NSString* SSHAcceptServerHostKeyFingerprintSHA1;

- (NSString*)SSHAcceptServerHostKeyFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyFingerprintSHA256) NSString* SSHAcceptServerHostKeyFingerprintSHA256;

- (NSString*)SSHAcceptServerHostKeyFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyIssuer) NSString* SSHAcceptServerHostKeyIssuer;

- (NSString*)SSHAcceptServerHostKeyIssuer;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyPrivateKey) NSString* SSHAcceptServerHostKeyPrivateKey;

- (NSString*)SSHAcceptServerHostKeyPrivateKey;

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

- (BOOL)SSHAcceptServerHostKeyPrivateKeyAvailable;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyPrivateKeyContainer) NSString* SSHAcceptServerHostKeyPrivateKeyContainer;

- (NSString*)SSHAcceptServerHostKeyPrivateKeyContainer;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyPublicKey) NSString* SSHAcceptServerHostKeyPublicKey;

- (NSString*)SSHAcceptServerHostKeyPublicKey;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyPublicKeyAlgorithm) NSString* SSHAcceptServerHostKeyPublicKeyAlgorithm;

- (NSString*)SSHAcceptServerHostKeyPublicKeyAlgorithm;

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

- (int)SSHAcceptServerHostKeyPublicKeyLength;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeySerialNumber) NSString* SSHAcceptServerHostKeySerialNumber;

- (NSString*)SSHAcceptServerHostKeySerialNumber;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeySignatureAlgorithm) NSString* SSHAcceptServerHostKeySignatureAlgorithm;

- (NSString*)SSHAcceptServerHostKeySignatureAlgorithm;

@property (nonatomic,readwrite,assign,getter=SSHAcceptServerHostKeyStore,setter=setSSHAcceptServerHostKeyStore:) NSString* SSHAcceptServerHostKeyStore;

- (NSString*)SSHAcceptServerHostKeyStore;
- (void)setSSHAcceptServerHostKeyStore :(NSString*)newSSHAcceptServerHostKeyStore;

@property (nonatomic,readwrite,assign,getter=SSHAcceptServerHostKeyStoreB,setter=setSSHAcceptServerHostKeyStoreB:) NSData* SSHAcceptServerHostKeyStoreB;

- (NSData*)SSHAcceptServerHostKeyStoreB;
- (void)setSSHAcceptServerHostKeyStoreB :(NSData*)newSSHAcceptServerHostKeyStore;
@property (nonatomic,readwrite,assign,getter=SSHAcceptServerHostKeyStorePassword,setter=setSSHAcceptServerHostKeyStorePassword:) NSString* SSHAcceptServerHostKeyStorePassword;

- (NSString*)SSHAcceptServerHostKeyStorePassword;
- (void)setSSHAcceptServerHostKeyStorePassword :(NSString*)newSSHAcceptServerHostKeyStorePassword;

@property (nonatomic,readwrite,assign,getter=SSHAcceptServerHostKeyStoreType,setter=setSSHAcceptServerHostKeyStoreType:) int SSHAcceptServerHostKeyStoreType;

- (int)SSHAcceptServerHostKeyStoreType;
- (void)setSSHAcceptServerHostKeyStoreType :(int)newSSHAcceptServerHostKeyStoreType;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeySubjectAltNames) NSString* SSHAcceptServerHostKeySubjectAltNames;

- (NSString*)SSHAcceptServerHostKeySubjectAltNames;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyThumbprintMD5) NSString* SSHAcceptServerHostKeyThumbprintMD5;

- (NSString*)SSHAcceptServerHostKeyThumbprintMD5;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyThumbprintSHA1) NSString* SSHAcceptServerHostKeyThumbprintSHA1;

- (NSString*)SSHAcceptServerHostKeyThumbprintSHA1;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyThumbprintSHA256) NSString* SSHAcceptServerHostKeyThumbprintSHA256;

- (NSString*)SSHAcceptServerHostKeyThumbprintSHA256;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyUsage) NSString* SSHAcceptServerHostKeyUsage;

- (NSString*)SSHAcceptServerHostKeyUsage;

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

- (int)SSHAcceptServerHostKeyUsageFlags;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyVersion) NSString* SSHAcceptServerHostKeyVersion;

- (NSString*)SSHAcceptServerHostKeyVersion;

@property (nonatomic,readwrite,assign,getter=SSHAcceptServerHostKeySubject,setter=setSSHAcceptServerHostKeySubject:) NSString* SSHAcceptServerHostKeySubject;

- (NSString*)SSHAcceptServerHostKeySubject;
- (void)setSSHAcceptServerHostKeySubject :(NSString*)newSSHAcceptServerHostKeySubject;

@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

60

Remarks

If the host key that will be used by the server is known in advance, this property may be set to accept the expected key. Otherwise, the SSHServerAuthentication event should be trapped, and the key should be accepted or refused in the event.

If this property is not set and the SSHServerAuthentication event is not trapped, the server will not be authenticated and the connection will be terminated by the client.

SSHAuthMode Property (SSHReverseTunnel Module)

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

Syntax

• Swift
• Objective-C

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

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

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

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

Default Value

2

Remarks

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

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

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

SSHCert Property (SSHReverseTunnel Module)

A certificate to be used for authenticating the SSHUser .

Syntax

• Swift
• Objective-C

public var sshCert: Certificate {
  get {...}
  set {...}
}

@property (nonatomic,readonly,assign,getter=SSHCertEffectiveDate) NSString* SSHCertEffectiveDate;

- (NSString*)SSHCertEffectiveDate;

@property (nonatomic,readonly,assign,getter=SSHCertExpirationDate) NSString* SSHCertExpirationDate;

- (NSString*)SSHCertExpirationDate;

@property (nonatomic,readonly,assign,getter=SSHCertExtendedKeyUsage) NSString* SSHCertExtendedKeyUsage;

- (NSString*)SSHCertExtendedKeyUsage;

@property (nonatomic,readonly,assign,getter=SSHCertFingerprint) NSString* SSHCertFingerprint;

- (NSString*)SSHCertFingerprint;

@property (nonatomic,readonly,assign,getter=SSHCertFingerprintSHA1) NSString* SSHCertFingerprintSHA1;

- (NSString*)SSHCertFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=SSHCertFingerprintSHA256) NSString* SSHCertFingerprintSHA256;

- (NSString*)SSHCertFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=SSHCertIssuer) NSString* SSHCertIssuer;

- (NSString*)SSHCertIssuer;

@property (nonatomic,readonly,assign,getter=SSHCertPrivateKey) NSString* SSHCertPrivateKey;

- (NSString*)SSHCertPrivateKey;

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

- (BOOL)SSHCertPrivateKeyAvailable;

@property (nonatomic,readonly,assign,getter=SSHCertPrivateKeyContainer) NSString* SSHCertPrivateKeyContainer;

- (NSString*)SSHCertPrivateKeyContainer;

@property (nonatomic,readonly,assign,getter=SSHCertPublicKey) NSString* SSHCertPublicKey;

- (NSString*)SSHCertPublicKey;

@property (nonatomic,readonly,assign,getter=SSHCertPublicKeyAlgorithm) NSString* SSHCertPublicKeyAlgorithm;

- (NSString*)SSHCertPublicKeyAlgorithm;

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

- (int)SSHCertPublicKeyLength;

@property (nonatomic,readonly,assign,getter=SSHCertSerialNumber) NSString* SSHCertSerialNumber;

- (NSString*)SSHCertSerialNumber;

@property (nonatomic,readonly,assign,getter=SSHCertSignatureAlgorithm) NSString* SSHCertSignatureAlgorithm;

- (NSString*)SSHCertSignatureAlgorithm;

@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;
@property (nonatomic,readwrite,assign,getter=SSHCertStorePassword,setter=setSSHCertStorePassword:) NSString* SSHCertStorePassword;

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

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

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

@property (nonatomic,readonly,assign,getter=SSHCertSubjectAltNames) NSString* SSHCertSubjectAltNames;

- (NSString*)SSHCertSubjectAltNames;

@property (nonatomic,readonly,assign,getter=SSHCertThumbprintMD5) NSString* SSHCertThumbprintMD5;

- (NSString*)SSHCertThumbprintMD5;

@property (nonatomic,readonly,assign,getter=SSHCertThumbprintSHA1) NSString* SSHCertThumbprintSHA1;

- (NSString*)SSHCertThumbprintSHA1;

@property (nonatomic,readonly,assign,getter=SSHCertThumbprintSHA256) NSString* SSHCertThumbprintSHA256;

- (NSString*)SSHCertThumbprintSHA256;

@property (nonatomic,readonly,assign,getter=SSHCertUsage) NSString* SSHCertUsage;

- (NSString*)SSHCertUsage;

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

- (int)SSHCertUsageFlags;

@property (nonatomic,readonly,assign,getter=SSHCertVersion) NSString* SSHCertVersion;

- (NSString*)SSHCertVersion;

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

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

@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

60

Remarks

To use public key authentication, SSHCert must contain a Certificate with a valid private key. The certificate's public key value is sent to the server along with a signature produced using the private key. The server will first check to see if the public key values match what is known for the user, and then it will attempt to use those values to verify the signature.

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

SSHCompressionAlgorithms Property (SSHReverseTunnel Module)

The comma-separated list containing all allowable compression algorithms.

Syntax

• Swift
• Objective-C

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

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

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

Default Value

"none,zlib"

Remarks

During the Secure Shell (SSH) handshake, this list will be used to negotiate the compression algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports. Therefore, it is important to list multiple algorithms in preferential order. If no algorithm can be agreed on, the 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 (SSHReverseTunnel Module)

The comma-separated list containing all allowable encryption algorithms.

Syntax

• Swift
• Objective-C

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

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

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

Default Value

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

Remarks

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

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

SSHHost Property (SSHReverseTunnel Module)

The address of the Secure Shell (SSH) host.

Syntax

• Swift
• Objective-C

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

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

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

Default Value

""

Remarks

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

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

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

SSHPassword Property (SSHReverseTunnel Module)

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

Syntax

• Swift
• Objective-C

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

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

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

Default Value

""

Remarks

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

SSHPort Property (SSHReverseTunnel Module)

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

Syntax

• Swift
• Objective-C

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

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

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

Default Value

22

Remarks

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

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

SSHUser Property (SSHReverseTunnel Module)

The username for Secure Shell (SSH) authentication.

Syntax

• Swift
• Objective-C

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

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

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

Default Value

""

Remarks

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

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

Timeout Property (SSHReverseTunnel Module)

This property includes the timeout for the module.

Syntax

• Swift
• Objective-C

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

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

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

Default Value

60

Remarks

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

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

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

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

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

The default value for the Timeout property is 60 seconds.

CancelForwarding Method (SSHReverseTunnel Module)

Requests the server to stop forwarding a remote Transmission Control Protocol (TCP)/IP port.

Syntax

• Swift
• Objective-C

public func cancelForwarding(address: String, port: Int32) throws -> Void

- (void)cancelForwarding:(NSString*)address :(int)port;

Remarks

The CancelForwarding cancels a previous TCP/IP port forwarding request. When calling it, provide the same argument values you provided on the RequestForwarding call.

CloseChannel Method (SSHReverseTunnel Module)

Closes a existing SSHChannel .

Syntax

• Swift
• Objective-C

public func closeChannel(channelId: String) throws -> Void

- (void)closeChannel:(NSString*)channelId;

Remarks

ChannelId is the identifier for the Secure Shell (SSH) channel to be closed.

Config Method (SSHReverseTunnel Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

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

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

Remarks

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

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

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

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

DecodePacket Method (SSHReverseTunnel Module)

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

Syntax

• Swift
• Objective-C

public func decodePacket(encodedPacket: String) throws -> Data

- (NSData*)decodePacket:(NSString*)encodedPacket;

Remarks

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

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

DoEvents Method (SSHReverseTunnel Module)

This method processes events from the internal message queue.

Syntax

• Swift
• Objective-C

public func doEvents() throws -> Void

- (void)doEvents;

Remarks

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

EncodePacket Method (SSHReverseTunnel Module)

Hex encodes a Secure Shell (SSH) packet.

Syntax

• Swift
• Objective-C

public func encodePacket(packet: Data) throws -> String

- (NSString*)encodePacket:(NSData*)packet;

Remarks

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

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

ExchangeKeys Method (SSHReverseTunnel Module)

Causes the component to exchange a new set of session keys with the SSHHost .

Syntax

• Swift
• Objective-C

public func exchangeKeys() throws -> Void

- (void)exchangeKeys;

Remarks

Secure Shell (SSH) key renegotiation can be initiated by either end of an established SSH connection. ExchangeKeys allows the user to start such a renegotiation with the SSHHost. During this process, SSHStatus events will fire containing updates regarding the key negotiation process.

The SSH 2.0 specification recommends that key renegotiation be done once for 2 gigabytes (GB) of data processed by the connection, or once every day. Doing so makes it more difficult to break the security of data-intensive or long-lived connections.

GetSSHParam Method (SSHReverseTunnel Module)

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

Syntax

• Swift
• Objective-C

public func getSSHParam(payload: Data, field: String) throws -> String

- (NSString*)getSSHParam:(NSData*)payload :(NSString*)field;

Remarks

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

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

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

pty-req

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

x11-req

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

env

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

exec

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

subsystem

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

xon-xoff

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

signal

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

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

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

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

GetSSHParamBytes Method (SSHReverseTunnel Module)

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

Syntax

• Swift
• Objective-C

public func getSSHParamBytes(payload: Data, field: String) throws -> Data

- (NSData*)getSSHParamBytes:(NSData*)payload :(NSString*)field;

Remarks

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

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

RequestForwarding Method (SSHReverseTunnel Module)

Requests the server to forward a remote Transmission Control Protocol (TCP)/IP port.

Syntax

• Swift
• Objective-C

public func requestForwarding(address: String, port: Int32, forwardingHost: String, forwardingPort: Int32) throws -> Void

- (void)requestForwarding:(NSString*)address :(int)port :(NSString*)forwardingHost :(int)forwardingPort;

Remarks

The RequestForwarding method asks the server to listen at the specified TCP/IP Address and Port for connection requests and then forward them as new Secure Shell (SSH) channels to the class.

ForwardingHost and ForwardingPort may be used to specify an address and port to which traffic will automatically be forwarded. If automatic forwarding is not desired, specify an empty string ("") for the ForwardingHost parameter.

The Address argument can be specified in different ways:

• "" means that connections are to be accepted on all protocol families supported by the server.
• "0.0.0.0" means to listen on all IPv4 addresses.
• "::" means to listen on all IPv6 addresses.
• "localhost" means to listen on all protocol families supported by the Secure Shell (SSH) implementation on loopback addresses only.
• "127.0.0.1" and "::1" indicate listening on the loopback interfaces for IPv4 and IPv6, respectively.

Passing a value of 0 for the Port parameter instructs the server to assign a port. In this case, query the ForwardedPort setting to determine the port that was assigned by the server.

The class has two modes that allow data to be dealt with directly from the events, or automatically forwarded on to a different endpoint.

Event Based Operation

In this mode, any data received by the class over the tunnel causes the events of the class to fire. For instance:

SSHReverseTunnel.RequestForwarding("0.0.0.0", 777, "", 0);

In the above code, forwarding is requested from port 777 on the SSHHost. Any data received on port 777 by the SSHHost will be sent to the class. In the above code, the last two parameters are empty and 0, indicating to the class that no local forwarding is requested.

Once RequestForwarding returns, the Secure Shell (SSH) reverse tunnel is established. Any connection made to the SSH host on the specified port will then trigger the class's events to fire, allowing you to handle the connection request and data.

When a client connects to the SSH host on the specified port, the SSHChannelOpenRequest event will fire. Within this event, choose to accept or reject the connection by setting the Accept parameter. This event contains details about the connection that may be used when determining whether to accept the connection.

After the channel is established, data are received through the SSHChannelData event. Call the SendChannelData method to send data over the channel, and call the CloseChannel method to close the channel.

Local Forwarding

In this mode, any data received by the class is automatically forwarded to a separate endpoint. This allows the class to act as a sort of proxy. There is no need to handle data directly in this case. For instance: SSHReverseTunnel.RequestForwarding("0.0.0.0", 777, "nsoftware.com", 80);

In the above code, forwarding is requested from port 777 on SSHHost. The class is instructed to establish a connection to "nsoftware.com" on port 80 when a client connects to SSHHost on port 777. Any data received from the client connected to SSHHost on port 777 will automatically be forwarded to "nsoftware.com" on port 80. Any data received back from "nsoftware.com" on port 80 will be sent back to the connected client.

In this mode, data may flow freely from the client connected to the SSHHost to the endpoint specified in the RequestForwarding method without any additional code required.

Reset Method (SSHReverseTunnel Module)

This method will reset the component.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

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

SendChannelData Method (SSHReverseTunnel Module)

Sends data over a Secure Shell (SSH) channel.

Syntax

• Swift
• Objective-C

public func sendChannelData(channelId: String, data: Data) throws -> Void

- (void)sendChannelData:(NSString*)channelId :(NSData*)data;

Remarks

This method can be used to send arbitrary data to the channel with the specified ChannelId.

SetSSHParam Method (SSHReverseTunnel Module)

Writes a field to the end of a payload.

Syntax

• Swift
• Objective-C

public func setSSHParam(payload: Data, fieldType: String, fieldValue: String) throws -> Data

- (NSData*)setSSHParam:(NSData*)payload :(NSString*)fieldType :(NSString*)fieldValue;

Remarks

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

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

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

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

SSHLogoff Method (SSHReverseTunnel Module)

Logs off from the Secure Shell (SSH) server.

Syntax

• Swift
• Objective-C

public func SSHLogoff() throws -> Void

- (void)SSHLogoff;

Remarks

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

SSHLogon Method (SSHReverseTunnel Module)

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

Syntax

• Swift
• Objective-C

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

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

Remarks

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

Example. Logging On:

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

Connected Event (SSHReverseTunnel Module)

Fired immediately after a connection completes (or fails).

Syntax

• Swift
• Objective-C

func onConnected(statusCode: Int32, description: String)

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

Remarks

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

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

Please refer to the Error Codes section for more information.

ConnectionStatus Event (SSHReverseTunnel Module)

Fired to indicate changes in the connection state.

Syntax

• Swift
• Objective-C

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

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

Remarks

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

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

Disconnected Event (SSHReverseTunnel Module)

Fired when a connection is closed.

Syntax

• Swift
• Objective-C

func onDisconnected(statusCode: Int32, description: String)

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

Remarks

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

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

Please refer to the Error Codes section for more information.

Error Event (SSHReverseTunnel Module)

Fired when information is available about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

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

Remarks

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

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

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

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

Log Event (SSHReverseTunnel Module)

Fired once for each log message.

Syntax

• Swift
• Objective-C

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

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

Remarks

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

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

Message is the log message.

LogType is reserved for future use.

ReconnectAttempt Event (SSHReverseTunnel Module)

Fired when attempting to reconnect.

Syntax

• Swift
• Objective-C

func onReconnectAttempt(host: String, port: Int32, retryCount: Int32, retriesRemaining: Int32, maxRetryCount: Int32, retryInterval: Int32, retryType: Int32, remoteListeningPort: Int32, cancel: inout Bool)

- (void)onReconnectAttempt:(NSString*)host :(int)port :(int)retryCount :(int)retriesRemaining :(int)maxRetryCount :(int)retryInterval :(int)retryType :(int)remoteListeningPort :(int*)cancel;

Remarks

This event fires both when attempting to reconnect to the SSHHost and when reestablishing a Secure Shell (SSH) tunnel.

This is applicable only when AutoReconnect is enabled. To determine which type of connection is being established check the RetryType parameter.

The following table provides details about the parameters:

SSHChannelClosed Event (SSHReverseTunnel Module)

Fired when a channel is closed.

Syntax

• Swift
• Objective-C

func onSSHChannelClosed(channelId: String)

- (void)onSSHChannelClosed:(NSString*)channelId;

Remarks

The SSHChannelClosed event is fired when a channel is closed on a Secure Shell (SSH) connection.

Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

SSHChannelData Event (SSHReverseTunnel Module)

Fired when the SSHHost sends channel data to the client.

Syntax

• Swift
• Objective-C

func onSSHChannelData(channelId: String, channelData: Data, channelDataEOLFound: Bool)

- (void)onSSHChannelData:(NSString*)channelId :(NSData*)channelData :(BOOL)channelDataEOLFound;

Remarks

The SSHChannelData event will fire as data are received for the given ChannelId. ChannelData will contain the decrypted contents of the Secure Shell (SSH) packet.

ChannelDataEOLFound indicates whether or not the ChannelEOL string for the channel was found at the end of ChannelData. If the ChannelEOL string was found, then ChannelDataEOLFound is True.

If ChannelData is part of a data portion of a length that is larger than the MaxChannelLength for the Channel with no ChannelEOL strings in it, then ChannelDataEOLFound is False.

Note: This means that one of more SSHChannelData events with ChannelDataEOLFound set to False can be received.

If the ChannelEOL property for the Channel is "" (empty string), then ChannelDataEOLFound can be disregarded (it is always True).

SSHChannelEOF Event (SSHReverseTunnel Module)

Fired when the remote peer signals the end of the data stream for the channel.

Syntax

• Swift
• Objective-C

func onSSHChannelEOF(channelId: String)

- (void)onSSHChannelEOF:(NSString*)channelId;

Remarks

The SSHChannelEOF event is fired when the end of the data stream for a channel on a Secure Shell (SSH) connection is reached.

Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

SSHChannelOpened Event (SSHReverseTunnel Module)

Fired when a channel is successfully opened.

Syntax

• Swift
• Objective-C

func onSSHChannelOpened(channelId: String)

- (void)onSSHChannelOpened:(NSString*)channelId;

Remarks

The SSHChannelOpened event is fired when a channel is successfully opened on a Secure Shell (SSH) connection.

Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

SSHChannelOpenRequest Event (SSHReverseTunnel Module)

Fired when the peer attempts to open a new channel.

Syntax

• Swift
• Objective-C

func onSSHChannelOpenRequest(channelId: String, service: String, connectedAddress: String, connectedPort: Int32, originAddress: String, originPort: Int32, accept: inout Bool)

- (void)onSSHChannelOpenRequest:(NSString*)channelId :(NSString*)service :(NSString*)connectedAddress :(int)connectedPort :(NSString*)originAddress :(int)originPort :(int*)accept;

Remarks

This event is fired whenever a peer attempts to open a new channel for a given connection. ChannelId will contain the Id of the channel to be created. Service will identify the type of channel that is being requested. Usually, this will be "forwarded-tcpip", in which case ConnectedAddress and ConnectedPort will contain the remote Transmission Control Protocol (TCP)/IP address and port on the peer to which the connection was established; OriginAddress and OriginPort contain the originating TCP/IP address and port of the connection.

By default, Accept is True and the channel will be opened. Set Accept to False to reject the request.

SSHChannelReadyToSend Event (SSHReverseTunnel Module)

Fired when the component is ready to send data.

Syntax

• Swift
• Objective-C

func onSSHChannelReadyToSend(channelId: String)

- (void)onSSHChannelReadyToSend:(NSString*)channelId;

Remarks

This event fires when data can be sent over the Secure Shell (SSH) Channel specified by ChannelId.

When a channel is opened, this event will fire after the channel is ready and data can be sent.

When Timeout is set to 0 (asynchronous) sending data may result in an error if the channel or underlying socket cannot accept more data to send. Monitor SSHChannelReadyToSend or ChannelsReadyToSend to determine when data can be sent again.

When Timeout is set to a positive value, the class will block when sending data until the data can be successfully sent and SSHChannelReadyToSend and ChannelsReadyToSend do not need to be monitored.

SSHChannelRequest Event (SSHReverseTunnel Module)

Fired when the SSHHost sends a channel request to the client.

Syntax

• Swift
• Objective-C

func onSSHChannelRequest(channelId: String, requestType: String, packet: Data, success: inout Bool)

- (void)onSSHChannelRequest:(NSString*)channelId :(NSString*)requestType :(NSData*)packet :(int*)success;

Remarks

The SSHHost may send requests that affect the status of a particular SSHChannel. Some requests will be automatically handled by the class. Others, however, may need the attention of the user to be dealt with properly within the scope of the application.

ChannelId identifies the channel receiving the request.

Type will contain the type of the request. These types depend on the type of the channel. For example, a "session" channel executing a command on the remote shell may receive an "exit-status" request containing the return code of that command.

RequestData contains the remainder of the original Secure Shell (SSH) packet. If the request type has specific parameters, they can be parsed out of this data.

Success should be used to instruct the class to respond to the request with either a success or failure notification. If the request is successful, SSHChannelRequested will fire with the same information in case the request requires further processing.

Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

SSHChannelRequested Event (SSHReverseTunnel Module)

Fired if the SSHChannelRequest was successful; any further processing for the channel request should be done here.

Syntax

• Swift
• Objective-C

func onSSHChannelRequested(channelId: String, requestType: String, packet: Data)

- (void)onSSHChannelRequested:(NSString*)channelId :(NSString*)requestType :(NSData*)packet;

Remarks

The SSHHost may send requests that affect the status of a particular SSHChannel. Some requests will be automatically handled by the class. Others, however, may need the attention of the user to be dealt with properly within the scope of the application.

ChannelId identifies the channel receiving the request.

Type will contain the type of the request. These types depend on the type of the channel. For example, a "session" channel executing a command on the remote shell may receive an "exit-status" request containing the return code of that command.

RequestData contains the remainder of the original Secure Shell (SSH) packet. If the request type has specific parameters, they can be parsed out of this data.

Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

SSHCustomAuth Event (SSHReverseTunnel Module)

Fired when the component is doing a custom authentication.

Syntax

• Swift
• Objective-C

func onSSHCustomAuth(packet: inout String)

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

Remarks

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

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

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

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

SSHKeyboardInteractive Event (SSHReverseTunnel Module)

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

Syntax

• Swift
• Objective-C

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

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

Remarks

SSHKeyboardInteractive is fired during the user authentication stage of the Secure Shell (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 (SSHReverseTunnel Module)

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

Syntax

• Swift
• Objective-C

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

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

Remarks

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

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

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

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

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

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

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

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

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

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

Status is reserved for future use.

SSHStatus Event (SSHReverseTunnel Module)

Fired to track the progress of the secure connection.

Syntax

• Swift
• Objective-C

func onSSHStatus(message: String)

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

Remarks

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

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

public init()

public init(encoded: )

public init(storeType: , store: , storePassword: , subject: )

public init(storeType: , store: , storePassword: , subject: )

Firewall Type

The firewall the component will connect through.

Remarks

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

Fields

Constructors

public init()

SSHRTChannel Type

A currently open Secure Shell (SSH) channel.

Remarks

This type holds details about currently open channels. Each time a client connects to the reverse tunnel a new channel of this type is added to Channels.

Fields

Config Settings (SSHReverseTunnel Module)

SSHReverseTunnel Config Settings

SSHClient Config Settings

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

TCPClient Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (SSHReverseTunnel Module)

SSHReverseTunnel Errors

SSHClient Errors

TCPClient Errors

TCP/IP Errors