1
# Copyright (C) 2005 Robey Pointer <robey@lag.net>
2
# Copyright (C) 2005, 2006 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."""
33
from bzrlib.errors import (FileExists,
34
NoSuchFile, PathNotChild,
41
from bzrlib.osutils import pathjoin, fancy_rename, getcwd
42
from bzrlib.trace import mutter, warning
43
from bzrlib.transport import (
44
register_urlparse_netloc_protocol,
50
import bzrlib.urlutils as urlutils
54
except ImportError, e:
55
raise ParamikoNotPresent(e)
57
from paramiko.sftp import (SFTP_FLAG_WRITE, SFTP_FLAG_CREATE,
58
SFTP_FLAG_EXCL, SFTP_FLAG_TRUNC,
60
from paramiko.sftp_attr import SFTPAttributes
61
from paramiko.sftp_file import SFTPFile
64
register_urlparse_netloc_protocol('sftp')
67
# This is a weakref dictionary, so that we can reuse connections
68
# that are still active. Long term, it might be nice to have some
69
# sort of expiration policy, such as disconnect if inactive for
70
# X seconds. But that requires a lot more fanciness.
71
_connected_hosts = weakref.WeakValueDictionary()
74
_paramiko_version = getattr(paramiko, '__version_info__', (0, 0, 0))
75
# don't use prefetch unless paramiko version >= 1.5.5 (there were bugs earlier)
76
_default_do_prefetch = (_paramiko_version >= (1, 5, 5))
79
def clear_connection_cache():
80
"""Remove all hosts from the SFTP connection cache.
82
Primarily useful for test cases wanting to force garbage collection.
84
_connected_hosts.clear()
87
class SFTPLock(object):
88
"""This fakes a lock in a remote location."""
89
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
90
def __init__(self, path, transport):
91
assert isinstance(transport, SFTPTransport)
95
self.lock_path = path + '.write-lock'
96
self.transport = transport
98
# RBC 20060103 FIXME should we be using private methods here ?
99
abspath = transport._remote_path(self.lock_path)
100
self.lock_file = transport._sftp_open_exclusive(abspath)
102
raise LockError('File %r already locked' % (self.path,))
105
"""Should this warn, or actually try to cleanup?"""
107
warning("SFTPLock %r not explicitly unlocked" % (self.path,))
111
if not self.lock_file:
113
self.lock_file.close()
114
self.lock_file = None
116
self.transport.delete(self.lock_path)
117
except (NoSuchFile,):
118
# What specific errors should we catch here?
122
class SFTPTransport(Transport):
123
"""Transport implementation for SFTP access."""
125
_do_prefetch = _default_do_prefetch
126
# TODO: jam 20060717 Conceivably these could be configurable, either
127
# by auto-tuning at run-time, or by a configuration (per host??)
128
# but the performance curve is pretty flat, so just going with
129
# reasonable defaults.
130
_max_readv_combine = 200
131
# Having to round trip to the server means waiting for a response,
132
# so it is better to download extra bytes.
133
# 8KiB had good performance for both local and remote network operations
134
_bytes_to_read_before_seek = 8192
136
# The sftp spec says that implementations SHOULD allow reads
137
# to be at least 32K. paramiko.readv() does an async request
138
# for the chunks. So we need to keep it within a single request
139
# size for paramiko <= 1.6.1. paramiko 1.6.2 will probably chop
140
# up the request itself, rather than us having to worry about it
141
_max_request_size = 32768
143
def __init__(self, base, clone_from=None):
144
assert base.startswith('sftp://')
145
self._parse_url(base)
146
base = self._unparse_url()
149
super(SFTPTransport, self).__init__(base)
150
if clone_from is None:
153
# use the same ssh connection, etc
154
self._sftp = clone_from._sftp
155
# super saves 'self.base'
157
def should_cache(self):
159
Return True if the data pulled across should be cached locally.
163
def clone(self, offset=None):
165
Return a new SFTPTransport with root at self.base + offset.
166
We share the same SFTP session between such transports, because it's
167
fairly expensive to set them up.
170
return SFTPTransport(self.base, self)
172
return SFTPTransport(self.abspath(offset), self)
174
def abspath(self, relpath):
176
Return the full url to the given relative path.
178
@param relpath: the relative path or path components
179
@type relpath: str or list
181
return self._unparse_url(self._remote_path(relpath))
183
def _remote_path(self, relpath):
184
"""Return the path to be passed along the sftp protocol for relpath.
186
relpath is a urlencoded string.
188
# FIXME: share the common code across transports
189
assert isinstance(relpath, basestring)
190
relpath = urlutils.unescape(relpath).split('/')
191
basepath = self._path.split('/')
192
if len(basepath) > 0 and basepath[-1] == '':
193
basepath = basepath[:-1]
197
if len(basepath) == 0:
198
# In most filesystems, a request for the parent
199
# of root, just returns root.
207
path = '/'.join(basepath)
208
# mutter('relpath => remotepath %s => %s', relpath, path)
211
def relpath(self, abspath):
212
username, password, host, port, path = self._split_url(abspath)
214
if (username != self._username):
215
error.append('username mismatch')
216
if (host != self._host):
217
error.append('host mismatch')
218
if (port != self._port):
219
error.append('port mismatch')
220
if (not path.startswith(self._path)):
221
error.append('path mismatch')
223
extra = ': ' + ', '.join(error)
224
raise PathNotChild(abspath, self.base, extra=extra)
226
return path[pl:].strip('/')
228
def has(self, relpath):
230
Does the target location exist?
233
self._sftp.stat(self._remote_path(relpath))
238
def get(self, relpath):
240
Get the file at the given relative path.
242
:param relpath: The relative path to the file
245
path = self._remote_path(relpath)
246
f = self._sftp.file(path, mode='rb')
247
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
250
except (IOError, paramiko.SSHException), e:
251
self._translate_io_exception(e, path, ': error retrieving')
253
def readv(self, relpath, offsets):
254
"""See Transport.readv()"""
255
# We overload the default readv() because we want to use a file
256
# that does not have prefetch enabled.
257
# Also, if we have a new paramiko, it implements an async readv()
262
path = self._remote_path(relpath)
263
fp = self._sftp.file(path, mode='rb')
264
readv = getattr(fp, 'readv', None)
266
return self._sftp_readv(fp, offsets)
267
mutter('seek and read %s offsets', len(offsets))
268
return self._seek_and_read(fp, offsets)
269
except (IOError, paramiko.SSHException), e:
270
self._translate_io_exception(e, path, ': error retrieving')
272
def _sftp_readv(self, fp, offsets):
273
"""Use the readv() member of fp to do async readv.
275
And then read them using paramiko.readv(). paramiko.readv()
276
does not support ranges > 64K, so it caps the request size, and
277
just reads until it gets all the stuff it wants
279
offsets = list(offsets)
280
sorted_offsets = sorted(offsets)
282
# The algorithm works as follows:
283
# 1) Coalesce nearby reads into a single chunk
284
# This generates a list of combined regions, the total size
285
# and the size of the sub regions. This coalescing step is limited
286
# in the number of nearby chunks to combine, and is allowed to
287
# skip small breaks in the requests. Limiting it makes sure that
288
# we can start yielding some data earlier, and skipping means we
289
# make fewer requests. (Beneficial even when using async)
290
# 2) Break up this combined regions into chunks that are smaller
291
# than 64KiB. Technically the limit is 65536, but we are a
292
# little bit conservative. This is because sftp has a maximum
293
# return chunk size of 64KiB (max size of an unsigned short)
294
# 3) Issue a readv() to paramiko to create an async request for
296
# 4) Read in the data as it comes back, until we've read one
297
# continuous section as determined in step 1
298
# 5) Break up the full sections into hunks for the original requested
299
# offsets. And put them in a cache
300
# 6) Check if the next request is in the cache, and if it is, remove
301
# it from the cache, and yield its data. Continue until no more
302
# entries are in the cache.
303
# 7) loop back to step 4 until all data has been read
305
# TODO: jam 20060725 This could be optimized one step further, by
306
# attempting to yield whatever data we have read, even before
307
# the first coallesced section has been fully processed.
309
# When coalescing for use with readv(), we don't really need to
310
# use any fudge factor, because the requests are made asynchronously
311
coalesced = list(self._coalesce_offsets(sorted_offsets,
312
limit=self._max_readv_combine,
316
for c_offset in coalesced:
317
start = c_offset.start
318
size = c_offset.length
320
# We need to break this up into multiple requests
322
next_size = min(size, self._max_request_size)
323
requests.append((start, next_size))
327
mutter('SFTP.readv() %s offsets => %s coalesced => %s requests',
328
len(offsets), len(coalesced), len(requests))
330
# Queue the current read until we have read the full coalesced section
333
cur_coalesced_stack = iter(coalesced)
334
cur_coalesced = cur_coalesced_stack.next()
336
# Cache the results, but only until they have been fulfilled
338
# turn the list of offsets into a stack
339
offset_stack = iter(offsets)
340
cur_offset_and_size = offset_stack.next()
342
for data in fp.readv(requests):
344
cur_data_len += len(data)
346
if cur_data_len < cur_coalesced.length:
348
assert cur_data_len == cur_coalesced.length, \
349
"Somehow we read too much: %s != %s" % (cur_data_len,
350
cur_coalesced.length)
351
all_data = ''.join(cur_data)
355
for suboffset, subsize in cur_coalesced.ranges:
356
key = (cur_coalesced.start+suboffset, subsize)
357
data_map[key] = all_data[suboffset:suboffset+subsize]
359
# Now that we've read some data, see if we can yield anything back
360
while cur_offset_and_size in data_map:
361
this_data = data_map.pop(cur_offset_and_size)
362
yield cur_offset_and_size[0], this_data
363
cur_offset_and_size = offset_stack.next()
365
# Now that we've read all of the data for this coalesced section
367
cur_coalesced = cur_coalesced_stack.next()
369
def put(self, relpath, f, mode=None):
371
Copy the file-like or string object into the location.
373
:param relpath: Location to put the contents, relative to base.
374
:param f: File-like or string object.
375
:param mode: The final mode for the file
377
final_path = self._remote_path(relpath)
378
self._put(final_path, f, mode=mode)
380
def _put(self, abspath, f, mode=None):
381
"""Helper function so both put() and copy_abspaths can reuse the code"""
382
tmp_abspath = '%s.tmp.%.9f.%d.%d' % (abspath, time.time(),
383
os.getpid(), random.randint(0,0x7FFFFFFF))
384
fout = self._sftp_open_exclusive(tmp_abspath, mode=mode)
388
fout.set_pipelined(True)
390
except (IOError, paramiko.SSHException), e:
391
self._translate_io_exception(e, tmp_abspath)
393
self._sftp.chmod(tmp_abspath, mode)
396
self._rename_and_overwrite(tmp_abspath, abspath)
398
# If we fail, try to clean up the temporary file
399
# before we throw the exception
400
# but don't let another exception mess things up
401
# Write out the traceback, because otherwise
402
# the catch and throw destroys it
404
mutter(traceback.format_exc())
408
self._sftp.remove(tmp_abspath)
410
# raise the saved except
412
# raise the original with its traceback if we can.
415
def iter_files_recursive(self):
416
"""Walk the relative paths of all files in this transport."""
417
queue = list(self.list_dir('.'))
419
relpath = queue.pop(0)
420
st = self.stat(relpath)
421
if stat.S_ISDIR(st.st_mode):
422
for i, basename in enumerate(self.list_dir(relpath)):
423
queue.insert(i, relpath+'/'+basename)
427
def mkdir(self, relpath, mode=None):
428
"""Create a directory at the given path."""
429
path = self._remote_path(relpath)
431
# In the paramiko documentation, it says that passing a mode flag
432
# will filtered against the server umask.
433
# StubSFTPServer does not do this, which would be nice, because it is
434
# what we really want :)
435
# However, real servers do use umask, so we really should do it that way
436
self._sftp.mkdir(path)
438
self._sftp.chmod(path, mode=mode)
439
except (paramiko.SSHException, IOError), e:
440
self._translate_io_exception(e, path, ': unable to mkdir',
441
failure_exc=FileExists)
443
def _translate_io_exception(self, e, path, more_info='',
444
failure_exc=PathError):
445
"""Translate a paramiko or IOError into a friendlier exception.
447
:param e: The original exception
448
:param path: The path in question when the error is raised
449
:param more_info: Extra information that can be included,
450
such as what was going on
451
:param failure_exc: Paramiko has the super fun ability to raise completely
452
opaque errors that just set "e.args = ('Failure',)" with
454
If this parameter is set, it defines the exception
455
to raise in these cases.
457
# paramiko seems to generate detailless errors.
458
self._translate_error(e, path, raise_generic=False)
459
if hasattr(e, 'args'):
460
if (e.args == ('No such file or directory',) or
461
e.args == ('No such file',)):
462
raise NoSuchFile(path, str(e) + more_info)
463
if (e.args == ('mkdir failed',)):
464
raise FileExists(path, str(e) + more_info)
465
# strange but true, for the paramiko server.
466
if (e.args == ('Failure',)):
467
raise failure_exc(path, str(e) + more_info)
468
mutter('Raising exception with args %s', e.args)
469
if hasattr(e, 'errno'):
470
mutter('Raising exception with errno %s', e.errno)
473
def append(self, relpath, f, mode=None):
475
Append the text in the file-like object into the final
479
path = self._remote_path(relpath)
480
fout = self._sftp.file(path, 'ab')
482
self._sftp.chmod(path, mode)
486
except (IOError, paramiko.SSHException), e:
487
self._translate_io_exception(e, relpath, ': unable to append')
489
def rename(self, rel_from, rel_to):
490
"""Rename without special overwriting"""
492
self._sftp.rename(self._remote_path(rel_from),
493
self._remote_path(rel_to))
494
except (IOError, paramiko.SSHException), e:
495
self._translate_io_exception(e, rel_from,
496
': unable to rename to %r' % (rel_to))
498
def _rename_and_overwrite(self, abs_from, abs_to):
499
"""Do a fancy rename on the remote server.
501
Using the implementation provided by osutils.
504
fancy_rename(abs_from, abs_to,
505
rename_func=self._sftp.rename,
506
unlink_func=self._sftp.remove)
507
except (IOError, paramiko.SSHException), e:
508
self._translate_io_exception(e, abs_from, ': unable to rename to %r' % (abs_to))
510
def move(self, rel_from, rel_to):
511
"""Move the item at rel_from to the location at rel_to"""
512
path_from = self._remote_path(rel_from)
513
path_to = self._remote_path(rel_to)
514
self._rename_and_overwrite(path_from, path_to)
516
def delete(self, relpath):
517
"""Delete the item at relpath"""
518
path = self._remote_path(relpath)
520
self._sftp.remove(path)
521
except (IOError, paramiko.SSHException), e:
522
self._translate_io_exception(e, path, ': unable to delete')
525
"""Return True if this store supports listing."""
528
def list_dir(self, relpath):
530
Return a list of all files at the given location.
532
# does anything actually use this?
534
# This is at least used by copy_tree for remote upgrades.
535
# -- David Allouche 2006-08-11
536
path = self._remote_path(relpath)
538
entries = self._sftp.listdir(path)
539
except (IOError, paramiko.SSHException), e:
540
self._translate_io_exception(e, path, ': failed to list_dir')
541
return [urlutils.escape(entry) for entry in entries]
543
def rmdir(self, relpath):
544
"""See Transport.rmdir."""
545
path = self._remote_path(relpath)
547
return self._sftp.rmdir(path)
548
except (IOError, paramiko.SSHException), e:
549
self._translate_io_exception(e, path, ': failed to rmdir')
551
def stat(self, relpath):
552
"""Return the stat information for a file."""
553
path = self._remote_path(relpath)
555
return self._sftp.stat(path)
556
except (IOError, paramiko.SSHException), e:
557
self._translate_io_exception(e, path, ': unable to stat')
559
def lock_read(self, relpath):
561
Lock the given file for shared (read) access.
562
:return: A lock object, which has an unlock() member function
564
# FIXME: there should be something clever i can do here...
565
class BogusLock(object):
566
def __init__(self, path):
570
return BogusLock(relpath)
572
def lock_write(self, relpath):
574
Lock the given file for exclusive (write) access.
575
WARNING: many transports do not support this, so trying avoid using it
577
:return: A lock object, which has an unlock() member function
579
# This is a little bit bogus, but basically, we create a file
580
# which should not already exist, and if it does, we assume
581
# that there is a lock, and if it doesn't, the we assume
582
# that we have taken the lock.
583
return SFTPLock(relpath, self)
585
def _unparse_url(self, path=None):
588
path = urllib.quote(path)
589
# handle homedir paths
590
if not path.startswith('/'):
592
netloc = urllib.quote(self._host)
593
if self._username is not None:
594
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
595
if self._port is not None:
596
netloc = '%s:%d' % (netloc, self._port)
597
return urlparse.urlunparse(('sftp', netloc, path, '', '', ''))
599
def _split_url(self, url):
600
(scheme, username, password, host, port, path) = split_url(url)
601
assert scheme == 'sftp'
603
# the initial slash should be removed from the path, and treated
604
# as a homedir relative path (the path begins with a double slash
605
# if it is absolute).
606
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
607
# RBC 20060118 we are not using this as its too user hostile. instead
608
# we are following lftp and using /~/foo to mean '~/foo'.
609
# handle homedir paths
610
if path.startswith('/~/'):
614
return (username, password, host, port, path)
616
def _parse_url(self, url):
617
(self._username, self._password,
618
self._host, self._port, self._path) = self._split_url(url)
620
def _sftp_connect(self):
621
"""Connect to the remote sftp server.
622
After this, self._sftp should have a valid connection (or
623
we raise an TransportError 'could not connect').
625
TODO: Raise a more reasonable ConnectionFailed exception
627
self._sftp = _sftp_connect(self._host, self._port, self._username,
630
def _sftp_open_exclusive(self, abspath, mode=None):
631
"""Open a remote path exclusively.
633
SFTP supports O_EXCL (SFTP_FLAG_EXCL), which fails if
634
the file already exists. However it does not expose this
635
at the higher level of SFTPClient.open(), so we have to
638
WARNING: This breaks the SFTPClient abstraction, so it
639
could easily break against an updated version of paramiko.
641
:param abspath: The remote absolute path where the file should be opened
642
:param mode: The mode permissions bits for the new file
644
path = self._sftp._adjust_cwd(abspath)
645
# mutter('sftp abspath %s => %s', abspath, path)
646
attr = SFTPAttributes()
649
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
650
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
652
t, msg = self._sftp._request(CMD_OPEN, path, omode, attr)
654
raise TransportError('Expected an SFTP handle')
655
handle = msg.get_string()
656
return SFTPFile(self._sftp, handle, 'wb', -1)
657
except (paramiko.SSHException, IOError), e:
658
self._translate_io_exception(e, abspath, ': unable to open',
659
failure_exc=FileExists)
662
# ------------- server test implementation --------------
665
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
667
STUB_SERVER_KEY = """
668
-----BEGIN RSA PRIVATE KEY-----
669
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
670
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
671
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
672
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
673
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
674
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
675
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
676
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
677
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
678
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
679
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
680
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
681
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
682
-----END RSA PRIVATE KEY-----
686
class SocketListener(threading.Thread):
688
def __init__(self, callback):
689
threading.Thread.__init__(self)
690
self._callback = callback
691
self._socket = socket.socket()
692
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
693
self._socket.bind(('localhost', 0))
694
self._socket.listen(1)
695
self.port = self._socket.getsockname()[1]
696
self._stop_event = threading.Event()
699
# called from outside this thread
700
self._stop_event.set()
701
# use a timeout here, because if the test fails, the server thread may
702
# never notice the stop_event.
708
readable, writable_unused, exception_unused = \
709
select.select([self._socket], [], [], 0.1)
710
if self._stop_event.isSet():
712
if len(readable) == 0:
715
s, addr_unused = self._socket.accept()
716
# because the loopback socket is inline, and transports are
717
# never explicitly closed, best to launch a new thread.
718
threading.Thread(target=self._callback, args=(s,)).start()
719
except socket.error, x:
720
sys.excepthook(*sys.exc_info())
721
warning('Socket error during accept() within unit test server'
724
# probably a failed test; unit test thread will log the
726
sys.excepthook(*sys.exc_info())
727
warning('Exception from within unit test server thread: %r' %
731
class SocketDelay(object):
732
"""A socket decorator to make TCP appear slower.
734
This changes recv, send, and sendall to add a fixed latency to each python
735
call if a new roundtrip is detected. That is, when a recv is called and the
736
flag new_roundtrip is set, latency is charged. Every send and send_all
739
In addition every send, sendall and recv sleeps a bit per character send to
742
Not all methods are implemented, this is deliberate as this class is not a
743
replacement for the builtin sockets layer. fileno is not implemented to
744
prevent the proxy being bypassed.
748
_proxied_arguments = dict.fromkeys([
749
"close", "getpeername", "getsockname", "getsockopt", "gettimeout",
750
"setblocking", "setsockopt", "settimeout", "shutdown"])
752
def __init__(self, sock, latency, bandwidth=1.0,
755
:param bandwith: simulated bandwith (MegaBit)
756
:param really_sleep: If set to false, the SocketDelay will just
757
increase a counter, instead of calling time.sleep. This is useful for
758
unittesting the SocketDelay.
761
self.latency = latency
762
self.really_sleep = really_sleep
763
self.time_per_byte = 1 / (bandwidth / 8.0 * 1024 * 1024)
764
self.new_roundtrip = False
767
if self.really_sleep:
770
SocketDelay.simulated_time += s
772
def __getattr__(self, attr):
773
if attr in SocketDelay._proxied_arguments:
774
return getattr(self.sock, attr)
775
raise AttributeError("'SocketDelay' object has no attribute %r" %
779
return SocketDelay(self.sock.dup(), self.latency, self.time_per_byte,
782
def recv(self, *args):
783
data = self.sock.recv(*args)
784
if data and self.new_roundtrip:
785
self.new_roundtrip = False
786
self.sleep(self.latency)
787
self.sleep(len(data) * self.time_per_byte)
790
def sendall(self, data, flags=0):
791
if not self.new_roundtrip:
792
self.new_roundtrip = True
793
self.sleep(self.latency)
794
self.sleep(len(data) * self.time_per_byte)
795
return self.sock.sendall(data, flags)
797
def send(self, data, flags=0):
798
if not self.new_roundtrip:
799
self.new_roundtrip = True
800
self.sleep(self.latency)
801
bytes_sent = self.sock.send(data, flags)
802
self.sleep(bytes_sent * self.time_per_byte)
806
class SFTPServer(Server):
807
"""Common code for SFTP server facilities."""
810
self._original_vendor = None
812
self._server_homedir = None
813
self._listener = None
815
self._vendor = ssh.ParamikoVendor()
820
def _get_sftp_url(self, path):
821
"""Calculate an sftp url to this server for path."""
822
return 'sftp://foo:bar@localhost:%d/%s' % (self._listener.port, path)
824
def log(self, message):
825
"""StubServer uses this to log when a new server is created."""
826
self.logs.append(message)
828
def _run_server_entry(self, sock):
829
"""Entry point for all implementations of _run_server.
831
If self.add_latency is > 0.000001 then sock is given a latency adding
834
if self.add_latency > 0.000001:
835
sock = SocketDelay(sock, self.add_latency)
836
return self._run_server(sock)
838
def _run_server(self, s):
839
ssh_server = paramiko.Transport(s)
840
key_file = pathjoin(self._homedir, 'test_rsa.key')
841
f = open(key_file, 'w')
842
f.write(STUB_SERVER_KEY)
844
host_key = paramiko.RSAKey.from_private_key_file(key_file)
845
ssh_server.add_server_key(host_key)
846
server = StubServer(self)
847
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
848
StubSFTPServer, root=self._root,
849
home=self._server_homedir)
850
event = threading.Event()
851
ssh_server.start_server(event, server)
855
self._original_vendor = ssh._ssh_vendor
856
ssh._ssh_vendor = self._vendor
857
if sys.platform == 'win32':
858
# Win32 needs to use the UNICODE api
859
self._homedir = getcwd()
861
# But Linux SFTP servers should just deal in bytestreams
862
self._homedir = os.getcwd()
863
if self._server_homedir is None:
864
self._server_homedir = self._homedir
866
if sys.platform == 'win32':
868
self._listener = SocketListener(self._run_server_entry)
869
self._listener.setDaemon(True)
870
self._listener.start()
873
"""See bzrlib.transport.Server.tearDown."""
874
self._listener.stop()
875
ssh._ssh_vendor = self._original_vendor
877
def get_bogus_url(self):
878
"""See bzrlib.transport.Server.get_bogus_url."""
879
# this is chosen to try to prevent trouble with proxies, wierd dns, etc
880
# we bind a random socket, so that we get a guaranteed unused port
881
# we just never listen on that port
883
s.bind(('localhost', 0))
884
return 'sftp://%s:%s/' % s.getsockname()
887
class SFTPFullAbsoluteServer(SFTPServer):
888
"""A test server for sftp transports, using absolute urls and ssh."""
891
"""See bzrlib.transport.Server.get_url."""
892
return self._get_sftp_url(urlutils.escape(self._homedir[1:]))
895
class SFTPServerWithoutSSH(SFTPServer):
896
"""An SFTP server that uses a simple TCP socket pair rather than SSH."""
899
super(SFTPServerWithoutSSH, self).__init__()
900
self._vendor = ssh.LoopbackVendor()
902
def _run_server(self, sock):
903
# Re-import these as locals, so that they're still accessible during
904
# interpreter shutdown (when all module globals get set to None, leading
905
# to confusing errors like "'NoneType' object has no attribute 'error'".
907
class FakeChannel(object):
908
def get_transport(self):
910
def get_log_channel(self):
914
def get_hexdump(self):
919
server = paramiko.SFTPServer(FakeChannel(), 'sftp', StubServer(self), StubSFTPServer,
920
root=self._root, home=self._server_homedir)
922
server.start_subsystem('sftp', None, sock)
923
except socket.error, e:
924
if (len(e.args) > 0) and (e.args[0] == errno.EPIPE):
925
# it's okay for the client to disconnect abruptly
926
# (bug in paramiko 1.6: it should absorb this exception)
931
import sys; sys.stderr.write('\nEXCEPTION %r\n\n' % e.__class__)
932
server.finish_subsystem()
935
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
936
"""A test server for sftp transports, using absolute urls."""
939
"""See bzrlib.transport.Server.get_url."""
940
if sys.platform == 'win32':
941
return self._get_sftp_url(urlutils.escape(self._homedir))
943
return self._get_sftp_url(urlutils.escape(self._homedir[1:]))
946
class SFTPHomeDirServer(SFTPServerWithoutSSH):
947
"""A test server for sftp transports, using homedir relative urls."""
950
"""See bzrlib.transport.Server.get_url."""
951
return self._get_sftp_url("~/")
954
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
955
"""A test servere for sftp transports, using absolute urls to non-home."""
958
self._server_homedir = '/dev/noone/runs/tests/here'
959
super(SFTPSiblingAbsoluteServer, self).setUp()
962
def _sftp_connect(host, port, username, password):
963
"""Connect to the remote sftp server.
965
:raises: a TransportError 'could not connect'.
967
:returns: an paramiko.sftp_client.SFTPClient
969
TODO: Raise a more reasonable ConnectionFailed exception
971
idx = (host, port, username)
973
return _connected_hosts[idx]
977
sftp = _sftp_connect_uncached(host, port, username, password)
978
_connected_hosts[idx] = sftp
981
def _sftp_connect_uncached(host, port, username, password):
982
vendor = ssh._get_ssh_vendor()
983
sftp = vendor.connect_sftp(username, password, host, port)
987
def get_test_permutations():
988
"""Return the permutations to be used in testing."""
989
return [(SFTPTransport, SFTPAbsoluteServer),
990
(SFTPTransport, SFTPHomeDirServer),
991
(SFTPTransport, SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
