129
122
elif 'SSH Secure Shell' in version:
130
123
trace.mutter('ssh implementation is SSH Corp.')
131
124
vendor = SSHCorpSubprocessVendor()
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':
125
elif 'plink' in version and args[0] == 'plink':
139
126
# Checking if "plink" was the executed argument as Windows
140
# sometimes reports 'ssh -V' incorrectly with 'plink' in its
127
# sometimes reports 'ssh -V' incorrectly with 'plink' in it's
141
128
# version. See https://bugs.launchpad.net/bzr/+bug/107155
142
129
trace.mutter("ssh implementation is Putty's plink.")
143
130
vendor = PLinkSubprocessVendor()
146
133
def _get_vendor_by_inspection(self):
147
134
"""Return the vendor or None by checking for known SSH implementations."""
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])
135
# detection of plink vendor is disabled because of bug #107593
136
# https://bugs.launchpad.net/bzr/+bug/107593
137
# who want plink should explicitly enable it with BZR_SSH environment
139
#~for args in (['ssh', '-V'], ['plink', '-V']):
140
for args in (['ssh', '-V'],):
141
version = self._get_ssh_version_string(args)
142
vendor = self._get_vendor_by_version_string(version, args)
143
if vendor is not None:
157
147
def get_vendor(self, environment=None):
158
148
"""Find out what version of SSH is on the system.
179
169
register_ssh_vendor = _ssh_vendor_manager.register_vendor
182
def _ignore_signals():
172
def _ignore_sigint():
183
173
# TODO: This should possibly ignore SIGHUP as well, but bzr currently
184
174
# doesn't handle it itself.
185
175
# <https://launchpad.net/products/bzr/+bug/41433/+index>
187
177
signal.signal(signal.SIGINT, signal.SIG_IGN)
188
# GZ 2010-02-19: Perhaps make this check if breakin is installed instead
189
if signal.getsignal(signal.SIGQUIT) != signal.SIG_DFL:
190
signal.signal(signal.SIGQUIT, signal.SIG_IGN)
193
class SocketAsChannelAdapter(object):
180
class LoopbackSFTP(object):
194
181
"""Simple wrapper for a socket that pretends to be a paramiko Channel."""
196
183
def __init__(self, sock):
197
184
self.__socket = sock
200
return "bzr SocketAsChannelAdapter"
202
186
def send(self, data):
203
187
return self.__socket.send(data)
205
189
def recv(self, n):
207
return self.__socket.recv(n)
208
except socket.error, e:
209
if e.args[0] in (errno.EPIPE, errno.ECONNRESET, errno.ECONNABORTED,
211
# Connection has closed. Paramiko expects an empty string in
212
# this case, not an exception.
190
return self.__socket.recv(n)
216
192
def recv_ready(self):
217
# TODO: jam 20051215 this function is necessary to support the
218
# pipelined() function. In reality, it probably should use
219
# poll() or select() to actually return if there is data
220
# available, otherwise we probably don't get any benefit
269
242
sock.connect((host, port))
270
243
except socket.error, e:
271
244
self._raise_connection_error(host, port=port, orig_error=e)
272
return SFTPClient(SocketAsChannelAdapter(sock))
245
return SFTPClient(LoopbackSFTP(sock))
274
247
register_ssh_vendor('loopback', LoopbackVendor())
250
class _ParamikoSSHConnection(object):
251
def __init__(self, channel):
252
self.channel = channel
254
def get_filelike_channels(self):
255
return self.channel.makefile('rb'), self.channel.makefile('wb')
258
return self.channel.close()
277
261
class ParamikoVendor(SSHVendor):
278
262
"""Vendor that uses paramiko."""
280
def _hexify(self, s):
281
return hexlify(s).upper()
283
264
def _connect(self, username, password, host, port):
284
265
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
293
274
self._raise_connection_error(host, port=port, orig_error=e)
295
276
server_key = t.get_remote_server_key()
296
server_key_hex = self._hexify(server_key.get_fingerprint())
277
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
297
278
keytype = server_key.get_name()
298
279
if host in SYSTEM_HOSTKEYS and keytype in SYSTEM_HOSTKEYS[host]:
299
280
our_server_key = SYSTEM_HOSTKEYS[host][keytype]
300
our_server_key_hex = self._hexify(our_server_key.get_fingerprint())
281
our_server_key_hex = paramiko.util.hexify(
282
our_server_key.get_fingerprint())
301
283
elif host in BZR_HOSTKEYS and keytype in BZR_HOSTKEYS[host]:
302
284
our_server_key = BZR_HOSTKEYS[host][keytype]
303
our_server_key_hex = self._hexify(our_server_key.get_fingerprint())
285
our_server_key_hex = paramiko.util.hexify(
286
our_server_key.get_fingerprint())
305
288
trace.warning('Adding %s host key for %s: %s'
306
289
% (keytype, host, server_key_hex))
342
326
self._raise_connection_error(host, port=port, orig_error=e,
343
327
msg='Unable to invoke remote bzr')
345
_ssh_connection_errors = (EOFError, OSError, IOError, socket.error)
346
329
if paramiko is not None:
347
330
vendor = ParamikoVendor()
348
331
register_ssh_vendor('paramiko', vendor)
349
332
register_ssh_vendor('none', vendor)
350
333
register_default_ssh_vendor(vendor)
351
_ssh_connection_errors += (paramiko.SSHException,)
334
_sftp_connection_errors = (EOFError, paramiko.SSHException)
337
_sftp_connection_errors = (EOFError,)
355
340
class SubprocessVendor(SSHVendor):
356
341
"""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
363
343
def _connect(self, argv):
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,
344
proc = subprocess.Popen(argv,
345
stdin=subprocess.PIPE,
346
stdout=subprocess.PIPE,
380
347
**os_specific_subprocess_params())
381
if subproc_sock is not None:
383
return SSHSubprocessConnection(proc, sock=my_sock)
348
return SSHSubprocess(proc)
385
350
def connect_sftp(self, username, password, host, port):
387
352
argv = self._get_vendor_specific_argv(username, host, port,
388
353
subsystem='sftp')
389
354
sock = self._connect(argv)
390
return SFTPClient(SocketAsChannelAdapter(sock))
391
except _ssh_connection_errors, e:
355
return SFTPClient(sock)
356
except _sftp_connection_errors, e:
357
self._raise_connection_error(host, port=port, orig_error=e)
358
except (OSError, IOError), e:
359
# If the machine is fast enough, ssh can actually exit
360
# before we try and send it the sftp request, which
361
# raises a Broken Pipe
362
if e.errno not in (errno.EPIPE,):
392
364
self._raise_connection_error(host, port=port, orig_error=e)
394
366
def connect_ssh(self, username, password, host, port, command):
396
368
argv = self._get_vendor_specific_argv(username, host, port,
398
370
return self._connect(argv)
399
except _ssh_connection_errors, e:
371
except (EOFError), e:
372
self._raise_connection_error(host, port=port, orig_error=e)
373
except (OSError, IOError), e:
374
# If the machine is fast enough, ssh can actually exit
375
# before we try and send it the sftp request, which
376
# raises a Broken Pipe
377
if e.errno not in (errno.EPIPE,):
400
379
self._raise_connection_error(host, port=port, orig_error=e)
402
381
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
404
383
"""Returns the argument list to run the subprocess with.
406
385
Exactly one of 'subsystem' and 'command' must be specified.
408
387
raise NotImplementedError(self._get_vendor_specific_argv)
411
390
class OpenSSHSubprocessVendor(SubprocessVendor):
412
391
"""SSH vendor that uses the 'ssh' executable from OpenSSH."""
414
executable_path = 'ssh'
416
393
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
418
args = [self.executable_path,
395
assert subsystem is not None or command is not None, (
396
'Must specify a command or subsystem')
397
if subsystem is not None:
398
assert command is None, (
399
'subsystem and command are mutually exclusive')
419
401
'-oForwardX11=no', '-oForwardAgent=no',
420
'-oClearAllForwardings=yes',
402
'-oClearAllForwardings=yes', '-oProtocol=2',
421
403
'-oNoHostAuthenticationForLocalhost=yes']
422
404
if port is not None:
423
405
args.extend(['-p', str(port)])
450
435
args.extend([host] + command)
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())
438
register_ssh_vendor('ssh', SSHCorpSubprocessVendor())
477
441
class PLinkSubprocessVendor(SubprocessVendor):
478
442
"""SSH vendor that uses the 'plink' executable from Putty."""
480
executable_path = 'plink'
482
444
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
484
args = [self.executable_path, '-x', '-a', '-ssh', '-2', '-batch']
446
assert subsystem is not None or command is not None, (
447
'Must specify a command or subsystem')
448
if subsystem is not None:
449
assert command is None, (
450
'subsystem and command are mutually exclusive')
451
args = ['plink', '-x', '-a', '-ssh', '-2']
485
452
if port is not None:
486
453
args.extend(['-P', str(port)])
487
454
if username is not None:
498
465
def _paramiko_auth(username, password, host, port, paramiko_transport):
466
# paramiko requires a username, but it might be none if nothing was supplied
467
# use the local username, just in case.
468
# We don't override username, because if we aren't using paramiko,
469
# the username might be specified in ~/.ssh/config and we don't want to
470
# force it to something else
471
# Also, it would mess up the self.relpath() functionality
499
472
auth = config.AuthenticationConfig()
500
# paramiko requires a username, but it might be none if nothing was
501
# supplied. If so, use the local username.
502
473
if username is None:
503
username = auth.get_user('ssh', host, port=port,
504
default=getpass.getuser())
474
username = auth.get_user('ssh', host, port=port)
476
# Default to local user
477
username = getpass.getuser()
505
479
if _use_ssh_agent:
506
480
agent = paramiko.Agent()
507
481
for key in agent.get_keys():
508
482
trace.mutter('Trying SSH agent key %s'
509
% self._hexify(key.get_fingerprint()))
483
% paramiko.util.hexify(key.get_fingerprint()))
511
485
paramiko_transport.auth_publickey(username, key)
519
493
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))
557
498
paramiko_transport.auth_password(username, password)
562
503
# give up and ask for a password
563
504
password = auth.get_password('ssh', host, username, port=port)
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))
506
paramiko_transport.auth_password(username, password)
507
except paramiko.SSHException, e:
508
raise errors.ConnectionError(
509
'Unable to authenticate to SSH host as %s@%s' % (username, host), e)
577
512
def _try_pkey_auth(paramiko_transport, pkey_class, username, filename):
652
586
# this causes it to be seen only by bzr and not by ssh. Python will
653
587
# generate a KeyboardInterrupt in bzr, and we will then have a chance
654
588
# to release locks or do other cleanup over ssh before the connection
656
590
# <https://launchpad.net/products/bzr/+bug/5987>
658
592
# Running it in a separate process group is not good because then it
659
593
# can't get non-echoed input of a password or passphrase.
660
594
# <https://launchpad.net/products/bzr/+bug/40508>
661
return {'preexec_fn': _ignore_signals,
595
return {'preexec_fn': _ignore_sigint,
662
596
'close_fds': True,
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.
600
class SSHSubprocess(object):
601
"""A socket-like object that talks to an ssh subprocess via pipes."""
603
def __init__(self, proc):
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))
733
606
def send(self, data):
734
if self._sock is not None:
735
return self._sock.send(data)
737
return os.write(self.proc.stdin.fileno(), data)
607
return os.write(self.proc.stdin.fileno(), data)
609
def recv_ready(self):
610
# TODO: jam 20051215 this function is necessary to support the
611
# pipelined() function. In reality, it probably should use
612
# poll() or select() to actually return if there is data
613
# available, otherwise we probably don't get any benefit
739
616
def recv(self, count):
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()
617
return os.read(self.proc.stdout.fileno(), count)
620
self.proc.stdin.close()
621
self.proc.stdout.close()
624
def get_filelike_channels(self):
625
return (self.proc.stdout, self.proc.stdin)
added
removed
bzrlib/transport/ssh.py
