1
# Copyright (C) 2005 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
"""Foundation SSH support for SFTP and smart server."""
27
from bzrlib.config import config_dir, ensure_config_dir_exists
28
from bzrlib.errors import (ConnectionError,
30
SocketConnectionError,
36
from bzrlib.osutils import pathjoin
37
from bzrlib.trace import mutter, warning
42
except ImportError, e:
43
# If we have an ssh subprocess, we don't strictly need paramiko for all ssh
47
from paramiko.sftp_client import SFTPClient
54
_paramiko_version = getattr(paramiko, '__version_info__', (0, 0, 0))
56
# Paramiko 1.5 tries to open a socket.AF_UNIX in order to connect
57
# to ssh-agent. That attribute doesn't exist on win32 (it does in cygwin)
58
# so we get an AttributeError exception. So we will not try to
59
# connect to an agent if we are on win32 and using Paramiko older than 1.6
60
_use_ssh_agent = (sys.platform != 'win32' or _paramiko_version >= (1, 6, 0))
63
class SSHVendorManager(object):
64
"""Manager for manage SSH vendors."""
66
# Note, although at first sign the class interface seems similar to
67
# bzrlib.registry.Registry it is not possible/convenient to directly use
68
# the Registry because the class just has "get()" interface instead of the
69
# Registry's "get(key)".
72
self._ssh_vendors = {}
73
self._cached_ssh_vendor = None
74
self._default_ssh_vendor = None
76
def register_default_vendor(self, vendor):
77
"""Register default SSH vendor."""
78
self._default_ssh_vendor = vendor
80
def register_vendor(self, name, vendor):
81
"""Register new SSH vendor by name."""
82
self._ssh_vendors[name] = vendor
84
def clear_cache(self):
85
"""Clear previously cached lookup result."""
86
self._cached_ssh_vendor = None
88
def _get_vendor_by_environment(self, environment=None):
89
"""Return the vendor or None based on BZR_SSH environment variable.
91
:raises UnknownSSH: if the BZR_SSH environment variable contains
94
if environment is None:
95
environment = os.environ
96
if 'BZR_SSH' in environment:
97
vendor_name = environment['BZR_SSH']
99
vendor = self._ssh_vendors[vendor_name]
101
raise UnknownSSH(vendor_name)
105
def _get_ssh_version_string(self, args):
106
"""Return SSH version string from the subprocess."""
108
p = subprocess.Popen(args,
109
stdout=subprocess.PIPE,
110
stderr=subprocess.PIPE,
111
**os_specific_subprocess_params())
112
stdout, stderr = p.communicate()
115
return stdout + stderr
117
def _get_vendor_by_version_string(self, version, args):
118
"""Return the vendor or None based on output from the subprocess.
120
:param version: The output of 'ssh -V' like command.
121
:param args: Command line that was run.
124
if 'OpenSSH' in version:
125
mutter('ssh implementation is OpenSSH')
126
vendor = OpenSSHSubprocessVendor()
127
elif 'SSH Secure Shell' in version:
128
mutter('ssh implementation is SSH Corp.')
129
vendor = SSHCorpSubprocessVendor()
130
elif 'plink' in version and args[0] == 'plink':
131
# Checking if "plink" was the executed argument as Windows sometimes
132
# reports 'ssh -V' incorrectly with 'plink' in it's version.
133
# See https://bugs.launchpad.net/bzr/+bug/107155
134
mutter("ssh implementation is Putty's plink.")
135
vendor = PLinkSubprocessVendor()
138
def _get_vendor_by_inspection(self):
139
"""Return the vendor or None by checking for known SSH implementations."""
140
for args in [['ssh', '-V'], ['plink', '-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:
147
def get_vendor(self, environment=None):
148
"""Find out what version of SSH is on the system.
150
:raises SSHVendorNotFound: if no any SSH vendor is found
151
:raises UnknownSSH: if the BZR_SSH environment variable contains
154
if self._cached_ssh_vendor is None:
155
vendor = self._get_vendor_by_environment(environment)
157
vendor = self._get_vendor_by_inspection()
159
mutter('falling back to default implementation')
160
vendor = self._default_ssh_vendor
162
raise SSHVendorNotFound()
163
self._cached_ssh_vendor = vendor
164
return self._cached_ssh_vendor
166
_ssh_vendor_manager = SSHVendorManager()
167
_get_ssh_vendor = _ssh_vendor_manager.get_vendor
168
register_default_ssh_vendor = _ssh_vendor_manager.register_default_vendor
169
register_ssh_vendor = _ssh_vendor_manager.register_vendor
172
def _ignore_sigint():
173
# TODO: This should possibly ignore SIGHUP as well, but bzr currently
174
# doesn't handle it itself.
175
# <https://launchpad.net/products/bzr/+bug/41433/+index>
177
signal.signal(signal.SIGINT, signal.SIG_IGN)
180
class LoopbackSFTP(object):
181
"""Simple wrapper for a socket that pretends to be a paramiko Channel."""
183
def __init__(self, sock):
186
def send(self, data):
187
return self.__socket.send(data)
190
return self.__socket.recv(n)
192
def recv_ready(self):
196
self.__socket.close()
199
class SSHVendor(object):
200
"""Abstract base class for SSH vendor implementations."""
202
def connect_sftp(self, username, password, host, port):
203
"""Make an SSH connection, and return an SFTPClient.
205
:param username: an ascii string
206
:param password: an ascii string
207
:param host: a host name as an ascii string
208
:param port: a port number
211
:raises: ConnectionError if it cannot connect.
213
:rtype: paramiko.sftp_client.SFTPClient
215
raise NotImplementedError(self.connect_sftp)
217
def connect_ssh(self, username, password, host, port, command):
218
"""Make an SSH connection.
220
:returns: something with a `close` method, and a `get_filelike_channels`
221
method that returns a pair of (read, write) filelike objects.
223
raise NotImplementedError(self.connect_ssh)
225
def _raise_connection_error(self, host, port=None, orig_error=None,
226
msg='Unable to connect to SSH host'):
227
"""Raise a SocketConnectionError with properly formatted host.
229
This just unifies all the locations that try to raise ConnectionError,
230
so that they format things properly.
232
raise SocketConnectionError(host=host, port=port, msg=msg,
233
orig_error=orig_error)
236
class LoopbackVendor(SSHVendor):
237
"""SSH "vendor" that connects over a plain TCP socket, not SSH."""
239
def connect_sftp(self, username, password, host, port):
240
sock = socket.socket()
242
sock.connect((host, port))
243
except socket.error, e:
244
self._raise_connection_error(host, port=port, orig_error=e)
245
return SFTPClient(LoopbackSFTP(sock))
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()
261
class ParamikoVendor(SSHVendor):
262
"""Vendor that uses paramiko."""
264
def _connect(self, username, password, host, port):
265
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
270
t = paramiko.Transport((host, port or 22))
271
t.set_log_channel('bzr.paramiko')
273
except (paramiko.SSHException, socket.error), e:
274
self._raise_connection_error(host, port=port, orig_error=e)
276
server_key = t.get_remote_server_key()
277
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
278
keytype = server_key.get_name()
279
if host in SYSTEM_HOSTKEYS and keytype in SYSTEM_HOSTKEYS[host]:
280
our_server_key = SYSTEM_HOSTKEYS[host][keytype]
281
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
282
elif host in BZR_HOSTKEYS and keytype in BZR_HOSTKEYS[host]:
283
our_server_key = BZR_HOSTKEYS[host][keytype]
284
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
286
warning('Adding %s host key for %s: %s' % (keytype, host, server_key_hex))
287
add = getattr(BZR_HOSTKEYS, 'add', None)
288
if add is not None: # paramiko >= 1.X.X
289
BZR_HOSTKEYS.add(host, keytype, server_key)
291
BZR_HOSTKEYS.setdefault(host, {})[keytype] = server_key
292
our_server_key = server_key
293
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
295
if server_key != our_server_key:
296
filename1 = os.path.expanduser('~/.ssh/known_hosts')
297
filename2 = pathjoin(config_dir(), 'ssh_host_keys')
298
raise TransportError('Host keys for %s do not match! %s != %s' % \
299
(host, our_server_key_hex, server_key_hex),
300
['Try editing %s or %s' % (filename1, filename2)])
302
_paramiko_auth(username, password, host, t)
305
def connect_sftp(self, username, password, host, port):
306
t = self._connect(username, password, host, port)
308
return t.open_sftp_client()
309
except paramiko.SSHException, e:
310
self._raise_connection_error(host, port=port, orig_error=e,
311
msg='Unable to start sftp client')
313
def connect_ssh(self, username, password, host, port, command):
314
t = self._connect(username, password, host, port)
316
channel = t.open_session()
317
cmdline = ' '.join(command)
318
channel.exec_command(cmdline)
319
return _ParamikoSSHConnection(channel)
320
except paramiko.SSHException, e:
321
self._raise_connection_error(host, port=port, orig_error=e,
322
msg='Unable to invoke remote bzr')
324
if paramiko is not None:
325
vendor = ParamikoVendor()
326
register_ssh_vendor('paramiko', vendor)
327
register_ssh_vendor('none', vendor)
328
register_default_ssh_vendor(vendor)
332
class SubprocessVendor(SSHVendor):
333
"""Abstract base class for vendors that use pipes to a subprocess."""
335
def _connect(self, argv):
336
proc = subprocess.Popen(argv,
337
stdin=subprocess.PIPE,
338
stdout=subprocess.PIPE,
339
**os_specific_subprocess_params())
340
return SSHSubprocess(proc)
342
def connect_sftp(self, username, password, host, port):
344
argv = self._get_vendor_specific_argv(username, host, port,
346
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,):
356
self._raise_connection_error(host, port=port, orig_error=e)
358
def connect_ssh(self, username, password, host, port, command):
360
argv = self._get_vendor_specific_argv(username, host, port,
362
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,):
371
self._raise_connection_error(host, port=port, orig_error=e)
373
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
375
"""Returns the argument list to run the subprocess with.
377
Exactly one of 'subsystem' and 'command' must be specified.
379
raise NotImplementedError(self._get_vendor_specific_argv)
382
class OpenSSHSubprocessVendor(SubprocessVendor):
383
"""SSH vendor that uses the 'ssh' executable from OpenSSH."""
385
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')
393
'-oForwardX11=no', '-oForwardAgent=no',
394
'-oClearAllForwardings=yes', '-oProtocol=2',
395
'-oNoHostAuthenticationForLocalhost=yes']
397
args.extend(['-p', str(port)])
398
if username is not None:
399
args.extend(['-l', username])
400
if subsystem is not None:
401
args.extend(['-s', host, subsystem])
403
args.extend([host] + command)
406
register_ssh_vendor('openssh', OpenSSHSubprocessVendor())
409
class SSHCorpSubprocessVendor(SubprocessVendor):
410
"""SSH vendor that uses the 'ssh' executable from SSH Corporation."""
412
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
414
assert subsystem is not None or command is not None, (
415
'Must specify a command or subsystem')
416
if subsystem is not None:
417
assert command is None, (
418
'subsystem and command are mutually exclusive')
421
args.extend(['-p', str(port)])
422
if username is not None:
423
args.extend(['-l', username])
424
if subsystem is not None:
425
args.extend(['-s', subsystem, host])
427
args.extend([host] + command)
430
register_ssh_vendor('ssh', SSHCorpSubprocessVendor())
433
class PLinkSubprocessVendor(SubprocessVendor):
434
"""SSH vendor that uses the 'plink' executable from Putty."""
436
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']
445
args.extend(['-P', str(port)])
446
if username is not None:
447
args.extend(['-l', username])
448
if subsystem is not None:
449
args.extend(['-s', host, subsystem])
451
args.extend([host] + command)
454
register_ssh_vendor('plink', PLinkSubprocessVendor())
457
def _paramiko_auth(username, password, host, 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
username = username or getpass.getuser()
467
agent = paramiko.Agent()
468
for key in agent.get_keys():
469
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
471
paramiko_transport.auth_publickey(username, key)
473
except paramiko.SSHException, e:
476
# okay, try finding id_rsa or id_dss? (posix only)
477
if _try_pkey_auth(paramiko_transport, paramiko.RSAKey, username, 'id_rsa'):
479
if _try_pkey_auth(paramiko_transport, paramiko.DSSKey, username, 'id_dsa'):
484
paramiko_transport.auth_password(username, password)
486
except paramiko.SSHException, e:
489
# give up and ask for a password
490
password = bzrlib.ui.ui_factory.get_password(
491
prompt='SSH %(user)s@%(host)s password',
492
user=username, host=host)
494
paramiko_transport.auth_password(username, password)
495
except paramiko.SSHException, e:
496
raise ConnectionError('Unable to authenticate to SSH host as %s@%s' %
500
def _try_pkey_auth(paramiko_transport, pkey_class, username, filename):
501
filename = os.path.expanduser('~/.ssh/' + filename)
503
key = pkey_class.from_private_key_file(filename)
504
paramiko_transport.auth_publickey(username, key)
506
except paramiko.PasswordRequiredException:
507
password = bzrlib.ui.ui_factory.get_password(
508
prompt='SSH %(filename)s password',
511
key = pkey_class.from_private_key_file(filename, password)
512
paramiko_transport.auth_publickey(username, key)
514
except paramiko.SSHException:
515
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
516
except paramiko.SSHException:
517
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
523
def load_host_keys():
525
Load system host keys (probably doesn't work on windows) and any
526
"discovered" keys from previous sessions.
528
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
530
SYSTEM_HOSTKEYS = paramiko.util.load_host_keys(os.path.expanduser('~/.ssh/known_hosts'))
532
mutter('failed to load system host keys: ' + str(e))
533
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
535
BZR_HOSTKEYS = paramiko.util.load_host_keys(bzr_hostkey_path)
537
mutter('failed to load bzr host keys: ' + str(e))
541
def save_host_keys():
543
Save "discovered" host keys in $(config)/ssh_host_keys/.
545
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
546
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
547
ensure_config_dir_exists()
550
f = open(bzr_hostkey_path, 'w')
551
f.write('# SSH host keys collected by bzr\n')
552
for hostname, keys in BZR_HOSTKEYS.iteritems():
553
for keytype, key in keys.iteritems():
554
f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
557
mutter('failed to save bzr host keys: ' + str(e))
560
def os_specific_subprocess_params():
561
"""Get O/S specific subprocess parameters."""
562
if sys.platform == 'win32':
563
# setting the process group and closing fds is not supported on
567
# We close fds other than the pipes as the child process does not need
570
# We also set the child process to ignore SIGINT. Normally the signal
571
# would be sent to every process in the foreground process group, but
572
# this causes it to be seen only by bzr and not by ssh. Python will
573
# generate a KeyboardInterrupt in bzr, and we will then have a chance
574
# to release locks or do other cleanup over ssh before the connection
576
# <https://launchpad.net/products/bzr/+bug/5987>
578
# Running it in a separate process group is not good because then it
579
# can't get non-echoed input of a password or passphrase.
580
# <https://launchpad.net/products/bzr/+bug/40508>
581
return {'preexec_fn': _ignore_sigint,
586
class SSHSubprocess(object):
587
"""A socket-like object that talks to an ssh subprocess via pipes."""
589
def __init__(self, proc):
592
def send(self, data):
593
return os.write(self.proc.stdin.fileno(), data)
595
def recv_ready(self):
596
# TODO: jam 20051215 this function is necessary to support the
597
# pipelined() function. In reality, it probably should use
598
# poll() or select() to actually return if there is data
599
# available, otherwise we probably don't get any benefit
602
def recv(self, count):
603
return os.read(self.proc.stdout.fileno(), count)
606
self.proc.stdin.close()
607
self.proc.stdout.close()
610
def get_filelike_channels(self):
611
return (self.proc.stdout, self.proc.stdin)
added
removed
bzrlib/transport/ssh.py
