SSHTunnel Module

Properties   Methods   Events   Config Settings   Errors  

The SSHTunnel module can be used to tunnel data through a Secure Shell (SSH) server to a remote location.

Syntax

IPWorksSSH.SSHTunnel

Remarks

The SSHTunnel class implements a daemon that accepts connections and tunnels the data from those connections over a Secure Shell (SSH) connection to a remote location.

First, set SSHHost to the server you wish to use to tunnel the data. SSHUser, SSHPassword, and the SSHCert* properties can be used to authenticate the tunneling connection.

Second, set SSHForwardHost to the hostname or IP address of the destination machine, and SSHForwardPort to the port to which you wish to send data. Finally, call StartListening. The class will listen for connections on the interface identified by LocalHost and LocalPort.

When a client attempts to connect to the class, the class will fire a ConnectionRequest event that can be used to accept or reject the connection. If the connection is accepted, the class will attempt to logon to the SSHHost and will tell the server to connect remotely to another machine. Once this process is complete, the tunnel will be established and data can be securely transmitted from end to end.

Example. Connecting Between Networks:

A client that exists in Network A wishes to connect to a resource that exists in Network B. Both networks are secured by a firewall, making it difficult to freely connect to resources within the other network. Network B, however, contains an SSH server that supports tunneling. An SSHTunnel class set up with Network A can be used to access any resource in Network B.

The SSHHost and SSHPort properties must be set to the hostname and port exposed by Network B's firewall. SSHForwardHost and SSHForwardPort are then set to the value of the resource within Network B to which the client in Network A wishes to connect. Any client in Network A can then connect to the SSHTunnel instance's LocalHost and LocalPort.

As clients within Network A connect to the SSHTunnel, the class will forward the connections, secured by SSH, through the network firewalls to the SSH server in Network B. The SSH server will then connect to the resource within Network B and forward all data received from the SSHTunnel instance to that resource. All data received from the resource will then be forwarded to the original client in Network A.

Dynamic Forwarding

Dynamic forwarding is a feature provided by SSH that leverages the SOCKS protocol. With dynamic forwarding, the SSHTunnel component acts as a SOCKS proxy, and all relevant traffic is relayed through the SSH connection to the destination defined by the client that made the request. The SSHTunnel component supports dynamic forwarding automatically when SSHForwardHost and SSHForwardPort are not specified (the forwarding host is determined dynamically).

The client making requests through SSHTunnel must be configured to use a SOCKS proxy, in which case the proxy port is the same as the LocalPort property. In IPWorks components, a SOCKS proxy can be enabled as follows:

// Enable the SOCKS proxy for IPWorks' HTTP component http.Firewall.FirewallType = nsoftware.IPWorks.FirewallTypes.fwSOCKS5; http.Firewall.Port = 1234; //The port set in the SSHTunnel LocalPort property http.Firewall.Host = "localhost"; //The hostname or IP address where SSHTunnel is listening

Note: SSHTunnel can support either dynamic forwarding (SSHForwardHost and SSHForwardPort are not set) or standard forwarding (SSHForwardHost and SSHForwardPort are set). It cannot support both modes at the same time. As a result, it is expected that clients connecting to the SSHTunnel component are configured in a way that matches the configuration of the SSHTunnel component (dynamic or standard forwarding). For example, if SSHTunnel has the SSHForwardHost and SSHForwardPort properties set, then the client must not treat SSHTunnel as a SOCKS proxy. If the SSHTunnel does not have the aforementioned properties set, then the client must treat SSHTunnel as a SOCKS proxy.

Note: Server components are designed to process events as they occur. To ensure that events are processed in a timely manner, DoEvents should be called in a loop after the server is started.

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.

Connected Property (SSHTunnel Module)

Whether the module is 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 Connect and Disconnect methods to manage the connection.

This property is read-only.

ConnectionBacklog Property (SSHTunnel Module)

This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=connectionBacklog,setter=setConnectionBacklog:) int connectionBacklog;

- (int)connectionBacklog;
- (void)setConnectionBacklog :(int)newConnectionBacklog;

Default Value

5

Remarks

This property contains the maximum number of pending connections maintained by the TCP/IP subsystem. This value reflects the SOMAXCONN option for the main listening socket. The default value for most systems is 5. You may set this property to a larger value if the server is expected to receive a large number of connections, and queuing them is desirable.

Connections Property (SSHTunnel Module)

This property includes a collection of currently connected clients.

Syntax

• Swift
• Objective-C

public var connections: [Int32: Connection] {
  get {...}
}

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

- (int)clientCount;

- (BOOL)clientAcceptData:(int)clientId;

- (int)clientBytesSent:(int)clientId;

- (BOOL)clientConnected:(int)clientId;

- (int)clientConnectionId:(int)clientId;

- (NSString*)clientEOL:(int)clientId;
- (void)setClientEOL:(int)clientId :(NSString*)newClientEOL;

- (NSData*)clientEOLB:(int)clientId;
- (void)setClientEOLB:(int)clientId :(NSData*)newClientEOL;
- (int)clientIdleTimeout:(int)clientId;
- (void)setClientIdleTimeout:(int)clientId :(int)newClientIdleTimeout;

- (NSString*)clientLocalAddress:(int)clientId;

- (BOOL)clientReadyToSend:(int)clientId;

- (int)clientRecordLength:(int)clientId;

- (NSString*)clientRemoteHost:(int)clientId;

- (int)clientRemotePort:(int)clientId;

- (BOOL)clientSingleLineMode:(int)clientId;
- (void)setClientSingleLineMode:(int)clientId :(BOOL)newClientSingleLineMode;

- (int)clientTimeout:(int)clientId;
- (void)setClientTimeout:(int)clientId :(int)newClientTimeout;

- (NSString*)clientUserData:(int)clientId;
- (void)setClientUserData:(int)clientId :(NSString*)newClientUserData;

- (NSData*)clientUserDataB:(int)clientId;
- (void)setClientUserDataB:(int)clientId :(NSData*)newClientUserData;

Default Value

""

Remarks

This property contains a collection of currently connected clients. All of the connections may be managed using this property. Each connection is described by the different fields of the Connection type.

This collection is a hash-table type of collection, in which the Connection Id string is used as the key to the desired connection. You may acquire the key for a given connection through the Connected event.

Example (Broadcasting Data) For i = 0 to Control.ConnectionCount Control.DataToSend(Control.ConnectionId(i)) = "Broadcast Data" Next i

DefaultEOL Property (SSHTunnel Module)

This property includes a default end-of-line (EOL) value to be used by incoming connections.

Syntax

• Swift
• Objective-C

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

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

@property (nonatomic,readwrite,assign,getter=defaultEOL,setter=setDefaultEOL:) NSString* defaultEOL;

- (NSString*)defaultEOL;
- (void)setDefaultEOL :(NSString*)newDefaultEOL;

@property (nonatomic,readwrite,assign,getter=defaultEOLB,setter=setDefaultEOLB:) NSData* defaultEOLB;

- (NSData*)defaultEOLB;
- (void)setDefaultEOLB :(NSData*)newDefaultEOL;

Default Value

""

Remarks

This property contains a default end-of-line (EOL) value to be used by incoming connections. Once the class accepts and establishes an inbound connection, it will set that connection's EOL to the value in this property. By default, this value is empty (""), meaning that data will be fired as it is received.

DefaultSingleLineMode Property (SSHTunnel Module)

This property tells the module whether or not to treat new connections as line oriented.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=defaultSingleLineMode,setter=setDefaultSingleLineMode:) BOOL defaultSingleLineMode;

- (BOOL)defaultSingleLineMode;
- (void)setDefaultSingleLineMode :(BOOL)newDefaultSingleLineMode;

Default Value

False

Remarks

This property instructs the component whether or not to treat newly established connections as line-oriented protocols. If this value is True, newly accepted connections will read the incoming data stream as lines separated by a carriage return line feed (CRLF), carriage return (CR), or line feed (LF) and will ignore the end of lines (EOLs).

DefaultTimeout Property (SSHTunnel Module)

This property includes an initial timeout value to be used by incoming connections.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=defaultTimeout,setter=setDefaultTimeout:) int defaultTimeout;

- (int)defaultTimeout;
- (void)setDefaultTimeout :(int)newDefaultTimeout;

Default Value

0

Remarks

This property is used by the class to set the operational timeout value of all inbound connections once they are established.

By default, the timeout is 0, meaning that all inbound connections will behave asynchronously.

Firewall Property (SSHTunnel 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

""

Remarks

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

KeepAlive Property (SSHTunnel Module)

When True, KEEPALIVE packets are enabled (for long connections).

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=keepAlive,setter=setKeepAlive:) BOOL keepAlive;

- (BOOL)keepAlive;
- (void)setKeepAlive :(BOOL)newKeepAlive;

Default Value

False

Remarks

This property enables the SO_KEEPALIVE option on the incoming connections. This option prevents long connections from timing out in case of inactivity.

Note: System Transmission Control Protocol (TCP)/IP stack implementations are not required to support SO_KEEPALIVE.

This property is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.

Linger Property (SSHTunnel Module)

When set to True, connections are terminated gracefully.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=linger,setter=setLinger:) BOOL linger;

- (BOOL)linger;
- (void)setLinger :(BOOL)newLinger;

Default Value

True

Remarks

This property controls how a connection is closed. The default is True. In this case, the connection is closed only after all the data are sent. Setting it to False forces an abrupt (hard) disconnection. Any data that were in the sending queue may be lost.

The default behavior (which is also the default mode for stream sockets) might result in an indefinite delay in closing the connection. Although the class returns control immediately, the system might indefinitely hold system resources until all pending data are sent (even after your application closes). This means that valuable system resources might be wasted.

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

This property is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.

Listening Property (SSHTunnel Module)

This property indicates whether the module is listening for incoming connections on LocalPort.

Syntax

• Swift
• Objective-C

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

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

- (BOOL)listening;

Default Value

False

Remarks

This property indicates whether the class is listening for connections on the port specified by the LocalPort property. Use the StartListening and StopListening methods to control whether the class is listening.

This property is read-only.

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 setListening(listening: Bool) throws

LocalHost Property (SSHTunnel 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 (SSHTunnel 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 the class can start listening. If its value is 0, then the TCP/IP subsystem picks a port number at random. The port number can be found by checking the value of this property after the class is listening (i.e., after successfully assigning True to the Listening property).

The service port is not shared among servers so two classs cannot be listening on the same port at the same time.

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 (SSHTunnel 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

""

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

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

Syntax

• Swift
• Objective-C

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

public enum SSHTunnelSSHAuthModes: 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 (SSHTunnel 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

""

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 (SSHTunnel 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 (SSHTunnel 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:

SSHForwardHost Property (SSHTunnel Module)

The address of the remote host. Domain names are resolved to IP addresses.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=SSHForwardHost,setter=setSSHForwardHost:) NSString* SSHForwardHost;

- (NSString*)SSHForwardHost;
- (void)setSSHForwardHost :(NSString*)newSSHForwardHost;

Default Value

""

Remarks

The SSHForwardHost 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 SSHForwardHost property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the SSHForwardHost property is set to the corresponding address. If the search is not successful, an error is returned.

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

SSHForwardPort Property (SSHTunnel Module)

The Transmission Control Protocol (TCP) port in the remote host.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=SSHForwardPort,setter=setSSHForwardPort:) int SSHForwardPort;

- (int)SSHForwardPort;
- (void)setSSHForwardPort :(int)newSSHForwardPort;

Default Value

0

Remarks

The SSHForwardPort property specifies a service port on the remote 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.

SSHHost Property (SSHTunnel 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 (SSHTunnel 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 (SSHTunnel 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 (SSHTunnel 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)

Config Method (SSHTunnel 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.

Connect Method (SSHTunnel Module)

Connects to the Secure Shell (SSH) host without logging in.

Syntax

• Swift
• Objective-C

public func connect() throws -> Void

- (void)connect;

Remarks

This method establishes a connection with the SSHHost but does not log in. In most cases, it is recommended to use the StartListening method that will both establish a connection and log in to the server.

This method may be useful in cases in which it is desirable to separate the connection and logon operations, for instance, when confirming a host is available by first creating the connection.

DecodePacket Method (SSHTunnel 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.

Disconnect Method (SSHTunnel Module)

This method disconnects the specified client.

Syntax

• Swift
• Objective-C

public func disconnect(connectionId: Int32) throws -> Void

- (void)disconnect:(int)connectionId;

Remarks

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

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

Calling this method will disconnect the client specified by the ConnectionId parameter.

DoEvents Method (SSHTunnel 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 (SSHTunnel 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.

GetSSHParam Method (SSHTunnel 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 (SSHTunnel 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.

Reset Method (SSHTunnel 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.

SetSSHParam Method (SSHTunnel 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.

Shutdown Method (SSHTunnel Module)

This method shuts down the server.

Syntax

• Swift
• Objective-C

public func shutdown() throws -> Void

- (void)shutdown;

Remarks

This method shuts down the server. Calling this method is equivalent to calling StopListening and then breaking every client connection by calling Disconnect.

StartListening Method (SSHTunnel Module)

This method starts listening for incoming connections.

Syntax

• Swift
• Objective-C

public func startListening() throws -> Void

- (void)startListening;

Remarks

This method begins listening for incoming connections on the port specified by LocalPort. Once listening, events will fire as new clients connect and data are transferred.

To stop listening for new connections, call StopListening. To stop listening for new connections and to disconnect all existing clients, call Shutdown.

StopListening Method (SSHTunnel Module)

This method stops listening for new connections.

Syntax

• Swift
• Objective-C

public func stopListening() throws -> Void

- (void)stopListening;

Remarks

This method stops listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections.

To stop listening and to disconnect all existing clients, call Shutdown instead.

Connected Event (SSHTunnel Module)

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

Syntax

• Swift
• Objective-C

func onConnected(connectionId: Int32, statusCode: Int32, description: String)

- (void)onConnected:(int)connectionId :(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 system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

ConnectionRequest Event (SSHTunnel Module)

This event is fired when a request for connection comes from a remote host.

Syntax

• Swift
• Objective-C

func onConnectionRequest(address: String, port: Int32, accept: inout Bool)

- (void)onConnectionRequest:(NSString*)address :(int)port :(int*)accept;

Remarks

This event indicates an incoming connection. The connection is accepted by default. Address and Port will contain information about the remote host requesting the inbound connection. If you want to refuse it, you can set the Accept parameter to False.

DataIn Event (SSHTunnel Module)

This event is fired when data come in.

Syntax

• Swift
• Objective-C

func onDataIn(connectionId: Int32, text: Data, eol: Bool)

- (void)onDataIn:(int)connectionId :(NSData*)text :(BOOL)EOL;

Remarks

Trapping the DataIn event is your only chance to get the data coming from the other end of the connection specified by ConnectionId. The incoming data are provided through the Text parameter.

EOL indicates whether or not the EOL string was found at the end of Text. If the EOL string was found, then EOL is True.

If Text is part of the data portion of length larger than either DefaultMaxLineLength or with no EOL strings in it, then EOL is False. Please note that this means that one or more DataIn events with EOL set to False can be received during a connection.

If the EOL property is "" (empty string), then EOL can be disregarded (it is always True).

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Disconnected Event (SSHTunnel Module)

Fired when a connection is closed.

Syntax

• Swift
• Objective-C

func onDisconnected(connectionId: Int32, statusCode: Int32, description: String)

- (void)onDisconnected:(int)connectionId :(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 system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

Note: When the class is disconnected from the Secure Shell (SSH) server for any reason the ConnectionId parameter will be -1.

Error Event (SSHTunnel Module)

Fired when errors occur during data delivery.

Syntax

• Swift
• Objective-C

func onError(connectionId: Int32, errorCode: Int32, description: String)

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

Remarks

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

ConnectionId 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.

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.

Log Event (SSHTunnel 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 (SSHTunnel 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:

SSHCustomAuth Event (SSHTunnel 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 (SSHTunnel 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 (SSHTunnel 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 (SSHTunnel 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: )

Connection Type

This is a currently connected client.

Remarks

This type describes the connection of a client that is currently connected to the class. You may use the different fields of this type to manage the connection.

Fields

Constructors

public init()

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

Config Settings (SSHTunnel Module)

SSHTunnel Config Settings

SSHClient Config Settings

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

TCPClient Config Settings

Socket Config Settings

TCPServer Config Settings

Base Config Settings

Trappable Errors (SSHTunnel Module)

SSHTunnel Errors

SSHClient Errors

TCPClient Errors

TCP/IP Errors