PANORAMIX repo
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
demo
docs
panoramix-agent
panoramix-server
panoramix
test/mixing
.gitignore
COPYING
EXAMPLE
README
version.txt

README

Panoramix mixnet server and client
==================================

Overview
--------

This repository includes three python packages:

  * panoramix: The main package that implements the mixnet logic
  * panoramix-server: A server implementing the panoramix API
  * panoramix-agent: A local agent


Installation
------------

In each of the three packages, run:

  python setup.py install

The panoramix package includes three cryptographic backends: 'gpg', 'zeus',
and 'sphinxmix'. In order to use them, you must install the respective
dependencies with:

  pip install -r requirements_<backend>.txt


Usage
-----

The panoramix-server package provides a wizard (panoramix-server-wizard) to
facilitate the setup of the server.

The panoramix package provides a wizard (panoramix-wizard) to allow the
mixnet contributors to set up a mixnet (currently works with the sphinxmix
backend only).

The panoramix-agent package provides a local agent to enable an end user to
use a mixnet. As an example, sphinxmix-agent is a wizard to configure and
launch an agent for sphinxmix. The end user can send messages to the mixnet
by posting it to the local agent, using the panoramix-client.


Demo
----

Check file EXAMPLE for an extended description on how to setup and use a
sphinxmix mixnet. For a demonstration of Panoramix workflow, see
demo/README.


Copyright and license
---------------------

Copyright (C) 2016-2017 GRNET S.A.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program 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 Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.