|CircleCI| |AppVeyor| |readthedocs| |coveralls| |version|

|pyversions| |license|

Автор: Pahaz_

Репозиторий: https://github.com/pahaz/sshtunnel/

Вдохновлено https://github.com/jmagnusson/bgtunnel, который не работает на Windows.

См. также: https://github.com/paramiko/paramiko/blob/master/demos/forward.py

Требования

• paramiko_

Установка

sshtunnel_ доступен на PyPI, поэтому просто выполните:

::

pip install sshtunnel

или ::

easy_install sshtunnel

или ::

conda install -c conda-forge sshtunnel

чтобы установить его в вашем окружении.

Для установки из исходного кода клонируйте репозиторий <https://github.com/pahaz/sshtunnel>_ и выполните::

python setup.py install

Тестирование пакета

Чтобы запустить тесты, сначала понадобится tox <https://testrun.org/tox/latest/>_, затем выполните::

python setup.py test

Сценарии использования

Один из типичных сценариев, где sshtunnel помогает, показан на рисунке ниже. Пользователю может потребоваться подключиться к порту удалённого сервера (например, 8080), где доступен только SSH-порт (обычно порт 22). ::

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

                            |
-------------+              |    +----------+
    LOCAL    |              |    |  REMOTE  | :22 SSH
    CLIENT   | <== SSH ========> |  SERVER  | :8080 web service
-------------+              |    +----------+
                            |
                         FIREWALL (only port 22 is open)

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

Рис.1: Как подключиться к сервису, заблокированному брандмауэром, через SSH-туннель.

Если это разрешено SSH-сервером, также возможно достичь частного сервера (с точки зрения REMOTE SERVER), не видимого напрямую извне (с точки зрения LOCAL CLIENT). ::

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

                            |
-------------+              |    +----------+               +---------
    LOCAL    |              |    |  REMOTE  |               | PRIVATE
    CLIENT   | <== SSH ========> |  SERVER  | <== local ==> | SERVER
-------------+              |    +----------+               +---------
                            |
                         FIREWALL (only port 443 is open)

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

Рис.2: Как подключиться к PRIVATE SERVER через SSH-туннель.

Примеры использования

API позволяет либо инициализировать туннель и запустить его, либо использовать контекст with, который позаботится о запуске и остановке туннеля:

Пример 1

Код, соответствующий Рис.1 выше, при условии, что адрес удалённого сервера — pahaz.urfuclub.ru, аутентификация по паролю и произвольно назначенный локальный порт привязки.

.. 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()

Пример 2

Пример перенаправления порта на частный сервер, недоступный напрямую, при условии аутентификации по закрытому ключу, защищённому паролем; SSH-сервис удалённого сервера слушает порт 443, и этот порт открыт в брандмауэре (Рис.2):

.. 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!')

Пример 3

Пример перенаправления порта для локального порта MySQL в Vagrant:

.. 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!')

Или просто с помощью CLI:

.. code-block:: console

(bash)$ python -m sshtunnel -U vagrant -P vagrant -L :3306 -R 127.0.0.1:3306 -p 2222 localhost

Пример 4

Открытие SSH-сессии с перескоком через два туннеля. SSH-транспорт и туннели будут демонизированы, что не будет ждать остановки соединений при закрытии.

.. 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

::

$ sshtunnel --help
usage: sshtunnel [-h] [-U SSH_USERNAME] [-p SSH_PORT] [-P SSH_PASSWORD] -R
                 IP:PORT [IP:PORT ...] [-L [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 ...]]
                 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