122
128
elif 'SSH Secure Shell' in version:
123
129
trace.mutter('ssh implementation is SSH Corp.')
124
130
vendor = SSHCorpSubprocessVendor()
125
elif 'plink' in version and args[0] == 'plink':
131
elif 'lsh' in version:
132
trace.mutter('ssh implementation is GNU lsh.')
133
vendor = LSHSubprocessVendor()
134
# As plink user prompts are not handled currently, don't auto-detect
135
# it by inspection below, but keep this vendor detection for if a path
136
# is given in BZR_SSH. See https://bugs.launchpad.net/bugs/414743
137
elif 'plink' in version and progname == 'plink':
126
138
# Checking if "plink" was the executed argument as Windows
127
# sometimes reports 'ssh -V' incorrectly with 'plink' in it's
139
# sometimes reports 'ssh -V' incorrectly with 'plink' in its
128
140
# version. See https://bugs.launchpad.net/bzr/+bug/107155
129
141
trace.mutter("ssh implementation is Putty's plink.")
130
142
vendor = PLinkSubprocessVendor()
133
145
def _get_vendor_by_inspection(self):
134
146
"""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:
147
version = self._get_ssh_version_string(['ssh', '-V'])
148
return self._get_vendor_by_version_string(version, "ssh")
150
def _get_vendor_from_path(self, path):
151
"""Return the vendor or None using the program at the given path"""
152
version = self._get_ssh_version_string([path, '-V'])
153
return self._get_vendor_by_version_string(version,
154
os.path.splitext(os.path.basename(path))[0])
142
156
def get_vendor(self, environment=None):
143
157
"""Find out what version of SSH is on the system.
164
178
register_ssh_vendor = _ssh_vendor_manager.register_vendor
167
def _ignore_sigint():
181
def _ignore_signals():
168
182
# TODO: This should possibly ignore SIGHUP as well, but bzr currently
169
183
# doesn't handle it itself.
170
184
# <https://launchpad.net/products/bzr/+bug/41433/+index>
172
186
signal.signal(signal.SIGINT, signal.SIG_IGN)
175
class LoopbackSFTP(object):
187
# GZ 2010-02-19: Perhaps make this check if breakin is installed instead
188
if signal.getsignal(signal.SIGQUIT) != signal.SIG_DFL:
189
signal.signal(signal.SIGQUIT, signal.SIG_IGN)
192
class SocketAsChannelAdapter(object):
176
193
"""Simple wrapper for a socket that pretends to be a paramiko Channel."""
178
195
def __init__(self, sock):
179
196
self.__socket = sock
199
return "bzr SocketAsChannelAdapter"
181
201
def send(self, data):
182
202
return self.__socket.send(data)
184
204
def recv(self, n):
185
return self.__socket.recv(n)
206
return self.__socket.recv(n)
207
except socket.error, e:
208
if e.args[0] in (errno.EPIPE, errno.ECONNRESET, errno.ECONNABORTED,
210
# Connection has closed. Paramiko expects an empty string in
211
# this case, not an exception.
187
215
def recv_ready(self):
216
# TODO: jam 20051215 this function is necessary to support the
217
# pipelined() function. In reality, it probably should use
218
# poll() or select() to actually return if there is data
219
# available, otherwise we probably don't get any benefit
237
268
sock.connect((host, port))
238
269
except socket.error, e:
239
270
self._raise_connection_error(host, port=port, orig_error=e)
240
return SFTPClient(LoopbackSFTP(sock))
271
return SFTPClient(SocketAsChannelAdapter(sock))
242
273
register_ssh_vendor('loopback', LoopbackVendor())
245
class _ParamikoSSHConnection(object):
246
def __init__(self, channel):
247
self.channel = channel
249
def get_filelike_channels(self):
250
return self.channel.makefile('rb'), self.channel.makefile('wb')
253
return self.channel.close()
256
276
class ParamikoVendor(SSHVendor):
257
277
"""Vendor that uses paramiko."""
321
341
self._raise_connection_error(host, port=port, orig_error=e,
322
342
msg='Unable to invoke remote bzr')
344
_ssh_connection_errors = (EOFError, OSError, IOError, socket.error)
324
345
if paramiko is not None:
325
346
vendor = ParamikoVendor()
326
347
register_ssh_vendor('paramiko', vendor)
327
348
register_ssh_vendor('none', vendor)
328
349
register_default_ssh_vendor(vendor)
350
_ssh_connection_errors += (paramiko.SSHException,)
332
354
class SubprocessVendor(SSHVendor):
333
355
"""Abstract base class for vendors that use pipes to a subprocess."""
357
# In general stderr should be inherited from the parent process so prompts
358
# are visible on the terminal. This can be overriden to another file for
359
# tests, but beware of using PIPE which may hang due to not being read.
360
_stderr_target = None
335
362
def _connect(self, argv):
336
proc = subprocess.Popen(argv,
337
stdin=subprocess.PIPE,
338
stdout=subprocess.PIPE,
363
# Attempt to make a socketpair to use as stdin/stdout for the SSH
364
# subprocess. We prefer sockets to pipes because they support
365
# non-blocking short reads, allowing us to optimistically read 64k (or
368
my_sock, subproc_sock = socket.socketpair()
369
osutils.set_fd_cloexec(my_sock)
370
except (AttributeError, socket.error):
371
# This platform doesn't support socketpair(), so just use ordinary
373
stdin = stdout = subprocess.PIPE
374
my_sock, subproc_sock = None, None
376
stdin = stdout = subproc_sock
377
proc = subprocess.Popen(argv, stdin=stdin, stdout=stdout,
378
stderr=self._stderr_target,
339
379
**os_specific_subprocess_params())
340
return SSHSubprocess(proc)
380
if subproc_sock is not None:
382
return SSHSubprocessConnection(proc, sock=my_sock)
342
384
def connect_sftp(self, username, password, host, port):
344
386
argv = self._get_vendor_specific_argv(username, host, port,
345
387
subsystem='sftp')
346
388
sock = self._connect(argv)
347
return SFTPClient(sock)
348
except (EOFError, paramiko.SSHException), e:
349
self._raise_connection_error(host, port=port, orig_error=e)
350
except (OSError, IOError), e:
351
# If the machine is fast enough, ssh can actually exit
352
# before we try and send it the sftp request, which
353
# raises a Broken Pipe
354
if e.errno not in (errno.EPIPE,):
389
return SFTPClient(SocketAsChannelAdapter(sock))
390
except _ssh_connection_errors, e:
356
391
self._raise_connection_error(host, port=port, orig_error=e)
358
393
def connect_ssh(self, username, password, host, port, command):
360
395
argv = self._get_vendor_specific_argv(username, host, port,
362
397
return self._connect(argv)
363
except (EOFError), e:
364
self._raise_connection_error(host, port=port, orig_error=e)
365
except (OSError, IOError), e:
366
# If the machine is fast enough, ssh can actually exit
367
# before we try and send it the sftp request, which
368
# raises a Broken Pipe
369
if e.errno not in (errno.EPIPE,):
398
except _ssh_connection_errors, e:
371
399
self._raise_connection_error(host, port=port, orig_error=e)
373
401
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
375
403
"""Returns the argument list to run the subprocess with.
377
405
Exactly one of 'subsystem' and 'command' must be specified.
379
407
raise NotImplementedError(self._get_vendor_specific_argv)
382
410
class OpenSSHSubprocessVendor(SubprocessVendor):
383
411
"""SSH vendor that uses the 'ssh' executable from OpenSSH."""
413
executable_path = 'ssh'
385
415
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
387
assert subsystem is not None or command is not None, (
388
'Must specify a command or subsystem')
389
if subsystem is not None:
390
assert command is None, (
391
'subsystem and command are mutually exclusive')
417
args = [self.executable_path,
393
418
'-oForwardX11=no', '-oForwardAgent=no',
394
'-oClearAllForwardings=yes', '-oProtocol=2',
419
'-oClearAllForwardings=yes',
395
420
'-oNoHostAuthenticationForLocalhost=yes']
396
421
if port is not None:
397
422
args.extend(['-p', str(port)])
427
449
args.extend([host] + command)
430
register_ssh_vendor('ssh', SSHCorpSubprocessVendor())
452
register_ssh_vendor('sshcorp', SSHCorpSubprocessVendor())
455
class LSHSubprocessVendor(SubprocessVendor):
456
"""SSH vendor that uses the 'lsh' executable from GNU"""
458
executable_path = 'lsh'
460
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
462
args = [self.executable_path]
464
args.extend(['-p', str(port)])
465
if username is not None:
466
args.extend(['-l', username])
467
if subsystem is not None:
468
args.extend(['--subsystem', subsystem, host])
470
args.extend([host] + command)
473
register_ssh_vendor('lsh', LSHSubprocessVendor())
433
476
class PLinkSubprocessVendor(SubprocessVendor):
434
477
"""SSH vendor that uses the 'plink' executable from Putty."""
479
executable_path = 'plink'
436
481
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
438
assert subsystem is not None or command is not None, (
439
'Must specify a command or subsystem')
440
if subsystem is not None:
441
assert command is None, (
442
'subsystem and command are mutually exclusive')
443
args = ['plink', '-x', '-a', '-ssh', '-2']
483
args = [self.executable_path, '-x', '-a', '-ssh', '-2', '-batch']
444
484
if port is not None:
445
485
args.extend(['-P', str(port)])
446
486
if username is not None:
457
497
def _paramiko_auth(username, password, host, port, paramiko_transport):
458
# paramiko requires a username, but it might be none if nothing was supplied
459
# use the local username, just in case.
460
# We don't override username, because if we aren't using paramiko,
461
# the username might be specified in ~/.ssh/config and we don't want to
462
# force it to something else
463
# Also, it would mess up the self.relpath() functionality
464
498
auth = config.AuthenticationConfig()
499
# paramiko requires a username, but it might be none if nothing was
500
# supplied. If so, use the local username.
465
501
if username is None:
466
username = auth.get_user('ssh', host, port=port)
468
# Default to local user
469
username = getpass.getuser()
502
username = auth.get_user('ssh', host, port=port,
503
default=getpass.getuser())
471
504
if _use_ssh_agent:
472
505
agent = paramiko.Agent()
473
506
for key in agent.get_keys():
485
518
if _try_pkey_auth(paramiko_transport, paramiko.DSSKey, username, 'id_dsa'):
521
# If we have gotten this far, we are about to try for passwords, do an
522
# auth_none check to see if it is even supported.
523
supported_auth_types = []
525
# Note that with paramiko <1.7.5 this logs an INFO message:
526
# Authentication type (none) not permitted.
527
# So we explicitly disable the logging level for this action
528
old_level = paramiko_transport.logger.level
529
paramiko_transport.logger.setLevel(logging.WARNING)
531
paramiko_transport.auth_none(username)
533
paramiko_transport.logger.setLevel(old_level)
534
except paramiko.BadAuthenticationType, e:
535
# Supported methods are in the exception
536
supported_auth_types = e.allowed_types
537
except paramiko.SSHException, e:
538
# Don't know what happened, but just ignore it
540
# We treat 'keyboard-interactive' and 'password' auth methods identically,
541
# because Paramiko's auth_password method will automatically try
542
# 'keyboard-interactive' auth (using the password as the response) if
543
# 'password' auth is not available. Apparently some Debian and Gentoo
544
# OpenSSH servers require this.
545
# XXX: It's possible for a server to require keyboard-interactive auth that
546
# requires something other than a single password, but we currently don't
548
if ('password' not in supported_auth_types and
549
'keyboard-interactive' not in supported_auth_types):
550
raise errors.ConnectionError('Unable to authenticate to SSH host as'
551
'\n %s@%s\nsupported auth types: %s'
552
% (username, host, supported_auth_types))
490
556
paramiko_transport.auth_password(username, password)
495
561
# give up and ask for a password
496
562
password = auth.get_password('ssh', host, username, port=port)
498
paramiko_transport.auth_password(username, password)
499
except paramiko.SSHException, e:
500
raise errors.ConnectionError(
501
'Unable to authenticate to SSH host as %s@%s' % (username, host), e)
563
# get_password can still return None, which means we should not prompt
564
if password is not None:
566
paramiko_transport.auth_password(username, password)
567
except paramiko.SSHException, e:
568
raise errors.ConnectionError(
569
'Unable to authenticate to SSH host as'
570
'\n %s@%s\n' % (username, host), e)
572
raise errors.ConnectionError('Unable to authenticate to SSH host as'
573
' %s@%s' % (username, host))
504
576
def _try_pkey_auth(paramiko_transport, pkey_class, username, filename):
578
651
# this causes it to be seen only by bzr and not by ssh. Python will
579
652
# generate a KeyboardInterrupt in bzr, and we will then have a chance
580
653
# to release locks or do other cleanup over ssh before the connection
582
655
# <https://launchpad.net/products/bzr/+bug/5987>
584
657
# Running it in a separate process group is not good because then it
585
658
# can't get non-echoed input of a password or passphrase.
586
659
# <https://launchpad.net/products/bzr/+bug/40508>
587
return {'preexec_fn': _ignore_sigint,
660
return {'preexec_fn': _ignore_signals,
588
661
'close_fds': True,
592
class SSHSubprocess(object):
593
"""A socket-like object that talks to an ssh subprocess via pipes."""
595
def __init__(self, proc):
665
_subproc_weakrefs = set()
667
def _close_ssh_proc(proc, sock):
668
"""Carefully close stdin/stdout and reap the SSH process.
670
If the pipes are already closed and/or the process has already been
671
wait()ed on, that's ok, and no error is raised. The goal is to do our best
672
to clean up (whether or not a clean up was already tried).
675
for closeable in (proc.stdin, proc.stdout, sock):
676
# We expect that either proc (a subprocess.Popen) will have stdin and
677
# stdout streams to close, or that we will have been passed a socket to
678
# close, with the option not in use being None.
679
if closeable is not None:
680
funcs.append(closeable.close)
681
funcs.append(proc.wait)
686
# It's ok for the pipe to already be closed, or the process to
687
# already be finished.
691
class SSHConnection(object):
692
"""Abstract base class for SSH connections."""
694
def get_sock_or_pipes(self):
695
"""Returns a (kind, io_object) pair.
697
If kind == 'socket', then io_object is a socket.
699
If kind == 'pipes', then io_object is a pair of file-like objects
700
(read_from, write_to).
702
raise NotImplementedError(self.get_sock_or_pipes)
705
raise NotImplementedError(self.close)
708
class SSHSubprocessConnection(SSHConnection):
709
"""A connection to an ssh subprocess via pipes or a socket.
711
This class is also socket-like enough to be used with
712
SocketAsChannelAdapter (it has 'send' and 'recv' methods).
715
def __init__(self, proc, sock=None):
718
:param proc: a subprocess.Popen
719
:param sock: if proc.stdin/out is a socket from a socketpair, then sock
720
should bzrlib's half of that socketpair. If not passed, proc's
721
stdin/out is assumed to be ordinary pipes.
725
# Add a weakref to proc that will attempt to do the same as self.close
726
# to avoid leaving processes lingering indefinitely.
728
_subproc_weakrefs.remove(ref)
729
_close_ssh_proc(proc, sock)
730
_subproc_weakrefs.add(weakref.ref(self, terminate))
598
732
def send(self, data):
599
return os.write(self.proc.stdin.fileno(), data)
601
def recv_ready(self):
602
# TODO: jam 20051215 this function is necessary to support the
603
# pipelined() function. In reality, it probably should use
604
# poll() or select() to actually return if there is data
605
# available, otherwise we probably don't get any benefit
733
if self._sock is not None:
734
return self._sock.send(data)
736
return os.write(self.proc.stdin.fileno(), data)
608
738
def recv(self, count):
609
return os.read(self.proc.stdout.fileno(), count)
612
self.proc.stdin.close()
613
self.proc.stdout.close()
616
def get_filelike_channels(self):
617
return (self.proc.stdout, self.proc.stdin)
739
if self._sock is not None:
740
return self._sock.recv(count)
742
return os.read(self.proc.stdout.fileno(), count)
745
_close_ssh_proc(self.proc, self._sock)
747
def get_sock_or_pipes(self):
748
if self._sock is not None:
749
return 'socket', self._sock
751
return 'pipes', (self.proc.stdout, self.proc.stdin)
754
class _ParamikoSSHConnection(SSHConnection):
755
"""An SSH connection via paramiko."""
757
def __init__(self, channel):
758
self.channel = channel
760
def get_sock_or_pipes(self):
761
return ('socket', self.channel)
764
return self.channel.close()
added
removed
bzrlib/transport/ssh.py
