Skip to content

Commit

Permalink
Doc: remove notus-scanner and explain openvasd installation
Browse files Browse the repository at this point in the history
  • Loading branch information
nichtsfrei authored and greenbonebot committed Apr 15, 2024
1 parent 217ffdc commit 881f3a4
Showing 10 changed files with 90 additions and 131 deletions.
19 changes: 8 additions & 11 deletions src/22.4/source-build/index.md
Original file line number Diff line number Diff line change
@@ -142,7 +142,7 @@ export GSAD_VERSION=22.9.0
```{code-block}
:caption: Setting the openvas-scanner version to use
export OPENVAS_SCANNER_VERSION=22.7.9
export OPENVAS_SCANNER_VERSION=23.0.1
```

```{include} /22.4/source-build/openvas-scanner/dependencies.md
@@ -174,24 +174,24 @@ export OSPD_OPENVAS_VERSION=22.6.2
```{include} /22.4/source-build/ospd-openvas/build.md
```

### notus-scanner
### openvasd

```{include} /22.4/source-build/notus-scanner/description.md
```{include} /22.4/source-build/openvasd/description.md
```

```{code-block}
:caption: Setting the notus version to use
:caption: Setting the openvas versions to use
export NOTUS_VERSION=22.6.2
export OPENVAS_DAEMON=23.0.1
```

```{include} /22.4/source-build/notus-scanner/dependencies.md
```{include} /22.4/source-build/openvasd/dependencies.md
```

```{include} /22.4/source-build/notus-scanner/download.md
```{include} /22.4/source-build/openvasd/download.md
```

```{include} /22.4/source-build/notus-scanner/build.md
```{include} /22.4/source-build/openvasd/build.md
```

### greenbone-feed-sync
@@ -221,9 +221,6 @@ export NOTUS_VERSION=22.6.2
```{include} /22.4/source-build/redis.md
```

```{include} /22.4/source-build/mqtt-broker.md
```

```{include} /22.4/source-build/directory-permissions.md
```

30 changes: 0 additions & 30 deletions src/22.4/source-build/mqtt-broker.md

This file was deleted.

26 changes: 0 additions & 26 deletions src/22.4/source-build/notus-scanner/build.md

This file was deleted.

37 changes: 0 additions & 37 deletions src/22.4/source-build/notus-scanner/dependencies.md

This file was deleted.

4 changes: 0 additions & 4 deletions src/22.4/source-build/notus-scanner/description.md

This file was deleted.

23 changes: 0 additions & 23 deletions src/22.4/source-build/notus-scanner/download.md

This file was deleted.

23 changes: 23 additions & 0 deletions src/22.4/source-build/openvasd/build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
```{eval-rst}
.. tabs::
.. tab:: Debian/Ubuntu
.. code-block::
:caption: Installing openvas-scanner
cd $SOURCE_DIR/openvas-scanner-$NOTUS_VERSION/rust/openvasd
cargo build --release
sudo cp -v ../target/release/openvasd /usr/local/bin/
.. tab:: Fedora/CentOS
.. code-block::
:caption: Installing openvas-scanner
cd $SOURCE_DIR/openvas-scanner-$NOTUS_VERSION/rust/openvasd
cargo build --release
sudo cp -v ../target/release/openvasd /usr/local/bin/
```
29 changes: 29 additions & 0 deletions src/22.4/source-build/openvasd/dependencies.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
```{eval-rst}
.. tabs::
.. tab:: Debian/Ubuntu
.. code-block::
:caption: Required dependencies for openvasd
sudo apt install -y \
cargo \
pkg-config \
libssl-dev
.. tab:: Fedora
.. code-block::
:caption: Required dependencies for openvasd
sudo dnf install -y \
cargo \
pkg-config \
openssl-devel
.. tab:: CentOS
.. code-block::
:caption: Required dependencies for openvasd
sudo dnf install -y \
cargo \
pkg-config \
openssl-devel
```
7 changes: 7 additions & 0 deletions src/22.4/source-build/openvasd/description.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
*OpenVASD* is used for detecting vulnerable products.

It controls `openvas-scanner` for scanning and is used to get the results.

For more information see:
- https://greenbone.github.io/scanner-api/
- https://github.com/greenbone/openvas-scanner/tree/main/rust/openvasd
23 changes: 23 additions & 0 deletions src/22.4/source-build/openvasd/download.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
```{code-block}
:caption: Downloading the openvas-scanner sources
curl -f -L https://github.com/greenbone/openvas-scanner/archive/refs/tags/v$OPENVAS_DAEMON.tar.gz -o $SOURCE_DIR/openvas-scanner-$OPENVAS_DAEMON.tar.gz
curl -f -L https://github.com/greenbone/openvas-scanner/releases/download/v$OPENVAS_DAEMON/openvas-scanner-v$OPENVAS_DAEMON.tar.gz.asc -o $SOURCE_DIR/openvas-scanner-$OPENVAS_DAEMON.tar.gz.asc
```

```{code-block}
:caption: Verifying the source file
gpg --verify $SOURCE_DIR/openvas-scanner-$OPENVAS_DAEMON.tar.gz.asc $SOURCE_DIR/openvas-scanner-$OPENVAS_DAEMON.tar.gz
```

The output of the last command should be similar to:

```{include} /22.4/source-build/verify.md
```

If the signature is valid, the tarball can be extracted.

```
tar -C $SOURCE_DIR -xvzf $SOURCE_DIR/openvas-scanner-$OPENVAS_DAEMON.tar.gz
```

0 comments on commit 881f3a4

Please sign in to comment.