Skip to content

Commit 3fd9ebd

Browse files
Heiko KieselWeltraumschaf
authored andcommitted
Add architecture decision for OpenVAS
Signed-off-by: Heiko Kiesel <heiko.kiesel@iteratec.com>
1 parent 24b7efb commit 3fd9ebd

1 file changed

Lines changed: 55 additions & 0 deletions

File tree

  • documentation/docs/architecture/09_architecture_decisions
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
# SPDX-FileCopyrightText: the secureCodeBox authors
3+
#
4+
# SPDX-License-Identifier: Apache-2.0
5+
6+
title: "ADR-0019: OpenVAS Integration"
7+
sidebar_label: "ADR-0019"
8+
---
9+
# ADR-0019: OpenVAS Integration
10+
11+
| <!-- --> | <!-- --> |
12+
|----------------|----------------------------------------------------|
13+
| **Status**: | DRAFT |
14+
| **Date**: | 2023-09-14 |
15+
| **Author(s)**: | Heiko Kiesel <heiko.kiesel@iteratec.com> |
16+
17+
## Context
18+
19+
In the past, there were multiple requests for an OpenVAS integration (e.g., [#1642]). OpenVAS is an all-in-one solution, consisting of a scanner, database, frontend dashboard, and so on. Its architecture is shown in detail on their [OpenVAS architecture] page.
20+
21+
The scanner uses the NASL Attack Scripting Language to implement vulnerability tests. These tests are fetched periodically from the free Greenbone Community Feed or the paid Greenbone Enterprise Feed. These feeds combine Network Vulnerability Tests, CVEs, CPEs, CERT-Bund-Advisories, and DFN-CERT-Advisories.
22+
23+
The scanners and their corresponding parsers in secureCodeBox are implemented with Docker containers. We either dockerized them ourselves or used provided ones. Greenbone also provides a dockerized version of their OpenVAS scanner in a [Docker Compose file].
24+
25+
Technically, one can communicate to parts of OpenVAS with two protocols. The Open Scanner Protocol is provided by `ospd-openvas`. With that, it is possible to start scans, get Vulnerability Tests information and receive scan results. The Greenbone Management Protocol allows to communicate with the core OpenVAS Greenbone Security Assistant. With it, one can create, read, update and delete scans and vulnerability information. These two protocols are available in the official [python-gvm] package.
26+
27+
Furthermore, OpenVAS offers another type of scans (vulnerability tests). They seem to be more focussed on particular CVE's, outdated service versions and advisories. Moreover, some vulnerabilities, for example SSH weaknesses, are already covered in our offered scanneres, e.g., ssh_scan and ssh-audit.
28+
29+
30+
### Problem
31+
32+
Due to OpenVAS being an all-in-one solution, the Docker Compose file consists of 16! containers. As we only need support for the Open Scanner Protocol, we tried to isolate the `ospd-openvas` container - the core scanner component. However, it seems like that it is only possible to reave out the container serving the frontend. It is not possible to isolate the scanner. Thus, we need to include the whole OpenVAS setup. For more information see my question regarding a [Minimal OpenVAS Docker setup].
33+
34+
In contrast, secureCodeBox integrates more than 20 independent scanning tools. Each scanning tool is available as a docker container (and the corresponding parsing container). Unlike OpenVAS, only two containers (the operator and MinIO) must be running all the time. The other containers are created and stopped on runtime.
35+
36+
TODO: do we even need it?
37+
38+
### Solutions
39+
40+
TODO
41+
42+
## Decision
43+
44+
TODO
45+
46+
## Consequences
47+
48+
TODO
49+
50+
[#1642]: https://github.com/secureCodeBox/secureCodeBox/issues/1642
51+
[OpenVAS architecture]: https://greenbone.github.io/docs/latest/background.html
52+
[Docker Compose file]: https://greenbone.github.io/docs/latest/22.4/container/index.html#docker-compose-file
53+
[Minimal OpenVAS Docker setup]: https://forum.greenbone.net/t/minimal-docker-setup-with-python-gvm-osp-api/15630
54+
[python-gvm]: https://python-gvm.readthedocs.io/en/latest/usage.html
55+
[Persistence Hook]: https://www.securecodebox.io/docs/hooks/defectdojo

0 commit comments

Comments
 (0)