Skip to main content

ospd based scanner for openvas

Project description

Greenbone Logo

ospd-openvas

Scrutinizer Code Quality

This is an OSP server implementation to allow GVM to remotely control OpenVAS, see https://github.com/greenbone/openvas.

Once running, you need to configure OpenVAS for the Greenbone Vulnerability Manager, for example via the web interface Greenbone Security Assistant. Then you can create scan tasks to use OpenVAS.

Installation

Requirements

Python 3.5 and later is supported.

Beyond the ospd base library, ospd-openvas has dependencies on the following Python packages:

  • redis
  • psutil
  • packaging

There are no special installation aspects for this module beyond the general installation guide for ospd-based scanners.

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

https://github.com/greenbone/ospd/blob/master/doc/INSTALL-ospd-scanner.md

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

<user> ALL = NOPASSWD: <install prefix>/sbin/openvas

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

Defaults        secure_path=<existing paths...>:<install prefix>/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:

https://github.com/greenbone/ospd/blob/master/doc/USAGE-ospd-scanner.md

Support

For any question on the usage of ospd-openvas please use the Greenbone Community Portal. If you found a problem with the software, please create an issue 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 Networks GmbH.

Contributing

Your contributions are highly appreciated. Please create a pull request on GitHub. Bigger changes need to be discussed with the development team via the issues section at GitHub first.

For development you should use poetry to keep you 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 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-2020 Greenbone Networks GmbH

Licensed under the GNU General Public License v2.0 or later.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ospd-openvas-20.8.0.tar.gz (78.4 kB view details)

Uploaded Source

Built Distribution

ospd_openvas-20.8.0-py3-none-any.whl (46.7 kB view details)

Uploaded Python 3

File details

Details for the file ospd-openvas-20.8.0.tar.gz.

File metadata

  • Download URL: ospd-openvas-20.8.0.tar.gz
  • Upload date:
  • Size: 78.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.8

File hashes

Hashes for ospd-openvas-20.8.0.tar.gz
Algorithm Hash digest
SHA256 2d1566f09283d3ecce372f9b9ec2e830e59a53a6fcfb26149192355403e01861
MD5 0fa4eb3e20b15ffe249c4f7d9780fb1b
BLAKE2b-256 d075945a5c26f5de54bf293b44191772a75c7935ea98c52f14951103a8b474f4

See more details on using hashes here.

Provenance

File details

Details for the file ospd_openvas-20.8.0-py3-none-any.whl.

File metadata

  • Download URL: ospd_openvas-20.8.0-py3-none-any.whl
  • Upload date:
  • Size: 46.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.8

File hashes

Hashes for ospd_openvas-20.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5da111ebe13860c6120f64f05d0eac8272636bea890fe9925e146a7318121377
MD5 4481f91d7d8ff8694923848a324e9b2c
BLAKE2b-256 b0a1c425840d9c570909ede24bc44f3ce7ba49967134ddc86c32254abb22b4eb

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page