SQL Server

Open a direct-tcpip Channel (SSH Port Forwarding)

Demonstrates the Chilkat Ssh.OpenDirectTcpIpChannel method, which opens a direct-tcpip channel through the SSH server to a target host and port. The first argument is the target hostname and the second is the target port. It returns the channel number, or -1 on failure.

Background: This is SSH local port forwarding at the API level: the channel carries ordinary TCP traffic to a service that may be reachable only from the SSH server's network — a database, an internal web app, a message broker. The key detail is that the server resolves the target name, not your machine, so it must resolve and be reachable there. Supplying a numeric IPv4 address avoids remote DNS resolution entirely.

Chilkat SQL Server Downloads

Download Chilkat for SQL Server

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

    --  Demonstrates the Ssh.OpenDirectTcpIpChannel method, which opens a direct-tcpip channel
    --  through the SSH server to a target host and port.  The 1st argument is the target hostname
    --  and the 2nd is the target port.  It returns the channel number, or -1 on failure.

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

    DECLARE @sshPort int
    SELECT @sshPort = 22
    EXEC sp_OAMethod @ssh, 'Connect', @success OUT, 'ssh.example.com', @sshPort
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @ssh, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        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'

    EXEC sp_OAMethod @ssh, 'AuthenticatePw', @success OUT, 'mySshLogin', @password
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @ssh, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        RETURN
      END

    --  The target name is resolved by the SSH server, not by this computer, so it must be
    --  reachable from the server's network.
    DECLARE @targetHostname nvarchar(4000)
    SELECT @targetHostname = 'db.internal.example.com'
    DECLARE @targetPort int
    SELECT @targetPort = 5432
    DECLARE @channelNum int
    EXEC sp_OAMethod @ssh, 'OpenDirectTcpIpChannel', @channelNum OUT, @targetHostname, @targetPort
    IF @channelNum < 0
      BEGIN
        EXEC sp_OAGetProperty @ssh, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        RETURN
      END


    PRINT 'Opened direct-tcpip channel: ' + @channelNum

    --  The channel now carries ordinary TCP data to the target, tunneled over SSH.

    EXEC sp_OAMethod @ssh, 'Disconnect', NULL

    EXEC @hr = sp_OADestroy @ssh


END
GO