49 Commits

Author SHA1 Message Date
6004f6aeb4 add windows build step, 9
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
2025-07-11 16:22:11 +02:00
3ffcf262e5 add windows build step, 8 2025-07-11 16:17:24 +02:00
550b5ff28a add windows build step, 7 2025-07-11 16:10:35 +02:00
302f4df307 add windows build step, 6 2025-07-11 16:09:15 +02:00
b8f4a3c46f add windows build step, 5 2025-07-11 16:07:54 +02:00
1cee3b5dae add windows build step, 4 2025-07-11 16:03:20 +02:00
0d28c61c0f add windows build step, 3 2025-07-11 16:01:54 +02:00
7fefc75d64 add windows build step, 2 2025-07-11 15:59:48 +02:00
e0398bd8fb add windows build step
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
2025-07-11 15:49:58 +02:00
5ff83f3af7 change artifacts 2025-07-11 15:00:30 +02:00
e85858d342 Multiple cpe experiments, failed. Add reimport feature.
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
2025-07-11 13:29:02 +02:00
6811740835 prepare local env
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
2025-07-10 16:23:46 +02:00
86ab9808d8 local build env
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
2025-07-10 14:55:34 +02:00
117a74989e hallo hier ein commit
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
2025-07-10 12:06:41 +02:00
b91a7ae0fc fix in ci script, 2
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
2025-07-09 12:18:13 +02:00
e3043c5646 fix in ci script
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
2025-07-09 11:44:18 +02:00
9afa00f61f add minimal sbom converter
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
ci/woodpecker/tag/woodpecker Pipeline was successful
2025-07-09 11:26:50 +02:00
bd92d8eb87 drop plantuml snippet
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
2025-07-09 08:43:37 +02:00
5a1d6903e8 test plantuml integration
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
2025-06-25 16:05:48 +02:00
67bab6710c documentation
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
2025-06-20 10:38:12 +02:00
f55c3da3ef solve conflicting option
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
ci/woodpecker/tag/woodpecker Pipeline was successful
2025-06-11 10:40:53 +02:00
f50d821aec verbose switch
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
ci/woodpecker/tag/woodpecker Pipeline was successful
2025-06-11 09:59:13 +02:00
609f33b181 use correct custom ca location
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
ci/woodpecker/tag/woodpecker Pipeline was successful
2025-06-11 07:40:14 +02:00
7c8e1156aa some debug
All checks were successful
ci/woodpecker/tag/woodpecker Pipeline was successful
2025-06-10 18:48:47 +02:00
226456ccd2 absolute pathes
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
ci/woodpecker/tag/woodpecker Pipeline was successful
2025-06-10 17:18:34 +02:00
227ef294d3 custom ca, 14
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
ci/woodpecker/tag/woodpecker Pipeline was successful
2025-06-04 16:14:16 +02:00
a14e0ab2c5 custom ca, 13
Some checks are pending
ci/woodpecker/tag/woodpecker Pipeline is pending
2025-06-04 16:13:14 +02:00
471fcb2177 custom ca, 12
Some checks are pending
ci/woodpecker/tag/woodpecker Pipeline is pending
2025-06-04 16:01:37 +02:00
0d4ac4022a custom ca, 11
Some checks are pending
ci/woodpecker/tag/woodpecker Pipeline is pending
2025-06-04 15:56:55 +02:00
405d66cdcb custom ca, 10
Some checks are pending
ci/woodpecker/tag/woodpecker Pipeline is pending
2025-06-04 15:53:49 +02:00
a32d9fd643 custom ca, 9
Some checks are pending
ci/woodpecker/tag/woodpecker Pipeline is pending
2025-06-04 15:51:21 +02:00
7f394f82ee custom ca, 8 2025-06-04 15:49:42 +02:00
c8577edf0c custom ca, 7
Some checks failed
ci/woodpecker/tag/woodpecker Pipeline failed
2025-06-04 15:45:06 +02:00
02aba34391 custom ca, 6
Some checks failed
ci/woodpecker/tag/woodpecker Pipeline failed
2025-06-04 15:42:15 +02:00
1fb4c387a7 custom ca, 5
Some checks are pending
ci/woodpecker/tag/woodpecker Pipeline is pending
2025-06-04 15:37:48 +02:00
92b61fdae0 custom ca, 4
Some checks are pending
ci/woodpecker/tag/woodpecker Pipeline is pending
2025-06-04 15:35:23 +02:00
4ddb6cfd30 custom ca, 3
Some checks are pending
ci/woodpecker/tag/woodpecker Pipeline is pending
2025-06-04 15:33:14 +02:00
0eb761db27 custom ca, 2
Some checks are pending
ci/woodpecker/tag/woodpecker Pipeline is pending
2025-06-04 15:31:14 +02:00
9cc81373dc custom ca
Some checks are pending
ci/woodpecker/tag/woodpecker Pipeline is pending
2025-06-04 15:24:15 +02:00
b856424640 factorize stages
Some checks are pending
ci/woodpecker/tag/woodpecker Pipeline is pending
2025-06-04 15:08:00 +02:00
d6a8f5f436 urls in variables 2025-06-04 15:01:52 +02:00
4cc4e5cec6 dockerize goal, 8
Some checks are pending
ci/woodpecker/tag/woodpecker Pipeline is pending
2025-06-04 14:56:11 +02:00
aec0e3fb0e dockerize goal, 7
Some checks are pending
ci/woodpecker/tag/woodpecker Pipeline is pending
2025-06-04 14:03:39 +02:00
05c5c49cd5 dockerize goal, 6
All checks were successful
ci/woodpecker/tag/woodpecker Pipeline was successful
2025-06-04 14:00:46 +02:00
9156b594e3 dockerize goal, 5
Some checks are pending
ci/woodpecker/push/woodpecker Pipeline was successful
ci/woodpecker/tag/woodpecker Pipeline is pending
2025-06-04 13:48:19 +02:00
4fbda91e15 dockerize goal, 4
Some checks are pending
ci/woodpecker/tag/woodpecker Pipeline is pending
2025-06-04 13:46:16 +02:00
50248acefb dockerize goal, 3
Some checks are pending
ci/woodpecker/tag/woodpecker Pipeline is pending
2025-06-04 13:40:05 +02:00
c9c57445b9 dockerize goal, 2
Some checks are pending
ci/woodpecker/tag/woodpecker Pipeline is pending
2025-06-04 13:37:56 +02:00
18631dc02a dockerize goal
Some checks are pending
ci/woodpecker/tag/woodpecker Pipeline is pending
2025-06-04 13:34:45 +02:00
13 changed files with 496 additions and 174 deletions

1
.gitignore vendored
View File

@ -4,4 +4,5 @@ defs/
__pycache__/ __pycache__/
.*.swp .*.swp
tmp/ tmp/
locallibs

View File

@ -1,27 +1,40 @@
stages: stages:
- generate-api-clients - generate-api-clients
- build
variables: variables:
REGISTRY: devnexus.krohne.com:18079/repository/docker-krohne REGISTRY: devnexus.krohne.com:18079/repository/docker-krohne
IMAGE_NAME: $REGISTRY/$CI_PROJECT_NAME IMAGE_NAME: $REGISTRY/$CI_PROJECT_NAME
DTRACK_API_URL: https://dtrack-api-rd.krohne.com
DEFECTDOJO_API_URL: https://defectdojo-rd.krohne.com
KROHNE_CA_URL: https://devwiki.krohnegroup.com/lib/exe/fetch.php?media=krohne-ca.crt
KROHNE_CA_CHECKSUM: a921e440a742f1e67c7714306e2c0d76
.generate-api:
generate-dtrack-api:
stage: generate-api-clients stage: generate-api-clients
image: openapitools/openapi-generator-cli:v7.12.0 image: openapitools/openapi-generator-cli:v7.12.0
tags: tags:
- linux - linux
- docker - docker
- bash - bash
only: rules:
refs: - if: '$CI_COMMIT_BRANCH == "main"'
- main - if: '$CI_COMMIT_TAG'
before_script:
- curl --insecure $KROHNE_CA_URL -o krohne-ca.crt
- echo "$KROHNE_CA_CHECKSUM krohne-ca.crt" | md5sum -c
- mv krohne-ca.crt /usr/local/share/ca-certificates
- update-ca-certificates
generate-dtrack-api:
extends: .generate-api
artifacts: artifacts:
paths: paths:
- dtrack-api-client.tgz - dependencytrack-client
expire_in: 1 week expire_in: 1 week
script: script:
- curl https://dtrack-api.hottis.de/api/openapi.json > dependencytrack-openapi.json - curl ${DTRACK_API_URL}/api/openapi.json > dependencytrack-openapi.json
- | - |
docker-entrypoint.sh \ docker-entrypoint.sh \
author template \ author template \
@ -37,25 +50,16 @@ generate-dtrack-api:
-o dependencytrack-client \ -o dependencytrack-client \
--package-name dependencytrack_api \ --package-name dependencytrack_api \
-t dependencytrack-openapi-custom-template -t dependencytrack-openapi-custom-template
- tar -czvf dtrack-api-client.tgz dependencytrack-client
generate-defectdojo-api: generate-defectdojo-api:
stage: generate-api-clients extends: .generate-api
image: openapitools/openapi-generator-cli:v7.12.0
tags:
- linux
- docker
- bash
only:
refs:
- main
artifacts: artifacts:
paths: paths:
- defectdojo-api-client.tgz - defectdojo-client
expire_in: 1 week expire_in: 1 week
script: script:
- curl https://defectdojo.hottis.de/api/v2/oa3/schema/?format=json > defectdojo-openapi.json - curl ${DEFECTDOJO_API_URL}/api/v2/oa3/schema/?format=json > defectdojo-openapi.json
- | - |
docker-entrypoint.sh \ docker-entrypoint.sh \
generate \ generate \
@ -63,77 +67,51 @@ generate-defectdojo-api:
-g python \ -g python \
-o defectdojo-client \ -o defectdojo-client \
--package-name defectdojo_api --package-name defectdojo_api
- tar -czvf defectdojo-api-client.tgz defectdojo-client
dockerize:
stage: build
image: devnexus.krohne.com:18079/repository/docker-krohne/krohnedockerbash:0.5
tags:
- linux
- docker
- bash
rules:
- if: '$CI_COMMIT_TAG'
script:
- docker build --build-arg ADDITIONAL_CA_URL="$KROHNE_CA_URL"
--build-arg ADDITIONAL_CA_CHECKSUM=$KROHNE_CA_CHECKSUM
--tag $IMAGE_NAME:latest
--tag $IMAGE_NAME:$CI_COMMIT_SHA
--tag $IMAGE_NAME:$CI_COMMIT_TAG
.
- docker login -u $NEXUS_USER -p $NEXUS_PASSWORD $REGISTRY
- docker push $IMAGE_NAME:latest
- docker push $IMAGE_NAME:$CI_COMMIT_SHA
- docker push $IMAGE_NAME:$CI_COMMIT_TAG
build-windows-binary:
stage: build
tags:
- windows
- pwsh
- python3.13
rules:
- if: '$CI_COMMIT_TAG'
artifacts:
paths:
- sbom-dt-dd.exe
script:
- |
cd src
mv ..\dependencytrack-client .
mv ..\defectdojo-client .
& 'C:\Program Files\Python313\python.exe' -m venv venv
.\venv\Scripts\pip.exe install --upgrade pip
.\venv\Scripts\pip.exe install -r requirements.txt
.\venv\Scripts\pip.exe install -r dependencytrack-client\requirements.txt
.\venv\Scripts\pip.exe install -r defectdojo-client\requirements.txt
.\venv\Scripts\pip.exe install pyinstaller
.\venv\Scripts\pyinstaller.exe --onefile --add-data "dependencytrack-client;dependencytrack-client" --add-data "defectdojo-client;defectdojo-client" sbom-dt-dd.py
mv dist\sbom-dt-dd.exe ..
# steps:
# generate-dtrack-api:
# image: openapitools/openapi-generator-cli:v7.12.0
# commands:
# - curl https://dtrack-api.hottis.de/api/openapi.json > dependencytrack-openapi.json
# - |
# docker-entrypoint.sh \
# author template \
# -g python \
# -o dependencytrack-openapi-custom-template
# - sed -i 's/import re/import regex as re/' dependencytrack-openapi-custom-template/model_anyof.mustache
# - sed -i 's/import re/import regex as re/' dependencytrack-openapi-custom-template/model_generic.mustache
# - |
# docker-entrypoint.sh \
# generate \
# -i dependencytrack-openapi.json \
# -g python \
# -o dependencytrack-client \
# --package-name dependencytrack_api \
# -t dependencytrack-openapi-custom-template
# when:
# - event: [ push, tag ]
#
# generate-defectdojo:
# image: openapitools/openapi-generator-cli:v7.12.0
# commands:
# - curl https://defectdojo.hottis.de/api/v2/oa3/schema/?format=json > defectdojo-openapi.json
# - |
# docker-entrypoint.sh \
# generate \
# -i defectdojo-openapi.json \
# -g python \
# -o defectdojo-client \
# --package-name defectdojo_api \
# when:
# - event: [ push, tag ]
#
# build:
# image: plugins/kaniko
# settings:
# repo: ${FORGE_NAME}/${CI_REPO}
# registry:
# from_secret: container_registry
# tags: latest,${CI_COMMIT_SHA},${CI_COMMIT_TAG}
# username:
# from_secret: container_registry_username
# password:
# from_secret: container_registry_password
# dockerfile: Dockerfile
# when:
# - event: [ push, tag ]
#
# build-for-quay:
# image: plugins/kaniko
# settings:
# repo: quay.io/wollud1969/${CI_REPO_NAME}
# registry: quay.io
# tags:
# - latest
# - ${CI_COMMIT_TAG}
# username:
# from_secret: quay_username
# password:
# from_secret: quay_password
# dockerfile: Dockerfile
# when:
# - event: [tag]
#

View File

@ -41,14 +41,16 @@ steps:
repo: ${FORGE_NAME}/${CI_REPO} repo: ${FORGE_NAME}/${CI_REPO}
registry: registry:
from_secret: container_registry from_secret: container_registry
tags: latest,${CI_COMMIT_SHA},${CI_COMMIT_TAG} tags:
- latest
- ${CI_COMMIT_SHA}
username: username:
from_secret: container_registry_username from_secret: container_registry_username
password: password:
from_secret: container_registry_password from_secret: container_registry_password
dockerfile: Dockerfile dockerfile: Dockerfile
when: when:
- event: [ push, tag ] - event: [ push ]
build-for-quay: build-for-quay:
image: plugins/kaniko image: plugins/kaniko

View File

@ -6,18 +6,33 @@ ENV DEFECTDOJO_URL=""
ENV DEFECTDOJO_TOKEN="" ENV DEFECTDOJO_TOKEN=""
ARG APP_DIR=/opt/app ARG APP_DIR=/opt/app
ARG ADDITIONAL_CA_URL="x"
ARG ADDITIONAL_CA_CHECKSUM="y"
RUN \ RUN \
set -e &&\
apk add --no-cache syft &&\ apk add --no-cache syft &&\
adduser -s /bin/sh -D user &&\ adduser -s /bin/sh -D user &&\
mkdir -p $APP_DIR &&\ mkdir -p $APP_DIR &&\
chown user:user $APP_DIR chown user:user $APP_DIR &&\
echo $ADDITIONAL_CA_URL &&\
echo $ADDITIONAL_CA_CHECKSUM &&\
if [ "$ADDITIONAL_CA_URL" != "x" ]; then \
cd /usr/local/share/ca-certificates; \
wget --no-check-certificate -O custom-ca.crt $ADDITIONAL_CA_URL; \
echo "$ADDITIONAL_CA_CHECKSUM custom-ca.crt" | md5sum -c; \
/usr/sbin/update-ca-certificates; \
echo "custom ca added"; \
else \
echo "no additional ca"; \
fi
USER user USER user
WORKDIR $APP_DIR WORKDIR $APP_DIR
COPY src/requirements.txt . COPY src/requirements.txt .
COPY src/sbom-dt-dd.py . COPY src/sbom-dt-dd.py .
COPY src/converter.py .
COPY src/entrypoint.sh . COPY src/entrypoint.sh .
COPY dependencytrack-client/ ./dependencytrack-client COPY dependencytrack-client/ ./dependencytrack-client
COPY defectdojo-client/ ./defectdojo-client COPY defectdojo-client/ ./defectdojo-client

100
readme.md
View File

@ -1,6 +1,96 @@
# Python Client Packages for the DependencyTrack and DefectDojo API # DependencyTrack and DefectDojo Automation
## Download the OpenAPI definitions
## Using
### Distribution
The glue logic comes in a docker image and can be started as a docker container. Due to the dependencies, especially the ones related to the
APIs of DependencyTrack and DefectDojo this approach has been chosen.
The image is available at
```
quay.io/wollud1969/dtrack-defectdojo-automation
```
and at
```
devnexus.krohne.com:18079/repository/docker-krohne/dtrack-defectdojo-automation
```
The tag to be used at the moment is `1.0.5`.
### Start script
On Linux I've created two files to start the beast:
env-sbom-dd-dt
```
DTRACK_API_URL=https://dtrack-api-rd.krohne.com
DEFECTDOJO_URL=https://defectdojo-rd.krohne.com
DTRACK_TOKEN=...
DEFECTDOJO_TOKEN=...
```
The correct values for the tokens must be set here, obviously.
sbom-dd-dt.sh
```
#!/bin/bash
docker run -t -v $PWD:/work --rm --env-file ~/env-sbom-dt-dd devnexus.krohne.com:18079/repository/docker-krohne/dtrack-defectdojo-automation:1.0.5 "$@"
```
I've both files directly in my home-dir.
### File locations
When using the container and the script, you must consider that the container has no full access to your filesystem and you need to mount required parts of your filesystem into the container. In the above script I do this with the option `-v $PWD:/work`. This option mounts the current directory (the one from where you are starting the script and thus the container) into the directory `/work` within the container.
This is required when scanning a directory or uploading a prepared SBOM file.
### Options of the container/script
The container has the glue logic script as entrypoint. To find out about the options, call
```
dehottgw@DE01RDDEV01:~$ docker run -t -v $PWD:/work --rm --env-file ~/env-sbom-dt-dd devnexus.krohne.com:18079/repository/docker-krohne/dtrack-defectdojo-automation:1.0.5 -- -h
usage: sbom-dt-dd.py [-h] --name NAME --version VERSION --description DESCRIPTION --type TYPE --classifier
{APPLICATION,FRAMEWORK,LIBRARY,CONTAINER,OPERATING_SYSTEM,DEVICE,FIRMWARE,FILE,PLATFORM,DEVICE_DRIVER,MACHINE_LEARNING_MODEL,DATA}
[--uploadsbom] [--sbomfile SBOMFILE] [--target TARGET] [--verbose]
sbom-dt-dd.py: error: the following arguments are required: --name/-n, --version/-v, --description/-d, --type/-t, --classifier/-c
dehottgw@DE01RDDEV01:~$
```
Note the double-dash at the end of the commandline before the `-h`. It is necessary, otherwise the `-h` would be considered as an option for the docker command itself.
### SBOM upload example
For this example I've a file `combined-sbom.json` in the directory `software1`:
```
cd software1/
~/sbom-dt-dd.sh --name software1-server --version 0.0.1 --description "Server software for the Software1 platform" --type 1 --classifier APPLICATION --uploadsbom --sbomfile /work/combined-sbom.json -V
```
## Building
### Python Client Packages for the DependencyTrack and DefectDojo API
#### Download the OpenAPI definitions
``` ```
curl https://dtrack-api.hottis.de/api/openapi.json \ curl https://dtrack-api.hottis.de/api/openapi.json \
@ -10,7 +100,7 @@ curl https://defectdojo.hottis.de/api/v2/oa3/schema/?format=json \
``` ```
## Naive Generation of the Client Package for DefectDojo #### Naive Generation of the Client Package for DefectDojo
``` ```
docker run \ docker run \
@ -28,7 +118,7 @@ docker run \
For DefectDojo the naive code generation works. For DefectDojo the naive code generation works.
## Naive Generation of the Client Package for DependencyTrack #### Naive Generation of the Client Package for DependencyTrack
``` ```
docker run \ docker run \
@ -43,7 +133,7 @@ docker run \
--package-name dependencytrack_api --package-name dependencytrack_api
``` ```
## Fixed Generation of the Client Package for DependencyTrack #### Fixed Generation of the Client Package for DependencyTrack
In the OpenAPI definition of DependencyTrack a regex is used which is not understood by Python's In the OpenAPI definition of DependencyTrack a regex is used which is not understood by Python's
default regex implement `re`, which in turn is hardwired in the openapi-generator provided code. default regex implement `re`, which in turn is hardwired in the openapi-generator provided code.

10
src/ENV-krohne.asc Normal file
View File

@ -0,0 +1,10 @@
-----BEGIN PGP MESSAGE-----
jA0ECQMC0qbzN9I9kGP/0sAlARybIFvSNy12iziCC4waAcAPBvvvVrutjyIYtaV1
z9WeoBv7TlHB9aKAgxj8LuSh44iDH6uz9FvZfYcZ2BpC9PQYr5IkIw9+iqq9hODM
P90Kr9CPazMR8BQUb+4iJjNlHKJL1HCYaFnSHdquzCD4KGqUkkRPPt4Oj/5baJVi
kfhU6bKuM6rarcVL0ebSbc2jUIEaugXhnvEWRTiAfOE8v6o7CneoK5hdMbhVA1iC
j3sVIcCWgfgMOGDfL2P8DCr7GsGoOxMXvfsPZZL1BRNIf8WXWGpml/TA5Q1vw8TM
z8l6SIHklQ==
=T8wW
-----END PGP MESSAGE-----

5
src/ENV-python Normal file
View File

@ -0,0 +1,5 @@
export PYTHONPATH=./locallibs/defectdojo-client:./locallibs/dependencytrack-client

117
src/converter.py Normal file
View File

@ -0,0 +1,117 @@
from loguru import logger
import yaml
import uuid
from packageurl import PackageURL
from cyclonedx.builder.this import this_component as cdx_lib_component
from cyclonedx.factory.license import LicenseFactory
from cyclonedx.model.bom import Bom
from cyclonedx.model.component import Component, ComponentType
from cyclonedx.model.contact import OrganizationalEntity
from cyclonedx.model import XsUri
from cyclonedx.model import ExternalReference
from cyclonedx.output.json import JsonV1Dot5
class MyLocalConverterException(Exception): pass
def __converterClassifierToComponentType(classifier):
componentType = ''
match classifier:
case 'APPLICATION':
componentType = ComponentType.APPLICATION
case 'FRAMEWORK':
componentType = ComponentType.FRAMEWORK
case 'LIBRARY':
componentType = ComponentType.LIBRARY
case 'CONTAINER':
componentType = ComponentType.CONTAINER
case 'OPERATING_SYSTEM':
componentType = ComponentType.OPERATING_SYSTEM
case 'DEVICE':
componentType = ComponentType.DEVICE
case 'FIRMWARE':
componentType = ComponentType.FIRMWARE
case 'FILE':
componentType = ComponentType.FILE
case 'PLATFORM':
componentType = ComponentType.PLATFORM
case 'DEVICE_DRIVER':
componentType = ComponentType.DEVICE_DRIVER
case 'MACHINE_LEARNING_MODEL':
componentType = ComponentType.MACHINE_LEARNING_MODEL
case 'DATA':
componentType = ComponentType.DATA
case _:
raise MyLocalConverterException(f"No componentType for {classifier} found")
return componentType
def minimalSbomFormatConverter(minimalSbom, classifier):
logger.info(f"Minimal input: {minimalSbom}")
lc_factory = LicenseFactory()
minimalSbomObject = yaml.safe_load(minimalSbom)
logger.debug(f"{minimalSbomObject=}")
bom = Bom(
version=minimalSbomObject['sbomVersion']
)
bom.metadata.tools.components.add(cdx_lib_component())
bom.metadata.tools.components.add(Component(
name='sbom-dt-dd',
type=ComponentType.APPLICATION
))
bom.metadata.component = root_component = Component(
name=minimalSbomObject['product'],
type=__converterClassifierToComponentType(minimalSbomObject['classifier']),
description=minimalSbomObject['description'],
version=minimalSbomObject['version'],
licenses=[lc_factory.make_from_string(minimalSbomObject['license'])],
supplier=OrganizationalEntity(
name=minimalSbomObject['supplier']['name'],
urls=[XsUri(minimalSbomObject['supplier']['url'])]
),
bom_ref = f"urn:uuid:{uuid.uuid4()}"
)
component = Component(
type=__converterClassifierToComponentType(minimalSbomObject['classifier']),
name=f"{minimalSbomObject['supplier']['name']}´s own code",
version=minimalSbomObject['version'],
licenses=[lc_factory.make_from_string(minimalSbomObject['license'])],
supplier=OrganizationalEntity(
name=minimalSbomObject['supplier']['name'],
urls=[XsUri(minimalSbomObject['supplier']['url'])]
),
bom_ref = f"urn:uuid:{uuid.uuid4()}"
)
bom.components.add(component)
bom.register_dependency(root_component, [component])
for minimalComponentDescription in minimalSbomObject['components']:
component = Component(
type=ComponentType.LIBRARY,
name=minimalComponentDescription['name'],
version=minimalComponentDescription['version'],
licenses=[lc_factory.make_from_string(minimalComponentDescription['license'])],
bom_ref = f"urn:uuid:{uuid.uuid4()}"
)
if 'cpe' in minimalComponentDescription:
component.cpe = minimalComponentDescription['cpe']
if 'purl' in minimalComponentDescription:
component.purl = PackageURL.from_string(minimalComponentDescription['purl'])
bom.components.add(component)
bom.register_dependency(root_component, [component])
outputSbom = JsonV1Dot5(bom).output_as_string(indent=2)
logger.info(outputSbom)
with open('/tmp/bom.json', 'w') as f:
f.write(outputSbom)
return (outputSbom, minimalSbomObject['product'], minimalSbomObject['version'], minimalSbomObject['classifier'], minimalSbomObject['description'])

View File

@ -1,11 +1,11 @@
#!/bin/sh #!/bin/sh
# entrypoint.sh # entrypoint.sh
source ./.venv/bin/activate source /opt/app/.venv/bin/activate
PYTHONPATH="$PYTHONPATH:./dependencytrack-client" PYTHONPATH="$PYTHONPATH:/opt/app/dependencytrack-client"
PYTHONPATH="$PYTHONPATH:./defectdojo-client" PYTHONPATH="$PYTHONPATH:/opt/app/defectdojo-client"
export PYTHONPATH export PYTHONPATH
exec python sbom-dt-dd.py "$@" exec python /opt/app/sbom-dt-dd.py "$@"

47
src/prepare-local-env.sh Executable file
View File

@ -0,0 +1,47 @@
#!/bin/bash
set -e
. ./ENV
LOCALLBIS=./locallibs
OPENAPI_GENERATOR=openapitools/openapi-generator-cli:v7.12.0
mkdir $LOCALLBIS && cd $LOCALLBIS
# --- DependencyTrack Client Library -----------------------------------------------------
curl ${DTRACK_API_URL}/api/openapi.json >dependencytrack-openapi.json
docker run -v $PWD:/work -u $UID $OPENAPI_GENERATOR \
author template \
-g python \
-o /work/dependencytrack-openapi-custom-template
sed -i -e 's/import re/import regex as re/' dependencytrack-openapi-custom-template/model_anyof.mustache
sed -i -e 's/import re/import regex as re/' dependencytrack-openapi-custom-template/model_generic.mustache
docker run -v $PWD:/work -u $UID $OPENAPI_GENERATOR \
generate \
-i /work/dependencytrack-openapi.json \
-g python \
-o /work/dependencytrack-client \
--package-name dependencytrack_api \
-t /work/dependencytrack-openapi-custom-template
# --- Defectdojo Client Library ----------------------------------------------------------
curl ${DEFECTDOJO_URL}/api/v2/oa3/schema/?format=json >defectdojo-openapi.json
docker run -v $PWD:/work -u $UID $OPENAPI_GENERATOR \
generate \
-i /work/defectdojo-openapi.json \
-g python \
-o /work/defectdojo-client \
--package-name defectdojo_api
cd ..
python3 -m venv .venv
. .venv/bin/activate
pip install -r requirements.txt
pip install -r $LOCALLBIS/dependencytrack-client/requirements.txt
pip install -r $LOCALLBIS/defectdojo-client/requirements.txt

View File

@ -1,3 +1,5 @@
regex==2024.11.6 regex==2024.11.6
loguru==0.7.3 loguru==0.7.3
PyYAML==6.0.2
cyclonedx-python-lib==10.4.1

View File

@ -4,19 +4,28 @@ import argparse
import subprocess import subprocess
import json import json
import defectdojo_api
from defectdojo_api.rest import ApiException as DefectDojoApiException
import datetime import datetime
from dateutil.relativedelta import relativedelta from dateutil.relativedelta import relativedelta
sys.path.insert(0, os.path.join(os.path.dirname(__file__), 'defectdojo-client'))
sys.path.insert(0, os.path.join(os.path.dirname(__file__), 'dependencytrack-client'))
import defectdojo_api
from defectdojo_api.rest import ApiException as DefectDojoApiException
import dependencytrack_api import dependencytrack_api
from dependencytrack_api.rest import ApiException as DependencyTrackApiException from dependencytrack_api.rest import ApiException as DependencyTrackApiException
from converter import minimalSbomFormatConverter
class MyLocalException(Exception): pass class MyLocalException(Exception): pass
def executeApiCall(apiClient, ApiClass, EndpointMethod, RequestClass, requestParams, additionalParams=[]): def executeApiCall(apiClient, ApiClass, EndpointMethod, RequestClass, requestParams, additionalParams=[]):
try: try:
logger.info(f"Calling {ApiClass}.{EndpointMethod} with {RequestClass} ({additionalParams}, {requestParams})") logger.info(f"Calling {ApiClass=}.{EndpointMethod=} with {RequestClass=})")
if VERBOSE:
logger.debug(f"{additionalParams=}, {requestParams=}")
instance = ApiClass(apiClient) instance = ApiClass(apiClient)
if RequestClass: if RequestClass:
request = RequestClass(**requestParams) request = RequestClass(**requestParams)
@ -58,13 +67,16 @@ except KeyError as e:
parser = argparse.ArgumentParser(description='sbom-dt-dd glue logic') parser = argparse.ArgumentParser(description='sbom-dt-dd glue logic')
parser.add_argument('--name', '-n', parser.add_argument('--name', '-n',
help='Project Name', help='Project Name',
required=True) required=False,
default=''),
parser.add_argument('--version', '-v', parser.add_argument('--version', '-v',
help='Project Version', help='Project Version',
required=True) required=False,
default='')
parser.add_argument('--description', '-d', parser.add_argument('--description', '-d',
help='Project Description', help='Project Description',
required=True) required=False,
default='')
parser.add_argument('--type', '-t', parser.add_argument('--type', '-t',
help='Product Type from DefectDojo', help='Product Type from DefectDojo',
type=int, type=int,
@ -73,7 +85,8 @@ parser.add_argument('--classifier', '-c',
help='Project Classifier from DependencyTrack', help='Project Classifier from DependencyTrack',
choices=['APPLICATION', 'FRAMEWORK', 'LIBRARY', 'CONTAINER', 'OPERATING_SYSTEM', 'DEVICE', choices=['APPLICATION', 'FRAMEWORK', 'LIBRARY', 'CONTAINER', 'OPERATING_SYSTEM', 'DEVICE',
'FIRMWARE', 'FILE', 'PLATFORM', 'DEVICE_DRIVER', 'MACHINE_LEARNING_MODEL', 'DATA'], 'FIRMWARE', 'FILE', 'PLATFORM', 'DEVICE_DRIVER', 'MACHINE_LEARNING_MODEL', 'DATA'],
required=True) required=False,
default='')
parser.add_argument('--uploadsbom', '-U', parser.add_argument('--uploadsbom', '-U',
help='Upload a already existing SBOM instead of generating it. Give the SBOM file at -F instead of a target', help='Upload a already existing SBOM instead of generating it. Give the SBOM file at -F instead of a target',
required=False, required=False,
@ -82,22 +95,50 @@ parser.add_argument('--uploadsbom', '-U',
parser.add_argument('--sbomfile', '-F', parser.add_argument('--sbomfile', '-F',
help='Filename of existing SBOM file to upload, use together with -U, do not use together with -T', help='Filename of existing SBOM file to upload, use together with -U, do not use together with -T',
required=False) required=False)
parser.add_argument('--minimalsbomformat', '-K',
help='SBOM file comes in dedicated minimal format and will be converted into cyclonedx before uploading',
action='store_true',
default=False)
parser.add_argument('--overwritemetadata', '-O',
help='Overwrite name, version, description and classifier with data from minimal SBOM',
action='store_true',
default=False)
parser.add_argument('--target', '-T', parser.add_argument('--target', '-T',
help='Target to scan, either path name for sources or docker image tag', help='Target to scan, either path name for sources or docker image tag',
required=False) required=False)
parser.add_argument('--reimport', '-R',
help='Import the SBOM for an existing project/product once again',
required=False,
action='store_true',
default=False)
parser.add_argument('--verbose', '-V',
help='A lot of debug output',
required=False,
action='store_true',
default=False)
args = parser.parse_args() args = parser.parse_args()
projectName = args.name projectName = args.name
projectVersion = args.version projectVersion = args.version
projectDescription = args.description projectDescription = args.description
productType = args.type productType = args.type
projectClassifier = args.classifier projectClassifier = args.classifier
reImport = args.reimport
uploadSbomFlag = args.uploadsbom uploadSbomFlag = args.uploadsbom
if uploadSbomFlag: if uploadSbomFlag:
sbomFileName = args.sbomfile sbomFileName = args.sbomfile
minimalSbomFormat = args.minimalsbomformat
else: else:
target = args.target target = args.target
if minimalSbomFormat:
overwriteMetadata = args.overwritemetadata
if not overwriteMetadata and not (projectName and projectVersion and projectClassifier and projectDescription):
raise MyLocalException("If overwriteMetadata is not selected, projectName, projectVersion, projectClassifier and projectDescription must be set.")
VERBOSE = args.verbose
# ---- main starts here -------------------------------------------------------------------------------------------------- # ---- main starts here --------------------------------------------------------------------------------------------------
@ -106,6 +147,16 @@ if uploadSbomFlag:
logger.info(f"Reading SBOM from file {sbomFileName}") logger.info(f"Reading SBOM from file {sbomFileName}")
with open(sbomFileName, 'r') as sbomFile: with open(sbomFileName, 'r') as sbomFile:
sbom = sbomFile.read() sbom = sbomFile.read()
logger.info("SBOM file read.")
if minimalSbomFormat:
logger.info("Start converting from minimal format into cyclonedx")
(sbom, nameFromMinimalSbom, versionFromMinimalSbom, classifierFromMinimalSbom, descriptionFromMinimalSbom) = minimalSbomFormatConverter(sbom, projectClassifier)
logger.info("Converted")
if overwriteMetadata:
projectName = nameFromMinimalSbom
projectVersion = versionFromMinimalSbom
projectClassifier = classifierFromMinimalSbom
projectDescription = descriptionFromMinimalSbom
logger.info("Done.") logger.info("Done.")
else: else:
# ------- generate SBOM ------------ # ------- generate SBOM ------------
@ -117,13 +168,15 @@ else:
# ------- create product and engagement in DefectDojo ------- # ------- create product and engagement in DefectDojo -------
defectdojo_configuration = defectdojo_api.Configuration( if not reImport:
# in case of a reimport no modification on DefectDojo are required
defectdojo_configuration = defectdojo_api.Configuration(
host = DEFECTDOJO_URL host = DEFECTDOJO_URL
) )
defectdojo_configuration.api_key['tokenAuth'] = DEFECTDOJO_TOKEN defectdojo_configuration.api_key['tokenAuth'] = DEFECTDOJO_TOKEN
defectdojo_configuration.api_key_prefix['tokenAuth'] = 'Token' defectdojo_configuration.api_key_prefix['tokenAuth'] = 'Token'
with defectdojo_api.ApiClient(defectdojo_configuration) as defectdojo_api_client: with defectdojo_api.ApiClient(defectdojo_configuration) as defectdojo_api_client:
print("Create product in DefectDojo") print("Create product in DefectDojo")
productName = f"{projectName}:{projectVersion}" productName = f"{projectName}:{projectVersion}"
product_response = \ product_response = \
@ -165,6 +218,8 @@ dependencytrack_configuration.debug = False
dependencytrack_configuration.api_key['ApiKeyAuth'] = DTRACK_TOKEN dependencytrack_configuration.api_key['ApiKeyAuth'] = DTRACK_TOKEN
with dependencytrack_api.ApiClient(dependencytrack_configuration) as dependencytrack_api_client: with dependencytrack_api.ApiClient(dependencytrack_configuration) as dependencytrack_api_client:
if not reImport:
# in case of a reimport it is not necessary to create the project
project_response = \ project_response = \
executeApiCall( executeApiCall(
dependencytrack_api_client, dependencytrack_api_client,