Skip to content

Commit

Permalink
Simple recipe for standard run (#9)
Browse files Browse the repository at this point in the history
* Simple recipe for standard run
  • Loading branch information
Enkelmann authored and tbarabosch committed Feb 5, 2019
1 parent 5ce77d7 commit 002a375
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 3 deletions.
6 changes: 4 additions & 2 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@

- Refactoring: Unification of cwe_checker function interface
- Refactoring: Created utils module for JSON functionality
- Added check for CWE 248: Uncaught Exception
- Added automated test suite (run with make test)
- Added check for CWE 248: Uncaught Exception (PR #5)
- Added automated test suite (run with make test) (PR #7)
- Improved cross compiling for acceptance test cases by using dockcross (PR #8)
- Added BAP recipe for standard cwe_checker run (PR #9)

0.1 (2018-10-08)
=====
Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,11 @@ The usage is straight forward: adjust the `config.json` (if needed) and call BAP
``` bash
bap PATH_TO_BINARY --pass=cwe-checker --cwe-checker-config=src/config.json
```
*cwe_checker* outputs to stdin. This output is parsable (sexep). There is a script `cwe_checker_to_ida` to visualize the results in IDA Pro.
For common use cases you can find some recipes in the recipes folder. These can be run with
```
bap PATH_TO_BINARY --recipe=recipes/RECIPE_FOLDER_NAME
```
*cwe_checker* outputs to stdout. This output is parsable (sexep). There is a script `cwe_checker_to_ida` to visualize the results in IDA Pro.
## How to extend cwe_checker? ##
New plugins should be added to src/checkers. Implement a .ml and .mli file. See the existing modules for an interface description. If necessary add a section to `config.json` to allow users to configure your plugin. Finally, add your plugin to `cwe_checker.ml`.
### Contribute ###
Expand Down
1 change: 1 addition & 0 deletions recipes/static_analysis/descr
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Runs those checks of the cwe-checker plugin that rely on static analysis.
5 changes: 5 additions & 0 deletions recipes/static_analysis/recipe.scm
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
(option pass cwe-checker)

(option rooter internal)

(option cwe-checker-config $prefix/../../src/config.json)

0 comments on commit 002a375

Please sign in to comment.