(SQL Server) SFTP Public-Key Authentication (id_ed25519)

See more SFTP Examples

Demonstrates how to authenticate with an SSH/SFTP server using publickey authentication with an Ed25519 private key (id_ed25519).

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
    DECLARE @iTmp0 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 @key int
    -- Use "Chilkat_9_5_0.SshKey" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.SshKey', @key OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- The id_ed25519 file should contain something like this:
    -- (You can open it in a text editor..)

    -- -----BEGIN OPENSSH PRIVATE KEY-----
    -- b3BlbnNzaC1rZXktdjEAAAAACmFlczI1Ni1jdHIAAAAGYmNyeXB0AAAAGAAAABDIeK9+Xw
    -- 6Do9gnhtrJu5iJAAAAZAAAAAEAAAAzAAAAC3NzaC1lZDI1NTE5AAAAIMh/Ge7fjQCssmVd
    -- BqjYZbRAI0pY8IrnB6J1yLetq34OAAAAoMVP7cvy4hTiAINA3I4v55OonkpKza8mzfUW18
    -- RDQeYL3ovCVaAYOGcCpf/SW3QiY6tnXq+5WDEfJ7Z/kQ0nl2+1wSLOytxpyO+IY0rRtLrX
    -- 6e/agR4nbZpt/MFG6xqcNASbtDgg+9IWGvDrtXOLFofx07/zml+UjFL0tXRpCjOxeqKyXH
    -- t8SRgdT97d9/bYPwapaXY+b2DVVy5/LVx4Sq8=
    -- -----END OPENSSH PRIVATE KEY-----

    DECLARE @privKeyText nvarchar(4000)
    EXEC sp_OAMethod @key, 'LoadText', @privKeyText OUT, 'c:/temp/id_ed25519'
    EXEC sp_OAGetProperty @key, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 <> 1
      BEGIN
        EXEC sp_OAGetProperty @key, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @key
        RETURN
      END

    -- If your private key was saved encrypted, then you'll need the password.
    -- In this example, the password "blahblah" is valid for the above key -- which is a real Ed25519 key generated/saved from puttygen.
    EXEC sp_OASetProperty @key, 'Password', 'blahblah'

    DECLARE @success int
    EXEC sp_OAMethod @key, 'FromOpenSshPrivateKey', @success OUT, @privKeyText
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @key, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @key
        RETURN
      END

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

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

    DECLARE @hostname nvarchar(4000)
    SELECT @hostname = 'sftp.example.com'
    DECLARE @port int
    SELECT @port = 22
    DECLARE @success int
    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 @key
        EXEC @hr = sp_OADestroy @sftp
        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
        EXEC @hr = sp_OADestroy @key
        EXEC @hr = sp_OADestroy @sftp
        RETURN
      END
    EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
    PRINT @sTmp0

    PRINT 'Public-Key Authentication Successful!'

    -- Now go do whatever you're app needs to do...

    EXEC @hr = sp_OADestroy @key
    EXEC @hr = sp_OADestroy @sftp


END
GO