2 import heapq, traceback, array, stat, struct
3 from types import NoneType
4 from stat import S_IFREG, S_IFDIR
5 from time import time, strftime, localtime
7 from zope.interface import implements
8 from twisted.python import components
9 from twisted.application import service, strports
10 from twisted.conch.ssh import factory, keys, session
11 from twisted.conch.ssh.filetransfer import FileTransferServer, SFTPError, \
12 FX_NO_SUCH_FILE, FX_OP_UNSUPPORTED, FX_PERMISSION_DENIED, FX_EOF, \
13 FX_BAD_MESSAGE, FX_FAILURE, FX_OK
14 from twisted.conch.ssh.filetransfer import FXF_READ, FXF_WRITE, FXF_APPEND, \
15 FXF_CREAT, FXF_TRUNC, FXF_EXCL
16 from twisted.conch.interfaces import ISFTPServer, ISFTPFile, IConchUser, ISession
17 from twisted.conch.avatar import ConchUser
18 from twisted.conch.openssh_compat import primes
19 from twisted.cred import portal
20 from twisted.internet.error import ProcessDone, ProcessTerminated
21 from twisted.python.failure import Failure
22 from twisted.internet.interfaces import ITransport
24 from twisted.internet import defer
25 from twisted.internet.interfaces import IFinishableConsumer
26 from foolscap.api import eventually
27 from allmydata.util import deferredutil
29 from allmydata.util.consumer import download_to_data
30 from allmydata.interfaces import IFileNode, IDirectoryNode, ExistingChildError, \
31 NoSuchChildError, ChildOfWrongTypeError
32 from allmydata.mutable.common import NotWriteableError
33 from allmydata.immutable.upload import FileHandle
34 from allmydata.dirnode import update_metadata
35 from allmydata.util.fileutil import EncryptedTemporaryFile
38 use_foolscap_logging = True
40 from allmydata.util.log import NOISY, OPERATIONAL, WEIRD, \
41 msg as _msg, err as _err, PrefixingLogMixin as _PrefixingLogMixin
43 if use_foolscap_logging:
44 (logmsg, logerr, PrefixingLogMixin) = (_msg, _err, _PrefixingLogMixin)
45 else: # pragma: no cover
46 def logmsg(s, level=None):
48 def logerr(s, level=None):
50 class PrefixingLogMixin:
51 def __init__(self, facility=None, prefix=''):
53 def log(self, s, level=None):
54 print "%r %s" % (self.prefix, s)
57 def eventually_callback(d):
58 return lambda res: eventually(d.callback, res)
60 def eventually_errback(d):
61 return lambda err: eventually(d.errback, err)
65 if isinstance(x, unicode):
66 return x.encode('utf-8')
67 if isinstance(x, str):
73 """SFTP times are unsigned 32-bit integers representing UTC seconds
74 (ignoring leap seconds) since the Unix epoch, January 1 1970 00:00 UTC.
75 A Tahoe time is the corresponding float."""
76 return long(t) & 0xFFFFFFFFL
79 def _convert_error(res, request):
80 """If res is not a Failure, return it, otherwise reraise the appropriate
83 if not isinstance(res, Failure):
85 if isinstance(res, str): logged_res = "<data of length %r>" % (len(res),)
86 logmsg("SUCCESS %r %r" % (request, logged_res,), level=OPERATIONAL)
90 logmsg("RAISE %r %r" % (request, err.value), level=OPERATIONAL)
92 if noisy: logmsg(traceback.format_exc(err.value), level=NOISY)
93 except Exception: # pragma: no cover
96 # The message argument to SFTPError must not reveal information that
97 # might compromise anonymity, if we are running over an anonymous network.
99 if err.check(SFTPError):
100 # original raiser of SFTPError has responsibility to ensure anonymity
102 if err.check(NoSuchChildError):
103 childname = _utf8(err.value.args[0])
104 raise SFTPError(FX_NO_SUCH_FILE, childname)
105 if err.check(NotWriteableError) or err.check(ChildOfWrongTypeError):
106 msg = _utf8(err.value.args[0])
107 raise SFTPError(FX_PERMISSION_DENIED, msg)
108 if err.check(ExistingChildError):
109 # Versions of SFTP after v3 (which is what twisted.conch implements)
110 # define a specific error code for this case: FX_FILE_ALREADY_EXISTS.
111 # However v3 doesn't; instead, other servers such as sshd return
112 # FX_FAILURE. The gvfs SFTP backend, for example, depends on this
113 # to translate the error to the equivalent of POSIX EEXIST, which is
114 # necessary for some picky programs (such as gedit).
115 msg = _utf8(err.value.args[0])
116 raise SFTPError(FX_FAILURE, msg)
117 if err.check(NotImplementedError):
118 raise SFTPError(FX_OP_UNSUPPORTED, _utf8(err.value))
119 if err.check(EOFError):
120 raise SFTPError(FX_EOF, "end of file reached")
121 if err.check(defer.FirstError):
122 _convert_error(err.value.subFailure, request)
124 # We assume that the error message is not anonymity-sensitive.
125 raise SFTPError(FX_FAILURE, _utf8(err.value))
128 def _repr_flags(flags):
129 return "|".join([f for f in
130 [(flags & FXF_READ) and "FXF_READ" or None,
131 (flags & FXF_WRITE) and "FXF_WRITE" or None,
132 (flags & FXF_APPEND) and "FXF_APPEND" or None,
133 (flags & FXF_CREAT) and "FXF_CREAT" or None,
134 (flags & FXF_TRUNC) and "FXF_TRUNC" or None,
135 (flags & FXF_EXCL) and "FXF_EXCL" or None,
140 def _lsLine(name, attrs):
143 st_mtime = attrs.get("mtime", 0)
144 st_mode = attrs["permissions"]
146 # Some clients won't tolerate '?' in the size field (#1337).
147 st_size = attrs.get("size", 0)
149 # We don't know how many links there really are to this object.
152 # Based on <http://twistedmatrix.com/trac/browser/trunk/twisted/conch/ls.py?rev=25412>.
153 # We can't call the version in Twisted because we might have a version earlier than
154 # <http://twistedmatrix.com/trac/changeset/25412> (released in Twisted 8.2).
157 perms = array.array('c', '-'*10)
158 ft = stat.S_IFMT(mode)
159 if stat.S_ISDIR(ft): perms[0] = 'd'
160 elif stat.S_ISREG(ft): perms[0] = '-'
163 if mode&stat.S_IRUSR: perms[1] = 'r'
164 if mode&stat.S_IWUSR: perms[2] = 'w'
165 if mode&stat.S_IXUSR: perms[3] = 'x'
167 if mode&stat.S_IRGRP: perms[4] = 'r'
168 if mode&stat.S_IWGRP: perms[5] = 'w'
169 if mode&stat.S_IXGRP: perms[6] = 'x'
171 if mode&stat.S_IROTH: perms[7] = 'r'
172 if mode&stat.S_IWOTH: perms[8] = 'w'
173 if mode&stat.S_IXOTH: perms[9] = 'x'
174 # suid/sgid never set
177 l += str(st_nlink).rjust(5) + ' '
188 if st_mtime + sixmo < now or st_mtime > now + day:
189 # mtime is more than 6 months ago, or more than one day in the future
190 l += strftime("%b %d %Y ", localtime(st_mtime))
192 l += strftime("%b %d %H:%M ", localtime(st_mtime))
197 def _no_write(parent_readonly, child, metadata=None):
198 """Whether child should be listed as having read-only permissions in parent."""
200 if child.is_unknown():
202 elif child.is_mutable():
203 return child.is_readonly()
204 elif parent_readonly or IDirectoryNode.providedBy(child):
207 return metadata is not None and metadata.get('no-write', False)
210 def _populate_attrs(childnode, metadata, size=None):
213 # The permissions must have the S_IFDIR (040000) or S_IFREG (0100000)
214 # bits, otherwise the client may refuse to open a directory.
215 # Also, sshfs run as a non-root user requires files and directories
216 # to be world-readable/writeable.
217 # It is important that we never set the executable bits on files.
219 # Directories and unknown nodes have no size, and SFTP doesn't
220 # require us to make one up.
222 # childnode might be None, meaning that the file doesn't exist yet,
223 # but we're going to write it later.
225 if childnode and childnode.is_unknown():
227 elif childnode and IDirectoryNode.providedBy(childnode):
228 perms = S_IFDIR | 0777
230 # For files, omit the size if we don't immediately know it.
231 if childnode and size is None:
232 size = childnode.get_size()
234 assert isinstance(size, (int, long)) and not isinstance(size, bool), repr(size)
236 perms = S_IFREG | 0666
239 if metadata.get('no-write', False):
240 perms &= S_IFDIR | S_IFREG | 0555 # clear 'w' bits
242 # See webapi.txt for what these times mean.
243 # We would prefer to omit atime, but SFTP version 3 can only
244 # accept mtime if atime is also set.
245 if 'linkmotime' in metadata.get('tahoe', {}):
246 attrs['ctime'] = attrs['mtime'] = attrs['atime'] = _to_sftp_time(metadata['tahoe']['linkmotime'])
247 elif 'mtime' in metadata:
248 attrs['ctime'] = attrs['mtime'] = attrs['atime'] = _to_sftp_time(metadata['mtime'])
250 if 'linkcrtime' in metadata.get('tahoe', {}):
251 attrs['createtime'] = _to_sftp_time(metadata['tahoe']['linkcrtime'])
253 attrs['permissions'] = perms
255 # twisted.conch.ssh.filetransfer only implements SFTP version 3,
256 # which doesn't include SSH_FILEXFER_ATTR_FLAGS.
261 def _attrs_to_metadata(attrs):
265 if key == "mtime" or key == "ctime" or key == "createtime":
266 metadata[key] = long(attrs[key])
267 elif key.startswith("ext_"):
268 metadata[key] = str(attrs[key])
270 perms = attrs.get('permissions', stat.S_IWUSR)
271 if not (perms & stat.S_IWUSR):
272 metadata['no-write'] = True
277 def _direntry_for(filenode_or_parent, childname, filenode=None):
278 assert isinstance(childname, (unicode, NoneType)), childname
280 if childname is None:
281 filenode_or_parent = filenode
283 if filenode_or_parent:
284 rw_uri = filenode_or_parent.get_write_uri()
285 if rw_uri and childname:
286 return rw_uri + "/" + childname.encode('utf-8')
293 class OverwriteableFileConsumer(PrefixingLogMixin):
294 implements(IFinishableConsumer)
295 """I act both as a consumer for the download of the original file contents, and as a
296 wrapper for a temporary file that records the downloaded data and any overwrites.
297 I use a priority queue to keep track of which regions of the file have been overwritten
298 but not yet downloaded, so that the download does not clobber overwritten data.
299 I use another priority queue to record milestones at which to make callbacks
300 indicating that a given number of bytes have been downloaded.
302 The temporary file reflects the contents of the file that I represent, except that:
303 - regions that have neither been downloaded nor overwritten, if present,
305 - the temporary file may be shorter than the represented file (it is never longer).
306 The latter's current size is stored in self.current_size.
308 This abstraction is mostly independent of SFTP. Consider moving it, if it is found
309 useful for other frontends."""
311 def __init__(self, download_size, tempfile_maker):
312 PrefixingLogMixin.__init__(self, facility="tahoe.sftp")
313 if noisy: self.log(".__init__(%r, %r)" % (download_size, tempfile_maker), level=NOISY)
314 self.download_size = download_size
315 self.current_size = download_size
316 self.f = tempfile_maker()
318 self.milestones = [] # empty heap of (offset, d)
319 self.overwrites = [] # empty heap of (start, end)
320 self.is_closed = False
321 self.done = self.when_reached(download_size) # adds a milestone
323 def _signal_done(ign):
324 if noisy: self.log("DONE", level=NOISY)
326 self.done.addCallback(_signal_done)
332 def get_current_size(self):
333 return self.current_size
335 def set_current_size(self, size):
336 if noisy: self.log(".set_current_size(%r), current_size = %r, downloaded = %r" %
337 (size, self.current_size, self.downloaded), level=NOISY)
338 if size < self.current_size or size < self.downloaded:
339 self.f.truncate(size)
340 if size > self.current_size:
341 self.overwrite(self.current_size, "\x00" * (size - self.current_size))
342 self.current_size = size
344 # make the invariant self.download_size <= self.current_size be true again
345 if size < self.download_size:
346 self.download_size = size
348 if self.downloaded >= self.download_size:
351 def registerProducer(self, p, streaming):
352 if noisy: self.log(".registerProducer(%r, streaming=%r)" % (p, streaming), level=NOISY)
353 if self.producer is not None:
354 raise RuntimeError("producer is already registered")
358 # call resumeProducing once to start things off
367 def write(self, data):
368 if noisy: self.log(".write(<data of length %r>)" % (len(data),), level=NOISY)
372 if self.downloaded >= self.download_size:
375 next_downloaded = self.downloaded + len(data)
376 if next_downloaded > self.download_size:
377 data = data[:(self.download_size - self.downloaded)]
379 while len(self.overwrites) > 0:
380 (start, end) = self.overwrites[0]
381 if start >= next_downloaded:
382 # This and all remaining overwrites are after the data we just downloaded.
384 if start > self.downloaded:
385 # The data we just downloaded has been partially overwritten.
386 # Write the prefix of it that precedes the overwritten region.
387 self.f.seek(self.downloaded)
388 self.f.write(data[:(start - self.downloaded)])
390 # This merges consecutive overwrites if possible, which allows us to detect the
391 # case where the download can be stopped early because the remaining region
392 # to download has already been fully overwritten.
393 heapq.heappop(self.overwrites)
394 while len(self.overwrites) > 0:
395 (start1, end1) = self.overwrites[0]
399 heapq.heappop(self.overwrites)
401 if end >= next_downloaded:
402 # This overwrite extends past the downloaded data, so there is no
403 # more data to consider on this call.
404 heapq.heappush(self.overwrites, (next_downloaded, end))
405 self._update_downloaded(next_downloaded)
407 elif end >= self.downloaded:
408 data = data[(end - self.downloaded):]
409 self._update_downloaded(end)
411 self.f.seek(self.downloaded)
413 self._update_downloaded(next_downloaded)
415 def _update_downloaded(self, new_downloaded):
416 self.downloaded = new_downloaded
417 milestone = new_downloaded
418 if len(self.overwrites) > 0:
419 (start, end) = self.overwrites[0]
420 if start <= new_downloaded and end > milestone:
423 while len(self.milestones) > 0:
424 (next, d) = self.milestones[0]
427 if noisy: self.log("MILESTONE %r %r" % (next, d), level=NOISY)
428 heapq.heappop(self.milestones)
429 eventually(d.callback, None)
431 if milestone >= self.download_size:
434 def overwrite(self, offset, data):
435 if noisy: self.log(".overwrite(%r, <data of length %r>)" % (offset, len(data)), level=NOISY)
436 if offset > self.current_size:
437 # Normally writing at an offset beyond the current end-of-file
438 # would leave a hole that appears filled with zeroes. However, an
439 # EncryptedTemporaryFile doesn't behave like that (if there is a
440 # hole in the file on disk, the zeroes that are read back will be
441 # XORed with the keystream). So we must explicitly write zeroes in
442 # the gap between the current EOF and the offset.
444 self.f.seek(self.current_size)
445 self.f.write("\x00" * (offset - self.current_size))
446 start = self.current_size
452 end = offset + len(data)
453 self.current_size = max(self.current_size, end)
454 if end > self.downloaded:
455 heapq.heappush(self.overwrites, (start, end))
457 def read(self, offset, length):
458 """When the data has been read, callback the Deferred that we return with this data.
459 Otherwise errback the Deferred that we return.
460 The caller must perform no more overwrites until the Deferred has fired."""
462 if noisy: self.log(".read(%r, %r), current_size = %r" % (offset, length, self.current_size), level=NOISY)
463 if offset >= self.current_size:
464 def _eof(): raise EOFError("read past end of file")
465 return defer.execute(_eof)
467 if offset + length > self.current_size:
468 length = self.current_size - offset
469 if noisy: self.log("truncating read to %r bytes" % (length,), level=NOISY)
471 needed = min(offset + length, self.download_size)
472 d = self.when_reached(needed)
474 # It is not necessarily the case that self.downloaded >= needed, because
475 # the file might have been truncated (thus truncating the download) and
478 assert self.current_size >= offset + length, (self.current_size, offset, length)
479 if noisy: self.log("self.f = %r" % (self.f,), level=NOISY)
481 return self.f.read(length)
482 d.addCallback(_reached)
485 def when_reached(self, index):
486 if noisy: self.log(".when_reached(%r)" % (index,), level=NOISY)
487 if index <= self.downloaded: # already reached
488 if noisy: self.log("already reached %r" % (index,), level=NOISY)
489 return defer.succeed(None)
492 if noisy: self.log("reached %r" % (index,), level=NOISY)
494 d.addCallback(_reached)
495 heapq.heappush(self.milestones, (index, d))
502 """Called by the producer when it has finished producing, or when we have
503 received enough bytes, or as a result of a close. Defined by IFinishableConsumer."""
505 while len(self.milestones) > 0:
506 (next, d) = self.milestones[0]
507 if noisy: self.log("MILESTONE FINISH %r %r" % (next, d), level=NOISY)
508 heapq.heappop(self.milestones)
509 # The callback means that the milestone has been reached if
510 # it is ever going to be. Note that the file may have been
511 # truncated to before the milestone.
512 eventually(d.callback, None)
515 if not self.is_closed:
516 self.is_closed = True
520 self.log("suppressed %r from close of temporary file %r" % (e, self.f), level=WEIRD)
523 def unregisterProducer(self):
527 SIZE_THRESHOLD = 1000
530 class ShortReadOnlySFTPFile(PrefixingLogMixin):
531 implements(ISFTPFile)
532 """I represent a file handle to a particular file on an SFTP connection.
533 I am used only for short immutable files opened in read-only mode.
534 When I am created, the file contents start to be downloaded to memory.
535 self.async is used to delay read requests until the download has finished."""
537 def __init__(self, userpath, filenode, metadata):
538 PrefixingLogMixin.__init__(self, facility="tahoe.sftp", prefix=userpath)
539 if noisy: self.log(".__init__(%r, %r, %r)" % (userpath, filenode, metadata), level=NOISY)
541 assert isinstance(userpath, str) and IFileNode.providedBy(filenode), (userpath, filenode)
542 self.filenode = filenode
543 self.metadata = metadata
544 self.async = download_to_data(filenode)
547 def readChunk(self, offset, length):
548 request = ".readChunk(%r, %r)" % (offset, length)
549 self.log(request, level=OPERATIONAL)
552 def _closed(): raise SFTPError(FX_BAD_MESSAGE, "cannot read from a closed file handle")
553 return defer.execute(_closed)
557 if noisy: self.log("_read(<data of length %r>) in readChunk(%r, %r)" % (len(data), offset, length), level=NOISY)
559 # "In response to this request, the server will read as many bytes as it
560 # can from the file (up to 'len'), and return them in a SSH_FXP_DATA
561 # message. If an error occurs or EOF is encountered before reading any
562 # data, the server will respond with SSH_FXP_STATUS. For normal disk
563 # files, it is guaranteed that this will read the specified number of
564 # bytes, or up to end of file."
566 # i.e. we respond with an EOF error iff offset is already at EOF.
568 if offset >= len(data):
569 eventually(d.errback, SFTPError(FX_EOF, "read at or past end of file"))
571 eventually(d.callback, data[offset:offset+length]) # truncated if offset+length > len(data)
573 self.async.addCallbacks(_read, eventually_errback(d))
574 d.addBoth(_convert_error, request)
577 def writeChunk(self, offset, data):
578 self.log(".writeChunk(%r, <data of length %r>) denied" % (offset, len(data)), level=OPERATIONAL)
580 def _denied(): raise SFTPError(FX_PERMISSION_DENIED, "file handle was not opened for writing")
581 return defer.execute(_denied)
584 self.log(".close()", level=OPERATIONAL)
587 return defer.succeed(None)
590 request = ".getAttrs()"
591 self.log(request, level=OPERATIONAL)
594 def _closed(): raise SFTPError(FX_BAD_MESSAGE, "cannot get attributes for a closed file handle")
595 return defer.execute(_closed)
597 d = defer.execute(_populate_attrs, self.filenode, self.metadata)
598 d.addBoth(_convert_error, request)
601 def setAttrs(self, attrs):
602 self.log(".setAttrs(%r) denied" % (attrs,), level=OPERATIONAL)
603 def _denied(): raise SFTPError(FX_PERMISSION_DENIED, "file handle was not opened for writing")
604 return defer.execute(_denied)
607 class GeneralSFTPFile(PrefixingLogMixin):
608 implements(ISFTPFile)
609 """I represent a file handle to a particular file on an SFTP connection.
610 I wrap an instance of OverwriteableFileConsumer, which is responsible for
611 storing the file contents. In order to allow write requests to be satisfied
612 immediately, there is effectively a FIFO queue between requests made to this
613 file handle, and requests to my OverwriteableFileConsumer. This queue is
614 implemented by the callback chain of self.async.
616 When first constructed, I am in an 'unopened' state that causes most
617 operations to be delayed until 'open' is called."""
619 def __init__(self, userpath, flags, close_notify, convergence):
620 PrefixingLogMixin.__init__(self, facility="tahoe.sftp", prefix=userpath)
621 if noisy: self.log(".__init__(%r, %r = %r, %r, <convergence censored>)" %
622 (userpath, flags, _repr_flags(flags), close_notify), level=NOISY)
624 assert isinstance(userpath, str), userpath
625 self.userpath = userpath
627 self.close_notify = close_notify
628 self.convergence = convergence
629 self.async = defer.Deferred()
630 # Creating or truncating the file is a change, but if FXF_EXCL is set, a zero-length file has already been created.
631 self.has_changed = (flags & (FXF_CREAT | FXF_TRUNC)) and not (flags & FXF_EXCL)
633 self.abandoned = False
635 self.childname = None
639 # self.consumer should only be relied on in callbacks for self.async, since it might
640 # not be set before then.
643 def open(self, parent=None, childname=None, filenode=None, metadata=None):
644 self.log(".open(parent=%r, childname=%r, filenode=%r, metadata=%r)" %
645 (parent, childname, filenode, metadata), level=OPERATIONAL)
647 assert isinstance(childname, (unicode, NoneType)), childname
648 # If the file has been renamed, the new (parent, childname) takes precedence.
649 if self.parent is None:
651 if self.childname is None:
652 self.childname = childname
653 self.filenode = filenode
654 self.metadata = metadata
656 assert not self.closed, self
657 tempfile_maker = EncryptedTemporaryFile
659 if (self.flags & FXF_TRUNC) or not filenode:
660 # We're either truncating or creating the file, so we don't need the old contents.
661 self.consumer = OverwriteableFileConsumer(0, tempfile_maker)
662 self.consumer.finish()
664 assert IFileNode.providedBy(filenode), filenode
666 if filenode.is_mutable():
667 self.async.addCallback(lambda ign: filenode.download_best_version())
668 def _downloaded(data):
669 self.consumer = OverwriteableFileConsumer(len(data), tempfile_maker)
670 self.consumer.write(data)
671 self.consumer.finish()
673 self.async.addCallback(_downloaded)
675 download_size = filenode.get_size()
676 assert download_size is not None, "download_size is None"
677 self.consumer = OverwriteableFileConsumer(download_size, tempfile_maker)
679 if noisy: self.log("_read immutable", level=NOISY)
680 filenode.read(self.consumer, 0, None)
681 self.async.addCallback(_read)
683 eventually(self.async.callback, None)
685 if noisy: self.log("open done", level=NOISY)
688 def get_userpath(self):
691 def get_direntry(self):
692 return _direntry_for(self.parent, self.childname)
694 def rename(self, new_userpath, new_parent, new_childname):
695 self.log(".rename(%r, %r, %r)" % (new_userpath, new_parent, new_childname), level=OPERATIONAL)
697 assert isinstance(new_userpath, str) and isinstance(new_childname, unicode), (new_userpath, new_childname)
698 self.userpath = new_userpath
699 self.parent = new_parent
700 self.childname = new_childname
703 self.log(".abandon()", level=OPERATIONAL)
705 self.abandoned = True
707 def sync(self, ign=None):
708 # The ign argument allows some_file.sync to be used as a callback.
709 self.log(".sync()", level=OPERATIONAL)
712 self.async.addBoth(eventually_callback(d))
714 if noisy: self.log("_done(%r) in .sync()" % (res,), level=NOISY)
719 def readChunk(self, offset, length):
720 request = ".readChunk(%r, %r)" % (offset, length)
721 self.log(request, level=OPERATIONAL)
723 if not (self.flags & FXF_READ):
724 def _denied(): raise SFTPError(FX_PERMISSION_DENIED, "file handle was not opened for reading")
725 return defer.execute(_denied)
728 def _closed(): raise SFTPError(FX_BAD_MESSAGE, "cannot read from a closed file handle")
729 return defer.execute(_closed)
733 if noisy: self.log("_read in readChunk(%r, %r)" % (offset, length), level=NOISY)
734 d2 = self.consumer.read(offset, length)
735 d2.addCallbacks(eventually_callback(d), eventually_errback(d))
736 # It is correct to drop d2 here.
738 self.async.addCallbacks(_read, eventually_errback(d))
739 d.addBoth(_convert_error, request)
742 def writeChunk(self, offset, data):
743 self.log(".writeChunk(%r, <data of length %r>)" % (offset, len(data)), level=OPERATIONAL)
745 if not (self.flags & FXF_WRITE):
746 def _denied(): raise SFTPError(FX_PERMISSION_DENIED, "file handle was not opened for writing")
747 return defer.execute(_denied)
750 def _closed(): raise SFTPError(FX_BAD_MESSAGE, "cannot write to a closed file handle")
751 return defer.execute(_closed)
753 self.has_changed = True
755 # Note that we return without waiting for the write to occur. Reads and
756 # close wait for prior writes, and will fail if any prior operation failed.
757 # This is ok because SFTP makes no guarantee that the write completes
758 # before the request does. In fact it explicitly allows write errors to be
759 # delayed until close:
760 # "One should note that on some server platforms even a close can fail.
761 # This can happen e.g. if the server operating system caches writes,
762 # and an error occurs while flushing cached writes during the close."
765 if noisy: self.log("_write in .writeChunk(%r, <data of length %r>), current_size = %r" %
766 (offset, len(data), self.consumer.get_current_size()), level=NOISY)
767 # FXF_APPEND means that we should always write at the current end of file.
768 write_offset = offset
769 if self.flags & FXF_APPEND:
770 write_offset = self.consumer.get_current_size()
772 self.consumer.overwrite(write_offset, data)
773 if noisy: self.log("overwrite done", level=NOISY)
775 self.async.addCallback(_write)
776 # don't addErrback to self.async, just allow subsequent async ops to fail.
777 return defer.succeed(None)
781 self.log(request, level=OPERATIONAL)
784 return defer.succeed(None)
786 # This means that close has been called, not that the close has succeeded.
789 if not (self.flags & (FXF_WRITE | FXF_CREAT)):
790 def _readonly_close():
792 self.consumer.close()
793 return defer.execute(_readonly_close)
795 # We must capture the abandoned, parent, and childname variables synchronously
796 # at the close call. This is needed by the correctness arguments in the comments
797 # for _abandon_any_heisenfiles and _rename_heisenfiles.
798 # Note that the file must have been opened before it can be closed.
799 abandoned = self.abandoned
801 childname = self.childname
803 # has_changed is set when writeChunk is called, not when the write occurs, so
804 # it is correct to optimize out the commit if it is False at the close call.
805 has_changed = self.has_changed
808 if noisy: self.log("_committed(%r)" % (res,), level=NOISY)
810 self.consumer.close()
812 # We must close_notify before re-firing self.async.
813 if self.close_notify:
814 self.close_notify(self.userpath, self.parent, self.childname, self)
818 d2 = self.consumer.when_done()
819 if self.filenode and self.filenode.is_mutable():
820 self.log("update mutable file %r childname=%r metadata=%r" % (self.filenode, childname, self.metadata), level=OPERATIONAL)
821 if self.metadata.get('no-write', False) and not self.filenode.is_readonly():
822 assert parent and childname, (parent, childname, self.metadata)
823 d2.addCallback(lambda ign: parent.set_metadata_for(childname, self.metadata))
825 d2.addCallback(lambda ign: self.consumer.get_current_size())
826 d2.addCallback(lambda size: self.consumer.read(0, size))
827 d2.addCallback(lambda new_contents: self.filenode.overwrite(new_contents))
830 self.log("_add_file childname=%r" % (childname,), level=OPERATIONAL)
831 u = FileHandle(self.consumer.get_file(), self.convergence)
832 return parent.add_file(childname, u, metadata=self.metadata)
833 d2.addCallback(_add_file)
835 d2.addBoth(_committed)
840 # If the file has been abandoned, we don't want the close operation to get "stuck",
841 # even if self.async fails to re-fire. Doing the close independently of self.async
842 # in that case ensures that dropping an ssh connection is sufficient to abandon
843 # any heisenfiles that were not explicitly closed in that connection.
844 if abandoned or not has_changed:
845 d.addCallback(_committed)
847 self.async.addCallback(_close)
849 self.async.addCallbacks(eventually_callback(d), eventually_errback(d))
850 d.addBoth(_convert_error, request)
854 request = ".getAttrs()"
855 self.log(request, level=OPERATIONAL)
858 def _closed(): raise SFTPError(FX_BAD_MESSAGE, "cannot get attributes for a closed file handle")
859 return defer.execute(_closed)
861 # Optimization for read-only handles, when we already know the metadata.
862 if not (self.flags & (FXF_WRITE | FXF_CREAT)) and self.metadata and self.filenode and not self.filenode.is_mutable():
863 return defer.succeed(_populate_attrs(self.filenode, self.metadata))
867 if noisy: self.log("_get(%r) in %r, filenode = %r, metadata = %r" % (ign, request, self.filenode, self.metadata), level=NOISY)
869 # self.filenode might be None, but that's ok.
870 attrs = _populate_attrs(self.filenode, self.metadata, size=self.consumer.get_current_size())
871 eventually(d.callback, attrs)
873 self.async.addCallbacks(_get, eventually_errback(d))
874 d.addBoth(_convert_error, request)
877 def setAttrs(self, attrs, only_if_at=None):
878 request = ".setAttrs(%r, only_if_at=%r)" % (attrs, only_if_at)
879 self.log(request, level=OPERATIONAL)
881 if not (self.flags & FXF_WRITE):
882 def _denied(): raise SFTPError(FX_PERMISSION_DENIED, "file handle was not opened for writing")
883 return defer.execute(_denied)
886 def _closed(): raise SFTPError(FX_BAD_MESSAGE, "cannot set attributes for a closed file handle")
887 return defer.execute(_closed)
889 size = attrs.get("size", None)
890 if size is not None and (not isinstance(size, (int, long)) or size < 0):
891 def _bad(): raise SFTPError(FX_BAD_MESSAGE, "new size is not a valid nonnegative integer")
892 return defer.execute(_bad)
896 if noisy: self.log("_set(%r) in %r" % (ign, request), level=NOISY)
897 current_direntry = _direntry_for(self.parent, self.childname, self.filenode)
898 if only_if_at and only_if_at != current_direntry:
899 if noisy: self.log("not setting attributes: current_direntry=%r in %r" %
900 (current_direntry, request), level=NOISY)
904 self.metadata = update_metadata(self.metadata, _attrs_to_metadata(attrs), now)
906 # TODO: should we refuse to truncate a file opened with FXF_APPEND?
907 # <http://allmydata.org/trac/tahoe-lafs/ticket/1037#comment:20>
908 self.consumer.set_current_size(size)
909 eventually(d.callback, None)
911 self.async.addCallbacks(_set, eventually_errback(d))
912 d.addBoth(_convert_error, request)
917 def __init__(self, items):
927 def __init__(self, value):
931 # A "heisenfile" is a file that has been opened with write flags
932 # (FXF_WRITE and/or FXF_CREAT) and not yet close-notified.
933 # 'all_heisenfiles' maps from a direntry string to a list of
936 # A direntry string is parent_write_uri + "/" + childname_utf8 for
937 # an immutable file, or file_write_uri for a mutable file.
938 # Updates to this dict are single-threaded.
943 global all_heisenfiles
946 class SFTPUserHandler(ConchUser, PrefixingLogMixin):
947 implements(ISFTPServer)
948 def __init__(self, client, rootnode, username):
949 ConchUser.__init__(self)
950 PrefixingLogMixin.__init__(self, facility="tahoe.sftp", prefix=username)
951 if noisy: self.log(".__init__(%r, %r, %r)" % (client, rootnode, username), level=NOISY)
953 self.channelLookup["session"] = session.SSHSession
954 self.subsystemLookup["sftp"] = FileTransferServer
956 self._client = client
957 self._root = rootnode
958 self._username = username
959 self._convergence = client.convergence
961 # maps from UTF-8 paths for this user, to files written and still open
962 self._heisenfiles = {}
964 def gotVersion(self, otherVersion, extData):
965 self.log(".gotVersion(%r, %r)" % (otherVersion, extData), level=OPERATIONAL)
967 # advertise the same extensions as the OpenSSH SFTP server
968 # <http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/ssh/PROTOCOL?rev=1.15>
969 return {'posix-rename@openssh.com': '1',
970 'statvfs@openssh.com': '2',
971 'fstatvfs@openssh.com': '2',
975 self.log(".logout()", level=OPERATIONAL)
977 for files in self._heisenfiles.itervalues():
981 def _add_heisenfile_by_path(self, file):
982 self.log("._add_heisenfile_by_path(%r)" % (file,), level=OPERATIONAL)
984 userpath = file.get_userpath()
985 if userpath in self._heisenfiles:
986 self._heisenfiles[userpath] += [file]
988 self._heisenfiles[userpath] = [file]
990 def _add_heisenfile_by_direntry(self, file):
991 self.log("._add_heisenfile_by_direntry(%r)" % (file,), level=OPERATIONAL)
993 direntry = file.get_direntry()
995 if direntry in all_heisenfiles:
996 all_heisenfiles[direntry] += [file]
998 all_heisenfiles[direntry] = [file]
1000 def _abandon_any_heisenfiles(self, userpath, direntry):
1001 request = "._abandon_any_heisenfiles(%r, %r)" % (userpath, direntry)
1002 self.log(request, level=OPERATIONAL)
1004 assert isinstance(userpath, str), userpath
1006 # First we synchronously mark all heisenfiles matching the userpath or direntry
1007 # as abandoned, and remove them from the two heisenfile dicts. Then we .sync()
1008 # each file that we abandoned.
1010 # For each file, the call to .abandon() occurs:
1011 # * before the file is closed, in which case it will never be committed
1012 # (uploaded+linked or published); or
1013 # * after it is closed but before it has been close_notified, in which case the
1014 # .sync() ensures that it has been committed (successfully or not) before we
1017 # This avoids a race that might otherwise cause the file to be committed after
1018 # the remove operation has completed.
1020 # We return a Deferred that fires with True if any files were abandoned (this
1021 # does not mean that they were not committed; it is used to determine whether
1022 # a NoSuchChildError from the attempt to delete the file should be suppressed).
1025 if direntry in all_heisenfiles:
1026 files = all_heisenfiles[direntry]
1027 del all_heisenfiles[direntry]
1028 if userpath in self._heisenfiles:
1029 files += self._heisenfiles[userpath]
1030 del self._heisenfiles[userpath]
1032 if noisy: self.log("files = %r in %r" % (files, request), level=NOISY)
1037 d = defer.succeed(None)
1042 self.log("done %r" % (request,), level=OPERATIONAL)
1043 return len(files) > 0
1047 def _rename_heisenfiles(self, from_userpath, from_parent, from_childname,
1048 to_userpath, to_parent, to_childname, overwrite=True):
1049 request = ("._rename_heisenfiles(%r, %r, %r, %r, %r, %r, overwrite=%r)" %
1050 (from_userpath, from_parent, from_childname, to_userpath, to_parent, to_childname, overwrite))
1051 self.log(request, level=OPERATIONAL)
1053 assert (isinstance(from_userpath, str) and isinstance(from_childname, unicode) and
1054 isinstance(to_userpath, str) and isinstance(to_childname, unicode)), \
1055 (from_userpath, from_childname, to_userpath, to_childname)
1057 if noisy: self.log("all_heisenfiles = %r\nself._heisenfiles = %r" % (all_heisenfiles, self._heisenfiles), level=NOISY)
1059 # First we synchronously rename all heisenfiles matching the userpath or direntry.
1060 # Then we .sync() each file that we renamed.
1062 # For each file, the call to .rename occurs:
1063 # * before the file is closed, in which case it will be committed at the
1065 # * after it is closed but before it has been close_notified, in which case the
1066 # .sync() ensures that it has been committed (successfully or not) before we
1069 # This avoids a race that might otherwise cause the file to be committed at the
1070 # old name after the rename operation has completed.
1072 # Note that if overwrite is False, the caller should already have checked
1073 # whether a real direntry exists at the destination. It is possible that another
1074 # direntry (heisen or real) comes to exist at the destination after that check,
1075 # but in that case it is correct for the rename to succeed (and for the commit
1076 # of the heisenfile at the destination to possibly clobber the other entry, since
1077 # that can happen anyway when we have concurrent write handles to the same direntry).
1079 # We return a Deferred that fires with True if any files were renamed (this
1080 # does not mean that they were not committed; it is used to determine whether
1081 # a NoSuchChildError from the rename attempt should be suppressed). If overwrite
1082 # is False and there were already heisenfiles at the destination userpath or
1083 # direntry, we return a Deferred that fails with SFTPError(FX_PERMISSION_DENIED).
1085 from_direntry = _direntry_for(from_parent, from_childname)
1086 to_direntry = _direntry_for(to_parent, to_childname)
1088 if noisy: self.log("from_direntry = %r, to_direntry = %r, len(all_heisenfiles) = %r, len(self._heisenfiles) = %r in %r" %
1089 (from_direntry, to_direntry, len(all_heisenfiles), len(self._heisenfiles), request), level=NOISY)
1091 if not overwrite and (to_userpath in self._heisenfiles or to_direntry in all_heisenfiles):
1092 def _existing(): raise SFTPError(FX_PERMISSION_DENIED, "cannot rename to existing path " + to_userpath)
1093 if noisy: self.log("existing", level=NOISY)
1094 return defer.execute(_existing)
1097 if from_direntry in all_heisenfiles:
1098 from_files = all_heisenfiles[from_direntry]
1099 del all_heisenfiles[from_direntry]
1100 if from_userpath in self._heisenfiles:
1101 from_files += self._heisenfiles[from_userpath]
1102 del self._heisenfiles[from_userpath]
1104 if noisy: self.log("from_files = %r in %r" % (from_files, request), level=NOISY)
1106 for f in from_files:
1107 f.rename(to_userpath, to_parent, to_childname)
1108 self._add_heisenfile_by_path(f)
1109 self._add_heisenfile_by_direntry(f)
1111 d = defer.succeed(None)
1112 for f in from_files:
1116 if noisy: self.log("done: len(all_heisenfiles) = %r, len(self._heisenfiles) = %r in %r" %
1117 (len(all_heisenfiles), len(self._heisenfiles), request), level=NOISY)
1118 return len(from_files) > 0
1122 def _update_attrs_for_heisenfiles(self, userpath, direntry, attrs):
1123 request = "._update_attrs_for_heisenfiles(%r, %r, %r)" % (userpath, direntry, attrs)
1124 self.log(request, level=OPERATIONAL)
1126 assert isinstance(userpath, str) and isinstance(direntry, str), (userpath, direntry)
1129 if direntry in all_heisenfiles:
1130 files = all_heisenfiles[direntry]
1131 if userpath in self._heisenfiles:
1132 files += self._heisenfiles[userpath]
1134 if noisy: self.log("files = %r in %r" % (files, request), level=NOISY)
1136 # We set the metadata for all heisenfiles at this path or direntry.
1137 # Since a direntry includes a write URI, we must have authority to
1138 # change the metadata of heisenfiles found in the all_heisenfiles dict.
1139 # However that's not necessarily the case for heisenfiles found by
1140 # path. Therefore we tell the setAttrs method of each file to only
1141 # perform the update if the file is at the correct direntry.
1143 d = defer.succeed(None)
1145 d.addBoth(f.setAttrs, attrs, only_if_at=direntry)
1148 self.log("done %r" % (request,), level=OPERATIONAL)
1149 # TODO: this should not return True if only_if_at caused all files to be skipped.
1150 return len(files) > 0
1154 def _sync_heisenfiles(self, userpath, direntry, ignore=None):
1155 request = "._sync_heisenfiles(%r, %r, ignore=%r)" % (userpath, direntry, ignore)
1156 self.log(request, level=OPERATIONAL)
1158 assert isinstance(userpath, str) and isinstance(direntry, (str, NoneType)), (userpath, direntry)
1161 if direntry in all_heisenfiles:
1162 files = all_heisenfiles[direntry]
1163 if userpath in self._heisenfiles:
1164 files += self._heisenfiles[userpath]
1166 if noisy: self.log("files = %r in %r" % (files, request), level=NOISY)
1168 d = defer.succeed(None)
1174 self.log("done %r" % (request,), level=OPERATIONAL)
1179 def _remove_heisenfile(self, userpath, parent, childname, file_to_remove):
1180 if noisy: self.log("._remove_heisenfile(%r, %r, %r, %r)" % (userpath, parent, childname, file_to_remove), level=NOISY)
1182 assert isinstance(userpath, str) and isinstance(childname, (unicode, NoneType)), (userpath, childname)
1184 direntry = _direntry_for(parent, childname)
1185 if direntry in all_heisenfiles:
1186 all_old_files = all_heisenfiles[direntry]
1187 all_new_files = [f for f in all_old_files if f is not file_to_remove]
1188 if len(all_new_files) > 0:
1189 all_heisenfiles[direntry] = all_new_files
1191 del all_heisenfiles[direntry]
1193 if userpath in self._heisenfiles:
1194 old_files = self._heisenfiles[userpath]
1195 new_files = [f for f in old_files if f is not file_to_remove]
1196 if len(new_files) > 0:
1197 self._heisenfiles[userpath] = new_files
1199 del self._heisenfiles[userpath]
1201 if noisy: self.log("all_heisenfiles = %r\nself._heisenfiles = %r" % (all_heisenfiles, self._heisenfiles), level=NOISY)
1203 def _make_file(self, existing_file, userpath, flags, parent=None, childname=None, filenode=None, metadata=None):
1204 if noisy: self.log("._make_file(%r, %r, %r = %r, parent=%r, childname=%r, filenode=%r, metadata=%r)" %
1205 (existing_file, userpath, flags, _repr_flags(flags), parent, childname, filenode, metadata),
1208 assert (isinstance(userpath, str) and isinstance(childname, (unicode, NoneType)) and
1209 (metadata is None or 'no-write' in metadata)), (userpath, childname, metadata)
1211 writing = (flags & (FXF_WRITE | FXF_CREAT)) != 0
1212 direntry = _direntry_for(parent, childname, filenode)
1214 d = self._sync_heisenfiles(userpath, direntry, ignore=existing_file)
1216 if not writing and (flags & FXF_READ) and filenode and not filenode.is_mutable() and filenode.get_size() <= SIZE_THRESHOLD:
1217 d.addCallback(lambda ign: ShortReadOnlySFTPFile(userpath, filenode, metadata))
1221 close_notify = self._remove_heisenfile
1223 d.addCallback(lambda ign: existing_file or GeneralSFTPFile(userpath, flags, close_notify, self._convergence))
1224 def _got_file(file):
1225 file.open(parent=parent, childname=childname, filenode=filenode, metadata=metadata)
1227 self._add_heisenfile_by_direntry(file)
1229 d.addCallback(_got_file)
1232 def openFile(self, pathstring, flags, attrs, delay=None):
1233 request = ".openFile(%r, %r = %r, %r, delay=%r)" % (pathstring, flags, _repr_flags(flags), attrs, delay)
1234 self.log(request, level=OPERATIONAL)
1236 # This is used for both reading and writing.
1237 # First exclude invalid combinations of flags, and empty paths.
1239 if not (flags & (FXF_READ | FXF_WRITE)):
1240 def _bad_readwrite():
1241 raise SFTPError(FX_BAD_MESSAGE, "invalid file open flags: at least one of FXF_READ and FXF_WRITE must be set")
1242 return defer.execute(_bad_readwrite)
1244 if (flags & FXF_EXCL) and not (flags & FXF_CREAT):
1245 def _bad_exclcreat():
1246 raise SFTPError(FX_BAD_MESSAGE, "invalid file open flags: FXF_EXCL cannot be set without FXF_CREAT")
1247 return defer.execute(_bad_exclcreat)
1249 path = self._path_from_string(pathstring)
1251 def _emptypath(): raise SFTPError(FX_NO_SUCH_FILE, "path cannot be empty")
1252 return defer.execute(_emptypath)
1254 # The combination of flags is potentially valid.
1256 # To work around clients that have race condition bugs, a getAttr, rename, or
1257 # remove request following an 'open' request with FXF_WRITE or FXF_CREAT flags,
1258 # should succeed even if the 'open' request has not yet completed. So we now
1259 # synchronously add a file object into the self._heisenfiles dict, indexed
1260 # by its UTF-8 userpath. (We can't yet add it to the all_heisenfiles dict,
1261 # because we don't yet have a user-independent path for the file.) The file
1262 # object does not know its filenode, parent, or childname at this point.
1264 userpath = self._path_to_utf8(path)
1266 if flags & (FXF_WRITE | FXF_CREAT):
1267 file = GeneralSFTPFile(userpath, flags, self._remove_heisenfile, self._convergence)
1268 self._add_heisenfile_by_path(file)
1270 # We haven't decided which file implementation to use yet.
1273 desired_metadata = _attrs_to_metadata(attrs)
1275 # Now there are two major cases:
1277 # 1. The path is specified as /uri/FILECAP, with no parent directory.
1278 # If the FILECAP is mutable and writeable, then we can open it in write-only
1279 # or read/write mode (non-exclusively), otherwise we can only open it in
1280 # read-only mode. The open should succeed immediately as long as FILECAP is
1281 # a valid known filecap that grants the required permission.
1283 # 2. The path is specified relative to a parent. We find the parent dirnode and
1284 # get the child's URI and metadata if it exists. There are four subcases:
1285 # a. the child does not exist: FXF_CREAT must be set, and we must be able
1286 # to write to the parent directory.
1287 # b. the child exists but is not a valid known filecap: fail
1288 # c. the child is mutable: if we are trying to open it write-only or
1289 # read/write, then we must be able to write to the file.
1290 # d. the child is immutable: if we are trying to open it write-only or
1291 # read/write, then we must be able to write to the parent directory.
1293 # To reduce latency, open normally succeeds as soon as these conditions are
1294 # met, even though there might be a failure in downloading the existing file
1295 # or uploading a new one. However, there is an exception: if a file has been
1296 # written, then closed, and is now being reopened, then we have to delay the
1297 # open until the previous upload/publish has completed. This is necessary
1298 # because sshfs does not wait for the result of an FXF_CLOSE message before
1299 # reporting to the client that a file has been closed. It applies both to
1300 # mutable files, and to directory entries linked to an immutable file.
1302 # Note that the permission checks below are for more precise error reporting on
1303 # the open call; later operations would fail even if we did not make these checks.
1305 d = delay or defer.succeed(None)
1306 d.addCallback(lambda ign: self._get_root(path))
1307 def _got_root( (root, path) ):
1308 if root.is_unknown():
1309 raise SFTPError(FX_PERMISSION_DENIED,
1310 "cannot open an unknown cap (or child of an unknown object). "
1311 "Upgrading the gateway to a later Tahoe-LAFS version may help")
1314 if noisy: self.log("case 1: root = %r, path[:-1] = %r" % (root, path[:-1]), level=NOISY)
1315 if not IFileNode.providedBy(root):
1316 raise SFTPError(FX_PERMISSION_DENIED,
1317 "cannot open a directory cap")
1318 if (flags & FXF_WRITE) and root.is_readonly():
1319 raise SFTPError(FX_PERMISSION_DENIED,
1320 "cannot write to a non-writeable filecap without a parent directory")
1321 if flags & FXF_EXCL:
1322 raise SFTPError(FX_FAILURE,
1323 "cannot create a file exclusively when it already exists")
1325 # The file does not need to be added to all_heisenfiles, because it is not
1326 # associated with a directory entry that needs to be updated.
1328 metadata = update_metadata(None, desired_metadata, time())
1330 # We have to decide what to pass for the 'parent_readonly' argument to _no_write,
1331 # given that we don't actually have a parent. This only affects the permissions
1332 # reported by a getAttrs on this file handle in the case of an immutable file.
1333 # We choose 'parent_readonly=True' since that will cause the permissions to be
1334 # reported as r--r--r--, which is appropriate because an immutable file can't be
1335 # written via this path.
1337 metadata['no-write'] = _no_write(True, root)
1338 return self._make_file(file, userpath, flags, filenode=root, metadata=metadata)
1341 childname = path[-1]
1343 if noisy: self.log("case 2: root = %r, childname = %r, desired_metadata = %r, path[:-1] = %r" %
1344 (root, childname, desired_metadata, path[:-1]), level=NOISY)
1345 d2 = root.get_child_at_path(path[:-1])
1346 def _got_parent(parent):
1347 if noisy: self.log("_got_parent(%r)" % (parent,), level=NOISY)
1348 if parent.is_unknown():
1349 raise SFTPError(FX_PERMISSION_DENIED,
1350 "cannot open a child of an unknown object. "
1351 "Upgrading the gateway to a later Tahoe-LAFS version may help")
1353 parent_readonly = parent.is_readonly()
1354 d3 = defer.succeed(None)
1355 if flags & FXF_EXCL:
1356 # FXF_EXCL means that the link to the file (not the file itself) must
1357 # be created atomically wrt updates by this storage client.
1358 # That is, we need to create the link before returning success to the
1359 # SFTP open request (and not just on close, as would normally be the
1360 # case). We make the link initially point to a zero-length LIT file,
1361 # which is consistent with what might happen on a POSIX filesystem.
1364 raise SFTPError(FX_FAILURE,
1365 "cannot create a file exclusively when the parent directory is read-only")
1367 # 'overwrite=False' ensures failure if the link already exists.
1368 # FIXME: should use a single call to set_uri and return (child, metadata) (#1035)
1370 zero_length_lit = "URI:LIT:"
1371 if noisy: self.log("%r.set_uri(%r, None, readcap=%r, overwrite=False)" %
1372 (parent, zero_length_lit, childname), level=NOISY)
1373 d3.addCallback(lambda ign: parent.set_uri(childname, None, readcap=zero_length_lit,
1374 metadata=desired_metadata, overwrite=False))
1375 def _seturi_done(child):
1376 if noisy: self.log("%r.get_metadata_for(%r)" % (parent, childname), level=NOISY)
1377 d4 = parent.get_metadata_for(childname)
1378 d4.addCallback(lambda metadata: (child, metadata))
1380 d3.addCallback(_seturi_done)
1382 if noisy: self.log("%r.get_child_and_metadata(%r)" % (parent, childname), level=NOISY)
1383 d3.addCallback(lambda ign: parent.get_child_and_metadata(childname))
1385 def _got_child( (filenode, current_metadata) ):
1386 if noisy: self.log("_got_child( (%r, %r) )" % (filenode, current_metadata), level=NOISY)
1388 metadata = update_metadata(current_metadata, desired_metadata, time())
1390 # Ignore the permissions of the desired_metadata in an open call. The permissions
1391 # can only be set by setAttrs.
1392 metadata['no-write'] = _no_write(parent_readonly, filenode, current_metadata)
1394 if filenode.is_unknown():
1395 raise SFTPError(FX_PERMISSION_DENIED,
1396 "cannot open an unknown cap. Upgrading the gateway "
1397 "to a later Tahoe-LAFS version may help")
1398 if not IFileNode.providedBy(filenode):
1399 raise SFTPError(FX_PERMISSION_DENIED,
1400 "cannot open a directory as if it were a file")
1401 if (flags & FXF_WRITE) and metadata['no-write']:
1402 raise SFTPError(FX_PERMISSION_DENIED,
1403 "cannot open a non-writeable file for writing")
1405 return self._make_file(file, userpath, flags, parent=parent, childname=childname,
1406 filenode=filenode, metadata=metadata)
1408 if noisy: self.log("_no_child(%r)" % (f,), level=NOISY)
1409 f.trap(NoSuchChildError)
1411 if not (flags & FXF_CREAT):
1412 raise SFTPError(FX_NO_SUCH_FILE,
1413 "the file does not exist, and was not opened with the creation (CREAT) flag")
1415 raise SFTPError(FX_PERMISSION_DENIED,
1416 "cannot create a file when the parent directory is read-only")
1418 return self._make_file(file, userpath, flags, parent=parent, childname=childname)
1419 d3.addCallbacks(_got_child, _no_child)
1422 d2.addCallback(_got_parent)
1425 d.addCallback(_got_root)
1426 def _remove_on_error(err):
1428 self._remove_heisenfile(userpath, None, None, file)
1430 d.addErrback(_remove_on_error)
1431 d.addBoth(_convert_error, request)
1434 def renameFile(self, from_pathstring, to_pathstring, overwrite=False):
1435 request = ".renameFile(%r, %r)" % (from_pathstring, to_pathstring)
1436 self.log(request, level=OPERATIONAL)
1438 from_path = self._path_from_string(from_pathstring)
1439 to_path = self._path_from_string(to_pathstring)
1440 from_userpath = self._path_to_utf8(from_path)
1441 to_userpath = self._path_to_utf8(to_path)
1443 # the target directory must already exist
1444 d = deferredutil.gatherResults([self._get_parent_or_node(from_path),
1445 self._get_parent_or_node(to_path)])
1446 def _got( (from_pair, to_pair) ):
1447 if noisy: self.log("_got( (%r, %r) ) in .renameFile(%r, %r, overwrite=%r)" %
1448 (from_pair, to_pair, from_pathstring, to_pathstring, overwrite), level=NOISY)
1449 (from_parent, from_childname) = from_pair
1450 (to_parent, to_childname) = to_pair
1452 if from_childname is None:
1453 raise SFTPError(FX_NO_SUCH_FILE, "cannot rename a source object specified by URI")
1454 if to_childname is None:
1455 raise SFTPError(FX_NO_SUCH_FILE, "cannot rename to a destination specified by URI")
1457 # <http://tools.ietf.org/html/draft-ietf-secsh-filexfer-02#section-6.5>
1458 # "It is an error if there already exists a file with the name specified
1460 # OpenSSH's SFTP server returns FX_PERMISSION_DENIED for this error.
1462 # For the standard SSH_FXP_RENAME operation, overwrite=False.
1463 # We also support the posix-rename@openssh.com extension, which uses overwrite=True.
1465 d2 = defer.succeed(None)
1467 d2.addCallback(lambda ign: to_parent.get(to_childname))
1468 def _expect_fail(res):
1469 if not isinstance(res, Failure):
1470 raise SFTPError(FX_PERMISSION_DENIED, "cannot rename to existing path " + to_userpath)
1472 # It is OK if we fail for errors other than NoSuchChildError, since that probably
1473 # indicates some problem accessing the destination directory.
1474 res.trap(NoSuchChildError)
1475 d2.addBoth(_expect_fail)
1477 # If there are heisenfiles to be written at the 'from' direntry, then ensure
1478 # they will now be written at the 'to' direntry instead.
1479 d2.addCallback(lambda ign:
1480 self._rename_heisenfiles(from_userpath, from_parent, from_childname,
1481 to_userpath, to_parent, to_childname, overwrite=overwrite))
1484 # FIXME: use move_child_to_path to avoid possible data loss due to #943
1485 #d3 = from_parent.move_child_to_path(from_childname, to_root, to_path, overwrite=overwrite)
1487 d3 = from_parent.move_child_to(from_childname, to_parent, to_childname, overwrite=overwrite)
1489 if noisy: self.log("_check(%r) in .renameFile(%r, %r, overwrite=%r)" %
1490 (err, from_pathstring, to_pathstring, overwrite), level=NOISY)
1492 if not isinstance(err, Failure) or (renamed and err.check(NoSuchChildError)):
1494 if not overwrite and err.check(ExistingChildError):
1495 raise SFTPError(FX_PERMISSION_DENIED, "cannot rename to existing path " + to_userpath)
1500 d2.addCallback(_move)
1503 d.addBoth(_convert_error, request)
1506 def makeDirectory(self, pathstring, attrs):
1507 request = ".makeDirectory(%r, %r)" % (pathstring, attrs)
1508 self.log(request, level=OPERATIONAL)
1510 path = self._path_from_string(pathstring)
1511 metadata = _attrs_to_metadata(attrs)
1512 if 'no-write' in metadata:
1513 def _denied(): raise SFTPError(FX_PERMISSION_DENIED, "cannot create a directory that is initially read-only")
1514 return defer.execute(_denied)
1516 d = self._get_root(path)
1517 d.addCallback(lambda (root, path):
1518 self._get_or_create_directories(root, path, metadata))
1519 d.addBoth(_convert_error, request)
1522 def _get_or_create_directories(self, node, path, metadata):
1523 if not IDirectoryNode.providedBy(node):
1524 # TODO: provide the name of the blocking file in the error message.
1525 def _blocked(): raise SFTPError(FX_FAILURE, "cannot create directory because there "
1526 "is a file in the way") # close enough
1527 return defer.execute(_blocked)
1530 return defer.succeed(node)
1531 d = node.get(path[0])
1532 def _maybe_create(f):
1533 f.trap(NoSuchChildError)
1534 return node.create_subdirectory(path[0])
1535 d.addErrback(_maybe_create)
1536 d.addCallback(self._get_or_create_directories, path[1:], metadata)
1539 def removeFile(self, pathstring):
1540 request = ".removeFile(%r)" % (pathstring,)
1541 self.log(request, level=OPERATIONAL)
1543 path = self._path_from_string(pathstring)
1544 d = self._remove_object(path, must_be_file=True)
1545 d.addBoth(_convert_error, request)
1548 def removeDirectory(self, pathstring):
1549 request = ".removeDirectory(%r)" % (pathstring,)
1550 self.log(request, level=OPERATIONAL)
1552 path = self._path_from_string(pathstring)
1553 d = self._remove_object(path, must_be_directory=True)
1554 d.addBoth(_convert_error, request)
1557 def _remove_object(self, path, must_be_directory=False, must_be_file=False):
1558 userpath = self._path_to_utf8(path)
1559 d = self._get_parent_or_node(path)
1560 def _got_parent( (parent, childname) ):
1561 if childname is None:
1562 raise SFTPError(FX_NO_SUCH_FILE, "cannot remove an object specified by URI")
1564 direntry = _direntry_for(parent, childname)
1565 d2 = defer.succeed(False)
1566 if not must_be_directory:
1567 d2.addCallback(lambda ign: self._abandon_any_heisenfiles(userpath, direntry))
1569 d2.addCallback(lambda abandoned:
1570 parent.delete(childname, must_exist=not abandoned,
1571 must_be_directory=must_be_directory, must_be_file=must_be_file))
1573 d.addCallback(_got_parent)
1576 def openDirectory(self, pathstring):
1577 request = ".openDirectory(%r)" % (pathstring,)
1578 self.log(request, level=OPERATIONAL)
1580 path = self._path_from_string(pathstring)
1581 d = self._get_parent_or_node(path)
1582 def _got_parent_or_node( (parent_or_node, childname) ):
1583 if noisy: self.log("_got_parent_or_node( (%r, %r) ) in openDirectory(%r)" %
1584 (parent_or_node, childname, pathstring), level=NOISY)
1585 if childname is None:
1586 return parent_or_node
1588 return parent_or_node.get(childname)
1589 d.addCallback(_got_parent_or_node)
1591 if dirnode.is_unknown():
1592 raise SFTPError(FX_PERMISSION_DENIED,
1593 "cannot list an unknown cap as a directory. Upgrading the gateway "
1594 "to a later Tahoe-LAFS version may help")
1595 if not IDirectoryNode.providedBy(dirnode):
1596 raise SFTPError(FX_PERMISSION_DENIED,
1597 "cannot list a file as if it were a directory")
1600 def _render(children):
1601 parent_readonly = dirnode.is_readonly()
1603 for filename, (child, metadata) in children.iteritems():
1604 # The file size may be cached or absent.
1605 metadata['no-write'] = _no_write(parent_readonly, child, metadata)
1606 attrs = _populate_attrs(child, metadata)
1607 filename_utf8 = filename.encode('utf-8')
1608 longname = _lsLine(filename_utf8, attrs)
1609 results.append( (filename_utf8, longname, attrs) )
1610 return StoppableList(results)
1611 d2.addCallback(_render)
1613 d.addCallback(_list)
1614 d.addBoth(_convert_error, request)
1617 def getAttrs(self, pathstring, followLinks):
1618 request = ".getAttrs(%r, followLinks=%r)" % (pathstring, followLinks)
1619 self.log(request, level=OPERATIONAL)
1621 # When asked about a specific file, report its current size.
1622 # TODO: the modification time for a mutable file should be
1623 # reported as the update time of the best version. But that
1624 # information isn't currently stored in mutable shares, I think.
1626 path = self._path_from_string(pathstring)
1627 userpath = self._path_to_utf8(path)
1628 d = self._get_parent_or_node(path)
1629 def _got_parent_or_node( (parent_or_node, childname) ):
1630 if noisy: self.log("_got_parent_or_node( (%r, %r) )" % (parent_or_node, childname), level=NOISY)
1632 # Some clients will incorrectly try to get the attributes
1633 # of a file immediately after opening it, before it has been put
1634 # into the all_heisenfiles table. This is a race condition bug in
1635 # the client, but we handle it anyway by calling .sync() on all
1636 # files matching either the path or the direntry.
1638 direntry = _direntry_for(parent_or_node, childname)
1639 d2 = self._sync_heisenfiles(userpath, direntry)
1641 if childname is None:
1642 node = parent_or_node
1643 d2.addCallback(lambda ign: node.get_current_size())
1644 d2.addCallback(lambda size:
1645 _populate_attrs(node, {'no-write': node.is_unknown() or node.is_readonly()}, size=size))
1647 parent = parent_or_node
1648 d2.addCallback(lambda ign: parent.get_child_and_metadata_at_path([childname]))
1649 def _got( (child, metadata) ):
1650 if noisy: self.log("_got( (%r, %r) )" % (child, metadata), level=NOISY)
1651 assert IDirectoryNode.providedBy(parent), parent
1652 metadata['no-write'] = _no_write(parent.is_readonly(), child, metadata)
1653 d3 = child.get_current_size()
1654 d3.addCallback(lambda size: _populate_attrs(child, metadata, size=size))
1657 if noisy: self.log("_nosuch(%r)" % (err,), level=NOISY)
1658 err.trap(NoSuchChildError)
1659 if noisy: self.log("checking open files:\nself._heisenfiles = %r\nall_heisenfiles = %r\ndirentry=%r" %
1660 (self._heisenfiles, all_heisenfiles, direntry), level=NOISY)
1661 if direntry in all_heisenfiles:
1662 files = all_heisenfiles[direntry]
1663 if len(files) == 0: # pragma: no cover
1665 # use the heisenfile that was most recently opened
1666 return files[-1].getAttrs()
1668 d2.addCallbacks(_got, _nosuch)
1670 d.addCallback(_got_parent_or_node)
1671 d.addBoth(_convert_error, request)
1674 def setAttrs(self, pathstring, attrs):
1675 request = ".setAttrs(%r, %r)" % (pathstring, attrs)
1676 self.log(request, level=OPERATIONAL)
1679 # this would require us to download and re-upload the truncated/extended
1681 def _unsupported(): raise SFTPError(FX_OP_UNSUPPORTED, "setAttrs wth size attribute unsupported")
1682 return defer.execute(_unsupported)
1684 path = self._path_from_string(pathstring)
1685 userpath = self._path_to_utf8(path)
1686 d = self._get_parent_or_node(path)
1687 def _got_parent_or_node( (parent_or_node, childname) ):
1688 if noisy: self.log("_got_parent_or_node( (%r, %r) )" % (parent_or_node, childname), level=NOISY)
1690 direntry = _direntry_for(parent_or_node, childname)
1691 d2 = self._update_attrs_for_heisenfiles(userpath, direntry, attrs)
1693 def _update(updated_heisenfiles):
1694 if childname is None:
1695 if updated_heisenfiles:
1697 raise SFTPError(FX_NO_SUCH_FILE, userpath)
1699 desired_metadata = _attrs_to_metadata(attrs)
1700 if noisy: self.log("desired_metadata = %r" % (desired_metadata,), level=NOISY)
1702 d3 = parent_or_node.set_metadata_for(childname, desired_metadata)
1704 if updated_heisenfiles:
1705 err.trap(NoSuchChildError)
1708 d3.addErrback(_nosuch)
1710 d2.addCallback(_update)
1711 d2.addCallback(lambda ign: None)
1713 d.addCallback(_got_parent_or_node)
1714 d.addBoth(_convert_error, request)
1717 def readLink(self, pathstring):
1718 self.log(".readLink(%r)" % (pathstring,), level=OPERATIONAL)
1720 def _unsupported(): raise SFTPError(FX_OP_UNSUPPORTED, "readLink")
1721 return defer.execute(_unsupported)
1723 def makeLink(self, linkPathstring, targetPathstring):
1724 self.log(".makeLink(%r, %r)" % (linkPathstring, targetPathstring), level=OPERATIONAL)
1726 # If this is implemented, note the reversal of arguments described in point 7 of
1727 # <http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/ssh/PROTOCOL?rev=1.15>.
1729 def _unsupported(): raise SFTPError(FX_OP_UNSUPPORTED, "makeLink")
1730 return defer.execute(_unsupported)
1732 def extendedRequest(self, extensionName, extensionData):
1733 self.log(".extendedRequest(%r, <data of length %r>)" % (extensionName, len(extensionData)), level=OPERATIONAL)
1735 # We implement the three main OpenSSH SFTP extensions; see
1736 # <http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/ssh/PROTOCOL?rev=1.15>
1738 if extensionName == 'posix-rename@openssh.com':
1739 def _bad(): raise SFTPError(FX_BAD_MESSAGE, "could not parse posix-rename@openssh.com request")
1741 if 4 > len(extensionData): return defer.execute(_bad)
1742 (fromPathLen,) = struct.unpack('>L', extensionData[0:4])
1743 if 8 + fromPathLen > len(extensionData): return defer.execute(_bad)
1745 (toPathLen,) = struct.unpack('>L', extensionData[(4 + fromPathLen):(8 + fromPathLen)])
1746 if 8 + fromPathLen + toPathLen != len(extensionData): return defer.execute(_bad)
1748 fromPathstring = extensionData[4:(4 + fromPathLen)]
1749 toPathstring = extensionData[(8 + fromPathLen):]
1750 d = self.renameFile(fromPathstring, toPathstring, overwrite=True)
1752 # Twisted conch assumes that the response from an extended request is either
1753 # an error, or an FXP_EXTENDED_REPLY. But it happens to do the right thing
1754 # (respond with an FXP_STATUS message) if we return a Failure with code FX_OK.
1755 def _succeeded(ign):
1756 raise SFTPError(FX_OK, "request succeeded")
1757 d.addCallback(_succeeded)
1760 if extensionName == 'statvfs@openssh.com' or extensionName == 'fstatvfs@openssh.com':
1761 # f_bsize and f_frsize should be the same to avoid a bug in 'df'
1762 return defer.succeed(struct.pack('>11Q',
1763 1024, # uint64 f_bsize /* file system block size */
1764 1024, # uint64 f_frsize /* fundamental fs block size */
1765 628318530, # uint64 f_blocks /* number of blocks (unit f_frsize) */
1766 314159265, # uint64 f_bfree /* free blocks in file system */
1767 314159265, # uint64 f_bavail /* free blocks for non-root */
1768 200000000, # uint64 f_files /* total file inodes */
1769 100000000, # uint64 f_ffree /* free file inodes */
1770 100000000, # uint64 f_favail /* free file inodes for non-root */
1771 0x1AF5, # uint64 f_fsid /* file system id */
1772 2, # uint64 f_flag /* bit mask = ST_NOSUID; not ST_RDONLY */
1773 65535, # uint64 f_namemax /* maximum filename length */
1776 def _unsupported(): raise SFTPError(FX_OP_UNSUPPORTED, "unsupported %r request <data of length %r>" %
1777 (extensionName, len(extensionData)))
1778 return defer.execute(_unsupported)
1780 def realPath(self, pathstring):
1781 self.log(".realPath(%r)" % (pathstring,), level=OPERATIONAL)
1783 return self._path_to_utf8(self._path_from_string(pathstring))
1785 def _path_to_utf8(self, path):
1786 return (u"/" + u"/".join(path)).encode('utf-8')
1788 def _path_from_string(self, pathstring):
1789 if noisy: self.log("CONVERT %r" % (pathstring,), level=NOISY)
1791 assert isinstance(pathstring, str), pathstring
1793 # The home directory is the root directory.
1794 pathstring = pathstring.strip("/")
1795 if pathstring == "" or pathstring == ".":
1798 path_utf8 = pathstring.split("/")
1800 # <http://tools.ietf.org/html/draft-ietf-secsh-filexfer-02#section-6.2>
1801 # "Servers SHOULD interpret a path name component ".." as referring to
1802 # the parent directory, and "." as referring to the current directory."
1804 for p_utf8 in path_utf8:
1806 # ignore excess .. components at the root
1811 p = p_utf8.decode('utf-8', 'strict')
1812 except UnicodeError:
1813 raise SFTPError(FX_NO_SUCH_FILE, "path could not be decoded as UTF-8")
1816 if noisy: self.log(" PATH %r" % (path,), level=NOISY)
1819 def _get_root(self, path):
1820 # return Deferred (root, remaining_path)
1821 d = defer.succeed(None)
1822 if path and path[0] == u"uri":
1823 d.addCallback(lambda ign: self._client.create_node_from_uri(path[1].encode('utf-8')))
1824 d.addCallback(lambda root: (root, path[2:]))
1826 d.addCallback(lambda ign: (self._root, path))
1829 def _get_parent_or_node(self, path):
1830 # return Deferred (parent, childname) or (node, None)
1831 d = self._get_root(path)
1832 def _got_root( (root, remaining_path) ):
1833 if not remaining_path:
1836 d2 = root.get_child_at_path(remaining_path[:-1])
1837 d2.addCallback(lambda parent: (parent, remaining_path[-1]))
1839 d.addCallback(_got_root)
1843 class FakeTransport:
1844 implements(ITransport)
1845 def write(self, data):
1846 logmsg("FakeTransport.write(<data of length %r>)" % (len(data),), level=NOISY)
1848 def writeSequence(self, data):
1849 logmsg("FakeTransport.writeSequence(...)", level=NOISY)
1851 def loseConnection(self):
1852 logmsg("FakeTransport.loseConnection()", level=NOISY)
1854 # getPeer and getHost can just raise errors, since we don't know what to return
1857 class ShellSession(PrefixingLogMixin):
1858 implements(ISession)
1859 def __init__(self, userHandler):
1860 PrefixingLogMixin.__init__(self, facility="tahoe.sftp")
1861 if noisy: self.log(".__init__(%r)" % (userHandler), level=NOISY)
1863 def getPty(self, terminal, windowSize, attrs):
1864 self.log(".getPty(%r, %r, %r)" % (terminal, windowSize, attrs), level=OPERATIONAL)
1866 def openShell(self, protocol):
1867 self.log(".openShell(%r)" % (protocol,), level=OPERATIONAL)
1868 if hasattr(protocol, 'transport') and protocol.transport is None:
1869 protocol.transport = FakeTransport() # work around Twisted bug
1871 d = defer.succeed(None)
1872 d.addCallback(lambda ign: protocol.write("This server supports only SFTP, not shell sessions.\n"))
1873 d.addCallback(lambda ign: protocol.processEnded(Reason(ProcessTerminated(exitCode=1))))
1876 def execCommand(self, protocol, cmd):
1877 self.log(".execCommand(%r, %r)" % (protocol, cmd), level=OPERATIONAL)
1878 if hasattr(protocol, 'transport') and protocol.transport is None:
1879 protocol.transport = FakeTransport() # work around Twisted bug
1881 d = defer.succeed(None)
1882 if cmd == "df -P -k /":
1883 d.addCallback(lambda ign: protocol.write(
1884 "Filesystem 1024-blocks Used Available Capacity Mounted on\n"
1885 "tahoe 628318530 314159265 314159265 50% /\n"))
1886 d.addCallback(lambda ign: protocol.processEnded(Reason(ProcessDone(None))))
1888 d.addCallback(lambda ign: protocol.processEnded(Reason(ProcessTerminated(exitCode=1))))
1891 def windowChanged(self, newWindowSize):
1892 self.log(".windowChanged(%r)" % (newWindowSize,), level=OPERATIONAL)
1894 def eofReceived(self):
1895 self.log(".eofReceived()", level=OPERATIONAL)
1898 self.log(".closed()", level=OPERATIONAL)
1901 # If you have an SFTPUserHandler and want something that provides ISession, you get
1902 # ShellSession(userHandler).
1903 # We use adaptation because this must be a different object to the SFTPUserHandler.
1904 components.registerAdapter(ShellSession, SFTPUserHandler, ISession)
1907 from allmydata.frontends.auth import AccountURLChecker, AccountFileChecker, NeedRootcapLookupScheme
1910 implements(portal.IRealm)
1911 def __init__(self, client):
1912 self._client = client
1914 def requestAvatar(self, avatarID, mind, interface):
1915 assert interface == IConchUser, interface
1916 rootnode = self._client.create_node_from_uri(avatarID.rootcap)
1917 handler = SFTPUserHandler(self._client, rootnode, avatarID.username)
1918 return (interface, handler, handler.logout)
1921 class SFTPServer(service.MultiService):
1922 def __init__(self, client, accountfile, accounturl,
1923 sftp_portstr, pubkey_file, privkey_file):
1924 service.MultiService.__init__(self)
1926 r = Dispatcher(client)
1927 p = portal.Portal(r)
1930 c = AccountFileChecker(self, accountfile)
1931 p.registerChecker(c)
1933 c = AccountURLChecker(self, accounturl)
1934 p.registerChecker(c)
1935 if not accountfile and not accounturl:
1936 # we could leave this anonymous, with just the /uri/CAP form
1937 raise NeedRootcapLookupScheme("must provide an account file or URL")
1939 pubkey = keys.Key.fromFile(pubkey_file)
1940 privkey = keys.Key.fromFile(privkey_file)
1941 class SSHFactory(factory.SSHFactory):
1942 publicKeys = {pubkey.sshType(): pubkey}
1943 privateKeys = {privkey.sshType(): privkey}
1944 def getPrimes(self):
1946 # if present, this enables diffie-hellman-group-exchange
1947 return primes.parseModuliFile("/etc/ssh/moduli")
1954 s = strports.service(sftp_portstr, f)
1955 s.setServiceParent(self)