Restringindo verificações do agent

Visão geral

Você pode controlar quais chaves de item o Zabbix agent ou o agent 2 têm permissão ou não para usar ao executar verificações de item, comandos remotos ou scripts.

Para isso, use estes parâmetros de configuração do agent para definir regras de permissão ou negação:

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

O <pattern> deve conter uma única chave de item.
Para AllowKey e DenyKey, o <pattern> aceita curingas (*). O curinga corresponde a qualquer quantidade de quaisquer caracteres em sua posição e pode ser usado para corresponder a chaves de item ou parâmetros (por exemplo, vfs.file.*[*]).
Para AllowKeyRegexp e DenyKeyRegexp, o <pattern> aceita expressões regulares. O padrão de expressão regular pode ser usado para corresponder a chaves de item e suas strings de parâmetros. Consulte também exemplos de escape correto.
Observe que o Zabbix agent e o Zabbix agent 2 podem aceitar sintaxes de expressão regular diferentes.

Ao contrário de outros parâmetros de configuração do agent, você pode especificar um número ilimitado de parâmetros AllowKey, DenyKey, AllowKeyRegexp ou DenyKeyRegexp.

Observações importantes

  • Use AllowKey ou AllowKeyRegexp para permitir apenas os itens necessários e DenyKey ou DenyKeyRegexp como a última regra para negar todos os demais. Isso é mais seguro do que depender apenas de regras de negação, pois novas versões do Zabbix agent podem introduzir chaves de item que não sejam abrangidas pelas suas regras DenyKey ou DenyKeyRegexp.

  • Torne as regras de permissão o mais específicas possível: use chaves de item exatas em vez de curingas (*) nas regras AllowKey e use padrões de expressão regular mais específicos nas regras AllowKeyRegexp.

  • Se você usar DenyKey ou DenyKeyRegexp, negue chaves de item inteiras em vez de arquivos ou comandos específicos. Regras que têm como alvo parâmetros específicos podem ser contornadas; por exemplo, a travessia de caminho (vfs.file.contents["../../../../etc/passwd"]) pode ler um arquivo que uma regra destinada a bloquear seu caminho direto deveria impedir. Para obter detalhes, consulte Protegendo regras de permissão/negação.

  • Todos os itens system.run são negados por padrão (mesmo quando DenyKey e DenyKeyRegexp estão vazios), como se DenyKey=system.run[*] tivesse sido definido como a última regra. Por isso, você pode permitir itens system.run específicos sem negar explicitamente outros itens system.run. Essa negação implícita se aplica somente a system.run; para todas as outras chaves, as regras de permissão não têm efeito a menos que uma regra de negação as siga.

  • A configuração de AllowKey, DenyKey, AllowKeyRegexp e DenyKeyRegexp não afeta os parâmetros do agent HostnameItem, HostMetadataItem ou HostInterfaceItem.

  • Os itens negados tornam-se não suportados sem qualquer indicação de que foram negados; eles têm a mesma aparência que chaves de item inexistentes. Por exemplo:

    • O parâmetro de linha de comando do Zabbix agent --print (-p) não exibirá chaves de item negadas.
    • O parâmetro de linha de comando do Zabbix agent --test (-t) retornará Unsupported item key. para chaves de item negadas.
    • Quando o registro em log está ativado (LogRemoteCommands=1), o arquivo de log do Zabbix agent não registrará comandos remotos negados.

Ordem das regras de अनुमति/negação

Você pode especificar um número ilimitado de regras AllowKey, DenyKey, AllowKeyRegexp ou DenyKeyRegexp, embora a ordem delas seja importante.

  • As regras são avaliadas uma a uma, de cima para baixo.
  • Quando uma item key corresponde a uma regra, ela é permitida ou negada, e a avaliação das regras é interrompida.

Por exemplo, ao avaliar vfs.file.contents[/etc/passwd], as regras são processadas da seguinte forma:

AllowKey=vfs.file.contents[/tmp/app.log]    # O padrão da item key não corresponde; o agent prossegue para a próxima regra.
AllowKey=vfs.file.contents[/etc/passwd]     # O padrão da item key corresponde; o agent permite a verificação do item e interrompe a avaliação das regras.
DenyKey=vfs.file.*[*]                       # O agent ignora a regra, pois a avaliação já foi interrompida.

A seguinte ordem de regras negará a verificação do item:

DenyKey=vfs.file.*[*]                       # O padrão da item key corresponde; o agent nega a verificação do item e interrompe a avaliação das regras.
AllowKey=vfs.file.contents[/etc/passwd]     # O agent ignora a regra, pois a avaliação já foi interrompida.
AllowKey=vfs.file.contents[/tmp/app.log]    # O agent ignora a regra, pois a avaliação já foi interrompida.

Exemplos

Os exemplos a seguir mostram padrões comuns de configuração para AllowKey, DenyKey, AllowKeyRegexp e DenyKeyRegexp.

Permitir verificações e comandos específicos

Permitir apenas duas verificações de item vfs.file e dois comandos system.run:

usando AllowKey e 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.*[*]

usando AllowKeyRegexp e DenyKeyRegexp:

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

Definir DenyKey=system.run[*] é desnecessário, pois todos os outros comandos system.run são negados por padrão (consulte Notas importantes).

Permitindo scripts

Permita que o Zabbix agent execute scripts nos hosts por meio de todos os métodos disponíveis:

  • Scripts globais que podem ser executados no frontend ou via API (este método sempre usa a chave system.run[myscript.sh])
  • Comandos remotos de operações de ação (este método sempre usa a chave system.run[myscript.sh,nowait])
  • Itens do Zabbix agent system.run com o script, por exemplo:
    • system.run[myscript.sh]
    • system.run[myscript.sh,wait]
    • system.run[myscript.sh,nowait]
AllowKey=system.run[myscript.sh,*]

ou

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

Para controlar o parâmetro wait/nowait, você deve definir uma regra diferente. Por exemplo, você pode permitir somente itens system.run[myscript.sh,wait], excluindo assim os outros métodos:

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

ou

AllowKeyRegexp=^system\.run\[myscript\.sh,wait\]$
Protegendo regras de permissão/negação

Estes exemplos mostram como proteger regras excessivamente permissivas AllowKey/AllowKeyRegexp ou DenyKey/DenyKeyRegexp.

Considere as seguintes regras:

usando AllowKey e DenyKey:

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

usando AllowKeyRegexp e DenyKeyRegexp:

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

No Windows, você deve escapar os espaços no caminho usando um acento circunflexo (^) para AllowKey ou DenyKey e \s para AllowKeyRegexp ou DenyKeyRegexp.

Essas regras contêm um caractere curinga (*), que pode ser usado indevidamente:

  • O script test.bat pode ser executado com quaisquer argumentos, inclusive argumentos não intencionais.
  • O padrão vfs.file.* corresponde a chaves de item sem parâmetros; no entanto, todos os itens vfs.file exigem parâmetros.
  • O padrão system.cpu.load[*] corresponde apenas a chaves de item com parâmetros; no entanto, os itens system.cpu.load não exigem parâmetros.

Para proteger essas regras, permita explicitamente a execução de test.bat somente com argumentos específicos e negue os padrões corretos de chave de item; por exemplo:

usando AllowKey e 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[*]

usando AllowKeyRegexp e DenyKeyRegexp:

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

Você pode testar as regras executando os comandos a seguir, que retornarão 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]
Exemplos de padrões

As tabelas a seguir mostram como os padrões de chave de item são correspondidos:

  • Uma chave corresponde ao padrão somente se atender a todas as condições da coluna Corresponde.
  • Os parâmetros devem estar totalmente delimitados por colchetes (por exemplo, vfs.file.contents[* e vfs.file.contents*utf8] são padrões inválidos).
  • Os exemplos ilustram apenas a correspondência de padrões; os itens reais exigem parâmetros.

Recomenda-se usar AllowKey ou AllowKeyRegexp para permitir explicitamente o acesso somente aos arquivos e comandos necessários, e DenyKey ou DenyKeyRegexp para negar chaves de item inteiras (consulte Observações importantes).

Usando regras baseadas em curingas:

Padrão Corresponde Exemplos
* Qualquer chave com ou sem parâmetros
vfs.file.* A chave começa com vfs.file.
Sem parâmetros
Corresponde a:
vfs.file.size
vfs.file.contents

Não corresponde a:
vfs.file.contents[]
vfs.file.size[/var/log/app.log]
vfs.*.contents A chave começa com vfs.
A chave termina com .contents
Sem parâmetros
Corresponde a:
vfs..contents
vfs.file.contents
vfs.mount.point.file.contents

Não corresponde a:
vfs.contents
vfs.file.contents[]
vfs.file.*[*] A chave começa com vfs.file.
Parâmetros quaisquer ou vazios
Corresponde a
vfs.file.get.custom[]
vfs.file.size[/var/log/app.log, utf8]

Não corresponde a:
vfs.file.get.custom
vfs.file.contents A chave é vfs.file.contents
Sem parâmetros
Corresponde a:
vfs.file.contents

Não corresponde a:
vfs.file.contents[/etc/passwd]
vfs.file.contents[] A chave é vfs.file.contents[]
Parâmetros vazios
Corresponde a:
vfs.file.contents[]

Não corresponde a:
vfs.file.contents
vfs.file.contents[*] A chave é vfs.file.contents
Parâmetros quaisquer ou vazios
Corresponde a:
vfs.file.contents[/path/to/file]

Não corresponde a:
vfs.file.contents
vfs.file.contents[/etc/passwd,*] A chave é vfs.file.contents
O primeiro parâmetro é /etc/passwd
Quaisquer parâmetros adicionais, vazios ou nenhum parâmetro adicional
Corresponde a:
vfs.file.contents[/etc/passwd,]
vfs.file.contents[/etc/passwd,utf8]
vfs.file.contents[/etc/passwd]

Não corresponde a:
vfs.file.contents[]
vfs.file.contents[*passwd*] A chave é vfs.file.contents
Exatamente um parâmetro contendo passwd
Corresponde a:
vfs.file.contents[/etc/passwd]

Não corresponde a:
vfs.file.contents[/etc/passwd,]
vfs.file.contents[/etc/passwd,utf8]
vfs.file.contents[*passwd*,*] A chave é vfs.file.contents
O primeiro parâmetro contém passwd
O segundo parâmetro pode ser qualquer um ou vazio
Corresponde a:
vfs.file.contents[/etc/passwd,]
vfs.file.contents[/etc/passwd,utf8]
vfs.file.contents[/etc/passwd]

Não corresponde a:
vfs.file.contents[/tmp/test]
vfs.file.contents[/etc/passwd,utf8] A chave é vfs.file.contents
O primeiro parâmetro é /etc/passwd
O segundo parâmetro é utf8
Corresponde a:
vfs.file.contents[/etc/passwd,utf8]

Não corresponde a:
vfs.file.contents[/etc/passwd,]
vfs.file.contents[/etc/passwd,utf16]

Usando regras baseadas em expressões regulares:

Padrão Corresponde Exemplos
^[\s\S]*$ Qualquer chave com ou sem parâmetros
^vfs\.file\.[^\[]*$ A chave começa com vfs.file.
Sem parâmetros
Corresponde a:
vfs.file.size
vfs.file.contents

Não corresponde a:
vfs.file.contents[]
vfs.file.size[/var/log/app.log]
^vfs\..*\.contents$ A chave começa com vfs.
A chave termina com .contents
Sem parâmetros
Corresponde a:
vfs..contents
vfs.mount.point.file.contents

Não corresponde a:
vfs.contents
vfs.file.contents[]
^vfs\.file\..*\[[\s\S]*\]$ A chave começa com vfs.file.
Parâmetros quaisquer ou vazios
Corresponde a
vfs.file.get.custom[]
vfs.file.size[/var/log/app.log, utf8]

Não corresponde a:
vfs.file.get.custom
^vfs\.file\.contents$ A chave é vfs.file.contents
Sem parâmetros
Corresponde a:
vfs.file.contents

Não corresponde a:
vfs.file.contents[/etc/passwd]
^vfs\.file\.contents\[\]$ A chave é vfs.file.contents[]
Parâmetros vazios
Corresponde a:
vfs.file.contents[]

Não corresponde a:
vfs.file.contents
^vfs\.file\.contents\[[\s\S]*\]$ A chave é vfs.file.contents
Parâmetros quaisquer ou vazios
Corresponde a:
vfs.file.contents[/path/to/file]

Não corresponde a:
vfs.file.contents
^vfs\.file\.contents\[/etc/passwd,[\s\S]*\]$ A chave é vfs.file.contents
O primeiro parâmetro é /etc/passwd
O segundo parâmetro pode ser qualquer um ou vazio
Corresponde a:
vfs.file.contents[/etc/passwd,]
vfs.file.contents[/etc/passwd,utf8]

Não corresponde a:
vfs.file.contents[]
vfs.file.contents[/etc/passwd]
^vfs\.file\.contents\[[\s\S]*passwd[\s\S]*\]$ A chave é vfs.file.contents
Quaisquer parâmetros, sendo que pelo menos um contém passwd
Corresponde a:
vfs.file.contents[/etc/passwd]
vfs.file.contents[/etc/passwd,]
vfs.file.contents[/etc/passwd,utf8]
^vfs\.file\.contents\[[^,]*passwd[^,]*,[\s\S]*\]$ A chave é vfs.file.contents
O primeiro parâmetro contém passwd
O segundo parâmetro pode ser qualquer um ou vazio
Corresponde a:
vfs.file.contents[/etc/passwd,]
vfs.file.contents[/etc/passwd,utf8]

Não corresponde a:
vfs.file.contents[/etc/passwd]
vfs.file.contents[/tmp/test]
^vfs\.file\.contents\[/etc/passwd,(utf8|windows-1252)\]$ A chave é vfs.file.contents
O primeiro parâmetro é /etc/passwd
O segundo parâmetro é utf8 ou windows-1252
Corresponde a:
vfs.file.contents[/etc/passwd,utf8]
vfs.file.contents[/etc/passwd,windows-1252]

Não corresponde a:
vfs.file.contents[/etc/passwd,]
vfs.file.contents[/etc/passwd,utf16]