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,
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
62
except ImportError, e:
63
raise ParamikoNotPresent(e)
47
error('The SFTP transport requires paramiko.')
65
50
from paramiko.sftp import (SFTP_FLAG_WRITE, SFTP_FLAG_CREATE,
66
51
SFTP_FLAG_EXCL, SFTP_FLAG_TRUNC,
67
52
CMD_HANDLE, CMD_OPEN)
68
53
from paramiko.sftp_attr import SFTPAttributes
69
54
from paramiko.sftp_file import SFTPFile
72
register_urlparse_netloc_protocol('sftp')
55
from paramiko.sftp_client import SFTPClient
57
if 'sftp' not in urlparse.uses_netloc: urlparse.uses_netloc.append('sftp')
61
if sys.platform == 'win32':
62
# close_fds not supported on win32
66
def _get_ssh_vendor():
67
"""Find out what version of SSH is on the system."""
69
if _ssh_vendor is not None:
75
p = subprocess.Popen(['ssh', '-V'],
77
stdin=subprocess.PIPE,
78
stdout=subprocess.PIPE,
79
stderr=subprocess.PIPE)
80
returncode = p.returncode
81
stdout, stderr = p.communicate()
85
if 'OpenSSH' in stderr:
86
mutter('ssh implementation is OpenSSH')
87
_ssh_vendor = 'openssh'
88
elif 'SSH Secure Shell' in stderr:
89
mutter('ssh implementation is SSH Corp.')
92
if _ssh_vendor != 'none':
95
# XXX: 20051123 jamesh
96
# A check for putty's plink or lsh would go here.
98
mutter('falling back to paramiko implementation')
102
class SFTPSubprocess:
103
"""A socket-like object that talks to an ssh subprocess via pipes."""
104
def __init__(self, hostname, vendor, port=None, user=None):
105
assert vendor in ['openssh', 'ssh']
106
if vendor == 'openssh':
108
'-oForwardX11=no', '-oForwardAgent=no',
109
'-oClearAllForwardings=yes', '-oProtocol=2',
110
'-oNoHostAuthenticationForLocalhost=yes']
112
args.extend(['-p', str(port)])
114
args.extend(['-l', user])
115
args.extend(['-s', hostname, 'sftp'])
116
elif vendor == 'ssh':
119
args.extend(['-p', str(port)])
121
args.extend(['-l', user])
122
args.extend(['-s', 'sftp', hostname])
124
self.proc = subprocess.Popen(args, close_fds=_close_fds,
125
stdin=subprocess.PIPE,
126
stdout=subprocess.PIPE)
128
def send(self, data):
129
return os.write(self.proc.stdin.fileno(), data)
131
def recv_ready(self):
132
# TODO: jam 20051215 this function is necessary to support the
133
# pipelined() function. In reality, it probably should use
134
# poll() or select() to actually return if there is data
135
# available, otherwise we probably don't get any benefit
138
def recv(self, count):
139
return os.read(self.proc.stdout.fileno(), count)
142
self.proc.stdin.close()
143
self.proc.stdout.close()
147
class LoopbackSFTP(object):
148
"""Simple wrapper for a socket that pretends to be a paramiko Channel."""
150
def __init__(self, sock):
153
def send(self, data):
154
return self.__socket.send(data)
157
return self.__socket.recv(n)
159
def recv_ready(self):
163
self.__socket.close()
75
169
# This is a weakref dictionary, so that we can reuse connections
76
170
# that are still active. Long term, it might be nice to have some
79
173
_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()
176
def load_host_keys():
178
Load system host keys (probably doesn't work on windows) and any
179
"discovered" keys from previous sessions.
181
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
183
SYSTEM_HOSTKEYS = paramiko.util.load_host_keys(os.path.expanduser('~/.ssh/known_hosts'))
185
mutter('failed to load system host keys: ' + str(e))
186
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
188
BZR_HOSTKEYS = paramiko.util.load_host_keys(bzr_hostkey_path)
190
mutter('failed to load bzr host keys: ' + str(e))
194
def save_host_keys():
196
Save "discovered" host keys in $(config)/ssh_host_keys/.
198
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
199
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
200
ensure_config_dir_exists()
203
f = open(bzr_hostkey_path, 'w')
204
f.write('# SSH host keys collected by bzr\n')
205
for hostname, keys in BZR_HOSTKEYS.iteritems():
206
for keytype, key in keys.iteritems():
207
f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
210
mutter('failed to save bzr host keys: ' + str(e))
95
213
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.
214
"""This fakes a lock in a remote location."""
103
215
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
105
216
def __init__(self, path, transport):
106
217
assert isinstance(transport, SFTPTransport)
137
class SFTPUrlHandling(Transport):
138
"""Mix-in that does common handling of SSH/SFTP URLs."""
248
class SFTPTransport (Transport):
250
Transport implementation for SFTP access.
252
_do_prefetch = False # Right now Paramiko's prefetch support causes things to hang
140
def __init__(self, base):
254
def __init__(self, base, clone_from=None):
255
assert base.startswith('sftp://')
141
256
self._parse_url(base)
142
base = self._unparse_url(self._path)
257
base = self._unparse_url()
143
258
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
260
super(SFTPTransport, self).__init__(base)
222
261
if clone_from is None:
223
262
self._sftp_connect()
244
283
return SFTPTransport(self.abspath(offset), self)
285
def abspath(self, relpath):
287
Return the full url to the given relative path.
289
@param relpath: the relative path or path components
290
@type relpath: str or list
292
return self._unparse_url(self._remote_path(relpath))
246
294
def _remote_path(self, relpath):
247
295
"""Return the path to be passed along the sftp protocol for relpath.
249
297
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
299
# FIXME: share the common code across transports
299
300
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)
301
relpath = urllib.unquote(relpath).split('/')
302
basepath = self._path.split('/')
303
if len(basepath) > 0 and basepath[-1] == '':
304
basepath = basepath[:-1]
308
if len(basepath) == 0:
309
# In most filesystems, a request for the parent
310
# of root, just returns root.
318
path = '/'.join(basepath)
355
321
def relpath(self, abspath):
356
scheme, username, password, host, port, path = self._split_url(abspath)
322
username, password, host, port, path = self._split_url(abspath)
358
324
if (username != self._username):
359
325
error.append('username mismatch')
389
355
path = self._remote_path(relpath)
390
356
f = self._sftp.file(path, mode='rb')
391
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
357
if self._do_prefetch and hasattr(f, 'prefetch'):
394
360
except (IOError, paramiko.SSHException), e:
395
361
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.
363
def get_partial(self, relpath, start, length=None):
365
Get just part of a file.
367
:param relpath: Path to the file, relative to base
368
:param start: The starting position to read from
369
:param length: The length to read. A length of None indicates
370
read to the end of the file.
371
:return: A file-like object containing at least the specified bytes.
372
Some implementations may return objects which can be read
373
past this length, but this is not guaranteed.
375
# TODO: implement get_partial_multi to help with knit support
376
f = self.get(relpath)
378
if self._do_prefetch and hasattr(f, 'prefetch'):
382
def put(self, relpath, f, mode=None):
384
Copy the file-like or string object into the location.
523
386
:param relpath: Location to put the contents, relative to base.
524
:param f: File-like object.
387
:param f: File-like or string object.
525
388
:param mode: The final mode for the file
527
390
final_path = self._remote_path(relpath)
575
425
# 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
428
def iter_files_recursive(self):
656
429
"""Walk the relative paths of all files in this transport."""
657
430
queue = list(self.list_dir('.'))
659
relpath = queue.pop(0)
432
relpath = urllib.quote(queue.pop(0))
660
433
st = self.stat(relpath)
661
434
if stat.S_ISDIR(st.st_mode):
662
435
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
440
def mkdir(self, relpath, mode=None):
681
441
"""Create a directory at the given path."""
682
self._mkdir(self._remote_path(relpath), mode=mode)
443
path = self._remote_path(relpath)
444
# In the paramiko documentation, it says that passing a mode flag
445
# will filtered against the server umask.
446
# StubSFTPServer does not do this, which would be nice, because it is
447
# what we really want :)
448
# However, real servers do use umask, so we really should do it that way
449
self._sftp.mkdir(path)
451
self._sftp.chmod(path, mode=mode)
452
except (paramiko.SSHException, IOError), e:
453
self._translate_io_exception(e, path, ': unable to mkdir',
454
failure_exc=FileExists)
684
def _translate_io_exception(self, e, path, more_info='',
685
failure_exc=PathError):
456
def _translate_io_exception(self, e, path, more_info='', failure_exc=NoSuchFile):
686
457
"""Translate a paramiko or IOError into a friendlier exception.
688
459
:param e: The original exception
720
491
path = self._remote_path(relpath)
721
492
fout = self._sftp.file(path, 'ab')
723
self._sftp.chmod(path, mode)
725
493
self._pump(f, fout)
727
494
except (IOError, paramiko.SSHException), e:
728
495
self._translate_io_exception(e, relpath, ': unable to append')
730
def rename(self, rel_from, rel_to):
731
"""Rename without special overwriting"""
497
def copy(self, rel_from, rel_to):
498
"""Copy the item at rel_from to the location at rel_to"""
499
path_from = self._remote_path(rel_from)
500
path_to = self._remote_path(rel_to)
501
self._copy_abspaths(path_from, path_to)
503
def _copy_abspaths(self, path_from, path_to, mode=None):
504
"""Copy files given an absolute path
506
:param path_from: Path on remote server to read
507
:param path_to: Path on remote server to write
510
TODO: Should the destination location be atomically created?
511
This has not been specified
512
TODO: This should use some sort of remote copy, rather than
513
pulling the data locally, and then writing it remotely
733
self._sftp.rename(self._remote_path(rel_from),
734
self._remote_path(rel_to))
516
fin = self._sftp.file(path_from, 'rb')
518
self._put(path_to, fin, mode=mode)
735
521
except (IOError, paramiko.SSHException), e:
736
self._translate_io_exception(e, rel_from,
737
': unable to rename to %r' % (rel_to))
739
def _rename_and_overwrite(self, abs_from, abs_to):
522
self._translate_io_exception(e, path_from, ': unable copy to: %r' % path_to)
524
def copy_to(self, relpaths, other, mode=None, pb=None):
525
"""Copy a set of entries from self into another Transport.
527
:param relpaths: A list/generator of entries to be copied.
529
if isinstance(other, SFTPTransport) and other._sftp is self._sftp:
530
# Both from & to are on the same remote filesystem
531
# We can use a remote copy, instead of pulling locally, and pushing
533
total = self._get_total(relpaths)
535
for path in relpaths:
536
path_from = self._remote_path(relpath)
537
path_to = other._remote_path(relpath)
538
self._update_pb(pb, 'copy-to', count, total)
539
self._copy_abspaths(path_from, path_to, mode=mode)
543
return super(SFTPTransport, self).copy_to(relpaths, other, mode=mode, pb=pb)
545
def _rename(self, abs_from, abs_to):
740
546
"""Do a fancy rename on the remote server.
742
548
Using the implementation provided by osutils.
823
617
# that we have taken the lock.
824
618
return SFTPLock(relpath, self)
620
def _unparse_url(self, path=None):
623
path = urllib.quote(path)
624
# handle homedir paths
625
if not path.startswith('/'):
627
netloc = urllib.quote(self._host)
628
if self._username is not None:
629
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
630
if self._port is not None:
631
netloc = '%s:%d' % (netloc, self._port)
633
return urlparse.urlunparse(('sftp', netloc, path, '', '', ''))
635
def _split_url(self, url):
636
if isinstance(url, unicode):
637
url = url.encode('utf-8')
638
(scheme, netloc, path, params,
639
query, fragment) = urlparse.urlparse(url, allow_fragments=False)
640
assert scheme == 'sftp'
641
username = password = host = port = None
643
username, host = netloc.split('@', 1)
645
username, password = username.split(':', 1)
646
password = urllib.unquote(password)
647
username = urllib.unquote(username)
652
host, port = host.rsplit(':', 1)
656
# TODO: Should this be ConnectionError?
657
raise TransportError('%s: invalid port number' % port)
658
host = urllib.unquote(host)
660
path = urllib.unquote(path)
662
# the initial slash should be removed from the path, and treated
663
# as a homedir relative path (the path begins with a double slash
664
# if it is absolute).
665
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
666
# RBC 20060118 we are not using this as its too user hostile. instead
667
# we are following lftp and using /~/foo to mean '~/foo'.
668
# handle homedir paths
669
if path.startswith('/~/'):
673
return (username, password, host, port, path)
675
def _parse_url(self, url):
676
(self._username, self._password,
677
self._host, self._port, self._path) = self._split_url(url)
826
679
def _sftp_connect(self):
827
680
"""Connect to the remote sftp server.
828
681
After this, self._sftp should have a valid connection (or
831
684
TODO: Raise a more reasonable ConnectionFailed exception
833
self._sftp = _sftp_connect(self._host, self._port, self._username,
686
global _connected_hosts
688
idx = (self._host, self._port, self._username)
690
self._sftp = _connected_hosts[idx]
695
vendor = _get_ssh_vendor()
696
if vendor == 'loopback':
697
sock = socket.socket()
698
sock.connect((self._host, self._port))
699
self._sftp = SFTPClient(LoopbackSFTP(sock))
700
elif vendor != 'none':
701
sock = SFTPSubprocess(self._host, vendor, self._port,
703
self._sftp = SFTPClient(sock)
705
self._paramiko_connect()
707
_connected_hosts[idx] = self._sftp
709
def _paramiko_connect(self):
710
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
715
t = paramiko.Transport((self._host, self._port or 22))
716
t.set_log_channel('bzr.paramiko')
718
except paramiko.SSHException, e:
719
raise ConnectionError('Unable to reach SSH host %s:%d' %
720
(self._host, self._port), e)
722
server_key = t.get_remote_server_key()
723
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
724
keytype = server_key.get_name()
725
if SYSTEM_HOSTKEYS.has_key(self._host) and SYSTEM_HOSTKEYS[self._host].has_key(keytype):
726
our_server_key = SYSTEM_HOSTKEYS[self._host][keytype]
727
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
728
elif BZR_HOSTKEYS.has_key(self._host) and BZR_HOSTKEYS[self._host].has_key(keytype):
729
our_server_key = BZR_HOSTKEYS[self._host][keytype]
730
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
732
warning('Adding %s host key for %s: %s' % (keytype, self._host, server_key_hex))
733
if not BZR_HOSTKEYS.has_key(self._host):
734
BZR_HOSTKEYS[self._host] = {}
735
BZR_HOSTKEYS[self._host][keytype] = server_key
736
our_server_key = server_key
737
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
739
if server_key != our_server_key:
740
filename1 = os.path.expanduser('~/.ssh/known_hosts')
741
filename2 = pathjoin(config_dir(), 'ssh_host_keys')
742
raise TransportError('Host keys for %s do not match! %s != %s' % \
743
(self._host, our_server_key_hex, server_key_hex),
744
['Try editing %s or %s' % (filename1, filename2)])
749
self._sftp = t.open_sftp_client()
750
except paramiko.SSHException, e:
751
raise ConnectionError('Unable to start sftp client %s:%d' %
752
(self._host, self._port), e)
754
def _sftp_auth(self, transport):
755
# paramiko requires a username, but it might be none if nothing was supplied
756
# use the local username, just in case.
757
# We don't override self._username, because if we aren't using paramiko,
758
# the username might be specified in ~/.ssh/config and we don't want to
759
# force it to something else
760
# Also, it would mess up the self.relpath() functionality
761
username = self._username or getpass.getuser()
763
# Paramiko tries to open a socket.AF_UNIX in order to connect
764
# to ssh-agent. That attribute doesn't exist on win32 (it does in cygwin)
765
# so we get an AttributeError exception. For now, just don't try to
766
# connect to an agent if we are on win32
767
if sys.platform != 'win32':
768
agent = paramiko.Agent()
769
for key in agent.get_keys():
770
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
772
transport.auth_publickey(username, key)
774
except paramiko.SSHException, e:
777
# okay, try finding id_rsa or id_dss? (posix only)
778
if self._try_pkey_auth(transport, paramiko.RSAKey, username, 'id_rsa'):
780
if self._try_pkey_auth(transport, paramiko.DSSKey, username, 'id_dsa'):
785
transport.auth_password(username, self._password)
787
except paramiko.SSHException, e:
790
# FIXME: Don't keep a password held in memory if you can help it
791
#self._password = None
793
# give up and ask for a password
794
password = bzrlib.ui.ui_factory.get_password(
795
prompt='SSH %(user)s@%(host)s password',
796
user=username, host=self._host)
798
transport.auth_password(username, password)
799
except paramiko.SSHException, e:
800
raise ConnectionError('Unable to authenticate to SSH host as %s@%s' %
801
(username, self._host), e)
803
def _try_pkey_auth(self, transport, pkey_class, username, filename):
804
filename = os.path.expanduser('~/.ssh/' + filename)
806
key = pkey_class.from_private_key_file(filename)
807
transport.auth_publickey(username, key)
809
except paramiko.PasswordRequiredException:
810
password = bzrlib.ui.ui_factory.get_password(
811
prompt='SSH %(filename)s password',
814
key = pkey_class.from_private_key_file(filename, password)
815
transport.auth_publickey(username, key)
817
except paramiko.SSHException:
818
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
819
except paramiko.SSHException:
820
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
836
825
def _sftp_open_exclusive(self, abspath, mode=None):
837
826
"""Open a remote path exclusively.
909
888
self._socket.bind(('localhost', 0))
910
889
self._socket.listen(1)
911
890
self.port = self._socket.getsockname()[1]
912
self._stop_event = threading.Event()
891
self.stop_event = threading.Event()
894
s, _ = self._socket.accept()
895
# now close the listen socket
898
self._callback(s, self.stop_event)
900
pass #Ignore socket errors
902
# probably a failed test
903
warning('Exception from within unit test server thread: %r' % x)
915
# called from outside this thread
916
self._stop_event.set()
906
self.stop_event.set()
917
907
# use a timeout here, because if the test fails, the server thread may
918
908
# 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
912
class SFTPServer(Server):
1023
913
"""Common code for SFTP server facilities."""
1025
def __init__(self, server_interface=StubServer):
1026
916
self._original_vendor = None
1027
917
self._homedir = None
1028
918
self._server_homedir = None
1029
919
self._listener = None
1030
920
self._root = None
1031
self._vendor = ssh.ParamikoVendor()
1032
self._server_interface = server_interface
921
self._vendor = 'none'
1033
922
# sftp server logs
1035
self.add_latency = 0
1037
925
def _get_sftp_url(self, path):
1038
926
"""Calculate an sftp url to this server for path."""
1042
930
"""StubServer uses this to log when a new server is created."""
1043
931
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):
933
def _run_server(self, s, stop_event):
1056
934
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)
935
key_file = os.path.join(self._homedir, 'test_rsa.key')
936
file(key_file, 'w').write(STUB_SERVER_KEY)
1061
937
host_key = paramiko.RSAKey.from_private_key_file(key_file)
1062
938
ssh_server.add_server_key(host_key)
1063
server = self._server_interface(self)
939
server = StubServer(self)
1064
940
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
1065
941
StubSFTPServer, root=self._root,
1066
942
home=self._server_homedir)
1067
943
event = threading.Event()
1068
944
ssh_server.start_server(event, server)
946
stop_event.wait(30.0)
1071
948
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()
950
self._original_vendor = _ssh_vendor
951
_ssh_vendor = self._vendor
952
self._homedir = os.getcwdu()
1080
953
if self._server_homedir is None:
1081
954
self._server_homedir = self._homedir
1082
955
self._root = '/'
1083
if sys.platform == 'win32':
1085
self._listener = SocketListener(self._run_server_entry)
956
# FIXME WINDOWS: _root should be _server_homedir[0]:/
957
self._listener = SingleListener(self._run_server)
1086
958
self._listener.setDaemon(True)
1087
959
self._listener.start()
1089
961
def tearDown(self):
1090
962
"""See bzrlib.transport.Server.tearDown."""
1091
964
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()
1104
class SFTPFullAbsoluteServer(SFTPServer):
1105
"""A test server for sftp transports, using absolute urls and ssh."""
1108
"""See bzrlib.transport.Server.get_url."""
1109
return self._get_sftp_url(urlutils.escape(self._homedir[1:]))
965
_ssh_vendor = self._original_vendor
1112
968
class SFTPServerWithoutSSH(SFTPServer):
1113
"""An SFTP server that uses a simple TCP socket pair rather than SSH."""
970
Common code for an SFTP server over a clear TCP loopback socket,
971
instead of over an SSH secured socket.
1115
974
def __init__(self):
1116
975
super(SFTPServerWithoutSSH, self).__init__()
1117
self._vendor = ssh.LoopbackVendor()
976
self._vendor = 'loopback'
1119
def _run_server(self, sock):
1120
# Re-import these as locals, so that they're still accessible during
1121
# interpreter shutdown (when all module globals get set to None, leading
1122
# to confusing errors like "'NoneType' object has no attribute 'error'".
978
def _run_server(self, sock, stop_event):
1123
979
class FakeChannel(object):
1124
980
def get_transport(self):
added
removed
bzrlib/transport/sftp.py
