1
# Copyright (C) 2005-2010 Canonical Ltd
1
# Copyright (C) 2005 Robey Pointer <robey@lag.net>, Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""Implementation of Transport over SFTP, using paramiko."""
19
# TODO: Remove the transport-based lock_read and lock_write methods. They'll
20
# then raise TransportNotPossible, which will break remote access to any
21
# formats which rely on OS-level locks. That should be fine as those formats
22
# are pretty old, but these combinations may have to be removed from the test
23
# suite. Those formats all date back to 0.7; so we should be able to remove
24
# these methods when we officially drop support for those formats.
44
from bzrlib.errors import (FileExists,
45
NoSuchFile, PathNotChild,
32
from bzrlib.config import config_dir, ensure_config_dir_exists
33
from bzrlib.errors import (ConnectionError,
35
TransportNotPossible, NoSuchFile, PathNotChild,
51
from bzrlib.osutils import pathjoin, fancy_rename, getcwd
52
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')
39
from bzrlib.osutils import pathjoin, fancy_rename
40
from bzrlib.trace import mutter, warning, error
41
from bzrlib.transport import Transport, Server, urlescape
80
except ImportError, e:
81
raise ParamikoNotPresent(e)
47
error('The SFTP transport requires paramiko.')
83
50
from paramiko.sftp import (SFTP_FLAG_WRITE, SFTP_FLAG_CREATE,
84
51
SFTP_FLAG_EXCL, SFTP_FLAG_TRUNC,
85
SFTP_OK, CMD_HANDLE, CMD_OPEN)
86
53
from paramiko.sftp_attr import SFTPAttributes
87
54
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))
55
from paramiko.sftp_client import SFTPClient
57
if 'sftp' not in urlparse.uses_netloc: urlparse.uses_netloc.append('sftp')
61
if sys.platform == 'win32':
62
# close_fds not supported on win32
66
def _get_ssh_vendor():
67
"""Find out what version of SSH is on the system."""
69
if _ssh_vendor is not None:
75
p = subprocess.Popen(['ssh', '-V'],
77
stdin=subprocess.PIPE,
78
stdout=subprocess.PIPE,
79
stderr=subprocess.PIPE)
80
returncode = p.returncode
81
stdout, stderr = p.communicate()
85
if 'OpenSSH' in stderr:
86
mutter('ssh implementation is OpenSSH')
87
_ssh_vendor = 'openssh'
88
elif 'SSH Secure Shell' in stderr:
89
mutter('ssh implementation is SSH Corp.')
92
if _ssh_vendor != 'none':
95
# XXX: 20051123 jamesh
96
# A check for putty's plink or lsh would go here.
98
mutter('falling back to paramiko implementation')
102
class SFTPSubprocess:
103
"""A socket-like object that talks to an ssh subprocess via pipes."""
104
def __init__(self, hostname, vendor, port=None, user=None):
105
assert vendor in ['openssh', 'ssh']
106
if vendor == 'openssh':
108
'-oForwardX11=no', '-oForwardAgent=no',
109
'-oClearAllForwardings=yes', '-oProtocol=2',
110
'-oNoHostAuthenticationForLocalhost=yes']
112
args.extend(['-p', str(port)])
114
args.extend(['-l', user])
115
args.extend(['-s', hostname, 'sftp'])
116
elif vendor == 'ssh':
119
args.extend(['-p', str(port)])
121
args.extend(['-l', user])
122
args.extend(['-s', 'sftp', hostname])
124
self.proc = subprocess.Popen(args, close_fds=_close_fds,
125
stdin=subprocess.PIPE,
126
stdout=subprocess.PIPE)
128
def send(self, data):
129
return os.write(self.proc.stdin.fileno(), data)
131
def recv_ready(self):
132
# TODO: jam 20051215 this function is necessary to support the
133
# pipelined() function. In reality, it probably should use
134
# poll() or select() to actually return if there is data
135
# available, otherwise we probably don't get any benefit
138
def recv(self, count):
139
return os.read(self.proc.stdout.fileno(), count)
142
self.proc.stdin.close()
143
self.proc.stdout.close()
150
# This is a weakref dictionary, so that we can reuse connections
151
# that are still active. Long term, it might be nice to have some
152
# sort of expiration policy, such as disconnect if inactive for
153
# X seconds. But that requires a lot more fanciness.
154
_connected_hosts = weakref.WeakValueDictionary()
156
def load_host_keys():
158
Load system host keys (probably doesn't work on windows) and any
159
"discovered" keys from previous sessions.
161
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
163
SYSTEM_HOSTKEYS = paramiko.util.load_host_keys(os.path.expanduser('~/.ssh/known_hosts'))
165
mutter('failed to load system host keys: ' + str(e))
166
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
168
BZR_HOSTKEYS = paramiko.util.load_host_keys(bzr_hostkey_path)
170
mutter('failed to load bzr host keys: ' + str(e))
173
def save_host_keys():
175
Save "discovered" host keys in $(config)/ssh_host_keys/.
177
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
178
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
179
ensure_config_dir_exists()
182
f = open(bzr_hostkey_path, 'w')
183
f.write('# SSH host keys collected by bzr\n')
184
for hostname, keys in BZR_HOSTKEYS.iteritems():
185
for keytype, key in keys.iteritems():
186
f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
189
mutter('failed to save bzr host keys: ' + str(e))
95
192
class SFTPLock(object):
96
"""This fakes a lock in a remote location.
98
A present lock is indicated just by the existence of a file. This
99
doesn't work well on all transports and they are only used in
100
deprecated storage formats.
193
"""This fakes a lock in a remote location."""
103
194
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
105
195
def __init__(self, path, transport):
196
assert isinstance(transport, SFTPTransport)
106
198
self.lock_file = None
108
200
self.lock_path = path + '.write-lock'
135
class _SFTPReadvHelper(object):
136
"""A class to help with managing the state of a readv request."""
138
# See _get_requests for an explanation.
139
_max_request_size = 32768
141
def __init__(self, original_offsets, relpath, _report_activity):
142
"""Create a new readv helper.
144
:param original_offsets: The original requests given by the caller of
146
:param relpath: The name of the file (if known)
147
:param _report_activity: A Transport._report_activity bound method,
148
to be called as data arrives.
150
self.original_offsets = list(original_offsets)
151
self.relpath = relpath
152
self._report_activity = _report_activity
154
def _get_requests(self):
155
"""Break up the offsets into individual requests over sftp.
157
The SFTP spec only requires implementers to support 32kB requests. We
158
could try something larger (openssh supports 64kB), but then we have to
159
handle requests that fail.
160
So instead, we just break up our maximum chunks into 32kB chunks, and
161
asyncronously requests them.
162
Newer versions of paramiko would do the chunking for us, but we want to
163
start processing results right away, so we do it ourselves.
165
# TODO: Because we issue async requests, we don't 'fudge' any extra
166
# data. I'm not 100% sure that is the best choice.
168
# The first thing we do, is to collapse the individual requests as much
169
# as possible, so we don't issues requests <32kB
170
sorted_offsets = sorted(self.original_offsets)
171
coalesced = list(ConnectedTransport._coalesce_offsets(sorted_offsets,
172
limit=0, fudge_factor=0))
174
for c_offset in coalesced:
175
start = c_offset.start
176
size = c_offset.length
178
# Break this up into 32kB requests
180
next_size = min(size, self._max_request_size)
181
requests.append((start, next_size))
184
if 'sftp' in debug.debug_flags:
185
mutter('SFTP.readv(%s) %s offsets => %s coalesced => %s requests',
186
self.relpath, len(sorted_offsets), len(coalesced),
190
def request_and_yield_offsets(self, fp):
191
"""Request the data from the remote machine, yielding the results.
193
:param fp: A Paramiko SFTPFile object that supports readv.
194
:return: Yield the data requested by the original readv caller, one by
197
requests = self._get_requests()
198
offset_iter = iter(self.original_offsets)
199
cur_offset, cur_size = offset_iter.next()
200
# paramiko .readv() yields strings that are in the order of the requests
201
# So we track the current request to know where the next data is
202
# being returned from.
208
# This is used to buffer chunks which we couldn't process yet
209
# It is (start, end, data) tuples.
211
# Create an 'unlimited' data stream, so we stop based on requests,
212
# rather than just because the data stream ended. This lets us detect
214
data_stream = itertools.chain(fp.readv(requests),
215
itertools.repeat(None))
216
for (start, length), data in itertools.izip(requests, data_stream):
218
if cur_coalesced is not None:
219
raise errors.ShortReadvError(self.relpath,
220
start, length, len(data))
221
if len(data) != length:
222
raise errors.ShortReadvError(self.relpath,
223
start, length, len(data))
224
self._report_activity(length, 'read')
226
# This is the first request, just buffer it
227
buffered_data = [data]
228
buffered_len = length
230
elif start == last_end:
231
# The data we are reading fits neatly on the previous
232
# buffer, so this is all part of a larger coalesced range.
233
buffered_data.append(data)
234
buffered_len += length
236
# We have an 'interrupt' in the data stream. So we know we are
237
# at a request boundary.
239
# We haven't consumed the buffer so far, so put it into
240
# data_chunks, and continue.
241
buffered = ''.join(buffered_data)
242
data_chunks.append((input_start, buffered))
244
buffered_data = [data]
245
buffered_len = length
246
last_end = start + length
247
if input_start == cur_offset and cur_size <= buffered_len:
248
# Simplify the next steps a bit by transforming buffered_data
249
# into a single string. We also have the nice property that
250
# when there is only one string ''.join([x]) == x, so there is
252
buffered = ''.join(buffered_data)
253
# Clean out buffered data so that we keep memory
257
# TODO: We *could* also consider the case where cur_offset is in
258
# in the buffered range, even though it doesn't *start*
259
# the buffered range. But for packs we pretty much always
260
# read in order, so you won't get any extra data in the
262
while (input_start == cur_offset
263
and (buffered_offset + cur_size) <= buffered_len):
264
# We've buffered enough data to process this request, spit it
266
cur_data = buffered[buffered_offset:buffered_offset + cur_size]
267
# move the direct pointer into our buffered data
268
buffered_offset += cur_size
269
# Move the start-of-buffer pointer
270
input_start += cur_size
271
# Yield the requested data
272
yield cur_offset, cur_data
273
cur_offset, cur_size = offset_iter.next()
274
# at this point, we've consumed as much of buffered as we can,
275
# so break off the portion that we consumed
276
if buffered_offset == len(buffered_data):
277
# No tail to leave behind
281
buffered = buffered[buffered_offset:]
282
buffered_data = [buffered]
283
buffered_len = len(buffered)
285
buffered = ''.join(buffered_data)
287
data_chunks.append((input_start, buffered))
289
if 'sftp' in debug.debug_flags:
290
mutter('SFTP readv left with %d out-of-order bytes',
291
sum(map(lambda x: len(x[1]), data_chunks)))
292
# We've processed all the readv data, at this point, anything we
293
# couldn't process is in data_chunks. This doesn't happen often, so
294
# this code path isn't optimized
295
# We use an interesting process for data_chunks
296
# Specifically if we have "bisect_left([(start, len, entries)],
298
# If start == qstart, then we get the specific node. Otherwise we
299
# get the previous node
301
idx = bisect.bisect_left(data_chunks, (cur_offset,))
302
if idx < len(data_chunks) and data_chunks[idx][0] == cur_offset:
303
# The data starts here
304
data = data_chunks[idx][1][:cur_size]
306
# The data is in a portion of a previous page
308
sub_offset = cur_offset - data_chunks[idx][0]
309
data = data_chunks[idx][1]
310
data = data[sub_offset:sub_offset + cur_size]
312
# We are missing the page where the data should be found,
315
if len(data) != cur_size:
316
raise AssertionError('We must have miscalulated.'
317
' We expected %d bytes, but only found %d'
318
% (cur_size, len(data)))
319
yield cur_offset, data
320
cur_offset, cur_size = offset_iter.next()
323
class SFTPTransport(ConnectedTransport):
324
"""Transport implementation for SFTP access."""
326
_do_prefetch = _default_do_prefetch
327
# TODO: jam 20060717 Conceivably these could be configurable, either
328
# by auto-tuning at run-time, or by a configuration (per host??)
329
# but the performance curve is pretty flat, so just going with
330
# reasonable defaults.
331
_max_readv_combine = 200
332
# Having to round trip to the server means waiting for a response,
333
# so it is better to download extra bytes.
334
# 8KiB had good performance for both local and remote network operations
335
_bytes_to_read_before_seek = 8192
337
# The sftp spec says that implementations SHOULD allow reads
338
# to be at least 32K. paramiko.readv() does an async request
339
# for the chunks. So we need to keep it within a single request
340
# size for paramiko <= 1.6.1. paramiko 1.6.2 will probably chop
341
# up the request itself, rather than us having to worry about it
342
_max_request_size = 32768
344
def __init__(self, base, _from_transport=None):
345
super(SFTPTransport, self).__init__(base,
346
_from_transport=_from_transport)
228
class SFTPTransport (Transport):
230
Transport implementation for SFTP access.
232
_do_prefetch = False # Right now Paramiko's prefetch support causes things to hang
234
def __init__(self, base, clone_from=None):
235
assert base.startswith('sftp://')
236
self._parse_url(base)
237
base = self._unparse_url()
240
super(SFTPTransport, self).__init__(base)
241
if clone_from is None:
244
# use the same ssh connection, etc
245
self._sftp = clone_from._sftp
246
# super saves 'self.base'
248
def should_cache(self):
250
Return True if the data pulled across should be cached locally.
254
def clone(self, offset=None):
256
Return a new SFTPTransport with root at self.base + offset.
257
We share the same SFTP session between such transports, because it's
258
fairly expensive to set them up.
261
return SFTPTransport(self.base, self)
263
return SFTPTransport(self.abspath(offset), self)
265
def abspath(self, relpath):
267
Return the full url to the given relative path.
269
@param relpath: the relative path or path components
270
@type relpath: str or list
272
return self._unparse_url(self._remote_path(relpath))
348
274
def _remote_path(self, relpath):
349
275
"""Return the path to be passed along the sftp protocol for relpath.
351
:param relpath: is a urlencoded string.
353
relative = urlutils.unescape(relpath).encode('utf-8')
354
remote_path = self._combine_paths(self._path, relative)
355
# the initial slash should be removed from the path, and treated as a
356
# homedir relative path (the path begins with a double slash if it is
357
# absolute). see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
358
# RBC 20060118 we are not using this as its too user hostile. instead
359
# we are following lftp and using /~/foo to mean '~/foo'
360
# vila--20070602 and leave absolute paths begin with a single slash.
361
if remote_path.startswith('/~/'):
362
remote_path = remote_path[3:]
363
elif remote_path == '/~':
367
def _create_connection(self, credentials=None):
368
"""Create a new connection with the provided credentials.
370
:param credentials: The credentials needed to establish the connection.
372
:return: The created connection and its associated credentials.
374
The credentials are only the password as it may have been entered
375
interactively by the user and may be different from the one provided
376
in base url at transport creation time.
378
if credentials is None:
379
password = self._password
381
password = credentials
383
vendor = ssh._get_ssh_vendor()
386
auth = config.AuthenticationConfig()
387
user = auth.get_user('ssh', self._host, self._port)
388
connection = vendor.connect_sftp(self._user, password,
389
self._host, self._port)
390
return connection, (user, password)
393
"""Ensures that a connection is established"""
394
connection = self._get_connection()
395
if connection is None:
396
# First connection ever
397
connection, credentials = self._create_connection()
398
self._set_connection(connection, credentials)
277
relpath is a urlencoded string.
279
# FIXME: share the common code across transports
280
assert isinstance(relpath, basestring)
281
relpath = urllib.unquote(relpath).split('/')
282
basepath = self._path.split('/')
283
if len(basepath) > 0 and basepath[-1] == '':
284
basepath = basepath[:-1]
288
if len(basepath) == 0:
289
# In most filesystems, a request for the parent
290
# of root, just returns root.
298
path = '/'.join(basepath)
301
def relpath(self, abspath):
302
username, password, host, port, path = self._split_url(abspath)
304
if (username != self._username):
305
error.append('username mismatch')
306
if (host != self._host):
307
error.append('host mismatch')
308
if (port != self._port):
309
error.append('port mismatch')
310
if (not path.startswith(self._path)):
311
error.append('path mismatch')
313
extra = ': ' + ', '.join(error)
314
raise PathNotChild(abspath, self.base, extra=extra)
316
return path[pl:].strip('/')
401
318
def has(self, relpath):
403
320
Does the target location exist?
406
self._get_sftp().stat(self._remote_path(relpath))
407
# stat result is about 20 bytes, let's say
408
self._report_activity(20, 'read')
323
self._sftp.stat(self._remote_path(relpath))
413
def get(self, relpath):
414
"""Get the file at the given relative path.
328
def get(self, relpath, decode=False):
330
Get the file at the given relative path.
416
332
:param relpath: The relative path to the file
419
# FIXME: by returning the file directly, we don't pass this
420
# through to report_activity. We could try wrapping the object
421
# before it's returned. For readv and get_bytes it's handled in
422
# the higher-level function.
424
335
path = self._remote_path(relpath)
425
f = self._get_sftp().file(path, mode='rb')
426
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
336
f = self._sftp.file(path, mode='rb')
337
if self._do_prefetch and hasattr(f, 'prefetch'):
429
340
except (IOError, paramiko.SSHException), e:
430
self._translate_io_exception(e, path, ': error retrieving',
431
failure_exc=errors.ReadError)
433
def get_bytes(self, relpath):
434
# reimplement this here so that we can report how many bytes came back
341
self._translate_io_exception(e, path, ': error retrieving')
343
def get_partial(self, relpath, start, length=None):
345
Get just part of a file.
347
:param relpath: Path to the file, relative to base
348
:param start: The starting position to read from
349
:param length: The length to read. A length of None indicates
350
read to the end of the file.
351
:return: A file-like object containing at least the specified bytes.
352
Some implementations may return objects which can be read
353
past this length, but this is not guaranteed.
355
# TODO: implement get_partial_multi to help with knit support
435
356
f = self.get(relpath)
438
self._report_activity(len(bytes), 'read')
443
def _readv(self, relpath, offsets):
444
"""See Transport.readv()"""
445
# We overload the default readv() because we want to use a file
446
# that does not have prefetch enabled.
447
# Also, if we have a new paramiko, it implements an async readv()
452
path = self._remote_path(relpath)
453
fp = self._get_sftp().file(path, mode='rb')
454
readv = getattr(fp, 'readv', None)
456
return self._sftp_readv(fp, offsets, relpath)
457
if 'sftp' in debug.debug_flags:
458
mutter('seek and read %s offsets', len(offsets))
459
return self._seek_and_read(fp, offsets, relpath)
460
except (IOError, paramiko.SSHException), e:
461
self._translate_io_exception(e, path, ': error retrieving')
463
def recommended_page_size(self):
464
"""See Transport.recommended_page_size().
466
For SFTP we suggest a large page size to reduce the overhead
467
introduced by latency.
471
def _sftp_readv(self, fp, offsets, relpath):
472
"""Use the readv() member of fp to do async readv.
474
Then read them using paramiko.readv(). paramiko.readv()
475
does not support ranges > 64K, so it caps the request size, and
476
just reads until it gets all the stuff it wants.
478
helper = _SFTPReadvHelper(offsets, relpath, self._report_activity)
479
return helper.request_and_yield_offsets(fp)
481
def put_file(self, relpath, f, mode=None):
483
Copy the file-like object into the location.
358
if self._do_prefetch and hasattr(f, 'prefetch'):
362
def put(self, relpath, f, mode=None):
364
Copy the file-like or string object into the location.
485
366
:param relpath: Location to put the contents, relative to base.
486
:param f: File-like object.
367
:param f: File-like or string object.
487
368
:param mode: The final mode for the file
489
370
final_path = self._remote_path(relpath)
490
return self._put(final_path, f, mode=mode)
371
self._put(final_path, f, mode=mode)
492
373
def _put(self, abspath, f, mode=None):
493
374
"""Helper function so both put() and copy_abspaths can reuse the code"""
631
def _mkdir(self, abspath, mode=None):
637
self._report_activity(len(abspath), 'write')
638
self._get_sftp().mkdir(abspath, local_mode)
639
self._report_activity(1, 'read')
641
# chmod a dir through sftp will erase any sgid bit set
642
# on the server side. So, if the bit mode are already
643
# set, avoid the chmod. If the mode is not fine but
644
# the sgid bit is set, report a warning to the user
645
# with the umask fix.
646
stat = self._get_sftp().lstat(abspath)
647
mode = mode & 0777 # can't set special bits anyway
648
if mode != stat.st_mode & 0777:
649
if stat.st_mode & 06000:
650
warning('About to chmod %s over sftp, which will result'
651
' in its suid or sgid bits being cleared. If'
652
' you want to preserve those bits, change your '
653
' environment on the server to use umask 0%03o.'
654
% (abspath, 0777 - mode))
655
self._get_sftp().chmod(abspath, mode=mode)
656
except (paramiko.SSHException, IOError), e:
657
self._translate_io_exception(e, abspath, ': unable to mkdir',
658
failure_exc=FileExists)
660
420
def mkdir(self, relpath, mode=None):
661
421
"""Create a directory at the given path."""
662
self._mkdir(self._remote_path(relpath), mode=mode)
664
def open_write_stream(self, relpath, mode=None):
665
"""See Transport.open_write_stream."""
666
# initialise the file to zero-length
667
# this is three round trips, but we don't use this
668
# api more than once per write_group at the moment so
669
# it is a tolerable overhead. Better would be to truncate
670
# the file after opening. RBC 20070805
671
self.put_bytes_non_atomic(relpath, "", mode)
672
abspath = self._remote_path(relpath)
673
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
674
# set the file mode at create time. If it does, use it.
675
# But for now, we just chmod later anyway.
678
handle = self._get_sftp().file(abspath, mode='wb')
679
handle.set_pipelined(True)
423
path = self._remote_path(relpath)
424
# In the paramiko documentation, it says that passing a mode flag
425
# will filtered against the server umask.
426
# StubSFTPServer does not do this, which would be nice, because it is
427
# what we really want :)
428
# However, real servers do use umask, so we really should do it that way
429
self._sftp.mkdir(path)
431
self._sftp.chmod(path, mode=mode)
680
432
except (paramiko.SSHException, IOError), e:
681
self._translate_io_exception(e, abspath,
683
_file_streams[self.abspath(relpath)] = handle
684
return FileFileStream(self, relpath, handle)
433
self._translate_io_exception(e, path, ': unable to mkdir',
434
failure_exc=FileExists)
686
def _translate_io_exception(self, e, path, more_info='',
687
failure_exc=PathError):
436
def _translate_io_exception(self, e, path, more_info='', failure_exc=NoSuchFile):
688
437
"""Translate a paramiko or IOError into a friendlier exception.
690
439
:param e: The original exception
694
443
:param failure_exc: Paramiko has the super fun ability to raise completely
695
444
opaque errors that just set "e.args = ('Failure',)" with
696
445
no more information.
697
If this parameter is set, it defines the exception
698
to raise in these cases.
446
This sometimes means FileExists, but it also sometimes
700
449
# paramiko seems to generate detailless errors.
701
450
self._translate_error(e, path, raise_generic=False)
702
if getattr(e, 'args', None) is not None:
451
if hasattr(e, 'args'):
703
452
if (e.args == ('No such file or directory',) or
704
453
e.args == ('No such file',)):
705
454
raise NoSuchFile(path, str(e) + more_info)
706
if (e.args == ('mkdir failed',) or
707
e.args[0].startswith('syserr: File exists')):
455
if (e.args == ('mkdir failed',)):
708
456
raise FileExists(path, str(e) + more_info)
709
457
# strange but true, for the paramiko server.
710
458
if (e.args == ('Failure',)):
711
459
raise failure_exc(path, str(e) + more_info)
712
# Can be something like args = ('Directory not empty:
713
# '/srv/bazaar.launchpad.net/blah...: '
714
# [Errno 39] Directory not empty',)
715
if (e.args[0].startswith('Directory not empty: ')
716
or getattr(e, 'errno', None) == errno.ENOTEMPTY):
717
raise errors.DirectoryNotEmpty(path, str(e))
718
460
mutter('Raising exception with args %s', e.args)
719
if getattr(e, 'errno', None) is not None:
461
if hasattr(e, 'errno'):
720
462
mutter('Raising exception with errno %s', e.errno)
723
def append_file(self, relpath, f, mode=None):
465
def append(self, relpath, f):
725
467
Append the text in the file-like object into the final
729
471
path = self._remote_path(relpath)
730
fout = self._get_sftp().file(path, 'ab')
732
self._get_sftp().chmod(path, mode)
472
fout = self._sftp.file(path, 'ab')
734
473
self._pump(f, fout)
736
474
except (IOError, paramiko.SSHException), e:
737
475
self._translate_io_exception(e, relpath, ': unable to append')
739
def rename(self, rel_from, rel_to):
740
"""Rename without special overwriting"""
477
def copy(self, rel_from, rel_to):
478
"""Copy the item at rel_from to the location at rel_to"""
479
path_from = self._remote_path(rel_from)
480
path_to = self._remote_path(rel_to)
481
self._copy_abspaths(path_from, path_to)
483
def _copy_abspaths(self, path_from, path_to, mode=None):
484
"""Copy files given an absolute path
486
:param path_from: Path on remote server to read
487
:param path_to: Path on remote server to write
490
TODO: Should the destination location be atomically created?
491
This has not been specified
492
TODO: This should use some sort of remote copy, rather than
493
pulling the data locally, and then writing it remotely
742
self._get_sftp().rename(self._remote_path(rel_from),
743
self._remote_path(rel_to))
496
fin = self._sftp.file(path_from, 'rb')
498
self._put(path_to, fin, mode=mode)
744
501
except (IOError, paramiko.SSHException), e:
745
self._translate_io_exception(e, rel_from,
746
': unable to rename to %r' % (rel_to))
748
def _rename_and_overwrite(self, abs_from, abs_to):
502
self._translate_io_exception(e, path_from, ': unable copy to: %r' % path_to)
504
def copy_to(self, relpaths, other, mode=None, pb=None):
505
"""Copy a set of entries from self into another Transport.
507
:param relpaths: A list/generator of entries to be copied.
509
if isinstance(other, SFTPTransport) and other._sftp is self._sftp:
510
# Both from & to are on the same remote filesystem
511
# We can use a remote copy, instead of pulling locally, and pushing
513
total = self._get_total(relpaths)
515
for path in relpaths:
516
path_from = self._remote_path(relpath)
517
path_to = other._remote_path(relpath)
518
self._update_pb(pb, 'copy-to', count, total)
519
self._copy_abspaths(path_from, path_to, mode=mode)
523
return super(SFTPTransport, self).copy_to(relpaths, other, mode=mode, pb=pb)
525
def _rename(self, abs_from, abs_to):
749
526
"""Do a fancy rename on the remote server.
751
528
Using the implementation provided by osutils.
754
sftp = self._get_sftp()
755
531
fancy_rename(abs_from, abs_to,
756
rename_func=sftp.rename,
757
unlink_func=sftp.remove)
532
rename_func=self._sftp.rename,
533
unlink_func=self._sftp.remove)
758
534
except (IOError, paramiko.SSHException), e:
759
self._translate_io_exception(e, abs_from,
760
': unable to rename to %r' % (abs_to))
535
self._translate_io_exception(e, abs_from, ': unable to rename to %r' % (abs_to))
762
537
def move(self, rel_from, rel_to):
763
538
"""Move the item at rel_from to the location at rel_to"""
764
539
path_from = self._remote_path(rel_from)
765
540
path_to = self._remote_path(rel_to)
766
self._rename_and_overwrite(path_from, path_to)
541
self._rename(path_from, path_to)
768
543
def delete(self, relpath):
769
544
"""Delete the item at relpath"""
770
545
path = self._remote_path(relpath)
772
self._get_sftp().remove(path)
547
self._sftp.remove(path)
773
548
except (IOError, paramiko.SSHException), e:
774
549
self._translate_io_exception(e, path, ': unable to delete')
776
def external_url(self):
777
"""See bzrlib.transport.Transport.external_url."""
778
# the external path for SFTP is the base
781
551
def listable(self):
782
552
"""Return True if this store supports listing."""
862
597
# that we have taken the lock.
863
598
return SFTPLock(relpath, self)
601
def _unparse_url(self, path=None):
604
path = urllib.quote(path)
605
if path.startswith('/'):
606
path = '/%2F' + path[1:]
609
netloc = urllib.quote(self._host)
610
if self._username is not None:
611
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
612
if self._port is not None:
613
netloc = '%s:%d' % (netloc, self._port)
615
return urlparse.urlunparse(('sftp', netloc, path, '', '', ''))
617
def _split_url(self, url):
618
if isinstance(url, unicode):
619
url = url.encode('utf-8')
620
(scheme, netloc, path, params,
621
query, fragment) = urlparse.urlparse(url, allow_fragments=False)
622
assert scheme == 'sftp'
623
username = password = host = port = None
625
username, host = netloc.split('@', 1)
627
username, password = username.split(':', 1)
628
password = urllib.unquote(password)
629
username = urllib.unquote(username)
634
host, port = host.rsplit(':', 1)
638
# TODO: Should this be ConnectionError?
639
raise TransportError('%s: invalid port number' % port)
640
host = urllib.unquote(host)
642
path = urllib.unquote(path)
644
# the initial slash should be removed from the path, and treated
645
# as a homedir relative path (the path begins with a double slash
646
# if it is absolute).
647
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
648
if path.startswith('/'):
651
return (username, password, host, port, path)
653
def _parse_url(self, url):
654
(self._username, self._password,
655
self._host, self._port, self._path) = self._split_url(url)
657
def _sftp_connect(self):
658
"""Connect to the remote sftp server.
659
After this, self._sftp should have a valid connection (or
660
we raise an TransportError 'could not connect').
662
TODO: Raise a more reasonable ConnectionFailed exception
664
global _connected_hosts
666
idx = (self._host, self._port, self._username)
668
self._sftp = _connected_hosts[idx]
673
vendor = _get_ssh_vendor()
675
sock = SFTPSubprocess(self._host, vendor, self._port,
677
self._sftp = SFTPClient(sock)
679
self._paramiko_connect()
681
_connected_hosts[idx] = self._sftp
683
def _paramiko_connect(self):
684
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
689
t = paramiko.Transport((self._host, self._port or 22))
691
except paramiko.SSHException, e:
692
raise ConnectionError('Unable to reach SSH host %s:%d' %
693
(self._host, self._port), e)
695
server_key = t.get_remote_server_key()
696
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
697
keytype = server_key.get_name()
698
if SYSTEM_HOSTKEYS.has_key(self._host) and SYSTEM_HOSTKEYS[self._host].has_key(keytype):
699
our_server_key = SYSTEM_HOSTKEYS[self._host][keytype]
700
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
701
elif BZR_HOSTKEYS.has_key(self._host) and BZR_HOSTKEYS[self._host].has_key(keytype):
702
our_server_key = BZR_HOSTKEYS[self._host][keytype]
703
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
705
warning('Adding %s host key for %s: %s' % (keytype, self._host, server_key_hex))
706
if not BZR_HOSTKEYS.has_key(self._host):
707
BZR_HOSTKEYS[self._host] = {}
708
BZR_HOSTKEYS[self._host][keytype] = server_key
709
our_server_key = server_key
710
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
712
if server_key != our_server_key:
713
filename1 = os.path.expanduser('~/.ssh/known_hosts')
714
filename2 = pathjoin(config_dir(), 'ssh_host_keys')
715
raise TransportError('Host keys for %s do not match! %s != %s' % \
716
(self._host, our_server_key_hex, server_key_hex),
717
['Try editing %s or %s' % (filename1, filename2)])
722
self._sftp = t.open_sftp_client()
723
except paramiko.SSHException, e:
724
raise ConnectionError('Unable to start sftp client %s:%d' %
725
(self._host, self._port), e)
727
def _sftp_auth(self, transport):
728
# paramiko requires a username, but it might be none if nothing was supplied
729
# use the local username, just in case.
730
# We don't override self._username, because if we aren't using paramiko,
731
# the username might be specified in ~/.ssh/config and we don't want to
732
# force it to something else
733
# Also, it would mess up the self.relpath() functionality
734
username = self._username or getpass.getuser()
736
# Paramiko tries to open a socket.AF_UNIX in order to connect
737
# to ssh-agent. That attribute doesn't exist on win32 (it does in cygwin)
738
# so we get an AttributeError exception. For now, just don't try to
739
# connect to an agent if we are on win32
740
if sys.platform != 'win32':
741
agent = paramiko.Agent()
742
for key in agent.get_keys():
743
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
745
transport.auth_publickey(username, key)
747
except paramiko.SSHException, e:
750
# okay, try finding id_rsa or id_dss? (posix only)
751
if self._try_pkey_auth(transport, paramiko.RSAKey, username, 'id_rsa'):
753
if self._try_pkey_auth(transport, paramiko.DSSKey, username, 'id_dsa'):
758
transport.auth_password(username, self._password)
760
except paramiko.SSHException, e:
763
# FIXME: Don't keep a password held in memory if you can help it
764
#self._password = None
766
# give up and ask for a password
767
password = bzrlib.ui.ui_factory.get_password(
768
prompt='SSH %(user)s@%(host)s password',
769
user=username, host=self._host)
771
transport.auth_password(username, password)
772
except paramiko.SSHException, e:
773
raise ConnectionError('Unable to authenticate to SSH host as %s@%s' %
774
(username, self._host), e)
776
def _try_pkey_auth(self, transport, pkey_class, username, filename):
777
filename = os.path.expanduser('~/.ssh/' + filename)
779
key = pkey_class.from_private_key_file(filename)
780
transport.auth_publickey(username, key)
782
except paramiko.PasswordRequiredException:
783
password = bzrlib.ui.ui_factory.get_password(
784
prompt='SSH %(filename)s password',
787
key = pkey_class.from_private_key_file(filename, password)
788
transport.auth_publickey(username, key)
790
except paramiko.SSHException:
791
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
792
except paramiko.SSHException:
793
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
865
798
def _sftp_open_exclusive(self, abspath, mode=None):
866
799
"""Open a remote path exclusively.
876
809
:param abspath: The remote absolute path where the file should be opened
877
810
:param mode: The mode permissions bits for the new file
879
# TODO: jam 20060816 Paramiko >= 1.6.2 (probably earlier) supports
880
# using the 'x' flag to indicate SFTP_FLAG_EXCL.
881
# However, there is no way to set the permission mode at open
882
# time using the sftp_client.file() functionality.
883
path = self._get_sftp()._adjust_cwd(abspath)
884
# mutter('sftp abspath %s => %s', abspath, path)
812
path = self._sftp._adjust_cwd(abspath)
885
813
attr = SFTPAttributes()
886
814
if mode is not None:
887
815
attr.st_mode = mode
888
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
816
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
889
817
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
891
t, msg = self._get_sftp()._request(CMD_OPEN, path, omode, attr)
819
t, msg = self._sftp._request(CMD_OPEN, path, omode, attr)
892
820
if t != CMD_HANDLE:
893
821
raise TransportError('Expected an SFTP handle')
894
822
handle = msg.get_string()
895
return SFTPFile(self._get_sftp(), handle, 'wb', -1)
823
return SFTPFile(self._sftp, handle, 'wb', -1)
896
824
except (paramiko.SSHException, IOError), e:
897
825
self._translate_io_exception(e, abspath, ': unable to open',
898
826
failure_exc=FileExists)
900
def _can_roundtrip_unix_modebits(self):
901
if sys.platform == 'win32':
829
# ------------- server test implementation --------------
833
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
835
STUB_SERVER_KEY = """
836
-----BEGIN RSA PRIVATE KEY-----
837
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
838
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
839
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
840
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
841
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
842
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
843
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
844
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
845
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
846
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
847
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
848
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
849
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
850
-----END RSA PRIVATE KEY-----
854
class SingleListener(threading.Thread):
856
def __init__(self, callback):
857
threading.Thread.__init__(self)
858
self._callback = callback
859
self._socket = socket.socket()
860
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
861
self._socket.bind(('localhost', 0))
862
self._socket.listen(1)
863
self.port = self._socket.getsockname()[1]
864
self.stop_event = threading.Event()
867
s, _ = self._socket.accept()
868
# now close the listen socket
870
self._callback(s, self.stop_event)
873
self.stop_event.set()
874
# We should consider waiting for the other thread
875
# to stop, because otherwise we get spurious
876
# bzr: ERROR: Socket exception: Connection reset by peer (54)
877
# because the test suite finishes before the thread has a chance
878
# to close. (Especially when only running a few tests)
881
class SFTPServer(Server):
882
"""Common code for SFTP server facilities."""
884
def _get_sftp_url(self, path):
885
"""Calculate a sftp url to this server for path."""
886
return 'sftp://foo:bar@localhost:%d/%s' % (self._listener.port, path)
889
self._original_vendor = None
891
self._server_homedir = None
892
self._listener = None
897
def log(self, message):
898
"""What to do here? do we need this? Its for the StubServer.."""
899
self.logs.append(message)
901
def _run_server(self, s, stop_event):
902
ssh_server = paramiko.Transport(s)
903
key_file = os.path.join(self._homedir, 'test_rsa.key')
904
file(key_file, 'w').write(STUB_SERVER_KEY)
905
host_key = paramiko.RSAKey.from_private_key_file(key_file)
906
ssh_server.add_server_key(host_key)
907
server = StubServer(self)
908
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
909
StubSFTPServer, root=self._root,
910
home=self._server_homedir)
911
event = threading.Event()
912
ssh_server.start_server(event, server)
914
stop_event.wait(30.0)
917
"""See bzrlib.transport.Server.setUp."""
918
# XXX: 20051124 jamesh
919
# The tests currently pop up a password prompt when an external ssh
920
# is used. This forces the use of the paramiko implementation.
922
self._original_vendor = _ssh_vendor
924
self._homedir = os.getcwdu()
925
if self._server_homedir is None:
926
self._server_homedir = self._homedir
928
# FIXME WINDOWS: _root should be _server_homedir[0]:/
929
self._listener = SingleListener(self._run_server)
930
self._listener.setDaemon(True)
931
self._listener.start()
934
"""See bzrlib.transport.Server.tearDown."""
936
self._listener.stop()
937
_ssh_vendor = self._original_vendor
940
class SFTPAbsoluteServer(SFTPServer):
941
"""A test server for sftp transports, using absolute urls."""
944
"""See bzrlib.transport.Server.get_url."""
945
return self._get_sftp_url("%%2f%s" %
946
urlescape(self._homedir[1:]))
949
class SFTPHomeDirServer(SFTPServer):
950
"""A test server for sftp transports, using homedir relative urls."""
953
"""See bzrlib.transport.Server.get_url."""
954
return self._get_sftp_url("")
957
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
958
"""A test servere for sftp transports, using absolute urls to non-home."""
961
self._server_homedir = '/dev/noone/runs/tests/here'
962
super(SFTPSiblingAbsoluteServer, self).setUp()
908
965
def get_test_permutations():
909
966
"""Return the permutations to be used in testing."""
910
from bzrlib.tests import stub_sftp
911
return [(SFTPTransport, stub_sftp.SFTPAbsoluteServer),
912
(SFTPTransport, stub_sftp.SFTPHomeDirServer),
913
(SFTPTransport, stub_sftp.SFTPSiblingAbsoluteServer),
967
return [(SFTPTransport, SFTPAbsoluteServer),
968
(SFTPTransport, SFTPHomeDirServer),
969
(SFTPTransport, SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
