1
1
# Copyright (C) 2005 Robey Pointer <robey@lag.net>
2
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
# Copyright (C) 2005, 2006 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.
43
from bzrlib.errors import (FileExists,
44
NoSuchFile, PathNotChild,
33
from bzrlib.config import config_dir, ensure_config_dir_exists
34
from bzrlib.errors import (ConnectionError,
36
TransportNotPossible, NoSuchFile, PathNotChild,
48
40
ParamikoNotPresent,
50
from bzrlib.osutils import pathjoin, fancy_rename, getcwd
51
from bzrlib.trace import mutter, warning
42
from bzrlib.osutils import pathjoin, fancy_rename
43
from bzrlib.trace import mutter, warning, error
52
44
from bzrlib.transport import (
54
45
register_urlparse_netloc_protocol,
68
59
CMD_HANDLE, CMD_OPEN)
69
60
from paramiko.sftp_attr import SFTPAttributes
70
61
from paramiko.sftp_file import SFTPFile
62
from paramiko.sftp_client import SFTPClient
73
65
register_urlparse_netloc_protocol('sftp')
69
# TODO: This should possibly ignore SIGHUP as well, but bzr currently
70
# doesn't handle it itself.
71
# <https://launchpad.net/products/bzr/+bug/41433/+index>
73
signal.signal(signal.SIGINT, signal.SIG_IGN)
76
def os_specific_subprocess_params():
77
"""Get O/S specific subprocess parameters."""
78
if sys.platform == 'win32':
79
# setting the process group and closing fds is not supported on
83
# We close fds other than the pipes as the child process does not need
86
# We also set the child process to ignore SIGINT. Normally the signal
87
# would be sent to every process in the foreground process group, but
88
# this causes it to be seen only by bzr and not by ssh. Python will
89
# generate a KeyboardInterrupt in bzr, and we will then have a chance
90
# to release locks or do other cleanup over ssh before the connection
92
# <https://launchpad.net/products/bzr/+bug/5987>
94
# Running it in a separate process group is not good because then it
95
# can't get non-echoed input of a password or passphrase.
96
# <https://launchpad.net/products/bzr/+bug/40508>
97
return {'preexec_fn': _ignore_sigint,
102
# don't use prefetch unless paramiko version >= 1.5.2 (there were bugs earlier)
103
_default_do_prefetch = False
104
if getattr(paramiko, '__version_info__', (0, 0, 0)) >= (1, 5, 5):
105
_default_do_prefetch = True
109
def _get_ssh_vendor():
110
"""Find out what version of SSH is on the system."""
112
if _ssh_vendor is not None:
117
if 'BZR_SSH' in os.environ:
118
_ssh_vendor = os.environ['BZR_SSH']
119
if _ssh_vendor == 'paramiko':
124
p = subprocess.Popen(['ssh', '-V'],
125
stdin=subprocess.PIPE,
126
stdout=subprocess.PIPE,
127
stderr=subprocess.PIPE,
128
**os_specific_subprocess_params())
129
returncode = p.returncode
130
stdout, stderr = p.communicate()
134
if 'OpenSSH' in stderr:
135
mutter('ssh implementation is OpenSSH')
136
_ssh_vendor = 'openssh'
137
elif 'SSH Secure Shell' in stderr:
138
mutter('ssh implementation is SSH Corp.')
141
if _ssh_vendor != 'none':
144
# XXX: 20051123 jamesh
145
# A check for putty's plink or lsh would go here.
147
mutter('falling back to paramiko implementation')
151
class SFTPSubprocess:
152
"""A socket-like object that talks to an ssh subprocess via pipes."""
153
def __init__(self, hostname, vendor, port=None, user=None):
154
assert vendor in ['openssh', 'ssh']
155
if vendor == 'openssh':
157
'-oForwardX11=no', '-oForwardAgent=no',
158
'-oClearAllForwardings=yes', '-oProtocol=2',
159
'-oNoHostAuthenticationForLocalhost=yes']
161
args.extend(['-p', str(port)])
163
args.extend(['-l', user])
164
args.extend(['-s', hostname, 'sftp'])
165
elif vendor == 'ssh':
168
args.extend(['-p', str(port)])
170
args.extend(['-l', user])
171
args.extend(['-s', 'sftp', hostname])
173
self.proc = subprocess.Popen(args,
174
stdin=subprocess.PIPE,
175
stdout=subprocess.PIPE,
176
**os_specific_subprocess_params())
178
def send(self, data):
179
return os.write(self.proc.stdin.fileno(), data)
181
def recv_ready(self):
182
# TODO: jam 20051215 this function is necessary to support the
183
# pipelined() function. In reality, it probably should use
184
# poll() or select() to actually return if there is data
185
# available, otherwise we probably don't get any benefit
188
def recv(self, count):
189
return os.read(self.proc.stdout.fileno(), count)
192
self.proc.stdin.close()
193
self.proc.stdout.close()
197
class LoopbackSFTP(object):
198
"""Simple wrapper for a socket that pretends to be a paramiko Channel."""
200
def __init__(self, sock):
203
def send(self, data):
204
return self.__socket.send(data)
207
return self.__socket.recv(n)
209
def recv_ready(self):
213
self.__socket.close()
76
219
# This is a weakref dictionary, so that we can reuse connections
77
220
# that are still active. Long term, it might be nice to have some
78
221
# sort of expiration policy, such as disconnect if inactive for
79
222
# X seconds. But that requires a lot more fanciness.
80
223
_connected_hosts = weakref.WeakValueDictionary()
83
_paramiko_version = getattr(paramiko, '__version_info__', (0, 0, 0))
84
# don't use prefetch unless paramiko version >= 1.5.5 (there were bugs earlier)
85
_default_do_prefetch = (_paramiko_version >= (1, 5, 5))
88
225
def clear_connection_cache():
89
226
"""Remove all hosts from the SFTP connection cache.
93
230
_connected_hosts.clear()
233
def load_host_keys():
235
Load system host keys (probably doesn't work on windows) and any
236
"discovered" keys from previous sessions.
238
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
240
SYSTEM_HOSTKEYS = paramiko.util.load_host_keys(os.path.expanduser('~/.ssh/known_hosts'))
242
mutter('failed to load system host keys: ' + str(e))
243
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
245
BZR_HOSTKEYS = paramiko.util.load_host_keys(bzr_hostkey_path)
247
mutter('failed to load bzr host keys: ' + str(e))
251
def save_host_keys():
253
Save "discovered" host keys in $(config)/ssh_host_keys/.
255
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
256
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
257
ensure_config_dir_exists()
260
f = open(bzr_hostkey_path, 'w')
261
f.write('# SSH host keys collected by bzr\n')
262
for hostname, keys in BZR_HOSTKEYS.iteritems():
263
for keytype, key in keys.iteritems():
264
f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
267
mutter('failed to save bzr host keys: ' + str(e))
96
270
class SFTPLock(object):
97
"""This fakes a lock in a remote location.
99
A present lock is indicated just by the existence of a file. This
100
doesn't work well on all transports and they are only used in
101
deprecated storage formats.
271
"""This fakes a lock in a remote location."""
104
272
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
106
273
def __init__(self, path, transport):
107
274
assert isinstance(transport, SFTPTransport)
134
301
# What specific errors should we catch here?
138
class SFTPUrlHandling(Transport):
139
"""Mix-in that does common handling of SSH/SFTP URLs."""
141
def __init__(self, base):
304
class SFTPTransport (Transport):
306
Transport implementation for SFTP access.
308
_do_prefetch = _default_do_prefetch
310
def __init__(self, base, clone_from=None):
311
assert base.startswith('sftp://')
142
312
self._parse_url(base)
143
base = self._unparse_url(self._path)
313
base = self._unparse_url()
144
314
if base[-1] != '/':
146
super(SFTPUrlHandling, self).__init__(base)
148
def _parse_url(self, url):
150
self._username, self._password,
151
self._host, self._port, self._path) = self._split_url(url)
153
def _unparse_url(self, path):
154
"""Return a URL for a path relative to this transport.
156
path = urllib.quote(path)
157
# handle homedir paths
158
if not path.startswith('/'):
160
netloc = urllib.quote(self._host)
161
if self._username is not None:
162
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
163
if self._port is not None:
164
netloc = '%s:%d' % (netloc, self._port)
165
return urlparse.urlunparse((self._scheme, netloc, path, '', '', ''))
167
def _split_url(self, url):
168
(scheme, username, password, host, port, path) = split_url(url)
169
## assert scheme == 'sftp'
171
# the initial slash should be removed from the path, and treated
172
# as a homedir relative path (the path begins with a double slash
173
# if it is absolute).
174
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
175
# RBC 20060118 we are not using this as its too user hostile. instead
176
# we are following lftp and using /~/foo to mean '~/foo'.
177
# handle homedir paths
178
if path.startswith('/~/'):
182
return (scheme, username, password, host, port, path)
184
def abspath(self, relpath):
185
"""Return the full url to the given relative path.
187
@param relpath: the relative path or path components
188
@type relpath: str or list
190
return self._unparse_url(self._remote_path(relpath))
192
def _remote_path(self, relpath):
193
"""Return the path to be passed along the sftp protocol for relpath.
195
:param relpath: is a urlencoded string.
197
return self._combine_paths(self._path, relpath)
200
class SFTPTransport(SFTPUrlHandling):
201
"""Transport implementation for SFTP access."""
203
_do_prefetch = _default_do_prefetch
204
# TODO: jam 20060717 Conceivably these could be configurable, either
205
# by auto-tuning at run-time, or by a configuration (per host??)
206
# but the performance curve is pretty flat, so just going with
207
# reasonable defaults.
208
_max_readv_combine = 200
209
# Having to round trip to the server means waiting for a response,
210
# so it is better to download extra bytes.
211
# 8KiB had good performance for both local and remote network operations
212
_bytes_to_read_before_seek = 8192
214
# The sftp spec says that implementations SHOULD allow reads
215
# to be at least 32K. paramiko.readv() does an async request
216
# for the chunks. So we need to keep it within a single request
217
# size for paramiko <= 1.6.1. paramiko 1.6.2 will probably chop
218
# up the request itself, rather than us having to worry about it
219
_max_request_size = 32768
221
def __init__(self, base, clone_from=None):
222
316
super(SFTPTransport, self).__init__(base)
223
317
if clone_from is None:
224
318
self._sftp_connect()
245
339
return SFTPTransport(self.abspath(offset), self)
341
def abspath(self, relpath):
343
Return the full url to the given relative path.
345
@param relpath: the relative path or path components
346
@type relpath: str or list
348
return self._unparse_url(self._remote_path(relpath))
247
350
def _remote_path(self, relpath):
248
351
"""Return the path to be passed along the sftp protocol for relpath.
250
353
relpath is a urlencoded string.
252
:return: a path prefixed with / for regular abspath-based urls, or a
253
path that does not begin with / for urls which begin with /~/.
255
# how does this work?
256
# it processes relpath with respect to
258
# firstly we create a path to evaluate:
259
# if relpath is an abspath or homedir path, its the entire thing
260
# otherwise we join our base with relpath
261
# then we eliminate all empty segments (double //'s) outside the first
262
# two elements of the list. This avoids problems with trailing
263
# slashes, or other abnormalities.
264
# finally we evaluate the entire path in a single pass
266
# '..' result in popping the left most already
267
# processed path (which can never be empty because of the check for
268
# abspath and homedir meaning that its not, or that we've used our
269
# path. If the pop would pop the root, we ignore it.
271
# Specific case examinations:
272
# remove the special casefor ~: if the current root is ~/ popping of it
273
# = / thus our seed for a ~ based path is ['', '~']
274
# and if we end up with [''] then we had basically ('', '..') (which is
275
# '/..' so we append '' if the length is one, and assert that the first
276
# element is still ''. Lastly, if we end with ['', '~'] as a prefix for
277
# the output, we've got a homedir path, so we strip that prefix before
278
# '/' joining the resulting list.
280
# case one: '/' -> ['', ''] cannot shrink
281
# case two: '/' + '../foo' -> ['', 'foo'] (take '', '', '..', 'foo')
282
# and pop the second '' for the '..', append 'foo'
283
# case three: '/~/' -> ['', '~', '']
284
# case four: '/~/' + '../foo' -> ['', '~', '', '..', 'foo'],
285
# and we want to get '/foo' - the empty path in the middle
286
# needs to be stripped, then normal path manipulation will
288
# case five: '/..' ['', '..'], we want ['', '']
289
# stripping '' outside the first two is ok
290
# ignore .. if its too high up
292
# lastly this code is possibly reusable by FTP, but not reusable by
293
# local paths: ~ is resolvable correctly, nor by HTTP or the smart
294
# server: ~ is resolved remotely.
296
# however, a version of this that acts on self.base is possible to be
297
# written which manipulates the URL in canonical form, and would be
298
# reusable for all transports, if a flag for allowing ~/ at all was
355
# FIXME: share the common code across transports
300
356
assert isinstance(relpath, basestring)
301
relpath = urlutils.unescape(relpath)
304
if relpath.startswith('/'):
305
# abspath - normal split is fine.
306
current_path = relpath.split('/')
307
elif relpath.startswith('~/'):
308
# root is homedir based: normal split and prefix '' to remote the
310
current_path = [''].extend(relpath.split('/'))
312
# root is from the current directory:
313
if self._path.startswith('/'):
314
# abspath, take the regular split
317
# homedir based, add the '', '~' not present in self._path
318
current_path = ['', '~']
319
# add our current dir
320
current_path.extend(self._path.split('/'))
321
# add the users relpath
322
current_path.extend(relpath.split('/'))
323
# strip '' segments that are not in the first one - the leading /.
324
to_process = current_path[:1]
325
for segment in current_path[1:]:
327
to_process.append(segment)
329
# process '.' and '..' segments into output_path.
331
for segment in to_process:
333
# directory pop. Remove a directory
334
# as long as we are not at the root
335
if len(output_path) > 1:
338
# cannot pop beyond the root, so do nothing
340
continue # strip the '.' from the output.
342
# this will append '' to output_path for the root elements,
343
# which is appropriate: its why we strip '' in the first pass.
344
output_path.append(segment)
346
# check output special cases:
347
if output_path == ['']:
349
output_path = ['', '']
350
elif output_path[:2] == ['', '~']:
351
# ['', '~', ...] -> ...
352
output_path = output_path[2:]
353
path = '/'.join(output_path)
357
relpath = urllib.unquote(relpath).split('/')
358
basepath = self._path.split('/')
359
if len(basepath) > 0 and basepath[-1] == '':
360
basepath = basepath[:-1]
364
if len(basepath) == 0:
365
# In most filesystems, a request for the parent
366
# of root, just returns root.
374
path = '/'.join(basepath)
356
377
def relpath(self, abspath):
357
scheme, username, password, host, port, path = self._split_url(abspath)
378
username, password, host, port, path = self._split_url(abspath)
359
380
if (username != self._username):
360
381
error.append('username mismatch')
395
416
except (IOError, paramiko.SSHException), e:
396
417
self._translate_io_exception(e, path, ': error retrieving')
398
def readv(self, relpath, offsets):
399
"""See Transport.readv()"""
400
# We overload the default readv() because we want to use a file
401
# that does not have prefetch enabled.
402
# Also, if we have a new paramiko, it implements an async readv()
407
path = self._remote_path(relpath)
408
fp = self._sftp.file(path, mode='rb')
409
readv = getattr(fp, 'readv', None)
411
return self._sftp_readv(fp, offsets, relpath)
412
mutter('seek and read %s offsets', len(offsets))
413
return self._seek_and_read(fp, offsets, relpath)
414
except (IOError, paramiko.SSHException), e:
415
self._translate_io_exception(e, path, ': error retrieving')
417
def _sftp_readv(self, fp, offsets, relpath='<unknown>'):
418
"""Use the readv() member of fp to do async readv.
420
And then read them using paramiko.readv(). paramiko.readv()
421
does not support ranges > 64K, so it caps the request size, and
422
just reads until it gets all the stuff it wants
424
offsets = list(offsets)
425
sorted_offsets = sorted(offsets)
427
# The algorithm works as follows:
428
# 1) Coalesce nearby reads into a single chunk
429
# This generates a list of combined regions, the total size
430
# and the size of the sub regions. This coalescing step is limited
431
# in the number of nearby chunks to combine, and is allowed to
432
# skip small breaks in the requests. Limiting it makes sure that
433
# we can start yielding some data earlier, and skipping means we
434
# make fewer requests. (Beneficial even when using async)
435
# 2) Break up this combined regions into chunks that are smaller
436
# than 64KiB. Technically the limit is 65536, but we are a
437
# little bit conservative. This is because sftp has a maximum
438
# return chunk size of 64KiB (max size of an unsigned short)
439
# 3) Issue a readv() to paramiko to create an async request for
441
# 4) Read in the data as it comes back, until we've read one
442
# continuous section as determined in step 1
443
# 5) Break up the full sections into hunks for the original requested
444
# offsets. And put them in a cache
445
# 6) Check if the next request is in the cache, and if it is, remove
446
# it from the cache, and yield its data. Continue until no more
447
# entries are in the cache.
448
# 7) loop back to step 4 until all data has been read
450
# TODO: jam 20060725 This could be optimized one step further, by
451
# attempting to yield whatever data we have read, even before
452
# the first coallesced section has been fully processed.
454
# When coalescing for use with readv(), we don't really need to
455
# use any fudge factor, because the requests are made asynchronously
456
coalesced = list(self._coalesce_offsets(sorted_offsets,
457
limit=self._max_readv_combine,
461
for c_offset in coalesced:
462
start = c_offset.start
463
size = c_offset.length
465
# We need to break this up into multiple requests
467
next_size = min(size, self._max_request_size)
468
requests.append((start, next_size))
472
mutter('SFTP.readv() %s offsets => %s coalesced => %s requests',
473
len(offsets), len(coalesced), len(requests))
475
# Queue the current read until we have read the full coalesced section
478
cur_coalesced_stack = iter(coalesced)
479
cur_coalesced = cur_coalesced_stack.next()
481
# Cache the results, but only until they have been fulfilled
483
# turn the list of offsets into a stack
484
offset_stack = iter(offsets)
485
cur_offset_and_size = offset_stack.next()
487
for data in fp.readv(requests):
489
cur_data_len += len(data)
491
if cur_data_len < cur_coalesced.length:
493
assert cur_data_len == cur_coalesced.length, \
494
"Somehow we read too much: %s != %s" % (cur_data_len,
495
cur_coalesced.length)
496
all_data = ''.join(cur_data)
500
for suboffset, subsize in cur_coalesced.ranges:
501
key = (cur_coalesced.start+suboffset, subsize)
502
data_map[key] = all_data[suboffset:suboffset+subsize]
504
# Now that we've read some data, see if we can yield anything back
505
while cur_offset_and_size in data_map:
506
this_data = data_map.pop(cur_offset_and_size)
507
yield cur_offset_and_size[0], this_data
508
cur_offset_and_size = offset_stack.next()
510
# We read a coalesced entry, so mark it as done
512
# Now that we've read all of the data for this coalesced section
514
cur_coalesced = cur_coalesced_stack.next()
516
if cur_coalesced is not None:
517
raise errors.ShortReadvError(relpath, cur_coalesced.start,
518
cur_coalesced.length, len(data))
520
def put_file(self, relpath, f, mode=None):
522
Copy the file-like object into the location.
419
def get_partial(self, relpath, start, length=None):
421
Get just part of a file.
423
:param relpath: Path to the file, relative to base
424
:param start: The starting position to read from
425
:param length: The length to read. A length of None indicates
426
read to the end of the file.
427
:return: A file-like object containing at least the specified bytes.
428
Some implementations may return objects which can be read
429
past this length, but this is not guaranteed.
431
# TODO: implement get_partial_multi to help with knit support
432
f = self.get(relpath)
434
if self._do_prefetch and hasattr(f, 'prefetch'):
438
def put(self, relpath, f, mode=None):
440
Copy the file-like or string object into the location.
524
442
:param relpath: Location to put the contents, relative to base.
525
:param f: File-like object.
443
:param f: File-like or string object.
526
444
:param mode: The final mode for the file
528
446
final_path = self._remote_path(relpath)
576
481
# raise the original with its traceback if we can.
579
def _put_non_atomic_helper(self, relpath, writer, mode=None,
580
create_parent_dir=False,
582
abspath = self._remote_path(relpath)
584
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
585
# set the file mode at create time. If it does, use it.
586
# But for now, we just chmod later anyway.
588
def _open_and_write_file():
589
"""Try to open the target file, raise error on failure"""
593
fout = self._sftp.file(abspath, mode='wb')
594
fout.set_pipelined(True)
596
except (paramiko.SSHException, IOError), e:
597
self._translate_io_exception(e, abspath,
600
# This is designed to chmod() right before we close.
601
# Because we set_pipelined() earlier, theoretically we might
602
# avoid the round trip for fout.close()
604
self._sftp.chmod(abspath, mode)
609
if not create_parent_dir:
610
_open_and_write_file()
613
# Try error handling to create the parent directory if we need to
615
_open_and_write_file()
617
# Try to create the parent directory, and then go back to
619
parent_dir = os.path.dirname(abspath)
620
self._mkdir(parent_dir, dir_mode)
621
_open_and_write_file()
623
def put_file_non_atomic(self, relpath, f, mode=None,
624
create_parent_dir=False,
626
"""Copy the file-like object into the target location.
628
This function is not strictly safe to use. It is only meant to
629
be used when you already know that the target does not exist.
630
It is not safe, because it will open and truncate the remote
631
file. So there may be a time when the file has invalid contents.
633
:param relpath: The remote location to put the contents.
634
:param f: File-like object.
635
:param mode: Possible access permissions for new file.
636
None means do not set remote permissions.
637
:param create_parent_dir: If we cannot create the target file because
638
the parent directory does not exist, go ahead and
639
create it, and then try again.
643
self._put_non_atomic_helper(relpath, writer, mode=mode,
644
create_parent_dir=create_parent_dir,
647
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
648
create_parent_dir=False,
652
self._put_non_atomic_helper(relpath, writer, mode=mode,
653
create_parent_dir=create_parent_dir,
656
484
def iter_files_recursive(self):
657
485
"""Walk the relative paths of all files in this transport."""
658
486
queue = list(self.list_dir('.'))
660
relpath = queue.pop(0)
488
relpath = urllib.quote(queue.pop(0))
661
489
st = self.stat(relpath)
662
490
if stat.S_ISDIR(st.st_mode):
663
491
for i, basename in enumerate(self.list_dir(relpath)):
668
def _mkdir(self, abspath, mode=None):
674
self._sftp.mkdir(abspath, local_mode)
676
self._sftp.chmod(abspath, mode=mode)
677
except (paramiko.SSHException, IOError), e:
678
self._translate_io_exception(e, abspath, ': unable to mkdir',
679
failure_exc=FileExists)
681
496
def mkdir(self, relpath, mode=None):
682
497
"""Create a directory at the given path."""
683
self._mkdir(self._remote_path(relpath), mode=mode)
499
path = self._remote_path(relpath)
500
# In the paramiko documentation, it says that passing a mode flag
501
# will filtered against the server umask.
502
# StubSFTPServer does not do this, which would be nice, because it is
503
# what we really want :)
504
# However, real servers do use umask, so we really should do it that way
505
self._sftp.mkdir(path)
507
self._sftp.chmod(path, mode=mode)
508
except (paramiko.SSHException, IOError), e:
509
self._translate_io_exception(e, path, ': unable to mkdir',
510
failure_exc=FileExists)
685
512
def _translate_io_exception(self, e, path, more_info='',
686
513
failure_exc=PathError):
824
647
# that we have taken the lock.
825
648
return SFTPLock(relpath, self)
650
def _unparse_url(self, path=None):
653
path = urllib.quote(path)
654
# handle homedir paths
655
if not path.startswith('/'):
657
netloc = urllib.quote(self._host)
658
if self._username is not None:
659
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
660
if self._port is not None:
661
netloc = '%s:%d' % (netloc, self._port)
662
return urlparse.urlunparse(('sftp', netloc, path, '', '', ''))
664
def _split_url(self, url):
665
if isinstance(url, unicode):
666
url = url.encode('utf-8')
667
(scheme, netloc, path, params,
668
query, fragment) = urlparse.urlparse(url, allow_fragments=False)
669
assert scheme == 'sftp'
670
username = password = host = port = None
672
username, host = netloc.split('@', 1)
674
username, password = username.split(':', 1)
675
password = urllib.unquote(password)
676
username = urllib.unquote(username)
681
host, port = host.rsplit(':', 1)
685
# TODO: Should this be ConnectionError?
686
raise TransportError('%s: invalid port number' % port)
687
host = urllib.unquote(host)
689
path = urllib.unquote(path)
691
# the initial slash should be removed from the path, and treated
692
# as a homedir relative path (the path begins with a double slash
693
# if it is absolute).
694
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
695
# RBC 20060118 we are not using this as its too user hostile. instead
696
# we are following lftp and using /~/foo to mean '~/foo'.
697
# handle homedir paths
698
if path.startswith('/~/'):
702
return (username, password, host, port, path)
704
def _parse_url(self, url):
705
(self._username, self._password,
706
self._host, self._port, self._path) = self._split_url(url)
827
708
def _sftp_connect(self):
828
709
"""Connect to the remote sftp server.
829
710
After this, self._sftp should have a valid connection (or
832
713
TODO: Raise a more reasonable ConnectionFailed exception
834
self._sftp = _sftp_connect(self._host, self._port, self._username,
715
global _connected_hosts
717
idx = (self._host, self._port, self._username)
719
self._sftp = _connected_hosts[idx]
724
vendor = _get_ssh_vendor()
725
if vendor == 'loopback':
726
sock = socket.socket()
727
sock.connect((self._host, self._port))
728
self._sftp = SFTPClient(LoopbackSFTP(sock))
729
elif vendor != 'none':
730
sock = SFTPSubprocess(self._host, vendor, self._port,
732
self._sftp = SFTPClient(sock)
734
self._paramiko_connect()
736
_connected_hosts[idx] = self._sftp
738
def _paramiko_connect(self):
739
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
744
t = paramiko.Transport((self._host, self._port or 22))
745
t.set_log_channel('bzr.paramiko')
747
except paramiko.SSHException, e:
748
raise ConnectionError('Unable to reach SSH host %s:%d' %
749
(self._host, self._port), e)
751
server_key = t.get_remote_server_key()
752
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
753
keytype = server_key.get_name()
754
if SYSTEM_HOSTKEYS.has_key(self._host) and SYSTEM_HOSTKEYS[self._host].has_key(keytype):
755
our_server_key = SYSTEM_HOSTKEYS[self._host][keytype]
756
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
757
elif BZR_HOSTKEYS.has_key(self._host) and BZR_HOSTKEYS[self._host].has_key(keytype):
758
our_server_key = BZR_HOSTKEYS[self._host][keytype]
759
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
761
warning('Adding %s host key for %s: %s' % (keytype, self._host, server_key_hex))
762
if not BZR_HOSTKEYS.has_key(self._host):
763
BZR_HOSTKEYS[self._host] = {}
764
BZR_HOSTKEYS[self._host][keytype] = server_key
765
our_server_key = server_key
766
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
768
if server_key != our_server_key:
769
filename1 = os.path.expanduser('~/.ssh/known_hosts')
770
filename2 = pathjoin(config_dir(), 'ssh_host_keys')
771
raise TransportError('Host keys for %s do not match! %s != %s' % \
772
(self._host, our_server_key_hex, server_key_hex),
773
['Try editing %s or %s' % (filename1, filename2)])
778
self._sftp = t.open_sftp_client()
779
except paramiko.SSHException, e:
780
raise ConnectionError('Unable to start sftp client %s:%d' %
781
(self._host, self._port), e)
783
def _sftp_auth(self, transport):
784
# paramiko requires a username, but it might be none if nothing was supplied
785
# use the local username, just in case.
786
# We don't override self._username, because if we aren't using paramiko,
787
# the username might be specified in ~/.ssh/config and we don't want to
788
# force it to something else
789
# Also, it would mess up the self.relpath() functionality
790
username = self._username or getpass.getuser()
792
# Paramiko tries to open a socket.AF_UNIX in order to connect
793
# to ssh-agent. That attribute doesn't exist on win32 (it does in cygwin)
794
# so we get an AttributeError exception. For now, just don't try to
795
# connect to an agent if we are on win32
796
if sys.platform != 'win32':
797
agent = paramiko.Agent()
798
for key in agent.get_keys():
799
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
801
transport.auth_publickey(username, key)
803
except paramiko.SSHException, e:
806
# okay, try finding id_rsa or id_dss? (posix only)
807
if self._try_pkey_auth(transport, paramiko.RSAKey, username, 'id_rsa'):
809
if self._try_pkey_auth(transport, paramiko.DSSKey, username, 'id_dsa'):
814
transport.auth_password(username, self._password)
816
except paramiko.SSHException, e:
819
# FIXME: Don't keep a password held in memory if you can help it
820
#self._password = None
822
# give up and ask for a password
823
password = bzrlib.ui.ui_factory.get_password(
824
prompt='SSH %(user)s@%(host)s password',
825
user=username, host=self._host)
827
transport.auth_password(username, password)
828
except paramiko.SSHException, e:
829
raise ConnectionError('Unable to authenticate to SSH host as %s@%s' %
830
(username, self._host), e)
832
def _try_pkey_auth(self, transport, pkey_class, username, filename):
833
filename = os.path.expanduser('~/.ssh/' + filename)
835
key = pkey_class.from_private_key_file(filename)
836
transport.auth_publickey(username, key)
838
except paramiko.PasswordRequiredException:
839
password = bzrlib.ui.ui_factory.get_password(
840
prompt='SSH %(filename)s password',
843
key = pkey_class.from_private_key_file(filename, password)
844
transport.auth_publickey(username, key)
846
except paramiko.SSHException:
847
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
848
except paramiko.SSHException:
849
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
837
854
def _sftp_open_exclusive(self, abspath, mode=None):
838
855
"""Open a remote path exclusively.
910
917
self._socket.bind(('localhost', 0))
911
918
self._socket.listen(1)
912
919
self.port = self._socket.getsockname()[1]
913
self._stop_event = threading.Event()
920
self.stop_event = threading.Event()
923
s, _ = self._socket.accept()
924
# now close the listen socket
927
self._callback(s, self.stop_event)
929
pass #Ignore socket errors
931
# probably a failed test
932
warning('Exception from within unit test server thread: %r' % x)
916
# called from outside this thread
917
self._stop_event.set()
935
self.stop_event.set()
918
936
# use a timeout here, because if the test fails, the server thread may
919
937
# never notice the stop_event.
925
readable, writable_unused, exception_unused = \
926
select.select([self._socket], [], [], 0.1)
927
if self._stop_event.isSet():
929
if len(readable) == 0:
932
s, addr_unused = self._socket.accept()
933
# because the loopback socket is inline, and transports are
934
# never explicitly closed, best to launch a new thread.
935
threading.Thread(target=self._callback, args=(s,)).start()
936
except socket.error, x:
937
sys.excepthook(*sys.exc_info())
938
warning('Socket error during accept() within unit test server'
941
# probably a failed test; unit test thread will log the
943
sys.excepthook(*sys.exc_info())
944
warning('Exception from within unit test server thread: %r' %
948
class SocketDelay(object):
949
"""A socket decorator to make TCP appear slower.
951
This changes recv, send, and sendall to add a fixed latency to each python
952
call if a new roundtrip is detected. That is, when a recv is called and the
953
flag new_roundtrip is set, latency is charged. Every send and send_all
956
In addition every send, sendall and recv sleeps a bit per character send to
959
Not all methods are implemented, this is deliberate as this class is not a
960
replacement for the builtin sockets layer. fileno is not implemented to
961
prevent the proxy being bypassed.
965
_proxied_arguments = dict.fromkeys([
966
"close", "getpeername", "getsockname", "getsockopt", "gettimeout",
967
"setblocking", "setsockopt", "settimeout", "shutdown"])
969
def __init__(self, sock, latency, bandwidth=1.0,
972
:param bandwith: simulated bandwith (MegaBit)
973
:param really_sleep: If set to false, the SocketDelay will just
974
increase a counter, instead of calling time.sleep. This is useful for
975
unittesting the SocketDelay.
978
self.latency = latency
979
self.really_sleep = really_sleep
980
self.time_per_byte = 1 / (bandwidth / 8.0 * 1024 * 1024)
981
self.new_roundtrip = False
984
if self.really_sleep:
987
SocketDelay.simulated_time += s
989
def __getattr__(self, attr):
990
if attr in SocketDelay._proxied_arguments:
991
return getattr(self.sock, attr)
992
raise AttributeError("'SocketDelay' object has no attribute %r" %
996
return SocketDelay(self.sock.dup(), self.latency, self.time_per_byte,
999
def recv(self, *args):
1000
data = self.sock.recv(*args)
1001
if data and self.new_roundtrip:
1002
self.new_roundtrip = False
1003
self.sleep(self.latency)
1004
self.sleep(len(data) * self.time_per_byte)
1007
def sendall(self, data, flags=0):
1008
if not self.new_roundtrip:
1009
self.new_roundtrip = True
1010
self.sleep(self.latency)
1011
self.sleep(len(data) * self.time_per_byte)
1012
return self.sock.sendall(data, flags)
1014
def send(self, data, flags=0):
1015
if not self.new_roundtrip:
1016
self.new_roundtrip = True
1017
self.sleep(self.latency)
1018
bytes_sent = self.sock.send(data, flags)
1019
self.sleep(bytes_sent * self.time_per_byte)
1023
941
class SFTPServer(Server):
1024
942
"""Common code for SFTP server facilities."""
1026
def __init__(self, server_interface=StubServer):
1027
945
self._original_vendor = None
1028
946
self._homedir = None
1029
947
self._server_homedir = None
1030
948
self._listener = None
1031
949
self._root = None
1032
self._vendor = ssh.ParamikoVendor()
1033
self._server_interface = server_interface
950
self._vendor = 'none'
1034
951
# sftp server logs
1036
self.add_latency = 0
1038
954
def _get_sftp_url(self, path):
1039
955
"""Calculate an sftp url to this server for path."""
1043
959
"""StubServer uses this to log when a new server is created."""
1044
960
self.logs.append(message)
1046
def _run_server_entry(self, sock):
1047
"""Entry point for all implementations of _run_server.
1049
If self.add_latency is > 0.000001 then sock is given a latency adding
1052
if self.add_latency > 0.000001:
1053
sock = SocketDelay(sock, self.add_latency)
1054
return self._run_server(sock)
1056
def _run_server(self, s):
962
def _run_server(self, s, stop_event):
1057
963
ssh_server = paramiko.Transport(s)
1058
key_file = pathjoin(self._homedir, 'test_rsa.key')
1059
f = open(key_file, 'w')
1060
f.write(STUB_SERVER_KEY)
964
key_file = os.path.join(self._homedir, 'test_rsa.key')
965
file(key_file, 'w').write(STUB_SERVER_KEY)
1062
966
host_key = paramiko.RSAKey.from_private_key_file(key_file)
1063
967
ssh_server.add_server_key(host_key)
1064
server = self._server_interface(self)
968
server = StubServer(self)
1065
969
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
1066
970
StubSFTPServer, root=self._root,
1067
971
home=self._server_homedir)
1068
972
event = threading.Event()
1069
973
ssh_server.start_server(event, server)
975
stop_event.wait(30.0)
1072
def setUp(self, backing_server=None):
1073
# XXX: TODO: make sftpserver back onto backing_server rather than local
1075
assert (backing_server is None or
1076
isinstance(backing_server, local.LocalURLServer)), (
1077
"backing_server should not be %r, because this can only serve the "
1078
"local current working directory." % (backing_server,))
1079
self._original_vendor = ssh._ssh_vendor_manager._cached_ssh_vendor
1080
ssh._ssh_vendor_manager._cached_ssh_vendor = self._vendor
1081
if sys.platform == 'win32':
1082
# Win32 needs to use the UNICODE api
1083
self._homedir = getcwd()
1085
# But Linux SFTP servers should just deal in bytestreams
1086
self._homedir = os.getcwd()
979
self._original_vendor = _ssh_vendor
980
_ssh_vendor = self._vendor
981
self._homedir = os.getcwdu()
1087
982
if self._server_homedir is None:
1088
983
self._server_homedir = self._homedir
1089
984
self._root = '/'
1090
if sys.platform == 'win32':
1092
self._listener = SocketListener(self._run_server_entry)
985
# FIXME WINDOWS: _root should be _server_homedir[0]:/
986
self._listener = SingleListener(self._run_server)
1093
987
self._listener.setDaemon(True)
1094
988
self._listener.start()
1096
990
def tearDown(self):
1097
991
"""See bzrlib.transport.Server.tearDown."""
1098
993
self._listener.stop()
1099
ssh._ssh_vendor_manager._cached_ssh_vendor = self._original_vendor
1101
def get_bogus_url(self):
1102
"""See bzrlib.transport.Server.get_bogus_url."""
1103
# this is chosen to try to prevent trouble with proxies, wierd dns, etc
1104
# we bind a random socket, so that we get a guaranteed unused port
1105
# we just never listen on that port
1107
s.bind(('localhost', 0))
1108
return 'sftp://%s:%s/' % s.getsockname()
994
_ssh_vendor = self._original_vendor
1111
997
class SFTPFullAbsoluteServer(SFTPServer):
1188
1047
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
1189
"""A test server for sftp transports where only absolute paths will work.
1191
It does this by serving from a deeply-nested directory that doesn't exist.
1194
def setUp(self, backing_server=None):
1048
"""A test servere for sftp transports, using absolute urls to non-home."""
1195
1051
self._server_homedir = '/dev/noone/runs/tests/here'
1196
super(SFTPSiblingAbsoluteServer, self).setUp(backing_server)
1199
def _sftp_connect(host, port, username, password):
1200
"""Connect to the remote sftp server.
1202
:raises: a TransportError 'could not connect'.
1204
:returns: an paramiko.sftp_client.SFTPClient
1206
TODO: Raise a more reasonable ConnectionFailed exception
1208
idx = (host, port, username)
1210
return _connected_hosts[idx]
1214
sftp = _sftp_connect_uncached(host, port, username, password)
1215
_connected_hosts[idx] = sftp
1218
def _sftp_connect_uncached(host, port, username, password):
1219
vendor = ssh._get_ssh_vendor()
1220
sftp = vendor.connect_sftp(username, password, host, port)
1052
super(SFTPSiblingAbsoluteServer, self).setUp()
1224
1055
def get_test_permutations():
added
removed
bzrlib/transport/sftp.py
