class Automators(Main):
def __init__(self, cfg, use_case_config):
self.logger = logging.getLogger(__name__)
self.logger.info('Initiating QRadar Automators')
self.cfg = cfg
self.use_case_config = use_case_config
self.TheHiveConnector = TheHiveConnector(cfg)
self.TheHiveAutomators = TheHiveAutomators(cfg, use_case_config)
self.QRadarConnector = QRadarConnector(cfg)
def checkSiem(self, action_config, webhook):
#Only continue if the right webhook is triggered
if webhook.isImportedAlert() or webhook.isNewAlert() or webhook.isQRadarAlertUpdateFollowTrue():
pass
else:
return False
#Define variables and actions based on certain webhook types
#Alerts
if webhook.isNewAlert() or webhook.isQRadarAlertUpdateFollowTrue():
self.alert_id = webhook.data['object']['id']
self.alert_description = webhook.data['object']['description']
self.supported_query_type = 'enrichment_queries'
#Cases
elif webhook.isImportedAlert():
self.case_id = webhook.data['object']['case']
self.supported_query_type = 'search_queries'
self.query_variables = {}
self.query_variables['input'] = {}
self.enriched = False
#Prepare search queries for searches
for query_name, query_config in action_config[self.supported_query_type].items():
try:
self.logger.info('Found the following query: %s' % (query_name))
self.query_variables[query_name] = {}
#Render query
try:
#Prepare the template
self.template = Template(query_config['query'])
#Find variables in the template
self.template_env = Environment()
self.template_parsed = self.template_env.parse(query_config['query'])
#Grab all the variales from the template and try to find them in the description
self.template_vars = meta.find_undeclared_variables(self.template_parsed)
self.logger.debug("Found the following variables in query: {}".format(self.template_vars))
for template_var in self.template_vars:
#Skip dynamically generated Stop_time variable
if template_var == "Stop_Time":
continue
self.logger.debug("Looking up variable required for template: {}".format(template_var))
#Replace the underscore from the variable name to a white space as this is used in the description table
self.template_var_with_ws = template_var.replace("_", " ")
self.query_variables['input'][template_var] = self.TheHiveAutomators.fetchValueFromDescription(webhook,self.template_var_with_ws)
#Parse times required for the query (with or without offset)
if template_var == "Start_Time":
self.logger.debug("Found Start Time: %s" % self.query_variables['input']['Start_Time'])
if 'start_time_offset' in query_config:
self.query_variables['input']['Start_Time'] = self.parseTimeOffset(self.query_variables['input']['Start_Time'], self.cfg.get('Automation', 'event_start_time_format'), query_config['start_time_offset'], self.cfg.get('QRadar', 'time_format'))
else:
self.query_variables['input']['Start_Time'] = self.query_variables['input']['Start_Time']
if 'stop_time_offset' in query_config:
self.query_variables['input']['Stop_Time'] = self.parseTimeOffset(self.query_variables['input']['Start_Time'], self.cfg.get('Automation', 'event_start_time_format'), query_config['stop_time_offset'], self.cfg.get('QRadar', 'time_format'))
else:
self.query_variables['input']['Stop_Time'] = datetime.now().strftime(self.cfg.get('Automation', 'event_start_time_format'))
if not self.query_variables['input']['Start_Time']:
self.logger.warning("Could not find Start Time value ")
raise GetOutOfLoop
self.query_variables[query_name]['query'] = self.template.render(self.query_variables['input'])
self.logger.debug("Rendered the following query: %s" % self.query_variables[query_name]['query'])
except Exception as e:
self.logger.warning("Could not render query due to missing variables", exc_info=True)
raise GetOutOfLoop
#Perform search queries
try:
self.query_variables[query_name]['result'] = self.QRadarConnector.aqlSearch(self.query_variables[query_name]['query'])
except Exception as e:
self.logger.warning("Could not perform query", exc_info=True)
raise GetOutOfLoop
#Check results
self.logger.debug('The search result returned the following information: \n %s' % self.query_variables[query_name]['result'])
if self.supported_query_type == "search_queries":
#Task name
self.uc_task_title = query_config['task_title']
self.uc_task_description = "The following information is found. Investigate the results and act accordingly:\n\n\n\n"
#create a table header
self.table_header = "|"
self.rows = "|"
if len(self.query_variables[query_name]['result']['events']) != 0:
for key in self.query_variables[query_name]['result']['events'][0].keys():
self.table_header = self.table_header + " %s |" % key
self.rows = self.rows + "---|"
self.table_header = self.table_header + "\n" + self.rows + "\n"
self.uc_task_description = self.uc_task_description + self.table_header
#Create the data table for the results
for event in self.query_variables[query_name]['result']['events']:
self.table_data_row = "|"
for field_key, field_value in event.items():
# Escape pipe signs
if field_value:
field_value = field_value.replace("|", "|")
# Use to create some additional spacing
self.table_data_row = self.table_data_row + " %s |" % field_value
self.table_data_row = self.table_data_row + "\n"
self.uc_task_description = self.uc_task_description + self.table_data_row
else:
self.uc_task_description = self.uc_task_description + "No results \n"
#Add the case task
self.uc_task = self.TheHiveAutomators.craftUcTask(self.uc_task_title, self.uc_task_description)
self.TheHiveConnector.createTask(self.case_id, self.uc_task)
if self.supported_query_type == "enrichment_queries":
#Add results to description
try:
if self.TheHiveAutomators.fetchValueFromDescription(webhook,query_name) != self.query_variables[query_name]['result']['events'][0]['enrichment_result']:
self.regex_end_of_table = ' \|\\n\\n\\n'
self.end_of_table = ' |\n\n\n'
self.replacement_description = '|\n | **%s** | %s %s' % (query_name, self.query_variables[query_name]['result']['events'][0]['enrichment_result'], self.end_of_table)
self.th_alert_description = self.TheHiveConnector.getAlert(self.alert_id)['description']
self.alert_description = re.sub(self.regex_end_of_table, self.replacement_description, self.th_alert_description)
self.enriched = True
#Update Alert with the new description field
self.updated_alert = Alert
self.updated_alert.description = self.alert_description
self.TheHiveConnector.updateAlert(self.alert_id, self.updated_alert, ["description"])
except Exception as e:
self.logger.warning("Could not add results from the query to the description. Error: {}".format(e))
raise GetOutOfLoop
except GetOutOfLoop:
pass
return True
def connectEws():
logger = logging.getLogger(__name__)
logger.info('%s.connectEws starts', __name__)
report = dict()
report['success'] = bool()
try:
cfg = getConf()
ewsConnector = EwsConnector(cfg)
folder_name = cfg.get('EWS', 'folder_name')
unread = ewsConnector.scan(folder_name)
TheHiveConnector = TheHiveConnector(cfg)
for msg in unread:
#type(msg)
#<class 'exchangelib.folders.Message'>
conversationId = msg.conversation_id.id
#searching if case has already been created from the email
#conversation
esCaseId = TheHiveConnector.searchCaseByDescription(conversationId)
if esCaseId is None:
#no case previously created from the conversation
caseTitle = str(msg.subject)
caseDescription = ('```\n' + 'Case created by Synapse\n' +
'conversation_id: "' +
str(msg.conversation_id.id) + '"\n' + '```')
if msg.categories:
assignee = msg.categories[0]
else:
assignee = 'synapse'
case = TheHiveConnector.craftCase(caseTitle, caseDescription)
createdCase = TheHiveConnector.createCase(case)
caseUpdated = TheHiveConnector.assignCase(
createdCase, assignee)
commTask = TheHiveConnector.craftCommTask()
esCaseId = caseUpdated.id
commTaskId = TheHiveConnector.createTask(esCaseId, commTask)
else:
#case previously created from the conversation
commTaskId = TheHiveConnector.getTaskIdByTitle(
esCaseId, 'Communication')
if commTaskId != None:
pass
else:
#case already exists but no Communication task found
#creating comm task
commTask = TheHiveConnector.craftCommTask()
commTaskId = TheHiveConnector.createTask(
esCaseId, commTask)
fullBody = getEmailBody(msg)
taskLog = TheHiveConnector.craftTaskLog(fullBody)
createdTaskLogId = TheHiveConnector.addTaskLog(commTaskId, taskLog)
readMsg = ewsConnector.markAsRead(msg)
for attachmentLvl1 in msg.attachments:
#uploading the attachment as file observable
#is the attachment is a .msg, the eml version
#of the file is uploaded
tempAttachment = TempAttachment(attachmentLvl1)
if not tempAttachment.isInline:
#adding the attachment only if it is not inline
#inline attachments are pictures in the email body
tmpFilepath = tempAttachment.writeFile()
to = str()
for recipient in msg.to_recipients:
to = to + recipient.email_address + ' '
comment = 'Attachment from email sent by '
comment += str(msg.author.email_address).lower()
comment += ' and received by '
comment += str(to).lower()
comment += ' with subject: <'
comment += msg.subject
comment += '>'
TheHiveConnector.addFileObservable(esCaseId, tmpFilepath,
comment)
if tempAttachment.isEmailAttachment:
#if the attachment is an email
#attachments of this email are also
#uploaded to TheHive
for attachmentLvl2 in tempAttachment.attachments:
tempAttachmentLvl2 = TempAttachment(attachmentLvl2)
tmpFilepath = tempAttachmentLvl2.writeFile()
comment = 'Attachment from the email attached'
TheHiveConnector.addFileObservable(
esCaseId, tmpFilepath, comment)
report['success'] = True
return report
except Exception as e:
logger.error('Failed to create case from email', exc_info=True)
report['success'] = False
return report
class Automation():
def __init__(self, webhook, cfg):
logger.info('Initiating MISPautomation')
self.TheHiveConnector = TheHiveConnector(cfg)
if self.cfg.getboolean('Cortex', 'enabled'):
self.CortexConnector = CortexConnector(cfg)
self.webhook = webhook
self.report_action = report_action
self.qr_config = {}
for key, value in cfg.items('QRadar'):
self.qr_config[key] = value
def parse_hooks(self):
"""
Check for new MISP Alert containing supported IOC to search automatically
"""
if self.webhook.isNewMispAlert():
logger.info(
'Alert {} has been tagged as MISP and is just created'.format(
self.webhook.data['rootId']))
#Check alert for supported ioc types
supported_iocs = False
for artifact in self.webhook.data['object']['artifacts']:
if artifact['dataType'] in self.qr_config[
'supported_datatypes']:
supported_iocs = True
#Promote alert to case if there are support ioc types
if supported_iocs:
alert_id = self.webhook.data['rootId']
casetemplate = "MISP Event"
logger.info('Alert {} contains IOCs that are supported'.format(
alert_id))
response = self.TheHiveConnector.createCaseFromAlert(
alert_id, casetemplate)
self.report_action = 'createCase'
"""
Add timestamps to keep track of the search activity per case (we do not want to keep searching forever)
"""
#Perform automated Analyzer runs for supported observables in a case that has been created from a MISP alert
if self.webhook.isNewMispCase():
logger.info(
'Case {} has been tagged as MISP and is just created'.format(
self.webhook.data['rootId']))
#Retrieve caseid
caseid = self.webhook.data['object']['id']
#Add customFields firstSearched and lastSearched
#Create a Case object? Or whatever it is
case = Case()
#Add the case id to the object
case.id = caseid
#Debug output
logger.info('Updating case %s' % case.id)
#Define which fields need to get updated
fields = ['customFields']
#Retrieve all required attributes from the alert and add them as custom fields to the case
current_time = int(round(time.time() * 1000))
customFields = CustomFieldHelper()\
.add_date('firstSearched', current_time)\
.add_date('lastSearched', current_time)\
.build()
#Add custom fields to the case object
case.customFields = customFields
#Update the case
self.TheHiveConnector.updateCase(case, fields)
self.report_action = 'updateCase'
"""
Start the analyzers automatically for MISP observables that are supported and update the case with a new timestamp
"""
#Automatically run Analyzers for newly created MISP cases where supported IOC's are present
if self.webhook.isNewMispArtifact():
logger.info(
'Case artifact is tagged with "MISP-extern". Checking if observable is of a supported type'
)
#Retrieve caseid
caseid = self.webhook.data['rootId']
#Retrieve case data
case_data = self.TheHiveConnector.getCase(caseid)
#List all supported ioc's for the case
observable = self.webhook.data['object']
#When supported, start a cortex analyzer for it
if observable['dataType'] in self.qr_config['supported_datatypes']:
supported_observable = observable['_id']
#Trigger a search for the supported ioc
logger.info('Launching analyzers for observable: {}'.format(
observable['_id']))
response = self.CortexConnector.runAnalyzer(
"Cortex-intern", supported_observable,
"IBMQRadar_Search_Manual_0_1")
#Add customFields firstSearched and lastSearched
#Create a Case object
case = Case()
#Add the case id to the object
case.id = caseid
#Debug output
logger.info('Updating case %s' % case.id)
#Define which fields need to get updated
fields = ['customFields']
#Retrieve all required attributes from the alert and add them as custom fields to the case
current_time = int(round(time.time() * 1000))
customFields = CustomFieldHelper()\
.add_date('firstSearched', case_data['customFields']['firstSearched']['date'])\
.add_date('lastSearched', current_time)\
.build()
#Add custom fields to the case object
case.customFields = customFields
#Update the case
self.TheHiveConnector.updateCase(case, fields)
self.report_action = 'updateCase'
"""
Automatically create a task for a found IOC
"""
#If the Job result contains a successful search with minimum of 1 hit, create a task to investigate the results
if self.webhook.isCaseArtifactJob() and self.webhook.isSuccess(
) and self.webhook.isMisp():
#Case ID
caseid = self.webhook.data['rootId']
#Load Case information
case_data = self.TheHiveConnector.getCase(caseid)
logger.info(
'Job {} is part of a case that has been tagged as MISP case and has just finished'
.format(self.webhook.data['object']['cortexJobId']))
#Check if the result count higher than 0
if int(
float(self.webhook.data['object']['report']['summary']
['taxonomies'][0]['value'])) > 0:
logger.info(
'Job {} contains hits, checking if a task is already present for this observable'
.format(self.webhook.data['object']['cortexJobId']))
#Retrieve case task information
response = self.TheHiveConnector.getCaseTasks(caseid)
case_tasks = response.json()
#Load CaseTask template
casetask = CaseTask()
#Observable + Link
observable = self.webhook.data['object']['artifactId']
observable_link = TheHive.get(
'url'
) + "/index.html#!/case/" + caseid + "/observables/" + self.webhook.data[
'object']['artifactId']
#Task name
casetask.title = "Investigate found IOC with id: {}".format(
observable)
#Date
date_found = time.strftime("%d-%m-%Y %H:%M")
case_task_found = False
for case_task in case_tasks:
#Check if task is present for investigating the new results
if casetask.title == case_task['title']:
case_task_found = True
if not case_task_found:
logger.info(
'No task found, creating task for observable found in job {}'
.format(self.webhook.data['object']['cortexJobId']))
#Add description
casetask.description = "The following ioc is hit in the environment. Investigate the results and act accordingly:\n\n"
casetask.description = casetask.description + "{} is seen on {}\n".format(
observable_link, date_found)
#Check if case is closed
if case_data['status'] == "Resolved":
#Create a Case object? Or whatever it is
case = Case()
#Add the case id to the object
case.id = caseid
logger.info('Updating case %s' % case.id)
#Define which fields need to get updated
fields = ['status']
#Reopen the case
case.status = "Open"
#Update the case
self.TheHiveConnector.updateCase(case, fields)
#Add the case task
self.TheHiveConnector.createTask(caseid, casetask)
self.report_action = 'createTask'
return self.report_action
class Automators(Main):
def __init__(self, cfg, use_case_config):
self.logger = logging.getLogger(__name__)
self.logger.info('Initiating QRadar Automators')
self.cfg = cfg
self.use_case_config = use_case_config
self.TheHiveConnector = TheHiveConnector(cfg)
self.TheHiveAutomators = TheHiveAutomators(cfg, use_case_config)
self.QRadarConnector = QRadarConnector(cfg)
def search(self, action_config, webhook):
# Only continue if the right webhook is triggered
self.logger.debug("action_config:{}".format(action_config))
if webhook.isImportedAlert():
pass
else:
return False
# Define variables and actions based on certain webhook types
self.case_id = webhook.data['object']['case']
self.logger.debug(self.case_id)
self.enriched = False
for query_name, query_config in action_config.items():
try:
self.logger.debug('Found the following query: {}'.format(
query_config['query']))
self.query_variables = {}
self.query_variables['input'] = {}
# Render query
try:
# Prepare the template
self.template = Template(query_config['query'])
# Find variables in the template
self.template_env = Environment()
self.template_parsed = self.template_env.parse(
query_config['query'])
# Grab all the variales from the template and try to find them in the description
self.template_vars = meta.find_undeclared_variables(
self.template_parsed)
self.logger.debug(
"Found the following variables in query: {}".format(
self.template_vars))
for template_var in self.template_vars:
# Skip dynamically generated Stop_time variable
if template_var == "Stop_Time":
continue
self.logger.debug(
"Looking up variable required for template: {}".
format(template_var))
# Replace the underscore from the variable name to a white space as this is used in the description table
self.template_var_with_ws = template_var.replace(
"_", " ")
self.case_data = self.TheHiveConnector.getCase(
self.case_id)
self.logger.debug('output for get_case: {}'.format(
self.case_data))
self.query_variables['input'][
template_var] = self.TheHiveAutomators.fetchValueFromMDTable(
self.case_data['description'],
self.template_var_with_ws)
if 'Start_Time' not in self.query_variables['input']:
self.logger.warning(
"Could not find Start Time value required to build the search"
)
# Parse times required for the query (with or without offset)
if template_var == "Start_Time":
self.logger.debug(
"Found Start Time: %s" %
self.query_variables['input']['Start_Time'])
if 'start_time_offset' in query_config:
self.query_variables['input'][
'Start_Time'] = self.parseTimeOffset(
self.query_variables['input']
['Start_Time'],
self.cfg.get(
'Automation',
'event_start_time_format'),
query_config['start_time_offset'],
self.cfg.get('QRadar', 'time_format'))
else:
self.query_variables['input'][
'Start_Time'] = self.query_variables[
'input']['Start_Time']
if 'stop_time_offset' in query_config:
self.query_variables['input'][
'Stop_Time'] = self.parseTimeOffset(
self.query_variables['input']
['Start_Time'],
self.cfg.get(
'Automation',
'event_start_time_format'),
query_config['stop_time_offset'],
self.cfg.get('QRadar', 'time_format'))
else:
self.query_variables['input'][
'Stop_Time'] = datetime.now().strftime(
self.cfg.get(
'Automation',
'event_start_time_format'))
self.rendered_query = self.template.render(
self.query_variables['input'])
self.logger.debug("Rendered the following query: %s" %
self.rendered_query)
except Exception as e:
self.logger.warning(
"Could not render query due to missing variables",
exc_info=True)
continue
# Perform search queries
try:
self.rendered_query_result = self.QRadarConnector.aqlSearch(
self.rendered_query)
# Check results
self.logger.debug(
'The search result returned the following information: \n %s'
% self.rendered_query_result)
except Exception as e:
self.logger.warning("Could not perform query",
exc_info=True)
continue
try:
if query_config['create_thehive_task']:
self.logger.debug("create task is enabled")
# Task name
self.uc_task_title = query_config['thehive_task_title']
self.uc_task_description = "The following information is found. Investigate the results and act accordingly:\n\n\n\n"
# create a table header
self.table_header = "|"
self.rows = "|"
if len(self.rendered_query_result['events']) != 0:
for key in self.rendered_query_result['events'][
0].keys():
self.table_header = self.table_header + " %s |" % key
self.rows = self.rows + "---|"
self.table_header = self.table_header + "\n" + self.rows + "\n"
self.uc_task_description = self.uc_task_description + self.table_header
# Create the data table for the results
for event in self.rendered_query_result['events']:
self.table_data_row = "|"
for field_key, field_value in event.items():
# Escape pipe signs
if field_value:
field_value = field_value.replace(
"|", "|")
# Use to create some additional spacing
self.table_data_row = self.table_data_row + " %s |" % field_value
self.table_data_row = self.table_data_row + "\n"
self.uc_task_description = self.uc_task_description + self.table_data_row
else:
self.uc_task_description = self.uc_task_description + "No results \n"
# Add the case task
self.uc_task = self.TheHiveAutomators.craftUcTask(
self.uc_task_title, self.uc_task_description)
self.TheHiveConnector.createTask(
self.case_id, self.uc_task)
except Exception as e:
self.logger.debug(e)
pass
try:
if query_config['create_ioc']:
self.logger.debug("create IOC is enabled")
self.comment = "offense enrichment"
#static tags list
self.tags = ['synapse']
#want to add SECID of the rule as well in the tag
rule_secid = [
x for x in webhook.data['object']['tags']
if x.startswith('SEC')
]
self.tags.extend(rule_secid)
self.uc_ioc_type = query_config['ioc_type']
if len(self.rendered_query_result['events']) != 0:
for event in self.rendered_query_result['events']:
for field_key, field_value in event.items():
self.TheHiveConnector.addObservable(
self.case_id, self.uc_ioc_type,
list(field_value.split(",")),
self.tags, self.comment)
except Exception as e:
self.logger.debug(e)
pass
except Exception as e:
self.logger.debug(
'Could not process the following query: {}\n{}'.format(
query_config, e))
continue
# Return True when succesful
return True
def enrichAlert(self, action_config, webhook):
# Only continue if the right webhook is triggered
if webhook.isNewAlert():
pass
else:
return False
# Define variables and actions based on certain webhook types
# Alerts
self.alert_id = webhook.data['object']['id']
self.alert_description = webhook.data['object']['description']
self.query_variables = {}
self.query_variables['input'] = {}
self.enriched = False
# Prepare search queries for searches
for query_name, query_config in action_config.items():
try:
self.logger.info('Found the following query: %s' %
(query_name))
self.query_variables[query_name] = {}
# Render query
try:
# Prepare the template
self.template = Template(query_config['query'])
# Find variables in the template
self.template_env = Environment()
self.template_parsed = self.template_env.parse(
query_config['query'])
# Grab all the variales from the template and try to find them in the description
self.template_vars = meta.find_undeclared_variables(
self.template_parsed)
self.logger.debug(
"Found the following variables in query: {}".format(
self.template_vars))
for template_var in self.template_vars:
# Skip dynamically generated Stop_time variable
if template_var == "Stop_Time":
continue
self.logger.debug(
"Looking up variable required for template: {}".
format(template_var))
# Replace the underscore from the variable name to a white space as this is used in the description table
self.template_var_with_ws = template_var.replace(
"_", " ")
self.alert_data = self.TheHiveConnector.getAlert(
self.alert_id)
self.logger.debug('output for get_alert: {}'.format(
self.alert_data))
self.query_variables['input'][
template_var] = self.TheHiveAutomators.fetchValueFromMDTable(
self.alert_data['description'],
self.template_var_with_ws)
# Parse times required for the query (with or without offset)
if template_var == "Start_Time":
self.logger.debug(
"Found Start Time: %s" %
self.query_variables['input']['Start_Time'])
if 'start_time_offset' in query_config:
self.query_variables['input'][
'Start_Time'] = self.parseTimeOffset(
self.query_variables['input']
['Start_Time'],
self.cfg.get(
'Automation',
'event_start_time_format'),
query_config['start_time_offset'],
self.cfg.get('QRadar', 'time_format'))
else:
self.query_variables['input'][
'Start_Time'] = self.query_variables[
'input']['Start_Time']
if 'stop_time_offset' in query_config:
self.query_variables['input'][
'Stop_Time'] = self.parseTimeOffset(
self.query_variables['input']
['Start_Time'],
self.cfg.get(
'Automation',
'event_start_time_format'),
query_config['stop_time_offset'],
self.cfg.get('QRadar', 'time_format'))
else:
self.query_variables['input'][
'Stop_Time'] = datetime.now().strftime(
self.cfg.get(
'Automation',
'event_start_time_format'))
if not self.query_variables['input']['Start_Time']:
self.logger.warning("Could not find Start Time value ")
raise GetOutOfLoop
self.query_variables[query_name][
'query'] = self.template.render(
self.query_variables['input'])
self.logger.debug(
"Rendered the following query: %s" %
self.query_variables[query_name]['query'])
except Exception as e:
self.logger.warning(
"Could not render query due to missing variables",
exc_info=True)
raise GetOutOfLoop
# Perform search queries
try:
self.query_variables[query_name][
'result'] = self.QRadarConnector.aqlSearch(
self.query_variables[query_name]['query'])
except Exception as e:
self.logger.warning("Could not perform query",
exc_info=True)
raise GetOutOfLoop
# Check results
self.logger.debug(
'The search result returned the following information: \n %s'
% self.query_variables[query_name]['result'])
# making enrichment results presentable
clean_enrichment_results = self.TheHiveAutomators.make_it_presentable(
self.query_variables[query_name]['result']['events'][0]
['enrichment_result'])
# Add results to description
success = self.enrichAlertDescription(
self.alert_data['description'], query_name,
self.query_variables[query_name]['result']['events'][0]
['enrichment_result'])
if not success:
self.logger.warning(
"Could not add results from the query to the description. Error: {}"
.format(e))
raise GetOutOfLoop
except GetOutOfLoop:
pass
return True
class Automators(Main):
def __init__(self, cfg, use_case_config):
self.logger = logging.getLogger(__name__)
self.logger.info('Initiating The Hive Automator')
self.cfg = cfg
self.TheHiveConnector = TheHiveConnector(cfg)
if self.cfg.getboolean('Cortex', 'enabled'):
self.CortexConnector = CortexConnector(cfg)
#Read mail config
self.mailsettings = self.cfg.get('TheHive', 'mail')
'''
Can be used to check if there is a match between tags and the provided list.
Useful for checking if there is a customer tag (having a list of customers) present where only one can match.
'''
def MatchValueAgainstTags(self, tags, list):
for tag in tags:
if tag in list:
return tag
def craftUcTask(self, title, description):
self.logger.debug('%s.craftUcTask starts', __name__)
self.uc_task = CaseTask(title=title, description=description)
return self.uc_task
def createBasicTask(self, action_config, webhook):
#Only continue if the right webhook is triggered
if webhook.isImportedAlert():
pass
else:
return False
#Perform actions for the CreateBasicTask action
self.case_id = webhook.data['object']['case']
self.title = action_config['title']
self.description = action_config['description']
self.logger.info('Found basic task to create: %s' % self.title)
#Create Task
self.uc_task = self.craftUcTask(self.title, self.description)
self.uc_task_id = self.TheHiveConnector.createTask(
self.case_id, self.uc_task)
return True
def createMailTask(self, action_config, webhook):
#Only continue if the right webhook is triggered
if webhook.isImportedAlert():
pass
else:
return False
self.tags = webhook.data['object']['tags']
self.case_id = webhook.data['object']['case']
if self.cfg.getboolean('Automation',
'enable_customer_list',
fallback=False):
self.customer_id = self.MatchValueAgainstTags(
self.tags, self.customers)
self.logger.info('Found customer %s, retrieving recipient' %
self.customer_id)
else:
self.customer_id = None
self.notification_type = "email"
self.title = action_config['title']
self.description = self.renderTemplate(action_config['long_template'],
self.tags,
webhook,
self.notification_type,
customer_id=self.customer_id,
mail_settings=self.mailsettings)
self.logger.info('Found mail task to create: %s' % self.title)
#Create Task
self.ucTask = self.craftUcTask(self.title, self.description)
self.ucTaskId = self.TheHiveConnector.createTask(
self.case_id, self.ucTask)
if 'auto_send_mail' in action_config and action_config[
'auto_send_mail'] and not self.stopsend:
self.logger.info('Sending mail for task with id: %s' %
self.ucTaskId)
self.TheHiveConnector.runResponder(
'case_task', self.ucTaskId,
self.use_case_config['configuration']['mail']['responder_id'])
def runAnalyzer(self, action_config, webhook):
#Automatically run Analyzers for newly created cases where supported IOC's are present
if webhook.isNewArtifact():
self.logger.debug(
'Case artifact found. Checking if observable is of a supported type to automatically fire the analyzer'
)
#Retrieve caseid
self.caseid = webhook.data['rootId']
#List all supported ioc's for the case
self.observable = webhook.data['object']
#When supported, start a cortex analyzer for it
if self.observable['dataType'] in action_config['datatypes']:
self.supported_observable = self.observable['_id']
#Blacklist IP addresses, make sure the blacklist is present
if self.observable[
'dataType'] == "ip" and 'blacklist' in action_config and 'ip' in action_config[
'blacklist']:
for entry in action_config['blacklist']['ip']:
#Initial values
match = False
observable_ip = ipaddress.ip_address(
self.observable['data'])
#Match ip with CIDR syntax
if entry[-3:] == "/32":
bl_entry = ipaddress.ip_address(entry[:-3])
match = observable_ip == bl_entry
#Match ip without CIDR syntax
elif "/" not in entry:
bl_entry = ipaddress.ip_address(entry)
match = observable_ip == bl_entry
#Capture actual network entries
else:
bl_entry = ipaddress.ip_network(entry,
strict=False)
match = observable_ip in bl_entry
#If matched add it to new entries to use outside of the loop
if match:
self.logger.debug(
"Observable {} has matched {} of blacklist. Ignoring..."
.format(self.observable['data'], entry))
return
#Trigger a search for the supported ioc
self.logger.debug(
'Launching analyzers for observable: {}'.format(
self.observable['_id']))
self.TheHiveConnector.runAnalyzer(
action_config['cortex_instance'],
self.supported_observable, action_config['analyzer'])
def closeCaseForTaxonomyInAnalyzerResults(self, action_config, webhook):
#If the Job result contains a successful search with minimum of 1 hit, create a task to investigate the results
if webhook.isCaseArtifactJob() and webhook.isSuccess():
#Case ID
self.caseid = webhook.data['rootId']
#Load Case information
self.case_data = self.TheHiveConnector.getCase(self.caseid)
self.logger.debug('Job {} has just finished'.format(
webhook.data['object']['cortexJobId']))
#Check if the result count higher than 0
if webhook.data['object']['report']['summary']['taxonomies'][0][
'level'] in action_config["taxonomy_level"]:
self.logger.info(
'Job {} has configured taxonomy level, checking if a task is already present for this observable'
.format(webhook.data['object']['cortexJobId']))
#Check if task is present for investigating the new results
if self.case_data['status'] != "Resolved":
self.logger.info(
'Case is not yet closed, closing case for {} now...'.
format(webhook.data['object']['cortexJobId']))
#Close the case
self.TheHiveConnector.closeCase(self.caseid)
self.report_action = 'closeCase'
return self.report_action
def createTaskForTaxonomyinAnalyzerResults(self, action_config, webhook):
#If the Job result contains a successful search with minimum of 1 hit, create a task to investigate the results
if webhook.isCaseArtifactJob() and webhook.isSuccess():
#Case ID
self.caseid = webhook.data['rootId']
#Load Case information
self.case_data = self.TheHiveConnector.getCase(self.caseid)
self.logger.debug('Job {} has just finished'.format(
webhook.data['object']['cortexJobId']))
#Check if the result count higher than 0
if webhook.data['object']['report']['summary']['taxonomies'][0][
'level'] in action_config["taxonomy_level"]:
self.logger.info(
'Job {} has configured taxonomy level, checking if a task is already present for this observable'
.format(webhook.data['object']['cortexJobId']))
#Retrieve case task information
self.response = self.TheHiveConnector.getCaseTasks(self.caseid)
self.case_tasks = self.response.json()
#Load CaseTask template
self.casetask = CaseTask()
#Observable + Link
self.observable = webhook.data['object']['artifactId']
self.observable_link = self.cfg.get(
'Automation', 'hive_url', fallback="https://localhost"
) + "/index.html#!/case/" + self.caseid + "/observables/" + webhook.data[
'object']['artifactId']
#Task name
self.casetask.title = "{} {}".format(action_config['title'],
self.observable)
#Date
self.date_found = time.strftime("%d-%m-%Y %H:%M")
self.case_task_found = False
for case_task in self.case_tasks:
#Check if task is present for investigating the new results
if self.casetask.title == case_task['title']:
self.case_task_found = True
if not self.case_task_found:
self.logger.info(
'No task found, creating task for observable found in job {}'
.format(webhook.data['object']['cortexJobId']))
#Add description
self.casetask.description = action_config['description']
self.casetask.description = self.casetask.description + "\n\n {} is seen on {}\n".format(
self.observable_link, self.date_found)
#Check if case is closed
if self.case_data['status'] == "Resolved":
#Create a Case object
case = Case()
#Add the case id to the object
case.id = self.caseid
self.logger.info('Updating case %s' % case.id)
#Define which fields need to get updated
fields = ['status']
#Reopen the case
case.status = "Open"
#Update the case
self.TheHiveConnector.updateCase(case, fields)
#Add the case task
self.TheHiveConnector.createTask(self.caseid,
self.casetask)
self.report_action = 'createTask'
return self.report_action