# ospd-openvas
[](https://github.com/greenbone/ospd-openvas/releases)
[](https://pypi.org/project/ospd-openvas/)
[](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: `<install-prefix>/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
<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-openvas/blob/main/docs/USAGE-ospd-scanner.md>
## 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 Networks
GmbH](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).
Raw data
{
"_id": null,
"home_page": "https://github.com/greenbone/ospd-openvas",
"name": "ospd-openvas",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "openvas, Greenbone Vulnerability Management, Vulnerability Scanning, OSP, Open Scanner Protocol",
"author": "Greenbone AG",
"author_email": "info@greenbone.net",
"download_url": "https://files.pythonhosted.org/packages/e7/d1/ef77b575793183801d8a8acfdc91bad760ec97bfdaacffdbd8c2eb0a01c3/ospd_openvas-22.7.1.tar.gz",
"platform": null,
"description": "\n\n# ospd-openvas\n\n[](https://github.com/greenbone/ospd-openvas/releases)\n[](https://pypi.org/project/ospd-openvas/)\n[](https://github.com/greenbone/ospd-openvas/actions/workflows/ci-python.yml?query=branch%3Amain++)\n\nospd-openvas is an OSP server implementation to remotely control\n[OpenVAS Scanner](https://github.com/greenbone/openvas-scanner) and [Notus Scanner](https://github.com/greenbone/notus-scanner).\n\nOnce running, you need to configure OpenVAS Scanner and Notus Scanner for the Greenbone Vulnerability\nManager, for example via the web interface Greenbone Security Assistant. Then\nyou can create scan tasks to use both scanners.\n\n## Installation\n\n### Requirements\n\nPython 3.7 and later is supported.\n\n`ospd-openvas` has dependencies on the following Python packages:\n\n- `defusedxml`\n- `deprecated`\n- `lxml`\n- `packaging`\n- `paho-mqtt`\n- `psutil`\n- `python-gnupg`\n- `redis`\n\n### Mandatory configuration\n\nThe `ospd-openvas` startup parameter `--lock-file-dir` or the `lock_file_dir` config\nparameter of the `ospd.conf` config file needs to point to the same location / path of\nthe `gvmd` daemon and the `openvas` command line tool (Default: `<install-prefix>/var/run`).\nExamples for both are shipped within the `config` sub-folder of this project.\n\nAlso 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).\n\nPlease see the `Details` section of the [GVM release notes](https://community.greenbone.net/t/gvm-20-08-stable-initial-release-2020-08-12/6312)\nfor more details.\n\n### Optional configuration\n\nPlease note that although you can run `openvas` (launched from an `ospd-openvas`\nprocess) as a user without elevated privileges, it is recommended that you start\n`openvas` as `root` since a number of Network Vulnerability Tests (NVTs) require\nroot privileges to perform certain operations like packet forgery. If you run\n`openvas` as a user without permission to perform these operations, your scan\nresults are likely to be incomplete.\n\nAs `openvas` will be launched from an `ospd-openvas` process with sudo,\nthe next configuration is required in the sudoers file:\n\n sudo visudo\n\nadd this line to allow the user running `ospd-openvas`, to launch `openvas`\nwith root permissions\n\n <user> ALL = NOPASSWD: <install prefix>/sbin/openvas\n\nIf you set an install prefix, you have to update the path in the sudoers\nfile too:\n\n Defaults secure_path=<existing paths...>:<install prefix>/sbin\n\n## Usage\n\nThere are no special usage aspects for this module beyond the generic usage\nguide.\n\nPlease follow the general usage guide for ospd-based scanners:\n\n <https://github.com/greenbone/ospd-openvas/blob/main/docs/USAGE-ospd-scanner.md>\n\n## Support\n\nFor any question on the usage of ospd-openvas please use the [Greenbone\nCommunity Portal](https://community.greenbone.net/). If you found a problem\nwith the software, please [create an\nissue](https://github.com/greenbone/ospd-openvas/issues) on GitHub. If you are a\nGreenbone customer you may alternatively or additionally forward your issue to\nthe Greenbone Support Portal.\n\n## Maintainer\n\nThis project is maintained by [Greenbone Networks\nGmbH](https://www.greenbone.net/).\n\n## Contributing\n\nYour contributions are highly appreciated. Please [create a pull\nrequest](https://github.com/greenbone/ospd-openvas/pulls) on GitHub. Bigger\nchanges need to be discussed with the development team via the [issues section\nat GitHub](https://github.com/greenbone/ospd-openvas/issues) first.\n\nFor development you should use [poetry](https://python-poetry.org)\nto keep your python packages separated in different environments. First install\npoetry via pip\n\n python3 -m pip install --user poetry\n\nAfterwards run\n\n poetry install\n\nin the checkout directory of ospd-openvas (the directory containing the\n`pyproject.toml` file) to install all dependencies including the packages only\nrequired for development.\n\nThe ospd-openvas repository uses [autohooks](https://github.com/greenbone/autohooks)\nto apply linting and auto formatting via git hooks. Please ensure the git hooks\nare active.\n\n poetry install\n poetry run autohooks activate --force\n\n## License\n\nCopyright (C) 2018-2022 [Greenbone AG](https://www.greenbone.net/)\n\nLicensed under the [GNU Affero General Public License v3.0 or later](COPYING).\n\n",
"bugtrack_url": null,
"license": "AGPL-3.0-or-later",
"summary": "ospd based scanner for openvas",
"version": "22.7.1",
"project_urls": {
"Homepage": "https://github.com/greenbone/ospd-openvas",
"Repository": "https://github.com/greenbone/ospd-openvas"
},
"split_keywords": [
"openvas",
" greenbone vulnerability management",
" vulnerability scanning",
" osp",
" open scanner protocol"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1b0b01bca05e06d9c7205cd673af24d176d6b992a0ec2639b6d148df50d12d43",
"md5": "e63e0e56b49717271bc8d29af01cb3da",
"sha256": "abe66558ee660c2ef9bdb94e7caf692afcdb1becae3c151917700709421c4388"
},
"downloads": -1,
"filename": "ospd_openvas-22.7.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e63e0e56b49717271bc8d29af01cb3da",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 112153,
"upload_time": "2024-04-22T13:24:17",
"upload_time_iso_8601": "2024-04-22T13:24:17.005539Z",
"url": "https://files.pythonhosted.org/packages/1b/0b/01bca05e06d9c7205cd673af24d176d6b992a0ec2639b6d148df50d12d43/ospd_openvas-22.7.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e7d1ef77b575793183801d8a8acfdc91bad760ec97bfdaacffdbd8c2eb0a01c3",
"md5": "49bd9b2a4bbeb40e9e19068fb8dfd64f",
"sha256": "cee3d3c853dc9605012cb84d0333a117990117fd6bfb0d770539ea895f7150e3"
},
"downloads": -1,
"filename": "ospd_openvas-22.7.1.tar.gz",
"has_sig": false,
"md5_digest": "49bd9b2a4bbeb40e9e19068fb8dfd64f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 178562,
"upload_time": "2024-04-22T13:24:18",
"upload_time_iso_8601": "2024-04-22T13:24:18.420534Z",
"url": "https://files.pythonhosted.org/packages/e7/d1/ef77b575793183801d8a8acfdc91bad760ec97bfdaacffdbd8c2eb0a01c3/ospd_openvas-22.7.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-22 13:24:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "greenbone",
"github_project": "ospd-openvas",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "ospd-openvas"
}
JSON
