Documentation #8261: doc/userguide: fix within-distance pointer graphics in payload-keywords doc - Suricata - Open Information Security Foundation

Actions

Copy link

Documentation #8261

closed

AD AD

doc/userguide: fix within-distance pointer graphics in payload-keywords doc

Documentation #8261: doc/userguide: fix within-distance pointer graphics in payload-keywords doc

Added by Andreas Dolp 2 months ago. Updated 2 months ago.

Status:

Closed

Priority:

Normal

Assignee:

Andreas Dolp

Target version:

9.0.0-beta1

Affected Versions:

Effort:

low

Difficulty:

Label:

Description

Hi Suricata team,

according to this forum thread [1], the graphic 'within_distance2.png' in the userguide docs contain an error.
If the 'within' payload keyword is combined with the 'distance' keyword, 'within' does not refer only to the end of the previous match, but also includes the distance-pointer. In the graphic named this is stated otherwise, which can lead to confusion.

The graphics should be fixed by placing the within-pointer between g-h instead of f-g.

Fixed this in a new graphic by some GIMP arts.

I did a first PR [2] requesting to open a redmine ticket, because this should also be backported to 7.x and 8.x.
After getting the ticket number, I will do a second PR with the fix referencing the ticket number.

Thanks and best regards!
Andreas

PS: Special thanks to one of our team members Annika C. for initially spotting this!

[1] https://forum.suricata.io/t/is-within-affected-by-distance/1688
[2] https://github.com/OISF/suricata/pull/14744

Subtasks 2 (0 open — 2 closed)