# Greenbone Vulnerability Management Tools <!-- omit in toc -->
[](https://github.com/greenbone/gvm-tools/releases)
[](https://pypi.org/project/gvm-tools/)
[](https://codecov.io/gh/greenbone/gvm-tools)
[](https://github.com/greenbone/gvm-tools/actions/workflows/ci-python.yml)
The Greenbone Vulnerability Management Tools `gvm-tools` are a collection of
tools that help with remote controlling a Greenbone Enterprise Appliance and
Greenbone Community Edition installations. The tools aid in accessing the
communication protocols GMP (Greenbone Management Protocol) and OSP
(Open Scanner Protocol).
This module is comprised of interactive and non-interactive clients.
The programming language Python is supported directly for interactive scripting.
But it is also possible to issue remote GMP/OSP commands without programming in
Python.
## Table of Contents <!-- omit in toc -->
- [Documentation](#documentation)
- [Installation](#installation)
- [Requirements](#requirements)
- [Version](#version)
- [Usage](#usage)
- [gvm-cli](#gvm-cli)
- [Examples](#examples)
- [gvm-script](#gvm-script)
- [Example script](#example-script)
- [More example scripts](#more-example-scripts)
- [gvm-pyshell](#gvm-pyshell)
- [Example program use](#example-program-use)
- [Support](#support)
- [Maintainer](#maintainer)
- [Contributing](#contributing)
- [License](#license)
## Documentation
The documentation for `gvm-tools` can be found at
[https://greenbone.github.io/gvm-tools/](https://greenbone.github.io/gvm-tools/).
Please refer to the documentation for more details as this README just
gives a short overview.
## Installation
See the [documentation](https://greenbone.github.io/gvm-tools/install.html)
for all supported installation options.
### Requirements
Python 3.9 and later is supported.
### Version
Please consider to always use the **newest** version of `gvm-tools` and `python-gvm`.
We frequently update this projects to add features and keep them free from bugs.
This is why installing `gvm-tools` using pip is recommended.
**To use `gvm-tools` with an old GMP version (7, 8, 9) you must use a release version**
**that is `<21.06`, combined with an `python-gvm` version `<21.05`.**
**In the `21.06` release the support of these older versions has been dropped.**
## Usage
There are several clients to communicate via GMP/OSP.
All clients have the ability to build a connection in various ways:
* Unix Socket
* TLS Connection
* SSH Connection
### gvm-cli
This tool sends plain GMP/OSP commands and prints the result to the standard
output.
#### Examples
Return the current protocol version used by the server:
```bash
gvm-cli socket --xml "<get_version/>"
```
Return all tasks visible to the GMP user with the provided credentials:
```bash
gvm-cli --gmp-username foo --gmp-password bar socket --xml "<get_tasks/>"
```
Read a file with GMP commands and return the result:
```bash
gvm-cli --gmp-username foo --gmp-password bar socket myfile.xml
```
Note that `gvm-cli` will by default print an error message and exit with a
non-zero exit code when a command is rejected by the server. If this kind of
error handling is not desired, the unparsed XML response can be requested using
the `--raw` parameter:
```bash
gvm-cli socket --raw --xml "<authenticate/>"
```
### gvm-script
This tool has a lot more features than the simple `gvm-cli` client. You
have the possibility to create your own custom gmp or osp scripts with commands
from the [python-gvm library](https://github.com/greenbone/python-gvm) and from
Python 3 itself.
#### Example script
```python
# Retrieve current GMP version
version = gmp.get_version()
# Prints the XML in beautiful form
from gvmtools.helper import pretty_print
pretty_print(version)
# Retrieve all tasks
tasks = gmp.get_tasks()
# Get names of tasks
task_names = tasks.xpath('task/name/text()')
pretty_print(task_names)
```
#### More example scripts
There is a growing collection of gmp-scripts in the
["scripts/"](scripts/) folder.
Some of them might be exactly what you need and all of them help writing
your own gmp scripts.
### gvm-pyshell
This tool is for running gmp or osp scripts interactively. It provides the same
API as [gvm-script](#gvm-script) using the
[python-gvm library](https://github.com/greenbone/python-gvm).
#### Example program use
Connect with given credentials via a unix domain socket and open an interactive
shell:
```bash
gvm-pyshell --gmp-username user --gmp-password pass socket
```
Connect through SSH connection and open the interactive shell:
```bash
gvm-pyshell --hostname 127.0.0.1 ssh
```
## Support
For any question on the usage of `gvm-tools` or gmp scripts please use the
[Greenbone Community Portal](https://community.greenbone.net/c/gmp). If you
found a problem with the software, please
[create an issue](https://github.com/greenbone/gvm-tools/issues) on GitHub.
## 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/gvm-tools/pulls) on GitHub.
For bigger changes, please discuss it first in the
[issues](https://github.com/greenbone/gvm-tools/issues).
For development you should use [poetry](https://python-poetry.org/)
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 `gvm-tools` (the directory containing the
`pyproject.toml` file) to install all dependencies including the packages only
required for development.
Afterwards active the git hooks for auto-formatting and linting via
[autohooks](https://github.com/greenbone/autohooks).
poetry run autohooks activate --force
## License
Copyright (C) 2017-2024 [Greenbone AG](https://www.greenbone.net/)
Licensed under the [GNU General Public License v3.0 or later](LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/greenbone/gvm-tools/",
"name": "gvm-tools",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Greenbone AG",
"author_email": "info@greenbone.net",
"download_url": "https://files.pythonhosted.org/packages/36/5b/1767308e50b60d9ad111ccf14b3fb2aa1f4c1a29e3f3c40b77e3129b53fb/gvm_tools-24.8.0.tar.gz",
"platform": null,
"description": "\n\n# Greenbone Vulnerability Management Tools <!-- omit in toc -->\n[](https://github.com/greenbone/gvm-tools/releases)\n[](https://pypi.org/project/gvm-tools/)\n[](https://codecov.io/gh/greenbone/gvm-tools)\n[](https://github.com/greenbone/gvm-tools/actions/workflows/ci-python.yml)\n\nThe Greenbone Vulnerability Management Tools `gvm-tools` are a collection of\ntools that help with remote controlling a Greenbone Enterprise Appliance and\nGreenbone Community Edition installations. The tools aid in accessing the\ncommunication protocols GMP (Greenbone Management Protocol) and OSP\n(Open Scanner Protocol).\n\nThis module is comprised of interactive and non-interactive clients.\nThe programming language Python is supported directly for interactive scripting.\nBut it is also possible to issue remote GMP/OSP commands without programming in\nPython.\n\n\n## Table of Contents <!-- omit in toc -->\n- [Documentation](#documentation)\n- [Installation](#installation)\n - [Requirements](#requirements)\n - [Version](#version)\n- [Usage](#usage)\n - [gvm-cli](#gvm-cli)\n - [Examples](#examples)\n - [gvm-script](#gvm-script)\n - [Example script](#example-script)\n - [More example scripts](#more-example-scripts)\n - [gvm-pyshell](#gvm-pyshell)\n - [Example program use](#example-program-use)\n- [Support](#support)\n- [Maintainer](#maintainer)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Documentation\n\nThe documentation for `gvm-tools` can be found at\n[https://greenbone.github.io/gvm-tools/](https://greenbone.github.io/gvm-tools/).\nPlease refer to the documentation for more details as this README just\ngives a short overview.\n\n## Installation\n\nSee the [documentation](https://greenbone.github.io/gvm-tools/install.html)\nfor all supported installation options.\n\n### Requirements\n\nPython 3.9 and later is supported.\n\n### Version\n\nPlease consider to always use the **newest** version of `gvm-tools` and `python-gvm`.\nWe frequently update this projects to add features and keep them free from bugs.\nThis is why installing `gvm-tools` using pip is recommended.\n\n**To use `gvm-tools` with an old GMP version (7, 8, 9) you must use a release version**\n**that is `<21.06`, combined with an `python-gvm` version `<21.05`.**\n**In the `21.06` release the support of these older versions has been dropped.**\n\n## Usage\n\nThere are several clients to communicate via GMP/OSP.\n\nAll clients have the ability to build a connection in various ways:\n\n* Unix Socket\n* TLS Connection\n* SSH Connection\n\n### gvm-cli\n\nThis tool sends plain GMP/OSP commands and prints the result to the standard\noutput.\n\n#### Examples\n\nReturn the current protocol version used by the server:\n\n```bash\ngvm-cli socket --xml \"<get_version/>\"\n```\n\nReturn all tasks visible to the GMP user with the provided credentials:\n\n```bash\ngvm-cli --gmp-username foo --gmp-password bar socket --xml \"<get_tasks/>\"\n```\n\nRead a file with GMP commands and return the result:\n\n```bash\ngvm-cli --gmp-username foo --gmp-password bar socket myfile.xml\n```\n\nNote that `gvm-cli` will by default print an error message and exit with a\nnon-zero exit code when a command is rejected by the server. If this kind of\nerror handling is not desired, the unparsed XML response can be requested using\nthe `--raw` parameter:\n\n```bash\ngvm-cli socket --raw --xml \"<authenticate/>\"\n\n```\n\n### gvm-script\n\nThis tool has a lot more features than the simple `gvm-cli` client. You\nhave the possibility to create your own custom gmp or osp scripts with commands\nfrom the [python-gvm library](https://github.com/greenbone/python-gvm) and from\nPython 3 itself.\n\n#### Example script\n\n```python\n# Retrieve current GMP version\nversion = gmp.get_version()\n\n# Prints the XML in beautiful form\nfrom gvmtools.helper import pretty_print\npretty_print(version)\n\n# Retrieve all tasks\ntasks = gmp.get_tasks()\n\n# Get names of tasks\ntask_names = tasks.xpath('task/name/text()')\npretty_print(task_names)\n```\n\n#### More example scripts\n\nThere is a growing collection of gmp-scripts in the\n[\"scripts/\"](scripts/) folder.\nSome of them might be exactly what you need and all of them help writing\nyour own gmp scripts.\n\n### gvm-pyshell\n\nThis tool is for running gmp or osp scripts interactively. It provides the same\nAPI as [gvm-script](#gvm-script) using the\n[python-gvm library](https://github.com/greenbone/python-gvm).\n\n#### Example program use\n\nConnect with given credentials via a unix domain socket and open an interactive\nshell:\n\n```bash\ngvm-pyshell --gmp-username user --gmp-password pass socket\n```\n\nConnect through SSH connection and open the interactive shell:\n\n```bash\ngvm-pyshell --hostname 127.0.0.1 ssh\n```\n\n## Support\n\nFor any question on the usage of `gvm-tools` or gmp scripts please use the\n[Greenbone Community Portal](https://community.greenbone.net/c/gmp). If you\nfound a problem with the software, please\n[create an issue](https://github.com/greenbone/gvm-tools/issues) on GitHub.\n\n## Maintainer\n\nThis project is maintained by [Greenbone AG](https://www.greenbone.net/).\n\n## Contributing\n\nYour contributions are highly appreciated. Please\n[create a pull request](https://github.com/greenbone/gvm-tools/pulls) on GitHub.\nFor bigger changes, please discuss it first in the\n[issues](https://github.com/greenbone/gvm-tools/issues).\n\nFor development you should use [poetry](https://python-poetry.org/)\nto keep you 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 `gvm-tools` (the directory containing the\n`pyproject.toml` file) to install all dependencies including the packages only\nrequired for development.\n\nAfterwards active the git hooks for auto-formatting and linting via\n[autohooks](https://github.com/greenbone/autohooks).\n\n poetry run autohooks activate --force\n\n## License\n\nCopyright (C) 2017-2024 [Greenbone AG](https://www.greenbone.net/)\n\nLicensed under the [GNU General Public License v3.0 or later](LICENSE).\n\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Tools to control a GSM/GVM over GMP or OSP",
"version": "24.8.0",
"project_urls": {
"Documentation": "https://greenbone.github.io/gvm-tools/",
"Homepage": "https://github.com/greenbone/gvm-tools/",
"Repository": "https://github.com/greenbone/gvm-tools/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "18f15f468c7cc558105eed7bf72078dc1dae97a33dae523d3a2422196afbbe44",
"md5": "3fb38bbce76d4bc25cfc860dbcfce0e9",
"sha256": "4576802c2d5b5c07f565abd0ffa2c4b02c323940a20e9eacdff1b2cfaec8a4b7"
},
"downloads": -1,
"filename": "gvm_tools-24.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3fb38bbce76d4bc25cfc860dbcfce0e9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 29914,
"upload_time": "2024-08-29T12:49:35",
"upload_time_iso_8601": "2024-08-29T12:49:35.149195Z",
"url": "https://files.pythonhosted.org/packages/18/f1/5f468c7cc558105eed7bf72078dc1dae97a33dae523d3a2422196afbbe44/gvm_tools-24.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "365b1767308e50b60d9ad111ccf14b3fb2aa1f4c1a29e3f3c40b77e3129b53fb",
"md5": "76d499e4ae0de83d7a3eff69c224061e",
"sha256": "8dbb4e996b34558f1f41c612277f418dc5658c14ae59b6240e6f961243c53504"
},
"downloads": -1,
"filename": "gvm_tools-24.8.0.tar.gz",
"has_sig": false,
"md5_digest": "76d499e4ae0de83d7a3eff69c224061e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 125390,
"upload_time": "2024-08-29T12:49:36",
"upload_time_iso_8601": "2024-08-29T12:49:36.610137Z",
"url": "https://files.pythonhosted.org/packages/36/5b/1767308e50b60d9ad111ccf14b3fb2aa1f4c1a29e3f3c40b77e3129b53fb/gvm_tools-24.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-29 12:49:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "greenbone",
"github_project": "gvm-tools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gvm-tools"
}
JSON
