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.

LOCAL lnSuccess
LOCAL loSocket
LOCAL lcSshPassword

lnSuccess = 0

loSocket = CreateObject('Chilkat.Socket')

*  Connect to the SSH server and initialize an SSH tunneling session.  Port 22 is conventional but
*  not required.
lnSuccess = loSocket.SshOpenTunnel("ssh.example.com",22)
IF (lnSuccess = 0) THEN
    ? loSocket.LastErrorText
    RELEASE loSocket
    CANCEL
ENDIF

*  Authenticate the SSH session before opening forwarded channels.
*  The SSH password should come from a secure source rather than being hard-coded.
lcSshPassword = "mySshPassword"
lnSuccess = loSocket.SshAuthenticatePw("sshUser",lcSshPassword)
IF (lnSuccess = 0) THEN
    ? loSocket.LastErrorText
    RELEASE loSocket
    CANCEL
ENDIF

*  Close the SSH tunnel and terminate its forwarded channels.  This does not affect unrelated SSH
*  objects or connections.
lnSuccess = loSocket.SshCloseTunnel()
IF (lnSuccess = 0) THEN
    ? loSocket.LastErrorText
    RELEASE loSocket
    CANCEL
ENDIF

? "SSH tunnel closed."

RELEASE loSocket