master
is unsafe, please refer to tags.
An api wrapping the belenios-tool command line.
- Yarn
- Refer to the INSTALL.md file.
- From the project root directory, run
yarn
to install dependencies. - Read the compilation instructions provided in INSTALL.md
- Run
yarn setup
. - Run
yarn start
.
Never commit directly on master, instead use branches and pull requests.
Once approved, a Pull request is merged in master
by its author. Also, it must be squashed before merging,
either manually or using GitHub's Squash and merge
feature.
You must use the following Style Guides :
This project contains a linting config, you should setup eslint
into your IDE with .eslintrc.js
.
Please refer to the Issues section if you encounter any problems during development.
Belenios is a verifiable voting system that partly implements the Helios-C protocol described here, which is itself derived from Helios.
It consists of a command-line tool and a web server. Both use the same backend and can be used to organize elections and perform verifications. They employ messages formatted in a common format, a specification of which is available in doc/specification.tex.
Compilation instructions are provided in INSTALL.md.
An election involves several roles: an administrator, a credential authority, trustees and voters. For maximum security, each of these roles must be performed by a different entity. An election can be summarized as follows:
- The administrator initiates the process.
- The credential authority generates one credential per voter; he sends the private part to each voter and all public parts to the administrator.
- Each trustee generates a keypair and sends his/her public key to the administrator.
- The administrator collects all public credentials and trustees' public keys and sets up the election.
- The administrator opens the election.
- Each voter votes; the administrator collects, checks and publishes all the ballots.
- The administrator closes the election.
- Trustees collectively decrypt the result.
- The administrator announces the result of the election.
Each step can be performed with the help of the command-line tool. The tool is also the most convenient way to exercise the verifiability capabilities of the system.
More information in doc/tool.md.
By "internal code", we mean everything that is not in the ext/
directory.
Copyright © 2012-2021 Inria, CNRS
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, with the additional exemption that compiling, linking, and/or using OpenSSL is allowed.
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.
Please refer to each file for accurate copyright and licensing information.