mirror of
https://github.com/splunk/security_content
synced 2026-06-08 17:32:49 +00:00
pyth0n1c
71b7c5d45c
was being uploaded from. This means that delete does not work as expected, causing a large number of tests to fail and slower searches.
200 lines
7.9 KiB
Python
200 lines
7.9 KiB
Python
|
|
import re
|
|
|
|
#import ansible_runner
|
|
import yaml
|
|
import uuid
|
|
import sys
|
|
import os
|
|
import time
|
|
import requests
|
|
from modules.DataManipulation import DataManipulation
|
|
from modules import utils
|
|
from modules import splunk_sdk
|
|
import timeit
|
|
from typing import Union, Tuple
|
|
from os.path import relpath
|
|
from tempfile import mkdtemp
|
|
import datetime
|
|
import http.client
|
|
|
|
|
|
|
|
|
|
def test_detection_wrapper(container_name:str, splunk_ip:str, splunk_password:str, splunk_port:int,
|
|
test_file:str, attack_data_root_folder, wait_on_failure:bool=False, wait_on_completion:bool=False)->dict:
|
|
|
|
one_test_start = timeit.default_timer()
|
|
uuid_var = str(uuid.uuid4())
|
|
result_test, indices_to_delete = test_detection(splunk_ip, splunk_port, container_name, splunk_password, test_file, uuid_var, attack_data_root_folder)
|
|
one_test_stop = timeit.default_timer()
|
|
|
|
if result_test is None:
|
|
#We failed so early in the process that we could not produce any meaningful result
|
|
raise(Exception("Test execution Error"))
|
|
|
|
#enter = input("Run some tests from [%s] on [%s] - we don't delete until you hit enter :)"%(container_name, test_file))
|
|
# delete test data
|
|
search_string = result_test['detection_result']['search_string']
|
|
|
|
#get pretty time info
|
|
elapsed_search_time_string = str(datetime.timedelta(seconds=round(one_test_stop - one_test_start)))
|
|
|
|
#search failed if there was an error or the detection failed to produce the expected result
|
|
#print("Elapsed search time: %s"%(elapsed_search_time_string))
|
|
if (wait_on_failure or wait_on_completion) and (result_test['detection_result']['error'] or not result_test['detection_result']['success']):
|
|
wait_on_delete = {'message':"\n\n\n****SEARCH FAILURE : Allowing time to debug search/data****"}
|
|
elif wait_on_completion:
|
|
wait_on_delete = {'message':"\n\n\n****SEARCH SUCCESS : Allowing time to examine search/data****"}
|
|
else:
|
|
wait_on_delete = None
|
|
|
|
|
|
splunk_sdk.delete_attack_data(splunk_ip, splunk_password, splunk_port, wait_on_delete, search_string, test_file, indices = indices_to_delete)
|
|
|
|
|
|
return result_test
|
|
|
|
|
|
import splunklib.client as client
|
|
def get_service(splunk_ip:str, splunk_port:int, splunk_password:str):
|
|
|
|
try:
|
|
service = client.connect(
|
|
host=splunk_ip,
|
|
port=splunk_port,
|
|
username='admin',
|
|
password=splunk_password
|
|
)
|
|
except Exception as e:
|
|
raise(Exception("Unable to connect to Splunk instance: " + str(e)))
|
|
return service
|
|
|
|
def test_detection(splunk_ip:str, splunk_port:int, container_name:str, splunk_password:str, test_file:str, uuid_var, attack_data_root_folder)->Tuple[Union[dict,None], set[str]]:
|
|
|
|
test_file_obj = load_file(os.path.join("security_content/", test_file))
|
|
|
|
|
|
if not test_file_obj:
|
|
print("Not test_file_obj!")
|
|
raise(Exception("No test file object found for [%s]"%(test_file)))
|
|
#print(test_file_obj)
|
|
|
|
# write entry dynamodb
|
|
#aws_service.add_detection_results_in_dynamo_db('eu-central-1', uuid_var , uuid_test, test_file_obj['tests'][0]['name'], test_file_obj['tests'][0]['file'], str(int(time.time())))
|
|
|
|
#epoch_time = str(int(time.time()))
|
|
|
|
|
|
abs_folder_path = mkdtemp(prefix="DATA_", dir=attack_data_root_folder)
|
|
#We want the relative path, so we convert it as required
|
|
folder_name = relpath(abs_folder_path, os.getcwd())
|
|
|
|
|
|
|
|
|
|
indices_to_delete = set()
|
|
for attack_data in test_file_obj['tests'][0]['attack_data']:
|
|
url = attack_data['data']
|
|
|
|
if 'custom_index' in attack_data:
|
|
print(f"Found a custom index for {test_file}: {attack_data['custom_index']}")
|
|
data_upload_index = attack_data['custom_index']
|
|
else:
|
|
data_upload_index = splunk_sdk.DEFAULT_DATA_INDEX
|
|
|
|
indices_to_delete.add(data_upload_index)
|
|
|
|
target_file = os.path.join(folder_name, attack_data['file_name'])
|
|
utils.download_file_from_http(url, target_file)
|
|
|
|
|
|
|
|
# Update timestamps before replay
|
|
if 'update_timestamp' in attack_data:
|
|
if attack_data['update_timestamp'] == True:
|
|
data_manipulation = DataManipulation()
|
|
data_manipulation.manipulate_timestamp(target_file, attack_data['sourcetype'], attack_data['source'])
|
|
#replay_attack_dataset(container_name, splunk_password, folder_name, "test0", attack_data['sourcetype'], attack_data['source'], attack_data['file_name'])
|
|
|
|
try:
|
|
service = get_service(splunk_ip, splunk_port, splunk_password)
|
|
test_index = service.indexes[data_upload_index]
|
|
|
|
with open(target_file, 'rb') as target:
|
|
test_index.submit(target.read(), sourcetype=attack_data['sourcetype'], source=attack_data['source'], host=splunk_sdk.DEFAULT_EVENT_HOST)
|
|
|
|
except http.client.HTTPException as e:
|
|
raise(Exception(f"Failed to submit detection file {target_file} to Splunk Server: {str(e)}"))
|
|
|
|
except Exception as e:
|
|
raise(Exception(f"Failed to submit detection file {target_file} to Splunk Server: {str(e)}"))
|
|
|
|
|
|
|
|
|
|
if not splunk_sdk.wait_for_indexing_to_complete(splunk_ip, splunk_port, splunk_password, attack_data['sourcetype'], data_upload_index):
|
|
raise Exception("There was an error waiting for indexing to complete.")
|
|
|
|
#Allow some time for the data to be ingested and processed
|
|
#print("begin sleep 30")
|
|
#time.sleep(60)
|
|
|
|
|
|
#print("end sleep 30")
|
|
|
|
result_test = {}
|
|
test = test_file_obj['tests'][0]
|
|
|
|
|
|
if 'baselines' in test:
|
|
results_baselines = []
|
|
for baseline_obj in test['baselines']:
|
|
baseline_file_name = baseline_obj['file']
|
|
baseline = load_file(os.path.join(os.path.dirname(__file__), '../security_content', baseline_file_name))
|
|
result_obj = dict()
|
|
result_obj['baseline'] = baseline_obj['name']
|
|
result_obj['baseline_file'] = baseline_obj['file']
|
|
print("Making test_baseline_search request to: [%s:%d]"%(splunk_ip, splunk_port))
|
|
result = splunk_sdk.test_baseline_search(splunk_ip, splunk_port, splunk_password, baseline['search'], baseline_obj['pass_condition'], baseline['name'], baseline_obj['file'], baseline_obj['earliest_time'], baseline_obj['latest_time'])
|
|
#we don't seem to be doing anything with this loop... are we supposed to have the following line belwo?
|
|
results_baselines.append(result)
|
|
|
|
result_test['baselines_result'] = results_baselines
|
|
|
|
detection_file_name = test['file']
|
|
detection = load_file(os.path.join(os.path.dirname(__file__), '../security_content/detections', detection_file_name))
|
|
#print("Making test_detection_search request to: [%s:%d]"%(splunk_ip, splunk_port))
|
|
|
|
result_detection = splunk_sdk.test_detection_search(splunk_ip, splunk_port, splunk_password, detection['search'], test['pass_condition'], detection['name'], test['file'], test['earliest_time'], test['latest_time'])
|
|
if result_detection['error']:
|
|
print("There was an error running the search: %s"%(result_detection['search_string']))
|
|
|
|
|
|
|
|
|
|
|
|
result_detection['detection_name'] = test['name']
|
|
result_detection['detection_file'] = test['file']
|
|
result_test['detection_result'] = result_detection
|
|
result_test['attack_data_directory'] = abs_folder_path
|
|
|
|
|
|
return result_test, indices_to_delete
|
|
|
|
|
|
def load_file(file_path):
|
|
try:
|
|
|
|
with open(file_path, 'r', encoding="utf-8") as stream:
|
|
try:
|
|
file = list(yaml.safe_load_all(stream))[0]
|
|
except yaml.YAMLError as exc:
|
|
raise(Exception("ERROR: parsing YAML for {0}:[{1}]".format(file_path, str(exc))))
|
|
except Exception as e:
|
|
raise(Exception("ERROR: opening {0}:[{1}]".format(file_path, str(e))))
|
|
return file
|
|
|
|
|
|
|