Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bitbomdev/minefield
Graphing SBOM's Fast.
https://github.com/bitbomdev/minefield
airgap graph roaring-bitmaps sbom supply-chain-security
Last synced: about 2 months ago
JSON representation
Graphing SBOM's Fast.
- Host: GitHub
- URL: https://github.com/bitbomdev/minefield
- Owner: bitbomdev
- License: apache-2.0
- Created: 2024-06-05T15:35:52.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-10-23T21:20:11.000Z (about 2 months ago)
- Last Synced: 2024-10-23T23:53:26.862Z (about 2 months ago)
- Topics: airgap, graph, roaring-bitmaps, sbom, supply-chain-security
- Language: Go
- Homepage: https://bitbom.dev
- Size: 2.46 MB
- Stars: 221
- Watchers: 6
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://goreportcard.com/report/github.com/bit-bom/minefield)
[](https://github.com/bitbomdev/minefield/actions/workflows/build.yaml)
**BitBom** Minefield uses roaring **Bit**maps to graph S**BOM**s with four main fundamentals:
* **Speed**: Optimized for rapid data processing.
* **Air-Gapped**: Operates securely in isolated environments.
* **Scalable**: Supports millions of nodes effortlessly.
* **Customizable**: Allows users to extend the project without relying on upstream changes.
---
>Before moving on, please consider giving us a GitHub star ⭐️. Thank you!
---
> Caching 10,000 SBOMs packages transitive dependents in 30 seconds.
## Table of Contents
1. [Quickstart Guide](#quickstart-guide)
2. [Example](#example)
3. [To Start Using Minefield](#to-start-using-minefield)
- [Using Docker](#using-docker)
- [Building From Source](#building-from-source)
4. [How Minefield Works](#how-minefield-works)
- [Air-Gapped Design Philosophy](#air-gapped-design-philosophy)
5. [Visualization of a Query](#visualization-of-a-query)
6. [Documentation](#documentation)
7. [Blog](#blog)
8. [Star History](#star-history)
9. [Acknowledgements](#acknowledgements)
[View Minefield demo on asciinema](https://asciinema.org/a/674302)
## Quickstart Guide
1. **Ingest some data:**
```sh
minefield ingest sbom
```
2. **Cache the data:**
```sh
minefield cache
```
3. **Run a query:**
```sh
minefield query
```
### Example
_Redis must be running at `localhost:6379`. If not, please use `make docker-up` to start Redis._
1. **Start the API server:**
```shell
minefield start-service
```
2. **Ingest the `test` SBOM directory:**
```sh
minefield ingest sbom testdata
```
3. **Cache the data:**
```sh
minefield cache
```
4. **Run the leaderboard custom with "dependents PACKAGE":**
- This command generates a ranked list of packages, ordered by the number of other packages that depend on them.
```sh
minefield leaderboard custom "dependents PACKAGE"
```
5. **Run a query on the top value from the leaderboard:**
- This command queries the dependents for a specific package, in this case `dep2`.
```sh
minefield query "dependents PACKAGE dep2"
```
6. **Run queries to see the shared dependencies of `lib-A` and `dep1`, and `lib-A` and `lib-B`:**
- These queries output the intersection of two queries, finding package dependencies shared between each pair.
```sh
minefield query "dependencies PACKAGE pkg:generic/[email protected] and dependencies PACKAGE pkg:generic/[email protected]"
```
7. **Run queries with the visualizer:**
```sh
minefield query "dependents PACKAGE pkg:generic/[email protected]" --visualize
```
## To Start Using Minefield
### Using Docker
```sh
docker pull ghcr.io/bitbomdev/minefield:latest
docker run -it ghcr.io/bitbomdev/minefield:latest
```
### Building From Source
```sh
git clone https://github.com/bitbomdev/minefield.git
cd minefield
go build -o minefield main.go
./minefield
```
## How Minefield Works
The design decisions and architecture of Minefield can be found [here](docs/bitbom.pdf).
### Air-Gapped Design Philosophy
Minefield is primarily designed as an air-gapped solution, operating seamlessly without internet connectivity. It makes it ideal for secure environments that require complete isolation from external networks.
- **Offline Operation**: All functionalities, including data ingestion, caching, querying, and visualization, are performed locally without external dependencies.
- **Enhanced Security**: Operating in an air-gapped environment minimizes the risk of data breaches and unauthorized access, ensuring that sensitive information remains within your controlled infrastructure.
- **Data Sovereignty**: Users have complete control over their data, with no external transmissions, adhering to strict compliance and regulatory requirements.
- **Efficiency**: Minefield is optimized for performance and can handle large datasets quickly even without network resources.
Minefield makes it easy to securely and efficiently manage and explore your software dependencies within isolated environments by offline processing and analyzing SBOMs (Software Bill of Materials).
## Visualization of a Query
## Documentation
For comprehensive guides and detailed documentation, please visit our [Docs](https://bitbom.dev/docs/intro).
## Blog
Stay updated with the latest news and insights by visiting our [Blog](https://bitbom.dev/blog).
## Star History
[](https://star-history.com/#bitbomdev/minefield&Date)
## Acknowledgements
- https://github.com/RoaringBitmap/roaring