
Túneles SSH hacia servidor remoto.
|Tests| |AppVeyor| |readthedocs| |coveralls| |version|
|pyversions| |license|
Autor: Pahaz_
Repositorio: https://github.com/pahaz/sshtunnel/
Inspirado por https://github.com/jmagnusson/bgtunnel, que no funciona en Windows.
Véase también: https://github.com/paramiko/paramiko/blob/master/demos/forward.py
paramiko_sshtunnel_ está en PyPI, así que simplemente ejecute:
::
pip install sshtunnel
o ::
easy_install sshtunnel
o ::
conda install -c conda-forge sshtunnel
para tenerlo instalado en su entorno.
Para instalar desde el código fuente, clone el
repositorio <https://github.com/pahaz/sshtunnel>_ y ejecute::
python setup.py install
Para ejecutar las pruebas primero necesita
tox <https://testrun.org/tox/latest/>_ y ejecutar::
python setup.py test
Uno de los escenarios típicos en los que sshtunnel resulta útil se muestra en la
figura siguiente. El usuario puede necesitar conectarse a un puerto de un servidor remoto (es decir, 8080)
donde solo el puerto SSH (normalmente el puerto 22) es accesible. ::
----------------------------------------------------------------------
|
-------------+ | +----------+
LOCAL | | | REMOTE | :22 SSH
CLIENT | <== SSH ========> | SERVER | :8080 web service
-------------+ | +----------+
|
FIREWALL (only port 22 is open)
----------------------------------------------------------------------
Fig1: Cómo conectarse a un servicio bloqueado por un firewall a través de un túnel SSH.
Si el servidor SSH lo permite, también es posible alcanzar un servidor privado
(desde la perspectiva del REMOTE SERVER) que no es directamente visible desde el
exterior (perspectiva del LOCAL CLIENT). ::
----------------------------------------------------------------------
|
-------------+ | +----------+ +---------
LOCAL | | | REMOTE | | PRIVATE
CLIENT | <== SSH ========> | SERVER | <== local ==> | SERVER
-------------+ | +----------+ +---------
|
FIREWALL (only port 443 is open)
----------------------------------------------------------------------
Fig2: Cómo conectarse a PRIVATE SERVER a través de un túnel SSH.
La API permite tanto inicializar el túnel y ponerlo en marcha como usar un contexto
with, que se encargará de iniciar y detener el túnel:
El código correspondiente a la Fig1 anterior se muestra a continuación, dado que la dirección del servidor remoto es
pahaz.urfuclub.ru, autenticación por contraseña y puerto de enlace local asignado aleatoriamente.
.. 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()
Ejemplo de un reenvío de puerto a un servidor privado no directamente accesible, asumiendo autenticación pkey protegida por contraseña, el servicio SSH del servidor remoto está escuchando en el puerto 443 y ese puerto está abierto en el 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!')
Ejemplo de un reenvío de puertos para el puerto local de MySQL en 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!')
O simplemente usando la CLI:
.. code-block:: console
(bash)$ python -m sshtunnel -U vagrant -P vagrant -L :3306 -R 127.0.0.1:3306 -p 2222 localhost
Apertura de una sesión SSH saltando sobre dos túneles. El transporte SSH y los túneles se ejecutarán como demonios, lo que no esperará a que las conexiones se detengan al cerrar.
.. 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(...)
::
$ 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.5.1
positional arguments:
ssh_address SSH server IP address (GW for SSH tunnels)
set with "-- ssh_address" if immediately after -R or -L