Project

General

Profile

Actions

Documentation #2016

open

doc: improve keywords self documentation

Added by Eric Leblond over 4 years ago. Updated almost 2 years ago.

Status:
New
Priority:
Normal
Assignee:
Target version:
Affected Versions:
Effort:
Difficulty:
Label:

Description

Newly introduced keyword follow a different logic compared to previous one. For example, if we take http_user_agent, it applies on content placed before it. This is the contrary for a keyword like tls_sni. But the information provided by list-keywords are the same:

= tls_sni =
Description: content modifier to match specifically and only on the TLS
SNI buffer
Features: No option,payload inspecting keyword
= http_user_agent =
Description: content modifier to match only on the HTTP User-Agent
header
Features: No option,payload inspecting keyword

Consequence is that user has not enough information to know how to use it.

At minimum I propose we use context setter instead of content modifier

Actions #1

Updated by Victor Julien over 4 years ago

  • Target version set to TBD
Actions #2

Updated by Victor Julien over 4 years ago

  • Subject changed from Improve keywords self documentation to doc: improve keywords self documentation
  • Assignee set to OISF Dev
Actions #3

Updated by Andreas Herz almost 2 years ago

  • Tracker changed from Feature to Documentation
Actions #4

Updated by Victor Julien almost 2 years ago

Content modifier is a term that we just use for certain types of keywords.

I think this issue is mostly fixed.

Actions

Also available in: Atom PDF