Skip to main content

Library to communicate with remote servers over GMP or OSP

Project description

Greenbone Logo

Greenbone Vulnerability Management Python Library

GitHub releases PyPI release code test coverage Build and test

The Greenbone Vulnerability Management Python API library (python-gvm) is a collection of APIs that help with remote controlling Greenbone Community Edition installations and Greenbone Enterprise Appliances. The library essentially abstracts accessing the communication protocols Greenbone Management Protocol (GMP) and Open Scanner Protocol (OSP).

Table of Contents

Documentation

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

Installation

Version

python-gvm uses semantic versioning.

Versions prior to 26.0.0 used calendar versioning.

Please consider to always use the newest releases of gvm-tools and python-gvm. We frequently update these projects to add features and keep them free from bugs.

[!IMPORTANT] To use python-gvm with GMP version of 7, 8 or 9 you must use a release version that is <21.5. In the 21.5 release the support of these versions has been dropped.

[!IMPORTANT] To use python-gvm with GMP version 20.8 or 21.4 you must use a release version that is <24.6. In the 24.6 release the support of these versions has been dropped.

Requirements

Python 3.9 and later is supported.

Install using pip

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

python3 -m pip install --user python-gvm

Example

from gvm.connections import UnixSocketConnection
from gvm.protocols.gmp import GMP
from gvm.transforms import EtreeTransform
from gvm.xml import pretty_print

connection = UnixSocketConnection()
transform = EtreeTransform()

with GMP(connection, transform=transform) as gmp:
    # Retrieve GMP version supported by the remote daemon
    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)

Support

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

Maintainer

This project is maintained by Greenbone AG.

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

The python-gvm repository uses autohooks to apply linting and auto formatting via git hooks. Please ensure the git hooks are active.

poetry install
poetry run autohooks activate --force

License

Copyright (C) 2017-2025 Greenbone AG

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python_gvm-26.3.0.tar.gz (237.5 kB view details)

Uploaded Source

Built Distribution

python_gvm-26.3.0-py3-none-any.whl (159.0 kB view details)

Uploaded Python 3

File details

Details for the file python_gvm-26.3.0.tar.gz.

File metadata

  • Download URL: python_gvm-26.3.0.tar.gz
  • Upload date:
  • Size: 237.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.11

File hashes

Hashes for python_gvm-26.3.0.tar.gz
Algorithm Hash digest
SHA256 d22280330dcf94e18cd1204d14ebdeee7a41eb9c06ebec6ee7acbaa925f64b00
MD5 be218be5f2ff8d2310a7ab587b2d1f37
BLAKE2b-256 c9587ee72e23e3c495804e2bb7842fbcfcfda94febb5f63fe42e989c9be7e90e

See more details on using hashes here.

Provenance

The following attestation bundles were made for python_gvm-26.3.0.tar.gz:

Publisher: deploy-pypi.yml on greenbone/python-gvm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file python_gvm-26.3.0-py3-none-any.whl.

File metadata

  • Download URL: python_gvm-26.3.0-py3-none-any.whl
  • Upload date:
  • Size: 159.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.11

File hashes

Hashes for python_gvm-26.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0d107b88bd1ad49fa1b802442e723350e4278264bce5c689d81915ba0b39e387
MD5 904aafaf8512db8c689ccb62129d306d
BLAKE2b-256 0f66b0a5fb719e57ce39552b6a9e2a08ba9ac1e227334fa6d2e89f6f9fabaa00

See more details on using hashes here.

Provenance

The following attestation bundles were made for python_gvm-26.3.0-py3-none-any.whl:

Publisher: deploy-pypi.yml on greenbone/python-gvm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page