Xbase++

SSH Tunnel Authenticate with a SecureString Password and Private Key

Demonstrates the Chilkat SshTunnel.AuthenticateSecPwPk method, which authenticates using SecureString login and password objects together with a private key. The third argument is the SshKey private key.

Note: The private-key path is relative to the application's current working directory. Absolute paths may also be used. Supply the path to your own key file.

Background: This is the SecureString form of two-factor tunnel authentication: the password is held encrypted in memory and combined with a private key for servers that require both. It is the most protective option when a deployment mandates two-factor SSH and you also want to minimize plaintext credential exposure in a long-running process.

Chilkat Xbase++ Downloads

Download Chilkat for Xbase++

Xbase++

LOCAL nSuccess
LOCAL oTunnel
LOCAL nSshPort
LOCAL cPassword
LOCAL oPrivKey
LOCAL cKeyText
LOCAL oSecureLogin
LOCAL oSecurePassword
LOCAL nWaitForThreadExit

nSuccess := 0

//  Demonstrates the SshTunnel.AuthenticateSecPwPk method, which authenticates using SecureString
//  login and password objects together with a private key.  The 1st argument is the username, the
//  2nd is the password, and the 3rd is an SshKey private key.

oTunnel := CreateObject("Chilkat.SshTunnel")

//  The tunnel forwards accepted local connections to this destination through the SSH server.
oTunnel:DestHostname := "db.internal.example.com"
oTunnel:DestPort := 5432

//  Connect to the SSH server.  This performs the TCP/proxy connection and SSH handshake, but
//  does not authenticate yet.
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"

//  Load the SSH private key.  LoadText reads the file's text, which is then imported.
oPrivKey := CreateObject("Chilkat.SshKey")
cKeyText := oPrivKey:LoadText("qa_data/id_rsa")
IF (oPrivKey:LastMethodSuccess == 0)
    ? oPrivKey:LastErrorText
    oTunnel:destroy()
    oPrivKey:destroy()
    RETURN
ENDIF

nSuccess := oPrivKey:FromOpenSshPrivateKey(cKeyText)
IF (nSuccess == 0)
    ? oPrivKey:LastErrorText
    oTunnel:destroy()
    oPrivKey:destroy()
    RETURN
ENDIF

//  Place the login and password into SecureString objects.
oSecureLogin := CreateObject("Chilkat.SecureString")
oSecureLogin:Append("mySshLogin")
oSecurePassword := CreateObject("Chilkat.SecureString")
oSecurePassword:Append(cPassword)

nSuccess := oTunnel:AuthenticateSecPwPk(oSecureLogin, oSecurePassword, oPrivKey)
IF (nSuccess == 0)
    ? oTunnel:LastErrorText
    oTunnel:destroy()
    oPrivKey:destroy()
    oSecureLogin:destroy()
    oSecurePassword:destroy()
    RETURN
ENDIF

? "Authenticated."

//  After authenticating, call BeginAccepting to start listening for local connections to forward.

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

oTunnel:destroy()
oPrivKey:destroy()
oSecureLogin:destroy()
oSecurePassword:destroy()