From 8ea1230bb87ec4e7c91a054173ee3af24e0fd33f Mon Sep 17 00:00:00 2001 From: Toby Murray <toby.murray@unimelb.edu.au> Date: Mon, 16 Sep 2019 15:40:55 +1000 Subject: [PATCH] update README to reflect the repo structure --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index db6100b..db8a2f4 100644 --- a/README.md +++ b/README.md @@ -5,22 +5,22 @@ information. Structure of this repository: -FIXME FIXME FIXME all out of date!! - -* src/: - where the code for the C implementation of the passbook lives -* src/pocs/: - where your PoCs live +* src/original/: - where the code for the original passbook lives +* src/vuln-1 -- src/vuln-5 - where your vulnerable versions will live +* poc/: - where your PoCs will live * fuzzer/: - where your fuzzer will live Pre-Included Scripts: -* src/Makefile - makefile for building the C implementation etc. -* src/get_coverage.sh - script to generate coverage reports +* Makefile - makefile for building the C implementation etc. +* get_coverage.sh - script to generate coverage reports +* run_fuzzer.sh - script for running your fuzzer to generate inputs Vulnerable Versions (you should put your security vulnerabilities in here): -* src/passbook-vuln1.c -- src/passbook-vuln5.c +* src/vuln-1/passbook.c -- src/vuln-5/passbook.c Proofs of Concept (PoCs that you should provide for each vulnerability): -* src/pocs/poc1.txt -- src/pocs/poc5.txt +* poc/vuln-1.poc -- poc/vuln-5.poc -- GitLab