mirror of
https://github.com/aljazceru/CTFd.git
synced 2025-12-17 05:54:19 +01:00
b8d0f80d01
2.2.0 / 2019-12-22
==================
## Notice
2.2.0 focuses on updating the front end of CTFd to use more modern programming practices and changes some aspects of core CTFd design. If your current installation is using a custom theme or custom plugin with ***any*** kind of JavaScript, it is likely that you will need to upgrade that theme/plugin to be useable with v2.2.0.
**General**
* Team size limits can now be enforced from the configuration panel
* Access tokens functionality for API usage
* Admins can now choose how to deliver their notifications
* Toast (new default)
* Alert
* Background
* Sound On / Sound Off
* There is now a notification counter showing how many unread notifications were received
* Setup has been redesigned to have multiple steps
* Added Description
* Added Start time and End time,
* Added MajorLeagueCyber integration
* Added Theme and color selection
* Fixes issue where updating dynamic challenges could change the value to an incorrect value
* Properly use a less restrictive regex to validate email addresses
* Bump Python dependencies to latest working versions
* Admins can now give awards to team members from the team's admin panel page
**API**
* Team member removals (`DELETE /api/v1/teams/[team_id]/members`) from the admin panel will now delete the removed members's Submissions, Awards, Unlocks
**Admin Panel**
* Admins can now user a color input box to specify a theme color which is injected as part of the CSS configuration. Theme developers can use this CSS value to change colors and styles accordingly.
* Challenge updates will now alert you if the challenge doesn't have a flag
* Challenge entry now allows you to upload files and enter simple flags from the initial challenge creation page
**Themes**
* Significant JavaScript and CSS rewrite to use ES6, Webpack, yarn, and babel
* Theme asset specially generated URLs
* Static theme assets are now loaded with either .dev.extension or .min.extension depending on production or development (i.e. debug server)
* Static theme assets are also given a `d` GET parameter that changes per server start. Used to bust browser caches.
* Use `defer` for script tags to not block page rendering
* Only show the MajorLeagueCyber button if configured in configuration
* The admin panel now links to https://help.ctfd.io/ in the top right
* Create an `ezToast()` function to use [Bootstrap's toasts](https://getbootstrap.com/docs/4.3/components/toasts/)
* The user-facing navbar now features icons
* Awards shown on a user's profile can now have award icons
* The default MarkdownIt render created by CTFd will now open links in new tabs
* Country flags can now be shown on the user pages
**Deployment**
* Switch `Dockerfile` from `python:2.7-alpine` to `python:3.7-alpine`
* Add `SERVER_SENT_EVENTS` config value to control whether Notifications are enabled
* Challenge ID is now recorded in the submission log
**Plugins**
* Add an endpoint parameter to `register_plugin_assets_directory()` and `register_plugin_asset()` to control what endpoint Flask uses for the added route
**Miscellaneous**
* `CTFd.utils.email.sendmail()` now allows the caller to specify subject as an argument
* The subject allows for injecting custom variable via the new `CTFd.utils.formatters.safe_format()` function
* Admin user information is now error checked during setup
* Added yarn to the toolchain and the yarn dev, yarn build, yarn verify, and yarn clean scripts
* Prevent old CTFd imports from being imported
195 lines
6.8 KiB
Python
195 lines
6.8 KiB
Python
from tests.helpers import create_ctfd, destroy_ctfd
|
|
from CTFd.utils import get_config, set_config
|
|
from CTFd.utils.email import sendmail, verify_email_address
|
|
from freezegun import freeze_time
|
|
from mock import patch, Mock
|
|
from email.mime.text import MIMEText
|
|
import requests
|
|
|
|
|
|
@patch("smtplib.SMTP")
|
|
def test_sendmail_with_smtp_from_config_file(mock_smtp):
|
|
"""Does sendmail work properly with simple SMTP mail servers using file configuration"""
|
|
app = create_ctfd()
|
|
with app.app_context():
|
|
app.config["MAIL_SERVER"] = "localhost"
|
|
app.config["MAIL_PORT"] = "25"
|
|
app.config["MAIL_USEAUTH"] = "True"
|
|
app.config["MAIL_USERNAME"] = "username"
|
|
app.config["MAIL_PASSWORD"] = "password"
|
|
|
|
from_addr = get_config("mailfrom_addr") or app.config.get("MAILFROM_ADDR")
|
|
to_addr = "user@user.com"
|
|
msg = "this is a test"
|
|
|
|
sendmail(to_addr, msg)
|
|
|
|
ctf_name = get_config("ctf_name")
|
|
email_msg = MIMEText(msg)
|
|
email_msg["Subject"] = "Message from {0}".format(ctf_name)
|
|
email_msg["From"] = from_addr
|
|
email_msg["To"] = to_addr
|
|
|
|
mock_smtp.return_value.sendmail.assert_called_once_with(
|
|
from_addr, [to_addr], email_msg.as_string()
|
|
)
|
|
destroy_ctfd(app)
|
|
|
|
|
|
@patch("smtplib.SMTP")
|
|
def test_sendmail_with_smtp_from_db_config(mock_smtp):
|
|
"""Does sendmail work properly with simple SMTP mail servers using database configuration"""
|
|
app = create_ctfd()
|
|
with app.app_context():
|
|
set_config("mail_server", "localhost")
|
|
set_config("mail_port", 25)
|
|
set_config("mail_useauth", True)
|
|
set_config("mail_username", "username")
|
|
set_config("mail_password", "password")
|
|
|
|
from_addr = get_config("mailfrom_addr") or app.config.get("MAILFROM_ADDR")
|
|
to_addr = "user@user.com"
|
|
msg = "this is a test"
|
|
|
|
sendmail(to_addr, msg)
|
|
|
|
ctf_name = get_config("ctf_name")
|
|
email_msg = MIMEText(msg)
|
|
email_msg["Subject"] = "Message from {0}".format(ctf_name)
|
|
email_msg["From"] = from_addr
|
|
email_msg["To"] = to_addr
|
|
|
|
mock_smtp.return_value.sendmail.assert_called_once_with(
|
|
from_addr, [to_addr], email_msg.as_string()
|
|
)
|
|
destroy_ctfd(app)
|
|
|
|
|
|
@patch.object(requests, "post")
|
|
def test_sendmail_with_mailgun_from_config_file(fake_post_request):
|
|
"""Does sendmail work properly with Mailgun using file configuration"""
|
|
app = create_ctfd()
|
|
with app.app_context():
|
|
app.config["MAILGUN_API_KEY"] = "key-1234567890-file-config"
|
|
app.config["MAILGUN_BASE_URL"] = "https://api.mailgun.net/v3/file.faked.com"
|
|
|
|
from_addr = get_config("mailfrom_addr") or app.config.get("MAILFROM_ADDR")
|
|
to_addr = "user@user.com"
|
|
msg = "this is a test"
|
|
|
|
sendmail(to_addr, msg)
|
|
|
|
ctf_name = get_config("ctf_name")
|
|
email_msg = MIMEText(msg)
|
|
email_msg["Subject"] = "Message from {0}".format(ctf_name)
|
|
email_msg["From"] = from_addr
|
|
email_msg["To"] = to_addr
|
|
|
|
fake_response = Mock()
|
|
fake_post_request.return_value = fake_response
|
|
fake_response.status_code = 200
|
|
|
|
status, message = sendmail(to_addr, msg)
|
|
|
|
args, kwargs = fake_post_request.call_args
|
|
assert args[0] == "https://api.mailgun.net/v3/file.faked.com/messages"
|
|
assert kwargs["auth"] == ("api", u"key-1234567890-file-config")
|
|
assert kwargs["timeout"] == 1.0
|
|
assert kwargs["data"] == {
|
|
"to": ["user@user.com"],
|
|
"text": "this is a test",
|
|
"from": "CTFd Admin <noreply@ctfd.io>",
|
|
"subject": "Message from CTFd",
|
|
}
|
|
|
|
assert fake_response.status_code == 200
|
|
assert status is True
|
|
assert message == "Email sent"
|
|
destroy_ctfd(app)
|
|
|
|
|
|
@patch.object(requests, "post")
|
|
def test_sendmail_with_mailgun_from_db_config(fake_post_request):
|
|
"""Does sendmail work properly with Mailgun using database configuration"""
|
|
app = create_ctfd()
|
|
with app.app_context():
|
|
app.config["MAILGUN_API_KEY"] = "key-1234567890-file-config"
|
|
app.config["MAILGUN_BASE_URL"] = "https://api.mailgun.net/v3/file.faked.com"
|
|
|
|
# db values should take precedence over file values
|
|
set_config("mailgun_api_key", "key-1234567890-db-config")
|
|
set_config("mailgun_base_url", "https://api.mailgun.net/v3/db.faked.com")
|
|
|
|
from_addr = get_config("mailfrom_addr") or app.config.get("MAILFROM_ADDR")
|
|
to_addr = "user@user.com"
|
|
msg = "this is a test"
|
|
|
|
sendmail(to_addr, msg)
|
|
|
|
ctf_name = get_config("ctf_name")
|
|
email_msg = MIMEText(msg)
|
|
email_msg["Subject"] = "Message from {0}".format(ctf_name)
|
|
email_msg["From"] = from_addr
|
|
email_msg["To"] = to_addr
|
|
|
|
fake_response = Mock()
|
|
fake_post_request.return_value = fake_response
|
|
fake_response.status_code = 200
|
|
|
|
status, message = sendmail(to_addr, msg)
|
|
|
|
args, kwargs = fake_post_request.call_args
|
|
assert args[0] == "https://api.mailgun.net/v3/db.faked.com/messages"
|
|
assert kwargs["auth"] == ("api", u"key-1234567890-db-config")
|
|
assert kwargs["timeout"] == 1.0
|
|
assert kwargs["data"] == {
|
|
"to": ["user@user.com"],
|
|
"text": "this is a test",
|
|
"from": "CTFd Admin <noreply@ctfd.io>",
|
|
"subject": "Message from CTFd",
|
|
}
|
|
|
|
assert fake_response.status_code == 200
|
|
assert status is True
|
|
assert message == "Email sent"
|
|
destroy_ctfd(app)
|
|
|
|
|
|
@patch("smtplib.SMTP")
|
|
@freeze_time("2012-01-14 03:21:34")
|
|
def test_verify_email(mock_smtp):
|
|
"""Does verify_email send emails"""
|
|
app = create_ctfd()
|
|
with app.app_context():
|
|
set_config("mail_server", "localhost")
|
|
set_config("mail_port", 25)
|
|
set_config("mail_useauth", True)
|
|
set_config("mail_username", "username")
|
|
set_config("mail_password", "password")
|
|
set_config("verify_emails", True)
|
|
|
|
from_addr = get_config("mailfrom_addr") or app.config.get("MAILFROM_ADDR")
|
|
to_addr = "user@user.com"
|
|
|
|
verify_email_address(to_addr)
|
|
|
|
# This is currently not actually validated
|
|
msg = (
|
|
"Please click the following link to confirm"
|
|
" your email address for CTFd:"
|
|
" http://localhost/confirm/InVzZXJAdXNlci5jb20i.TxD0vg.28dY_Gzqb1TH9nrcE_H7W8YFM-U"
|
|
)
|
|
|
|
ctf_name = get_config("ctf_name")
|
|
email_msg = MIMEText(msg)
|
|
email_msg["Subject"] = "Message from {0}".format(ctf_name)
|
|
email_msg["From"] = from_addr
|
|
email_msg["To"] = to_addr
|
|
|
|
# Need to freeze time to predict the value of the itsdangerous token.
|
|
# For now just assert that sendmail was called.
|
|
mock_smtp.return_value.sendmail.assert_called_with(
|
|
from_addr, [to_addr], email_msg.as_string()
|
|
)
|
|
destroy_ctfd(app)
|