Project

General

Profile

Actions

Documentation #8261

open

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

Added by Andreas Dolp 1 day ago. Updated about 4 hours ago.

Status:
Resolved
Priority:
Normal
Assignee:
Target version:
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 (2 open0 closed)

Documentation #8263: doc/userguide: fix within-distance pointer graphics in payload-keywords doc (8.0.x backport)AssignedOISF DevActions
Documentation #8264: doc/userguide: fix within-distance pointer graphics in payload-keywords doc (7.0.x backport)AssignedOISF DevActions
Actions #2

Updated by Shivani Bhardwaj about 23 hours ago

  • Assignee set to Andreas Dolp
  • Target version changed from TBD to 9.0.0-beta1
Actions #3

Updated by OISF Ticketbot about 23 hours ago

  • Subtask #8263 added
Actions #4

Updated by OISF Ticketbot about 23 hours ago

  • Label deleted (Needs backport to 8.0)
Actions #5

Updated by OISF Ticketbot about 23 hours ago

  • Subtask #8264 added
Actions #6

Updated by OISF Ticketbot about 23 hours ago

  • Label deleted (Needs backport to 7.0)
Actions #7

Updated by Shivani Bhardwaj about 4 hours ago

  • Status changed from In Progress to Resolved

Closed by: https://github.com/OISF/suricata/pull/14748
Thank you, Andreas and Annika! :)

Actions

Also available in: Atom PDF