[{"_1":2,"_198":-5,"_199":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_173":174},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":89,"_111":112,"_162":-5,"_163":11,"_164":21,"_165":11,"_166":-5,"_167":11,"_168":-5,"_169":170,"_171":113,"_172":-7},"canonicalUrl","https://hub.docker.com/r/binaryanalysisplatform/bap-toolkit/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","binaryanalysisplatform","reponame","bap-toolkit","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2019-05-16T19:11:36.050035Z","description","","is_private","last_updated","2022-04-21T14:03:34.789791Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",14189,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","![](https://github.com/BinaryAnalysisPlatform/bap-toolkit/workflows/Daily%20test/badge.svg)\n\n# Introduction\n\nThis repository provides a collection of ready to use binary analysis tools,\nas well as a framework and a conventional repository structure for developing\nnew tools. Think of it as BAP on Rails. This repository should be seen as a collaboration\nplatform encouraging everyone to fork it, implement an analysis, and share it back with\nthe community. PRs are very welcomed and accepted with no questions asked.\n\n# Table of Contents\n\n- [Installation](#installation) - how to install all or some tools\n- [Usage](#usage) - how to run tools and analyze results\n- [Developing](#developing) - how to develop a new tool\n- [Contributing](#contributing) - how to contribute a new tool\n- Tools\n - checks from the [Joint Strike Fighter coding standards](http://stroustrup.com/JSF-AV-rules.pdf)\n - [av-rule-3](av-rule-3/descr) - all functions have a cyclomatic complexity less than 20\n - [av-rule-17](av-rule-17/descr) - `errno` is not used as an error indicator\n - [av-rule-19](av-rule-19/descr) - `setlocale` et all functions are not be used\n - [av-rule-20](av-rule-20/descr) - `setjmp`/`longjmp` are not be used\n - [av-rule-21](av-rule-21/descr) - signal handling facilities of `` are not be used\n - [av-rule-22](av-rule-22/descr) - The input/output library `` shall not be used\n - [av-rule-23](av-rule-23/descr) - `atof`, `atoi`, and `atol` are not be used\n - [av-rule-24](av-rule-24/descr) - `abort`, `exit`, `getenv` and `system` are not be used\n - [av-rule-25](av-rule-25/descr) - the `` interface is not used\n - [av-rule-174](av-rule-174/descr) - potential null pointer dereferencings\n - [av-rule-189](av-rule-189/descr) - `goto` statements are not used\n - checks from the [JPL Institutional Coding Standard](http://bsivko.pbworks.com/w/file/fetch/68132300/JPL_Coding_Standard_C.pdf)\n - [jpl-rule-4](jpl-rule-4/descr) - no recursive functions\n - [jpl-rule-11](jpl-rule-11/descr) - `goto` statements are not used\n - [jpl-rule-14](jpl-rule-14/descr) - return values of all non-void functions are used\n - [forbidden-symbols](forbidden-symbol/descr) - detects all forbidden symbols from the av-rule-{17,19,20,21,22,23,24,25}\n - [defective-symbols](defective-symbol/descr) - detects all defective symbols from the av-rule-{3,189} and jpl-rule-4\n - [untrusted-argument](untrusted-argument/descr) - checks that certain functions never use untrusted data\n - [must-check-value](must-check-value/descr) - detects an unchecked return value of certain functions\n - [use-after-free](use-after-free/descr) - detects a usage of a pointer that was freed before\n - [double-free](double-free/descr) - detects a pointer that is freed twice\n - [restrictness-check](restrictness-check/descr) - detects an incorrect invocation of a function with strictness requirement\n - [warn-unused](warn-unused/descr) - detects an unused value returned by a function with warn-unused attribute\n - [primus-checks](primus-checks/descr) - an all-in-one analysis that uses Primus to identify the following CWE:\n - CWE-122 (Buffer Overwrite)\n - CWE-125 (Buffer Overread)\n - CWE-416 (Use after free)\n - CWE-415 (Double free)\n - CWE-798 (Use of Hard-coded Credentials)\n - CWE-259 (Use of Hard-coded Password)\n - CWE-822 (Untrusted Pointer Dereference)\n - CWE-291 (Relience on IP Address for Authentication)\n - CWE-170 (Improper Null Termination)\n - CWE-138 (Improper Neutralization)\n - CWE-74 (Command Injection)\n - CWE-476 (NULL pointer dereference)\n - CWE-690 (Unchecked Return Value to NULL Pointer Dereference)\n - CWE-252 (Unchecked Return Value)\n\n\n## Installation\n\nThe build and installation system is currently querying the opam tool for all the\nnecessary information, therefore make sure that opam 2.x is installed on your\nsystem, and a switch is activated, with\n\n eval $(opam env)\n\nNext, to install all tools in the repository to the default share folder just do\n\n\n make\n make install\n\nTo install a specific tool, run the same commands but pass the tool name to them, e.g.,\n\n make TARGET=primus-checks\n make install TARGET=primus-checks\n\n# Usage\n\nTool are packed as BAP recipes, therefore to run a tool just pass its name to the `--recipe` option, e.g.,\n\n bap ./exe --recipe=av-rule-3\n\nTo get a detailed description of a recipe, use the `--show-recipe` option, e.g.,\n\n bap --show-recipe=av-rule-3\n\nYou can also list all available using the `--list-recipes` option,\n\n bap --list-recipes\n\n# Results\nThe results of the checks from this repository applied to [bap-artifacts](https://github.com/BinaryAnalysisPlatform/bap-artifacts) can\nbe seen [here](http://htmlpreview.github.io/?https://github.com/BinaryAnalysisPlatform/bap-toolkit/blob/master/results.html)\n\n\n# Developing\n\n## Creating a new tool\n\nTo create a new tool clone this repository,\n\n https://github.com/BinaryAnalysisPlatform/bap-toolkit.git\n\nThen create a new folder inside the newly cloned `bap-toolkit` folder,\n\n cd bap-toolkit\n mkdir my-first-tool\n cd my-first-tool\n\nAll files in this folder will form the body of your tool. They may contain input\nfiles, scripts for pre and post processing, BAP plugins and libraries, etc. The only\nrequired file is the `recipe.scm` file which is the entry point of your tool. This\nfile contains a list of options which are passed to `bap`, for example, to create a\ntool that just dumps a file in multiple formats, create a `recipe.scm` file with the\nfollowing contents\n\n (option dump asm:out.asm)\n (option dump bir:out.bir)\n\nAfter the tool is [built and installed](#installation), you can run it with\n\n bap ./test-file --recipe=my-first-tool\n\nAnd this would essentially the same as running bap with the following command line arguments\n\n bap ./test-file --dump=asm:out.asm --dump=bir:out.bir\n\nNot a big deal so far, but typical bap invocation may contain lots of command line option.\nYou may also need to pass files, header files, BAP Lisp scripts, etc. This is where the recipe\nsystem shines. In general, the recipe specification contains a list of recipe items in\nan arbitrary order. Each item is either a command line option, a parameter, or a reference to\nanother recipe. All items share the same syntax - they are flat s-expressions, i.e., a whitespace\nseparated list of strings enclosed in parentheses. The first string in the list denotes the type\nof the item, e.g.,\n\n (option run-entry-points malloc calloc free)\n\n\nThe `option` command requires one mandatory parameter, the option name,\nand an arbitrary number of arguments that will be passed to the\ncorresponding command line option. If there are more than one argument\nthen they will be concatenated with the comman symbol, e.g.,\n\n (option opt a b c d)\n\nwill be translated to\n\n --opt=a,b,c,d\n\nOption arguments may contain _substitution symbols_. A subsitution\nsymbol starts with the dollar sign, that is followed by a named\n(optionally delimited with curly braces, to disambiguate it from the\nrest of the argument). There is one built in parameter `prefix`,\nthat is substituted with the path to the recipe top folder.\n\nThe `parameter` command introduces a parameter to the recipe, i.e., a\nvariable ingredient that could be changed when the recipe is used. The\n`parameter` command has 3 arguments, all required. The first argument is\nthe parameter name, the second is the default value, that is used if\nthe parameter wasn't set, and the last argument is the parameter\ndescription. The substitution symbol will be replaced with the default\nvalue of a parameter, if a value of the parameter wasn't passed through\nthe command line. Example,\n\n (parameter depth 128 \"maximum depth of analysis\")\n (option analysis-depth $depth)\n\n\nIf the parameter is not set through the command line, then it will be\nsubstituted with `128` otherwise it will receive whatever value a user\nhas passed.\n\nFinally, the `extend` command is like the `#include` statement in the C\npreprocessor as it includes all the ingredients from another\nrecipe. (Make sure that you're not introducing loops!). The command\nhas one mandatory argument, the name of the recipe to include.\n\n## The recipe file grammar\n\nThe grammar is specified below, but for the details and up-to-date information, \nplease refer to `bap recipe --help`\n\n recipe ::= {}\n recipe-item ::=

binaryanalysisplatform/bap-toolkit

Tags for binaryanalysisplatform/bap-toolkit