SQL Server

REST through SSH Tunnel

See more REST Examples

Demonstrates how to connect through an SSH Tunnel (via port-forwarding) to make REST API calls. 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
    DECLARE @iTmp0 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 @tunnel int
    EXEC @hr = sp_OACreate 'Chilkat.Socket', @tunnel OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @sshHostname nvarchar(4000)
    SELECT @sshHostname = 'sftp.example.com'
    DECLARE @sshPort int
    SELECT @sshPort = 22

    -- Connect to an SSH server and establish the SSH tunnel:
    EXEC sp_OAMethod @tunnel, 'SshOpenTunnel', @success OUT, @sshHostname, @sshPort
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @tunnel, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @tunnel
        RETURN
      END

    -- Authenticate with the SSH server via a login/password
    -- or with a public key.
    -- This example demonstrates SSH password authentication.
    EXEC sp_OAMethod @tunnel, 'SshAuthenticatePw', @success OUT, 'mySshLogin', 'mySshPassword'
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @tunnel, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @tunnel
        RETURN
      END

    --  OK, the SSH tunnel is setup.  Now open a channel within the tunnel.
    --  (Any number of channels may be created from the same SSH tunnel.
    --  Multiple channels may coexist at the same time.)

    -- This example connects to a REST server through the SSH tunnel.
    -- It will connect to the Amazon AWS service for this example.
    DECLARE @rest int
    EXEC @hr = sp_OACreate 'Chilkat.Rest', @rest OUT

    DECLARE @bTls int
    SELECT @bTls = 1
    DECLARE @port int
    SELECT @port = 443
    DECLARE @maxWaitMs int
    SELECT @maxWaitMs = 5000

    -- This returns a socket object that is a single channel within the SSH tunnel.
    DECLARE @channel int
    EXEC @hr = sp_OACreate 'Chilkat.Socket', @channel OUT

    EXEC sp_OAMethod @tunnel, 'SshNewChannel', @success OUT, 's3.amazonaws.com', @port, @bTls, @maxWaitMs, @channel
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @tunnel, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @tunnel
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @channel
        RETURN
      END

    -- Use the connection.  (This connection is a TLS running on an SSH channel through an SSH tunnel.
    -- In other words, TLS is wrapped within the SSH tunnel.)
    EXEC sp_OAMethod @rest, 'UseConnection', @success OUT, @channel, 1
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @tunnel
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @channel
        RETURN
      END

    -- Provide AWS credentials for the REST call.
    DECLARE @authAws int
    EXEC @hr = sp_OACreate 'Chilkat.AuthAws', @authAws OUT

    EXEC sp_OASetProperty @authAws, 'AccessKey', 'AWS_ACCESS_KEY'
    EXEC sp_OASetProperty @authAws, 'SecretKey', 'AWS_SECRET_KEY'
    EXEC sp_OASetProperty @authAws, 'ServiceName', 's3'
    EXEC sp_OAMethod @rest, 'SetAuthAws', @success OUT, @authAws

    -- List all buckets for the account...
    DECLARE @responseXml nvarchar(4000)
    EXEC sp_OAMethod @rest, 'FullRequestNoBody', @responseXml OUT, 'GET', '/'
    EXEC sp_OAGetProperty @rest, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 <> 1
      BEGIN
        EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @tunnel
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @channel
        EXEC @hr = sp_OADestroy @authAws
        RETURN
      END

    DECLARE @xml int
    EXEC @hr = sp_OACreate 'Chilkat.Xml', @xml OUT

    EXEC sp_OAMethod @xml, 'LoadXml', @success OUT, @responseXml

    -- Show the full XML returned.
    EXEC sp_OAMethod @xml, 'GetXml', @sTmp0 OUT
    PRINT @sTmp0

    -- Iterate over the buckets, showing each bucket name.
    EXEC sp_OAMethod @xml, 'FindChild2', @success OUT, 'Buckets'
    EXEC sp_OAMethod @xml, 'FirstChild2', @iTmp0 OUT
    IF @iTmp0 = 1
      BEGIN
        EXEC sp_OAMethod @xml, 'GetChildContent', @sTmp0 OUT, 'Name'
        PRINT @sTmp0
        EXEC sp_OAMethod @xml, 'NextSibling2', @iTmp0 OUT
        WHILE (@iTmp0 = 1)
          BEGIN
            EXEC sp_OAMethod @xml, 'GetChildContent', @sTmp0 OUT, 'Name'
            PRINT @sTmp0
          END
      END
    -- Move the internal pointer back to the root node.
    EXEC sp_OAMethod @xml, 'GetRoot2', NULL

    EXEC @hr = sp_OADestroy @tunnel
    EXEC @hr = sp_OADestroy @rest
    EXEC @hr = sp_OADestroy @channel
    EXEC @hr = sp_OADestroy @authAws
    EXEC @hr = sp_OADestroy @xml


END
GO