# Notus Scanner <!-- omit in toc -->
[](https://github.com/greenbone/notus-scanner/actions/workflows/ci-python.yml)
Notus Scanner detects vulnerable products in a system environment. The scanning
method is to evaluate internal system information. It does this very fast and
even detects currently inactive products because it does not need to interact
with each of the products.
To report about vulnerabilities, Notus Scanner receives collected system
information on the one hand and accesses the vulnerability information from the
feed service on the other. Both input elements are in table form: the system
information is specific to each environment and the vulnerability information is
specific to each system type.
Notus Scanner integrates into the Greenbone Vulnerability Management framework
which allows to let it scan entire networks within a single task. Any
vulnerability test in the format of `.notus` files inside the Greenbone Feed
will be considered and automatically matched with the scanned environments.
A system environment can be the operating system of a host. But it could also be
containers like Docker or virtual machines. Neither of these need to be actively
running for scanning.
The Notus Scanner is implemented in Python and published under an Open Source
license. Greenbone Networks maintains and extends it since it is embedded in the
Greenbone Professional Edition as well as in the Greenbone Cloud Services.
Greenbone also keeps the vulnerability information up-to-date via the feed on a
daily basis. The `.notus` format specification is open and part of the
documentation.
## Table of Contents <!-- omit in toc -->
- [Installation](#installation)
- [Development](#development)
- [Support](#support)
- [Maintainer](#maintainer)
- [Contributing](#contributing)
- [License](#license)
## Installation
Python 3.9 and later is supported.
For further information about installation and configuration read [install description](./INSTALL.md).
## Development
**notus-scanner** uses [poetry] for its own dependency management and build
process.
First install poetry via pip
python3 -m pip install --user poetry
Afterwards run
poetry install
in the checkout directory of **notus-scanner** (the directory containing the
`pyproject.toml` file) to install all dependencies including the packages only
required for development.
For development activate the git hooks for auto-formatting and linting via
[autohooks].
poetry run autohooks activate
Validate the activated git hooks by running
poetry run autohooks check
## Support
For any question on the usage of Notus Scanner please use the
[Greenbone Community Forum]. 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 AG][Greenbone Networks]
## Contributing
Your contributions are highly appreciated. Please
[create a pull request](https://github.com/greenbone/notus-scanner/pulls)
on GitHub. Bigger changes need to be discussed with the development team via the
[issues section at GitHub](https://github.com/greenbone/notus-scanner/issues)
first.
## License
Copyright (C) 2021-2024 Greenbone AG
Licensed under the GNU Affero General Public License v3.0 or later.
[Greenbone Networks]: https://www.greenbone.net/
[poetry]: https://python-poetry.org/
[pip]: https://pip.pypa.io/
[autohooks]: https://github.com/greenbone/autohooks
[Greenbone Community Forum]: https://forum.greenbone.net/
Raw data
{
"_id": null,
"home_page": "https://github.com/greenbone/notus-scanner",
"name": "notus-scanner",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "openvas, Greenbone Vulnerability Management, Vulnerability Scanning, Notus, Open Scanner Protocol, Local Security Checks, LSC",
"author": "Greenbone AG",
"author_email": "info@greenbone.net",
"download_url": "https://files.pythonhosted.org/packages/aa/31/e0ae4e5ed6d59c1602524cf701431fc1489fa0eb84069e82c2cb6dfea950/notus_scanner-22.6.3.tar.gz",
"platform": null,
"description": "\n\n# Notus Scanner <!-- omit in toc -->\n\n[](https://github.com/greenbone/notus-scanner/actions/workflows/ci-python.yml)\n\nNotus Scanner detects vulnerable products in a system environment. The scanning\nmethod is to evaluate internal system information. It does this very fast and\neven detects currently inactive products because it does not need to interact\nwith each of the products.\n\nTo report about vulnerabilities, Notus Scanner receives collected system\ninformation on the one hand and accesses the vulnerability information from the\nfeed service on the other. Both input elements are in table form: the system\ninformation is specific to each environment and the vulnerability information is\nspecific to each system type.\n\nNotus Scanner integrates into the Greenbone Vulnerability Management framework\nwhich allows to let it scan entire networks within a single task. Any\nvulnerability test in the format of `.notus` files inside the Greenbone Feed\nwill be considered and automatically matched with the scanned environments.\n\nA system environment can be the operating system of a host. But it could also be\ncontainers like Docker or virtual machines. Neither of these need to be actively\nrunning for scanning.\n\nThe Notus Scanner is implemented in Python and published under an Open Source\nlicense. Greenbone Networks maintains and extends it since it is embedded in the\nGreenbone Professional Edition as well as in the Greenbone Cloud Services.\n\nGreenbone also keeps the vulnerability information up-to-date via the feed on a\ndaily basis. The `.notus` format specification is open and part of the\ndocumentation.\n\n## Table of Contents <!-- omit in toc -->\n\n- [Installation](#installation)\n- [Development](#development)\n- [Support](#support)\n- [Maintainer](#maintainer)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Installation\n\nPython 3.9 and later is supported.\n\nFor further information about installation and configuration read [install description](./INSTALL.md).\n\n## Development\n\n**notus-scanner** uses [poetry] for its own dependency management and build\nprocess.\n\nFirst install poetry via pip\n\n python3 -m pip install --user poetry\n\nAfterwards run\n\n poetry install\n\n\nin the checkout directory of **notus-scanner** (the directory containing the\n`pyproject.toml` file) to install all dependencies including the packages only\nrequired for development.\n\n\nFor development activate the git hooks for auto-formatting and linting via\n[autohooks].\n\n poetry run autohooks activate\n\nValidate the activated git hooks by running\n\n poetry run autohooks check\n\n## Support\n\nFor any question on the usage of Notus Scanner please use the\n[Greenbone Community Forum]. If you found a problem with the software, please\ncreate an issue on GitHub. If you are a Greenbone customer you may alternatively\nor additionally forward your issue to the Greenbone Support Portal.\n\n## Maintainer\n\nThis project is maintained by [Greenbone AG][Greenbone Networks]\n\n## Contributing\n\nYour contributions are highly appreciated. Please\n[create a pull request](https://github.com/greenbone/notus-scanner/pulls)\non GitHub. Bigger changes need to be discussed with the development team via the\n[issues section at GitHub](https://github.com/greenbone/notus-scanner/issues)\nfirst.\n\n## License\n\nCopyright (C) 2021-2024 Greenbone AG\n\nLicensed under the GNU Affero General Public License v3.0 or later.\n\n[Greenbone Networks]: https://www.greenbone.net/\n[poetry]: https://python-poetry.org/\n[pip]: https://pip.pypa.io/\n[autohooks]: https://github.com/greenbone/autohooks\n[Greenbone Community Forum]: https://forum.greenbone.net/\n\n",
"bugtrack_url": null,
"license": "AGPL-3.0-or-later",
"summary": "A vulnerability scanner for creating results from local security checks (LSCs)",
"version": "22.6.3",
"project_urls": {
"Homepage": "https://github.com/greenbone/notus-scanner",
"Repository": "https://github.com/greenbone/notus-scanner"
},
"split_keywords": [
"openvas",
" greenbone vulnerability management",
" vulnerability scanning",
" notus",
" open scanner protocol",
" local security checks",
" lsc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "de3e614de8e4f34ece67ed4d4217f2256c51a7317e98e6c1d9fa9edfd1d91844",
"md5": "b59413e492ac6051a9207a3014ea4d85",
"sha256": "8c9962b99b8c0bc691ce4a52da893243b647be7a49a812924d3f08da4aad1d1e"
},
"downloads": -1,
"filename": "notus_scanner-22.6.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b59413e492ac6051a9207a3014ea4d85",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 46606,
"upload_time": "2024-04-22T09:41:10",
"upload_time_iso_8601": "2024-04-22T09:41:10.154636Z",
"url": "https://files.pythonhosted.org/packages/de/3e/614de8e4f34ece67ed4d4217f2256c51a7317e98e6c1d9fa9edfd1d91844/notus_scanner-22.6.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "aa31e0ae4e5ed6d59c1602524cf701431fc1489fa0eb84069e82c2cb6dfea950",
"md5": "0b8e79531f03a39e268b5ef66bce1402",
"sha256": "1d1941311e9d93362781b2fb2b56996f36f7e0b3d3850e14c56cb3a4a267b1cc"
},
"downloads": -1,
"filename": "notus_scanner-22.6.3.tar.gz",
"has_sig": false,
"md5_digest": "0b8e79531f03a39e268b5ef66bce1402",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 284221,
"upload_time": "2024-04-22T09:41:12",
"upload_time_iso_8601": "2024-04-22T09:41:12.034027Z",
"url": "https://files.pythonhosted.org/packages/aa/31/e0ae4e5ed6d59c1602524cf701431fc1489fa0eb84069e82c2cb6dfea950/notus_scanner-22.6.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-22 09:41:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "greenbone",
"github_project": "notus-scanner",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "notus-scanner"
}
JSON
