More readme

This commit is contained in:
sk4nz 2022-02-02 15:20:17 +01:00
parent bd07863edf
commit f652a21e43
2 changed files with 17 additions and 15 deletions

View File

@ -16,14 +16,13 @@
.PHONY: clean build upload .PHONY: clean build upload
.SILENT: .SILENT:
ifeq ($(shell uname),OpenBSD) ifeq ($(shell uname),OpenBSD)
GCC:= egcc GCC:= egcc
else else
GCC:= gcc GCC:= gcc
endif endif
EXECUTABLES= clang $(GCC) uuid lld taskset EXECUTABLES= clang $(GCC) uuid lld
XXXX:= $(foreach exec,$(EXECUTABLES), $(if $(shell which $(exec) 2> /dev/null),X,$(error "No '$(exec)' in PATH, please install it and restart octopus !"))) XXXX:= $(foreach exec,$(EXECUTABLES), $(if $(shell which $(exec) 2> /dev/null),X,$(error "No '$(exec)' in PATH, please install it and restart octopus !")))
### Generic flags ### Generic flags

View File

@ -5,19 +5,19 @@ Samuel AUBERTIN - EURECOM - 2022
![SPECTRE Octopus Logo](logo.png "SPECTRE Octopus Logo") ![SPECTRE Octopus Logo](logo.png "SPECTRE Octopus Logo")
**OCTOPUS** is a [Spectre](https://spectreattack.com/spectre.pdf) V1 (_Bounds Check Bypass_) + V2 (_Branch Target Injection_) compiler flag tester. **OCTOPUS** is a [Spectre](https://spectreattack.com/spectre.pdf) V1 (_Bounds Check Bypass_) + V2 (_Branch Target Injection_) vulnerabilty tester.
It measures the success rate of the attacks using different compilers: It measures the success rate of the Spectre attacks using different compilers:
- GCC - [GCC](https://gcc.gnu.org/)
- CLANG - [Clang](https://clang.llvm.org/)
And compilation/linking flags such as: And compilation/linking flags such as:
- Optimisation levels (```-O```) - Optimisation levels (```-O```)
- Static/dynamic linking - Static/dynamic linking
- Masking and lfence as mitigation against Spectre V1 - [Masking](https://github.com/torvalds/linux/blob/cb6416592bc2a8b731dabcec0d63cda270764fc6/arch/x86/include/asm/barrier.h#L27) and [lfence](https://www.intel.com/content/www/us/en/developer/articles/troubleshooting/using-intel-compilers-to-mitigate-speculative-execution-side-channel-issues.html) mitigations against Spectre V1
- RETPOLINE as mitigation against Spectre V2 - [RETPOLINE](https://support.google.com/faqs/answer/7625886) mitigation against Spectre V2
## Results ## Results
@ -25,11 +25,10 @@ Results are stored as JSON objects in an unique file for each run, following thi
## Dependencies ## Dependencies
- ```clang``` and ```lld``` - Compiler: ```clang``` and ```gcc```
- ```gcc``` - Linker: ```lld```
- ```sftp``` - For upload: ```openssh``` and ```uuid```
- ```uuid``` - The C library static symbols: ```glibc-static```
- The libC static symbols: ```glibc-static```
## Execution ## Execution
@ -39,6 +38,10 @@ Will build, execute and upload the results.
### Build only ### Build only
```make build```
To build using multiple processes:
```make [-j XXX] build``` where ```XXX``` is the number of parallel processes. ```make [-j XXX] build``` where ```XXX``` is the number of parallel processes.
## Results aggregation ## Results aggregation