                                 Foolscap

Foolscap is an RPC/RMI (Remote Procedure Call / Remote Method Invocation)
protocol for use with Twisted, derived/inspired by Twisted's built-in
"Perspective Broker" package.

If you have control of both ends of the wire, and are thus not constrained to
use some other protocol like HTTP/XMLRPC/CORBA/etc, you might consider using
Foolscap.

Fundamentally, Foolscap allows you to make a python object in one process
available to code in other processes, which means you can invoke its methods
remotely. This includes a data serialization layer to convey the object
graphs for the arguments and the eventual response, and an object reference
system to keep track of which objects you are connecting to. It uses a
capability-based security model, such that once you create a non-public
object, it is only accessible to clients to whom you've given the
(unguessable) FURL. You can of course publish world-visible objects that
have well-known FURLs.

Full documentation and examples are in the doc/ directory.

DEPENDENCIES:

 * Python 2.7
 * Twisted 10.1.0 or later
 * PyOpenSSL (tested against 0.6)


INSTALLATION:

 To install foolscap into your system's normal python library directory, just
 run the following (you will probably have to do this as root):

  pip install .

 You can also just add the foolscap source tree to your PYTHONPATH, since
 there are no compile steps or .so/.dll files involved.


COMPATIBILITY:

 Foolscap's wire protocol is unlikely to change in the near future.

 Foolscap has a built-in version-negotiation mechanism that allows the two
 processes to determine how to best communicate with each other. The two ends
 will agree upon the highest mutually-supported version for all their
 traffic. If they do not have any versions in common, the connection will
 fail with a NegotiationError.

 Please check the NEWS file for announcements of compatibility-breaking
 changes in any given release.

 Foolscap-0.9.1 was compatible with (and tested against) Python-2.6 . Since
 that release, the most recent Twisted (15.5.0) has dropped py2.6 support
 (throwing an error at import time), so Foolscap no longer tests against
 py2.6. It may continue to be compatible for a while, but without testing,
 incompatible changes may eventually creep in.


HEARTBLEED:

 Foolscap currently depends upon SSL for its transport security
 (confidentiality and authentication), using the PyOpenSSL bindings to the
 OpenSSL library for this purpose. Certain recent versions of OpenSSL were
 vulnerable to the devastating "Heartbleed" attack, which allowed a casual
 attacker to obtain memory fragments of the target process, revealing secret
 data (even occasionally the SSL private key).

 Do not use Foolscap with a version of OpenSSL that contains the Heartbleed
 vulnerability (or any other vulnerability, for that matter). This was fixed
 in OpenSSL 1.0.1g . More information about known OpenSSL vulnerabilities can
 be found here: http://www.openssl.org/news/vulnerabilities.html .


HISTORY:

 Foolscap is a rewrite of the Perspective Broker protocol provided by Twisted
 (in the twisted.pb package), with the goal of improving serialization
 flexibility and connection security. It also adds features to assist
 application development, such as distributed/incident-triggered logging,
 Service management, persistent object naming, and debugging tools.

 For a brief while, it was intended to replace Perspective Broker, so it had
 a name of "newpb" or "pb2". However we no longer expect Foolscap to ever be
 added to the Twisted source tree.

 A "foolscap" is a size of paper, probably measuring 17 by 13.5 inches. A
 twisted foolscap of paper makes a good fool's cap. Also, "cap" implies
 capabilities, and Foolscap is a protocol to implement a distributed
 object-capabilities model in python.

AUTHOR:

 Brian Warner is responsible for this thing. Please discuss it on the
 twisted-python mailing list.

 The Foolscap home page is a Trac instance at
 <http://foolscap.lothar.com/trac>. It contains pointers to the latest
 release, bug reports, patches, documentation, and other resources.

 Foolscap is distributed under the same license as Twisted itself, namely the
 MIT license. Details are in the LICENSE file.

