gvm-tools  2.0.0
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). Series 2.x.
  Fossies Dox: gvm-tools-2.0.0.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-2.0.0.tar.gz contents page and use the Fossies standard member browsing features (also with source code highlighting and additionally with optional code folding).
README.md

Greenbone Logo

Greenbone Vulnerability Management Tools

GitHub releases PyPI release Scrutinizer Code Quality code test coverage CircleCI

The Greenbone Vulnerability Management Tools or gvm-tools in short are 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).

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

Documentation

The documentation for gvm-tools can be found at https://gvm-tools.readthedocs.io/. Please always take a look at the documentation for further details. This README just gives you a short overview.

Installation

See the documentation for all supported installation options.

Requirements

Python 3.5 and later is supported.

Install using pip

You can install the latest stable release of gvm-tools from the Python Package Index using pip:

pip install --user gvm-tools

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 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/>"

Returns the current version using a TLS connection with certificates.

gvm-cli tls --hostname 192.168.0.10 --port 1234 --certfile '/tmp/certs/cert.pem' --keyfile '/tmp/certs/key.pem' --cafile '/tmp/certs/cert.pem' --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 --gmp-username foo --gmp-password socket bar < myfile.xml

Note that gvm-cli will by default raise an exception 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:

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 and from Python 3 itself.

Example script

# 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/" 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 using the python-gvm library.

Example program use

Connect with given credentials via a unix domain socket and open an interactive shell.

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

Connect through SSH connection and open the interactive shell.

gvm-pyshell ssh --hostname=127.0.0.1 -i

Support

For any question on the usage of gvm-tools or gmp scripts please use the Greenbone Community Portal. If you found a problem with the software, please create an issue on GitHub.

Maintainer

This project is maintained by Greenbone Networks GmbH.

Contributing

Your contributions are highly appreciated. Please create a pull request on GitHub. For bigger changes, please discuss it first in the issues.

For development you should use pipenv to keep you python packages separated in different environments. First install pipenv via pip

pip install --user pipenv

Afterwards run

pipenv install --dev

in the checkout directory of gvm-tools (the directory containing the Pipfile) to install all dependencies including the packages only required for development.

License

Copyright (C) 2017-2018 Greenbone Networks GmbH

Licensed under the GNU General Public License v3.0 or later.