Coletar registros da Sonrai Security
Este documento explica como ingerir registros do Sonrai Security no Google Security Operations usando o Google Cloud Storage V2.
A Sonrai Security é uma plataforma de segurança empresarial na nuvem para governança de identidade, dados e acesso em ambientes multicloud. Ele fornece descobertas de segurança, tíquetes e dados de auditoria por meio de uma API GraphQL.
Antes de começar
Verifique se você tem os pré-requisitos a seguir:
- Uma instância do Google SecOps
- Um projeto do GCP com a API Cloud Storage ativada
- Permissões para criar e gerenciar buckets do GCS
- Permissões para gerenciar políticas do IAM em buckets do GCS
- Permissões para criar serviços do Cloud Run, tópicos do Pub/Sub e jobs do Cloud Scheduler
- Acesso privilegiado à Sonrai Security com permissões de administrador e acesso à chave de API
Criar um bucket do Google Cloud Storage
- Acesse o Console do Google Cloud.
- Selecione seu projeto ou crie um novo.
- No menu de navegação, acesse Cloud Storage > Buckets.
- Clique em Criar bucket.
Informe os seguintes detalhes de configuração:
Configuração Valor Nomeie seu bucket Insira um nome globalmente exclusivo (por exemplo, sonrai-security-logs)Tipo de local Escolha de acordo com suas necessidades (região, birregional, multirregional) Local Selecione o local (por exemplo, us-central1).Classe de armazenamento Padrão (recomendado para registros acessados com frequência) Controle de acesso Uniforme (recomendado) Ferramentas de proteção Opcional: ativar o controle de versões de objetos ou a política de retenção Clique em Criar.
Coletar credenciais da API Sonrai Security
Gerar chave de API
- Faça login na plataforma Sonrai Security como administrador.
- Acesse Configurações > Chaves de API.
- Clique em Criar chave de API.
- Insira um nome para a chave (por exemplo,
Google Security Operations Integration). - Copie e salve a chave de API gerada em um local seguro.
Determinar o URL da organização
O endpoint de API é baseado na sua organização da Sonrai Security. O formato é:
| Componente | Valor |
|---|---|
| Endpoint do GraphQL | https://YOUR_ORG.sonraisecurity.com/graphql |
Verifique as permissões
Para verificar se a chave de API tem o acesso necessário:
- Faça login na plataforma Sonrai Security.
- Acesse Configurações > Chaves de API.
- Verifique se a chave de API está listada e ativa.
- Confirme se a chave tem permissões para consultar dados de Tickets, Findings e Audit.
- Se as permissões forem restritas, entre em contato com o administrador da Sonrai Security.
Testar o acesso à API
Teste suas credenciais antes de prosseguir com a integração:
# Replace with your actual credentials API_KEY="your-api-key" ORG_URL="https://YOUR_ORG.sonraisecurity.com" # Test API access - query tickets curl -v -X POST \ -H "Authorization: Bearer ${API_KEY}" \ -H "Content-Type: application/json" \ -d '{"query": "{ Tickets(where: {createdDate: {op: GT, value: \"2024-01-01T00:00:00Z\"}}) { count } }"}' \ "${ORG_URL}/graphql"
Criar uma conta de serviço para a função do Cloud Run
A função do Cloud Run precisa de uma conta de serviço com permissões para gravar no bucket do GCS e ser invocada pelo Pub/Sub.
Criar conta de serviço
- No Console do GCP, acesse IAM e administrador > Contas de serviço.
- Clique em Criar conta de serviço.
- Informe os seguintes detalhes de configuração:
- Nome da conta de serviço: insira
sonrai-collector-sa. - Descrição da conta de serviço: insira
Service account for Cloud Run function to collect Sonrai Security logs.
- Nome da conta de serviço: insira
- Clique em Criar e continuar.
- Na seção Conceder acesso a essa conta de serviço ao projeto, adicione os seguintes papéis:
- Clique em Selecionar papel.
- Pesquise e selecione Administrador de objetos do Storage.
- Clique em + Adicionar outro papel.
- Pesquise e selecione Invocador do Cloud Run.
- Clique em + Adicionar outro papel.
- Pesquise e selecione Invocador do Cloud Functions.
- Clique em Continuar.
- Clique em Concluído.
Esses papéis são necessários para:
- Administrador de objetos do Storage: gravar registros no bucket do GCS e gerenciar arquivos de estado
- Invocador do Cloud Run: permite que o Pub/Sub invoque a função.
- Invocador do Cloud Functions: permite a invocação de funções.
Conceder permissões do IAM no bucket do GCS
Conceda à conta de serviço permissões de gravação no bucket do GCS:
- Acesse Cloud Storage > Buckets.
- Clique no nome do bucket (por exemplo,
sonrai-security-logs). - Acesse a guia Permissões.
- Clique em Conceder acesso.
- Informe os seguintes detalhes de configuração:
- Adicionar participantes: insira o e-mail da conta de serviço (por exemplo,
sonrai-collector-sa@your-project.iam.gserviceaccount.com). - Atribuir papéis: selecione Administrador de objetos do Storage.
- Adicionar participantes: insira o e-mail da conta de serviço (por exemplo,
- Clique em Salvar.
Criar tópico Pub/Sub
Crie um tópico do Pub/Sub em que o Cloud Scheduler vai publicar e a função do Cloud Run vai se inscrever.
- No Console do GCP, acesse Pub/Sub > Tópicos.
- Selecione Criar tópico.
- Informe os seguintes detalhes de configuração:
- ID do tópico: insira
sonrai-trigger. - Não mude as outras configurações.
- ID do tópico: insira
- Clique em Criar.
Criar uma função do Cloud Run para coletar registros
A função do Cloud Run será acionada por mensagens do Pub/Sub do Cloud Scheduler para buscar registros da API GraphQL da Sonrai Security e gravá-los no GCS.
- No Console do GCP, acesse o Cloud Run.
- Clique em Criar serviço.
- Selecione Função (use um editor in-line para criar uma função).
Na seção Configurar, forneça os seguintes detalhes de configuração:
Configuração Valor Nome do serviço sonrai-collectorRegião Selecione a região correspondente ao bucket do GCS (por exemplo, us-central1).Ambiente de execução Selecione Python 3.12 ou mais recente. Na seção Acionador (opcional):
- Clique em + Adicionar gatilho.
- Selecione Cloud Pub/Sub.
- Em Selecionar um tópico do Cloud Pub/Sub, escolha o tópico
sonrai-trigger. - Clique em Salvar.
Na seção Autenticação:
- Selecione Exigir autenticação.
- Verifique o Identity and Access Management (IAM).
Role para baixo e abra Contêineres, rede, segurança.
Acesse a guia Segurança:
- Conta de serviço: selecione a conta de serviço
sonrai-collector-sa.
- Conta de serviço: selecione a conta de serviço
Acesse a guia Contêineres:
- Clique em Variáveis e secrets.
- Clique em + Adicionar variável para cada variável de ambiente:
Nome da variável Valor de exemplo Descrição GCS_BUCKETsonrai-security-logsNome do bucket do GCS GCS_PREFIXsonraiPrefixo para arquivos de registro STATE_KEYsonrai/state.jsonCaminho do arquivo de estado API_KEYyour-api-keyChave de API da Sonrai Security ORG_URLhttps://YOUR_ORG.sonraisecurity.comURL da organização na Sonrai MAX_RECORDS10000Máximo de registros por execução PAGE_SIZE500Registros por página LOOKBACK_HOURS24Período de lookback inicial Role para baixo na guia Variáveis e secrets até Solicitações:
- Tempo limite da solicitação: insira
600segundos (10 minutos).
- Tempo limite da solicitação: insira
Acesse a guia Configurações em Contêineres:
- Na seção Recursos:
- Memória: selecione 512 MiB ou mais.
- CPU: selecione 1.
- Na seção Recursos:
Na seção Escalonamento de revisão:
- Número mínimo de instâncias: insira
0. - Número máximo de instâncias: insira
100(ou ajuste com base na carga esperada).
- Número mínimo de instâncias: insira
Clique em Criar.
Aguarde a criação do serviço (1 a 2 minutos).
Depois que o serviço for criado, o editor de código inline será aberto automaticamente.
Adicionar código da função
- Insira main em Ponto de entrada da função.
No editor de código inline, crie dois arquivos:
Primeiro arquivo: main.py:
import functions_framework from google.cloud import storage import json import os import urllib3 from datetime import datetime, timezone, timedelta import time # Initialize HTTP client with timeouts http = urllib3.PoolManager( timeout=urllib3.Timeout(connect=5.0, read=30.0), retries=False, ) # Initialize Storage client storage_client = storage.Client() # Environment variables GCS_BUCKET = os.environ.get('GCS_BUCKET') GCS_PREFIX = os.environ.get('GCS_PREFIX', 'sonrai') STATE_KEY = os.environ.get('STATE_KEY', 'sonrai/state.json') API_KEY = os.environ.get('API_KEY', '') ORG_URL = os.environ.get('ORG_URL', '').rstrip('/') MAX_RECORDS = int(os.environ.get('MAX_RECORDS', '10000')) PAGE_SIZE = int(os.environ.get('PAGE_SIZE', '500')) LOOKBACK_HOURS = int(os.environ.get('LOOKBACK_HOURS', '24')) def parse_datetime(value: str) -> datetime: """Parse ISO datetime string to datetime object.""" if value.endswith("Z"): value = value[:-1] + "+00:00" return datetime.fromisoformat(value) @functions_framework.cloud_event def main(cloud_event): """ Cloud Run function triggered by Pub/Sub to fetch Sonrai Security logs and write to GCS. Args: cloud_event: CloudEvent object containing Pub/Sub message """ if not all([GCS_BUCKET, API_KEY, ORG_URL]): print('Error: Missing required environment variables') return try: bucket = storage_client.bucket(GCS_BUCKET) # Load state state = load_state(bucket, STATE_KEY) # Determine time window now = datetime.now(timezone.utc) last_time = None if isinstance(state, dict) and state.get("last_event_time"): try: last_time = parse_datetime(state["last_event_time"]) last_time = last_time - timedelta(minutes=2) except Exception as e: print(f"Warning: Could not parse last_event_time: {e}") if last_time is None: last_time = now - timedelta(hours=LOOKBACK_HOURS) print(f"Fetching tickets from {last_time.isoformat()} to {now.isoformat()}") # Fetch tickets/findings records, newest_event_time = fetch_tickets( start_time=last_time, end_time=now, page_size=PAGE_SIZE, max_records=MAX_RECORDS, ) if not records: print("No new records found.") save_state(bucket, STATE_KEY, now.isoformat()) return # Write to GCS as NDJSON timestamp = now.strftime('%Y%m%d_%H%M%S') object_key = f"{GCS_PREFIX}/logs_{timestamp}.ndjson" blob = bucket.blob(object_key) ndjson = '\n'.join([json.dumps(record, ensure_ascii=False) for record in records]) + '\n' blob.upload_from_string(ndjson, content_type='application/x-ndjson') print(f"Wrote {len(records)} records to gs://{GCS_BUCKET}/{object_key}") if newest_event_time: save_state(bucket, STATE_KEY, newest_event_time) else: save_state(bucket, STATE_KEY, now.isoformat()) print(f"Successfully processed {len(records)} records") except Exception as e: print(f'Error processing logs: {str(e)}') raise def load_state(bucket, key): """Load state from GCS.""" try: blob = bucket.blob(key) if blob.exists(): state_data = blob.download_as_text() return json.loads(state_data) except Exception as e: print(f"Warning: Could not load state: {e}") return {} def save_state(bucket, key, last_event_time_iso: str): """Save the last event timestamp to GCS state file.""" try: state = {'last_event_time': last_event_time_iso} blob = bucket.blob(key) blob.upload_from_string( json.dumps(state, indent=2), content_type='application/json' ) print(f"Saved state: last_event_time={last_event_time_iso}") except Exception as e: print(f"Warning: Could not save state: {e}") def graphql_query(query: str): """Execute a GraphQL query against Sonrai Security API with rate limiting.""" endpoint = f"{ORG_URL}/graphql" headers = { 'Authorization': f'Bearer {API_KEY}', 'Content-Type': 'application/json', 'Accept': 'application/json', 'User-Agent': 'GoogleSecOps-SonraiCollector/1.0' } body = json.dumps({'query': query}) backoff = 1.0 max_retries = 3 for attempt in range(max_retries): response = http.request('POST', endpoint, body=body.encode('utf-8'), headers=headers) if response.status == 429: retry_after = int(response.headers.get('Retry-After', str(int(backoff)))) print(f"Rate limited (429). Retrying after {retry_after}s...") time.sleep(retry_after) backoff = min(backoff * 2, 30.0) continue if response.status != 200: print(f"HTTP Error: {response.status} - {response.data.decode('utf-8')}") return None data = json.loads(response.data.decode('utf-8')) if 'errors' in data: print(f"GraphQL errors: {json.dumps(data['errors'])}") return None return data.get('data') print(f"Failed after {max_retries} retries due to rate limiting") return None def fetch_tickets(start_time: datetime, end_time: datetime, page_size: int, max_records: int): """ Fetch tickets from Sonrai Security GraphQL API with pagination and rate limiting. """ records = [] newest_time = None page_num = 0 offset = 0 start_iso = start_time.strftime('%Y-%m-%dT%H:%M:%SZ') while True: page_num += 1 if len(records) >= max_records: print(f"Reached max_records limit ({max_records})") break current_limit = min(page_size, max_records - len(records)) query = f"""{{ Tickets( where: {{createdDate: {{op: GT, value: \"{start_iso}\"}}}} limit: {current_limit} offset: {offset} ) {{ count items {{ srn title severity status createdDate updatedDate resourceSrn eventName actionType sourceIp actor {{ profile {{ srn name }} }} message }} }} }}""" data = graphql_query(query) if not data: break tickets_data = data.get('Tickets', {}) page_results = tickets_data.get('items', []) if not page_results: print(f"No more results (empty page)") break print(f"Page {page_num}: Retrieved {len(page_results)} tickets") records.extend(page_results) # Track newest event time for ticket in page_results: try: event_time = ticket.get('createdDate') if event_time: if newest_time is None or parse_datetime(event_time) > parse_datetime(newest_time): newest_time = event_time except Exception as e: print(f"Warning: Could not parse event time: {e}") if len(page_results) < current_limit: print(f"Reached last page (size={len(page_results)} < limit={current_limit})") break offset += len(page_results) print(f"Retrieved {len(records)} total records from {page_num} pages") return records, newest_time
Segundo arquivo: requirements.txt::
functions-framework==3.* google-cloud-storage==2.* urllib3>=2.0.0
Clique em Implantar para salvar e implantar a função.
Aguarde a conclusão da implantação (2 a 3 minutos).
Criar o job do Cloud Scheduler
O Cloud Scheduler vai publicar mensagens no tópico do Pub/Sub em intervalos regulares, acionando a função do Cloud Run.
- No Console do GCP, acesse o Cloud Scheduler.
- Clique em Criar job.
Informe os seguintes detalhes de configuração:
Configuração Valor Nome sonrai-collector-hourlyRegião Selecione a mesma região da função do Cloud Run Frequência 0 * * * *(de hora em hora)Fuso horário Selecione o fuso horário (UTC recomendado) Tipo de destino Pub/Sub Tópico Selecione o tópico sonrai-trigger.Corpo da mensagem {}(objeto JSON vazio)Clique em Criar.
Opções de frequência de programação
Escolha a frequência com base no volume de registros e nos requisitos de latência:
| Frequência | Expressão Cron | Caso de uso |
|---|---|---|
| A cada 5 minutos | */5 * * * * |
Alto volume e baixa latência |
| A cada 15 minutos | */15 * * * * |
Volume médio |
| A cada hora | 0 * * * * |
Padrão (recomendado) |
| A cada 6 horas | 0 */6 * * * |
Processamento em lote de baixo volume |
| Diário | 0 0 * * * |
Coleta de dados históricos |
Testar a integração
- No console do Cloud Scheduler, encontre seu job (
sonrai-collector-hourly). - Clique em Forçar execução para acionar manualmente.
- Aguarde alguns segundos e acesse Cloud Run > Serviços > sonrai-collector > Registros.
Verifique se a função foi executada com sucesso. Procure por:
Fetching tickets from YYYY-MM-DDTHH:MM:SS+00:00 to YYYY-MM-DDTHH:MM:SS+00:00 Page 1: Retrieved X tickets Wrote X records to gs://sonrai-security-logs/sonrai/logs_YYYYMMDD_HHMMSS.ndjson Successfully processed X recordsVerifique o bucket do GCS (
sonrai-security-logs) para confirmar se os registros foram gravados.
Se você encontrar erros nos registros:
- HTTP 401: verifique a chave de API nas variáveis de ambiente.
- HTTP 403: verifique se a chave de API tem as permissões necessárias na plataforma Sonrai Security.
- HTTP 429: limitação de taxa. A função vai tentar novamente de forma automática com espera
- Erros do GraphQL: verifique a sintaxe da consulta e os campos disponíveis.
Configurar um feed no Google SecOps para ingerir registros do Sonrai Security
- Acesse Configurações > Gerenciamento de dados > Feeds. Se você estiver em uma plataforma somente SIEM, acesse Configurações > Feeds.
- Clique em Adicionar novo feed.
- Clique em Configurar um único feed.
- No campo Nome do feed, insira um nome para o feed (por exemplo,
Sonrai Security Logs). - Selecione Google Cloud Storage V2 como o Tipo de origem.
- Selecione Sonrai Enterprise Cloud Security Solution como o Tipo de registro.
Clique em Get Service Account. Um e-mail exclusivo da conta de serviço será exibido, por exemplo:
chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.comCopie o endereço de e-mail. Você vai usá-la na próxima etapa.
Clique em Próxima.
Especifique valores para os seguintes parâmetros de entrada:
URL do bucket de armazenamento: insira o URI do bucket do GCS com o caminho do prefixo:
gs://sonrai-security-logs/sonrai/- Substitua:
sonrai-security-logs: o nome do bucket do GCS.sonrai: prefixo/caminho de pasta opcional em que os registros são armazenados (deixe em branco para a raiz).
- Substitua:
Opção de exclusão da fonte: selecione a opção de exclusão de acordo com sua preferência:
- Nunca: nunca exclui arquivos após as transferências (recomendado para testes).
- Excluir arquivos transferidos: exclui arquivos após a transferência.
Excluir arquivos transferidos e diretórios vazios: exclui arquivos e diretórios vazios após a transferência.
Idade máxima do arquivo: inclua arquivos modificados nos últimos dias (o padrão é 180 dias).
Namespace do recurso: o namespace do recurso.
Rótulos de ingestão: o rótulo a ser aplicado aos eventos desse feed.
Clique em Próxima.
Revise a configuração do novo feed na tela Finalizar e clique em Enviar.
Conceder permissões do IAM à conta de serviço do Google SecOps
A conta de serviço do Google SecOps precisa do papel Leitor de objetos do Storage no bucket do GCS.
- Acesse Cloud Storage > Buckets.
- Clique no nome do bucket (
sonrai-security-logs). - Acesse a guia Permissões.
- Clique em Conceder acesso.
- Informe os seguintes detalhes de configuração:
- Adicionar principais: cole o e-mail da conta de serviço do Google SecOps.
- Atribuir papéis: selecione Leitor de objetos do Storage.
Clique em Salvar.
Tabela de mapeamento de UDM
| Campo de registro | Mapeamento de UDM | Lógica |
|---|---|---|
| actor.profile | principal.resource.attribute.labels | Rótulos associados ao recurso |
| actor.profile.srn | target.user.product_object_id | ID do objeto específico do produto para o usuário |
| actor.profile.srn | target.user.userid | ID do usuário |
| actorSrn, variables, gql, type | additional.fields | Campos adicionais não capturados em outro lugar no esquema de UDM |
| actionType | security_result.action_details | Detalhes da ação realizada |
| createdDate | metadata.event_timestamp | Carimbo de data/hora do evento |
| event_type | metadata.event_type | Tipo de evento (por exemplo, USER_LOGIN, NETWORK_CONNECTION) |
| eventName | metadata.product_event_type | Tipo de evento específico do produto |
| mensagem | security_result.summary | Resumo do resultado de segurança |
| metadados | metadados | Metadados sobre o evento. |
| participante | participante | Informações sobre o principal (ator) |
| resourceSrn | principal.resource.name | Nome do recurso |
| security_result | security_result | Informações do resultado de segurança |
| sourceIp | principal.asset.ip | Endereço IP do recurso |
| sourceIp | principal.ip | Endereço IP associado ao principal |
| destino | destino | Informações sobre o destino |
| extensions.auth.type | Tipo de autenticação usado no evento | |
| metadata.product_name | Nome do produto | |
| metadata.vendor_name | Nome do fornecedor/da empresa |
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.