Table of contents
GVM-Tools is a collection of tools that help with remote controlling a Greenbone Security Manager (GSM) appliance and its underlying Greenbone Vulnerability Manager (GVM). The tools essentially aid accessing the communication protocols GMP (Greenbone Management Protocol) and OSP (Open Scanner Protocol).
Current Version: 1.3.1
This module is comprised of interactive and non-interactive clients as well as supporting libraries. The programming language Python is supported directly for interactive scripting and library use. But it is also possible to issue remote GMP/OSP commands without programming in Python.
GVM-Tools requires Python >= 3 along with the following libraries:
- python3-paramiko - python3-lxml - python3-dialog
Some scripts need additional requirements.
To install it, after downloading the repository, you can use pip like that:
pip install .
Otherwise y 7FD7 ou can use python itself to install it:
# System python3 setup.py install # Local python3 setup.py install --user
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
This little tool sends plain GMP/OSP commands and prints the result to the standard output. When the program is used without any parameters, it asks for an XML command and for the user credentials.
Returns the current version.
gvm-cli socket --xml "<get_version/>"Return all tasks.
gvm-cli socket --xml "<commands><authenticate><credentials><username>myuser</username><password>mypass</password></credentials></authenticate><get_tasks/></commands>"Reads a file with GMP commands and return the result.
gvm-cli socket --gmp-username foo --gmp-password bar < myfile.gmpThis tool has a lot more features than the simple gvm-cli client. You have the possibility to create your own custom scripts with commands from the gvm-lib and from python3 itself. The scripts can be pre-loaded in the program through an additional argument.
Open script.gmp over TLS connection.
gvm-pyshell tls --hostname=127.0.0.1 script.gmpConnect with given credentials and as unixsocket. Opens an interactive shell.
gvm-pyshell socket --gmp-username=user --gmp-password=pass -iConnect through SSH connection. Opens an interactive shell.
gvm-pyshell ssh --hostname=127.0.0.1 -i# Retrieve current GMP version
version = gmp.get_version()
# Prints the XML in beautiful form
pretty(version)
# Retrieve all tasks
tasks = gmp.get_tasks()
# Get names of tasks
task_names = tasks.xpath('task/name/text()')
pretty(task_names)With gvm-dialog you'll get a terminal-based dialog.
This client is experimental.
Example:
gvm-dialog socket