Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

openvas.oaplib

An OAP (OpenVAS Administration Protocol) client interface for Python.

Author:

Hartmut Goebel <h.goebel@goebel-consult.de>

Version:

Version 0.0.1

Copyright:

GNU Public Licence v3 (GPLv3)

Homepage:

http://www.openvas.org/

OpenVAS (Open Vulnerability Assessment System) is a network security scanner with associated tools. OpenVAS Version 3 introduces a new core component: The OpenVAS-Administrator. It is intended to simplify the configuration and administration of an OpenVAS server both on a local installation as well as on a remote system.

OpenVAS Administration Protocol (OAP) is the protocol based on XML to talk to the OpenVAS-Administrator. openvas.oaplib is a pure-Python implementation of OAP which allows easy access to the OpenVAS-Administrator.

This package also includes a command line tool oap-cli which uses sub-commands like svn or openssl does. See examples below.

Example:

admin = openvas.oaplib.OAPClient(host=sensor)
admin.open(username, password)
admin.create_user(name, password, role, hosts)
admin.modify_user(name, role="Admin")
admin.sync_feed()
# ... later ...
settings = admin.get_settings()
pprint.pprint(settings)

openvas.opmlib also supports a low-level interface where you can send OAP XML directly:

help_text = admin.xml('<help/>')

Examples for oap-cli usage:

oap-cli –help # get help oap-cli get-users –help # get help on subcommand get-users oap-cli create-user –new-pass xxx john oap-cli get-users john

Requirements and Installation

openvas.oaplib requires

  • Python 2.5 or higher with SSL support (which should be the

    default on most platforms) (NB: Python 3.x is not supported)

  • setuptools for installation (see below).

  • argparse (already included in Python starting with Python 2.7)

Hints for installing on Windows:

Following the links above you will find .msi and .exe-installers. Simply install them and continue with installing openvas.oaplib.

Hints for installing on Linux:

Most current Linux distributions provide packages for the requirements. Look for packages names like python-setuptools and python-argparse. Simply install them and continue with installing openvas.oaplib.

Hint for installing on other platforms:

Many vendors provide Python. Please check your vendors software repository. Otherwise please download Python 2.6 (or any higer version from the 2.x series) from http://www.python.org/download/ and follow the installation instructions there.

After installing Python, install setuptools. You may want to read More Hints on Installing setuptools first.

Using setuptools, compiling and installing the remaining requirements is a piece of cake:

# if the system has network access
easy_install argparse

# without network access download argparse
# from http://pypi.python.org/pypi/argparse and run
easy_install argparse-*.zip

Installing openvas.oaplib

When you are reading this you most probably already downloaded and unpacked openvas.oaplib. Thus installing is as easy as running:

python ./setup.py install

Otherwise you may install directly using setuptools/easy_install. If your system has network access installing openvas.oaplib is a breeze:

easy_install openvas.oaplib

Without network access download openvas.oaplib from http://pypi.python.org/pypi/openvas.oaplib and run:

easy_install openvas.oaplib-*.tar.gz

More Hints on Installing setuptools

openvas.oaplib uses setuptools for installation. Thus you need either

  • network access, so the install script will automatically download and install setuptools if they are not already installed

or

  • the correct version of setuptools preinstalled using the EasyInstall installation instructions. Those instructions also have tips for dealing with firewalls as well as how to manually download and install setuptools.

Custom Installation Locations

openvas.oaplib is just a single script (aka Python program). So you can copy it where ever you want (maybe fixing the first line). But it’s easier to just use:

# install to /usr/local/bin
python ./setup.py install --prefix /usr/local

# install to your Home directory (~/bin)
python ./setup.py install --home ~

Please mind: This effects also the installation of pfPDf (and setuptools) if they are not already installed.

For more information about Custom Installation Locations please refer to the Custom Installation Locations Instructions before installing openvas.oaplib.

Metadata

Release files for openvas.oaplib 0.0.1dev-r7742

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distributions (sdists)

Source distribution for openvas.oaplib 0.0.1dev-r7742
File Size Uploaded Provenance Actions
openvas.oaplib-0.0.1dev-r7742.zip 41.5 kB Without provenance Details for openvas.oaplib-0.0.1dev-r7742.zip
openvas.oaplib-0.0.1dev-r7742.tar.bz2 27.8 kB Without provenance Details for openvas.oaplib-0.0.1dev-r7742.tar.bz2

Release files / openvas.oaplib-0.0.1dev-r7742.zip

Download URL openvas.oaplib-0.0.1dev-r7742.zip
Size 41.5 kB
Tags Source
SHA-256 checksum
How to use checksums
680effdf64fe24e9cd5c53a88cbf73f12faee7c5eab3ab6f465dca5b6caa0b91
BLAKE2b-256 checksum
How to use checksums
da9efcebb7d4b98ad1cb18fc8d9198e2d569ace54c9e69f24a4f021c50efad39
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / openvas.oaplib-0.0.1dev-r7742.tar.bz2

Download URL openvas.oaplib-0.0.1dev-r7742.tar.bz2
Size 27.8 kB
Tags Source
SHA-256 checksum
How to use checksums
e0171fff99380d3e263cc72f01db86f0c2da8a32c1479e86c1920fc956188b71
BLAKE2b-256 checksum
How to use checksums
130d1e312c4d27ce7b729f2d897db69fc26d5331c66a94cad54c900e91c8c3ae
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for openvas.oaplib 0.0.1dev-r7742

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page