ConfidentialLCA/README.md

74 lines
1.6 KiB
Markdown

# Confidentiality Enhanced Life-Cycle Assessment
ConfidentialLCA is a prototype demonstrating the use of Secure
Multi-Party Computation (SMPC) for Life-Cycle Assessment (LCA) of
supply chain.
## Prerequisites
ConfidentialLCA requires [Pyton](https://www.python.org/) 3 and
[Podman](https://podman.io/).
## Installation
First, you need to install a few Python libraries. For this, please
execute:
```shell
pip3 install --user -r requirements.txt
```
Second, you need to build a podman container. For this, please
execute:
``` shell
podman build -t scale-mamba-latest .devcontainer
```
## Usage
### Preparing the PKI Infrastructure
To generate the required X.509 certificates for executing the example
case study scenarios, please execute
```shell
./generate-all-certificates.sh <number_of_companies>
```
Where ``<number_of_companies>`` is the maximum number of companies of
all scenarios.
### Running LCA
For various different scenarios, the LCA can be run using the provided
script for running our default benchmarks:
```shell
generate_and_run_test_scenario.py <scenario>
```
Where ``<scenario>`` is an integer between 0 and 2 that allows for
selecting the structure of the supply chain.
## Authors
* [Achim D. Brucker](http://www.brucker.ch/)
* [Sakine Yalman](http://emps.exeter.ac.uk/computer-science/staff/sy359)
## License
This project is licensed under an Apache 2.0 license.
SPDX-License-Identifier: Apache-2.0
## Main Repository
The main git repository for this project is hosted by the [Software
Assurance & Security Research Team](https://logicalhacking.com) at
<https://git.logicalhacking.com/PrivacyPreservingLCA/ConfidentialLCA>.