Xbase++

SSH Tunnel Uncommon Options

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 Xbase++ Downloads

Download Chilkat for Xbase++

Xbase++

LOCAL nSuccess
LOCAL oTunnel
LOCAL nSshPort
LOCAL cPassword
LOCAL nListenPort
LOCAL nWaitForThreadExit

nSuccess := 0

//  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 := CreateObject("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

nSshPort := 22
nSuccess := oTunnel:Connect("ssh.example.com", nSshPort)
IF (nSuccess == 0)
    ? oTunnel:LastErrorText
    oTunnel:destroy()
    RETURN
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.
cPassword := "mySshPassword"

nSuccess := oTunnel:AuthenticatePw("mySshLogin", cPassword)
IF (nSuccess == 0)
    ? oTunnel:LastErrorText
    oTunnel:destroy()
    RETURN
ENDIF

nListenPort := 1080
nSuccess := oTunnel:BeginAccepting(nListenPort)
IF (nSuccess == 0)
    ? oTunnel:LastErrorText
    oTunnel:destroy()
    RETURN
ENDIF

? "Tunnel established."

nWaitForThreadExit := 1
nSuccess := oTunnel:CloseTunnel(nWaitForThreadExit)
IF (nSuccess == 0)
    ? oTunnel:LastErrorText
    oTunnel:destroy()
    RETURN
ENDIF

oTunnel:destroy()