1
# Copyright (C) 2006-2011 Robey Pointer <robey@lag.net>
2
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
"""Foundation SSH support for SFTP and smart server."""
20
from __future__ import absolute_import
40
except ImportError, e:
41
# If we have an ssh subprocess, we don't strictly need paramiko for all ssh
45
from paramiko.sftp_client import SFTPClient
52
_paramiko_version = getattr(paramiko, '__version_info__', (0, 0, 0))
54
# Paramiko 1.5 tries to open a socket.AF_UNIX in order to connect
55
# to ssh-agent. That attribute doesn't exist on win32 (it does in cygwin)
56
# so we get an AttributeError exception. So we will not try to
57
# connect to an agent if we are on win32 and using Paramiko older than 1.6
58
_use_ssh_agent = (sys.platform != 'win32' or _paramiko_version >= (1, 6, 0))
61
class SSHVendorManager(object):
62
"""Manager for manage SSH vendors."""
64
# Note, although at first sign the class interface seems similar to
65
# bzrlib.registry.Registry it is not possible/convenient to directly use
66
# the Registry because the class just has "get()" interface instead of the
67
# Registry's "get(key)".
70
self._ssh_vendors = {}
71
self._cached_ssh_vendor = None
72
self._default_ssh_vendor = None
74
def register_default_vendor(self, vendor):
75
"""Register default SSH vendor."""
76
self._default_ssh_vendor = vendor
78
def register_vendor(self, name, vendor):
79
"""Register new SSH vendor by name."""
80
self._ssh_vendors[name] = vendor
82
def clear_cache(self):
83
"""Clear previously cached lookup result."""
84
self._cached_ssh_vendor = None
86
def _get_vendor_by_environment(self, environment=None):
87
"""Return the vendor or None based on BZR_SSH environment variable.
89
:raises UnknownSSH: if the BZR_SSH environment variable contains
92
if environment is None:
93
environment = os.environ
94
if 'BZR_SSH' in environment:
95
vendor_name = environment['BZR_SSH']
97
vendor = self._ssh_vendors[vendor_name]
99
vendor = self._get_vendor_from_path(vendor_name)
101
raise errors.UnknownSSH(vendor_name)
102
vendor.executable_path = vendor_name
106
def _get_ssh_version_string(self, args):
107
"""Return SSH version string from the subprocess."""
109
p = subprocess.Popen(args,
110
stdout=subprocess.PIPE,
111
stderr=subprocess.PIPE,
112
**os_specific_subprocess_params())
113
stdout, stderr = p.communicate()
116
return stdout + stderr
118
def _get_vendor_by_version_string(self, version, progname):
119
"""Return the vendor or None based on output from the subprocess.
121
:param version: The output of 'ssh -V' like command.
122
:param args: Command line that was run.
125
if 'OpenSSH' in version:
126
trace.mutter('ssh implementation is OpenSSH')
127
vendor = OpenSSHSubprocessVendor()
128
elif 'SSH Secure Shell' in version:
129
trace.mutter('ssh implementation is SSH Corp.')
130
vendor = SSHCorpSubprocessVendor()
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':
138
# Checking if "plink" was the executed argument as Windows
139
# sometimes reports 'ssh -V' incorrectly with 'plink' in its
140
# version. See https://bugs.launchpad.net/bzr/+bug/107155
141
trace.mutter("ssh implementation is Putty's plink.")
142
vendor = PLinkSubprocessVendor()
145
def _get_vendor_by_inspection(self):
146
"""Return the vendor or None by checking for known SSH implementations."""
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])
156
def get_vendor(self, environment=None):
157
"""Find out what version of SSH is on the system.
159
:raises SSHVendorNotFound: if no any SSH vendor is found
160
:raises UnknownSSH: if the BZR_SSH environment variable contains
163
if self._cached_ssh_vendor is None:
164
vendor = self._get_vendor_by_environment(environment)
166
vendor = self._get_vendor_by_inspection()
168
trace.mutter('falling back to default implementation')
169
vendor = self._default_ssh_vendor
171
raise errors.SSHVendorNotFound()
172
self._cached_ssh_vendor = vendor
173
return self._cached_ssh_vendor
175
_ssh_vendor_manager = SSHVendorManager()
176
_get_ssh_vendor = _ssh_vendor_manager.get_vendor
177
register_default_ssh_vendor = _ssh_vendor_manager.register_default_vendor
178
register_ssh_vendor = _ssh_vendor_manager.register_vendor
181
def _ignore_signals():
182
# TODO: This should possibly ignore SIGHUP as well, but bzr currently
183
# doesn't handle it itself.
184
# <https://launchpad.net/products/bzr/+bug/41433/+index>
186
signal.signal(signal.SIGINT, signal.SIG_IGN)
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):
193
"""Simple wrapper for a socket that pretends to be a paramiko Channel."""
195
def __init__(self, sock):
199
return "bzr SocketAsChannelAdapter"
201
def send(self, data):
202
return self.__socket.send(data)
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.
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
223
self.__socket.close()
226
class SSHVendor(object):
227
"""Abstract base class for SSH vendor implementations."""
229
def connect_sftp(self, username, password, host, port):
230
"""Make an SSH connection, and return an SFTPClient.
232
:param username: an ascii string
233
:param password: an ascii string
234
:param host: a host name as an ascii string
235
:param port: a port number
238
:raises: ConnectionError if it cannot connect.
240
:rtype: paramiko.sftp_client.SFTPClient
242
raise NotImplementedError(self.connect_sftp)
244
def connect_ssh(self, username, password, host, port, command):
245
"""Make an SSH connection.
247
:returns: an SSHConnection.
249
raise NotImplementedError(self.connect_ssh)
251
def _raise_connection_error(self, host, port=None, orig_error=None,
252
msg='Unable to connect to SSH host'):
253
"""Raise a SocketConnectionError with properly formatted host.
255
This just unifies all the locations that try to raise ConnectionError,
256
so that they format things properly.
258
raise errors.SocketConnectionError(host=host, port=port, msg=msg,
259
orig_error=orig_error)
262
class LoopbackVendor(SSHVendor):
263
"""SSH "vendor" that connects over a plain TCP socket, not SSH."""
265
def connect_sftp(self, username, password, host, port):
266
sock = socket.socket()
268
sock.connect((host, port))
269
except socket.error, e:
270
self._raise_connection_error(host, port=port, orig_error=e)
271
return SFTPClient(SocketAsChannelAdapter(sock))
273
register_ssh_vendor('loopback', LoopbackVendor())
276
class ParamikoVendor(SSHVendor):
277
"""Vendor that uses paramiko."""
279
def _connect(self, username, password, host, port):
280
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
285
t = paramiko.Transport((host, port or 22))
286
t.set_log_channel('bzr.paramiko')
288
except (paramiko.SSHException, socket.error), e:
289
self._raise_connection_error(host, port=port, orig_error=e)
291
server_key = t.get_remote_server_key()
292
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
293
keytype = server_key.get_name()
294
if host in SYSTEM_HOSTKEYS and keytype in SYSTEM_HOSTKEYS[host]:
295
our_server_key = SYSTEM_HOSTKEYS[host][keytype]
296
our_server_key_hex = paramiko.util.hexify(
297
our_server_key.get_fingerprint())
298
elif host in BZR_HOSTKEYS and keytype in BZR_HOSTKEYS[host]:
299
our_server_key = BZR_HOSTKEYS[host][keytype]
300
our_server_key_hex = paramiko.util.hexify(
301
our_server_key.get_fingerprint())
303
trace.warning('Adding %s host key for %s: %s'
304
% (keytype, host, server_key_hex))
305
add = getattr(BZR_HOSTKEYS, 'add', None)
306
if add is not None: # paramiko >= 1.X.X
307
BZR_HOSTKEYS.add(host, keytype, server_key)
309
BZR_HOSTKEYS.setdefault(host, {})[keytype] = server_key
310
our_server_key = server_key
311
our_server_key_hex = paramiko.util.hexify(
312
our_server_key.get_fingerprint())
314
if server_key != our_server_key:
315
filename1 = os.path.expanduser('~/.ssh/known_hosts')
316
filename2 = osutils.pathjoin(config.config_dir(), 'ssh_host_keys')
317
raise errors.TransportError(
318
'Host keys for %s do not match! %s != %s' %
319
(host, our_server_key_hex, server_key_hex),
320
['Try editing %s or %s' % (filename1, filename2)])
322
_paramiko_auth(username, password, host, port, t)
325
def connect_sftp(self, username, password, host, port):
326
t = self._connect(username, password, host, port)
328
return t.open_sftp_client()
329
except paramiko.SSHException, e:
330
self._raise_connection_error(host, port=port, orig_error=e,
331
msg='Unable to start sftp client')
333
def connect_ssh(self, username, password, host, port, command):
334
t = self._connect(username, password, host, port)
336
channel = t.open_session()
337
cmdline = ' '.join(command)
338
channel.exec_command(cmdline)
339
return _ParamikoSSHConnection(channel)
340
except paramiko.SSHException, e:
341
self._raise_connection_error(host, port=port, orig_error=e,
342
msg='Unable to invoke remote bzr')
344
_ssh_connection_errors = (EOFError, OSError, IOError, socket.error)
345
if paramiko is not None:
346
vendor = ParamikoVendor()
347
register_ssh_vendor('paramiko', vendor)
348
register_ssh_vendor('none', vendor)
349
register_default_ssh_vendor(vendor)
350
_ssh_connection_errors += (paramiko.SSHException,)
354
class SubprocessVendor(SSHVendor):
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
362
def _connect(self, argv):
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,
379
**os_specific_subprocess_params())
380
if subproc_sock is not None:
382
return SSHSubprocessConnection(proc, sock=my_sock)
384
def connect_sftp(self, username, password, host, port):
386
argv = self._get_vendor_specific_argv(username, host, port,
388
sock = self._connect(argv)
389
return SFTPClient(SocketAsChannelAdapter(sock))
390
except _ssh_connection_errors, e:
391
self._raise_connection_error(host, port=port, orig_error=e)
393
def connect_ssh(self, username, password, host, port, command):
395
argv = self._get_vendor_specific_argv(username, host, port,
397
return self._connect(argv)
398
except _ssh_connection_errors, e:
399
self._raise_connection_error(host, port=port, orig_error=e)
401
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
403
"""Returns the argument list to run the subprocess with.
405
Exactly one of 'subsystem' and 'command' must be specified.
407
raise NotImplementedError(self._get_vendor_specific_argv)
410
class OpenSSHSubprocessVendor(SubprocessVendor):
411
"""SSH vendor that uses the 'ssh' executable from OpenSSH."""
413
executable_path = 'ssh'
415
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
417
args = [self.executable_path,
418
'-oForwardX11=no', '-oForwardAgent=no',
419
'-oClearAllForwardings=yes',
420
'-oNoHostAuthenticationForLocalhost=yes']
422
args.extend(['-p', str(port)])
423
if username is not None:
424
args.extend(['-l', username])
425
if subsystem is not None:
426
args.extend(['-s', host, subsystem])
428
args.extend([host] + command)
431
register_ssh_vendor('openssh', OpenSSHSubprocessVendor())
434
class SSHCorpSubprocessVendor(SubprocessVendor):
435
"""SSH vendor that uses the 'ssh' executable from SSH Corporation."""
437
executable_path = 'ssh'
439
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
441
args = [self.executable_path, '-x']
443
args.extend(['-p', str(port)])
444
if username is not None:
445
args.extend(['-l', username])
446
if subsystem is not None:
447
args.extend(['-s', subsystem, host])
449
args.extend([host] + command)
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())
476
class PLinkSubprocessVendor(SubprocessVendor):
477
"""SSH vendor that uses the 'plink' executable from Putty."""
479
executable_path = 'plink'
481
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
483
args = [self.executable_path, '-x', '-a', '-ssh', '-2', '-batch']
485
args.extend(['-P', str(port)])
486
if username is not None:
487
args.extend(['-l', username])
488
if subsystem is not None:
489
args.extend(['-s', host, subsystem])
491
args.extend([host] + command)
494
register_ssh_vendor('plink', PLinkSubprocessVendor())
497
def _paramiko_auth(username, password, host, port, paramiko_transport):
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.
502
username = auth.get_user('ssh', host, port=port,
503
default=getpass.getuser())
505
agent = paramiko.Agent()
506
for key in agent.get_keys():
507
trace.mutter('Trying SSH agent key %s'
508
% paramiko.util.hexify(key.get_fingerprint()))
510
paramiko_transport.auth_publickey(username, key)
512
except paramiko.SSHException, e:
515
# okay, try finding id_rsa or id_dss? (posix only)
516
if _try_pkey_auth(paramiko_transport, paramiko.RSAKey, username, 'id_rsa'):
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))
556
paramiko_transport.auth_password(username, password)
558
except paramiko.SSHException, e:
561
# give up and ask for a password
562
password = auth.get_password('ssh', host, username, port=port)
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))
576
def _try_pkey_auth(paramiko_transport, pkey_class, username, filename):
577
filename = os.path.expanduser('~/.ssh/' + filename)
579
key = pkey_class.from_private_key_file(filename)
580
paramiko_transport.auth_publickey(username, key)
582
except paramiko.PasswordRequiredException:
583
password = ui.ui_factory.get_password(
584
prompt=u'SSH %(filename)s password',
585
filename=filename.decode(osutils._fs_enc))
587
key = pkey_class.from_private_key_file(filename, password)
588
paramiko_transport.auth_publickey(username, key)
590
except paramiko.SSHException:
591
trace.mutter('SSH authentication via %s key failed.'
592
% (os.path.basename(filename),))
593
except paramiko.SSHException:
594
trace.mutter('SSH authentication via %s key failed.'
595
% (os.path.basename(filename),))
601
def load_host_keys():
603
Load system host keys (probably doesn't work on windows) and any
604
"discovered" keys from previous sessions.
606
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
608
SYSTEM_HOSTKEYS = paramiko.util.load_host_keys(
609
os.path.expanduser('~/.ssh/known_hosts'))
611
trace.mutter('failed to load system host keys: ' + str(e))
612
bzr_hostkey_path = osutils.pathjoin(config.config_dir(), 'ssh_host_keys')
614
BZR_HOSTKEYS = paramiko.util.load_host_keys(bzr_hostkey_path)
616
trace.mutter('failed to load bzr host keys: ' + str(e))
620
def save_host_keys():
622
Save "discovered" host keys in $(config)/ssh_host_keys/.
624
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
625
bzr_hostkey_path = osutils.pathjoin(config.config_dir(), 'ssh_host_keys')
626
config.ensure_config_dir_exists()
629
f = open(bzr_hostkey_path, 'w')
630
f.write('# SSH host keys collected by bzr\n')
631
for hostname, keys in BZR_HOSTKEYS.iteritems():
632
for keytype, key in keys.iteritems():
633
f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
636
trace.mutter('failed to save bzr host keys: ' + str(e))
639
def os_specific_subprocess_params():
640
"""Get O/S specific subprocess parameters."""
641
if sys.platform == 'win32':
642
# setting the process group and closing fds is not supported on
646
# We close fds other than the pipes as the child process does not need
649
# We also set the child process to ignore SIGINT. Normally the signal
650
# would be sent to every process in the foreground process group, but
651
# this causes it to be seen only by bzr and not by ssh. Python will
652
# generate a KeyboardInterrupt in bzr, and we will then have a chance
653
# to release locks or do other cleanup over ssh before the connection
655
# <https://launchpad.net/products/bzr/+bug/5987>
657
# Running it in a separate process group is not good because then it
658
# can't get non-echoed input of a password or passphrase.
659
# <https://launchpad.net/products/bzr/+bug/40508>
660
return {'preexec_fn': _ignore_signals,
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))
732
def send(self, data):
733
if self._sock is not None:
734
return self._sock.send(data)
736
return os.write(self.proc.stdin.fileno(), data)
738
def recv(self, count):
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
