Files
CTFd-Whale/api.py
2025-09-19 15:59:08 +08:00

139 lines
5.0 KiB
Python
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

from datetime import datetime
from flask import request
from flask_restx import Namespace, Resource, abort
from CTFd.utils import get_config
from CTFd.utils import user as current_user
from CTFd.utils.decorators import admins_only, authed_only
from .decorators import challenge_visible, frequency_limited
from .utils.control import ControlUtil
from .utils.db import DBContainer
from .utils.routers import Router
admin_namespace = Namespace("ctfd-whale-admin")
user_namespace = Namespace("ctfd-whale-user")
@admin_namespace.errorhandler
@user_namespace.errorhandler
def handle_default(err):
return {
'success': False,
'message': 'Unexpected things happened'
}, 500
@admin_namespace.route('/container')
class AdminContainers(Resource):
@staticmethod
@admins_only
def get():
page = abs(request.args.get("page", 1, type=int))
results_per_page = abs(request.args.get("per_page", 20, type=int))
page_start = results_per_page * (page - 1)
page_end = results_per_page * (page - 1) + results_per_page
count = DBContainer.get_all_alive_container_count()
containers = DBContainer.get_all_alive_container_page(
page_start, page_end)
return {'success': True, 'data': {
'containers': containers,
'total': count,
'pages': int(count / results_per_page) + (count % results_per_page > 0),
'page_start': page_start,
}}
@staticmethod
@admins_only
def patch():
user_id = request.args.get('user_id', -1)
result, message = ControlUtil.try_renew_container(user_id=int(user_id))
if not result:
abort(403, message, success=False)
return {'success': True, 'message': message}
@staticmethod
@admins_only
def delete():
user_id = request.args.get('user_id')
result, message = ControlUtil.try_remove_container(user_id)
return {'success': result, 'message': message}
@user_namespace.route("/container")
class UserContainers(Resource):
@staticmethod
@authed_only
@challenge_visible
def get():
user_id = current_user.get_current_user().id
challenge_id = request.args.get('challenge_id')
container = DBContainer.get_current_containers(user_id=user_id)
if not container:
return {'success': True, 'data': {}}
timeout = int(get_config("whale:docker_timeout", "3600"))
c = container.challenge # build a url for quick jump. todo: escape dash in categories and names.
link = f'<a target="_blank" href="/challenges#{c.category}-{c.name}-{c.id}">{c.name}</a>'
if int(container.challenge_id) != int(challenge_id):
return abort(403, f'Container already started but not from this challenge ({link})', success=False)
return {
'success': True,
'data': {
'lan_domain': str(user_id) + "-" + container.uuid,
'user_access': Router.access(container),
'remaining_time': timeout - (datetime.now() - container.start_time).seconds,
}
}
@staticmethod
@authed_only
@challenge_visible
@frequency_limited
def post():
user_id = current_user.get_current_user().id
ControlUtil.try_remove_container(user_id)
current_count = DBContainer.get_all_alive_container_count()
if int(get_config("whale:docker_max_container_count")) <= int(current_count):
abort(403, 'Max container count exceed.', success=False)
challenge_id = request.args.get('challenge_id')
result, message = ControlUtil.try_add_container(
user_id=user_id,
challenge_id=challenge_id
)
if not result:
abort(403, message, success=False)
return {'success': True, 'message': message}
@staticmethod
@authed_only
@challenge_visible
@frequency_limited
def patch():
user_id = current_user.get_current_user().id
challenge_id = request.args.get('challenge_id')
docker_max_renew_count = int(get_config("whale:docker_max_renew_count", 5))
container = DBContainer.get_current_containers(user_id)
if container is None:
abort(403, 'Instance not found.', success=False)
if int(container.challenge_id) != int(challenge_id):
abort(403, f'Container started but not from this challenge{container.challenge.name}', success=False)
if container.renew_count >= docker_max_renew_count:
abort(403, 'Max renewal count exceed.', success=False)
result, message = ControlUtil.try_renew_container(user_id=user_id)
return {'success': result, 'message': message}
@staticmethod
@authed_only
@frequency_limited
def delete():
user_id = current_user.get_current_user().id
result, message = ControlUtil.try_remove_container(user_id)
if not result:
abort(403, message, success=False)
return {'success': True, 'message': message}