83
59
from paramiko.sftp import (SFTP_FLAG_WRITE, SFTP_FLAG_CREATE,
84
60
SFTP_FLAG_EXCL, SFTP_FLAG_TRUNC,
85
SFTP_OK, CMD_HANDLE, CMD_OPEN)
86
62
from paramiko.sftp_attr import SFTPAttributes
87
63
from paramiko.sftp_file import SFTPFile
90
_paramiko_version = getattr(paramiko, '__version_info__', (0, 0, 0))
91
# don't use prefetch unless paramiko version >= 1.5.5 (there were bugs earlier)
92
_default_do_prefetch = (_paramiko_version >= (1, 5, 5))
64
from paramiko.sftp_client import SFTPClient
67
register_urlparse_netloc_protocol('sftp')
71
# TODO: This should possibly ignore SIGHUP as well, but bzr currently
72
# doesn't handle it itself.
73
# <https://launchpad.net/products/bzr/+bug/41433/+index>
75
signal.signal(signal.SIGINT, signal.SIG_IGN)
78
def os_specific_subprocess_params():
79
"""Get O/S specific subprocess parameters."""
80
if sys.platform == 'win32':
81
# setting the process group and closing fds is not supported on
85
# We close fds other than the pipes as the child process does not need
88
# We also set the child process to ignore SIGINT. Normally the signal
89
# would be sent to every process in the foreground process group, but
90
# this causes it to be seen only by bzr and not by ssh. Python will
91
# generate a KeyboardInterrupt in bzr, and we will then have a chance
92
# to release locks or do other cleanup over ssh before the connection
94
# <https://launchpad.net/products/bzr/+bug/5987>
96
# Running it in a separate process group is not good because then it
97
# can't get non-echoed input of a password or passphrase.
98
# <https://launchpad.net/products/bzr/+bug/40508>
99
return {'preexec_fn': _ignore_sigint,
104
# don't use prefetch unless paramiko version >= 1.5.2 (there were bugs earlier)
105
_default_do_prefetch = False
106
if getattr(paramiko, '__version_info__', (0, 0, 0)) >= (1, 5, 5):
107
_default_do_prefetch = True
111
def _get_ssh_vendor():
112
"""Find out what version of SSH is on the system."""
114
if _ssh_vendor is not None:
119
if 'BZR_SSH' in os.environ:
120
_ssh_vendor = os.environ['BZR_SSH']
121
if _ssh_vendor == 'paramiko':
126
p = subprocess.Popen(['ssh', '-V'],
127
stdin=subprocess.PIPE,
128
stdout=subprocess.PIPE,
129
stderr=subprocess.PIPE,
130
**os_specific_subprocess_params())
131
returncode = p.returncode
132
stdout, stderr = p.communicate()
136
if 'OpenSSH' in stderr:
137
mutter('ssh implementation is OpenSSH')
138
_ssh_vendor = 'openssh'
139
elif 'SSH Secure Shell' in stderr:
140
mutter('ssh implementation is SSH Corp.')
143
if _ssh_vendor != 'none':
146
# XXX: 20051123 jamesh
147
# A check for putty's plink or lsh would go here.
149
mutter('falling back to paramiko implementation')
153
class SFTPSubprocess:
154
"""A socket-like object that talks to an ssh subprocess via pipes."""
155
def __init__(self, hostname, vendor, port=None, user=None):
156
assert vendor in ['openssh', 'ssh']
157
if vendor == 'openssh':
159
'-oForwardX11=no', '-oForwardAgent=no',
160
'-oClearAllForwardings=yes', '-oProtocol=2',
161
'-oNoHostAuthenticationForLocalhost=yes']
163
args.extend(['-p', str(port)])
165
args.extend(['-l', user])
166
args.extend(['-s', hostname, 'sftp'])
167
elif vendor == 'ssh':
170
args.extend(['-p', str(port)])
172
args.extend(['-l', user])
173
args.extend(['-s', 'sftp', hostname])
175
self.proc = subprocess.Popen(args,
176
stdin=subprocess.PIPE,
177
stdout=subprocess.PIPE,
178
**os_specific_subprocess_params())
180
def send(self, data):
181
return os.write(self.proc.stdin.fileno(), data)
183
def recv_ready(self):
184
# TODO: jam 20051215 this function is necessary to support the
185
# pipelined() function. In reality, it probably should use
186
# poll() or select() to actually return if there is data
187
# available, otherwise we probably don't get any benefit
190
def recv(self, count):
191
return os.read(self.proc.stdout.fileno(), count)
194
self.proc.stdin.close()
195
self.proc.stdout.close()
199
class LoopbackSFTP(object):
200
"""Simple wrapper for a socket that pretends to be a paramiko Channel."""
202
def __init__(self, sock):
205
def send(self, data):
206
return self.__socket.send(data)
209
return self.__socket.recv(n)
211
def recv_ready(self):
215
self.__socket.close()
221
# This is a weakref dictionary, so that we can reuse connections
222
# that are still active. Long term, it might be nice to have some
223
# sort of expiration policy, such as disconnect if inactive for
224
# X seconds. But that requires a lot more fanciness.
225
_connected_hosts = weakref.WeakValueDictionary()
227
def clear_connection_cache():
228
"""Remove all hosts from the SFTP connection cache.
230
Primarily useful for test cases wanting to force garbage collection.
232
_connected_hosts.clear()
235
def load_host_keys():
237
Load system host keys (probably doesn't work on windows) and any
238
"discovered" keys from previous sessions.
240
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
242
SYSTEM_HOSTKEYS = paramiko.util.load_host_keys(os.path.expanduser('~/.ssh/known_hosts'))
244
mutter('failed to load system host keys: ' + str(e))
245
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
247
BZR_HOSTKEYS = paramiko.util.load_host_keys(bzr_hostkey_path)
249
mutter('failed to load bzr host keys: ' + str(e))
253
def save_host_keys():
255
Save "discovered" host keys in $(config)/ssh_host_keys/.
257
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
258
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
259
ensure_config_dir_exists()
262
f = open(bzr_hostkey_path, 'w')
263
f.write('# SSH host keys collected by bzr\n')
264
for hostname, keys in BZR_HOSTKEYS.iteritems():
265
for keytype, key in keys.iteritems():
266
f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
269
mutter('failed to save bzr host keys: ' + str(e))
95
272
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.
273
"""This fakes a lock in a remote location."""
103
274
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
105
275
def __init__(self, path, transport):
276
assert isinstance(transport, SFTPTransport)
106
278
self.lock_file = None
108
280
self.lock_path = path + '.write-lock'
135
class _SFTPReadvHelper(object):
136
"""A class to help with managing the state of a readv request."""
138
# See _get_requests for an explanation.
139
_max_request_size = 32768
141
def __init__(self, original_offsets, relpath, _report_activity):
142
"""Create a new readv helper.
144
:param original_offsets: The original requests given by the caller of
146
:param relpath: The name of the file (if known)
147
:param _report_activity: A Transport._report_activity bound method,
148
to be called as data arrives.
150
self.original_offsets = list(original_offsets)
151
self.relpath = relpath
152
self._report_activity = _report_activity
154
def _get_requests(self):
155
"""Break up the offsets into individual requests over sftp.
157
The SFTP spec only requires implementers to support 32kB requests. We
158
could try something larger (openssh supports 64kB), but then we have to
159
handle requests that fail.
160
So instead, we just break up our maximum chunks into 32kB chunks, and
161
asyncronously requests them.
162
Newer versions of paramiko would do the chunking for us, but we want to
163
start processing results right away, so we do it ourselves.
165
# TODO: Because we issue async requests, we don't 'fudge' any extra
166
# data. I'm not 100% sure that is the best choice.
168
# The first thing we do, is to collapse the individual requests as much
169
# as possible, so we don't issues requests <32kB
170
sorted_offsets = sorted(self.original_offsets)
171
coalesced = list(ConnectedTransport._coalesce_offsets(sorted_offsets,
172
limit=0, fudge_factor=0))
174
for c_offset in coalesced:
175
start = c_offset.start
176
size = c_offset.length
178
# Break this up into 32kB requests
180
next_size = min(size, self._max_request_size)
181
requests.append((start, next_size))
184
if 'sftp' in debug.debug_flags:
185
mutter('SFTP.readv(%s) %s offsets => %s coalesced => %s requests',
186
self.relpath, len(sorted_offsets), len(coalesced),
190
def request_and_yield_offsets(self, fp):
191
"""Request the data from the remote machine, yielding the results.
193
:param fp: A Paramiko SFTPFile object that supports readv.
194
:return: Yield the data requested by the original readv caller, one by
197
requests = self._get_requests()
198
offset_iter = iter(self.original_offsets)
199
cur_offset, cur_size = offset_iter.next()
200
# paramiko .readv() yields strings that are in the order of the requests
201
# So we track the current request to know where the next data is
202
# being returned from.
208
# This is used to buffer chunks which we couldn't process yet
209
# It is (start, end, data) tuples.
211
# Create an 'unlimited' data stream, so we stop based on requests,
212
# rather than just because the data stream ended. This lets us detect
214
data_stream = itertools.chain(fp.readv(requests),
215
itertools.repeat(None))
216
for (start, length), data in itertools.izip(requests, data_stream):
218
if cur_coalesced is not None:
219
raise errors.ShortReadvError(self.relpath,
220
start, length, len(data))
221
if len(data) != length:
222
raise errors.ShortReadvError(self.relpath,
223
start, length, len(data))
224
self._report_activity(length, 'read')
226
# This is the first request, just buffer it
227
buffered_data = [data]
228
buffered_len = length
230
elif start == last_end:
231
# The data we are reading fits neatly on the previous
232
# buffer, so this is all part of a larger coalesced range.
233
buffered_data.append(data)
234
buffered_len += length
236
# We have an 'interrupt' in the data stream. So we know we are
237
# at a request boundary.
239
# We haven't consumed the buffer so far, so put it into
240
# data_chunks, and continue.
241
buffered = ''.join(buffered_data)
242
data_chunks.append((input_start, buffered))
244
buffered_data = [data]
245
buffered_len = length
246
last_end = start + length
247
if input_start == cur_offset and cur_size <= buffered_len:
248
# Simplify the next steps a bit by transforming buffered_data
249
# into a single string. We also have the nice property that
250
# when there is only one string ''.join([x]) == x, so there is
252
buffered = ''.join(buffered_data)
253
# Clean out buffered data so that we keep memory
257
# TODO: We *could* also consider the case where cur_offset is in
258
# in the buffered range, even though it doesn't *start*
259
# the buffered range. But for packs we pretty much always
260
# read in order, so you won't get any extra data in the
262
while (input_start == cur_offset
263
and (buffered_offset + cur_size) <= buffered_len):
264
# We've buffered enough data to process this request, spit it
266
cur_data = buffered[buffered_offset:buffered_offset + cur_size]
267
# move the direct pointer into our buffered data
268
buffered_offset += cur_size
269
# Move the start-of-buffer pointer
270
input_start += cur_size
271
# Yield the requested data
272
yield cur_offset, cur_data
273
cur_offset, cur_size = offset_iter.next()
274
# at this point, we've consumed as much of buffered as we can,
275
# so break off the portion that we consumed
276
if buffered_offset == len(buffered_data):
277
# No tail to leave behind
281
buffered = buffered[buffered_offset:]
282
buffered_data = [buffered]
283
buffered_len = len(buffered)
285
buffered = ''.join(buffered_data)
287
data_chunks.append((input_start, buffered))
289
if 'sftp' in debug.debug_flags:
290
mutter('SFTP readv left with %d out-of-order bytes',
291
sum(map(lambda x: len(x[1]), data_chunks)))
292
# We've processed all the readv data, at this point, anything we
293
# couldn't process is in data_chunks. This doesn't happen often, so
294
# this code path isn't optimized
295
# We use an interesting process for data_chunks
296
# Specifically if we have "bisect_left([(start, len, entries)],
298
# If start == qstart, then we get the specific node. Otherwise we
299
# get the previous node
301
idx = bisect.bisect_left(data_chunks, (cur_offset,))
302
if idx < len(data_chunks) and data_chunks[idx][0] == cur_offset:
303
# The data starts here
304
data = data_chunks[idx][1][:cur_size]
306
# The data is in a portion of a previous page
308
sub_offset = cur_offset - data_chunks[idx][0]
309
data = data_chunks[idx][1]
310
data = data[sub_offset:sub_offset + cur_size]
312
# We are missing the page where the data should be found,
315
if len(data) != cur_size:
316
raise AssertionError('We must have miscalulated.'
317
' We expected %d bytes, but only found %d'
318
% (cur_size, len(data)))
319
yield cur_offset, data
320
cur_offset, cur_size = offset_iter.next()
323
class SFTPTransport(ConnectedTransport):
324
"""Transport implementation for SFTP access."""
307
class SFTPTransport (Transport):
309
Transport implementation for SFTP access.
326
311
_do_prefetch = _default_do_prefetch
327
# TODO: jam 20060717 Conceivably these could be configurable, either
328
# by auto-tuning at run-time, or by a configuration (per host??)
329
# but the performance curve is pretty flat, so just going with
330
# reasonable defaults.
331
_max_readv_combine = 200
332
# Having to round trip to the server means waiting for a response,
333
# so it is better to download extra bytes.
334
# 8KiB had good performance for both local and remote network operations
335
_bytes_to_read_before_seek = 8192
337
# The sftp spec says that implementations SHOULD allow reads
338
# to be at least 32K. paramiko.readv() does an async request
339
# for the chunks. So we need to keep it within a single request
340
# size for paramiko <= 1.6.1. paramiko 1.6.2 will probably chop
341
# up the request itself, rather than us having to worry about it
342
_max_request_size = 32768
344
def __init__(self, base, _from_transport=None):
345
super(SFTPTransport, self).__init__(base,
346
_from_transport=_from_transport)
313
def __init__(self, base, clone_from=None):
314
assert base.startswith('sftp://')
315
self._parse_url(base)
316
base = self._unparse_url()
319
super(SFTPTransport, self).__init__(base)
320
if clone_from is None:
323
# use the same ssh connection, etc
324
self._sftp = clone_from._sftp
325
# super saves 'self.base'
327
def should_cache(self):
329
Return True if the data pulled across should be cached locally.
333
def clone(self, offset=None):
335
Return a new SFTPTransport with root at self.base + offset.
336
We share the same SFTP session between such transports, because it's
337
fairly expensive to set them up.
340
return SFTPTransport(self.base, self)
342
return SFTPTransport(self.abspath(offset), self)
344
def abspath(self, relpath):
346
Return the full url to the given relative path.
348
@param relpath: the relative path or path components
349
@type relpath: str or list
351
return self._unparse_url(self._remote_path(relpath))
348
353
def _remote_path(self, relpath):
349
354
"""Return the path to be passed along the sftp protocol for relpath.
351
:param relpath: is a urlencoded string.
353
relative = urlutils.unescape(relpath).encode('utf-8')
354
remote_path = self._combine_paths(self._path, relative)
355
# the initial slash should be removed from the path, and treated as a
356
# homedir relative path (the path begins with a double slash if it is
357
# absolute). see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
358
# RBC 20060118 we are not using this as its too user hostile. instead
359
# we are following lftp and using /~/foo to mean '~/foo'
360
# vila--20070602 and leave absolute paths begin with a single slash.
361
if remote_path.startswith('/~/'):
362
remote_path = remote_path[3:]
363
elif remote_path == '/~':
367
def _create_connection(self, credentials=None):
368
"""Create a new connection with the provided credentials.
370
:param credentials: The credentials needed to establish the connection.
372
:return: The created connection and its associated credentials.
374
The credentials are only the password as it may have been entered
375
interactively by the user and may be different from the one provided
376
in base url at transport creation time.
378
if credentials is None:
379
password = self._password
381
password = credentials
383
vendor = ssh._get_ssh_vendor()
386
auth = config.AuthenticationConfig()
387
user = auth.get_user('ssh', self._host, self._port)
388
connection = vendor.connect_sftp(self._user, password,
389
self._host, self._port)
390
return connection, (user, password)
393
"""Ensures that a connection is established"""
394
connection = self._get_connection()
395
if connection is None:
396
# First connection ever
397
connection, credentials = self._create_connection()
398
self._set_connection(connection, credentials)
356
relpath is a urlencoded string.
358
# FIXME: share the common code across transports
359
assert isinstance(relpath, basestring)
360
relpath = urlutils.unescape(relpath).split('/')
361
basepath = self._path.split('/')
362
if len(basepath) > 0 and basepath[-1] == '':
363
basepath = basepath[:-1]
367
if len(basepath) == 0:
368
# In most filesystems, a request for the parent
369
# of root, just returns root.
377
path = '/'.join(basepath)
380
def relpath(self, abspath):
381
username, password, host, port, path = self._split_url(abspath)
383
if (username != self._username):
384
error.append('username mismatch')
385
if (host != self._host):
386
error.append('host mismatch')
387
if (port != self._port):
388
error.append('port mismatch')
389
if (not path.startswith(self._path)):
390
error.append('path mismatch')
392
extra = ': ' + ', '.join(error)
393
raise PathNotChild(abspath, self.base, extra=extra)
395
return path[pl:].strip('/')
401
397
def has(self, relpath):
403
399
Does the target location exist?
406
self._get_sftp().stat(self._remote_path(relpath))
407
# stat result is about 20 bytes, let's say
408
self._report_activity(20, 'read')
402
self._sftp.stat(self._remote_path(relpath))
413
407
def get(self, relpath):
414
"""Get the file at the given relative path.
409
Get the file at the given relative path.
416
411
:param relpath: The relative path to the file
419
# FIXME: by returning the file directly, we don't pass this
420
# through to report_activity. We could try wrapping the object
421
# before it's returned. For readv and get_bytes it's handled in
422
# the higher-level function.
424
414
path = self._remote_path(relpath)
425
f = self._get_sftp().file(path, mode='rb')
415
f = self._sftp.file(path, mode='rb')
426
416
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
429
419
except (IOError, paramiko.SSHException), e:
430
self._translate_io_exception(e, path, ': error retrieving',
431
failure_exc=errors.ReadError)
433
def get_bytes(self, relpath):
434
# reimplement this here so that we can report how many bytes came back
420
self._translate_io_exception(e, path, ': error retrieving')
422
def get_partial(self, relpath, start, length=None):
424
Get just part of a file.
426
:param relpath: Path to the file, relative to base
427
:param start: The starting position to read from
428
:param length: The length to read. A length of None indicates
429
read to the end of the file.
430
:return: A file-like object containing at least the specified bytes.
431
Some implementations may return objects which can be read
432
past this length, but this is not guaranteed.
434
# TODO: implement get_partial_multi to help with knit support
435
435
f = self.get(relpath)
438
self._report_activity(len(bytes), 'read')
443
def _readv(self, relpath, offsets):
444
"""See Transport.readv()"""
445
# We overload the default readv() because we want to use a file
446
# that does not have prefetch enabled.
447
# Also, if we have a new paramiko, it implements an async readv()
452
path = self._remote_path(relpath)
453
fp = self._get_sftp().file(path, mode='rb')
454
readv = getattr(fp, 'readv', None)
456
return self._sftp_readv(fp, offsets, relpath)
457
if 'sftp' in debug.debug_flags:
458
mutter('seek and read %s offsets', len(offsets))
459
return self._seek_and_read(fp, offsets, relpath)
460
except (IOError, paramiko.SSHException), e:
461
self._translate_io_exception(e, path, ': error retrieving')
463
def recommended_page_size(self):
464
"""See Transport.recommended_page_size().
466
For SFTP we suggest a large page size to reduce the overhead
467
introduced by latency.
471
def _sftp_readv(self, fp, offsets, relpath):
472
"""Use the readv() member of fp to do async readv.
474
Then read them using paramiko.readv(). paramiko.readv()
475
does not support ranges > 64K, so it caps the request size, and
476
just reads until it gets all the stuff it wants.
478
helper = _SFTPReadvHelper(offsets, relpath, self._report_activity)
479
return helper.request_and_yield_offsets(fp)
481
def put_file(self, relpath, f, mode=None):
483
Copy the file-like object into the location.
437
if self._do_prefetch and hasattr(f, 'prefetch'):
441
def put(self, relpath, f, mode=None):
443
Copy the file-like or string object into the location.
485
445
:param relpath: Location to put the contents, relative to base.
486
:param f: File-like object.
446
:param f: File-like or string object.
487
447
:param mode: The final mode for the file
489
449
final_path = self._remote_path(relpath)
490
return self._put(final_path, f, mode=mode)
450
self._put(final_path, f, mode=mode)
492
452
def _put(self, abspath, f, mode=None):
493
453
"""Helper function so both put() and copy_abspaths can reuse the code"""
631
def _mkdir(self, abspath, mode=None):
637
self._report_activity(len(abspath), 'write')
638
self._get_sftp().mkdir(abspath, local_mode)
639
self._report_activity(1, 'read')
641
# chmod a dir through sftp will erase any sgid bit set
642
# on the server side. So, if the bit mode are already
643
# set, avoid the chmod. If the mode is not fine but
644
# the sgid bit is set, report a warning to the user
645
# with the umask fix.
646
stat = self._get_sftp().lstat(abspath)
647
mode = mode & 0777 # can't set special bits anyway
648
if mode != stat.st_mode & 0777:
649
if stat.st_mode & 06000:
650
warning('About to chmod %s over sftp, which will result'
651
' in its suid or sgid bits being cleared. If'
652
' you want to preserve those bits, change your '
653
' environment on the server to use umask 0%03o.'
654
% (abspath, 0777 - mode))
655
self._get_sftp().chmod(abspath, mode=mode)
656
except (paramiko.SSHException, IOError), e:
657
self._translate_io_exception(e, abspath, ': unable to mkdir',
658
failure_exc=FileExists)
660
499
def mkdir(self, relpath, mode=None):
661
500
"""Create a directory at the given path."""
662
self._mkdir(self._remote_path(relpath), mode=mode)
664
def open_write_stream(self, relpath, mode=None):
665
"""See Transport.open_write_stream."""
666
# initialise the file to zero-length
667
# this is three round trips, but we don't use this
668
# api more than once per write_group at the moment so
669
# it is a tolerable overhead. Better would be to truncate
670
# the file after opening. RBC 20070805
671
self.put_bytes_non_atomic(relpath, "", mode)
672
abspath = self._remote_path(relpath)
673
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
674
# set the file mode at create time. If it does, use it.
675
# But for now, we just chmod later anyway.
678
handle = self._get_sftp().file(abspath, mode='wb')
679
handle.set_pipelined(True)
502
path = self._remote_path(relpath)
503
# In the paramiko documentation, it says that passing a mode flag
504
# will filtered against the server umask.
505
# StubSFTPServer does not do this, which would be nice, because it is
506
# what we really want :)
507
# However, real servers do use umask, so we really should do it that way
508
self._sftp.mkdir(path)
510
self._sftp.chmod(path, mode=mode)
680
511
except (paramiko.SSHException, IOError), e:
681
self._translate_io_exception(e, abspath,
683
_file_streams[self.abspath(relpath)] = handle
684
return FileFileStream(self, relpath, handle)
512
self._translate_io_exception(e, path, ': unable to mkdir',
513
failure_exc=FileExists)
686
def _translate_io_exception(self, e, path, more_info='',
515
def _translate_io_exception(self, e, path, more_info='',
687
516
failure_exc=PathError):
688
517
"""Translate a paramiko or IOError into a friendlier exception.
862
650
# that we have taken the lock.
863
651
return SFTPLock(relpath, self)
653
def _unparse_url(self, path=None):
656
path = urllib.quote(path)
657
# handle homedir paths
658
if not path.startswith('/'):
660
netloc = urllib.quote(self._host)
661
if self._username is not None:
662
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
663
if self._port is not None:
664
netloc = '%s:%d' % (netloc, self._port)
665
return urlparse.urlunparse(('sftp', netloc, path, '', '', ''))
667
def _split_url(self, url):
668
(scheme, username, password, host, port, path) = split_url(url)
669
assert scheme == 'sftp'
671
# the initial slash should be removed from the path, and treated
672
# as a homedir relative path (the path begins with a double slash
673
# if it is absolute).
674
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
675
# RBC 20060118 we are not using this as its too user hostile. instead
676
# we are following lftp and using /~/foo to mean '~/foo'.
677
# handle homedir paths
678
if path.startswith('/~/'):
682
return (username, password, host, port, path)
684
def _parse_url(self, url):
685
(self._username, self._password,
686
self._host, self._port, self._path) = self._split_url(url)
688
def _sftp_connect(self):
689
"""Connect to the remote sftp server.
690
After this, self._sftp should have a valid connection (or
691
we raise an TransportError 'could not connect').
693
TODO: Raise a more reasonable ConnectionFailed exception
695
global _connected_hosts
697
idx = (self._host, self._port, self._username)
699
self._sftp = _connected_hosts[idx]
704
vendor = _get_ssh_vendor()
705
if vendor == 'loopback':
706
sock = socket.socket()
708
sock.connect((self._host, self._port))
709
except socket.error, e:
710
raise ConnectionError('Unable to connect to SSH host %s:%s: %s'
711
% (self._host, self._port, e))
712
self._sftp = SFTPClient(LoopbackSFTP(sock))
713
elif vendor != 'none':
714
sock = SFTPSubprocess(self._host, vendor, self._port,
716
self._sftp = SFTPClient(sock)
718
self._paramiko_connect()
720
_connected_hosts[idx] = self._sftp
722
def _paramiko_connect(self):
723
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
728
t = paramiko.Transport((self._host, self._port or 22))
729
t.set_log_channel('bzr.paramiko')
731
except paramiko.SSHException, e:
732
raise ConnectionError('Unable to reach SSH host %s:%s: %s'
733
% (self._host, self._port, e))
735
server_key = t.get_remote_server_key()
736
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
737
keytype = server_key.get_name()
738
if SYSTEM_HOSTKEYS.has_key(self._host) and SYSTEM_HOSTKEYS[self._host].has_key(keytype):
739
our_server_key = SYSTEM_HOSTKEYS[self._host][keytype]
740
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
741
elif BZR_HOSTKEYS.has_key(self._host) and BZR_HOSTKEYS[self._host].has_key(keytype):
742
our_server_key = BZR_HOSTKEYS[self._host][keytype]
743
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
745
warning('Adding %s host key for %s: %s' % (keytype, self._host, server_key_hex))
746
if not BZR_HOSTKEYS.has_key(self._host):
747
BZR_HOSTKEYS[self._host] = {}
748
BZR_HOSTKEYS[self._host][keytype] = server_key
749
our_server_key = server_key
750
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
752
if server_key != our_server_key:
753
filename1 = os.path.expanduser('~/.ssh/known_hosts')
754
filename2 = pathjoin(config_dir(), 'ssh_host_keys')
755
raise TransportError('Host keys for %s do not match! %s != %s' % \
756
(self._host, our_server_key_hex, server_key_hex),
757
['Try editing %s or %s' % (filename1, filename2)])
762
self._sftp = t.open_sftp_client()
763
except paramiko.SSHException, e:
764
raise ConnectionError('Unable to start sftp client %s:%d' %
765
(self._host, self._port), e)
767
def _sftp_auth(self, transport):
768
# paramiko requires a username, but it might be none if nothing was supplied
769
# use the local username, just in case.
770
# We don't override self._username, because if we aren't using paramiko,
771
# the username might be specified in ~/.ssh/config and we don't want to
772
# force it to something else
773
# Also, it would mess up the self.relpath() functionality
774
username = self._username or getpass.getuser()
776
# Paramiko tries to open a socket.AF_UNIX in order to connect
777
# to ssh-agent. That attribute doesn't exist on win32 (it does in cygwin)
778
# so we get an AttributeError exception. For now, just don't try to
779
# connect to an agent if we are on win32
780
if sys.platform != 'win32':
781
agent = paramiko.Agent()
782
for key in agent.get_keys():
783
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
785
transport.auth_publickey(username, key)
787
except paramiko.SSHException, e:
790
# okay, try finding id_rsa or id_dss? (posix only)
791
if self._try_pkey_auth(transport, paramiko.RSAKey, username, 'id_rsa'):
793
if self._try_pkey_auth(transport, paramiko.DSSKey, username, 'id_dsa'):
798
transport.auth_password(username, self._password)
800
except paramiko.SSHException, e:
803
# FIXME: Don't keep a password held in memory if you can help it
804
#self._password = None
806
# give up and ask for a password
807
password = bzrlib.ui.ui_factory.get_password(
808
prompt='SSH %(user)s@%(host)s password',
809
user=username, host=self._host)
811
transport.auth_password(username, password)
812
except paramiko.SSHException, e:
813
raise ConnectionError('Unable to authenticate to SSH host as %s@%s' %
814
(username, self._host), e)
816
def _try_pkey_auth(self, transport, pkey_class, username, filename):
817
filename = os.path.expanduser('~/.ssh/' + filename)
819
key = pkey_class.from_private_key_file(filename)
820
transport.auth_publickey(username, key)
822
except paramiko.PasswordRequiredException:
823
password = bzrlib.ui.ui_factory.get_password(
824
prompt='SSH %(filename)s password',
827
key = pkey_class.from_private_key_file(filename, password)
828
transport.auth_publickey(username, key)
830
except paramiko.SSHException:
831
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
832
except paramiko.SSHException:
833
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
865
838
def _sftp_open_exclusive(self, abspath, mode=None):
866
839
"""Open a remote path exclusively.
876
849
:param abspath: The remote absolute path where the file should be opened
877
850
:param mode: The mode permissions bits for the new file
879
# TODO: jam 20060816 Paramiko >= 1.6.2 (probably earlier) supports
880
# using the 'x' flag to indicate SFTP_FLAG_EXCL.
881
# However, there is no way to set the permission mode at open
882
# time using the sftp_client.file() functionality.
883
path = self._get_sftp()._adjust_cwd(abspath)
884
# mutter('sftp abspath %s => %s', abspath, path)
852
path = self._sftp._adjust_cwd(abspath)
885
853
attr = SFTPAttributes()
886
854
if mode is not None:
887
855
attr.st_mode = mode
888
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
856
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
889
857
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
891
t, msg = self._get_sftp()._request(CMD_OPEN, path, omode, attr)
859
t, msg = self._sftp._request(CMD_OPEN, path, omode, attr)
892
860
if t != CMD_HANDLE:
893
861
raise TransportError('Expected an SFTP handle')
894
862
handle = msg.get_string()
895
return SFTPFile(self._get_sftp(), handle, 'wb', -1)
863
return SFTPFile(self._sftp, handle, 'wb', -1)
896
864
except (paramiko.SSHException, IOError), e:
897
865
self._translate_io_exception(e, abspath, ': unable to open',
898
866
failure_exc=FileExists)
900
def _can_roundtrip_unix_modebits(self):
901
if sys.platform == 'win32':
869
# ------------- server test implementation --------------
873
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
875
STUB_SERVER_KEY = """
876
-----BEGIN RSA PRIVATE KEY-----
877
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
878
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
879
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
880
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
881
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
882
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
883
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
884
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
885
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
886
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
887
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
888
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
889
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
890
-----END RSA PRIVATE KEY-----
894
class SocketListener(threading.Thread):
896
def __init__(self, callback):
897
threading.Thread.__init__(self)
898
self._callback = callback
899
self._socket = socket.socket()
900
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
901
self._socket.bind(('localhost', 0))
902
self._socket.listen(1)
903
self.port = self._socket.getsockname()[1]
904
self._stop_event = threading.Event()
907
# called from outside this thread
908
self._stop_event.set()
909
# use a timeout here, because if the test fails, the server thread may
910
# never notice the stop_event.
916
readable, writable_unused, exception_unused = \
917
select.select([self._socket], [], [], 0.1)
918
if self._stop_event.isSet():
920
if len(readable) == 0:
923
s, addr_unused = self._socket.accept()
924
# because the loopback socket is inline, and transports are
925
# never explicitly closed, best to launch a new thread.
926
threading.Thread(target=self._callback, args=(s,)).start()
927
except socket.error, x:
928
sys.excepthook(*sys.exc_info())
929
warning('Socket error during accept() within unit test server'
932
# probably a failed test; unit test thread will log the
934
sys.excepthook(*sys.exc_info())
935
warning('Exception from within unit test server thread: %r' %
939
class SFTPServer(Server):
940
"""Common code for SFTP server facilities."""
943
self._original_vendor = None
945
self._server_homedir = None
946
self._listener = None
948
self._vendor = 'none'
952
def _get_sftp_url(self, path):
953
"""Calculate an sftp url to this server for path."""
954
return 'sftp://foo:bar@localhost:%d/%s' % (self._listener.port, path)
956
def log(self, message):
957
"""StubServer uses this to log when a new server is created."""
958
self.logs.append(message)
960
def _run_server(self, s):
961
ssh_server = paramiko.Transport(s)
962
key_file = os.path.join(self._homedir, 'test_rsa.key')
963
f = open(key_file, 'w')
964
f.write(STUB_SERVER_KEY)
966
host_key = paramiko.RSAKey.from_private_key_file(key_file)
967
ssh_server.add_server_key(host_key)
968
server = StubServer(self)
969
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
970
StubSFTPServer, root=self._root,
971
home=self._server_homedir)
972
event = threading.Event()
973
ssh_server.start_server(event, server)
978
self._original_vendor = _ssh_vendor
979
_ssh_vendor = self._vendor
980
self._homedir = os.getcwd()
981
if self._server_homedir is None:
982
self._server_homedir = self._homedir
984
# FIXME WINDOWS: _root should be _server_homedir[0]:/
985
self._listener = SocketListener(self._run_server)
986
self._listener.setDaemon(True)
987
self._listener.start()
990
"""See bzrlib.transport.Server.tearDown."""
992
self._listener.stop()
993
_ssh_vendor = self._original_vendor
995
def get_bogus_url(self):
996
"""See bzrlib.transport.Server.get_bogus_url."""
997
# this is chosen to try to prevent trouble with proxies, wierd dns,
999
return 'sftp://127.0.0.1:1/'
1003
class SFTPFullAbsoluteServer(SFTPServer):
1004
"""A test server for sftp transports, using absolute urls and ssh."""
1007
"""See bzrlib.transport.Server.get_url."""
1008
return self._get_sftp_url(urlutils.escape(self._homedir[1:]))
1011
class SFTPServerWithoutSSH(SFTPServer):
1012
"""An SFTP server that uses a simple TCP socket pair rather than SSH."""
1015
super(SFTPServerWithoutSSH, self).__init__()
1016
self._vendor = 'loopback'
1018
def _run_server(self, sock):
1019
class FakeChannel(object):
1020
def get_transport(self):
1022
def get_log_channel(self):
1026
def get_hexdump(self):
1031
server = paramiko.SFTPServer(FakeChannel(), 'sftp', StubServer(self), StubSFTPServer,
1032
root=self._root, home=self._server_homedir)
1033
server.start_subsystem('sftp', None, sock)
1034
server.finish_subsystem()
1037
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
1038
"""A test server for sftp transports, using absolute urls."""
1041
"""See bzrlib.transport.Server.get_url."""
1042
return self._get_sftp_url(urlutils.escape(self._homedir[1:]))
1045
class SFTPHomeDirServer(SFTPServerWithoutSSH):
1046
"""A test server for sftp transports, using homedir relative urls."""
1049
"""See bzrlib.transport.Server.get_url."""
1050
return self._get_sftp_url("~/")
1053
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
1054
"""A test servere for sftp transports, using absolute urls to non-home."""
1057
self._server_homedir = '/dev/noone/runs/tests/here'
1058
super(SFTPSiblingAbsoluteServer, self).setUp()
908
1061
def get_test_permutations():
909
1062
"""Return the permutations to be used in testing."""
910
from bzrlib.tests import stub_sftp
911
return [(SFTPTransport, stub_sftp.SFTPAbsoluteServer),
912
(SFTPTransport, stub_sftp.SFTPHomeDirServer),
913
(SFTPTransport, stub_sftp.SFTPSiblingAbsoluteServer),
1063
return [(SFTPTransport, SFTPAbsoluteServer),
1064
(SFTPTransport, SFTPHomeDirServer),
1065
(SFTPTransport, SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
