126
123
elif 'SSH Secure Shell' in version:
127
124
trace.mutter('ssh implementation is SSH Corp.')
128
125
vendor = SSHCorpSubprocessVendor()
129
# As plink user prompts are not handled currently, don't auto-detect
130
# it by inspection below, but keep this vendor detection for if a path
131
# is given in BZR_SSH. See https://bugs.launchpad.net/bugs/414743
132
elif 'plink' in version and progname == 'plink':
133
# Checking if "plink" was the executed argument as Windows
134
# sometimes reports 'ssh -V' incorrectly with 'plink' in it's
135
# version. See https://bugs.launchpad.net/bzr/+bug/107155
136
trace.mutter("ssh implementation is Putty's plink.")
137
vendor = PLinkSubprocessVendor()
126
# Auto-detect of plink vendor disabled, on Windows recommended
127
# default ssh-client is paramiko
128
# see https://bugs.launchpad.net/bugs/414743
129
#~elif 'plink' in version and args[0] == 'plink':
130
#~ # Checking if "plink" was the executed argument as Windows
131
#~ # sometimes reports 'ssh -V' incorrectly with 'plink' in it's
132
#~ # version. See https://bugs.launchpad.net/bzr/+bug/107155
133
#~ trace.mutter("ssh implementation is Putty's plink.")
134
#~ vendor = PLinkSubprocessVendor()
140
137
def _get_vendor_by_inspection(self):
141
138
"""Return the vendor or None by checking for known SSH implementations."""
142
version = self._get_ssh_version_string(['ssh', '-V'])
143
return self._get_vendor_by_version_string(version, "ssh")
145
def _get_vendor_from_path(self, path):
146
"""Return the vendor or None using the program at the given path"""
147
version = self._get_ssh_version_string([path, '-V'])
148
return self._get_vendor_by_version_string(version,
149
os.path.splitext(os.path.basename(path))[0])
139
for args in (['ssh', '-V'], ['plink', '-V']):
140
version = self._get_ssh_version_string(args)
141
vendor = self._get_vendor_by_version_string(version, args)
142
if vendor is not None:
151
146
def get_vendor(self, environment=None):
152
147
"""Find out what version of SSH is on the system.
173
168
register_ssh_vendor = _ssh_vendor_manager.register_vendor
176
def _ignore_signals():
171
def _ignore_sigint():
177
172
# TODO: This should possibly ignore SIGHUP as well, but bzr currently
178
173
# doesn't handle it itself.
179
174
# <https://launchpad.net/products/bzr/+bug/41433/+index>
181
176
signal.signal(signal.SIGINT, signal.SIG_IGN)
182
# GZ 2010-02-19: Perhaps make this check if breakin is installed instead
183
if signal.getsignal(signal.SIGQUIT) != signal.SIG_DFL:
184
signal.signal(signal.SIGQUIT, signal.SIG_IGN)
187
179
class SocketAsChannelAdapter(object):
351
355
"""Abstract base class for vendors that use pipes to a subprocess."""
353
357
def _connect(self, argv):
354
# Attempt to make a socketpair to use as stdin/stdout for the SSH
355
# subprocess. We prefer sockets to pipes because they support
356
# non-blocking short reads, allowing us to optimistically read 64k (or
359
my_sock, subproc_sock = socket.socketpair()
360
except (AttributeError, socket.error):
361
# This platform doesn't support socketpair(), so just use ordinary
363
stdin = stdout = subprocess.PIPE
366
stdin = stdout = subproc_sock
368
proc = subprocess.Popen(argv, stdin=stdin, stdout=stdout,
358
proc = subprocess.Popen(argv,
359
stdin=subprocess.PIPE,
360
stdout=subprocess.PIPE,
369
361
**os_specific_subprocess_params())
370
return SSHSubprocessConnection(proc, sock=sock)
362
return SSHSubprocess(proc)
372
364
def connect_sftp(self, username, password, host, port):
412
404
class OpenSSHSubprocessVendor(SubprocessVendor):
413
405
"""SSH vendor that uses the 'ssh' executable from OpenSSH."""
415
executable_path = 'ssh'
417
407
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
419
args = [self.executable_path,
420
410
'-oForwardX11=no', '-oForwardAgent=no',
421
411
'-oClearAllForwardings=yes', '-oProtocol=2',
422
412
'-oNoHostAuthenticationForLocalhost=yes']
451
439
args.extend([host] + command)
454
register_ssh_vendor('sshcorp', SSHCorpSubprocessVendor())
442
register_ssh_vendor('ssh', SSHCorpSubprocessVendor())
457
445
class PLinkSubprocessVendor(SubprocessVendor):
458
446
"""SSH vendor that uses the 'plink' executable from Putty."""
460
executable_path = 'plink'
462
448
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
464
args = [self.executable_path, '-x', '-a', '-ssh', '-2', '-batch']
450
args = ['plink', '-x', '-a', '-ssh', '-2', '-batch']
465
451
if port is not None:
466
452
args.extend(['-P', str(port)])
467
453
if username is not None:
637
623
# Running it in a separate process group is not good because then it
638
624
# can't get non-echoed input of a password or passphrase.
639
625
# <https://launchpad.net/products/bzr/+bug/40508>
640
return {'preexec_fn': _ignore_signals,
626
return {'preexec_fn': _ignore_sigint,
641
627
'close_fds': True,
645
_subproc_weakrefs = set()
647
def _close_ssh_proc(proc):
648
for func in [proc.stdin.close, proc.stdout.close, proc.wait]:
655
class SSHConnection(object):
656
"""Abstract base class for SSH connections."""
658
def get_sock_or_pipes(self):
659
"""Returns a (kind, io_object) pair.
661
If kind == 'socket', then io_object is a socket.
663
If kind == 'pipes', then io_object is a pair of file-like objects
664
(read_from, write_to).
666
raise NotImplementedError(self.get_sock_or_pipes)
669
raise NotImplementedError(self.close)
672
class SSHSubprocessConnection(SSHConnection):
673
"""A connection to an ssh subprocess via pipes or a socket.
675
This class is also socket-like enough to be used with
676
SocketAsChannelAdapter (it has 'send' and 'recv' methods).
679
def __init__(self, proc, sock=None):
682
:param proc: a subprocess.Popen
683
:param sock: if proc.stdin/out is a socket from a socketpair, then sock
684
should bzrlib's half of that socketpair. If not passed, proc's
685
stdin/out is assumed to be ordinary pipes.
631
class SSHSubprocess(object):
632
"""A socket-like object that talks to an ssh subprocess via pipes."""
634
def __init__(self, proc):
689
# Add a weakref to proc that will attempt to do the same as self.close
690
# to avoid leaving processes lingering indefinitely.
692
_subproc_weakrefs.remove(ref)
693
_close_ssh_proc(proc)
694
_subproc_weakrefs.add(weakref.ref(self, terminate))
696
637
def send(self, data):
697
if self._sock is not None:
698
return self._sock.send(data)
700
return os.write(self.proc.stdin.fileno(), data)
638
return os.write(self.proc.stdin.fileno(), data)
702
640
def recv(self, count):
703
if self._sock is not None:
704
return self._sock.recv(count)
706
return os.read(self.proc.stdout.fileno(), count)
709
_close_ssh_proc(self.proc)
711
def get_sock_or_pipes(self):
712
if self._sock is not None:
713
return 'socket', self._sock
715
return 'pipes', (self.proc.stdout, self.proc.stdin)
718
class _ParamikoSSHConnection(SSHConnection):
719
"""An SSH connection via paramiko."""
721
def __init__(self, channel):
722
self.channel = channel
724
def get_sock_or_pipes(self):
725
return ('socket', self.channel)
728
return self.channel.close()
641
return os.read(self.proc.stdout.fileno(), count)
644
self.proc.stdin.close()
645
self.proc.stdout.close()
648
def get_filelike_channels(self):
649
return (self.proc.stdout, self.proc.stdin)