付録C リダクション設定 YAML ファイルのオプション

# file-redaction.yaml
---

ファイル名を含むコメント (任意)。

# Exclude the entire output of commands
#   Specify the full command path or the symbolic name in .cache.json

 commands:
- /bin/rpm -qa
- /bin/ls
- ethtool_i

/bin/rpm -qa および bin/ls からの全出力がアーカイブファイルから除外されます。

.cache.json ファイルで /sbin/ethtool -i の全コマンドがシンボリック名 ethtool_i にマッピングされます。

# Exclude the entire output of files
#  Specify the full filename path or the symbolic name in .cache.json

files:
- /etc/audit/auditd.conf
- cluster_conf

指定されたファイルは、ファイル名とファイルの内容がアーカイブファイルから除外されます。

.cache.json ファイルで /etc/cluster/cluster.conf の完全ファイルパスがシンボリック名 cluster_conf にマッピングされます。

# file-content-redaction.yaml
---

ファイル名を含むコメント (任意)。

# Pattern redaction per matching line
#  Lines that match a pattern are excluded from files and command output.
#  Patterns are processed in the order that they are listed.
# Example

patterns:
 - "a_string_1"
 - "a_string_2"

パターンが a_string_1 または a_string_2 を含む行に完全一致する場合には、そのパターンがコマンドの出力やファイルから除外されます。パターンの文字列を引用符で囲みます。

#
# Regular expression pattern redaction per line
#  Patterns with regular expressions (regex) are wrapped with "regex:"
# Example

patterns:
 regex:
 - "abc.*def"
 - "localhost[[:digit:]]"
 #

正規表現は regex でラップされます。egrep コマンドで認識される正規表現 (regex) を使用できます。正規表現を引用符で囲みます。

# Lines matching these regular expressions are excluded
# from output.
patterns:
  regex:
  - "*\.conf"
  - "^include"

egrep 式は引用符で囲み、正規表現が正しく認識されるようにします。

この例では、文字列に .conf が含まれる場合、または行が include で始まる場合に、行がアーカイブファイルからリダクションされます。

# Replace keywords in files and command output with generic identifiers by the Python soscleaner module
keywords:
- "1.1.1.1"
- "My Name"
- "a_name"

keywords: 配列の文字列は、keyword の実際の値と数字に置き換えられます。

たとえば、1.1.1.1 の文字列は keyword0 に置き換えられます。文字列 My Name が出現するたびに、keyword1 に置き換えられます。a_name は keyword3 に置き換えられます。他に定義したキーワードは、keywordn (n は 1 ずつ漸増) に置き換えられます。置き換えられた keywordn の値は、Python SoS プロセスで決定されるので変更できません。

keywords: 配列で定義する文字列は、大文字と小文字が区別されます。