1
# Copyright (C) 2005 Robey Pointer <robey@lag.net>
2
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
"""Implementation of Transport over SFTP, using paramiko."""
20
# TODO: Remove the transport-based lock_read and lock_write methods. They'll
21
# then raise TransportNotPossible, which will break remote access to any
22
# formats which rely on OS-level locks. That should be fine as those formats
23
# are pretty old, but these combinations may have to be removed from the test
24
# suite. Those formats all date back to 0.7; so we should be able to remove
25
# these methods when we officially drop support for those formats.
43
from bzrlib.errors import (FileExists,
44
NoSuchFile, PathNotChild,
50
from bzrlib.osutils import pathjoin, fancy_rename, getcwd
51
from bzrlib.symbol_versioning import (
55
from bzrlib.trace import mutter, warning
56
from bzrlib.transport import (
65
# Disable one particular warning that comes from paramiko in Python2.5; if
66
# this is emitted at the wrong time it tends to cause spurious test failures
67
# or at least noise in the test case::
69
# [1770/7639 in 86s, 1 known failures, 50 skipped, 2 missing features]
70
# test_permissions.TestSftpPermissions.test_new_files
71
# /var/lib/python-support/python2.5/paramiko/message.py:226: DeprecationWarning: integer argument expected, got float
72
# self.packet.write(struct.pack('>I', n))
73
warnings.filterwarnings('ignore',
74
'integer argument expected, got float',
75
category=DeprecationWarning,
76
module='paramiko.message')
80
except ImportError, e:
81
raise ParamikoNotPresent(e)
83
from paramiko.sftp import (SFTP_FLAG_WRITE, SFTP_FLAG_CREATE,
84
SFTP_FLAG_EXCL, SFTP_FLAG_TRUNC,
86
from paramiko.sftp_attr import SFTPAttributes
87
from paramiko.sftp_file import SFTPFile
90
_paramiko_version = getattr(paramiko, '__version_info__', (0, 0, 0))
91
# don't use prefetch unless paramiko version >= 1.5.5 (there were bugs earlier)
92
_default_do_prefetch = (_paramiko_version >= (1, 5, 5))
95
@deprecated_function(zero_ninety)
96
def clear_connection_cache():
97
"""Remove all hosts from the SFTP connection cache.
99
Primarily useful for test cases wanting to force garbage collection.
100
We don't have a global connection cache anymore.
103
class SFTPLock(object):
104
"""This fakes a lock in a remote location.
106
A present lock is indicated just by the existence of a file. This
107
doesn't work well on all transports and they are only used in
108
deprecated storage formats.
111
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
113
def __init__(self, path, transport):
114
self.lock_file = None
116
self.lock_path = path + '.write-lock'
117
self.transport = transport
119
# RBC 20060103 FIXME should we be using private methods here ?
120
abspath = transport._remote_path(self.lock_path)
121
self.lock_file = transport._sftp_open_exclusive(abspath)
123
raise LockError('File %r already locked' % (self.path,))
126
"""Should this warn, or actually try to cleanup?"""
128
warning("SFTPLock %r not explicitly unlocked" % (self.path,))
132
if not self.lock_file:
134
self.lock_file.close()
135
self.lock_file = None
137
self.transport.delete(self.lock_path)
138
except (NoSuchFile,):
139
# What specific errors should we catch here?
143
class SFTPTransport(ConnectedTransport):
144
"""Transport implementation for SFTP access."""
146
_do_prefetch = _default_do_prefetch
147
# TODO: jam 20060717 Conceivably these could be configurable, either
148
# by auto-tuning at run-time, or by a configuration (per host??)
149
# but the performance curve is pretty flat, so just going with
150
# reasonable defaults.
151
_max_readv_combine = 200
152
# Having to round trip to the server means waiting for a response,
153
# so it is better to download extra bytes.
154
# 8KiB had good performance for both local and remote network operations
155
_bytes_to_read_before_seek = 8192
157
# The sftp spec says that implementations SHOULD allow reads
158
# to be at least 32K. paramiko.readv() does an async request
159
# for the chunks. So we need to keep it within a single request
160
# size for paramiko <= 1.6.1. paramiko 1.6.2 will probably chop
161
# up the request itself, rather than us having to worry about it
162
_max_request_size = 32768
164
def __init__(self, base, _from_transport=None):
165
super(SFTPTransport, self).__init__(base,
166
_from_transport=_from_transport)
168
def _remote_path(self, relpath):
169
"""Return the path to be passed along the sftp protocol for relpath.
171
:param relpath: is a urlencoded string.
173
relative = urlutils.unescape(relpath).encode('utf-8')
174
remote_path = self._combine_paths(self._path, relative)
175
# the initial slash should be removed from the path, and treated as a
176
# homedir relative path (the path begins with a double slash if it is
177
# absolute). see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
178
# RBC 20060118 we are not using this as its too user hostile. instead
179
# we are following lftp and using /~/foo to mean '~/foo'
180
# vila--20070602 and leave absolute paths begin with a single slash.
181
if remote_path.startswith('/~/'):
182
remote_path = remote_path[3:]
183
elif remote_path == '/~':
187
def _create_connection(self, credentials=None):
188
"""Create a new connection with the provided credentials.
190
:param credentials: The credentials needed to establish the connection.
192
:return: The created connection and its associated credentials.
194
The credentials are only the password as it may have been entered
195
interactively by the user and may be different from the one provided
196
in base url at transport creation time.
198
if credentials is None:
199
password = self._password
201
password = credentials
203
vendor = ssh._get_ssh_vendor()
204
connection = vendor.connect_sftp(self._user, password,
205
self._host, self._port)
206
return connection, password
209
"""Ensures that a connection is established"""
210
connection = self._get_connection()
211
if connection is None:
212
# First connection ever
213
connection, credentials = self._create_connection()
214
self._set_connection(connection, credentials)
217
def has(self, relpath):
219
Does the target location exist?
222
self._get_sftp().stat(self._remote_path(relpath))
227
def get(self, relpath):
229
Get the file at the given relative path.
231
:param relpath: The relative path to the file
234
path = self._remote_path(relpath)
235
f = self._get_sftp().file(path, mode='rb')
236
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
239
except (IOError, paramiko.SSHException), e:
240
self._translate_io_exception(e, path, ': error retrieving',
241
failure_exc=errors.ReadError)
243
def _readv(self, relpath, offsets):
244
"""See Transport.readv()"""
245
# We overload the default readv() because we want to use a file
246
# that does not have prefetch enabled.
247
# Also, if we have a new paramiko, it implements an async readv()
252
path = self._remote_path(relpath)
253
fp = self._get_sftp().file(path, mode='rb')
254
readv = getattr(fp, 'readv', None)
256
return self._sftp_readv(fp, offsets, relpath)
257
mutter('seek and read %s offsets', len(offsets))
258
return self._seek_and_read(fp, offsets, relpath)
259
except (IOError, paramiko.SSHException), e:
260
self._translate_io_exception(e, path, ': error retrieving')
262
def recommended_page_size(self):
263
"""See Transport.recommended_page_size().
265
For SFTP we suggest a large page size to reduce the overhead
266
introduced by latency.
270
def _sftp_readv(self, fp, offsets, relpath='<unknown>'):
271
"""Use the readv() member of fp to do async readv.
273
And then read them using paramiko.readv(). paramiko.readv()
274
does not support ranges > 64K, so it caps the request size, and
275
just reads until it gets all the stuff it wants
277
offsets = list(offsets)
278
sorted_offsets = sorted(offsets)
280
# The algorithm works as follows:
281
# 1) Coalesce nearby reads into a single chunk
282
# This generates a list of combined regions, the total size
283
# and the size of the sub regions. This coalescing step is limited
284
# in the number of nearby chunks to combine, and is allowed to
285
# skip small breaks in the requests. Limiting it makes sure that
286
# we can start yielding some data earlier, and skipping means we
287
# make fewer requests. (Beneficial even when using async)
288
# 2) Break up this combined regions into chunks that are smaller
289
# than 64KiB. Technically the limit is 65536, but we are a
290
# little bit conservative. This is because sftp has a maximum
291
# return chunk size of 64KiB (max size of an unsigned short)
292
# 3) Issue a readv() to paramiko to create an async request for
294
# 4) Read in the data as it comes back, until we've read one
295
# continuous section as determined in step 1
296
# 5) Break up the full sections into hunks for the original requested
297
# offsets. And put them in a cache
298
# 6) Check if the next request is in the cache, and if it is, remove
299
# it from the cache, and yield its data. Continue until no more
300
# entries are in the cache.
301
# 7) loop back to step 4 until all data has been read
303
# TODO: jam 20060725 This could be optimized one step further, by
304
# attempting to yield whatever data we have read, even before
305
# the first coallesced section has been fully processed.
307
# When coalescing for use with readv(), we don't really need to
308
# use any fudge factor, because the requests are made asynchronously
309
coalesced = list(self._coalesce_offsets(sorted_offsets,
310
limit=self._max_readv_combine,
314
for c_offset in coalesced:
315
start = c_offset.start
316
size = c_offset.length
318
# We need to break this up into multiple requests
320
next_size = min(size, self._max_request_size)
321
requests.append((start, next_size))
325
mutter('SFTP.readv() %s offsets => %s coalesced => %s requests',
326
len(offsets), len(coalesced), len(requests))
328
# Queue the current read until we have read the full coalesced section
331
cur_coalesced_stack = iter(coalesced)
332
cur_coalesced = cur_coalesced_stack.next()
334
# Cache the results, but only until they have been fulfilled
336
# turn the list of offsets into a stack
337
offset_stack = iter(offsets)
338
cur_offset_and_size = offset_stack.next()
340
for data in fp.readv(requests):
342
cur_data_len += len(data)
344
if cur_data_len < cur_coalesced.length:
346
if cur_data_len != cur_coalesced.length:
347
raise AssertionError(
348
"Somehow we read too much: %s != %s"
349
% (cur_data_len, cur_coalesced.length))
350
all_data = ''.join(cur_data)
354
for suboffset, subsize in cur_coalesced.ranges:
355
key = (cur_coalesced.start+suboffset, subsize)
356
data_map[key] = all_data[suboffset:suboffset+subsize]
358
# Now that we've read some data, see if we can yield anything back
359
while cur_offset_and_size in data_map:
360
this_data = data_map.pop(cur_offset_and_size)
361
yield cur_offset_and_size[0], this_data
362
cur_offset_and_size = offset_stack.next()
364
# We read a coalesced entry, so mark it as done
366
# Now that we've read all of the data for this coalesced section
368
cur_coalesced = cur_coalesced_stack.next()
370
if cur_coalesced is not None:
371
raise errors.ShortReadvError(relpath, cur_coalesced.start,
372
cur_coalesced.length, len(data))
374
def put_file(self, relpath, f, mode=None):
376
Copy the file-like object into the location.
378
:param relpath: Location to put the contents, relative to base.
379
:param f: File-like object.
380
:param mode: The final mode for the file
382
final_path = self._remote_path(relpath)
383
return self._put(final_path, f, mode=mode)
385
def _put(self, abspath, f, mode=None):
386
"""Helper function so both put() and copy_abspaths can reuse the code"""
387
tmp_abspath = '%s.tmp.%.9f.%d.%d' % (abspath, time.time(),
388
os.getpid(), random.randint(0,0x7FFFFFFF))
389
fout = self._sftp_open_exclusive(tmp_abspath, mode=mode)
393
fout.set_pipelined(True)
394
length = self._pump(f, fout)
395
except (IOError, paramiko.SSHException), e:
396
self._translate_io_exception(e, tmp_abspath)
397
# XXX: This doesn't truly help like we would like it to.
398
# The problem is that openssh strips sticky bits. So while we
399
# can properly set group write permission, we lose the group
400
# sticky bit. So it is probably best to stop chmodding, and
401
# just tell users that they need to set the umask correctly.
402
# The attr.st_mode = mode, in _sftp_open_exclusive
403
# will handle when the user wants the final mode to be more
404
# restrictive. And then we avoid a round trip. Unless
405
# paramiko decides to expose an async chmod()
407
# This is designed to chmod() right before we close.
408
# Because we set_pipelined() earlier, theoretically we might
409
# avoid the round trip for fout.close()
411
self._get_sftp().chmod(tmp_abspath, mode)
414
self._rename_and_overwrite(tmp_abspath, abspath)
417
# If we fail, try to clean up the temporary file
418
# before we throw the exception
419
# but don't let another exception mess things up
420
# Write out the traceback, because otherwise
421
# the catch and throw destroys it
423
mutter(traceback.format_exc())
427
self._get_sftp().remove(tmp_abspath)
429
# raise the saved except
431
# raise the original with its traceback if we can.
434
def _put_non_atomic_helper(self, relpath, writer, mode=None,
435
create_parent_dir=False,
437
abspath = self._remote_path(relpath)
439
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
440
# set the file mode at create time. If it does, use it.
441
# But for now, we just chmod later anyway.
443
def _open_and_write_file():
444
"""Try to open the target file, raise error on failure"""
448
fout = self._get_sftp().file(abspath, mode='wb')
449
fout.set_pipelined(True)
451
except (paramiko.SSHException, IOError), e:
452
self._translate_io_exception(e, abspath,
455
# This is designed to chmod() right before we close.
456
# Because we set_pipelined() earlier, theoretically we might
457
# avoid the round trip for fout.close()
459
self._get_sftp().chmod(abspath, mode)
464
if not create_parent_dir:
465
_open_and_write_file()
468
# Try error handling to create the parent directory if we need to
470
_open_and_write_file()
472
# Try to create the parent directory, and then go back to
474
parent_dir = os.path.dirname(abspath)
475
self._mkdir(parent_dir, dir_mode)
476
_open_and_write_file()
478
def put_file_non_atomic(self, relpath, f, mode=None,
479
create_parent_dir=False,
481
"""Copy the file-like object into the target location.
483
This function is not strictly safe to use. It is only meant to
484
be used when you already know that the target does not exist.
485
It is not safe, because it will open and truncate the remote
486
file. So there may be a time when the file has invalid contents.
488
:param relpath: The remote location to put the contents.
489
:param f: File-like object.
490
:param mode: Possible access permissions for new file.
491
None means do not set remote permissions.
492
:param create_parent_dir: If we cannot create the target file because
493
the parent directory does not exist, go ahead and
494
create it, and then try again.
498
self._put_non_atomic_helper(relpath, writer, mode=mode,
499
create_parent_dir=create_parent_dir,
502
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
503
create_parent_dir=False,
507
self._put_non_atomic_helper(relpath, writer, mode=mode,
508
create_parent_dir=create_parent_dir,
511
def iter_files_recursive(self):
512
"""Walk the relative paths of all files in this transport."""
513
queue = list(self.list_dir('.'))
515
relpath = queue.pop(0)
516
st = self.stat(relpath)
517
if stat.S_ISDIR(st.st_mode):
518
for i, basename in enumerate(self.list_dir(relpath)):
519
queue.insert(i, relpath+'/'+basename)
523
def _mkdir(self, abspath, mode=None):
529
self._get_sftp().mkdir(abspath, local_mode)
531
self._get_sftp().chmod(abspath, mode=mode)
532
except (paramiko.SSHException, IOError), e:
533
self._translate_io_exception(e, abspath, ': unable to mkdir',
534
failure_exc=FileExists)
536
def mkdir(self, relpath, mode=None):
537
"""Create a directory at the given path."""
538
self._mkdir(self._remote_path(relpath), mode=mode)
540
def open_write_stream(self, relpath, mode=None):
541
"""See Transport.open_write_stream."""
542
# initialise the file to zero-length
543
# this is three round trips, but we don't use this
544
# api more than once per write_group at the moment so
545
# it is a tolerable overhead. Better would be to truncate
546
# the file after opening. RBC 20070805
547
self.put_bytes_non_atomic(relpath, "", mode)
548
abspath = self._remote_path(relpath)
549
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
550
# set the file mode at create time. If it does, use it.
551
# But for now, we just chmod later anyway.
554
handle = self._get_sftp().file(abspath, mode='wb')
555
handle.set_pipelined(True)
556
except (paramiko.SSHException, IOError), e:
557
self._translate_io_exception(e, abspath,
559
_file_streams[self.abspath(relpath)] = handle
560
return FileFileStream(self, relpath, handle)
562
def _translate_io_exception(self, e, path, more_info='',
563
failure_exc=PathError):
564
"""Translate a paramiko or IOError into a friendlier exception.
566
:param e: The original exception
567
:param path: The path in question when the error is raised
568
:param more_info: Extra information that can be included,
569
such as what was going on
570
:param failure_exc: Paramiko has the super fun ability to raise completely
571
opaque errors that just set "e.args = ('Failure',)" with
573
If this parameter is set, it defines the exception
574
to raise in these cases.
576
# paramiko seems to generate detailless errors.
577
self._translate_error(e, path, raise_generic=False)
578
if getattr(e, 'args', None) is not None:
579
if (e.args == ('No such file or directory',) or
580
e.args == ('No such file',)):
581
raise NoSuchFile(path, str(e) + more_info)
582
if (e.args == ('mkdir failed',)):
583
raise FileExists(path, str(e) + more_info)
584
# strange but true, for the paramiko server.
585
if (e.args == ('Failure',)):
586
raise failure_exc(path, str(e) + more_info)
587
mutter('Raising exception with args %s', e.args)
588
if getattr(e, 'errno', None) is not None:
589
mutter('Raising exception with errno %s', e.errno)
592
def append_file(self, relpath, f, mode=None):
594
Append the text in the file-like object into the final
598
path = self._remote_path(relpath)
599
fout = self._get_sftp().file(path, 'ab')
601
self._get_sftp().chmod(path, mode)
605
except (IOError, paramiko.SSHException), e:
606
self._translate_io_exception(e, relpath, ': unable to append')
608
def rename(self, rel_from, rel_to):
609
"""Rename without special overwriting"""
611
self._get_sftp().rename(self._remote_path(rel_from),
612
self._remote_path(rel_to))
613
except (IOError, paramiko.SSHException), e:
614
self._translate_io_exception(e, rel_from,
615
': unable to rename to %r' % (rel_to))
617
def _rename_and_overwrite(self, abs_from, abs_to):
618
"""Do a fancy rename on the remote server.
620
Using the implementation provided by osutils.
623
sftp = self._get_sftp()
624
fancy_rename(abs_from, abs_to,
625
rename_func=sftp.rename,
626
unlink_func=sftp.remove)
627
except (IOError, paramiko.SSHException), e:
628
self._translate_io_exception(e, abs_from,
629
': unable to rename to %r' % (abs_to))
631
def move(self, rel_from, rel_to):
632
"""Move the item at rel_from to the location at rel_to"""
633
path_from = self._remote_path(rel_from)
634
path_to = self._remote_path(rel_to)
635
self._rename_and_overwrite(path_from, path_to)
637
def delete(self, relpath):
638
"""Delete the item at relpath"""
639
path = self._remote_path(relpath)
641
self._get_sftp().remove(path)
642
except (IOError, paramiko.SSHException), e:
643
self._translate_io_exception(e, path, ': unable to delete')
645
def external_url(self):
646
"""See bzrlib.transport.Transport.external_url."""
647
# the external path for SFTP is the base
651
"""Return True if this store supports listing."""
654
def list_dir(self, relpath):
656
Return a list of all files at the given location.
658
# does anything actually use this?
660
# This is at least used by copy_tree for remote upgrades.
661
# -- David Allouche 2006-08-11
662
path = self._remote_path(relpath)
664
entries = self._get_sftp().listdir(path)
665
except (IOError, paramiko.SSHException), e:
666
self._translate_io_exception(e, path, ': failed to list_dir')
667
return [urlutils.escape(entry) for entry in entries]
669
def rmdir(self, relpath):
670
"""See Transport.rmdir."""
671
path = self._remote_path(relpath)
673
return self._get_sftp().rmdir(path)
674
except (IOError, paramiko.SSHException), e:
675
self._translate_io_exception(e, path, ': failed to rmdir')
677
def stat(self, relpath):
678
"""Return the stat information for a file."""
679
path = self._remote_path(relpath)
681
return self._get_sftp().stat(path)
682
except (IOError, paramiko.SSHException), e:
683
self._translate_io_exception(e, path, ': unable to stat')
685
def lock_read(self, relpath):
687
Lock the given file for shared (read) access.
688
:return: A lock object, which has an unlock() member function
690
# FIXME: there should be something clever i can do here...
691
class BogusLock(object):
692
def __init__(self, path):
696
return BogusLock(relpath)
698
def lock_write(self, relpath):
700
Lock the given file for exclusive (write) access.
701
WARNING: many transports do not support this, so trying avoid using it
703
:return: A lock object, which has an unlock() member function
705
# This is a little bit bogus, but basically, we create a file
706
# which should not already exist, and if it does, we assume
707
# that there is a lock, and if it doesn't, the we assume
708
# that we have taken the lock.
709
return SFTPLock(relpath, self)
711
def _sftp_open_exclusive(self, abspath, mode=None):
712
"""Open a remote path exclusively.
714
SFTP supports O_EXCL (SFTP_FLAG_EXCL), which fails if
715
the file already exists. However it does not expose this
716
at the higher level of SFTPClient.open(), so we have to
719
WARNING: This breaks the SFTPClient abstraction, so it
720
could easily break against an updated version of paramiko.
722
:param abspath: The remote absolute path where the file should be opened
723
:param mode: The mode permissions bits for the new file
725
# TODO: jam 20060816 Paramiko >= 1.6.2 (probably earlier) supports
726
# using the 'x' flag to indicate SFTP_FLAG_EXCL.
727
# However, there is no way to set the permission mode at open
728
# time using the sftp_client.file() functionality.
729
path = self._get_sftp()._adjust_cwd(abspath)
730
# mutter('sftp abspath %s => %s', abspath, path)
731
attr = SFTPAttributes()
734
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
735
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
737
t, msg = self._get_sftp()._request(CMD_OPEN, path, omode, attr)
739
raise TransportError('Expected an SFTP handle')
740
handle = msg.get_string()
741
return SFTPFile(self._get_sftp(), handle, 'wb', -1)
742
except (paramiko.SSHException, IOError), e:
743
self._translate_io_exception(e, abspath, ': unable to open',
744
failure_exc=FileExists)
746
def _can_roundtrip_unix_modebits(self):
747
if sys.platform == 'win32':
753
# ------------- server test implementation --------------
756
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
758
STUB_SERVER_KEY = """
759
-----BEGIN RSA PRIVATE KEY-----
760
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
761
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
762
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
763
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
764
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
765
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
766
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
767
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
768
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
769
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
770
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
771
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
772
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
773
-----END RSA PRIVATE KEY-----
777
class SocketListener(threading.Thread):
779
def __init__(self, callback):
780
threading.Thread.__init__(self)
781
self._callback = callback
782
self._socket = socket.socket()
783
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
784
self._socket.bind(('localhost', 0))
785
self._socket.listen(1)
786
self.port = self._socket.getsockname()[1]
787
self._stop_event = threading.Event()
790
# called from outside this thread
791
self._stop_event.set()
792
# use a timeout here, because if the test fails, the server thread may
793
# never notice the stop_event.
799
readable, writable_unused, exception_unused = \
800
select.select([self._socket], [], [], 0.1)
801
if self._stop_event.isSet():
803
if len(readable) == 0:
806
s, addr_unused = self._socket.accept()
807
# because the loopback socket is inline, and transports are
808
# never explicitly closed, best to launch a new thread.
809
threading.Thread(target=self._callback, args=(s,)).start()
810
except socket.error, x:
811
sys.excepthook(*sys.exc_info())
812
warning('Socket error during accept() within unit test server'
815
# probably a failed test; unit test thread will log the
817
sys.excepthook(*sys.exc_info())
818
warning('Exception from within unit test server thread: %r' %
822
class SocketDelay(object):
823
"""A socket decorator to make TCP appear slower.
825
This changes recv, send, and sendall to add a fixed latency to each python
826
call if a new roundtrip is detected. That is, when a recv is called and the
827
flag new_roundtrip is set, latency is charged. Every send and send_all
830
In addition every send, sendall and recv sleeps a bit per character send to
833
Not all methods are implemented, this is deliberate as this class is not a
834
replacement for the builtin sockets layer. fileno is not implemented to
835
prevent the proxy being bypassed.
839
_proxied_arguments = dict.fromkeys([
840
"close", "getpeername", "getsockname", "getsockopt", "gettimeout",
841
"setblocking", "setsockopt", "settimeout", "shutdown"])
843
def __init__(self, sock, latency, bandwidth=1.0,
846
:param bandwith: simulated bandwith (MegaBit)
847
:param really_sleep: If set to false, the SocketDelay will just
848
increase a counter, instead of calling time.sleep. This is useful for
849
unittesting the SocketDelay.
852
self.latency = latency
853
self.really_sleep = really_sleep
854
self.time_per_byte = 1 / (bandwidth / 8.0 * 1024 * 1024)
855
self.new_roundtrip = False
858
if self.really_sleep:
861
SocketDelay.simulated_time += s
863
def __getattr__(self, attr):
864
if attr in SocketDelay._proxied_arguments:
865
return getattr(self.sock, attr)
866
raise AttributeError("'SocketDelay' object has no attribute %r" %
870
return SocketDelay(self.sock.dup(), self.latency, self.time_per_byte,
873
def recv(self, *args):
874
data = self.sock.recv(*args)
875
if data and self.new_roundtrip:
876
self.new_roundtrip = False
877
self.sleep(self.latency)
878
self.sleep(len(data) * self.time_per_byte)
881
def sendall(self, data, flags=0):
882
if not self.new_roundtrip:
883
self.new_roundtrip = True
884
self.sleep(self.latency)
885
self.sleep(len(data) * self.time_per_byte)
886
return self.sock.sendall(data, flags)
888
def send(self, data, flags=0):
889
if not self.new_roundtrip:
890
self.new_roundtrip = True
891
self.sleep(self.latency)
892
bytes_sent = self.sock.send(data, flags)
893
self.sleep(bytes_sent * self.time_per_byte)
897
class SFTPServer(Server):
898
"""Common code for SFTP server facilities."""
900
def __init__(self, server_interface=StubServer):
901
self._original_vendor = None
903
self._server_homedir = None
904
self._listener = None
906
self._vendor = ssh.ParamikoVendor()
907
self._server_interface = server_interface
912
def _get_sftp_url(self, path):
913
"""Calculate an sftp url to this server for path."""
914
return 'sftp://foo:bar@localhost:%d/%s' % (self._listener.port, path)
916
def log(self, message):
917
"""StubServer uses this to log when a new server is created."""
918
self.logs.append(message)
920
def _run_server_entry(self, sock):
921
"""Entry point for all implementations of _run_server.
923
If self.add_latency is > 0.000001 then sock is given a latency adding
926
if self.add_latency > 0.000001:
927
sock = SocketDelay(sock, self.add_latency)
928
return self._run_server(sock)
930
def _run_server(self, s):
931
ssh_server = paramiko.Transport(s)
932
key_file = pathjoin(self._homedir, 'test_rsa.key')
933
f = open(key_file, 'w')
934
f.write(STUB_SERVER_KEY)
936
host_key = paramiko.RSAKey.from_private_key_file(key_file)
937
ssh_server.add_server_key(host_key)
938
server = self._server_interface(self)
939
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
940
StubSFTPServer, root=self._root,
941
home=self._server_homedir)
942
event = threading.Event()
943
ssh_server.start_server(event, server)
946
def setUp(self, backing_server=None):
947
# XXX: TODO: make sftpserver back onto backing_server rather than local
949
if not (backing_server is None or
950
isinstance(backing_server, local.LocalURLServer)):
951
raise AssertionError(
952
"backing_server should not be %r, because this can only serve the "
953
"local current working directory." % (backing_server,))
954
self._original_vendor = ssh._ssh_vendor_manager._cached_ssh_vendor
955
ssh._ssh_vendor_manager._cached_ssh_vendor = self._vendor
956
if sys.platform == 'win32':
957
# Win32 needs to use the UNICODE api
958
self._homedir = getcwd()
960
# But Linux SFTP servers should just deal in bytestreams
961
self._homedir = os.getcwd()
962
if self._server_homedir is None:
963
self._server_homedir = self._homedir
965
if sys.platform == 'win32':
967
self._listener = SocketListener(self._run_server_entry)
968
self._listener.setDaemon(True)
969
self._listener.start()
972
"""See bzrlib.transport.Server.tearDown."""
973
self._listener.stop()
974
ssh._ssh_vendor_manager._cached_ssh_vendor = self._original_vendor
976
def get_bogus_url(self):
977
"""See bzrlib.transport.Server.get_bogus_url."""
978
# this is chosen to try to prevent trouble with proxies, wierd dns, etc
979
# we bind a random socket, so that we get a guaranteed unused port
980
# we just never listen on that port
982
s.bind(('localhost', 0))
983
return 'sftp://%s:%s/' % s.getsockname()
986
class SFTPFullAbsoluteServer(SFTPServer):
987
"""A test server for sftp transports, using absolute urls and ssh."""
990
"""See bzrlib.transport.Server.get_url."""
991
homedir = self._homedir
992
if sys.platform != 'win32':
993
# Remove the initial '/' on all platforms but win32
994
homedir = homedir[1:]
995
return self._get_sftp_url(urlutils.escape(homedir))
998
class SFTPServerWithoutSSH(SFTPServer):
999
"""An SFTP server that uses a simple TCP socket pair rather than SSH."""
1002
super(SFTPServerWithoutSSH, self).__init__()
1003
self._vendor = ssh.LoopbackVendor()
1005
def _run_server(self, sock):
1006
# Re-import these as locals, so that they're still accessible during
1007
# interpreter shutdown (when all module globals get set to None, leading
1008
# to confusing errors like "'NoneType' object has no attribute 'error'".
1009
class FakeChannel(object):
1010
def get_transport(self):
1012
def get_log_channel(self):
1016
def get_hexdump(self):
1021
server = paramiko.SFTPServer(
1022
FakeChannel(), 'sftp', StubServer(self), StubSFTPServer,
1023
root=self._root, home=self._server_homedir)
1025
server.start_subsystem(
1026
'sftp', None, ssh.SocketAsChannelAdapter(sock))
1027
except socket.error, e:
1028
if (len(e.args) > 0) and (e.args[0] == errno.EPIPE):
1029
# it's okay for the client to disconnect abruptly
1030
# (bug in paramiko 1.6: it should absorb this exception)
1034
except Exception, e:
1035
# This typically seems to happen during interpreter shutdown, so
1036
# most of the useful ways to report this error are won't work.
1037
# Writing the exception type, and then the text of the exception,
1038
# seems to be the best we can do.
1040
sys.stderr.write('\nEXCEPTION %r: ' % (e.__class__,))
1041
sys.stderr.write('%s\n\n' % (e,))
1042
server.finish_subsystem()
1045
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
1046
"""A test server for sftp transports, using absolute urls."""
1049
"""See bzrlib.transport.Server.get_url."""
1050
homedir = self._homedir
1051
if sys.platform != 'win32':
1052
# Remove the initial '/' on all platforms but win32
1053
homedir = homedir[1:]
1054
return self._get_sftp_url(urlutils.escape(homedir))
1057
class SFTPHomeDirServer(SFTPServerWithoutSSH):
1058
"""A test server for sftp transports, using homedir relative urls."""
1061
"""See bzrlib.transport.Server.get_url."""
1062
return self._get_sftp_url("~/")
1065
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
1066
"""A test server for sftp transports where only absolute paths will work.
1068
It does this by serving from a deeply-nested directory that doesn't exist.
1071
def setUp(self, backing_server=None):
1072
self._server_homedir = '/dev/noone/runs/tests/here'
1073
super(SFTPSiblingAbsoluteServer, self).setUp(backing_server)
1076
def get_test_permutations():
1077
"""Return the permutations to be used in testing."""
1078
return [(SFTPTransport, SFTPAbsoluteServer),
1079
(SFTPTransport, SFTPHomeDirServer),
1080
(SFTPTransport, SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
