Author: Pahaz Blinov

Repo: https://github.com/pahaz/sshtunnel/

Inspired by https://github.com/jmagnusson/bgtunnel but it doesn't work on Windows.
See also: https://github.com/paramiko/paramiko/blob/master/demos/forward.py

Require paramiko.

Install

pip install sshtunnel

or

easy_install sshtunnel

SSH tunnels to remote server

Useful when you need to connect to local port on remote server through ssh tunnel. It works by opening a port forwarding ssh connection in the background, using threads. The connection(s) are closed when explicitly calling the close method of the returned SSHTunnelForwarder object.

----------------------------------------------------------------------

                            |
-------------+              |    +----------+               +---------
    LOCAL    |              |    |  REMOTE  |               | PRIVATE
    SERVER   | <== SSH ========> |  SERVER  | <== local ==> | SERVER
-------------+              |    +----------+               +---------
                            |
                         FIREWALL

----------------------------------------------------------------------

Fig1: How to connect to PRIVATE SERVER throw SSH tunnel.

Ex 1:

from sshtunnel import SSHTunnelForwarder

server = SSHTunnelForwarder(
    ('pahaz.urfuclub.ru', 22),
    ssh_username="pahaz",
    ssh_password="secret",
    remote_bind_address=('127.0.0.1', 5555))

server.start()

print(server.local_bind_port)
# work with `SECRET SERVICE` throw `server.local_bind_port`.

server.stop()

Ex 2:

Example of a port forwarding for the Vagrant MySQL local port:

from sshtunnel import SSHTunnelForwarder
from time import sleep

with SSHTunnelForwarder(
    ('localhost', 2222),
    ssh_username="vagrant",
    ssh_password="vagrant",
    remote_bind_address=('127.0.0.1', 3306)) as server:

    print(server.local_bind_port)
    while True:
        # press Ctrl-C for stopping
        sleep(1)

print('FINISH!')

Or simple use CLI:

python -m sshtunnel -U vagrant -P vagrant -L :3306 -R 127.0.0.1:3306 -p 2222 localhost

API/arguments

SSHTunnelForwarder arguments

This is an incomplete list of arguments. See __init__() method of SSHTunnelForwarder class in sshtunnel.py for a full list.

ssh_proxy = None

Accepts a paramiko.ProxyCommand object which all SSH traffic will be passed through. See either the paramiko.ProxyCommand documentation or ProxyCommand in ssh_config(5) for more information.

Note ssh_proxy overrides any ProxyCommand sourced from the user's ssh_config.

Note ssh_proxy is ignored if ssh_proxy_enabled != True.

ssh_proxy_enabled = True

If true (default) and the user's ssh_config file contains a ProxyCommand directive that matches the specified ssh_address_or_host (or first positional argument) SSHTunnelForwarder will create a paramiko.ProxyCommand object which all SSH traffic will be passed through. See the ssh_proxy argument for more details.

CONTRIBUTORS

• Cameron Maske
• Gustavo Machado
• Colin Jermain
• J.M. Fernández - (big thanks!)
• Lewis Thompson
• Erik Rogers

TODO

• Write tests!

CHANGELOG

work in progress

• add ssh_proxy argument, as well as ssh_config(5) ProxyCommand support (lewisthompson)

v.0.0.4.4

• fix issuse #24 - hide ssh password in logs (pahaz)

v.0.0.4.3

• fix default port issuse #19 (pahaz)

v.0.0.4.2

• fix Thread.daemon mode for Python < 3.3 #16, #21 (lewisthompson, ewrogers)

v.0.0.4.1

• fix CLI issues/13 (pahaz)

v.0.0.4

• daemon mode by default for all threads (fernandezcuesta, pahaz) - incompatible
• move make_ssh_forward_server to SSHTunnelForwarder.make_ssh_forward_server (pahaz, fernandezcuesta) - incompatible
• move make_ssh_forward_handler to SSHTunnelForwarder.make_ssh_forward_handler_class (pahaz, fernandezcuesta) - incompatible
• rename open to open_tunnel (fernandezcuesta) - incompatible
• add CLI interface (fernandezcuesta)
• support opening several tunnels at once (fernandezcuesta)
• improve stability and readability (fernandezcuesta, pahaz)
• improve logging (fernandezcuesta, pahaz)
• add raise_exception_if_any_forwarder_have_a_problem argument for opening several tunnels at once (pahaz)
• add ssh_config_file argument support (fernandezcuesta)
• add Python 3 support (fernandezcuesta, pahaz)

v.0.0.3

• add threaded options (cameronmaske)
• fix exception error message, correctly printing destination address (gdmachado)
• fix pip install fails (cjermain, pahaz)

v.0.0.1

• SSHTunnelForwarder class (pahaz)
• open function (pahaz)