/docs

iden3 documentation

GNU Affero General Public License v3.0AGPL-3.0


Chat on Twitter Chat on Telegram Website

Identity protocol

Prove your access rights, not your identity

iden3 is a next-generation private access control based on self-sovereign identity, designed for decentralised and trust-minimised environments.

Privacy for all

Everyone has the right to liberty and equality, the right freely to participate in their community, and the right to privacy.

The aim of the iden3 protocol is to empower people and create a more inclusive and egalitarian foundation for better human relationships through open-source cryptography and decentralised technologies.


Privacy by design Decentralised Open source

Iden3 protocol libraries

  • Crypto library (go-iden3-crypto)
    Implementation of Poseidon hash and Baby JubJub Eliptic curve

  • Merkle tree sql library (go-merkletree-sql)
    Implementation of Sparse Merkle tree

  • Core library (go-iden3-core)
    Identity core primitives

  • Circuits (circuits)
    Identity circuits

  • Go-circuits (go-circuits)
    Library for transformation go-core primitives to json inputs for identity circuits

  • Prover server (prover-server)
    Wrapper on snarkjs for ZK proof generation

  • Authorization library (go-iden3-auth)
    Library for authentication with zkp verification (edited)


How to run this documentation (locally)

Install mkdocs

pip3 install mkdocs

In case you have a rendering problem with the pieces of code, please execute:

pip install --upgrade mkdocs

Install mkdocs-material theme

pip install mkdocs-material

Install mkdocs-markdown-graphviz (1.3)

pip3 install mkdocs-markdown-graphviz==1.3

Run the webserver

At the mkdocs directory execute:

mkdocs serve