SQL Server

SSH Public Key Authentication

See more SSH Examples

Demonstrates how to authenticate with an SSH server using public key authentication. 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
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    DECLARE @success int
    SELECT @success = 0

    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

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

    -- Set some timeouts, in milliseconds:
    EXEC sp_OASetProperty @ssh, 'ConnectTimeoutMs', 5000
    EXEC sp_OASetProperty @ssh, 'IdleTimeoutMs', 15000

    -- Connect to the SSH server.  
    -- The standard SSH port = 22
    -- The hostname may be a hostname or IP address.
    DECLARE @hostname nvarchar(4000)
    SELECT @hostname = 'sftp.example.com'
    DECLARE @port int
    SELECT @port = 22
    EXEC sp_OAMethod @ssh, 'Connect', @success OUT, @hostname, @port
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @ssh, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        RETURN
      END

    DECLARE @key int
    EXEC @hr = sp_OACreate 'Chilkat.SshKey', @key OUT

    -- Read the PEM file into a string variable:
    -- (This does not load the PEM file into the key.  The LoadText
    -- method is a convenience method for loading the full contents of ANY text
    -- file into a string variable.)
    DECLARE @privKey nvarchar(4000)
    EXEC sp_OAMethod @key, 'LoadText', @privKey OUT, 'myPrivateKey.pem'
    EXEC sp_OAGetProperty @key, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 <> 1
      BEGIN
        EXEC sp_OAGetProperty @key, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        EXEC @hr = sp_OADestroy @key
        RETURN
      END

    -- Load a private key from a PEM string:
    -- (Private keys may be loaded from OpenSSH and Putty formats.
    -- Both encrypted and unencrypted private key file formats
    -- are supported.  This example loads an unencrypted private
    -- key in OpenSSH format.  PuTTY keys typically use the .ppk
    -- file extension, while OpenSSH keys use the PEM format.
    -- (For PuTTY keys, call FromPuttyPrivateKey instead.)
    EXEC sp_OAMethod @key, 'FromOpenSshPrivateKey', @success OUT, @privKey
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @key, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        EXEC @hr = sp_OADestroy @key
        RETURN
      END

    -- Authenticate with the SSH server using the login and
    -- private key.  (The corresponding public key should've 
    -- been installed on the SSH server beforehand.)
    EXEC sp_OAMethod @ssh, 'AuthenticatePk', @success OUT, 'myLogin', @key
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @ssh, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        EXEC @hr = sp_OADestroy @key
        RETURN
      END
    EXEC sp_OAGetProperty @ssh, 'LastErrorText', @sTmp0 OUT
    PRINT @sTmp0

    PRINT 'Public-Key Authentication Successful!'

    EXEC @hr = sp_OADestroy @ssh
    EXEC @hr = sp_OADestroy @key


END
GO