Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/greenbone/pheme

pheme is a service to create scan reports
https://github.com/greenbone/pheme

base gea greenbone-networks python reporting reports vulnerability-management

Last synced: about 2 months ago
JSON representation

pheme is a service to create scan reports

Host: GitHub
URL: https://github.com/greenbone/pheme
Owner: greenbone
License: agpl-3.0
Created: 2020-08-12T07:11:30.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2024-04-15T06:22:23.000Z (9 months ago)
Last Synced: 2024-04-17T16:11:17.292Z (9 months ago)
Topics: base, gea, greenbone-networks, python, reporting, reports, vulnerability-management
Language: Python
Homepage:
Size: 11.5 MB
Stars: 9
Watchers: 11
Forks: 9
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        ![Greenbone Logo](https://www.greenbone.net/wp-content/uploads/gb_new-logo_horizontal_rgb_small.png)

# Pheme - Greenbone Static Report Generator 

[![GitHub releases](https://img.shields.io/github/release-pre/greenbone/pheme.svg)](https://github.com/greenbone/pheme/releases)

 [![PyPI release](https://img.shields.io/pypi/v/pheme.svg)](https://pypi.org/project/pheme/)

 [![code test coverage](https://codecov.io/gh/greenbone/pheme/branch/main/graph/badge.svg)](https://codecov.io/gh/greenbone/pheme)

 [![Build and test](https://github.com/greenbone/pheme/actions/workflows/ci-python.yml/badge.svg)](https://github.com/greenbone/pheme/actions/workflows/ci-python.yml)

**pheme** is a service to create scan reports. It is maintained by [Greenbone AG][Greenbone AG].

[Pheme](https://en.wikipedia.org/wiki/Pheme) is the personification of fame and renown.

Or in this case personification of a service to generate reports.

## Table of Contents 

- [Installation](#installation)

  - [Requirements](#requirements)

- [Development](#development)

- [Usage](#usage)

- [Maintainer](#maintainer)

- [Contributing](#contributing)

- [License](#license)

## Installation

### Requirements

Python 3.8 and later is supported.

Besides python `pheme` also needs to have

- libcairo2-dev

- pango1.0

installed.

## Development

**pheme** uses [poetry] for its own dependency management and build

process.

First install poetry via pip

    python3 -m pip install --user poetry

Afterwards run

    poetry install

in the checkout directory of **pheme** (the directory containing the

`pyproject.toml` file) to install all dependencies including the packages only

required for development.

Afterwards activate the git hooks for auto-formatting and linting via

[autohooks].

    poetry run autohooks activate

Validate the activated git hooks by running

    poetry run autohooks check

## Usage

In order to prepare the data structure the XML report data needs to be posted to `pheme` with a grouping indicator (either by host or nvt).

E.g.:

```

> curl -X POST 'http://localhost:8000/transform?grouping=nvt'\

    -H 'Content-Type: application/xml'\

    -H 'Accept: application/json'\

    -d @test_data/longer_report.xml

  "scanreport-nvt-9a233b0d-713c-4f22-9e15-f6e5090873e3"⏎

```

The returned identifier can be used to generate the actual report.

So far a report can be either in:

- application/json

- application/xml

- text/csv

E.g.

```

> curl -v 'http://localhost:8000/report/scanreport-nvt-9a233b0d-713c-4f22-9e15-f6e5090873e3' -H 'Accept: application/csv'

```

For visual report like

- application/pdf

- text/html

the corresponding css and html template needs to be put into pheme first:

```

> curl -X PUT localhost:8000/parameter\

    -H 'x-api-key: SECRET_KEY_missing_using_default_not_suitable_in_production'\

    --form vulnerability_report_html_css=@path_to_css_template\

    --form vulnerability_report_pdf_css=@path_to_css_template\

    --form vulnerability_report=@path_to_html_template

```

afterwards it can be get as usual:

```

> curl -v 'http://localhost:8000/report/scanreport-nvt-9a233b0d-713c-4f22-9e15-f6e5090873e3' -H 'Accept: application/pdf'

```

## Maintainer

This project is maintained by [Greenbone AG][Greenbone AG]

## Contributing

Your contributions are highly appreciated. Please

[create a pull request](https://github.com/greenbone/pheme/pulls)

on GitHub. Bigger changes need to be discussed with the development team via the

[issues section at GitHub](https://github.com/greenbone/pheme/issues)

first.

## License

Copyright (C) 2020-2023 [Greenbone AG][Greenbone AG]

Licensed under the [GNU Affero General Public License v3.0 or later](LICENSE).

[Greenbone AG]: https://www.greenbone.net/

[poetry]: https://python-poetry.org/

[autohooks]: https://github.com/greenbone/autohooks