-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathadmin.py
More file actions
458 lines (370 loc) · 16.3 KB
/
admin.py
File metadata and controls
458 lines (370 loc) · 16.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
from __future__ import annotations
from flask import Blueprint, abort, flash, redirect, render_template, request, url_for, jsonify
from CTFd.models import Users, db
from CTFd.utils.decorators import admins_only, ratelimit
from CTFd.utils.user import get_current_user
from .models import Module, ModuleAccess, ModuleCategory, ModuleChallenge, ModuleStatus
from .compat import csrf_protect
from .utils import (
ensure_private_invite_code,
generate_invite_code,
grant_access,
revoke_access,
ordered_modules_query,
ordered_categories_query,
)
def _to_int(value, default=0):
try:
return int(value)
except Exception:
return default
modules_admin_bp = Blueprint(
"ctfd_modules_admin",
__name__,
url_prefix="/plugins/ctfd_modules/admin",
template_folder="templates",
static_folder="static",
)
def _ensure_module_category(name: str) -> ModuleCategory:
name = (name or "").strip()
if not name:
raise ValueError("empty category")
existing = ModuleCategory.query.filter(ModuleCategory.name == name).first()
if existing:
return existing
max_order = db.session.query(db.func.max(ModuleCategory.order)).scalar() or 0
cat = ModuleCategory(name=name, order=int(max_order) + 1)
db.session.add(cat)
return cat
def register_admin_menu(app):
# In CTFd 3.x the admin menu is rendered via templates.
# We inject helpers via a context_processor (minimally invasive).
@app.context_processor
def inject_admin_modules_menu():
def ctfd_modules_all_modules():
try:
return Module.query.order_by(Module.name.asc()).all()
except Exception:
return []
def ctfd_modules_challenge_module_ids(challenge_id):
try:
rows = ModuleChallenge.query.filter_by(challenge_id=challenge_id).all()
return [row.module_id for row in rows]
except Exception:
return []
def ctfd_modules_challenge_module_id(challenge_id):
try:
ids = ctfd_modules_challenge_module_ids(challenge_id)
return ids[0] if ids else None
except Exception:
return None
def ctfd_modules_challenge_module_name(challenge_id):
try:
rows = ModuleChallenge.query.filter_by(challenge_id=challenge_id).all()
if not rows:
return ""
names = []
for row in rows:
m = Module.query.get(row.module_id)
if m and m.name:
names.append(m.name)
return ", ".join(sorted(set(names)))
except Exception:
return ""
return {
"ctfd_modules_all_modules": ctfd_modules_all_modules,
"ctfd_modules_challenge_module_ids": ctfd_modules_challenge_module_ids,
"ctfd_modules_challenge_module_id": ctfd_modules_challenge_module_id,
"ctfd_modules_challenge_module_name": ctfd_modules_challenge_module_name,
}
@modules_admin_bp.route("/modules", methods=["GET"])
@admins_only
def admin_modules_list():
status = request.args.get("status")
category = request.args.get("category")
q = ordered_modules_query()
if status:
q = q.filter(Module.status == status)
if category:
q = q.filter(Module.category == category)
modules = q.all()
categories = [category_row.name for category_row in ordered_categories_query().all()]
return render_template("admin/modules/list.html", modules=modules, categories=categories)
@modules_admin_bp.route("/modules/new", methods=["GET", "POST"])
@admins_only
def admin_modules_new():
if request.method == "POST":
name = (request.form.get("name") or "").strip()
if not name:
flash("Name is required", "danger")
categories = ordered_categories_query().all()
return render_template("admin/modules/edit.html", module=None, categories=categories)
category_name = (request.form.get("category") or "").strip() or None
if category_name and not ModuleCategory.query.filter_by(name=category_name).first():
flash("Please select a category from the list", "danger")
categories = ordered_categories_query().all()
return render_template("admin/modules/edit.html", module=None, categories=categories)
m = Module(
name=name,
category=category_name,
banner_url=(request.form.get("banner_url") or "").strip() or None,
order=_to_int(request.form.get("order"), 0),
status=(request.form.get("status") or "public").strip(),
)
ensure_private_invite_code(m)
db.session.add(m)
db.session.commit()
flash("Module created", "success")
return redirect(url_for("ctfd_modules_admin.admin_modules_edit", module_id=m.id))
categories = ordered_categories_query().all()
return render_template("admin/modules/edit.html", module=None, categories=categories)
@modules_admin_bp.route("/modules/<int:module_id>/edit", methods=["GET", "POST"])
@admins_only
def admin_modules_edit(module_id: int):
module = Module.query.get_or_404(module_id)
if request.method == "POST":
name = (request.form.get("name") or "").strip()
if not name:
flash("Name is required", "danger")
return redirect(url_for("ctfd_modules_admin.admin_modules_edit", module_id=module.id))
category_name = (request.form.get("category") or "").strip() or None
if category_name and not ModuleCategory.query.filter_by(name=category_name).first():
flash("Please select a category from the list", "danger")
return redirect(url_for("ctfd_modules_admin.admin_modules_edit", module_id=module.id))
module.name = name
module.category = category_name
module.banner_url = (request.form.get("banner_url") or "").strip() or None
module.order = _to_int(request.form.get("order"), 0)
module.status = (request.form.get("status") or "public").strip()
ensure_private_invite_code(module)
db.session.commit()
flash("Module updated", "success")
return redirect(url_for("ctfd_modules_admin.admin_modules_edit", module_id=module.id))
categories = ordered_categories_query().all()
access_q = (request.args.get("access_q") or "").strip()
access_results = []
access_users = []
access_user_ids = set()
try:
access_users = (
db.session.query(Users)
.join(ModuleAccess, ModuleAccess.user_id == Users.id)
.filter(ModuleAccess.module_id == module.id)
.order_by(Users.name.asc())
.all()
)
access_user_ids = {u.id for u in access_users}
except Exception:
access_users = []
access_user_ids = set()
if access_q:
try:
filters = []
if hasattr(Users, "name"):
filters.append(Users.name.ilike(f"%{access_q}%"))
if hasattr(Users, "email"):
filters.append(Users.email.ilike(f"%{access_q}%"))
if hasattr(Users, "username"):
filters.append(Users.username.ilike(f"%{access_q}%"))
q = Users.query
if filters:
cond = filters[0]
for f in filters[1:]:
cond = cond | f
q = q.filter(cond)
order_col = Users.name if hasattr(Users, "name") else Users.id
access_results = q.order_by(order_col.asc()).limit(25).all()
except Exception:
access_results = []
return render_template(
"admin/modules/edit.html",
module=module,
categories=categories,
access_q=access_q,
access_results=access_results,
access_users=access_users,
access_user_ids=access_user_ids,
)
@modules_admin_bp.route("/settings", methods=["GET", "POST"])
@admins_only
def admin_modules_settings():
if request.method == "POST":
from .utils import update_settings_from_form
update_settings_from_form(request.form)
flash("Settings updated", "success")
return redirect(url_for("ctfd_modules_admin.admin_modules_settings"))
from .utils import get_settings, get_ui_theme, get_progress_mode
s = get_settings(create=True)
current_mode = (getattr(s, "challenges_board_mode", "all") or "all").strip().lower()
hide_challenges_page = bool(getattr(s, "hide_challenges_page", False))
modules_enabled = bool(getattr(s, "modules_enabled", True))
invite_code_length = int(getattr(s, "invite_code_length", 8) or 8)
lock_message = str(getattr(s, "lock_message", "") or "")
ui_theme = get_ui_theme()
progress_mode = get_progress_mode()
return render_template(
"admin/modules/settings.html",
challenges_board_mode=current_mode,
hide_challenges_page=hide_challenges_page,
modules_enabled=modules_enabled,
invite_code_length=invite_code_length,
lock_message=lock_message,
ui_theme=ui_theme,
progress_mode=progress_mode,
)
@modules_admin_bp.route("/categories", methods=["GET"])
@admins_only
def admin_module_categories_list():
categories = ordered_categories_query().all()
return render_template("admin/modules/categories/list.html", categories=categories)
@modules_admin_bp.route("/categories/new", methods=["GET", "POST"])
@admins_only
def admin_module_categories_new():
if request.method == "POST":
name = (request.form.get("name") or "").strip()
if not name:
flash("Name is required", "danger")
return render_template("admin/modules/categories/edit.html", category=None)
order = _to_int(request.form.get("order"), 0)
if ModuleCategory.query.filter_by(name=name).first():
flash("A category with this name already exists", "warning")
return render_template("admin/modules/categories/edit.html", category=None)
cat = ModuleCategory(name=name, order=order)
db.session.add(cat)
db.session.commit()
flash("Category created", "success")
return redirect(url_for("ctfd_modules_admin.admin_module_categories_list"))
return render_template("admin/modules/categories/edit.html", category=None)
@modules_admin_bp.route("/categories/<int:category_id>/edit", methods=["GET", "POST"])
@admins_only
def admin_module_categories_edit(category_id: int):
category = ModuleCategory.query.get_or_404(category_id)
if request.method == "POST":
name = (request.form.get("name") or "").strip()
if not name:
flash("Name is required", "danger")
return redirect(url_for("ctfd_modules_admin.admin_module_categories_edit", category_id=category.id))
# Rename: keep modules.category in sync
old_name = category.name
category.name = name
category.order = _to_int(request.form.get("order"), 0)
if old_name != name:
Module.query.filter(Module.category == old_name).update({"category": name})
db.session.commit()
flash("Category updated", "success")
return redirect(url_for("ctfd_modules_admin.admin_module_categories_list"))
return render_template("admin/modules/categories/edit.html", category=category)
@modules_admin_bp.route("/categories/<int:category_id>/delete", methods=["POST"])
@admins_only
def admin_module_categories_delete(category_id: int):
category = ModuleCategory.query.get_or_404(category_id)
# Detach modules from this category
Module.query.filter(Module.category == category.name).update({"category": None})
db.session.delete(category)
db.session.commit()
flash("Category deleted", "success")
return redirect(url_for("ctfd_modules_admin.admin_module_categories_list"))
@modules_admin_bp.route("/modules/<int:module_id>/delete", methods=["POST"])
@admins_only
def admin_modules_delete(module_id: int):
module = Module.query.get_or_404(module_id)
ModuleAccess.query.filter_by(module_id=module.id).delete()
ModuleChallenge.query.filter_by(module_id=module.id).delete()
db.session.delete(module)
db.session.commit()
flash("Module deleted", "success")
return redirect(url_for("ctfd_modules_admin.admin_modules_list"))
@modules_admin_bp.route("/modules/reorder", methods=["POST"])
@admins_only
def admin_modules_reorder():
body = request.get_json(silent=True) or {}
ordered_ids = body.get("ordered_ids") or []
if not isinstance(ordered_ids, list):
return jsonify({"success": False, "error": "INVALID_PAYLOAD"}), 400
for idx, mid in enumerate(ordered_ids):
Module.query.filter_by(id=mid).update({"order": idx})
db.session.commit()
return jsonify({"success": True})
@modules_admin_bp.route("/modules/<int:module_id>/regen", methods=["POST"])
@admins_only
def admin_modules_regen_invite(module_id: int):
module = Module.query.get_or_404(module_id)
if module.status != ModuleStatus.private:
flash("Invite codes are only available for private modules", "warning")
return redirect(url_for("ctfd_modules_admin.admin_modules_edit", module_id=module.id))
for _ in range(20):
code = generate_invite_code()
if not Module.query.filter(Module.invite_code == code).first():
module.invite_code = code
db.session.commit()
flash("Invite code updated", "success")
return redirect(url_for("ctfd_modules_admin.admin_modules_edit", module_id=module.id))
flash("Failed to generate a new code", "danger")
return redirect(url_for("ctfd_modules_admin.admin_modules_edit", module_id=module.id))
@modules_admin_bp.route("/modules/<int:module_id>/access/add", methods=["POST"])
@admins_only
@ratelimit(method="POST", limit=60, interval=60)
def admin_modules_access_add(module_id: int):
module = Module.query.get_or_404(module_id)
user_id = request.form.get("user_id")
try:
user_id_int = int(user_id)
except Exception:
flash("Invalid user_id", "danger")
return redirect(url_for("ctfd_modules_admin.admin_modules_edit", module_id=module.id))
user = Users.query.get(user_id_int)
if not user:
flash("User not found", "danger")
return redirect(url_for("ctfd_modules_admin.admin_modules_edit", module_id=module.id))
grant_access(module, user, granted_by_user=get_current_user())
db.session.commit()
flash("Access granted", "success")
return redirect(url_for("ctfd_modules_admin.admin_modules_edit", module_id=module.id))
@modules_admin_bp.route("/modules/<int:module_id>/access/revoke", methods=["POST"])
@admins_only
def admin_modules_access_revoke(module_id: int):
module = Module.query.get_or_404(module_id)
user_id = request.form.get("user_id")
try:
user_id_int = int(user_id)
except Exception:
flash("Invalid user_id", "danger")
return redirect(url_for("ctfd_modules_admin.admin_modules_edit", module_id=module.id))
revoke_access(module, user_id_int)
db.session.commit()
flash("Access revoked", "success")
return redirect(url_for("ctfd_modules_admin.admin_modules_edit", module_id=module.id))
@modules_admin_bp.route("/users/search", methods=["GET"])
@admins_only
def admin_users_search():
q = (request.args.get("q") or "").strip()
if not q:
return jsonify({"success": True, "data": []})
try:
filters = []
if hasattr(Users, "name"):
filters.append(Users.name.ilike(f"%{q}%"))
if hasattr(Users, "email"):
filters.append(Users.email.ilike(f"%{q}%"))
if hasattr(Users, "username"):
filters.append(Users.username.ilike(f"%{q}%"))
query = Users.query
if filters:
cond = filters[0]
for f in filters[1:]:
cond = cond | f
query = query.filter(cond)
order_col = Users.name if hasattr(Users, "name") else Users.id
users = query.order_by(order_col.asc()).limit(20).all()
except Exception:
users = []
data = []
for u in users:
data.append(
{
"id": getattr(u, "id", None),
"name": getattr(u, "name", None) or getattr(u, "username", None) or "",
"email": getattr(u, "email", None) or "",
}
)
return jsonify({"success": True, "data": data})