Linter and SBOM generator for binary files.
Project description
BLint
BLint is a Binary Linter that checks the security properties and capabilities of your executables. It is powered by lief. Since version 2, blint can also generate Software Bill-of-Materials (SBOM) for supported binaries.
Supported binary formats:
- Android (apk, aab)
- ELF (GNU, musl)
- PE (exe, dll)
- Mach-O (x64, arm64)
You can run blint on Linux, Windows, and Mac against any of these binary formats.
Motivation
Nowadays, vendors distribute statically linked binaries produced by Golang, Rust, or Dotnet tooling. Users are used to running antivirus and anti-malware scans while using these binaries in their local devices. Blint augments these scans by listing the technical capabilities of a binary. For example, whether the binary could use network connections or can perform file system operations and so on. The binary is first parsed using the lief framework to identify the various properties, such as functions and the presence of symtab and dynamic symbols. Thanks to YAML-based annotation data, this information can be matched against capabilities and presented visually using a rich table. NOTE: The presence of capabilities doesn't imply that the binary always performs the operations. Use the output of this tool to get an idea about a binary. Also, this tool is not suitable for reviewing malware and other heavily obfuscated binaries for obvious reasons.
Use cases
- Quickly identify malicious binaries by looking at their capabilities (Ability to manipulate networks or drivers or kernels etc)
- Add blint to CI/CD to inspect the final binaries to ensure code signing or authenticode is applied correctly
- Identify interesting functions and symbols for fuzzing
Installation
- Install python 3.10, 3.11, or 3.12
pip install blint
Single binary releases
You can download single binary builds from the blint-bin releases. These executables should work without requiring python to be installed. The macOS .pkg file is signed with a valid developer account.
Usage
usage: blint [-h] [-i SRC_DIR_IMAGE [SRC_DIR_IMAGE ...]] [-o REPORTS_DIR] [--no-error] [--no-banner]
[--no-reviews] [--suggest-fuzzable]
{sbom} ...
Binary linter and SBOM generator.
options:
-h, --help show this help message and exit
-i SRC_DIR_IMAGE [SRC_DIR_IMAGE ...], --src SRC_DIR_IMAGE [SRC_DIR_IMAGE ...]
Source directories, container images or binary files. Defaults to current directory.
-o REPORTS_DIR, --reports REPORTS_DIR
Reports directory. Defaults to reports.
--no-error Continue on error to prevent build from breaking.
--no-banner Do not display banner.
--no-reviews Do not perform method reviews.
--suggest-fuzzable Suggest functions and symbols for fuzzing based on a dictionary.
sub-commands:
Additional sub-commands
{sbom}
sbom Command to generate SBOM for supported binaries.
SBOM sub-command
usage: blint sbom [-h] [-i SRC_DIR_IMAGE [SRC_DIR_IMAGE ...]] [-o SBOM_OUTPUT] [--deep]
options:
-h, --help show this help message and exit
-i SRC_DIR_IMAGE [SRC_DIR_IMAGE ...], --src SRC_DIR_IMAGE [SRC_DIR_IMAGE ...]
Source directories, container images or binary files. Defaults to current directory.
-o SBOM_OUTPUT, --output-file SBOM_OUTPUT
SBOM output file. Defaults to bom.json in current directory.
--deep Enable deep mode to collect more used symbols and modules aggressively. Slow
operation.
--stdout Print the SBOM to stdout instead of a file.
To test any binary, including default commands
blint -i /bin/netstat -o /tmp/blint
Use -i to check any other binary. For eg: to check ngrok
blint -i ~/ngrok -o /tmp/blint
Pass --suggest-fuzzable
to get suggestions for fuzzing. A dictionary containing "common verbs" is used to identify these functions.
blint -i ~/ngrok -o /tmp/blint --suggest-fuzzable
To generate SBOM in CycloneDX format for supported binaries, use the sbom sub-command.
blint sbom -i /path/to/apk -o bom.json
blint sbom -i /directory/with/apk/aab -o bom.json
To parse all files, including .dex
files, pass --deep
argument.
blint sbom -i /path/to/apk -o bom.json --deep
The following binaries are supported:
- Android (apk/aab)
- Dotnet executable binaries
- Go binaries
- Rust binaries
blint sbom -i /path/to/go-binaries -o bom.json --deep
For all other binaries, the symbols will be collected and represented as properties with internal
prefixes for the parent component. Child components and dependencies would be missing.
PowerShell example
Reports
Blint produces the following json artifacts in the reports directory:
- blint-output.html - HTML output from the console logs
- exename-metadata.json - Raw metadata about the parsed binary. Includes symbols, functions, and signature information
- findings.json - Contains information from the security properties audit. Useful for CI/CD integrations
- reviews.json - Contains information from the capability reviews. Useful for further analysis
- fuzzables.json - Contains a suggested list of methods for fuzzing
sbom command generates CycloneDX json.
References
Discord support
The developers can be reached via the Discord channel.
Sponsorship wishlist
If you love blint, you should consider donating to our project. In addition, consider donating to the below projects, which make blint possible.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file blint-2.3.0.tar.gz
.
File metadata
- Download URL: blint-2.3.0.tar.gz
- Upload date:
- Size: 142.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8275033a121a214d4c61c34bc80dce57c11da37d50e7257f9b904a1a43e0bc8c |
|
MD5 | 3fb7ddd1ff851610fdd98c5a269a7ce4 |
|
BLAKE2b-256 | 5874d3e54793bceb436202b3f1f18f45cca0511aac426466cd8b83072ee63a6b |
Provenance
The following attestation bundles were made for blint-2.3.0.tar.gz
:
Publisher:
publish.yml
on owasp-dep-scan/blint
-
Statement type:
https://in-toto.io/Statement/v1
- Predicate type:
https://docs.pypi.org/attestations/publish/v1
- Subject name:
blint-2.3.0.tar.gz
- Subject digest:
8275033a121a214d4c61c34bc80dce57c11da37d50e7257f9b904a1a43e0bc8c
- Sigstore transparency entry: 147573489
- Sigstore integration time:
- Predicate type:
File details
Details for the file blint-2.3.0-py3-none-any.whl
.
File metadata
- Download URL: blint-2.3.0-py3-none-any.whl
- Upload date:
- Size: 151.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 28e818fe1bde9550de86040393e381d72a2dee0734c425f3515629de27e4de4b |
|
MD5 | e97eb0eb3eda279591150d578aa782e0 |
|
BLAKE2b-256 | 1e25283dedaeece2e2ba0b0e04312d28ddbbc8672c05ef337e12d7b9c58d360d |
Provenance
The following attestation bundles were made for blint-2.3.0-py3-none-any.whl
:
Publisher:
publish.yml
on owasp-dep-scan/blint
-
Statement type:
https://in-toto.io/Statement/v1
- Predicate type:
https://docs.pypi.org/attestations/publish/v1
- Subject name:
blint-2.3.0-py3-none-any.whl
- Subject digest:
28e818fe1bde9550de86040393e381d72a2dee0734c425f3515629de27e4de4b
- Sigstore transparency entry: 147573490
- Sigstore integration time:
- Predicate type: