mirror of
https://github.com/Security-Onion-Solutions/securityonion.git
synced 2026-06-14 22:28:43 +02:00
Merge remote-tracking branch 'origin/3/dev' into saltthangs
This commit is contained in:
@@ -63,7 +63,8 @@
|
|||||||
{ "set": { "if": "ctx.event?.dataset != null && !ctx.event.dataset.contains('.')", "field": "event.dataset", "value": "{{event.module}}.{{event.dataset}}" } },
|
{ "set": { "if": "ctx.event?.dataset != null && !ctx.event.dataset.contains('.')", "field": "event.dataset", "value": "{{event.module}}.{{event.dataset}}" } },
|
||||||
{ "split": { "if": "ctx.event?.dataset != null && ctx.event.dataset.contains('.')", "field": "event.dataset", "separator": "\\.", "target_field": "dataset_tag_temp" } },
|
{ "split": { "if": "ctx.event?.dataset != null && ctx.event.dataset.contains('.')", "field": "event.dataset", "separator": "\\.", "target_field": "dataset_tag_temp" } },
|
||||||
{ "append": { "if": "ctx.dataset_tag_temp != null", "field": "tags", "value": "{{dataset_tag_temp.1}}" } },
|
{ "append": { "if": "ctx.dataset_tag_temp != null", "field": "tags", "value": "{{dataset_tag_temp.1}}" } },
|
||||||
{ "convert": { "if": "ctx.http?.response?.status_code != null", "field": "http.response.status_code", "type":"long", "ignore_missing": true } },
|
{ "grok": { "if": "ctx.http?.response?.status_code instanceof String", "field": "http.response.status_code", "patterns": ["%{NUMBER:http.response.status_code:long}(?:\\s+%{GREEDYDATA})?"], "ignore_failure": true } },
|
||||||
|
{ "convert": { "if": "ctx.http?.response?.status_code != null && !(ctx.http.response.status_code instanceof Number)", "field": "http.response.status_code", "type": "long", "ignore_failure": true } },
|
||||||
{ "set": { "if": "ctx?.metadata?.kafka != null" , "field": "kafka.id", "value": "{{metadata.kafka.partition}}{{metadata.kafka.offset}}{{metadata.kafka.timestamp}}", "ignore_failure": true } },
|
{ "set": { "if": "ctx?.metadata?.kafka != null" , "field": "kafka.id", "value": "{{metadata.kafka.partition}}{{metadata.kafka.offset}}{{metadata.kafka.timestamp}}", "ignore_failure": true } },
|
||||||
{ "remove": { "field": [ "message2", "type", "fields", "category", "module", "dataset", "dataset_tag_temp", "event.dataset_temp" ], "ignore_missing": true, "ignore_failure": true } },
|
{ "remove": { "field": [ "message2", "type", "fields", "category", "module", "dataset", "dataset_tag_temp", "event.dataset_temp" ], "ignore_missing": true, "ignore_failure": true } },
|
||||||
{ "pipeline": { "name": "global@custom", "ignore_missing_pipeline": true, "description": "[Fleet] Global pipeline for all data streams" } }
|
{ "pipeline": { "name": "global@custom", "ignore_missing_pipeline": true, "description": "[Fleet] Global pipeline for all data streams" } }
|
||||||
|
|||||||
@@ -177,12 +177,84 @@
|
|||||||
"description": "Extract IPs from Elastic Agent events (host.ip) and adds them to related.ip"
|
"description": "Extract IPs from Elastic Agent events (host.ip) and adds them to related.ip"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"script": {
|
||||||
|
"description": "Snapshot event.ingested into _tmp.event_ingested_pre_fleet before .fleet_final_pipeline-1 overwrites it with ES ingest time",
|
||||||
|
"lang": "painless",
|
||||||
|
"if": "ctx.event?.ingested != null && ctx.event?.created == null",
|
||||||
|
"ignore_failure": true,
|
||||||
|
"source": "ctx.putIfAbsent('_tmp', [:]); ctx._tmp.event_ingested_pre_fleet = ctx.event.ingested;"
|
||||||
|
}
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"pipeline": {
|
"pipeline": {
|
||||||
"name": ".fleet_final_pipeline-1",
|
"name": ".fleet_final_pipeline-1",
|
||||||
"ignore_missing_pipeline": true
|
"ignore_missing_pipeline": true
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"script": {
|
||||||
|
"description": "Calculate time from Elastic Agent to Logstash.",
|
||||||
|
"lang": "painless",
|
||||||
|
"if": "ctx._tmp?.logstash_from_agent != null",
|
||||||
|
"ignore_failure": true,
|
||||||
|
"source": "ZonedDateTime start = ctx._tmp.event_ingested_pre_fleet != null ? ZonedDateTime.parse(ctx._tmp.event_ingested_pre_fleet) : ZonedDateTime.parse(ctx['@timestamp']); ctx.event.putIfAbsent('ingestion', [:]); ctx.event.ingestion.latency_elasticagent_to_logstash = ChronoUnit.SECONDS.between(start, ZonedDateTime.parse(ctx._tmp.logstash_from_agent));"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"script": {
|
||||||
|
"description": "Calculate time from Logstash to Redis",
|
||||||
|
"lang": "painless",
|
||||||
|
"if": "ctx._tmp?.logstash_from_agent != null && ctx._tmp?.logstash_to_redis != null",
|
||||||
|
"ignore_failure": true,
|
||||||
|
"source": "ctx.event.putIfAbsent('ingestion', [:]); ctx.event.ingestion.latency_logstash_to_redis = ChronoUnit.SECONDS.between(ZonedDateTime.parse(ctx._tmp.logstash_from_agent), ZonedDateTime.parse(ctx._tmp.logstash_to_redis));"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"script": {
|
||||||
|
"description": "Calculate time message spends in redis queue (logstash delay in pulling event).",
|
||||||
|
"lang": "painless",
|
||||||
|
"if": "ctx._tmp?.logstash_to_redis != null && ctx._tmp?.logstash_from_redis != null",
|
||||||
|
"ignore_failure": true,
|
||||||
|
"source": "ctx.event.putIfAbsent('ingestion', [:]); ctx.event.ingestion.latency_redis_to_logstash = ChronoUnit.SECONDS.between(ZonedDateTime.parse(ctx._tmp.logstash_to_redis), ZonedDateTime.parse(ctx._tmp.logstash_from_redis));"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"script": {
|
||||||
|
"description": "Calculate time from Logstash to Elasticsearch (after read from Redis).",
|
||||||
|
"lang": "painless",
|
||||||
|
"if": "ctx._tmp?.logstash_from_redis != null",
|
||||||
|
"ignore_failure": true,
|
||||||
|
"source": "ctx.event.putIfAbsent('ingestion', [:]); ctx.event.ingestion.latency_logstash_to_elasticsearch = ChronoUnit.SECONDS.between(ZonedDateTime.parse(ctx._tmp.logstash_from_redis), metadata().now);"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"script": {
|
||||||
|
"description": "Calculate time from Elastic Agent to Kafka.",
|
||||||
|
"lang": "painless",
|
||||||
|
"if": "ctx._tmp?.logstash_from_kafka != null && ctx._tmp?.logstash_from_agent == null",
|
||||||
|
"ignore_failure": true,
|
||||||
|
"source": "ZonedDateTime start = ctx._tmp.event_ingested_pre_fleet != null ? ZonedDateTime.parse(ctx._tmp.event_ingested_pre_fleet) : ZonedDateTime.parse(ctx['@timestamp']); ctx.event.putIfAbsent('ingestion', [:]); ctx.event.ingestion.latency_elasticagent_to_kafka = ChronoUnit.SECONDS.between(start, ZonedDateTime.parse(ctx._tmp.logstash_from_kafka));"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"script": {
|
||||||
|
"description": "Calculate time message spends in Kafka queue (logstash delay in pulling event).",
|
||||||
|
"lang": "painless",
|
||||||
|
"if": "ctx._tmp?.logstash_from_kafka != null && ctx.metadata?.kafka?.timestamp != null && ctx._tmp?.logstash_from_agent == null",
|
||||||
|
"ignore_failure": true,
|
||||||
|
"source": "ctx.event.putIfAbsent('ingestion', [:]); ctx.event.ingestion.latency_kafka_queue = ChronoUnit.SECONDS.between(ZonedDateTime.ofInstant(Instant.ofEpochMilli(Long.parseLong(ctx.metadata.kafka.timestamp.toString())), ZoneId.of('UTC')), ZonedDateTime.parse(ctx._tmp.logstash_from_kafka));"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"script": {
|
||||||
|
"description": "Calculate time from Logstash to Elasticsearch (after read from Kafka).",
|
||||||
|
"lang": "painless",
|
||||||
|
"if": "ctx._tmp?.logstash_from_kafka != null && ctx._tmp?.logstash_from_agent == null",
|
||||||
|
"ignore_failure": true,
|
||||||
|
"source": "ctx.event.putIfAbsent('ingestion', [:]); ctx.event.ingestion.latency_kafka_to_elasticsearch = ChronoUnit.SECONDS.between(ZonedDateTime.parse(ctx._tmp.logstash_from_kafka), metadata().now);"
|
||||||
|
}
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"remove": {
|
"remove": {
|
||||||
"field": "event.agent_id_status",
|
"field": "event.agent_id_status",
|
||||||
@@ -202,7 +274,8 @@
|
|||||||
"event.dataset_temp",
|
"event.dataset_temp",
|
||||||
"dataset_tag_temp",
|
"dataset_tag_temp",
|
||||||
"module_temp",
|
"module_temp",
|
||||||
"datastream_dataset_temp"
|
"datastream_dataset_temp",
|
||||||
|
"_tmp"
|
||||||
],
|
],
|
||||||
"ignore_missing": true,
|
"ignore_missing": true,
|
||||||
"ignore_failure": true
|
"ignore_failure": true
|
||||||
|
|||||||
@@ -26,12 +26,12 @@ logstash:
|
|||||||
manager:
|
manager:
|
||||||
- so/0011_input_endgame.conf
|
- so/0011_input_endgame.conf
|
||||||
- so/0012_input_elastic_agent.conf.jinja
|
- so/0012_input_elastic_agent.conf.jinja
|
||||||
- so/0013_input_lumberjack_fleet.conf
|
- so/0013_input_lumberjack_fleet.conf.jinja
|
||||||
- so/9999_output_redis.conf.jinja
|
- so/9999_output_redis.conf.jinja
|
||||||
receiver:
|
receiver:
|
||||||
- so/0011_input_endgame.conf
|
- so/0011_input_endgame.conf
|
||||||
- so/0012_input_elastic_agent.conf.jinja
|
- so/0012_input_elastic_agent.conf.jinja
|
||||||
- so/0013_input_lumberjack_fleet.conf
|
- so/0013_input_lumberjack_fleet.conf.jinja
|
||||||
- so/9999_output_redis.conf.jinja
|
- so/9999_output_redis.conf.jinja
|
||||||
search:
|
search:
|
||||||
- so/0900_input_redis.conf.jinja
|
- so/0900_input_redis.conf.jinja
|
||||||
@@ -69,4 +69,5 @@ logstash:
|
|||||||
pipeline_x_batch_x_size: 125
|
pipeline_x_batch_x_size: 125
|
||||||
pipeline_x_ecs_compatibility: disabled
|
pipeline_x_ecs_compatibility: disabled
|
||||||
dmz_nodes: []
|
dmz_nodes: []
|
||||||
|
latency_metrics: False
|
||||||
|
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
|
{%- from 'logstash/map.jinja' import LOGSTASH_MERGED %}
|
||||||
input {
|
input {
|
||||||
elastic_agent {
|
elastic_agent {
|
||||||
port => 5055
|
port => 5055
|
||||||
@@ -11,10 +12,15 @@ input {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
filter {
|
filter {
|
||||||
if ![metadata] {
|
{% if LOGSTASH_MERGED.get('latency_metrics', False) %}
|
||||||
mutate {
|
ruby {
|
||||||
rename => {"@metadata" => "metadata"}
|
code => "event.set('[_tmp][logstash_from_agent]', Time.now().utc.iso8601(3));"
|
||||||
|
}
|
||||||
|
{% endif %}
|
||||||
|
if ![metadata] {
|
||||||
|
mutate {
|
||||||
|
rename => {"@metadata" => "metadata"}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,23 +0,0 @@
|
|||||||
input {
|
|
||||||
elastic_agent {
|
|
||||||
port => 5056
|
|
||||||
tags => [ "elastic-agent", "fleet-lumberjack-input" ]
|
|
||||||
ssl_enabled => true
|
|
||||||
ssl_certificate => "/usr/share/logstash/elasticfleet-lumberjack.crt"
|
|
||||||
ssl_key => "/usr/share/logstash/elasticfleet-lumberjack.key"
|
|
||||||
ecs_compatibility => v8
|
|
||||||
id => "fleet-lumberjack-in"
|
|
||||||
codec => "json"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
filter {
|
|
||||||
if ![metadata] {
|
|
||||||
mutate {
|
|
||||||
rename => {"@metadata" => "metadata"}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
{%- from 'logstash/map.jinja' import LOGSTASH_MERGED %}
|
||||||
|
input {
|
||||||
|
elastic_agent {
|
||||||
|
port => 5056
|
||||||
|
tags => [ "elastic-agent", "fleet-lumberjack-input" ]
|
||||||
|
ssl_enabled => true
|
||||||
|
ssl_certificate => "/usr/share/logstash/elasticfleet-lumberjack.crt"
|
||||||
|
ssl_key => "/usr/share/logstash/elasticfleet-lumberjack.key"
|
||||||
|
ecs_compatibility => v8
|
||||||
|
id => "fleet-lumberjack-in"
|
||||||
|
codec => "json"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
filter {
|
||||||
|
{% if LOGSTASH_MERGED.get('latency_metrics', False) %}
|
||||||
|
ruby {
|
||||||
|
code => "event.set('[_tmp][logstash_from_fleet]', Time.now().utc.iso8601(3));"
|
||||||
|
}
|
||||||
|
{% endif %}
|
||||||
|
if ![metadata] {
|
||||||
|
mutate {
|
||||||
|
rename => {"@metadata" => "metadata"}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,3 +1,4 @@
|
|||||||
|
{%- from 'logstash/map.jinja' import LOGSTASH_MERGED %}
|
||||||
{%- set kafka_password = salt['pillar.get']('kafka:config:password') %}
|
{%- set kafka_password = salt['pillar.get']('kafka:config:password') %}
|
||||||
{%- set kafka_trustpass = salt['pillar.get']('kafka:config:trustpass') %}
|
{%- set kafka_trustpass = salt['pillar.get']('kafka:config:trustpass') %}
|
||||||
{%- set kafka_brokers = salt['pillar.get']('kafka:nodes', {}) %}
|
{%- set kafka_brokers = salt['pillar.get']('kafka:nodes', {}) %}
|
||||||
@@ -30,6 +31,11 @@ input {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
filter {
|
filter {
|
||||||
|
{% if LOGSTASH_MERGED.get('latency_metrics', False) %}
|
||||||
|
ruby {
|
||||||
|
code => "event.set('[_tmp][logstash_from_kafka]', Time.now().utc.iso8601(3));"
|
||||||
|
}
|
||||||
|
{% endif %}
|
||||||
if ![metadata] {
|
if ![metadata] {
|
||||||
mutate {
|
mutate {
|
||||||
rename => { "@metadata" => "metadata" }
|
rename => { "@metadata" => "metadata" }
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
{%- from 'logstash/map.jinja' import LOGSTASH_REDIS_NODES with context %}
|
{%- from 'logstash/map.jinja' import LOGSTASH_REDIS_NODES, LOGSTASH_MERGED %}
|
||||||
{%- set REDIS_PASS = salt['pillar.get']('redis:config:requirepass') %}
|
{%- set REDIS_PASS = salt['pillar.get']('redis:config:requirepass') %}
|
||||||
|
|
||||||
{%- for index in range(LOGSTASH_REDIS_NODES|length) %}
|
{%- for index in range(LOGSTASH_REDIS_NODES|length) %}
|
||||||
@@ -18,3 +18,10 @@ input {
|
|||||||
}
|
}
|
||||||
{% endfor %}
|
{% endfor %}
|
||||||
{% endfor -%}
|
{% endfor -%}
|
||||||
|
filter {
|
||||||
|
{% if LOGSTASH_MERGED.get('latency_metrics', False) %}
|
||||||
|
ruby {
|
||||||
|
code => "event.set('[_tmp][logstash_from_redis]', Time.now().utc.iso8601(3));"
|
||||||
|
}
|
||||||
|
{% endif %}
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,3 +1,11 @@
|
|||||||
|
{%- from 'logstash/map.jinja' import LOGSTASH_MERGED %}
|
||||||
|
{% if LOGSTASH_MERGED.get('latency_metrics', False) %}
|
||||||
|
filter {
|
||||||
|
ruby {
|
||||||
|
code => "event.set('[_tmp][logstash_to_elasticsearch]', Time.now().utc.iso8601(3));"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
{% endif %}
|
||||||
output {
|
output {
|
||||||
if "elastic-agent" in [tags] and "so-ip-mappings" in [tags] {
|
if "elastic-agent" in [tags] and "so-ip-mappings" in [tags] {
|
||||||
elasticsearch {
|
elasticsearch {
|
||||||
|
|||||||
@@ -13,7 +13,14 @@ filter {
|
|||||||
add_tag => "fleet-lumberjack-{{ GLOBALS.hostname }}"
|
add_tag => "fleet-lumberjack-{{ GLOBALS.hostname }}"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
{%- from 'logstash/map.jinja' import LOGSTASH_MERGED %}
|
||||||
|
{% if LOGSTASH_MERGED.get('latency_metrics', False) %}
|
||||||
|
filter {
|
||||||
|
ruby {
|
||||||
|
code => "event.set('[_tmp][fleet_to_logstash]', Time.now().utc.iso8601(3));"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
{% endif %}
|
||||||
output {
|
output {
|
||||||
lumberjack {
|
lumberjack {
|
||||||
codec => json
|
codec => json
|
||||||
|
|||||||
@@ -1,10 +1,17 @@
|
|||||||
|
{%- from 'logstash/map.jinja' import LOGSTASH_MERGED %}
|
||||||
{%- if grains.role in ['so-heavynode', 'so-receiver'] %}
|
{%- if grains.role in ['so-heavynode', 'so-receiver'] %}
|
||||||
{%- set HOST = GLOBALS.hostname %}
|
{%- set HOST = GLOBALS.hostname %}
|
||||||
{%- else %}
|
{%- else %}
|
||||||
{%- set HOST = GLOBALS.manager %}
|
{%- set HOST = GLOBALS.manager %}
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
{%- set REDIS_PASS = salt['pillar.get']('redis:config:requirepass') %}
|
{%- set REDIS_PASS = salt['pillar.get']('redis:config:requirepass') %}
|
||||||
|
{% if LOGSTASH_MERGED.get('latency_metrics', False) %}
|
||||||
|
filter {
|
||||||
|
ruby {
|
||||||
|
code => "event.set('[_tmp][logstash_to_redis]', Time.now().utc.iso8601(3));"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
{% endif %}
|
||||||
output {
|
output {
|
||||||
redis {
|
redis {
|
||||||
host => '{{ HOST }}'
|
host => '{{ HOST }}'
|
||||||
|
|||||||
@@ -86,3 +86,8 @@ logstash:
|
|||||||
multiline: True
|
multiline: True
|
||||||
advanced: True
|
advanced: True
|
||||||
forcedType: "[]string"
|
forcedType: "[]string"
|
||||||
|
latency_metrics:
|
||||||
|
description: Enable latency metrics within events processed by logstash. Useful for pinpointing log ingest delay.
|
||||||
|
forcedType: bool
|
||||||
|
global: False
|
||||||
|
advanced: True
|
||||||
|
|||||||
+381
@@ -0,0 +1,381 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
|
||||||
|
# Copyright Security Onion Solutions LLC and/or licensed to Security Onion Solutions LLC under one
|
||||||
|
# or more contributor license agreements. Licensed under the Elastic License 2.0 as shown at
|
||||||
|
# https://securityonion.net/license; you may not use this file except in compliance with the
|
||||||
|
# Elastic License 2.0.
|
||||||
|
|
||||||
|
# Imports detection overrides (e.g. from so-detections-backup) into the so-detection
|
||||||
|
# index. Reads <publicId>.<ext> files (NDJSON, one override per line) from a source
|
||||||
|
# directory, looks up the matching detection by publicId+engine, validates each
|
||||||
|
# override against the same rules SOC enforces, dedupes against existing overrides
|
||||||
|
# (operational fields only), and appends new ones.
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import ipaddress
|
||||||
|
import json
|
||||||
|
import os
|
||||||
|
import re
|
||||||
|
import sys
|
||||||
|
from datetime import datetime
|
||||||
|
|
||||||
|
import requests
|
||||||
|
from requests.auth import HTTPBasicAuth
|
||||||
|
import urllib3
|
||||||
|
|
||||||
|
urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
|
||||||
|
|
||||||
|
DEFAULT_INDEX = "so-detection"
|
||||||
|
AUTH_FILE = "/opt/so/conf/elasticsearch/curl.config"
|
||||||
|
ES_URL = "https://localhost:9200"
|
||||||
|
|
||||||
|
# Engines we know how to handle and the file extension the backup script writes.
|
||||||
|
ENGINES = {
|
||||||
|
"suricata": "txt",
|
||||||
|
}
|
||||||
|
|
||||||
|
# Standard Suricata variables that ship with Security Onion. Anything else
|
||||||
|
# referenced in an override is "custom" and the user needs to make sure it
|
||||||
|
# exists in SOC Config before the override will function.
|
||||||
|
BUILTIN_SURICATA_VARS = {
|
||||||
|
"$HOME_NET", "$EXTERNAL_NET",
|
||||||
|
"$HTTP_SERVERS", "$DNS_SERVERS", "$SQL_SERVERS", "$SMTP_SERVERS",
|
||||||
|
"$TELNET_SERVERS", "$AIM_SERVERS", "$DC_SERVERS", "$MODBUS_SERVER",
|
||||||
|
"$MODBUS_CLIENT", "$ENIP_CLIENT", "$ENIP_SERVER",
|
||||||
|
"$HTTP_PORTS", "$SHELLCODE_PORTS", "$ORACLE_PORTS", "$SSH_PORTS",
|
||||||
|
"$FTP_PORTS", "$FILE_DATA_PORTS",
|
||||||
|
}
|
||||||
|
|
||||||
|
VAR_PATTERN = re.compile(r"\$[A-Z_][A-Z0-9_]*")
|
||||||
|
|
||||||
|
# Canonical valid values, per securityonion-soc/model/detection.go.
|
||||||
|
SURICATA_OVERRIDE_TYPES = {"suppress", "threshold", "modify"}
|
||||||
|
SUPPRESS_TRACKS = {"by_src", "by_dst", "by_either"}
|
||||||
|
THRESHOLD_TRACKS = {"by_src", "by_dst", "by_both"}
|
||||||
|
THRESHOLD_TYPES = {"limit", "threshold", "both"}
|
||||||
|
|
||||||
|
STALE_WARNING = """\
|
||||||
|
WARNING: so-detections-backup does not remove backup files when overrides are
|
||||||
|
deleted via the Security Onion web UI. As a result, files in the source
|
||||||
|
directory may represent overrides that were intentionally deleted and should
|
||||||
|
NOT be re-imported.
|
||||||
|
|
||||||
|
Before continuing, verify that the source directory reflects the overrides you
|
||||||
|
actually want imported. Remove any files corresponding to overrides you previously deleted.
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
def make_session(auth_file):
|
||||||
|
with open(auth_file, "r") as f:
|
||||||
|
for line in f:
|
||||||
|
if line.startswith("user ="):
|
||||||
|
creds = line.split("=", 1)[1].strip().replace('"', "")
|
||||||
|
user, _, password = creds.partition(":")
|
||||||
|
session = requests.Session()
|
||||||
|
session.auth = HTTPBasicAuth(user, password)
|
||||||
|
session.headers.update({"Content-Type": "application/json"})
|
||||||
|
session.verify = False
|
||||||
|
return session
|
||||||
|
raise RuntimeError(f"Could not find 'user =' line in {auth_file}")
|
||||||
|
|
||||||
|
|
||||||
|
def find_detection(session, index, public_id, engine):
|
||||||
|
query = {
|
||||||
|
"query": {"bool": {"must": [
|
||||||
|
{"term": {"so_detection.publicId": public_id}},
|
||||||
|
{"term": {"so_detection.engine": engine}},
|
||||||
|
]}},
|
||||||
|
"size": 2,
|
||||||
|
}
|
||||||
|
r = session.get(f"{ES_URL}/{index}/_search", json=query)
|
||||||
|
r.raise_for_status()
|
||||||
|
hits = r.json().get("hits", {}).get("hits", [])
|
||||||
|
if not hits:
|
||||||
|
return None, None, None
|
||||||
|
if len(hits) > 1:
|
||||||
|
# Shouldn't happen — publicId is unique per engine — but flag it.
|
||||||
|
print(f" WARN: {len(hits)} detections matched publicId={public_id} engine={engine}; using first")
|
||||||
|
hit = hits[0]
|
||||||
|
existing = hit["_source"].get("so_detection", {}).get("overrides") or []
|
||||||
|
return hit["_id"], hit["_index"], existing
|
||||||
|
|
||||||
|
|
||||||
|
def update_overrides(session, doc_index, doc_id, overrides):
|
||||||
|
body = {"doc": {"so_detection": {"overrides": overrides}}}
|
||||||
|
r = session.post(f"{ES_URL}/{doc_index}/_update/{doc_id}", json=body)
|
||||||
|
r.raise_for_status()
|
||||||
|
return r.json()
|
||||||
|
|
||||||
|
|
||||||
|
def dedupe_key(override):
|
||||||
|
"""Operational fields only, per Override.Equal() in detection.go.
|
||||||
|
Excludes timestamps and isEnabled so re-imports don't appear unique."""
|
||||||
|
t = override.get("type")
|
||||||
|
if t == "suppress":
|
||||||
|
return (t, override.get("track"), override.get("ip"))
|
||||||
|
if t == "threshold":
|
||||||
|
return (t, override.get("thresholdType"), override.get("track"),
|
||||||
|
override.get("count"), override.get("seconds"))
|
||||||
|
if t == "modify":
|
||||||
|
return (t, override.get("regex"), override.get("value"))
|
||||||
|
|
||||||
|
|
||||||
|
def _validate_suricata_ip(ip):
|
||||||
|
if not ip:
|
||||||
|
return "ip cannot be empty"
|
||||||
|
if ip.startswith("$"):
|
||||||
|
return None
|
||||||
|
if ip.startswith("[") and ip.endswith("]"):
|
||||||
|
for part in ip[1:-1].split(","):
|
||||||
|
err = _validate_single_ip(part.strip())
|
||||||
|
if err:
|
||||||
|
return f"invalid IP in list: {err}"
|
||||||
|
return None
|
||||||
|
return _validate_single_ip(ip)
|
||||||
|
|
||||||
|
|
||||||
|
def _validate_single_ip(ip):
|
||||||
|
try:
|
||||||
|
if "/" in ip:
|
||||||
|
ipaddress.ip_network(ip, strict=False)
|
||||||
|
else:
|
||||||
|
ipaddress.ip_address(ip)
|
||||||
|
except ValueError:
|
||||||
|
return f"invalid IP/CIDR {ip!r}"
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def validate_override(override, engine):
|
||||||
|
"""Mirror Override.Validate() from securityonion-soc/model/detection.go.
|
||||||
|
Returns None on success, an error string otherwise."""
|
||||||
|
t = override.get("type")
|
||||||
|
if not t:
|
||||||
|
return "override type is required"
|
||||||
|
if t not in SURICATA_OVERRIDE_TYPES:
|
||||||
|
return f"invalid type {t!r}: must be one of {sorted(SURICATA_OVERRIDE_TYPES)}"
|
||||||
|
|
||||||
|
has = {k: override.get(k) is not None for k in
|
||||||
|
("regex", "value", "thresholdType", "track", "ip", "count", "seconds", "customFilter")}
|
||||||
|
|
||||||
|
if t == "suppress":
|
||||||
|
if not has["ip"] or not has["track"]:
|
||||||
|
return "suppress requires 'ip' and 'track'"
|
||||||
|
if any(has[k] for k in ("regex", "value", "thresholdType", "count", "seconds", "customFilter")):
|
||||||
|
return "suppress has unnecessary fields"
|
||||||
|
if override["track"] not in SUPPRESS_TRACKS:
|
||||||
|
return f"invalid track {override['track']!r}: must be one of {sorted(SUPPRESS_TRACKS)}"
|
||||||
|
return _validate_suricata_ip(override["ip"])
|
||||||
|
|
||||||
|
if t == "threshold":
|
||||||
|
if not all(has[k] for k in ("thresholdType", "track", "count", "seconds")):
|
||||||
|
return "threshold requires 'thresholdType', 'track', 'count', 'seconds'"
|
||||||
|
if any(has[k] for k in ("regex", "value", "customFilter")):
|
||||||
|
return "threshold has unnecessary fields"
|
||||||
|
if override["thresholdType"] not in THRESHOLD_TYPES:
|
||||||
|
return f"invalid thresholdType {override['thresholdType']!r}: must be one of {sorted(THRESHOLD_TYPES)}"
|
||||||
|
if override["track"] not in THRESHOLD_TRACKS:
|
||||||
|
return f"invalid track {override['track']!r}: must be one of {sorted(THRESHOLD_TRACKS)}"
|
||||||
|
if not isinstance(override["count"], int) or override["count"] <= 0:
|
||||||
|
return f"count must be a positive integer, got {override['count']!r}"
|
||||||
|
if not isinstance(override["seconds"], int) or override["seconds"] <= 0:
|
||||||
|
return f"seconds must be a positive integer, got {override['seconds']!r}"
|
||||||
|
return None
|
||||||
|
|
||||||
|
if t == "modify":
|
||||||
|
if not has["regex"] or not has["value"]:
|
||||||
|
return "modify requires 'regex' and 'value'"
|
||||||
|
if any(has[k] for k in ("thresholdType", "track", "count", "seconds", "customFilter")):
|
||||||
|
return "modify has unnecessary fields"
|
||||||
|
try:
|
||||||
|
re.compile(override["regex"])
|
||||||
|
except re.error as e:
|
||||||
|
return f"invalid regex: {e}"
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def parse_overrides_file(path):
|
||||||
|
"""Parse a file written by so-detections-backup.py: NDJSON, one override
|
||||||
|
per line. Returns a list of (override_dict, line_number)."""
|
||||||
|
overrides = []
|
||||||
|
with open(path, "r") as f:
|
||||||
|
for i, line in enumerate(f, start=1):
|
||||||
|
line = line.strip()
|
||||||
|
if not line:
|
||||||
|
continue
|
||||||
|
overrides.append((json.loads(line), i))
|
||||||
|
return overrides
|
||||||
|
|
||||||
|
|
||||||
|
def describe(override):
|
||||||
|
"""Human-readable summary of the operational fields for a given override type."""
|
||||||
|
t = override.get("type")
|
||||||
|
if t == "suppress":
|
||||||
|
return f"type=suppress track={override.get('track')} ip={override.get('ip')}"
|
||||||
|
if t == "threshold":
|
||||||
|
return (f"type=threshold track={override.get('track')} "
|
||||||
|
f"thresholdType={override.get('thresholdType')} "
|
||||||
|
f"count={override.get('count')} seconds={override.get('seconds')}")
|
||||||
|
if t == "modify":
|
||||||
|
return f"type=modify regex={override.get('regex')!r}"
|
||||||
|
|
||||||
|
|
||||||
|
def collect_custom_vars(override):
|
||||||
|
found = set()
|
||||||
|
for value in override.values():
|
||||||
|
if isinstance(value, str):
|
||||||
|
for match in VAR_PATTERN.findall(value):
|
||||||
|
if match not in BUILTIN_SURICATA_VARS:
|
||||||
|
found.add(match)
|
||||||
|
return found
|
||||||
|
|
||||||
|
|
||||||
|
def parse_args():
|
||||||
|
p = argparse.ArgumentParser(
|
||||||
|
description="Import detection overrides into the so-detection index.",
|
||||||
|
)
|
||||||
|
p.add_argument("--source", "-s", required=True,
|
||||||
|
help="Source directory containing <publicId>.<ext> override files.")
|
||||||
|
p.add_argument("--engine", "-e", default="suricata", choices=list(ENGINES.keys()),
|
||||||
|
help="Detection engine (default: suricata).")
|
||||||
|
p.add_argument("--dry-run", "-n", action="store_true",
|
||||||
|
help="Print what would happen without writing to Elasticsearch.")
|
||||||
|
p.add_argument("--no-import-note", action="store_true",
|
||||||
|
help="Do not prepend '[Imported YYYY-MM-DD] ' to the override note.")
|
||||||
|
p.add_argument("--index", "-i", default=DEFAULT_INDEX,
|
||||||
|
help=f"Elasticsearch index to update (default: {DEFAULT_INDEX}).")
|
||||||
|
return p.parse_args()
|
||||||
|
|
||||||
|
|
||||||
|
def confirm_proceed(args):
|
||||||
|
"""Show the stale-backup warning. Dry-run prints it and continues. Real
|
||||||
|
runs require the user typing 'yes' at the prompt."""
|
||||||
|
print(STALE_WARNING)
|
||||||
|
if args.dry_run:
|
||||||
|
print("(dry-run: no acknowledgement required)\n")
|
||||||
|
return True
|
||||||
|
answer = input("Type 'yes' to acknowledge and continue: ").strip().lower()
|
||||||
|
print()
|
||||||
|
return answer == "yes"
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
args = parse_args()
|
||||||
|
|
||||||
|
if not os.path.isdir(args.source):
|
||||||
|
print(f"ERROR: source directory not found: {args.source}", file=sys.stderr)
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
|
extension = ENGINES[args.engine]
|
||||||
|
files = sorted(f for f in os.listdir(args.source) if f.endswith(f".{extension}"))
|
||||||
|
if not files:
|
||||||
|
print(f"No *.{extension} files found in {args.source}")
|
||||||
|
sys.exit(0)
|
||||||
|
|
||||||
|
if not confirm_proceed(args):
|
||||||
|
print("Aborted.")
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
|
session = make_session(AUTH_FILE)
|
||||||
|
today = datetime.now().strftime("%Y-%m-%d")
|
||||||
|
note_prefix = "" if args.no_import_note else f"[Imported {today}] "
|
||||||
|
|
||||||
|
counts = {"added": 0, "skipped_dedupe": 0, "skipped_not_found": 0, "invalid": 0, "error": 0}
|
||||||
|
custom_vars = set()
|
||||||
|
|
||||||
|
mode = "DRY-RUN" if args.dry_run else "IMPORT"
|
||||||
|
print(f"[{mode}] engine={args.engine} source={args.source} index={args.index}\n")
|
||||||
|
|
||||||
|
for filename in files:
|
||||||
|
public_id = os.path.splitext(filename)[0]
|
||||||
|
path = os.path.join(args.source, filename)
|
||||||
|
print(f"{public_id}:")
|
||||||
|
|
||||||
|
try:
|
||||||
|
new_overrides = parse_overrides_file(path)
|
||||||
|
except (json.JSONDecodeError, OSError) as e:
|
||||||
|
print(f" ERROR: could not parse {filename}: {e}")
|
||||||
|
counts["error"] += 1
|
||||||
|
continue
|
||||||
|
|
||||||
|
if not new_overrides:
|
||||||
|
print(" SKIP: empty file")
|
||||||
|
continue
|
||||||
|
|
||||||
|
try:
|
||||||
|
doc_id, doc_index, existing = find_detection(session, args.index, public_id, args.engine)
|
||||||
|
except requests.HTTPError as e:
|
||||||
|
print(f" ERROR: search failed: {e}")
|
||||||
|
counts["error"] += 1
|
||||||
|
continue
|
||||||
|
|
||||||
|
if doc_id is None:
|
||||||
|
print(f" WARN: no detection found for publicId={public_id} engine={args.engine}; skipping")
|
||||||
|
counts["skipped_not_found"] += len(new_overrides)
|
||||||
|
continue
|
||||||
|
|
||||||
|
existing_keys = {dedupe_key(o) for o in existing}
|
||||||
|
merged = list(existing)
|
||||||
|
added_this_file = 0
|
||||||
|
|
||||||
|
for override, line_no in new_overrides:
|
||||||
|
err = validate_override(override, args.engine)
|
||||||
|
if err:
|
||||||
|
print(f" INVALID (line {line_no}): {err}")
|
||||||
|
counts["invalid"] += 1
|
||||||
|
continue
|
||||||
|
|
||||||
|
custom_vars.update(collect_custom_vars(override))
|
||||||
|
key = dedupe_key(override)
|
||||||
|
if key in existing_keys:
|
||||||
|
print(f" SKIP (line {line_no}): duplicate of existing override [{describe(override)}]")
|
||||||
|
counts["skipped_dedupe"] += 1
|
||||||
|
continue
|
||||||
|
|
||||||
|
if note_prefix:
|
||||||
|
override = dict(override)
|
||||||
|
override["note"] = note_prefix + (override.get("note") or "")
|
||||||
|
|
||||||
|
merged.append(override)
|
||||||
|
existing_keys.add(key)
|
||||||
|
added_this_file += 1
|
||||||
|
print(f" ADD (line {line_no}): {describe(override)}")
|
||||||
|
|
||||||
|
if added_this_file == 0:
|
||||||
|
continue
|
||||||
|
|
||||||
|
if args.dry_run:
|
||||||
|
print(f" DRY-RUN: would update {doc_index}/{doc_id} "
|
||||||
|
f"({len(existing)} existing → {len(merged)} total)")
|
||||||
|
counts["added"] += added_this_file
|
||||||
|
continue
|
||||||
|
|
||||||
|
try:
|
||||||
|
update_overrides(session, doc_index, doc_id, merged)
|
||||||
|
print(f" UPDATED {doc_index}/{doc_id} ({len(existing)} → {len(merged)})")
|
||||||
|
counts["added"] += added_this_file
|
||||||
|
except requests.HTTPError as e:
|
||||||
|
print(f" ERROR: update failed: {e}")
|
||||||
|
counts["error"] += 1
|
||||||
|
|
||||||
|
print()
|
||||||
|
print("=" * 60)
|
||||||
|
print(f"Summary ({mode}):")
|
||||||
|
print(f" Overrides added: {counts['added']}")
|
||||||
|
print(f" Skipped (already present): {counts['skipped_dedupe']}")
|
||||||
|
print(f" Skipped (no detection): {counts['skipped_not_found']}")
|
||||||
|
print(f" Invalid (failed checks): {counts['invalid']}")
|
||||||
|
print(f" Errors: {counts['error']}")
|
||||||
|
|
||||||
|
if custom_vars:
|
||||||
|
print()
|
||||||
|
print("WARNING: detected custom Suricata variables in imported overrides:")
|
||||||
|
for v in sorted(custom_vars):
|
||||||
|
print(f" {v}")
|
||||||
|
print("If any of these are not already defined in SOC Config (Suricata variables),")
|
||||||
|
print("you must add them manually before the rules will function correctly.")
|
||||||
|
|
||||||
|
sys.exit(0 if counts["error"] == 0 and counts["invalid"] == 0 else 1)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
@@ -0,0 +1,588 @@
|
|||||||
|
# Copyright Security Onion Solutions LLC and/or licensed to Security Onion Solutions LLC under one
|
||||||
|
# or more contributor license agreements. Licensed under the Elastic License 2.0 as shown at
|
||||||
|
# https://securityonion.net/license; you may not use this file except in compliance with the
|
||||||
|
# Elastic License 2.0.
|
||||||
|
|
||||||
|
import importlib.util
|
||||||
|
import json
|
||||||
|
import os
|
||||||
|
import shutil
|
||||||
|
import sys
|
||||||
|
import tempfile
|
||||||
|
import unittest
|
||||||
|
from importlib.machinery import SourceFileLoader
|
||||||
|
from io import StringIO
|
||||||
|
from unittest.mock import MagicMock, patch
|
||||||
|
|
||||||
|
import requests
|
||||||
|
|
||||||
|
# The script has no .py extension; spec_from_file_location can't auto-detect a
|
||||||
|
# loader, so we hand it a SourceFileLoader explicitly. (load_module() is
|
||||||
|
# deprecated in 3.14 and slated for removal in 3.15.)
|
||||||
|
HERE = os.path.dirname(os.path.abspath(__file__))
|
||||||
|
SCRIPT = os.path.join(HERE, "so-detections-overrides-import")
|
||||||
|
_loader = SourceFileLoader("so_overrides_import", SCRIPT)
|
||||||
|
_spec = importlib.util.spec_from_loader("so_overrides_import", _loader)
|
||||||
|
soi = importlib.util.module_from_spec(_spec)
|
||||||
|
_loader.exec_module(soi)
|
||||||
|
|
||||||
|
|
||||||
|
class TestValidateSuppress(unittest.TestCase):
|
||||||
|
def test_valid(self):
|
||||||
|
self.assertIsNone(soi.validate_override(
|
||||||
|
{"type": "suppress", "track": "by_src", "ip": "1.2.3.4"}, "suricata"))
|
||||||
|
|
||||||
|
def test_valid_var(self):
|
||||||
|
self.assertIsNone(soi.validate_override(
|
||||||
|
{"type": "suppress", "track": "by_either", "ip": "$HOME_NET"}, "suricata"))
|
||||||
|
|
||||||
|
def test_valid_cidr(self):
|
||||||
|
self.assertIsNone(soi.validate_override(
|
||||||
|
{"type": "suppress", "track": "by_dst", "ip": "10.0.0.0/8"}, "suricata"))
|
||||||
|
|
||||||
|
def test_valid_bracket_list(self):
|
||||||
|
self.assertIsNone(soi.validate_override(
|
||||||
|
{"type": "suppress", "track": "by_src", "ip": "[1.2.3.4,10.0.0.0/8]"}, "suricata"))
|
||||||
|
|
||||||
|
def test_missing_ip(self):
|
||||||
|
err = soi.validate_override({"type": "suppress", "track": "by_src"}, "suricata")
|
||||||
|
self.assertIn("requires", err)
|
||||||
|
|
||||||
|
def test_missing_track(self):
|
||||||
|
err = soi.validate_override({"type": "suppress", "ip": "1.2.3.4"}, "suricata")
|
||||||
|
self.assertIn("requires", err)
|
||||||
|
|
||||||
|
def test_invalid_track(self):
|
||||||
|
err = soi.validate_override(
|
||||||
|
{"type": "suppress", "track": "by_both", "ip": "1.2.3.4"}, "suricata")
|
||||||
|
self.assertIn("invalid track", err)
|
||||||
|
|
||||||
|
def test_invalid_ip(self):
|
||||||
|
err = soi.validate_override(
|
||||||
|
{"type": "suppress", "track": "by_src", "ip": "not-an-ip"}, "suricata")
|
||||||
|
self.assertIn("invalid IP", err)
|
||||||
|
|
||||||
|
def test_unnecessary_field(self):
|
||||||
|
err = soi.validate_override(
|
||||||
|
{"type": "suppress", "track": "by_src", "ip": "1.2.3.4", "count": 5}, "suricata")
|
||||||
|
self.assertIn("unnecessary fields", err)
|
||||||
|
|
||||||
|
|
||||||
|
class TestValidateThreshold(unittest.TestCase):
|
||||||
|
def test_valid(self):
|
||||||
|
self.assertIsNone(soi.validate_override({
|
||||||
|
"type": "threshold", "track": "by_src",
|
||||||
|
"thresholdType": "limit", "count": 10, "seconds": 60,
|
||||||
|
}, "suricata"))
|
||||||
|
|
||||||
|
def test_valid_by_both(self):
|
||||||
|
self.assertIsNone(soi.validate_override({
|
||||||
|
"type": "threshold", "track": "by_both",
|
||||||
|
"thresholdType": "both", "count": 1, "seconds": 1,
|
||||||
|
}, "suricata"))
|
||||||
|
|
||||||
|
def test_track_by_either_invalid(self):
|
||||||
|
err = soi.validate_override({
|
||||||
|
"type": "threshold", "track": "by_either",
|
||||||
|
"thresholdType": "limit", "count": 10, "seconds": 60,
|
||||||
|
}, "suricata")
|
||||||
|
self.assertIn("invalid track", err)
|
||||||
|
|
||||||
|
def test_invalid_threshold_type(self):
|
||||||
|
err = soi.validate_override({
|
||||||
|
"type": "threshold", "track": "by_src",
|
||||||
|
"thresholdType": "bogus", "count": 10, "seconds": 60,
|
||||||
|
}, "suricata")
|
||||||
|
self.assertIn("invalid thresholdType", err)
|
||||||
|
|
||||||
|
def test_zero_count(self):
|
||||||
|
err = soi.validate_override({
|
||||||
|
"type": "threshold", "track": "by_src",
|
||||||
|
"thresholdType": "limit", "count": 0, "seconds": 60,
|
||||||
|
}, "suricata")
|
||||||
|
self.assertIn("count", err)
|
||||||
|
|
||||||
|
def test_negative_seconds(self):
|
||||||
|
err = soi.validate_override({
|
||||||
|
"type": "threshold", "track": "by_src",
|
||||||
|
"thresholdType": "limit", "count": 10, "seconds": -1,
|
||||||
|
}, "suricata")
|
||||||
|
self.assertIn("seconds", err)
|
||||||
|
|
||||||
|
def test_missing_field(self):
|
||||||
|
err = soi.validate_override({
|
||||||
|
"type": "threshold", "track": "by_src",
|
||||||
|
"thresholdType": "limit", "count": 10, # missing seconds
|
||||||
|
}, "suricata")
|
||||||
|
self.assertIn("requires", err)
|
||||||
|
|
||||||
|
def test_unnecessary_field(self):
|
||||||
|
err = soi.validate_override({
|
||||||
|
"type": "threshold", "track": "by_src",
|
||||||
|
"thresholdType": "limit", "count": 10, "seconds": 60,
|
||||||
|
"regex": "foo",
|
||||||
|
}, "suricata")
|
||||||
|
self.assertIn("unnecessary fields", err)
|
||||||
|
|
||||||
|
|
||||||
|
class TestValidateModify(unittest.TestCase):
|
||||||
|
def test_valid(self):
|
||||||
|
self.assertIsNone(soi.validate_override(
|
||||||
|
{"type": "modify", "regex": r"content:\"foo\"", "value": "content:bar"}, "suricata"))
|
||||||
|
|
||||||
|
def test_invalid_regex(self):
|
||||||
|
err = soi.validate_override(
|
||||||
|
{"type": "modify", "regex": "(unbalanced", "value": "x"}, "suricata")
|
||||||
|
self.assertIn("invalid regex", err)
|
||||||
|
|
||||||
|
def test_missing_value(self):
|
||||||
|
err = soi.validate_override({"type": "modify", "regex": "x"}, "suricata")
|
||||||
|
self.assertIn("requires", err)
|
||||||
|
|
||||||
|
def test_unnecessary_field(self):
|
||||||
|
err = soi.validate_override(
|
||||||
|
{"type": "modify", "regex": "x", "value": "y", "track": "by_src"}, "suricata")
|
||||||
|
self.assertIn("unnecessary fields", err)
|
||||||
|
|
||||||
|
|
||||||
|
class TestValidateMisc(unittest.TestCase):
|
||||||
|
def test_unknown_type(self):
|
||||||
|
err = soi.validate_override({"type": "suppresss", "track": "by_src", "ip": "1.2.3.4"}, "suricata")
|
||||||
|
self.assertIn("invalid type", err)
|
||||||
|
|
||||||
|
def test_missing_type(self):
|
||||||
|
err = soi.validate_override({"track": "by_src"}, "suricata")
|
||||||
|
self.assertIn("type is required", err)
|
||||||
|
|
||||||
|
|
||||||
|
class TestValidateIP(unittest.TestCase):
|
||||||
|
def test_plain_ipv4(self):
|
||||||
|
self.assertIsNone(soi._validate_suricata_ip("1.2.3.4"))
|
||||||
|
|
||||||
|
def test_plain_ipv6(self):
|
||||||
|
self.assertIsNone(soi._validate_suricata_ip("::1"))
|
||||||
|
|
||||||
|
def test_cidr(self):
|
||||||
|
self.assertIsNone(soi._validate_suricata_ip("10.0.0.0/8"))
|
||||||
|
|
||||||
|
def test_var(self):
|
||||||
|
self.assertIsNone(soi._validate_suricata_ip("$CONCOURSEWORKERS"))
|
||||||
|
|
||||||
|
def test_bracket_list(self):
|
||||||
|
self.assertIsNone(soi._validate_suricata_ip("[1.2.3.4, 10.0.0.0/8]"))
|
||||||
|
|
||||||
|
def test_bracket_list_bad_member(self):
|
||||||
|
err = soi._validate_suricata_ip("[1.2.3.4,nope]")
|
||||||
|
self.assertIn("invalid IP in list", err)
|
||||||
|
|
||||||
|
def test_empty(self):
|
||||||
|
self.assertIn("empty", soi._validate_suricata_ip(""))
|
||||||
|
|
||||||
|
def test_invalid(self):
|
||||||
|
self.assertIn("invalid", soi._validate_suricata_ip("999.999.999.999"))
|
||||||
|
|
||||||
|
|
||||||
|
class TestDedupeKey(unittest.TestCase):
|
||||||
|
def test_suppress(self):
|
||||||
|
a = {"type": "suppress", "track": "by_src", "ip": "1.2.3.4", "count": 99}
|
||||||
|
b = {"type": "suppress", "track": "by_src", "ip": "1.2.3.4"}
|
||||||
|
# count is irrelevant for suppress dedupe
|
||||||
|
self.assertEqual(soi.dedupe_key(a), soi.dedupe_key(b))
|
||||||
|
|
||||||
|
def test_suppress_differs_on_ip(self):
|
||||||
|
a = {"type": "suppress", "track": "by_src", "ip": "1.2.3.4"}
|
||||||
|
b = {"type": "suppress", "track": "by_src", "ip": "5.6.7.8"}
|
||||||
|
self.assertNotEqual(soi.dedupe_key(a), soi.dedupe_key(b))
|
||||||
|
|
||||||
|
def test_threshold(self):
|
||||||
|
a = {"type": "threshold", "track": "by_src", "thresholdType": "limit",
|
||||||
|
"count": 10, "seconds": 60, "ip": "ignored"}
|
||||||
|
b = {"type": "threshold", "track": "by_src", "thresholdType": "limit",
|
||||||
|
"count": 10, "seconds": 60}
|
||||||
|
self.assertEqual(soi.dedupe_key(a), soi.dedupe_key(b))
|
||||||
|
|
||||||
|
def test_threshold_differs_on_count(self):
|
||||||
|
a = {"type": "threshold", "track": "by_src", "thresholdType": "limit",
|
||||||
|
"count": 10, "seconds": 60}
|
||||||
|
b = {"type": "threshold", "track": "by_src", "thresholdType": "limit",
|
||||||
|
"count": 20, "seconds": 60}
|
||||||
|
self.assertNotEqual(soi.dedupe_key(a), soi.dedupe_key(b))
|
||||||
|
|
||||||
|
def test_modify(self):
|
||||||
|
a = {"type": "modify", "regex": "x", "value": "y"}
|
||||||
|
b = {"type": "modify", "regex": "x", "value": "y"}
|
||||||
|
self.assertEqual(soi.dedupe_key(a), soi.dedupe_key(b))
|
||||||
|
|
||||||
|
|
||||||
|
class TestDescribe(unittest.TestCase):
|
||||||
|
def test_suppress(self):
|
||||||
|
s = soi.describe({"type": "suppress", "track": "by_src", "ip": "1.2.3.4"})
|
||||||
|
self.assertIn("suppress", s)
|
||||||
|
self.assertIn("by_src", s)
|
||||||
|
self.assertIn("1.2.3.4", s)
|
||||||
|
|
||||||
|
def test_threshold_includes_count(self):
|
||||||
|
s = soi.describe({"type": "threshold", "track": "by_src",
|
||||||
|
"thresholdType": "limit", "count": 10, "seconds": 60})
|
||||||
|
self.assertIn("count=10", s)
|
||||||
|
self.assertIn("seconds=60", s)
|
||||||
|
|
||||||
|
def test_modify(self):
|
||||||
|
s = soi.describe({"type": "modify", "regex": "foo"})
|
||||||
|
self.assertIn("modify", s)
|
||||||
|
self.assertIn("foo", s)
|
||||||
|
|
||||||
|
|
||||||
|
class TestParseOverridesFile(unittest.TestCase):
|
||||||
|
def _write(self, content):
|
||||||
|
fd, path = tempfile.mkstemp(suffix=".txt")
|
||||||
|
os.close(fd)
|
||||||
|
with open(path, "w") as f:
|
||||||
|
f.write(content)
|
||||||
|
self.addCleanup(os.unlink, path)
|
||||||
|
return path
|
||||||
|
|
||||||
|
def test_single_line(self):
|
||||||
|
path = self._write('{"type":"suppress","track":"by_src","ip":"1.2.3.4"}')
|
||||||
|
result = soi.parse_overrides_file(path)
|
||||||
|
self.assertEqual(len(result), 1)
|
||||||
|
self.assertEqual(result[0][0]["type"], "suppress")
|
||||||
|
self.assertEqual(result[0][1], 1)
|
||||||
|
|
||||||
|
def test_ndjson(self):
|
||||||
|
path = self._write(
|
||||||
|
'{"type":"suppress","track":"by_src","ip":"1.2.3.4"}\n'
|
||||||
|
'{"type":"suppress","track":"by_dst","ip":"5.6.7.8"}\n'
|
||||||
|
)
|
||||||
|
result = soi.parse_overrides_file(path)
|
||||||
|
self.assertEqual(len(result), 2)
|
||||||
|
self.assertEqual(result[1][1], 2)
|
||||||
|
|
||||||
|
def test_empty(self):
|
||||||
|
path = self._write("")
|
||||||
|
self.assertEqual(soi.parse_overrides_file(path), [])
|
||||||
|
|
||||||
|
def test_blank_lines_skipped(self):
|
||||||
|
path = self._write('\n{"type":"suppress","track":"by_src","ip":"1.2.3.4"}\n\n')
|
||||||
|
result = soi.parse_overrides_file(path)
|
||||||
|
self.assertEqual(len(result), 1)
|
||||||
|
self.assertEqual(result[0][1], 2) # line number reflects original position
|
||||||
|
|
||||||
|
def test_invalid_raises(self):
|
||||||
|
path = self._write("not json")
|
||||||
|
with self.assertRaises(json.JSONDecodeError):
|
||||||
|
soi.parse_overrides_file(path)
|
||||||
|
|
||||||
|
|
||||||
|
class TestCollectCustomVars(unittest.TestCase):
|
||||||
|
def test_finds_custom(self):
|
||||||
|
v = soi.collect_custom_vars({"ip": "$CONCOURSEWORKERS"})
|
||||||
|
self.assertEqual(v, {"$CONCOURSEWORKERS"})
|
||||||
|
|
||||||
|
def test_filters_builtins(self):
|
||||||
|
v = soi.collect_custom_vars({"ip": "$HOME_NET"})
|
||||||
|
self.assertEqual(v, set())
|
||||||
|
|
||||||
|
def test_mixed(self):
|
||||||
|
v = soi.collect_custom_vars({"ip": "[$HOME_NET,$MYNET]"})
|
||||||
|
self.assertEqual(v, {"$MYNET"})
|
||||||
|
|
||||||
|
def test_non_string_fields_ignored(self):
|
||||||
|
v = soi.collect_custom_vars({"count": 10, "isEnabled": True})
|
||||||
|
self.assertEqual(v, set())
|
||||||
|
|
||||||
|
|
||||||
|
class TestMakeSession(unittest.TestCase):
|
||||||
|
def _write(self, content):
|
||||||
|
fd, path = tempfile.mkstemp()
|
||||||
|
os.close(fd)
|
||||||
|
with open(path, "w") as f:
|
||||||
|
f.write(content)
|
||||||
|
self.addCleanup(os.unlink, path)
|
||||||
|
return path
|
||||||
|
|
||||||
|
def test_valid_auth_file(self):
|
||||||
|
path = self._write('user = "admin:secret"\n')
|
||||||
|
session = soi.make_session(path)
|
||||||
|
self.assertEqual(session.auth.username, "admin")
|
||||||
|
self.assertEqual(session.auth.password, "secret")
|
||||||
|
self.assertFalse(session.verify)
|
||||||
|
|
||||||
|
def test_missing_user_line(self):
|
||||||
|
path = self._write("# no user line here\n")
|
||||||
|
with self.assertRaises(RuntimeError):
|
||||||
|
soi.make_session(path)
|
||||||
|
|
||||||
|
|
||||||
|
class TestFindDetection(unittest.TestCase):
|
||||||
|
def _session_with_response(self, payload):
|
||||||
|
session = MagicMock()
|
||||||
|
response = MagicMock()
|
||||||
|
response.json.return_value = payload
|
||||||
|
response.raise_for_status.return_value = None
|
||||||
|
session.get.return_value = response
|
||||||
|
return session
|
||||||
|
|
||||||
|
def test_found(self):
|
||||||
|
session = self._session_with_response({"hits": {"hits": [{
|
||||||
|
"_id": "abc", "_index": "so-detection",
|
||||||
|
"_source": {"so_detection": {"overrides": [{"type": "suppress"}]}},
|
||||||
|
}]}})
|
||||||
|
doc_id, idx, existing = soi.find_detection(session, "so-detection", "2049201", "suricata")
|
||||||
|
self.assertEqual(doc_id, "abc")
|
||||||
|
self.assertEqual(idx, "so-detection")
|
||||||
|
self.assertEqual(len(existing), 1)
|
||||||
|
|
||||||
|
def test_not_found(self):
|
||||||
|
session = self._session_with_response({"hits": {"hits": []}})
|
||||||
|
doc_id, idx, existing = soi.find_detection(session, "so-detection", "x", "suricata")
|
||||||
|
self.assertIsNone(doc_id)
|
||||||
|
self.assertIsNone(idx)
|
||||||
|
self.assertIsNone(existing)
|
||||||
|
|
||||||
|
def test_no_overrides_field(self):
|
||||||
|
session = self._session_with_response({"hits": {"hits": [{
|
||||||
|
"_id": "abc", "_index": "so-detection",
|
||||||
|
"_source": {"so_detection": {}},
|
||||||
|
}]}})
|
||||||
|
_, _, existing = soi.find_detection(session, "so-detection", "x", "suricata")
|
||||||
|
self.assertEqual(existing, [])
|
||||||
|
|
||||||
|
def test_multiple_hits_warns(self):
|
||||||
|
session = self._session_with_response({"hits": {"hits": [
|
||||||
|
{"_id": "a", "_index": "i", "_source": {"so_detection": {"overrides": []}}},
|
||||||
|
{"_id": "b", "_index": "i", "_source": {"so_detection": {"overrides": []}}},
|
||||||
|
]}})
|
||||||
|
with patch("sys.stdout", new=StringIO()) as out:
|
||||||
|
doc_id, _, _ = soi.find_detection(session, "i", "x", "suricata")
|
||||||
|
self.assertEqual(doc_id, "a")
|
||||||
|
self.assertIn("WARN", out.getvalue())
|
||||||
|
|
||||||
|
|
||||||
|
class TestUpdateOverrides(unittest.TestCase):
|
||||||
|
def test_posts_to_update_endpoint(self):
|
||||||
|
session = MagicMock()
|
||||||
|
response = MagicMock()
|
||||||
|
response.raise_for_status.return_value = None
|
||||||
|
response.json.return_value = {"result": "updated"}
|
||||||
|
session.post.return_value = response
|
||||||
|
|
||||||
|
result = soi.update_overrides(session, "so-detection", "abc", [{"type": "suppress"}])
|
||||||
|
|
||||||
|
self.assertEqual(result, {"result": "updated"})
|
||||||
|
url = session.post.call_args[0][0]
|
||||||
|
self.assertIn("/_update/abc", url)
|
||||||
|
body = session.post.call_args[1]["json"]
|
||||||
|
self.assertEqual(body["doc"]["so_detection"]["overrides"], [{"type": "suppress"}])
|
||||||
|
|
||||||
|
|
||||||
|
class TestConfirmProceed(unittest.TestCase):
|
||||||
|
def test_dry_run_skips_prompt(self):
|
||||||
|
args = MagicMock(dry_run=True)
|
||||||
|
with patch("sys.stdout", new=StringIO()):
|
||||||
|
self.assertTrue(soi.confirm_proceed(args))
|
||||||
|
|
||||||
|
def test_yes_input(self):
|
||||||
|
args = MagicMock(dry_run=False)
|
||||||
|
with patch("sys.stdout", new=StringIO()):
|
||||||
|
with patch("builtins.input", return_value="yes"):
|
||||||
|
self.assertTrue(soi.confirm_proceed(args))
|
||||||
|
|
||||||
|
def test_yes_input_case_insensitive(self):
|
||||||
|
args = MagicMock(dry_run=False)
|
||||||
|
with patch("sys.stdout", new=StringIO()):
|
||||||
|
with patch("builtins.input", return_value="YES"):
|
||||||
|
self.assertTrue(soi.confirm_proceed(args))
|
||||||
|
|
||||||
|
def test_no_input_aborts(self):
|
||||||
|
args = MagicMock(dry_run=False)
|
||||||
|
with patch("sys.stdout", new=StringIO()):
|
||||||
|
with patch("builtins.input", return_value="no"):
|
||||||
|
self.assertFalse(soi.confirm_proceed(args))
|
||||||
|
|
||||||
|
def test_empty_input_aborts(self):
|
||||||
|
args = MagicMock(dry_run=False)
|
||||||
|
with patch("sys.stdout", new=StringIO()):
|
||||||
|
with patch("builtins.input", return_value=""):
|
||||||
|
self.assertFalse(soi.confirm_proceed(args))
|
||||||
|
|
||||||
|
|
||||||
|
class TestParseArgs(unittest.TestCase):
|
||||||
|
def test_defaults(self):
|
||||||
|
with patch.object(sys, "argv", ["cmd", "--source", "/some/path"]):
|
||||||
|
args = soi.parse_args()
|
||||||
|
self.assertEqual(args.source, "/some/path")
|
||||||
|
self.assertEqual(args.engine, "suricata")
|
||||||
|
self.assertFalse(args.dry_run)
|
||||||
|
self.assertFalse(args.no_import_note)
|
||||||
|
self.assertEqual(args.index, soi.DEFAULT_INDEX)
|
||||||
|
|
||||||
|
def test_all_options(self):
|
||||||
|
argv = ["cmd", "-s", "/x", "-e", "suricata", "-n",
|
||||||
|
"--no-import-note", "-i", "alt-index"]
|
||||||
|
with patch.object(sys, "argv", argv):
|
||||||
|
args = soi.parse_args()
|
||||||
|
self.assertEqual(args.source, "/x")
|
||||||
|
self.assertTrue(args.dry_run)
|
||||||
|
self.assertTrue(args.no_import_note)
|
||||||
|
self.assertEqual(args.index, "alt-index")
|
||||||
|
|
||||||
|
|
||||||
|
class TestMain(unittest.TestCase):
|
||||||
|
def setUp(self):
|
||||||
|
self.tmpdir = tempfile.mkdtemp()
|
||||||
|
self.addCleanup(shutil.rmtree, self.tmpdir, ignore_errors=True)
|
||||||
|
# Stub make_session so tests don't need /opt/so/conf/elasticsearch/curl.config.
|
||||||
|
p = patch.object(soi, "make_session", return_value=MagicMock())
|
||||||
|
p.start()
|
||||||
|
self.addCleanup(p.stop)
|
||||||
|
|
||||||
|
def _write_file(self, public_id, overrides, ext="txt"):
|
||||||
|
"""Write an NDJSON override file. Entries may be dicts or raw strings (for malformed input)."""
|
||||||
|
path = os.path.join(self.tmpdir, f"{public_id}.{ext}")
|
||||||
|
with open(path, "w") as f:
|
||||||
|
for o in overrides:
|
||||||
|
f.write(o if isinstance(o, str) else json.dumps(o))
|
||||||
|
f.write("\n")
|
||||||
|
return path
|
||||||
|
|
||||||
|
def _run_main(self, *extra_argv, input_response="yes"):
|
||||||
|
"""Run main() with stdout/stderr captured and input mocked. Returns (stdout, stderr, exit_code)."""
|
||||||
|
argv = ["cmd", "--source", self.tmpdir, *extra_argv]
|
||||||
|
out, err = StringIO(), StringIO()
|
||||||
|
with patch.object(sys, "argv", argv), \
|
||||||
|
patch("sys.stdout", new=out), \
|
||||||
|
patch("sys.stderr", new=err), \
|
||||||
|
patch("builtins.input", return_value=input_response):
|
||||||
|
with self.assertRaises(SystemExit) as cm:
|
||||||
|
soi.main()
|
||||||
|
return out.getvalue(), err.getvalue(), cm.exception.code
|
||||||
|
|
||||||
|
def test_source_dir_missing(self):
|
||||||
|
argv = ["cmd", "--source", "/no/such/path/here"]
|
||||||
|
err = StringIO()
|
||||||
|
with patch.object(sys, "argv", argv), patch("sys.stderr", new=err):
|
||||||
|
with self.assertRaises(SystemExit) as cm:
|
||||||
|
soi.main()
|
||||||
|
self.assertEqual(cm.exception.code, 1)
|
||||||
|
self.assertIn("source directory not found", err.getvalue())
|
||||||
|
|
||||||
|
def test_no_files_found(self):
|
||||||
|
out, _, code = self._run_main()
|
||||||
|
self.assertEqual(code, 0)
|
||||||
|
self.assertIn("No *.txt files found", out)
|
||||||
|
|
||||||
|
def test_user_aborts(self):
|
||||||
|
self._write_file("1001", [{"type": "suppress", "track": "by_src", "ip": "1.2.3.4"}])
|
||||||
|
out, _, code = self._run_main(input_response="no")
|
||||||
|
self.assertEqual(code, 1)
|
||||||
|
self.assertIn("Aborted", out)
|
||||||
|
|
||||||
|
def test_parse_error_increments_error(self):
|
||||||
|
# Malformed JSON line — parse_overrides_file raises JSONDecodeError.
|
||||||
|
self._write_file("1002", ["not json"])
|
||||||
|
out, _, code = self._run_main("--dry-run")
|
||||||
|
self.assertEqual(code, 1) # invalid+error → non-zero
|
||||||
|
self.assertIn("could not parse", out)
|
||||||
|
self.assertIn("Errors: 1", out)
|
||||||
|
|
||||||
|
def test_empty_file_skipped(self):
|
||||||
|
# Blank lines only — parse_overrides_file returns []; main reports "empty file" and continues.
|
||||||
|
path = os.path.join(self.tmpdir, "1003.txt")
|
||||||
|
with open(path, "w") as f:
|
||||||
|
f.write("\n\n")
|
||||||
|
out, _, code = self._run_main("--dry-run")
|
||||||
|
self.assertEqual(code, 0)
|
||||||
|
self.assertIn("empty file", out)
|
||||||
|
|
||||||
|
@patch.object(soi, "find_detection")
|
||||||
|
def test_search_http_error(self, mock_find):
|
||||||
|
mock_find.side_effect = requests.HTTPError("boom")
|
||||||
|
self._write_file("1004", [{"type": "suppress", "track": "by_src", "ip": "1.2.3.4"}])
|
||||||
|
out, _, code = self._run_main("--dry-run")
|
||||||
|
self.assertEqual(code, 1)
|
||||||
|
self.assertIn("search failed", out)
|
||||||
|
|
||||||
|
@patch.object(soi, "find_detection")
|
||||||
|
def test_no_detection_found(self, mock_find):
|
||||||
|
mock_find.return_value = (None, None, None)
|
||||||
|
self._write_file("1005", [{"type": "suppress", "track": "by_src", "ip": "1.2.3.4"}])
|
||||||
|
out, _, code = self._run_main("--dry-run")
|
||||||
|
self.assertEqual(code, 0)
|
||||||
|
self.assertIn("no detection found", out)
|
||||||
|
self.assertIn("Skipped (no detection): 1", out)
|
||||||
|
|
||||||
|
@patch.object(soi, "find_detection")
|
||||||
|
def test_all_duplicates_no_update(self, mock_find):
|
||||||
|
existing = [{"type": "suppress", "track": "by_src", "ip": "1.2.3.4"}]
|
||||||
|
mock_find.return_value = ("doc1", "so-detection", existing)
|
||||||
|
self._write_file("1006", [{"type": "suppress", "track": "by_src", "ip": "1.2.3.4"}])
|
||||||
|
out, _, code = self._run_main("--dry-run")
|
||||||
|
self.assertEqual(code, 0)
|
||||||
|
self.assertIn("SKIP", out)
|
||||||
|
self.assertNotIn("DRY-RUN: would update", out) # added_this_file == 0 branch
|
||||||
|
|
||||||
|
@patch.object(soi, "update_overrides")
|
||||||
|
@patch.object(soi, "find_detection")
|
||||||
|
def test_happy_path_full(self, mock_find, mock_update):
|
||||||
|
# Exercises: ADD, dedupe SKIP, INVALID, note prefix, UPDATE, custom-vars warning, exit=1 (invalid present)
|
||||||
|
existing = [{"type": "suppress", "track": "by_src", "ip": "9.9.9.9"}]
|
||||||
|
mock_find.return_value = ("doc1", "so-detection", existing)
|
||||||
|
mock_update.return_value = {"result": "updated"}
|
||||||
|
self._write_file("1007", [
|
||||||
|
{"type": "suppress", "track": "by_src", "ip": "1.2.3.4"}, # ADD
|
||||||
|
{"type": "suppress", "track": "by_src", "ip": "9.9.9.9"}, # SKIP (dupe of existing)
|
||||||
|
{"type": "suppress", "track": "bogus", "ip": "1.2.3.4"}, # INVALID
|
||||||
|
{"type": "suppress", "track": "by_src", "ip": "$CONCOURSEWORKERS"}, # ADD + custom var
|
||||||
|
])
|
||||||
|
out, _, code = self._run_main()
|
||||||
|
self.assertEqual(code, 1) # one invalid -> non-zero
|
||||||
|
|
||||||
|
mock_update.assert_called_once()
|
||||||
|
merged = mock_update.call_args[0][3]
|
||||||
|
self.assertEqual(len(merged), 3) # 1 existing + 2 new
|
||||||
|
new_notes = [o.get("note", "") for o in merged if o.get("ip") in ("1.2.3.4", "$CONCOURSEWORKERS")]
|
||||||
|
self.assertTrue(all(n.startswith("[Imported ") for n in new_notes))
|
||||||
|
|
||||||
|
self.assertIn("ADD", out)
|
||||||
|
self.assertIn("SKIP", out)
|
||||||
|
self.assertIn("INVALID", out)
|
||||||
|
self.assertIn("UPDATED", out)
|
||||||
|
self.assertIn("$CONCOURSEWORKERS", out)
|
||||||
|
|
||||||
|
@patch.object(soi, "update_overrides")
|
||||||
|
@patch.object(soi, "find_detection")
|
||||||
|
def test_no_import_note_preserves_note(self, mock_find, mock_update):
|
||||||
|
mock_find.return_value = ("doc1", "so-detection", [])
|
||||||
|
mock_update.return_value = {"result": "updated"}
|
||||||
|
self._write_file("1008", [
|
||||||
|
{"type": "suppress", "track": "by_src", "ip": "1.2.3.4", "note": "original"},
|
||||||
|
])
|
||||||
|
_, _, code = self._run_main("--no-import-note")
|
||||||
|
self.assertEqual(code, 0)
|
||||||
|
merged = mock_update.call_args[0][3]
|
||||||
|
self.assertEqual(merged[0]["note"], "original") # no prefix applied
|
||||||
|
|
||||||
|
@patch.object(soi, "find_detection")
|
||||||
|
def test_dry_run_skips_update(self, mock_find):
|
||||||
|
mock_find.return_value = ("doc1", "so-detection", [])
|
||||||
|
self._write_file("1009", [{"type": "suppress", "track": "by_src", "ip": "1.2.3.4"}])
|
||||||
|
with patch.object(soi, "update_overrides") as mock_update:
|
||||||
|
out, _, code = self._run_main("--dry-run")
|
||||||
|
self.assertEqual(code, 0)
|
||||||
|
mock_update.assert_not_called()
|
||||||
|
self.assertIn("DRY-RUN: would update", out)
|
||||||
|
|
||||||
|
@patch.object(soi, "update_overrides")
|
||||||
|
@patch.object(soi, "find_detection")
|
||||||
|
def test_update_http_error(self, mock_find, mock_update):
|
||||||
|
mock_find.return_value = ("doc1", "so-detection", [])
|
||||||
|
mock_update.side_effect = requests.HTTPError("nope")
|
||||||
|
self._write_file("1010", [{"type": "suppress", "track": "by_src", "ip": "1.2.3.4"}])
|
||||||
|
out, _, code = self._run_main()
|
||||||
|
self.assertEqual(code, 1)
|
||||||
|
self.assertIn("update failed", out)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
@@ -556,14 +556,23 @@ check_transform_health_and_reauthorize() {
|
|||||||
# - unhealthy (any non-green health status)
|
# - unhealthy (any non-green health status)
|
||||||
# - metadata has run_as_kibana_system: false (this fix is specific to transforms started prior to Kibana 9.3.3)
|
# - metadata has run_as_kibana_system: false (this fix is specific to transforms started prior to Kibana 9.3.3)
|
||||||
# - are not orphaned (integration is not somehow missing/corrupt/uninstalled)
|
# - are not orphaned (integration is not somehow missing/corrupt/uninstalled)
|
||||||
|
local tmp_transforms tmp_stats tmp_installed
|
||||||
|
tmp_transforms=$(mktemp)
|
||||||
|
tmp_stats=$(mktemp)
|
||||||
|
tmp_installed=$(mktemp)
|
||||||
|
|
||||||
|
echo "$transforms_doc" > "$tmp_transforms"
|
||||||
|
echo "$stats_doc" > "$tmp_stats"
|
||||||
|
echo "$installed_doc" > "$tmp_installed"
|
||||||
|
|
||||||
local unhealthy_transforms
|
local unhealthy_transforms
|
||||||
unhealthy_transforms=$(jq -c -n \
|
unhealthy_transforms=$(jq -c -n \
|
||||||
--argjson t "$transforms_doc" \
|
--slurpfile t "$tmp_transforms" \
|
||||||
--argjson s "$stats_doc" \
|
--slurpfile s "$tmp_stats" \
|
||||||
--argjson i "$installed_doc" '
|
--slurpfile i "$tmp_installed" '
|
||||||
($i.items | map({key: .name, value: .version}) | from_entries) as $pkg_ver
|
($i[0].items | map({key: .name, value: .version}) | from_entries) as $pkg_ver
|
||||||
| ($s.transforms | map({key: .id, value: .health.status}) | from_entries) as $health
|
| ($s[0].transforms | map({key: .id, value: .health.status}) | from_entries) as $health
|
||||||
| [ $t.transforms[]
|
| [ $t[0].transforms[]
|
||||||
| select(._meta.run_as_kibana_system == false)
|
| select(._meta.run_as_kibana_system == false)
|
||||||
| select(($health[.id] // "unknown") != "green")
|
| select(($health[.id] // "unknown") != "green")
|
||||||
| {id, pkg: ._meta.package.name, ver: ($pkg_ver[._meta.package.name])}
|
| {id, pkg: ._meta.package.name, ver: ($pkg_ver[._meta.package.name])}
|
||||||
@@ -604,6 +613,8 @@ check_transform_health_and_reauthorize() {
|
|||||||
(( total_failures += $(jq 'map(select(.success != true)) | length' <<< "$resp" 2>/dev/null) ))
|
(( total_failures += $(jq 'map(select(.success != true)) | length' <<< "$resp" 2>/dev/null) ))
|
||||||
done <<< "$unhealthy_transforms"
|
done <<< "$unhealthy_transforms"
|
||||||
|
|
||||||
|
rm -f "$tmp_transforms" "$tmp_stats" "$tmp_installed"
|
||||||
|
|
||||||
if [[ "$total_failures" -gt 0 ]]; then
|
if [[ "$total_failures" -gt 0 ]]; then
|
||||||
echo "Some transform(s) failed to reauthorize."
|
echo "Some transform(s) failed to reauthorize."
|
||||||
fi
|
fi
|
||||||
@@ -644,6 +655,27 @@ ensure_postgres_secret() {
|
|||||||
chown socore:socore "$secrets_file"
|
chown socore:socore "$secrets_file"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
rename_strelka_scan_lnk() {
|
||||||
|
echo "Renaming strelka pillar ScanLNK to ScanLnk."
|
||||||
|
local STRELKA_FILE=/opt/so/saltstack/local/pillar/strelka/soc_strelka.sls
|
||||||
|
local MINIONDIR=/opt/so/saltstack/local/pillar/minions
|
||||||
|
local OLD_KEY=strelka.backend.config.backend.scanners.ScanLNK
|
||||||
|
local NEW_KEY=strelka.backend.config.backend.scanners.ScanLnk
|
||||||
|
local TMP_VALUE_FILE
|
||||||
|
TMP_VALUE_FILE=$(mktemp)
|
||||||
|
|
||||||
|
for pillar_file in "$STRELKA_FILE" "$MINIONDIR"/*.sls; do
|
||||||
|
[[ -f "$pillar_file" ]] || continue
|
||||||
|
# Skip if ScanLNK doesn't exist
|
||||||
|
so-yaml.py get "$pillar_file" "$OLD_KEY" > "$TMP_VALUE_FILE" 2>/dev/null || continue
|
||||||
|
echo "Found 'ScanLNK' key in $pillar_file. Renaming to 'ScanLnk'."
|
||||||
|
so-yaml.py add "$pillar_file" "$NEW_KEY" "file:$TMP_VALUE_FILE"
|
||||||
|
so-yaml.py remove "$pillar_file" "$OLD_KEY"
|
||||||
|
done
|
||||||
|
|
||||||
|
rm -f "$TMP_VALUE_FILE"
|
||||||
|
}
|
||||||
|
|
||||||
up_to_3.1.0() {
|
up_to_3.1.0() {
|
||||||
ensure_postgres_local_pillar
|
ensure_postgres_local_pillar
|
||||||
ensure_postgres_secret
|
ensure_postgres_secret
|
||||||
@@ -651,7 +683,7 @@ up_to_3.1.0() {
|
|||||||
elasticsearch_backup_index_templates
|
elasticsearch_backup_index_templates
|
||||||
# Clear existing component template state file.
|
# Clear existing component template state file.
|
||||||
rm -f /opt/so/state/esfleet_component_templates.json
|
rm -f /opt/so/state/esfleet_component_templates.json
|
||||||
|
rename_strelka_scan_lnk
|
||||||
|
|
||||||
INSTALLEDVERSION=3.1.0
|
INSTALLEDVERSION=3.1.0
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -117,6 +117,121 @@ transformations:
|
|||||||
- type: logsource
|
- type: logsource
|
||||||
product: linux
|
product: linux
|
||||||
service: auth
|
service: auth
|
||||||
|
# Maps M365 audit rules to Elastic Agent O365 integration logs
|
||||||
|
- id: m365_audit_field_mappings
|
||||||
|
type: field_name_mapping
|
||||||
|
mapping:
|
||||||
|
Operation: event.action
|
||||||
|
ResultStatus: event.outcome
|
||||||
|
ApplicationId: o365.audit.ApplicationId
|
||||||
|
ObjectId: o365.audit.ObjectId
|
||||||
|
RequestType: o365.audit.RequestType
|
||||||
|
rule_conditions:
|
||||||
|
- type: logsource
|
||||||
|
product: m365
|
||||||
|
service: audit
|
||||||
|
- id: m365_audit_add-fields
|
||||||
|
type: add_condition
|
||||||
|
conditions:
|
||||||
|
event.dataset: 'o365.audit'
|
||||||
|
event.module: 'o365'
|
||||||
|
rule_conditions:
|
||||||
|
- type: logsource
|
||||||
|
product: m365
|
||||||
|
service: audit
|
||||||
|
# Maps M365 exchange rules to Elastic Agent O365 integration logs
|
||||||
|
- id: m365_exchange_field_mappings
|
||||||
|
type: field_name_mapping
|
||||||
|
mapping:
|
||||||
|
eventSource: event.provider
|
||||||
|
eventName: event.action
|
||||||
|
status: event.outcome
|
||||||
|
rule_conditions:
|
||||||
|
- type: logsource
|
||||||
|
product: m365
|
||||||
|
service: exchange
|
||||||
|
- id: m365_exchange_add-fields
|
||||||
|
type: add_condition
|
||||||
|
conditions:
|
||||||
|
event.dataset: 'o365.audit'
|
||||||
|
event.module: 'o365'
|
||||||
|
rule_conditions:
|
||||||
|
- type: logsource
|
||||||
|
product: m365
|
||||||
|
service: exchange
|
||||||
|
# Maps M365 threat_management rules to Elastic Agent O365 integration logs
|
||||||
|
- id: m365_threat_management_field_mappings
|
||||||
|
type: field_name_mapping
|
||||||
|
mapping:
|
||||||
|
eventSource: event.provider
|
||||||
|
eventName: event.action
|
||||||
|
status: event.outcome
|
||||||
|
rule_conditions:
|
||||||
|
- type: logsource
|
||||||
|
product: m365
|
||||||
|
service: threat_management
|
||||||
|
- id: m365_threat_management_add-fields
|
||||||
|
type: add_condition
|
||||||
|
conditions:
|
||||||
|
event.dataset: 'o365.audit'
|
||||||
|
event.module: 'o365'
|
||||||
|
rule_conditions:
|
||||||
|
- type: logsource
|
||||||
|
product: m365
|
||||||
|
service: threat_management
|
||||||
|
# Maps M365 threat_detection rules to Elastic Agent O365 integration logs
|
||||||
|
- id: m365_threat_detection_field_mappings
|
||||||
|
type: field_name_mapping
|
||||||
|
mapping:
|
||||||
|
eventSource: event.provider
|
||||||
|
eventName: event.action
|
||||||
|
status: event.outcome
|
||||||
|
rule_conditions:
|
||||||
|
- type: logsource
|
||||||
|
product: m365
|
||||||
|
service: threat_detection
|
||||||
|
- id: m365_threat_detection_add-fields
|
||||||
|
type: add_condition
|
||||||
|
conditions:
|
||||||
|
event.dataset: 'o365.audit'
|
||||||
|
event.module: 'o365'
|
||||||
|
rule_conditions:
|
||||||
|
- type: logsource
|
||||||
|
product: m365
|
||||||
|
service: threat_detection
|
||||||
|
# Maps FortiGate event rules to Elastic Agent Fortinet integration logs
|
||||||
|
- id: fortigate_event_field_mappings
|
||||||
|
type: field_name_mapping
|
||||||
|
mapping:
|
||||||
|
action: fortinet.firewall.action
|
||||||
|
cfgpath: fortinet.firewall.cfgpath
|
||||||
|
cfgobj: fortinet.firewall.cfgobj
|
||||||
|
cfgattr: fortinet.firewall.cfgattr
|
||||||
|
devname: observer.name
|
||||||
|
devid: observer.serial_number
|
||||||
|
logid: event.code
|
||||||
|
type: fortinet.firewall.type
|
||||||
|
subtype: fortinet.firewall.subtype
|
||||||
|
level: log.level
|
||||||
|
vd: fortinet.firewall.vd
|
||||||
|
logdesc: fortinet.firewall.desc
|
||||||
|
user: user.name
|
||||||
|
ui: fortinet.firewall.ui
|
||||||
|
cfgtid: fortinet.firewall.cfgtid
|
||||||
|
msg: message
|
||||||
|
rule_conditions:
|
||||||
|
- type: logsource
|
||||||
|
product: fortigate
|
||||||
|
service: event
|
||||||
|
- id: fortigate_event_add-fields
|
||||||
|
type: add_condition
|
||||||
|
conditions:
|
||||||
|
event.dataset: 'fortinet_fortigate.log'
|
||||||
|
event.module: 'fortinet_fortigate'
|
||||||
|
rule_conditions:
|
||||||
|
- type: logsource
|
||||||
|
product: fortigate
|
||||||
|
service: event
|
||||||
# event.code should always be a string
|
# event.code should always be a string
|
||||||
- id: convert_event_code_to_string
|
- id: convert_event_code_to_string
|
||||||
type: convert_type
|
type: convert_type
|
||||||
@@ -126,15 +241,36 @@ transformations:
|
|||||||
fields:
|
fields:
|
||||||
- event.code
|
- event.code
|
||||||
# Maps process_creation rules to endpoint process creation logs
|
# Maps process_creation rules to endpoint process creation logs
|
||||||
# This is an OS-agnostic mapping, to account for logs that don't specify source OS
|
|
||||||
- id: endpoint_process_create_windows_add-fields
|
- id: endpoint_process_create_windows_add-fields
|
||||||
type: add_condition
|
type: add_condition
|
||||||
conditions:
|
conditions:
|
||||||
event.category: 'process'
|
event.category: 'process'
|
||||||
event.type: 'start'
|
event.type: 'start'
|
||||||
|
host.os.type: 'windows'
|
||||||
rule_conditions:
|
rule_conditions:
|
||||||
- type: logsource
|
- type: logsource
|
||||||
category: process_creation
|
category: process_creation
|
||||||
|
product: windows
|
||||||
|
- id: endpoint_process_create_macos_add-fields
|
||||||
|
type: add_condition
|
||||||
|
conditions:
|
||||||
|
event.category: 'process'
|
||||||
|
event.type: 'start'
|
||||||
|
host.os.type: 'macos'
|
||||||
|
rule_conditions:
|
||||||
|
- type: logsource
|
||||||
|
category: process_creation
|
||||||
|
product: macos
|
||||||
|
- id: endpoint_process_create_linux_add-fields
|
||||||
|
type: add_condition
|
||||||
|
conditions:
|
||||||
|
event.category: 'process'
|
||||||
|
event.type: 'start'
|
||||||
|
host.os.type: 'linux'
|
||||||
|
rule_conditions:
|
||||||
|
- type: logsource
|
||||||
|
category: process_creation
|
||||||
|
product: linux
|
||||||
# Maps file_event rules to endpoint file creation logs
|
# Maps file_event rules to endpoint file creation logs
|
||||||
# This is an OS-agnostic mapping, to account for logs that don't specify source OS
|
# This is an OS-agnostic mapping, to account for logs that don't specify source OS
|
||||||
- id: endpoint_file_create_add-fields
|
- id: endpoint_file_create_add-fields
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
telegraf:
|
telegraf:
|
||||||
enabled: False
|
enabled: False
|
||||||
output: BOTH
|
output: INFLUXDB
|
||||||
config:
|
config:
|
||||||
interval: '30s'
|
interval: '30s'
|
||||||
metric_batch_size: 1000
|
metric_batch_size: 1000
|
||||||
|
|||||||
+27
-2
@@ -119,7 +119,7 @@ base:
|
|||||||
- kafka
|
- kafka
|
||||||
- pcap.cleanup
|
- pcap.cleanup
|
||||||
|
|
||||||
'*_manager or *_managerhype and G@saltversion:{{saltversion}} and not I@node_data:False':
|
'*_manager and G@saltversion:{{saltversion}} and not I@node_data:False':
|
||||||
- match: compound
|
- match: compound
|
||||||
- salt.master
|
- salt.master
|
||||||
- registry
|
- registry
|
||||||
@@ -146,6 +146,32 @@ base:
|
|||||||
- stig
|
- stig
|
||||||
- kafka
|
- kafka
|
||||||
|
|
||||||
|
'*_managerhype and G@saltversion:{{saltversion}} and not I@node_data:False':
|
||||||
|
- match: compound
|
||||||
|
- salt.master
|
||||||
|
- registry
|
||||||
|
- nginx
|
||||||
|
- influxdb
|
||||||
|
- postgres
|
||||||
|
- strelka.manager
|
||||||
|
- soc
|
||||||
|
- kratos
|
||||||
|
- hydra
|
||||||
|
- firewall
|
||||||
|
- manager
|
||||||
|
- sensoroni
|
||||||
|
- telegraf
|
||||||
|
- backup.config_backup
|
||||||
|
- elasticsearch
|
||||||
|
- logstash
|
||||||
|
- redis
|
||||||
|
- elastic-fleet-package-registry
|
||||||
|
- kibana
|
||||||
|
- elastalert
|
||||||
|
- utility
|
||||||
|
- elasticfleet
|
||||||
|
- kafka
|
||||||
|
|
||||||
'*_managerhype and I@features:vrt and G@saltversion:{{saltversion}}':
|
'*_managerhype and I@features:vrt and G@saltversion:{{saltversion}}':
|
||||||
- match: compound
|
- match: compound
|
||||||
- manager.hypervisor
|
- manager.hypervisor
|
||||||
@@ -286,7 +312,6 @@ base:
|
|||||||
- libvirt
|
- libvirt
|
||||||
- libvirt.images
|
- libvirt.images
|
||||||
- elasticfleet.install_agent_grid
|
- elasticfleet.install_agent_grid
|
||||||
- stig
|
|
||||||
|
|
||||||
'*_desktop and G@saltversion:{{saltversion}}':
|
'*_desktop and G@saltversion:{{saltversion}}':
|
||||||
- sensoroni
|
- sensoroni
|
||||||
|
|||||||
Reference in New Issue
Block a user