Improve generate report

[madelondohmen]

Changes

This PR makes a lot of changes to (mostly) the HTML of the Generate Reports.

The following changes are made to meet the design :

• Add a table of contents
• Update the header
• Add chapter numbers
• Update the download report button
• Change "Summary" to "Asset overview"

Other changes that have been made to the Generate Report:

• Add the human readable OOI to the titles of the reports (instead of the full OOI name)
• Add text to the report when no data has been found (insead of showing nothing/an empty report)
• Add "-" to some tables when no data has been found (instead of showing an empty field)
• Fix some headings that were too big
• Add "nowrap" class to TTL column in DNS report
• Add introductory text at the beginning of each section
• Change the order of the reports
• Fix styling of Risk Levels (severity_level)

Issue link

Closes #2588
Closes #2422

Demo

Before

After

Opens

This PR opens some new issues:
#2671 and #2655

Code Checklist

• All the commits in this PR are properly PGP-signed and verified.
• This PR only contains functionality relevant to the issue; tickets have been created for newly discovered issues.
• I have written unit tests for the changes or fixes I made.
• For any non-trivial functionality, I have added integration and/or end-to-end tests.
• I have performed a self-review of my code and refactored it to the best of my abilities.

Communication

• I have informed others of any required .env changes files if required and changed the .env-dist accordingly.
• I have made corresponding changes to the documentation, if necessary.
• I have included comments in the code to elaborate on what is not self-evident from the code itself, including references to issues and discussions online, or implicit behavior of an interface.

---

Checklist for code reviewers:

Copy-paste the checklist from the docs/source/templates folder into your comment.

---

Checklist for QA:

Copy-paste the checklist from the docs/source/templates folder into your comment.

[ammar92]

Looks good in general; just a few tips to improve it even more. There are probably more use cases of joins and blocktranslate vs translate calls that I haven't seen

[ammar92]

Looks good to me 👍

[stephanie0x00]

Checklist for QA:

• I have checked out this branch, and successfully ran a fresh make reset.
• I confirmed that there are no unintended functional regressions in this branch:
  • I have managed to pass the onboarding flow
  • Objects and Findings are created properly
  • Tasks are created and completed properly
• I confirmed that the PR's advertised feature or hotfix works as intended.

What works:

Looks good! I did find some things we could improve to make it better. I've added them to the last section. I expect some/maybe all things can be picked up in different tickets.

What doesn't work:

n/a

Bug or feature?:

• Takes a long time to generate the report for all 12 report types.

• Asset Overview should be sorted based on type I think where Hostnames should appear before IP addresses.

  • The object primary key "IPService|internet||tcp|443|https" should drop the 'IPService|internet' part and only show IP address, port, service, protocol. Maybe this should be done through additional columns.
  • Selected report types should be sorted based on either the order of the reports or otherwise alphabetically (a-z). There are arguments for both. I think a-z is the easiest for implementation for now.

• Change text from "No ciphers found for this IPService." to "No ciphers were found for this combination of IP address, port and service."

• The order of all the reports is now based on IP/hostname, I think it become more organised to sort these based on report type and within that report show the output per OOI. Unsure if this is even possible in the current setup.

• The primary key now is something like: "TLS Report for IPService|internet||tcp|443|https" it becomes more readable if this is something like: TLS Report for on port for .

  • Primary key in Safe Cnonections report for the section name of the compliance issues table is now "IPAddressV4|internet|" It becomes more readable if this just says: IP

  • Primary keys of sections: Is it possible to split the IP (and protocol) from the URL/Hostname? Thus instead of 'https://1.2.3.4:443/tcp' we show 'https://1.2.3.4' at 'port: 443/tcp'

[madelondohmen]

* Change text from "No ciphers found for this IPService." to "No ciphers were found for this combination of IP address, port and service."

* The order of all the reports is now based on IP/hostname, I think it become more organised to sort these based on report type and within that report show the output per OOI. Unsure if this is even possible in the current setup.

These two should now be resolved. I have created a new ticket for the other improvements and I will create another PR for those.

[stephanie0x00]

Changes look good. Ready for merge.