54
54
# connect to an agent if we are on win32 and using Paramiko older than 1.6
55
55
_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']
58
class SSHVendorManager(object):
59
"""Manager for manage SSH vendors."""
61
# Note, although at first sign the class interface seems similar to
62
# bzrlib.registry.Registry it is not possible/convenient to directly use
63
# the Registry because the class just has "get()" interface instead of the
64
# Registry's "get(key)".
67
self._ssh_vendors = {}
68
self._cached_ssh_vendor = None
69
self._default_ssh_vendor = None
71
def register_default_vendor(self, vendor):
72
"""Register default SSH vendor."""
73
self._default_ssh_vendor = vendor
75
def register_vendor(self, name, vendor):
76
"""Register new SSH vendor by name."""
77
self._ssh_vendors[name] = vendor
79
def clear_cache(self):
80
"""Clear previously cached lookup result."""
81
self._cached_ssh_vendor = None
83
def _get_vendor_by_environment(self, environment=None):
84
"""Return the vendor or None based on BZR_SSH environment variable.
86
:raises UnknownSSH: if the BZR_SSH environment variable contains
89
if environment is None:
90
environment = os.environ
91
if 'BZR_SSH' in environment:
92
vendor_name = environment['BZR_SSH']
94
vendor = self._ssh_vendors[vendor_name]
96
raise errors.UnknownSSH(vendor_name)
100
def _get_ssh_version_string(self, args):
101
"""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()
103
p = subprocess.Popen(args,
104
stdout=subprocess.PIPE,
105
stderr=subprocess.PIPE,
106
**os_specific_subprocess_params())
107
stdout, stderr = p.communicate()
110
return stdout + stderr
112
def _get_vendor_by_version_string(self, version, args):
113
"""Return the vendor or None based on output from the subprocess.
115
:param version: The output of 'ssh -V' like command.
116
:param args: Command line that was run.
119
if 'OpenSSH' in version:
120
trace.mutter('ssh implementation is OpenSSH')
121
vendor = OpenSSHSubprocessVendor()
122
elif 'SSH Secure Shell' in version:
123
trace.mutter('ssh implementation is SSH Corp.')
124
vendor = SSHCorpSubprocessVendor()
125
elif 'plink' in version and args[0] == 'plink':
126
# Checking if "plink" was the executed argument as Windows
127
# sometimes reports 'ssh -V' incorrectly with 'plink' in it's
128
# version. See https://bugs.launchpad.net/bzr/+bug/107155
129
trace.mutter("ssh implementation is Putty's plink.")
130
vendor = PLinkSubprocessVendor()
133
def _get_vendor_by_inspection(self):
134
"""Return the vendor or None by checking for known SSH implementations."""
135
for args in (['ssh', '-V'], ['plink', '-V']):
136
version = self._get_ssh_version_string(args)
137
vendor = self._get_vendor_by_version_string(version, args)
138
if vendor is not None:
142
def get_vendor(self, environment=None):
143
"""Find out what version of SSH is on the system.
145
:raises SSHVendorNotFound: if no any SSH vendor is found
146
:raises UnknownSSH: if the BZR_SSH environment variable contains
149
if self._cached_ssh_vendor is None:
150
vendor = self._get_vendor_by_environment(environment)
152
vendor = self._get_vendor_by_inspection()
154
trace.mutter('falling back to default implementation')
155
vendor = self._default_ssh_vendor
157
raise errors.SSHVendorNotFound()
158
self._cached_ssh_vendor = vendor
159
return self._cached_ssh_vendor
161
_ssh_vendor_manager = SSHVendorManager()
162
_get_ssh_vendor = _ssh_vendor_manager.get_vendor
163
register_default_ssh_vendor = _ssh_vendor_manager.register_default_vendor
164
register_ssh_vendor = _ssh_vendor_manager.register_vendor
109
167
def _ignore_sigint():
153
225
raise NotImplementedError(self.connect_sftp)
155
227
def connect_ssh(self, username, password, host, port, command):
156
"""Make an SSH connection, and return a pipe-like object.
228
"""Make an SSH connection.
158
(This is currently unused, it's just here to indicate future directions
230
:returns: something with a `close` method, and a `get_filelike_channels`
231
method that returns a pair of (read, write) filelike objects.
161
233
raise NotImplementedError(self.connect_ssh)
235
def _raise_connection_error(self, host, port=None, orig_error=None,
236
msg='Unable to connect to SSH host'):
237
"""Raise a SocketConnectionError with properly formatted host.
239
This just unifies all the locations that try to raise ConnectionError,
240
so that they format things properly.
242
raise errors.SocketConnectionError(host=host, port=port, msg=msg,
243
orig_error=orig_error)
164
246
class LoopbackVendor(SSHVendor):
165
247
"""SSH "vendor" that connects over a plain TCP socket, not SSH."""
167
249
def connect_sftp(self, username, password, host, port):
168
250
sock = socket.socket()
170
252
sock.connect((host, port))
171
253
except socket.error, e:
172
raise ConnectionError('Unable to connect to SSH host %s:%s: %s'
174
return SFTPClient(LoopbackSFTP(sock))
254
self._raise_connection_error(host, port=port, orig_error=e)
255
return SFTPClient(SocketAsChannelAdapter(sock))
176
257
register_ssh_vendor('loopback', LoopbackVendor())
260
class _ParamikoSSHConnection(object):
261
def __init__(self, channel):
262
self.channel = channel
264
def get_filelike_channels(self):
265
return self.channel.makefile('rb'), self.channel.makefile('wb')
268
return self.channel.close()
179
271
class ParamikoVendor(SSHVendor):
180
272
"""Vendor that uses paramiko."""
182
def connect_sftp(self, username, password, host, port):
274
def _connect(self, username, password, host, port):
183
275
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
189
281
t.set_log_channel('bzr.paramiko')
191
283
except (paramiko.SSHException, socket.error), e:
192
raise ConnectionError('Unable to reach SSH host %s:%s: %s'
284
self._raise_connection_error(host, port=port, orig_error=e)
195
286
server_key = t.get_remote_server_key()
196
287
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
197
288
keytype = server_key.get_name()
198
289
if host in SYSTEM_HOSTKEYS and keytype in SYSTEM_HOSTKEYS[host]:
199
290
our_server_key = SYSTEM_HOSTKEYS[host][keytype]
200
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
291
our_server_key_hex = paramiko.util.hexify(
292
our_server_key.get_fingerprint())
201
293
elif host in BZR_HOSTKEYS and keytype in BZR_HOSTKEYS[host]:
202
294
our_server_key = BZR_HOSTKEYS[host][keytype]
203
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
295
our_server_key_hex = paramiko.util.hexify(
296
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
298
trace.warning('Adding %s host key for %s: %s'
299
% (keytype, host, server_key_hex))
300
add = getattr(BZR_HOSTKEYS, 'add', None)
301
if add is not None: # paramiko >= 1.X.X
302
BZR_HOSTKEYS.add(host, keytype, server_key)
304
BZR_HOSTKEYS.setdefault(host, {})[keytype] = server_key
209
305
our_server_key = server_key
210
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
306
our_server_key_hex = paramiko.util.hexify(
307
our_server_key.get_fingerprint())
212
309
if server_key != our_server_key:
213
310
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' % \
311
filename2 = osutils.pathjoin(config.config_dir(), 'ssh_host_keys')
312
raise errors.TransportError(
313
'Host keys for %s do not match! %s != %s' %
216
314
(host, our_server_key_hex, server_key_hex),
217
315
['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())
317
_paramiko_auth(username, password, host, port, t)
320
def connect_sftp(self, username, password, host, port):
321
t = self._connect(username, password, host, port)
323
return t.open_sftp_client()
324
except paramiko.SSHException, e:
325
self._raise_connection_error(host, port=port, orig_error=e,
326
msg='Unable to start sftp client')
328
def connect_ssh(self, username, password, host, port, command):
329
t = self._connect(username, password, host, port)
331
channel = t.open_session()
332
cmdline = ' '.join(command)
333
channel.exec_command(cmdline)
334
return _ParamikoSSHConnection(channel)
335
except paramiko.SSHException, e:
336
self._raise_connection_error(host, port=port, orig_error=e,
337
msg='Unable to invoke remote bzr')
339
if paramiko is not None:
340
vendor = ParamikoVendor()
341
register_ssh_vendor('paramiko', vendor)
342
register_ssh_vendor('none', vendor)
343
register_default_ssh_vendor(vendor)
344
_sftp_connection_errors = (EOFError, paramiko.SSHException)
347
_sftp_connection_errors = (EOFError,)
231
350
class SubprocessVendor(SSHVendor):
232
351
"""Abstract base class for vendors that use pipes to a subprocess."""
353
def _connect(self, argv):
354
proc = subprocess.Popen(argv,
355
stdin=subprocess.PIPE,
356
stdout=subprocess.PIPE,
357
**os_specific_subprocess_params())
358
return SSHSubprocess(proc)
234
360
def connect_sftp(self, username, password, host, port):
236
362
argv = self._get_vendor_specific_argv(username, host, port,
237
363
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'
364
sock = self._connect(argv)
365
return SFTPClient(SocketAsChannelAdapter(sock))
366
except _sftp_connection_errors, e:
367
self._raise_connection_error(host, port=port, orig_error=e)
368
except (OSError, IOError), e:
369
# If the machine is fast enough, ssh can actually exit
370
# before we try and send it the sftp request, which
371
# raises a Broken Pipe
372
if e.errno not in (errno.EPIPE,):
374
self._raise_connection_error(host, port=port, orig_error=e)
376
def connect_ssh(self, username, password, host, port, command):
378
argv = self._get_vendor_specific_argv(username, host, port,
380
return self._connect(argv)
381
except (EOFError), e:
382
self._raise_connection_error(host, port=port, orig_error=e)
383
except (OSError, IOError), e:
384
# If the machine is fast enough, ssh can actually exit
385
# before we try and send it the sftp request, which
386
# raises a Broken Pipe
387
if e.errno not in (errno.EPIPE,):
389
self._raise_connection_error(host, port=port, orig_error=e)
256
391
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
312
435
args.extend([host] + command)
315
438
register_ssh_vendor('ssh', SSHCorpSubprocessVendor())
318
def _paramiko_auth(username, password, host, paramiko_transport):
441
class PLinkSubprocessVendor(SubprocessVendor):
442
"""SSH vendor that uses the 'plink' executable from Putty."""
444
def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
446
args = ['plink', '-x', '-a', '-ssh', '-2', '-batch']
448
args.extend(['-P', str(port)])
449
if username is not None:
450
args.extend(['-l', username])
451
if subsystem is not None:
452
args.extend(['-s', host, subsystem])
454
args.extend([host] + command)
457
register_ssh_vendor('plink', PLinkSubprocessVendor())
460
def _paramiko_auth(username, password, host, port, paramiko_transport):
319
461
# paramiko requires a username, but it might be none if nothing was supplied
320
462
# use the local username, just in case.
321
463
# We don't override username, because if we aren't using paramiko,
322
464
# the username might be specified in ~/.ssh/config and we don't want to
323
465
# force it to something else
324
466
# Also, it would mess up the self.relpath() functionality
325
username = username or getpass.getuser()
467
auth = config.AuthenticationConfig()
469
username = auth.get_user('ssh', host, port=port)
471
# Default to local user
472
username = getpass.getuser()
327
474
if _use_ssh_agent:
328
475
agent = paramiko.Agent()
329
476
for key in agent.get_keys():
330
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
477
trace.mutter('Trying SSH agent key %s'
478
% paramiko.util.hexify(key.get_fingerprint()))
332
480
paramiko_transport.auth_publickey(username, key)
334
482
except paramiko.SSHException, e:
337
485
# okay, try finding id_rsa or id_dss? (posix only)
338
486
if _try_pkey_auth(paramiko_transport, paramiko.RSAKey, username, 'id_rsa'):