mirror of
https://github.com/aljazceru/CTFd.git
synced 2025-12-17 05:54:19 +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`
51 lines
1.4 KiB
Bash
Executable File
51 lines
1.4 KiB
Bash
Executable File
#!/bin/bash
|
|
set -euo pipefail
|
|
|
|
WORKERS=${WORKERS:-1}
|
|
WORKER_CLASS=${WORKER_CLASS:-gevent}
|
|
ACCESS_LOG=${ACCESS_LOG:--}
|
|
ERROR_LOG=${ERROR_LOG:--}
|
|
WORKER_TEMP_DIR=${WORKER_TEMP_DIR:-/dev/shm}
|
|
SECRET_KEY=${SECRET_KEY:-}
|
|
DATABASE_URL=${DATABASE_URL:-}
|
|
|
|
# Check that a .ctfd_secret_key file or SECRET_KEY envvar is set
|
|
if [ ! -f .ctfd_secret_key ] && [ -z "$SECRET_KEY" ]; then
|
|
if [ $WORKERS -gt 1 ]; then
|
|
echo "[ ERROR ] You are configured to use more than 1 worker."
|
|
echo "[ ERROR ] To do this, you must define the SECRET_KEY environment variable or create a .ctfd_secret_key file."
|
|
echo "[ ERROR ] Exiting..."
|
|
exit 1
|
|
fi
|
|
fi
|
|
|
|
# Check that the database is available
|
|
if [ -n "$DATABASE_URL" ]
|
|
then
|
|
url=`echo $DATABASE_URL | awk -F[@//] '{print $4}'`
|
|
database=`echo $url | awk -F[:] '{print $1}'`
|
|
port=`echo $url | awk -F[:] '{print $2}'`
|
|
echo "Waiting for $database:$port to be ready"
|
|
while ! mysqladmin ping -h "$database" -P "$port" --silent; do
|
|
# Show some progress
|
|
echo -n '.';
|
|
sleep 1;
|
|
done
|
|
echo "$database is ready"
|
|
# Give it another second.
|
|
sleep 1;
|
|
fi
|
|
|
|
# Initialize database
|
|
python manage.py db upgrade
|
|
|
|
# Start CTFd
|
|
echo "Starting CTFd"
|
|
exec gunicorn 'CTFd:create_app()' \
|
|
--bind '0.0.0.0:8000' \
|
|
--workers $WORKERS \
|
|
--worker-tmp-dir "$WORKER_TEMP_DIR" \
|
|
--worker-class "$WORKER_CLASS" \
|
|
--access-logfile "$ACCESS_LOG" \
|
|
--error-logfile "$ERROR_LOG"
|