(SQL Server) SFTP use Cert's Private Key for Authentication (Windows)

Demonstrates how to use the private key of a pre-installed certificate (on Windows) for SFTP authentication. The certificate's private key must be marked as "exportable" when originally installed.

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
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

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

    -- Load the certificate from the Windows certificate store
    DECLARE @success int
    EXEC sp_OAMethod @cert, 'LoadByCommonName', @success OUT, 'my_cert_common_name'
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @cert, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @cert
        RETURN
      END

    -- Get the private key.  
    DECLARE @privKey int
    EXEC sp_OAMethod @cert, 'ExportPrivateKey', @privKey OUT
    EXEC sp_OAGetProperty @cert, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @cert, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @cert
        RETURN
      END

    DECLARE @privKeyPem nvarchar(4000)
    EXEC sp_OAMethod @privKey, 'GetPkcs8Pem', @privKeyPem OUT
    EXEC sp_OAGetProperty @privKey, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @privKey, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @cert
        RETURN
      END

    DECLARE @sshKey int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.SshKey', @sshKey OUT

    EXEC sp_OAMethod @sshKey, 'FromOpenSshPrivateKey', @success OUT, @privKeyPem
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @sshKey, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @cert
        EXEC @hr = sp_OADestroy @sshKey
        RETURN
      END

    -- Connect to an SSH/SFTP server
    DECLARE @sftp int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.SFtp', @sftp OUT

    EXEC sp_OAMethod @sftp, 'Connect', @success OUT, 'sftp.example.com', 22
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @cert
        EXEC @hr = sp_OADestroy @sshKey
        EXEC @hr = sp_OADestroy @sftp
        RETURN
      END

    -- Authenticate with the SSH server using a username + private key.
    -- (The private key serves as the password.  The username identifies
    -- the SSH user account on the server.)
    EXEC sp_OAMethod @sftp, 'AuthenticatePk', @success OUT, 'mySshLogin', @sshKey
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @cert
        EXEC @hr = sp_OADestroy @sshKey
        EXEC @hr = sp_OADestroy @sftp
        RETURN
      END


    PRINT 'OK, the connection and authentication with the SSH server is completed.'

    -- This example is only to show the connection + authentication using a private key associated with a certificate in the Windows certificate store...

    EXEC @hr = sp_OADestroy @cert
    EXEC @hr = sp_OADestroy @sshKey
    EXEC @hr = sp_OADestroy @sftp


END
GO