SSH Tunnel Authenticate with a SecureString Password and Private Key

See more SSH Tunnel Examples

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.

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    DECLARE @sTmp0 nvarchar(4000)
    DECLARE @success int
    SELECT @success = 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.

    DECLARE @tunnel int
    EXEC @hr = sp_OACreate 'Chilkat.SshTunnel', @tunnel OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    --  The tunnel forwards accepted local connections to this destination through the SSH server.
    EXEC sp_OASetProperty @tunnel, 'DestHostname', 'db.internal.example.com'
    EXEC sp_OASetProperty @tunnel, 'DestPort', 5432

    --  Connect to the SSH server.  This performs the TCP/proxy connection and SSH handshake, but
    --  does not authenticate yet.
    DECLARE @sshPort int
    SELECT @sshPort = 22
    EXEC sp_OAMethod @tunnel, 'Connect', @success OUT, 'ssh.example.com', @sshPort
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @tunnel, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @tunnel
        RETURN
      END

    --  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.
    DECLARE @password nvarchar(4000)
    SELECT @password = 'mySshPassword'

    --  Load the SSH private key.  LoadText reads the file's text, which is then imported.
    DECLARE @privKey int
    EXEC @hr = sp_OACreate 'Chilkat.SshKey', @privKey OUT

    DECLARE @keyText nvarchar(4000)
    EXEC sp_OAMethod @privKey, 'LoadText', @keyText OUT, 'qa_data/id_rsa'
    EXEC sp_OAGetProperty @privKey, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @privKey, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @tunnel
        EXEC @hr = sp_OADestroy @privKey
        RETURN
      END
    EXEC sp_OAMethod @privKey, 'FromOpenSshPrivateKey', @success OUT, @keyText
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @privKey, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @tunnel
        EXEC @hr = sp_OADestroy @privKey
        RETURN
      END

    --  Place the login and password into SecureString objects.
    DECLARE @secureLogin int
    EXEC @hr = sp_OACreate 'Chilkat.SecureString', @secureLogin OUT

    EXEC sp_OAMethod @secureLogin, 'Append', @success OUT, 'mySshLogin'
    DECLARE @securePassword int
    EXEC @hr = sp_OACreate 'Chilkat.SecureString', @securePassword OUT

    EXEC sp_OAMethod @securePassword, 'Append', @success OUT, @password

    EXEC sp_OAMethod @tunnel, 'AuthenticateSecPwPk', @success OUT, @secureLogin, @securePassword, @privKey
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @tunnel, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @tunnel
        EXEC @hr = sp_OADestroy @privKey
        EXEC @hr = sp_OADestroy @secureLogin
        EXEC @hr = sp_OADestroy @securePassword
        RETURN
      END

    PRINT 'Authenticated.'

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

    DECLARE @waitForThreadExit int
    SELECT @waitForThreadExit = 1
    EXEC sp_OAMethod @tunnel, 'CloseTunnel', @success OUT, @waitForThreadExit
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @tunnel, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @tunnel
        EXEC @hr = sp_OADestroy @privKey
        EXEC @hr = sp_OADestroy @secureLogin
        EXEC @hr = sp_OADestroy @securePassword
        RETURN
      END

    EXEC @hr = sp_OADestroy @tunnel
    EXEC @hr = sp_OADestroy @privKey
    EXEC @hr = sp_OADestroy @secureLogin
    EXEC @hr = sp_OADestroy @securePassword


END
GO