1
# Copyright (C) 2005 Robey Pointer <robey@lag.net>
2
# Copyright (C) 2005, 2006 Canonical Ltd
1
# Copyright (C) 2005 Robey Pointer <robey@lag.net>, Canonical Ltd
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
6
5
# the Free Software Foundation; either version 2 of the License, or
7
6
# (at your option) any later version.
9
8
# This program is distributed in the hope that it will be useful,
10
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
11
# GNU General Public License for more details.
14
13
# You should have received a copy of the GNU General Public License
15
14
# along with this program; if not, write to the Free Software
16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
17
"""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,
32
from bzrlib.config import config_dir, ensure_config_dir_exists
33
from bzrlib.errors import (ConnectionError,
35
TransportNotPossible, NoSuchFile, PathNotChild,
37
LockError, ParamikoNotPresent
50
from bzrlib.osutils import pathjoin, fancy_rename, getcwd
51
from bzrlib.trace import mutter, warning
52
from bzrlib.transport import (
53
register_urlparse_netloc_protocol,
39
from bzrlib.osutils import pathjoin, fancy_rename
40
from bzrlib.trace import mutter, warning, error
41
from bzrlib.transport import Transport, Server, urlescape
67
51
CMD_HANDLE, CMD_OPEN)
68
52
from paramiko.sftp_attr import SFTPAttributes
69
53
from paramiko.sftp_file import SFTPFile
72
register_urlparse_netloc_protocol('sftp')
54
from paramiko.sftp_client import SFTPClient
56
if 'sftp' not in urlparse.uses_netloc:
57
urlparse.uses_netloc.append('sftp')
59
# don't use prefetch unless paramiko version >= 1.5.2 (there were bugs earlier)
60
_default_do_prefetch = False
61
if getattr(paramiko, '__version_info__', (0, 0, 0)) >= (1, 5, 2):
62
_default_do_prefetch = True
66
if sys.platform == 'win32':
67
# close_fds not supported on win32
72
def _get_ssh_vendor():
73
"""Find out what version of SSH is on the system."""
75
if _ssh_vendor is not None:
80
if 'BZR_SSH' in os.environ:
81
_ssh_vendor = os.environ['BZR_SSH']
82
if _ssh_vendor == 'paramiko':
87
p = subprocess.Popen(['ssh', '-V'],
89
stdin=subprocess.PIPE,
90
stdout=subprocess.PIPE,
91
stderr=subprocess.PIPE)
92
returncode = p.returncode
93
stdout, stderr = p.communicate()
97
if 'OpenSSH' in stderr:
98
mutter('ssh implementation is OpenSSH')
99
_ssh_vendor = 'openssh'
100
elif 'SSH Secure Shell' in stderr:
101
mutter('ssh implementation is SSH Corp.')
104
if _ssh_vendor != 'none':
107
# XXX: 20051123 jamesh
108
# A check for putty's plink or lsh would go here.
110
mutter('falling back to paramiko implementation')
114
class SFTPSubprocess:
115
"""A socket-like object that talks to an ssh subprocess via pipes."""
116
def __init__(self, hostname, vendor, port=None, user=None):
117
assert vendor in ['openssh', 'ssh']
118
if vendor == 'openssh':
120
'-oForwardX11=no', '-oForwardAgent=no',
121
'-oClearAllForwardings=yes', '-oProtocol=2',
122
'-oNoHostAuthenticationForLocalhost=yes']
124
args.extend(['-p', str(port)])
126
args.extend(['-l', user])
127
args.extend(['-s', hostname, 'sftp'])
128
elif vendor == 'ssh':
131
args.extend(['-p', str(port)])
133
args.extend(['-l', user])
134
args.extend(['-s', 'sftp', hostname])
136
self.proc = subprocess.Popen(args, close_fds=_close_fds,
137
stdin=subprocess.PIPE,
138
stdout=subprocess.PIPE)
140
def send(self, data):
141
return os.write(self.proc.stdin.fileno(), data)
143
def recv_ready(self):
144
# TODO: jam 20051215 this function is necessary to support the
145
# pipelined() function. In reality, it probably should use
146
# poll() or select() to actually return if there is data
147
# available, otherwise we probably don't get any benefit
150
def recv(self, count):
151
return os.read(self.proc.stdout.fileno(), count)
154
self.proc.stdin.close()
155
self.proc.stdout.close()
159
class LoopbackSFTP(object):
160
"""Simple wrapper for a socket that pretends to be a paramiko Channel."""
162
def __init__(self, sock):
165
def send(self, data):
166
return self.__socket.send(data)
169
return self.__socket.recv(n)
171
def recv_ready(self):
175
self.__socket.close()
75
181
# This is a weakref dictionary, so that we can reuse connections
76
182
# that are still active. Long term, it might be nice to have some
79
185
_connected_hosts = weakref.WeakValueDictionary()
82
_paramiko_version = getattr(paramiko, '__version_info__', (0, 0, 0))
83
# don't use prefetch unless paramiko version >= 1.5.5 (there were bugs earlier)
84
_default_do_prefetch = (_paramiko_version >= (1, 5, 5))
87
def clear_connection_cache():
88
"""Remove all hosts from the SFTP connection cache.
90
Primarily useful for test cases wanting to force garbage collection.
92
_connected_hosts.clear()
188
def load_host_keys():
190
Load system host keys (probably doesn't work on windows) and any
191
"discovered" keys from previous sessions.
193
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
195
SYSTEM_HOSTKEYS = paramiko.util.load_host_keys(os.path.expanduser('~/.ssh/known_hosts'))
197
mutter('failed to load system host keys: ' + str(e))
198
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
200
BZR_HOSTKEYS = paramiko.util.load_host_keys(bzr_hostkey_path)
202
mutter('failed to load bzr host keys: ' + str(e))
206
def save_host_keys():
208
Save "discovered" host keys in $(config)/ssh_host_keys/.
210
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
211
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
212
ensure_config_dir_exists()
215
f = open(bzr_hostkey_path, 'w')
216
f.write('# SSH host keys collected by bzr\n')
217
for hostname, keys in BZR_HOSTKEYS.iteritems():
218
for keytype, key in keys.iteritems():
219
f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
222
mutter('failed to save bzr host keys: ' + str(e))
95
225
class SFTPLock(object):
96
"""This fakes a lock in a remote location.
98
A present lock is indicated just by the existence of a file. This
99
doesn't work well on all transports and they are only used in
100
deprecated storage formats.
226
"""This fakes a lock in a remote location."""
103
227
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
105
228
def __init__(self, path, transport):
106
229
assert isinstance(transport, SFTPTransport)
133
256
# What specific errors should we catch here?
137
class SFTPUrlHandling(Transport):
138
"""Mix-in that does common handling of SSH/SFTP URLs."""
140
def __init__(self, base):
259
class SFTPTransport (Transport):
261
Transport implementation for SFTP access.
263
_do_prefetch = _default_do_prefetch
265
def __init__(self, base, clone_from=None):
266
assert base.startswith('sftp://')
141
267
self._parse_url(base)
142
base = self._unparse_url(self._path)
268
base = self._unparse_url()
143
269
if base[-1] != '/':
145
super(SFTPUrlHandling, self).__init__(base)
147
def _parse_url(self, url):
149
self._username, self._password,
150
self._host, self._port, self._path) = self._split_url(url)
152
def _unparse_url(self, path):
153
"""Return a URL for a path relative to this transport.
155
path = urllib.quote(path)
156
# handle homedir paths
157
if not path.startswith('/'):
159
netloc = urllib.quote(self._host)
160
if self._username is not None:
161
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
162
if self._port is not None:
163
netloc = '%s:%d' % (netloc, self._port)
164
return urlparse.urlunparse((self._scheme, netloc, path, '', '', ''))
166
def _split_url(self, url):
167
(scheme, username, password, host, port, path) = split_url(url)
168
## assert scheme == 'sftp'
170
# the initial slash should be removed from the path, and treated
171
# as a homedir relative path (the path begins with a double slash
172
# if it is absolute).
173
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
174
# RBC 20060118 we are not using this as its too user hostile. instead
175
# we are following lftp and using /~/foo to mean '~/foo'.
176
# handle homedir paths
177
if path.startswith('/~/'):
181
return (scheme, username, password, host, port, path)
183
def abspath(self, relpath):
184
"""Return the full url to the given relative path.
186
@param relpath: the relative path or path components
187
@type relpath: str or list
189
return self._unparse_url(self._remote_path(relpath))
191
def _remote_path(self, relpath):
192
"""Return the path to be passed along the sftp protocol for relpath.
194
:param relpath: is a urlencoded string.
196
return self._combine_paths(self._path, relpath)
199
class SFTPTransport(SFTPUrlHandling):
200
"""Transport implementation for SFTP access."""
202
_do_prefetch = _default_do_prefetch
203
# TODO: jam 20060717 Conceivably these could be configurable, either
204
# by auto-tuning at run-time, or by a configuration (per host??)
205
# but the performance curve is pretty flat, so just going with
206
# reasonable defaults.
207
_max_readv_combine = 200
208
# Having to round trip to the server means waiting for a response,
209
# so it is better to download extra bytes.
210
# 8KiB had good performance for both local and remote network operations
211
_bytes_to_read_before_seek = 8192
213
# The sftp spec says that implementations SHOULD allow reads
214
# to be at least 32K. paramiko.readv() does an async request
215
# for the chunks. So we need to keep it within a single request
216
# size for paramiko <= 1.6.1. paramiko 1.6.2 will probably chop
217
# up the request itself, rather than us having to worry about it
218
_max_request_size = 32768
220
def __init__(self, base, clone_from=None):
221
271
super(SFTPTransport, self).__init__(base)
222
272
if clone_from is None:
223
273
self._sftp_connect()
244
294
return SFTPTransport(self.abspath(offset), self)
296
def abspath(self, relpath):
298
Return the full url to the given relative path.
300
@param relpath: the relative path or path components
301
@type relpath: str or list
303
return self._unparse_url(self._remote_path(relpath))
246
305
def _remote_path(self, relpath):
247
306
"""Return the path to be passed along the sftp protocol for relpath.
249
308
relpath is a urlencoded string.
251
:return: a path prefixed with / for regular abspath-based urls, or a
252
path that does not begin with / for urls which begin with /~/.
254
# how does this work?
255
# it processes relpath with respect to
257
# firstly we create a path to evaluate:
258
# if relpath is an abspath or homedir path, its the entire thing
259
# otherwise we join our base with relpath
260
# then we eliminate all empty segments (double //'s) outside the first
261
# two elements of the list. This avoids problems with trailing
262
# slashes, or other abnormalities.
263
# finally we evaluate the entire path in a single pass
265
# '..' result in popping the left most already
266
# processed path (which can never be empty because of the check for
267
# abspath and homedir meaning that its not, or that we've used our
268
# path. If the pop would pop the root, we ignore it.
270
# Specific case examinations:
271
# remove the special casefor ~: if the current root is ~/ popping of it
272
# = / thus our seed for a ~ based path is ['', '~']
273
# and if we end up with [''] then we had basically ('', '..') (which is
274
# '/..' so we append '' if the length is one, and assert that the first
275
# element is still ''. Lastly, if we end with ['', '~'] as a prefix for
276
# the output, we've got a homedir path, so we strip that prefix before
277
# '/' joining the resulting list.
279
# case one: '/' -> ['', ''] cannot shrink
280
# case two: '/' + '../foo' -> ['', 'foo'] (take '', '', '..', 'foo')
281
# and pop the second '' for the '..', append 'foo'
282
# case three: '/~/' -> ['', '~', '']
283
# case four: '/~/' + '../foo' -> ['', '~', '', '..', 'foo'],
284
# and we want to get '/foo' - the empty path in the middle
285
# needs to be stripped, then normal path manipulation will
287
# case five: '/..' ['', '..'], we want ['', '']
288
# stripping '' outside the first two is ok
289
# ignore .. if its too high up
291
# lastly this code is possibly reusable by FTP, but not reusable by
292
# local paths: ~ is resolvable correctly, nor by HTTP or the smart
293
# server: ~ is resolved remotely.
295
# however, a version of this that acts on self.base is possible to be
296
# written which manipulates the URL in canonical form, and would be
297
# reusable for all transports, if a flag for allowing ~/ at all was
310
# FIXME: share the common code across transports
299
311
assert isinstance(relpath, basestring)
300
relpath = urlutils.unescape(relpath)
303
if relpath.startswith('/'):
304
# abspath - normal split is fine.
305
current_path = relpath.split('/')
306
elif relpath.startswith('~/'):
307
# root is homedir based: normal split and prefix '' to remote the
309
current_path = [''].extend(relpath.split('/'))
311
# root is from the current directory:
312
if self._path.startswith('/'):
313
# abspath, take the regular split
316
# homedir based, add the '', '~' not present in self._path
317
current_path = ['', '~']
318
# add our current dir
319
current_path.extend(self._path.split('/'))
320
# add the users relpath
321
current_path.extend(relpath.split('/'))
322
# strip '' segments that are not in the first one - the leading /.
323
to_process = current_path[:1]
324
for segment in current_path[1:]:
326
to_process.append(segment)
328
# process '.' and '..' segments into output_path.
330
for segment in to_process:
332
# directory pop. Remove a directory
333
# as long as we are not at the root
334
if len(output_path) > 1:
337
# cannot pop beyond the root, so do nothing
339
continue # strip the '.' from the output.
341
# this will append '' to output_path for the root elements,
342
# which is appropriate: its why we strip '' in the first pass.
343
output_path.append(segment)
345
# check output special cases:
346
if output_path == ['']:
348
output_path = ['', '']
349
elif output_path[:2] == ['', '~']:
350
# ['', '~', ...] -> ...
351
output_path = output_path[2:]
352
path = '/'.join(output_path)
312
relpath = urllib.unquote(relpath).split('/')
313
basepath = self._path.split('/')
314
if len(basepath) > 0 and basepath[-1] == '':
315
basepath = basepath[:-1]
319
if len(basepath) == 0:
320
# In most filesystems, a request for the parent
321
# of root, just returns root.
329
path = '/'.join(basepath)
355
332
def relpath(self, abspath):
356
scheme, username, password, host, port, path = self._split_url(abspath)
333
username, password, host, port, path = self._split_url(abspath)
358
335
if (username != self._username):
359
336
error.append('username mismatch')
394
371
except (IOError, paramiko.SSHException), e:
395
372
self._translate_io_exception(e, path, ': error retrieving')
397
def readv(self, relpath, offsets):
398
"""See Transport.readv()"""
399
# We overload the default readv() because we want to use a file
400
# that does not have prefetch enabled.
401
# Also, if we have a new paramiko, it implements an async readv()
406
path = self._remote_path(relpath)
407
fp = self._sftp.file(path, mode='rb')
408
readv = getattr(fp, 'readv', None)
410
return self._sftp_readv(fp, offsets, relpath)
411
mutter('seek and read %s offsets', len(offsets))
412
return self._seek_and_read(fp, offsets, relpath)
413
except (IOError, paramiko.SSHException), e:
414
self._translate_io_exception(e, path, ': error retrieving')
416
def _sftp_readv(self, fp, offsets, relpath='<unknown>'):
417
"""Use the readv() member of fp to do async readv.
419
And then read them using paramiko.readv(). paramiko.readv()
420
does not support ranges > 64K, so it caps the request size, and
421
just reads until it gets all the stuff it wants
423
offsets = list(offsets)
424
sorted_offsets = sorted(offsets)
426
# The algorithm works as follows:
427
# 1) Coalesce nearby reads into a single chunk
428
# This generates a list of combined regions, the total size
429
# and the size of the sub regions. This coalescing step is limited
430
# in the number of nearby chunks to combine, and is allowed to
431
# skip small breaks in the requests. Limiting it makes sure that
432
# we can start yielding some data earlier, and skipping means we
433
# make fewer requests. (Beneficial even when using async)
434
# 2) Break up this combined regions into chunks that are smaller
435
# than 64KiB. Technically the limit is 65536, but we are a
436
# little bit conservative. This is because sftp has a maximum
437
# return chunk size of 64KiB (max size of an unsigned short)
438
# 3) Issue a readv() to paramiko to create an async request for
440
# 4) Read in the data as it comes back, until we've read one
441
# continuous section as determined in step 1
442
# 5) Break up the full sections into hunks for the original requested
443
# offsets. And put them in a cache
444
# 6) Check if the next request is in the cache, and if it is, remove
445
# it from the cache, and yield its data. Continue until no more
446
# entries are in the cache.
447
# 7) loop back to step 4 until all data has been read
449
# TODO: jam 20060725 This could be optimized one step further, by
450
# attempting to yield whatever data we have read, even before
451
# the first coallesced section has been fully processed.
453
# When coalescing for use with readv(), we don't really need to
454
# use any fudge factor, because the requests are made asynchronously
455
coalesced = list(self._coalesce_offsets(sorted_offsets,
456
limit=self._max_readv_combine,
460
for c_offset in coalesced:
461
start = c_offset.start
462
size = c_offset.length
464
# We need to break this up into multiple requests
466
next_size = min(size, self._max_request_size)
467
requests.append((start, next_size))
471
mutter('SFTP.readv() %s offsets => %s coalesced => %s requests',
472
len(offsets), len(coalesced), len(requests))
474
# Queue the current read until we have read the full coalesced section
477
cur_coalesced_stack = iter(coalesced)
478
cur_coalesced = cur_coalesced_stack.next()
480
# Cache the results, but only until they have been fulfilled
482
# turn the list of offsets into a stack
483
offset_stack = iter(offsets)
484
cur_offset_and_size = offset_stack.next()
486
for data in fp.readv(requests):
488
cur_data_len += len(data)
490
if cur_data_len < cur_coalesced.length:
492
assert cur_data_len == cur_coalesced.length, \
493
"Somehow we read too much: %s != %s" % (cur_data_len,
494
cur_coalesced.length)
495
all_data = ''.join(cur_data)
499
for suboffset, subsize in cur_coalesced.ranges:
500
key = (cur_coalesced.start+suboffset, subsize)
501
data_map[key] = all_data[suboffset:suboffset+subsize]
503
# Now that we've read some data, see if we can yield anything back
504
while cur_offset_and_size in data_map:
505
this_data = data_map.pop(cur_offset_and_size)
506
yield cur_offset_and_size[0], this_data
507
cur_offset_and_size = offset_stack.next()
509
# We read a coalesced entry, so mark it as done
511
# Now that we've read all of the data for this coalesced section
513
cur_coalesced = cur_coalesced_stack.next()
515
if cur_coalesced is not None:
516
raise errors.ShortReadvError(relpath, cur_coalesced.start,
517
cur_coalesced.length, len(data))
519
def put_file(self, relpath, f, mode=None):
521
Copy the file-like object into the location.
374
def get_partial(self, relpath, start, length=None):
376
Get just part of a file.
378
:param relpath: Path to the file, relative to base
379
:param start: The starting position to read from
380
:param length: The length to read. A length of None indicates
381
read to the end of the file.
382
:return: A file-like object containing at least the specified bytes.
383
Some implementations may return objects which can be read
384
past this length, but this is not guaranteed.
386
# TODO: implement get_partial_multi to help with knit support
387
f = self.get(relpath)
389
if self._do_prefetch and hasattr(f, 'prefetch'):
393
def put(self, relpath, f, mode=None):
395
Copy the file-like or string object into the location.
523
397
:param relpath: Location to put the contents, relative to base.
524
:param f: File-like object.
398
:param f: File-like or string object.
525
399
:param mode: The final mode for the file
527
401
final_path = self._remote_path(relpath)
539
413
self._pump(f, fout)
540
414
except (IOError, paramiko.SSHException), e:
541
415
self._translate_io_exception(e, tmp_abspath)
542
# XXX: This doesn't truly help like we would like it to.
543
# The problem is that openssh strips sticky bits. So while we
544
# can properly set group write permission, we lose the group
545
# sticky bit. So it is probably best to stop chmodding, and
546
# just tell users that they need to set the umask correctly.
547
# The attr.st_mode = mode, in _sftp_open_exclusive
548
# will handle when the user wants the final mode to be more
549
# restrictive. And then we avoid a round trip. Unless
550
# paramiko decides to expose an async chmod()
552
# This is designed to chmod() right before we close.
553
# Because we set_pipelined() earlier, theoretically we might
554
# avoid the round trip for fout.close()
555
416
if mode is not None:
556
417
self._sftp.chmod(tmp_abspath, mode)
559
self._rename_and_overwrite(tmp_abspath, abspath)
420
self._rename(tmp_abspath, abspath)
560
421
except Exception, e:
561
422
# If we fail, try to clean up the temporary file
562
423
# before we throw the exception
575
436
# raise the original with its traceback if we can.
578
def _put_non_atomic_helper(self, relpath, writer, mode=None,
579
create_parent_dir=False,
581
abspath = self._remote_path(relpath)
583
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
584
# set the file mode at create time. If it does, use it.
585
# But for now, we just chmod later anyway.
587
def _open_and_write_file():
588
"""Try to open the target file, raise error on failure"""
592
fout = self._sftp.file(abspath, mode='wb')
593
fout.set_pipelined(True)
595
except (paramiko.SSHException, IOError), e:
596
self._translate_io_exception(e, abspath,
599
# This is designed to chmod() right before we close.
600
# Because we set_pipelined() earlier, theoretically we might
601
# avoid the round trip for fout.close()
603
self._sftp.chmod(abspath, mode)
608
if not create_parent_dir:
609
_open_and_write_file()
612
# Try error handling to create the parent directory if we need to
614
_open_and_write_file()
616
# Try to create the parent directory, and then go back to
618
parent_dir = os.path.dirname(abspath)
619
self._mkdir(parent_dir, dir_mode)
620
_open_and_write_file()
622
def put_file_non_atomic(self, relpath, f, mode=None,
623
create_parent_dir=False,
625
"""Copy the file-like object into the target location.
627
This function is not strictly safe to use. It is only meant to
628
be used when you already know that the target does not exist.
629
It is not safe, because it will open and truncate the remote
630
file. So there may be a time when the file has invalid contents.
632
:param relpath: The remote location to put the contents.
633
:param f: File-like object.
634
:param mode: Possible access permissions for new file.
635
None means do not set remote permissions.
636
:param create_parent_dir: If we cannot create the target file because
637
the parent directory does not exist, go ahead and
638
create it, and then try again.
642
self._put_non_atomic_helper(relpath, writer, mode=mode,
643
create_parent_dir=create_parent_dir,
646
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
647
create_parent_dir=False,
651
self._put_non_atomic_helper(relpath, writer, mode=mode,
652
create_parent_dir=create_parent_dir,
655
439
def iter_files_recursive(self):
656
440
"""Walk the relative paths of all files in this transport."""
657
441
queue = list(self.list_dir('.'))
659
relpath = queue.pop(0)
443
relpath = urllib.quote(queue.pop(0))
660
444
st = self.stat(relpath)
661
445
if stat.S_ISDIR(st.st_mode):
662
446
for i, basename in enumerate(self.list_dir(relpath)):
667
def _mkdir(self, abspath, mode=None):
673
self._sftp.mkdir(abspath, local_mode)
675
self._sftp.chmod(abspath, mode=mode)
676
except (paramiko.SSHException, IOError), e:
677
self._translate_io_exception(e, abspath, ': unable to mkdir',
678
failure_exc=FileExists)
680
451
def mkdir(self, relpath, mode=None):
681
452
"""Create a directory at the given path."""
682
self._mkdir(self._remote_path(relpath), mode=mode)
454
path = self._remote_path(relpath)
455
# In the paramiko documentation, it says that passing a mode flag
456
# will filtered against the server umask.
457
# StubSFTPServer does not do this, which would be nice, because it is
458
# what we really want :)
459
# However, real servers do use umask, so we really should do it that way
460
self._sftp.mkdir(path)
462
self._sftp.chmod(path, mode=mode)
463
except (paramiko.SSHException, IOError), e:
464
self._translate_io_exception(e, path, ': unable to mkdir',
465
failure_exc=FileExists)
684
def _translate_io_exception(self, e, path, more_info='',
685
failure_exc=PathError):
467
def _translate_io_exception(self, e, path, more_info='', failure_exc=NoSuchFile):
686
468
"""Translate a paramiko or IOError into a friendlier exception.
688
470
:param e: The original exception
823
588
# that we have taken the lock.
824
589
return SFTPLock(relpath, self)
591
def _unparse_url(self, path=None):
594
path = urllib.quote(path)
595
# handle homedir paths
596
if not path.startswith('/'):
598
netloc = urllib.quote(self._host)
599
if self._username is not None:
600
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
601
if self._port is not None:
602
netloc = '%s:%d' % (netloc, self._port)
604
return urlparse.urlunparse(('sftp', netloc, path, '', '', ''))
606
def _split_url(self, url):
607
if isinstance(url, unicode):
608
url = url.encode('utf-8')
609
(scheme, netloc, path, params,
610
query, fragment) = urlparse.urlparse(url, allow_fragments=False)
611
assert scheme == 'sftp'
612
username = password = host = port = None
614
username, host = netloc.split('@', 1)
616
username, password = username.split(':', 1)
617
password = urllib.unquote(password)
618
username = urllib.unquote(username)
623
host, port = host.rsplit(':', 1)
627
# TODO: Should this be ConnectionError?
628
raise TransportError('%s: invalid port number' % port)
629
host = urllib.unquote(host)
631
path = urllib.unquote(path)
633
# the initial slash should be removed from the path, and treated
634
# as a homedir relative path (the path begins with a double slash
635
# if it is absolute).
636
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
637
# RBC 20060118 we are not using this as its too user hostile. instead
638
# we are following lftp and using /~/foo to mean '~/foo'.
639
# handle homedir paths
640
if path.startswith('/~/'):
644
return (username, password, host, port, path)
646
def _parse_url(self, url):
647
(self._username, self._password,
648
self._host, self._port, self._path) = self._split_url(url)
826
650
def _sftp_connect(self):
827
651
"""Connect to the remote sftp server.
828
652
After this, self._sftp should have a valid connection (or
831
655
TODO: Raise a more reasonable ConnectionFailed exception
833
self._sftp = _sftp_connect(self._host, self._port, self._username,
657
global _connected_hosts
659
idx = (self._host, self._port, self._username)
661
self._sftp = _connected_hosts[idx]
666
vendor = _get_ssh_vendor()
667
if vendor == 'loopback':
668
sock = socket.socket()
669
sock.connect((self._host, self._port))
670
self._sftp = SFTPClient(LoopbackSFTP(sock))
671
elif vendor != 'none':
672
sock = SFTPSubprocess(self._host, vendor, self._port,
674
self._sftp = SFTPClient(sock)
676
self._paramiko_connect()
678
_connected_hosts[idx] = self._sftp
680
def _paramiko_connect(self):
681
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
686
t = paramiko.Transport((self._host, self._port or 22))
687
t.set_log_channel('bzr.paramiko')
689
except paramiko.SSHException, e:
690
raise ConnectionError('Unable to reach SSH host %s:%d' %
691
(self._host, self._port), e)
693
server_key = t.get_remote_server_key()
694
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
695
keytype = server_key.get_name()
696
if SYSTEM_HOSTKEYS.has_key(self._host) and SYSTEM_HOSTKEYS[self._host].has_key(keytype):
697
our_server_key = SYSTEM_HOSTKEYS[self._host][keytype]
698
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
699
elif BZR_HOSTKEYS.has_key(self._host) and BZR_HOSTKEYS[self._host].has_key(keytype):
700
our_server_key = BZR_HOSTKEYS[self._host][keytype]
701
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
703
warning('Adding %s host key for %s: %s' % (keytype, self._host, server_key_hex))
704
if not BZR_HOSTKEYS.has_key(self._host):
705
BZR_HOSTKEYS[self._host] = {}
706
BZR_HOSTKEYS[self._host][keytype] = server_key
707
our_server_key = server_key
708
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
710
if server_key != our_server_key:
711
filename1 = os.path.expanduser('~/.ssh/known_hosts')
712
filename2 = pathjoin(config_dir(), 'ssh_host_keys')
713
raise TransportError('Host keys for %s do not match! %s != %s' % \
714
(self._host, our_server_key_hex, server_key_hex),
715
['Try editing %s or %s' % (filename1, filename2)])
720
self._sftp = t.open_sftp_client()
721
except paramiko.SSHException, e:
722
raise ConnectionError('Unable to start sftp client %s:%d' %
723
(self._host, self._port), e)
725
def _sftp_auth(self, transport):
726
# paramiko requires a username, but it might be none if nothing was supplied
727
# use the local username, just in case.
728
# We don't override self._username, because if we aren't using paramiko,
729
# the username might be specified in ~/.ssh/config and we don't want to
730
# force it to something else
731
# Also, it would mess up the self.relpath() functionality
732
username = self._username or getpass.getuser()
734
# Paramiko tries to open a socket.AF_UNIX in order to connect
735
# to ssh-agent. That attribute doesn't exist on win32 (it does in cygwin)
736
# so we get an AttributeError exception. For now, just don't try to
737
# connect to an agent if we are on win32
738
if sys.platform != 'win32':
739
agent = paramiko.Agent()
740
for key in agent.get_keys():
741
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
743
transport.auth_publickey(username, key)
745
except paramiko.SSHException, e:
748
# okay, try finding id_rsa or id_dss? (posix only)
749
if self._try_pkey_auth(transport, paramiko.RSAKey, username, 'id_rsa'):
751
if self._try_pkey_auth(transport, paramiko.DSSKey, username, 'id_dsa'):
756
transport.auth_password(username, self._password)
758
except paramiko.SSHException, e:
761
# FIXME: Don't keep a password held in memory if you can help it
762
#self._password = None
764
# give up and ask for a password
765
password = bzrlib.ui.ui_factory.get_password(
766
prompt='SSH %(user)s@%(host)s password',
767
user=username, host=self._host)
769
transport.auth_password(username, password)
770
except paramiko.SSHException, e:
771
raise ConnectionError('Unable to authenticate to SSH host as %s@%s' %
772
(username, self._host), e)
774
def _try_pkey_auth(self, transport, pkey_class, username, filename):
775
filename = os.path.expanduser('~/.ssh/' + filename)
777
key = pkey_class.from_private_key_file(filename)
778
transport.auth_publickey(username, key)
780
except paramiko.PasswordRequiredException:
781
password = bzrlib.ui.ui_factory.get_password(
782
prompt='SSH %(filename)s password',
785
key = pkey_class.from_private_key_file(filename, password)
786
transport.auth_publickey(username, key)
788
except paramiko.SSHException:
789
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
790
except paramiko.SSHException:
791
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
836
796
def _sftp_open_exclusive(self, abspath, mode=None):
837
797
"""Open a remote path exclusively.
909
859
self._socket.bind(('localhost', 0))
910
860
self._socket.listen(1)
911
861
self.port = self._socket.getsockname()[1]
912
self._stop_event = threading.Event()
862
self.stop_event = threading.Event()
865
s, _ = self._socket.accept()
866
# now close the listen socket
869
self._callback(s, self.stop_event)
871
pass #Ignore socket errors
873
# probably a failed test
874
warning('Exception from within unit test server thread: %r' % x)
915
# called from outside this thread
916
self._stop_event.set()
877
self.stop_event.set()
917
878
# use a timeout here, because if the test fails, the server thread may
918
879
# never notice the stop_event.
924
readable, writable_unused, exception_unused = \
925
select.select([self._socket], [], [], 0.1)
926
if self._stop_event.isSet():
928
if len(readable) == 0:
931
s, addr_unused = self._socket.accept()
932
# because the loopback socket is inline, and transports are
933
# never explicitly closed, best to launch a new thread.
934
threading.Thread(target=self._callback, args=(s,)).start()
935
except socket.error, x:
936
sys.excepthook(*sys.exc_info())
937
warning('Socket error during accept() within unit test server'
940
# probably a failed test; unit test thread will log the
942
sys.excepthook(*sys.exc_info())
943
warning('Exception from within unit test server thread: %r' %
947
class SocketDelay(object):
948
"""A socket decorator to make TCP appear slower.
950
This changes recv, send, and sendall to add a fixed latency to each python
951
call if a new roundtrip is detected. That is, when a recv is called and the
952
flag new_roundtrip is set, latency is charged. Every send and send_all
955
In addition every send, sendall and recv sleeps a bit per character send to
958
Not all methods are implemented, this is deliberate as this class is not a
959
replacement for the builtin sockets layer. fileno is not implemented to
960
prevent the proxy being bypassed.
964
_proxied_arguments = dict.fromkeys([
965
"close", "getpeername", "getsockname", "getsockopt", "gettimeout",
966
"setblocking", "setsockopt", "settimeout", "shutdown"])
968
def __init__(self, sock, latency, bandwidth=1.0,
971
:param bandwith: simulated bandwith (MegaBit)
972
:param really_sleep: If set to false, the SocketDelay will just
973
increase a counter, instead of calling time.sleep. This is useful for
974
unittesting the SocketDelay.
977
self.latency = latency
978
self.really_sleep = really_sleep
979
self.time_per_byte = 1 / (bandwidth / 8.0 * 1024 * 1024)
980
self.new_roundtrip = False
983
if self.really_sleep:
986
SocketDelay.simulated_time += s
988
def __getattr__(self, attr):
989
if attr in SocketDelay._proxied_arguments:
990
return getattr(self.sock, attr)
991
raise AttributeError("'SocketDelay' object has no attribute %r" %
995
return SocketDelay(self.sock.dup(), self.latency, self.time_per_byte,
998
def recv(self, *args):
999
data = self.sock.recv(*args)
1000
if data and self.new_roundtrip:
1001
self.new_roundtrip = False
1002
self.sleep(self.latency)
1003
self.sleep(len(data) * self.time_per_byte)
1006
def sendall(self, data, flags=0):
1007
if not self.new_roundtrip:
1008
self.new_roundtrip = True
1009
self.sleep(self.latency)
1010
self.sleep(len(data) * self.time_per_byte)
1011
return self.sock.sendall(data, flags)
1013
def send(self, data, flags=0):
1014
if not self.new_roundtrip:
1015
self.new_roundtrip = True
1016
self.sleep(self.latency)
1017
bytes_sent = self.sock.send(data, flags)
1018
self.sleep(bytes_sent * self.time_per_byte)
1022
883
class SFTPServer(Server):
1023
884
"""Common code for SFTP server facilities."""
1025
def __init__(self, server_interface=StubServer):
1026
887
self._original_vendor = None
1027
888
self._homedir = None
1028
889
self._server_homedir = None
1029
890
self._listener = None
1030
891
self._root = None
1031
self._vendor = ssh.ParamikoVendor()
1032
self._server_interface = server_interface
892
self._vendor = 'none'
1033
893
# sftp server logs
1035
self.add_latency = 0
1037
896
def _get_sftp_url(self, path):
1038
897
"""Calculate an sftp url to this server for path."""
1042
901
"""StubServer uses this to log when a new server is created."""
1043
902
self.logs.append(message)
1045
def _run_server_entry(self, sock):
1046
"""Entry point for all implementations of _run_server.
1048
If self.add_latency is > 0.000001 then sock is given a latency adding
1051
if self.add_latency > 0.000001:
1052
sock = SocketDelay(sock, self.add_latency)
1053
return self._run_server(sock)
1055
def _run_server(self, s):
904
def _run_server(self, s, stop_event):
1056
905
ssh_server = paramiko.Transport(s)
1057
key_file = pathjoin(self._homedir, 'test_rsa.key')
1058
f = open(key_file, 'w')
1059
f.write(STUB_SERVER_KEY)
906
key_file = os.path.join(self._homedir, 'test_rsa.key')
907
file(key_file, 'w').write(STUB_SERVER_KEY)
1061
908
host_key = paramiko.RSAKey.from_private_key_file(key_file)
1062
909
ssh_server.add_server_key(host_key)
1063
server = self._server_interface(self)
910
server = StubServer(self)
1064
911
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
1065
912
StubSFTPServer, root=self._root,
1066
913
home=self._server_homedir)
1067
914
event = threading.Event()
1068
915
ssh_server.start_server(event, server)
917
stop_event.wait(30.0)
1071
919
def setUp(self):
1072
self._original_vendor = ssh._ssh_vendor
1073
ssh._ssh_vendor = self._vendor
1074
if sys.platform == 'win32':
1075
# Win32 needs to use the UNICODE api
1076
self._homedir = getcwd()
1078
# But Linux SFTP servers should just deal in bytestreams
1079
self._homedir = os.getcwd()
921
self._original_vendor = _ssh_vendor
922
_ssh_vendor = self._vendor
923
self._homedir = os.getcwdu()
1080
924
if self._server_homedir is None:
1081
925
self._server_homedir = self._homedir
1082
926
self._root = '/'
1083
if sys.platform == 'win32':
1085
self._listener = SocketListener(self._run_server_entry)
927
# FIXME WINDOWS: _root should be _server_homedir[0]:/
928
self._listener = SingleListener(self._run_server)
1086
929
self._listener.setDaemon(True)
1087
930
self._listener.start()
1089
932
def tearDown(self):
1090
933
"""See bzrlib.transport.Server.tearDown."""
1091
935
self._listener.stop()
1092
ssh._ssh_vendor = self._original_vendor
1094
def get_bogus_url(self):
1095
"""See bzrlib.transport.Server.get_bogus_url."""
1096
# this is chosen to try to prevent trouble with proxies, wierd dns, etc
1097
# we bind a random socket, so that we get a guaranteed unused port
1098
# we just never listen on that port
1100
s.bind(('localhost', 0))
1101
return 'sftp://%s:%s/' % s.getsockname()
936
_ssh_vendor = self._original_vendor
1104
939
class SFTPFullAbsoluteServer(SFTPServer):
1175
992
super(SFTPSiblingAbsoluteServer, self).setUp()
1178
def _sftp_connect(host, port, username, password):
1179
"""Connect to the remote sftp server.
1181
:raises: a TransportError 'could not connect'.
1183
:returns: an paramiko.sftp_client.SFTPClient
1185
TODO: Raise a more reasonable ConnectionFailed exception
1187
idx = (host, port, username)
1189
return _connected_hosts[idx]
1193
sftp = _sftp_connect_uncached(host, port, username, password)
1194
_connected_hosts[idx] = sftp
1197
def _sftp_connect_uncached(host, port, username, password):
1198
vendor = ssh._get_ssh_vendor()
1199
sftp = vendor.connect_sftp(username, password, host, port)
1203
995
def get_test_permutations():
1204
996
"""Return the permutations to be used in testing."""
1205
997
return [(SFTPTransport, SFTPAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
