gvm-tools  1.4.1
About: 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). OpenVAS-8 and OpenVAS-9.
  Fossies Dox: gvm-tools-1.4.1.tar.gz  ("inofficial" and yet experimental doxygen-generated source code documentation)  

gvm-tools Documentation

Some Fossies usage hints in advance:

  1. To see the Doxygen generated documentation please click on one of the items in the steelblue colored "quick index" bar above or use the side panel at the left which displays a hierarchical tree-like index structure and is adjustable in width.
  2. If you want to search for something by keyword rather than browse for it you can use the client side search facility (using Javascript and DHTML) that provides live searching, i.e. the search results are presented and adapted as you type in the Search input field at the top right.
  3. Doxygen doesn't incorporate all member files but just a definable subset (basically the main project source code files that are written in a supported language). So to search and browse all member files you may visit the Fossies
  4. gvm-tools-1.4.1.tar.gz contents page and use the Fossies standard member browsing features (also with source code highlighting and additionally with optional code folding).
README.rst

image

GVM-Tools

Table of contents

Introduction

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.4.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.

Requirements

GVM-Tools requires Python >= 3 along with the following libraries:

- python3-paramiko
- python3-lxml
- python3-dialog
- python3-defusedxml

The file 'requirements.txt' is used for CI tests to ensure the CI tests happen in a defined known-good environment and are not affected by sudden changes in the dependent modules.

Some scripts need additional requirements.

Installing

To install it, after downloading the repository, you can use pip like that:

pip install .

Otherwise you can use python itself to install it:

# System
python3 setup.py install

# Local
python3 setup.py install --user

Clients

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 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.

Example program use

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.gmp

gvm-pyshell

This 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.

Example program use

Open script.gmp over TLS connection.

gvm-pyshell tls --hostname=127.0.0.1 script.gmp

Connect with given credentials and as unixsocket. Opens an interactive shell.

gvm-pyshell socket --gmp-username=user --gmp-password=pass -i

Connect through SSH connection. Opens an interactive shell.

gvm-pyshell ssh --hostname=127.0.0.1 -i

Example script

# 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)

More example scripts

There is a growing collection of gmp-scripts in the folder "scripts/". Some of them might be exactly what you need and all of them help writing your own gmp scripts.

gvm-dialog

With gvm-dialog you'll get a terminal-based dialog.

This client is experimental.

Example:

gvm-dialog socket