Commit a14bb4d8 authored by Sietse Ringers's avatar Sietse Ringers
Browse files

Update README.md and AUTHORS

parent b810308c
......@@ -2,3 +2,4 @@ Maarten Everts (maarten.everts@tno.nl)
Wouter Lueks (lueks@cs.ru.nl)
Patrick Uiterwijk (puiterwijk@gmail.com)
Pim Vullers (pim@cs.ru.nl)
Sietse Ringers (s.ringers@privacybydesign.foundation)
# IRMA Configuration files
# The `irma-demo` scheme manager
This repository contains all the configuration files for the irma project. It describes the issuers and declares which credentials are issued by these issuers.
This repository contains the credential definitions, issuer information, and their public *and* private keys of the `irma-demo` scheme manager.
## Picking the right branch
***CAREFUL!*** This scheme manager is only ever meant to be used for development, demoing and experimenting! Because the issuer private keys are included in this repository everyone can issue any credential from this scheme manager, choosing the attributes freely. Thus their authenticity cannot be trusted. (For an actual scheme manager, see the [Privacy by Design Foundation scheme manager](https://github.com/credentials/pbdf-schememanager).)
The latest versions of the [Android app](https://github.com/credentials/irma_android_cardemu) and the [API server](https://github.com/credentials/irma_api_server) use the `combined` branch, which can contain keys for multiple scheme managers. Currently it only contains the demo keys from the `demo` branch. The master, demo and pilot branches are used by older projects and are structured differently.
Use this repository by putting it in the `irma_configuration` folder of your project (for example, [the IRMA mobile app](https://github.com/credentials/irma_mobile/tree/rctevents/ios/irma_configuration) or the [IRMA API server](https://github.com/credentials/irma_api_server/tree/master/src/main/resources)). Be sure to call the folder `irma-demo`! E.g.,
git clone https://github.com/credentials/irma-demo-schememanager irma-demo
## Directory structure
Stores configuration files per issuer/relying party. Typical directory structure:
A scheme manager, issuer, or credential type (call it an *entity*) is always stored in `description.xml`, contained in a folder whose name *must* be that of the entity as specified by the xml file. Multiple issuers are grouped under the scheme manager, and each issuer may issue multiple credential types.
SchemeManager
+-- IssuerName
| +-- Issues
| | +-- CredentialName
| | +--- description.xml
| +-- Issues
| | +-- CredentialName
| | +--- description.xml
| | +--- logo.png
| +-- PublicKeys
| | +-- 0.xml
| | +-- 1.xml
| +-- PrivateKeys (need not be present)
| | +-- 0.xml
| +-- PrivateKeys (need not be present)
| | +-- 0.xml
| | +-- 1.xml
| +-- description.xml
| +-- logo.png
| +-- description.xml
| +-- logo.png
+-- description.xml
## Some notes on adding a new organization
......@@ -36,3 +40,7 @@ $ silvia_keygen -a 6 -n 4096 -c 0 -p ipk.xml -P isk.xml
```
You will need to place these keys at the correct place in the directory tree. Alternatively, the `generate_keys.sh` script can generate keys (with counter 0) for you at the correct place.
# Note
This repository contains the same tree as (the now deprecated) [github.com/credentials/irma_configuration](https://github.com/credentials/irma_configuration) but with the outer `irma_configuration` folder removed.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment