14
14
# You should have received a copy of the GNU General Public License
15
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
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
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
113
114
stdout = stderr = ''
114
115
return stdout + stderr
116
def _get_vendor_by_version_string(self, version, progname):
117
def _get_vendor_by_version_string(self, version):
117
118
"""Return the vendor or None based on output from the subprocess.
119
120
:param version: The output of 'ssh -V' like command.
120
:param args: Command line that was run.
123
123
if 'OpenSSH' in version:
124
trace.mutter('ssh implementation is OpenSSH')
124
mutter('ssh implementation is OpenSSH')
125
125
vendor = OpenSSHSubprocessVendor()
126
126
elif 'SSH Secure Shell' in version:
127
trace.mutter('ssh implementation is SSH Corp.')
127
mutter('ssh implementation is SSH Corp.')
128
128
vendor = SSHCorpSubprocessVendor()
129
# As plink user prompts are not handled currently, don't auto-detect
130
# it by inspection below, but keep this vendor detection for if a path
131
# is given in BZR_SSH. See https://bugs.launchpad.net/bugs/414743
132
elif 'plink' in version and progname == 'plink':
133
# Checking if "plink" was the executed argument as Windows
134
# sometimes reports 'ssh -V' incorrectly with 'plink' in its
135
# version. See https://bugs.launchpad.net/bzr/+bug/107155
136
trace.mutter("ssh implementation is Putty's plink.")
129
elif 'plink' in version:
130
mutter("ssh implementation is Putty's plink.")
137
131
vendor = PLinkSubprocessVendor()
140
134
def _get_vendor_by_inspection(self):
141
135
"""Return the vendor or None by checking for known SSH implementations."""
142
version = self._get_ssh_version_string(['ssh', '-V'])
143
return self._get_vendor_by_version_string(version, "ssh")
145
def _get_vendor_from_path(self, path):
146
"""Return the vendor or None using the program at the given path"""
147
version = self._get_ssh_version_string([path, '-V'])
148
return self._get_vendor_by_version_string(version,
149
os.path.splitext(os.path.basename(path))[0])
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)
139
if vendor is not None:
151
143
def get_vendor(self, environment=None):
152
144
"""Find out what version of SSH is on the system.
173
165
register_ssh_vendor = _ssh_vendor_manager.register_vendor
176
def _ignore_signals():
168
def _ignore_sigint():
177
169
# TODO: This should possibly ignore SIGHUP as well, but bzr currently
178
170
# doesn't handle it itself.
179
171
# <https://launchpad.net/products/bzr/+bug/41433/+index>
181
173
signal.signal(signal.SIGINT, signal.SIG_IGN)
182
# GZ 2010-02-19: Perhaps make this check if breakin is installed instead
183
if signal.getsignal(signal.SIGQUIT) != signal.SIG_DFL:
184
signal.signal(signal.SIGQUIT, signal.SIG_IGN)
187
class SocketAsChannelAdapter(object):
176
class LoopbackSFTP(object):
188
177
"""Simple wrapper for a socket that pretends to be a paramiko Channel."""
190
179
def __init__(self, sock):
191
180
self.__socket = sock
194
return "bzr SocketAsChannelAdapter"
196
182
def send(self, data):
197
183
return self.__socket.send(data)
199
185
def recv(self, n):
201
return self.__socket.recv(n)
202
except socket.error, e:
203
if e.args[0] in (errno.EPIPE, errno.ECONNRESET, errno.ECONNABORTED,
205
# Connection has closed. Paramiko expects an empty string in
206
# this case, not an exception.
186
return self.__socket.recv(n)
210
188
def recv_ready(self):
211
# TODO: jam 20051215 this function is necessary to support the
212
# pipelined() function. In reality, it probably should use
213
# poll() or select() to actually return if there is data
214
# available, otherwise we probably don't get any benefit
239
213
def connect_ssh(self, username, password, host, port, command):
240
214
"""Make an SSH connection.
242
:returns: an SSHConnection.
216
:returns: something with a `close` method, and a `get_filelike_channels`
217
method that returns a pair of (read, write) filelike objects.
244
219
raise NotImplementedError(self.connect_ssh)
246
221
def _raise_connection_error(self, host, port=None, orig_error=None,
247
222
msg='Unable to connect to SSH host'):
248
223
"""Raise a SocketConnectionError with properly formatted host.
250
225
This just unifies all the locations that try to raise ConnectionError,
251
226
so that they format things properly.
253
raise errors.SocketConnectionError(host=host, port=port, msg=msg,
254
orig_error=orig_error)
228
raise SocketConnectionError(host=host, port=port, msg=msg,
229
orig_error=orig_error)
257
232
class LoopbackVendor(SSHVendor):
258
233
"""SSH "vendor" that connects over a plain TCP socket, not SSH."""
260
235
def connect_sftp(self, username, password, host, port):
261
236
sock = socket.socket()
263
238
sock.connect((host, port))
264
239
except socket.error, e:
265
240
self._raise_connection_error(host, port=port, orig_error=e)
266
return SFTPClient(SocketAsChannelAdapter(sock))
241
return SFTPClient(LoopbackSFTP(sock))
268
243
register_ssh_vendor('loopback', LoopbackVendor())
246
class _ParamikoSSHConnection(object):
247
def __init__(self, channel):
248
self.channel = channel
250
def get_filelike_channels(self):
251
return self.channel.makefile('rb'), self.channel.makefile('wb')
254
return self.channel.close()
271
257
class ParamikoVendor(SSHVendor):
272
258
"""Vendor that uses paramiko."""
274
260
def _connect(self, username, password, host, port):
275
261
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
283
269
except (paramiko.SSHException, socket.error), e:
284
270
self._raise_connection_error(host, port=port, orig_error=e)
286
272
server_key = t.get_remote_server_key()
287
273
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
288
274
keytype = server_key.get_name()
289
275
if host in SYSTEM_HOSTKEYS and keytype in SYSTEM_HOSTKEYS[host]:
290
276
our_server_key = SYSTEM_HOSTKEYS[host][keytype]
291
our_server_key_hex = paramiko.util.hexify(
292
our_server_key.get_fingerprint())
277
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
293
278
elif host in BZR_HOSTKEYS and keytype in BZR_HOSTKEYS[host]:
294
279
our_server_key = BZR_HOSTKEYS[host][keytype]
295
our_server_key_hex = paramiko.util.hexify(
296
our_server_key.get_fingerprint())
280
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
298
trace.warning('Adding %s host key for %s: %s'
299
% (keytype, host, server_key_hex))
282
warning('Adding %s host key for %s: %s' % (keytype, host, server_key_hex))
300
283
add = getattr(BZR_HOSTKEYS, 'add', None)
301
284
if add is not None: # paramiko >= 1.X.X
302
285
BZR_HOSTKEYS.add(host, keytype, server_key)
304
287
BZR_HOSTKEYS.setdefault(host, {})[keytype] = server_key
305
288
our_server_key = server_key
306
our_server_key_hex = paramiko.util.hexify(
307
our_server_key.get_fingerprint())
289
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
309
291
if server_key != our_server_key:
310
292
filename1 = os.path.expanduser('~/.ssh/known_hosts')
311
filename2 = osutils.pathjoin(config.config_dir(), 'ssh_host_keys')
312
raise errors.TransportError(
313
'Host keys for %s do not match! %s != %s' %
293
filename2 = pathjoin(config_dir(), 'ssh_host_keys')
294
raise TransportError('Host keys for %s do not match! %s != %s' % \
314
295
(host, our_server_key_hex, server_key_hex),
315
296
['Try editing %s or %s' % (filename1, filename2)])
317
_paramiko_auth(username, password, host, port, t)
298
_paramiko_auth(username, password, host, t)
320
301
def connect_sftp(self, username, password, host, port):
321
302
t = self._connect(username, password, host, port)
336
317
self._raise_connection_error(host, port=port, orig_error=e,
337
318
msg='Unable to invoke remote bzr')
339
_ssh_connection_errors = (EOFError, OSError, IOError, socket.error)
340
320
if paramiko is not None:
341
321
vendor = ParamikoVendor()
342
322
register_ssh_vendor('paramiko', vendor)
343
323
register_ssh_vendor('none', vendor)
344
324
register_default_ssh_vendor(vendor)
345
_ssh_connection_errors += (paramiko.SSHException,)
349
328
class SubprocessVendor(SSHVendor):
350
329
"""Abstract base class for vendors that use pipes to a subprocess."""
352
331
def _connect(self, argv):
353
# Attempt to make a socketpair to use as stdin/stdout for the SSH
354
# subprocess. We prefer sockets to pipes because they support
355
# non-blocking short reads, allowing us to optimistically read 64k (or
358
my_sock, subproc_sock = socket.socketpair()
359
except (AttributeError, socket.error):
360
# This platform doesn't support socketpair(), so just use ordinary
362
stdin = stdout = subprocess.PIPE
365
stdin = stdout = subproc_sock
367
proc = subprocess.Popen(argv, stdin=stdin, stdout=stdout,
332
proc = subprocess.Popen(argv,
333
stdin=subprocess.PIPE,
334
stdout=subprocess.PIPE,
368
335
**os_specific_subprocess_params())
369
return SSHSubprocessConnection(proc, sock=sock)
336
return SSHSubprocess(proc)
371
338
def connect_sftp(self, username, password, host, port):
373
340
argv = self._get_vendor_specific_argv(username, host, port,
374
341
subsystem='sftp')
375
342
sock = self._connect(argv)
376
return SFTPClient(SocketAsChannelAdapter(sock))
377
except _ssh_connection_errors, e:
343
return SFTPClient(sock)
344
except (EOFError, paramiko.SSHException), e:
345
self._raise_connection_error(host, port=port, orig_error=e)
346
except (OSError, IOError), e:
347
# If the machine is fast enough, ssh can actually exit
348
# before we try and send it the sftp request, which
349
# raises a Broken Pipe
350
if e.errno not in (errno.EPIPE,):
378
352
self._raise_connection_error(host, port=port, orig_error=e)
380
354
def connect_ssh(self, username, password, host, port, command):
382
356
argv = self._get_vendor_specific_argv(username, host, port,
384
358
return self._connect(argv)
385
except _ssh_connection_errors, e:
359
except (EOFError), e:
360
self._raise_connection_error(host, port=port, orig_error=e)
361
except (OSError, IOError), e:
362
# If the machine is fast enough, ssh can actually exit
363
# before we try and send it the sftp request, which
364
# raises a Broken Pipe
365
if e.errno not in (errno.EPIPE,):
386
367
self._raise_connection_error(host, port=port, orig_error=e)
388
369
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
390
371
"""Returns the argument list to run the subprocess with.
392
373
Exactly one of 'subsystem' and 'command' must be specified.
394
375
raise NotImplementedError(self._get_vendor_specific_argv)
397
378
class OpenSSHSubprocessVendor(SubprocessVendor):
398
379
"""SSH vendor that uses the 'ssh' executable from OpenSSH."""
400
executable_path = 'ssh'
402
381
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
404
args = [self.executable_path,
383
assert subsystem is not None or command is not None, (
384
'Must specify a command or subsystem')
385
if subsystem is not None:
386
assert command is None, (
387
'subsystem and command are mutually exclusive')
405
389
'-oForwardX11=no', '-oForwardAgent=no',
406
390
'-oClearAllForwardings=yes', '-oProtocol=2',
407
391
'-oNoHostAuthenticationForLocalhost=yes']
421
405
class SSHCorpSubprocessVendor(SubprocessVendor):
422
406
"""SSH vendor that uses the 'ssh' executable from SSH Corporation."""
424
executable_path = 'ssh'
426
408
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
428
args = [self.executable_path, '-x']
410
assert subsystem is not None or command is not None, (
411
'Must specify a command or subsystem')
412
if subsystem is not None:
413
assert command is None, (
414
'subsystem and command are mutually exclusive')
429
416
if port is not None:
430
417
args.extend(['-p', str(port)])
431
418
if username is not None:
436
423
args.extend([host] + command)
439
register_ssh_vendor('sshcorp', SSHCorpSubprocessVendor())
426
register_ssh_vendor('ssh', SSHCorpSubprocessVendor())
442
429
class PLinkSubprocessVendor(SubprocessVendor):
443
430
"""SSH vendor that uses the 'plink' executable from Putty."""
445
executable_path = 'plink'
447
432
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
449
args = [self.executable_path, '-x', '-a', '-ssh', '-2', '-batch']
434
assert subsystem is not None or command is not None, (
435
'Must specify a command or subsystem')
436
if subsystem is not None:
437
assert command is None, (
438
'subsystem and command are mutually exclusive')
439
args = ['plink', '-x', '-a', '-ssh', '-2']
450
440
if port is not None:
451
441
args.extend(['-P', str(port)])
452
442
if username is not None:
460
450
register_ssh_vendor('plink', PLinkSubprocessVendor())
463
def _paramiko_auth(username, password, host, port, paramiko_transport):
464
auth = config.AuthenticationConfig()
465
# paramiko requires a username, but it might be none if nothing was
466
# supplied. If so, use the local username.
468
username = auth.get_user('ssh', host, port=port,
469
default=getpass.getuser())
453
def _paramiko_auth(username, password, host, paramiko_transport):
454
# paramiko requires a username, but it might be none if nothing was supplied
455
# use the local username, just in case.
456
# We don't override username, because if we aren't using paramiko,
457
# the username might be specified in ~/.ssh/config and we don't want to
458
# force it to something else
459
# Also, it would mess up the self.relpath() functionality
460
username = username or getpass.getuser()
470
462
if _use_ssh_agent:
471
463
agent = paramiko.Agent()
472
464
for key in agent.get_keys():
473
trace.mutter('Trying SSH agent key %s'
474
% paramiko.util.hexify(key.get_fingerprint()))
465
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
476
467
paramiko_transport.auth_publickey(username, key)
478
469
except paramiko.SSHException, e:
481
472
# okay, try finding id_rsa or id_dss? (posix only)
482
473
if _try_pkey_auth(paramiko_transport, paramiko.RSAKey, username, 'id_rsa'):
484
475
if _try_pkey_auth(paramiko_transport, paramiko.DSSKey, username, 'id_dsa'):
487
# If we have gotten this far, we are about to try for passwords, do an
488
# auth_none check to see if it is even supported.
489
supported_auth_types = []
491
# Note that with paramiko <1.7.5 this logs an INFO message:
492
# Authentication type (none) not permitted.
493
# So we explicitly disable the logging level for this action
494
old_level = paramiko_transport.logger.level
495
paramiko_transport.logger.setLevel(logging.WARNING)
497
paramiko_transport.auth_none(username)
499
paramiko_transport.logger.setLevel(old_level)
500
except paramiko.BadAuthenticationType, e:
501
# Supported methods are in the exception
502
supported_auth_types = e.allowed_types
503
except paramiko.SSHException, e:
504
# Don't know what happened, but just ignore it
506
# We treat 'keyboard-interactive' and 'password' auth methods identically,
507
# because Paramiko's auth_password method will automatically try
508
# 'keyboard-interactive' auth (using the password as the response) if
509
# 'password' auth is not available. Apparently some Debian and Gentoo
510
# OpenSSH servers require this.
511
# XXX: It's possible for a server to require keyboard-interactive auth that
512
# requires something other than a single password, but we currently don't
514
if ('password' not in supported_auth_types and
515
'keyboard-interactive' not in supported_auth_types):
516
raise errors.ConnectionError('Unable to authenticate to SSH host as'
517
'\n %s@%s\nsupported auth types: %s'
518
% (username, host, supported_auth_types))
522
480
paramiko_transport.auth_password(username, password)
527
485
# give up and ask for a password
528
password = auth.get_password('ssh', host, username, port=port)
529
# get_password can still return None, which means we should not prompt
530
if password is not None:
532
paramiko_transport.auth_password(username, password)
533
except paramiko.SSHException, e:
534
raise errors.ConnectionError(
535
'Unable to authenticate to SSH host as'
536
'\n %s@%s\n' % (username, host), e)
538
raise errors.ConnectionError('Unable to authenticate to SSH host as'
539
' %s@%s' % (username, host))
486
password = bzrlib.ui.ui_factory.get_password(
487
prompt='SSH %(user)s@%(host)s password',
488
user=username, host=host)
490
paramiko_transport.auth_password(username, password)
491
except paramiko.SSHException, e:
492
raise ConnectionError('Unable to authenticate to SSH host as %s@%s' %
542
496
def _try_pkey_auth(paramiko_transport, pkey_class, username, filename):
546
500
paramiko_transport.auth_publickey(username, key)
548
502
except paramiko.PasswordRequiredException:
549
password = ui.ui_factory.get_password(
550
prompt='SSH %(filename)s password', filename=filename)
503
password = bzrlib.ui.ui_factory.get_password(
504
prompt='SSH %(filename)s password',
552
507
key = pkey_class.from_private_key_file(filename, password)
553
508
paramiko_transport.auth_publickey(username, key)
555
510
except paramiko.SSHException:
556
trace.mutter('SSH authentication via %s key failed.'
557
% (os.path.basename(filename),))
511
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
558
512
except paramiko.SSHException:
559
trace.mutter('SSH authentication via %s key failed.'
560
% (os.path.basename(filename),))
513
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
616
568
# this causes it to be seen only by bzr and not by ssh. Python will
617
569
# generate a KeyboardInterrupt in bzr, and we will then have a chance
618
570
# to release locks or do other cleanup over ssh before the connection
620
572
# <https://launchpad.net/products/bzr/+bug/5987>
622
574
# Running it in a separate process group is not good because then it
623
575
# can't get non-echoed input of a password or passphrase.
624
576
# <https://launchpad.net/products/bzr/+bug/40508>
625
return {'preexec_fn': _ignore_signals,
577
return {'preexec_fn': _ignore_sigint,
626
578
'close_fds': True,
630
_subproc_weakrefs = set()
632
def _close_ssh_proc(proc):
633
"""Carefully close stdin/stdout and reap the SSH process.
635
If the pipes are already closed and/or the process has already been
636
wait()ed on, that's ok, and no error is raised. The goal is to do our best
637
to clean up (whether or not a clean up was already tried).
639
dotted_names = ['stdin.close', 'stdout.close', 'wait']
640
for dotted_name in dotted_names:
641
attrs = dotted_name.split('.')
645
obj = getattr(obj, attr)
646
except AttributeError:
647
# It's ok for proc.stdin or proc.stdout to be None.
652
# It's ok for the pipe to already be closed, or the process to
653
# already be finished.
657
class SSHConnection(object):
658
"""Abstract base class for SSH connections."""
660
def get_sock_or_pipes(self):
661
"""Returns a (kind, io_object) pair.
663
If kind == 'socket', then io_object is a socket.
665
If kind == 'pipes', then io_object is a pair of file-like objects
666
(read_from, write_to).
668
raise NotImplementedError(self.get_sock_or_pipes)
671
raise NotImplementedError(self.close)
674
class SSHSubprocessConnection(SSHConnection):
675
"""A connection to an ssh subprocess via pipes or a socket.
677
This class is also socket-like enough to be used with
678
SocketAsChannelAdapter (it has 'send' and 'recv' methods).
681
def __init__(self, proc, sock=None):
684
:param proc: a subprocess.Popen
685
:param sock: if proc.stdin/out is a socket from a socketpair, then sock
686
should bzrlib's half of that socketpair. If not passed, proc's
687
stdin/out is assumed to be ordinary pipes.
582
class SSHSubprocess(object):
583
"""A socket-like object that talks to an ssh subprocess via pipes."""
585
def __init__(self, proc):
691
# Add a weakref to proc that will attempt to do the same as self.close
692
# to avoid leaving processes lingering indefinitely.
694
_subproc_weakrefs.remove(ref)
695
_close_ssh_proc(proc)
696
_subproc_weakrefs.add(weakref.ref(self, terminate))
698
588
def send(self, data):
699
if self._sock is not None:
700
return self._sock.send(data)
702
return os.write(self.proc.stdin.fileno(), data)
589
return os.write(self.proc.stdin.fileno(), data)
591
def recv_ready(self):
592
# TODO: jam 20051215 this function is necessary to support the
593
# pipelined() function. In reality, it probably should use
594
# poll() or select() to actually return if there is data
595
# available, otherwise we probably don't get any benefit
704
598
def recv(self, count):
705
if self._sock is not None:
706
return self._sock.recv(count)
708
return os.read(self.proc.stdout.fileno(), count)
711
_close_ssh_proc(self.proc)
713
def get_sock_or_pipes(self):
714
if self._sock is not None:
715
return 'socket', self._sock
717
return 'pipes', (self.proc.stdout, self.proc.stdin)
720
class _ParamikoSSHConnection(SSHConnection):
721
"""An SSH connection via paramiko."""
723
def __init__(self, channel):
724
self.channel = channel
726
def get_sock_or_pipes(self):
727
return ('socket', self.channel)
730
return self.channel.close()
599
return os.read(self.proc.stdout.fileno(), count)
602
self.proc.stdin.close()
603
self.proc.stdout.close()
606
def get_filelike_channels(self):
607
return (self.proc.stdout, self.proc.stdin)
added
removed
bzrlib/transport/ssh.py
