Esta página foi traduzida pela API Cloud Translation.

Guia do utilizador da CLI do Google SecOps

Compatível com:

Google secops SIEM

O SDK do Google Security Operations oferece uma interface de linhas de comando (CLI) abrangente que facilita a interação com os produtos do Google SecOps a partir do seu terminal. A nova secops CLI substitui a chronicle_cli antiga com funcionalidades melhoradas e uma experiência do utilizador melhorada.

Vista geral

A CLI secops oferece acesso ao seguinte:

Pesquise e analise eventos da UDM
Faça a gestão de feeds, encaminhadores e analisadores
Crie e faça a gestão de regras de deteção
Trate alertas e registos
Faça a gestão das listas de referência e das tabelas de dados
Exporte dados para o BigQuery e o Google Cloud Storage
Consulte a IA do Gemini para obter estatísticas de segurança
E muito mais

Os comandos da CLI do Google SecOps usam a seguinte sintaxe:

$ secops COMMAND [SUBCOMMAND] [OPTIONS]

Por exemplo, para pesquisar eventos:

$ secops search --query "metadata.event_type = \"NETWORK_CONNECTION\"" --time-window 24

Antes de começar

Antes de instalar a CLI Google SecOps, certifique-se de que tem:

O Python 3.8 ou superior instalado no seu ambiente. Para mais informações, consulte o artigo Instalar o Python.
Uma instância do Google SecOps com autorizações de acesso adequadas.
Credenciais de autenticação (conta de serviço ou credenciais padrão da aplicação).

Instalação

Instale o SDK SecOps, que inclui a CLI:

pip install secops

Valide a instalação:

$ secops --help

Autenticação

A CLI suporta vários métodos de autenticação:

Usar credenciais padrão da aplicação (recomendado)

# Set up ADC with gcloud
gcloud auth application-default login

A usar a conta de serviço

Coloque o ficheiro JSON da conta de serviço numa localização segura e faça referência ao mesmo nos comandos:

$ secops search --service-account "/path/to/service-account.json" --customer-id "your-instance-id" --project-id "your-project-id" --query "metadata.event_type = \"USER_LOGIN\""

Configuração

Guarde definições comuns para evitar a repetição nos comandos:

Guardar configuração

# Save instance and authentication settings
$ secops config set --customer-id "your-instance-id" --project-id "your-project-id" --region "us"

# Save service account path (optional)
$ secops config set --service-account "/path/to/service-account.json" --customer-id "your-instance-id" --project-id "your-project-id"

# Set default time window
$ secops config set --time-window 48

Ver configuração

$ secops config view

Limpar configuração

$ secops config clear

Regiões

A CLI suporta todas as regiões do Google SecOps. Pode definir a região através de:

A flag --region com qualquer comando
O ficheiro de configuração que usa secops config set --region REGION

As regiões suportadas incluem: * US (predefinição) * EUROPE * ASIA-SOUTHEAST1 * ASIA-SOUTH1 * AUSTRALIA-SOUTHEAST1 * EUROPE-WEST2, EUROPE-WEST3, EUROPE-WEST6, EUROPE-WEST9, EUROPE-WEST12 * E mais

Comandos principais

Pesquisar eventos

Pesquise eventos UDM através da sintaxe de consulta:

# Search with UDM query
$ secops search --query "metadata.event_type = \"NETWORK_CONNECTION\"" --time-window 24 --max-events 100

# Search using natural language
$ secops search --nl-query "show me failed login attempts" --time-window 24

# Export results as CSV
$ secops search --query "metadata.event_type = \"USER_LOGIN\" AND security_result.action = \"BLOCK\"" \
    --fields "metadata.event_timestamp,principal.user.userid,principal.ip" \
    --time-window 24 --csv

Informações da entidade

Obtenha informações detalhadas sobre IPs, domínios ou hashes de ficheiros:

$ secops entity --value "8.8.8.8" --time-window 24
$ secops entity --value "example.com" --time-window 24
$ secops entity --value "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" --time-window 24

Estatísticas

Execute análises estatísticas nos seus dados:

$ secops stats --query "metadata.event_type = \"NETWORK_CONNECTION\"
match:
  target.hostname
outcome:
  \$count = count(metadata.id)
order:
  \$count desc" --time-window 24

Gestão de feeds

Faça a gestão dos feeds de carregamento de dados no Google SecOps:

Apresentar feeds

$ secops feed list

Criar feed

# Create an HTTP feed
$ secops feed create \
    --display-name "My HTTP Feed" \
    --details '{"logType":"projects/your-project-id/locations/us/instances/your-instance-id/logTypes/WINEVTLOG","feedSourceType":"HTTP","httpSettings":{"uri":"https://example.com/feed","sourceType":"FILES"}}'

Atualize o feed

$ secops feed update --id "feed-123" --display-name "Updated Feed Name"

Ativar/desativar feed

$ secops feed enable --id "feed-123"
$ secops feed disable --id "feed-123"

Elimine o feed

$ secops feed delete --id "feed-123"

Gestão do analisador

Os analisadores processam e normalizam os dados de registo não processados no formato UDM:

Listar analisadores

$ secops parser list
$ secops parser list --log-type "WINDOWS"

Obtenha detalhes do analisador

$ secops parser get --log-type "WINDOWS" --id "pa_12345"

Crie um analisador

# Create from file
$ secops parser create --log-type "CUSTOM_LOG" --parser-code-file "/path/to/parser.conf"

# Create from string
$ secops parser create --log-type "CUSTOM_LOG" --parser-code "filter { mutate { add_field => { \"test\" => \"value\" } } }"

Testar analisador

Teste um analisador em relação a registos de amostra antes da implementação:

# Test with inline logs
$ secops parser run \
    --log-type OKTA \
    --parser-code-file "./parser.conf" \
    --log '{"message": "Test log 1"}' \
    --log '{"message": "Test log 2"}'

# Test with logs from file
$ secops parser run \
    --log-type WINDOWS \
    --parser-code-file "./parser.conf" \
    --logs-file "./sample_logs.txt"

Ative/desative o analisador

$ secops parser activate --log-type "WINDOWS" --id "pa_12345"
$ secops parser deactivate --log-type "WINDOWS" --id "pa_12345"

Eliminar analisador

$ secops parser delete --log-type "WINDOWS" --id "pa_12345"

Gestão de extensões do analisador

As extensões de análise sintática expandem os analisadores existentes sem os substituir:

Apresentar extensões

$ secops parser-extension list --log-type OKTA

Criar extensão

$ secops parser-extension create --log-type OKTA \
    --log /path/to/sample.log \
    --parser-config-file /path/to/parser-config.conf

Ative a extensão

$ secops parser-extension activate --log-type OKTA --id "1234567890"

Gestão de encaminhadores

Os encaminhadores são usados para carregar registos com configurações específicas:

Crie um encaminhador

# Basic forwarder
$ secops forwarder create --display-name "my-custom-forwarder"

# With metadata and settings
$ secops forwarder create --display-name "prod-forwarder" \
    --metadata '{"environment":"prod","team":"security"}' \
    --upload-compression true \
    --http-settings '{"port":80,"host":"example.com"}'

Liste encaminhadores

$ secops forwarder list --page-size 100

Obtenha o encaminhador

$ secops forwarder get --id "1234567890"

Atualize o encaminhador

$ secops forwarder update --id "1234567890" --display-name "updated-name"

Elimine o encaminhador

$ secops forwarder delete --id "1234567890"

Carregamento de registos

Carregue registos para o Google SecOps:

Carregue registos não processados

# From file
$ secops log ingest --type "OKTA" --file "/path/to/okta_logs.json"

# With labels
$ secops log ingest --type "WINDOWS" --file "/path/to/logs.xml" \
    --labels "environment=production,team=security"

# Inline message
$ secops log ingest --type "WINDOWS" --message "{\"event\": \"data\"}"

Carregue eventos UDM

$ secops log ingest-udm --file "/path/to/udm_event.json"

Apresentar tipos de registos

$ secops log types
$ secops log types --search "windows"

Gere o mapeamento de UDM

$ secops log generate-udm-mapping \
    --log-format "JSON" \
    --log '{"id":"123","user":"test_user","source_ip":"192.168.1.10"}'

Gestão das regras

Faça a gestão das regras de deteção:

Regras de listas

$ secops rule list --page-size 50

Criar regra

$ secops rule create --file "/path/to/rule.yaral"

Atualizar regra

$ secops rule update --id "ru_12345" --file "/path/to/updated_rule.yaral"

Ativar/desativar regra

$ secops rule enable --id "ru_12345" --enabled true
$ secops rule enable --id "ru_12345" --enabled false

Regra de teste

Teste uma regra com dados do histórico:

# Test for last 24 hours
$ secops rule test --file "/path/to/rule.yaral" --time-window 24

# Test with specific time range
$ secops rule test --file "/path/to/rule.yaral" \
    --start-time "2023-07-01T00:00:00Z" \
    --end-time "2023-07-02T00:00:00Z" \
    --max-results 1000

Validar regra

$ secops rule validate --file "/path/to/rule.yaral"

Eliminar Regra

$ secops rule delete --id "ru_12345"

Gestão de alertas

Receba e faça a gestão de alertas:

$ secops alert --time-window 24 --max-alerts 50
$ secops alert --snapshot-query "feedback_summary.status != \"CLOSED\"" --time-window 24

Gestão de registos

Obtenha detalhes do registo:

$ secops case --ids "case-123,case-456"

Tabelas de dados

As tabelas de dados são recolhas de dados estruturados para utilização em regras de deteção:

Crie uma tabela de dados

$ secops data-table create \
    --name "suspicious_ips" \
    --description "Known suspicious IP addresses" \
    --header '{"ip_address":"CIDR","description":"STRING","severity":"STRING"}'

Adicionar linhas

$ secops data-table add-rows \
    --name "suspicious_ips" \
    --rows '[["192.168.1.100","Scanning activity","Medium"]]'

Apresentar linhas

$ secops data-table list-rows --name "suspicious_ips"

Elimine a tabela de dados

$ secops data-table delete --name "suspicious_ips"

Listas de referências

As listas de referência são listas de valores simples para regras de deteção:

Crie uma lista de referências

$ secops reference-list create \
    --name "admin_accounts" \
    --description "Administrative accounts" \
    --entries "admin,administrator,root,superuser"

Atualize a lista de referências

$ secops reference-list update \
    --name "admin_accounts" \
    --entries "admin,administrator,root,superuser,sysadmin"

Apresente listas de referências

$ secops reference-list list

Exportação de dados

Exporte dados para análise:

Criar exportação

# Export specific log type
$ secops export create \
    --gcs-bucket "projects/my-project/buckets/my-bucket" \
    --log-type "WINDOWS" \
    --time-window 24

# Export all logs
$ secops export create \
    --gcs-bucket "projects/my-project/buckets/my-bucket" \
    --all-logs \
    --time-window 168

Verifique o estado da exportação

$ secops export status --id "export-123"

Cancelar exportação

$ secops export cancel --id "export-123"

Liste os tipos de registos disponíveis para exportação

$ secops export log-types --time-window 24

Integração da IA do Gemini

Consultar a IA do Gemini para obter estatísticas de segurança:

# Ask about security concepts
$ secops gemini --query "What is Windows event ID 4625?"

# Generate detection rules
$ secops gemini --query "Write a rule to detect PowerShell downloading files"

# Get vulnerability information
$ secops gemini --query "Tell me about CVE-2021-44228"

Ative o Gemini:

$ secops gemini --opt-in

Gestão do painel de controlo

Faça a gestão dos painéis de controlo nativos:

Criar painel de controlo

$ secops dashboard create \
    --display-name "Security Overview" \
    --description "Security monitoring dashboard" \
    --access-type PRIVATE

Listar painéis de controlo

$ secops dashboard list --page-size 10

Atualizar painel de controlo

$ secops dashboard update --id dashboard-id \
    --display-name "Updated Security Dashboard" \
    --description "Updated security monitoring dashboard"

Painel de controlo de exportação/importação

# Export
$ secops dashboard export --dashboard-names 'projects/your-project-id/locations/us/instances/your-instance-id/nativeDashboard/xxxxxxx'

# Import
$ secops dashboard import --dashboard-data-file dashboard_data.json

Adicionar gráfico ao painel de controlo

$ secops dashboard add-chart --dashboard-id dashboard-id \
    --display-name "DNS Query Chart" \
    --description "Shows DNS query patterns" \
    --query-file dns_query.txt \
    --chart_layout '{"startX": 0, "spanX": 12, "startY": 0, "spanY": 8}'

Eliminar painel

$ secops dashboard delete --id dashboard-id

Exemplos avançados

Fluxo de trabalho do analisador completo

Receba, teste e implemente um analisador:

# List parsers
$ secops parser list --log-type "OKTA" > okta_parsers.json

# Get parser details
PARSER_ID=$(cat okta_parsers.json | jq -r '.[0].name' | awk -F'/' '{print $NF}')
$ secops parser get --log-type "OKTA" --id "$PARSER_ID" > parser_details.json

# Extract parser code
cat parser_details.json | jq -r '.cbn' | base64 -d > okta_parser.conf

# Test parser
$ secops parser run \
    --log-type "OKTA" \
    --parser-code-file "okta_parser.conf" \
    --logs-file "sample_logs.txt" > parser_result.json

# Activate if successful
$ secops parser activate --log-type "OKTA" --id "$PARSER_ID"

Fluxo de trabalho de pesquisa e exportação

Pesquise eventos e exporte resultados:

# Search for failed logins
$ secops search \
    --query "metadata.event_type = \"USER_LOGIN\" AND security_result.action = \"BLOCK\"" \
    --fields "metadata.event_timestamp,principal.user.userid,principal.ip" \
    --time-window 24 \
    --csv > failed_logins.csv

# Get entity details for suspicious IPs
cat failed_logins.csv | awk -F',' '{print $3}' | sort -u | while read ip; do
    secops entity --value "$ip" --time-window 72
done

Testes e implementação de regras

Crie, teste e implemente uma regra de deteção:

# Create rule file
cat > suspicious_activity.yaral << 'EOF'
rule suspicious_powershell {
    meta:
        description = "Detects suspicious PowerShell activity"
        severity = "Medium"
    events:
        $e.metadata.event_type = "PROCESS_LAUNCH"
        $e.principal.process.file.full_path = /powershell\.exe/i nocase
        $e.principal.process.command_line = /download|invoke-expression|hidden/i nocase
    condition:
        $e
}
EOF

# Validate rule
$ secops rule validate --file suspicious_activity.yaral

# Test against historical data
$ secops rule test --file suspicious_activity.yaral --time-window 168

# Create and enable if tests pass
$ secops rule create --file suspicious_activity.yaral
$ secops rule enable --id "ru_generated_id" --enabled true

Resolução de problemas

Problemas comuns

Erros de autenticação

Se encontrar erros de autenticação:

Valide se as suas credenciais são válidas
Verifique se a sua conta de serviço tem as autorizações necessárias
Certifique-se de que o ADC está configurado corretamente: gcloud auth application-default login

Erros de região

Se receber erros relacionados com a região:

Verifique se a região é suportada
Verifique se a sua instância está na região especificada
Use o sinalizador --region ou defina-o na configuração

Limitação de velocidade

Para problemas de limitação de velocidade:

Reduza a frequência das chamadas API
Use a paginação para grandes conjuntos de resultados
Implemente a retirada exponencial para novas tentativas

Receber ajuda

Ver ajuda para qualquer comando:

$ secops --help
$ secops search --help
$ secops rule create --help

Migração do chronicle_cli

Se estiver a migrar do chronicle_cli antigo, aqui tem um mapeamento dos comandos comuns:

chronicle_cli	secops
`chronicle_cli feeds create`	`secops feed create`
`chronicle_cli feeds list`	`secops feed list`
`chronicle_cli feeds update`	`secops feed update`
`chronicle_cli feeds delete`	`secops feed delete`
`chronicle_cli parsers list`	`secops parser list`
`chronicle_cli parsers create`	`secops parser create`
`chronicle_cli parsers activate`	`secops parser activate`
`chronicle_cli forwarders create`	`secops forwarder create`
`chronicle_cli forwarders list`	`secops forwarder list`

A nova CLI secops oferece muitas funcionalidades adicionais não disponíveis na chronicle_cli, incluindo:

Pesquisa de linguagem natural
Integração da IA do Gemini
Gestão do painel de controlo
Testes e validação de regras
Tabelas de dados e listas de referências
Gestão de registos
E muito mais