Coletar registros do ForgeRock OpenAM

Versão do analisador:4.0

Compatível com:

Google SecOps SIEM

Neste documento, explicamos como ingerir registros do ForgeRock OpenAM no Google Security Operations usando o agente do Bindplane.

O ForgeRock OpenAM é uma solução de gerenciamento de acesso que gera mensagens de syslog para eventos de autenticação, decisões de controle de acesso, atividade de sessão e mudanças de configuração. O analisador extrai campos de registros de auditoria formatados em JSON e os mapeia para o modelo de dados unificado (UDM).

Antes de começar

Verifique se você tem os pré-requisitos a seguir:

• Uma instância do Google SecOps
• Windows Server 2016 ou mais recente ou host do Linux com systemd
• Conectividade de rede entre o agente do Bindplane e o servidor ForgeRock OpenAM
• Se estiver em execução atrás de um proxy, verifique se as portas do firewall estão abertas de acordo com os requisitos do agente do Bindplane.
• Acesso de administrador ao console do AM (por exemplo, amAdmin)

Receber credenciais do Google SecOps para o agente do Bindplane

Para autenticar o agente do Bindplane no Google SecOps, escolha um dos seguintes métodos:

• Novas implantações: use a API Chronicle (opção 1).
• Implantações legadas: continue usando o arquivo de autenticação de ingestão (opção 2) até que a API Ingestion seja descontinuada em 20 de julho de 2027.

Opção 1: criar uma conta de serviço para a API Chronicle (recomendado)

1. Faça login no console doGoogle Cloud e selecione o projeto do Google Cloud vinculado à sua instância do Google SecOps.
2. Acesse IAM e administrador > Contas de serviço.
3. Clique em Criar conta de serviço.
4. Informe os seguintes detalhes de configuração:
   • Nome da conta de serviço: insira um nome para a conta (por exemplo, bindplane-ingest).
   • Descrição da conta de serviço: insira uma descrição (por exemplo, Bindplane agent log ingestion).
5. Clique em Criar e continuar.
6. Na seção Conceder a essa conta de serviço acesso ao projeto, clique em Selecionar uma função e escolha Editor do Chronicle.
7. Clique em Continuar e depois em Concluído.
8. Clique na conta de serviço que você criou e acesse a guia Chaves.
9. Clique em Adicionar chave > Criar nova chave.
10. Selecione JSON e clique em Criar. O arquivo de chave é baixado para o computador.
11. Salve o arquivo de chave como ingestion-auth.json no diretório do coletor do Bindplane (/opt/observiq-otel-collector/ingestion-auth.json no Linux ou C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json no Windows) ou atualize creds_file_path em config.yaml para corresponder ao caminho em que você o salvou.
12. Acesse IAM e administrador > Configurações e copie o número do projeto. Você vai precisar dele para a configuração do exportador.

Observação :a chave JSON é uma credencial. Restrinja o acesso ao arquivo no host do Bindplane e gire a chave de acordo com a política da sua organização.

Opção 2: fazer o download do arquivo de autenticação de ingestão (legado)

1. Faça login no console do Google SecOps.
2. Acesse Configurações do SIEM > Agentes de coleta.
3. Faça o download do arquivo de autenticação de ingestão.
4. Salve o arquivo com segurança no sistema em que o agente do Bindplane será instalado.

Observação: esse arquivo autentica o agente na API Ingestion legada (malachiteingestion-pa.googleapis.com), que o Google programou para o fim da vida útil em 20 de julho de 2027. Planeje migrar para a opção 1 antes dessa data.

Receber o ID de cliente do Google SecOps

1. Faça login no console do Google SecOps.
2. Acesse Configurações do SIEM > Perfil.

3. Copie e salve o ID de cliente na seção Detalhes da organização.

   Observação :o ID de cliente é necessário para configurar o exportador do agente do BindPlane.

Instalar o agente do Bindplane

Instale o agente do Bindplane no seu sistema operacional Windows ou Linux de acordo com as instruções a seguir.

Instalação do Windows

1. Abra o prompt de comando ou o PowerShell como administrador.

2. Execute este comando:

   msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quiet
   

3. Aguarde a conclusão da instalação.

4. Execute o seguinte comando para confirmar a instalação:

   sc query observiq-otel-collector
   

   O serviço precisa aparecer como RUNNING.

Instalação do Linux

1. Abra um terminal com privilégios de raiz ou sudo.

2. Execute este comando:

   sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh
   

3. Aguarde a conclusão da instalação.

4. Execute o seguinte comando para confirmar a instalação:

   sudo systemctl status observiq-otel-collector
   

   O serviço vai aparecer como ativo (em execução).

Outros recursos de instalação

Para mais opções de instalação e solução de problemas, consulte o guia de instalação do agente do Bindplane.

Observação: a configuração do exportador da API Chronicle requer o coletor Bindplane v1.106.0 ou mais recente. Os comandos anteriores instalam a versão mais recente. Se você estiver atualizando uma instalação atual, faça upgrade do coletor antes de mudar a configuração.

Configurar o agente do Bindplane para ingerir o syslog e enviar ao Google SecOps

Localizar o arquivo de configuração

• Linux:

  sudo nano /opt/observiq-otel-collector/config.yaml
  

• Windows:

  notepad "C:\Program Files\observIQ OpenTelemetry Collector\config.yaml"
  

Editar o arquivo de configuração

• Substitua todo o conteúdo de config.yaml pela seguinte configuração:

  receivers:
    udplog:
      listen_address: "0.0.0.0:514"
  
  exporters:
    chronicle/openam:
      protocol: https
      # Region of your instance, for example us, europe, asia-southeast1
      location: <LOCATION>
      # Project number of the Google Cloud project linked to the instance
      project: '<PROJECT_NUMBER>'
      compression: gzip
      creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: chronicle.googleapis.com
      log_type: OPENAM
      raw_log_field: body
  
  service:
    pipelines:
      logs/openam_to_chronicle:
        receivers:
          - udplog
        exporters:
          - chronicle/openam
  

Parâmetros de configuração

Substitua os seguintes marcadores de posição:

• Configuração do receptor:

  • listen_address: endereço IP e porta a serem detectados:
    • 0.0.0.0 para ouvir em todas as interfaces (recomendado)
    • A porta 514 é a porta syslog padrão (requer raiz no Linux; use 1514 para não raiz)

• Configuração do exportador:

  • creds_file_path: caminho completo para o arquivo de chave JSON da conta de serviço (opção 1):
    • Linux: /opt/observiq-otel-collector/ingestion-auth.json
    • Windows: C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
  • customer_id: ID de cliente copiado do console do Google SecOps
  • location: substitua <LOCATION> pela região da sua instância do Google SecOps (por exemplo, us, europe ou asia-southeast1). O exportador prefixa chronicle.googleapis.com com esse valor. Consulte Endpoints regionais para ver a lista completa.
  • project: substitua <PROJECT_NUMBER> pelo número do projeto em IAM e administrador > Configurações.
  • endpoint: mantenha definido como chronicle.googleapis.com.

Exportador da API de ingestão legada

• Se você usar o arquivo de autenticação de ingestão da Opção 2, substitua o bloco exporters pelo seguinte. Defina creds_file_path como o caminho para o arquivo de autenticação de ingestão e, se a instância estiver fora dos EUA, substitua malachiteingestion-pa.googleapis.com pelo endpoint regional (por exemplo, europe-malachiteingestion-pa.googleapis.com).

  exporters:
    chronicle/openam:
      compression: gzip
      creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: malachiteingestion-pa.googleapis.com
      log_type: OPENAM
      raw_log_field: body
  

Observação: esse exportador vai parar de funcionar quando a API Ingestion for desativada em 20 de julho de 2027.

Salvar o arquivo de configuração

• Depois de editar, salve o arquivo:
  • Linux: pressione Ctrl+O, depois Enter e, em seguida, Ctrl+X.
  • Windows: clique em Arquivo > Salvar.

Reinicie o agente do Bindplane para aplicar as mudanças:

• Para reiniciar o agente do Bindplane no Linux, execute o seguinte comando:

  sudo systemctl restart observiq-otel-collector
  

  1. Verifique se o serviço está em execução:

     sudo systemctl status observiq-otel-collector
     

  2. Verifique se há erros nos registros:

     sudo journalctl -u observiq-otel-collector -f
     

• Para reiniciar o agente do Bindplane em Windows, escolha uma das seguintes opções:

  • Prompt de comando ou PowerShell como administrador:

    net stop observiq-otel-collector && net start observiq-otel-collector
    

  • Console de serviços:

    1. Pressione Win+R, digite services.msc e pressione Enter.
    2. Localize o Coletor do OpenTelemetry da observIQ.
    3. Clique com o botão direito do mouse e selecione Reiniciar.

    4. Verifique se o serviço está em execução:

       sc query observiq-otel-collector
       

    5. Verifique se há erros nos registros:

       type "C:\Program Files\observIQ OpenTelemetry Collector\log\collector.log"
       

Configurar gerenciadores de syslog para o ForgeRock OpenAM

1. Faça login no console do AM como administrador (por exemplo, amAdmin).
2. Para criar o manipulador de eventos na configuração global, acesse Configurar > Serviços globais > Geração de registros de auditoria.
   • Para criar o manipulador de eventos em um realm, acesse Realms > Nome do realm > Serviços > Registro de auditoria.
3. Clique em Adicionar uma configuração secundária > Syslog.
4. Informe os seguintes detalhes de configuração:
   • Nome: insira um nome para o manipulador de eventos (por exemplo, Syslog Event Handler).
   • Nome do host do servidor: insira o endereço IP do agente do Bindplane.
   • Porta do servidor: digite o número da porta do agente do BindPlane (por exemplo, 514 para UDP).
   • Protocolo de transporte: selecione UDP.
   • Tempo limite de conexão: insira o número de segundos para conectar (por exemplo, 120).
   • Opcional: ative a opção Buffering.
5. Clique em Criar.
6. Na guia Configuração geral do manipulador, selecione Ativado para ativar o manipulador de eventos.
7. Selecione os tópicos para os registros de auditoria:
   • Acesso
   • Atividade
   • Autenticação
   • Configuração
8. Clique em Salvar.
9. Na guia Configuração do Syslog, forneça os seguintes detalhes de configuração:
   • Nome do host do servidor: insira o endereço IP do Bindplane.
   • Porta do servidor: insira o número da porta do Bindplane.
   • Tempo limite da conexão: insira o número de segundos para se conectar (por exemplo, 120).
   • Protocolo de transporte: selecione UDP.
   • Recurso: selecione Local0.
   • Todos os tópicos definem a gravidade como INFORMATIVA.
10. Clique em Salvar.
11. Na guia Buffering, selecione Buffering Enabled para ativar o recurso.
12. Clique em Salvar.

Tabela de mapeamento de UDM

Campo de registro	Mapeamento de UDM	Lógica
client.ip	principal.ip	O endereço IP do cliente que está fazendo a solicitação.
client.ip	principal.asset.ip	O endereço IP do recurso do cliente que está fazendo a solicitação.
client.port	principal.port	A porta usada pelo cliente que está fazendo a solicitação.
entries[0].info.authLevel	principal.resource.resource_subtype	O nível de autenticação associado ao evento. Com o prefixo "authLevel:".
entries[0].info.displayName	security_result.description	Um nome descritivo para o nó na árvore de autenticação.
entries[0].info.ipAddress	principal.asset.ip	O endereço IP associado ao principal no evento.
entries[0].info.ipAddress	principal.ip	O endereço IP associado ao principal no evento.
entries[0].info.nodeId	principal.resource.id	O identificador exclusivo do nó na árvore de autenticação. Prefixo "nodeId:".
entries[0].info.nodeOutcome	principal.resource.attribute.labels.value	O resultado do nó na árvore de autenticação.
entries[0].info.nodeType	principal.resource.type	O tipo do nó na árvore de autenticação. Com o prefixo "nodeType:".
entries[0].info.treeName	principal.resource.name	O nome da árvore de autenticação. Prefixo "treeName:".
eventName	metadata.product_event_type	O nome do evento bruto dos registros do OpenAM.
http.request.headers.host[0]	target.asset.hostname	O nome do host do servidor de destino, extraído do cabeçalho host.
http.request.headers.host[0]	target.hostname	O nome do host do servidor de destino, extraído do cabeçalho host.
http.request.headers.user-agent[0]	network.http.user_agent	O user agent da solicitação HTTP.
http.request.method	network.http.method	O método HTTP usado na solicitação.
http.request.path	target.url	O caminho do URL da solicitação HTTP.
info.failureReason	security_result.summary	O motivo de uma falha de autenticação. Fixado no código como "SSO". Determinado pela lógica com base em eventName e outros campos. Pode ser GENERIC_EVENT, USER_LOGIN, USER_LOGOUT, NETWORK_HTTP ou STATUS_UPDATE. Fixado no código como "OPENAM". Fixado no código como "OpenAM". Fixado no código como "ForgeRock".
principal	target.user.userid	O ID do usuário envolvido no evento, extraído dos campos userId, principal ou runAs.
result	security_result.action_details	O resultado do evento (por exemplo, "SUCCESSFUL", "FAILED").
response.detail.reason	security_result.summary	O motivo de uma falha em um evento de resultado de acesso.
response.status	security_result.action_details	O status da resposta em um evento de resultado de acesso.
runAs	target.user.userid	O ID do usuário envolvido no evento, extraído dos campos userId, principal ou runAs.
security_result.action	security_result.action	A ação realizada como resultado do ocorrência de segurança (por exemplo, "ALLOW", "BLOCK").
server.ip	target.asset.ip	O endereço IP do servidor de destino.
server.ip	target.ip	O endereço IP do servidor de destino.
server.port	target.port	A porta do servidor de destino.
timestamp	metadata.event_timestamp	O carimbo de data/hora do evento.
trackingIds	metadata.product_log_id	O ID de rastreamento associado ao evento.
transactionId	metadata.product_deployment_id	O ID da transação associada ao evento.
userId	target.user.userid	O ID do usuário envolvido no evento, extraído dos campos userId, principal ou runAs.
userId	target.user.group_identifiers	Os identificadores de grupo associados ao usuário.
am_group	target.user.group_identifiers	Os identificadores de grupo associados ao usuário.
am_user	target.user.email_addresses	O endereço de e-mail do usuário, se estiver presente no campo am_user.
loginID[0]	target.user.userid	O ID de login usado no evento.
loginID[0]	target.user.email_addresses	O endereço de e-mail usado para fazer login, se presente no campo loginID.
hostip	intermediary.hostname	O nome do host de um dispositivo intermediário.
hostip	intermediary.ip	O endereço IP de um dispositivo intermediário.
src_ip	principal.asset.ip	O endereço IP de origem.
src_ip	principal.ip	O endereço IP de origem.
desc	metadata.description	É a descrição do evento.
payload	metadata.description	O payload do evento.
http.request.headers.host.0	tatget.hostname	Mapeado do registro de mudanças
http.request.headers.user-agent.0	network.http.user_agent	Mapeado do registro de alterações
extensions.auth.type	SSO	Mapeado do registro de mudanças

Registro de alterações

Confira o registro de alterações deste analisador

Precisa de mais ajuda? Receba respostas de membros da comunidade e profissionais do Google SecOps.