Project

General

Profile

Actions

Documentation #4658

open

Add/improve documentation for pcre substring capture logging

Added by Juliana Fajardini Reichow over 1 year ago. Updated 13 days ago.

Status:
Assigned
Priority:
Normal
Assignee:
Target version:
Affected Versions:
Effort:
Difficulty:
Label:

Description

Currently, if a user wants to log a matching string from a rule that uses `pcre`, there isn't much documentation to help them understand how can they do that.
Our documentation has:
https://suricata.readthedocs.io/en/suricata-6.0.3/rules/payload-keywords.html#pcre-perl-compatible-regular-expressions
And some `suricata-verify` tests could provide some examples:
https://github.com/OISF/suricata-verify/blob/master/tests/eve-metadata/test.rules
And others in the eve-matadata-* dirs.

But we could have all that better documented.

(image offers context from ad hoc support offered in our IRC chat)


Files

Screenshot from 2021-09-02 16-41-26.png (56.9 KB) Screenshot from 2021-09-02 16-41-26.png Juliana Fajardini Reichow, 09/02/2021 03:37 PM
Actions #2

Updated by Jason Ish about 2 months ago

  • Status changed from New to Assigned
  • Assignee set to Jason Ish
  • Target version changed from TBD to 7.0.0-rc1

Going to try to address this a.s.a.p.

Actions #3

Updated by Victor Julien 13 days ago

  • Target version changed from 7.0.0-rc1 to 7.0.0
Actions

Also available in: Atom PDF