ospd - OSPd is a framework for vulnerability scanners whi

项目说明

!Greenbone Logo

ospd <!-- omit in toc -->

:warning: ospd got merged into ospd-openvas. Therefore this repository is unmaintained and will not get any further changes!

![GitHub releases]()
![PyPI]()
![Scrutinizer Code Quality]()
![code test co]()
![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 a under the central Greenbone 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

Installation

Requirements

ospd requires Python >= 3.7 along with the following libraries:

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 de :

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 Manager which will automatically establish a full
GUI integration for the Greenbone Security Assistant (GSA).

For an example implementation see ospd-example-scanner.

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 de you should use poetry
to keep you python packages separated in different en. 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 de.

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.

项目信息

开发语言：Python

Star 数：33

技术要点

该项目属于安全软件方向的开源资源，代码结构清晰，适合安全研究人员学习参考。项目围绕OSPd is a framework for vulnerability scanners which share the same communication protocol: OSP (Open Scanner Protocol)展开，提供了可运行的实现，对理解相关安全机制、工具原理与攻防技术具有较高的研究价值。

从技术实现角度看，此类项目的核心在于对底层原理的深入理解与工程化落地。开发者在研究过程中可以结合官方文档与社区讨论，梳理项目的初始化流程、核心模块职责与数据流转，逐步掌握其中的技术细节与设计思路。

使用与学习建议

1. 下载源码压缩包，解压到本地环境。

2. 根据项目类型准备对应的运行环境与依赖。

3. 按照 README 中的步骤完成配置与部署。

4. 在隔离的测试环境中运行验证，避免影响生产系统。

免责声明

本资源来源于开源社区，仅供安全研究、技术学习与合法授权范围内的攻防演练使用，请勿用于任何非法或侵害他人权益的用途。使用本项目产生的一切后果由使用者自行承担。