Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/greenbone/ospd-openvas

ospd-openvas is an OSP server implementation to allow GVM to remotely control an OpenVAS Scanner
https://github.com/greenbone/ospd-openvas

base openvas python techops tooling

Last synced: 6 days ago
JSON representation

ospd-openvas is an OSP server implementation to allow GVM to remotely control an OpenVAS Scanner

Awesome Lists containing this project

README 

        
![Greenbone Logo](https://www.greenbone.net/wp-content/uploads/gb_new-logo_horizontal_rgb_small.png)



# ospd-openvas



[![GitHub releases](https://img.shields.io/github/release/greenbone/ospd-openvas.svg)](https://github.com/greenbone/ospd-openvas/releases)

[![PyPI](https://img.shields.io/pypi/v/ospd-openvas.svg)](https://pypi.org/project/ospd-openvas/)

[![Build and test](https://github.com/greenbone/ospd-openvas/actions/workflows/ci-python.yml/badge.svg?branch=main)](https://github.com/greenbone/ospd-openvas/actions/workflows/ci-python.yml?query=branch%3Amain++)



ospd-openvas is an OSP server implementation to remotely control

[OpenVAS Scanner](https://github.com/greenbone/openvas-scanner) and [Notus Scanner](https://github.com/greenbone/notus-scanner).



Once running, you need to configure OpenVAS Scanner and Notus Scanner for the Greenbone Vulnerability

Manager, for example via the web interface Greenbone Security Assistant. Then

you can create scan tasks to use both scanners.



## Installation



### Requirements



Python 3.7 and later is supported.



`ospd-openvas` has dependencies on the following Python packages:



- `defusedxml`

- `deprecated`

- `lxml`

- `packaging`

- `paho-mqtt`

- `psutil`

- `python-gnupg`

- `redis`



### Mandatory configuration



The `ospd-openvas` startup parameter `--lock-file-dir` or the `lock_file_dir` config

parameter of the `ospd.conf` config file needs to point to the same location / path of

the `gvmd` daemon and the `openvas` command line tool (Default: `/var/run`).

Examples for both are shipped within the `config` sub-folder of this project.



Also in order to be able to use Notus ospd-openvas must connect to a MQTT broker, such as [Mosquitto](https://mosquitto.org/) in order to communicate. With the parameter `--mqtt-broker-address` (Default: localhost) the correct address must be given as well as the corresponding port with `--mqtt-broker-port` (Default: 1883).



Please see the `Details` section of the [GVM release notes](https://community.greenbone.net/t/gvm-20-08-stable-initial-release-2020-08-12/6312)

for more details.



### Optional configuration



Please note that although you can run `openvas` (launched from an `ospd-openvas`

process) as a user without elevated privileges, it is recommended that you start

`openvas` as `root` since a number of Network Vulnerability Tests (NVTs) require

root privileges to perform certain operations like packet forgery. If you run

`openvas` as a user without permission to perform these operations, your scan

results are likely to be incomplete.



As `openvas` will be launched from an `ospd-openvas` process with sudo,

the next configuration is required in the sudoers file:



    sudo visudo



add this line to allow the user running `ospd-openvas`, to launch `openvas`

with root permissions



     ALL = NOPASSWD: /sbin/openvas



If you set an install prefix, you have to update the path in the sudoers

file too:



    Defaults        secure_path=:/sbin



## Usage



There are no special usage aspects for this module beyond the generic usage

guide.



Please follow the general usage guide for ospd-based scanners:



  



## Support



For any question on the usage of ospd-openvas please use the [Greenbone

Community Portal](https://community.greenbone.net/). If you found a problem

with the software, please [create an

issue](https://github.com/greenbone/ospd-openvas/issues) on GitHub. If you are a

Greenbone customer you may alternatively or additionally forward your issue to

the Greenbone Support Portal.



## Maintainer



This project is maintained by [Greenbone AG](https://www.greenbone.net/).



## Contributing



Your contributions are highly appreciated. Please [create a pull

request](https://github.com/greenbone/ospd-openvas/pulls) on GitHub. Bigger

changes need to be discussed with the development team via the [issues section

at GitHub](https://github.com/greenbone/ospd-openvas/issues) first.



For development you should use [poetry](https://python-poetry.org)

to keep your python packages separated in different environments. First install

poetry via pip



    python3 -m pip install --user poetry



Afterwards run



    poetry install



in the checkout directory of ospd-openvas (the directory containing the

`pyproject.toml` file) to install all dependencies including the packages only

required for development.



The ospd-openvas repository uses [autohooks](https://github.com/greenbone/autohooks)

to apply linting and auto formatting via git hooks. Please ensure the git hooks

are active.



    poetry install

    poetry run autohooks activate --force



## License



Copyright (C) 2018-2022 [Greenbone AG](https://www.greenbone.net/)



Licensed under the [GNU Affero General Public License v3.0 or later](COPYING).