Close an SSH Tunnel

See more Socket/SSL/TLS Examples

Demonstrates Socket.SshCloseTunnel, which closes the SSH tunnel opened by SshOpenTunnel and terminates its forwarded channels.

IncludeFile "CkSocket.pb"

Procedure ChilkatExample()

    success.i = 0

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

    ;  Connect to the SSH server and initialize an SSH tunneling session.  Port 22 is conventional but
    ;  not required.
    success = CkSocket::ckSshOpenTunnel(socket,"ssh.example.com",22)
    If success = 0
        Debug CkSocket::ckLastErrorText(socket)
        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

    ;  Authenticate the SSH session before opening forwarded channels.
    ;  The SSH password should come from a secure source rather than being hard-coded.
    sshPassword.s = "mySshPassword"
    success = CkSocket::ckSshAuthenticatePw(socket,"sshUser",sshPassword)
    If success = 0
        Debug CkSocket::ckLastErrorText(socket)
        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

    ;  Close the SSH tunnel and terminate its forwarded channels.  This does not affect unrelated SSH
    ;  objects or connections.
    success = CkSocket::ckSshCloseTunnel(socket)
    If success = 0
        Debug CkSocket::ckLastErrorText(socket)
        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

    Debug "SSH tunnel closed."


    CkSocket::ckDispose(socket)


    ProcedureReturn
EndProcedure