Sample code for 30+ languages & platforms
B4X

SSH Tunnel Uncommon Options

See more SSH Tunnel Examples

Demonstrates the UncommonOptions property, which enables optional behavior for uncommon requirements. The default is an empty string; provide a comma-separated list of keywords to enable more than one option. Available keywords are listed in the reference documentation.

Background: This is a catch-all for narrow workarounds that do not warrant their own properties — forcing a specific signature algorithm, disabling the periodic keep-alive, removing weak MACs, bypassing a VPN on Android, and so on. Most applications never set it. When you do, it is usually to satisfy a particular server's quirk or a specific security requirement, and the exact keyword matters, so consult the documented list rather than guessing.

Chilkat B4X Downloads

B4X
Dim success As Boolean = False

'  Demonstrates the SshTunnel.UncommonOptions property, which enables optional behavior for
'  uncommon requirements.  The default is an empty string, appropriate for most applications.
'  Provide a comma-separated list of keywords to enable more than one option.

Dim tunnel As ChilkatSshTunnel
tunnel.Initialize("tunnel")

'  For example, disable the periodic keep-alive ignore message and remove weak MAC algorithms
'  from those offered.  Available keywords are listed in the reference documentation.
tunnel.UncommonOptions = "NoKeepAliveIgnoreMsg,no-weak-mac-algs"

tunnel.DestHostname = "db.internal.example.com"
tunnel.DestPort = 5432

Dim sshPort As Int = 22
success = tunnel.Connect("ssh.example.com", sshPort)
If success = False Then
    Log(tunnel.LastErrorText)
    Return
End If


'  Normally you would not hard-code the password in source.  You should instead obtain it
'  from an interactive prompt, environment variable, or a secrets vault.
Dim password As String = "mySshPassword"

success = tunnel.AuthenticatePw("mySshLogin", password)
If success = False Then
    Log(tunnel.LastErrorText)
    Return
End If


Dim listenPort As Int = 1080
success = tunnel.BeginAccepting(listenPort)
If success = False Then
    Log(tunnel.LastErrorText)
    Return
End If

Log("Tunnel established.")

Dim waitForThreadExit As Boolean = True
success = tunnel.CloseTunnel(waitForThreadExit)
If success = False Then
    Log(tunnel.LastErrorText)
    Return
End If