Skip to content

Add feature to download debrief pdf report via API #2666

@L015H4CK

Description

@L015H4CK

What problem are you trying to solve? Please describe.
The API already offers many possibilities to interact with the CALDERA server.
Adding the possibility to download the PDF report created by the debrief plugin via API would be really useful to further automate CALDERA's functionalities.

The ideal solution: What should the feature should do?
The PDF report created by the debrief plugin should be downloadable via API.

What category of feature is this?

  • UI/UX
  • API
  • Other

If you have code or pseudo-code please provide:

Similar to the JSON report via curl:

curl -X 'POST' 'http://localhost:8888/api/v2/operations/<operation-id>/pdfreport' -H 'accept: application/json' -H 'Content-Type: application/json' -H 'KEY: ADMIN123'

Alternatively:

curl -X 'POST' 'http://localhost:8888/plugin/debrief/pdf' -H 'accept: application/json' -H 'Content-Type: application/json' -d '{"operations": ["<operation-id>"]}' -H 'KEY: ADMIN123'

Additional context
See discussion #2658.

Note: In theory the pdf report (or more exact the pdf bytes) can already be downloaded via the API with a call like this:

curl -X 'POST' 'http://localhost:8888/plugin/debrief/pdf' -H 'accept: application/json' -H 'Content-Type: application/json' -H 'KEY: ADMIN123' -d '{"operations":["<operation-id>"], "graphs": {}, "header-logo": "", "report-sections": ["main-summary", "statistics", "agents"]}'

This results in a "basic report" that does not include the nice graphs created by the debrief plugin.
In order to get a report that includes the graphs, one would have to know the IDs/encoded values of the respective attackpaths, facts, steps, tactics and techniques - which I think is not realistic (see linked discussion update 2).

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions