dalemyers / binskim

A binary static analysis tool that provides security and correctness results for Windows Portable Executable and *nix ELF binary formats

BinSkim Binary Analyzer

This repository contains the source code for BinSkim, a Portable Executable (PE) light-weight scanner that validates compiler/linker settings and other security-relevant binary characteristics.

For Developers

1. Fork the repository -- Need Help?
2. Load and compile src\BinSkim.sln to develop changes for contribution.
3. Execute BuildAndTest.cmd at the root of the enlistment to validate before submitting a PR.

Submit Pull Requests

1. Run BuildAndTest.cmd at the root of the enlistment to ensure that all tests pass, release build succeeds, and NuGet packages are created
2. Submit a Pull Request to the 'develop' branch -- Need Help?

For Users

1. Download BinSkim from NuGet
2. Read the User Guide
3. Find out more about the Static Analysis Results Interchange Format (SARIF) used to output Binskim results

How to extract the exe file from the nuget package

If you only want to run the Binskim tool without installing anything, then you can

1. Download BinSkim from NuGet
2. Rename the file extension from .nupkg to .zip
3. Unzip
4. Executable files are now available in the folder tools\netcoreapp3.1

Command-Line Quick Guide

Argument (short form, long form)	Meaning
--sympath	Symbols path value (e.g. SRV http://msdl.microsoft.com/download/symbols or Cache d:\symbols;Srv http://symweb)
-o, --output	File path used to write and output analysis using SARIF
-r, --recurse	Recurse into subdirectories when evaluating file specifier arguments
-c, --config	(Default: ‘default’) Path to policy file to be used to configure analysis. Passing value of 'default' (or omitting the argument) invokes built-in settings
-q, --quiet	Do not log results to the console
-s, --statistics	Generate timing and other statistics for analysis session
-h, --hashes	Output hashes of analysis targets when emitting SARIF reports
-e, --environment	Log machine environment details of run to output file. WARNING: This option records potentially sensitive information (such as all environment variable values) to the log file.
-p, --plugin	Path to plugin that will be invoked against all targets in the analysis set.
--level	Filter output of scan results to one or more failure levels. Valid values: Error, Warning and Note.
--kind	Filter output one or more result kinds. Valid values: Fail (for literal scan results), Pass, Review, Open, NotApplicable and Informational.
--trace	Execution traces, expressed as a semicolon-delimited list, that should be emitted to the console and log file (if appropriate). Valid values: PdbLoad.
--help	Table of argument information.
--version	BinSkim version details.
value pos. 0	One or more specifiers to a file, directory, or filter pattern that resolves to one or more binaries to analyze.

Example: binskim.exe analyze c:\bld\*.dll --recurse --output MyRun.sarif