126
122
elif 'SSH Secure Shell' in version:
127
123
trace.mutter('ssh implementation is SSH Corp.')
128
124
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':
125
elif 'plink' in version and args[0] == 'plink':
133
126
# Checking if "plink" was the executed argument as Windows
134
# sometimes reports 'ssh -V' incorrectly with 'plink' in its
127
# sometimes reports 'ssh -V' incorrectly with 'plink' in it's
135
128
# version. See https://bugs.launchpad.net/bzr/+bug/107155
136
129
trace.mutter("ssh implementation is Putty's plink.")
137
130
vendor = PLinkSubprocessVendor()
140
133
def _get_vendor_by_inspection(self):
141
134
"""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])
135
for args in (['ssh', '-V'], ['plink', '-V']):
136
version = self._get_ssh_version_string(args)
137
vendor = self._get_vendor_by_version_string(version, args)
138
if vendor is not None:
151
142
def get_vendor(self, environment=None):
152
143
"""Find out what version of SSH is on the system.
336
336
self._raise_connection_error(host, port=port, orig_error=e,
337
337
msg='Unable to invoke remote bzr')
339
_ssh_connection_errors = (EOFError, OSError, IOError, socket.error)
340
339
if paramiko is not None:
341
340
vendor = ParamikoVendor()
342
341
register_ssh_vendor('paramiko', vendor)
343
342
register_ssh_vendor('none', vendor)
344
343
register_default_ssh_vendor(vendor)
345
_ssh_connection_errors += (paramiko.SSHException,)
344
_sftp_connection_errors = (EOFError, paramiko.SSHException)
347
_sftp_connection_errors = (EOFError,)
349
350
class SubprocessVendor(SSHVendor):
350
351
"""Abstract base class for vendors that use pipes to a subprocess."""
352
353
def _connect(self, argv):
353
# Attempt to make a socketpair to use as stdin/stdout for the SSH
354
# subprocess. We prefer sockets to pipes because they support
355
# non-blocking short reads, allowing us to optimistically read 64k (or
358
my_sock, subproc_sock = socket.socketpair()
359
except (AttributeError, socket.error):
360
# This platform doesn't support socketpair(), so just use ordinary
362
stdin = stdout = subprocess.PIPE
365
stdin = stdout = subproc_sock
367
proc = subprocess.Popen(argv, stdin=stdin, stdout=stdout,
354
proc = subprocess.Popen(argv,
355
stdin=subprocess.PIPE,
356
stdout=subprocess.PIPE,
368
357
**os_specific_subprocess_params())
369
return SSHSubprocessConnection(proc, sock=sock)
358
return SSHSubprocess(proc)
371
360
def connect_sftp(self, username, password, host, port):
374
363
subsystem='sftp')
375
364
sock = self._connect(argv)
376
365
return SFTPClient(SocketAsChannelAdapter(sock))
377
except _ssh_connection_errors, e:
366
except _sftp_connection_errors, e:
367
self._raise_connection_error(host, port=port, orig_error=e)
368
except (OSError, IOError), e:
369
# If the machine is fast enough, ssh can actually exit
370
# before we try and send it the sftp request, which
371
# raises a Broken Pipe
372
if e.errno not in (errno.EPIPE,):
378
374
self._raise_connection_error(host, port=port, orig_error=e)
380
376
def connect_ssh(self, username, password, host, port, command):
382
378
argv = self._get_vendor_specific_argv(username, host, port,
384
380
return self._connect(argv)
385
except _ssh_connection_errors, e:
381
except (EOFError), e:
382
self._raise_connection_error(host, port=port, orig_error=e)
383
except (OSError, IOError), e:
384
# If the machine is fast enough, ssh can actually exit
385
# before we try and send it the sftp request, which
386
# raises a Broken Pipe
387
if e.errno not in (errno.EPIPE,):
386
389
self._raise_connection_error(host, port=port, orig_error=e)
388
391
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
397
400
class OpenSSHSubprocessVendor(SubprocessVendor):
398
401
"""SSH vendor that uses the 'ssh' executable from OpenSSH."""
400
executable_path = 'ssh'
402
403
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
404
args = [self.executable_path,
405
406
'-oForwardX11=no', '-oForwardAgent=no',
406
407
'-oClearAllForwardings=yes', '-oProtocol=2',
407
408
'-oNoHostAuthenticationForLocalhost=yes']
436
435
args.extend([host] + command)
439
register_ssh_vendor('sshcorp', SSHCorpSubprocessVendor())
438
register_ssh_vendor('ssh', SSHCorpSubprocessVendor())
442
441
class PLinkSubprocessVendor(SubprocessVendor):
443
442
"""SSH vendor that uses the 'plink' executable from Putty."""
445
executable_path = 'plink'
447
444
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
449
args = [self.executable_path, '-x', '-a', '-ssh', '-2', '-batch']
446
args = ['plink', '-x', '-a', '-ssh', '-2', '-batch']
450
447
if port is not None:
451
448
args.extend(['-P', str(port)])
452
449
if username is not None:
484
481
if _try_pkey_auth(paramiko_transport, paramiko.DSSKey, username, 'id_dsa'):
487
# If we have gotten this far, we are about to try for passwords, do an
488
# auth_none check to see if it is even supported.
489
supported_auth_types = []
491
# Note that with paramiko <1.7.5 this logs an INFO message:
492
# Authentication type (none) not permitted.
493
# So we explicitly disable the logging level for this action
494
old_level = paramiko_transport.logger.level
495
paramiko_transport.logger.setLevel(logging.WARNING)
497
paramiko_transport.auth_none(username)
499
paramiko_transport.logger.setLevel(old_level)
500
except paramiko.BadAuthenticationType, e:
501
# Supported methods are in the exception
502
supported_auth_types = e.allowed_types
503
except paramiko.SSHException, e:
504
# Don't know what happened, but just ignore it
506
# We treat 'keyboard-interactive' and 'password' auth methods identically,
507
# because Paramiko's auth_password method will automatically try
508
# 'keyboard-interactive' auth (using the password as the response) if
509
# 'password' auth is not available. Apparently some Debian and Gentoo
510
# OpenSSH servers require this.
511
# XXX: It's possible for a server to require keyboard-interactive auth that
512
# requires something other than a single password, but we currently don't
514
if ('password' not in supported_auth_types and
515
'keyboard-interactive' not in supported_auth_types):
516
raise errors.ConnectionError('Unable to authenticate to SSH host as'
517
'\n %s@%s\nsupported auth types: %s'
518
% (username, host, supported_auth_types))
522
486
paramiko_transport.auth_password(username, password)
527
491
# give up and ask for a password
528
492
password = auth.get_password('ssh', host, username, port=port)
529
# get_password can still return None, which means we should not prompt
530
if password is not None:
532
paramiko_transport.auth_password(username, password)
533
except paramiko.SSHException, e:
534
raise errors.ConnectionError(
535
'Unable to authenticate to SSH host as'
536
'\n %s@%s\n' % (username, host), e)
538
raise errors.ConnectionError('Unable to authenticate to SSH host as'
539
' %s@%s' % (username, host))
494
paramiko_transport.auth_password(username, password)
495
except paramiko.SSHException, e:
496
raise errors.ConnectionError(
497
'Unable to authenticate to SSH host as %s@%s' % (username, host), e)
542
500
def _try_pkey_auth(paramiko_transport, pkey_class, username, filename):
622
580
# Running it in a separate process group is not good because then it
623
581
# can't get non-echoed input of a password or passphrase.
624
582
# <https://launchpad.net/products/bzr/+bug/40508>
625
return {'preexec_fn': _ignore_signals,
583
return {'preexec_fn': _ignore_sigint,
626
584
'close_fds': True,
630
_subproc_weakrefs = set()
632
def _close_ssh_proc(proc):
633
"""Carefully close stdin/stdout and reap the SSH process.
635
If the pipes are already closed and/or the process has already been
636
wait()ed on, that's ok, and no error is raised. The goal is to do our best
637
to clean up (whether or not a clean up was already tried).
639
dotted_names = ['stdin.close', 'stdout.close', 'wait']
640
for dotted_name in dotted_names:
641
attrs = dotted_name.split('.')
645
obj = getattr(obj, attr)
646
except AttributeError:
647
# It's ok for proc.stdin or proc.stdout to be None.
652
# It's ok for the pipe to already be closed, or the process to
653
# already be finished.
657
class SSHConnection(object):
658
"""Abstract base class for SSH connections."""
660
def get_sock_or_pipes(self):
661
"""Returns a (kind, io_object) pair.
663
If kind == 'socket', then io_object is a socket.
665
If kind == 'pipes', then io_object is a pair of file-like objects
666
(read_from, write_to).
668
raise NotImplementedError(self.get_sock_or_pipes)
671
raise NotImplementedError(self.close)
674
class SSHSubprocessConnection(SSHConnection):
675
"""A connection to an ssh subprocess via pipes or a socket.
677
This class is also socket-like enough to be used with
678
SocketAsChannelAdapter (it has 'send' and 'recv' methods).
681
def __init__(self, proc, sock=None):
684
:param proc: a subprocess.Popen
685
:param sock: if proc.stdin/out is a socket from a socketpair, then sock
686
should bzrlib's half of that socketpair. If not passed, proc's
687
stdin/out is assumed to be ordinary pipes.
588
class SSHSubprocess(object):
589
"""A socket-like object that talks to an ssh subprocess via pipes."""
591
def __init__(self, proc):
691
# Add a weakref to proc that will attempt to do the same as self.close
692
# to avoid leaving processes lingering indefinitely.
694
_subproc_weakrefs.remove(ref)
695
_close_ssh_proc(proc)
696
_subproc_weakrefs.add(weakref.ref(self, terminate))
698
594
def send(self, data):
699
if self._sock is not None:
700
return self._sock.send(data)
702
return os.write(self.proc.stdin.fileno(), data)
595
return os.write(self.proc.stdin.fileno(), data)
704
597
def recv(self, count):
705
if self._sock is not None:
706
return self._sock.recv(count)
708
return os.read(self.proc.stdout.fileno(), count)
711
_close_ssh_proc(self.proc)
713
def get_sock_or_pipes(self):
714
if self._sock is not None:
715
return 'socket', self._sock
717
return 'pipes', (self.proc.stdout, self.proc.stdin)
720
class _ParamikoSSHConnection(SSHConnection):
721
"""An SSH connection via paramiko."""
723
def __init__(self, channel):
724
self.channel = channel
726
def get_sock_or_pipes(self):
727
return ('socket', self.channel)
730
return self.channel.close()
598
return os.read(self.proc.stdout.fileno(), count)
601
self.proc.stdin.close()
602
self.proc.stdout.close()
605
def get_filelike_channels(self):
606
return (self.proc.stdout, self.proc.stdin)
added
removed
bzrlib/transport/ssh.py
