Adding a package manager
This guide walks through adding support for a new programming language or package manager, step by step.
Before you start
Section titled “Before you start”Check the following before adding a new language or package manager.
- cdxgen support: Check the cdxgen supported project types. If an official cdxgen language image exists, adding it to the routing table is enough.
- syft support: If you need binary or image analysis, check the syft supported ecosystems.
- Need for a custom analyzer: Consider a custom analysis script only when neither tool supports the ecosystem.
Source scanning is a two-stage design that routes to per-language official cdxgen images rather than using a single image. See Architecture for the full picture.
1. Add language detection and image routing
Section titled “1. Add language detection and image routing”docker/lib/source-detect.sh is the shared detection logic used by both the CLI and the web UI. Modify two functions.
detect_lang()— add a rule that detects the language from the project’s manifest files (for example, Kotlin checks forbuild.gradle.kts— Kotlin is already covered by thejavabranch).img_for_lang()— add the official cdxgen image that corresponds to the detected language.
# img_for_lang() example — add a new language entrynewlang) echo "${p}cdxgen-debian-newlang:$CDXGEN_TAG" ;;2. Update build-prep.sh if dependency preparation is needed
Section titled “2. Update build-prep.sh if dependency preparation is needed”If cdxgen cannot resolve transitive dependencies in the ecosystem without a lock file, add preparation logic to docker/lib/build-prep.sh, which creates lock files right before cdxgen runs. Rust (cargo generate-lockfile) and Go (go mod download) are existing precedents. Write the preparation as best-effort so it never fails the scan.
3. Add an example project
Section titled “3. Add an example project”Add an example project under the examples/ directory.
examples/<language>/├── README.md # Example description├── build.gradle.kts # Build file├── gradle.lockfile # Lock file (required!)└── src/main/kotlin/ └── Main.ktWhy the lock file matters: cdxgen extracts exact version information from lock files. Without one, dependency detection is incomplete.
4. Add a test
Section titled “4. Add a test”There is no per-language test file to create. Add a new numbered block to tests/test-scan.sh, following an existing one (the Java Maven block, Test 3, is a good template): create the fixture project, run the scan with run_scan_with_logs, locate the BOM with find_bom_file, and assert on it with jq or with assert_bom_sane / assert_spdx_sane / assert_root_has_direct_deps. Each block’s print_test label is hand-numbered (“Test N/15”), so renumber the labels after inserting one and update the total in the --help text and summary banner.
If the case doesn’t fit the source-scan pattern, add a standalone tests/test-<name>.sh script instead and wire it into ci.yml (per-PR) or nightly.yml (slow/network-dependent). See the testing guide for the full explanation and examples of both paths.
5. Update the documentation
Section titled “5. Update the documentation”After adding a new language, update the following documents.
README.md— add it to the supported language list- Supported ecosystems — add a section for the new language (follow the format of the existing language examples)
- CLI reference — add a row to the “language not detected” table in the troubleshooting section:
| Kotlin | `build.gradle.kts` + `gradle.lockfile` |6. Submit a PR
Section titled “6. Submit a PR”Submit a PR following the contributing guide. Include the following in the PR description.
- The name of the language or package manager you added
- Test run results (screenshot or log)
- A sample of the generated SBOM output
Example: adding Kotlin support
Section titled “Example: adding Kotlin support”Kotlin uses the Gradle build system and runs on the JVM, so it reuses the java branch of detect_lang() (which detects *.gradle.kts) and the Java image choice as is (by jvmToolchain(N) and the wrapper version, see Java (Gradle)).
How to generate a Gradle lock file
Section titled “How to generate a Gradle lock file”cd examples/<language>
# Add dependency locking to build.gradle.ktscat >> build.gradle.kts << 'EOF'dependencyLocking { lockAllConfigurations()}EOF
# Generate the lock file./gradlew dependencies --write-locksExpected SBOM output (partial components)
Section titled “Expected SBOM output (partial components)”{ "components": [ { "type": "library", "name": "kotlin-stdlib", "version": "1.9.21", "purl": "pkg:maven/org.jetbrains.kotlin/kotlin-stdlib@1.9.21" } ]}Kotlin shares the Maven ecosystem, so its PURL uses the pkg:maven/ prefix.
Checklist
Section titled “Checklist”Confirm every item before submitting a PR that adds a new language.
- Detection rules and image routing are added to
docker/lib/source-detect.sh. - If transitive dependency preparation is needed, it is reflected in
docker/lib/build-prep.sh. - An example project exists under
examples/{language}/. - The example project includes a lock file.
- A test block is added to
tests/test-scan.sh(or a standalonetests/test-<name>.shif the case doesn’t fit the source-scan pattern). - The full
./tests/test-scan.shrun passes. - The supported language list in
README.mdis updated. - An example section is added to the examples guide.
- The troubleshooting table in the usage guide is updated.
Related: Contributing | Architecture | Testing guide
OWASP BomLens, an OWASP Incubator Project ·Contributing
Copyright © 2026 SK Telecom Co., Ltd. ·Apache-2.0 ·Third-party licenses