The Greenbone Vulnerability Management Python API library (python-gvm) is a collection of APIs that help with remote controlling a Greenbone Security Manager (GSM) appliance and its underlying Greenbone Vulnerability Manager (GVM). The library essentially abstracts accessing the communication protocols Greenbone Management Protocol (GMP) and Open Scanner Protocol (OSP).

• Installation
  • Requirements
  • Install using pip
• Example
• Support
• Maintainer
• Contributing
• License

Python 3.5 and later is supported.

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

pip install python-gvm

alternatively download or clone this repository and install the latest development version:

pip install .

from gvm.connections import UnixSocketConnection
from gvm.protocols.latest import Gmp
from gvm.transforms import EtreeTransform
from gvm.xml import pretty_print

connection = UnixSocketConnection()
transform = EtreeTransform()
gmp = Gmp(connection, transform)

# Retrieve current GMP version
version = gmp.get_version()

# Prints the XML in beautiful form
pretty_print(version)

# Login
gmp.authenticate('foo', 'bar')

# Retrieve all tasks
tasks = gmp.get_tasks()

# Get names of tasks
task_names = tasks.xpath('task/name/text()')
pretty_print(task_names)

The documentation for python-gvm can be found at https://python-gvm.readthedocs.io/

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

This project is maintained by Greenbone Networks GmbH.

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 python-gvm (the directory containing the Pipfile) to install all dependencies including the packages only required for development.

Copyright (C) 2017-2018 Greenbone Networks GmbH

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