Package: openvas.oaplib
Author:Hartmut Goebel <h.goebel@goebel-consult.de>Version:Version 0.1.0Copyright: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.oaplibis a pure-Python
implementation of OAP which allows easy access to the
OpenVAS-Administrator.This package also includes a command line tooloap-clifor
interacting with openvas-administrator. For easy of usage, this tool
uses sub-commands much like svn or openssl does.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.opmlibalso supports a low-level interface where you can send
OAP XML directly:help_text = admin.xml('<help/>')Examples foroap-cliusage: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 johnRequirements and Installationopenvas.oaplibrequiresPython 2.5or higher with SSL support (which should be thedefault on most platforms) (NB: Python 3.x isnotsupported)setuptoolsfor 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
withinstalling openvas.oaplib.Hints for installing on GNU/Linux:Most current GNU/Linux distributions
provide packages for the requirements. Look for packages names likepython-setuptoolsandpython-argparse. Simply install them and
continue withinstalling 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) fromhttp://www.python.org/download/and follow the installation
instructions there.After installing Python, installsetuptools. You may want to
readMore Hints on Installing setuptoolsfirst.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-*.zipInstalling openvas.oaplibWhen you are reading this you most probably already downloaded and
unpackedopenvas.oaplib. Thus installing is as easy as running:python ./setup.py installOtherwise you may install directly using setuptools/easy_install. If
your system has network access installingopenvas.oaplibis a
breeze:easy_install openvas.oaplibWithout network access downloadopenvas.oaplibfromhttp://pypi.python.org/pypi/openvas.oapliband run:easy_install openvas.oaplib-*.tar.gzMore Hints on Installing setuptoolsopenvas.oaplibuses setuptools for installation. Thus you need
eithernetwork access, so the install script will automatically download
and install setuptools if they are not already installedorthe correct version of setuptools preinstalled using theEasyInstall installation instructions. Those instructions also
have tips for dealing with firewalls as well as how to manually
download and install setuptools.Custom Installation Locationsopenvas.oaplibis 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 argparse (and
setuptools) if they are not already installed.For more information about Custom Installation Locations please refer
to theCustom Installation Locations Instructionsbefore
installingopenvas.oaplib.