Skip to main content
Pre-release

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

Author:

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

Version:
Version 0.0.1
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-Manager, a layer between OpenVAS-Scanner and various client applications such as OpenVAS-Client or Greenbone Security Assistant. Among other features, it adds server-side storage of scan results and it makes it unnecessary for a scan client to keep the connection open until the scan finishes.

OpenVAS Management Protocol (OMP) is the protocol based on XML to talk to the OpenVAS-Manager. openvas.omplib is a pure-Python implementation of OMP which allows easy access to the OpenVAS-Manager.

Example:

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

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

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

Requirements and Installation

openvas.omplib 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.omplib.

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

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

When you are reading this you most probably already downloaded and unpacked openvas.omplib. 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.omplib is a breeze:

easy_install openvas.omplib

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

easy_install openvas.omplib-*.tar.gz

More Hints on Installing setuptools

openvas.omplib 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.omplib 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.omplib.

Release files for openvas.omplib 0.0.1dev-r7491

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.omplib 0.0.1dev-r7491
File Size Uploaded
openvas.omplib-0.0.1dev-r7491.zip 43.1 kB Details
openvas.omplib-0.0.1dev-r7491.tar.bz2 30.5 kB Details

Release files / openvas.omplib-0.0.1dev-r7491.zip

Download URL openvas.omplib-0.0.1dev-r7491.zip
Size 43.1 kB
Tags Source
SHA-256 checksum
How to use checksums
717a7807fac029d0537768191e8c065e562ed8bce086dd233c24a2907a3761fc
BLAKE2b-256 checksum
How to use checksums
036db68ac38b4c8948ee6c7fed767daed9d9b8c4dc7fd07bbb8c7cf7e316847f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / openvas.omplib-0.0.1dev-r7491.tar.bz2

Download URL openvas.omplib-0.0.1dev-r7491.tar.bz2
Size 30.5 kB
Tags Source
SHA-256 checksum
How to use checksums
59b6555203471d9dc71c844d85d8bf4ac389372e366a9b5ff0c53d61db268751
BLAKE2b-256 checksum
How to use checksums
2b3d4f20f390ae8c0ec1fa899260cdbe6cb4d7e9e425717f1d4a10dfaca79699
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

0.1.0

This release
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