Skip to main content

report-generation-service

Project description

Greenbone Logo

Pheme - Greenbone Static Report Generator

pheme is a service to create scan reports. It is maintained by Greenbone Networks.

Pheme is the personification of fame and renown.

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

Table of Contents

Installation

Requirements

Python 3.7 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

API overview

To get an overview of the API you can start this project

poetry run python manage.py runserver

and then go to swagger

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 Networks GmbH

Contributing

Your contributions are highly appreciated. Please create a pull request on GitHub. Bigger changes need to be discussed with the development team via the issues section at GitHub first.

License

Copyright (C) 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

pheme-21.4rc4.tar.gz (35.9 kB view details)

Uploaded Source

Built Distribution

pheme-21.4rc4-py3-none-any.whl (51.9 kB view details)

Uploaded Python 3

File details

Details for the file pheme-21.4rc4.tar.gz.

File metadata

  • Download URL: pheme-21.4rc4.tar.gz
  • Upload date:
  • Size: 35.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.7.10

File hashes

Hashes for pheme-21.4rc4.tar.gz
Algorithm Hash digest
SHA256 d6f539cb99366dac6ca3ad4141277e3d072cacaf6922e3617d257f443f758f79
MD5 ebee83cd219a917b0e7df9d7c842a8ef
BLAKE2b-256 68960192dfe9e3b41c05e89a5ba4c5de29fd2f36b55679c96a32613cff91b0ea

See more details on using hashes here.

Provenance

File details

Details for the file pheme-21.4rc4-py3-none-any.whl.

File metadata

  • Download URL: pheme-21.4rc4-py3-none-any.whl
  • Upload date:
  • Size: 51.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.7.10

File hashes

Hashes for pheme-21.4rc4-py3-none-any.whl
Algorithm Hash digest
SHA256 8e7dd823e4cc132fbc97d015117863f55fe7ffa9deb773942987774ecb039b6d
MD5 da998b0e130dca46a1d29b55c067c295
BLAKE2b-256 6c4f5548b6931944d817688aaf73b7bc51ee158452ce611c6a04c196d943cc8f

See more details on using hashes here.

Provenance

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