Skip to content

Add passthrough for Paramiko Transport kwargs #279

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jciskey wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add passthrough for Paramiko Transport kwargs #279

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions sshtunnel.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
input_ = input


__version__ = '0.4.0'
__version__ = '0.4.1'
__author__ = 'pahaz'


Expand Down Expand Up @@ -684,6 +684,16 @@ class SSHTunnelForwarder(object):

.. versionadded:: 0.0.3

paramiko_transport_kwargs (dict or None):
Dictionary of kwargs that are passed directly into the
:class:`paramiko.Transport` constructor. This can be used
to override the Transport configuration, such as if you
need to use the disabled_algorithms parameter.

Default: ``None``

.. versionadded:: 0.4.1

ssh_address (str):
Superseded by ``ssh_address_or_host``, tuple of type (str, int)
representing the IP and port of ``REMOTE SERVER``
Expand Down Expand Up @@ -901,6 +911,7 @@ def __init__(
compression=None,
allow_agent=True, # look for keys from an SSH agent
host_pkey_directories=None, # look for keys in ~/.ssh
paramiko_transport_kwargs=None, # allow passthrough arguments to the underlying Paramiko.Transport when created
*args,
**kwargs # for backwards compatibility
):
Expand Down Expand Up @@ -975,6 +986,10 @@ def __init__(
check_host(self.ssh_host)
check_port(self.ssh_port)

self._paramiko_transport_kwargs = {}
if paramiko_transport_kwargs is not None:
self._paramiko_transport_kwargs = paramiko_transport_kwargs

self.logger.info("Connecting to gateway: {0}:{1} as user '{2}'"
.format(self.ssh_host,
self.ssh_port,
Expand Down Expand Up @@ -1189,7 +1204,7 @@ def _get_transport(self):
if isinstance(_socket, socket.socket):
_socket.settimeout(SSH_TIMEOUT)
_socket.connect((self.ssh_host, self.ssh_port))
transport = paramiko.Transport(_socket)
transport = paramiko.Transport(_socket, **self._paramiko_transport_kwargs)
sock = transport.sock
if isinstance(sock, socket.socket):
sock.settimeout(SSH_TIMEOUT)
Expand Down