Sample code for 30+ languages & platforms
AutoIt

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 AutoIt Downloads

AutoIt
Local $bSuccess = 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.

$oTunnel = ObjCreate("Chilkat.SshTunnel")

;  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.
$oTunnel.UncommonOptions = "NoKeepAliveIgnoreMsg,no-weak-mac-algs"

$oTunnel.DestHostname = "db.internal.example.com"
$oTunnel.DestPort = 5432

Local $iSshPort = 22
$bSuccess = $oTunnel.Connect("ssh.example.com",$iSshPort)
If ($bSuccess = False) Then
    ConsoleWrite($oTunnel.LastErrorText & @CRLF)
    Exit
EndIf

;  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.
Local $sPassword = "mySshPassword"

$bSuccess = $oTunnel.AuthenticatePw("mySshLogin",$sPassword)
If ($bSuccess = False) Then
    ConsoleWrite($oTunnel.LastErrorText & @CRLF)
    Exit
EndIf

Local $iListenPort = 1080
$bSuccess = $oTunnel.BeginAccepting($iListenPort)
If ($bSuccess = False) Then
    ConsoleWrite($oTunnel.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite("Tunnel established." & @CRLF)

Local $bWaitForThreadExit = True
$bSuccess = $oTunnel.CloseTunnel($bWaitForThreadExit)
If ($bSuccess = False) Then
    ConsoleWrite($oTunnel.LastErrorText & @CRLF)
    Exit
EndIf