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,
51
import bzrlib.urlutils as urlutils
68
60
CMD_HANDLE, CMD_OPEN)
69
61
from paramiko.sftp_attr import SFTPAttributes
70
62
from paramiko.sftp_file import SFTPFile
63
from paramiko.sftp_client import SFTPClient
73
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()
76
220
# This is a weakref dictionary, so that we can reuse connections
77
221
# that are still active. Long term, it might be nice to have some
78
222
# sort of expiration policy, such as disconnect if inactive for
79
223
# X seconds. But that requires a lot more fanciness.
80
224
_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
226
def clear_connection_cache():
89
227
"""Remove all hosts from the SFTP connection cache.
93
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))
96
271
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.
272
"""This fakes a lock in a remote location."""
104
273
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
106
274
def __init__(self, path, transport):
107
275
assert isinstance(transport, SFTPTransport)
134
302
# 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):
305
class SFTPTransport (Transport):
307
Transport implementation for SFTP access.
309
_do_prefetch = _default_do_prefetch
311
def __init__(self, base, clone_from=None):
312
assert base.startswith('sftp://')
142
313
self._parse_url(base)
143
base = self._unparse_url(self._path)
314
base = self._unparse_url()
144
315
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
317
super(SFTPTransport, self).__init__(base)
223
318
if clone_from is None:
224
319
self._sftp_connect()
245
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))
247
351
def _remote_path(self, relpath):
248
352
"""Return the path to be passed along the sftp protocol for relpath.
250
354
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
356
# FIXME: share the common code across transports
300
357
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)
358
relpath = urlutils.unescape(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)
356
378
def relpath(self, abspath):
357
scheme, username, password, host, port, path = self._split_url(abspath)
379
username, password, host, port, path = self._split_url(abspath)
359
381
if (username != self._username):
360
382
error.append('username mismatch')
395
417
except (IOError, paramiko.SSHException), e:
396
418
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.
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.
524
443
:param relpath: Location to put the contents, relative to base.
525
:param f: File-like object.
444
:param f: File-like or string object.
526
445
:param mode: The final mode for the file
528
447
final_path = self._remote_path(relpath)
576
482
# 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
485
def iter_files_recursive(self):
657
486
"""Walk the relative paths of all files in this transport."""
658
487
queue = list(self.list_dir('.'))
660
relpath = queue.pop(0)
489
relpath = urllib.quote(queue.pop(0))
661
490
st = self.stat(relpath)
662
491
if stat.S_ISDIR(st.st_mode):
663
492
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
497
def mkdir(self, relpath, mode=None):
682
498
"""Create a directory at the given path."""
683
self._mkdir(self._remote_path(relpath), mode=mode)
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)
509
except (paramiko.SSHException, IOError), e:
510
self._translate_io_exception(e, path, ': unable to mkdir',
511
failure_exc=FileExists)
685
513
def _translate_io_exception(self, e, path, more_info='',
686
514
failure_exc=PathError):
824
648
# that we have taken the lock.
825
649
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)
827
686
def _sftp_connect(self):
828
687
"""Connect to the remote sftp server.
829
688
After this, self._sftp should have a valid connection (or
832
691
TODO: Raise a more reasonable ConnectionFailed exception
834
self._sftp = _sftp_connect(self._host, self._port, self._username,
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),))
837
832
def _sftp_open_exclusive(self, abspath, mode=None):
838
833
"""Open a remote path exclusively.
910
895
self._socket.bind(('localhost', 0))
911
896
self._socket.listen(1)
912
897
self.port = self._socket.getsockname()[1]
913
self._stop_event = threading.Event()
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)
916
# called from outside this thread
917
self._stop_event.set()
913
self.stop_event.set()
918
914
# use a timeout here, because if the test fails, the server thread may
919
915
# 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
919
class SFTPServer(Server):
1024
920
"""Common code for SFTP server facilities."""
1026
def __init__(self, server_interface=StubServer):
1027
923
self._original_vendor = None
1028
924
self._homedir = None
1029
925
self._server_homedir = None
1030
926
self._listener = None
1031
927
self._root = None
1032
self._vendor = ssh.ParamikoVendor()
1033
self._server_interface = server_interface
928
self._vendor = 'none'
1034
929
# sftp server logs
1036
self.add_latency = 0
1038
932
def _get_sftp_url(self, path):
1039
933
"""Calculate an sftp url to this server for path."""
1043
937
"""StubServer uses this to log when a new server is created."""
1044
938
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):
940
def _run_server(self, s, stop_event):
1057
941
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)
942
key_file = os.path.join(self._homedir, 'test_rsa.key')
943
file(key_file, 'w').write(STUB_SERVER_KEY)
1062
944
host_key = paramiko.RSAKey.from_private_key_file(key_file)
1063
945
ssh_server.add_server_key(host_key)
1064
server = self._server_interface(self)
946
server = StubServer(self)
1065
947
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
1066
948
StubSFTPServer, root=self._root,
1067
949
home=self._server_homedir)
1068
950
event = threading.Event()
1069
951
ssh_server.start_server(event, server)
953
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()
957
self._original_vendor = _ssh_vendor
958
_ssh_vendor = self._vendor
959
self._homedir = os.getcwd()
1087
960
if self._server_homedir is None:
1088
961
self._server_homedir = self._homedir
1089
962
self._root = '/'
1090
if sys.platform == 'win32':
1092
self._listener = SocketListener(self._run_server_entry)
963
# FIXME WINDOWS: _root should be _server_homedir[0]:/
964
self._listener = SingleListener(self._run_server)
1093
965
self._listener.setDaemon(True)
1094
966
self._listener.start()
1096
968
def tearDown(self):
1097
969
"""See bzrlib.transport.Server.tearDown."""
1098
971
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()
972
_ssh_vendor = self._original_vendor
1111
975
class SFTPFullAbsoluteServer(SFTPServer):
1188
1025
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):
1026
"""A test servere for sftp transports, using absolute urls to non-home."""
1195
1029
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)
1030
super(SFTPSiblingAbsoluteServer, self).setUp()
1224
1033
def get_test_permutations():
added
removed
bzrlib/transport/sftp.py
