Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
ethanysng committed Sep 6, 2024
1 parent 2f5ffe0 commit 3ac6b04
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# LHS: Leveraging (not) HIR via Symbolic execution
### A command line utility for searching for analyzing a given Rust code's MIR and verifying `std::fs::write` calls' safeness, in particular, writes to `/proc/self/mem`
### A command line utility for analyzing a given Rust code's MIR and verifying `std::fs::write` calls' safeness, in particular, writes to `/proc/self/mem`

## Installation

Expand Down Expand Up @@ -91,6 +91,14 @@ WARNING: potential write to `/proc/self/mem`
Please see the `inputoutput.md` file for input and output examples and expectations.
All code snippets used can also be found in the `examples/` directory.
## FAQ
1. What is with the funny name `LHS`?
This came about during project selection when our principle investigator proposed two project directions, one listed on the left hand side of the board, and one on the right.
LHS, short for Left Hand Side, became the *de facto* name of the project.
At the time of release, one of our team members came up with a more applicable name that would also shorten to LHS, now known as "Leveraging (not) HIR via Symbolic execution",
ensuring that LHS continues to live on gloriously as part of the repository.
## Credits
This project was a result of Prof. Dr. Caleb Stanford's Davis PL research group.
The following members have made contributions to this project (names in alphabetical order):
Expand Down

0 comments on commit 3ac6b04

Please sign in to comment.