1
# Copyright (C) 2005 Robey Pointer <robey@lag.net>
2
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
1
# Copyright (C) 2005 Robey Pointer <robey@lag.net>, Canonical Ltd
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
6
5
# the Free Software Foundation; either version 2 of the License, or
7
6
# (at your option) any later version.
9
8
# This program is distributed in the hope that it will be useful,
10
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
11
# GNU General Public License for more details.
14
13
# You should have received a copy of the GNU General Public License
15
14
# along with this program; if not, write to the Free Software
16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
17
"""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')
27
from bzrlib.errors import (FileExists,
28
TransportNotPossible, NoSuchFile, NonRelativePath,
30
from bzrlib.config import config_dir
31
from bzrlib.trace import mutter, warning, error
32
from bzrlib.transport import Transport, register_transport
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
assert isinstance(transport, SFTPTransport)
116
self.lock_file = None
118
self.lock_path = path + '.write-lock'
119
self.transport = transport
121
# RBC 20060103 FIXME should we be using private methods here ?
122
abspath = transport._remote_path(self.lock_path)
123
self.lock_file = transport._sftp_open_exclusive(abspath)
125
raise LockError('File %r already locked' % (self.path,))
128
"""Should this warn, or actually try to cleanup?"""
130
warning("SFTPLock %r not explicitly unlocked" % (self.path,))
134
if not self.lock_file:
136
self.lock_file.close()
137
self.lock_file = None
139
self.transport.delete(self.lock_path)
140
except (NoSuchFile,):
141
# What specific errors should we catch here?
145
class SFTPTransport(ConnectedTransport):
146
"""Transport implementation for SFTP access."""
148
_do_prefetch = _default_do_prefetch
149
# TODO: jam 20060717 Conceivably these could be configurable, either
150
# by auto-tuning at run-time, or by a configuration (per host??)
151
# but the performance curve is pretty flat, so just going with
152
# reasonable defaults.
153
_max_readv_combine = 200
154
# Having to round trip to the server means waiting for a response,
155
# so it is better to download extra bytes.
156
# 8KiB had good performance for both local and remote network operations
157
_bytes_to_read_before_seek = 8192
159
# The sftp spec says that implementations SHOULD allow reads
160
# to be at least 32K. paramiko.readv() does an async request
161
# for the chunks. So we need to keep it within a single request
162
# size for paramiko <= 1.6.1. paramiko 1.6.2 will probably chop
163
# up the request itself, rather than us having to worry about it
164
_max_request_size = 32768
166
def __init__(self, base, _from_transport=None):
37
error('The SFTP transport requires paramiko.')
46
Load system host keys (probably doesn't work on windows) and any
47
"discovered" keys from previous sessions.
49
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
51
SYSTEM_HOSTKEYS = paramiko.util.load_host_keys(os.path.expanduser('~/.ssh/known_hosts'))
53
mutter('failed to load system host keys: ' + str(e))
54
bzr_hostkey_path = os.path.join(config_dir(), 'ssh_host_keys')
56
BZR_HOSTKEYS = paramiko.util.load_host_keys(bzr_hostkey_path)
58
mutter('failed to load bzr host keys: ' + str(e))
63
Save "discovered" host keys in $(config)/ssh_host_keys/.
65
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
66
bzr_hostkey_path = os.path.join(config_dir(), 'ssh_host_keys')
67
if not os.path.isdir(config_dir()):
68
os.mkdir(config_dir())
70
f = open(bzr_hostkey_path, 'w')
71
f.write('# SSH host keys collected by bzr\n')
72
for hostname, keys in BZR_HOSTKEYS.iteritems():
73
for keytype, key in keys.iteritems():
74
f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
77
mutter('failed to save bzr host keys: ' + str(e))
81
class SFTPTransportError (TransportError):
85
class SFTPTransport (Transport):
87
Transport implementation for SFTP access.
90
_url_matcher = re.compile(r'^sftp://([^:@]*(:[^@]*)?@)?(.*?)(:\d+)?(/.*)?$')
92
def __init__(self, base, clone_from=None):
167
93
assert base.startswith('sftp://')
168
super(SFTPTransport, self).__init__(base,
169
_from_transport=_from_transport)
171
def _remote_path(self, relpath):
172
"""Return the path to be passed along the sftp protocol for relpath.
94
super(SFTPTransport, self).__init__(base)
96
if clone_from is None:
99
# use the same ssh connection, etc
100
self._sftp = clone_from._sftp
101
# super saves 'self.base'
103
def should_cache(self):
105
Return True if the data pulled across should be cached locally.
109
def clone(self, offset=None):
111
Return a new SFTPTransport with root at self.base + offset.
112
We share the same SFTP session between such transports, because it's
113
fairly expensive to set them up.
116
return SFTPTransport(self.base, self)
118
return SFTPTransport(self.abspath(offset), self)
120
def abspath(self, relpath):
122
Return the full url to the given relative path.
174
:param relpath: is a urlencoded string.
176
relative = urlutils.unescape(relpath).encode('utf-8')
177
remote_path = self._combine_paths(self._path, relative)
178
# the initial slash should be removed from the path, and treated as a
179
# homedir relative path (the path begins with a double slash if it is
180
# absolute). see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
181
# RBC 20060118 we are not using this as its too user hostile. instead
182
# we are following lftp and using /~/foo to mean '~/foo'
183
# vila--20070602 and leave absolute paths begin with a single slash.
184
if remote_path.startswith('/~/'):
185
remote_path = remote_path[3:]
186
elif remote_path == '/~':
190
def _create_connection(self, credentials=None):
191
"""Create a new connection with the provided credentials.
193
:param credentials: The credentials needed to establish the connection.
195
:return: The created connection and its associated credentials.
197
The credentials are only the password as it may have been entered
198
interactively by the user and may be different from the one provided
199
in base url at transport creation time.
201
if credentials is None:
202
password = self._password
204
password = credentials
206
vendor = ssh._get_ssh_vendor()
207
connection = vendor.connect_sftp(self._user, password,
208
self._host, self._port)
209
return connection, password
212
"""Ensures that a connection is established"""
213
connection = self._get_connection()
214
if connection is None:
215
# First connection ever
216
connection, credentials = self._create_connection()
217
self._set_connection(connection, credentials)
124
@param relpath: the relative path or path components
125
@type relpath: str or list
127
return self._unparse_url(self._abspath(relpath))
129
def _abspath(self, relpath):
130
"""Return the absolute path segment without the SFTP URL."""
131
# FIXME: share the common code across transports
132
assert isinstance(relpath, basestring)
133
relpath = [urllib.unquote(relpath)]
134
basepath = self._path.split('/')
135
if len(basepath) > 0 and basepath[-1] == '':
136
basepath = basepath[:-1]
140
if len(basepath) == 0:
141
# In most filesystems, a request for the parent
142
# of root, just returns root.
150
path = '/'.join(basepath)
151
if len(path) and path[0] != '/':
155
def relpath(self, abspath):
156
# FIXME: this is identical to HttpTransport -- share it
157
if not abspath.startswith(self.base):
158
raise NonRelativePath('path %r is not under base URL %r'
159
% (abspath, self.base))
161
return abspath[pl:].lstrip('/')
220
163
def has(self, relpath):
222
165
Does the target location exist?
225
self._get_sftp().stat(self._remote_path(relpath))
168
self._sftp.stat(self._abspath(relpath))
230
def get(self, relpath):
173
def get(self, relpath, decode=False):
232
175
Get the file at the given relative path.
234
177
:param relpath: The relative path to the file
237
path = self._remote_path(relpath)
238
f = self._get_sftp().file(path, mode='rb')
239
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
242
except (IOError, paramiko.SSHException), e:
243
self._translate_io_exception(e, path, ': error retrieving',
244
failure_exc=errors.ReadError)
246
def _readv(self, relpath, offsets):
247
"""See Transport.readv()"""
248
# We overload the default readv() because we want to use a file
249
# that does not have prefetch enabled.
250
# Also, if we have a new paramiko, it implements an async readv()
255
path = self._remote_path(relpath)
256
fp = self._get_sftp().file(path, mode='rb')
257
readv = getattr(fp, 'readv', None)
259
return self._sftp_readv(fp, offsets, relpath)
260
mutter('seek and read %s offsets', len(offsets))
261
return self._seek_and_read(fp, offsets, relpath)
262
except (IOError, paramiko.SSHException), e:
263
self._translate_io_exception(e, path, ': error retrieving')
265
def recommended_page_size(self):
266
"""See Transport.recommended_page_size().
268
For SFTP we suggest a large page size to reduce the overhead
269
introduced by latency.
273
def _sftp_readv(self, fp, offsets, relpath='<unknown>'):
274
"""Use the readv() member of fp to do async readv.
276
And then read them using paramiko.readv(). paramiko.readv()
277
does not support ranges > 64K, so it caps the request size, and
278
just reads until it gets all the stuff it wants
280
offsets = list(offsets)
281
sorted_offsets = sorted(offsets)
283
# The algorithm works as follows:
284
# 1) Coalesce nearby reads into a single chunk
285
# This generates a list of combined regions, the total size
286
# and the size of the sub regions. This coalescing step is limited
287
# in the number of nearby chunks to combine, and is allowed to
288
# skip small breaks in the requests. Limiting it makes sure that
289
# we can start yielding some data earlier, and skipping means we
290
# make fewer requests. (Beneficial even when using async)
291
# 2) Break up this combined regions into chunks that are smaller
292
# than 64KiB. Technically the limit is 65536, but we are a
293
# little bit conservative. This is because sftp has a maximum
294
# return chunk size of 64KiB (max size of an unsigned short)
295
# 3) Issue a readv() to paramiko to create an async request for
297
# 4) Read in the data as it comes back, until we've read one
298
# continuous section as determined in step 1
299
# 5) Break up the full sections into hunks for the original requested
300
# offsets. And put them in a cache
301
# 6) Check if the next request is in the cache, and if it is, remove
302
# it from the cache, and yield its data. Continue until no more
303
# entries are in the cache.
304
# 7) loop back to step 4 until all data has been read
306
# TODO: jam 20060725 This could be optimized one step further, by
307
# attempting to yield whatever data we have read, even before
308
# the first coallesced section has been fully processed.
310
# When coalescing for use with readv(), we don't really need to
311
# use any fudge factor, because the requests are made asynchronously
312
coalesced = list(self._coalesce_offsets(sorted_offsets,
313
limit=self._max_readv_combine,
317
for c_offset in coalesced:
318
start = c_offset.start
319
size = c_offset.length
321
# We need to break this up into multiple requests
323
next_size = min(size, self._max_request_size)
324
requests.append((start, next_size))
328
mutter('SFTP.readv() %s offsets => %s coalesced => %s requests',
329
len(offsets), len(coalesced), len(requests))
331
# Queue the current read until we have read the full coalesced section
334
cur_coalesced_stack = iter(coalesced)
335
cur_coalesced = cur_coalesced_stack.next()
337
# Cache the results, but only until they have been fulfilled
339
# turn the list of offsets into a stack
340
offset_stack = iter(offsets)
341
cur_offset_and_size = offset_stack.next()
343
for data in fp.readv(requests):
345
cur_data_len += len(data)
347
if cur_data_len < cur_coalesced.length:
349
assert cur_data_len == cur_coalesced.length, \
350
"Somehow we read too much: %s != %s" % (cur_data_len,
351
cur_coalesced.length)
352
all_data = ''.join(cur_data)
356
for suboffset, subsize in cur_coalesced.ranges:
357
key = (cur_coalesced.start+suboffset, subsize)
358
data_map[key] = all_data[suboffset:suboffset+subsize]
360
# Now that we've read some data, see if we can yield anything back
361
while cur_offset_and_size in data_map:
362
this_data = data_map.pop(cur_offset_and_size)
363
yield cur_offset_and_size[0], this_data
364
cur_offset_and_size = offset_stack.next()
366
# We read a coalesced entry, so mark it as done
368
# Now that we've read all of the data for this coalesced section
370
cur_coalesced = cur_coalesced_stack.next()
372
if cur_coalesced is not None:
373
raise errors.ShortReadvError(relpath, cur_coalesced.start,
374
cur_coalesced.length, len(data))
376
def put_file(self, relpath, f, mode=None):
378
Copy the file-like object into the location.
180
path = self._abspath(relpath)
181
return self._sftp.file(path)
182
except (IOError, paramiko.SSHException), x:
183
raise NoSuchFile('Error retrieving %s: %s' % (path, str(x)), x)
185
def get_partial(self, relpath, start, length=None):
187
Get just part of a file.
189
:param relpath: Path to the file, relative to base
190
:param start: The starting position to read from
191
:param length: The length to read. A length of None indicates
192
read to the end of the file.
193
:return: A file-like object containing at least the specified bytes.
194
Some implementations may return objects which can be read
195
past this length, but this is not guaranteed.
197
f = self.get(relpath)
201
def put(self, relpath, f):
203
Copy the file-like or string object into the location.
380
205
:param relpath: Location to put the contents, relative to base.
381
:param f: File-like object.
382
:param mode: The final mode for the file
206
:param f: File-like or string object.
384
final_path = self._remote_path(relpath)
385
return self._put(final_path, f, mode=mode)
387
def _put(self, abspath, f, mode=None):
388
"""Helper function so both put() and copy_abspaths can reuse the code"""
389
tmp_abspath = '%s.tmp.%.9f.%d.%d' % (abspath, time.time(),
390
os.getpid(), random.randint(0,0x7FFFFFFF))
391
fout = self._sftp_open_exclusive(tmp_abspath, mode=mode)
395
fout.set_pipelined(True)
396
length = self._pump(f, fout)
397
except (IOError, paramiko.SSHException), e:
398
self._translate_io_exception(e, tmp_abspath)
399
# XXX: This doesn't truly help like we would like it to.
400
# The problem is that openssh strips sticky bits. So while we
401
# can properly set group write permission, we lose the group
402
# sticky bit. So it is probably best to stop chmodding, and
403
# just tell users that they need to set the umask correctly.
404
# The attr.st_mode = mode, in _sftp_open_exclusive
405
# will handle when the user wants the final mode to be more
406
# restrictive. And then we avoid a round trip. Unless
407
# paramiko decides to expose an async chmod()
409
# This is designed to chmod() right before we close.
410
# Because we set_pipelined() earlier, theoretically we might
411
# avoid the round trip for fout.close()
413
self._get_sftp().chmod(tmp_abspath, mode)
208
# FIXME: should do something atomic or locking here, this is unsafe
210
path = self._abspath(relpath)
211
fout = self._sftp.file(path, 'wb')
213
self._translate_io_exception(e, relpath)
214
except (IOError, paramiko.SSHException), x:
215
raise SFTPTransportError('Unable to write file %r' % (path,), x)
416
self._rename_and_overwrite(tmp_abspath, abspath)
419
# If we fail, try to clean up the temporary file
420
# before we throw the exception
421
# but don't let another exception mess things up
422
# Write out the traceback, because otherwise
423
# the catch and throw destroys it
425
mutter(traceback.format_exc())
429
self._get_sftp().remove(tmp_abspath)
431
# raise the saved except
433
# raise the original with its traceback if we can.
436
def _put_non_atomic_helper(self, relpath, writer, mode=None,
437
create_parent_dir=False,
439
abspath = self._remote_path(relpath)
441
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
442
# set the file mode at create time. If it does, use it.
443
# But for now, we just chmod later anyway.
445
def _open_and_write_file():
446
"""Try to open the target file, raise error on failure"""
450
fout = self._get_sftp().file(abspath, mode='wb')
451
fout.set_pipelined(True)
453
except (paramiko.SSHException, IOError), e:
454
self._translate_io_exception(e, abspath,
457
# This is designed to chmod() right before we close.
458
# Because we set_pipelined() earlier, theoretically we might
459
# avoid the round trip for fout.close()
461
self._get_sftp().chmod(abspath, mode)
466
if not create_parent_dir:
467
_open_and_write_file()
470
# Try error handling to create the parent directory if we need to
472
_open_and_write_file()
474
# Try to create the parent directory, and then go back to
476
parent_dir = os.path.dirname(abspath)
477
self._mkdir(parent_dir, dir_mode)
478
_open_and_write_file()
480
def put_file_non_atomic(self, relpath, f, mode=None,
481
create_parent_dir=False,
483
"""Copy the file-like object into the target location.
485
This function is not strictly safe to use. It is only meant to
486
be used when you already know that the target does not exist.
487
It is not safe, because it will open and truncate the remote
488
file. So there may be a time when the file has invalid contents.
490
:param relpath: The remote location to put the contents.
491
:param f: File-like object.
492
:param mode: Possible access permissions for new file.
493
None means do not set remote permissions.
494
:param create_parent_dir: If we cannot create the target file because
495
the parent directory does not exist, go ahead and
496
create it, and then try again.
500
self._put_non_atomic_helper(relpath, writer, mode=mode,
501
create_parent_dir=create_parent_dir,
504
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
505
create_parent_dir=False,
509
self._put_non_atomic_helper(relpath, writer, mode=mode,
510
create_parent_dir=create_parent_dir,
513
221
def iter_files_recursive(self):
514
222
"""Walk the relative paths of all files in this transport."""
515
223
queue = list(self.list_dir('.'))
517
relpath = queue.pop(0)
225
relpath = urllib.quote(queue.pop(0))
518
226
st = self.stat(relpath)
519
227
if stat.S_ISDIR(st.st_mode):
520
228
for i, basename in enumerate(self.list_dir(relpath)):
525
def _mkdir(self, abspath, mode=None):
531
self._get_sftp().mkdir(abspath, local_mode)
533
self._get_sftp().chmod(abspath, mode=mode)
534
except (paramiko.SSHException, IOError), e:
535
self._translate_io_exception(e, abspath, ': unable to mkdir',
536
failure_exc=FileExists)
538
def mkdir(self, relpath, mode=None):
233
def mkdir(self, relpath):
539
234
"""Create a directory at the given path."""
540
self._mkdir(self._remote_path(relpath), mode=mode)
542
def open_write_stream(self, relpath, mode=None):
543
"""See Transport.open_write_stream."""
544
# initialise the file to zero-length
545
# this is three round trips, but we don't use this
546
# api more than once per write_group at the moment so
547
# it is a tolerable overhead. Better would be to truncate
548
# the file after opening. RBC 20070805
549
self.put_bytes_non_atomic(relpath, "", mode)
550
abspath = self._remote_path(relpath)
551
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
552
# set the file mode at create time. If it does, use it.
553
# But for now, we just chmod later anyway.
556
handle = self._get_sftp().file(abspath, mode='wb')
557
handle.set_pipelined(True)
558
except (paramiko.SSHException, IOError), e:
559
self._translate_io_exception(e, abspath,
561
_file_streams[self.abspath(relpath)] = handle
562
return FileFileStream(self, relpath, handle)
564
def _translate_io_exception(self, e, path, more_info='',
565
failure_exc=PathError):
566
"""Translate a paramiko or IOError into a friendlier exception.
568
:param e: The original exception
569
:param path: The path in question when the error is raised
570
:param more_info: Extra information that can be included,
571
such as what was going on
572
:param failure_exc: Paramiko has the super fun ability to raise completely
573
opaque errors that just set "e.args = ('Failure',)" with
575
If this parameter is set, it defines the exception
576
to raise in these cases.
236
path = self._abspath(relpath)
237
self._sftp.mkdir(path)
239
self._translate_io_exception(e, relpath)
240
except (IOError, paramiko.SSHException), x:
241
raise SFTPTransportError('Unable to mkdir %r' % (path,), x)
243
def _translate_io_exception(self, e, relpath):
578
244
# paramiko seems to generate detailless errors.
579
self._translate_error(e, path, raise_generic=False)
580
if getattr(e, 'args', None) is not None:
581
if (e.args == ('No such file or directory',) or
582
e.args == ('No such file',)):
583
raise NoSuchFile(path, str(e) + more_info)
584
if (e.args == ('mkdir failed',)):
585
raise FileExists(path, str(e) + more_info)
586
# strange but true, for the paramiko server.
587
if (e.args == ('Failure',)):
588
raise failure_exc(path, str(e) + more_info)
589
mutter('Raising exception with args %s', e.args)
590
if getattr(e, 'errno', None) is not None:
591
mutter('Raising exception with errno %s', e.errno)
245
if (e.errno == errno.ENOENT or
246
e.args == ('No such file or directory',) or
247
e.args == ('No such file',)):
248
raise NoSuchFile(relpath)
249
if (e.args == ('mkdir failed',)):
250
raise FileExists(relpath)
251
# strange but true, for the paramiko server.
252
if (e.args == ('Failure',)):
253
raise FileExists(relpath)
594
def append_file(self, relpath, f, mode=None):
256
def append(self, relpath, f):
596
258
Append the text in the file-like object into the final
600
path = self._remote_path(relpath)
601
fout = self._get_sftp().file(path, 'ab')
603
self._get_sftp().chmod(path, mode)
262
path = self._abspath(relpath)
263
fout = self._sftp.file(path, 'ab')
605
264
self._pump(f, fout)
607
except (IOError, paramiko.SSHException), e:
608
self._translate_io_exception(e, relpath, ': unable to append')
610
def rename(self, rel_from, rel_to):
611
"""Rename without special overwriting"""
613
self._get_sftp().rename(self._remote_path(rel_from),
614
self._remote_path(rel_to))
615
except (IOError, paramiko.SSHException), e:
616
self._translate_io_exception(e, rel_from,
617
': unable to rename to %r' % (rel_to))
619
def _rename_and_overwrite(self, abs_from, abs_to):
620
"""Do a fancy rename on the remote server.
622
Using the implementation provided by osutils.
625
sftp = self._get_sftp()
626
fancy_rename(abs_from, abs_to,
627
rename_func=sftp.rename,
628
unlink_func=sftp.remove)
629
except (IOError, paramiko.SSHException), e:
630
self._translate_io_exception(e, abs_from,
631
': unable to rename to %r' % (abs_to))
265
except (IOError, paramiko.SSHException), x:
266
raise SFTPTransportError('Unable to append file %r' % (path,), x)
268
def copy(self, rel_from, rel_to):
269
"""Copy the item at rel_from to the location at rel_to"""
270
path_from = self._abspath(rel_from)
271
path_to = self._abspath(rel_to)
273
fin = self._sftp.file(path_from, 'rb')
275
fout = self._sftp.file(path_to, 'wb')
277
fout.set_pipelined(True)
278
self._pump(fin, fout)
283
except (IOError, paramiko.SSHException), x:
284
raise SFTPTransportError('Unable to copy %r to %r' % (path_from, path_to), x)
633
286
def move(self, rel_from, rel_to):
634
287
"""Move the item at rel_from to the location at rel_to"""
635
path_from = self._remote_path(rel_from)
636
path_to = self._remote_path(rel_to)
637
self._rename_and_overwrite(path_from, path_to)
288
path_from = self._abspath(rel_from)
289
path_to = self._abspath(rel_to)
291
self._sftp.rename(path_from, path_to)
292
except (IOError, paramiko.SSHException), x:
293
raise SFTPTransportError('Unable to move %r to %r' % (path_from, path_to), x)
639
295
def delete(self, relpath):
640
296
"""Delete the item at relpath"""
641
path = self._remote_path(relpath)
297
path = self._abspath(relpath)
643
self._get_sftp().remove(path)
644
except (IOError, paramiko.SSHException), e:
645
self._translate_io_exception(e, path, ': unable to delete')
299
self._sftp.remove(path)
300
except (IOError, paramiko.SSHException), x:
301
raise SFTPTransportError('Unable to delete %r' % (path,), x)
647
def external_url(self):
648
"""See bzrlib.transport.Transport.external_url."""
649
# the external path for SFTP is the base
652
303
def listable(self):
653
304
"""Return True if this store supports listing."""
702
341
Lock the given file for exclusive (write) access.
703
342
WARNING: many transports do not support this, so trying avoid using it
705
:return: A lock object, which has an unlock() member function
707
# This is a little bit bogus, but basically, we create a file
708
# which should not already exist, and if it does, we assume
709
# that there is a lock, and if it doesn't, the we assume
710
# that we have taken the lock.
711
return SFTPLock(relpath, self)
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._get_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._get_sftp()._request(CMD_OPEN, path, omode, attr)
741
raise TransportError('Expected an SFTP handle')
742
handle = msg.get_string()
743
return SFTPFile(self._get_sftp(), handle, 'wb', -1)
744
except (paramiko.SSHException, IOError), e:
745
self._translate_io_exception(e, abspath, ': unable to open',
746
failure_exc=FileExists)
748
def _can_roundtrip_unix_modebits(self):
749
if sys.platform == 'win32':
344
:return: A lock object, which should be passed to Transport.unlock()
346
# FIXME: there should be something clever i can do here...
347
class BogusLock(object):
348
def __init__(self, path):
352
return BogusLock(relpath)
355
def _unparse_url(self, path=None):
359
return 'sftp://%s@%s%s' % (self._username, self._host, path)
360
return 'sftp://%s@%s:%d%s' % (self._username, self._host, self._port, path)
362
def _parse_url(self, url):
363
assert url[:7] == 'sftp://'
364
m = self._url_matcher.match(url)
366
raise SFTPTransportError('Unable to parse SFTP URL %r' % (url,))
367
self._username, self._password, self._host, self._port, self._path = m.groups()
368
if self._username is None:
369
self._username = getpass.getuser()
371
self._username = self._username[:-1]
373
self._password = self._password[1:]
374
self._username = self._username[len(self._password)+1:]
375
if self._port is None:
378
self._port = int(self._port[1:])
379
if (self._path is None) or (self._path == ''):
382
def _sftp_connect(self):
383
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
388
t = paramiko.Transport((self._host, self._port))
390
except paramiko.SSHException:
391
raise SFTPTransportError('Unable to reach SSH host %s:%d' % (self._host, self._port))
393
server_key = t.get_remote_server_key()
394
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
395
keytype = server_key.get_name()
396
if SYSTEM_HOSTKEYS.has_key(self._host) and SYSTEM_HOSTKEYS[self._host].has_key(keytype):
397
our_server_key = SYSTEM_HOSTKEYS[self._host][keytype]
398
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
399
elif BZR_HOSTKEYS.has_key(self._host) and BZR_HOSTKEYS[self._host].has_key(keytype):
400
our_server_key = BZR_HOSTKEYS[self._host][keytype]
401
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
403
warning('Adding %s host key for %s: %s' % (keytype, self._host, server_key_hex))
404
if not BZR_HOSTKEYS.has_key(self._host):
405
BZR_HOSTKEYS[self._host] = {}
406
BZR_HOSTKEYS[self._host][keytype] = server_key
407
our_server_key = server_key
408
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
410
if server_key != our_server_key:
411
filename1 = os.path.expanduser('~/.ssh/known_hosts')
412
filename2 = os.path.join(config_dir(), 'ssh_host_keys')
413
raise SFTPTransportError('Host keys for %s do not match! %s != %s' % \
414
(self._host, our_server_key_hex, server_key_hex),
415
['Try editing %s or %s' % (filename1, filename2)])
417
self._sftp_auth(t, self._username, self._host)
420
self._sftp = t.open_sftp_client()
421
except paramiko.SSHException:
422
raise BzrError('Unable to find path %s on SFTP server %s' % \
423
(self._path, self._host))
425
def _sftp_auth(self, transport, username, host):
426
agent = paramiko.Agent()
427
for key in agent.get_keys():
428
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
430
transport.auth_publickey(self._username, key)
432
except paramiko.SSHException, e:
435
# okay, try finding id_rsa or id_dss? (posix only)
436
if self._try_pkey_auth(transport, paramiko.RSAKey, 'id_rsa'):
438
if self._try_pkey_auth(transport, paramiko.DSSKey, 'id_dsa'):
443
transport.auth_password(self._username, self._password)
445
except paramiko.SSHException, e:
448
# give up and ask for a password
449
password = getpass.getpass('SSH %s@%s password: ' % (self._username, self._host))
451
transport.auth_password(self._username, password)
452
except paramiko.SSHException:
453
raise SFTPTransportError('Unable to authenticate to SSH host as %s@%s' % \
454
(self._username, self._host))
456
def _try_pkey_auth(self, transport, pkey_class, filename):
457
filename = os.path.expanduser('~/.ssh/' + filename)
459
key = pkey_class.from_private_key_file(filename)
460
transport.auth_publickey(self._username, key)
755
# ------------- server test implementation --------------
758
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
760
STUB_SERVER_KEY = """
761
-----BEGIN RSA PRIVATE KEY-----
762
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
763
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
764
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
765
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
766
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
767
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
768
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
769
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
770
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
771
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
772
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
773
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
774
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
775
-----END RSA PRIVATE KEY-----
779
class SocketListener(threading.Thread):
781
def __init__(self, callback):
782
threading.Thread.__init__(self)
783
self._callback = callback
784
self._socket = socket.socket()
785
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
786
self._socket.bind(('localhost', 0))
787
self._socket.listen(1)
788
self.port = self._socket.getsockname()[1]
789
self._stop_event = threading.Event()
792
# called from outside this thread
793
self._stop_event.set()
794
# use a timeout here, because if the test fails, the server thread may
795
# never notice the stop_event.
801
readable, writable_unused, exception_unused = \
802
select.select([self._socket], [], [], 0.1)
803
if self._stop_event.isSet():
805
if len(readable) == 0:
462
except paramiko.PasswordRequiredException:
463
password = getpass.getpass('SSH %s password: ' % (os.path.basename(filename),))
808
s, addr_unused = self._socket.accept()
809
# because the loopback socket is inline, and transports are
810
# never explicitly closed, best to launch a new thread.
811
threading.Thread(target=self._callback, args=(s,)).start()
812
except socket.error, x:
813
sys.excepthook(*sys.exc_info())
814
warning('Socket error during accept() within unit test server'
817
# probably a failed test; unit test thread will log the
819
sys.excepthook(*sys.exc_info())
820
warning('Exception from within unit test server thread: %r' %
824
class SocketDelay(object):
825
"""A socket decorator to make TCP appear slower.
827
This changes recv, send, and sendall to add a fixed latency to each python
828
call if a new roundtrip is detected. That is, when a recv is called and the
829
flag new_roundtrip is set, latency is charged. Every send and send_all
832
In addition every send, sendall and recv sleeps a bit per character send to
835
Not all methods are implemented, this is deliberate as this class is not a
836
replacement for the builtin sockets layer. fileno is not implemented to
837
prevent the proxy being bypassed.
841
_proxied_arguments = dict.fromkeys([
842
"close", "getpeername", "getsockname", "getsockopt", "gettimeout",
843
"setblocking", "setsockopt", "settimeout", "shutdown"])
845
def __init__(self, sock, latency, bandwidth=1.0,
848
:param bandwith: simulated bandwith (MegaBit)
849
:param really_sleep: If set to false, the SocketDelay will just
850
increase a counter, instead of calling time.sleep. This is useful for
851
unittesting the SocketDelay.
854
self.latency = latency
855
self.really_sleep = really_sleep
856
self.time_per_byte = 1 / (bandwidth / 8.0 * 1024 * 1024)
857
self.new_roundtrip = False
860
if self.really_sleep:
863
SocketDelay.simulated_time += s
865
def __getattr__(self, attr):
866
if attr in SocketDelay._proxied_arguments:
867
return getattr(self.sock, attr)
868
raise AttributeError("'SocketDelay' object has no attribute %r" %
872
return SocketDelay(self.sock.dup(), self.latency, self.time_per_byte,
875
def recv(self, *args):
876
data = self.sock.recv(*args)
877
if data and self.new_roundtrip:
878
self.new_roundtrip = False
879
self.sleep(self.latency)
880
self.sleep(len(data) * self.time_per_byte)
883
def sendall(self, data, flags=0):
884
if not self.new_roundtrip:
885
self.new_roundtrip = True
886
self.sleep(self.latency)
887
self.sleep(len(data) * self.time_per_byte)
888
return self.sock.sendall(data, flags)
890
def send(self, data, flags=0):
891
if not self.new_roundtrip:
892
self.new_roundtrip = True
893
self.sleep(self.latency)
894
bytes_sent = self.sock.send(data, flags)
895
self.sleep(bytes_sent * self.time_per_byte)
899
class SFTPServer(Server):
900
"""Common code for SFTP server facilities."""
902
def __init__(self, server_interface=StubServer):
903
self._original_vendor = None
905
self._server_homedir = None
906
self._listener = None
908
self._vendor = ssh.ParamikoVendor()
909
self._server_interface = server_interface
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 = self._server_interface(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)
948
def setUp(self, backing_server=None):
949
# XXX: TODO: make sftpserver back onto backing_server rather than local
951
assert (backing_server is None or
952
isinstance(backing_server, local.LocalURLServer)), (
953
"backing_server should not be %r, because this can only serve the "
954
"local current working directory." % (backing_server,))
955
self._original_vendor = ssh._ssh_vendor_manager._cached_ssh_vendor
956
ssh._ssh_vendor_manager._cached_ssh_vendor = self._vendor
957
if sys.platform == 'win32':
958
# Win32 needs to use the UNICODE api
959
self._homedir = getcwd()
961
# But Linux SFTP servers should just deal in bytestreams
962
self._homedir = os.getcwd()
963
if self._server_homedir is None:
964
self._server_homedir = self._homedir
966
if sys.platform == 'win32':
968
self._listener = SocketListener(self._run_server_entry)
969
self._listener.setDaemon(True)
970
self._listener.start()
973
"""See bzrlib.transport.Server.tearDown."""
974
self._listener.stop()
975
ssh._ssh_vendor_manager._cached_ssh_vendor = self._original_vendor
977
def get_bogus_url(self):
978
"""See bzrlib.transport.Server.get_bogus_url."""
979
# this is chosen to try to prevent trouble with proxies, wierd dns, etc
980
# we bind a random socket, so that we get a guaranteed unused port
981
# we just never listen on that port
983
s.bind(('localhost', 0))
984
return 'sftp://%s:%s/' % s.getsockname()
987
class SFTPFullAbsoluteServer(SFTPServer):
988
"""A test server for sftp transports, using absolute urls and ssh."""
991
"""See bzrlib.transport.Server.get_url."""
992
homedir = self._homedir
993
if sys.platform != 'win32':
994
# Remove the initial '/' on all platforms but win32
995
homedir = homedir[1:]
996
return self._get_sftp_url(urlutils.escape(homedir))
999
class SFTPServerWithoutSSH(SFTPServer):
1000
"""An SFTP server that uses a simple TCP socket pair rather than SSH."""
1003
super(SFTPServerWithoutSSH, self).__init__()
1004
self._vendor = ssh.LoopbackVendor()
1006
def _run_server(self, sock):
1007
# Re-import these as locals, so that they're still accessible during
1008
# interpreter shutdown (when all module globals get set to None, leading
1009
# to confusing errors like "'NoneType' object has no attribute 'error'".
1010
class FakeChannel(object):
1011
def get_transport(self):
1013
def get_log_channel(self):
1017
def get_hexdump(self):
1022
server = paramiko.SFTPServer(FakeChannel(), 'sftp', StubServer(self), StubSFTPServer,
1023
root=self._root, home=self._server_homedir)
1025
server.start_subsystem('sftp', None, sock)
1026
except socket.error, e:
1027
if (len(e.args) > 0) and (e.args[0] == errno.EPIPE):
1028
# it's okay for the client to disconnect abruptly
1029
# (bug in paramiko 1.6: it should absorb this exception)
1033
except Exception, e:
1034
# This typically seems to happen during interpreter shutdown, so
1035
# most of the useful ways to report this error are won't work.
1036
# Writing the exception type, and then the text of the exception,
1037
# seems to be the best we can do.
1039
sys.stderr.write('\nEXCEPTION %r: ' % (e.__class__,))
1040
sys.stderr.write('%s\n\n' % (e,))
1041
server.finish_subsystem()
1044
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
1045
"""A test server for sftp transports, using absolute urls."""
1048
"""See bzrlib.transport.Server.get_url."""
1049
homedir = self._homedir
1050
if sys.platform != 'win32':
1051
# Remove the initial '/' on all platforms but win32
1052
homedir = homedir[1:]
1053
return self._get_sftp_url(urlutils.escape(homedir))
1056
class SFTPHomeDirServer(SFTPServerWithoutSSH):
1057
"""A test server for sftp transports, using homedir relative urls."""
1060
"""See bzrlib.transport.Server.get_url."""
1061
return self._get_sftp_url("~/")
1064
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
1065
"""A test server for sftp transports where only absolute paths will work.
1067
It does this by serving from a deeply-nested directory that doesn't exist.
1070
def setUp(self, backing_server=None):
1071
self._server_homedir = '/dev/noone/runs/tests/here'
1072
super(SFTPSiblingAbsoluteServer, self).setUp(backing_server)
1075
def get_test_permutations():
1076
"""Return the permutations to be used in testing."""
1077
return [(SFTPTransport, SFTPAbsoluteServer),
1078
(SFTPTransport, SFTPHomeDirServer),
1079
(SFTPTransport, SFTPSiblingAbsoluteServer),
465
key = pkey_class.from_private_key_file(filename, password)
466
transport.auth_publickey(self._username, key)
468
except paramiko.SSHException:
469
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
470
except paramiko.SSHException:
471
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
added
removed
bzrlib/transport/sftp.py
