Commit 0d6d907b authored by Loïck Bonniot's avatar Loïck Bonniot

Update READMEs

parent cb8589b6
Pipeline #2297 passed with stages
DFSS DFSS
==== ====
> Distributed Fair Signature System
> Distributed Fair Signing System
DFSS is a simple and secure way to e-sign contracts with a large number of participants, ensuring fairness and minimizing the involvement of the trusted third party (TTP). DFSS is a simple and secure way to e-sign contracts with a large number of participants, ensuring fairness and minimizing the involvement of the trusted third party (TTP).
This repository contains source code for this INSA Rennes project. This repository contains source code for this INSA Rennes project.
......
DFSS DFSS
==== ====
> Distributed Fair Signing System > Distributed Fair Signature System
Prerequisites Prerequisites
------------- -------------
...@@ -25,7 +25,8 @@ You just have to untar the archive and run the following binaries: ...@@ -25,7 +25,8 @@ You just have to untar the archive and run the following binaries:
./dfsst help # TTP ./dfsst help # TTP
``` ```
On Linux-64 and Windows builds, two additional graphic binaries are included. You may need some Qt4 libraries on your system to run them. On Linux-64 and Windows builds, two additional graphic binaries are included.
You may need some Qt4 libraries on your system to run them (Ubuntu and Fedora standard releases have these dependencies).
```bash ```bash
./dfssc_gui # Graphic client ./dfssc_gui # Graphic client
...@@ -43,11 +44,12 @@ For instance, if we are running the plaform on the `example.com` host: ...@@ -43,11 +44,12 @@ For instance, if we are running the plaform on the `example.com` host:
./dfssp --cn example.com --country FR --validity 3650 init ./dfssp --cn example.com --country FR --validity 3650 init
``` ```
Then, it is possible to create TTP credentials from generated root credentials. Then, it's possible to create TTP credentials from generated root credentials.
The generated files are stored in a subdirectory "ttp". The generated files are stored in a subdirectory "ttp".
Please note that the platform needs to generate a ttp listing, called "ttps". This file contains the ttp public address specified in the following command.
```bash ```bash
./dfssp --cn ttp.example.com --country FR --validity 365 ttp ./dfssp --cn ttp.example.com --country FR --validity 365 --addr ttp.example.com:9020 ttp
``` ```
You can then start the platform. Here we are considering a mongoDB database running on the same host. You can then start the platform. Here we are considering a mongoDB database running on the same host.
...@@ -64,10 +66,10 @@ export DFSS_MAIL_PASSWORD="password" ...@@ -64,10 +66,10 @@ export DFSS_MAIL_PASSWORD="password"
Then: Then:
```bash ```bash
./dfssp start ./dfssp -t ttps start
``` ```
You can also start the TTP: You must also start the TTP:
```bash ```bash
./dfsst --cert ttp/cert.pem --key ttp/cert.pem start ./dfsst --cert ttp/cert.pem --key ttp/cert.pem start
...@@ -94,3 +96,10 @@ It's then possible to send new contracts to the platform: ...@@ -94,3 +96,10 @@ It's then possible to send new contracts to the platform:
```bash ```bash
./dfssc --ca path/to/dfssp_rootCA.pem --host example.com new ./dfssc --ca path/to/dfssp_rootCA.pem --host example.com new
``` ```
Other commands like `sign`, `fetch` and `recover` are available in the documentation that can be accessed using the `-h` flag.
For example:
```bash
./dfssc sign -h
```
Markdown is supported
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