forked from thinkst/canarytokens
-
Notifications
You must be signed in to change notification settings - Fork 0
/
channel_output_email.py
235 lines (197 loc) · 9.29 KB
/
channel_output_email.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
"""
Output channel that sends emails. Relies on Mandrill, Sendgrid or SMTP to actually send mails.
"""
import settings
import pprint
from twisted.logger import Logger
log = Logger()
import mandrill
import requests
from htmlmin import minify
from httpd_site import env
from channel import OutputChannel
from constants import OUTPUT_CHANNEL_EMAIL
import sendgrid
from sendgrid.helpers.mail import *
from email.mime.text import MIMEText
import smtplib
try:
# Python 3
import urllib.request as urllib
except ImportError:
# Python 2
import urllib2 as urllib
class EmailOutputChannel(OutputChannel):
CHANNEL = OUTPUT_CHANNEL_EMAIL
DESCRIPTION = 'Canarytoken triggered'
TIME_FORMAT = '%Y-%m-%d %H:%M:%S (UTC)'
def format_report_html(self,):
"""Returns a string containing an incident report in HTML,
suitable for emailing"""
# Use the Flask app context to render the emails
# (this generates the urls + schemes correctly)
rendered_html = env.get_template('emails/notification.html').render(
Title=self.DESCRIPTION,
Intro=self.format_report_intro(),
BasicDetails=self.get_basic_details(),
ManageLink=self.data['manage'],
HistoryLink=self.data['history']
)
return minify(rendered_html)
def format_report_intro(self,):
if self.data['channel'] == 'HTTP' or self.data['channel'] == 'AWS API Key Token':
template = ("An {Type} Canarytoken has been triggered")
else:
template = ("A {Type} Canarytoken has been triggered")
if 'src_ip' in self.data:
template += " by the Source IP {src}.".format(src=self.data['src_ip'])
if self.data['channel'] == 'DNS':
template += "\n\nPlease note that the source IP refers to a DNS server," \
" rather than the host that triggered the token. "
if self.data['channel'] == 'DNS' and self.data.get('tokentype') == "my_sql":
template = ("Your MySQL token was tripped, but the attackers machine was unable to connect " +
"to the server directly. Instead, we can tell that it happened, and merely report " +
"on their DNS server. Source IP therefore refers to the DNS server used by the attacker.")
return template.format(
Type=self.data['channel'])
def get_basic_details(self,):
vars = { 'Description' : self.data['description'],
'Channel' : self.data['channel'],
'Time' : self.data['time'],
'Canarytoken' : self.data['canarytoken']
}
if 'src_ip' in self.data:
vars['src_ip'] = self.data['src_ip']
vars['SourceIP'] = self.data['src_ip']
if 'useragent' in self.data:
vars['User-Agent'] = self.data['useragent']
if 'tokentype' in self.data:
vars['TokenType'] = self.data['tokentype']
if 'referer' in self.data:
vars['Referer'] = self.data['referer']
if 'location' in self.data:
try:
vars['Location'] = self.data['location'].decode('utf-8')
except Exception:
vars['Location'] = self.data['location']
if 'log4_shell_computer_name' in self.data:
vars['Log4JComputerName'] = self.data['log4_shell_computer_name']
return vars
def do_send_alert(self, input_channel=None, canarydrop=None, **kwargs):
msg = input_channel.format_canaryalert(
params={'subject_required':True,
'from_display_required':True,
'from_address_required':True},
canarydrop=canarydrop,
**kwargs)
self.data = msg
if 'type' in canarydrop._drop:
self.data['tokentype'] = canarydrop._drop['type']
self.data['canarytoken'] = canarydrop['canarytoken']
self.data['description'] = unicode(canarydrop['memo'], "utf8") if canarydrop['memo'] is not None else ''
if settings.MAILGUN_DOMAIN_NAME and settings.MAILGUN_API_KEY:
self.mailgun_send(msg=msg,canarydrop=canarydrop)
elif settings.MANDRILL_API_KEY:
self.mandrill_send(msg=msg,canarydrop=canarydrop)
elif settings.SENDGRID_API_KEY:
self.sendgrid_send(msg=msg,canarydrop=canarydrop)
elif settings.SMTP_SERVER:
self.smtp_send(msg=msg,canarydrop=canarydrop)
else:
log.error("No email settings found")
def mailgun_send(self, msg=None, canarydrop=None):
try:
base_url = 'https://api.mailgun.net'
if settings.MAILGUN_BASE_URL:
base_url = settings.MAILGUN_BASE_URL
url = '{}/v3/{}/messages'.format(base_url, settings.MAILGUN_DOMAIN_NAME)
auth = ('api', settings.MAILGUN_API_KEY)
data = {
'from': '{name} <{address}>'.format(name=msg['from_display'],address=msg['from_address']),
'to': canarydrop['alert_email_recipient'],
'subject': msg['subject'],
'text': msg['body'],
'html': self.format_report_html()
}
if settings.DEBUG:
pprint.pprint(data)
else:
result = requests.post(url, auth=auth, data=data)
#Raise an error if the returned status is 4xx or 5xx
result.raise_for_status()
log.info('Sent alert to {recipient} for token {token}'\
.format(recipient=canarydrop['alert_email_recipient'],
token=canarydrop.canarytoken.value()))
except requests.exceptions.HTTPError as e:
log.error('A mailgun error occurred: %s - %s' % (e.__class__, e))
def mandrill_send(self, msg=None, canarydrop=None):
try:
mandrill_client = mandrill.Mandrill(settings.MANDRILL_API_KEY)
message = {
'auto_html': None,
'auto_text': None,
'from_email': msg['from_address'],
'from_name': msg['from_display'],
'text': msg['body'],
'html':self.format_report_html(),
'subject': msg['subject'],
'to': [{'email': canarydrop['alert_email_recipient'],
'name': '',
'type': 'to'}],
}
if settings.DEBUG:
pprint.pprint(message)
else:
result = mandrill_client.messages.send(
message=message,
send_async=False,
ip_pool='Main Pool'
)
log.info('Sent alert to {recipient} for token {token}'\
.format(recipient=canarydrop['alert_email_recipient'],
token=canarydrop.canarytoken.value()))
except mandrill.Error as e:
# Mandrill errors are thrown as exceptions
log.error('A mandrill error occurred: %s - %s' % (e.__class__, e))
# A mandrill error occurred: <class 'mandrill.UnknownSubaccountError'> - No subaccount exists with the id 'customer-123'....
def sendgrid_send(self, msg=None, canarydrop=None):
try:
sg = sendgrid.SendGridAPIClient(apikey=settings.SENDGRID_API_KEY)
from_email = Email(msg['from_address'], msg['from_display'])
subject = msg['subject']
to_email = Email(canarydrop['alert_email_recipient'])
text = msg['body']
content = Content("text/html", self.format_report_html())
mail = Mail(from_email, subject, to_email, content)
if settings.DEBUG:
pprint.pprint(mail)
else:
response = sg.client.mail.send.post(request_body=mail.get())
log.info('Sent alert to {recipient} for token {token}'\
.format(recipient=canarydrop['alert_email_recipient'],
token=canarydrop.canarytoken.value()))
except urllib.HTTPError as e:
log.error('A sendgrid error occurred: %s - %s' % (e.__class__, e))
def smtp_send(self, msg=None, canarydrop=None):
try:
fromaddr = msg['from_address']
toaddr = canarydrop['alert_email_recipient']
smtpmsg = MIMEText(msg['body'])
smtpmsg['From'] = fromaddr
smtpmsg['To'] = toaddr
smtpmsg['Subject'] = msg['subject']
if settings.DEBUG:
pprint.pprint(message)
else:
server = smtplib.SMTP(settings.SMTP_SERVER, settings.SMTP_PORT)
server.ehlo()
server.starttls()
server.ehlo()
server.login(settings.SMTP_USERNAME, settings.SMTP_PASSWORD)
text = smtpmsg.as_string()
server.sendmail(fromaddr, toaddr, text)
log.info('Sent alert to {recipient} for token {token}'\
.format(recipient=canarydrop['alert_email_recipient'],
token=canarydrop.canarytoken.value()))
except smtplib.SMTPException as e:
log.error('A smtp error occurred: %s - %s' % (e.__class__, e))