Refinement pass on top of the validated v1.2 base.
Hardening / quick fixes
- Caddyfile.tpl: CSP / HSTS / X-Frame / Referrer-Policy / Permissions-Policy,
1 MiB request body cap, X-Forwarded-For pass-through; stock-Caddy compatible.
- auth.py: STUDENT_MAX_AGE 1y -> 30d.
- bootstrap.sh: stage 5 prepends `git config --add safe.directory` so the
re-bootstrap path no longer 'detected dubious ownership' faults.
- admin.js: drop the misleading `closedPayload?.state || session.state`
shim; state derives from session only.
Anti-cheat
- New `student_events` audit table; new POST /api/session/{sid}/event for
blur / visibility_hidden / focus / visibility_visible. quiz.js debounces
events at 1.5s and uses sendBeacon for visibility_hidden so the event
survives a navigation. Counts surface in admin presence + CSV export.
- First-claim-wins on join: add_participant raises DuplicateStudentId on
PK violation; route returns 409 + records a duplicate_join audit event
with attempted name + IP + UA. Admin dashboard surfaces a per-row red
badge for hits on real participants and a top-of-page alert for orphan
attempts.
- DELETE /admin/api/students/{id} as the recovery hatch: clears the
participant + submissions, kicks active WS sockets so a stale cookie
cannot continue submitting. quiz.js surfaces the FastAPI detail message
in the join form so users see the 'already in use' guidance.
Presence panel
- New presence_update WS message; in-process presence map keyed on
student_id tracks ws_count + last_seen_ms. Admin dashboard renders
per-student rows: connected/idle/dropped dot, blur+hidden+duplicate
badges, 'answered current Q' tick, and a clear-student button.
Projector view (public, read-only)
- /projector/?sid=..., GET /api/session/{sid}/projector, WS
/ws/projector/{sid}. Single self-contained projector_state snapshot
pushed on every state change. Public leaderboard strips student_id;
QR rendered server-side as data: URL (CSP-compliant).
- Includes per-Q answer histogram, 8-bucket response-time distribution,
10-bucket score distribution.
- static/projector.{html,css,js}: editorial-broadside design — masthead,
registration crosses, conic-gradient countdown ring, SVG stepped-area
score distribution with median tick, leaderboard row-stagger. Inherits
light/dark tokens from style.css; honours prefers-reduced-motion. No
scroll at 1366x768 / 1920x1080 / 3440x1440.
Tests
- tests/test_anti_cheat.py: blur logging + CSV count, unknown-kind 422,
unauthenticated event 401, duplicate-join 409 + audit, admin
clear-student happy + 404, server-side submit lockout regression.
- tests/test_projector.py: snapshot shape, leaderboard student_id
redaction, WS push on state change, 404 for unknown sid, page redirect
when no sid.
- Existing tests updated for the new presence_update snapshot frame +
CSV header columns + first-claim-wins refusal of re-key.
57/57 pytest green; smoke-tested locally end-to-end.
130 lines
5.3 KiB
Python
130 lines
5.3 KiB
Python
"""Instructor routes (single-session deployment).
|
|
|
|
The deployment runs exactly one quiz session at a time, loaded from
|
|
`QUIZ_POOL_PATH` at startup. There is no per-quiz CRUD; the operator
|
|
edits the pool JSON on disk and restarts the service when they want
|
|
a new pool. The admin UI is therefore a thin control panel for the
|
|
single canonical session whose id is `Settings.default_session_id`.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from pathlib import Path
|
|
|
|
from fastapi import APIRouter, HTTPException, Request, Response, WebSocket
|
|
from fastapi.responses import FileResponse, PlainTextResponse
|
|
|
|
from app import auth
|
|
from app.config import Settings
|
|
from app.csv_export import export_session_csv
|
|
from app.models import AdminLoginRequest
|
|
from app.rate_limit import TokenBucket, client_ip
|
|
from app.room import RoomManager, _qr_data_url
|
|
|
|
|
|
def router(settings: Settings, rooms: RoomManager) -> APIRouter:
|
|
api = APIRouter()
|
|
|
|
# Per-app instance so test apps get fresh state.
|
|
# 10 attempts/minute/IP — generous for the instructor, hostile to brute
|
|
# force without locking out the campus network on student endpoints
|
|
# (which are not rate-limited at all, see rate_limit.py).
|
|
login_bucket = TokenBucket(capacity=10, refill_per_minute=10)
|
|
|
|
def require_admin(request: Request) -> None:
|
|
auth.require_admin_request(settings, request)
|
|
|
|
@api.post("/admin/login")
|
|
async def login(body: AdminLoginRequest, request: Request, response: Response):
|
|
ip = client_ip(request)
|
|
if not login_bucket.take(ip):
|
|
raise HTTPException(
|
|
status_code=429,
|
|
detail="Too many login attempts; try again in a minute.",
|
|
)
|
|
if not auth.verify_admin_password(settings, body.password):
|
|
raise HTTPException(status_code=401, detail="Invalid admin password")
|
|
auth.set_admin_cookie(settings, response, auth.sign_admin(settings))
|
|
return {"ok": True}
|
|
|
|
@api.post("/admin/logout")
|
|
async def logout(response: Response):
|
|
response.delete_cookie(auth.ADMIN_COOKIE, path="/")
|
|
return {"ok": True}
|
|
|
|
@api.get("/admin/")
|
|
async def admin_page():
|
|
# No auth gate; the SPA fetches /admin/api/state and renders
|
|
# the login form on 401 or the dashboard on 200.
|
|
return FileResponse(Path("static/admin.html"))
|
|
|
|
@api.get("/admin/api/state")
|
|
async def admin_state(request: Request):
|
|
require_admin(request)
|
|
sid = rooms.canonical_sid or settings.default_session_id
|
|
if not await rooms.session_exists(sid):
|
|
raise HTTPException(status_code=503, detail="Session is not initialised")
|
|
session = await rooms.get_session(sid)
|
|
pool = await rooms.get_pool_for_session(sid)
|
|
join_url = f"{settings.public_url}/?sid={sid}"
|
|
return {
|
|
"sid": sid,
|
|
"title": session["title"],
|
|
"state": session["state"],
|
|
"current_question_idx": session["current_question_idx"],
|
|
"join_url": join_url,
|
|
"qr_url": _qr_data_url(join_url),
|
|
"pool_meta": {
|
|
"score_fn": pool["score_fn"],
|
|
"time_limit_default": pool["time_limit_default"],
|
|
"question_count": len(pool["questions"]),
|
|
},
|
|
}
|
|
|
|
@api.post("/admin/api/reset")
|
|
async def admin_reset(request: Request):
|
|
require_admin(request)
|
|
sid = rooms.canonical_sid or settings.default_session_id
|
|
if not await rooms.session_exists(sid):
|
|
raise HTTPException(status_code=503, detail="Session is not initialised")
|
|
await rooms.reset(sid)
|
|
return {"ok": True}
|
|
|
|
@api.delete("/admin/api/students/{student_id}")
|
|
async def admin_clear_student(student_id: str, request: Request):
|
|
# Recovery hatch for first-claim-wins: if a student lost their
|
|
# cookie or their id was hijacked, the instructor can free the
|
|
# slot here. Removes the participant + all of their submissions
|
|
# and kicks any active WS for that id; the legitimate student
|
|
# then re-joins via the normal flow.
|
|
require_admin(request)
|
|
sid = rooms.canonical_sid or settings.default_session_id
|
|
if not await rooms.session_exists(sid):
|
|
raise HTTPException(status_code=503, detail="Session is not initialised")
|
|
removed = await rooms.clear_student(sid, student_id)
|
|
if not removed:
|
|
raise HTTPException(status_code=404, detail="No such student in session")
|
|
return {"ok": True}
|
|
|
|
@api.get("/admin/api/csv")
|
|
async def csv_download(request: Request):
|
|
require_admin(request)
|
|
sid = rooms.canonical_sid or settings.default_session_id
|
|
if not await rooms.session_exists(sid):
|
|
raise HTTPException(status_code=503, detail="Session is not initialised")
|
|
csv_text = await export_session_csv(settings.db_path, sid)
|
|
return PlainTextResponse(
|
|
csv_text,
|
|
media_type="text/csv",
|
|
headers={"Content-Disposition": f'attachment; filename="{sid}-results.csv"'},
|
|
)
|
|
|
|
@api.websocket("/ws/instructor/{sid}")
|
|
async def instructor_socket(websocket: WebSocket, sid: str):
|
|
if not auth.is_admin_ws(settings, websocket) or not await rooms.session_exists(sid):
|
|
await websocket.close(code=4001)
|
|
return
|
|
await rooms.instructor_ws(websocket, sid)
|
|
|
|
return api
|