Project

General

Profile

Actions

Documentation #8738

open
JI OD

config: document support for dotted configuration keys in YAML

Documentation #8738: config: document support for dotted configuration keys in YAML

Added by Jason Ish about 9 hours ago.

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

Description

Background

Feature #4783 added support for fully qualified configuration keys in YAML configuration files and includes. For example:

vars.address-groups.HOME_NET: "[192.0.2.0/24]" 

This addresses the same configuration node as:

vars:
  address-groups:
    HOME_NET: "[192.0.2.0/24]" 

Another valid example using the Suricata configuration is:

app-layer.protocols.smtp.mime.body-md5: yes

This behavior was implemented by PR #8439 but is not documented in the user guide. The existing documentation only demonstrates dotted configuration paths with the command-line --set option.

Dotted keys are particularly useful in configuration include or override files because they update a specific leaf without removing sibling settings such as EXTERNAL_NET or other application-layer protocol settings.


Related issues 2 (1 open1 closed)

Related to Suricata - Feature #4783: config/yaml: Allow fully qualified configuration keys (top.sub.sub: value)ClosedJason IshActions
Related to Suricata - Feature #8427: Feature request: support glob patterns in include directiveNewSamaresh Kumar singhActions

JI Updated by Jason Ish about 9 hours ago Actions #1

  • Related to Feature #4783: config/yaml: Allow fully qualified configuration keys (top.sub.sub: value) added
  • Related to Feature #8427: Feature request: support glob patterns in include directive added
Actions

Also available in: PDF Atom