Project

General

Profile

Actions
Copy link

Documentation #8372

open
JF PA

rules: fix typos/ missing keywords in rule examples

Documentation #8372: rules: fix typos/ missing keywords in rule examples

Added by Juliana Fajardini Reichow 25 days ago. Updated 5 days ago.

Status:
In Review
Priority:
Normal
Assignee:
Philippe Antoine
Target version:
9.0.0-beta1
Affected Versions:
Effort:
Difficulty:
Label:

Description

As shown in https://github.com/OISF/suricata/pull/15015, typos and missing keywords can happen (and do exist) in the docs,
since rules used in examples many times aren't tested.

Review the existing rules and fix them.
Besides the ones fixed on that PR, capture-hardware/ebpf-xdp.rst has two.

Would be good if we could automate this, somehow, after fixing the docs...

JF Updated by Juliana Fajardini Reichow 18 days ago Actions
Copy link
 #1

  • Status changed from New to In Review

PR for review: https://github.com/OISF/suricata/pull/15068

There may be more, but didn't know how to search

PA Updated by Philippe Antoine 18 days ago Actions
Copy link
 #2

git grep "any any" doc

git grep "alert " doc | grep sid

JF Updated by Juliana Fajardini Reichow 7 days ago Actions
Copy link
 #3

  • Assignee changed from Juliana Fajardini Reichow to Philippe Antoine

Assigning to Philippe as he's interested in trying some techniques to address this one.

PA Updated by Philippe Antoine 5 days ago Actions
Copy link
 #4

  • Status changed from In Review to In Progress

PA Updated by Philippe Antoine 5 days ago Actions
Copy link
 #5

  • Status changed from In Progress to In Review

PA Updated by Philippe Antoine 5 days ago Actions
Copy link
 #6

There may be more, but didn't know how to search

6 more found including

Error: detect-bsize: signature can't match as required content length 16 exceeds bsize value: 14 [DetectBsizeValidateContentCallback:detect-bsize.c:91]

which is hard to spot by just reading the signature

Actions
Copy link

Also available in: PDF Atom