Refactor openvasd #1972

nichtsfrei · 2025-08-14T14:53:33Z

This refactors openvasd to use:

SQLite
greenbone-scanner-framework
And adds:
container-image-scanner functionality as a new endpoint localhost:3000/container-image-scanner/

TODO:

internal scanner needs to be implemented
lint issues needs to be fixed
code duplication needs to be reduced
workspace dependencies instead of each one separately in crates

Adds the greenbone-scanner-framework to enable us to remodel openvasd. Chore: move vts to new greenbone-scanner-framework system Chore: migrate notus endpoints to gsf

Instead of returning a boolean the construct to verify if the scan_id is known by the client it now returns an Option<String>. That way the implementing interfaces don't need client_id and scan_id but just that internal id.

This adds a new scanner on the subroute: `container-image-scanner`. Meaning the scans API is additionally available under e.g. `curl localhost:3000/container-image-scanner/scans'

In environments that don't have a docker environment available we download the images and extract them via download-frozen-image-v2.sh. This bash script is based on: https://raw.githubusercontent.com/moby/moby/refs/heads/master/contrib/download-frozen-image-v2.sh

Instead of having to define a duration like ```toml [check_interval] secs = 0 nanos = 500000000 ``` you can additionally define it as ```toml check_interval = "500ms" ``` Which makes the configuration less polluted and easier to read.

This allows us to configure some packages to be quieter than others: ```toml [logging] level = 'INFO' [logging.additional] sqlx = 'WARN' ``` This sets the overall logging level to INFO but sqlx to WARN.

nichtsfrei requested a review from a team as a code owner August 14, 2025 14:53

nichtsfrei marked this pull request as draft August 14, 2025 15:00

nichtsfrei force-pushed the refactor-openvasd branch 2 times, most recently from 3f4272a to 736d1df Compare August 15, 2025 05:04

nichtsfrei added 24 commits August 15, 2025 05:28

Chore: move to greenbone-scanner-framework

1cbace9

Adds the greenbone-scanner-framework to enable us to remodel openvasd. Chore: move vts to new greenbone-scanner-framework system Chore: migrate notus endpoints to gsf

Chore: migrate post_scans

ceb05c5

Chore: change contains id to mapped it

8cc96b2

Instead of returning a boolean the construct to verify if the scan_id is known by the client it now returns an Option<String>. That way the implementing interfaces don't need client_id and scan_id but just that internal id.

Chore: migrate get_scans to gsf

d42ce69

Chore: implement MapScanID

7f9cc28

Chore: implement get_scans_id

abb053a

Chore: unified models

3f017e0

Chore: migrated scan scheduler

20cbfa2

Chore: migrated openvas and osp scanner to openvasd

0da9f4e

Chore: warn of failed scans only when there are ones

b76b44b

Chore: migrated get_scans_id_status

057a71a

Chore: implement results and openvas scanner type

88c93a3

Add: container-image-scanner functionality

ca1da46

This adds a new scanner on the subroute: `container-image-scanner`. Meaning the scans API is additionally available under e.g. `curl localhost:3000/container-image-scanner/scans'

Chore: feed version reflected on HEAD

d8f6193

Chore: change Notus from HTTP to internal direct use

ad8b178

Add: duration parser into openvasd config

f984e83

Instead of having to define a duration like ```toml [check_interval] secs = 0 nanos = 500000000 ``` you can additionally define it as ```toml check_interval = "500ms" ``` Which makes the configuration less polluted and easier to read.

Chore: made it possible to set packages to another log level

3925e16

This allows us to configure some packages to be quieter than others: ```toml [logging] level = 'INFO' [logging.additional] sqlx = 'WARN' ``` This sets the overall logging level to INFO but sqlx to WARN.

Chore: add container-image-scanner configuration to openvasd#config

b2ed525

Chore: add sqlite db configuration to openvasd config

8067fb7

Chore: adapt config.example.toml to new duration option

f53a2b7

Chore: remove openvasdold

db8e6df

Chore: fixes import on test

0b89882

Chore: cargo clippy --fix

0f81ddd

nichtsfrei force-pushed the refactor-openvasd branch from 736d1df to 0f81ddd Compare August 15, 2025 05:57

github-actions bot added the minor_release creates a minor release label Aug 15, 2025

github-actions bot added minor_release creates a minor release and removed minor_release creates a minor release labels Aug 26, 2025

Rename weird type

69fb71c

github-actions bot added minor_release creates a minor release and removed minor_release creates a minor release labels Aug 26, 2025

Chore: fmt

643f166

github-actions bot added minor_release creates a minor release and removed minor_release creates a minor release labels Aug 26, 2025

Rename typo'd variable

cfe7b0e