1
1
# Copyright (C) 2005 Robey Pointer <robey@lag.net>
2
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.
35
from bzrlib.config import config_dir, ensure_config_dir_exists
36
from bzrlib.errors import (ConnectionError,
38
TransportNotPossible, NoSuchFile, PathNotChild,
43
from bzrlib.errors import (FileExists,
44
NoSuchFile, PathNotChild,
42
48
ParamikoNotPresent,
44
50
from bzrlib.osutils import pathjoin, fancy_rename, getcwd
45
from bzrlib.trace import mutter, warning, error
51
from bzrlib.trace import mutter, warning
46
52
from bzrlib.transport import (
47
53
register_urlparse_netloc_protocol,
53
import bzrlib.urlutils as urlutils
62
67
CMD_HANDLE, CMD_OPEN)
63
68
from paramiko.sftp_attr import SFTPAttributes
64
69
from paramiko.sftp_file import SFTPFile
65
from paramiko.sftp_client import SFTPClient
68
72
register_urlparse_netloc_protocol('sftp')
72
# TODO: This should possibly ignore SIGHUP as well, but bzr currently
73
# doesn't handle it itself.
74
# <https://launchpad.net/products/bzr/+bug/41433/+index>
76
signal.signal(signal.SIGINT, signal.SIG_IGN)
79
def os_specific_subprocess_params():
80
"""Get O/S specific subprocess parameters."""
81
if sys.platform == 'win32':
82
# setting the process group and closing fds is not supported on
86
# We close fds other than the pipes as the child process does not need
89
# We also set the child process to ignore SIGINT. Normally the signal
90
# would be sent to every process in the foreground process group, but
91
# this causes it to be seen only by bzr and not by ssh. Python will
92
# generate a KeyboardInterrupt in bzr, and we will then have a chance
93
# to release locks or do other cleanup over ssh before the connection
95
# <https://launchpad.net/products/bzr/+bug/5987>
97
# Running it in a separate process group is not good because then it
98
# can't get non-echoed input of a password or passphrase.
99
# <https://launchpad.net/products/bzr/+bug/40508>
100
return {'preexec_fn': _ignore_sigint,
105
_paramiko_version = getattr(paramiko, '__version_info__', (0, 0, 0))
106
# don't use prefetch unless paramiko version >= 1.5.5 (there were bugs earlier)
107
_default_do_prefetch = (_paramiko_version >= (1, 5, 5))
109
# Paramiko 1.5 tries to open a socket.AF_UNIX in order to connect
110
# to ssh-agent. That attribute doesn't exist on win32 (it does in cygwin)
111
# so we get an AttributeError exception. So we will not try to
112
# connect to an agent if we are on win32 and using Paramiko older than 1.6
113
_use_ssh_agent = (sys.platform != 'win32' or _paramiko_version >= (1, 6, 0))
117
def _get_ssh_vendor():
118
"""Find out what version of SSH is on the system."""
120
if _ssh_vendor is not None:
125
if 'BZR_SSH' in os.environ:
126
_ssh_vendor = os.environ['BZR_SSH']
127
if _ssh_vendor == 'paramiko':
132
p = subprocess.Popen(['ssh', '-V'],
133
stdin=subprocess.PIPE,
134
stdout=subprocess.PIPE,
135
stderr=subprocess.PIPE,
136
**os_specific_subprocess_params())
137
returncode = p.returncode
138
stdout, stderr = p.communicate()
142
if 'OpenSSH' in stderr:
143
mutter('ssh implementation is OpenSSH')
144
_ssh_vendor = 'openssh'
145
elif 'SSH Secure Shell' in stderr:
146
mutter('ssh implementation is SSH Corp.')
149
if _ssh_vendor != 'none':
152
# XXX: 20051123 jamesh
153
# A check for putty's plink or lsh would go here.
155
mutter('falling back to paramiko implementation')
159
class SFTPSubprocess:
160
"""A socket-like object that talks to an ssh subprocess via pipes."""
161
def __init__(self, hostname, vendor, port=None, user=None):
162
assert vendor in ['openssh', 'ssh']
163
if vendor == 'openssh':
165
'-oForwardX11=no', '-oForwardAgent=no',
166
'-oClearAllForwardings=yes', '-oProtocol=2',
167
'-oNoHostAuthenticationForLocalhost=yes']
169
args.extend(['-p', str(port)])
171
args.extend(['-l', user])
172
args.extend(['-s', hostname, 'sftp'])
173
elif vendor == 'ssh':
176
args.extend(['-p', str(port)])
178
args.extend(['-l', user])
179
args.extend(['-s', 'sftp', hostname])
181
self.proc = subprocess.Popen(args,
182
stdin=subprocess.PIPE,
183
stdout=subprocess.PIPE,
184
**os_specific_subprocess_params())
186
def send(self, data):
187
return os.write(self.proc.stdin.fileno(), data)
189
def recv_ready(self):
190
# TODO: jam 20051215 this function is necessary to support the
191
# pipelined() function. In reality, it probably should use
192
# poll() or select() to actually return if there is data
193
# available, otherwise we probably don't get any benefit
196
def recv(self, count):
197
return os.read(self.proc.stdout.fileno(), count)
200
self.proc.stdin.close()
201
self.proc.stdout.close()
205
class LoopbackSFTP(object):
206
"""Simple wrapper for a socket that pretends to be a paramiko Channel."""
208
def __init__(self, sock):
211
def send(self, data):
212
return self.__socket.send(data)
215
return self.__socket.recv(n)
217
def recv_ready(self):
221
self.__socket.close()
227
75
# This is a weakref dictionary, so that we can reuse connections
228
76
# that are still active. Long term, it might be nice to have some
229
77
# sort of expiration policy, such as disconnect if inactive for
230
78
# X seconds. But that requires a lot more fanciness.
231
79
_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))
233
87
def clear_connection_cache():
234
88
"""Remove all hosts from the SFTP connection cache.
238
92
_connected_hosts.clear()
241
def load_host_keys():
243
Load system host keys (probably doesn't work on windows) and any
244
"discovered" keys from previous sessions.
246
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
248
SYSTEM_HOSTKEYS = paramiko.util.load_host_keys(os.path.expanduser('~/.ssh/known_hosts'))
250
mutter('failed to load system host keys: ' + str(e))
251
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
253
BZR_HOSTKEYS = paramiko.util.load_host_keys(bzr_hostkey_path)
255
mutter('failed to load bzr host keys: ' + str(e))
259
def save_host_keys():
261
Save "discovered" host keys in $(config)/ssh_host_keys/.
263
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
264
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
265
ensure_config_dir_exists()
268
f = open(bzr_hostkey_path, 'w')
269
f.write('# SSH host keys collected by bzr\n')
270
for hostname, keys in BZR_HOSTKEYS.iteritems():
271
for keytype, key in keys.iteritems():
272
f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
275
mutter('failed to save bzr host keys: ' + str(e))
278
95
class SFTPLock(object):
279
"""This fakes a lock in a remote location."""
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.
280
103
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
281
105
def __init__(self, path, transport):
282
106
assert isinstance(transport, SFTPTransport)
313
class SFTPTransport (Transport):
315
Transport implementation for SFTP access.
317
_do_prefetch = _default_do_prefetch
137
class SFTPUrlHandling(Transport):
138
"""Mix-in that does common handling of SSH/SFTP URLs."""
319
def __init__(self, base, clone_from=None):
320
assert base.startswith('sftp://')
140
def __init__(self, base):
321
141
self._parse_url(base)
322
base = self._unparse_url()
142
base = self._unparse_url(self._path)
323
143
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):
325
221
super(SFTPTransport, self).__init__(base)
326
222
if clone_from is None:
327
223
self._sftp_connect()
348
244
return SFTPTransport(self.abspath(offset), self)
350
def abspath(self, relpath):
352
Return the full url to the given relative path.
354
@param relpath: the relative path or path components
355
@type relpath: str or list
357
return self._unparse_url(self._remote_path(relpath))
359
246
def _remote_path(self, relpath):
360
247
"""Return the path to be passed along the sftp protocol for relpath.
362
249
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 /~/.
364
# FIXME: share the common code across transports
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
365
299
assert isinstance(relpath, basestring)
366
relpath = urlutils.unescape(relpath).split('/')
367
basepath = self._path.split('/')
368
if len(basepath) > 0 and basepath[-1] == '':
369
basepath = basepath[:-1]
373
if len(basepath) == 0:
374
# In most filesystems, a request for the parent
375
# of root, just returns root.
383
path = '/'.join(basepath)
384
# mutter('relpath => remotepath %s => %s', relpath, path)
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)
387
355
def relpath(self, abspath):
388
username, password, host, port, path = self._split_url(abspath)
356
scheme, username, password, host, port, path = self._split_url(abspath)
390
358
if (username != self._username):
391
359
error.append('username mismatch')
426
394
except (IOError, paramiko.SSHException), e:
427
395
self._translate_io_exception(e, path, ': error retrieving')
429
def get_partial(self, relpath, start, length=None):
431
Get just part of a file.
433
:param relpath: Path to the file, relative to base
434
:param start: The starting position to read from
435
:param length: The length to read. A length of None indicates
436
read to the end of the file.
437
:return: A file-like object containing at least the specified bytes.
438
Some implementations may return objects which can be read
439
past this length, but this is not guaranteed.
441
# TODO: implement get_partial_multi to help with knit support
442
f = self.get(relpath)
444
if self._do_prefetch and hasattr(f, 'prefetch'):
448
def put(self, relpath, f, mode=None):
450
Copy the file-like or string object into the location.
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.
452
523
:param relpath: Location to put the contents, relative to base.
453
:param f: File-like or string object.
524
:param f: File-like object.
454
525
:param mode: The final mode for the file
456
527
final_path = self._remote_path(relpath)
491
575
# 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,
494
655
def iter_files_recursive(self):
495
656
"""Walk the relative paths of all files in this transport."""
496
657
queue = list(self.list_dir('.'))
498
relpath = urllib.quote(queue.pop(0))
659
relpath = queue.pop(0)
499
660
st = self.stat(relpath)
500
661
if stat.S_ISDIR(st.st_mode):
501
662
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)
506
680
def mkdir(self, relpath, mode=None):
507
681
"""Create a directory at the given path."""
508
path = self._remote_path(relpath)
510
# In the paramiko documentation, it says that passing a mode flag
511
# will filtered against the server umask.
512
# StubSFTPServer does not do this, which would be nice, because it is
513
# what we really want :)
514
# However, real servers do use umask, so we really should do it that way
515
self._sftp.mkdir(path)
517
self._sftp.chmod(path, mode=mode)
518
except (paramiko.SSHException, IOError), e:
519
self._translate_io_exception(e, path, ': unable to mkdir',
520
failure_exc=FileExists)
682
self._mkdir(self._remote_path(relpath), mode=mode)
522
684
def _translate_io_exception(self, e, path, more_info='',
523
685
failure_exc=PathError):
657
823
# that we have taken the lock.
658
824
return SFTPLock(relpath, self)
660
def _unparse_url(self, path=None):
663
path = urllib.quote(path)
664
# handle homedir paths
665
if not path.startswith('/'):
667
netloc = urllib.quote(self._host)
668
if self._username is not None:
669
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
670
if self._port is not None:
671
netloc = '%s:%d' % (netloc, self._port)
672
return urlparse.urlunparse(('sftp', netloc, path, '', '', ''))
674
def _split_url(self, url):
675
(scheme, username, password, host, port, path) = split_url(url)
676
assert scheme == 'sftp'
678
# the initial slash should be removed from the path, and treated
679
# as a homedir relative path (the path begins with a double slash
680
# if it is absolute).
681
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
682
# RBC 20060118 we are not using this as its too user hostile. instead
683
# we are following lftp and using /~/foo to mean '~/foo'.
684
# handle homedir paths
685
if path.startswith('/~/'):
689
return (username, password, host, port, path)
691
def _parse_url(self, url):
692
(self._username, self._password,
693
self._host, self._port, self._path) = self._split_url(url)
695
826
def _sftp_connect(self):
696
827
"""Connect to the remote sftp server.
697
828
After this, self._sftp should have a valid connection (or
700
831
TODO: Raise a more reasonable ConnectionFailed exception
702
global _connected_hosts
704
idx = (self._host, self._port, self._username)
706
self._sftp = _connected_hosts[idx]
711
vendor = _get_ssh_vendor()
712
if vendor == 'loopback':
713
sock = socket.socket()
715
sock.connect((self._host, self._port))
716
except socket.error, e:
717
raise ConnectionError('Unable to connect to SSH host %s:%s: %s'
718
% (self._host, self._port, e))
719
self._sftp = SFTPClient(LoopbackSFTP(sock))
720
elif vendor != 'none':
721
sock = SFTPSubprocess(self._host, vendor, self._port,
723
self._sftp = SFTPClient(sock)
725
self._paramiko_connect()
727
_connected_hosts[idx] = self._sftp
729
def _paramiko_connect(self):
730
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
735
t = paramiko.Transport((self._host, self._port or 22))
736
t.set_log_channel('bzr.paramiko')
738
except paramiko.SSHException, e:
739
raise ConnectionError('Unable to reach SSH host %s:%s: %s'
740
% (self._host, self._port, e))
742
server_key = t.get_remote_server_key()
743
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
744
keytype = server_key.get_name()
745
if SYSTEM_HOSTKEYS.has_key(self._host) and SYSTEM_HOSTKEYS[self._host].has_key(keytype):
746
our_server_key = SYSTEM_HOSTKEYS[self._host][keytype]
747
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
748
elif BZR_HOSTKEYS.has_key(self._host) and BZR_HOSTKEYS[self._host].has_key(keytype):
749
our_server_key = BZR_HOSTKEYS[self._host][keytype]
750
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
752
warning('Adding %s host key for %s: %s' % (keytype, self._host, server_key_hex))
753
if not BZR_HOSTKEYS.has_key(self._host):
754
BZR_HOSTKEYS[self._host] = {}
755
BZR_HOSTKEYS[self._host][keytype] = server_key
756
our_server_key = server_key
757
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
759
if server_key != our_server_key:
760
filename1 = os.path.expanduser('~/.ssh/known_hosts')
761
filename2 = pathjoin(config_dir(), 'ssh_host_keys')
762
raise TransportError('Host keys for %s do not match! %s != %s' % \
763
(self._host, our_server_key_hex, server_key_hex),
764
['Try editing %s or %s' % (filename1, filename2)])
769
self._sftp = t.open_sftp_client()
770
except paramiko.SSHException, e:
771
raise ConnectionError('Unable to start sftp client %s:%d' %
772
(self._host, self._port), e)
774
def _sftp_auth(self, transport):
775
# paramiko requires a username, but it might be none if nothing was supplied
776
# use the local username, just in case.
777
# We don't override self._username, because if we aren't using paramiko,
778
# the username might be specified in ~/.ssh/config and we don't want to
779
# force it to something else
780
# Also, it would mess up the self.relpath() functionality
781
username = self._username or getpass.getuser()
784
agent = paramiko.Agent()
785
for key in agent.get_keys():
786
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
788
transport.auth_publickey(username, key)
790
except paramiko.SSHException, e:
793
# okay, try finding id_rsa or id_dss? (posix only)
794
if self._try_pkey_auth(transport, paramiko.RSAKey, username, 'id_rsa'):
796
if self._try_pkey_auth(transport, paramiko.DSSKey, username, 'id_dsa'):
801
transport.auth_password(username, self._password)
803
except paramiko.SSHException, e:
806
# FIXME: Don't keep a password held in memory if you can help it
807
#self._password = None
809
# give up and ask for a password
810
password = bzrlib.ui.ui_factory.get_password(
811
prompt='SSH %(user)s@%(host)s password',
812
user=username, host=self._host)
814
transport.auth_password(username, password)
815
except paramiko.SSHException, e:
816
raise ConnectionError('Unable to authenticate to SSH host as %s@%s' %
817
(username, self._host), e)
819
def _try_pkey_auth(self, transport, pkey_class, username, filename):
820
filename = os.path.expanduser('~/.ssh/' + filename)
822
key = pkey_class.from_private_key_file(filename)
823
transport.auth_publickey(username, key)
825
except paramiko.PasswordRequiredException:
826
password = bzrlib.ui.ui_factory.get_password(
827
prompt='SSH %(filename)s password',
830
key = pkey_class.from_private_key_file(filename, password)
831
transport.auth_publickey(username, key)
833
except paramiko.SSHException:
834
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
835
except paramiko.SSHException:
836
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
833
self._sftp = _sftp_connect(self._host, self._port, self._username,
841
836
def _sftp_open_exclusive(self, abspath, mode=None):
842
837
"""Open a remote path exclusively.
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)
943
1022
class SFTPServer(Server):
944
1023
"""Common code for SFTP server facilities."""
1025
def __init__(self, server_interface=StubServer):
947
1026
self._original_vendor = None
948
1027
self._homedir = None
949
1028
self._server_homedir = None
950
1029
self._listener = None
951
1030
self._root = None
952
self._vendor = 'none'
1031
self._vendor = ssh.ParamikoVendor()
1032
self._server_interface = server_interface
953
1033
# sftp server logs
1035
self.add_latency = 0
956
1037
def _get_sftp_url(self, path):
957
1038
"""Calculate an sftp url to this server for path."""
1081
1175
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)
1084
1203
def get_test_permutations():
1085
1204
"""Return the permutations to be used in testing."""
1086
1205
return [(SFTPTransport, SFTPAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
