ospd  1.3.2
About: OSPd is a base class for scanner wrappers which share the same communication protocol: OSP (OpenVAS Scanner Protocol). OpenVAS-9.
  Fossies Dox: ospd-1.3.2.tar.gz  ("inofficial" and yet experimental doxygen-generated source code documentation)  

ospd Documentation

Some Fossies usage hints in advance:

  1. To see the Doxygen generated documentation please click on one of the items in the steelblue colored "quick index" bar above or use the side panel at the left which displays a hierarchical tree-like index structure and is adjustable in width.
  2. If you want to search for something by keyword rather than browse for it you can use the client side search facility (using Javascript and DHTML) that provides live searching, i.e. the search results are presented and adapted as you type in the Search input field at the top right.
  3. Doxygen doesn't incorporate all member files but just a definable subset (basically the main project source code files that are written in a supported language). So to search and browse all member files you may visit the Fossies
  4. ospd-1.3.2.tar.gz contents page and use the Fossies standard member browsing features (also with source code highlighting and additionally with optional code folding).

About OSPD

OSPD is a base class for scanner wrappers which share the same communication protocol: OSP (Open Scanner Protocol). OSP creates a unified interface for different security scanners and makes their control flow and scan results consistently available under the central Greenbone Vulnerability Manager service.

OSP is similar in many ways to GMP (Greenbone Management Protocol): XML-based, stateless and non-permanent connection.

The design supports wrapping arbitrary scanners with same protocol OSP, sharing the core daemon options while adding scanner specific parameters and options.

OSPD is licensed under GNU General Public License Version 2 or any later version. Please see file COPYING for details.

All parts of OSPD are Copyright (C) by Greenbone Networks GmbH (see http://www.greenbone.net).

How to install OSPD?

You can install ospd from the Python Package Index using pip:

pip install ospd

How to write your own OSP Scanner Wrapper

As a core you need to derive from the class OSPDaemon from ospd.py. See the documentation there for the single steps to establish the full wrapper.

See the file doc/INSTALL-ospd-scanner about how to register a OSP scanner at the Greenbone Vulnerability Manager which will automatically establish a full GUI integration for the Greenbone Security Assistant (GSA).

There are some online resources about this topic: http://docs.greenbone.net/GSM-Manual/gos-3.1/en/osp.html#how-to-write-your-own-osp-wrapper

Module structure

  • ospd/ospd.py: Core OSP Daemon class.
  • ospd/misc.py: Miscellaneous code and classes related to OSPD.
  • ospd/ospd_ssh.py: OSP Daemon class for simple remote SSH-based command execution.
  • ospd/win_socket.py: Network class/functions for running a OSP daemon on Windows systems.