1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
1
# Copyright (C) 2005 Robey Pointer <robey@lag.net>
2
# Copyright (C) 2005, 2006 Canonical Ltd
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
5
6
# the Free Software Foundation; either version 2 of the License, or
6
7
# (at your option) any later version.
8
9
# This program is distributed in the hope that it will be useful,
9
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
12
# GNU General Public License for more details.
13
14
# You should have received a copy of the GNU General Public License
14
15
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
18
"""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.
46
from bzrlib.errors import (FileExists,
47
NoSuchFile, PathNotChild,
35
from bzrlib.config import config_dir, ensure_config_dir_exists
36
from bzrlib.errors import (ConnectionError,
38
TransportNotPossible, NoSuchFile, PathNotChild,
51
42
ParamikoNotPresent,
53
from bzrlib.osutils import pathjoin, fancy_rename, getcwd
54
from bzrlib.symbol_versioning import (
57
from bzrlib.trace import mutter, warning
44
from bzrlib.osutils import pathjoin, fancy_rename
45
from bzrlib.trace import mutter, warning, error
58
46
from bzrlib.transport import (
47
register_urlparse_netloc_protocol,
67
# Disable one particular warning that comes from paramiko in Python2.5; if
68
# this is emitted at the wrong time it tends to cause spurious test failures
69
# or at least noise in the test case::
71
# [1770/7639 in 86s, 1 known failures, 50 skipped, 2 missing features]
72
# test_permissions.TestSftpPermissions.test_new_files
73
# /var/lib/python-support/python2.5/paramiko/message.py:226: DeprecationWarning: integer argument expected, got float
74
# self.packet.write(struct.pack('>I', n))
75
warnings.filterwarnings('ignore',
76
'integer argument expected, got float',
77
category=DeprecationWarning,
78
module='paramiko.message')
53
import bzrlib.urlutils as urlutils
87
62
CMD_HANDLE, CMD_OPEN)
88
63
from paramiko.sftp_attr import SFTPAttributes
89
64
from paramiko.sftp_file import SFTPFile
92
_paramiko_version = getattr(paramiko, '__version_info__', (0, 0, 0))
93
# don't use prefetch unless paramiko version >= 1.5.5 (there were bugs earlier)
94
_default_do_prefetch = (_paramiko_version >= (1, 5, 5))
65
from paramiko.sftp_client import SFTPClient
68
register_urlparse_netloc_protocol('sftp')
72
# TODO: This should possibly ignore SIGHUP as well, but bzr currently
73
# doesn't handle it itself.
74
# <https://launchpad.net/products/bzr/+bug/41433/+index>
76
signal.signal(signal.SIGINT, signal.SIG_IGN)
79
def os_specific_subprocess_params():
80
"""Get O/S specific subprocess parameters."""
81
if sys.platform == 'win32':
82
# setting the process group and closing fds is not supported on
86
# We close fds other than the pipes as the child process does not need
89
# We also set the child process to ignore SIGINT. Normally the signal
90
# would be sent to every process in the foreground process group, but
91
# this causes it to be seen only by bzr and not by ssh. Python will
92
# generate a KeyboardInterrupt in bzr, and we will then have a chance
93
# to release locks or do other cleanup over ssh before the connection
95
# <https://launchpad.net/products/bzr/+bug/5987>
97
# Running it in a separate process group is not good because then it
98
# can't get non-echoed input of a password or passphrase.
99
# <https://launchpad.net/products/bzr/+bug/40508>
100
return {'preexec_fn': _ignore_sigint,
105
# don't use prefetch unless paramiko version >= 1.5.2 (there were bugs earlier)
106
_default_do_prefetch = False
107
if getattr(paramiko, '__version_info__', (0, 0, 0)) >= (1, 5, 5):
108
_default_do_prefetch = True
112
def _get_ssh_vendor():
113
"""Find out what version of SSH is on the system."""
115
if _ssh_vendor is not None:
120
if 'BZR_SSH' in os.environ:
121
_ssh_vendor = os.environ['BZR_SSH']
122
if _ssh_vendor == 'paramiko':
127
p = subprocess.Popen(['ssh', '-V'],
128
stdin=subprocess.PIPE,
129
stdout=subprocess.PIPE,
130
stderr=subprocess.PIPE,
131
**os_specific_subprocess_params())
132
returncode = p.returncode
133
stdout, stderr = p.communicate()
137
if 'OpenSSH' in stderr:
138
mutter('ssh implementation is OpenSSH')
139
_ssh_vendor = 'openssh'
140
elif 'SSH Secure Shell' in stderr:
141
mutter('ssh implementation is SSH Corp.')
144
if _ssh_vendor != 'none':
147
# XXX: 20051123 jamesh
148
# A check for putty's plink or lsh would go here.
150
mutter('falling back to paramiko implementation')
154
class SFTPSubprocess:
155
"""A socket-like object that talks to an ssh subprocess via pipes."""
156
def __init__(self, hostname, vendor, port=None, user=None):
157
assert vendor in ['openssh', 'ssh']
158
if vendor == 'openssh':
160
'-oForwardX11=no', '-oForwardAgent=no',
161
'-oClearAllForwardings=yes', '-oProtocol=2',
162
'-oNoHostAuthenticationForLocalhost=yes']
164
args.extend(['-p', str(port)])
166
args.extend(['-l', user])
167
args.extend(['-s', hostname, 'sftp'])
168
elif vendor == 'ssh':
171
args.extend(['-p', str(port)])
173
args.extend(['-l', user])
174
args.extend(['-s', 'sftp', hostname])
176
self.proc = subprocess.Popen(args,
177
stdin=subprocess.PIPE,
178
stdout=subprocess.PIPE,
179
**os_specific_subprocess_params())
181
def send(self, data):
182
return os.write(self.proc.stdin.fileno(), data)
184
def recv_ready(self):
185
# TODO: jam 20051215 this function is necessary to support the
186
# pipelined() function. In reality, it probably should use
187
# poll() or select() to actually return if there is data
188
# available, otherwise we probably don't get any benefit
191
def recv(self, count):
192
return os.read(self.proc.stdout.fileno(), count)
195
self.proc.stdin.close()
196
self.proc.stdout.close()
200
class LoopbackSFTP(object):
201
"""Simple wrapper for a socket that pretends to be a paramiko Channel."""
203
def __init__(self, sock):
206
def send(self, data):
207
return self.__socket.send(data)
210
return self.__socket.recv(n)
212
def recv_ready(self):
216
self.__socket.close()
222
# This is a weakref dictionary, so that we can reuse connections
223
# that are still active. Long term, it might be nice to have some
224
# sort of expiration policy, such as disconnect if inactive for
225
# X seconds. But that requires a lot more fanciness.
226
_connected_hosts = weakref.WeakValueDictionary()
228
def clear_connection_cache():
229
"""Remove all hosts from the SFTP connection cache.
231
Primarily useful for test cases wanting to force garbage collection.
233
_connected_hosts.clear()
236
def load_host_keys():
238
Load system host keys (probably doesn't work on windows) and any
239
"discovered" keys from previous sessions.
241
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
243
SYSTEM_HOSTKEYS = paramiko.util.load_host_keys(os.path.expanduser('~/.ssh/known_hosts'))
245
mutter('failed to load system host keys: ' + str(e))
246
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
248
BZR_HOSTKEYS = paramiko.util.load_host_keys(bzr_hostkey_path)
250
mutter('failed to load bzr host keys: ' + str(e))
254
def save_host_keys():
256
Save "discovered" host keys in $(config)/ssh_host_keys/.
258
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
259
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
260
ensure_config_dir_exists()
263
f = open(bzr_hostkey_path, 'w')
264
f.write('# SSH host keys collected by bzr\n')
265
for hostname, keys in BZR_HOSTKEYS.iteritems():
266
for keytype, key in keys.iteritems():
267
f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
270
mutter('failed to save bzr host keys: ' + str(e))
97
273
class SFTPLock(object):
98
"""This fakes a lock in a remote location.
100
A present lock is indicated just by the existence of a file. This
101
doesn't work well on all transports and they are only used in
102
deprecated storage formats.
274
"""This fakes a lock in a remote location."""
105
275
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
107
276
def __init__(self, path, transport):
277
assert isinstance(transport, SFTPTransport)
108
279
self.lock_file = None
110
281
self.lock_path = path + '.write-lock'
137
class _SFTPReadvHelper(object):
138
"""A class to help with managing the state of a readv request."""
140
# See _get_requests for an explanation.
141
_max_request_size = 32768
143
def __init__(self, original_offsets, relpath, _report_activity):
144
"""Create a new readv helper.
146
:param original_offsets: The original requests given by the caller of
148
:param relpath: The name of the file (if known)
149
:param _report_activity: A Transport._report_activity bound method,
150
to be called as data arrives.
152
self.original_offsets = list(original_offsets)
153
self.relpath = relpath
154
self._report_activity = _report_activity
156
def _get_requests(self):
157
"""Break up the offsets into individual requests over sftp.
159
The SFTP spec only requires implementers to support 32kB requests. We
160
could try something larger (openssh supports 64kB), but then we have to
161
handle requests that fail.
162
So instead, we just break up our maximum chunks into 32kB chunks, and
163
asyncronously requests them.
164
Newer versions of paramiko would do the chunking for us, but we want to
165
start processing results right away, so we do it ourselves.
167
# TODO: Because we issue async requests, we don't 'fudge' any extra
168
# data. I'm not 100% sure that is the best choice.
170
# The first thing we do, is to collapse the individual requests as much
171
# as possible, so we don't issues requests <32kB
172
sorted_offsets = sorted(self.original_offsets)
173
coalesced = list(ConnectedTransport._coalesce_offsets(sorted_offsets,
174
limit=0, fudge_factor=0))
176
for c_offset in coalesced:
177
start = c_offset.start
178
size = c_offset.length
180
# Break this up into 32kB requests
182
next_size = min(size, self._max_request_size)
183
requests.append((start, next_size))
186
if 'sftp' in debug.debug_flags:
187
mutter('SFTP.readv(%s) %s offsets => %s coalesced => %s requests',
188
self.relpath, len(sorted_offsets), len(coalesced),
192
def request_and_yield_offsets(self, fp):
193
"""Request the data from the remote machine, yielding the results.
195
:param fp: A Paramiko SFTPFile object that supports readv.
196
:return: Yield the data requested by the original readv caller, one by
199
requests = self._get_requests()
200
offset_iter = iter(self.original_offsets)
201
cur_offset, cur_size = offset_iter.next()
202
# paramiko .readv() yields strings that are in the order of the requests
203
# So we track the current request to know where the next data is
204
# being returned from.
210
# This is used to buffer chunks which we couldn't process yet
211
# It is (start, end, data) tuples.
213
# Create an 'unlimited' data stream, so we stop based on requests,
214
# rather than just because the data stream ended. This lets us detect
216
data_stream = itertools.chain(fp.readv(requests),
217
itertools.repeat(None))
218
for (start, length), data in itertools.izip(requests, data_stream):
220
if cur_coalesced is not None:
221
raise errors.ShortReadvError(self.relpath,
222
start, length, len(data))
223
if len(data) != length:
224
raise errors.ShortReadvError(self.relpath,
225
start, length, len(data))
226
self._report_activity(length, 'read')
228
# This is the first request, just buffer it
229
buffered_data = [data]
230
buffered_len = length
232
elif start == last_end:
233
# The data we are reading fits neatly on the previous
234
# buffer, so this is all part of a larger coalesced range.
235
buffered_data.append(data)
236
buffered_len += length
238
# We have an 'interrupt' in the data stream. So we know we are
239
# at a request boundary.
241
# We haven't consumed the buffer so far, so put it into
242
# data_chunks, and continue.
243
buffered = ''.join(buffered_data)
244
data_chunks.append((input_start, buffered))
246
buffered_data = [data]
247
buffered_len = length
248
last_end = start + length
249
if input_start == cur_offset and cur_size <= buffered_len:
250
# Simplify the next steps a bit by transforming buffered_data
251
# into a single string. We also have the nice property that
252
# when there is only one string ''.join([x]) == x, so there is
254
buffered = ''.join(buffered_data)
255
# Clean out buffered data so that we keep memory
259
# TODO: We *could* also consider the case where cur_offset is in
260
# in the buffered range, even though it doesn't *start*
261
# the buffered range. But for packs we pretty much always
262
# read in order, so you won't get any extra data in the
264
while (input_start == cur_offset
265
and (buffered_offset + cur_size) <= buffered_len):
266
# We've buffered enough data to process this request, spit it
268
cur_data = buffered[buffered_offset:buffered_offset + cur_size]
269
# move the direct pointer into our buffered data
270
buffered_offset += cur_size
271
# Move the start-of-buffer pointer
272
input_start += cur_size
273
# Yield the requested data
274
yield cur_offset, cur_data
275
cur_offset, cur_size = offset_iter.next()
276
# at this point, we've consumed as much of buffered as we can,
277
# so break off the portion that we consumed
278
if buffered_offset == len(buffered_data):
279
# No tail to leave behind
283
buffered = buffered[buffered_offset:]
284
buffered_data = [buffered]
285
buffered_len = len(buffered)
287
buffered = ''.join(buffered_data)
289
data_chunks.append((input_start, buffered))
291
if 'sftp' in debug.debug_flags:
292
mutter('SFTP readv left with %d out-of-order bytes',
293
sum(map(lambda x: len(x[1]), data_chunks)))
294
# We've processed all the readv data, at this point, anything we
295
# couldn't process is in data_chunks. This doesn't happen often, so
296
# this code path isn't optimized
297
# We use an interesting process for data_chunks
298
# Specifically if we have "bisect_left([(start, len, entries)],
300
# If start == qstart, then we get the specific node. Otherwise we
301
# get the previous node
303
idx = bisect.bisect_left(data_chunks, (cur_offset,))
304
if idx < len(data_chunks) and data_chunks[idx][0] == cur_offset:
305
# The data starts here
306
data = data_chunks[idx][1][:cur_size]
308
# The data is in a portion of a previous page
310
sub_offset = cur_offset - data_chunks[idx][0]
311
data = data_chunks[idx][1]
312
data = data[sub_offset:sub_offset + cur_size]
314
# We are missing the page where the data should be found,
317
if len(data) != cur_size:
318
raise AssertionError('We must have miscalulated.'
319
' We expected %d bytes, but only found %d'
320
% (cur_size, len(data)))
321
yield cur_offset, data
322
cur_offset, cur_size = offset_iter.next()
325
class SFTPTransport(ConnectedTransport):
326
"""Transport implementation for SFTP access."""
308
class SFTPTransport (Transport):
310
Transport implementation for SFTP access.
328
312
_do_prefetch = _default_do_prefetch
329
# TODO: jam 20060717 Conceivably these could be configurable, either
330
# by auto-tuning at run-time, or by a configuration (per host??)
331
# but the performance curve is pretty flat, so just going with
332
# reasonable defaults.
333
_max_readv_combine = 200
334
# Having to round trip to the server means waiting for a response,
335
# so it is better to download extra bytes.
336
# 8KiB had good performance for both local and remote network operations
337
_bytes_to_read_before_seek = 8192
339
# The sftp spec says that implementations SHOULD allow reads
340
# to be at least 32K. paramiko.readv() does an async request
341
# for the chunks. So we need to keep it within a single request
342
# size for paramiko <= 1.6.1. paramiko 1.6.2 will probably chop
343
# up the request itself, rather than us having to worry about it
344
_max_request_size = 32768
346
def __init__(self, base, _from_transport=None):
347
super(SFTPTransport, self).__init__(base,
348
_from_transport=_from_transport)
314
def __init__(self, base, clone_from=None):
315
assert base.startswith('sftp://')
316
self._parse_url(base)
317
base = self._unparse_url()
320
super(SFTPTransport, self).__init__(base)
321
if clone_from is None:
324
# use the same ssh connection, etc
325
self._sftp = clone_from._sftp
326
# super saves 'self.base'
328
def should_cache(self):
330
Return True if the data pulled across should be cached locally.
334
def clone(self, offset=None):
336
Return a new SFTPTransport with root at self.base + offset.
337
We share the same SFTP session between such transports, because it's
338
fairly expensive to set them up.
341
return SFTPTransport(self.base, self)
343
return SFTPTransport(self.abspath(offset), self)
345
def abspath(self, relpath):
347
Return the full url to the given relative path.
349
@param relpath: the relative path or path components
350
@type relpath: str or list
352
return self._unparse_url(self._remote_path(relpath))
350
354
def _remote_path(self, relpath):
351
355
"""Return the path to be passed along the sftp protocol for relpath.
353
:param relpath: is a urlencoded string.
355
relative = urlutils.unescape(relpath).encode('utf-8')
356
remote_path = self._combine_paths(self._path, relative)
357
# the initial slash should be removed from the path, and treated as a
358
# homedir relative path (the path begins with a double slash if it is
359
# absolute). see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
360
# RBC 20060118 we are not using this as its too user hostile. instead
361
# we are following lftp and using /~/foo to mean '~/foo'
362
# vila--20070602 and leave absolute paths begin with a single slash.
363
if remote_path.startswith('/~/'):
364
remote_path = remote_path[3:]
365
elif remote_path == '/~':
369
def _create_connection(self, credentials=None):
370
"""Create a new connection with the provided credentials.
372
:param credentials: The credentials needed to establish the connection.
374
:return: The created connection and its associated credentials.
376
The credentials are only the password as it may have been entered
377
interactively by the user and may be different from the one provided
378
in base url at transport creation time.
380
if credentials is None:
381
password = self._password
383
password = credentials
385
vendor = ssh._get_ssh_vendor()
388
auth = config.AuthenticationConfig()
389
user = auth.get_user('ssh', self._host, self._port)
390
connection = vendor.connect_sftp(self._user, password,
391
self._host, self._port)
392
return connection, (user, password)
395
"""Ensures that a connection is established"""
396
connection = self._get_connection()
397
if connection is None:
398
# First connection ever
399
connection, credentials = self._create_connection()
400
self._set_connection(connection, credentials)
357
relpath is a urlencoded string.
359
# FIXME: share the common code across transports
360
assert isinstance(relpath, basestring)
361
relpath = urlutils.unescape(relpath).split('/')
362
basepath = self._path.split('/')
363
if len(basepath) > 0 and basepath[-1] == '':
364
basepath = basepath[:-1]
368
if len(basepath) == 0:
369
# In most filesystems, a request for the parent
370
# of root, just returns root.
378
path = '/'.join(basepath)
381
def relpath(self, abspath):
382
username, password, host, port, path = self._split_url(abspath)
384
if (username != self._username):
385
error.append('username mismatch')
386
if (host != self._host):
387
error.append('host mismatch')
388
if (port != self._port):
389
error.append('port mismatch')
390
if (not path.startswith(self._path)):
391
error.append('path mismatch')
393
extra = ': ' + ', '.join(error)
394
raise PathNotChild(abspath, self.base, extra=extra)
396
return path[pl:].strip('/')
403
398
def has(self, relpath):
405
400
Does the target location exist?
408
self._get_sftp().stat(self._remote_path(relpath))
409
# stat result is about 20 bytes, let's say
410
self._report_activity(20, 'read')
403
self._sftp.stat(self._remote_path(relpath))
415
408
def get(self, relpath):
416
"""Get the file at the given relative path.
410
Get the file at the given relative path.
418
412
:param relpath: The relative path to the file
421
# FIXME: by returning the file directly, we don't pass this
422
# through to report_activity. We could try wrapping the object
423
# before it's returned. For readv and get_bytes it's handled in
424
# the higher-level function.
426
415
path = self._remote_path(relpath)
427
f = self._get_sftp().file(path, mode='rb')
416
f = self._sftp.file(path, mode='rb')
428
417
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
431
420
except (IOError, paramiko.SSHException), e:
432
self._translate_io_exception(e, path, ': error retrieving',
433
failure_exc=errors.ReadError)
435
def get_bytes(self, relpath):
436
# reimplement this here so that we can report how many bytes came back
421
self._translate_io_exception(e, path, ': error retrieving')
423
def get_partial(self, relpath, start, length=None):
425
Get just part of a file.
427
:param relpath: Path to the file, relative to base
428
:param start: The starting position to read from
429
:param length: The length to read. A length of None indicates
430
read to the end of the file.
431
:return: A file-like object containing at least the specified bytes.
432
Some implementations may return objects which can be read
433
past this length, but this is not guaranteed.
435
# TODO: implement get_partial_multi to help with knit support
437
436
f = self.get(relpath)
440
self._report_activity(len(bytes), 'read')
445
def _readv(self, relpath, offsets):
446
"""See Transport.readv()"""
447
# We overload the default readv() because we want to use a file
448
# that does not have prefetch enabled.
449
# Also, if we have a new paramiko, it implements an async readv()
454
path = self._remote_path(relpath)
455
fp = self._get_sftp().file(path, mode='rb')
456
readv = getattr(fp, 'readv', None)
458
return self._sftp_readv(fp, offsets, relpath)
459
if 'sftp' in debug.debug_flags:
460
mutter('seek and read %s offsets', len(offsets))
461
return self._seek_and_read(fp, offsets, relpath)
462
except (IOError, paramiko.SSHException), e:
463
self._translate_io_exception(e, path, ': error retrieving')
465
def recommended_page_size(self):
466
"""See Transport.recommended_page_size().
468
For SFTP we suggest a large page size to reduce the overhead
469
introduced by latency.
473
def _sftp_readv(self, fp, offsets, relpath):
474
"""Use the readv() member of fp to do async readv.
476
Then read them using paramiko.readv(). paramiko.readv()
477
does not support ranges > 64K, so it caps the request size, and
478
just reads until it gets all the stuff it wants.
480
helper = _SFTPReadvHelper(offsets, relpath, self._report_activity)
481
return helper.request_and_yield_offsets(fp)
483
def put_file(self, relpath, f, mode=None):
485
Copy the file-like object into the location.
438
if self._do_prefetch and hasattr(f, 'prefetch'):
442
def put(self, relpath, f, mode=None):
444
Copy the file-like or string object into the location.
487
446
:param relpath: Location to put the contents, relative to base.
488
:param f: File-like object.
447
:param f: File-like or string object.
489
448
:param mode: The final mode for the file
491
450
final_path = self._remote_path(relpath)
492
return self._put(final_path, f, mode=mode)
451
self._put(final_path, f, mode=mode)
494
453
def _put(self, abspath, f, mode=None):
495
454
"""Helper function so both put() and copy_abspaths can reuse the code"""
633
def _mkdir(self, abspath, mode=None):
639
self._report_activity(len(abspath), 'write')
640
self._get_sftp().mkdir(abspath, local_mode)
641
self._report_activity(1, 'read')
643
# chmod a dir through sftp will erase any sgid bit set
644
# on the server side. So, if the bit mode are already
645
# set, avoid the chmod. If the mode is not fine but
646
# the sgid bit is set, report a warning to the user
647
# with the umask fix.
648
stat = self._get_sftp().lstat(abspath)
649
mode = mode & 0777 # can't set special bits anyway
650
if mode != stat.st_mode & 0777:
651
if stat.st_mode & 06000:
652
warning('About to chmod %s over sftp, which will result'
653
' in its suid or sgid bits being cleared. If'
654
' you want to preserve those bits, change your '
655
' environment on the server to use umask 0%03o.'
656
% (abspath, 0777 - mode))
657
self._get_sftp().chmod(abspath, mode=mode)
658
except (paramiko.SSHException, IOError), e:
659
self._translate_io_exception(e, abspath, ': unable to mkdir',
660
failure_exc=FileExists)
662
500
def mkdir(self, relpath, mode=None):
663
501
"""Create a directory at the given path."""
664
self._mkdir(self._remote_path(relpath), mode=mode)
666
def open_write_stream(self, relpath, mode=None):
667
"""See Transport.open_write_stream."""
668
# initialise the file to zero-length
669
# this is three round trips, but we don't use this
670
# api more than once per write_group at the moment so
671
# it is a tolerable overhead. Better would be to truncate
672
# the file after opening. RBC 20070805
673
self.put_bytes_non_atomic(relpath, "", mode)
674
abspath = self._remote_path(relpath)
675
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
676
# set the file mode at create time. If it does, use it.
677
# But for now, we just chmod later anyway.
680
handle = self._get_sftp().file(abspath, mode='wb')
681
handle.set_pipelined(True)
503
path = self._remote_path(relpath)
504
# In the paramiko documentation, it says that passing a mode flag
505
# will filtered against the server umask.
506
# StubSFTPServer does not do this, which would be nice, because it is
507
# what we really want :)
508
# However, real servers do use umask, so we really should do it that way
509
self._sftp.mkdir(path)
511
self._sftp.chmod(path, mode=mode)
682
512
except (paramiko.SSHException, IOError), e:
683
self._translate_io_exception(e, abspath,
685
_file_streams[self.abspath(relpath)] = handle
686
return FileFileStream(self, relpath, handle)
513
self._translate_io_exception(e, path, ': unable to mkdir',
514
failure_exc=FileExists)
688
def _translate_io_exception(self, e, path, more_info='',
516
def _translate_io_exception(self, e, path, more_info='',
689
517
failure_exc=PathError):
690
518
"""Translate a paramiko or IOError into a friendlier exception.
842
651
# that we have taken the lock.
843
652
return SFTPLock(relpath, self)
654
def _unparse_url(self, path=None):
657
path = urllib.quote(path)
658
# handle homedir paths
659
if not path.startswith('/'):
661
netloc = urllib.quote(self._host)
662
if self._username is not None:
663
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
664
if self._port is not None:
665
netloc = '%s:%d' % (netloc, self._port)
666
return urlparse.urlunparse(('sftp', netloc, path, '', '', ''))
668
def _split_url(self, url):
669
(scheme, username, password, host, port, path) = split_url(url)
670
assert scheme == 'sftp'
672
# the initial slash should be removed from the path, and treated
673
# as a homedir relative path (the path begins with a double slash
674
# if it is absolute).
675
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
676
# RBC 20060118 we are not using this as its too user hostile. instead
677
# we are following lftp and using /~/foo to mean '~/foo'.
678
# handle homedir paths
679
if path.startswith('/~/'):
683
return (username, password, host, port, path)
685
def _parse_url(self, url):
686
(self._username, self._password,
687
self._host, self._port, self._path) = self._split_url(url)
689
def _sftp_connect(self):
690
"""Connect to the remote sftp server.
691
After this, self._sftp should have a valid connection (or
692
we raise an TransportError 'could not connect').
694
TODO: Raise a more reasonable ConnectionFailed exception
696
global _connected_hosts
698
idx = (self._host, self._port, self._username)
700
self._sftp = _connected_hosts[idx]
705
vendor = _get_ssh_vendor()
706
if vendor == 'loopback':
707
sock = socket.socket()
709
sock.connect((self._host, self._port))
710
except socket.error, e:
711
raise ConnectionError('Unable to connect to SSH host %s:%s: %s'
712
% (self._host, self._port, e))
713
self._sftp = SFTPClient(LoopbackSFTP(sock))
714
elif vendor != 'none':
715
sock = SFTPSubprocess(self._host, vendor, self._port,
717
self._sftp = SFTPClient(sock)
719
self._paramiko_connect()
721
_connected_hosts[idx] = self._sftp
723
def _paramiko_connect(self):
724
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
729
t = paramiko.Transport((self._host, self._port or 22))
730
t.set_log_channel('bzr.paramiko')
732
except paramiko.SSHException, e:
733
raise ConnectionError('Unable to reach SSH host %s:%s: %s'
734
% (self._host, self._port, e))
736
server_key = t.get_remote_server_key()
737
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
738
keytype = server_key.get_name()
739
if SYSTEM_HOSTKEYS.has_key(self._host) and SYSTEM_HOSTKEYS[self._host].has_key(keytype):
740
our_server_key = SYSTEM_HOSTKEYS[self._host][keytype]
741
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
742
elif BZR_HOSTKEYS.has_key(self._host) and BZR_HOSTKEYS[self._host].has_key(keytype):
743
our_server_key = BZR_HOSTKEYS[self._host][keytype]
744
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
746
warning('Adding %s host key for %s: %s' % (keytype, self._host, server_key_hex))
747
if not BZR_HOSTKEYS.has_key(self._host):
748
BZR_HOSTKEYS[self._host] = {}
749
BZR_HOSTKEYS[self._host][keytype] = server_key
750
our_server_key = server_key
751
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
753
if server_key != our_server_key:
754
filename1 = os.path.expanduser('~/.ssh/known_hosts')
755
filename2 = pathjoin(config_dir(), 'ssh_host_keys')
756
raise TransportError('Host keys for %s do not match! %s != %s' % \
757
(self._host, our_server_key_hex, server_key_hex),
758
['Try editing %s or %s' % (filename1, filename2)])
763
self._sftp = t.open_sftp_client()
764
except paramiko.SSHException, e:
765
raise ConnectionError('Unable to start sftp client %s:%d' %
766
(self._host, self._port), e)
768
def _sftp_auth(self, transport):
769
# paramiko requires a username, but it might be none if nothing was supplied
770
# use the local username, just in case.
771
# We don't override self._username, because if we aren't using paramiko,
772
# the username might be specified in ~/.ssh/config and we don't want to
773
# force it to something else
774
# Also, it would mess up the self.relpath() functionality
775
username = self._username or getpass.getuser()
777
# Paramiko tries to open a socket.AF_UNIX in order to connect
778
# to ssh-agent. That attribute doesn't exist on win32 (it does in cygwin)
779
# so we get an AttributeError exception. For now, just don't try to
780
# connect to an agent if we are on win32
781
if sys.platform != 'win32':
782
agent = paramiko.Agent()
783
for key in agent.get_keys():
784
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
786
transport.auth_publickey(username, key)
788
except paramiko.SSHException, e:
791
# okay, try finding id_rsa or id_dss? (posix only)
792
if self._try_pkey_auth(transport, paramiko.RSAKey, username, 'id_rsa'):
794
if self._try_pkey_auth(transport, paramiko.DSSKey, username, 'id_dsa'):
799
transport.auth_password(username, self._password)
801
except paramiko.SSHException, e:
804
# FIXME: Don't keep a password held in memory if you can help it
805
#self._password = None
807
# give up and ask for a password
808
password = bzrlib.ui.ui_factory.get_password(
809
prompt='SSH %(user)s@%(host)s password',
810
user=username, host=self._host)
812
transport.auth_password(username, password)
813
except paramiko.SSHException, e:
814
raise ConnectionError('Unable to authenticate to SSH host as %s@%s' %
815
(username, self._host), e)
817
def _try_pkey_auth(self, transport, pkey_class, username, filename):
818
filename = os.path.expanduser('~/.ssh/' + filename)
820
key = pkey_class.from_private_key_file(filename)
821
transport.auth_publickey(username, key)
823
except paramiko.PasswordRequiredException:
824
password = bzrlib.ui.ui_factory.get_password(
825
prompt='SSH %(filename)s password',
828
key = pkey_class.from_private_key_file(filename, password)
829
transport.auth_publickey(username, key)
831
except paramiko.SSHException:
832
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
833
except paramiko.SSHException:
834
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
845
839
def _sftp_open_exclusive(self, abspath, mode=None):
846
840
"""Open a remote path exclusively.
949
933
# probably a failed test; unit test thread will log the
951
935
sys.excepthook(*sys.exc_info())
952
warning('Exception from within unit test server thread: %r' %
936
warning('Exception from within unit test server thread: %r' %
956
class SocketDelay(object):
957
"""A socket decorator to make TCP appear slower.
959
This changes recv, send, and sendall to add a fixed latency to each python
960
call if a new roundtrip is detected. That is, when a recv is called and the
961
flag new_roundtrip is set, latency is charged. Every send and send_all
964
In addition every send, sendall and recv sleeps a bit per character send to
967
Not all methods are implemented, this is deliberate as this class is not a
968
replacement for the builtin sockets layer. fileno is not implemented to
969
prevent the proxy being bypassed.
973
_proxied_arguments = dict.fromkeys([
974
"close", "getpeername", "getsockname", "getsockopt", "gettimeout",
975
"setblocking", "setsockopt", "settimeout", "shutdown"])
977
def __init__(self, sock, latency, bandwidth=1.0,
980
:param bandwith: simulated bandwith (MegaBit)
981
:param really_sleep: If set to false, the SocketDelay will just
982
increase a counter, instead of calling time.sleep. This is useful for
983
unittesting the SocketDelay.
986
self.latency = latency
987
self.really_sleep = really_sleep
988
self.time_per_byte = 1 / (bandwidth / 8.0 * 1024 * 1024)
989
self.new_roundtrip = False
992
if self.really_sleep:
995
SocketDelay.simulated_time += s
997
def __getattr__(self, attr):
998
if attr in SocketDelay._proxied_arguments:
999
return getattr(self.sock, attr)
1000
raise AttributeError("'SocketDelay' object has no attribute %r" %
1004
return SocketDelay(self.sock.dup(), self.latency, self.time_per_byte,
1007
def recv(self, *args):
1008
data = self.sock.recv(*args)
1009
if data and self.new_roundtrip:
1010
self.new_roundtrip = False
1011
self.sleep(self.latency)
1012
self.sleep(len(data) * self.time_per_byte)
1015
def sendall(self, data, flags=0):
1016
if not self.new_roundtrip:
1017
self.new_roundtrip = True
1018
self.sleep(self.latency)
1019
self.sleep(len(data) * self.time_per_byte)
1020
return self.sock.sendall(data, flags)
1022
def send(self, data, flags=0):
1023
if not self.new_roundtrip:
1024
self.new_roundtrip = True
1025
self.sleep(self.latency)
1026
bytes_sent = self.sock.send(data, flags)
1027
self.sleep(bytes_sent * self.time_per_byte)
1031
940
class SFTPServer(Server):
1032
941
"""Common code for SFTP server facilities."""
1034
def __init__(self, server_interface=StubServer):
1035
944
self._original_vendor = None
1036
945
self._homedir = None
1037
946
self._server_homedir = None
1038
947
self._listener = None
1039
948
self._root = None
1040
self._vendor = ssh.ParamikoVendor()
1041
self._server_interface = server_interface
949
self._vendor = 'none'
1042
950
# sftp server logs
1044
self.add_latency = 0
1046
953
def _get_sftp_url(self, path):
1047
954
"""Calculate an sftp url to this server for path."""
added
removed
bzrlib/transport/sftp.py
