# Copyright (C) 2012 Yipit, Inc <coders@yipit.com> # # This file is part of paramiko. # # Paramiko is free software; you can redistribute it and/or modify it under the # terms of the GNU Lesser General Public License as published by the Free # Software Foundation; either version 2.1 of the License, or (at your option) # any later version. # # Paramiko is distrubuted in the hope that it will be useful, but WITHOUT ANY # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR # A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more # details. # # You should have received a copy of the GNU Lesser General Public License # along with Paramiko; if not, write to the Free Software Foundation, Inc., # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. import os from shlex import split as shlsplit import signal from select import select import socket import time from paramiko.ssh_exception import ProxyCommandFailure from paramiko.util import ClosingContextManager class ProxyCommand(ClosingContextManager): """ Wraps a subprocess running ProxyCommand-driven programs. This class implements a the socket-like interface needed by the `.Transport` and `.Packetizer` classes. Using this class instead of a regular socket makes it possible to talk with a Popen'd command that will proxy traffic between the client and a server hosted in another machine. Instances of this class may be used as context managers. """ def __init__(self, command_line): """ Create a new CommandProxy instance. The instance created by this class can be passed as an argument to the `.Transport` class. :param str command_line: the command that should be executed and used as the proxy. """ # NOTE: subprocess import done lazily so platforms without it (e.g. # GAE) can still import us during overall Paramiko load. from subprocess import Popen, PIPE self.cmd = shlsplit(command_line) self.process = Popen( self.cmd, stdin=PIPE, stdout=PIPE, stderr=PIPE, bufsize=0 ) self.timeout = None def send(self, content): """ Write the content received from the SSH client to the standard input of the forked command. :param str content: string to be sent to the forked command """ try: self.process.stdin.write(content) except IOError as e: # There was a problem with the child process. It probably # died and we can't proceed. The best option here is to # raise an exception informing the user that the informed # ProxyCommand is not working. raise ProxyCommandFailure(" ".join(self.cmd), e.strerror) return len(content) def recv(self, size): """ Read from the standard output of the forked program. :param int size: how many chars should be read :return: the string of bytes read, which may be shorter than requested """ try: buffer = b"" start = time.time() while len(buffer) < size: select_timeout = None if self.timeout is not None: elapsed = time.time() - start if elapsed >= self.timeout: raise socket.timeout() select_timeout = self.timeout - elapsed r, w, x = select([self.process.stdout], [], [], select_timeout) if r and r[0] == self.process.stdout: buffer += os.read( self.process.stdout.fileno(), size - len(buffer) ) return buffer except socket.timeout: if buffer: # Don't raise socket.timeout, return partial result instead return buffer raise # socket.timeout is a subclass of IOError except IOError as e: raise ProxyCommandFailure(" ".join(self.cmd), e.strerror) def close(self): os.kill(self.process.pid, signal.SIGTERM) @property def closed(self): return self.process.returncode is not None @property def _closed(self): # Concession to Python 3 socket-like API return self.closed def settimeout(self, timeout): self.timeout = timeout
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
__pycache__ | Folder | 0755 |
|
|
__init__.py | File | 3.76 KB | 0644 |
|
_version.py | File | 80 B | 0644 |
|
_winapi.py | File | 11.09 KB | 0644 |
|
agent.py | File | 12.46 KB | 0644 |
|
auth_handler.py | File | 31.19 KB | 0644 |
|
ber.py | File | 4.25 KB | 0644 |
|
buffered_pipe.py | File | 7.29 KB | 0644 |
|
channel.py | File | 48.18 KB | 0644 |
|
client.py | File | 31.32 KB | 0644 |
|
common.py | File | 8.04 KB | 0644 |
|
compress.py | File | 1.26 KB | 0644 |
|
config.py | File | 13.17 KB | 0644 |
|
dsskey.py | File | 7.65 KB | 0644 |
|
ecdsakey.py | File | 10.1 KB | 0644 |
|
ed25519key.py | File | 7.84 KB | 0644 |
|
file.py | File | 19.13 KB | 0644 |
|
hostkeys.py | File | 12.95 KB | 0644 |
|
kex_curve25519.py | File | 4.3 KB | 0644 |
|
kex_ecdh_nist.py | File | 4.86 KB | 0644 |
|
kex_gex.py | File | 10.06 KB | 0644 |
|
kex_group1.py | File | 5.6 KB | 0644 |
|
kex_group14.py | File | 1.79 KB | 0644 |
|
kex_group16.py | File | 2.23 KB | 0644 |
|
kex_gss.py | File | 24 KB | 0644 |
|
message.py | File | 8.8 KB | 0644 |
|
packet.py | File | 22.13 KB | 0644 |
|
pipe.py | File | 3.83 KB | 0644 |
|
pkey.py | File | 21.04 KB | 0644 |
|
primes.py | File | 5 KB | 0644 |
|
proxy.py | File | 4.34 KB | 0644 |
|
py3compat.py | File | 3.71 KB | 0644 |
|
rsakey.py | File | 5.84 KB | 0644 |
|
server.py | File | 29.7 KB | 0644 |
|
sftp.py | File | 5.89 KB | 0644 |
|
sftp_attr.py | File | 8.15 KB | 0644 |
|
sftp_client.py | File | 33.4 KB | 0644 |
|
sftp_file.py | File | 20.1 KB | 0644 |
|
sftp_handle.py | File | 7.26 KB | 0644 |
|
sftp_server.py | File | 19.14 KB | 0644 |
|
sftp_si.py | File | 12.28 KB | 0644 |
|
ssh_exception.py | File | 6.24 KB | 0644 |
|
ssh_gss.py | File | 28.22 KB | 0644 |
|
transport.py | File | 117.68 KB | 0644 |
|
util.py | File | 8.37 KB | 0644 |
|
win_pageant.py | File | 4.17 KB | 0644 |
|