1
# Copyright (C) 2005 Robey Pointer <robey@lag.net>
1
# Copyright (C) 2006-2010 Robey Pointer <robey@lag.net>
2
2
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
4
4
# This program is free software; you can redistribute it and/or modify
126
126
elif 'SSH Secure Shell' in version:
127
127
trace.mutter('ssh implementation is SSH Corp.')
128
128
vendor = SSHCorpSubprocessVendor()
129
elif 'lsh' in version:
130
trace.mutter('ssh implementation is GNU lsh.')
131
vendor = LSHSubprocessVendor()
129
132
# As plink user prompts are not handled currently, don't auto-detect
130
133
# it by inspection below, but keep this vendor detection for if a path
131
134
# is given in BZR_SSH. See https://bugs.launchpad.net/bugs/414743
132
135
elif 'plink' in version and progname == 'plink':
133
136
# Checking if "plink" was the executed argument as Windows
134
# sometimes reports 'ssh -V' incorrectly with 'plink' in it's
137
# sometimes reports 'ssh -V' incorrectly with 'plink' in its
135
138
# version. See https://bugs.launchpad.net/bzr/+bug/107155
136
139
trace.mutter("ssh implementation is Putty's plink.")
137
140
vendor = PLinkSubprocessVendor()
173
176
register_ssh_vendor = _ssh_vendor_manager.register_vendor
176
def _ignore_sigint():
179
def _ignore_signals():
177
180
# TODO: This should possibly ignore SIGHUP as well, but bzr currently
178
181
# doesn't handle it itself.
179
182
# <https://launchpad.net/products/bzr/+bug/41433/+index>
181
184
signal.signal(signal.SIGINT, signal.SIG_IGN)
185
# GZ 2010-02-19: Perhaps make this check if breakin is installed instead
186
if signal.getsignal(signal.SIGQUIT) != signal.SIG_DFL:
187
signal.signal(signal.SIGQUIT, signal.SIG_IGN)
184
190
class SocketAsChannelAdapter(object):
236
242
def connect_ssh(self, username, password, host, port, command):
237
243
"""Make an SSH connection.
239
:returns: something with a `close` method, and a `get_filelike_channels`
240
method that returns a pair of (read, write) filelike objects.
245
:returns: an SSHConnection.
242
247
raise NotImplementedError(self.connect_ssh)
266
271
register_ssh_vendor('loopback', LoopbackVendor())
269
class _ParamikoSSHConnection(object):
270
def __init__(self, channel):
271
self.channel = channel
273
def get_filelike_channels(self):
274
return self.channel.makefile('rb'), self.channel.makefile('wb')
277
return self.channel.close()
280
274
class ParamikoVendor(SSHVendor):
281
275
"""Vendor that uses paramiko."""
345
339
self._raise_connection_error(host, port=port, orig_error=e,
346
340
msg='Unable to invoke remote bzr')
342
_ssh_connection_errors = (EOFError, OSError, IOError, socket.error)
348
343
if paramiko is not None:
349
344
vendor = ParamikoVendor()
350
345
register_ssh_vendor('paramiko', vendor)
351
346
register_ssh_vendor('none', vendor)
352
347
register_default_ssh_vendor(vendor)
353
_sftp_connection_errors = (EOFError, paramiko.SSHException)
348
_ssh_connection_errors += (paramiko.SSHException,)
356
_sftp_connection_errors = (EOFError,)
359
352
class SubprocessVendor(SSHVendor):
360
353
"""Abstract base class for vendors that use pipes to a subprocess."""
362
355
def _connect(self, argv):
363
proc = subprocess.Popen(argv,
364
stdin=subprocess.PIPE,
365
stdout=subprocess.PIPE,
356
# Attempt to make a socketpair to use as stdin/stdout for the SSH
357
# subprocess. We prefer sockets to pipes because they support
358
# non-blocking short reads, allowing us to optimistically read 64k (or
361
my_sock, subproc_sock = socket.socketpair()
362
except (AttributeError, socket.error):
363
# This platform doesn't support socketpair(), so just use ordinary
365
stdin = stdout = subprocess.PIPE
368
stdin = stdout = subproc_sock
370
proc = subprocess.Popen(argv, stdin=stdin, stdout=stdout,
366
371
**os_specific_subprocess_params())
367
return SSHSubprocess(proc)
372
return SSHSubprocessConnection(proc, sock=sock)
369
374
def connect_sftp(self, username, password, host, port):
372
377
subsystem='sftp')
373
378
sock = self._connect(argv)
374
379
return SFTPClient(SocketAsChannelAdapter(sock))
375
except _sftp_connection_errors, e:
376
self._raise_connection_error(host, port=port, orig_error=e)
377
except (OSError, IOError), e:
378
# If the machine is fast enough, ssh can actually exit
379
# before we try and send it the sftp request, which
380
# raises a Broken Pipe
381
if e.errno not in (errno.EPIPE,):
380
except _ssh_connection_errors, e:
383
381
self._raise_connection_error(host, port=port, orig_error=e)
385
383
def connect_ssh(self, username, password, host, port, command):
387
385
argv = self._get_vendor_specific_argv(username, host, port,
389
387
return self._connect(argv)
390
except (EOFError), e:
391
self._raise_connection_error(host, port=port, orig_error=e)
392
except (OSError, IOError), e:
393
# If the machine is fast enough, ssh can actually exit
394
# before we try and send it the sftp request, which
395
# raises a Broken Pipe
396
if e.errno not in (errno.EPIPE,):
388
except _ssh_connection_errors, e:
398
389
self._raise_connection_error(host, port=port, orig_error=e)
400
391
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
416
407
args = [self.executable_path,
417
408
'-oForwardX11=no', '-oForwardAgent=no',
418
'-oClearAllForwardings=yes', '-oProtocol=2',
409
'-oClearAllForwardings=yes',
419
410
'-oNoHostAuthenticationForLocalhost=yes']
420
411
if port is not None:
421
412
args.extend(['-p', str(port)])
451
442
register_ssh_vendor('sshcorp', SSHCorpSubprocessVendor())
445
class LSHSubprocessVendor(SubprocessVendor):
446
"""SSH vendor that uses the 'lsh' executable from GNU"""
448
executable_path = 'lsh'
450
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
452
args = [self.executable_path]
454
args.extend(['-p', str(port)])
455
if username is not None:
456
args.extend(['-l', username])
457
if subsystem is not None:
458
args.extend(['--subsystem', subsystem, host])
460
args.extend([host] + command)
463
register_ssh_vendor('lsh', LSHSubprocessVendor())
454
466
class PLinkSubprocessVendor(SubprocessVendor):
455
467
"""SSH vendor that uses the 'plink' executable from Putty."""
634
646
# Running it in a separate process group is not good because then it
635
647
# can't get non-echoed input of a password or passphrase.
636
648
# <https://launchpad.net/products/bzr/+bug/40508>
637
return {'preexec_fn': _ignore_sigint,
649
return {'preexec_fn': _ignore_signals,
638
650
'close_fds': True,
642
654
_subproc_weakrefs = set()
644
656
def _close_ssh_proc(proc):
645
for func in [proc.stdin.close, proc.stdout.close, proc.wait]:
657
"""Carefully close stdin/stdout and reap the SSH process.
659
If the pipes are already closed and/or the process has already been
660
wait()ed on, that's ok, and no error is raised. The goal is to do our best
661
to clean up (whether or not a clean up was already tried).
663
dotted_names = ['stdin.close', 'stdout.close', 'wait']
664
for dotted_name in dotted_names:
665
attrs = dotted_name.split('.')
669
obj = getattr(obj, attr)
670
except AttributeError:
671
# It's ok for proc.stdin or proc.stdout to be None.
652
class SSHSubprocess(object):
653
"""A socket-like object that talks to an ssh subprocess via pipes."""
655
def __init__(self, proc):
676
# It's ok for the pipe to already be closed, or the process to
677
# already be finished.
681
class SSHConnection(object):
682
"""Abstract base class for SSH connections."""
684
def get_sock_or_pipes(self):
685
"""Returns a (kind, io_object) pair.
687
If kind == 'socket', then io_object is a socket.
689
If kind == 'pipes', then io_object is a pair of file-like objects
690
(read_from, write_to).
692
raise NotImplementedError(self.get_sock_or_pipes)
695
raise NotImplementedError(self.close)
698
class SSHSubprocessConnection(SSHConnection):
699
"""A connection to an ssh subprocess via pipes or a socket.
701
This class is also socket-like enough to be used with
702
SocketAsChannelAdapter (it has 'send' and 'recv' methods).
705
def __init__(self, proc, sock=None):
708
:param proc: a subprocess.Popen
709
:param sock: if proc.stdin/out is a socket from a socketpair, then sock
710
should bzrlib's half of that socketpair. If not passed, proc's
711
stdin/out is assumed to be ordinary pipes.
657
715
# Add a weakref to proc that will attempt to do the same as self.close
658
716
# to avoid leaving processes lingering indefinitely.
659
717
def terminate(ref):
662
720
_subproc_weakrefs.add(weakref.ref(self, terminate))
664
722
def send(self, data):
665
return os.write(self.proc.stdin.fileno(), data)
723
if self._sock is not None:
724
return self._sock.send(data)
726
return os.write(self.proc.stdin.fileno(), data)
667
728
def recv(self, count):
668
return os.read(self.proc.stdout.fileno(), count)
729
if self._sock is not None:
730
return self._sock.recv(count)
732
return os.read(self.proc.stdout.fileno(), count)
671
735
_close_ssh_proc(self.proc)
673
def get_filelike_channels(self):
674
return (self.proc.stdout, self.proc.stdin)
737
def get_sock_or_pipes(self):
738
if self._sock is not None:
739
return 'socket', self._sock
741
return 'pipes', (self.proc.stdout, self.proc.stdin)
744
class _ParamikoSSHConnection(SSHConnection):
745
"""An SSH connection via paramiko."""
747
def __init__(self, channel):
748
self.channel = channel
750
def get_sock_or_pipes(self):
751
return ('socket', self.channel)
754
return self.channel.close()
added
removed
bzrlib/transport/ssh.py
