mirror of
https://github.com/aljazceru/CTFd.git
synced 2026-02-03 05:14:24 +01:00
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
372 lines
12 KiB
Python
372 lines
12 KiB
Python
from flask import (
|
|
current_app as app,
|
|
render_template,
|
|
request,
|
|
redirect,
|
|
abort,
|
|
url_for,
|
|
session,
|
|
Blueprint,
|
|
Response,
|
|
send_file,
|
|
)
|
|
from flask.helpers import safe_join
|
|
|
|
from CTFd.models import (
|
|
db,
|
|
Users,
|
|
Admins,
|
|
Teams,
|
|
Files,
|
|
Pages,
|
|
Notifications,
|
|
UserTokens,
|
|
)
|
|
from CTFd.utils import markdown
|
|
from CTFd.cache import cache
|
|
from CTFd.utils import get_config, set_config
|
|
from CTFd.utils.user import authed, get_current_user, is_admin
|
|
from CTFd.utils import config, validators
|
|
from CTFd.utils.modes import USERS_MODE
|
|
from CTFd.utils.helpers import get_errors
|
|
from CTFd.utils.uploads import get_uploader
|
|
from CTFd.utils.config.pages import get_page
|
|
from CTFd.utils.config.visibility import challenges_visible
|
|
from CTFd.utils.config import is_setup
|
|
from CTFd.utils.security.auth import login_user
|
|
from CTFd.utils.security.csrf import generate_nonce
|
|
from CTFd.utils import user as current_user
|
|
from CTFd.utils.dates import ctftime, ctf_ended, view_after_ctf
|
|
from CTFd.utils.decorators import authed_only
|
|
from CTFd.utils.security.signing import (
|
|
serialize,
|
|
unserialize,
|
|
BadTimeSignature,
|
|
SignatureExpired,
|
|
BadSignature,
|
|
)
|
|
from sqlalchemy.exc import IntegrityError
|
|
import os
|
|
|
|
|
|
views = Blueprint("views", __name__)
|
|
|
|
|
|
@views.route("/setup", methods=["GET", "POST"])
|
|
def setup():
|
|
errors = get_errors()
|
|
if not config.is_setup():
|
|
if not session.get("nonce"):
|
|
session["nonce"] = generate_nonce()
|
|
if request.method == "POST":
|
|
# General
|
|
ctf_name = request.form.get("ctf_name")
|
|
ctf_description = request.form.get("ctf_description")
|
|
user_mode = request.form.get("user_mode", USERS_MODE)
|
|
set_config("ctf_name", ctf_name)
|
|
set_config("ctf_description", ctf_description)
|
|
set_config("user_mode", user_mode)
|
|
|
|
# Style
|
|
theme = request.form.get("ctf_theme", "core")
|
|
set_config("ctf_theme", theme)
|
|
theme_color = request.form.get("theme_color")
|
|
if theme_color:
|
|
# Uses {{ and }} to insert curly braces while using the format method
|
|
css = (
|
|
":root {{--theme-color: {theme_color};}}\n"
|
|
".navbar{{background-color: var(--theme-color) !important;}}\n"
|
|
".jumbotron{{background-color: var(--theme-color) !important;}}\n"
|
|
).format(theme_color=theme_color)
|
|
set_config("css", css)
|
|
|
|
# DateTime
|
|
start = request.form.get("start")
|
|
end = request.form.get("end")
|
|
set_config("start", start)
|
|
set_config("end", end)
|
|
set_config("freeze", None)
|
|
|
|
# Administration
|
|
name = request.form["name"]
|
|
email = request.form["email"]
|
|
password = request.form["password"]
|
|
|
|
name_len = len(name) == 0
|
|
names = Users.query.add_columns("name", "id").filter_by(name=name).first()
|
|
emails = (
|
|
Users.query.add_columns("email", "id").filter_by(email=email).first()
|
|
)
|
|
pass_short = len(password) == 0
|
|
pass_long = len(password) > 128
|
|
valid_email = validators.validate_email(request.form["email"])
|
|
team_name_email_check = validators.validate_email(name)
|
|
|
|
if not valid_email:
|
|
errors.append("Please enter a valid email address")
|
|
if names:
|
|
errors.append("That user name is already taken")
|
|
if team_name_email_check is True:
|
|
errors.append("Your user name cannot be an email address")
|
|
if emails:
|
|
errors.append("That email has already been used")
|
|
if pass_short:
|
|
errors.append("Pick a longer password")
|
|
if pass_long:
|
|
errors.append("Pick a shorter password")
|
|
if name_len:
|
|
errors.append("Pick a longer user name")
|
|
|
|
if len(errors) > 0:
|
|
return render_template(
|
|
"setup.html",
|
|
errors=errors,
|
|
name=name,
|
|
email=email,
|
|
password=password,
|
|
state=serialize(generate_nonce()),
|
|
)
|
|
|
|
admin = Admins(
|
|
name=name, email=email, password=password, type="admin", hidden=True
|
|
)
|
|
|
|
# Index page
|
|
|
|
index = """<div class="row">
|
|
<div class="col-md-6 offset-md-3">
|
|
<img class="w-100 mx-auto d-block" style="max-width: 500px;padding: 50px;padding-top: 14vh;" src="themes/core/static/img/logo.png" />
|
|
<h3 class="text-center">
|
|
<p>A cool CTF platform from <a href="https://ctfd.io">ctfd.io</a></p>
|
|
<p>Follow us on social media:</p>
|
|
<a href="https://twitter.com/ctfdio"><i class="fab fa-twitter fa-2x" aria-hidden="true"></i></a>
|
|
<a href="https://facebook.com/ctfdio"><i class="fab fa-facebook fa-2x" aria-hidden="true"></i></a>
|
|
<a href="https://github.com/ctfd"><i class="fab fa-github fa-2x" aria-hidden="true"></i></a>
|
|
</h3>
|
|
<br>
|
|
<h4 class="text-center">
|
|
<a href="admin">Click here</a> to login and setup your CTF
|
|
</h4>
|
|
</div>
|
|
</div>""".format(
|
|
request.script_root
|
|
)
|
|
|
|
page = Pages(title=None, route="index", content=index, draft=False)
|
|
|
|
# Visibility
|
|
set_config("challenge_visibility", "private")
|
|
set_config("registration_visibility", "public")
|
|
set_config("score_visibility", "public")
|
|
set_config("account_visibility", "public")
|
|
|
|
# Verify emails
|
|
set_config("verify_emails", None)
|
|
|
|
set_config("mail_server", None)
|
|
set_config("mail_port", None)
|
|
set_config("mail_tls", None)
|
|
set_config("mail_ssl", None)
|
|
set_config("mail_username", None)
|
|
set_config("mail_password", None)
|
|
set_config("mail_useauth", None)
|
|
|
|
set_config("setup", True)
|
|
|
|
try:
|
|
db.session.add(admin)
|
|
db.session.commit()
|
|
except IntegrityError:
|
|
db.session.rollback()
|
|
|
|
try:
|
|
db.session.add(page)
|
|
db.session.commit()
|
|
except IntegrityError:
|
|
db.session.rollback()
|
|
|
|
login_user(admin)
|
|
|
|
db.session.close()
|
|
with app.app_context():
|
|
cache.clear()
|
|
|
|
return redirect(url_for("views.static_html"))
|
|
return render_template(
|
|
"setup.html",
|
|
nonce=session.get("nonce"),
|
|
state=serialize(generate_nonce()),
|
|
themes=config.get_themes(),
|
|
)
|
|
return redirect(url_for("views.static_html"))
|
|
|
|
|
|
@views.route("/setup/integrations", methods=["GET", "POST"])
|
|
def integrations():
|
|
if is_admin() or is_setup() is False:
|
|
name = request.values.get("name")
|
|
state = request.values.get("state")
|
|
|
|
try:
|
|
state = unserialize(state, max_age=3600)
|
|
except (BadSignature, BadTimeSignature):
|
|
state = False
|
|
except Exception:
|
|
state = False
|
|
|
|
if state:
|
|
if name == "mlc":
|
|
mlc_client_id = request.values.get("mlc_client_id")
|
|
mlc_client_secret = request.values.get("mlc_client_secret")
|
|
set_config("oauth_client_id", mlc_client_id)
|
|
set_config("oauth_client_secret", mlc_client_secret)
|
|
return render_template("admin/integrations.html")
|
|
else:
|
|
abort(404)
|
|
else:
|
|
abort(403)
|
|
else:
|
|
abort(403)
|
|
|
|
|
|
@views.route("/notifications", methods=["GET"])
|
|
def notifications():
|
|
notifications = Notifications.query.order_by(Notifications.id.desc()).all()
|
|
return render_template("notifications.html", notifications=notifications)
|
|
|
|
|
|
@views.route("/settings", methods=["GET"])
|
|
@authed_only
|
|
def settings():
|
|
user = get_current_user()
|
|
name = user.name
|
|
email = user.email
|
|
website = user.website
|
|
affiliation = user.affiliation
|
|
country = user.country
|
|
|
|
tokens = UserTokens.query.filter_by(user_id=user.id).all()
|
|
|
|
prevent_name_change = get_config("prevent_name_change")
|
|
confirm_email = get_config("verify_emails") and not user.verified
|
|
return render_template(
|
|
"settings.html",
|
|
name=name,
|
|
email=email,
|
|
website=website,
|
|
affiliation=affiliation,
|
|
country=country,
|
|
tokens=tokens,
|
|
prevent_name_change=prevent_name_change,
|
|
confirm_email=confirm_email,
|
|
)
|
|
|
|
|
|
@views.route("/static/user.css")
|
|
def custom_css():
|
|
"""
|
|
Custom CSS Handler route
|
|
:return:
|
|
"""
|
|
return Response(get_config("css"), mimetype="text/css")
|
|
|
|
|
|
@views.route("/", defaults={"route": "index"})
|
|
@views.route("/<path:route>")
|
|
def static_html(route):
|
|
"""
|
|
Route in charge of routing users to Pages.
|
|
:param route:
|
|
:return:
|
|
"""
|
|
page = get_page(route)
|
|
if page is None:
|
|
abort(404)
|
|
else:
|
|
if page.auth_required and authed() is False:
|
|
return redirect(url_for("auth.login", next=request.full_path))
|
|
|
|
return render_template("page.html", content=markdown(page.content))
|
|
|
|
|
|
@views.route("/files", defaults={"path": ""})
|
|
@views.route("/files/<path:path>")
|
|
def files(path):
|
|
"""
|
|
Route in charge of dealing with making sure that CTF challenges are only accessible during the competition.
|
|
:param path:
|
|
:return:
|
|
"""
|
|
f = Files.query.filter_by(location=path).first_or_404()
|
|
if f.type == "challenge":
|
|
if challenges_visible():
|
|
if current_user.is_admin() is False:
|
|
if not ctftime():
|
|
if ctf_ended() and view_after_ctf():
|
|
pass
|
|
else:
|
|
abort(403)
|
|
else:
|
|
if not ctftime():
|
|
abort(403)
|
|
|
|
# Allow downloads if a valid token is provided
|
|
token = request.args.get("token", "")
|
|
try:
|
|
data = unserialize(token, max_age=3600)
|
|
user_id = data.get("user_id")
|
|
team_id = data.get("team_id")
|
|
file_id = data.get("file_id")
|
|
user = Users.query.filter_by(id=user_id).first()
|
|
team = Teams.query.filter_by(id=team_id).first()
|
|
|
|
# Check user is admin if challenge_visibility is admins only
|
|
if (
|
|
get_config("challenge_visibility") == "admins"
|
|
and user.type != "admin"
|
|
):
|
|
abort(403)
|
|
|
|
# Check that the user exists and isn't banned
|
|
if user:
|
|
if user.banned:
|
|
abort(403)
|
|
else:
|
|
abort(403)
|
|
|
|
# Check that the team isn't banned
|
|
if team:
|
|
if team.banned:
|
|
abort(403)
|
|
else:
|
|
pass
|
|
|
|
# Check that the token properly refers to the file
|
|
if file_id != f.id:
|
|
abort(403)
|
|
|
|
# The token isn't expired or broken
|
|
except (BadTimeSignature, SignatureExpired, BadSignature):
|
|
abort(403)
|
|
|
|
uploader = get_uploader()
|
|
try:
|
|
return uploader.download(f.location)
|
|
except IOError:
|
|
abort(404)
|
|
|
|
|
|
@views.route("/themes/<theme>/static/<path:path>")
|
|
def themes(theme, path):
|
|
"""
|
|
General static file handler
|
|
:param theme:
|
|
:param path:
|
|
:return:
|
|
"""
|
|
filename = safe_join(app.root_path, "themes", theme, "static", path)
|
|
if os.path.isfile(filename):
|
|
return send_file(filename)
|
|
else:
|
|
abort(404)
|