122
126
elif 'SSH Secure Shell' in version:
123
127
trace.mutter('ssh implementation is SSH Corp.')
124
128
vendor = SSHCorpSubprocessVendor()
125
elif 'plink' in version and args[0] == 'plink':
129
elif 'lsh' in version:
130
trace.mutter('ssh implementation is GNU lsh.')
131
vendor = LSHSubprocessVendor()
132
# As plink user prompts are not handled currently, don't auto-detect
133
# it by inspection below, but keep this vendor detection for if a path
134
# is given in BZR_SSH. See https://bugs.launchpad.net/bugs/414743
135
elif 'plink' in version and progname == 'plink':
126
136
# Checking if "plink" was the executed argument as Windows
127
# sometimes reports 'ssh -V' incorrectly with 'plink' in it's
137
# sometimes reports 'ssh -V' incorrectly with 'plink' in its
128
138
# version. See https://bugs.launchpad.net/bzr/+bug/107155
129
139
trace.mutter("ssh implementation is Putty's plink.")
130
140
vendor = PLinkSubprocessVendor()
133
143
def _get_vendor_by_inspection(self):
134
144
"""Return the vendor or None by checking for known SSH implementations."""
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:
145
version = self._get_ssh_version_string(['ssh', '-V'])
146
return self._get_vendor_by_version_string(version, "ssh")
148
def _get_vendor_from_path(self, path):
149
"""Return the vendor or None using the program at the given path"""
150
version = self._get_ssh_version_string([path, '-V'])
151
return self._get_vendor_by_version_string(version,
152
os.path.splitext(os.path.basename(path))[0])
142
154
def get_vendor(self, environment=None):
143
155
"""Find out what version of SSH is on the system.
336
339
self._raise_connection_error(host, port=port, orig_error=e,
337
340
msg='Unable to invoke remote bzr')
342
_ssh_connection_errors = (EOFError, OSError, IOError, socket.error)
339
343
if paramiko is not None:
340
344
vendor = ParamikoVendor()
341
345
register_ssh_vendor('paramiko', vendor)
342
346
register_ssh_vendor('none', vendor)
343
347
register_default_ssh_vendor(vendor)
344
_sftp_connection_errors = (EOFError, paramiko.SSHException)
348
_ssh_connection_errors += (paramiko.SSHException,)
347
_sftp_connection_errors = (EOFError,)
350
352
class SubprocessVendor(SSHVendor):
351
353
"""Abstract base class for vendors that use pipes to a subprocess."""
353
355
def _connect(self, argv):
354
proc = subprocess.Popen(argv,
355
stdin=subprocess.PIPE,
356
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
osutils.set_fd_cloexec(my_sock)
363
except (AttributeError, socket.error):
364
# This platform doesn't support socketpair(), so just use ordinary
366
stdin = stdout = subprocess.PIPE
367
my_sock, subproc_sock = None, None
369
stdin = stdout = subproc_sock
370
proc = subprocess.Popen(argv, stdin=stdin, stdout=stdout,
357
371
**os_specific_subprocess_params())
358
return SSHSubprocess(proc)
372
if subproc_sock is not None:
374
return SSHSubprocessConnection(proc, sock=my_sock)
360
376
def connect_sftp(self, username, password, host, port):
363
379
subsystem='sftp')
364
380
sock = self._connect(argv)
365
381
return SFTPClient(SocketAsChannelAdapter(sock))
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,):
382
except _ssh_connection_errors, e:
374
383
self._raise_connection_error(host, port=port, orig_error=e)
376
385
def connect_ssh(self, username, password, host, port, command):
378
387
argv = self._get_vendor_specific_argv(username, host, port,
380
389
return self._connect(argv)
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,):
390
except _ssh_connection_errors, e:
389
391
self._raise_connection_error(host, port=port, orig_error=e)
391
393
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
393
395
"""Returns the argument list to run the subprocess with.
395
397
Exactly one of 'subsystem' and 'command' must be specified.
397
399
raise NotImplementedError(self._get_vendor_specific_argv)
400
402
class OpenSSHSubprocessVendor(SubprocessVendor):
401
403
"""SSH vendor that uses the 'ssh' executable from OpenSSH."""
405
executable_path = 'ssh'
403
407
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
409
args = [self.executable_path,
406
410
'-oForwardX11=no', '-oForwardAgent=no',
407
'-oClearAllForwardings=yes', '-oProtocol=2',
411
'-oClearAllForwardings=yes',
408
412
'-oNoHostAuthenticationForLocalhost=yes']
409
413
if port is not None:
410
414
args.extend(['-p', str(port)])
435
441
args.extend([host] + command)
438
register_ssh_vendor('ssh', SSHCorpSubprocessVendor())
444
register_ssh_vendor('sshcorp', SSHCorpSubprocessVendor())
447
class LSHSubprocessVendor(SubprocessVendor):
448
"""SSH vendor that uses the 'lsh' executable from GNU"""
450
executable_path = 'lsh'
452
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
454
args = [self.executable_path]
456
args.extend(['-p', str(port)])
457
if username is not None:
458
args.extend(['-l', username])
459
if subsystem is not None:
460
args.extend(['--subsystem', subsystem, host])
462
args.extend([host] + command)
465
register_ssh_vendor('lsh', LSHSubprocessVendor())
441
468
class PLinkSubprocessVendor(SubprocessVendor):
442
469
"""SSH vendor that uses the 'plink' executable from Putty."""
471
executable_path = 'plink'
444
473
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
446
args = ['plink', '-x', '-a', '-ssh', '-2', '-batch']
475
args = [self.executable_path, '-x', '-a', '-ssh', '-2', '-batch']
447
476
if port is not None:
448
477
args.extend(['-P', str(port)])
449
478
if username is not None:
460
489
def _paramiko_auth(username, password, host, port, paramiko_transport):
461
# paramiko requires a username, but it might be none if nothing was supplied
462
# use the local username, just in case.
463
# We don't override username, because if we aren't using paramiko,
464
# the username might be specified in ~/.ssh/config and we don't want to
465
# force it to something else
466
# Also, it would mess up the self.relpath() functionality
467
490
auth = config.AuthenticationConfig()
491
# paramiko requires a username, but it might be none if nothing was
492
# supplied. If so, use the local username.
468
493
if username is None:
469
username = auth.get_user('ssh', host, port=port)
471
# Default to local user
472
username = getpass.getuser()
494
username = auth.get_user('ssh', host, port=port,
495
default=getpass.getuser())
474
496
if _use_ssh_agent:
475
497
agent = paramiko.Agent()
476
498
for key in agent.get_keys():
488
510
if _try_pkey_auth(paramiko_transport, paramiko.DSSKey, username, 'id_dsa'):
513
# If we have gotten this far, we are about to try for passwords, do an
514
# auth_none check to see if it is even supported.
515
supported_auth_types = []
517
# Note that with paramiko <1.7.5 this logs an INFO message:
518
# Authentication type (none) not permitted.
519
# So we explicitly disable the logging level for this action
520
old_level = paramiko_transport.logger.level
521
paramiko_transport.logger.setLevel(logging.WARNING)
523
paramiko_transport.auth_none(username)
525
paramiko_transport.logger.setLevel(old_level)
526
except paramiko.BadAuthenticationType, e:
527
# Supported methods are in the exception
528
supported_auth_types = e.allowed_types
529
except paramiko.SSHException, e:
530
# Don't know what happened, but just ignore it
532
# We treat 'keyboard-interactive' and 'password' auth methods identically,
533
# because Paramiko's auth_password method will automatically try
534
# 'keyboard-interactive' auth (using the password as the response) if
535
# 'password' auth is not available. Apparently some Debian and Gentoo
536
# OpenSSH servers require this.
537
# XXX: It's possible for a server to require keyboard-interactive auth that
538
# requires something other than a single password, but we currently don't
540
if ('password' not in supported_auth_types and
541
'keyboard-interactive' not in supported_auth_types):
542
raise errors.ConnectionError('Unable to authenticate to SSH host as'
543
'\n %s@%s\nsupported auth types: %s'
544
% (username, host, supported_auth_types))
493
548
paramiko_transport.auth_password(username, password)
498
553
# give up and ask for a password
499
554
password = auth.get_password('ssh', host, username, port=port)
501
paramiko_transport.auth_password(username, password)
502
except paramiko.SSHException, e:
503
raise errors.ConnectionError(
504
'Unable to authenticate to SSH host as %s@%s' % (username, host), e)
555
# get_password can still return None, which means we should not prompt
556
if password is not None:
558
paramiko_transport.auth_password(username, password)
559
except paramiko.SSHException, e:
560
raise errors.ConnectionError(
561
'Unable to authenticate to SSH host as'
562
'\n %s@%s\n' % (username, host), e)
564
raise errors.ConnectionError('Unable to authenticate to SSH host as'
565
' %s@%s' % (username, host))
507
568
def _try_pkey_auth(paramiko_transport, pkey_class, username, filename):
581
643
# this causes it to be seen only by bzr and not by ssh. Python will
582
644
# generate a KeyboardInterrupt in bzr, and we will then have a chance
583
645
# to release locks or do other cleanup over ssh before the connection
585
647
# <https://launchpad.net/products/bzr/+bug/5987>
587
649
# Running it in a separate process group is not good because then it
588
650
# can't get non-echoed input of a password or passphrase.
589
651
# <https://launchpad.net/products/bzr/+bug/40508>
590
return {'preexec_fn': _ignore_sigint,
652
return {'preexec_fn': _ignore_signals,
591
653
'close_fds': True,
595
class SSHSubprocess(object):
596
"""A socket-like object that talks to an ssh subprocess via pipes."""
598
def __init__(self, proc):
657
_subproc_weakrefs = set()
659
def _close_ssh_proc(proc, sock):
660
"""Carefully close stdin/stdout and reap the SSH process.
662
If the pipes are already closed and/or the process has already been
663
wait()ed on, that's ok, and no error is raised. The goal is to do our best
664
to clean up (whether or not a clean up was already tried).
667
for closeable in (proc.stdin, proc.stdout, sock):
668
# We expect that either proc (a subprocess.Popen) will have stdin and
669
# stdout streams to close, or that we will have been passed a socket to
670
# close, with the option not in use being None.
671
if closeable is not None:
672
funcs.append(closeable.close)
673
funcs.append(proc.wait)
678
# It's ok for the pipe to already be closed, or the process to
679
# already be finished.
683
class SSHConnection(object):
684
"""Abstract base class for SSH connections."""
686
def get_sock_or_pipes(self):
687
"""Returns a (kind, io_object) pair.
689
If kind == 'socket', then io_object is a socket.
691
If kind == 'pipes', then io_object is a pair of file-like objects
692
(read_from, write_to).
694
raise NotImplementedError(self.get_sock_or_pipes)
697
raise NotImplementedError(self.close)
700
class SSHSubprocessConnection(SSHConnection):
701
"""A connection to an ssh subprocess via pipes or a socket.
703
This class is also socket-like enough to be used with
704
SocketAsChannelAdapter (it has 'send' and 'recv' methods).
707
def __init__(self, proc, sock=None):
710
:param proc: a subprocess.Popen
711
:param sock: if proc.stdin/out is a socket from a socketpair, then sock
712
should bzrlib's half of that socketpair. If not passed, proc's
713
stdin/out is assumed to be ordinary pipes.
717
# Add a weakref to proc that will attempt to do the same as self.close
718
# to avoid leaving processes lingering indefinitely.
720
_subproc_weakrefs.remove(ref)
721
_close_ssh_proc(proc, sock)
722
_subproc_weakrefs.add(weakref.ref(self, terminate))
601
724
def send(self, data):
602
return os.write(self.proc.stdin.fileno(), data)
725
if self._sock is not None:
726
return self._sock.send(data)
728
return os.write(self.proc.stdin.fileno(), data)
604
730
def recv(self, count):
605
return os.read(self.proc.stdout.fileno(), count)
608
self.proc.stdin.close()
609
self.proc.stdout.close()
612
def get_filelike_channels(self):
613
return (self.proc.stdout, self.proc.stdin)
731
if self._sock is not None:
732
return self._sock.recv(count)
734
return os.read(self.proc.stdout.fileno(), count)
737
_close_ssh_proc(self.proc, self._sock)
739
def get_sock_or_pipes(self):
740
if self._sock is not None:
741
return 'socket', self._sock
743
return 'pipes', (self.proc.stdout, self.proc.stdin)
746
class _ParamikoSSHConnection(SSHConnection):
747
"""An SSH connection via paramiko."""
749
def __init__(self, channel):
750
self.channel = channel
752
def get_sock_or_pipes(self):
753
return ('socket', self.channel)
756
return self.channel.close()
added
removed
bzrlib/transport/ssh.py
