SFTP Public-Key Authentication

Demonstrates how to authenticate with an SSH server using publickey authentication.

Download Chilkat 32-bit SSH / SFTP ActiveX (.msi)

Download All 32-bit Chilkat ActiveX Components (.zip)

Download All 64-bit Chilkat ActiveX Components (.zip)

CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @sTmp0 nvarchar(4000)
    --  Important: It is helpful to send the contents of the
    --  sftp.LastErrorText property when requesting support.

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

    --  Any string automatically begins a fully-functional 30-day trial.
    DECLARE @success int

    EXEC sp_OAMethod @sftp, 'UnlockComponent', @success OUT, 'Anything for 30-day trial'
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END

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

    --  Connect to the SSH server.
    --  The standard SSH port = 22
    --  The hostname may be a hostname or IP address.
    DECLARE @port int

    DECLARE @hostname nvarchar(4000)

    SELECT @hostname = 'www.my-ssh-server.com'
    SELECT @port = 22
    EXEC sp_OAMethod @sftp, 'Connect', @success OUT, @hostname, @port
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END

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

    --  Load a private key from a PEM file:
    --  (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.
    DECLARE @privKey nvarchar(4000)

    EXEC sp_OAMethod @key, 'LoadText', @privKey OUT, 'myPrivateKey.pem'
    IF @privKey Is NULL 
      BEGIN
        EXEC sp_OAGetProperty @key, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END

    EXEC sp_OAMethod @key, 'FromOpenSshPrivateKey', @success OUT, @privKey
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @key, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END

    --  Authenticate with the SSH server.  Chilkat SFTP supports
    --  both password-based authenication as well as public-key
    --  authentication.
    EXEC sp_OAMethod @sftp, 'AuthenticatePk', @success OUT, 'myLogin', @key
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END
    EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
    PRINT @sTmp0
    PRINT 'Public-Key Authentication Successful!'
END
GO