Sample code for 30+ languages & platforms
SQL Server

SSH Tunnel Authenticate with a Private Key

See more SSH Tunnel Examples

Demonstrates the Chilkat SshTunnel.AuthenticatePk method, which authenticates the SSH connection using public-key authentication. The first argument is the username and the second is an SshKey private key. The matching public key must already be installed for the account on the SSH server.

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: Public-key authentication suits tunnels especially well because they typically run unattended for long periods: the private key stays on the client, the server trusts the corresponding public key, and no reusable password crosses the wire. The SshKey object imports several formats; for an encrypted key, set its Password before importing.

Chilkat SQL Server Downloads

SQL Server
-- 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.AuthenticatePk method, which authenticates the SSH connection using
    --  public-key authentication.  The 1st argument is the username and the 2nd is an SshKey private
    --  key.  The matching public key must already be installed for the account on the SSH server.

    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

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

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

    PRINT 'Authenticated with a private key.'

    --  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
        RETURN
      END

    EXEC @hr = sp_OADestroy @tunnel
    EXEC @hr = sp_OADestroy @privKey


END
GO