From f54a8e556714279a6933477570e87bd9b361bbcb Mon Sep 17 00:00:00 2001
From: chronal <benni.haschka@gmail.com>
Date: Sun, 7 Jul 2024 23:03:15 +0200
Subject: [PATCH] Assignment 7 sgximpl: refactor README for project needs

---
 7-SGX_Hands-on/README.md | 34 +++++++++++++++++++++++++---------
 1 file changed, 25 insertions(+), 9 deletions(-)

diff --git a/7-SGX_Hands-on/README.md b/7-SGX_Hands-on/README.md
index 5265352..cb6cb64 100644
--- a/7-SGX_Hands-on/README.md
+++ b/7-SGX_Hands-on/README.md
@@ -6,6 +6,16 @@ For more informationm, read the [project description](doc/abgabe.pdf).
 
 We recommend viewing the [repository](https://git.pfzetto.de/RubNoobs/Systemsicherheit/src/branch/Assignment-7-sgximpl/7-SGX_Hands-on) we worked on together at.
 
+## Requirements
+
+You will need the latest version of OpenSSL.
+Execute the following command to automatically meet all requirements. 
+
+```bash
+$ ./src/setup
+```
+
+
 ## Compiling
 
 This project can be compiled for simulation environments or directly on the hardware.
@@ -26,20 +36,26 @@ At project root type the command
 $ make
 ```
 
-This creates the following directory tree:
+That creates all the necessary objects and binaries to execute. 
+The executable binary will be `src/signatureproxy`.
 
-```
-out
-├── bin <- here is the executable binary file
-└── obj <- here are the object files generated by the compiling process
-``` 
+## Running
+
+## Running story
+
+To execute an example usage of the project, execute `./src/simulate`. 
+Note, that this will only work, if you sucessfully compiled the project.
+
+## Manual Usage
+
+### Setup
+
+Go to the `src` directory.
 
-# Usage
-## Setup
 Initialize the Enclave keypair by executing:
 `./signatureproxy proxysetup -pkey <sealed_proxy_key.bin> > <proxy_public_key.pem>` 
 
-## Sign
+### Sign
 1. Create employee signature using `./signatureproxy employee -firm <firmware.bin> -ekey <employee_privat_key.pem> > <employee_signature.der>`
    This step can also be done using OpenSSL: `openssl dgst -sha256 -sign <employee_private_key.pem> -out <employee_signature.der> -in <firmware.bin>`
 2. Use the signature proxy to resign the firmware using `./signatureproxy proxy -pkey <sealed_proxy_key.bin> -epub <employee_public_key.der> -firm <firmware.bin> > <proxy_signature.der>`