エージェントチェックの制限

概要

アイテムチェック、リモートコマンド、またはスクリプトの実行時に、Zabbix エージェントまたはエージェント 2で使用を許可または禁止するアイテムキーを制御できます。

これを行うには、以下のエージェント設定パラメータを使用して、許可または禁止のルールを定義します。

  • AllowKey=<pattern>
  • DenyKey=<pattern>
  • AllowKeyRegexp=<pattern>
  • DenyKeyRegexp=<pattern>

<pattern>には、単一のアイテムキーを指定する必要があります。
AllowKeyおよびDenyKeyでは、<pattern>でワイルドカード(*)を使用できます。 ワイルドカードは、その位置にある任意の文字を任意の数だけ照合します。アイテムキーまたはパラメータの照合に使用できます(例:vfs.file.*[*])。
AllowKeyRegexpおよびDenyKeyRegexpでは、<pattern>で正規表現を使用できます。 正規表現パターンを使用して、アイテムキーおよびそのパラメータ文字列を照合できます。 正しいエスケープの例も参照してください。
Zabbix エージェントとZabbix エージェント 2では、サポートされる正規表現の構文が異なる場合があることに注意してください。

他のエージェント設定パラメータとは異なり、AllowKey、DenyKey、AllowKeyRegexp、またはDenyKeyRegexpパラメータは、無制限の数を指定できます。

重要な注意事項

  • 必要なアイテムのみを許可するには AllowKey または AllowKeyRegexp を使用し、その他すべてを拒否するルールとして DenyKey または DenyKeyRegexp を最後に指定します。 拒否ルールだけに依存するよりも安全です。新しい Zabbix エージェントのバージョンでは、DenyKey または DenyKeyRegexp ルールで対象になっていないアイテムキーが追加される可能性があるためです。

  • 許可ルールは可能な限り具体的に指定します。AllowKey ルールではワイルドカード(*)ではなく正確なアイテムキーを使用し、AllowKeyRegexp ルールでは最も具体的な正規表現パターンを使用します。

  • DenyKey または DenyKeyRegexp を使用する場合は、特定のファイルやコマンドではなく、アイテムキー全体を拒否します。 特定のパラメータを対象とするルールは回避される可能性があります。たとえば、パス・トラバーサル(vfs.file.contents["../../../../etc/passwd"])によって、直接のパスを対象とするルールでブロックするはずだったファイルを読み取ることができます。 詳細については、許可/拒否ルールのセキュリティ保護を参照してください。

  • すべての system.run アイテムは、デフォルトで拒否されます(DenyKey と DenyKeyRegexp が空の場合も同様です)。これは、最後のルールとして DenyKey=system.run[*] が設定されている場合と同じです。 このため、他の system.run アイテムを明示的に拒否しなくても、特定の system.run アイテムを許可できます。 この暗黙的な拒否は system.run にのみ適用されます。それ以外のすべてのキーでは、許可ルールの後に拒否ルールが続かない限り、許可ルールは効果を持ちません。

  • AllowKey、DenyKey、AllowKeyRegexp、DenyKeyRegexp の設定は、エージェントパラメータ HostnameItem、HostMetadataItem、HostInterfaceItem には影響しません。

  • 拒否されたアイテムは、拒否されたことを示す情報なしに未サポートになります。存在しないアイテムキーと同じように扱われます。たとえば、次のようになります。

    • Zabbix エージェントの --print (-p) コマンドラインパラメータには、拒否されたアイテムキーは表示されません。
    • Zabbix エージェントの --test (-t) コマンドラインパラメータは、拒否されたアイテムキーに対して Unsupported item key. を返します。
    • ロギングが有効(LogRemoteCommands=1)な場合、Zabbix エージェントのログファイルには、拒否されたリモートコマンドは記録されません。

許可/拒否ルールの順序

AllowKey、DenyKey、AllowKeyRegexp、または DenyKeyRegexp のルールは無制限に指定できますが、順序が重要です。

  • ルールは上から下へ、1つずつ評価されます。
  • アイテムキーがあるルールに一致すると、そのアイテムは許可または拒否され、ルールの評価は停止します。

たとえば、vfs.file.contents[/etc/passwd] を評価する場合、ルールは次のように処理されます。

AllowKey=vfs.file.contents[/tmp/app.log]    # アイテムキーのパターンは一致せず、エージェントは次のルールへ進みます。
AllowKey=vfs.file.contents[/etc/passwd]     # アイテムキーのパターンが一致し、エージェントはアイテムチェックを許可してルール評価を停止します。
DenyKey=vfs.file.*[*]                       # 評価はすでに停止しているため、エージェントはこのルールを無視します。

次のルール順では、アイテムチェックは拒否されます。

DenyKey=vfs.file.*[*]                       # アイテムキーのパターンが一致し、エージェントはアイテムチェックを拒否してルール評価を停止します。
AllowKey=vfs.file.contents[/etc/passwd]     # 評価はすでに停止しているため、エージェントはこのルールを無視します。
AllowKey=vfs.file.contents[/tmp/app.log]    # 評価はすでに停止しているため、エージェントはこのルールを無視します。

例

以下の例では、AllowKey、DenyKey、AllowKeyRegexp、DenyKeyRegexp の一般的な設定パターンを示します。

特定のチェックとコマンドを許可する

2つの vfs.file アイテムチェックと、2つの system.run コマンドのみを許可します。

AllowKey と DenyKey を使用する場合:

AllowKey=vfs.file.contents[/tmp/app.log]
AllowKey=vfs.file.size[/tmp/app.log]
AllowKey=system.run[/usr/bin/uptime]
AllowKey=system.run[/usr/bin/df -h /]
DenyKey=vfs.file.*[*]

AllowKeyRegexp と DenyKeyRegexp を使用する場合:

AllowKeyRegexp=^vfs\.file\.(contents|size)\[/tmp/app\.log\]$
AllowKeyRegexp=^system\.run\[/usr/bin/(uptime|df -h /)\]$
DenyKeyRegexp=^vfs\.file\..*\[[\s\S]*\]$

DenyKey=system.run[*] の設定は不要です。その他すべての system.run コマンドは、デフォルトで拒否されるためです(重要な注意事項を参照)。

スクリプトの許可

すべての利用可能な方法で、Zabbix エージェントがホスト上でスクリプトを実行できるようにします。

  • Webインターフェースまたは API 経由で実行できるグローバルスクリプト(この方法では常に system.run[myscript.sh] キーを使用します)
  • アクションの実行内容からのリモートコマンド(この方法では常に system.run[myscript.sh,nowait] キーを使用します)
  • スクリプトを指定した system.run Zabbix エージェントアイテム。例:
    • system.run[myscript.sh]
    • system.run[myscript.sh,wait]
    • system.run[myscript.sh,nowait]
AllowKey=system.run[myscript.sh,*]

または

AllowKeyRegexp=(?s)^system\.run\[myscript\.sh,.*\]$

wait/nowait パラメータを制御するには、別のルールを設定する必要があります。 たとえば、system.run[myscript.sh,wait] アイテムのみを許可し、その他の方法を除外できます。

AllowKey=system.run[myscript.sh,wait]

または

AllowKeyRegexp=^system\.run\[myscript\.sh,wait\]$
Allow/denyルールのセキュリティ保護

以下の例では、過度に許可範囲が広い AllowKey/AllowKeyRegexp または DenyKey/DenyKeyRegexp ルールを安全にする方法を示します。

次のルールを考えてみます。

AllowKey と DenyKey を使用する場合:

AllowKey=system.run["C:\Program^ Files\Zabbix^ Agent^ 2\scripts\test.bat*"]
DenyKey=vfs.file.*
DenyKey=system.cpu.load[*]

AllowKeyRegexp と DenyKeyRegexp を使用する場合:

AllowKeyRegexp=^system\.run\["C:\\Program\sFiles\\Zabbix\sAgent\s2\\scripts\\test\.bat.*"\]$
DenyKeyRegexp=^vfs\.file\..*$
DenyKeyRegexp=^system\.cpu\.load\[.*\]$

Windowsでは、AllowKey または DenyKey でパス内のスペースをエスケープするにはキャレット(^)を使用し、AllowKeyRegexp または DenyKeyRegexp では \s を使用する必要があります。

これらのルールにはワイルドカード(*)が含まれているため、悪用される可能性があります。

  • test.bat スクリプトを、意図しない引数を含む任意の引数で実行できます。
  • vfs.file.* パターンはパラメーターなしのアイテムキーに一致しますが、すべての vfs.file アイテムにはパラメーターが必要です。
  • system.cpu.load[*] パターンはパラメーター付きのアイテムキーにのみ一致しますが、system.cpu.load アイテムではパラメーターは必須ではありません。

これらのルールを安全にするには、特定の引数を指定した場合にのみ test.bat の実行を明示的に許可し、正しいアイテムキーパターンを拒否します。例:

AllowKey と DenyKey を使用する場合:

AllowKey=system.run["C:\Program^ Files\Zabbix^ Agent^ 2\scripts\test.bat status"]
AllowKey=system.run["C:\Program^ Files\Zabbix^ Agent^ 2\scripts\test.bat version"]
DenyKey=vfs.file.*[*]
DenyKey=system.cpu.load
DenyKey=system.cpu.load[*]

AllowKeyRegexp と DenyKeyRegexp を使用する場合:

AllowKeyRegexp=^system\.run\["C:\\Program\sFiles\\Zabbix\sAgent\s2\\scripts\\test\.bat (status|version)"\]$
DenyKeyRegexp=^vfs\.file\..+\[[\s\S]*\]$
DenyKeyRegexp=^system\.cpu\.load(\[.*\])?$

次のコマンドを実行してルールをテストできます。これらのコマンドは ZBX_NOTSUPPORTED を返します。

cd "C:\Program Files\Zabbix Agent 2"
zabbix_agent2.exe -t system.run["C:\Program^ Files\Zabbix^ Agent^ 2\scripts\test.bat debug"]
zabbix_agent2.exe -t vfs.file.size["C:\ProgramData\MyApp\config.ini"]
zabbix_agent2.exe -t vfs.file.contents["C:\Windows\System32\drivers\etc\hosts"]
zabbix_agent2.exe -t system.cpu.load
zabbix_agent2.exe -t system.cpu.load[all,avg1]
パターンの例

以下の表は、アイテムキーのパターンがどのように照合されるかを示しています。

  • キーは、Matches 列のすべての条件を満たす場合にのみパターンに一致します。
  • パラメータは角括弧で完全に囲む必要があります(例: vfs.file.contents[* および vfs.file.contents*utf8] は無効なパターンです)。
  • 例はパターン照合のみを示しています。実際のアイテムにはパラメータが必要です。

必要なファイルとコマンドへのアクセスのみを明示的に許可するには AllowKey または AllowKeyRegexp を使用し、アイテムキー全体を拒否するには DenyKey または DenyKeyRegexp を使用することを推奨します(重要な注意事項を参照)。

ワイルドカードベースのルールを使用する場合:

Pattern Matches Examples
* パラメータの有無を問わず、任意のキー
vfs.file.* キーが vfs.file. で始まる
パラメータなし
一致:
vfs.file.size
vfs.file.contents

不一致:
vfs.file.contents[]
vfs.file.size[/var/log/app.log]
vfs.*.contents キーが vfs. で始まる
キーが .contents で終わる
パラメータなし
一致:
vfs..contents
vfs.file.contents
vfs.mount.point.file.contents

不一致:
vfs.contents
vfs.file.contents[]
vfs.file.*[*] キーが vfs.file. で始まる
任意または空のパラメータ
一致
vfs.file.get.custom[]
vfs.file.size[/var/log/app.log, utf8]

不一致:
vfs.file.get.custom
vfs.file.contents キーが vfs.file.contents
パラメータなし
一致:
vfs.file.contents

不一致:
vfs.file.contents[/etc/passwd]
vfs.file.contents[] キーが vfs.file.contents[]
空のパラメータ
一致:
vfs.file.contents[]

不一致:
vfs.file.contents
vfs.file.contents[*] キーが vfs.file.contents
任意または空のパラメータ
一致:
vfs.file.contents[/path/to/file]

不一致:
vfs.file.contents
vfs.file.contents[/etc/passwd,*] キーが vfs.file.contents
最初のパラメータが /etc/passwd
2番目以降のパラメータは任意、空、またはなし
一致:
vfs.file.contents[/etc/passwd,]
vfs.file.contents[/etc/passwd,utf8]
vfs.file.contents[/etc/passwd]

不一致:
vfs.file.contents[]
vfs.file.contents[*passwd*] キーが vfs.file.contents
passwd を含むパラメータが1つだけ
一致:
vfs.file.contents[/etc/passwd]
不一致:
vfs.file.contents[/etc/passwd,]
vfs.file.contents[/etc/passwd,utf8]
vfs.file.contents[*passwd*,*] キーが vfs.file.contents
最初のパラメータに passwd が含まれる
2番目のパラメータは任意または空
一致:
vfs.file.contents[/etc/passwd,]
vfs.file.contents[/etc/passwd,utf8]
vfs.file.contents[/etc/passwd]

不一致:
vfs.file.contents[/tmp/test]
vfs.file.contents[/etc/passwd,utf8] キーが vfs.file.contents
最初のパラメータが /etc/passwd
2番目のパラメータが utf8
一致:
vfs.file.contents[/etc/passwd,utf8]

不一致:
vfs.file.contents[/etc/passwd,]
vfs.file.contents[/etc/passwd,utf16]

正規表現ベースのルールを使用する場合:

Pattern Matches Examples
^[\s\S]*$ パラメータの有無を問わず、任意のキー
^vfs\.file\.[^\[]*$ キーが vfs.file. で始まる
パラメータなし
一致:
vfs.file.size
vfs.file.contents

不一致:
vfs.file.contents[]
vfs.file.size[/var/log/app.log]
^vfs\..*\.contents$ キーが vfs. で始まる
キーが .contents で終わる
パラメータなし
一致:
vfs..contents
vfs.mount.point.file.contents

不一致:
vfs.contents
vfs.file.contents[]
^vfs\.file\..*\[[\s\S]*\]$ キーが vfs.file. で始まる
任意または空のパラメータ
一致
vfs.file.get.custom[]
vfs.file.size[/var/log/app.log, utf8]

不一致:
vfs.file.get.custom
^vfs\.file\.contents$ キーが vfs.file.contents
パラメータなし
一致:
vfs.file.contents

不一致:
vfs.file.contents[/etc/passwd]
^vfs\.file\.contents\[\]$ キーが vfs.file.contents[]
空のパラメータ
一致:
vfs.file.contents[]

不一致:
vfs.file.contents
^vfs\.file\.contents\[[\s\S]*\]$ キーが vfs.file.contents
任意または空のパラメータ
一致:
vfs.file.contents[/path/to/file]

不一致:
vfs.file.contents
^vfs\.file\.contents\[/etc/passwd,[\s\S]*\]$ キーが vfs.file.contents
最初のパラメータが /etc/passwd
2番目のパラメータは任意または空
一致:
vfs.file.contents[/etc/passwd,]
vfs.file.contents[/etc/passwd,utf8]

不一致:
vfs.file.contents[]
vfs.file.contents[/etc/passwd]
^vfs\.file\.contents\[[\s\S]*passwd[\s\S]*\]$ キーが vfs.file.contents
任意のパラメータ。少なくとも1つに passwd が含まれる
一致:
vfs.file.contents[/etc/passwd]
vfs.file.contents[/etc/passwd,]
vfs.file.contents[/etc/passwd,utf8]
^vfs\.file\.contents\[[^,]*passwd[^,]*,[\s\S]*\]$ キーが vfs.file.contents
最初のパラメータに passwd が含まれる
2番目のパラメータは任意または空
一致:
vfs.file.contents[/etc/passwd,]
vfs.file.contents[/etc/passwd,utf8]

不一致:
vfs.file.contents[/etc/passwd]
vfs.file.contents[/tmp/test]
^vfs\.file\.contents\[/etc/passwd,(utf8|windows-1252)\]$ キーが vfs.file.contents
最初のパラメータが /etc/passwd
2番目のパラメータが utf8 または windows-1252
一致:
vfs.file.contents[/etc/passwd,utf8]
vfs.file.contents[/etc/passwd,windows-1252]

不一致:
vfs.file.contents[/etc/passwd,]
vfs.file.contents[/etc/passwd,utf16]