mirror of
https://github.com/aljazceru/CTFd.git
synced 2025-12-17 14:04:20 +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`
352 lines
12 KiB
Python
352 lines
12 KiB
Python
#!/usr/bin/env python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
from CTFd.models import Challenges
|
|
from CTFd.plugins.dynamic_challenges import DynamicChallenge, DynamicValueChallenge
|
|
from CTFd.utils.security.signing import hmac
|
|
from tests.helpers import (
|
|
FakeRequest,
|
|
create_ctfd,
|
|
destroy_ctfd,
|
|
gen_flag,
|
|
gen_user,
|
|
login_as_user,
|
|
register_user,
|
|
)
|
|
|
|
|
|
def test_can_create_dynamic_challenge():
|
|
"""Test that dynamic challenges can be made from the API/admin panel"""
|
|
app = create_ctfd(enable_plugins=True)
|
|
with app.app_context():
|
|
register_user(app)
|
|
client = login_as_user(app, name="admin", password="password")
|
|
|
|
challenge_data = {
|
|
"name": "name",
|
|
"category": "category",
|
|
"description": "description",
|
|
"value": 100,
|
|
"decay": 20,
|
|
"minimum": 1,
|
|
"state": "hidden",
|
|
"type": "dynamic",
|
|
}
|
|
|
|
r = client.post("/api/v1/challenges", json=challenge_data)
|
|
assert r.get_json().get("data")["id"] == 1
|
|
|
|
challenges = DynamicChallenge.query.all()
|
|
assert len(challenges) == 1
|
|
|
|
challenge = challenges[0]
|
|
assert challenge.value == 100
|
|
assert challenge.initial == 100
|
|
assert challenge.decay == 20
|
|
assert challenge.minimum == 1
|
|
destroy_ctfd(app)
|
|
|
|
|
|
def test_can_update_dynamic_challenge():
|
|
app = create_ctfd(enable_plugins=True)
|
|
with app.app_context():
|
|
challenge_data = {
|
|
"name": "name",
|
|
"category": "category",
|
|
"description": "description",
|
|
"value": 100,
|
|
"decay": 20,
|
|
"minimum": 1,
|
|
"state": "hidden",
|
|
"type": "dynamic",
|
|
}
|
|
req = FakeRequest(form=challenge_data)
|
|
challenge = DynamicValueChallenge.create(req)
|
|
|
|
assert challenge.value == 100
|
|
assert challenge.initial == 100
|
|
assert challenge.decay == 20
|
|
assert challenge.minimum == 1
|
|
|
|
challenge_data = {
|
|
"name": "new_name",
|
|
"category": "category",
|
|
"description": "new_description",
|
|
"value": "200",
|
|
"initial": "200",
|
|
"decay": "40",
|
|
"minimum": "5",
|
|
"max_attempts": "0",
|
|
"state": "visible",
|
|
}
|
|
|
|
req = FakeRequest(form=challenge_data)
|
|
challenge = DynamicValueChallenge.update(challenge, req)
|
|
|
|
assert challenge.name == "new_name"
|
|
assert challenge.description == "new_description"
|
|
assert challenge.value == 200
|
|
assert challenge.initial == 200
|
|
assert challenge.decay == 40
|
|
assert challenge.minimum == 5
|
|
assert challenge.state == "visible"
|
|
|
|
destroy_ctfd(app)
|
|
|
|
|
|
def test_can_add_requirement_dynamic_challenge():
|
|
"""Test that requirements can be added to dynamic challenges"""
|
|
app = create_ctfd(enable_plugins=True)
|
|
with app.app_context():
|
|
challenge_data = {
|
|
"name": "name",
|
|
"category": "category",
|
|
"description": "description",
|
|
"value": 100,
|
|
"decay": 20,
|
|
"minimum": 1,
|
|
"state": "hidden",
|
|
"type": "dynamic",
|
|
}
|
|
req = FakeRequest(form=challenge_data)
|
|
challenge = DynamicValueChallenge.create(req)
|
|
|
|
assert challenge.value == 100
|
|
assert challenge.initial == 100
|
|
assert challenge.decay == 20
|
|
assert challenge.minimum == 1
|
|
|
|
challenge_data = {
|
|
"name": "second_name",
|
|
"category": "category",
|
|
"description": "new_description",
|
|
"value": "200",
|
|
"initial": "200",
|
|
"decay": "40",
|
|
"minimum": "5",
|
|
"max_attempts": "0",
|
|
"state": "visible",
|
|
}
|
|
|
|
req = FakeRequest(form=challenge_data)
|
|
challenge = DynamicValueChallenge.create(req)
|
|
|
|
assert challenge.name == "second_name"
|
|
assert challenge.description == "new_description"
|
|
assert challenge.value == 200
|
|
assert challenge.initial == 200
|
|
assert challenge.decay == 40
|
|
assert challenge.minimum == 5
|
|
assert challenge.state == "visible"
|
|
|
|
challenge_data = {"requirements": [1]}
|
|
|
|
req = FakeRequest(form=challenge_data)
|
|
challenge = DynamicValueChallenge.update(challenge, req)
|
|
|
|
assert challenge.requirements == [1]
|
|
|
|
destroy_ctfd(app)
|
|
|
|
|
|
def test_can_delete_dynamic_challenge():
|
|
"""Test that dynamic challenges can be deleted"""
|
|
app = create_ctfd(enable_plugins=True)
|
|
with app.app_context():
|
|
register_user(app)
|
|
client = login_as_user(app, name="admin", password="password")
|
|
|
|
challenge_data = {
|
|
"name": "name",
|
|
"category": "category",
|
|
"description": "description",
|
|
"value": 100,
|
|
"decay": 20,
|
|
"minimum": 1,
|
|
"state": "hidden",
|
|
"type": "dynamic",
|
|
}
|
|
|
|
r = client.post("/api/v1/challenges", json=challenge_data)
|
|
assert r.get_json().get("data")["id"] == 1
|
|
|
|
challenges = DynamicChallenge.query.all()
|
|
assert len(challenges) == 1
|
|
|
|
challenge = challenges[0]
|
|
DynamicValueChallenge.delete(challenge)
|
|
|
|
challenges = DynamicChallenge.query.all()
|
|
assert len(challenges) == 0
|
|
destroy_ctfd(app)
|
|
|
|
|
|
def test_dynamic_challenge_loses_value_properly():
|
|
app = create_ctfd(enable_plugins=True)
|
|
with app.app_context():
|
|
register_user(app)
|
|
client = login_as_user(app, name="admin", password="password")
|
|
|
|
challenge_data = {
|
|
"name": "name",
|
|
"category": "category",
|
|
"description": "description",
|
|
"value": 100,
|
|
"decay": 20,
|
|
"minimum": 1,
|
|
"state": "visible",
|
|
"type": "dynamic",
|
|
}
|
|
|
|
r = client.post("/api/v1/challenges", json=challenge_data)
|
|
assert r.get_json().get("data")["id"] == 1
|
|
|
|
gen_flag(app.db, challenge_id=1, content="flag")
|
|
|
|
for i, team_id in enumerate(range(2, 26)):
|
|
name = "user{}".format(team_id)
|
|
email = "user{}@ctfd.io".format(team_id)
|
|
# We need to bypass rate-limiting so gen_user instead of register_user
|
|
user = gen_user(app.db, name=name, email=email)
|
|
user_id = user.id
|
|
|
|
with app.test_client() as client:
|
|
# We need to bypass rate-limiting so creating a fake user instead of logging in
|
|
with client.session_transaction() as sess:
|
|
sess["id"] = user_id
|
|
sess["nonce"] = "fake-nonce"
|
|
sess["hash"] = hmac(user.password)
|
|
|
|
data = {"submission": "flag", "challenge_id": 1}
|
|
|
|
r = client.post("/api/v1/challenges/attempt", json=data)
|
|
resp = r.get_json()["data"]
|
|
assert resp["status"] == "correct"
|
|
|
|
chal = DynamicChallenge.query.filter_by(id=1).first()
|
|
if i >= 20:
|
|
assert chal.value == chal.minimum
|
|
else:
|
|
assert chal.initial >= chal.value
|
|
assert chal.value > chal.minimum
|
|
destroy_ctfd(app)
|
|
|
|
|
|
def test_dynamic_challenge_doesnt_lose_value_on_update():
|
|
"""Dynamic challenge updates without changing any values or solves shouldn't change the current value. See #1043"""
|
|
app = create_ctfd(enable_plugins=True)
|
|
with app.app_context():
|
|
challenge_data = {
|
|
"name": "name",
|
|
"category": "category",
|
|
"description": "description",
|
|
"value": 10000,
|
|
"decay": 4,
|
|
"minimum": 10,
|
|
"state": "visible",
|
|
"type": "dynamic",
|
|
}
|
|
req = FakeRequest(form=challenge_data)
|
|
challenge = DynamicValueChallenge.create(req)
|
|
challenge_id = challenge.id
|
|
gen_flag(app.db, challenge_id=challenge.id, content="flag")
|
|
register_user(app)
|
|
with login_as_user(app) as client:
|
|
data = {"submission": "flag", "challenge_id": challenge_id}
|
|
r = client.post("/api/v1/challenges/attempt", json=data)
|
|
assert r.status_code == 200
|
|
assert r.get_json()["data"]["status"] == "correct"
|
|
chal = Challenges.query.filter_by(id=challenge_id).first()
|
|
prev_chal_value = chal.value
|
|
chal = DynamicValueChallenge.update(chal, req)
|
|
assert prev_chal_value == chal.value
|
|
destroy_ctfd(app)
|
|
|
|
|
|
def test_dynamic_challenge_value_isnt_affected_by_hidden_users():
|
|
app = create_ctfd(enable_plugins=True)
|
|
with app.app_context():
|
|
register_user(app)
|
|
client = login_as_user(app, name="admin", password="password")
|
|
|
|
challenge_data = {
|
|
"name": "name",
|
|
"category": "category",
|
|
"description": "description",
|
|
"value": 100,
|
|
"decay": 20,
|
|
"minimum": 1,
|
|
"state": "visible",
|
|
"type": "dynamic",
|
|
}
|
|
|
|
r = client.post("/api/v1/challenges", json=challenge_data)
|
|
assert r.get_json().get("data")["id"] == 1
|
|
|
|
gen_flag(app.db, challenge_id=1, content="flag")
|
|
|
|
# Make a solve as a regular user. This should not affect the value.
|
|
data = {"submission": "flag", "challenge_id": 1}
|
|
|
|
r = client.post("/api/v1/challenges/attempt", json=data)
|
|
resp = r.get_json()["data"]
|
|
assert resp["status"] == "correct"
|
|
|
|
# Make solves as hidden users. Also should not affect value
|
|
for i, team_id in enumerate(range(2, 26)):
|
|
name = "user{}".format(team_id)
|
|
email = "user{}@ctfd.io".format(team_id)
|
|
# We need to bypass rate-limiting so gen_user instead of register_user
|
|
user = gen_user(app.db, name=name, email=email)
|
|
user.hidden = True
|
|
app.db.session.commit()
|
|
user_id = user.id
|
|
|
|
with app.test_client() as client:
|
|
# We need to bypass rate-limiting so creating a fake user instead of logging in
|
|
with client.session_transaction() as sess:
|
|
sess["id"] = user_id
|
|
sess["nonce"] = "fake-nonce"
|
|
sess["hash"] = hmac(user.password)
|
|
|
|
data = {"submission": "flag", "challenge_id": 1}
|
|
|
|
r = client.post("/api/v1/challenges/attempt", json=data)
|
|
assert r.status_code == 200
|
|
resp = r.get_json()["data"]
|
|
assert resp["status"] == "correct"
|
|
|
|
chal = DynamicChallenge.query.filter_by(id=1).first()
|
|
assert chal.value == chal.initial
|
|
destroy_ctfd(app)
|
|
|
|
|
|
def test_dynamic_challenges_reset():
|
|
app = create_ctfd(enable_plugins=True)
|
|
with app.app_context():
|
|
client = login_as_user(app, name="admin", password="password")
|
|
|
|
challenge_data = {
|
|
"name": "name",
|
|
"category": "category",
|
|
"description": "description",
|
|
"value": 100,
|
|
"decay": 20,
|
|
"minimum": 1,
|
|
"state": "hidden",
|
|
"type": "dynamic",
|
|
}
|
|
|
|
r = client.post("/api/v1/challenges", json=challenge_data)
|
|
assert Challenges.query.count() == 1
|
|
assert DynamicChallenge.query.count() == 1
|
|
|
|
with client.session_transaction() as sess:
|
|
data = {"nonce": sess.get("nonce"), "challenges": "on"}
|
|
r = client.post("/admin/reset", data=data)
|
|
assert r.location.endswith("/admin/statistics")
|
|
assert Challenges.query.count() == 0
|
|
assert DynamicChallenge.query.count() == 0
|
|
|
|
destroy_ctfd(app)
|