def post_request(self, base_url, uri, post_body, access_key, secret_key):
# Create variables required for request headers
request_id = str(uuid.uuid4())
request_date = get_hdr_date()
signature = 'MC ' + access_key + ':' + self.create_signature(':'.join([request_date, request_id, uri, configuration.authenication_details['APP_KEY']]), secret_key)
headers = {'Authorization': signature, 'x-mc-app-id': configuration.authenication_details['APP_ID'], 'x-mc-req-id': request_id, 'x-mc-date': request_date}
try:
# Send request to API
log.debug('Sending request to https://' + base_url + self.event_type + ' with request Id: ' + request_id)
r = requests.post(url='https://' + base_url + uri, data=json.dumps(post_body), headers=headers)
# Handle Rate Limiting
if r.status_code == 429:
log.warn('Rate limit hit. Sleeping for ' + str(r.headers['X-RateLimit-Reset']))
rate_limit = (int(r.headers['X-RateLimit-Reset'])/1000) % 60
time.sleep(rate_limit * 20)
# Handle errors on client side
except Exception as e:
log.error('Unexpected error connecting to API. Exception: ' + str(e))
return 'error'
# Handle errors from API
if r.status_code != 200:
log.error('Request to ' + uri + ' with , request id: ' + request_id + ' returned with status code: ' + str(r.status_code) + ', response body: ' + r.text)
# Return response body and response headers
return r.text, r.headers
def get_ttp_logs():
try:
base_url = connection.get_base_url(
configuration.authenication_details['EMAIL_ADDRESS'])
print(base_url)
except Exception:
log.error(
'Error discovering base url for %s. Please double check configuration.py'
% (configuration.authenication_details['EMAIL_ADDRESS']))
quit()
# Request log data in a loop until there are no more logs to collect
try:
log.info('Getting TTP log data')
while Get_TTPURL_events(
base_url=base_url,
access_key=configuration.authenication_details['ACCESS_KEY'],
secret_key=configuration.authenication_details['SECRET_KEY']
) is True:
print("Getting additional TTP logs after %s seconds" %
(interval_time))
time.sleep(interval_time)
except Exception as e:
log.error('Unexpected error getting TTP logs ' + (str(e)))
quit()
def get_siem_logs():
try:
base_url = connection.get_base_url(configuration.authenication_details['EMAIL_ADDRESS'])
print(base_url)
except Exception:
log.error('Error discovering base url for %s. Please double check configuration.py' % (configuration.authenication_details['EMAIL_ADDRESS']))
quit()
# Request log data in a loop until there are no more logs to collect
try:
log.info('Getting MTA log data')
while get_mta_siem_logs(checkpoint_dir=configuration.logging_details['CHK_POINT_DIR'], base_url=base_url, access_key=configuration.authenication_details['ACCESS_KEY'], secret_key=configuration.authenication_details['SECRET_KEY']) is True:
print("Getting additional SIEM logs")
except Exception as e:
log.error('Unexpected error getting MTA logs ' + (str(e)))
quit()
def get_audit_logs():
try:
base_url = connection.get_base_url(
configuration.authenication_details['EMAIL_ADDRESS'])
except Exception:
log.error(
'Error discovering base url for %s. Please double check configuration.py'
% (configuration.authenication_details['EMAIL_ADDRESS']))
quit()
try:
log.info('Getting Audit log data')
while get_audit_events(
base_url=base_url,
access_key=configuration.authenication_details['ACCESS_KEY'],
secret_key=configuration.authenication_details['SECRET_KEY']
) is True:
log.info("Getting additional Audit logs after %s seconds" %
(interval_time))
time.sleep(interval_time)
except Exception as e:
log.error('Unexpected error getting Audit logs ' + (str(e)))
quit()
def get_mta_siem_logs(checkpoint_dir, base_url, access_key, secret_key):
# Set checkpoint file name to store page token
checkpoint_filename = os.path.join(checkpoint_dir, 'get_mta_siem_logs_checkpoint')
# Build post body for request
post_body = dict()
post_body['data'] = [{}]
post_body['data'][0]['type'] = 'MTA'
if os.path.exists(checkpoint_filename):
post_body['data'][0]['token'] = read_file(checkpoint_filename)
# Send request to API
resp = connection.post_request(base_url, event_type, post_body, access_key, secret_key)
# Process response
if resp != 'error':
resp_body = resp[0]
resp_headers = resp[1]
content_type = resp_headers['Content-Type']
# End if response is JSON as there is no log file to download
if content_type == 'application/json':
log.info('No more SIEM logs available - Resting for 60 seconds')
time.sleep(60)
return True
# Process log file
elif content_type == 'application/octet-stream':
file_name = resp_headers['Content-Disposition'].split('=\"')
file_name = file_name[1][:-1]
# Save file to log file path
write_file(os.path.join(configuration.logging_details['LOG_FILE_PATH'], file_name), resp_body)
# Save mc-siem-token page token to check point directory
write_file(checkpoint_filename, resp_headers['mc-siem-token'])
try:
if configuration.syslog_details['syslog_output'] is True:
log.info('Loading file: ' + os.path.join(configuration.logging_details['LOG_FILE_PATH'], file_name) + ' to output to ' + configuration.syslog_details['syslog_server'] + ':' + str(configuration.syslog_details['syslog_port']))
with open(os.path.join(configuration.logging_details['LOG_FILE_PATH'], file_name), 'r') as log_file:
lines = log_file.read().splitlines()
for line in lines:
syslogger.info(line)
log.info('Syslog output completed for file ' + file_name)
except Exception as e:
log.error('Unexpected error writing to syslog. Exception: ' + str(e))
# return true to continue loop
return True
else:
# Handle errors
log.error('Unexpected response')
for header in resp_headers:
log.error(header)
return False
def get_base_url(self, email_address):
# Create post body for request
post_body = dict()
post_body['data'] = [{}]
post_body['data'][0]['emailAddress'] = email_address
# Create variables required for request headers
request_id = str(uuid.uuid4())
request_date = get_hdr_date()
headers = {'x-mc-app-id': configuration.authenication_details['APP_ID'], 'x-mc-req-id': request_id, 'x-mc-date': request_date}
# Send request to API
log.debug('Sending request to https://api.mimecast.com/api/discover-authentication with request ID: %s' % (request_id))
try:
r = requests.post(url='https://api.mimecast.com/api/login/discover-authentication', data=json.dumps(post_body), headers=headers)
# Handle Rate Limiting
if r.status_code == 429:
rate_limit = (int(r.headers['X-RateLimit-Reset'])/1000) % 60
time.sleep(rate_limit * 20)
except Exception as e:
log.error('Unexpected error getting base url. Cannot continue.' + str(e))
quit()
# Handle error from API
if r.status_code != 200:
log.error('Request returned with status code: ' + str(r.status_code) + ', response body: ' + r.text + '. Cannot continue.')
quit()
# Load response body as JSON
resp_data = json.loads(r.text)
# Look for api key in region region object to get base url
if 'region' in resp_data["data"][0]:
base_url = resp_data["data"][0]["region"]["api"].split('//')
base_url = base_url[1]
else:
# Handle no region found, likely the email address was entered incorrectly
log.error('No region information returned from API, please check the supplied email address in configuration.py. Cannot continue')
quit()
return base_url
def Get_TTPURL_events(base_url, access_key, secret_key):
post_body = dict()
resp = connection.post_request(base_url, event_type, post_body, access_key,
secret_key)
# Process response
if resp != 'error':
resp_body = resp[0]
resp_headers = resp[1]
content_type = resp_headers['Content-Type']
# No more TTP events available
if 'application/json' not in content_type:
log.info('No more TTP URL logs available - Resting for 60 seconds')
time.sleep(60)
return True
# Process log file
elif 'application/json' in content_type:
file_name = 'ttp_events' # Storing everything into one file
rjson = json.loads(resp_body)
resp_body = rjson['data'][0]['clickLogs'] # Get TTP urls
# Forward each event individually
for row in resp_body:
row = str(row).replace(
"'", '"') # Convert audit event to valid JSON
# Save file to log file path
append_file(
os.path.join(
configuration.logging_details['LOG_FILE_PATH'],
file_name), str(row))
try:
if configuration.syslog_details['syslog_output'] is True:
log.info(
'Loading file: ' + os.path.join(
configuration.logging_details['LOG_FILE_PATH'],
file_name) + ' to output to ' +
configuration.syslog_details['syslog_server'] +
':' +
str(configuration.syslog_details['syslog_port']))
with open(
os.path.join(
configuration.
logging_details['LOG_FILE_PATH'],
file_name), 'r') as log_file:
lines = log_file.read().splitlines()
for line in lines:
hashed_event = (hashlib.md5(
line.encode('utf-8')).hexdigest())
with open(
configuration.
logging_details['CHK_POINT_DIR'] +
'hash_file', 'r') as hash_file:
if (hashed_event +
'\n') in hash_file.readlines():
print("Hash %s already exists" %
(hashed_event))
else:
syslogger.info(line)
append_file(
configuration.
logging_details['CHK_POINT_DIR'] +
'hash_file', hashed_event)
log.info('Syslog output completed for file ' +
file_name)
except Exception as e:
log.error(
'Unexpected error writing to syslog. Exception: ' +
str(e))
# Return True to continue loop
return True
else:
# Handle errors
log.error('Unexpected response')
for header in resp_headers:
log.error(header)
return False
def Get_TTPURL_events(base_url, access_key, secret_key):
post_body = dict()
resp = connection.post_request(base_url, event_type, post_body, access_key,
secret_key)
# Process response
if resp != 'error':
resp_body = resp[0]
resp_headers = resp[1]
content_type = resp_headers['Content-Type']
# No more TTP events available
if 'application/json' not in content_type:
log.info('No more TTP URL logs available - Resting temporarily')
time.sleep(interval_time)
return True
# Process log file
elif 'application/json' in content_type:
file_name = 'ttp_events' # Storing everything into one file
rjson = json.loads(resp_body)
resp_body = rjson['data'][0]['clickLogs'] # Get TTP urls
# Forward each event individually
for row in resp_body:
row = str(row).replace(
"'", '"') # Convert audit event to valid JSON
try:
if configuration.syslog_details['syslog_output'] is True:
hashed_event = (hashlib.md5(
row.encode('utf-8')).hexdigest())
if os.path.isfile(configuration.
logging_details['CHK_POINT_DIR'] +
str(event_category) +
str(hashed_event)): # If true
print("Hash already exists in %s" % configuration.
logging_details['CHK_POINT_DIR'] +
str(event_category) + str(hashed_event))
else:
log.info(
"Creating hash %s in %s and forwarding to configured syslog"
%
(hashed_event,
configuration.logging_details['CHK_POINT_DIR']
+ str(event_category)))
os.mknod(configuration.
logging_details['CHK_POINT_DIR'] +
str(event_category) + str(hashed_event))
syslogger.info(row)
log.info("Syslog output completed for %s" %
str(event_category))
except Exception as e:
log.error(
'Unexpected error writing to syslog. Exception: ' +
str(e))
# Return True to continue loop
return True
else:
# Handle errors
log.error('Unexpected response')
for header in resp_headers:
log.error(header)
return False
