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_file(self, relpath, f, mode=None):
371
Copy the file-like object into the location.
373
:param relpath: Location to put the contents, relative to base.
374
:param f: File-like 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)
392
# XXX: This doesn't truly help like we would like it to.
393
# The problem is that openssh strips sticky bits. So while we
394
# can properly set group write permission, we lose the group
395
# sticky bit. So it is probably best to stop chmodding, and
396
# just tell users that they need to set the umask correctly.
397
# The attr.st_mode = mode, in _sftp_open_exclusive
398
# will handle when the user wants the final mode to be more
399
# restrictive. And then we avoid a round trip. Unless
400
# paramiko decides to expose an async chmod()
402
# This is designed to chmod() right before we close.
403
# Because we set_pipelined() earlier, theoretically we might
404
# avoid the round trip for fout.close()
406
self._sftp.chmod(tmp_abspath, mode)
409
self._rename_and_overwrite(tmp_abspath, abspath)
411
# If we fail, try to clean up the temporary file
412
# before we throw the exception
413
# but don't let another exception mess things up
414
# Write out the traceback, because otherwise
415
# the catch and throw destroys it
417
mutter(traceback.format_exc())
421
self._sftp.remove(tmp_abspath)
423
# raise the saved except
425
# raise the original with its traceback if we can.
428
def _put_non_atomic_helper(self, relpath, writer, mode=None,
429
create_parent_dir=False,
431
abspath = self._remote_path(relpath)
433
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
434
# set the file mode at create time. If it does, use it.
435
# But for now, we just chmod later anyway.
437
def _open_and_write_file():
438
"""Try to open the target file, raise error on failure"""
442
fout = self._sftp.file(abspath, mode='wb')
443
fout.set_pipelined(True)
445
except (paramiko.SSHException, IOError), e:
446
self._translate_io_exception(e, abspath,
449
# This is designed to chmod() right before we close.
450
# Because we set_pipelined() earlier, theoretically we might
451
# avoid the round trip for fout.close()
453
self._sftp.chmod(abspath, mode)
458
if not create_parent_dir:
459
_open_and_write_file()
462
# Try error handling to create the parent directory if we need to
464
_open_and_write_file()
466
# Try to create the parent directory, and then go back to
468
parent_dir = os.path.dirname(abspath)
470
self._sftp.mkdir(parent_dir)
471
if dir_mode is not None:
472
self._sftp.chmod(path, mode=dir_mode)
473
except (paramiko.SSHException, IOError), e:
474
self._translate_io_exception(e, abspath, ': unable to open')
475
_open_and_write_file()
477
def put_file_non_atomic(self, relpath, f, mode=None,
478
create_parent_dir=False,
480
"""Copy the file-like object into the target location.
482
This function is not strictly safe to use. It is only meant to
483
be used when you already know that the target does not exist.
484
It is not safe, because it will open and truncate the remote
485
file. So there may be a time when the file has invalid contents.
487
:param relpath: The remote location to put the contents.
488
:param f: File-like object.
489
:param mode: Possible access permissions for new file.
490
None means do not set remote permissions.
491
:param create_parent_dir: If we cannot create the target file because
492
the parent directory does not exist, go ahead and
493
create it, and then try again.
497
self._put_non_atomic_helper(relpath, writer, mode=mode,
498
create_parent_dir=create_parent_dir,
501
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
502
create_parent_dir=False,
506
self._put_non_atomic_helper(relpath, writer, mode=mode,
507
create_parent_dir=create_parent_dir,
510
def iter_files_recursive(self):
511
"""Walk the relative paths of all files in this transport."""
512
queue = list(self.list_dir('.'))
514
relpath = queue.pop(0)
515
st = self.stat(relpath)
516
if stat.S_ISDIR(st.st_mode):
517
for i, basename in enumerate(self.list_dir(relpath)):
518
queue.insert(i, relpath+'/'+basename)
522
def mkdir(self, relpath, mode=None):
523
"""Create a directory at the given path."""
524
path = self._remote_path(relpath)
526
self._sftp.mkdir(path)
528
self._sftp.chmod(path, mode=mode)
529
except (paramiko.SSHException, IOError), e:
530
self._translate_io_exception(e, path, ': unable to mkdir',
531
failure_exc=FileExists)
533
def _translate_io_exception(self, e, path, more_info='',
534
failure_exc=PathError):
535
"""Translate a paramiko or IOError into a friendlier exception.
537
:param e: The original exception
538
:param path: The path in question when the error is raised
539
:param more_info: Extra information that can be included,
540
such as what was going on
541
:param failure_exc: Paramiko has the super fun ability to raise completely
542
opaque errors that just set "e.args = ('Failure',)" with
544
If this parameter is set, it defines the exception
545
to raise in these cases.
547
# paramiko seems to generate detailless errors.
548
self._translate_error(e, path, raise_generic=False)
549
if hasattr(e, 'args'):
550
if (e.args == ('No such file or directory',) or
551
e.args == ('No such file',)):
552
raise NoSuchFile(path, str(e) + more_info)
553
if (e.args == ('mkdir failed',)):
554
raise FileExists(path, str(e) + more_info)
555
# strange but true, for the paramiko server.
556
if (e.args == ('Failure',)):
557
raise failure_exc(path, str(e) + more_info)
558
mutter('Raising exception with args %s', e.args)
559
if hasattr(e, 'errno'):
560
mutter('Raising exception with errno %s', e.errno)
563
def append_file(self, relpath, f, mode=None):
565
Append the text in the file-like object into the final
569
path = self._remote_path(relpath)
570
fout = self._sftp.file(path, 'ab')
572
self._sftp.chmod(path, mode)
576
except (IOError, paramiko.SSHException), e:
577
self._translate_io_exception(e, relpath, ': unable to append')
579
def rename(self, rel_from, rel_to):
580
"""Rename without special overwriting"""
582
self._sftp.rename(self._remote_path(rel_from),
583
self._remote_path(rel_to))
584
except (IOError, paramiko.SSHException), e:
585
self._translate_io_exception(e, rel_from,
586
': unable to rename to %r' % (rel_to))
588
def _rename_and_overwrite(self, abs_from, abs_to):
589
"""Do a fancy rename on the remote server.
591
Using the implementation provided by osutils.
594
fancy_rename(abs_from, abs_to,
595
rename_func=self._sftp.rename,
596
unlink_func=self._sftp.remove)
597
except (IOError, paramiko.SSHException), e:
598
self._translate_io_exception(e, abs_from, ': unable to rename to %r' % (abs_to))
600
def move(self, rel_from, rel_to):
601
"""Move the item at rel_from to the location at rel_to"""
602
path_from = self._remote_path(rel_from)
603
path_to = self._remote_path(rel_to)
604
self._rename_and_overwrite(path_from, path_to)
606
def delete(self, relpath):
607
"""Delete the item at relpath"""
608
path = self._remote_path(relpath)
610
self._sftp.remove(path)
611
except (IOError, paramiko.SSHException), e:
612
self._translate_io_exception(e, path, ': unable to delete')
615
"""Return True if this store supports listing."""
618
def list_dir(self, relpath):
620
Return a list of all files at the given location.
622
# does anything actually use this?
624
# This is at least used by copy_tree for remote upgrades.
625
# -- David Allouche 2006-08-11
626
path = self._remote_path(relpath)
628
entries = self._sftp.listdir(path)
629
except (IOError, paramiko.SSHException), e:
630
self._translate_io_exception(e, path, ': failed to list_dir')
631
return [urlutils.escape(entry) for entry in entries]
633
def rmdir(self, relpath):
634
"""See Transport.rmdir."""
635
path = self._remote_path(relpath)
637
return self._sftp.rmdir(path)
638
except (IOError, paramiko.SSHException), e:
639
self._translate_io_exception(e, path, ': failed to rmdir')
641
def stat(self, relpath):
642
"""Return the stat information for a file."""
643
path = self._remote_path(relpath)
645
return self._sftp.stat(path)
646
except (IOError, paramiko.SSHException), e:
647
self._translate_io_exception(e, path, ': unable to stat')
649
def lock_read(self, relpath):
651
Lock the given file for shared (read) access.
652
:return: A lock object, which has an unlock() member function
654
# FIXME: there should be something clever i can do here...
655
class BogusLock(object):
656
def __init__(self, path):
660
return BogusLock(relpath)
662
def lock_write(self, relpath):
664
Lock the given file for exclusive (write) access.
665
WARNING: many transports do not support this, so trying avoid using it
667
:return: A lock object, which has an unlock() member function
669
# This is a little bit bogus, but basically, we create a file
670
# which should not already exist, and if it does, we assume
671
# that there is a lock, and if it doesn't, the we assume
672
# that we have taken the lock.
673
return SFTPLock(relpath, self)
675
def _unparse_url(self, path=None):
678
path = urllib.quote(path)
679
# handle homedir paths
680
if not path.startswith('/'):
682
netloc = urllib.quote(self._host)
683
if self._username is not None:
684
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
685
if self._port is not None:
686
netloc = '%s:%d' % (netloc, self._port)
687
return urlparse.urlunparse(('sftp', netloc, path, '', '', ''))
689
def _split_url(self, url):
690
(scheme, username, password, host, port, path) = split_url(url)
691
assert scheme == 'sftp'
693
# the initial slash should be removed from the path, and treated
694
# as a homedir relative path (the path begins with a double slash
695
# if it is absolute).
696
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
697
# RBC 20060118 we are not using this as its too user hostile. instead
698
# we are following lftp and using /~/foo to mean '~/foo'.
699
# handle homedir paths
700
if path.startswith('/~/'):
704
return (username, password, host, port, path)
706
def _parse_url(self, url):
707
(self._username, self._password,
708
self._host, self._port, self._path) = self._split_url(url)
710
def _sftp_connect(self):
711
"""Connect to the remote sftp server.
712
After this, self._sftp should have a valid connection (or
713
we raise an TransportError 'could not connect').
715
TODO: Raise a more reasonable ConnectionFailed exception
717
self._sftp = _sftp_connect(self._host, self._port, self._username,
720
def _sftp_open_exclusive(self, abspath, mode=None):
721
"""Open a remote path exclusively.
723
SFTP supports O_EXCL (SFTP_FLAG_EXCL), which fails if
724
the file already exists. However it does not expose this
725
at the higher level of SFTPClient.open(), so we have to
728
WARNING: This breaks the SFTPClient abstraction, so it
729
could easily break against an updated version of paramiko.
731
:param abspath: The remote absolute path where the file should be opened
732
:param mode: The mode permissions bits for the new file
734
# TODO: jam 20060816 Paramiko >= 1.6.2 (probably earlier) supports
735
# using the 'x' flag to indicate SFTP_FLAG_EXCL.
736
# However, there is no way to set the permission mode at open
737
# time using the sftp_client.file() functionality.
738
path = self._sftp._adjust_cwd(abspath)
739
# mutter('sftp abspath %s => %s', abspath, path)
740
attr = SFTPAttributes()
743
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
744
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
746
t, msg = self._sftp._request(CMD_OPEN, path, omode, attr)
748
raise TransportError('Expected an SFTP handle')
749
handle = msg.get_string()
750
return SFTPFile(self._sftp, handle, 'wb', -1)
751
except (paramiko.SSHException, IOError), e:
752
self._translate_io_exception(e, abspath, ': unable to open',
753
failure_exc=FileExists)
756
# ------------- server test implementation --------------
759
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
761
STUB_SERVER_KEY = """
762
-----BEGIN RSA PRIVATE KEY-----
763
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
764
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
765
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
766
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
767
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
768
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
769
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
770
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
771
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
772
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
773
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
774
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
775
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
776
-----END RSA PRIVATE KEY-----
780
class SocketListener(threading.Thread):
782
def __init__(self, callback):
783
threading.Thread.__init__(self)
784
self._callback = callback
785
self._socket = socket.socket()
786
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
787
self._socket.bind(('localhost', 0))
788
self._socket.listen(1)
789
self.port = self._socket.getsockname()[1]
790
self._stop_event = threading.Event()
793
# called from outside this thread
794
self._stop_event.set()
795
# use a timeout here, because if the test fails, the server thread may
796
# never notice the stop_event.
802
readable, writable_unused, exception_unused = \
803
select.select([self._socket], [], [], 0.1)
804
if self._stop_event.isSet():
806
if len(readable) == 0:
809
s, addr_unused = self._socket.accept()
810
# because the loopback socket is inline, and transports are
811
# never explicitly closed, best to launch a new thread.
812
threading.Thread(target=self._callback, args=(s,)).start()
813
except socket.error, x:
814
sys.excepthook(*sys.exc_info())
815
warning('Socket error during accept() within unit test server'
818
# probably a failed test; unit test thread will log the
820
sys.excepthook(*sys.exc_info())
821
warning('Exception from within unit test server thread: %r' %
825
class SocketDelay(object):
826
"""A socket decorator to make TCP appear slower.
828
This changes recv, send, and sendall to add a fixed latency to each python
829
call if a new roundtrip is detected. That is, when a recv is called and the
830
flag new_roundtrip is set, latency is charged. Every send and send_all
833
In addition every send, sendall and recv sleeps a bit per character send to
836
Not all methods are implemented, this is deliberate as this class is not a
837
replacement for the builtin sockets layer. fileno is not implemented to
838
prevent the proxy being bypassed.
842
_proxied_arguments = dict.fromkeys([
843
"close", "getpeername", "getsockname", "getsockopt", "gettimeout",
844
"setblocking", "setsockopt", "settimeout", "shutdown"])
846
def __init__(self, sock, latency, bandwidth=1.0,
849
:param bandwith: simulated bandwith (MegaBit)
850
:param really_sleep: If set to false, the SocketDelay will just
851
increase a counter, instead of calling time.sleep. This is useful for
852
unittesting the SocketDelay.
855
self.latency = latency
856
self.really_sleep = really_sleep
857
self.time_per_byte = 1 / (bandwidth / 8.0 * 1024 * 1024)
858
self.new_roundtrip = False
861
if self.really_sleep:
864
SocketDelay.simulated_time += s
866
def __getattr__(self, attr):
867
if attr in SocketDelay._proxied_arguments:
868
return getattr(self.sock, attr)
869
raise AttributeError("'SocketDelay' object has no attribute %r" %
873
return SocketDelay(self.sock.dup(), self.latency, self.time_per_byte,
876
def recv(self, *args):
877
data = self.sock.recv(*args)
878
if data and self.new_roundtrip:
879
self.new_roundtrip = False
880
self.sleep(self.latency)
881
self.sleep(len(data) * self.time_per_byte)
884
def sendall(self, data, flags=0):
885
if not self.new_roundtrip:
886
self.new_roundtrip = True
887
self.sleep(self.latency)
888
self.sleep(len(data) * self.time_per_byte)
889
return self.sock.sendall(data, flags)
891
def send(self, data, flags=0):
892
if not self.new_roundtrip:
893
self.new_roundtrip = True
894
self.sleep(self.latency)
895
bytes_sent = self.sock.send(data, flags)
896
self.sleep(bytes_sent * self.time_per_byte)
900
class SFTPServer(Server):
901
"""Common code for SFTP server facilities."""
904
self._original_vendor = None
906
self._server_homedir = None
907
self._listener = None
909
self._vendor = ssh.ParamikoVendor()
914
def _get_sftp_url(self, path):
915
"""Calculate an sftp url to this server for path."""
916
return 'sftp://foo:bar@localhost:%d/%s' % (self._listener.port, path)
918
def log(self, message):
919
"""StubServer uses this to log when a new server is created."""
920
self.logs.append(message)
922
def _run_server_entry(self, sock):
923
"""Entry point for all implementations of _run_server.
925
If self.add_latency is > 0.000001 then sock is given a latency adding
928
if self.add_latency > 0.000001:
929
sock = SocketDelay(sock, self.add_latency)
930
return self._run_server(sock)
932
def _run_server(self, s):
933
ssh_server = paramiko.Transport(s)
934
key_file = pathjoin(self._homedir, 'test_rsa.key')
935
f = open(key_file, 'w')
936
f.write(STUB_SERVER_KEY)
938
host_key = paramiko.RSAKey.from_private_key_file(key_file)
939
ssh_server.add_server_key(host_key)
940
server = StubServer(self)
941
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
942
StubSFTPServer, root=self._root,
943
home=self._server_homedir)
944
event = threading.Event()
945
ssh_server.start_server(event, server)
949
self._original_vendor = ssh._ssh_vendor
950
ssh._ssh_vendor = self._vendor
951
if sys.platform == 'win32':
952
# Win32 needs to use the UNICODE api
953
self._homedir = getcwd()
955
# But Linux SFTP servers should just deal in bytestreams
956
self._homedir = os.getcwd()
957
if self._server_homedir is None:
958
self._server_homedir = self._homedir
960
if sys.platform == 'win32':
962
self._listener = SocketListener(self._run_server_entry)
963
self._listener.setDaemon(True)
964
self._listener.start()
967
"""See bzrlib.transport.Server.tearDown."""
968
self._listener.stop()
969
ssh._ssh_vendor = self._original_vendor
971
def get_bogus_url(self):
972
"""See bzrlib.transport.Server.get_bogus_url."""
973
# this is chosen to try to prevent trouble with proxies, wierd dns, etc
974
# we bind a random socket, so that we get a guaranteed unused port
975
# we just never listen on that port
977
s.bind(('localhost', 0))
978
return 'sftp://%s:%s/' % s.getsockname()
981
class SFTPFullAbsoluteServer(SFTPServer):
982
"""A test server for sftp transports, using absolute urls and ssh."""
985
"""See bzrlib.transport.Server.get_url."""
986
return self._get_sftp_url(urlutils.escape(self._homedir[1:]))
989
class SFTPServerWithoutSSH(SFTPServer):
990
"""An SFTP server that uses a simple TCP socket pair rather than SSH."""
993
super(SFTPServerWithoutSSH, self).__init__()
994
self._vendor = ssh.LoopbackVendor()
996
def _run_server(self, sock):
997
# Re-import these as locals, so that they're still accessible during
998
# interpreter shutdown (when all module globals get set to None, leading
999
# to confusing errors like "'NoneType' object has no attribute 'error'".
1000
import socket, errno
1001
class FakeChannel(object):
1002
def get_transport(self):
1004
def get_log_channel(self):
1008
def get_hexdump(self):
1013
server = paramiko.SFTPServer(FakeChannel(), 'sftp', StubServer(self), StubSFTPServer,
1014
root=self._root, home=self._server_homedir)
1016
server.start_subsystem('sftp', None, sock)
1017
except socket.error, e:
1018
if (len(e.args) > 0) and (e.args[0] == errno.EPIPE):
1019
# it's okay for the client to disconnect abruptly
1020
# (bug in paramiko 1.6: it should absorb this exception)
1024
except Exception, e:
1025
import sys; sys.stderr.write('\nEXCEPTION %r\n\n' % e.__class__)
1026
server.finish_subsystem()
1029
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
1030
"""A test server for sftp transports, using absolute urls."""
1033
"""See bzrlib.transport.Server.get_url."""
1034
if sys.platform == 'win32':
1035
return self._get_sftp_url(urlutils.escape(self._homedir))
1037
return self._get_sftp_url(urlutils.escape(self._homedir[1:]))
1040
class SFTPHomeDirServer(SFTPServerWithoutSSH):
1041
"""A test server for sftp transports, using homedir relative urls."""
1044
"""See bzrlib.transport.Server.get_url."""
1045
return self._get_sftp_url("~/")
1048
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
1049
"""A test servere for sftp transports, using absolute urls to non-home."""
1052
self._server_homedir = '/dev/noone/runs/tests/here'
1053
super(SFTPSiblingAbsoluteServer, self).setUp()
1056
def _sftp_connect(host, port, username, password):
1057
"""Connect to the remote sftp server.
1059
:raises: a TransportError 'could not connect'.
1061
:returns: an paramiko.sftp_client.SFTPClient
1063
TODO: Raise a more reasonable ConnectionFailed exception
1065
idx = (host, port, username)
1067
return _connected_hosts[idx]
1071
sftp = _sftp_connect_uncached(host, port, username, password)
1072
_connected_hosts[idx] = sftp
1075
def _sftp_connect_uncached(host, port, username, password):
1076
vendor = ssh._get_ssh_vendor()
1077
sftp = vendor.connect_sftp(username, password, host, port)
1081
def get_test_permutations():
1082
"""Return the permutations to be used in testing."""
1083
return [(SFTPTransport, SFTPAbsoluteServer),
1084
(SFTPTransport, SFTPHomeDirServer),
1085
(SFTPTransport, SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
