Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve default configuration and reporting of Bandit email hijacking #20

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Improve default configuration and reporting of Bandit email hijacking #20

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
55da623
Print name to real Bandit settings module
jmurty Jul 24, 2019
f3c7594
Raise exception if BANDIT_EMAIL is unset or empty
jmurty Jul 24, 2019
8f3f7fe
Print emails automatically whitelisted by Bandit
jmurty Jul 24, 2019
0f7d0ff
Avoid potentially risky import of django.conf.settings
jmurty Jul 24, 2019
a22cb40
Drop use of locals()
jmurty Jul 30, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 30 additions & 5 deletions ixc_django_docker/settings/email_bandit.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,19 @@
import os


# When loaded by django-split-settings __name__ gives us the *includer* file's
# name, not the name of this *included* file.
REAL_MODULE_NAME = ".".join([__package__, "email_bandit"])


# Hijack django-post-office backend if project is using that lib...
if 'POST_OFFICE' in locals():
try:
# Lookup of POST_OFFICE setting should fail if post-office isn't used
HIJACKED_EMAIL_BACKEND = POST_OFFICE['BACKENDS']['default']
POST_OFFICE['BACKENDS']['default'] = \
'ixc_django_docker.bandit.HijackedEmailBackend'
# ...otherwise hijack default Django backend
else:
except NameError:
HIJACKED_EMAIL_BACKEND = EMAIL_BACKEND
EMAIL_BACKEND = 'ixc_django_docker.bandit.HijackedEmailBackend'

Expand All @@ -22,7 +29,7 @@
]
else:
BANDIT_EMAIL = None
print("%s: BANDIT_EMAIL = %r" % (__name__, BANDIT_EMAIL))
print("%s: BANDIT_EMAIL = %r" % (REAL_MODULE_NAME, BANDIT_EMAIL))

# Whitelist outgoing emails to these specific addresses or domains to let
# them through, instead of redirecting them to the BANDIT_EMAIL address.
Expand All @@ -34,9 +41,27 @@
for wl in os.environ['BANDIT_WHITELIST'].split(',')
if wl.strip()
]
print("%s: BANDIT_WHITELIST = %r" % (__name__, BANDIT_WHITELIST))
else:
print("%s: BANDIT_WHITELIST is not set" % __name__)
BANDIT_WHITELIST = []
print("%s: BANDIT_WHITELIST = %r" % (REAL_MODULE_NAME, BANDIT_WHITELIST))

# Print the additional emails whitelisted by Bandit by default, to make it
# clearer that this is what Bandit does. See logic in
# `bandit.backends.base:HijackBackendMixin.send_messages()`
admin_emails = [email for name, email in ADMINS]
extra_whitelisted = admin_emails + [SERVER_EMAIL]
print(
"%s: Emails automatically whitelisted by Bandit, from `settings.ADMINS` and"
" `settings.SERVER_EMAIL` = %r" % (REAL_MODULE_NAME, extra_whitelisted)
)

# Ensure that BANDIT_EMAIL is set appropriately: it is always required and
# must contain at least one value
if not BANDIT_EMAIL:
raise ValueError(
"BANDIT_EMAIL environment variable must be set with at least one"
" email address. If you do not want to hijack email, remove"
" 'email_bandit.py' from the BASE_SETTINGS environment variable")

# Make it clear that emails have been hijacked and from which site.
# NOTE: This only applies to emails sent with admin-specific methods:
Expand Down