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.

Example:

admin = openvas.oaplib.OAPClient(host=sensor)
admin.open(username, password)
admin.create_target(job_name, targets, comment)
task_id = admin.create_task(job_name, comment, config=config_name,
                              target=job_name)
report_id = admin.start_task(task_id)
# ... later ...
report = admin.get_report(report_id)
print etree.tostring(report)

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

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

Requirements and Installation

openvas.oaplib requires

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, python-argparse and python-openssl. 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 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 pyOpenSSL

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

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-r7499

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-r7499
File Size Uploaded Provenance Actions
openvas.oaplib-0.0.1dev-r7499.zip 35.2 kB Without provenance Details for openvas.oaplib-0.0.1dev-r7499.zip
openvas.oaplib-0.0.1dev-r7499.tar.bz2 23.3 kB Without provenance Details for openvas.oaplib-0.0.1dev-r7499.tar.bz2

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

Download URL openvas.oaplib-0.0.1dev-r7499.zip
Size 35.2 kB
Tags Source
SHA-256 checksum
How to use checksums
8cde0c1dd6225650b26d0893f9ddf434b61cfe1e651b278b9843b06128b0dc1f
BLAKE2b-256 checksum
How to use checksums
c1a88d3a1a98ae5e6ea95116ccaf15aaedc1edbd1aa93f4c380928ec4efe0f20
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

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

Download URL openvas.oaplib-0.0.1dev-r7499.tar.bz2
Size 23.3 kB
Tags Source
SHA-256 checksum
How to use checksums
3cf362196f9faab954e181be1ef34113769666fbcb6504f582be2772b6f714f0
BLAKE2b-256 checksum
How to use checksums
5659b4658d0bf91020b8b26c06925c7e2a0c9bcc44de2a063578bbddb3b8beac
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for openvas.oaplib 0.0.1dev-r7499

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