Project

General

Profile

Actions

Documentation #3727

closed

byte_extract documentation is missing some optional arguments

Added by Roland Fischer over 1 year ago. Updated about 1 year ago.

Status:
Closed
Priority:
Low
Target version:
-
Affected Versions:
Effort:
low
Difficulty:
Label:
Beginner

Description

The byte_extract documentation is missing some optional args such as litte, big, multiplier, etc

This is on the master branch, but technically impacts all versions that support these optional args. These args have existed for many years already. git blame shows the changes as 6+ years old.

Current doc mentions:
https://github.com/OISF/suricata/blob/master/doc/userguide/rules/payload-keywords.rst#byte_extract

byte_extract implements some optional args:
https://github.com/OISF/suricata/blob/master/src/detect-byte-extract.c#L276

Should be able to copy the doc together from byte_jump fairly trivially, see https://github.com/OISF/suricata/blob/master/doc/userguide/rules/payload-keywords.rst#byte_jump

I can provide a PR once I get around to it.

Actions #1

Updated by Victor Julien over 1 year ago

  • Status changed from In Review to Assigned

Jeff Lucovsky you've been doing some work in this area. Pinging you to make sure we're not duplicating efforts.

Actions #2

Updated by Roland Fischer over 1 year ago

No worries. Have not done anything yet. ;) We'll wait what Jeff is coming back with.

Actions #3

Updated by Roland Fischer about 1 year ago

  • Status changed from Assigned to Closed
Actions

Also available in: Atom PDF