OSPD is a base for scanner wrappers which share the same communication protocol: OSP (Open Scanner Protocol)
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.
Table of Contents
- Table of Contents
- How to write your own OSP Scanner Wrapper
All release files are signed with
the Greenbone Community Feed integrity key.
This gpg key can be downloaded at https://www.greenbone.net/GBCommunitySigningKey.asc
and the fingerprint is
8AE4 BE42 9B60 A59B 311C 2E73 9823 FAA6 0ED1 E580.
ospd requires Python >= 3.7 along with the following libraries:
- python3-paramiko - python3-lxml - python3-defusedxml
Install using pip
You can install ospd from the Python Package Index using pip:
python3 -m pip install ospd
Alternatively download or clone this repository and install the latest development version:
python3 -m pip install .
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.md 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: https://docs.greenbone.net/GSM-Manual/gos-3.1/en/osp.html#how-to-write-your-own-osp-wrapper
This project is maintained by Greenbone Networks GmbH.
For development you should use poetry to keep you python packages separated in different environments. First install poetry via pip
python3 -m pip install --user poetry
in the checkout directory of ospd (the directory containing the
pyproject.toml file) to install all dependencies including the packages only
required for development.
The ospd repository uses autohooks to apply linting and auto formatting via git hooks. Please ensure the git hooks are active.
poetry install poetry run autohooks activate --force
Copyright (C) 2009-2020 Greenbone Networks GmbH
Licensed under the GNU Affero General Public License v3.0 or later.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size ospd-21.4.3-py3-none-any.whl (74.6 kB)||File type Wheel||Python version py3||Upload date||Hashes View|
|Filename, size ospd-21.4.3.tar.gz (100.4 kB)||File type Source||Python version None||Upload date||Hashes View|