(PureBasic) SSH Tunnel for Database Connection (such as ADO, ODBC, JDBC, etc.)

Demonstrates how to create an SSH tunneling client in a background thread of your application. This makes it possible to SSH tunnel database connections without the need for separate software (such as PuTTY) to be running.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkSshTunnel.pb"
IncludeFile "CkGlobal.pb"

Procedure ChilkatExample()

    chilkatGlob.i = CkGlobal::ckCreate()
    If chilkatGlob.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i = CkGlobal::ckUnlockBundle(chilkatGlob,"Anything for 30-day trial.")
    If success <> 1
        Debug CkGlobal::ckLastErrorText(chilkatGlob)
        CkGlobal::ckDispose(chilkatGlob)
        ProcedureReturn
    EndIf

    tunnel.i = CkSshTunnel::ckCreate()
    If tunnel.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    sshHostname.s = "www.my-ssh-server.com"
    sshPort.i = 22

    ;  Connect to an SSH server and establish the SSH tunnel:
    success = CkSshTunnel::ckConnect(tunnel,sshHostname,sshPort)
    If success <> 1
        Debug CkSshTunnel::ckLastErrorText(tunnel)
        CkGlobal::ckDispose(chilkatGlob)
        CkSshTunnel::ckDispose(tunnel)
        ProcedureReturn
    EndIf

    ;  Authenticate with the SSH server via a login/password
    ;  or with a public key.
    ;  This example demonstrates SSH password authentication.
    success = CkSshTunnel::ckAuthenticatePw(tunnel,"mySshLogin","mySshPassword")
    If success <> 1
        Debug CkSshTunnel::ckLastErrorText(tunnel)
        CkGlobal::ckDispose(chilkatGlob)
        CkSshTunnel::ckDispose(tunnel)
        ProcedureReturn
    EndIf

    ;  The destination host/port is the database server.
    ;  The DestHostname may be the domain name or
    ;  IP address (in dotted decimal notation) of the database
    ;  server.
    CkSshTunnel::setCkDestPort(tunnel, 1433)
    CkSshTunnel::setCkDestHostname(tunnel, "myDbServer.com")

    ;  Start accepting connections in a background thread.
    ;  The SSH tunnels are autonomously run in a background
    ;  thread.  There is one background thread for accepting
    ;  connections, and another for managing the tunnel pool.
    listenPort.i = 3316
    success = CkSshTunnel::ckBeginAccepting(tunnel,listenPort)
    If success <> 1
        Debug CkSshTunnel::ckLastErrorText(tunnel)
        CkGlobal::ckDispose(chilkatGlob)
        CkSshTunnel::ckDispose(tunnel)
        ProcedureReturn
    EndIf

    ;  At this point the app may connect to the database server through
    ;  the SSH tunnel.  The database connection string would
    ;  use "localhost" for the hostname and 3316 for the port.
    ;  We're not going to show the database coding here,
    ;  because it can vary depending on the API you're using
    ;  (ADO, ODBC, OLE DB, etc. )

    ;  This is where the application's database code would go...

    ;  Stop the background listen/accept thread:
    waitForThreadExit.i = 1
    success = CkSshTunnel::ckStopAccepting(tunnel,waitForThreadExit)
    If success <> 1
        Debug CkSshTunnel::ckLastErrorText(tunnel)
        CkGlobal::ckDispose(chilkatGlob)
        CkSshTunnel::ckDispose(tunnel)
        ProcedureReturn
    EndIf

    ;  Close the SSH tunnel (would also kick any remaining connected clients).
    success = CkSshTunnel::ckCloseTunnel(tunnel,waitForThreadExit)
    If success <> 1
        Debug CkSshTunnel::ckLastErrorText(tunnel)
        CkGlobal::ckDispose(chilkatGlob)
        CkSshTunnel::ckDispose(tunnel)
        ProcedureReturn
    EndIf



    CkGlobal::ckDispose(chilkatGlob)
    CkSshTunnel::ckDispose(tunnel)


    ProcedureReturn
EndProcedure