diff --git a/CHANGES.md b/CHANGES.md index b88c37eb5..5ab0af6f1 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -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) ===== diff --git a/README.md b/README.md index fb5c16a29..8071947bc 100644 --- a/README.md +++ b/README.md @@ -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 ### diff --git a/recipes/static_analysis/descr b/recipes/static_analysis/descr new file mode 100644 index 000000000..03e79a4a1 --- /dev/null +++ b/recipes/static_analysis/descr @@ -0,0 +1 @@ +Runs those checks of the cwe-checker plugin that rely on static analysis. diff --git a/recipes/static_analysis/recipe.scm b/recipes/static_analysis/recipe.scm new file mode 100644 index 000000000..ec0990df2 --- /dev/null +++ b/recipes/static_analysis/recipe.scm @@ -0,0 +1,5 @@ +(option pass cwe-checker) + +(option rooter internal) + +(option cwe-checker-config $prefix/../../src/config.json)