You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
1.1. Goals
The design goals for YAML are, in decreasing priority: 1 YAML should be easily readable by humans.
2 YAML data should be portable between programming languages.
3 YAML should match the native data structures of dynamic languages.
4 YAML should have a consistent model to support generic tools.
5 YAML should support one-pass processing.
6 YAML should be expressive and extensible.
7 YAML should be easy to implement and use.
Regarding strings, it also specifies:
The plain (unquoted) style has no identifying indicators and provides no form of escaping. It is therefore the most readable, most limited and most context sensitive style.
Since punctuation like quotes adds clutter to the rule, that all the fields in the rules don't use quotes for this reason, and to respect the first goal of YAML, I suggest that the specification changes its guideline to the following:
The rule files are written in yaml format To keep the rules interoperable use the following:
[...]
Do not use any quote for strings, unless it contains #'", it starts or end by white space caracters or the string starts with any of these caracters: :?[]{},&*!|>%@\n\r\t. To use line feed (\n) or tab caracters (\t), use double quotes ". For any other case, use single quotes '.
Example:
title: Test ruledescription: Test rule for specificationauthor: Émilio Gonzalezdate: 2023/07/19logsource:
category: process_creationproduct: windowsdetection:
selection:
Image: C:\Windows\System32\whoami.exeFileName: whoami.exeAuthor: "'threatactor1\t"DateWritten: 2023-01-14 12:34:56SomeOtherField: ':something:'condition: selectionlevel: high
This example is made to have all the quote possibilities, but realistically, the vast majority of rules do not require quotes at all, which would make most sigma rules more readable.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
The YAML specification 1.2.2 (latest) specifies:
Regarding strings, it also specifies:
However, the Sigma specification asks for quotes for strings:
However, this only seems respected in the
selection
s block of the rules, as seen in the example rule:Since punctuation like quotes adds clutter to the rule, that all the fields in the rules don't use quotes for this reason, and to respect the first goal of YAML, I suggest that the specification changes its guideline to the following:
Example:
This example is made to have all the quote possibilities, but realistically, the vast majority of rules do not require quotes at all, which would make most sigma rules more readable.
Beta Was this translation helpful? Give feedback.
All reactions