Reading the repo
Opening the box…
Reading the repo
Opening the box…
Assembly instructions
A toolset for dealing with Cryptography Bill of Materials (CBOM)
Saved setup from 8 h ago
Will it work on macOS?
Heads-upBuilding it yourself? It also needs PostgreSQL.
CONTRIBUTING.mdCBOMkit is a toolset for handling Cryptographic Bill of Materials (CBOM). This page describes how you can join the community in this goal.
If you are new to the community? We recommend you do the following before diving into the code:
The Sonar Cryptography Plugin uses the following labels to help non-maintainers find issues best suited to their interest and experience level:
Check if all java files are well formated and license headers are in place.
mvn spotless:check
Applies format and license headers to files.
mvn spotless:apply
Spotless Maven Documentation: https://github.com/diffplug/spotless/blob/main/plugin-maven/README.md
Check for coding style
mvn checkstyle::check
To build or run CBOMkit, you need access to the
sonar-cryptography-plugindependency, hosted on GitHub as a GitHub Package. Using GitHub Packages requires you to authenticate with a GitHub account using a personal access token. You will find explanations here.
# builds a JAR file for the Api server
make build-backend
# creates a docker image for the Api server
make build-backend-image
# creates a docker image for the frontend/viewer
make build-frontend-image
Depending on where you want to change things, you can spin up different development environments.
# creates a dev environment, including
# - postgres database
make dev
# creates a dev environment, including
# - postgres database
# - frontend
make dev-backend
# creates a dev environment, including
# - postgres database
# - api server (backend)
make dev-frontend
# using the cli
quarkus dev
# using maven
./mvnw quarkus:dev
Download and install the quarkus-cli from here.
# change to the frontend directory
cd frontend/
# use vue cli to start the frontend in dev mode
vue-cli-service serve --port 8001
When the service is deployed, it first attempts to parse the purls.json
file from the resource directory as part of the initialization procedure.
This process extracts repository related purls for a particular software
package referenced in the file and stores it as an identifier in a database
table along with other related purls.
The folks at ScanOSS maintain a repository called scanoss/purl2cpe.
This repository is the basis for the purls.json file,
as it already contains a large number of purls and their associated software packages.
When the purls-generation/main.py Python script is executed,
it traverses the resource folder containing a clone of the ScanOSS repository
from a given point in time and generates the purls.json file.
When a new file should be generated the variable version should be increased in
the purls-generation/main.py script. Only when the version changed, the CBOM Generator
will reread the purl.json file from the resource directory.
Then run bash setup.sh. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.
Needs Git: xcode-select --install
git clone https://github.com/cbomkit/cbomkit.git cd cbomkit
JDK 21, make
brew install openjdk@21 xcode-select --install
Needs: PostgreSQL
brew install --cask docker # Docker Desktop docker compose -f docker-compose.yaml up -d
./mvnw install -DskipTests
./mvnw exec:java
First, clone the repository and navigate to the project directory:
git clone https://github.com/cbomkit/cbomkit
cd cbomkit
Starting the CBOMkit using docker-compose.
# run the make command to start the docker compose
make production
To run the latest development build instead of the latest release, use the edge images:
make edge
If you prefer Podman, ensure podman-compose is installed (pip3 install podman-compose), then run:
# run the make command to start the docker compose using podman
make production ENGINE=podman
Deploy to a cluster by providing your domain and database credentials. This command automatically fetches the latest release tags:
# clone the repository
git clone https://github.com/cbomkit/cbomkit
cd cbomkit
# deploy using helm
helm install cbomkit \
--set common.clusterDomain={CLUSTER_DOMAIN} \
--set postgresql.auth.username={POSTGRES_USER} \
--set postgresql.auth.password={POSTGRES_PASSWORD} \
--set backend.tag=$(curl -s https://api.github.com/repos/cbomkit/cbomkit/releases/latest | grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/') \
--set frontend.tag=$(curl -s https://api.github.com/repos/cbomkit/cbomkit/releases/latest | grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/') \
./chart
pkg:maven/io.quarkus/quarkus-core@3.18.1 to generate a CBOMDefault service endpoints:
No reports for macOS yet.
GitManual AI Agent reads the 7 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.