SFTP Authenticate with a SecureString Password and Private Key

See more SFTP Examples

Demonstrates the Chilkat SFtp.AuthenticateSecPwPk method, which authenticates using SecureString login and password objects together with a private key. The third argument is the SshKey private key.

Note: The private-key path is relative to the application's current working directory. Supply the path to your own key file.

-- 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 SFtp.AuthenticateSecPwPk method, which authenticates using SecureString login
    --  and password objects together with a private key.  The 1st argument is the username, the 2nd
    --  is the password, and the 3rd is an SshKey private key.

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

    --  Step 1: Connect the SSH transport.  Port 22 is the usual port.
    DECLARE @port int
    SELECT @port = 22
    EXEC sp_OAMethod @sftp, 'Connect', @success OUT, 'sftp.example.com', @port
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sftp
        RETURN
      END

    --  Normally you would not hard-code the password in source.  You should instead obtain it
    --  from an interactive prompt, environment variable, or a secrets vault.
    DECLARE @password nvarchar(4000)
    SELECT @password = 'mySshPassword'

    --  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 @sftp
        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 @sftp
        EXEC @hr = sp_OADestroy @privKey
        RETURN
      END

    --  Place the login and password into SecureString objects.
    DECLARE @secureLogin int
    EXEC @hr = sp_OACreate 'Chilkat.SecureString', @secureLogin OUT

    EXEC sp_OAMethod @secureLogin, 'Append', @success OUT, 'mySshLogin'
    DECLARE @securePassword int
    EXEC @hr = sp_OACreate 'Chilkat.SecureString', @securePassword OUT

    EXEC sp_OAMethod @securePassword, 'Append', @success OUT, @password

    EXEC sp_OAMethod @sftp, 'AuthenticateSecPwPk', @success OUT, @secureLogin, @securePassword, @privKey
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sftp
        EXEC @hr = sp_OADestroy @privKey
        EXEC @hr = sp_OADestroy @secureLogin
        EXEC @hr = sp_OADestroy @securePassword
        RETURN
      END

    --  Step 3: Open the SFTP subsystem.  This must be done after authentication and before any
    --  file or directory operations.
    EXEC sp_OAMethod @sftp, 'InitializeSftp', @success OUT
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sftp
        EXEC @hr = sp_OADestroy @privKey
        EXEC @hr = sp_OADestroy @secureLogin
        EXEC @hr = sp_OADestroy @securePassword
        RETURN
      END


    PRINT 'Authenticated.'

    EXEC sp_OAMethod @sftp, 'Disconnect', NULL

    EXEC @hr = sp_OADestroy @sftp
    EXEC @hr = sp_OADestroy @privKey
    EXEC @hr = sp_OADestroy @secureLogin
    EXEC @hr = sp_OADestroy @securePassword


END
GO