Project

General

Profile

Actions

Task #2974

closed

detect: check all keyword urls

Added by Victor Julien almost 5 years ago. Updated over 4 years ago.

Status:
Closed
Priority:
Normal
Target version:
Effort:
Difficulty:
Label:

Description

Each detection keyword registers an documentation URL, or should do so. This happens in the per keyword *Register function.

To check:

$ suricata --list-keywords=all
...
base64_decode:
    Description: Decodes base64 encoded data.
    Features: none
    Documentation: https://suricata.readthedocs.io/en/latest/rules/payload-keywords.html#base64-decode
...

For each keyword where an url is missing, add it. For each url that is somehow wrong, fix it.

For each url that does not lead to actually written documentation, open a feature ticket.


Related issues 1 (0 open1 closed)

Related to Suricata - Optimization #3137: Make description of all keywords consistent and prettyClosedShivani BhardwajActions
Actions #1

Updated by Shivani Bhardwaj almost 5 years ago

  • Status changed from Assigned to Feedback
Actions #2

Updated by Andreas Herz almost 5 years ago

should we also change the name, since it doesn't cover the protocol keywords which come after the action? or include them as well?

And we might need to extend the issue https://redmine.openinfosecfoundation.org/issues/635 as well since those are not included in this list as well, any ideas how to proceed with that?

Actions #3

Updated by Shivani Bhardwaj almost 5 years ago

PR: https://github.com/OISF/suricata/pull/3984 This only partially fixes the issue. There are many keywords which do not have docs. Tickets corresponding to all such keywords have been created.

Actions #4

Updated by Victor Julien almost 5 years ago

  • Target version changed from TBD to 5.0rc1
Actions #5

Updated by Shivani Bhardwaj over 4 years ago

  • Status changed from Feedback to Assigned
Actions #6

Updated by Shivani Bhardwaj over 4 years ago

  • Related to Optimization #3137: Make description of all keywords consistent and pretty added
Actions #7

Updated by Shivani Bhardwaj over 4 years ago

  • Status changed from Assigned to Feedback
Actions #8

Updated by Shivani Bhardwaj over 4 years ago

  • Status changed from Feedback to Assigned
Actions #9

Updated by Victor Julien over 4 years ago

  • Status changed from Assigned to Closed
  • Priority changed from Low to Normal
Actions

Also available in: Atom PDF