@@ -35,17 +35,17 @@ The following arguments should convince you to give *cwe_checker* a try:
...
@@ -35,17 +35,17 @@ The following arguments should convince you to give *cwe_checker* a try:
- view results annotated in IDA Pro
- view results annotated in IDA Pro
-*cwe_checker* can be integrated as a plugin into [FACT](https://github.com/fkie-cad/FACT_core)
-*cwe_checker* can be integrated as a plugin into [FACT](https://github.com/fkie-cad/FACT_core)
## How to install cwe_checker? ##
## How to install cwe_checker? ##
There are several ways to install cwe_checker. The recommended way is to get cwe_checker from the Ocaml package manager Opam. You can install cwe_checker via the package [fkie-cad-cwe-checker](https://opam.ocaml.org/packages/fkie-cad-cwe-checker/)(`opam install fkie-cad-cwe-checker`). This gives you a stable version of cwe_checker.
There are several ways to install cwe_checker. The recommended way is to get cwe_checker from the Ocaml package manager Opam. You can install cwe_checker via the package [fkie-cad-cwe-checker](https://opam.ocaml.org/packages/fkie-cad-cwe-checker/)(`opam install fkie-cad-cwe-checker`). This gives you a stable version of cwe_checker. At the moment we depend on the testing version of BAP to include the latest features.
Another option is to pull the latest Docker container from [dockerhub](https://hub.docker.com/r/fkiecad/cwe_checker) (`docker pull fkiecad/cwe_checker`).
Another option is to pull the latest Docker container from [dockerhub](https://hub.docker.com/r/fkiecad/cwe_checker) (`docker pull fkiecad/cwe_checker`).
The last two ways are preferrable if you plan to develop cwe_checker. First, utilize the installation script `install.sh`, which is just a wrapper around Docker. Make sure to have the latest version of Docker. Second, build it using the provided `Makefile`. In this case you must ensure that all dependencies are fulfilled:
The last two ways are preferrable if you plan to develop cwe_checker. First, utilize the installation script `install.sh`, which is just a wrapper around Docker. Make sure to have the latest version of Docker. Second, build it using the provided `Makefile`. In this case you must ensure that all dependencies are fulfilled:
- Ocaml 4.05.0
- Ocaml 4.05.0
- Opam 2.0.2
- Opam 2.0.2
- BAP 1.5 (and its dependencies)
- BAP 1.6 (testing) (and its dependencies)
- yojson >= 1.4.1
- yojson >= 1.4.1
- alcotest >= 0.8.3
- alcotest >= 0.8.3
- Sark for IDA Pro annotations
- Sark (latest) for IDA Pro annotations
- pytest >= 3.5.1
- pytest >= 3.5.1
Just run `make all` to compile and register the plugin with BAP. You can run the test suite via `make test`.
Just run `make all` to compile and register the plugin with BAP. You can run the test suite via `make test`.
