Opam (#19)

This ensures that cwe_checker is deployable with opam.

README.md

@@ -43,14 +43,15 @@ The following arguments should convince you to give *cwe_checker* a try:
 -  view results annotated in IDA Pro
 -  *cwe_checker* can be integrated as a plugin into [FACT](https://github.com/fkie-cad/FACT_core)
 ## 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. At the moment we depend on the testing version of BAP to include the latest features.  
+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 [cwe_checker](https://opam.ocaml.org/packages/cwe_checker/) (`opam install cwe_checker`). This gives you a stable version of 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:
+If you plan to develop cwe_checker, it is recommended to build it using the provided `Makefile`. In this case you must ensure that all dependencies are fulfilled:
 -  Ocaml 4.05.0
 -  Opam 2.0.2
--  BAP 1.6 (testing) (and its dependencies)
+-  dune >= 1.6
+-  BAP 1.6 (and its dependencies)
 -  yojson >= 1.4.1
 -  alcotest >= 0.8.3
 -  Sark (latest) for IDA Pro annotations
@@ -68,11 +69,11 @@ 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`.
+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 `plugins/cwe_checker/cwe_checker.ml`.
 
 If you plan to open a PR, please utilize [precommit](https://pre-commit.com) in your development environment to catch many issues before the code review.
 ### Contribute ###
-Contributions are always welcomed. Just fork it and open a pull request!
+Contributions are always welcome. Just fork it and open a pull request!
 ## Acknowledgements ##
 This project is partly financed by [German Federal Office for Information Security (BSI)](https://www.bsi.bund.de).
 

cwe_checker.opam

+opam-version: "2.0"
+name: "cwe_checker"
+version: "0.2"
+synopsis: "BAP plugin collection to detect common bug classes"
+description: """
+cwe_checker is a suite of tools to detect common bug classes such as use of dangerous functions and simple integer overflows. These bug classes are formally known as Common Weakness Enumerations (CWEs).
+"""
+maintainer: "CWE_checker Team <firmware-security@fkie.fraunhofer.de>"
+authors: [ "Thomas Barabosch <thomas.barabosch@fkie.fraunhofer.de>" "Nils-Edvin Enkelmann <nils-edvin.enkelmann@fkie.fraunhofer.de>" ]
+license: "LGPL-3.0"
+homepage: "https://github.com/fkie-cad/cwe_checker"
+bug-reports: "https://github.com/fkie-cad/cwe_checker/issues"
+dev-repo: "git+https://github.com/fkie-cad/cwe_checker"
+depends: [
+  "ocaml" {>= "4.05"}
+  "dune" {>= "1.6"}
+  "yojson" {>= "1.4.1"}
+  "bap" {>= "1.6"}
+  "alcotest" {>= "0.8.3"}
+  "core_kernel" {>= "v0.11" & < "v0.12"}
+  "ppx_jane" {>= "v0.11" & < "v0.12"}
+  "cwe_checker_core" {= "0.2"}
+]
+depexts: [
+  "binutils"
+]
+build: [
+  [ "dune" "build" "--profile" "release" ]
+]
+install: [
+  [ make "uninstall" ]
+  [ make "clean" ]
+  [ make "all" ]
+]
+remove: [
+  [ make "uninstall" ]
+  [ make "clean" ]
+]

dune

+(install
+  (section etc)
+  (files
+    (src/config.json as config.json)
+  )
+)

plugins/cwe_checker/cwe_checker.ml

@@ -84,8 +84,18 @@ let main config module_versions partial_update project =
     end
   else
     begin
+      let config =
+        if config = "" then
+          (* try the standard installation path for the config file instead *)
+          match Sys.getenv_opt "OPAM_SWITCH_PREFIX" with
+          | Some(prefix) -> prefix ^ "/etc/cwe_checker/config.json"
+          | None -> ""
+        else
+          config in
       if config = "" then
         Log_utils.error "[cwe_checker] No configuration file provided! Aborting..."
+      else if Sys.file_exists config <> true then
+        Log_utils.error "[cwe_checker] Configuration file not found. Aborting..."
       else
         begin
           if partial_update = "" then

src/cwe_checker_core.opam

+opam-version: "2.0"
+name: "cwe_checker_core"
+version: "0.2"
+synopsis: "Core library for the cwe_checker package"
+description: """
+Core library for the cwe_checker suite of tools.
+"""
+maintainer: "CWE_checker Team <firmware-security@fkie.fraunhofer.de>"
+authors: [ "Thomas Barabosch <thomas.barabosch@fkie.fraunhofer.de>" "Nils-Edvin Enkelmann <nils-edvin.enkelmann@fkie.fraunhofer.de>" ]
+license: "LGPL-3.0"
+homepage: "https://github.com/fkie-cad/cwe_checker"
+bug-reports: "https://github.com/fkie-cad/cwe_checker/issues"
+dev-repo: "git+https://github.com/fkie-cad/cwe_checker"
+depends: [
+  "ocaml" {>= "4.05"}
+  "dune" {>= "1.6"}
+  "yojson" {>= "1.4.1"}
+  "bap" {>= "1.6"}
+  "core_kernel" {>= "v0.11" & < "v0.12"}
+  "ppx_jane" {>= "v0.11" & < "v0.12"}
+]
+depexts: [
+  "binutils"
+]
+build: [
+  [ "dune" "build" "--profile" "release" ]
+]
+install: [
+  [ "dune" "install" ]
+]
+remove: [
+  [ "dune" "uninstall" ]
+]

src/dune

@@ -4,8 +4,7 @@
   (libraries
   yojson
   bap
-  core_kernel
-  core)
+  core_kernel)
   (preprocess (pps ppx_jane))
 )