(SQL Server) SFTP Authentication using an SSH Certificate

See more SFTP Examples

Note: This example requires Chilkat v11.0.0 or greater.

For more information, see https://www.chilkatsoft.com/understanding_ssh_certificates.asp

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @sbSshCert int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbSshCert OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int
    EXEC sp_OAMethod @sbSshCert, 'LoadFile', @success OUT, 'qa_data/sshCert/user_ecdsa_key-cert.pub', 'utf-8'
    IF @success = 0
      BEGIN

        PRINT 'Failed to load user_ecdsa_key-cert.pub'
        EXEC @hr = sp_OADestroy @sbSshCert
        RETURN
      END

    DECLARE @sbPrivKey int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbPrivKey OUT

    EXEC sp_OAMethod @sbPrivKey, 'LoadFile', @success OUT, 'qa_data/sshKeys/user_ecdsa_key', 'utf-8'
    IF @success = 0
      BEGIN

        PRINT 'Failed to load user_ecdsa_key'
        EXEC @hr = sp_OADestroy @sbSshCert
        EXEC @hr = sp_OADestroy @sbPrivKey
        RETURN
      END

    DECLARE @key int
    -- Use "Chilkat_9_5_0.SshKey" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.SshKey', @key OUT

    -- Provide the password if the user_ecdsa_key is stored in an encrypted format.
    EXEC sp_OASetProperty @key, 'Password', 'secret'
    EXEC sp_OAMethod @sbPrivKey, 'GetAsString', @sTmp0 OUT
    EXEC sp_OAMethod @key, 'FromOpenSshPrivateKey', @success OUT, @sTmp0
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @key, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sbSshCert
        EXEC @hr = sp_OADestroy @sbPrivKey
        EXEC @hr = sp_OADestroy @key
        RETURN
      END

    -- Indicate that the SSH certificate is to be used for authentication.
    -- The UseSshCertificate method was added in Chilkat v11.0.0
    EXEC sp_OAMethod @sbSshCert, 'GetAsString', @sTmp0 OUT
    EXEC sp_OAMethod @key, 'UseSshCertificate', @success OUT, @sTmp0

    DECLARE @sftp int
    -- Use "Chilkat_9_5_0.SFtp" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.SFtp', @sftp OUT

    DECLARE @hostname nvarchar(4000)
    SELECT @hostname = 'sftp.example.com'
    DECLARE @port int
    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
        EXEC @hr = sp_OADestroy @sbSshCert
        EXEC @hr = sp_OADestroy @sbPrivKey
        EXEC @hr = sp_OADestroy @key
        EXEC @hr = sp_OADestroy @sftp
        RETURN
      END

    EXEC sp_OAMethod @sftp, 'AuthenticatePk', @success OUT, 'myLogin', @key
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sbSshCert
        EXEC @hr = sp_OADestroy @sbPrivKey
        EXEC @hr = sp_OADestroy @key
        EXEC @hr = sp_OADestroy @sftp
        RETURN
      END


    PRINT 'Public-Key Authentication using an SSH Certificate was Successful!'

    EXEC @hr = sp_OADestroy @sbSshCert
    EXEC @hr = sp_OADestroy @sbPrivKey
    EXEC @hr = sp_OADestroy @key
    EXEC @hr = sp_OADestroy @sftp


END
GO