60
86
CMD_HANDLE, CMD_OPEN)
61
87
from paramiko.sftp_attr import SFTPAttributes
62
88
from paramiko.sftp_file import SFTPFile
63
from paramiko.sftp_client import SFTPClient
66
register_urlparse_netloc_protocol('sftp')
70
# TODO: This should possibly ignore SIGHUP as well, but bzr currently
71
# doesn't handle it itself.
72
# <https://launchpad.net/products/bzr/+bug/41433/+index>
74
signal.signal(signal.SIGINT, signal.SIG_IGN)
77
def os_specific_subprocess_params():
78
"""Get O/S specific subprocess parameters."""
79
if sys.platform == 'win32':
80
# setting the process group and closing fds is not supported on
84
# We close fds other than the pipes as the child process does not need
87
# We also set the child process to ignore SIGINT. Normally the signal
88
# would be sent to every process in the foreground process group, but
89
# this causes it to be seen only by bzr and not by ssh. Python will
90
# generate a KeyboardInterrupt in bzr, and we will then have a chance
91
# to release locks or do other cleanup over ssh before the connection
93
# <https://launchpad.net/products/bzr/+bug/5987>
95
# Running it in a separate process group is not good because then it
96
# can't get non-echoed input of a password or passphrase.
97
# <https://launchpad.net/products/bzr/+bug/40508>
98
return {'preexec_fn': _ignore_sigint,
103
# don't use prefetch unless paramiko version >= 1.5.2 (there were bugs earlier)
104
_default_do_prefetch = False
105
if getattr(paramiko, '__version_info__', (0, 0, 0)) >= (1, 5, 5):
106
_default_do_prefetch = True
110
def _get_ssh_vendor():
111
"""Find out what version of SSH is on the system."""
113
if _ssh_vendor is not None:
118
if 'BZR_SSH' in os.environ:
119
_ssh_vendor = os.environ['BZR_SSH']
120
if _ssh_vendor == 'paramiko':
125
p = subprocess.Popen(['ssh', '-V'],
126
stdin=subprocess.PIPE,
127
stdout=subprocess.PIPE,
128
stderr=subprocess.PIPE,
129
**os_specific_subprocess_params())
130
returncode = p.returncode
131
stdout, stderr = p.communicate()
135
if 'OpenSSH' in stderr:
136
mutter('ssh implementation is OpenSSH')
137
_ssh_vendor = 'openssh'
138
elif 'SSH Secure Shell' in stderr:
139
mutter('ssh implementation is SSH Corp.')
142
if _ssh_vendor != 'none':
145
# XXX: 20051123 jamesh
146
# A check for putty's plink or lsh would go here.
148
mutter('falling back to paramiko implementation')
152
class SFTPSubprocess:
153
"""A socket-like object that talks to an ssh subprocess via pipes."""
154
def __init__(self, hostname, vendor, port=None, user=None):
155
assert vendor in ['openssh', 'ssh']
156
if vendor == 'openssh':
158
'-oForwardX11=no', '-oForwardAgent=no',
159
'-oClearAllForwardings=yes', '-oProtocol=2',
160
'-oNoHostAuthenticationForLocalhost=yes']
162
args.extend(['-p', str(port)])
164
args.extend(['-l', user])
165
args.extend(['-s', hostname, 'sftp'])
166
elif vendor == 'ssh':
169
args.extend(['-p', str(port)])
171
args.extend(['-l', user])
172
args.extend(['-s', 'sftp', hostname])
174
self.proc = subprocess.Popen(args,
175
stdin=subprocess.PIPE,
176
stdout=subprocess.PIPE,
177
**os_specific_subprocess_params())
179
def send(self, data):
180
return os.write(self.proc.stdin.fileno(), data)
182
def recv_ready(self):
183
# TODO: jam 20051215 this function is necessary to support the
184
# pipelined() function. In reality, it probably should use
185
# poll() or select() to actually return if there is data
186
# available, otherwise we probably don't get any benefit
189
def recv(self, count):
190
return os.read(self.proc.stdout.fileno(), count)
193
self.proc.stdin.close()
194
self.proc.stdout.close()
198
class LoopbackSFTP(object):
199
"""Simple wrapper for a socket that pretends to be a paramiko Channel."""
201
def __init__(self, sock):
204
def send(self, data):
205
return self.__socket.send(data)
208
return self.__socket.recv(n)
210
def recv_ready(self):
214
self.__socket.close()
220
# This is a weakref dictionary, so that we can reuse connections
221
# that are still active. Long term, it might be nice to have some
222
# sort of expiration policy, such as disconnect if inactive for
223
# X seconds. But that requires a lot more fanciness.
224
_connected_hosts = weakref.WeakValueDictionary()
226
def clear_connection_cache():
227
"""Remove all hosts from the SFTP connection cache.
229
Primarily useful for test cases wanting to force garbage collection.
231
_connected_hosts.clear()
234
def load_host_keys():
236
Load system host keys (probably doesn't work on windows) and any
237
"discovered" keys from previous sessions.
239
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
241
SYSTEM_HOSTKEYS = paramiko.util.load_host_keys(os.path.expanduser('~/.ssh/known_hosts'))
243
mutter('failed to load system host keys: ' + str(e))
244
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
246
BZR_HOSTKEYS = paramiko.util.load_host_keys(bzr_hostkey_path)
248
mutter('failed to load bzr host keys: ' + str(e))
252
def save_host_keys():
254
Save "discovered" host keys in $(config)/ssh_host_keys/.
256
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
257
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
258
ensure_config_dir_exists()
261
f = open(bzr_hostkey_path, 'w')
262
f.write('# SSH host keys collected by bzr\n')
263
for hostname, keys in BZR_HOSTKEYS.iteritems():
264
for keytype, key in keys.iteritems():
265
f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
268
mutter('failed to save bzr host keys: ' + str(e))
91
_paramiko_version = getattr(paramiko, '__version_info__', (0, 0, 0))
92
# don't use prefetch unless paramiko version >= 1.5.5 (there were bugs earlier)
93
_default_do_prefetch = (_paramiko_version >= (1, 5, 5))
271
96
class SFTPLock(object):
272
"""This fakes a lock in a remote location."""
97
"""This fakes a lock in a remote location.
99
A present lock is indicated just by the existence of a file. This
100
doesn't work well on all transports and they are only used in
101
deprecated storage formats.
273
104
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
274
106
def __init__(self, path, transport):
275
assert isinstance(transport, SFTPTransport)
277
107
self.lock_file = None
279
109
self.lock_path = path + '.write-lock'
302
132
# What specific errors should we catch here?
305
class SFTPTransport (Transport):
307
Transport implementation for SFTP access.
136
class _SFTPReadvHelper(object):
137
"""A class to help with managing the state of a readv request."""
139
# See _get_requests for an explanation.
140
_max_request_size = 32768
142
def __init__(self, original_offsets, relpath, _report_activity):
143
"""Create a new readv helper.
145
:param original_offsets: The original requests given by the caller of
147
:param relpath: The name of the file (if known)
148
:param _report_activity: A Transport._report_activity bound method,
149
to be called as data arrives.
151
self.original_offsets = list(original_offsets)
152
self.relpath = relpath
153
self._report_activity = _report_activity
155
def _get_requests(self):
156
"""Break up the offsets into individual requests over sftp.
158
The SFTP spec only requires implementers to support 32kB requests. We
159
could try something larger (openssh supports 64kB), but then we have to
160
handle requests that fail.
161
So instead, we just break up our maximum chunks into 32kB chunks, and
162
asyncronously requests them.
163
Newer versions of paramiko would do the chunking for us, but we want to
164
start processing results right away, so we do it ourselves.
166
# TODO: Because we issue async requests, we don't 'fudge' any extra
167
# data. I'm not 100% sure that is the best choice.
169
# The first thing we do, is to collapse the individual requests as much
170
# as possible, so we don't issues requests <32kB
171
sorted_offsets = sorted(self.original_offsets)
172
coalesced = list(ConnectedTransport._coalesce_offsets(sorted_offsets,
173
limit=0, fudge_factor=0))
175
for c_offset in coalesced:
176
start = c_offset.start
177
size = c_offset.length
179
# Break this up into 32kB requests
181
next_size = min(size, self._max_request_size)
182
requests.append((start, next_size))
185
mutter('SFTP.readv(%s) %s offsets => %s coalesced => %s requests',
186
self.relpath, len(sorted_offsets), len(coalesced),
190
def request_and_yield_offsets(self, fp):
191
"""Request the data from the remote machine, yielding the results.
193
:param fp: A Paramiko SFTPFile object that supports readv.
194
:return: Yield the data requested by the original readv caller, one by
197
requests = self._get_requests()
198
offset_iter = iter(self.original_offsets)
199
cur_offset, cur_size = offset_iter.next()
200
# paramiko .readv() yields strings that are in the order of the requests
201
# So we track the current request to know where the next data is
202
# being returned from.
208
# This is used to buffer chunks which we couldn't process yet
209
# It is (start, end, data) tuples.
211
# Create an 'unlimited' data stream, so we stop based on requests,
212
# rather than just because the data stream ended. This lets us detect
214
data_stream = itertools.chain(fp.readv(requests),
215
itertools.repeat(None))
216
for (start, length), data in itertools.izip(requests, data_stream):
218
if cur_coalesced is not None:
219
raise errors.ShortReadvError(self.relpath,
220
start, length, len(data))
221
if len(data) != length:
222
raise errors.ShortReadvError(self.relpath,
223
start, length, len(data))
224
self._report_activity(length, 'read')
226
# This is the first request, just buffer it
227
buffered_data = [data]
228
buffered_len = length
230
elif start == last_end:
231
# The data we are reading fits neatly on the previous
232
# buffer, so this is all part of a larger coalesced range.
233
buffered_data.append(data)
234
buffered_len += length
236
# We have an 'interrupt' in the data stream. So we know we are
237
# at a request boundary.
239
# We haven't consumed the buffer so far, so put it into
240
# data_chunks, and continue.
241
buffered = ''.join(buffered_data)
242
data_chunks.append((input_start, buffered))
244
buffered_data = [data]
245
buffered_len = length
246
last_end = start + length
247
if input_start == cur_offset and cur_size <= buffered_len:
248
# Simplify the next steps a bit by transforming buffered_data
249
# into a single string. We also have the nice property that
250
# when there is only one string ''.join([x]) == x, so there is
252
buffered = ''.join(buffered_data)
253
# Clean out buffered data so that we keep memory
257
# TODO: We *could* also consider the case where cur_offset is in
258
# in the buffered range, even though it doesn't *start*
259
# the buffered range. But for packs we pretty much always
260
# read in order, so you won't get any extra data in the
262
while (input_start == cur_offset
263
and (buffered_offset + cur_size) <= buffered_len):
264
# We've buffered enough data to process this request, spit it
266
cur_data = buffered[buffered_offset:buffered_offset + cur_size]
267
# move the direct pointer into our buffered data
268
buffered_offset += cur_size
269
# Move the start-of-buffer pointer
270
input_start += cur_size
271
# Yield the requested data
272
yield cur_offset, cur_data
273
cur_offset, cur_size = offset_iter.next()
274
# at this point, we've consumed as much of buffered as we can,
275
# so break off the portion that we consumed
276
if buffered_offset == len(buffered_data):
277
# No tail to leave behind
281
buffered = buffered[buffered_offset:]
282
buffered_data = [buffered]
283
buffered_len = len(buffered)
285
buffered = ''.join(buffered_data)
287
data_chunks.append((input_start, buffered))
289
mutter('SFTP readv left with %d out-of-order bytes',
290
sum(map(lambda x: len(x[1]), data_chunks)))
291
# We've processed all the readv data, at this point, anything we
292
# couldn't process is in data_chunks. This doesn't happen often, so
293
# this code path isn't optimized
294
# We use an interesting process for data_chunks
295
# Specifically if we have "bisect_left([(start, len, entries)],
297
# If start == qstart, then we get the specific node. Otherwise we
298
# get the previous node
300
idx = bisect.bisect_left(data_chunks, (cur_offset,))
301
if idx < len(data_chunks) and data_chunks[idx][0] == cur_offset:
302
# The data starts here
303
data = data_chunks[idx][1][:cur_size]
305
# The data is in a portion of a previous page
307
sub_offset = cur_offset - data_chunks[idx][0]
308
data = data_chunks[idx][1]
309
data = data[sub_offset:sub_offset + cur_size]
311
# We are missing the page where the data should be found,
314
if len(data) != cur_size:
315
raise AssertionError('We must have miscalulated.'
316
' We expected %d bytes, but only found %d'
317
% (cur_size, len(data)))
318
yield cur_offset, data
319
cur_offset, cur_size = offset_iter.next()
322
class SFTPTransport(ConnectedTransport):
323
"""Transport implementation for SFTP access."""
309
325
_do_prefetch = _default_do_prefetch
311
def __init__(self, base, clone_from=None):
312
assert base.startswith('sftp://')
313
self._parse_url(base)
314
base = self._unparse_url()
317
super(SFTPTransport, self).__init__(base)
318
if clone_from is None:
321
# use the same ssh connection, etc
322
self._sftp = clone_from._sftp
323
# super saves 'self.base'
325
def should_cache(self):
327
Return True if the data pulled across should be cached locally.
331
def clone(self, offset=None):
333
Return a new SFTPTransport with root at self.base + offset.
334
We share the same SFTP session between such transports, because it's
335
fairly expensive to set them up.
338
return SFTPTransport(self.base, self)
340
return SFTPTransport(self.abspath(offset), self)
342
def abspath(self, relpath):
344
Return the full url to the given relative path.
346
@param relpath: the relative path or path components
347
@type relpath: str or list
349
return self._unparse_url(self._remote_path(relpath))
326
# TODO: jam 20060717 Conceivably these could be configurable, either
327
# by auto-tuning at run-time, or by a configuration (per host??)
328
# but the performance curve is pretty flat, so just going with
329
# reasonable defaults.
330
_max_readv_combine = 200
331
# Having to round trip to the server means waiting for a response,
332
# so it is better to download extra bytes.
333
# 8KiB had good performance for both local and remote network operations
334
_bytes_to_read_before_seek = 8192
336
# The sftp spec says that implementations SHOULD allow reads
337
# to be at least 32K. paramiko.readv() does an async request
338
# for the chunks. So we need to keep it within a single request
339
# size for paramiko <= 1.6.1. paramiko 1.6.2 will probably chop
340
# up the request itself, rather than us having to worry about it
341
_max_request_size = 32768
343
def __init__(self, base, _from_transport=None):
344
super(SFTPTransport, self).__init__(base,
345
_from_transport=_from_transport)
351
347
def _remote_path(self, relpath):
352
348
"""Return the path to be passed along the sftp protocol for relpath.
354
relpath is a urlencoded string.
356
# FIXME: share the common code across transports
357
assert isinstance(relpath, basestring)
358
relpath = urlutils.unescape(relpath).split('/')
359
basepath = self._path.split('/')
360
if len(basepath) > 0 and basepath[-1] == '':
361
basepath = basepath[:-1]
365
if len(basepath) == 0:
366
# In most filesystems, a request for the parent
367
# of root, just returns root.
375
path = '/'.join(basepath)
378
def relpath(self, abspath):
379
username, password, host, port, path = self._split_url(abspath)
381
if (username != self._username):
382
error.append('username mismatch')
383
if (host != self._host):
384
error.append('host mismatch')
385
if (port != self._port):
386
error.append('port mismatch')
387
if (not path.startswith(self._path)):
388
error.append('path mismatch')
390
extra = ': ' + ', '.join(error)
391
raise PathNotChild(abspath, self.base, extra=extra)
393
return path[pl:].strip('/')
350
:param relpath: is a urlencoded string.
352
relative = urlutils.unescape(relpath).encode('utf-8')
353
remote_path = self._combine_paths(self._path, relative)
354
# the initial slash should be removed from the path, and treated as a
355
# homedir relative path (the path begins with a double slash if it is
356
# absolute). see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
357
# RBC 20060118 we are not using this as its too user hostile. instead
358
# we are following lftp and using /~/foo to mean '~/foo'
359
# vila--20070602 and leave absolute paths begin with a single slash.
360
if remote_path.startswith('/~/'):
361
remote_path = remote_path[3:]
362
elif remote_path == '/~':
366
def _create_connection(self, credentials=None):
367
"""Create a new connection with the provided credentials.
369
:param credentials: The credentials needed to establish the connection.
371
:return: The created connection and its associated credentials.
373
The credentials are only the password as it may have been entered
374
interactively by the user and may be different from the one provided
375
in base url at transport creation time.
377
if credentials is None:
378
password = self._password
380
password = credentials
382
vendor = ssh._get_ssh_vendor()
385
auth = config.AuthenticationConfig()
386
user = auth.get_user('ssh', self._host, self._port)
387
connection = vendor.connect_sftp(self._user, password,
388
self._host, self._port)
389
return connection, (user, password)
392
"""Ensures that a connection is established"""
393
connection = self._get_connection()
394
if connection is None:
395
# First connection ever
396
connection, credentials = self._create_connection()
397
self._set_connection(connection, credentials)
395
400
def has(self, relpath):
397
402
Does the target location exist?
400
self._sftp.stat(self._remote_path(relpath))
405
self._get_sftp().stat(self._remote_path(relpath))
405
410
def get(self, relpath):
407
Get the file at the given relative path.
411
"""Get the file at the given relative path.
409
413
:param relpath: The relative path to the file
412
416
path = self._remote_path(relpath)
413
f = self._sftp.file(path, mode='rb')
417
f = self._get_sftp().file(path, mode='rb')
414
418
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
417
421
except (IOError, paramiko.SSHException), e:
422
self._translate_io_exception(e, path, ': error retrieving',
423
failure_exc=errors.ReadError)
425
def get_bytes(self, relpath):
426
# reimplement this here so that we can report how many bytes came back
427
f = self.get(relpath)
430
self._report_activity(len(bytes), 'read')
435
def _readv(self, relpath, offsets):
436
"""See Transport.readv()"""
437
# We overload the default readv() because we want to use a file
438
# that does not have prefetch enabled.
439
# Also, if we have a new paramiko, it implements an async readv()
444
path = self._remote_path(relpath)
445
fp = self._get_sftp().file(path, mode='rb')
446
readv = getattr(fp, 'readv', None)
448
return self._sftp_readv(fp, offsets, relpath)
449
mutter('seek and read %s offsets', len(offsets))
450
return self._seek_and_read(fp, offsets, relpath)
451
except (IOError, paramiko.SSHException), e:
418
452
self._translate_io_exception(e, path, ': error retrieving')
420
def get_partial(self, relpath, start, length=None):
422
Get just part of a file.
424
:param relpath: Path to the file, relative to base
425
:param start: The starting position to read from
426
:param length: The length to read. A length of None indicates
427
read to the end of the file.
428
:return: A file-like object containing at least the specified bytes.
429
Some implementations may return objects which can be read
430
past this length, but this is not guaranteed.
432
# TODO: implement get_partial_multi to help with knit support
433
f = self.get(relpath)
435
if self._do_prefetch and hasattr(f, 'prefetch'):
439
def put(self, relpath, f, mode=None):
441
Copy the file-like or string object into the location.
454
def recommended_page_size(self):
455
"""See Transport.recommended_page_size().
457
For SFTP we suggest a large page size to reduce the overhead
458
introduced by latency.
462
def _sftp_readv(self, fp, offsets, relpath='<unknown>'):
463
"""Use the readv() member of fp to do async readv.
465
And then read them using paramiko.readv(). paramiko.readv()
466
does not support ranges > 64K, so it caps the request size, and
467
just reads until it gets all the stuff it wants
469
helper = _SFTPReadvHelper(offsets, relpath, self._report_activity)
470
return helper.request_and_yield_offsets(fp)
472
def put_file(self, relpath, f, mode=None):
474
Copy the file-like object into the location.
443
476
:param relpath: Location to put the contents, relative to base.
444
:param f: File-like or string object.
477
:param f: File-like object.
445
478
:param mode: The final mode for the file
447
480
final_path = self._remote_path(relpath)
448
self._put(final_path, f, mode=mode)
481
return self._put(final_path, f, mode=mode)
450
483
def _put(self, abspath, f, mode=None):
451
484
"""Helper function so both put() and copy_abspaths can reuse the code"""
621
def _mkdir(self, abspath, mode=None):
627
self._get_sftp().mkdir(abspath, local_mode)
629
# chmod a dir through sftp will erase any sgid bit set
630
# on the server side. So, if the bit mode are already
631
# set, avoid the chmod. If the mode is not fine but
632
# the sgid bit is set, report a warning to the user
633
# with the umask fix.
634
stat = self._get_sftp().lstat(abspath)
635
mode = mode & 0777 # can't set special bits anyway
636
if mode != stat.st_mode & 0777:
637
if stat.st_mode & 06000:
638
warning('About to chmod %s over sftp, which will result'
639
' in its suid or sgid bits being cleared. If'
640
' you want to preserve those bits, change your '
641
' environment on the server to use umask 0%03o.'
642
% (abspath, 0777 - mode))
643
self._get_sftp().chmod(abspath, mode=mode)
644
except (paramiko.SSHException, IOError), e:
645
self._translate_io_exception(e, abspath, ': unable to mkdir',
646
failure_exc=FileExists)
497
648
def mkdir(self, relpath, mode=None):
498
649
"""Create a directory at the given path."""
650
self._mkdir(self._remote_path(relpath), mode=mode)
652
def open_write_stream(self, relpath, mode=None):
653
"""See Transport.open_write_stream."""
654
# initialise the file to zero-length
655
# this is three round trips, but we don't use this
656
# api more than once per write_group at the moment so
657
# it is a tolerable overhead. Better would be to truncate
658
# the file after opening. RBC 20070805
659
self.put_bytes_non_atomic(relpath, "", mode)
660
abspath = self._remote_path(relpath)
661
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
662
# set the file mode at create time. If it does, use it.
663
# But for now, we just chmod later anyway.
500
path = self._remote_path(relpath)
501
# In the paramiko documentation, it says that passing a mode flag
502
# will filtered against the server umask.
503
# StubSFTPServer does not do this, which would be nice, because it is
504
# what we really want :)
505
# However, real servers do use umask, so we really should do it that way
506
self._sftp.mkdir(path)
508
self._sftp.chmod(path, mode=mode)
666
handle = self._get_sftp().file(abspath, mode='wb')
667
handle.set_pipelined(True)
509
668
except (paramiko.SSHException, IOError), e:
510
self._translate_io_exception(e, path, ': unable to mkdir',
511
failure_exc=FileExists)
669
self._translate_io_exception(e, abspath,
671
_file_streams[self.abspath(relpath)] = handle
672
return FileFileStream(self, relpath, handle)
513
def _translate_io_exception(self, e, path, more_info='',
674
def _translate_io_exception(self, e, path, more_info='',
514
675
failure_exc=PathError):
515
676
"""Translate a paramiko or IOError into a friendlier exception.
648
821
# that we have taken the lock.
649
822
return SFTPLock(relpath, self)
651
def _unparse_url(self, path=None):
654
path = urllib.quote(path)
655
# handle homedir paths
656
if not path.startswith('/'):
658
netloc = urllib.quote(self._host)
659
if self._username is not None:
660
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
661
if self._port is not None:
662
netloc = '%s:%d' % (netloc, self._port)
663
return urlparse.urlunparse(('sftp', netloc, path, '', '', ''))
665
def _split_url(self, url):
666
(scheme, username, password, host, port, path) = split_url(url)
667
assert scheme == 'sftp'
669
# the initial slash should be removed from the path, and treated
670
# as a homedir relative path (the path begins with a double slash
671
# if it is absolute).
672
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
673
# RBC 20060118 we are not using this as its too user hostile. instead
674
# we are following lftp and using /~/foo to mean '~/foo'.
675
# handle homedir paths
676
if path.startswith('/~/'):
680
return (username, password, host, port, path)
682
def _parse_url(self, url):
683
(self._username, self._password,
684
self._host, self._port, self._path) = self._split_url(url)
686
def _sftp_connect(self):
687
"""Connect to the remote sftp server.
688
After this, self._sftp should have a valid connection (or
689
we raise an TransportError 'could not connect').
691
TODO: Raise a more reasonable ConnectionFailed exception
693
global _connected_hosts
695
idx = (self._host, self._port, self._username)
697
self._sftp = _connected_hosts[idx]
702
vendor = _get_ssh_vendor()
703
if vendor == 'loopback':
704
sock = socket.socket()
705
sock.connect((self._host, self._port))
706
self._sftp = SFTPClient(LoopbackSFTP(sock))
707
elif vendor != 'none':
708
sock = SFTPSubprocess(self._host, vendor, self._port,
710
self._sftp = SFTPClient(sock)
712
self._paramiko_connect()
714
_connected_hosts[idx] = self._sftp
716
def _paramiko_connect(self):
717
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
722
t = paramiko.Transport((self._host, self._port or 22))
723
t.set_log_channel('bzr.paramiko')
725
except paramiko.SSHException, e:
726
raise ConnectionError('Unable to reach SSH host %s:%d' %
727
(self._host, self._port), e)
729
server_key = t.get_remote_server_key()
730
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
731
keytype = server_key.get_name()
732
if SYSTEM_HOSTKEYS.has_key(self._host) and SYSTEM_HOSTKEYS[self._host].has_key(keytype):
733
our_server_key = SYSTEM_HOSTKEYS[self._host][keytype]
734
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
735
elif BZR_HOSTKEYS.has_key(self._host) and BZR_HOSTKEYS[self._host].has_key(keytype):
736
our_server_key = BZR_HOSTKEYS[self._host][keytype]
737
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
739
warning('Adding %s host key for %s: %s' % (keytype, self._host, server_key_hex))
740
if not BZR_HOSTKEYS.has_key(self._host):
741
BZR_HOSTKEYS[self._host] = {}
742
BZR_HOSTKEYS[self._host][keytype] = server_key
743
our_server_key = server_key
744
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
746
if server_key != our_server_key:
747
filename1 = os.path.expanduser('~/.ssh/known_hosts')
748
filename2 = pathjoin(config_dir(), 'ssh_host_keys')
749
raise TransportError('Host keys for %s do not match! %s != %s' % \
750
(self._host, our_server_key_hex, server_key_hex),
751
['Try editing %s or %s' % (filename1, filename2)])
756
self._sftp = t.open_sftp_client()
757
except paramiko.SSHException, e:
758
raise ConnectionError('Unable to start sftp client %s:%d' %
759
(self._host, self._port), e)
761
def _sftp_auth(self, transport):
762
# paramiko requires a username, but it might be none if nothing was supplied
763
# use the local username, just in case.
764
# We don't override self._username, because if we aren't using paramiko,
765
# the username might be specified in ~/.ssh/config and we don't want to
766
# force it to something else
767
# Also, it would mess up the self.relpath() functionality
768
username = self._username or getpass.getuser()
770
# Paramiko tries to open a socket.AF_UNIX in order to connect
771
# to ssh-agent. That attribute doesn't exist on win32 (it does in cygwin)
772
# so we get an AttributeError exception. For now, just don't try to
773
# connect to an agent if we are on win32
774
if sys.platform != 'win32':
775
agent = paramiko.Agent()
776
for key in agent.get_keys():
777
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
779
transport.auth_publickey(username, key)
781
except paramiko.SSHException, e:
784
# okay, try finding id_rsa or id_dss? (posix only)
785
if self._try_pkey_auth(transport, paramiko.RSAKey, username, 'id_rsa'):
787
if self._try_pkey_auth(transport, paramiko.DSSKey, username, 'id_dsa'):
792
transport.auth_password(username, self._password)
794
except paramiko.SSHException, e:
797
# FIXME: Don't keep a password held in memory if you can help it
798
#self._password = None
800
# give up and ask for a password
801
password = bzrlib.ui.ui_factory.get_password(
802
prompt='SSH %(user)s@%(host)s password',
803
user=username, host=self._host)
805
transport.auth_password(username, password)
806
except paramiko.SSHException, e:
807
raise ConnectionError('Unable to authenticate to SSH host as %s@%s' %
808
(username, self._host), e)
810
def _try_pkey_auth(self, transport, pkey_class, username, filename):
811
filename = os.path.expanduser('~/.ssh/' + filename)
813
key = pkey_class.from_private_key_file(filename)
814
transport.auth_publickey(username, key)
816
except paramiko.PasswordRequiredException:
817
password = bzrlib.ui.ui_factory.get_password(
818
prompt='SSH %(filename)s password',
821
key = pkey_class.from_private_key_file(filename, password)
822
transport.auth_publickey(username, key)
824
except paramiko.SSHException:
825
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
826
except paramiko.SSHException:
827
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
832
824
def _sftp_open_exclusive(self, abspath, mode=None):
833
825
"""Open a remote path exclusively.
895
897
self._socket.bind(('localhost', 0))
896
898
self._socket.listen(1)
897
899
self.port = self._socket.getsockname()[1]
898
self.stop_event = threading.Event()
901
s, _ = self._socket.accept()
902
# now close the listen socket
905
self._callback(s, self.stop_event)
907
pass #Ignore socket errors
909
# probably a failed test
910
warning('Exception from within unit test server thread: %r' % x)
900
self._stop_event = threading.Event()
913
self.stop_event.set()
903
# called from outside this thread
904
self._stop_event.set()
914
905
# use a timeout here, because if the test fails, the server thread may
915
906
# never notice the stop_event.
912
readable, writable_unused, exception_unused = \
913
select.select([self._socket], [], [], 0.1)
914
if self._stop_event.isSet():
916
if len(readable) == 0:
919
s, addr_unused = self._socket.accept()
920
# because the loopback socket is inline, and transports are
921
# never explicitly closed, best to launch a new thread.
922
threading.Thread(target=self._callback, args=(s,)).start()
923
except socket.error, x:
924
sys.excepthook(*sys.exc_info())
925
warning('Socket error during accept() within unit test server'
928
# probably a failed test; unit test thread will log the
930
sys.excepthook(*sys.exc_info())
931
warning('Exception from within unit test server thread: %r' %
935
class SocketDelay(object):
936
"""A socket decorator to make TCP appear slower.
938
This changes recv, send, and sendall to add a fixed latency to each python
939
call if a new roundtrip is detected. That is, when a recv is called and the
940
flag new_roundtrip is set, latency is charged. Every send and send_all
943
In addition every send, sendall and recv sleeps a bit per character send to
946
Not all methods are implemented, this is deliberate as this class is not a
947
replacement for the builtin sockets layer. fileno is not implemented to
948
prevent the proxy being bypassed.
952
_proxied_arguments = dict.fromkeys([
953
"close", "getpeername", "getsockname", "getsockopt", "gettimeout",
954
"setblocking", "setsockopt", "settimeout", "shutdown"])
956
def __init__(self, sock, latency, bandwidth=1.0,
959
:param bandwith: simulated bandwith (MegaBit)
960
:param really_sleep: If set to false, the SocketDelay will just
961
increase a counter, instead of calling time.sleep. This is useful for
962
unittesting the SocketDelay.
965
self.latency = latency
966
self.really_sleep = really_sleep
967
self.time_per_byte = 1 / (bandwidth / 8.0 * 1024 * 1024)
968
self.new_roundtrip = False
971
if self.really_sleep:
974
SocketDelay.simulated_time += s
976
def __getattr__(self, attr):
977
if attr in SocketDelay._proxied_arguments:
978
return getattr(self.sock, attr)
979
raise AttributeError("'SocketDelay' object has no attribute %r" %
983
return SocketDelay(self.sock.dup(), self.latency, self.time_per_byte,
986
def recv(self, *args):
987
data = self.sock.recv(*args)
988
if data and self.new_roundtrip:
989
self.new_roundtrip = False
990
self.sleep(self.latency)
991
self.sleep(len(data) * self.time_per_byte)
994
def sendall(self, data, flags=0):
995
if not self.new_roundtrip:
996
self.new_roundtrip = True
997
self.sleep(self.latency)
998
self.sleep(len(data) * self.time_per_byte)
999
return self.sock.sendall(data, flags)
1001
def send(self, data, flags=0):
1002
if not self.new_roundtrip:
1003
self.new_roundtrip = True
1004
self.sleep(self.latency)
1005
bytes_sent = self.sock.send(data, flags)
1006
self.sleep(bytes_sent * self.time_per_byte)
919
1010
class SFTPServer(Server):
920
1011
"""Common code for SFTP server facilities."""
1013
def __init__(self, server_interface=StubServer):
923
1014
self._original_vendor = None
924
1015
self._homedir = None
925
1016
self._server_homedir = None
926
1017
self._listener = None
927
1018
self._root = None
928
self._vendor = 'none'
1019
self._vendor = ssh.ParamikoVendor()
1020
self._server_interface = server_interface
929
1021
# sftp server logs
1023
self.add_latency = 0
932
1025
def _get_sftp_url(self, path):
933
1026
"""Calculate an sftp url to this server for path."""
added
removed
bzrlib/transport/sftp.py
