Ruby

SSH Tunnel Credentials from OS Secure Storage

Demonstrates the EnableSecrets property, which enables automatic resolution of credentials from the operating system's secure storage. When enabled, password properties and methods may receive a "secret specification string" beginning with !! instead of a literal password.

Background: This is a cleaner alternative to reading a secret yourself and passing it in: with EnableSecrets on, you hand Chilkat a reference like !!my_secret_name and it fetches the actual value from the platform's secure store — Windows Credential Manager, Apple Keychain, and so on. The literal password never appears in your source or configuration, which is exactly the practice recommended throughout these examples.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

#  Demonstrates the SshTunnel.EnableSecrets property, which enables automatic resolution of
#  credentials from the operating system's secure storage.

tunnel = Chilkat::CkSshTunnel.new()

#  When EnableSecrets is true, supported password properties and methods may receive a "secret
#  specification string" beginning with "!!" instead of a literal password.  Chilkat resolves the
#  secret from the OS secure store (Windows Credential Manager, Apple Keychain, etc.).
tunnel.put_EnableSecrets(true)

tunnel.put_DestHostname("db.internal.example.com")
tunnel.put_DestPort(5432)

sshPort = 22
success = tunnel.Connect("ssh.example.com",sshPort)
if (success == false)
    print tunnel.lastErrorText() + "\n";
    exit
end

#  Pass a secret specification instead of a literal password.  Chilkat looks up the named secret
#  in the OS secure store rather than using this text directly.
password = "!!my_ssh_password_secret"
success = tunnel.AuthenticatePw("mySshLogin",password)
if (success == false)
    print tunnel.lastErrorText() + "\n";
    exit
end

listenPort = 1080
success = tunnel.BeginAccepting(listenPort)
if (success == false)
    print tunnel.lastErrorText() + "\n";
    exit
end

print "Authenticated using a secret from OS secure storage." + "\n";

waitForThreadExit = true
success = tunnel.CloseTunnel(waitForThreadExit)
if (success == false)
    print tunnel.lastErrorText() + "\n";
    exit
end