SQL Server

IMAP over Multiple Hop SSH

Demonstrates how to read IMAP email (using TCP or TLS) tunneled through mulitple-hop SSH. The scheme looks like this:

Application => ServerSSH1 => ServerSSH2 => IMAPServer

The ConnectThroughSsh and UseSsh methods are added in Chilkat version 9.5.0.55 to accomplish this task.

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 assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

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

    -- Connect directly to the 1st SSH server.
    EXEC sp_OAMethod @ssh1, 'Connect', @success OUT, 'serverssh1.com', 22
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @ssh1, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh1
        RETURN
      END

    -- Authenticate using login/password:
    EXEC sp_OAMethod @ssh1, 'AuthenticatePw', @success OUT, 'ssh1Login', 'ssh1Password'
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @ssh1, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh1
        RETURN
      END

    -- Connect through the 1st SSH connection to reach a 2nd SSH server.
    -- Note: Any number of SSH connections may be simultaneously tunneled through a single
    -- existing SSH connection.
    DECLARE @ssh2 int
    EXEC @hr = sp_OACreate 'Chilkat.Ssh', @ssh2 OUT

    EXEC sp_OAMethod @ssh2, 'ConnectThroughSsh', @success OUT, @ssh1, 'serverssh2.com', 22
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @ssh2, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh1
        EXEC @hr = sp_OADestroy @ssh2
        RETURN
      END

    -- Authenticate with ssh2...
    EXEC sp_OAMethod @ssh2, 'AuthenticatePw', @success OUT, 'ssh2Login', 'ssh2Password'
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @ssh2, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh1
        EXEC @hr = sp_OADestroy @ssh2
        RETURN
      END

    DECLARE @imap int
    EXEC @hr = sp_OACreate 'Chilkat.Imap', @imap OUT

    -- Tell the IMAP object to connect to the IMAP server though the ssh2 tunnel (which itself is routed through ssh1).
    -- The connection looks like this:  Application => ServerSSH1 => ServerSSH2 => IMAPServer
    EXEC sp_OAMethod @imap, 'UseSsh', @success OUT, @ssh2
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @imap, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh1
        EXEC @hr = sp_OADestroy @ssh2
        EXEC @hr = sp_OADestroy @imap
        RETURN
      END

    EXEC sp_OASetProperty @imap, 'Ssl', 1
    EXEC sp_OASetProperty @imap, 'Port', 993

    -- Connect to an IMAP server (through the multi-hop SSH tunnel)
    EXEC sp_OAMethod @imap, 'Connect', @success OUT, 'imap.someimapserver.com'
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @imap, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh1
        EXEC @hr = sp_OADestroy @ssh2
        EXEC @hr = sp_OADestroy @imap
        RETURN
      END

    -- Login
    EXEC sp_OAMethod @imap, 'Login', @success OUT, 'myLogin', 'myPassword'
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @imap, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh1
        EXEC @hr = sp_OADestroy @ssh2
        EXEC @hr = sp_OADestroy @imap
        RETURN
      END

    -- Do whatever needs to be done...  for example,

    -- Create the new email folder (sub-mailbox) on the IMAP server.
    -- If no folder path is provided, the new folder is a sub-mailbox of Inbox.
    EXEC sp_OAMethod @imap, 'CreateMailbox', @success OUT, 'newFolder'
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @imap, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh1
        EXEC @hr = sp_OADestroy @ssh2
        EXEC @hr = sp_OADestroy @imap
        RETURN
      END


    PRINT 'Success.'

    -- Close the connection with the IMAP server.  (This closes the tunnel through ssh2)
    -- The connection with ssh2 is still alive, and may be used for more connections.
    EXEC sp_OAMethod @imap, 'Disconnect', @success OUT

    -- Close the connection with ssh2.  (This closes the the tunnel through ssh1.)
    -- The connection with ssh1 is still alive, and may be used for more connections.
    EXEC sp_OAMethod @ssh2, 'Disconnect', NULL

    EXEC sp_OAMethod @ssh1, 'Disconnect', NULL

    EXEC @hr = sp_OADestroy @ssh1
    EXEC @hr = sp_OADestroy @ssh2
    EXEC @hr = sp_OADestroy @imap


END
GO