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):
430
abspath = self._remote_path(relpath)
432
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
433
# set the file mode at create time. If it does, use it.
434
# But for now, we just chmod later anyway.
436
def _open_and_write_file():
437
"""Try to open the target file, raise error on failure"""
441
fout = self._sftp.file(abspath, mode='wb')
442
fout.set_pipelined(True)
444
except (paramiko.SSHException, IOError), e:
445
self._translate_io_exception(e, abspath,
448
# This is designed to chmod() right before we close.
449
# Because we set_pipelined() earlier, theoretically we might
450
# avoid the round trip for fout.close()
452
self._sftp.chmod(abspath, mode)
457
if not create_parent_dir:
458
_open_and_write_file()
461
# Try error handling to create the parent directory if we need to
463
_open_and_write_file()
465
# Try to create the parent directory, and then go back to
467
parent_dir = os.path.dirname(abspath)
469
self._sftp.mkdir(parent_dir)
470
except (paramiko.SSHException, IOError), e:
471
self._translate_io_exception(e, abspath, ': unable to open')
472
_open_and_write_file()
474
def put_file_non_atomic(self, relpath, f, mode=None,
475
create_parent_dir=False):
476
"""Copy the file-like object into the target location.
478
This function is not strictly safe to use. It is only meant to
479
be used when you already know that the target does not exist.
480
It is not safe, because it will open and truncate the remote
481
file. So there may be a time when the file has invalid contents.
483
:param relpath: The remote location to put the contents.
484
:param f: File-like object.
485
:param mode: Possible access permissions for new file.
486
None means do not set remote permissions.
487
:param create_parent_dir: If we cannot create the target file because
488
the parent directory does not exist, go ahead and
489
create it, and then try again.
493
self._put_non_atomic_helper(relpath, writer, mode=mode,
494
create_parent_dir=create_parent_dir)
496
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
497
create_parent_dir=False):
500
self._put_non_atomic_helper(relpath, writer, mode=mode,
501
create_parent_dir=create_parent_dir)
503
def iter_files_recursive(self):
504
"""Walk the relative paths of all files in this transport."""
505
queue = list(self.list_dir('.'))
507
relpath = queue.pop(0)
508
st = self.stat(relpath)
509
if stat.S_ISDIR(st.st_mode):
510
for i, basename in enumerate(self.list_dir(relpath)):
511
queue.insert(i, relpath+'/'+basename)
515
def mkdir(self, relpath, mode=None):
516
"""Create a directory at the given path."""
517
path = self._remote_path(relpath)
519
self._sftp.mkdir(path)
521
self._sftp.chmod(path, mode=mode)
522
except (paramiko.SSHException, IOError), e:
523
self._translate_io_exception(e, path, ': unable to mkdir',
524
failure_exc=FileExists)
526
def _translate_io_exception(self, e, path, more_info='',
527
failure_exc=PathError):
528
"""Translate a paramiko or IOError into a friendlier exception.
530
:param e: The original exception
531
:param path: The path in question when the error is raised
532
:param more_info: Extra information that can be included,
533
such as what was going on
534
:param failure_exc: Paramiko has the super fun ability to raise completely
535
opaque errors that just set "e.args = ('Failure',)" with
537
If this parameter is set, it defines the exception
538
to raise in these cases.
540
# paramiko seems to generate detailless errors.
541
self._translate_error(e, path, raise_generic=False)
542
if hasattr(e, 'args'):
543
if (e.args == ('No such file or directory',) or
544
e.args == ('No such file',)):
545
raise NoSuchFile(path, str(e) + more_info)
546
if (e.args == ('mkdir failed',)):
547
raise FileExists(path, str(e) + more_info)
548
# strange but true, for the paramiko server.
549
if (e.args == ('Failure',)):
550
raise failure_exc(path, str(e) + more_info)
551
mutter('Raising exception with args %s', e.args)
552
if hasattr(e, 'errno'):
553
mutter('Raising exception with errno %s', e.errno)
556
def append_file(self, relpath, f, mode=None):
558
Append the text in the file-like object into the final
562
path = self._remote_path(relpath)
563
fout = self._sftp.file(path, 'ab')
565
self._sftp.chmod(path, mode)
569
except (IOError, paramiko.SSHException), e:
570
self._translate_io_exception(e, relpath, ': unable to append')
572
def rename(self, rel_from, rel_to):
573
"""Rename without special overwriting"""
575
self._sftp.rename(self._remote_path(rel_from),
576
self._remote_path(rel_to))
577
except (IOError, paramiko.SSHException), e:
578
self._translate_io_exception(e, rel_from,
579
': unable to rename to %r' % (rel_to))
581
def _rename_and_overwrite(self, abs_from, abs_to):
582
"""Do a fancy rename on the remote server.
584
Using the implementation provided by osutils.
587
fancy_rename(abs_from, abs_to,
588
rename_func=self._sftp.rename,
589
unlink_func=self._sftp.remove)
590
except (IOError, paramiko.SSHException), e:
591
self._translate_io_exception(e, abs_from, ': unable to rename to %r' % (abs_to))
593
def move(self, rel_from, rel_to):
594
"""Move the item at rel_from to the location at rel_to"""
595
path_from = self._remote_path(rel_from)
596
path_to = self._remote_path(rel_to)
597
self._rename_and_overwrite(path_from, path_to)
599
def delete(self, relpath):
600
"""Delete the item at relpath"""
601
path = self._remote_path(relpath)
603
self._sftp.remove(path)
604
except (IOError, paramiko.SSHException), e:
605
self._translate_io_exception(e, path, ': unable to delete')
608
"""Return True if this store supports listing."""
611
def list_dir(self, relpath):
613
Return a list of all files at the given location.
615
# does anything actually use this?
617
# This is at least used by copy_tree for remote upgrades.
618
# -- David Allouche 2006-08-11
619
path = self._remote_path(relpath)
621
entries = self._sftp.listdir(path)
622
except (IOError, paramiko.SSHException), e:
623
self._translate_io_exception(e, path, ': failed to list_dir')
624
return [urlutils.escape(entry) for entry in entries]
626
def rmdir(self, relpath):
627
"""See Transport.rmdir."""
628
path = self._remote_path(relpath)
630
return self._sftp.rmdir(path)
631
except (IOError, paramiko.SSHException), e:
632
self._translate_io_exception(e, path, ': failed to rmdir')
634
def stat(self, relpath):
635
"""Return the stat information for a file."""
636
path = self._remote_path(relpath)
638
return self._sftp.stat(path)
639
except (IOError, paramiko.SSHException), e:
640
self._translate_io_exception(e, path, ': unable to stat')
642
def lock_read(self, relpath):
644
Lock the given file for shared (read) access.
645
:return: A lock object, which has an unlock() member function
647
# FIXME: there should be something clever i can do here...
648
class BogusLock(object):
649
def __init__(self, path):
653
return BogusLock(relpath)
655
def lock_write(self, relpath):
657
Lock the given file for exclusive (write) access.
658
WARNING: many transports do not support this, so trying avoid using it
660
:return: A lock object, which has an unlock() member function
662
# This is a little bit bogus, but basically, we create a file
663
# which should not already exist, and if it does, we assume
664
# that there is a lock, and if it doesn't, the we assume
665
# that we have taken the lock.
666
return SFTPLock(relpath, self)
668
def _unparse_url(self, path=None):
671
path = urllib.quote(path)
672
# handle homedir paths
673
if not path.startswith('/'):
675
netloc = urllib.quote(self._host)
676
if self._username is not None:
677
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
678
if self._port is not None:
679
netloc = '%s:%d' % (netloc, self._port)
680
return urlparse.urlunparse(('sftp', netloc, path, '', '', ''))
682
def _split_url(self, url):
683
(scheme, username, password, host, port, path) = split_url(url)
684
assert scheme == 'sftp'
686
# the initial slash should be removed from the path, and treated
687
# as a homedir relative path (the path begins with a double slash
688
# if it is absolute).
689
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
690
# RBC 20060118 we are not using this as its too user hostile. instead
691
# we are following lftp and using /~/foo to mean '~/foo'.
692
# handle homedir paths
693
if path.startswith('/~/'):
697
return (username, password, host, port, path)
699
def _parse_url(self, url):
700
(self._username, self._password,
701
self._host, self._port, self._path) = self._split_url(url)
703
def _sftp_connect(self):
704
"""Connect to the remote sftp server.
705
After this, self._sftp should have a valid connection (or
706
we raise an TransportError 'could not connect').
708
TODO: Raise a more reasonable ConnectionFailed exception
710
self._sftp = _sftp_connect(self._host, self._port, self._username,
713
def _sftp_open_exclusive(self, abspath, mode=None):
714
"""Open a remote path exclusively.
716
SFTP supports O_EXCL (SFTP_FLAG_EXCL), which fails if
717
the file already exists. However it does not expose this
718
at the higher level of SFTPClient.open(), so we have to
721
WARNING: This breaks the SFTPClient abstraction, so it
722
could easily break against an updated version of paramiko.
724
:param abspath: The remote absolute path where the file should be opened
725
:param mode: The mode permissions bits for the new file
727
# TODO: jam 20060816 Paramiko >= 1.6.2 (probably earlier) supports
728
# using the 'x' flag to indicate SFTP_FLAG_EXCL.
729
# However, there is no way to set the permission mode at open
730
# time using the sftp_client.file() functionality.
731
path = self._sftp._adjust_cwd(abspath)
732
# mutter('sftp abspath %s => %s', abspath, path)
733
attr = SFTPAttributes()
736
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
737
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
739
t, msg = self._sftp._request(CMD_OPEN, path, omode, attr)
741
raise TransportError('Expected an SFTP handle')
742
handle = msg.get_string()
743
return SFTPFile(self._sftp, handle, 'wb', -1)
744
except (paramiko.SSHException, IOError), e:
745
self._translate_io_exception(e, abspath, ': unable to open',
746
failure_exc=FileExists)
749
# ------------- server test implementation --------------
752
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
754
STUB_SERVER_KEY = """
755
-----BEGIN RSA PRIVATE KEY-----
756
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
757
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
758
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
759
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
760
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
761
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
762
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
763
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
764
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
765
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
766
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
767
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
768
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
769
-----END RSA PRIVATE KEY-----
773
class SocketListener(threading.Thread):
775
def __init__(self, callback):
776
threading.Thread.__init__(self)
777
self._callback = callback
778
self._socket = socket.socket()
779
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
780
self._socket.bind(('localhost', 0))
781
self._socket.listen(1)
782
self.port = self._socket.getsockname()[1]
783
self._stop_event = threading.Event()
786
# called from outside this thread
787
self._stop_event.set()
788
# use a timeout here, because if the test fails, the server thread may
789
# never notice the stop_event.
795
readable, writable_unused, exception_unused = \
796
select.select([self._socket], [], [], 0.1)
797
if self._stop_event.isSet():
799
if len(readable) == 0:
802
s, addr_unused = self._socket.accept()
803
# because the loopback socket is inline, and transports are
804
# never explicitly closed, best to launch a new thread.
805
threading.Thread(target=self._callback, args=(s,)).start()
806
except socket.error, x:
807
sys.excepthook(*sys.exc_info())
808
warning('Socket error during accept() within unit test server'
811
# probably a failed test; unit test thread will log the
813
sys.excepthook(*sys.exc_info())
814
warning('Exception from within unit test server thread: %r' %
818
class SocketDelay(object):
819
"""A socket decorator to make TCP appear slower.
821
This changes recv, send, and sendall to add a fixed latency to each python
822
call if a new roundtrip is detected. That is, when a recv is called and the
823
flag new_roundtrip is set, latency is charged. Every send and send_all
826
In addition every send, sendall and recv sleeps a bit per character send to
829
Not all methods are implemented, this is deliberate as this class is not a
830
replacement for the builtin sockets layer. fileno is not implemented to
831
prevent the proxy being bypassed.
835
_proxied_arguments = dict.fromkeys([
836
"close", "getpeername", "getsockname", "getsockopt", "gettimeout",
837
"setblocking", "setsockopt", "settimeout", "shutdown"])
839
def __init__(self, sock, latency, bandwidth=1.0,
842
:param bandwith: simulated bandwith (MegaBit)
843
:param really_sleep: If set to false, the SocketDelay will just
844
increase a counter, instead of calling time.sleep. This is useful for
845
unittesting the SocketDelay.
848
self.latency = latency
849
self.really_sleep = really_sleep
850
self.time_per_byte = 1 / (bandwidth / 8.0 * 1024 * 1024)
851
self.new_roundtrip = False
854
if self.really_sleep:
857
SocketDelay.simulated_time += s
859
def __getattr__(self, attr):
860
if attr in SocketDelay._proxied_arguments:
861
return getattr(self.sock, attr)
862
raise AttributeError("'SocketDelay' object has no attribute %r" %
866
return SocketDelay(self.sock.dup(), self.latency, self.time_per_byte,
869
def recv(self, *args):
870
data = self.sock.recv(*args)
871
if data and self.new_roundtrip:
872
self.new_roundtrip = False
873
self.sleep(self.latency)
874
self.sleep(len(data) * self.time_per_byte)
877
def sendall(self, data, flags=0):
878
if not self.new_roundtrip:
879
self.new_roundtrip = True
880
self.sleep(self.latency)
881
self.sleep(len(data) * self.time_per_byte)
882
return self.sock.sendall(data, flags)
884
def send(self, data, flags=0):
885
if not self.new_roundtrip:
886
self.new_roundtrip = True
887
self.sleep(self.latency)
888
bytes_sent = self.sock.send(data, flags)
889
self.sleep(bytes_sent * self.time_per_byte)
893
class SFTPServer(Server):
894
"""Common code for SFTP server facilities."""
897
self._original_vendor = None
899
self._server_homedir = None
900
self._listener = None
902
self._vendor = ssh.ParamikoVendor()
907
def _get_sftp_url(self, path):
908
"""Calculate an sftp url to this server for path."""
909
return 'sftp://foo:bar@localhost:%d/%s' % (self._listener.port, path)
911
def log(self, message):
912
"""StubServer uses this to log when a new server is created."""
913
self.logs.append(message)
915
def _run_server_entry(self, sock):
916
"""Entry point for all implementations of _run_server.
918
If self.add_latency is > 0.000001 then sock is given a latency adding
921
if self.add_latency > 0.000001:
922
sock = SocketDelay(sock, self.add_latency)
923
return self._run_server(sock)
925
def _run_server(self, s):
926
ssh_server = paramiko.Transport(s)
927
key_file = pathjoin(self._homedir, 'test_rsa.key')
928
f = open(key_file, 'w')
929
f.write(STUB_SERVER_KEY)
931
host_key = paramiko.RSAKey.from_private_key_file(key_file)
932
ssh_server.add_server_key(host_key)
933
server = StubServer(self)
934
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
935
StubSFTPServer, root=self._root,
936
home=self._server_homedir)
937
event = threading.Event()
938
ssh_server.start_server(event, server)
942
self._original_vendor = ssh._ssh_vendor
943
ssh._ssh_vendor = self._vendor
944
if sys.platform == 'win32':
945
# Win32 needs to use the UNICODE api
946
self._homedir = getcwd()
948
# But Linux SFTP servers should just deal in bytestreams
949
self._homedir = os.getcwd()
950
if self._server_homedir is None:
951
self._server_homedir = self._homedir
953
if sys.platform == 'win32':
955
self._listener = SocketListener(self._run_server_entry)
956
self._listener.setDaemon(True)
957
self._listener.start()
960
"""See bzrlib.transport.Server.tearDown."""
961
self._listener.stop()
962
ssh._ssh_vendor = self._original_vendor
964
def get_bogus_url(self):
965
"""See bzrlib.transport.Server.get_bogus_url."""
966
# this is chosen to try to prevent trouble with proxies, wierd dns, etc
967
# we bind a random socket, so that we get a guaranteed unused port
968
# we just never listen on that port
970
s.bind(('localhost', 0))
971
return 'sftp://%s:%s/' % s.getsockname()
974
class SFTPFullAbsoluteServer(SFTPServer):
975
"""A test server for sftp transports, using absolute urls and ssh."""
978
"""See bzrlib.transport.Server.get_url."""
979
return self._get_sftp_url(urlutils.escape(self._homedir[1:]))
982
class SFTPServerWithoutSSH(SFTPServer):
983
"""An SFTP server that uses a simple TCP socket pair rather than SSH."""
986
super(SFTPServerWithoutSSH, self).__init__()
987
self._vendor = ssh.LoopbackVendor()
989
def _run_server(self, sock):
990
# Re-import these as locals, so that they're still accessible during
991
# interpreter shutdown (when all module globals get set to None, leading
992
# to confusing errors like "'NoneType' object has no attribute 'error'".
994
class FakeChannel(object):
995
def get_transport(self):
997
def get_log_channel(self):
1001
def get_hexdump(self):
1006
server = paramiko.SFTPServer(FakeChannel(), 'sftp', StubServer(self), StubSFTPServer,
1007
root=self._root, home=self._server_homedir)
1009
server.start_subsystem('sftp', None, sock)
1010
except socket.error, e:
1011
if (len(e.args) > 0) and (e.args[0] == errno.EPIPE):
1012
# it's okay for the client to disconnect abruptly
1013
# (bug in paramiko 1.6: it should absorb this exception)
1017
except Exception, e:
1018
import sys; sys.stderr.write('\nEXCEPTION %r\n\n' % e.__class__)
1019
server.finish_subsystem()
1022
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
1023
"""A test server for sftp transports, using absolute urls."""
1026
"""See bzrlib.transport.Server.get_url."""
1027
if sys.platform == 'win32':
1028
return self._get_sftp_url(urlutils.escape(self._homedir))
1030
return self._get_sftp_url(urlutils.escape(self._homedir[1:]))
1033
class SFTPHomeDirServer(SFTPServerWithoutSSH):
1034
"""A test server for sftp transports, using homedir relative urls."""
1037
"""See bzrlib.transport.Server.get_url."""
1038
return self._get_sftp_url("~/")
1041
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
1042
"""A test servere for sftp transports, using absolute urls to non-home."""
1045
self._server_homedir = '/dev/noone/runs/tests/here'
1046
super(SFTPSiblingAbsoluteServer, self).setUp()
1049
def _sftp_connect(host, port, username, password):
1050
"""Connect to the remote sftp server.
1052
:raises: a TransportError 'could not connect'.
1054
:returns: an paramiko.sftp_client.SFTPClient
1056
TODO: Raise a more reasonable ConnectionFailed exception
1058
idx = (host, port, username)
1060
return _connected_hosts[idx]
1064
sftp = _sftp_connect_uncached(host, port, username, password)
1065
_connected_hosts[idx] = sftp
1068
def _sftp_connect_uncached(host, port, username, password):
1069
vendor = ssh._get_ssh_vendor()
1070
sftp = vendor.connect_sftp(username, password, host, port)
1074
def get_test_permutations():
1075
"""Return the permutations to be used in testing."""
1076
return [(SFTPTransport, SFTPAbsoluteServer),
1077
(SFTPTransport, SFTPHomeDirServer),
1078
(SFTPTransport, SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
