Project

General

Profile

Actions

Documentation #3727

closed

byte_extract documentation is missing some optional arguments

Added by Roland Fischer almost 4 years ago. Updated almost 4 years 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

Also available in: Atom PDF