|CircleCI| |AppVeyor| |readthedocs| |coveralls| |version|
|pyversions| |license|
**Author**: `Pahaz`_
**Repo**: https://github.com/pahaz/sshtunnel/
Inspired by https://github.com/jmagnusson/bgtunnel, which doesn't work on
Windows.
See also: https://github.com/paramiko/paramiko/blob/master/demos/forward.py
Requirements
-------------
* `paramiko`_
Installation
============
`sshtunnel`_ is on PyPI, so simply run:
::
pip install sshtunnel
or ::
easy_install sshtunnel
or ::
conda install -c conda-forge sshtunnel
to have it installed in your environment.
For installing from source, clone the
`repo <https://github.com/pahaz/sshtunnel>`_ and run::
python setup.py install
Testing the package
-------------------
In order to run the tests you first need
`tox <https://testrun.org/tox/latest/>`_ and run::
python setup.py test
Usage scenarios
===============
One of the typical scenarios where ``sshtunnel`` is helpful is depicted in the
figure below. User may need to connect a port of a remote server (i.e. 8080)
where only SSH port (usually port 22) is reachable. ::
----------------------------------------------------------------------
|
-------------+ | +----------+
LOCAL | | | REMOTE | :22 SSH
CLIENT | <== SSH ========> | SERVER | :8080 web service
-------------+ | +----------+
|
FIREWALL (only port 22 is open)
----------------------------------------------------------------------
**Fig1**: How to connect to a service blocked by a firewall through SSH tunnel.
If allowed by the SSH server, it is also possible to reach a private server
(from the perspective of ``REMOTE SERVER``) not directly visible from the
outside (``LOCAL CLIENT``'s perspective). ::
----------------------------------------------------------------------
|
-------------+ | +----------+ +---------
LOCAL | | | REMOTE | | PRIVATE
CLIENT | <== SSH ========> | SERVER | <== local ==> | SERVER
-------------+ | +----------+ +---------
|
FIREWALL (only port 443 is open)
----------------------------------------------------------------------
**Fig2**: How to connect to ``PRIVATE SERVER`` through SSH tunnel.
Usage examples
==============
API allows either initializing the tunnel and starting it or using a ``with``
context, which will take care of starting **and stopping** the tunnel:
Example 1
---------
Code corresponding to **Fig1** above follows, given remote server's address is
``pahaz.urfuclub.ru``, password authentication and randomly assigned local bind
port.
.. code-block:: python
from sshtunnel import SSHTunnelForwarder
server = SSHTunnelForwarder(
'alfa.8iq.dev',
ssh_username="pahaz",
ssh_password="secret",
remote_bind_address=('127.0.0.1', 8080)
)
server.start()
print(server.local_bind_port) # show assigned local port
# work with `SECRET SERVICE` through `server.local_bind_port`.
server.stop()
Example 2
---------
Example of a port forwarding to a private server not directly reachable,
assuming password protected pkey authentication, remote server's SSH service is
listening on port 443 and that port is open in the firewall (**Fig2**):
.. code-block:: python
import paramiko
import sshtunnel
with sshtunnel.open_tunnel(
(REMOTE_SERVER_IP, 443),
ssh_username="",
ssh_pkey="/var/ssh/rsa_key",
ssh_private_key_password="secret",
remote_bind_address=(PRIVATE_SERVER_IP, 22),
local_bind_address=('0.0.0.0', 10022)
) as tunnel:
client = paramiko.SSHClient()
client.load_system_host_keys()
client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
client.connect('127.0.0.1', 10022)
# do some operations with client session
client.close()
print('FINISH!')
Example 3
---------
Example of a port forwarding for the Vagrant MySQL local port:
.. code-block:: python
from sshtunnel import open_tunnel
from time import sleep
with open_tunnel(
('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 simply using the CLI:
.. code-block:: console
(bash)$ python -m sshtunnel -U vagrant -P vagrant -L :3306 -R 127.0.0.1:3306 -p 2222 localhost
Example 4
---------
Opening an SSH session jumping over two tunnels. SSH transport and tunnels
will be daemonised, which will not wait for the connections to stop at close
time.
.. code-block:: python
import sshtunnel
from paramiko import SSHClient
with sshtunnel.open_tunnel(
ssh_address_or_host=('GW1_ip', 20022),
remote_bind_address=('GW2_ip', 22),
) as tunnel1:
print('Connection to tunnel1 (GW1_ip:GW1_port) OK...')
with sshtunnel.open_tunnel(
ssh_address_or_host=('localhost', tunnel1.local_bind_port),
remote_bind_address=('target_ip', 22),
ssh_username='GW2_user',
ssh_password='GW2_pwd',
) as tunnel2:
print('Connection to tunnel2 (GW2_ip:GW2_port) OK...')
with SSHClient() as ssh:
ssh.connect('localhost',
port=tunnel2.local_bind_port,
username='target_user',
password='target_pwd',
)
ssh.exec_command(...)
CLI usage
=========
::
$ sshtunnel --help
usage: sshtunnel [-h] [-U SSH_USERNAME] [-p SSH_PORT] [-P SSH_PASSWORD] -R
IP:PORT [IP:PORT ...] [-L [IP:PORT [IP:PORT ...]]]
[-k SSH_HOST_KEY] [-K KEY_FILE] [-S KEY_PASSWORD] [-t] [-v]
[-V] [-x IP:PORT] [-c SSH_CONFIG_FILE] [-z] [-n]
[-d [FOLDER [FOLDER ...]]]
ssh_address
Pure python ssh tunnel utils
Version 0.4.0
positional arguments:
ssh_address SSH server IP address (GW for SSH tunnels)
set with "-- ssh_address" if immediately after -R or -L
optional arguments:
-h, --help show this help message and exit
-U SSH_USERNAME, --username SSH_USERNAME
SSH server account username
-p SSH_PORT, --server_port SSH_PORT
SSH server TCP port (default: 22)
-P SSH_PASSWORD, --password SSH_PASSWORD
SSH server account password
-R IP:PORT [IP:PORT ...], --remote_bind_address IP:PORT [IP:PORT ...]
Remote bind address sequence: ip_1:port_1 ip_2:port_2 ... ip_n:port_n
Equivalent to ssh -Lxxxx:IP_ADDRESS:PORT
If port is omitted, defaults to 22.
Example: -R 10.10.10.10: 10.10.10.10:5900
-L [IP:PORT [IP:PORT ...]], --local_bind_address [IP:PORT [IP:PORT ...]]
Local bind address sequence: ip_1:port_1 ip_2:port_2 ... ip_n:port_n
Elements may also be valid UNIX socket domains:
/tmp/foo.sock /tmp/bar.sock ... /tmp/baz.sock
Equivalent to ssh -LPORT:xxxxxxxxx:xxxx, being the local IP address optional.
By default it will listen in all interfaces (0.0.0.0) and choose a random port.
Example: -L :40000
-k SSH_HOST_KEY, --ssh_host_key SSH_HOST_KEY
Gateway's host key
-K KEY_FILE, --private_key_file KEY_FILE
RSA/DSS/ECDSA private key file
-S KEY_PASSWORD, --private_key_password KEY_PASSWORD
RSA/DSS/ECDSA private key password
-t, --threaded Allow concurrent connections to each tunnel
-v, --verbose Increase output verbosity (default: ERROR)
-V, --version Show version number and quit
-x IP:PORT, --proxy IP:PORT
IP and port of SSH proxy to destination
-c SSH_CONFIG_FILE, --config SSH_CONFIG_FILE
SSH configuration file, defaults to ~/.ssh/config
-z, --compress Request server for compression over SSH transport
-n, --noagent Disable looking for keys from an SSH agent
-d [FOLDER [FOLDER ...]], --host_pkey_directories [FOLDER [FOLDER ...]]
List of directories where SSH pkeys (in the format `id_*`) may be found
.. _Pahaz: https://github.com/pahaz
.. _sshtunnel: https://pypi.python.org/pypi/sshtunnel
.. _paramiko: http://www.paramiko.org/
.. |CircleCI| image:: https://circleci.com/gh/pahaz/sshtunnel.svg?style=svg
:target: https://circleci.com/gh/pahaz/sshtunnel
.. |AppVeyor| image:: https://ci.appveyor.com/api/projects/status/oxg1vx2ycmnw3xr9?svg=true&passingText=Windows%20-%20OK&failingText=Windows%20-%20Fail
:target: https://ci.appveyor.com/project/pahaz/sshtunnel
.. |readthedocs| image:: https://readthedocs.org/projects/sshtunnel/badge/?version=latest
:target: http://sshtunnel.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. |coveralls| image:: https://coveralls.io/repos/github/pahaz/sshtunnel/badge.svg?branch=master
:target: https://coveralls.io/github/pahaz/sshtunnel?branch=master
.. |pyversions| image:: https://img.shields.io/pypi/pyversions/sshtunnel.svg
.. |version| image:: https://img.shields.io/pypi/v/sshtunnel.svg
:target: `sshtunnel`_
.. |license| image:: https://img.shields.io/pypi/l/sshtunnel.svg
:target: https://github.com/pahaz/sshtunnel/blob/master/LICENSE
Online documentation
====================
Documentation may be found at `readthedocs`_.
.. _readthedocs: https://sshtunnel.readthedocs.org/
CONTRIBUTORS
============
- `Cameron Maske`_
- `Gustavo Machado`_
- `Colin Jermain`_
- `JM Fernández`_ - (big thanks!)
- `Lewis Thompson`_
- `Erik Rogers`_
- `Mart Sõmermaa`_
- `Chronial`_
- `Dan Harbin`_
- `Ignacio Peluffo`_
- `Niels Zeilemaker`_
- `Georgy Rylov`_
- `Eddie Chiang`_
- `kkrasovskii`_
CHANGELOG
=========
- v.0.4.0 (`Pahaz`_)
+ Change the daemon mod flag for all tunnel threads (is not fully backward compatible) to prevent unexpected hangs (`#219`_)
+ Add docker based end to end functinal tests for Mongo/Postgres/MySQL (`#219`_)
+ Add docker based end to end hangs tests (`#219`_)
- v.0.3.2 (`Pahaz`_, `JM Fernández`_)
+ Fix host key directory detection
+ Unify default ssh config folder to `~/.ssh`
- v.0.3.1 (`Pahaz`_)
+ Increase open connection timeout to 10 secods
- v.0.3.0 (`Pahaz`_)
+ Change default with context behavior to use `.stop(force=True)` on exit (is not fully backward compatible)
+ Remove useless `daemon_forward_servers = True` hack for hangs prevention (is not fully backward compatible)
+ Set transport keepalive to 5 second by default (disabled for version < 0.3.0)
+ Set default transport timeout to 0.1
+ Deprecate and remove `block_on_close` option
+ Fix "deadlocks" / "tunneling hangs" (`#173`_, `#201`_, `#162`_, `#211`_)
- v.0.2.2 (`Pahaz`_)
+ Add `.stop(force=True)` for force close active connections (`#201`_)
- v.0.2.1 (`Pahaz`_, `Eddie Chiang`_ and `kkrasovskii`_)
+ Fixes bug with orphan thread for a tunnel that is DOWN (`#170`_)
- v.0.2.0 (`Georgy Rylov`_)
+ Support IPv6 without proxy command. Use built-in paramiko create socket logic. The logic tries to use ipv6 socket family first, then ipv4 socket family.
- v.0.1.5 (`JM Fernández`_)
+ Introduce `block_on_close` attribute
- v.0.1.4 (`Niels Zeilemaker`_)
+ Allow loading pkeys from `~/.ssh`
- v.0.1.3 (`Ignacio Peluffo`_ and others)
+ ``pkey_file`` parameter updated to accept relative paths to user folder using ``~``
+ Several bugfixes
- v.0.1.2 (`JM Fernández`_)
+ Fix #77
- v.0.1.1 (`JM Fernández`_)
+ Fix #72
- v.0.1.0 (`JM Fernández`_)
+ Add `tunnel_bindings` property
+ Several bugfixes (#49, #56, #57, #59, #60, #62, #64, #66, ...)
(`Pahaz`_, `JM Fernández`_)
+ Add TRACE logging level (`JM Fernández`_)
+ Code and tests refactoring (`JM Fernández`_)
+ Drop python3.2 support
- v.0.0.8 (`JM Fernández`_)
+ Merge `#31`_: Support Unix domain socket (local) forwarding (`Dan Harbin`_)
+ Simplify API (`JM Fernández`_)
+ Add sphinx-based documentation (`JM Fernández`_)
+ Add ``allow_agent`` (fixes `#36`_, `#46`_) (`JM Fernández`_)
+ Add ``compression`` (`JM Fernández`_)
+ Add ``__str__`` method (`JM Fernández`_)
+ Add test functions (`JM Fernández`_)
+ Fix default username when not provided and ssh_config file is skipped (`JM Fernández`_)
+ Fix gateway IP unresolvable exception catching (`JM Fernández`_)
+ Minor fixes (`JM Fernández`_)
+ Add AppVeyor support (`JM Fernández`_)
- v.0.0.7 (`JM Fernández`_)
+ Tunnels can now be stopped and started safely (`#41`_) (`JM Fernández`_)
+ Add timeout to SSH gateway and keep-alive messages (`#29`_) (`JM Fernández`_)
+ Allow sending a pkey directly (`#43`_) (`Chronial`_)
+ Add ``-V`` CLI option to show current version (`JM Fernández`_)
+ Add coverage (`JM Fernández`_)
+ Refactoring (`JM Fernández`_)
- v.0.0.6 (`Pahaz`_)
+ add ``-S`` CLI options for ssh private key password support (`Pahaz`_)
- v.0.0.5 (`Pahaz`_)
+ add ``ssh_proxy`` argument, as well as ``ssh_config(5)`` ``ProxyCommand`` support (`Lewis Thompson`_)
+ add some python 2.6 compatibility fixes (`Mart Sõmermaa`_)
+ ``paramiko.transport`` inherits handlers of loggers passed to ``SSHTunnelForwarder`` (`JM Fernández`_)
+ fix `#34`_, `#33`_, code style and docs (`JM Fernández`_)
+ add tests (`Pahaz`_)
+ add CI integration (`Pahaz`_)
+ normal packaging (`Pahaz`_)
+ disable check distenation socket connection by ``SSHTunnelForwarder.local_is_up`` (`Pahaz`_) [changed default behavior]
+ use daemon mode = False in all threads by default; detail_ (`Pahaz`_) [changed default behavior]
- v.0.0.4.4 (`Pahaz`_)
+ fix issue `#24`_ - hide ssh password in logs (`Pahaz`_)
- v.0.0.4.3 (`Pahaz`_)
+ fix default port issue `#19`_ (`Pahaz`_)
- v.0.0.4.2 (`Pahaz`_)
+ fix Thread.daemon mode for Python < 3.3 `#16`_, `#21`_ (`Lewis Thompson`_, `Erik Rogers`_)
- v.0.0.4.1 (`Pahaz`_)
+ fix CLI issues `#13`_ (`Pahaz`_)
- v.0.0.4 (`Pahaz`_)
+ daemon mode by default for all threads (`JM Fernández`_, `Pahaz`_) - *incompatible*
+ move ``make_ssh_forward_server`` to ``SSHTunnelForwarder.make_ssh_forward_server`` (`Pahaz`_, `JM Fernández`_) - *incompatible*
+ move ``make_ssh_forward_handler`` to ``SSHTunnelForwarder.make_ssh_forward_handler_class`` (`Pahaz`_, `JM Fernández`_) - *incompatible*
+ rename ``open`` to ``open_tunnel`` (`JM Fernández`_) - *incompatible*
+ add CLI interface (`JM Fernández`_)
+ support opening several tunnels at once (`JM Fernández`_)
+ improve stability and readability (`JM Fernández`_, `Pahaz`_)
+ improve logging (`JM Fernández`_, `Pahaz`_)
+ add ``raise_exception_if_any_forwarder_have_a_problem`` argument for opening several tunnels at once (`Pahaz`_)
+ add ``ssh_config_file`` argument support (`JM Fernández`_)
+ add Python 3 support (`JM Fernández`_, `Pahaz`_)
- v.0.0.3 (`Pahaz`_)
+ add ``threaded`` option (`Cameron Maske`_)
+ fix exception error message, correctly printing destination address (`Gustavo Machado`_)
+ fix ``pip install`` failure (`Colin Jermain`_, `Pahaz`_)
- v.0.0.1 (`Pahaz`_)
+ ``SSHTunnelForwarder`` class (`Pahaz`_)
+ ``open`` function (`Pahaz`_)
.. _Pahaz: https://github.com/pahaz
.. _Cameron Maske: https://github.com/cameronmaske
.. _Gustavo Machado: https://github.com/gdmachado
.. _Colin Jermain: https://github.com/cjermain
.. _JM Fernández: https://github.com/fernandezcuesta
.. _Lewis Thompson: https://github.com/lewisthompson
.. _Erik Rogers: https://github.com/ewrogers
.. _Mart Sõmermaa: https://github.com/mrts
.. _Chronial: https://github.com/Chronial
.. _Dan Harbin: https://github.com/RasterBurn
.. _Ignacio Peluffo: https://github.com/ipeluffo
.. _Niels Zeilemaker: https://github.com/NielsZeilemaker
.. _Georgy Rylov: https://github.com/g0djan
.. _Eddie Chiang: https://github.com/eddie-chiang
.. _kkrasovskii: https://github.com/kkrasovskii
.. _#13: https://github.com/pahaz/sshtunnel/issues/13
.. _#16: https://github.com/pahaz/sshtunnel/issues/16
.. _#19: https://github.com/pahaz/sshtunnel/issues/19
.. _#21: https://github.com/pahaz/sshtunnel/issues/21
.. _#24: https://github.com/pahaz/sshtunnel/issues/24
.. _#29: https://github.com/pahaz/sshtunnel/issues/29
.. _#31: https://github.com/pahaz/sshtunnel/issues/31
.. _#33: https://github.com/pahaz/sshtunnel/issues/33
.. _#34: https://github.com/pahaz/sshtunnel/issues/34
.. _#36: https://github.com/pahaz/sshtunnel/issues/36
.. _#41: https://github.com/pahaz/sshtunnel/issues/41
.. _#43: https://github.com/pahaz/sshtunnel/issues/43
.. _#46: https://github.com/pahaz/sshtunnel/issues/46
.. _#170: https://github.com/pahaz/sshtunnel/issues/170
.. _#201: https://github.com/pahaz/sshtunnel/issues/201
.. _#162: https://github.com/pahaz/sshtunnel/issues/162
.. _#173: https://github.com/pahaz/sshtunnel/issues/173
.. _#201: https://github.com/pahaz/sshtunnel/issues/201
.. _#211: https://github.com/pahaz/sshtunnel/issues/211
.. _#219: https://github.com/pahaz/sshtunnel/issues/219
.. _detail: https://github.com/pahaz/sshtunnel/commit/64af238b799b0e0057c4f9b386cda247e0006da9#diff-76bc1662a114401c2954deb92b740081R127
Raw data
{
"_id": null,
"home_page": "https://github.com/pahaz/sshtunnel",
"name": "sshtunnel",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "ssh tunnel paramiko proxy tcp-forward",
"author": "Pahaz White",
"author_email": "pahaz.white@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/8d/ad/4c587adf79865be268ee0b6bd52cfaa7a75d827a23ced072dc5ab554b4af/sshtunnel-0.4.0.tar.gz",
"platform": "unix",
"description": "|CircleCI| |AppVeyor| |readthedocs| |coveralls| |version|\n\n|pyversions| |license|\n\n**Author**: `Pahaz`_\n\n**Repo**: https://github.com/pahaz/sshtunnel/\n\nInspired by https://github.com/jmagnusson/bgtunnel, which doesn't work on\nWindows.\n\nSee also: https://github.com/paramiko/paramiko/blob/master/demos/forward.py\n\nRequirements\n-------------\n\n* `paramiko`_\n\nInstallation\n============\n\n`sshtunnel`_ is on PyPI, so simply run:\n\n::\n\n pip install sshtunnel\n\nor ::\n\n easy_install sshtunnel\n\nor ::\n\n conda install -c conda-forge sshtunnel\n\nto have it installed in your environment.\n\nFor installing from source, clone the\n`repo <https://github.com/pahaz/sshtunnel>`_ and run::\n\n python setup.py install\n\nTesting the package\n-------------------\n\nIn order to run the tests you first need\n`tox <https://testrun.org/tox/latest/>`_ and run::\n\n python setup.py test\n\nUsage scenarios\n===============\n\nOne of the typical scenarios where ``sshtunnel`` is helpful is depicted in the\nfigure below. User may need to connect a port of a remote server (i.e. 8080)\nwhere only SSH port (usually port 22) is reachable. ::\n\n ----------------------------------------------------------------------\n\n |\n -------------+ | +----------+\n LOCAL | | | REMOTE | :22 SSH\n CLIENT | <== SSH ========> | SERVER | :8080 web service\n -------------+ | +----------+\n |\n FIREWALL (only port 22 is open)\n\n ----------------------------------------------------------------------\n\n**Fig1**: How to connect to a service blocked by a firewall through SSH tunnel.\n\n\nIf allowed by the SSH server, it is also possible to reach a private server\n(from the perspective of ``REMOTE SERVER``) not directly visible from the\noutside (``LOCAL CLIENT``'s perspective). ::\n\n ----------------------------------------------------------------------\n\n |\n -------------+ | +----------+ +---------\n LOCAL | | | REMOTE | | PRIVATE\n CLIENT | <== SSH ========> | SERVER | <== local ==> | SERVER\n -------------+ | +----------+ +---------\n |\n FIREWALL (only port 443 is open)\n\n ----------------------------------------------------------------------\n\n**Fig2**: How to connect to ``PRIVATE SERVER`` through SSH tunnel.\n\n\nUsage examples\n==============\n\nAPI allows either initializing the tunnel and starting it or using a ``with``\ncontext, which will take care of starting **and stopping** the tunnel:\n\nExample 1\n---------\n\nCode corresponding to **Fig1** above follows, given remote server's address is\n``pahaz.urfuclub.ru``, password authentication and randomly assigned local bind\nport.\n\n.. code-block:: python\n\n from sshtunnel import SSHTunnelForwarder\n\n server = SSHTunnelForwarder(\n 'alfa.8iq.dev',\n ssh_username=\"pahaz\",\n ssh_password=\"secret\",\n remote_bind_address=('127.0.0.1', 8080)\n )\n\n server.start()\n\n print(server.local_bind_port) # show assigned local port\n # work with `SECRET SERVICE` through `server.local_bind_port`.\n\n server.stop()\n\nExample 2\n---------\n\nExample of a port forwarding to a private server not directly reachable,\nassuming password protected pkey authentication, remote server's SSH service is\nlistening on port 443 and that port is open in the firewall (**Fig2**):\n\n.. code-block:: python\n\n import paramiko\n import sshtunnel\n\n with sshtunnel.open_tunnel(\n (REMOTE_SERVER_IP, 443),\n ssh_username=\"\",\n ssh_pkey=\"/var/ssh/rsa_key\",\n ssh_private_key_password=\"secret\",\n remote_bind_address=(PRIVATE_SERVER_IP, 22),\n local_bind_address=('0.0.0.0', 10022)\n ) as tunnel:\n client = paramiko.SSHClient()\n client.load_system_host_keys()\n client.set_missing_host_key_policy(paramiko.AutoAddPolicy())\n client.connect('127.0.0.1', 10022)\n # do some operations with client session\n client.close()\n\n print('FINISH!')\n\nExample 3\n---------\n\nExample of a port forwarding for the Vagrant MySQL local port:\n\n.. code-block:: python\n\n from sshtunnel import open_tunnel\n from time import sleep\n\n with open_tunnel(\n ('localhost', 2222),\n ssh_username=\"vagrant\",\n ssh_password=\"vagrant\",\n remote_bind_address=('127.0.0.1', 3306)\n ) as server:\n\n print(server.local_bind_port)\n while True:\n # press Ctrl-C for stopping\n sleep(1)\n\n print('FINISH!')\n\nOr simply using the CLI:\n\n.. code-block:: console\n\n (bash)$ python -m sshtunnel -U vagrant -P vagrant -L :3306 -R 127.0.0.1:3306 -p 2222 localhost\n\nExample 4\n---------\n\nOpening an SSH session jumping over two tunnels. SSH transport and tunnels\nwill be daemonised, which will not wait for the connections to stop at close\ntime.\n\n.. code-block:: python\n\n import sshtunnel\n from paramiko import SSHClient\n\n\n with sshtunnel.open_tunnel(\n ssh_address_or_host=('GW1_ip', 20022),\n remote_bind_address=('GW2_ip', 22),\n ) as tunnel1:\n print('Connection to tunnel1 (GW1_ip:GW1_port) OK...')\n with sshtunnel.open_tunnel(\n ssh_address_or_host=('localhost', tunnel1.local_bind_port),\n remote_bind_address=('target_ip', 22),\n ssh_username='GW2_user',\n ssh_password='GW2_pwd',\n ) as tunnel2:\n print('Connection to tunnel2 (GW2_ip:GW2_port) OK...')\n with SSHClient() as ssh:\n ssh.connect('localhost',\n port=tunnel2.local_bind_port,\n username='target_user',\n password='target_pwd',\n )\n ssh.exec_command(...)\n\n\nCLI usage\n=========\n\n::\n\n $ sshtunnel --help\n usage: sshtunnel [-h] [-U SSH_USERNAME] [-p SSH_PORT] [-P SSH_PASSWORD] -R\n IP:PORT [IP:PORT ...] [-L [IP:PORT [IP:PORT ...]]]\n [-k SSH_HOST_KEY] [-K KEY_FILE] [-S KEY_PASSWORD] [-t] [-v]\n [-V] [-x IP:PORT] [-c SSH_CONFIG_FILE] [-z] [-n]\n [-d [FOLDER [FOLDER ...]]]\n ssh_address\n\n Pure python ssh tunnel utils\n Version 0.4.0\n\n positional arguments:\n ssh_address SSH server IP address (GW for SSH tunnels)\n set with \"-- ssh_address\" if immediately after -R or -L\n\n optional arguments:\n -h, --help show this help message and exit\n -U SSH_USERNAME, --username SSH_USERNAME\n SSH server account username\n -p SSH_PORT, --server_port SSH_PORT\n SSH server TCP port (default: 22)\n -P SSH_PASSWORD, --password SSH_PASSWORD\n SSH server account password\n -R IP:PORT [IP:PORT ...], --remote_bind_address IP:PORT [IP:PORT ...]\n Remote bind address sequence: ip_1:port_1 ip_2:port_2 ... ip_n:port_n\n Equivalent to ssh -Lxxxx:IP_ADDRESS:PORT\n If port is omitted, defaults to 22.\n Example: -R 10.10.10.10: 10.10.10.10:5900\n -L [IP:PORT [IP:PORT ...]], --local_bind_address [IP:PORT [IP:PORT ...]]\n Local bind address sequence: ip_1:port_1 ip_2:port_2 ... ip_n:port_n\n Elements may also be valid UNIX socket domains:\n /tmp/foo.sock /tmp/bar.sock ... /tmp/baz.sock\n Equivalent to ssh -LPORT:xxxxxxxxx:xxxx, being the local IP address optional.\n By default it will listen in all interfaces (0.0.0.0) and choose a random port.\n Example: -L :40000\n -k SSH_HOST_KEY, --ssh_host_key SSH_HOST_KEY\n Gateway's host key\n -K KEY_FILE, --private_key_file KEY_FILE\n RSA/DSS/ECDSA private key file\n -S KEY_PASSWORD, --private_key_password KEY_PASSWORD\n RSA/DSS/ECDSA private key password\n -t, --threaded Allow concurrent connections to each tunnel\n -v, --verbose Increase output verbosity (default: ERROR)\n -V, --version Show version number and quit\n -x IP:PORT, --proxy IP:PORT\n IP and port of SSH proxy to destination\n -c SSH_CONFIG_FILE, --config SSH_CONFIG_FILE\n SSH configuration file, defaults to ~/.ssh/config\n -z, --compress Request server for compression over SSH transport\n -n, --noagent Disable looking for keys from an SSH agent\n -d [FOLDER [FOLDER ...]], --host_pkey_directories [FOLDER [FOLDER ...]]\n List of directories where SSH pkeys (in the format `id_*`) may be found\n\n.. _Pahaz: https://github.com/pahaz\n.. _sshtunnel: https://pypi.python.org/pypi/sshtunnel\n.. _paramiko: http://www.paramiko.org/\n.. |CircleCI| image:: https://circleci.com/gh/pahaz/sshtunnel.svg?style=svg\n :target: https://circleci.com/gh/pahaz/sshtunnel\n.. |AppVeyor| image:: https://ci.appveyor.com/api/projects/status/oxg1vx2ycmnw3xr9?svg=true&passingText=Windows%20-%20OK&failingText=Windows%20-%20Fail\n :target: https://ci.appveyor.com/project/pahaz/sshtunnel\n.. |readthedocs| image:: https://readthedocs.org/projects/sshtunnel/badge/?version=latest\n :target: http://sshtunnel.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n.. |coveralls| image:: https://coveralls.io/repos/github/pahaz/sshtunnel/badge.svg?branch=master\n :target: https://coveralls.io/github/pahaz/sshtunnel?branch=master\n.. |pyversions| image:: https://img.shields.io/pypi/pyversions/sshtunnel.svg\n.. |version| image:: https://img.shields.io/pypi/v/sshtunnel.svg\n :target: `sshtunnel`_\n.. |license| image:: https://img.shields.io/pypi/l/sshtunnel.svg\n :target: https://github.com/pahaz/sshtunnel/blob/master/LICENSE\n\nOnline documentation\n====================\n\nDocumentation may be found at `readthedocs`_.\n\n.. _readthedocs: https://sshtunnel.readthedocs.org/\n\nCONTRIBUTORS\n============\n\n- `Cameron Maske`_\n- `Gustavo Machado`_\n- `Colin Jermain`_\n- `JM Fern\u00e1ndez`_ - (big thanks!)\n- `Lewis Thompson`_\n- `Erik Rogers`_\n- `Mart S\u00f5mermaa`_\n- `Chronial`_\n- `Dan Harbin`_\n- `Ignacio Peluffo`_\n- `Niels Zeilemaker`_\n- `Georgy Rylov`_\n- `Eddie Chiang`_\n- `kkrasovskii`_\n\nCHANGELOG\n=========\n\n- v.0.4.0 (`Pahaz`_)\n + Change the daemon mod flag for all tunnel threads (is not fully backward compatible) to prevent unexpected hangs (`#219`_)\n + Add docker based end to end functinal tests for Mongo/Postgres/MySQL (`#219`_)\n + Add docker based end to end hangs tests (`#219`_)\n\n- v.0.3.2 (`Pahaz`_, `JM Fern\u00e1ndez`_)\n + Fix host key directory detection\n + Unify default ssh config folder to `~/.ssh`\n\n- v.0.3.1 (`Pahaz`_)\n + Increase open connection timeout to 10 secods\n\n- v.0.3.0 (`Pahaz`_)\n + Change default with context behavior to use `.stop(force=True)` on exit (is not fully backward compatible)\n + Remove useless `daemon_forward_servers = True` hack for hangs prevention (is not fully backward compatible)\n + Set transport keepalive to 5 second by default (disabled for version < 0.3.0)\n + Set default transport timeout to 0.1\n + Deprecate and remove `block_on_close` option\n + Fix \"deadlocks\" / \"tunneling hangs\" (`#173`_, `#201`_, `#162`_, `#211`_)\n\n- v.0.2.2 (`Pahaz`_)\n + Add `.stop(force=True)` for force close active connections (`#201`_)\n\n- v.0.2.1 (`Pahaz`_, `Eddie Chiang`_ and `kkrasovskii`_)\n + Fixes bug with orphan thread for a tunnel that is DOWN (`#170`_)\n\n- v.0.2.0 (`Georgy Rylov`_)\n + Support IPv6 without proxy command. Use built-in paramiko create socket logic. The logic tries to use ipv6 socket family first, then ipv4 socket family.\n\n- v.0.1.5 (`JM Fern\u00e1ndez`_)\n + Introduce `block_on_close` attribute\n\n- v.0.1.4 (`Niels Zeilemaker`_)\n + Allow loading pkeys from `~/.ssh`\n\n- v.0.1.3 (`Ignacio Peluffo`_ and others)\n + ``pkey_file`` parameter updated to accept relative paths to user folder using ``~``\n + Several bugfixes\n\n- v.0.1.2 (`JM Fern\u00e1ndez`_)\n + Fix #77\n\n- v.0.1.1 (`JM Fern\u00e1ndez`_)\n + Fix #72\n\n- v.0.1.0 (`JM Fern\u00e1ndez`_)\n + Add `tunnel_bindings` property\n + Several bugfixes (#49, #56, #57, #59, #60, #62, #64, #66, ...)\n (`Pahaz`_, `JM Fern\u00e1ndez`_)\n + Add TRACE logging level (`JM Fern\u00e1ndez`_)\n + Code and tests refactoring (`JM Fern\u00e1ndez`_)\n + Drop python3.2 support\n\n- v.0.0.8 (`JM Fern\u00e1ndez`_)\n + Merge `#31`_: Support Unix domain socket (local) forwarding (`Dan Harbin`_)\n + Simplify API (`JM Fern\u00e1ndez`_)\n + Add sphinx-based documentation (`JM Fern\u00e1ndez`_)\n + Add ``allow_agent`` (fixes `#36`_, `#46`_) (`JM Fern\u00e1ndez`_)\n + Add ``compression`` (`JM Fern\u00e1ndez`_)\n + Add ``__str__`` method (`JM Fern\u00e1ndez`_)\n + Add test functions (`JM Fern\u00e1ndez`_)\n + Fix default username when not provided and ssh_config file is skipped (`JM Fern\u00e1ndez`_)\n + Fix gateway IP unresolvable exception catching (`JM Fern\u00e1ndez`_)\n + Minor fixes (`JM Fern\u00e1ndez`_)\n + Add AppVeyor support (`JM Fern\u00e1ndez`_)\n\n- v.0.0.7 (`JM Fern\u00e1ndez`_)\n + Tunnels can now be stopped and started safely (`#41`_) (`JM Fern\u00e1ndez`_)\n + Add timeout to SSH gateway and keep-alive messages (`#29`_) (`JM Fern\u00e1ndez`_)\n + Allow sending a pkey directly (`#43`_) (`Chronial`_)\n + Add ``-V`` CLI option to show current version (`JM Fern\u00e1ndez`_)\n + Add coverage (`JM Fern\u00e1ndez`_)\n + Refactoring (`JM Fern\u00e1ndez`_)\n\n- v.0.0.6 (`Pahaz`_)\n + add ``-S`` CLI options for ssh private key password support (`Pahaz`_)\n\n- v.0.0.5 (`Pahaz`_)\n + add ``ssh_proxy`` argument, as well as ``ssh_config(5)`` ``ProxyCommand`` support (`Lewis Thompson`_)\n + add some python 2.6 compatibility fixes (`Mart S\u00f5mermaa`_)\n + ``paramiko.transport`` inherits handlers of loggers passed to ``SSHTunnelForwarder`` (`JM Fern\u00e1ndez`_)\n + fix `#34`_, `#33`_, code style and docs (`JM Fern\u00e1ndez`_)\n + add tests (`Pahaz`_)\n + add CI integration (`Pahaz`_)\n + normal packaging (`Pahaz`_)\n + disable check distenation socket connection by ``SSHTunnelForwarder.local_is_up`` (`Pahaz`_) [changed default behavior]\n + use daemon mode = False in all threads by default; detail_ (`Pahaz`_) [changed default behavior]\n\n- v.0.0.4.4 (`Pahaz`_)\n + fix issue `#24`_ - hide ssh password in logs (`Pahaz`_)\n\n- v.0.0.4.3 (`Pahaz`_)\n + fix default port issue `#19`_ (`Pahaz`_)\n\n- v.0.0.4.2 (`Pahaz`_)\n + fix Thread.daemon mode for Python < 3.3 `#16`_, `#21`_ (`Lewis Thompson`_, `Erik Rogers`_)\n\n- v.0.0.4.1 (`Pahaz`_)\n + fix CLI issues `#13`_ (`Pahaz`_)\n\n- v.0.0.4 (`Pahaz`_)\n + daemon mode by default for all threads (`JM Fern\u00e1ndez`_, `Pahaz`_) - *incompatible*\n + move ``make_ssh_forward_server`` to ``SSHTunnelForwarder.make_ssh_forward_server`` (`Pahaz`_, `JM Fern\u00e1ndez`_) - *incompatible*\n + move ``make_ssh_forward_handler`` to ``SSHTunnelForwarder.make_ssh_forward_handler_class`` (`Pahaz`_, `JM Fern\u00e1ndez`_) - *incompatible*\n + rename ``open`` to ``open_tunnel`` (`JM Fern\u00e1ndez`_) - *incompatible*\n + add CLI interface (`JM Fern\u00e1ndez`_)\n + support opening several tunnels at once (`JM Fern\u00e1ndez`_)\n + improve stability and readability (`JM Fern\u00e1ndez`_, `Pahaz`_)\n + improve logging (`JM Fern\u00e1ndez`_, `Pahaz`_)\n + add ``raise_exception_if_any_forwarder_have_a_problem`` argument for opening several tunnels at once (`Pahaz`_)\n + add ``ssh_config_file`` argument support (`JM Fern\u00e1ndez`_)\n + add Python 3 support (`JM Fern\u00e1ndez`_, `Pahaz`_)\n\n- v.0.0.3 (`Pahaz`_)\n + add ``threaded`` option (`Cameron Maske`_)\n + fix exception error message, correctly printing destination address (`Gustavo Machado`_)\n + fix ``pip install`` failure (`Colin Jermain`_, `Pahaz`_)\n\n- v.0.0.1 (`Pahaz`_)\n + ``SSHTunnelForwarder`` class (`Pahaz`_)\n + ``open`` function (`Pahaz`_)\n\n\n.. _Pahaz: https://github.com/pahaz\n.. _Cameron Maske: https://github.com/cameronmaske\n.. _Gustavo Machado: https://github.com/gdmachado\n.. _Colin Jermain: https://github.com/cjermain\n.. _JM Fern\u00e1ndez: https://github.com/fernandezcuesta\n.. _Lewis Thompson: https://github.com/lewisthompson\n.. _Erik Rogers: https://github.com/ewrogers\n.. _Mart S\u00f5mermaa: https://github.com/mrts\n.. _Chronial: https://github.com/Chronial\n.. _Dan Harbin: https://github.com/RasterBurn\n.. _Ignacio Peluffo: https://github.com/ipeluffo\n.. _Niels Zeilemaker: https://github.com/NielsZeilemaker\n.. _Georgy Rylov: https://github.com/g0djan\n.. _Eddie Chiang: https://github.com/eddie-chiang\n.. _kkrasovskii: https://github.com/kkrasovskii\n.. _#13: https://github.com/pahaz/sshtunnel/issues/13\n.. _#16: https://github.com/pahaz/sshtunnel/issues/16\n.. _#19: https://github.com/pahaz/sshtunnel/issues/19\n.. _#21: https://github.com/pahaz/sshtunnel/issues/21\n.. _#24: https://github.com/pahaz/sshtunnel/issues/24\n.. _#29: https://github.com/pahaz/sshtunnel/issues/29\n.. _#31: https://github.com/pahaz/sshtunnel/issues/31\n.. _#33: https://github.com/pahaz/sshtunnel/issues/33\n.. _#34: https://github.com/pahaz/sshtunnel/issues/34\n.. _#36: https://github.com/pahaz/sshtunnel/issues/36\n.. _#41: https://github.com/pahaz/sshtunnel/issues/41\n.. _#43: https://github.com/pahaz/sshtunnel/issues/43\n.. _#46: https://github.com/pahaz/sshtunnel/issues/46\n.. _#170: https://github.com/pahaz/sshtunnel/issues/170\n.. _#201: https://github.com/pahaz/sshtunnel/issues/201\n.. _#162: https://github.com/pahaz/sshtunnel/issues/162\n.. _#173: https://github.com/pahaz/sshtunnel/issues/173\n.. _#201: https://github.com/pahaz/sshtunnel/issues/201\n.. _#211: https://github.com/pahaz/sshtunnel/issues/211\n.. _#219: https://github.com/pahaz/sshtunnel/issues/219\n.. _detail: https://github.com/pahaz/sshtunnel/commit/64af238b799b0e0057c4f9b386cda247e0006da9#diff-76bc1662a114401c2954deb92b740081R127\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Pure python SSH tunnels",
"version": "0.4.0",
"split_keywords": [
"ssh",
"tunnel",
"paramiko",
"proxy",
"tcp-forward"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "b1bdc8f01c63c61012de6ef8262afbcb",
"sha256": "98e54c26f726ab8bd42b47a3a21fca5c3e60f58956f0f70de2fb8ab0046d0606"
},
"downloads": -1,
"filename": "sshtunnel-0.4.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "b1bdc8f01c63c61012de6ef8262afbcb",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 24729,
"upload_time": "2021-01-11T13:26:29",
"upload_time_iso_8601": "2021-01-11T13:26:29.969084Z",
"url": "https://files.pythonhosted.org/packages/58/13/8476c4328dcadfe26f8bd7f3a1a03bf9ddb890a7e7b692f54a179bc525bf/sshtunnel-0.4.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "b5e59486675a206772f7111ee8bd8302",
"sha256": "4a07cf989712e8ba76a370584bec922d14775054b3ff18e5d075507a298dc3ed"
},
"downloads": -1,
"filename": "sshtunnel-0.4.0-py3.8.egg",
"has_sig": false,
"md5_digest": "b5e59486675a206772f7111ee8bd8302",
"packagetype": "bdist_egg",
"python_version": "3.8",
"requires_python": null,
"size": 24161,
"upload_time": "2021-01-11T13:26:31",
"upload_time_iso_8601": "2021-01-11T13:26:31.684163Z",
"url": "https://files.pythonhosted.org/packages/fb/b9/5bfdda9649c33b01e2a6c9a1b11a7925c82418d9e264f362b088bb84cda5/sshtunnel-0.4.0-py3.8.egg",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "4b523e55fa2b2c09acf9dbe2189fb1d1",
"sha256": "e7cb0ea774db81bf91844db22de72a40aae8f7b0f9bb9ba0f666d474ef6bf9fc"
},
"downloads": -1,
"filename": "sshtunnel-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "4b523e55fa2b2c09acf9dbe2189fb1d1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 62716,
"upload_time": "2021-01-11T13:26:32",
"upload_time_iso_8601": "2021-01-11T13:26:32.975793Z",
"url": "https://files.pythonhosted.org/packages/8d/ad/4c587adf79865be268ee0b6bd52cfaa7a75d827a23ced072dc5ab554b4af/sshtunnel-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-01-11 13:26:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "pahaz",
"github_project": "sshtunnel",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"circle": true,
"appveyor": true,
"tox": true,
"lcname": "sshtunnel"
}
JSON
