README

Sphinx v0.8 README
2011-03-06
Ian Goldberg <iang@cs.uwaterloo.ca>

Except for the public-domain curve25519 portions by Dan Bernstein, this
software is licenced as follows:

# Copyright 2011 Ian Goldberg
#
# This file is part of Sphinx.
# 
# Sphinx is free software: you can redistribute it and/or modify
# it under the terms of version 3 of the GNU Lesser General Public
# License as published by the Free Software Foundation.
# 
# Sphinx is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Lesser General Public License for more details.
# 
# You should have received a copy of the GNU Lesser General Public
# License along with Sphinx.  If not, see
# <http://www.gnu.org/licenses/>.

The LIONESS implementation and the xcounter CTR mode class are adapted
from "Experimental implementation of the sphinx cryptographic mix packet
format by George Danezis".

Enabling ECC (curve25519) support:

- You'll need swig, as well as a populated /usr/include/python-2.6
  directory.
- cd curve25519 && make && cd ..

Testing:

- ./SphinxClient.py  or  ./SphinxClient.py -ecc

The latter is smaller and faster, but requires curve25519 support to be
enabled.