1
# Copyright (C) 2005 Robey Pointer <robey@lag.net>
2
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
"""Implementation of Transport over SFTP, using paramiko."""
20
# TODO: Remove the transport-based lock_read and lock_write methods. They'll
21
# then raise TransportNotPossible, which will break remote access to any
22
# formats which rely on OS-level locks. That should be fine as those formats
23
# are pretty old, but these combinations may have to be removed from the test
24
# suite. Those formats all date back to 0.7; so we should be able to remove
25
# these methods when we officially drop support for those formats.
43
from bzrlib.errors import (FileExists,
44
NoSuchFile, PathNotChild,
50
from bzrlib.osutils import pathjoin, fancy_rename, getcwd
51
from bzrlib.symbol_versioning import (
55
from bzrlib.trace import mutter, warning
56
from bzrlib.transport import (
60
register_urlparse_netloc_protocol,
66
# Disable one particular warning that comes from paramiko in Python2.5; if
67
# this is emitted at the wrong time it tends to cause spurious test failures
68
# or at least noise in the test case::
70
# [1770/7639 in 86s, 1 known failures, 50 skipped, 2 missing features]
71
# test_permissions.TestSftpPermissions.test_new_files
72
# /var/lib/python-support/python2.5/paramiko/message.py:226: DeprecationWarning: integer argument expected, got float
73
# self.packet.write(struct.pack('>I', n))
74
warnings.filterwarnings('ignore',
75
'integer argument expected, got float',
76
category=DeprecationWarning,
77
module='paramiko.message')
81
except ImportError, e:
82
raise ParamikoNotPresent(e)
84
from paramiko.sftp import (SFTP_FLAG_WRITE, SFTP_FLAG_CREATE,
85
SFTP_FLAG_EXCL, SFTP_FLAG_TRUNC,
87
from paramiko.sftp_attr import SFTPAttributes
88
from paramiko.sftp_file import SFTPFile
91
register_urlparse_netloc_protocol('sftp')
94
_paramiko_version = getattr(paramiko, '__version_info__', (0, 0, 0))
95
# don't use prefetch unless paramiko version >= 1.5.5 (there were bugs earlier)
96
_default_do_prefetch = (_paramiko_version >= (1, 5, 5))
99
@deprecated_function(zero_ninety)
100
def clear_connection_cache():
101
"""Remove all hosts from the SFTP connection cache.
103
Primarily useful for test cases wanting to force garbage collection.
104
We don't have a global connection cache anymore.
107
class SFTPLock(object):
108
"""This fakes a lock in a remote location.
110
A present lock is indicated just by the existence of a file. This
111
doesn't work well on all transports and they are only used in
112
deprecated storage formats.
115
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
117
def __init__(self, path, transport):
118
assert isinstance(transport, SFTPTransport)
120
self.lock_file = None
122
self.lock_path = path + '.write-lock'
123
self.transport = transport
125
# RBC 20060103 FIXME should we be using private methods here ?
126
abspath = transport._remote_path(self.lock_path)
127
self.lock_file = transport._sftp_open_exclusive(abspath)
129
raise LockError('File %r already locked' % (self.path,))
132
"""Should this warn, or actually try to cleanup?"""
134
warning("SFTPLock %r not explicitly unlocked" % (self.path,))
138
if not self.lock_file:
140
self.lock_file.close()
141
self.lock_file = None
143
self.transport.delete(self.lock_path)
144
except (NoSuchFile,):
145
# What specific errors should we catch here?
149
class SFTPTransport(ConnectedTransport):
150
"""Transport implementation for SFTP access."""
152
_do_prefetch = _default_do_prefetch
153
# TODO: jam 20060717 Conceivably these could be configurable, either
154
# by auto-tuning at run-time, or by a configuration (per host??)
155
# but the performance curve is pretty flat, so just going with
156
# reasonable defaults.
157
_max_readv_combine = 200
158
# Having to round trip to the server means waiting for a response,
159
# so it is better to download extra bytes.
160
# 8KiB had good performance for both local and remote network operations
161
_bytes_to_read_before_seek = 8192
163
# The sftp spec says that implementations SHOULD allow reads
164
# to be at least 32K. paramiko.readv() does an async request
165
# for the chunks. So we need to keep it within a single request
166
# size for paramiko <= 1.6.1. paramiko 1.6.2 will probably chop
167
# up the request itself, rather than us having to worry about it
168
_max_request_size = 32768
170
def __init__(self, base, _from_transport=None):
171
assert base.startswith('sftp://')
172
super(SFTPTransport, self).__init__(base,
173
_from_transport=_from_transport)
175
def _remote_path(self, relpath):
176
"""Return the path to be passed along the sftp protocol for relpath.
178
:param relpath: is a urlencoded string.
180
relative = urlutils.unescape(relpath).encode('utf-8')
181
remote_path = self._combine_paths(self._path, relative)
182
# the initial slash should be removed from the path, and treated as a
183
# homedir relative path (the path begins with a double slash if it is
184
# absolute). see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
185
# RBC 20060118 we are not using this as its too user hostile. instead
186
# we are following lftp and using /~/foo to mean '~/foo'
187
# vila--20070602 and leave absolute paths begin with a single slash.
188
if remote_path.startswith('/~/'):
189
remote_path = remote_path[3:]
190
elif remote_path == '/~':
194
def _create_connection(self, credentials=None):
195
"""Create a new connection with the provided credentials.
197
:param credentials: The credentials needed to establish the connection.
199
:return: The created connection and its associated credentials.
201
The credentials are only the password as it may have been entered
202
interactively by the user and may be different from the one provided
203
in base url at transport creation time.
205
if credentials is None:
206
password = self._password
208
password = credentials
210
vendor = ssh._get_ssh_vendor()
211
connection = vendor.connect_sftp(self._user, password,
212
self._host, self._port)
213
return connection, password
216
"""Ensures that a connection is established"""
217
connection = self._get_connection()
218
if connection is None:
219
# First connection ever
220
connection, credentials = self._create_connection()
221
self._set_connection(connection, credentials)
224
def has(self, relpath):
226
Does the target location exist?
229
self._get_sftp().stat(self._remote_path(relpath))
234
def get(self, relpath):
236
Get the file at the given relative path.
238
:param relpath: The relative path to the file
241
path = self._remote_path(relpath)
242
f = self._get_sftp().file(path, mode='rb')
243
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
246
except (IOError, paramiko.SSHException), e:
247
self._translate_io_exception(e, path, ': error retrieving',
248
failure_exc=errors.ReadError)
250
def _readv(self, relpath, offsets):
251
"""See Transport.readv()"""
252
# We overload the default readv() because we want to use a file
253
# that does not have prefetch enabled.
254
# Also, if we have a new paramiko, it implements an async readv()
259
path = self._remote_path(relpath)
260
fp = self._get_sftp().file(path, mode='rb')
261
readv = getattr(fp, 'readv', None)
263
return self._sftp_readv(fp, offsets, relpath)
264
mutter('seek and read %s offsets', len(offsets))
265
return self._seek_and_read(fp, offsets, relpath)
266
except (IOError, paramiko.SSHException), e:
267
self._translate_io_exception(e, path, ': error retrieving')
269
def recommended_page_size(self):
270
"""See Transport.recommended_page_size().
272
For SFTP we suggest a large page size to reduce the overhead
273
introduced by latency.
277
def _sftp_readv(self, fp, offsets, relpath='<unknown>'):
278
"""Use the readv() member of fp to do async readv.
280
And then read them using paramiko.readv(). paramiko.readv()
281
does not support ranges > 64K, so it caps the request size, and
282
just reads until it gets all the stuff it wants
284
offsets = list(offsets)
285
sorted_offsets = sorted(offsets)
287
# The algorithm works as follows:
288
# 1) Coalesce nearby reads into a single chunk
289
# This generates a list of combined regions, the total size
290
# and the size of the sub regions. This coalescing step is limited
291
# in the number of nearby chunks to combine, and is allowed to
292
# skip small breaks in the requests. Limiting it makes sure that
293
# we can start yielding some data earlier, and skipping means we
294
# make fewer requests. (Beneficial even when using async)
295
# 2) Break up this combined regions into chunks that are smaller
296
# than 64KiB. Technically the limit is 65536, but we are a
297
# little bit conservative. This is because sftp has a maximum
298
# return chunk size of 64KiB (max size of an unsigned short)
299
# 3) Issue a readv() to paramiko to create an async request for
301
# 4) Read in the data as it comes back, until we've read one
302
# continuous section as determined in step 1
303
# 5) Break up the full sections into hunks for the original requested
304
# offsets. And put them in a cache
305
# 6) Check if the next request is in the cache, and if it is, remove
306
# it from the cache, and yield its data. Continue until no more
307
# entries are in the cache.
308
# 7) loop back to step 4 until all data has been read
310
# TODO: jam 20060725 This could be optimized one step further, by
311
# attempting to yield whatever data we have read, even before
312
# the first coallesced section has been fully processed.
314
# When coalescing for use with readv(), we don't really need to
315
# use any fudge factor, because the requests are made asynchronously
316
coalesced = list(self._coalesce_offsets(sorted_offsets,
317
limit=self._max_readv_combine,
321
for c_offset in coalesced:
322
start = c_offset.start
323
size = c_offset.length
325
# We need to break this up into multiple requests
327
next_size = min(size, self._max_request_size)
328
requests.append((start, next_size))
332
mutter('SFTP.readv() %s offsets => %s coalesced => %s requests',
333
len(offsets), len(coalesced), len(requests))
335
# Queue the current read until we have read the full coalesced section
338
cur_coalesced_stack = iter(coalesced)
339
cur_coalesced = cur_coalesced_stack.next()
341
# Cache the results, but only until they have been fulfilled
343
# turn the list of offsets into a stack
344
offset_stack = iter(offsets)
345
cur_offset_and_size = offset_stack.next()
347
for data in fp.readv(requests):
349
cur_data_len += len(data)
351
if cur_data_len < cur_coalesced.length:
353
assert cur_data_len == cur_coalesced.length, \
354
"Somehow we read too much: %s != %s" % (cur_data_len,
355
cur_coalesced.length)
356
all_data = ''.join(cur_data)
360
for suboffset, subsize in cur_coalesced.ranges:
361
key = (cur_coalesced.start+suboffset, subsize)
362
data_map[key] = all_data[suboffset:suboffset+subsize]
364
# Now that we've read some data, see if we can yield anything back
365
while cur_offset_and_size in data_map:
366
this_data = data_map.pop(cur_offset_and_size)
367
yield cur_offset_and_size[0], this_data
368
cur_offset_and_size = offset_stack.next()
370
# We read a coalesced entry, so mark it as done
372
# Now that we've read all of the data for this coalesced section
374
cur_coalesced = cur_coalesced_stack.next()
376
if cur_coalesced is not None:
377
raise errors.ShortReadvError(relpath, cur_coalesced.start,
378
cur_coalesced.length, len(data))
380
def put_file(self, relpath, f, mode=None):
382
Copy the file-like object into the location.
384
:param relpath: Location to put the contents, relative to base.
385
:param f: File-like object.
386
:param mode: The final mode for the file
388
final_path = self._remote_path(relpath)
389
return self._put(final_path, f, mode=mode)
391
def _put(self, abspath, f, mode=None):
392
"""Helper function so both put() and copy_abspaths can reuse the code"""
393
tmp_abspath = '%s.tmp.%.9f.%d.%d' % (abspath, time.time(),
394
os.getpid(), random.randint(0,0x7FFFFFFF))
395
fout = self._sftp_open_exclusive(tmp_abspath, mode=mode)
399
fout.set_pipelined(True)
400
length = self._pump(f, fout)
401
except (IOError, paramiko.SSHException), e:
402
self._translate_io_exception(e, tmp_abspath)
403
# XXX: This doesn't truly help like we would like it to.
404
# The problem is that openssh strips sticky bits. So while we
405
# can properly set group write permission, we lose the group
406
# sticky bit. So it is probably best to stop chmodding, and
407
# just tell users that they need to set the umask correctly.
408
# The attr.st_mode = mode, in _sftp_open_exclusive
409
# will handle when the user wants the final mode to be more
410
# restrictive. And then we avoid a round trip. Unless
411
# paramiko decides to expose an async chmod()
413
# This is designed to chmod() right before we close.
414
# Because we set_pipelined() earlier, theoretically we might
415
# avoid the round trip for fout.close()
417
self._get_sftp().chmod(tmp_abspath, mode)
420
self._rename_and_overwrite(tmp_abspath, abspath)
423
# If we fail, try to clean up the temporary file
424
# before we throw the exception
425
# but don't let another exception mess things up
426
# Write out the traceback, because otherwise
427
# the catch and throw destroys it
429
mutter(traceback.format_exc())
433
self._get_sftp().remove(tmp_abspath)
435
# raise the saved except
437
# raise the original with its traceback if we can.
440
def _put_non_atomic_helper(self, relpath, writer, mode=None,
441
create_parent_dir=False,
443
abspath = self._remote_path(relpath)
445
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
446
# set the file mode at create time. If it does, use it.
447
# But for now, we just chmod later anyway.
449
def _open_and_write_file():
450
"""Try to open the target file, raise error on failure"""
454
fout = self._get_sftp().file(abspath, mode='wb')
455
fout.set_pipelined(True)
457
except (paramiko.SSHException, IOError), e:
458
self._translate_io_exception(e, abspath,
461
# This is designed to chmod() right before we close.
462
# Because we set_pipelined() earlier, theoretically we might
463
# avoid the round trip for fout.close()
465
self._get_sftp().chmod(abspath, mode)
470
if not create_parent_dir:
471
_open_and_write_file()
474
# Try error handling to create the parent directory if we need to
476
_open_and_write_file()
478
# Try to create the parent directory, and then go back to
480
parent_dir = os.path.dirname(abspath)
481
self._mkdir(parent_dir, dir_mode)
482
_open_and_write_file()
484
def put_file_non_atomic(self, relpath, f, mode=None,
485
create_parent_dir=False,
487
"""Copy the file-like object into the target location.
489
This function is not strictly safe to use. It is only meant to
490
be used when you already know that the target does not exist.
491
It is not safe, because it will open and truncate the remote
492
file. So there may be a time when the file has invalid contents.
494
:param relpath: The remote location to put the contents.
495
:param f: File-like object.
496
:param mode: Possible access permissions for new file.
497
None means do not set remote permissions.
498
:param create_parent_dir: If we cannot create the target file because
499
the parent directory does not exist, go ahead and
500
create it, and then try again.
504
self._put_non_atomic_helper(relpath, writer, mode=mode,
505
create_parent_dir=create_parent_dir,
508
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
509
create_parent_dir=False,
513
self._put_non_atomic_helper(relpath, writer, mode=mode,
514
create_parent_dir=create_parent_dir,
517
def iter_files_recursive(self):
518
"""Walk the relative paths of all files in this transport."""
519
queue = list(self.list_dir('.'))
521
relpath = queue.pop(0)
522
st = self.stat(relpath)
523
if stat.S_ISDIR(st.st_mode):
524
for i, basename in enumerate(self.list_dir(relpath)):
525
queue.insert(i, relpath+'/'+basename)
529
def _mkdir(self, abspath, mode=None):
535
self._get_sftp().mkdir(abspath, local_mode)
537
self._get_sftp().chmod(abspath, mode=mode)
538
except (paramiko.SSHException, IOError), e:
539
self._translate_io_exception(e, abspath, ': unable to mkdir',
540
failure_exc=FileExists)
542
def mkdir(self, relpath, mode=None):
543
"""Create a directory at the given path."""
544
self._mkdir(self._remote_path(relpath), mode=mode)
546
def open_write_stream(self, relpath, mode=None):
547
"""See Transport.open_write_stream."""
548
# initialise the file to zero-length
549
# this is three round trips, but we don't use this
550
# api more than once per write_group at the moment so
551
# it is a tolerable overhead. Better would be to truncate
552
# the file after opening. RBC 20070805
553
self.put_bytes_non_atomic(relpath, "", mode)
554
abspath = self._remote_path(relpath)
555
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
556
# set the file mode at create time. If it does, use it.
557
# But for now, we just chmod later anyway.
560
handle = self._get_sftp().file(abspath, mode='wb')
561
handle.set_pipelined(True)
562
except (paramiko.SSHException, IOError), e:
563
self._translate_io_exception(e, abspath,
565
_file_streams[self.abspath(relpath)] = handle
566
return FileFileStream(self, relpath, handle)
568
def _translate_io_exception(self, e, path, more_info='',
569
failure_exc=PathError):
570
"""Translate a paramiko or IOError into a friendlier exception.
572
:param e: The original exception
573
:param path: The path in question when the error is raised
574
:param more_info: Extra information that can be included,
575
such as what was going on
576
:param failure_exc: Paramiko has the super fun ability to raise completely
577
opaque errors that just set "e.args = ('Failure',)" with
579
If this parameter is set, it defines the exception
580
to raise in these cases.
582
# paramiko seems to generate detailless errors.
583
self._translate_error(e, path, raise_generic=False)
584
if getattr(e, 'args', None) is not None:
585
if (e.args == ('No such file or directory',) or
586
e.args == ('No such file',)):
587
raise NoSuchFile(path, str(e) + more_info)
588
if (e.args == ('mkdir failed',)):
589
raise FileExists(path, str(e) + more_info)
590
# strange but true, for the paramiko server.
591
if (e.args == ('Failure',)):
592
raise failure_exc(path, str(e) + more_info)
593
mutter('Raising exception with args %s', e.args)
594
if getattr(e, 'errno', None) is not None:
595
mutter('Raising exception with errno %s', e.errno)
598
def append_file(self, relpath, f, mode=None):
600
Append the text in the file-like object into the final
604
path = self._remote_path(relpath)
605
fout = self._get_sftp().file(path, 'ab')
607
self._get_sftp().chmod(path, mode)
611
except (IOError, paramiko.SSHException), e:
612
self._translate_io_exception(e, relpath, ': unable to append')
614
def rename(self, rel_from, rel_to):
615
"""Rename without special overwriting"""
617
self._get_sftp().rename(self._remote_path(rel_from),
618
self._remote_path(rel_to))
619
except (IOError, paramiko.SSHException), e:
620
self._translate_io_exception(e, rel_from,
621
': unable to rename to %r' % (rel_to))
623
def _rename_and_overwrite(self, abs_from, abs_to):
624
"""Do a fancy rename on the remote server.
626
Using the implementation provided by osutils.
629
sftp = self._get_sftp()
630
fancy_rename(abs_from, abs_to,
631
rename_func=sftp.rename,
632
unlink_func=sftp.remove)
633
except (IOError, paramiko.SSHException), e:
634
self._translate_io_exception(e, abs_from,
635
': unable to rename to %r' % (abs_to))
637
def move(self, rel_from, rel_to):
638
"""Move the item at rel_from to the location at rel_to"""
639
path_from = self._remote_path(rel_from)
640
path_to = self._remote_path(rel_to)
641
self._rename_and_overwrite(path_from, path_to)
643
def delete(self, relpath):
644
"""Delete the item at relpath"""
645
path = self._remote_path(relpath)
647
self._get_sftp().remove(path)
648
except (IOError, paramiko.SSHException), e:
649
self._translate_io_exception(e, path, ': unable to delete')
651
def external_url(self):
652
"""See bzrlib.transport.Transport.external_url."""
653
# the external path for SFTP is the base
657
"""Return True if this store supports listing."""
660
def list_dir(self, relpath):
662
Return a list of all files at the given location.
664
# does anything actually use this?
666
# This is at least used by copy_tree for remote upgrades.
667
# -- David Allouche 2006-08-11
668
path = self._remote_path(relpath)
670
entries = self._get_sftp().listdir(path)
671
except (IOError, paramiko.SSHException), e:
672
self._translate_io_exception(e, path, ': failed to list_dir')
673
return [urlutils.escape(entry) for entry in entries]
675
def rmdir(self, relpath):
676
"""See Transport.rmdir."""
677
path = self._remote_path(relpath)
679
return self._get_sftp().rmdir(path)
680
except (IOError, paramiko.SSHException), e:
681
self._translate_io_exception(e, path, ': failed to rmdir')
683
def stat(self, relpath):
684
"""Return the stat information for a file."""
685
path = self._remote_path(relpath)
687
return self._get_sftp().stat(path)
688
except (IOError, paramiko.SSHException), e:
689
self._translate_io_exception(e, path, ': unable to stat')
691
def lock_read(self, relpath):
693
Lock the given file for shared (read) access.
694
:return: A lock object, which has an unlock() member function
696
# FIXME: there should be something clever i can do here...
697
class BogusLock(object):
698
def __init__(self, path):
702
return BogusLock(relpath)
704
def lock_write(self, relpath):
706
Lock the given file for exclusive (write) access.
707
WARNING: many transports do not support this, so trying avoid using it
709
:return: A lock object, which has an unlock() member function
711
# This is a little bit bogus, but basically, we create a file
712
# which should not already exist, and if it does, we assume
713
# that there is a lock, and if it doesn't, the we assume
714
# that we have taken the lock.
715
return SFTPLock(relpath, self)
717
def _sftp_open_exclusive(self, abspath, mode=None):
718
"""Open a remote path exclusively.
720
SFTP supports O_EXCL (SFTP_FLAG_EXCL), which fails if
721
the file already exists. However it does not expose this
722
at the higher level of SFTPClient.open(), so we have to
725
WARNING: This breaks the SFTPClient abstraction, so it
726
could easily break against an updated version of paramiko.
728
:param abspath: The remote absolute path where the file should be opened
729
:param mode: The mode permissions bits for the new file
731
# TODO: jam 20060816 Paramiko >= 1.6.2 (probably earlier) supports
732
# using the 'x' flag to indicate SFTP_FLAG_EXCL.
733
# However, there is no way to set the permission mode at open
734
# time using the sftp_client.file() functionality.
735
path = self._get_sftp()._adjust_cwd(abspath)
736
# mutter('sftp abspath %s => %s', abspath, path)
737
attr = SFTPAttributes()
740
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
741
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
743
t, msg = self._get_sftp()._request(CMD_OPEN, path, omode, attr)
745
raise TransportError('Expected an SFTP handle')
746
handle = msg.get_string()
747
return SFTPFile(self._get_sftp(), handle, 'wb', -1)
748
except (paramiko.SSHException, IOError), e:
749
self._translate_io_exception(e, abspath, ': unable to open',
750
failure_exc=FileExists)
752
def _can_roundtrip_unix_modebits(self):
753
if sys.platform == 'win32':
759
# ------------- server test implementation --------------
762
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
764
STUB_SERVER_KEY = """
765
-----BEGIN RSA PRIVATE KEY-----
766
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
767
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
768
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
769
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
770
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
771
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
772
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
773
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
774
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
775
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
776
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
777
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
778
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
779
-----END RSA PRIVATE KEY-----
783
class SocketListener(threading.Thread):
785
def __init__(self, callback):
786
threading.Thread.__init__(self)
787
self._callback = callback
788
self._socket = socket.socket()
789
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
790
self._socket.bind(('localhost', 0))
791
self._socket.listen(1)
792
self.port = self._socket.getsockname()[1]
793
self._stop_event = threading.Event()
796
# called from outside this thread
797
self._stop_event.set()
798
# use a timeout here, because if the test fails, the server thread may
799
# never notice the stop_event.
805
readable, writable_unused, exception_unused = \
806
select.select([self._socket], [], [], 0.1)
807
if self._stop_event.isSet():
809
if len(readable) == 0:
812
s, addr_unused = self._socket.accept()
813
# because the loopback socket is inline, and transports are
814
# never explicitly closed, best to launch a new thread.
815
threading.Thread(target=self._callback, args=(s,)).start()
816
except socket.error, x:
817
sys.excepthook(*sys.exc_info())
818
warning('Socket error during accept() within unit test server'
821
# probably a failed test; unit test thread will log the
823
sys.excepthook(*sys.exc_info())
824
warning('Exception from within unit test server thread: %r' %
828
class SocketDelay(object):
829
"""A socket decorator to make TCP appear slower.
831
This changes recv, send, and sendall to add a fixed latency to each python
832
call if a new roundtrip is detected. That is, when a recv is called and the
833
flag new_roundtrip is set, latency is charged. Every send and send_all
836
In addition every send, sendall and recv sleeps a bit per character send to
839
Not all methods are implemented, this is deliberate as this class is not a
840
replacement for the builtin sockets layer. fileno is not implemented to
841
prevent the proxy being bypassed.
845
_proxied_arguments = dict.fromkeys([
846
"close", "getpeername", "getsockname", "getsockopt", "gettimeout",
847
"setblocking", "setsockopt", "settimeout", "shutdown"])
849
def __init__(self, sock, latency, bandwidth=1.0,
852
:param bandwith: simulated bandwith (MegaBit)
853
:param really_sleep: If set to false, the SocketDelay will just
854
increase a counter, instead of calling time.sleep. This is useful for
855
unittesting the SocketDelay.
858
self.latency = latency
859
self.really_sleep = really_sleep
860
self.time_per_byte = 1 / (bandwidth / 8.0 * 1024 * 1024)
861
self.new_roundtrip = False
864
if self.really_sleep:
867
SocketDelay.simulated_time += s
869
def __getattr__(self, attr):
870
if attr in SocketDelay._proxied_arguments:
871
return getattr(self.sock, attr)
872
raise AttributeError("'SocketDelay' object has no attribute %r" %
876
return SocketDelay(self.sock.dup(), self.latency, self.time_per_byte,
879
def recv(self, *args):
880
data = self.sock.recv(*args)
881
if data and self.new_roundtrip:
882
self.new_roundtrip = False
883
self.sleep(self.latency)
884
self.sleep(len(data) * self.time_per_byte)
887
def sendall(self, data, flags=0):
888
if not self.new_roundtrip:
889
self.new_roundtrip = True
890
self.sleep(self.latency)
891
self.sleep(len(data) * self.time_per_byte)
892
return self.sock.sendall(data, flags)
894
def send(self, data, flags=0):
895
if not self.new_roundtrip:
896
self.new_roundtrip = True
897
self.sleep(self.latency)
898
bytes_sent = self.sock.send(data, flags)
899
self.sleep(bytes_sent * self.time_per_byte)
903
class SFTPServer(Server):
904
"""Common code for SFTP server facilities."""
906
def __init__(self, server_interface=StubServer):
907
self._original_vendor = None
909
self._server_homedir = None
910
self._listener = None
912
self._vendor = ssh.ParamikoVendor()
913
self._server_interface = server_interface
918
def _get_sftp_url(self, path):
919
"""Calculate an sftp url to this server for path."""
920
return 'sftp://foo:bar@localhost:%d/%s' % (self._listener.port, path)
922
def log(self, message):
923
"""StubServer uses this to log when a new server is created."""
924
self.logs.append(message)
926
def _run_server_entry(self, sock):
927
"""Entry point for all implementations of _run_server.
929
If self.add_latency is > 0.000001 then sock is given a latency adding
932
if self.add_latency > 0.000001:
933
sock = SocketDelay(sock, self.add_latency)
934
return self._run_server(sock)
936
def _run_server(self, s):
937
ssh_server = paramiko.Transport(s)
938
key_file = pathjoin(self._homedir, 'test_rsa.key')
939
f = open(key_file, 'w')
940
f.write(STUB_SERVER_KEY)
942
host_key = paramiko.RSAKey.from_private_key_file(key_file)
943
ssh_server.add_server_key(host_key)
944
server = self._server_interface(self)
945
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
946
StubSFTPServer, root=self._root,
947
home=self._server_homedir)
948
event = threading.Event()
949
ssh_server.start_server(event, server)
952
def setUp(self, backing_server=None):
953
# XXX: TODO: make sftpserver back onto backing_server rather than local
955
assert (backing_server is None or
956
isinstance(backing_server, local.LocalURLServer)), (
957
"backing_server should not be %r, because this can only serve the "
958
"local current working directory." % (backing_server,))
959
self._original_vendor = ssh._ssh_vendor_manager._cached_ssh_vendor
960
ssh._ssh_vendor_manager._cached_ssh_vendor = self._vendor
961
if sys.platform == 'win32':
962
# Win32 needs to use the UNICODE api
963
self._homedir = getcwd()
965
# But Linux SFTP servers should just deal in bytestreams
966
self._homedir = os.getcwd()
967
if self._server_homedir is None:
968
self._server_homedir = self._homedir
970
if sys.platform == 'win32':
972
self._listener = SocketListener(self._run_server_entry)
973
self._listener.setDaemon(True)
974
self._listener.start()
977
"""See bzrlib.transport.Server.tearDown."""
978
self._listener.stop()
979
ssh._ssh_vendor_manager._cached_ssh_vendor = self._original_vendor
981
def get_bogus_url(self):
982
"""See bzrlib.transport.Server.get_bogus_url."""
983
# this is chosen to try to prevent trouble with proxies, wierd dns, etc
984
# we bind a random socket, so that we get a guaranteed unused port
985
# we just never listen on that port
987
s.bind(('localhost', 0))
988
return 'sftp://%s:%s/' % s.getsockname()
991
class SFTPFullAbsoluteServer(SFTPServer):
992
"""A test server for sftp transports, using absolute urls and ssh."""
995
"""See bzrlib.transport.Server.get_url."""
996
homedir = self._homedir
997
if sys.platform != 'win32':
998
# Remove the initial '/' on all platforms but win32
999
homedir = homedir[1:]
1000
return self._get_sftp_url(urlutils.escape(homedir))
1003
class SFTPServerWithoutSSH(SFTPServer):
1004
"""An SFTP server that uses a simple TCP socket pair rather than SSH."""
1007
super(SFTPServerWithoutSSH, self).__init__()
1008
self._vendor = ssh.LoopbackVendor()
1010
def _run_server(self, sock):
1011
# Re-import these as locals, so that they're still accessible during
1012
# interpreter shutdown (when all module globals get set to None, leading
1013
# to confusing errors like "'NoneType' object has no attribute 'error'".
1014
class FakeChannel(object):
1015
def get_transport(self):
1017
def get_log_channel(self):
1021
def get_hexdump(self):
1026
server = paramiko.SFTPServer(FakeChannel(), 'sftp', StubServer(self), StubSFTPServer,
1027
root=self._root, home=self._server_homedir)
1029
server.start_subsystem('sftp', None, sock)
1030
except socket.error, e:
1031
if (len(e.args) > 0) and (e.args[0] == errno.EPIPE):
1032
# it's okay for the client to disconnect abruptly
1033
# (bug in paramiko 1.6: it should absorb this exception)
1037
except Exception, e:
1038
# This typically seems to happen during interpreter shutdown, so
1039
# most of the useful ways to report this error are won't work.
1040
# Writing the exception type, and then the text of the exception,
1041
# seems to be the best we can do.
1043
sys.stderr.write('\nEXCEPTION %r: ' % (e.__class__,))
1044
sys.stderr.write('%s\n\n' % (e,))
1045
server.finish_subsystem()
1048
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
1049
"""A test server for sftp transports, using absolute urls."""
1052
"""See bzrlib.transport.Server.get_url."""
1053
homedir = self._homedir
1054
if sys.platform != 'win32':
1055
# Remove the initial '/' on all platforms but win32
1056
homedir = homedir[1:]
1057
return self._get_sftp_url(urlutils.escape(homedir))
1060
class SFTPHomeDirServer(SFTPServerWithoutSSH):
1061
"""A test server for sftp transports, using homedir relative urls."""
1064
"""See bzrlib.transport.Server.get_url."""
1065
return self._get_sftp_url("~/")
1068
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
1069
"""A test server for sftp transports where only absolute paths will work.
1071
It does this by serving from a deeply-nested directory that doesn't exist.
1074
def setUp(self, backing_server=None):
1075
self._server_homedir = '/dev/noone/runs/tests/here'
1076
super(SFTPSiblingAbsoluteServer, self).setUp(backing_server)
1079
def get_test_permutations():
1080
"""Return the permutations to be used in testing."""
1081
return [(SFTPTransport, SFTPAbsoluteServer),
1082
(SFTPTransport, SFTPHomeDirServer),
1083
(SFTPTransport, SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
