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 Scrutinizer Code Quality code test coverage CircleCI

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

Table of Contents

Documentation

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

Installation

Version

Please consider to always use the newest version of gvm-tools and python-gvm. We freqently update this projects to add features and keep them free from bugs. This is why installing python-gvm using pip is recommended.

The current release of python-gvm can be used with all supported GOS versions.

Requirements

Python 3.5 and later is supported.

Install using pip

pip 19.0 or later is required.

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 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 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-2020 Greenbone Networks GmbH

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-21.1.0.tar.gz (180.5 kB view details)

Uploaded Source

Built Distribution

python_gvm-21.1.0-py3-none-any.whl (103.0 kB view details)

Uploaded Python 3

File details

Details for the file python-gvm-21.1.0.tar.gz.

File metadata

  • Download URL: python-gvm-21.1.0.tar.gz
  • Upload date:
  • Size: 180.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.55.1 CPython/3.7.9

File hashes

Hashes for python-gvm-21.1.0.tar.gz
Algorithm Hash digest
SHA256 669796df97f92b3aca9126a7bcc057143b1a3eba793c9e7183fb2cadc1d8a327
MD5 683f60de11d37e07d52b3e4c3c7a77fa
BLAKE2b-256 49579deefc272daedef4dcd5f0e96cbd5028a8952741f202882ca85038193a5d

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: python_gvm-21.1.0-py3-none-any.whl
  • Upload date:
  • Size: 103.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.55.1 CPython/3.7.9

File hashes

Hashes for python_gvm-21.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7b4d1d36761e20f910d8b69e2e8fb6f2a1d76652d944b26160a68e09c3965021
MD5 16bcc50b19ba86949a6d79d6256b15c2
BLAKE2b-256 cb7a93d38aacd1c6d12dc98712be68b79444894c1b814cd3343131b5d2417cbd

See more details on using hashes here.

Provenance

Supported by

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