Package: ospd-openvas
ospd-openvasospd-openvas is an OSP server implementation to remotely controlOpenVAS ScannerandNotus 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.InstallationRequirementsPython 3.7 and later is supported.ospd-openvashas dependencies on the following Python packages:defusedxmldepreactedlxmlpackagingpaho-mqttpsutilpython-gnupgredisMandatory configurationTheospd-openvasstartup parameter--lock-file-diror thelock_file_dirconfig
parameter of theospd.confconfig file needs to point to the same location / path of
thegvmddaemon and theopenvascommand line tool (Default:<install-prefix>/var/run).
Examples for both are shipped within theconfigsub-folder of this project.Also in order to be able to use Notus ospd-openvas must connect to a MQTT broker, such asMosquittoin 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 theDetailssection of theGVM release notesfor more details.Optional configurationPlease note that although you can runopenvas(launched from anospd-openvasprocess) as a user without elevated privileges, it is recommended that you startopenvasasrootsince a number of Network Vulnerability Tests (NVTs) require
root privileges to perform certain operations like packet forgery. If you runopenvasas a user without permission to perform these operations, your scan
results are likely to be incomplete.Asopenvaswill be launched from anospd-openvasprocess with sudo,
the next configuration is required in the sudoers file:sudo visudoadd this line to allow the user runningospd-openvas, to launchopenvaswith root permissions<user> ALL = NOPASSWD: <install prefix>/sbin/openvasIf you set an install prefix, you have to update the path in the sudoers
file too:Defaults        secure_path=<existing paths...>:<install prefix>/sbinUsageThere are no special usage aspects for this module beyond the generic usage
guide.Please follow the general usage guide for ospd-based scanners:https://github.com/greenbone/ospd-openvas/blob/main/docs/USAGE-ospd-scanner.mdSupportFor any question on the usage of ospd-openvas please use theGreenbone
Community Portal. If you found a problem
with the software, pleasecreate an
issueon GitHub. If you are a
Greenbone customer you may alternatively or additionally forward your issue to
the Greenbone Support Portal.MaintainerThis project is maintained byGreenbone Networks
GmbH.ContributingYour contributions are highly appreciated. Pleasecreate a pull
requeston GitHub. Bigger
changes need to be discussed with the development team via theissues section
at GitHubfirst.For development you should usepoetryto keep your python packages separated in different environments. First install
poetry via pippython3 -m pip install --user poetryAfterwards runpoetry installin the checkout directory of ospd-openvas (the directory containing thepyproject.tomlfile) to install all dependencies including the packages only
required for development.The ospd-openvas repository usesautohooksto apply linting and auto formatting via git hooks. Please ensure the git hooks
are active.poetry install
poetry run autohooks activate --forceLicenseCopyright (C) 2018-2022Greenbone AGLicensed under theGNU Affero General Public License v3.0 or later.