1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
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
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,
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')
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,
85
SFTP_OK, CMD_HANDLE, CMD_OPEN)
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
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.
103
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
105
def __init__(self, path, transport):
106
self.lock_file = None
108
self.lock_path = path + '.write-lock'
109
self.transport = transport
111
# RBC 20060103 FIXME should we be using private methods here ?
112
abspath = transport._remote_path(self.lock_path)
113
self.lock_file = transport._sftp_open_exclusive(abspath)
115
raise LockError('File %r already locked' % (self.path,))
118
"""Should this warn, or actually try to cleanup?"""
120
warning("SFTPLock %r not explicitly unlocked" % (self.path,))
124
if not self.lock_file:
126
self.lock_file.close()
127
self.lock_file = None
129
self.transport.delete(self.lock_path)
130
except (NoSuchFile,):
131
# What specific errors should we catch here?
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)
348
def _remote_path(self, relpath):
349
"""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)
401
def has(self, relpath):
403
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')
413
def get(self, relpath):
414
"""Get the file at the given relative path.
416
: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
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):
429
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
435
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.
485
:param relpath: Location to put the contents, relative to base.
486
:param f: File-like object.
487
:param mode: The final mode for the file
489
final_path = self._remote_path(relpath)
490
return self._put(final_path, f, mode=mode)
492
def _put(self, abspath, f, mode=None):
493
"""Helper function so both put() and copy_abspaths can reuse the code"""
494
tmp_abspath = '%s.tmp.%.9f.%d.%d' % (abspath, time.time(),
495
os.getpid(), random.randint(0,0x7FFFFFFF))
496
fout = self._sftp_open_exclusive(tmp_abspath, mode=mode)
500
fout.set_pipelined(True)
501
length = self._pump(f, fout)
502
except (IOError, paramiko.SSHException), e:
503
self._translate_io_exception(e, tmp_abspath)
504
# XXX: This doesn't truly help like we would like it to.
505
# The problem is that openssh strips sticky bits. So while we
506
# can properly set group write permission, we lose the group
507
# sticky bit. So it is probably best to stop chmodding, and
508
# just tell users that they need to set the umask correctly.
509
# The attr.st_mode = mode, in _sftp_open_exclusive
510
# will handle when the user wants the final mode to be more
511
# restrictive. And then we avoid a round trip. Unless
512
# paramiko decides to expose an async chmod()
514
# This is designed to chmod() right before we close.
515
# Because we set_pipelined() earlier, theoretically we might
516
# avoid the round trip for fout.close()
518
self._get_sftp().chmod(tmp_abspath, mode)
521
self._rename_and_overwrite(tmp_abspath, abspath)
524
# If we fail, try to clean up the temporary file
525
# before we throw the exception
526
# but don't let another exception mess things up
527
# Write out the traceback, because otherwise
528
# the catch and throw destroys it
530
mutter(traceback.format_exc())
534
self._get_sftp().remove(tmp_abspath)
536
# raise the saved except
538
# raise the original with its traceback if we can.
541
def _put_non_atomic_helper(self, relpath, writer, mode=None,
542
create_parent_dir=False,
544
abspath = self._remote_path(relpath)
546
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
547
# set the file mode at create time. If it does, use it.
548
# But for now, we just chmod later anyway.
550
def _open_and_write_file():
551
"""Try to open the target file, raise error on failure"""
555
fout = self._get_sftp().file(abspath, mode='wb')
556
fout.set_pipelined(True)
558
except (paramiko.SSHException, IOError), e:
559
self._translate_io_exception(e, abspath,
562
# This is designed to chmod() right before we close.
563
# Because we set_pipelined() earlier, theoretically we might
564
# avoid the round trip for fout.close()
566
self._get_sftp().chmod(abspath, mode)
571
if not create_parent_dir:
572
_open_and_write_file()
575
# Try error handling to create the parent directory if we need to
577
_open_and_write_file()
579
# Try to create the parent directory, and then go back to
581
parent_dir = os.path.dirname(abspath)
582
self._mkdir(parent_dir, dir_mode)
583
_open_and_write_file()
585
def put_file_non_atomic(self, relpath, f, mode=None,
586
create_parent_dir=False,
588
"""Copy the file-like object into the target location.
590
This function is not strictly safe to use. It is only meant to
591
be used when you already know that the target does not exist.
592
It is not safe, because it will open and truncate the remote
593
file. So there may be a time when the file has invalid contents.
595
:param relpath: The remote location to put the contents.
596
:param f: File-like object.
597
:param mode: Possible access permissions for new file.
598
None means do not set remote permissions.
599
:param create_parent_dir: If we cannot create the target file because
600
the parent directory does not exist, go ahead and
601
create it, and then try again.
605
self._put_non_atomic_helper(relpath, writer, mode=mode,
606
create_parent_dir=create_parent_dir,
609
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
610
create_parent_dir=False,
614
self._put_non_atomic_helper(relpath, writer, mode=mode,
615
create_parent_dir=create_parent_dir,
618
def iter_files_recursive(self):
619
"""Walk the relative paths of all files in this transport."""
620
# progress is handled by list_dir
621
queue = list(self.list_dir('.'))
623
relpath = queue.pop(0)
624
st = self.stat(relpath)
625
if stat.S_ISDIR(st.st_mode):
626
for i, basename in enumerate(self.list_dir(relpath)):
627
queue.insert(i, relpath+'/'+basename)
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
def mkdir(self, relpath, mode=None):
661
"""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)
680
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)
686
def _translate_io_exception(self, e, path, more_info='',
687
failure_exc=PathError):
688
"""Translate a paramiko or IOError into a friendlier exception.
690
:param e: The original exception
691
:param path: The path in question when the error is raised
692
:param more_info: Extra information that can be included,
693
such as what was going on
694
:param failure_exc: Paramiko has the super fun ability to raise completely
695
opaque errors that just set "e.args = ('Failure',)" with
697
If this parameter is set, it defines the exception
698
to raise in these cases.
700
# paramiko seems to generate detailless errors.
701
self._translate_error(e, path, raise_generic=False)
702
if getattr(e, 'args', None) is not None:
703
if (e.args == ('No such file or directory',) or
704
e.args == ('No such file',)):
705
raise NoSuchFile(path, str(e) + more_info)
706
if (e.args == ('mkdir failed',) or
707
e.args[0].startswith('syserr: File exists')):
708
raise FileExists(path, str(e) + more_info)
709
# strange but true, for the paramiko server.
710
if (e.args == ('Failure',)):
711
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
mutter('Raising exception with args %s', e.args)
719
if getattr(e, 'errno', None) is not None:
720
mutter('Raising exception with errno %s', e.errno)
723
def append_file(self, relpath, f, mode=None):
725
Append the text in the file-like object into the final
729
path = self._remote_path(relpath)
730
fout = self._get_sftp().file(path, 'ab')
732
self._get_sftp().chmod(path, mode)
736
except (IOError, paramiko.SSHException), e:
737
self._translate_io_exception(e, relpath, ': unable to append')
739
def rename(self, rel_from, rel_to):
740
"""Rename without special overwriting"""
742
self._get_sftp().rename(self._remote_path(rel_from),
743
self._remote_path(rel_to))
744
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):
749
"""Do a fancy rename on the remote server.
751
Using the implementation provided by osutils.
754
sftp = self._get_sftp()
755
fancy_rename(abs_from, abs_to,
756
rename_func=sftp.rename,
757
unlink_func=sftp.remove)
758
except (IOError, paramiko.SSHException), e:
759
self._translate_io_exception(e, abs_from,
760
': unable to rename to %r' % (abs_to))
762
def move(self, rel_from, rel_to):
763
"""Move the item at rel_from to the location at rel_to"""
764
path_from = self._remote_path(rel_from)
765
path_to = self._remote_path(rel_to)
766
self._rename_and_overwrite(path_from, path_to)
768
def delete(self, relpath):
769
"""Delete the item at relpath"""
770
path = self._remote_path(relpath)
772
self._get_sftp().remove(path)
773
except (IOError, paramiko.SSHException), e:
774
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
782
"""Return True if this store supports listing."""
785
def list_dir(self, relpath):
787
Return a list of all files at the given location.
789
# does anything actually use this?
791
# This is at least used by copy_tree for remote upgrades.
792
# -- David Allouche 2006-08-11
793
path = self._remote_path(relpath)
795
entries = self._get_sftp().listdir(path)
796
self._report_activity(sum(map(len, entries)), 'read')
797
except (IOError, paramiko.SSHException), e:
798
self._translate_io_exception(e, path, ': failed to list_dir')
799
return [urlutils.escape(entry) for entry in entries]
801
def rmdir(self, relpath):
802
"""See Transport.rmdir."""
803
path = self._remote_path(relpath)
805
return self._get_sftp().rmdir(path)
806
except (IOError, paramiko.SSHException), e:
807
self._translate_io_exception(e, path, ': failed to rmdir')
809
def stat(self, relpath):
810
"""Return the stat information for a file."""
811
path = self._remote_path(relpath)
813
return self._get_sftp().lstat(path)
814
except (IOError, paramiko.SSHException), e:
815
self._translate_io_exception(e, path, ': unable to stat')
817
def readlink(self, relpath):
818
"""See Transport.readlink."""
819
path = self._remote_path(relpath)
821
return self._get_sftp().readlink(path)
822
except (IOError, paramiko.SSHException), e:
823
self._translate_io_exception(e, path, ': unable to readlink')
825
def symlink(self, source, link_name):
826
"""See Transport.symlink."""
828
conn = self._get_sftp()
829
sftp_retval = conn.symlink(source, link_name)
830
if SFTP_OK != sftp_retval:
831
raise TransportError(
832
'%r: unable to create symlink to %r' % (link_name, source),
835
except (IOError, paramiko.SSHException), e:
836
self._translate_io_exception(e, link_name,
837
': unable to create symlink to %r' % (source))
839
def lock_read(self, relpath):
841
Lock the given file for shared (read) access.
842
:return: A lock object, which has an unlock() member function
844
# FIXME: there should be something clever i can do here...
845
class BogusLock(object):
846
def __init__(self, path):
850
return BogusLock(relpath)
852
def lock_write(self, relpath):
854
Lock the given file for exclusive (write) access.
855
WARNING: many transports do not support this, so trying avoid using it
857
:return: A lock object, which has an unlock() member function
859
# This is a little bit bogus, but basically, we create a file
860
# which should not already exist, and if it does, we assume
861
# that there is a lock, and if it doesn't, the we assume
862
# that we have taken the lock.
863
return SFTPLock(relpath, self)
865
def _sftp_open_exclusive(self, abspath, mode=None):
866
"""Open a remote path exclusively.
868
SFTP supports O_EXCL (SFTP_FLAG_EXCL), which fails if
869
the file already exists. However it does not expose this
870
at the higher level of SFTPClient.open(), so we have to
873
WARNING: This breaks the SFTPClient abstraction, so it
874
could easily break against an updated version of paramiko.
876
:param abspath: The remote absolute path where the file should be opened
877
: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)
885
attr = SFTPAttributes()
888
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
889
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
891
t, msg = self._get_sftp()._request(CMD_OPEN, path, omode, attr)
893
raise TransportError('Expected an SFTP handle')
894
handle = msg.get_string()
895
return SFTPFile(self._get_sftp(), handle, 'wb', -1)
896
except (paramiko.SSHException, IOError), e:
897
self._translate_io_exception(e, abspath, ': unable to open',
898
failure_exc=FileExists)
900
def _can_roundtrip_unix_modebits(self):
901
if sys.platform == 'win32':
908
def get_test_permutations():
909
"""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),
1
# Copyright (C) 2005 Robey Pointer <robey@lag.net>, Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Implementation of Transport over SFTP, using paramiko."""
26
from bzrlib.errors import TransportNotPossible, NoSuchFile, NonRelativePath, TransportError
27
from bzrlib.config import config_dir
28
from bzrlib.trace import mutter, warning, error
29
from bzrlib.transport import Transport, register_transport
34
error('The SFTP transport requires paramiko.')
43
Load system host keys (probably doesn't work on windows) and any
44
"discovered" keys from previous sessions.
46
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
48
SYSTEM_HOSTKEYS = paramiko.util.load_host_keys(os.path.expanduser('~/.ssh/known_hosts'))
50
mutter('failed to load system host keys: ' + str(e))
51
bzr_hostkey_path = os.path.join(config_dir(), 'ssh_host_keys')
53
BZR_HOSTKEYS = paramiko.util.load_host_keys(bzr_hostkey_path)
55
mutter('failed to load bzr host keys: ' + str(e))
60
Save "discovered" host keys in $(config)/ssh_host_keys/.
62
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
63
bzr_hostkey_path = os.path.join(config_dir(), 'ssh_host_keys')
64
if not os.path.isdir(config_dir()):
65
os.mkdir(config_dir())
67
f = open(bzr_hostkey_path, 'w')
68
f.write('# SSH host keys collected by bzr\n')
69
for hostname, keys in BZR_HOSTKEYS.iteritems():
70
for keytype, key in keys.iteritems():
71
f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
74
mutter('failed to save bzr host keys: ' + str(e))
78
class SFTPTransportError (TransportError):
82
class SFTPTransport (Transport):
84
Transport implementation for SFTP access.
87
_url_matcher = re.compile(r'^sftp://([^@]*@)?(.*?)(:\d+)?(/.*)?$')
89
def __init__(self, base, clone_from=None):
90
assert base.startswith('sftp://')
91
super(SFTPTransport, self).__init__(base)
93
if clone_from is None:
96
# use the same ssh connection, etc
97
self._sftp = clone_from._sftp
98
# super saves 'self.base'
100
def should_cache(self):
102
Return True if the data pulled across should be cached locally.
106
def clone(self, offset=None):
108
Return a new SFTPTransport with root at self.base + offset.
109
We share the same SFTP session between such transports, because it's
110
fairly expensive to set them up.
113
return SFTPTransport(self.base, self)
115
return SFTPTransport(self.abspath(offset), self)
117
def abspath(self, relpath):
119
Return the full url to the given relative path.
121
@param relpath: the relative path or path components
122
@type relpath: str or list
124
return self._unparse_url(self._abspath(relpath))
126
def _abspath(self, relpath):
127
"""Return the absolute path segment without the SFTP URL."""
128
# FIXME: share the common code across transports
129
assert isinstance(relpath, basestring)
130
relpath = [urllib.unquote(relpath)]
131
basepath = self._path.split('/')
132
if len(basepath) > 0 and basepath[-1] == '':
133
basepath = basepath[:-1]
137
if len(basepath) == 0:
138
# In most filesystems, a request for the parent
139
# of root, just returns root.
147
path = '/'.join(basepath)
152
def relpath(self, abspath):
153
# FIXME: this is identical to HttpTransport -- share it
154
if not abspath.startswith(self.base):
155
raise NonRelativePath('path %r is not under base URL %r'
156
% (abspath, self.base))
158
return abspath[pl:].lstrip('/')
160
def has(self, relpath):
162
Does the target location exist?
165
self._sftp.stat(self._abspath(relpath))
170
def get(self, relpath, decode=False):
172
Get the file at the given relative path.
174
:param relpath: The relative path to the file
177
path = self._abspath(relpath)
178
return self._sftp.file(path)
179
except (IOError, paramiko.SSHException), x:
180
raise NoSuchFile('Error retrieving %s: %s' % (path, str(x)), x)
182
def get_partial(self, relpath, start, length=None):
184
Get just part of a file.
186
:param relpath: Path to the file, relative to base
187
:param start: The starting position to read from
188
:param length: The length to read. A length of None indicates
189
read to the end of the file.
190
:return: A file-like object containing at least the specified bytes.
191
Some implementations may return objects which can be read
192
past this length, but this is not guaranteed.
194
f = self.get(relpath)
198
def put(self, relpath, f):
200
Copy the file-like or string object into the location.
202
:param relpath: Location to put the contents, relative to base.
203
:param f: File-like or string object.
205
# FIXME: should do something atomic or locking here, this is unsafe
207
path = self._abspath(relpath)
208
fout = self._sftp.file(path, 'wb')
209
except (IOError, paramiko.SSHException), x:
210
raise SFTPTransportError('Unable to write file %r' % (path,), x)
216
def iter_files_recursive(self):
217
"""Walk the relative paths of all files in this transport."""
218
queue = list(self.list_dir('.'))
220
relpath = urllib.quote(queue.pop(0))
221
st = self.stat(relpath)
222
if stat.S_ISDIR(st.st_mode):
223
for i, basename in enumerate(self.list_dir(relpath)):
224
queue.insert(i, relpath+'/'+basename)
228
def mkdir(self, relpath):
229
"""Create a directory at the given path."""
231
path = self._abspath(relpath)
232
self._sftp.mkdir(path)
233
except (IOError, paramiko.SSHException), x:
234
raise SFTPTransportError('Unable to mkdir %r' % (path,), x)
236
def append(self, relpath, f):
238
Append the text in the file-like object into the final
242
path = self._abspath(relpath)
243
fout = self._sftp.file(path, 'ab')
245
except (IOError, paramiko.SSHException), x:
246
raise SFTPTransportError('Unable to append file %r' % (path,), x)
248
def copy(self, rel_from, rel_to):
249
"""Copy the item at rel_from to the location at rel_to"""
250
path_from = self._abspath(rel_from)
251
path_to = self._abspath(rel_to)
253
fin = self._sftp.file(path_from, 'rb')
255
fout = self._sftp.file(path_to, 'wb')
257
fout.set_pipelined(True)
258
self._pump(fin, fout)
263
except (IOError, paramiko.SSHException), x:
264
raise SFTPTransportError('Unable to copy %r to %r' % (path_from, path_to), x)
266
def move(self, rel_from, rel_to):
267
"""Move the item at rel_from to the location at rel_to"""
268
path_from = self._abspath(rel_from)
269
path_to = self._abspath(rel_to)
271
self._sftp.rename(path_from, path_to)
272
except (IOError, paramiko.SSHException), x:
273
raise SFTPTransportError('Unable to move %r to %r' % (path_from, path_to), x)
275
def delete(self, relpath):
276
"""Delete the item at relpath"""
277
path = self._abspath(relpath)
279
self._sftp.remove(path)
280
except (IOError, paramiko.SSHException), x:
281
raise SFTPTransportError('Unable to delete %r' % (path,), x)
284
"""Return True if this store supports listing."""
287
def list_dir(self, relpath):
289
Return a list of all files at the given location.
291
# does anything actually use this?
292
path = self._abspath(relpath)
294
return self._sftp.listdir(path)
295
except (IOError, paramiko.SSHException), x:
296
raise SFTPTransportError('Unable to list folder %r' % (path,), x)
298
def stat(self, relpath):
299
"""Return the stat information for a file."""
300
path = self._abspath(relpath)
302
return self._sftp.stat(path)
303
except (IOError, paramiko.SSHException), x:
304
raise SFTPTransportError('Unable to stat %r' % (path,), x)
306
def lock_read(self, relpath):
308
Lock the given file for shared (read) access.
309
:return: A lock object, which should be passed to Transport.unlock()
311
# FIXME: there should be something clever i can do here...
312
class BogusLock(object):
313
def __init__(self, path):
317
return BogusLock(relpath)
319
def lock_write(self, relpath):
321
Lock the given file for exclusive (write) access.
322
WARNING: many transports do not support this, so trying avoid using it
324
:return: A lock object, which should be passed to Transport.unlock()
326
# FIXME: there should be something clever i can do here...
327
class BogusLock(object):
328
def __init__(self, path):
332
return BogusLock(relpath)
335
def _unparse_url(self, path=None):
339
return 'sftp://%s@%s%s' % (self._username, self._host, path)
340
return 'sftp://%s@%s:%d%s' % (self._username, self._host, self._port, path)
342
def _parse_url(self, url):
343
assert url[:7] == 'sftp://'
344
m = self._url_matcher.match(url)
346
raise SFTPTransportError('Unable to parse SFTP URL %r' % (url,))
347
self._username, self._host, self._port, self._path = m.groups()
348
if self._username is None:
349
self._username = getpass.getuser()
351
self._username = self._username[:-1]
352
if self._port is None:
355
self._port = int(self._port[1:])
356
if (self._path is None) or (self._path == ''):
359
def _sftp_connect(self):
360
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
365
t = paramiko.Transport((self._host, self._port))
367
except paramiko.SSHException:
368
raise SFTPTransportError('Unable to reach SSH host %s:%d' % (self._host, self._port))
370
server_key = t.get_remote_server_key()
371
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
372
keytype = server_key.get_name()
373
if SYSTEM_HOSTKEYS.has_key(self._host) and SYSTEM_HOSTKEYS[self._host].has_key(keytype):
374
our_server_key = SYSTEM_HOSTKEYS[self._host][keytype]
375
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
376
elif BZR_HOSTKEYS.has_key(self._host) and BZR_HOSTKEYS[self._host].has_key(keytype):
377
our_server_key = BZR_HOSTKEYS[self._host][keytype]
378
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
380
warning('Adding %s host key for %s: %s' % (keytype, self._host, server_key_hex))
381
if not BZR_HOSTKEYS.has_key(self._host):
382
BZR_HOSTKEYS[self._host] = {}
383
BZR_HOSTKEYS[self._host][keytype] = server_key
384
our_server_key = server_key
385
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
387
if server_key != our_server_key:
388
filename1 = os.path.expanduser('~/.ssh/known_hosts')
389
filename2 = os.path.join(config_dir(), 'ssh_host_keys')
390
raise SFTPTransportError('Host keys for %s do not match! %s != %s' % \
391
(self._host, our_server_key_hex, server_key_hex),
392
['Try editing %s or %s' % (filename1, filename2)])
394
self._sftp_auth(t, self._username, self._host)
397
self._sftp = t.open_sftp_client()
398
except paramiko.SSHException:
399
raise BzrError('Unable to find path %s on SFTP server %s' % \
400
(self._path, self._host))
402
def _sftp_auth(self, transport, username, host):
403
agent = paramiko.Agent()
404
for key in agent.get_keys():
405
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
407
transport.auth_publickey(self._username, key)
409
except paramiko.SSHException, e:
412
# okay, try finding id_rsa or id_dss? (posix only)
413
if self._try_pkey_auth(transport, paramiko.RSAKey, 'id_rsa'):
415
if self._try_pkey_auth(transport, paramiko.DSSKey, 'id_dsa'):
418
# give up and ask for a password
419
password = getpass.getpass('SSH %s@%s password: ' % (self._username, self._host))
421
transport.auth_password(self._username, password)
422
except paramiko.SSHException:
423
raise SFTPTransportError('Unable to authenticate to SSH host as %s@%s' % \
424
(self._username, self._host))
426
def _try_pkey_auth(self, transport, pkey_class, filename):
427
filename = os.path.expanduser('~/.ssh/' + filename)
429
key = pkey_class.from_private_key_file(filename)
430
transport.auth_publickey(self._username, key)
432
except paramiko.PasswordRequiredException:
433
password = getpass.getpass('SSH %s password: ' % (os.path.basename(filename),))
435
key = pkey_class.from_private_key_file(filename, password)
436
transport.auth_publickey(self._username, key)
438
except paramiko.SSHException:
439
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
440
except paramiko.SSHException:
441
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
added
removed
bzrlib/transport/sftp.py
