mirror of
https://github.com/aljazceru/CTFd.git
synced 2025-12-17 22:14:25 +01:00
adc70fb320
Alpha release of CTFd v3.
# 3.0.0a1 / 2020-07-01
**General**
- CTFd is now Python 3 only
- Render markdown with the CommonMark spec provided by `cmarkgfm`
- Render markdown stripped of any malicious JavaScript or HTML.
- This is a significant change from previous versions of CTFd where any HTML content from an admin was considered safe.
- Inject `Config`, `User`, `Team`, `Session`, and `Plugin` globals into Jinja
- User sessions no longer store any user-specific attributes.
- Sessions only store the user's ID, CSRF nonce, and an hmac of the user's password
- This allows for session invalidation on password changes
- The user facing side of CTFd now has user and team searching
- GeoIP support now available for converting IP addresses to guessed countries
**Admin Panel**
- Use EasyMDE as an improved description/text editor for Markdown enabled fields.
- Media Library button now integrated into EasyMDE enabled fields
- VueJS now used as the underlying implementation for the Media Library
- Fix setting theme color in Admin Panel
- Green outline border has been removed from the Admin Panel
**API**
- Significant overhauls in API documentation provided by Swagger UI and Swagger json
- Make almost all API endpoints provide filtering and searching capabilities
- Change `GET /api/v1/config/<config_key>` to return structured data according to ConfigSchema
**Themes**
- Themes now have access to the `Configs` global which provides wrapped access to `get_config`.
- For example, `{{ Configs.ctf_name }}` instead of `get_ctf_name()` or `get_config('ctf_name')`
- Themes must now specify a `challenge.html` which control how a challenge should look.
- The main library for charts has been changed from Plotly to Apache ECharts.
- Forms have been moved into wtforms for easier form rendering inside of Jinja.
- From Jinja you can access forms via the Forms global i.e. `{{ Forms }}`
- This allows theme developers to more easily re-use a form without having to copy-paste HTML.
- Themes can now provide a theme settings JSON blob which can be injected into the theme with `{{ Configs.theme_settings }}`
- Core theme now includes the challenge ID in location hash identifiers to always refer the right challenge despite duplicate names
**Plugins**
- Challenge plugins have changed in structure to better allow integration with themes and prevent obtrusive Javascript/XSS.
- Challenge rendering now uses `challenge.html` from the provided theme.
- Accessing the challenge view content is now provided by `/api/v1/challenges/<challenge_id>` in the `view` section. This allows for HTML to be properly sanitized and rendered by the server allowing CTFd to remove client side Jinja rendering.
- `challenge.html` now specifies what's required and what's rendered by the theme. This allows the challenge plugin to avoid having to deal with aspects of the challenge besides the description and input.
- A more complete migration guide will be provided when CTFd v3 leaves beta
- Display current attempt count in challenge view when max attempts is enabled
- `get_standings()`, `get_team_stanadings()`, `get_user_standings()` now has a fields keyword argument that allows for specificying additional fields that SQLAlchemy should return when building the response set.
- Useful for gathering additional data when building scoreboard pages
- Flags can now control the message that is shown to the user by raising `FlagException`
- Fix `override_template()` functionality
**Deployment**
- Enable SQLAlchemy's `pool_pre_ping` by default to reduce the likelihood of database connection issues
- Mailgun email settings are now deprecated. Admins should move to SMTP email settings instead.
- Postgres is now considered a second class citizen in CTFd. It is tested against but not a main database backend. If you use Postgres, you are entirely on your own with regards to supporting CTFd.
- Docker image now uses Debian instead of Alpine. See https://github.com/CTFd/CTFd/issues/1215 for rationale.
- `docker-compose.yml` now uses a non-root user to connect to MySQL/MariaDB
- `config.py` should no longer be editting for configuration, instead edit `config.ini` or the environment variables in `docker-compose.yml`
241 lines
8.0 KiB
Python
241 lines
8.0 KiB
Python
from email.message import EmailMessage
|
|
from unittest.mock import Mock, patch
|
|
|
|
import requests
|
|
from freezegun import freeze_time
|
|
|
|
from CTFd.utils import get_config, set_config
|
|
from CTFd.utils.email import (
|
|
sendmail,
|
|
successful_registration_notification,
|
|
verify_email_address,
|
|
)
|
|
from tests.helpers import create_ctfd, destroy_ctfd
|
|
|
|
|
|
@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"
|
|
|
|
ctf_name = get_config("ctf_name")
|
|
from_addr = get_config("mailfrom_addr") or app.config.get("MAILFROM_ADDR")
|
|
from_addr = "{} <{}>".format(ctf_name, from_addr)
|
|
|
|
to_addr = "user@user.com"
|
|
msg = "this is a test"
|
|
|
|
sendmail(to_addr, msg)
|
|
|
|
ctf_name = get_config("ctf_name")
|
|
|
|
email_msg = EmailMessage()
|
|
email_msg.set_content(msg)
|
|
|
|
email_msg["Subject"] = "Message from {0}".format(ctf_name)
|
|
email_msg["From"] = from_addr
|
|
email_msg["To"] = to_addr
|
|
|
|
mock_smtp.return_value.send_message.assert_called()
|
|
assert str(mock_smtp.return_value.send_message.call_args[0][0]) == str(
|
|
email_msg
|
|
)
|
|
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")
|
|
|
|
ctf_name = get_config("ctf_name")
|
|
from_addr = get_config("mailfrom_addr") or app.config.get("MAILFROM_ADDR")
|
|
from_addr = "{} <{}>".format(ctf_name, from_addr)
|
|
|
|
to_addr = "user@user.com"
|
|
msg = "this is a test"
|
|
|
|
sendmail(to_addr, msg)
|
|
|
|
ctf_name = get_config("ctf_name")
|
|
email_msg = EmailMessage()
|
|
email_msg.set_content(msg)
|
|
email_msg["Subject"] = "Message from {0}".format(ctf_name)
|
|
email_msg["From"] = from_addr
|
|
email_msg["To"] = to_addr
|
|
|
|
mock_smtp.return_value.send_message.assert_called()
|
|
assert str(mock_smtp.return_value.send_message.call_args[0][0]) == str(
|
|
email_msg
|
|
)
|
|
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"
|
|
|
|
to_addr = "user@user.com"
|
|
msg = "this is a test"
|
|
|
|
sendmail(to_addr, msg)
|
|
|
|
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 <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")
|
|
|
|
to_addr = "user@user.com"
|
|
msg = "this is a test"
|
|
|
|
sendmail(to_addr, msg)
|
|
|
|
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 <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")
|
|
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)
|
|
|
|
ctf_name = get_config("ctf_name")
|
|
from_addr = get_config("mailfrom_addr") or app.config.get("MAILFROM_ADDR")
|
|
from_addr = "{} <{}>".format(ctf_name, from_addr)
|
|
|
|
to_addr = "user@user.com"
|
|
|
|
with freeze_time("2012-01-14 03:21:34"):
|
|
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 = EmailMessage()
|
|
email_msg.set_content(msg)
|
|
email_msg["Subject"] = "Confirm your account for {ctf_name}".format(
|
|
ctf_name=ctf_name
|
|
)
|
|
email_msg["From"] = from_addr
|
|
email_msg["To"] = to_addr
|
|
|
|
mock_smtp.return_value.send_message.assert_called()
|
|
assert str(mock_smtp.return_value.send_message.call_args[0][0]) == str(
|
|
email_msg
|
|
)
|
|
destroy_ctfd(app)
|
|
|
|
|
|
@patch("smtplib.SMTP")
|
|
def test_successful_registration_email(mock_smtp):
|
|
"""Does successful_registration_notification 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)
|
|
|
|
ctf_name = get_config("ctf_name")
|
|
from_addr = get_config("mailfrom_addr") or app.config.get("MAILFROM_ADDR")
|
|
from_addr = "{} <{}>".format(ctf_name, from_addr)
|
|
|
|
to_addr = "user@user.com"
|
|
|
|
successful_registration_notification(to_addr)
|
|
|
|
msg = "You've successfully registered for CTFd!"
|
|
|
|
email_msg = EmailMessage()
|
|
email_msg.set_content(msg)
|
|
email_msg["Subject"] = "Successfully registered for {ctf_name}".format(
|
|
ctf_name=ctf_name
|
|
)
|
|
email_msg["From"] = from_addr
|
|
email_msg["To"] = to_addr
|
|
|
|
mock_smtp.return_value.send_message.assert_called()
|
|
assert str(mock_smtp.return_value.send_message.call_args[0][0]) == str(
|
|
email_msg
|
|
)
|
|
destroy_ctfd(app)
|