sysreptor icon indicating copy to clipboard operation
sysreptor copied to clipboard

[Feature Request] Suggest vulnerabilities link in markdown fields

Open danymat opened this issue 1 year ago • 1 comments

When writing a report, we may want to add a link to reference vulnerabilities, such as documented here: https://docs.sysreptor.com/reporting/references/

To improve usability and discovery of this feature, I would like to see a way for sysreptor to suggest a link to be written. The exact way could still be discussed, but here are some ideas:

  • A completion system: starting to write [vulnerability](# will trigger the list of findings to be selected
  • In the WYSIWYG markdown input field, adding an icon (next/on top) to the url icon to add a link to a finding, still selectable.

danymat avatar Sep 26 '24 09:09 danymat

Thanks for the suggestion. We will add a button to the markdown editor's toolbar to insert finding references.

image

MWedl avatar Oct 02 '24 12:10 MWedl

Implemented in https://github.com/Syslifters/sysreptor/releases/tag/2024.79

MWedl avatar Oct 15 '24 12:10 MWedl

It works great ! Thanks :)

danymat avatar Oct 28 '24 08:10 danymat

By the way, we see that it pastes the finding as: [](#uuid). Any reason to not put in by default the title of the finding ? Such as: `title ?

danymat avatar Nov 06 '24 12:11 danymat

We do not copy the title into markdown text, because when the title of the referenced finding is updated, the markdown text would not change. When the title is left empty, SysReptor dynamically resolves the finding reference during PDF rendering. By using dynamic references, it is possible to customize the reference format via CSS (e.g. chapter number instead of title).

Auto-resolving requires @import "/assets/global/base.css"; at the top of the design's CSS.

MWedl avatar Nov 06 '24 13:11 MWedl

Makes sense !

danymat avatar Nov 08 '24 15:11 danymat