-
Notifications
You must be signed in to change notification settings - Fork 2
/
dxl_bot.py
260 lines (209 loc) · 8.77 KB
/
dxl_bot.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
# -*- coding: utf-8 -*-
import os
import logging
import re
import time
from slackclient import SlackClient
from dxlclient.client import DxlClient
from dxlclient.client_config import DxlClientConfig
from dxltieclient import TieClient
from dxltieclient.constants import HashType, FileProvider
# Enable logging, this will also direct built-in DXL log messages.
# See - https://docs.python.org/2/howto/logging-cookbook.html
log_formatter = logging.Formatter('%(asctime)s %(name)s - %(levelname)s - %(message)s')
console_handler = logging.StreamHandler()
console_handler.setFormatter(log_formatter)
logger = logging.getLogger()
logger.addHandler(console_handler)
logger.setLevel(logging.INFO)
# DXL Client Configuration
CONFIG_FILE_NAME = "/vagrant/dxlclient.config"
if not os.path.isfile(CONFIG_FILE_NAME):
CONFIG_FILE_NAME = os.path.dirname(os.path.abspath(__file__)) + "/dxlclient.config"
# Create DXL configuration from file
config = DxlClientConfig.create_dxl_config_from_file(CONFIG_FILE_NAME)
# instantiate Slack & Twilio clients
slack_client = SlackClient(os.environ.get('SLACK_BOT_TOKEN'))
def is_sha1(maybe_sha):
# Check if it is a SHA1
if len(maybe_sha) != 40:
return False
try:
int(maybe_sha, 16)
except ValueError:
return False
return True
def is_sha256(maybe_sha):
# Check if it is a SHA256
if len(maybe_sha) != 64:
return False
try:
int(maybe_sha, 16)
except ValueError:
return False
return True
def is_md5(maybe_md5):
# Check if it is an MD5
if len(maybe_md5) != 32:
return False
try:
md5_int = int(maybe_md5, 16)
except ValueError:
return False
return True
# TIE Reputation Average Map
tiescoreMap = {0: 'Not Set', 1: 'Known Malicious', 15: 'Most Likely Malicious', 30: 'Might Be Malicious', 50: 'Unknown',
70: "Might Be Trusted", 85: "Most Likely Trusted", 99: "Known Trusted", 100: "Known Trusted Installer"}
# TIE Provider Map
providerMap = {1: 'GTI', 3: 'Enterprise Reputation', 5: 'ATD', 7: "MWG"}
def getFileProps(fileProps):
# Get File Properties and Map with Providers and TIE Score
propList = []
if FileProvider.GTI in fileProps:
propDict = {}
propDict['provider'] = providerMap[fileProps[FileProvider.GTI]['providerId']]
propDict['reputation'] = tiescoreMap[fileProps[FileProvider.GTI]['trustLevel']]
propDict['createDate'] = fileProps[FileProvider.GTI]['createDate']
propList.append(propDict)
if FileProvider.ENTERPRISE in fileProps:
propDict = {}
propDict['provider'] = providerMap[fileProps[FileProvider.ENTERPRISE]['providerId']]
propDict['reputation'] = tiescoreMap[fileProps[FileProvider.ENTERPRISE]['trustLevel']]
propDict['createDate'] = fileProps[FileProvider.ENTERPRISE]['createDate']
propList.append(propDict)
if FileProvider.ATD in fileProps:
propDict = {}
propDict['provider'] = providerMap[fileProps[FileProvider.ATD]['providerId']]
propDict['reputation'] = tiescoreMap[fileProps[FileProvider.ATD]['trustLevel']]
propDict['createDate'] = fileProps[FileProvider.ATD]['createDate']
propList.append(propDict)
if FileProvider.MWG in fileProps:
propDict = {}
propDict['provider'] = providerMap[fileProps[FileProvider.MWG]['providerId']]
propDict['reputation'] = tiescoreMap[fileProps[FileProvider.MWG]['trustLevel']]
propDict['createDate'] = fileProps[FileProvider.MWG]['createDate']
propList.append(propDict)
return propList
def getTieRep(tie_client, md5, sha1, sha256, ):
#
# Request and display reputation for notepad.exe
#
if md5:
reputations_dict = tie_client.get_file_reputation({HashType.MD5: md5})
if sha1:
reputations_dict = tie_client.get_file_reputation({HashType.SHA1: sha1})
if sha256:
reputations_dict = tie_client.get_file_reputation({HashType.SHA256: sha256})
return reputations_dict
def get_bot_id():
"""
Use the environment variable BOT_NAME to get the BOT ID from
Slack and returns the BOT ID
"""
BOT_NAME = os.environ.get('BOT_NAME')
api_call = slack_client.api_call("users.list")
if api_call.get('ok'):
# retrieve all users so we can find our bot
users = api_call.get('members')
for user in users:
if 'name' in user and user.get('name') == BOT_NAME:
return user.get('id')
else:
print("could not find bot user with the name " + BOT_NAME)
def handle_command(command, channel):
"""
Receives commands directed at the bot and determines if they
are valid commands. If so, then acts on the commands. If not,
returns back what it needs for clarification.
"""
response = "Not sure what you mean. Use the *" + EXAMPLE_COMMAND + \
"* command with numbers, delimited by spaces."
if command.startswith(EXAMPLE_COMMAND):
response = "Sure...write some more code then I can do that!"
slack_client.api_call("chat.postMessage", channel=channel,
text=response, as_user=True)
def parse_slack_output(slack_rtm_output):
"""
The Slack Real Time Messaging API is an events firehose.
this parsing function returns None unless a message is
directed at the Bot, based on its ID.
"""
output_list = slack_rtm_output
if output_list and len(output_list) > 0:
for output in output_list:
if output and 'text' in output and AT_BOT in output['text']:
# return text after the @ mention, whitespace removed
return output['text'].split(AT_BOT)[1].strip().lower(), \
output['channel']
return None, None
def getFileRep(tie_client, md5=None, sha1=None, sha256=None):
if md5 == None and sha1 == None and sha256 == None:
return "no file hash"
else:
# Verify SHA1 string
if sha1 != None:
if not is_sha1(sha1):
return "invalid sha1"
# Verify SHA256 string
if sha256 != None:
if not is_sha256(sha256):
return "invalid sha256"
if md5 != None:
if not is_md5(md5):
return "invalid md5"
return getTieRep(tie_client, md5, sha1, sha256)
def convertEpoc(myTime):
return time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(myTime))
def takeAction(commandStr, channel, tie_client):
checkTie = re.compile('check\s+md5\s+[a-f0-9]{32}\s*')
print commandStr
if checkTie.match(commandStr):
response = "Looking up md5 hash ..."
slack_client.api_call("chat.postMessage", channel=channel,
text=response, as_user=True)
md5 = re.search('check\s+md5\s+([a-f0-9]{32})', commandStr)
if md5:
myHash = md5.group(1)
if is_md5(myHash):
response = getFileRep(tie_client, myHash)
content = getFileProps(response)
slackResponse = "File Hash *" + myHash + "* Reputation\n"
# Format a Slack Response
i = 1
for key in content:
slackResponse = slackResponse + "*Provider: " + key['provider'] + "*\n"
slackResponse = slackResponse + "Creation Date: " + convertEpoc(key['createDate']) + "\n"
slackResponse = slackResponse + "Reputation: " + key['reputation'] + "\n"
slackResponse += "\n"
i += 1
slack_client.api_call("chat.postMessage", channel=channel,
text=slackResponse, as_user=True)
return True
else:
return False
if __name__ == "__main__":
# starterbot's ID as an environment variable
BOT_ID = get_bot_id()
if BOT_ID == None:
print "BOT_NAME is missing from ENV"
exit(0)
# constants
AT_BOT = "<@" + BOT_ID + ">"
EXAMPLE_COMMAND = "do"
READ_WEBSOCKET_DELAY = 1 # 1 second delay between reading from firehose
if slack_client.rtm_connect():
print("StarterBot connected and running!")
# Get the file reputation properties from TIE using md5 or sha1
with DxlClient(config) as client:
# Connect to the fabric
client.connect()
# Create the McAfee Threat Intelligence Exchange (TIE) client
tie_client = TieClient(client)
while True:
command, channel = parse_slack_output(slack_client.rtm_read())
if command and channel:
if takeAction(command, channel, tie_client) == False:
handle_command(command, channel)
time.sleep(READ_WEBSOCKET_DELAY)
else:
print("Connection failed. Invalid Slack token or bot ID?")