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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
"""Foundation SSH support for SFTP and smart server."""
38
except ImportError, e:
39
# If we have an ssh subprocess, we don't strictly need paramiko for all ssh
43
from paramiko.sftp_client import SFTPClient
50
_paramiko_version = getattr(paramiko, '__version_info__', (0, 0, 0))
52
# Paramiko 1.5 tries to open a socket.AF_UNIX in order to connect
53
# to ssh-agent. That attribute doesn't exist on win32 (it does in cygwin)
54
# so we get an AttributeError exception. So we will not try to
55
# connect to an agent if we are on win32 and using Paramiko older than 1.6
56
_use_ssh_agent = (sys.platform != 'win32' or _paramiko_version >= (1, 6, 0))
59
class SSHVendorManager(object):
60
"""Manager for manage SSH vendors."""
62
# Note, although at first sign the class interface seems similar to
63
# bzrlib.registry.Registry it is not possible/convenient to directly use
64
# the Registry because the class just has "get()" interface instead of the
65
# Registry's "get(key)".
68
self._ssh_vendors = {}
69
self._cached_ssh_vendor = None
70
self._default_ssh_vendor = None
72
def register_default_vendor(self, vendor):
73
"""Register default SSH vendor."""
74
self._default_ssh_vendor = vendor
76
def register_vendor(self, name, vendor):
77
"""Register new SSH vendor by name."""
78
self._ssh_vendors[name] = vendor
80
def clear_cache(self):
81
"""Clear previously cached lookup result."""
82
self._cached_ssh_vendor = None
84
def _get_vendor_by_environment(self, environment=None):
85
"""Return the vendor or None based on BZR_SSH environment variable.
87
:raises UnknownSSH: if the BZR_SSH environment variable contains
90
if environment is None:
91
environment = os.environ
92
if 'BZR_SSH' in environment:
93
vendor_name = environment['BZR_SSH']
95
vendor = self._ssh_vendors[vendor_name]
97
raise errors.UnknownSSH(vendor_name)
101
def _get_ssh_version_string(self, args):
102
"""Return SSH version string from the subprocess."""
104
p = subprocess.Popen(args,
105
stdout=subprocess.PIPE,
106
stderr=subprocess.PIPE,
107
**os_specific_subprocess_params())
108
stdout, stderr = p.communicate()
111
return stdout + stderr
113
def _get_vendor_by_version_string(self, version, args):
114
"""Return the vendor or None based on output from the subprocess.
116
:param version: The output of 'ssh -V' like command.
117
:param args: Command line that was run.
120
if 'OpenSSH' in version:
121
trace.mutter('ssh implementation is OpenSSH')
122
vendor = OpenSSHSubprocessVendor()
123
elif 'SSH Secure Shell' in version:
124
trace.mutter('ssh implementation is SSH Corp.')
125
vendor = SSHCorpSubprocessVendor()
126
elif 'plink' in version and args[0] == 'plink':
127
# Checking if "plink" was the executed argument as Windows
128
# sometimes reports 'ssh -V' incorrectly with 'plink' in it's
129
# version. See https://bugs.launchpad.net/bzr/+bug/107155
130
trace.mutter("ssh implementation is Putty's plink.")
131
vendor = PLinkSubprocessVendor()
134
def _get_vendor_by_inspection(self):
135
"""Return the vendor or None by checking for known SSH implementations."""
136
for args in (['ssh', '-V'], ['plink', '-V']):
137
version = self._get_ssh_version_string(args)
138
vendor = self._get_vendor_by_version_string(version, args)
139
if vendor is not None:
143
def get_vendor(self, environment=None):
144
"""Find out what version of SSH is on the system.
146
:raises SSHVendorNotFound: if no any SSH vendor is found
147
:raises UnknownSSH: if the BZR_SSH environment variable contains
150
if self._cached_ssh_vendor is None:
151
vendor = self._get_vendor_by_environment(environment)
153
vendor = self._get_vendor_by_inspection()
155
trace.mutter('falling back to default implementation')
156
vendor = self._default_ssh_vendor
158
raise errors.SSHVendorNotFound()
159
self._cached_ssh_vendor = vendor
160
return self._cached_ssh_vendor
162
_ssh_vendor_manager = SSHVendorManager()
163
_get_ssh_vendor = _ssh_vendor_manager.get_vendor
164
register_default_ssh_vendor = _ssh_vendor_manager.register_default_vendor
165
register_ssh_vendor = _ssh_vendor_manager.register_vendor
168
def _ignore_sigint():
169
# TODO: This should possibly ignore SIGHUP as well, but bzr currently
170
# doesn't handle it itself.
171
# <https://launchpad.net/products/bzr/+bug/41433/+index>
173
signal.signal(signal.SIGINT, signal.SIG_IGN)
176
class SocketAsChannelAdapter(object):
177
"""Simple wrapper for a socket that pretends to be a paramiko Channel."""
179
def __init__(self, sock):
183
return "bzr SocketAsChannelAdapter"
185
def send(self, data):
186
return self.__socket.send(data)
190
return self.__socket.recv(n)
191
except socket.error, e:
192
if e.args[0] in (errno.EPIPE, errno.ECONNRESET, errno.ECONNABORTED,
194
# Connection has closed. Paramiko expects an empty string in
195
# this case, not an exception.
199
def recv_ready(self):
200
# TODO: jam 20051215 this function is necessary to support the
201
# pipelined() function. In reality, it probably should use
202
# poll() or select() to actually return if there is data
203
# available, otherwise we probably don't get any benefit
207
self.__socket.close()
210
class SSHVendor(object):
211
"""Abstract base class for SSH vendor implementations."""
213
def connect_sftp(self, username, password, host, port):
214
"""Make an SSH connection, and return an SFTPClient.
216
:param username: an ascii string
217
:param password: an ascii string
218
:param host: a host name as an ascii string
219
:param port: a port number
222
:raises: ConnectionError if it cannot connect.
224
:rtype: paramiko.sftp_client.SFTPClient
226
raise NotImplementedError(self.connect_sftp)
228
def connect_ssh(self, username, password, host, port, command):
229
"""Make an SSH connection.
231
:returns: something with a `close` method, and a `get_filelike_channels`
232
method that returns a pair of (read, write) filelike objects.
234
raise NotImplementedError(self.connect_ssh)
236
def _raise_connection_error(self, host, port=None, orig_error=None,
237
msg='Unable to connect to SSH host'):
238
"""Raise a SocketConnectionError with properly formatted host.
240
This just unifies all the locations that try to raise ConnectionError,
241
so that they format things properly.
243
raise errors.SocketConnectionError(host=host, port=port, msg=msg,
244
orig_error=orig_error)
247
class LoopbackVendor(SSHVendor):
248
"""SSH "vendor" that connects over a plain TCP socket, not SSH."""
250
def connect_sftp(self, username, password, host, port):
251
sock = socket.socket()
253
sock.connect((host, port))
254
except socket.error, e:
255
self._raise_connection_error(host, port=port, orig_error=e)
256
return SFTPClient(SocketAsChannelAdapter(sock))
258
register_ssh_vendor('loopback', LoopbackVendor())
261
class _ParamikoSSHConnection(object):
262
def __init__(self, channel):
263
self.channel = channel
265
def get_filelike_channels(self):
266
return self.channel.makefile('rb'), self.channel.makefile('wb')
269
return self.channel.close()
272
class ParamikoVendor(SSHVendor):
273
"""Vendor that uses paramiko."""
275
def _connect(self, username, password, host, port):
276
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
281
t = paramiko.Transport((host, port or 22))
282
t.set_log_channel('bzr.paramiko')
284
except (paramiko.SSHException, socket.error), e:
285
self._raise_connection_error(host, port=port, orig_error=e)
287
server_key = t.get_remote_server_key()
288
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
289
keytype = server_key.get_name()
290
if host in SYSTEM_HOSTKEYS and keytype in SYSTEM_HOSTKEYS[host]:
291
our_server_key = SYSTEM_HOSTKEYS[host][keytype]
292
our_server_key_hex = paramiko.util.hexify(
293
our_server_key.get_fingerprint())
294
elif host in BZR_HOSTKEYS and keytype in BZR_HOSTKEYS[host]:
295
our_server_key = BZR_HOSTKEYS[host][keytype]
296
our_server_key_hex = paramiko.util.hexify(
297
our_server_key.get_fingerprint())
299
trace.warning('Adding %s host key for %s: %s'
300
% (keytype, host, server_key_hex))
301
add = getattr(BZR_HOSTKEYS, 'add', None)
302
if add is not None: # paramiko >= 1.X.X
303
BZR_HOSTKEYS.add(host, keytype, server_key)
305
BZR_HOSTKEYS.setdefault(host, {})[keytype] = server_key
306
our_server_key = server_key
307
our_server_key_hex = paramiko.util.hexify(
308
our_server_key.get_fingerprint())
310
if server_key != our_server_key:
311
filename1 = os.path.expanduser('~/.ssh/known_hosts')
312
filename2 = osutils.pathjoin(config.config_dir(), 'ssh_host_keys')
313
raise errors.TransportError(
314
'Host keys for %s do not match! %s != %s' %
315
(host, our_server_key_hex, server_key_hex),
316
['Try editing %s or %s' % (filename1, filename2)])
318
_paramiko_auth(username, password, host, port, t)
321
def connect_sftp(self, username, password, host, port):
322
t = self._connect(username, password, host, port)
324
return t.open_sftp_client()
325
except paramiko.SSHException, e:
326
self._raise_connection_error(host, port=port, orig_error=e,
327
msg='Unable to start sftp client')
329
def connect_ssh(self, username, password, host, port, command):
330
t = self._connect(username, password, host, port)
332
channel = t.open_session()
333
cmdline = ' '.join(command)
334
channel.exec_command(cmdline)
335
return _ParamikoSSHConnection(channel)
336
except paramiko.SSHException, e:
337
self._raise_connection_error(host, port=port, orig_error=e,
338
msg='Unable to invoke remote bzr')
340
if paramiko is not None:
341
vendor = ParamikoVendor()
342
register_ssh_vendor('paramiko', vendor)
343
register_ssh_vendor('none', vendor)
344
register_default_ssh_vendor(vendor)
345
_sftp_connection_errors = (EOFError, paramiko.SSHException)
348
_sftp_connection_errors = (EOFError,)
351
class SubprocessVendor(SSHVendor):
352
"""Abstract base class for vendors that use pipes to a subprocess."""
354
def _connect(self, argv):
355
proc = subprocess.Popen(argv,
356
stdin=subprocess.PIPE,
357
stdout=subprocess.PIPE,
358
**os_specific_subprocess_params())
359
return SSHSubprocess(proc)
361
def connect_sftp(self, username, password, host, port):
363
argv = self._get_vendor_specific_argv(username, host, port,
365
sock = self._connect(argv)
366
return SFTPClient(SocketAsChannelAdapter(sock))
367
except _sftp_connection_errors, e:
368
self._raise_connection_error(host, port=port, orig_error=e)
369
except (OSError, IOError), e:
370
# If the machine is fast enough, ssh can actually exit
371
# before we try and send it the sftp request, which
372
# raises a Broken Pipe
373
if e.errno not in (errno.EPIPE,):
375
self._raise_connection_error(host, port=port, orig_error=e)
377
def connect_ssh(self, username, password, host, port, command):
379
argv = self._get_vendor_specific_argv(username, host, port,
381
return self._connect(argv)
382
except (EOFError), e:
383
self._raise_connection_error(host, port=port, orig_error=e)
384
except (OSError, IOError), e:
385
# If the machine is fast enough, ssh can actually exit
386
# before we try and send it the sftp request, which
387
# raises a Broken Pipe
388
if e.errno not in (errno.EPIPE,):
390
self._raise_connection_error(host, port=port, orig_error=e)
392
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
394
"""Returns the argument list to run the subprocess with.
396
Exactly one of 'subsystem' and 'command' must be specified.
398
raise NotImplementedError(self._get_vendor_specific_argv)
401
class OpenSSHSubprocessVendor(SubprocessVendor):
402
"""SSH vendor that uses the 'ssh' executable from OpenSSH."""
404
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
407
'-oForwardX11=no', '-oForwardAgent=no',
408
'-oClearAllForwardings=yes', '-oProtocol=2',
409
'-oNoHostAuthenticationForLocalhost=yes']
411
args.extend(['-p', str(port)])
412
if username is not None:
413
args.extend(['-l', username])
414
if subsystem is not None:
415
args.extend(['-s', host, subsystem])
417
args.extend([host] + command)
420
register_ssh_vendor('openssh', OpenSSHSubprocessVendor())
423
class SSHCorpSubprocessVendor(SubprocessVendor):
424
"""SSH vendor that uses the 'ssh' executable from SSH Corporation."""
426
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
430
args.extend(['-p', str(port)])
431
if username is not None:
432
args.extend(['-l', username])
433
if subsystem is not None:
434
args.extend(['-s', subsystem, host])
436
args.extend([host] + command)
439
register_ssh_vendor('ssh', SSHCorpSubprocessVendor())
442
class PLinkSubprocessVendor(SubprocessVendor):
443
"""SSH vendor that uses the 'plink' executable from Putty."""
445
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
447
args = ['plink', '-x', '-a', '-ssh', '-2', '-batch']
449
args.extend(['-P', str(port)])
450
if username is not None:
451
args.extend(['-l', username])
452
if subsystem is not None:
453
args.extend(['-s', host, subsystem])
455
args.extend([host] + command)
458
register_ssh_vendor('plink', PLinkSubprocessVendor())
461
def _paramiko_auth(username, password, host, port, paramiko_transport):
462
auth = config.AuthenticationConfig()
463
# paramiko requires a username, but it might be none if nothing was
464
# supplied. If so, use the local username.
466
username = auth.get_user('ssh', host, port=port,
467
default=getpass.getuser())
469
agent = paramiko.Agent()
470
for key in agent.get_keys():
471
trace.mutter('Trying SSH agent key %s'
472
% paramiko.util.hexify(key.get_fingerprint()))
474
paramiko_transport.auth_publickey(username, key)
476
except paramiko.SSHException, e:
479
# okay, try finding id_rsa or id_dss? (posix only)
480
if _try_pkey_auth(paramiko_transport, paramiko.RSAKey, username, 'id_rsa'):
482
if _try_pkey_auth(paramiko_transport, paramiko.DSSKey, username, 'id_dsa'):
485
# If we have gotten this far, we are about to try for passwords, do an
486
# auth_none check to see if it is even supported.
487
supported_auth_types = []
489
# Note that with paramiko <1.7.5 this logs an INFO message:
490
# Authentication type (none) not permitted.
491
# So we explicitly disable the logging level for this action
492
old_level = paramiko_transport.logger.level
493
paramiko_transport.logger.setLevel(logging.WARNING)
495
paramiko_transport.auth_none(username)
497
paramiko_transport.logger.setLevel(old_level)
498
except paramiko.BadAuthenticationType, e:
499
# Supported methods are in the exception
500
supported_auth_types = e.allowed_types
501
except paramiko.SSHException, e:
502
# Don't know what happened, but just ignore it
504
if 'password' not in supported_auth_types:
505
raise errors.ConnectionError('Unable to authenticate to SSH host as'
506
'\n %s@%s\nsupported auth types: %s'
507
% (username, host, supported_auth_types))
511
paramiko_transport.auth_password(username, password)
513
except paramiko.SSHException, e:
516
# give up and ask for a password
517
password = auth.get_password('ssh', host, username, port=port)
518
# get_password can still return None, which means we should not prompt
519
if password is not None:
521
paramiko_transport.auth_password(username, password)
522
except paramiko.SSHException, e:
523
raise errors.ConnectionError(
524
'Unable to authenticate to SSH host as'
525
'\n %s@%s\n' % (username, host), e)
527
raise errors.ConnectionError('Unable to authenticate to SSH host as'
528
' %s@%s' % (username, host))
531
def _try_pkey_auth(paramiko_transport, pkey_class, username, filename):
532
filename = os.path.expanduser('~/.ssh/' + filename)
534
key = pkey_class.from_private_key_file(filename)
535
paramiko_transport.auth_publickey(username, key)
537
except paramiko.PasswordRequiredException:
538
password = ui.ui_factory.get_password(
539
prompt='SSH %(filename)s password', filename=filename)
541
key = pkey_class.from_private_key_file(filename, password)
542
paramiko_transport.auth_publickey(username, key)
544
except paramiko.SSHException:
545
trace.mutter('SSH authentication via %s key failed.'
546
% (os.path.basename(filename),))
547
except paramiko.SSHException:
548
trace.mutter('SSH authentication via %s key failed.'
549
% (os.path.basename(filename),))
555
def load_host_keys():
557
Load system host keys (probably doesn't work on windows) and any
558
"discovered" keys from previous sessions.
560
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
562
SYSTEM_HOSTKEYS = paramiko.util.load_host_keys(
563
os.path.expanduser('~/.ssh/known_hosts'))
565
trace.mutter('failed to load system host keys: ' + str(e))
566
bzr_hostkey_path = osutils.pathjoin(config.config_dir(), 'ssh_host_keys')
568
BZR_HOSTKEYS = paramiko.util.load_host_keys(bzr_hostkey_path)
570
trace.mutter('failed to load bzr host keys: ' + str(e))
574
def save_host_keys():
576
Save "discovered" host keys in $(config)/ssh_host_keys/.
578
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
579
bzr_hostkey_path = osutils.pathjoin(config.config_dir(), 'ssh_host_keys')
580
config.ensure_config_dir_exists()
583
f = open(bzr_hostkey_path, 'w')
584
f.write('# SSH host keys collected by bzr\n')
585
for hostname, keys in BZR_HOSTKEYS.iteritems():
586
for keytype, key in keys.iteritems():
587
f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
590
trace.mutter('failed to save bzr host keys: ' + str(e))
593
def os_specific_subprocess_params():
594
"""Get O/S specific subprocess parameters."""
595
if sys.platform == 'win32':
596
# setting the process group and closing fds is not supported on
600
# We close fds other than the pipes as the child process does not need
603
# We also set the child process to ignore SIGINT. Normally the signal
604
# would be sent to every process in the foreground process group, but
605
# this causes it to be seen only by bzr and not by ssh. Python will
606
# generate a KeyboardInterrupt in bzr, and we will then have a chance
607
# to release locks or do other cleanup over ssh before the connection
609
# <https://launchpad.net/products/bzr/+bug/5987>
611
# Running it in a separate process group is not good because then it
612
# can't get non-echoed input of a password or passphrase.
613
# <https://launchpad.net/products/bzr/+bug/40508>
614
return {'preexec_fn': _ignore_sigint,
619
class SSHSubprocess(object):
620
"""A socket-like object that talks to an ssh subprocess via pipes."""
622
def __init__(self, proc):
625
def send(self, data):
626
return os.write(self.proc.stdin.fileno(), data)
628
def recv(self, count):
629
return os.read(self.proc.stdout.fileno(), count)
632
self.proc.stdin.close()
633
self.proc.stdout.close()
636
def get_filelike_channels(self):
637
return (self.proc.stdout, self.proc.stdin)
added
removed
bzrlib/transport/ssh.py
