SQL Server

Secure FTP with Client Certificate

See more FTP Examples

Chilkat FTP2 provides the ability to use a client certificate with secure FTP (implicit or explicit SSL/TLS). This example demonstrates how to load a certificate from a .pfx and use it as the client-side SSL cert. Note: Client-side certificates are only needed in situations where the server demands one. SQL Server

-- 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)
    DECLARE @success int
    SELECT @success = 0

    -- This example requires the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

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

    EXEC sp_OASetProperty @ftp, 'Hostname', 'ftp.example.com'
    EXEC sp_OASetProperty @ftp, 'Port', 21
    EXEC sp_OASetProperty @ftp, 'Username', 'test'
    EXEC sp_OASetProperty @ftp, 'Password', 'test'

    -- This example will use explict TLS/SSL.
    -- Establish an explicit secure channel after connection
    -- on the standard FTP port 21.
    EXEC sp_OASetProperty @ftp, 'AuthTls', 1

    -- The Ssl property is for establishing an implicit SSL connection
    -- on port 990.  Because this example uses explicit SSL, it 
    -- should remain 0.
    EXEC sp_OASetProperty @ftp, 'Ssl', 0

    -- Load a certificate from a .pfx
    -- A PFX may contain several certs, including the certificates
    -- in a chain of authority.
    DECLARE @certStore int
    EXEC @hr = sp_OACreate 'Chilkat.CertStore', @certStore OUT

    DECLARE @password nvarchar(4000)

    SELECT @password = '***'
    -- Load the certs from a PFX into an in-memory certificate store:
    EXEC sp_OAMethod @certStore, 'LoadPfxFile', @success OUT, 'chilkat.pfx', @password
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @certStore, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ftp
        EXEC @hr = sp_OADestroy @certStore
        RETURN
      END

    -- Find the desired certificate.
    DECLARE @jsonCN int
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jsonCN OUT

    EXEC sp_OAMethod @jsonCN, 'UpdateString', @success OUT, 'CN', 'cert common name'

    DECLARE @cert int
    EXEC @hr = sp_OACreate 'Chilkat.Cert', @cert OUT

    EXEC sp_OAMethod @certStore, 'FindCert', @success OUT, @jsonCN, @cert
    IF @success = 0
      BEGIN

        PRINT 'Certificate not found!'
        EXEC @hr = sp_OADestroy @ftp
        EXEC @hr = sp_OADestroy @certStore
        EXEC @hr = sp_OADestroy @jsonCN
        EXEC @hr = sp_OADestroy @cert
        RETURN
      END

    -- Use this certificate for our secure (SSL/TLS) connection:
    EXEC sp_OAMethod @ftp, 'SetSslClientCert', @success OUT, @cert

    -- Connect and login to the FTP server.  The connection is 
    -- made secure because of the AuthTls setting.
    EXEC sp_OAMethod @ftp, 'Connect', @success OUT
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @ftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ftp
        EXEC @hr = sp_OADestroy @certStore
        EXEC @hr = sp_OADestroy @jsonCN
        EXEC @hr = sp_OADestroy @cert
        RETURN
      END
    ELSE
      BEGIN
        -- LastErrorText contains information even when
        -- successful. This allows you to visually verify
        -- that the secure connection actually occurred.
        EXEC sp_OAGetProperty @ftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
      END


    PRINT 'Secure FTP Channel Established!'

    -- Do whatever you're doing to do ...
    -- upload files, download files, etc...

    -- .....
    -- .....

    EXEC sp_OAMethod @ftp, 'Disconnect', @success OUT

    EXEC @hr = sp_OADestroy @ftp
    EXEC @hr = sp_OADestroy @certStore
    EXEC @hr = sp_OADestroy @jsonCN
    EXEC @hr = sp_OADestroy @cert


END
GO