Browse Source

Initial Readme

Miti Mazmudar 4 years ago
parent
commit
31d3a1eb04
1 changed files with 16 additions and 0 deletions
  1. 16 0
      README.md

+ 16 - 0
README.md

@@ -0,0 +1,16 @@
+# MITIGATOR #
+
+This repository contains Docker files for reproducing the implementation of the server-side code for the following paper: 
+
+Miti Mazmudar, Ian Goldberg. "Mitigator: Privacy policy compliance using trusted hardware" 
+Proceedings on Privacy Enhancing Technologies. Vol. 2020, No. 3. 18 pages. July 2020.
+
+This system requires a machine with Intel Software Guard Extension (SGX) to function correctly. It consists of three enclaves: a decryptor, a verifier and a target enclave. The Linux SGX driver and Linux SGX SDK are required to run the decryptor enclave. The Linux SGX SDK is also required for the enclaves to attest to each other and to seal secrets to disk. We use the Graphene-SGX library to support running a proof-of-concept verifier and the target application. The target application is an Apache server with a PHP extension to interface with the decryptor enclave. The Graphene-SGX driver is also required to run any applications within Graphene. 
+
+We have four main scripts. Two of these scripts setup drivers and the others setup, launch a docker container for running the three enclaves. 
+* build-driver: builds specific versions of the Linux SGX and the Graphene-SGX drivers as kernel modules.
+* install-driver: installs the kernel modules generated by the build-driver script onto the machine. 
+* build-mitigator: builds three docker images, one for each of the Dockerfiles in the sgx/, graphene/ and docker/ folders respectively. The first docker image contains the SGX SDK and PSW setup. The second docker image adds the Graphene-SGX setup onto the first one. The last docker image is formed by downloading the source-code for our enclaves, including any dependencies, and generating the three enclaves. 
+* run-mitigator: runs the three enclaves, starting with the decryptor, followed by the verifier and then the Apache server, each in a different tmux session. 
+
+We do require a client to install our browser extension to test our server-side setup.