Skip to main content

OSPD is a base for scanner wrappers which share the same communication protocol: OSP (Open Scanner Protocol)

Project description

Greenbone Logo

ospd

GitHub releases PyPI Scrutinizer Code Quality code test coverage CircleCI

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

Releases

 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.

Installation

Requirements

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

Support

For any question on the usage of OSPD please use the Greenbone Community Portal. If you found a problem with the software, please create an issue on GitHub.

Maintainer

This project is maintained by Greenbone Networks GmbH.

Contributing

Your contributions are highly appreciated. Please create a pull request on GitHub. For bigger changes, please discuss it first in the issues.

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

Afterwards run

poetry install

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

License

Copyright (C) 2009-2020 Greenbone Networks GmbH

Licensed under the GNU Affero General Public License v3.0 or later.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ospd-21.4.4.tar.gz (100.6 kB view details)

Uploaded Source

Built Distribution

ospd-21.4.4-py3-none-any.whl (74.6 kB view details)

Uploaded Python 3

File details

Details for the file ospd-21.4.4.tar.gz.

File metadata

  • Download URL: ospd-21.4.4.tar.gz
  • Upload date:
  • Size: 100.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for ospd-21.4.4.tar.gz
Algorithm Hash digest
SHA256 671cea59e63a7956a378f26275fc14693accacf90d91bddc76b914f48cbd6346
MD5 148781696ed1213e44ea57d8c2a7abb3
BLAKE2b-256 39dc94613f32d3aeb014f5098defbc918195ab8db14aa24af37a2673d72683a0

See more details on using hashes here.

File details

Details for the file ospd-21.4.4-py3-none-any.whl.

File metadata

  • Download URL: ospd-21.4.4-py3-none-any.whl
  • Upload date:
  • Size: 74.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for ospd-21.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f726b79ce0057027b6661734a5a79cafffe404a6b8587ab28f22181903e5a731
MD5 71a013a46c198592ba4be4be5d425956
BLAKE2b-256 18faca4e91aebfc684efd37b31786cc2aaaf9be807e878724c76c93b060248c1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page