122
129
elif 'SSH Secure Shell' in version:
123
130
trace.mutter('ssh implementation is SSH Corp.')
124
131
vendor = SSHCorpSubprocessVendor()
125
elif 'plink' in version and args[0] == 'plink':
132
elif 'lsh' in version:
133
trace.mutter('ssh implementation is GNU lsh.')
134
vendor = LSHSubprocessVendor()
135
# As plink user prompts are not handled currently, don't auto-detect
136
# it by inspection below, but keep this vendor detection for if a path
137
# is given in BZR_SSH. See https://bugs.launchpad.net/bugs/414743
138
elif 'plink' in version and progname == 'plink':
126
139
# Checking if "plink" was the executed argument as Windows
127
# sometimes reports 'ssh -V' incorrectly with 'plink' in it's
140
# sometimes reports 'ssh -V' incorrectly with 'plink' in its
128
141
# version. See https://bugs.launchpad.net/bzr/+bug/107155
129
142
trace.mutter("ssh implementation is Putty's plink.")
130
143
vendor = PLinkSubprocessVendor()
133
146
def _get_vendor_by_inspection(self):
134
147
"""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:
148
version = self._get_ssh_version_string(['ssh', '-V'])
149
return self._get_vendor_by_version_string(version, "ssh")
151
def _get_vendor_from_path(self, path):
152
"""Return the vendor or None using the program at the given path"""
153
version = self._get_ssh_version_string([path, '-V'])
154
return self._get_vendor_by_version_string(version,
155
os.path.splitext(os.path.basename(path))[0])
142
157
def get_vendor(self, environment=None):
143
158
"""Find out what version of SSH is on the system.
257
274
register_ssh_vendor('loopback', LoopbackVendor())
260
class _ParamikoSSHConnection(object):
261
def __init__(self, channel):
262
self.channel = channel
264
def get_filelike_channels(self):
265
return self.channel.makefile('rb'), self.channel.makefile('wb')
268
return self.channel.close()
271
277
class ParamikoVendor(SSHVendor):
272
278
"""Vendor that uses paramiko."""
280
def _hexify(self, s):
281
return hexlify(s).upper()
274
283
def _connect(self, username, password, host, port):
275
284
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
284
293
self._raise_connection_error(host, port=port, orig_error=e)
286
295
server_key = t.get_remote_server_key()
287
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
296
server_key_hex = self._hexify(server_key.get_fingerprint())
288
297
keytype = server_key.get_name()
289
298
if host in SYSTEM_HOSTKEYS and keytype in SYSTEM_HOSTKEYS[host]:
290
299
our_server_key = SYSTEM_HOSTKEYS[host][keytype]
291
our_server_key_hex = paramiko.util.hexify(
292
our_server_key.get_fingerprint())
300
our_server_key_hex = self._hexify(our_server_key.get_fingerprint())
293
301
elif host in BZR_HOSTKEYS and keytype in BZR_HOSTKEYS[host]:
294
302
our_server_key = BZR_HOSTKEYS[host][keytype]
295
our_server_key_hex = paramiko.util.hexify(
296
our_server_key.get_fingerprint())
303
our_server_key_hex = self._hexify(our_server_key.get_fingerprint())
298
305
trace.warning('Adding %s host key for %s: %s'
299
306
% (keytype, host, server_key_hex))
336
342
self._raise_connection_error(host, port=port, orig_error=e,
337
343
msg='Unable to invoke remote bzr')
345
_ssh_connection_errors = (EOFError, OSError, IOError, socket.error)
339
346
if paramiko is not None:
340
347
vendor = ParamikoVendor()
341
348
register_ssh_vendor('paramiko', vendor)
342
349
register_ssh_vendor('none', vendor)
343
350
register_default_ssh_vendor(vendor)
344
_sftp_connection_errors = (EOFError, paramiko.SSHException)
351
_ssh_connection_errors += (paramiko.SSHException,)
347
_sftp_connection_errors = (EOFError,)
350
355
class SubprocessVendor(SSHVendor):
351
356
"""Abstract base class for vendors that use pipes to a subprocess."""
358
# In general stderr should be inherited from the parent process so prompts
359
# are visible on the terminal. This can be overriden to another file for
360
# tests, but beware of using PIPE which may hang due to not being read.
361
_stderr_target = None
353
363
def _connect(self, argv):
354
proc = subprocess.Popen(argv,
355
stdin=subprocess.PIPE,
356
stdout=subprocess.PIPE,
364
# Attempt to make a socketpair to use as stdin/stdout for the SSH
365
# subprocess. We prefer sockets to pipes because they support
366
# non-blocking short reads, allowing us to optimistically read 64k (or
369
my_sock, subproc_sock = socket.socketpair()
370
osutils.set_fd_cloexec(my_sock)
371
except (AttributeError, socket.error):
372
# This platform doesn't support socketpair(), so just use ordinary
374
stdin = stdout = subprocess.PIPE
375
my_sock, subproc_sock = None, None
377
stdin = stdout = subproc_sock
378
proc = subprocess.Popen(argv, stdin=stdin, stdout=stdout,
379
stderr=self._stderr_target,
357
380
**os_specific_subprocess_params())
358
return SSHSubprocess(proc)
381
if subproc_sock is not None:
383
return SSHSubprocessConnection(proc, sock=my_sock)
360
385
def connect_sftp(self, username, password, host, port):
363
388
subsystem='sftp')
364
389
sock = self._connect(argv)
365
390
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,):
391
except _ssh_connection_errors, e:
374
392
self._raise_connection_error(host, port=port, orig_error=e)
376
394
def connect_ssh(self, username, password, host, port, command):
378
396
argv = self._get_vendor_specific_argv(username, host, port,
380
398
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,):
399
except _ssh_connection_errors, e:
389
400
self._raise_connection_error(host, port=port, orig_error=e)
391
402
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
393
404
"""Returns the argument list to run the subprocess with.
395
406
Exactly one of 'subsystem' and 'command' must be specified.
397
408
raise NotImplementedError(self._get_vendor_specific_argv)
400
411
class OpenSSHSubprocessVendor(SubprocessVendor):
401
412
"""SSH vendor that uses the 'ssh' executable from OpenSSH."""
414
executable_path = 'ssh'
403
416
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
418
args = [self.executable_path,
406
419
'-oForwardX11=no', '-oForwardAgent=no',
407
'-oClearAllForwardings=yes', '-oProtocol=2',
420
'-oClearAllForwardings=yes',
408
421
'-oNoHostAuthenticationForLocalhost=yes']
409
422
if port is not None:
410
423
args.extend(['-p', str(port)])
435
450
args.extend([host] + command)
438
register_ssh_vendor('ssh', SSHCorpSubprocessVendor())
453
register_ssh_vendor('sshcorp', SSHCorpSubprocessVendor())
456
class LSHSubprocessVendor(SubprocessVendor):
457
"""SSH vendor that uses the 'lsh' executable from GNU"""
459
executable_path = 'lsh'
461
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
463
args = [self.executable_path]
465
args.extend(['-p', str(port)])
466
if username is not None:
467
args.extend(['-l', username])
468
if subsystem is not None:
469
args.extend(['--subsystem', subsystem, host])
471
args.extend([host] + command)
474
register_ssh_vendor('lsh', LSHSubprocessVendor())
441
477
class PLinkSubprocessVendor(SubprocessVendor):
442
478
"""SSH vendor that uses the 'plink' executable from Putty."""
480
executable_path = 'plink'
444
482
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
446
args = ['plink', '-x', '-a', '-ssh', '-2', '-batch']
484
args = [self.executable_path, '-x', '-a', '-ssh', '-2', '-batch']
447
485
if port is not None:
448
486
args.extend(['-P', str(port)])
449
487
if username is not None:
460
498
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
499
auth = config.AuthenticationConfig()
500
# paramiko requires a username, but it might be none if nothing was
501
# supplied. If so, use the local username.
468
502
if username is None:
469
username = auth.get_user('ssh', host, port=port)
471
# Default to local user
472
username = getpass.getuser()
503
username = auth.get_user('ssh', host, port=port,
504
default=getpass.getuser())
474
505
if _use_ssh_agent:
475
506
agent = paramiko.Agent()
476
507
for key in agent.get_keys():
477
508
trace.mutter('Trying SSH agent key %s'
478
% paramiko.util.hexify(key.get_fingerprint()))
509
% self._hexify(key.get_fingerprint()))
480
511
paramiko_transport.auth_publickey(username, key)
488
519
if _try_pkey_auth(paramiko_transport, paramiko.DSSKey, username, 'id_dsa'):
522
# If we have gotten this far, we are about to try for passwords, do an
523
# auth_none check to see if it is even supported.
524
supported_auth_types = []
526
# Note that with paramiko <1.7.5 this logs an INFO message:
527
# Authentication type (none) not permitted.
528
# So we explicitly disable the logging level for this action
529
old_level = paramiko_transport.logger.level
530
paramiko_transport.logger.setLevel(logging.WARNING)
532
paramiko_transport.auth_none(username)
534
paramiko_transport.logger.setLevel(old_level)
535
except paramiko.BadAuthenticationType, e:
536
# Supported methods are in the exception
537
supported_auth_types = e.allowed_types
538
except paramiko.SSHException, e:
539
# Don't know what happened, but just ignore it
541
# We treat 'keyboard-interactive' and 'password' auth methods identically,
542
# because Paramiko's auth_password method will automatically try
543
# 'keyboard-interactive' auth (using the password as the response) if
544
# 'password' auth is not available. Apparently some Debian and Gentoo
545
# OpenSSH servers require this.
546
# XXX: It's possible for a server to require keyboard-interactive auth that
547
# requires something other than a single password, but we currently don't
549
if ('password' not in supported_auth_types and
550
'keyboard-interactive' not in supported_auth_types):
551
raise errors.ConnectionError('Unable to authenticate to SSH host as'
552
'\n %s@%s\nsupported auth types: %s'
553
% (username, host, supported_auth_types))
493
557
paramiko_transport.auth_password(username, password)
498
562
# give up and ask for a password
499
563
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)
564
# get_password can still return None, which means we should not prompt
565
if password is not None:
567
paramiko_transport.auth_password(username, password)
568
except paramiko.SSHException, e:
569
raise errors.ConnectionError(
570
'Unable to authenticate to SSH host as'
571
'\n %s@%s\n' % (username, host), e)
573
raise errors.ConnectionError('Unable to authenticate to SSH host as'
574
' %s@%s' % (username, host))
507
577
def _try_pkey_auth(paramiko_transport, pkey_class, username, filename):
581
652
# this causes it to be seen only by bzr and not by ssh. Python will
582
653
# generate a KeyboardInterrupt in bzr, and we will then have a chance
583
654
# to release locks or do other cleanup over ssh before the connection
585
656
# <https://launchpad.net/products/bzr/+bug/5987>
587
658
# Running it in a separate process group is not good because then it
588
659
# can't get non-echoed input of a password or passphrase.
589
660
# <https://launchpad.net/products/bzr/+bug/40508>
590
return {'preexec_fn': _ignore_sigint,
661
return {'preexec_fn': _ignore_signals,
591
662
'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):
666
_subproc_weakrefs = set()
668
def _close_ssh_proc(proc, sock):
669
"""Carefully close stdin/stdout and reap the SSH process.
671
If the pipes are already closed and/or the process has already been
672
wait()ed on, that's ok, and no error is raised. The goal is to do our best
673
to clean up (whether or not a clean up was already tried).
676
for closeable in (proc.stdin, proc.stdout, sock):
677
# We expect that either proc (a subprocess.Popen) will have stdin and
678
# stdout streams to close, or that we will have been passed a socket to
679
# close, with the option not in use being None.
680
if closeable is not None:
681
funcs.append(closeable.close)
682
funcs.append(proc.wait)
687
# It's ok for the pipe to already be closed, or the process to
688
# already be finished.
692
class SSHConnection(object):
693
"""Abstract base class for SSH connections."""
695
def get_sock_or_pipes(self):
696
"""Returns a (kind, io_object) pair.
698
If kind == 'socket', then io_object is a socket.
700
If kind == 'pipes', then io_object is a pair of file-like objects
701
(read_from, write_to).
703
raise NotImplementedError(self.get_sock_or_pipes)
706
raise NotImplementedError(self.close)
709
class SSHSubprocessConnection(SSHConnection):
710
"""A connection to an ssh subprocess via pipes or a socket.
712
This class is also socket-like enough to be used with
713
SocketAsChannelAdapter (it has 'send' and 'recv' methods).
716
def __init__(self, proc, sock=None):
719
:param proc: a subprocess.Popen
720
:param sock: if proc.stdin/out is a socket from a socketpair, then sock
721
should bzrlib's half of that socketpair. If not passed, proc's
722
stdin/out is assumed to be ordinary pipes.
726
# Add a weakref to proc that will attempt to do the same as self.close
727
# to avoid leaving processes lingering indefinitely.
729
_subproc_weakrefs.remove(ref)
730
_close_ssh_proc(proc, sock)
731
_subproc_weakrefs.add(weakref.ref(self, terminate))
601
733
def send(self, data):
602
return os.write(self.proc.stdin.fileno(), data)
734
if self._sock is not None:
735
return self._sock.send(data)
737
return os.write(self.proc.stdin.fileno(), data)
604
739
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)
740
if self._sock is not None:
741
return self._sock.recv(count)
743
return os.read(self.proc.stdout.fileno(), count)
746
_close_ssh_proc(self.proc, self._sock)
748
def get_sock_or_pipes(self):
749
if self._sock is not None:
750
return 'socket', self._sock
752
return 'pipes', (self.proc.stdout, self.proc.stdin)
755
class _ParamikoSSHConnection(SSHConnection):
756
"""An SSH connection via paramiko."""
758
def __init__(self, channel):
759
self.channel = channel
761
def get_sock_or_pipes(self):
762
return ('socket', self.channel)
765
return self.channel.close()
added
removed
bzrlib/transport/ssh.py
