54
55
# connect to an agent if we are on win32 and using Paramiko older than 1.6
55
56
_use_ssh_agent = (sys.platform != 'win32' or _paramiko_version >= (1, 6, 0))
59
def register_ssh_vendor(name, vendor):
60
"""Register SSH vendor."""
61
_ssh_vendors[name] = vendor
65
def _get_ssh_vendor():
66
"""Find out what version of SSH is on the system."""
68
if _ssh_vendor is not None:
71
if 'BZR_SSH' in os.environ:
72
vendor_name = os.environ['BZR_SSH']
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
vendor = self._get_vendor_from_path(vendor_name)
99
raise errors.UnknownSSH(vendor_name)
100
vendor.executable_path = vendor_name
104
def _get_ssh_version_string(self, args):
105
"""Return SSH version string from the subprocess."""
74
_ssh_vendor = _ssh_vendors[vendor_name]
76
raise UnknownSSH(vendor_name)
80
p = subprocess.Popen(['ssh', '-V'],
81
stdin=subprocess.PIPE,
82
stdout=subprocess.PIPE,
83
stderr=subprocess.PIPE,
84
**os_specific_subprocess_params())
85
returncode = p.returncode
86
stdout, stderr = p.communicate()
90
if 'OpenSSH' in stderr:
91
mutter('ssh implementation is OpenSSH')
92
_ssh_vendor = OpenSSHSubprocessVendor()
93
elif 'SSH Secure Shell' in stderr:
94
mutter('ssh implementation is SSH Corp.')
95
_ssh_vendor = SSHCorpSubprocessVendor()
97
if _ssh_vendor is not None:
100
# XXX: 20051123 jamesh
101
# A check for putty's plink or lsh would go here.
103
mutter('falling back to paramiko implementation')
104
_ssh_vendor = ssh.ParamikoVendor()
109
def _ignore_sigint():
107
p = subprocess.Popen(args,
108
stdout=subprocess.PIPE,
109
stderr=subprocess.PIPE,
110
**os_specific_subprocess_params())
111
stdout, stderr = p.communicate()
114
return stdout + stderr
116
def _get_vendor_by_version_string(self, version, progname):
117
"""Return the vendor or None based on output from the subprocess.
119
:param version: The output of 'ssh -V' like command.
120
:param args: Command line that was run.
123
if 'OpenSSH' in version:
124
trace.mutter('ssh implementation is OpenSSH')
125
vendor = OpenSSHSubprocessVendor()
126
elif 'SSH Secure Shell' in version:
127
trace.mutter('ssh implementation is SSH Corp.')
128
vendor = SSHCorpSubprocessVendor()
129
elif 'lsh' in version:
130
trace.mutter('ssh implementation is GNU lsh.')
131
vendor = LSHSubprocessVendor()
132
# As plink user prompts are not handled currently, don't auto-detect
133
# it by inspection below, but keep this vendor detection for if a path
134
# is given in BZR_SSH. See https://bugs.launchpad.net/bugs/414743
135
elif 'plink' in version and progname == 'plink':
136
# Checking if "plink" was the executed argument as Windows
137
# sometimes reports 'ssh -V' incorrectly with 'plink' in its
138
# version. See https://bugs.launchpad.net/bzr/+bug/107155
139
trace.mutter("ssh implementation is Putty's plink.")
140
vendor = PLinkSubprocessVendor()
143
def _get_vendor_by_inspection(self):
144
"""Return the vendor or None by checking for known SSH implementations."""
145
version = self._get_ssh_version_string(['ssh', '-V'])
146
return self._get_vendor_by_version_string(version, "ssh")
148
def _get_vendor_from_path(self, path):
149
"""Return the vendor or None using the program at the given path"""
150
version = self._get_ssh_version_string([path, '-V'])
151
return self._get_vendor_by_version_string(version,
152
os.path.splitext(os.path.basename(path))[0])
154
def get_vendor(self, environment=None):
155
"""Find out what version of SSH is on the system.
157
:raises SSHVendorNotFound: if no any SSH vendor is found
158
:raises UnknownSSH: if the BZR_SSH environment variable contains
161
if self._cached_ssh_vendor is None:
162
vendor = self._get_vendor_by_environment(environment)
164
vendor = self._get_vendor_by_inspection()
166
trace.mutter('falling back to default implementation')
167
vendor = self._default_ssh_vendor
169
raise errors.SSHVendorNotFound()
170
self._cached_ssh_vendor = vendor
171
return self._cached_ssh_vendor
173
_ssh_vendor_manager = SSHVendorManager()
174
_get_ssh_vendor = _ssh_vendor_manager.get_vendor
175
register_default_ssh_vendor = _ssh_vendor_manager.register_default_vendor
176
register_ssh_vendor = _ssh_vendor_manager.register_vendor
179
def _ignore_signals():
110
180
# TODO: This should possibly ignore SIGHUP as well, but bzr currently
111
181
# doesn't handle it itself.
112
182
# <https://launchpad.net/products/bzr/+bug/41433/+index>
114
184
signal.signal(signal.SIGINT, signal.SIG_IGN)
118
class LoopbackSFTP(object):
185
# GZ 2010-02-19: Perhaps make this check if breakin is installed instead
186
if signal.getsignal(signal.SIGQUIT) != signal.SIG_DFL:
187
signal.signal(signal.SIGQUIT, signal.SIG_IGN)
190
class SocketAsChannelAdapter(object):
119
191
"""Simple wrapper for a socket that pretends to be a paramiko Channel."""
121
193
def __init__(self, sock):
122
194
self.__socket = sock
197
return "bzr SocketAsChannelAdapter"
124
199
def send(self, data):
125
200
return self.__socket.send(data)
127
202
def recv(self, n):
128
return self.__socket.recv(n)
204
return self.__socket.recv(n)
205
except socket.error, e:
206
if e.args[0] in (errno.EPIPE, errno.ECONNRESET, errno.ECONNABORTED,
208
# Connection has closed. Paramiko expects an empty string in
209
# this case, not an exception.
130
213
def recv_ready(self):
214
# TODO: jam 20051215 this function is necessary to support the
215
# pipelined() function. In reality, it probably should use
216
# poll() or select() to actually return if there is data
217
# available, otherwise we probably don't get any benefit
153
240
raise NotImplementedError(self.connect_sftp)
155
242
def connect_ssh(self, username, password, host, port, command):
156
"""Make an SSH connection, and return a pipe-like object.
158
(This is currently unused, it's just here to indicate future directions
243
"""Make an SSH connection.
245
:returns: an SSHConnection.
161
247
raise NotImplementedError(self.connect_ssh)
249
def _raise_connection_error(self, host, port=None, orig_error=None,
250
msg='Unable to connect to SSH host'):
251
"""Raise a SocketConnectionError with properly formatted host.
253
This just unifies all the locations that try to raise ConnectionError,
254
so that they format things properly.
256
raise errors.SocketConnectionError(host=host, port=port, msg=msg,
257
orig_error=orig_error)
164
260
class LoopbackVendor(SSHVendor):
165
261
"""SSH "vendor" that connects over a plain TCP socket, not SSH."""
167
263
def connect_sftp(self, username, password, host, port):
168
264
sock = socket.socket()
170
266
sock.connect((host, port))
171
267
except socket.error, e:
172
raise ConnectionError('Unable to connect to SSH host %s:%s: %s'
174
return SFTPClient(LoopbackSFTP(sock))
268
self._raise_connection_error(host, port=port, orig_error=e)
269
return SFTPClient(SocketAsChannelAdapter(sock))
176
271
register_ssh_vendor('loopback', LoopbackVendor())
189
284
t.set_log_channel('bzr.paramiko')
191
286
except (paramiko.SSHException, socket.error), e:
192
raise ConnectionError('Unable to reach SSH host %s:%s: %s'
287
self._raise_connection_error(host, port=port, orig_error=e)
195
289
server_key = t.get_remote_server_key()
196
290
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
197
291
keytype = server_key.get_name()
198
292
if host in SYSTEM_HOSTKEYS and keytype in SYSTEM_HOSTKEYS[host]:
199
293
our_server_key = SYSTEM_HOSTKEYS[host][keytype]
200
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
294
our_server_key_hex = paramiko.util.hexify(
295
our_server_key.get_fingerprint())
201
296
elif host in BZR_HOSTKEYS and keytype in BZR_HOSTKEYS[host]:
202
297
our_server_key = BZR_HOSTKEYS[host][keytype]
203
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
298
our_server_key_hex = paramiko.util.hexify(
299
our_server_key.get_fingerprint())
205
warning('Adding %s host key for %s: %s' % (keytype, host, server_key_hex))
206
if host not in BZR_HOSTKEYS:
207
BZR_HOSTKEYS[host] = {}
208
BZR_HOSTKEYS[host][keytype] = server_key
301
trace.warning('Adding %s host key for %s: %s'
302
% (keytype, host, server_key_hex))
303
add = getattr(BZR_HOSTKEYS, 'add', None)
304
if add is not None: # paramiko >= 1.X.X
305
BZR_HOSTKEYS.add(host, keytype, server_key)
307
BZR_HOSTKEYS.setdefault(host, {})[keytype] = server_key
209
308
our_server_key = server_key
210
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
309
our_server_key_hex = paramiko.util.hexify(
310
our_server_key.get_fingerprint())
212
312
if server_key != our_server_key:
213
313
filename1 = os.path.expanduser('~/.ssh/known_hosts')
214
filename2 = pathjoin(config_dir(), 'ssh_host_keys')
215
raise TransportError('Host keys for %s do not match! %s != %s' % \
314
filename2 = osutils.pathjoin(config.config_dir(), 'ssh_host_keys')
315
raise errors.TransportError(
316
'Host keys for %s do not match! %s != %s' %
216
317
(host, our_server_key_hex, server_key_hex),
217
318
['Try editing %s or %s' % (filename1, filename2)])
219
_paramiko_auth(username, password, host, t)
222
sftp = t.open_sftp_client()
223
except paramiko.SSHException, e:
224
raise ConnectionError('Unable to start sftp client %s:%d' %
228
register_ssh_vendor('paramiko', ParamikoVendor())
320
_paramiko_auth(username, password, host, port, t)
323
def connect_sftp(self, username, password, host, port):
324
t = self._connect(username, password, host, port)
326
return t.open_sftp_client()
327
except paramiko.SSHException, e:
328
self._raise_connection_error(host, port=port, orig_error=e,
329
msg='Unable to start sftp client')
331
def connect_ssh(self, username, password, host, port, command):
332
t = self._connect(username, password, host, port)
334
channel = t.open_session()
335
cmdline = ' '.join(command)
336
channel.exec_command(cmdline)
337
return _ParamikoSSHConnection(channel)
338
except paramiko.SSHException, e:
339
self._raise_connection_error(host, port=port, orig_error=e,
340
msg='Unable to invoke remote bzr')
342
_ssh_connection_errors = (EOFError, OSError, IOError, socket.error)
343
if paramiko is not None:
344
vendor = ParamikoVendor()
345
register_ssh_vendor('paramiko', vendor)
346
register_ssh_vendor('none', vendor)
347
register_default_ssh_vendor(vendor)
348
_ssh_connection_errors += (paramiko.SSHException,)
231
352
class SubprocessVendor(SSHVendor):
232
353
"""Abstract base class for vendors that use pipes to a subprocess."""
355
def _connect(self, argv):
356
# Attempt to make a socketpair to use as stdin/stdout for the SSH
357
# subprocess. We prefer sockets to pipes because they support
358
# non-blocking short reads, allowing us to optimistically read 64k (or
361
my_sock, subproc_sock = socket.socketpair()
362
osutils.set_fd_cloexec(my_sock)
363
except (AttributeError, socket.error):
364
# This platform doesn't support socketpair(), so just use ordinary
366
stdin = stdout = subprocess.PIPE
367
my_sock, subproc_sock = None, None
369
stdin = stdout = subproc_sock
370
proc = subprocess.Popen(argv, stdin=stdin, stdout=stdout,
371
**os_specific_subprocess_params())
372
if subproc_sock is not None:
374
return SSHSubprocessConnection(proc, sock=my_sock)
234
376
def connect_sftp(self, username, password, host, port):
236
378
argv = self._get_vendor_specific_argv(username, host, port,
237
379
subsystem='sftp')
238
proc = subprocess.Popen(argv,
239
stdin=subprocess.PIPE,
240
stdout=subprocess.PIPE,
241
**os_specific_subprocess_params())
242
sock = SSHSubprocess(proc)
243
return SFTPClient(sock)
244
except (EOFError, paramiko.SSHException), e:
245
raise ConnectionError('Unable to connect to SSH host %s:%s: %s'
247
except (OSError, IOError), e:
248
# If the machine is fast enough, ssh can actually exit
249
# before we try and send it the sftp request, which
250
# raises a Broken Pipe
251
if e.errno not in (errno.EPIPE,):
253
raise ConnectionError('Unable to connect to SSH host %s:%s: %s'
380
sock = self._connect(argv)
381
return SFTPClient(SocketAsChannelAdapter(sock))
382
except _ssh_connection_errors, e:
383
self._raise_connection_error(host, port=port, orig_error=e)
385
def connect_ssh(self, username, password, host, port, command):
387
argv = self._get_vendor_specific_argv(username, host, port,
389
return self._connect(argv)
390
except _ssh_connection_errors, e:
391
self._raise_connection_error(host, port=port, orig_error=e)
256
393
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
258
395
"""Returns the argument list to run the subprocess with.
260
397
Exactly one of 'subsystem' and 'command' must be specified.
262
399
raise NotImplementedError(self._get_vendor_specific_argv)
264
register_ssh_vendor('none', ParamikoVendor())
267
402
class OpenSSHSubprocessVendor(SubprocessVendor):
268
403
"""SSH vendor that uses the 'ssh' executable from OpenSSH."""
405
executable_path = 'ssh'
270
407
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
272
assert subsystem is not None or command is not None, (
273
'Must specify a command or subsystem')
274
if subsystem is not None:
275
assert command is None, (
276
'subsystem and command are mutually exclusive')
409
args = [self.executable_path,
278
410
'-oForwardX11=no', '-oForwardAgent=no',
279
'-oClearAllForwardings=yes', '-oProtocol=2',
411
'-oClearAllForwardings=yes',
280
412
'-oNoHostAuthenticationForLocalhost=yes']
281
413
if port is not None:
282
414
args.extend(['-p', str(port)])
312
441
args.extend([host] + command)
315
register_ssh_vendor('ssh', SSHCorpSubprocessVendor())
318
def _paramiko_auth(username, password, host, paramiko_transport):
319
# paramiko requires a username, but it might be none if nothing was supplied
320
# use the local username, just in case.
321
# We don't override username, because if we aren't using paramiko,
322
# the username might be specified in ~/.ssh/config and we don't want to
323
# force it to something else
324
# Also, it would mess up the self.relpath() functionality
325
username = username or getpass.getuser()
444
register_ssh_vendor('sshcorp', SSHCorpSubprocessVendor())
447
class LSHSubprocessVendor(SubprocessVendor):
448
"""SSH vendor that uses the 'lsh' executable from GNU"""
450
executable_path = 'lsh'
452
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
454
args = [self.executable_path]
456
args.extend(['-p', str(port)])
457
if username is not None:
458
args.extend(['-l', username])
459
if subsystem is not None:
460
args.extend(['--subsystem', subsystem, host])
462
args.extend([host] + command)
465
register_ssh_vendor('lsh', LSHSubprocessVendor())
468
class PLinkSubprocessVendor(SubprocessVendor):
469
"""SSH vendor that uses the 'plink' executable from Putty."""
471
executable_path = 'plink'
473
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
475
args = [self.executable_path, '-x', '-a', '-ssh', '-2', '-batch']
477
args.extend(['-P', str(port)])
478
if username is not None:
479
args.extend(['-l', username])
480
if subsystem is not None:
481
args.extend(['-s', host, subsystem])
483
args.extend([host] + command)
486
register_ssh_vendor('plink', PLinkSubprocessVendor())
489
def _paramiko_auth(username, password, host, port, paramiko_transport):
490
auth = config.AuthenticationConfig()
491
# paramiko requires a username, but it might be none if nothing was
492
# supplied. If so, use the local username.
494
username = auth.get_user('ssh', host, port=port,
495
default=getpass.getuser())
327
496
if _use_ssh_agent:
328
497
agent = paramiko.Agent()
329
498
for key in agent.get_keys():
330
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
499
trace.mutter('Trying SSH agent key %s'
500
% paramiko.util.hexify(key.get_fingerprint()))
332
502
paramiko_transport.auth_publickey(username, key)
334
504
except paramiko.SSHException, e:
337
507
# okay, try finding id_rsa or id_dss? (posix only)
338
508
if _try_pkey_auth(paramiko_transport, paramiko.RSAKey, username, 'id_rsa'):
340
510
if _try_pkey_auth(paramiko_transport, paramiko.DSSKey, username, 'id_dsa'):
513
# If we have gotten this far, we are about to try for passwords, do an
514
# auth_none check to see if it is even supported.
515
supported_auth_types = []
517
# Note that with paramiko <1.7.5 this logs an INFO message:
518
# Authentication type (none) not permitted.
519
# So we explicitly disable the logging level for this action
520
old_level = paramiko_transport.logger.level
521
paramiko_transport.logger.setLevel(logging.WARNING)
523
paramiko_transport.auth_none(username)
525
paramiko_transport.logger.setLevel(old_level)
526
except paramiko.BadAuthenticationType, e:
527
# Supported methods are in the exception
528
supported_auth_types = e.allowed_types
529
except paramiko.SSHException, e:
530
# Don't know what happened, but just ignore it
532
# We treat 'keyboard-interactive' and 'password' auth methods identically,
533
# because Paramiko's auth_password method will automatically try
534
# 'keyboard-interactive' auth (using the password as the response) if
535
# 'password' auth is not available. Apparently some Debian and Gentoo
536
# OpenSSH servers require this.
537
# XXX: It's possible for a server to require keyboard-interactive auth that
538
# requires something other than a single password, but we currently don't
540
if ('password' not in supported_auth_types and
541
'keyboard-interactive' not in supported_auth_types):
542
raise errors.ConnectionError('Unable to authenticate to SSH host as'
543
'\n %s@%s\nsupported auth types: %s'
544
% (username, host, supported_auth_types))
345
548
paramiko_transport.auth_password(username, password)
433
642
# this causes it to be seen only by bzr and not by ssh. Python will
434
643
# generate a KeyboardInterrupt in bzr, and we will then have a chance
435
644
# to release locks or do other cleanup over ssh before the connection
437
646
# <https://launchpad.net/products/bzr/+bug/5987>
439
648
# Running it in a separate process group is not good because then it
440
649
# can't get non-echoed input of a password or passphrase.
441
650
# <https://launchpad.net/products/bzr/+bug/40508>
442
return {'preexec_fn': _ignore_sigint,
651
return {'preexec_fn': _ignore_signals,
443
652
'close_fds': True,
447
class SSHSubprocess(object):
448
"""A socket-like object that talks to an ssh subprocess via pipes."""
450
def __init__(self, proc):
656
_subproc_weakrefs = set()
658
def _close_ssh_proc(proc, sock):
659
"""Carefully close stdin/stdout and reap the SSH process.
661
If the pipes are already closed and/or the process has already been
662
wait()ed on, that's ok, and no error is raised. The goal is to do our best
663
to clean up (whether or not a clean up was already tried).
666
for closeable in (proc.stdin, proc.stdout, sock):
667
# We expect that either proc (a subprocess.Popen) will have stdin and
668
# stdout streams to close, or that we will have been passed a socket to
669
# close, with the option not in use being None.
670
if closeable is not None:
671
funcs.append(closeable.close)
672
funcs.append(proc.wait)
677
# It's ok for the pipe to already be closed, or the process to
678
# already be finished.
682
class SSHConnection(object):
683
"""Abstract base class for SSH connections."""
685
def get_sock_or_pipes(self):
686
"""Returns a (kind, io_object) pair.
688
If kind == 'socket', then io_object is a socket.
690
If kind == 'pipes', then io_object is a pair of file-like objects
691
(read_from, write_to).
693
raise NotImplementedError(self.get_sock_or_pipes)
696
raise NotImplementedError(self.close)
699
class SSHSubprocessConnection(SSHConnection):
700
"""A connection to an ssh subprocess via pipes or a socket.
702
This class is also socket-like enough to be used with
703
SocketAsChannelAdapter (it has 'send' and 'recv' methods).
706
def __init__(self, proc, sock=None):
709
:param proc: a subprocess.Popen
710
:param sock: if proc.stdin/out is a socket from a socketpair, then sock
711
should bzrlib's half of that socketpair. If not passed, proc's
712
stdin/out is assumed to be ordinary pipes.
716
# Add a weakref to proc that will attempt to do the same as self.close
717
# to avoid leaving processes lingering indefinitely.
719
_subproc_weakrefs.remove(ref)
720
_close_ssh_proc(proc, sock)
721
_subproc_weakrefs.add(weakref.ref(self, terminate))
453
723
def send(self, data):
454
return os.write(self.proc.stdin.fileno(), data)
456
def recv_ready(self):
457
# TODO: jam 20051215 this function is necessary to support the
458
# pipelined() function. In reality, it probably should use
459
# poll() or select() to actually return if there is data
460
# available, otherwise we probably don't get any benefit
724
if self._sock is not None:
725
return self._sock.send(data)
727
return os.write(self.proc.stdin.fileno(), data)
463
729
def recv(self, count):
464
return os.read(self.proc.stdout.fileno(), count)
467
self.proc.stdin.close()
468
self.proc.stdout.close()
730
if self._sock is not None:
731
return self._sock.recv(count)
733
return os.read(self.proc.stdout.fileno(), count)
736
_close_ssh_proc(self.proc, self._sock)
738
def get_sock_or_pipes(self):
739
if self._sock is not None:
740
return 'socket', self._sock
742
return 'pipes', (self.proc.stdout, self.proc.stdin)
745
class _ParamikoSSHConnection(SSHConnection):
746
"""An SSH connection via paramiko."""
748
def __init__(self, channel):
749
self.channel = channel
751
def get_sock_or_pipes(self):
752
return ('socket', self.channel)
755
return self.channel.close()
added
removed
bzrlib/transport/ssh.py
