Python implementation of the Jeeves programming language.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Jeeves 1.0

Jeeves is a programming language for automatically enforcing privacy policies. We have implemented it as an embedded domain-specific language in Python.

Jeeves helps programmers enforce information flow policies describing where values may flow through a program. An information flow policy can talk about not just whether Alice can see a sensitive value, but whether Alice can see a value computed from a sensitive value. For instance, a Jeeves policy may describe who can see a user's location in a social network. This policy is enforced not just when a viewer tries to access the location directly, but also when the viewer accesses values computed from the location, for instance the result of a search over all locations. Jeeves policies talk about whether a viewer may see a value. Policies are functions that take an argument corresponding to the output channel and produce a Boolean result.

Jeeves makes it easier for the programmer to enforce privacy policies by making the runtime responsible for producing the appropriate outputs. Jeeves has a policy-agnostic programming model: the programmer implements information flow policies separately from the other functionality. The runtime system becomes responsible for enforcing the policies. To allow for policy-agnostic programming, Jeeves asks the programmer to provide multiple views of sensitive values: a high-confidentiality value corresponding to the secret view and a low-confidentiality value corresponding to the public view. For instance, the high-confidentiality view of a user location could be the GPS location and the low-confidentiality view could be the corresponding country. The programmer provides policies about when the high-confidentiality view may be shown. The runtime then executes simultaneously on both views, yielding results that are appropriately guarded by policies. The Jeeves runtime guarantees that a value may only flow to a viewer if the policies allow.

This separation of policy and core functionality relieves programmer burden in keeping track of which policies need to be enforced where. The programmer can separately update policy and core functionality and rely on the runtime to handle the interaction of policies with each other and with the program.

Go ahead, try it out! Feel free to write to the Jeeves user group with questions.

Installing Jeeves.

Virtual Environment (Recommended)

If you have virtualenv installed, you can create an virtual environment for Jeeves without affecting your standard python installation. This is especially useful if your system python is Python 3.

# Clone Jeeves
git clone https://github.com/jeanqasaur/jeeves
cd jeeves
# Setup a virtual environment for Python 2, with files in ./env/
virtualenv -p python2 --no-site-packages env
# Activate the virtual environment
source env/bin/activate
# Install all dependencies
pip install -r requirements.txt

You are now ready to use Jeeves! Try running python runtests.py to ensure that Jeeves is working correctly.

Each time you start working with Jeeves, you will need to run the source env/bin/activate command to activate the virtual environment. When you are done, you can run deactivate from within the environment to return to your standard development environment.

Raw Build

First, you will need Python.

$ python --version
Python 2.7.6

Python libraries

For core Jeeves, we use MacroPy, Nose, Django, and Mock. You can install with pip as follows:

$ pip install macropy==1.0.3 nose==1.3.7 mock==2.0.0

For logging in our web demos, we also use Django timelog:

$ pip install django==1.6.5 django-jinja==1.0.2 django-timelog==0.4

For logging in our cms demo, we use the following version of Django timelog:

$ pip install django==1.10 django-jinja==2.3.1 django-timelog==0.4

Other

We also use the Z3 SMT Solver for helping resolve label values. Installing the Z3 binaries for your platform should install the Python Z3 package. You can test that it works by opening a Python interpreter:

>>> from z3 import *
>>> solve(x > 2, y < 10, x + 2*y == 7)
[y = 0, x = 7]
>>> print simplify(x + y + 2*x + 3)
3 + 3*x + y

You may need to build from source so that our code can use the Python Z3 library for interfacing with Z3.

On OSX, if you're familiar with Homebrew, this is easy:

$ brew tap homebrew/science
$ brew install z3

You can also build manually or use nightly build package for OSX(64bit).

Running Tests.

Once you have installed everything, you should run the tests to make sure everything is working together. To use nose, first make sure your PYTHONPATH environment variable is set to your current working directory. Then you can run the tests:

$ cd /to/jeeves
$ export PYTHONPATH=.
$ nosetests

You can also use nose to run specific tests. For instance:

nosetests test/gallery/authentication

Using Jeeves

There is documentation for the JeevesLib API here. There is more documentation on our Wiki. We have a Quick Introduction to Jeeves. (Happy to take suggestions on how to make it more useful!)

You may also find it helpful to read our tests in test and test/gallery.