1
1
# Copyright (C) 2005 Robey Pointer <robey@lag.net>
2
# Copyright (C) 2005, 2006 Canonical Ltd
2
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
4
4
# This program is free software; you can redistribute it and/or modify
5
5
# it under the terms of the GNU General Public License as published by
6
6
# the Free Software Foundation; either version 2 of the License, or
7
7
# (at your option) any later version.
9
9
# This program is distributed in the hope that it will be useful,
10
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
12
# GNU General Public License for more details.
14
14
# You should have received a copy of the GNU General Public License
15
15
# along with this program; if not, write to the Free Software
16
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
18
"""Implementation of Transport over SFTP, using paramiko."""
20
# TODO: Remove the transport-based lock_read and lock_write methods. They'll
21
# then raise TransportNotPossible, which will break remote access to any
22
# formats which rely on OS-level locks. That should be fine as those formats
23
# are pretty old, but these combinations may have to be removed from the test
24
# suite. Those formats all date back to 0.7; so we should be able to remove
25
# these methods when we officially drop support for those formats.
33
from bzrlib.config import config_dir, ensure_config_dir_exists
34
from bzrlib.errors import (ConnectionError,
36
TransportNotPossible, NoSuchFile, PathNotChild,
43
from bzrlib.errors import (FileExists,
44
NoSuchFile, PathNotChild,
40
48
ParamikoNotPresent,
42
from bzrlib.osutils import pathjoin, fancy_rename
43
from bzrlib.trace import mutter, warning, error
50
from bzrlib.osutils import pathjoin, fancy_rename, getcwd
51
from bzrlib.symbol_versioning import (
55
from bzrlib.trace import mutter, warning
44
56
from bzrlib.transport import (
45
register_urlparse_netloc_protocol,
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')
60
85
CMD_HANDLE, CMD_OPEN)
61
86
from paramiko.sftp_attr import SFTPAttributes
62
87
from paramiko.sftp_file import SFTPFile
63
from paramiko.sftp_client import SFTPClient
66
register_urlparse_netloc_protocol('sftp')
70
# TODO: This should possibly ignore SIGHUP as well, but bzr currently
71
# doesn't handle it itself.
72
# <https://launchpad.net/products/bzr/+bug/41433/+index>
74
signal.signal(signal.SIGINT, signal.SIG_IGN)
77
def os_specific_subprocess_params():
78
"""Get O/S specific subprocess parameters."""
79
if sys.platform == 'win32':
80
# setting the process group and closing fds is not supported on
84
# We close fds other than the pipes as the child process does not need
87
# We also set the child process to ignore SIGINT. Normally the signal
88
# would be sent to every process in the foreground process group, but
89
# this causes it to be seen only by bzr and not by ssh. Python will
90
# generate a KeyboardInterrupt in bzr, and we will then have a chance
91
# to release locks or do other cleanup over ssh before the connection
93
# <https://launchpad.net/products/bzr/+bug/5987>
95
# Running it in a separate process group is not good because then it
96
# can't get non-echoed input of a password or passphrase.
97
# <https://launchpad.net/products/bzr/+bug/40508>
98
return {'preexec_fn': _ignore_sigint,
103
# don't use prefetch unless paramiko version >= 1.5.2 (there were bugs earlier)
104
_default_do_prefetch = False
105
if getattr(paramiko, '__version_info__', (0, 0, 0)) >= (1, 5, 5):
106
_default_do_prefetch = True
110
def _get_ssh_vendor():
111
"""Find out what version of SSH is on the system."""
113
if _ssh_vendor is not None:
118
if 'BZR_SSH' in os.environ:
119
_ssh_vendor = os.environ['BZR_SSH']
120
if _ssh_vendor == 'paramiko':
125
p = subprocess.Popen(['ssh', '-V'],
126
stdin=subprocess.PIPE,
127
stdout=subprocess.PIPE,
128
stderr=subprocess.PIPE,
129
**os_specific_subprocess_params())
130
returncode = p.returncode
131
stdout, stderr = p.communicate()
135
if 'OpenSSH' in stderr:
136
mutter('ssh implementation is OpenSSH')
137
_ssh_vendor = 'openssh'
138
elif 'SSH Secure Shell' in stderr:
139
mutter('ssh implementation is SSH Corp.')
142
if _ssh_vendor != 'none':
145
# XXX: 20051123 jamesh
146
# A check for putty's plink or lsh would go here.
148
mutter('falling back to paramiko implementation')
152
class SFTPSubprocess:
153
"""A socket-like object that talks to an ssh subprocess via pipes."""
154
def __init__(self, hostname, vendor, port=None, user=None):
155
assert vendor in ['openssh', 'ssh']
156
if vendor == 'openssh':
158
'-oForwardX11=no', '-oForwardAgent=no',
159
'-oClearAllForwardings=yes', '-oProtocol=2',
160
'-oNoHostAuthenticationForLocalhost=yes']
162
args.extend(['-p', str(port)])
164
args.extend(['-l', user])
165
args.extend(['-s', hostname, 'sftp'])
166
elif vendor == 'ssh':
169
args.extend(['-p', str(port)])
171
args.extend(['-l', user])
172
args.extend(['-s', 'sftp', hostname])
174
self.proc = subprocess.Popen(args,
175
stdin=subprocess.PIPE,
176
stdout=subprocess.PIPE,
177
**os_specific_subprocess_params())
179
def send(self, data):
180
return os.write(self.proc.stdin.fileno(), data)
182
def recv_ready(self):
183
# TODO: jam 20051215 this function is necessary to support the
184
# pipelined() function. In reality, it probably should use
185
# poll() or select() to actually return if there is data
186
# available, otherwise we probably don't get any benefit
189
def recv(self, count):
190
return os.read(self.proc.stdout.fileno(), count)
193
self.proc.stdin.close()
194
self.proc.stdout.close()
198
class LoopbackSFTP(object):
199
"""Simple wrapper for a socket that pretends to be a paramiko Channel."""
201
def __init__(self, sock):
204
def send(self, data):
205
return self.__socket.send(data)
208
return self.__socket.recv(n)
210
def recv_ready(self):
214
self.__socket.close()
220
# This is a weakref dictionary, so that we can reuse connections
221
# that are still active. Long term, it might be nice to have some
222
# sort of expiration policy, such as disconnect if inactive for
223
# X seconds. But that requires a lot more fanciness.
224
_connected_hosts = weakref.WeakValueDictionary()
90
_paramiko_version = getattr(paramiko, '__version_info__', (0, 0, 0))
91
# don't use prefetch unless paramiko version >= 1.5.5 (there were bugs earlier)
92
_default_do_prefetch = (_paramiko_version >= (1, 5, 5))
95
@deprecated_function(zero_ninety)
226
96
def clear_connection_cache():
227
97
"""Remove all hosts from the SFTP connection cache.
229
99
Primarily useful for test cases wanting to force garbage collection.
231
_connected_hosts.clear()
234
def load_host_keys():
236
Load system host keys (probably doesn't work on windows) and any
237
"discovered" keys from previous sessions.
239
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
241
SYSTEM_HOSTKEYS = paramiko.util.load_host_keys(os.path.expanduser('~/.ssh/known_hosts'))
243
mutter('failed to load system host keys: ' + str(e))
244
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
246
BZR_HOSTKEYS = paramiko.util.load_host_keys(bzr_hostkey_path)
248
mutter('failed to load bzr host keys: ' + str(e))
252
def save_host_keys():
254
Save "discovered" host keys in $(config)/ssh_host_keys/.
256
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
257
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
258
ensure_config_dir_exists()
261
f = open(bzr_hostkey_path, 'w')
262
f.write('# SSH host keys collected by bzr\n')
263
for hostname, keys in BZR_HOSTKEYS.iteritems():
264
for keytype, key in keys.iteritems():
265
f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
268
mutter('failed to save bzr host keys: ' + str(e))
100
We don't have a global connection cache anymore.
271
103
class SFTPLock(object):
272
"""This fakes a lock in a remote location."""
104
"""This fakes a lock in a remote location.
106
A present lock is indicated just by the existence of a file. This
107
doesn't work well on all transports and they are only used in
108
deprecated storage formats.
273
111
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
274
113
def __init__(self, path, transport):
275
114
assert isinstance(transport, SFTPTransport)
302
141
# What specific errors should we catch here?
305
class SFTPTransport (Transport):
307
Transport implementation for SFTP access.
145
class SFTPTransport(ConnectedTransport):
146
"""Transport implementation for SFTP access."""
309
148
_do_prefetch = _default_do_prefetch
311
def __init__(self, base, clone_from=None):
149
# TODO: jam 20060717 Conceivably these could be configurable, either
150
# by auto-tuning at run-time, or by a configuration (per host??)
151
# but the performance curve is pretty flat, so just going with
152
# reasonable defaults.
153
_max_readv_combine = 200
154
# Having to round trip to the server means waiting for a response,
155
# so it is better to download extra bytes.
156
# 8KiB had good performance for both local and remote network operations
157
_bytes_to_read_before_seek = 8192
159
# The sftp spec says that implementations SHOULD allow reads
160
# to be at least 32K. paramiko.readv() does an async request
161
# for the chunks. So we need to keep it within a single request
162
# size for paramiko <= 1.6.1. paramiko 1.6.2 will probably chop
163
# up the request itself, rather than us having to worry about it
164
_max_request_size = 32768
166
def __init__(self, base, _from_transport=None):
312
167
assert base.startswith('sftp://')
313
self._parse_url(base)
314
base = self._unparse_url()
317
super(SFTPTransport, self).__init__(base)
318
if clone_from is None:
321
# use the same ssh connection, etc
322
self._sftp = clone_from._sftp
323
# super saves 'self.base'
325
def should_cache(self):
327
Return True if the data pulled across should be cached locally.
331
def clone(self, offset=None):
333
Return a new SFTPTransport with root at self.base + offset.
334
We share the same SFTP session between such transports, because it's
335
fairly expensive to set them up.
338
return SFTPTransport(self.base, self)
340
return SFTPTransport(self.abspath(offset), self)
342
def abspath(self, relpath):
344
Return the full url to the given relative path.
346
@param relpath: the relative path or path components
347
@type relpath: str or list
349
return self._unparse_url(self._remote_path(relpath))
168
super(SFTPTransport, self).__init__(base,
169
_from_transport=_from_transport)
351
171
def _remote_path(self, relpath):
352
172
"""Return the path to be passed along the sftp protocol for relpath.
354
relpath is a urlencoded string.
356
# FIXME: share the common code across transports
357
assert isinstance(relpath, basestring)
358
relpath = urllib.unquote(relpath).split('/')
359
basepath = self._path.split('/')
360
if len(basepath) > 0 and basepath[-1] == '':
361
basepath = basepath[:-1]
365
if len(basepath) == 0:
366
# In most filesystems, a request for the parent
367
# of root, just returns root.
375
path = '/'.join(basepath)
378
def relpath(self, abspath):
379
username, password, host, port, path = self._split_url(abspath)
381
if (username != self._username):
382
error.append('username mismatch')
383
if (host != self._host):
384
error.append('host mismatch')
385
if (port != self._port):
386
error.append('port mismatch')
387
if (not path.startswith(self._path)):
388
error.append('path mismatch')
390
extra = ': ' + ', '.join(error)
391
raise PathNotChild(abspath, self.base, extra=extra)
393
return path[pl:].strip('/')
174
:param relpath: is a urlencoded string.
176
relative = urlutils.unescape(relpath).encode('utf-8')
177
remote_path = self._combine_paths(self._path, relative)
178
# the initial slash should be removed from the path, and treated as a
179
# homedir relative path (the path begins with a double slash if it is
180
# absolute). see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
181
# RBC 20060118 we are not using this as its too user hostile. instead
182
# we are following lftp and using /~/foo to mean '~/foo'
183
# vila--20070602 and leave absolute paths begin with a single slash.
184
if remote_path.startswith('/~/'):
185
remote_path = remote_path[3:]
186
elif remote_path == '/~':
190
def _create_connection(self, credentials=None):
191
"""Create a new connection with the provided credentials.
193
:param credentials: The credentials needed to establish the connection.
195
:return: The created connection and its associated credentials.
197
The credentials are only the password as it may have been entered
198
interactively by the user and may be different from the one provided
199
in base url at transport creation time.
201
if credentials is None:
202
password = self._password
204
password = credentials
206
vendor = ssh._get_ssh_vendor()
207
connection = vendor.connect_sftp(self._user, password,
208
self._host, self._port)
209
return connection, password
212
"""Ensures that a connection is established"""
213
connection = self._get_connection()
214
if connection is None:
215
# First connection ever
216
connection, credentials = self._create_connection()
217
self._set_connection(connection, credentials)
395
220
def has(self, relpath):
397
222
Does the target location exist?
400
self._sftp.stat(self._remote_path(relpath))
225
self._get_sftp().stat(self._remote_path(relpath))
412
237
path = self._remote_path(relpath)
413
f = self._sftp.file(path, mode='rb')
238
f = self._get_sftp().file(path, mode='rb')
414
239
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
417
242
except (IOError, paramiko.SSHException), e:
243
self._translate_io_exception(e, path, ': error retrieving',
244
failure_exc=errors.ReadError)
246
def _readv(self, relpath, offsets):
247
"""See Transport.readv()"""
248
# We overload the default readv() because we want to use a file
249
# that does not have prefetch enabled.
250
# Also, if we have a new paramiko, it implements an async readv()
255
path = self._remote_path(relpath)
256
fp = self._get_sftp().file(path, mode='rb')
257
readv = getattr(fp, 'readv', None)
259
return self._sftp_readv(fp, offsets, relpath)
260
mutter('seek and read %s offsets', len(offsets))
261
return self._seek_and_read(fp, offsets, relpath)
262
except (IOError, paramiko.SSHException), e:
418
263
self._translate_io_exception(e, path, ': error retrieving')
420
def get_partial(self, relpath, start, length=None):
422
Get just part of a file.
424
:param relpath: Path to the file, relative to base
425
:param start: The starting position to read from
426
:param length: The length to read. A length of None indicates
427
read to the end of the file.
428
:return: A file-like object containing at least the specified bytes.
429
Some implementations may return objects which can be read
430
past this length, but this is not guaranteed.
432
# TODO: implement get_partial_multi to help with knit support
433
f = self.get(relpath)
435
if self._do_prefetch and hasattr(f, 'prefetch'):
439
def put(self, relpath, f, mode=None):
441
Copy the file-like or string object into the location.
265
def recommended_page_size(self):
266
"""See Transport.recommended_page_size().
268
For SFTP we suggest a large page size to reduce the overhead
269
introduced by latency.
273
def _sftp_readv(self, fp, offsets, relpath='<unknown>'):
274
"""Use the readv() member of fp to do async readv.
276
And then read them using paramiko.readv(). paramiko.readv()
277
does not support ranges > 64K, so it caps the request size, and
278
just reads until it gets all the stuff it wants
280
offsets = list(offsets)
281
sorted_offsets = sorted(offsets)
283
# The algorithm works as follows:
284
# 1) Coalesce nearby reads into a single chunk
285
# This generates a list of combined regions, the total size
286
# and the size of the sub regions. This coalescing step is limited
287
# in the number of nearby chunks to combine, and is allowed to
288
# skip small breaks in the requests. Limiting it makes sure that
289
# we can start yielding some data earlier, and skipping means we
290
# make fewer requests. (Beneficial even when using async)
291
# 2) Break up this combined regions into chunks that are smaller
292
# than 64KiB. Technically the limit is 65536, but we are a
293
# little bit conservative. This is because sftp has a maximum
294
# return chunk size of 64KiB (max size of an unsigned short)
295
# 3) Issue a readv() to paramiko to create an async request for
297
# 4) Read in the data as it comes back, until we've read one
298
# continuous section as determined in step 1
299
# 5) Break up the full sections into hunks for the original requested
300
# offsets. And put them in a cache
301
# 6) Check if the next request is in the cache, and if it is, remove
302
# it from the cache, and yield its data. Continue until no more
303
# entries are in the cache.
304
# 7) loop back to step 4 until all data has been read
306
# TODO: jam 20060725 This could be optimized one step further, by
307
# attempting to yield whatever data we have read, even before
308
# the first coallesced section has been fully processed.
310
# When coalescing for use with readv(), we don't really need to
311
# use any fudge factor, because the requests are made asynchronously
312
coalesced = list(self._coalesce_offsets(sorted_offsets,
313
limit=self._max_readv_combine,
317
for c_offset in coalesced:
318
start = c_offset.start
319
size = c_offset.length
321
# We need to break this up into multiple requests
323
next_size = min(size, self._max_request_size)
324
requests.append((start, next_size))
328
mutter('SFTP.readv() %s offsets => %s coalesced => %s requests',
329
len(offsets), len(coalesced), len(requests))
331
# Queue the current read until we have read the full coalesced section
334
cur_coalesced_stack = iter(coalesced)
335
cur_coalesced = cur_coalesced_stack.next()
337
# Cache the results, but only until they have been fulfilled
339
# turn the list of offsets into a stack
340
offset_stack = iter(offsets)
341
cur_offset_and_size = offset_stack.next()
343
for data in fp.readv(requests):
345
cur_data_len += len(data)
347
if cur_data_len < cur_coalesced.length:
349
assert cur_data_len == cur_coalesced.length, \
350
"Somehow we read too much: %s != %s" % (cur_data_len,
351
cur_coalesced.length)
352
all_data = ''.join(cur_data)
356
for suboffset, subsize in cur_coalesced.ranges:
357
key = (cur_coalesced.start+suboffset, subsize)
358
data_map[key] = all_data[suboffset:suboffset+subsize]
360
# Now that we've read some data, see if we can yield anything back
361
while cur_offset_and_size in data_map:
362
this_data = data_map.pop(cur_offset_and_size)
363
yield cur_offset_and_size[0], this_data
364
cur_offset_and_size = offset_stack.next()
366
# We read a coalesced entry, so mark it as done
368
# Now that we've read all of the data for this coalesced section
370
cur_coalesced = cur_coalesced_stack.next()
372
if cur_coalesced is not None:
373
raise errors.ShortReadvError(relpath, cur_coalesced.start,
374
cur_coalesced.length, len(data))
376
def put_file(self, relpath, f, mode=None):
378
Copy the file-like object into the location.
443
380
:param relpath: Location to put the contents, relative to base.
444
:param f: File-like or string object.
381
:param f: File-like object.
445
382
:param mode: The final mode for the file
447
384
final_path = self._remote_path(relpath)
448
self._put(final_path, f, mode=mode)
385
return self._put(final_path, f, mode=mode)
450
387
def _put(self, abspath, f, mode=None):
451
388
"""Helper function so both put() and copy_abspaths can reuse the code"""
478
self._sftp.remove(tmp_abspath)
429
self._get_sftp().remove(tmp_abspath)
480
431
# raise the saved except
482
433
# raise the original with its traceback if we can.
436
def _put_non_atomic_helper(self, relpath, writer, mode=None,
437
create_parent_dir=False,
439
abspath = self._remote_path(relpath)
441
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
442
# set the file mode at create time. If it does, use it.
443
# But for now, we just chmod later anyway.
445
def _open_and_write_file():
446
"""Try to open the target file, raise error on failure"""
450
fout = self._get_sftp().file(abspath, mode='wb')
451
fout.set_pipelined(True)
453
except (paramiko.SSHException, IOError), e:
454
self._translate_io_exception(e, abspath,
457
# This is designed to chmod() right before we close.
458
# Because we set_pipelined() earlier, theoretically we might
459
# avoid the round trip for fout.close()
461
self._get_sftp().chmod(abspath, mode)
466
if not create_parent_dir:
467
_open_and_write_file()
470
# Try error handling to create the parent directory if we need to
472
_open_and_write_file()
474
# Try to create the parent directory, and then go back to
476
parent_dir = os.path.dirname(abspath)
477
self._mkdir(parent_dir, dir_mode)
478
_open_and_write_file()
480
def put_file_non_atomic(self, relpath, f, mode=None,
481
create_parent_dir=False,
483
"""Copy the file-like object into the target location.
485
This function is not strictly safe to use. It is only meant to
486
be used when you already know that the target does not exist.
487
It is not safe, because it will open and truncate the remote
488
file. So there may be a time when the file has invalid contents.
490
:param relpath: The remote location to put the contents.
491
:param f: File-like object.
492
:param mode: Possible access permissions for new file.
493
None means do not set remote permissions.
494
:param create_parent_dir: If we cannot create the target file because
495
the parent directory does not exist, go ahead and
496
create it, and then try again.
500
self._put_non_atomic_helper(relpath, writer, mode=mode,
501
create_parent_dir=create_parent_dir,
504
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
505
create_parent_dir=False,
509
self._put_non_atomic_helper(relpath, writer, mode=mode,
510
create_parent_dir=create_parent_dir,
485
513
def iter_files_recursive(self):
486
514
"""Walk the relative paths of all files in this transport."""
487
515
queue = list(self.list_dir('.'))
489
relpath = urllib.quote(queue.pop(0))
517
relpath = queue.pop(0)
490
518
st = self.stat(relpath)
491
519
if stat.S_ISDIR(st.st_mode):
492
520
for i, basename in enumerate(self.list_dir(relpath)):
525
def _mkdir(self, abspath, mode=None):
531
self._get_sftp().mkdir(abspath, local_mode)
533
self._get_sftp().chmod(abspath, mode=mode)
534
except (paramiko.SSHException, IOError), e:
535
self._translate_io_exception(e, abspath, ': unable to mkdir',
536
failure_exc=FileExists)
497
538
def mkdir(self, relpath, mode=None):
498
539
"""Create a directory at the given path."""
540
self._mkdir(self._remote_path(relpath), mode=mode)
542
def open_write_stream(self, relpath, mode=None):
543
"""See Transport.open_write_stream."""
544
# initialise the file to zero-length
545
# this is three round trips, but we don't use this
546
# api more than once per write_group at the moment so
547
# it is a tolerable overhead. Better would be to truncate
548
# the file after opening. RBC 20070805
549
self.put_bytes_non_atomic(relpath, "", mode)
550
abspath = self._remote_path(relpath)
551
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
552
# set the file mode at create time. If it does, use it.
553
# But for now, we just chmod later anyway.
500
path = self._remote_path(relpath)
501
# In the paramiko documentation, it says that passing a mode flag
502
# will filtered against the server umask.
503
# StubSFTPServer does not do this, which would be nice, because it is
504
# what we really want :)
505
# However, real servers do use umask, so we really should do it that way
506
self._sftp.mkdir(path)
508
self._sftp.chmod(path, mode=mode)
556
handle = self._get_sftp().file(abspath, mode='wb')
557
handle.set_pipelined(True)
509
558
except (paramiko.SSHException, IOError), e:
510
self._translate_io_exception(e, path, ': unable to mkdir',
511
failure_exc=FileExists)
559
self._translate_io_exception(e, abspath,
561
_file_streams[self.abspath(relpath)] = handle
562
return FileFileStream(self, relpath, handle)
513
def _translate_io_exception(self, e, path, more_info='',
564
def _translate_io_exception(self, e, path, more_info='',
514
565
failure_exc=PathError):
515
566
"""Translate a paramiko or IOError into a friendlier exception.
648
710
# that we have taken the lock.
649
711
return SFTPLock(relpath, self)
651
def _unparse_url(self, path=None):
654
path = urllib.quote(path)
655
# handle homedir paths
656
if not path.startswith('/'):
658
netloc = urllib.quote(self._host)
659
if self._username is not None:
660
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
661
if self._port is not None:
662
netloc = '%s:%d' % (netloc, self._port)
663
return urlparse.urlunparse(('sftp', netloc, path, '', '', ''))
665
def _split_url(self, url):
666
(scheme, username, password, host, port, path) = split_url(url)
667
assert scheme == 'sftp'
669
# the initial slash should be removed from the path, and treated
670
# as a homedir relative path (the path begins with a double slash
671
# if it is absolute).
672
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
673
# RBC 20060118 we are not using this as its too user hostile. instead
674
# we are following lftp and using /~/foo to mean '~/foo'.
675
# handle homedir paths
676
if path.startswith('/~/'):
680
return (username, password, host, port, path)
682
def _parse_url(self, url):
683
(self._username, self._password,
684
self._host, self._port, self._path) = self._split_url(url)
686
def _sftp_connect(self):
687
"""Connect to the remote sftp server.
688
After this, self._sftp should have a valid connection (or
689
we raise an TransportError 'could not connect').
691
TODO: Raise a more reasonable ConnectionFailed exception
693
global _connected_hosts
695
idx = (self._host, self._port, self._username)
697
self._sftp = _connected_hosts[idx]
702
vendor = _get_ssh_vendor()
703
if vendor == 'loopback':
704
sock = socket.socket()
705
sock.connect((self._host, self._port))
706
self._sftp = SFTPClient(LoopbackSFTP(sock))
707
elif vendor != 'none':
708
sock = SFTPSubprocess(self._host, vendor, self._port,
710
self._sftp = SFTPClient(sock)
712
self._paramiko_connect()
714
_connected_hosts[idx] = self._sftp
716
def _paramiko_connect(self):
717
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
722
t = paramiko.Transport((self._host, self._port or 22))
723
t.set_log_channel('bzr.paramiko')
725
except paramiko.SSHException, e:
726
raise ConnectionError('Unable to reach SSH host %s:%d' %
727
(self._host, self._port), e)
729
server_key = t.get_remote_server_key()
730
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
731
keytype = server_key.get_name()
732
if SYSTEM_HOSTKEYS.has_key(self._host) and SYSTEM_HOSTKEYS[self._host].has_key(keytype):
733
our_server_key = SYSTEM_HOSTKEYS[self._host][keytype]
734
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
735
elif BZR_HOSTKEYS.has_key(self._host) and BZR_HOSTKEYS[self._host].has_key(keytype):
736
our_server_key = BZR_HOSTKEYS[self._host][keytype]
737
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
739
warning('Adding %s host key for %s: %s' % (keytype, self._host, server_key_hex))
740
if not BZR_HOSTKEYS.has_key(self._host):
741
BZR_HOSTKEYS[self._host] = {}
742
BZR_HOSTKEYS[self._host][keytype] = server_key
743
our_server_key = server_key
744
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
746
if server_key != our_server_key:
747
filename1 = os.path.expanduser('~/.ssh/known_hosts')
748
filename2 = pathjoin(config_dir(), 'ssh_host_keys')
749
raise TransportError('Host keys for %s do not match! %s != %s' % \
750
(self._host, our_server_key_hex, server_key_hex),
751
['Try editing %s or %s' % (filename1, filename2)])
756
self._sftp = t.open_sftp_client()
757
except paramiko.SSHException, e:
758
raise ConnectionError('Unable to start sftp client %s:%d' %
759
(self._host, self._port), e)
761
def _sftp_auth(self, transport):
762
# paramiko requires a username, but it might be none if nothing was supplied
763
# use the local username, just in case.
764
# We don't override self._username, because if we aren't using paramiko,
765
# the username might be specified in ~/.ssh/config and we don't want to
766
# force it to something else
767
# Also, it would mess up the self.relpath() functionality
768
username = self._username or getpass.getuser()
770
# Paramiko tries to open a socket.AF_UNIX in order to connect
771
# to ssh-agent. That attribute doesn't exist on win32 (it does in cygwin)
772
# so we get an AttributeError exception. For now, just don't try to
773
# connect to an agent if we are on win32
774
if sys.platform != 'win32':
775
agent = paramiko.Agent()
776
for key in agent.get_keys():
777
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
779
transport.auth_publickey(username, key)
781
except paramiko.SSHException, e:
784
# okay, try finding id_rsa or id_dss? (posix only)
785
if self._try_pkey_auth(transport, paramiko.RSAKey, username, 'id_rsa'):
787
if self._try_pkey_auth(transport, paramiko.DSSKey, username, 'id_dsa'):
792
transport.auth_password(username, self._password)
794
except paramiko.SSHException, e:
797
# FIXME: Don't keep a password held in memory if you can help it
798
#self._password = None
800
# give up and ask for a password
801
password = bzrlib.ui.ui_factory.get_password(
802
prompt='SSH %(user)s@%(host)s password',
803
user=username, host=self._host)
805
transport.auth_password(username, password)
806
except paramiko.SSHException, e:
807
raise ConnectionError('Unable to authenticate to SSH host as %s@%s' %
808
(username, self._host), e)
810
def _try_pkey_auth(self, transport, pkey_class, username, filename):
811
filename = os.path.expanduser('~/.ssh/' + filename)
813
key = pkey_class.from_private_key_file(filename)
814
transport.auth_publickey(username, key)
816
except paramiko.PasswordRequiredException:
817
password = bzrlib.ui.ui_factory.get_password(
818
prompt='SSH %(filename)s password',
821
key = pkey_class.from_private_key_file(filename, password)
822
transport.auth_publickey(username, key)
824
except paramiko.SSHException:
825
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
826
except paramiko.SSHException:
827
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
832
713
def _sftp_open_exclusive(self, abspath, mode=None):
833
714
"""Open a remote path exclusively.
843
724
:param abspath: The remote absolute path where the file should be opened
844
725
:param mode: The mode permissions bits for the new file
846
path = self._sftp._adjust_cwd(abspath)
727
# TODO: jam 20060816 Paramiko >= 1.6.2 (probably earlier) supports
728
# using the 'x' flag to indicate SFTP_FLAG_EXCL.
729
# However, there is no way to set the permission mode at open
730
# time using the sftp_client.file() functionality.
731
path = self._get_sftp()._adjust_cwd(abspath)
732
# mutter('sftp abspath %s => %s', abspath, path)
847
733
attr = SFTPAttributes()
848
734
if mode is not None:
849
735
attr.st_mode = mode
850
736
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
851
737
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
853
t, msg = self._sftp._request(CMD_OPEN, path, omode, attr)
739
t, msg = self._get_sftp()._request(CMD_OPEN, path, omode, attr)
854
740
if t != CMD_HANDLE:
855
741
raise TransportError('Expected an SFTP handle')
856
742
handle = msg.get_string()
857
return SFTPFile(self._sftp, handle, 'wb', -1)
743
return SFTPFile(self._get_sftp(), handle, 'wb', -1)
858
744
except (paramiko.SSHException, IOError), e:
859
745
self._translate_io_exception(e, abspath, ': unable to open',
860
746
failure_exc=FileExists)
748
def _can_roundtrip_unix_modebits(self):
749
if sys.platform == 'win32':
863
755
# ------------- server test implementation --------------
867
758
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
895
786
self._socket.bind(('localhost', 0))
896
787
self._socket.listen(1)
897
788
self.port = self._socket.getsockname()[1]
898
self.stop_event = threading.Event()
901
s, _ = self._socket.accept()
902
# now close the listen socket
905
self._callback(s, self.stop_event)
907
pass #Ignore socket errors
909
# probably a failed test
910
warning('Exception from within unit test server thread: %r' % x)
789
self._stop_event = threading.Event()
913
self.stop_event.set()
792
# called from outside this thread
793
self._stop_event.set()
914
794
# use a timeout here, because if the test fails, the server thread may
915
795
# never notice the stop_event.
801
readable, writable_unused, exception_unused = \
802
select.select([self._socket], [], [], 0.1)
803
if self._stop_event.isSet():
805
if len(readable) == 0:
808
s, addr_unused = self._socket.accept()
809
# because the loopback socket is inline, and transports are
810
# never explicitly closed, best to launch a new thread.
811
threading.Thread(target=self._callback, args=(s,)).start()
812
except socket.error, x:
813
sys.excepthook(*sys.exc_info())
814
warning('Socket error during accept() within unit test server'
817
# probably a failed test; unit test thread will log the
819
sys.excepthook(*sys.exc_info())
820
warning('Exception from within unit test server thread: %r' %
824
class SocketDelay(object):
825
"""A socket decorator to make TCP appear slower.
827
This changes recv, send, and sendall to add a fixed latency to each python
828
call if a new roundtrip is detected. That is, when a recv is called and the
829
flag new_roundtrip is set, latency is charged. Every send and send_all
832
In addition every send, sendall and recv sleeps a bit per character send to
835
Not all methods are implemented, this is deliberate as this class is not a
836
replacement for the builtin sockets layer. fileno is not implemented to
837
prevent the proxy being bypassed.
841
_proxied_arguments = dict.fromkeys([
842
"close", "getpeername", "getsockname", "getsockopt", "gettimeout",
843
"setblocking", "setsockopt", "settimeout", "shutdown"])
845
def __init__(self, sock, latency, bandwidth=1.0,
848
:param bandwith: simulated bandwith (MegaBit)
849
:param really_sleep: If set to false, the SocketDelay will just
850
increase a counter, instead of calling time.sleep. This is useful for
851
unittesting the SocketDelay.
854
self.latency = latency
855
self.really_sleep = really_sleep
856
self.time_per_byte = 1 / (bandwidth / 8.0 * 1024 * 1024)
857
self.new_roundtrip = False
860
if self.really_sleep:
863
SocketDelay.simulated_time += s
865
def __getattr__(self, attr):
866
if attr in SocketDelay._proxied_arguments:
867
return getattr(self.sock, attr)
868
raise AttributeError("'SocketDelay' object has no attribute %r" %
872
return SocketDelay(self.sock.dup(), self.latency, self.time_per_byte,
875
def recv(self, *args):
876
data = self.sock.recv(*args)
877
if data and self.new_roundtrip:
878
self.new_roundtrip = False
879
self.sleep(self.latency)
880
self.sleep(len(data) * self.time_per_byte)
883
def sendall(self, data, flags=0):
884
if not self.new_roundtrip:
885
self.new_roundtrip = True
886
self.sleep(self.latency)
887
self.sleep(len(data) * self.time_per_byte)
888
return self.sock.sendall(data, flags)
890
def send(self, data, flags=0):
891
if not self.new_roundtrip:
892
self.new_roundtrip = True
893
self.sleep(self.latency)
894
bytes_sent = self.sock.send(data, flags)
895
self.sleep(bytes_sent * self.time_per_byte)
919
899
class SFTPServer(Server):
920
900
"""Common code for SFTP server facilities."""
902
def __init__(self, server_interface=StubServer):
923
903
self._original_vendor = None
924
904
self._homedir = None
925
905
self._server_homedir = None
926
906
self._listener = None
927
907
self._root = None
928
self._vendor = 'none'
908
self._vendor = ssh.ParamikoVendor()
909
self._server_interface = server_interface
929
910
# sftp server logs
932
914
def _get_sftp_url(self, path):
933
915
"""Calculate an sftp url to this server for path."""
937
919
"""StubServer uses this to log when a new server is created."""
938
920
self.logs.append(message)
940
def _run_server(self, s, stop_event):
922
def _run_server_entry(self, sock):
923
"""Entry point for all implementations of _run_server.
925
If self.add_latency is > 0.000001 then sock is given a latency adding
928
if self.add_latency > 0.000001:
929
sock = SocketDelay(sock, self.add_latency)
930
return self._run_server(sock)
932
def _run_server(self, s):
941
933
ssh_server = paramiko.Transport(s)
942
key_file = os.path.join(self._homedir, 'test_rsa.key')
943
file(key_file, 'w').write(STUB_SERVER_KEY)
934
key_file = pathjoin(self._homedir, 'test_rsa.key')
935
f = open(key_file, 'w')
936
f.write(STUB_SERVER_KEY)
944
938
host_key = paramiko.RSAKey.from_private_key_file(key_file)
945
939
ssh_server.add_server_key(host_key)
946
server = StubServer(self)
940
server = self._server_interface(self)
947
941
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
948
942
StubSFTPServer, root=self._root,
949
943
home=self._server_homedir)
950
944
event = threading.Event()
951
945
ssh_server.start_server(event, server)
953
stop_event.wait(30.0)
957
self._original_vendor = _ssh_vendor
958
_ssh_vendor = self._vendor
959
self._homedir = os.getcwdu()
948
def setUp(self, backing_server=None):
949
# XXX: TODO: make sftpserver back onto backing_server rather than local
951
assert (backing_server is None or
952
isinstance(backing_server, local.LocalURLServer)), (
953
"backing_server should not be %r, because this can only serve the "
954
"local current working directory." % (backing_server,))
955
self._original_vendor = ssh._ssh_vendor_manager._cached_ssh_vendor
956
ssh._ssh_vendor_manager._cached_ssh_vendor = self._vendor
957
if sys.platform == 'win32':
958
# Win32 needs to use the UNICODE api
959
self._homedir = getcwd()
961
# But Linux SFTP servers should just deal in bytestreams
962
self._homedir = os.getcwd()
960
963
if self._server_homedir is None:
961
964
self._server_homedir = self._homedir
963
# FIXME WINDOWS: _root should be _server_homedir[0]:/
964
self._listener = SingleListener(self._run_server)
966
if sys.platform == 'win32':
968
self._listener = SocketListener(self._run_server_entry)
965
969
self._listener.setDaemon(True)
966
970
self._listener.start()
968
972
def tearDown(self):
969
973
"""See bzrlib.transport.Server.tearDown."""
971
974
self._listener.stop()
972
_ssh_vendor = self._original_vendor
975
ssh._ssh_vendor_manager._cached_ssh_vendor = self._original_vendor
977
def get_bogus_url(self):
978
"""See bzrlib.transport.Server.get_bogus_url."""
979
# this is chosen to try to prevent trouble with proxies, wierd dns, etc
980
# we bind a random socket, so that we get a guaranteed unused port
981
# we just never listen on that port
983
s.bind(('localhost', 0))
984
return 'sftp://%s:%s/' % s.getsockname()
975
987
class SFTPFullAbsoluteServer(SFTPServer):
added
removed
bzrlib/transport/sftp.py
