summaryrefslogtreecommitdiff
path: root/README.rst
blob: 7a7b20e9b31fb24aff893e9b8d1bee3e787f4319 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
Bonafide
========
Bonafide is the protocol for secure user registration, authentication, and provider discovery for the LEAP
applications. See the `Bonafide`_ design docs.

This is a client implementation, written in python. It consists of a python library, a
twisted service and a command-line interface to interact locally with it.

.. _`Bonafide`: https://leap.se/en/docs/design/bonafide

Using
-----

This is still in development. To play with it, create a virtualenv, and deploy
the package in development mode by running::

  python setup.py develop

from the parent folder.

To run the bonafide service, you can use the bitmask.core daemon. From an
environment in which you have installed the bitmask_core repo::

  bitmaskd

Then you can use `bitmask_cli` to see the available actions, under the user
command.