README.md 2.58 KB
Newer Older
Aditya Damodaran's avatar
Aditya Damodaran committed
1
2
3
4
<!--
SPDX-FileCopyrightText: 2021 University of Luxembourg
SPDX-License-Identifier: GPL-3.0-or-later
SPDXVersion: SPDX-2.2
Aditya Damodaran's avatar
Aditya Damodaran committed
5

Aditya Damodaran's avatar
Aditya Damodaran committed
6
7
8
9
Authors: 
       Aditya Damodaran, aditya.damodaran@uni.lu
       Alfredo Rial, alfredo.rial@uni.lu
-->
Aditya Shyam Shankar Damodaran's avatar
Aditya Shyam Shankar Damodaran committed
10
11
# Unlinkable Updatable Hiding Databases and Privacy-Preserving Loyalty Programs

Aditya Damodaran's avatar
Typos    
Aditya Damodaran committed
12
This repository contains the source code for an implementation of the HD (Unlinkable Updatable Hiding Database) primitive described in our paper titled "Unlinkable Updatable Hiding Databases and Privacy-Preserving Loyalty Programs". It also includes an implementation of the Privacy-Preserving Loyalty Program protocol put forward in this paper, which uses the aforementioned primitive. 
13
14

These implementations were used to measure the storage and computation costs of the cryptographic operations in our primitive and the protocol, for the _Efficiency Analysis_ sections of our paper.
Aditya Shyam Shankar Damodaran's avatar
Aditya Shyam Shankar Damodaran committed
15
16
17
18
19


# Installation

## Virtual Machine (Vagrant)
20
21
22
23
24
25
You can the use `Vagrantfile` file in this repository to spin up a virtual machine with a pre-configured execution environment using Vagrant: https://www.vagrantup.com.

You must first install Vagrant, and then run the following command from the root directory of this repository:
```bash
$ vagrant up
```
Aditya Shyam Shankar Damodaran's avatar
Aditya Shyam Shankar Damodaran committed
26

27
The code will then be accessible from the `/vagrant` directory, in the virtual machine window that shows up after the script downloads and installs all prerequisites.
Aditya Shyam Shankar Damodaran's avatar
Aditya Shyam Shankar Damodaran committed
28
29
30


## Manual Installation
31
Our code requires Python 3.7, and the Charm-Crypto library (v0.50) built with the Relic toolkit (v0.5.0) , as described on these pages:
Aditya Shyam Shankar Damodaran's avatar
Aditya Shyam Shankar Damodaran committed
32

33
34
35
36
37
38
39
40
41
1. Relic toolkit : https://jhuisi.github.io/charm/relic.html#charm-with-relic
2. Charm-Crypto https://jhuisi.github.io/charm/install_source.html#platform-install-manual

> Note: Charm-Crypto additionally requires PBC (v0.5.14) and GMP (v6.2.1). 

Finally, use the following command to install Openpyxl and Texttable: 
```bash
$ python3 -m pip install -r requirements.txt
```
Aditya Shyam Shankar Damodaran's avatar
Aditya Shyam Shankar Damodaran committed
42
43
44
45


# Usage
```bash
46
47
48
49
50
51
52
53
54
Usage: python3 ./protocol.py [-h] [-k K] [-r] N

positional arguments:
  N                    Database size (100-65000)

optional arguments:
  -h, --help           show this help message and exit
  -k K, --keylength K  Paillier Encryption key size (Supported values: 1024, 2048)
  -r, --randomise      Randomise database state 
Aditya Shyam Shankar Damodaran's avatar
Aditya Shyam Shankar Damodaran committed
55
```
56
57
58
59
60
61
62
63

 - Run tests against a database of size N = 100, random database values, and a Paillier key length of 2048 bits:
   ```bash
   $ python3 ./protocol.py -k 2048 -r 100
   ```

# Acknowledgements

Aditya Damodaran's avatar
Typos    
Aditya Damodaran committed
64
This research was supported by the Luxembourg National Research Fund (FNR) CORE
65
project “Stateful Zero-Knowledge” (Project code: C17/11650748).