Referência de comando da CLI de sensores de rede OT

Este artigo lista os comandos da CLI disponíveis nos sensores de rede OT do Defender para IoT.

Pré-requisitos

Antes de executar qualquer um dos comandos da CLI a seguir, você precisará acessar a CLI em seu sensor de rede OT como um usuário privilegiado.

Embora este artigo liste a sintaxe de comando para cada usuário, recomendamos usar o usuário admin para todos os comandos da CLI em que o usuário admin é compatível.

Para saber mais, confira Acessar a CLI e Acesso de usuário privilegiado para monitoramento de OT.

Manutenção de dispositivos

Verificar a integridade dos serviços de monitoramento de OT

Use os comandos a seguir para verificar se o aplicativo Defender para IoT no sensor OT está funcionando corretamente, incluindo o console Web e os processos de análise de tráfego.

As verificações de integridade também estão disponíveis no console do sensor OT. Para obter mais informações, confira Solucionar problemas do sensor.

Usuário	Comando	Sintaxe de comando completa
admin	system sanity	Nenhum atributo
cyberx, ou admin com acesso root	cyberx-xsense-sanity	Nenhum atributo

O exemplo a seguir mostra a sintaxe e a resposta do comando para o usuário administrador :

shell> system sanity
[+] C-Cabra Engine | Running for 17:26:30.191945
[+] Cache Layer | Running for 17:26:32.352745
[+] Core API | Running for 17:26:28
[+] Health Monitor | Running for 17:26:28
[+] Horizon Agent 1 | Running for 17:26:27
[+] Horizon Parser | Running for 17:26:30.183145
[+] Network Processor | Running for 17:26:27
[+] Persistence Layer | Running for 17:26:33.577045
[+] Profiling Service | Running for 17:26:34.105745
[+] Traffic Monitor | Running for 17:26:30.345145
[+] Upload Manager Service | Running for 17:26:31.514645
[+] Watch Dog | Running for 17:26:30
[+] Web Apps | Running for 17:26:30

System is UP! (medium)

Reiniciar um dispositivo

Use os comandos a seguir para reiniciar o dispositivo de sensor OT.

Usuário	Comando	Sintaxe de comando completa
admin	system reboot	Nenhum atributo
cyberx_host ou administrador com acesso root	sudo reboot	Nenhum atributo

Por exemplo, para o usuário administrador :

shell> system reboot

Desligar um dispositivo

Use os comandos a seguir para desligar o dispositivo de sensor OT.

Usuário	Comando	Sintaxe de comando completa
admin	system shutdown	Nenhum atributo
cyberx_host ou administrador com acesso root	sudo shutdown -r now	Nenhum atributo

Por exemplo, para o usuário administrador :

shell> system shutdown

Mostrar a versão do software instalada

Use os comandos a seguir para listar a versão de software do Defender para IoT instalada no sensor OT.

Usuário	Comando	Sintaxe de comando completa
admin	system version	Nenhum atributo
cyberx ou administrador com acesso root	cyberx-xsense-version	Nenhum atributo

Por exemplo, para o usuário administrador :

shell> system version
Version: 22.2.5.9-r-2121448

Mostrar a data/hora atual do sistema

Use os comandos a seguir para mostrar a data e a hora atual do sistema no sensor de rede OT, no formato GMT.

Usuário	Comando	Sintaxe de comando completa
admin	date	Nenhum atributo
cyberx ou administrador com acesso root	date	Nenhum atributo
cyberx_host ou administrador com acesso root	date	Nenhum atributo

Por exemplo, para o usuário administrador :

shell> date
Thu Sep 29 18:38:23 UTC 2022
shell>

Ativar a sincronização de horário NTP

Use os comandos a seguir para ativar a sincronização de horário do dispositivo com um servidor NTP.

Para usar esses comandos, verifique se:

• O servidor NTP pode ser alcançado na porta de gerenciamento do dispositivo
• Você usa o mesmo servidor NTP para sincronizar todos os dispositivos de sensor e o console de gerenciamento local

Usuário	Comando	Sintaxe de comando completa
admin	ntp enable <IP address>	Nenhum atributo
cyberx ou administrador com acesso root	cyberx-xsense-ntp-enable <IP address>	Nenhum atributo

Nesses comandos, <IP address> é o endereço IP de um servidor NTP IPv4 válido usando a porta 123.

Por exemplo, para o usuário administrador :

shell> ntp enable 129.6.15.28
shell>

Desativar a sincronização de horário NTP

Use os comandos a seguir para desativar a sincronização de horário do dispositivo com um servidor NTP.

Usuário	Comando	Sintaxe de comando completa
admin	ntp disable <IP address>	Nenhum atributo
cyberx ou administrador com acesso root	cyberx-xsense-ntp-disable <IP address>	Nenhum atributo

Nesses comandos, <IP address> é o endereço IP de um servidor NTP IPv4 válido usando a porta 123.

Por exemplo, para o usuário administrador :

shell> ntp disable 129.6.15.28
shell>

Backup e restauração

As seções a seguir descrevem os comandos da CLI com suporte para fazer backup e restaurar um instantâneo de sistema do sensor de rede OT.

Os arquivos de backup incluem um instantâneo completo do estado do sensor, incluindo definições de configuração, valores de linha de base, dados de inventário e logs.

Iniciar um backup imediato não agendado

Use o comando a seguir para iniciar um backup imediato e não programado dos dados em seu sensor OT. Para saber mais, confira Configurar arquivos de backup e restauração.

Usuário	Comando	Sintaxe de comando completa
admin	system backup create	Nenhum atributo
cyberx ou administrador com acesso root	cyberx-xsense-system-backup	Nenhum atributo

Por exemplo, para o usuário administrador :

shell> system backup create
Backing up DATA_KEY
...
...
Finished backup. Backup is stored at /var/cyberx/backups/e2e-xsense-1664469968212-backup-version-22.2.6.318-r-71e6295-2022-09-29_18:29:55.tar
Setting backup status 'SUCCESS' in redis
shell>

Listar arquivos de backup atuais

Use os comandos a seguir para listar os arquivos de backup armazenados atualmente no sensor de rede OT.

Usuário	Comando	Sintaxe de comando completa
admin	system backup list	Nenhum atributo
cyberx ou administrador com acesso root	cyberx-xsense-system-backup-list	Nenhum atributo

Por exemplo, para o usuário administrador :

shell> system backup list
backup files:
        e2e-xsense-1664469968212-backup-version-22.3.0.318-r-71e6295-2022-09-29_18:30:20.tar
        e2e-xsense-1664469968212-backup-version-22.3.0.318-r-71e6295-2022-09-29_18:29:55.tar
shell>

Restaurar dados do backup mais recente

Use o comando a seguir para restaurar dados em seu sensor de rede OT usando o arquivo de backup mais recente. Quando solicitado, confirme que você quer prosseguir.

Usuário	Comando	Sintaxe de comando completa
admin	system restore	Nenhum atributo
cyberx, ou admin com acesso root	cyberx-xsense-system-restore	-f <filename>

Por exemplo, para o usuário administrador :

shell> system restore
Waiting for redis to start...
Redis is up
Use backup file as "/var/cyberx/backups/e2e-xsense-1664469968212-backup-version-22.2.6.318-r-71e6295-2022-09-29_18:30:20.tar" ? [Y/n]: y
WARNING - the following procedure will restore data. do not stop or power off the server machine while this procedure is running. Are you sure you wish to proceed? [Y/n]: y
...
...
watchdog started
starting components
shell>

Exibir a alocação de espaço em disco de backup

O comando a seguir lista a alocação de espaço em disco de backup atual, incluindo os seguintes detalhes:

• Local da pasta de backup
• Tamanho da pasta de backup
• Limitações da pasta de backup
• Hora da última operação de backup
• Espaço livre em disco disponível para backups

Usuário	Comando	Sintaxe de comando completa
admin	cyberx-backup-memory-check	Nenhum atributo

Por exemplo, para o usuário administrador :

shell> cyberx-backup-memory-check
2.1M    /var/cyberx/backups
Backup limit is: 20Gb
shell>

Gerenciamento de usuários locais

Alterar senhas de usuário local

Use os comandos a seguir para alterar senhas de usuários locais no sensor OT. A nova senha deve ter pelo menos 8 caracteres, conter letras minúsculas e maiúsculas, caracteres alfabéticos, números e símbolos.

Quando você altera a senha do administrador , a senha é alterada para SSH e acesso à web.

Usuário	Comando	Sintaxe de comando completa
admin	system password	<username>

O exemplo a seguir mostra a alteração da senha do usuário administrador . A nova senha não aparece na tela quando você a digita, certifique-se de escrever para anotá-la e certifique-se de que ela seja digitada corretamente quando solicitado a digitar novamente a senha.

shell>system password user1
Enter New Password for user1: 
Reenter Password:
shell>

Configuração de rede

Alterar a configuração de rede ou reatribuir funções de adaptador de rede

Use o comando a seguir para executar novamente o assistente de configuração do software de monitoramento de OT, que ajuda você a definir ou redefinir as seguintes configurações do sensor OT:

• Habilitar/desabilitar interfaces de monitoramento de SPAN
• Definir as configurações de rede para a interface de gerenciamento (IP, sub-rede, gateway padrão, DNS)
• Atribuir um diretório de backup

Usuário	Comando	Sintaxe de comando completa
admin	network reconfigure	Nenhum atributo
cyberx	python3 -m cyberx.config.configure	Nenhum atributo

Por exemplo, com o usuário administrador :

shell> network reconfigure

O assistente de configuração é iniciado automaticamente depois que você executa esse comando. Para mais informações, confira Instalar software de monitoramento de OT.

Validar e mostrar a configuração do adaptador de rede

Use os comandos a seguir para validar e mostrar a configuração atual do adaptador de rede no sensor OT.

Usuário	Comando	Sintaxe de comando completa
admin	network validate	Nenhum atributo

Por exemplo, para o usuário administrador :

shell> network validate
Success! (Appliance configuration matches the network settings)
Current Network Settings:
interface: eth0
ip: 172.20.248.69
subnet: 255.255.192.0
default gateway: 10.1.0.1
dns: 168.63.129.16
monitor interfaces mapping: local_listener=adiot0
shell>

Verificar a conectividade de rede do sensor OT

Use o comando a seguir para enviar uma mensagem de ping do sensor OT.

Usuário	Comando	Sintaxe de comando completa
admin	ping <IP address>	Nenhum atributo
cyberx ou administrador com acesso root	ping <IP address>	Nenhum atributo

Nesses comandos, <IP address> é o endereço IP de um host de rede IPv4 válido acessível na porta de gerenciamento no sensor OT.

Localizar uma porta física piscando as luzes da interface

Use o comando a seguir para localizar uma interface física específica, fazendo com que as luzes da interface pisquem.

Usuário	Comando	Sintaxe de comando completa
admin	network blink <INT>	Nenhum atributo

Neste comando, <INT> é uma porta de rede física no dispositivo.

O exemplo a seguir mostra o usuário administrador piscando a interface eth0 :

shell> network blink eth0
Blinking interface for 20 seconds ...

Listar as interfaces físicas conectadas

Use o comando a seguir para listar as interfaces físicas conectadas em seu sensor OT.

Usuário	Comando	Sintaxe de comando completa
admin	network list	Nenhum atributo
cyberx, ou admin com acesso root	ifconfig	Nenhum atributo

Por exemplo, para o usuário administrador :

shell> network list
adiot0: flags=4419<UP,BROADCAST,RUNNING,PROMISC,MULTICAST>  mtu 4096
        ether be:b1:01:1f:91:88  txqueuelen 1000  (Ethernet)
        RX packets 2589575  bytes 740011013 (740.0 MB)
        RX errors 0  dropped 0  overruns 0  frame 0
        TX packets 1  bytes 90 (90.0 B)
        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0

eth0: flags=4163<UP,BROADCAST,RUNNING,MULTICAST>  mtu 1500
        inet 172.18.0.2  netmask 255.255.0.0  broadcast 172.18.255.255
        ether 02:42:ac:12:00:02  txqueuelen 0  (Ethernet)
        RX packets 22419372  bytes 5757035946 (5.7 GB)
        RX errors 0  dropped 0  overruns 0  frame 0
        TX packets 23078301  bytes 2544599581 (2.5 GB)
        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0

lo: flags=73<UP,LOOPBACK,RUNNING>  mtu 65536
        inet 127.0.0.1  netmask 255.0.0.0
        loop  txqueuelen 1000  (Local Loopback)
        RX packets 837196  bytes 259542408 (259.5 MB)
        RX errors 0  dropped 0  overruns 0  frame 0
        TX packets 837196  bytes 259542408 (259.5 MB)
        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0

shell>

Filtros de captura de tráfego

Para reduzir a fadiga do alerta e concentrar o monitoramento de rede no tráfego de alta prioridade, decida se quer filtrar o tráfego que é transmitido para o Defender para IoT na origem. Os filtros de captura permitem bloquear o tráfego de alta largura de banda na camada de hardware, otimizando o desempenho do dispositivo e o uso de recursos.

Use incluir uma/ou excluir listas para criar e configurar filtros de captura nos sensores de rede OT, evitando bloquear qualquer um dos tráfegos que quer monitorar.

O caso de uso básico para filtros de captura usa o mesmo filtro para todos os componentes do Defender para IoT. No entanto, para casos de uso avançados, convém configurar filtros separados para cada um dos seguintes componentes do Defender para IoT:

• horizon: captura dados de DPI (inspeção profunda de pacotes)
• collector: captura dados PCAP
• traffic-monitor: captura estatísticas de comunicação

Criar um filtro básico para todos os componentes

O método usado para configurar um filtro de captura básico difere dependendo do usuário que executar o comando:

• Usuário cyberx: execute o comando especificado com atributos específicos para configurar o filtro de captura.
• admin user: execute o comando especificado e insira os valores conforme solicitado pela CLI, editando suas listas de inclusão e exclusão em um editor nano.

Use os comandos a seguir para criar um novo filtro de captura:

Usuário	Comando	Sintaxe de comando completa
admin	network capture-filter	Nenhum atributo.
cyberx, ou admin com acesso root	cyberx-xsense-capture-filter	cyberx-xsense-capture-filter [-h] [-i INCLUDE] [-x EXCLUDE] [-etp EXCLUDE_TCP_PORT] [-eup EXCLUDE_UDP_PORT] [-itp INCLUDE_TCP_PORT] [-iup INCLUDE_UDP_PORT] [-vlan INCLUDE_VLAN_IDS] -m MODE [-S]

Os atributos com suporte para o usuário cyberx são definidos da seguinte maneira:

Atributo	Descrição
-h, --help	Mostra a mensagem de ajuda e sai.
-i <INCLUDE>, --include <INCLUDE>	O caminho para um arquivo que contém os dispositivos e as máscaras de sub-rede que você quer incluir, em que <INCLUDE> é o caminho para o arquivo. Por exemplo, consulte Amostra de arquivo de inclusão ou exclusão.
-x EXCLUDE, --exclude EXCLUDE	O caminho para um arquivo que contém os dispositivos e as máscaras de sub-rede que você quer excluir, em que <EXCLUDE> é o caminho para o arquivo. Por exemplo, consulte Amostra de arquivo de inclusão ou exclusão.
- -etp <EXCLUDE_TCP_PORT>, --exclude-tcp-port <EXCLUDE_TCP_PORT>	Exclui o tráfego TCP em todas as portas especificadas, em que <EXCLUDE_TCP_PORT> define a porta ou as portas que você quer excluir. Delimita várias portas por vírgulas, sem espaços.
-eup <EXCLUDE_UDP_PORT>, --exclude-udp-port <EXCLUDE_UDP_PORT>	Exclui o tráfego UDP em todas as portas especificadas, em que <EXCLUDE_UDP_PORT> define a porta ou as portas que você quer excluir. Delimita várias portas por vírgulas, sem espaços.
-itp <INCLUDE_TCP_PORT>, --include-tcp-port <INCLUDE_TCP_PORT>	Inclui o tráfego TCP em todas as portas especificadas, em que <INCLUDE_TCP_PORT> define a porta ou as portas que você quer incluir. Delimita várias portas por vírgulas, sem espaços.
-iup <INCLUDE_UDP_PORT>, --include-udp-port <INCLUDE_UDP_PORT>	Inclui o tráfego UDP em todas as portas especificadas, em que <INCLUDE_UDP_PORT> define a porta ou as portas que você quer incluir. Delimita várias portas por vírgulas, sem espaços.
-vlan <INCLUDE_VLAN_IDS>, --include-vlan-ids <INCLUDE_VLAN_IDS>	Inclui o tráfego VLAN por IDs de VLAN especificadas; <INCLUDE_VLAN_IDS> define a ID de VLAN ou as IDs que você quer incluir. Delimita várias IDs de VLAN por vírgulas, sem espaços.
-p <PROGRAM>, --program <PROGRAM>	Define o componente para o qual você quer configurar um filtro de captura. Use all para casos de uso básicos a fim de criar um único filtro de captura para todos os componentes. Para casos de uso avançados, crie filtros de captura separados para cada componente. Para saber mais, confira Criar um filtro avançado para componentes específicos.
-m <MODE>, --mode <MODE>	Define um modo de lista de inclusão e é relevante somente quando uma lista de inclusão é usada. Use um dos seguintes valores: - internal: inclui toda a comunicação entre a origem e o destino especificados - all-connected: inclui toda a comunicação entre pontos de extremidade especificados e pontos de extremidade externos. Por exemplo, para os pontos de extremidade A e B, se você usar o modo internal, o tráfego incluído conterá apenas as comunicações entre os pontos de extremidade A e B. No entanto, se você usar o modo all-connected, o tráfego incluído conterá todas as comunicações entre A ou B e outros pontos de extremidade externos.

Amostra de arquivo de inclusão ou exclusão

Por exemplo, um arquivo de inclusão ou exclusão .txt pode incluir as seguintes entradas:

192.168.50.10
172.20.248.1

Criar um filtro de captura básico usando o usuário administrador

Se você estiver criando um filtro de captura básico como usuário administrador , nenhum atributo será transmitido no comando original. Em vez disso, uma série de prompts será exibida para ajudar você a criar o filtro de captura interativamente.

Responda aos prompts exibidos da seguinte maneira:

1. Would you like to supply devices and subnet masks you wish to include in the capture filter? [Y/N]:

   Selecione Y para abrir um novo arquivo de inclusão, no qual você pode adicionar um dispositivo, canal e/ou sub-rede que quer incluir no tráfego monitorado. Qualquer outro tráfego, não listado no arquivo de inclusão, não será ingerido no Defender para IoT.

   O arquivo de inclusão é aberto no editor de texto Nano. No arquivo de inclusão, defina dispositivos, canais e sub-redes da seguinte maneira:

   Tipo	Descrição	Exemplo
   Dispositivo	Defina um dispositivo por seu endereço IP.	1.1.1.1 inclui todo o tráfego para esse dispositivo.
   Channel	Defina um canal para os endereços IP de seus dispositivos de origem e destino, separados por uma vírgula.	1.1.1.1,2.2.2.2 inclui todo o tráfego para esse canal.
   Sub-rede	Defina uma sub-rede por seu endereço de rede.	1.1.1 inclui todo o tráfego para essa sub-rede.

   Listar vários argumentos em linhas separadas.

2. Would you like to supply devices and subnet masks you wish to exclude from the capture filter? [Y/N]:

   Selecione Y para abrir um novo arquivo de exclusão, no qual você pode adicionar um dispositivo, canal e/ou sub-rede que quer excluir do tráfego monitorado. Qualquer outro tráfego, não listado no arquivo de exclusão, será ingerido no Defender para IoT.

   O arquivo de exclusão é aberto no editor de texto Nano. No arquivo de exclusão, defina dispositivos, canais e sub-redes da seguinte maneira:

   Tipo	Descrição	Exemplo
   Dispositivo	Defina um dispositivo por seu endereço IP.	1.1.1.1 exclui todo o tráfego para esse dispositivo.
   Channel	Defina um canal para os endereços IP de seus dispositivos de origem e destino, separados por uma vírgula.	1.1.1.1,2.2.2.2 exclui todo o tráfego entre esses dispositivos.
   Canal por porta	Defina um canal para os endereços IP de seus dispositivos de origem e destino e a porta de tráfego.	1.1.1.1,2.2.2.2,443 exclui todo o tráfego entre esses dispositivos usando a porta especificada.
   Sub-rede	Defina uma sub-rede por seu endereço de rede.	1.1.1 exclui todo o tráfego para essa sub-rede.
   Canal de sub-rede	Defina endereços de rede de canal de sub-rede para as sub-redes de origem e destino.	1.1.1,2.2.2 exclui todo o tráfego entre essas sub-redes.

   Listar vários argumentos em linhas separadas.

3. Responda aos prompts a seguir para definir todas as portas TCP ou UDP a serem incluídas ou excluídas. Separe várias portas por vírgula e pressione ENTER para ignorar qualquer prompt específico.

   • Enter tcp ports to include (delimited by comma or Enter to skip):
   • Enter udp ports to include (delimited by comma or Enter to skip):
   • Enter tcp ports to exclude (delimited by comma or Enter to skip):
   • Enter udp ports to exclude (delimited by comma or Enter to skip):
   • Enter VLAN ids to include (delimited by comma or Enter to skip):

   Por exemplo, insira várias portas da seguinte maneira: 502,443

4. In which component do you wish to apply this capture filter?

   Insira all para um filtro de captura básico. Para casos de uso avançados, crie filtros de captura para cada componente do Defender para IoT separadamente.

5. Type Y for "internal" otherwise N for "all-connected" (custom operation mode enabled) [Y/N]:

   Esse prompt permite que você configure qual tráfego está no escopo. Defina se quer coletar tráfego em que ambos os pontos de extremidade estão no escopo ou se apenas um deles está na sub-rede especificada. Os valores compatíveis incluem:

   • internal: inclui toda a comunicação entre a origem e o destino especificados
   • all-connected: inclui toda a comunicação entre pontos de extremidade especificados e pontos de extremidade externos.

   Por exemplo, para os pontos de extremidade A e B, se você usar o modo internal, o tráfego incluído conterá apenas as comunicações entre os pontos de extremidade A e B.
   No entanto, se você usar o modo all-connected, o tráfego incluído conterá todas as comunicações entre A ou B e outros pontos de extremidade externos.

   O modo padrão é internal. Para usar o modo all-connected, selecione Y no prompt e insira all-connected.

O exemplo a seguir mostra uma série de prompts que cria um filtro de captura para excluir a sub-rede 192.168.x.x e a porta 9000:

root@xsense: network capture-filter
Would you like to supply devices and subnet masks you wish to include in the capture filter? [y/N]: n
Would you like to supply devices and subnet masks you wish to exclude from the capture filter? [y/N]: y
You've exited the editor. Would you like to apply your modifications? [y/N]: y
Enter tcp ports to include (delimited by comma or Enter to skip):
Enter udp ports to include (delimited by comma or Enter to skip):
Enter tcp ports to exclude (delimited by comma or Enter to skip):9000
Enter udp ports to exclude (delimited by comma or Enter to skip):9000
Enter VLAN ids to include (delimited by comma or Enter to skip):
In which component do you wish to apply this capture filter?all
Would you like to supply a custom base capture filter for the collector component? [y/N]: n
Would you like to supply a custom base capture filter for the traffic_monitor component? [y/N]: n
Would you like to supply a custom base capture filter for the horizon component? [y/N]: n
type Y for "internal" otherwise N for "all-connected" (custom operation mode enabled) [Y/n]: internal
Please respond with 'yes' or 'no' (or 'y' or 'n').
type Y for "internal" otherwise N for "all-connected" (custom operation mode enabled) [Y/n]: y
starting "/usr/local/bin/cyberx-xsense-capture-filter --exclude /var/cyberx/media/capture-filter/exclude --exclude-tcp-port 9000 --exclude-udp-port 9000 --program all --mode internal --from-shell"
No include file given
Loaded 1 unique channels
(000) ret      #262144
(000) ldh      [12]
......
......
......
debug: set new filter for horizon '(((not (net 192.168))) and (not (tcp port 9000)) and (not (udp port 9000))) or (vlan and ((not (net 192.168))) and (not (tcp port 9000)) and (not (udp port 9000)))'
root@xsense:

Criar um filtro avançado para componentes específicos

Ao configurar filtros de captura avançados para componentes específicos, você pode usar seus arquivos iniciais de inclusão e exclusão como o filtro de captura de base ou modelo. Em seguida, configure filtros extras para cada componente sobre a base, conforme necessário.

Para criar um filtro de captura para cada componente, repita todo o processo para cada componente.

Usuário	Comando	Sintaxe de comando completa
admin	network capture-filter	Nenhum atributo.
cyberx, ou admin com acesso root	cyberx-xsense-capture-filter	cyberx-xsense-capture-filter [-h] [-i INCLUDE] [-x EXCLUDE] [-etp EXCLUDE_TCP_PORT] [-eup EXCLUDE_UDP_PORT] [-itp INCLUDE_TCP_PORT] [-iup INCLUDE_UDP_PORT] [-vlan INCLUDE_VLAN_IDS] -p PROGRAM [-o BASE_HORIZON] [-s BASE_TRAFFIC_MONITOR] [-c BASE_COLLECTOR] -m MODE [-S]

Os seguintes atributos extras são usados para o usuário cyberx criar filtros de captura para cada componente separadamente:

Atributo	Descrição
-p <PROGRAM>, --program <PROGRAM>	Define o componente para o qual você quer configurar um filtro de captura, em que <PROGRAM> tem os seguintes valores com suporte: - traffic-monitor - collector - horizon - all: cria um único filtro de captura para todos os componentes. Para saber mais, confira Criar um filtro básico para todos os componentes.
-o <BASE_HORIZON>, --base-horizon <BASE_HORIZON>	Define um filtro de captura base para o componente horizon, em que <BASE_HORIZON> é o filtro que você quer usar. Valor padrão = ""
-s BASE_TRAFFIC_MONITOR, --base-traffic-monitor BASE_TRAFFIC_MONITOR	Define um filtro de captura base para o componente traffic-monitor. Valor padrão = ""
-c BASE_COLLECTOR, --base-collector BASE_COLLECTOR	Define um filtro de captura base para o componente collector. Valor padrão = ""

Outros valores de atributo têm as mesmas descrições que no caso de uso básico, descrito anteriormente.

Criar um filtro de captura avançado usando o usuário administrador

Se você estiver criando um filtro de captura para cada componente separadamente como o usuário administrador , nenhum atributo será passado no comando original. Em vez disso, uma série de prompts será exibida para ajudar você a criar o filtro de captura interativamente.

A maioria dos prompts são idênticos ao caso de uso básico. Responda aos seguintes prompts extras da seguinte maneira:

1. In which component do you wish to apply this capture filter?

   Insira um dos valores a seguir, dependendo do componente que você quer filtrar:

   • horizon
   • traffic-monitor
   • collector

2. Você será solicitado a configurar um filtro de captura base personalizado para o componente selecionado. Essa opção usa o filtro de captura configurado nas etapas anteriores como base ou modelo, em que você pode adicionar configurações extras sobre a base.

   Por exemplo, se você tiver selecionado configurar um filtro de captura para o componente collector na etapa anterior, será solicitado: Would you like to supply a custom base capture filter for the collector component? [Y/N]:

   Insira Y para personalizar o modelo para o componente especificado ou N para usar o filtro de captura que você configurou anteriormente.

Continue com os prompts restantes como no caso de uso básico.

Listar os filtros de captura atuais para componentes específicos

Use os comandos a seguir para mostrar detalhes sobre os filtros de captura atuais configurados para o sensor.

Usuário	Comando	Sintaxe de comando completa
admin	Use os comandos a seguir para exibir os filtros de captura para cada componente: - horizon: edit-config horizon_parser/horizon.properties - traffic-monitor: edit-config traffic_monitor/traffic-monitor - collector: edit-config dumpark.properties	Nenhum atributo
cyberx, ou admin com acesso root	Use os comandos a seguir para exibir os filtros de captura para cada componente: -horizon: nano /var/cyberx/properties/horizon_parser/horizon.properties - traffic-monitor: nano /var/cyberx/properties/traffic_monitor/traffic-monitor.properties - collector: nano /var/cyberx/properties/dumpark.properties	Nenhum atributo

Esses comandos abrem os seguintes arquivos, que listam os filtros de captura configurados para cada componente:

Nome	Arquivo	Propriedade
horizon	/var/cyberx/properties/horizon.properties	horizon.processor.filter
traffic-monitor	/var/cyberx/properties/traffic-monitor.properties	horizon.processor.filter
coletor	/var/cyberx/properties/dumpark.properties	dumpark.network.filter

Por exemplo, com o usuário administrador, com um filtro de captura definido para o componente coletor que exclui a sub-rede 192.168.x.x e a porta 9000:

root@xsense: edit-config dumpark.properties
  GNU nano 2.9.3                      /tmp/tmpevt4igo7/tmpevt4igo7

dumpark.network.filter=(((not (net 192.168))) and (not (tcp port 9000)) and (not
dumpark.network.snaplen=4096
dumpark.packet.filter.data.transfer=false
dumpark.infinite=true
dumpark.output.session=false
dumpark.output.single=false
dumpark.output.raw=true
dumpark.output.rotate=true
dumpark.output.rotate.history=300
dumpark.output.size=20M
dumpark.output.time=30S

Redefinir todos os filtros de captura

Use o comando a seguir para redefinir o sensor para a configuração de captura padrão com o usuário cyberx, removendo todos os filtros de captura.

Usuário	Comando	Sintaxe de comando completa
cyberx, ou admin com acesso root	cyberx-xsense-capture-filter -p all -m all-connected	Nenhum atributo

Se você quiser modificar os filtros de captura existentes, execute o comando earlier novamente, com novos valores de atributo.

Para redefinir todos os filtros de captura usando o usuário admin , execute o comando anterior novamente e responda N a todos os prompts para redefinir todos os filtros de captura.

O exemplo a seguir mostra a sintaxe de comando e a resposta para o usuário cyberx:

root@xsense:/#  cyberx-xsense-capture-filter -p all -m all-connected
starting "/usr/local/bin/cyberx-xsense-capture-filter -p all -m all-connected"
No include file given
No exclude file given
(000) ret      #262144
(000) ret      #262144
debug: set new filter for dumpark ''
No include file given
No exclude file given
(000) ret      #262144
(000) ret      #262144
debug: set new filter for traffic-monitor ''
No include file given
No exclude file given
(000) ret      #262144
(000) ret      #262144
debug: set new filter for horizon ''
root@xsense:/#

Próximas etapas