wtclaude
565a7d2c20
The last split PR of docs/website/API_V2_PLAN.md § Phase 2. public.routes.js,
player.routes.js and auth.routes.js are deleted; each group is now a directory
whose index.js owns the group gate and the mount table and declares no routes.
Every one of the 200 manifest routes is now in a capability router.
public/ posts (2) wiki (4) pages (2) shard (12) site (4, group root)
player/ account (8) shard (8) appeals (4), behind noindex + requireAuth
auth/ login (2) register (1) invite (2) password (3) session (2, root)
No URL moves. All four gates zero-diff: routes.manifest.json (200 public + 2
internal), routes.guards.json, swagger-output.json (198 operations), and
docs/website/api-route-inventory.json was already in sync. 434 tests green.
Notes on the non-mechanical parts:
- public/index.js and auth/index.js carry no group gate, deliberately, and say
so. The public surface is anonymous by contract (logged-out SPA, Discord bot,
Android ShardStreamClient on /public/shard/stream); /auth is where a caller
becomes authenticated. player/index.js gates on requireAuth only, never
requireRole('player') — staff are a superset of players.
- GET /auth/me has a mount-order dependency: use('/me', meRouter) matches the
bare /me, so the request runs meRouter's noindex + requireAuth and falls
through. session.router.js must stay mounted last. Verified by the
counterfactual — mounting it first still 401s but drops X-Robots-Tag, which
no manifest or guards file can see.
- loginGuards moved to auth/loginGuards.js (frozen) rather than being copied
into the three routers that spread it; sso.routes.js drops its duplicate.
- The :param shadowing check was re-run in dispatch order against the built
stack: 86 routes, 64 literal, none shadowed. /public/wiki/{categories,tags}
ahead of /:slug is the only ordering-sensitive pair.
Co-Authored-By: Claude <noreply@anthropic.com>
44 lines
2.7 KiB
JavaScript
44 lines
2.7 KiB
JavaScript
// Auth · Register — public self-registration of player accounts.
|
|
//
|
|
// Mounted at /api/v1/auth/register by auth/index.js, so the single route below
|
|
// emits POST /auth/register. Gated in the controller by the player_registration
|
|
// setting (403 when closed); here it reuses the shared loginGuards stack plus its
|
|
// own per-IP registerLimiter, and accepts the honeypot field.
|
|
//
|
|
// Invite acceptance is the other account-creating route and lives in
|
|
// invite.router.js — it deliberately bypasses the player_registration gate, since
|
|
// the invite is its own authority.
|
|
|
|
const express = require('express')
|
|
const { body } = require('express-validator')
|
|
|
|
const { register, HONEYPOT_FIELD } = require('./auth.controller')
|
|
const { loginGuards } = require('./loginGuards')
|
|
const { registerLimiter } = require('../../../middleware/rateLimit')
|
|
const validate = require('../../../middleware/validate')
|
|
|
|
const registerRouter = express.Router()
|
|
|
|
registerRouter.post(
|
|
'/',
|
|
// #swagger.tags = ['Auth']
|
|
// #swagger.summary = 'Register a player account'
|
|
// #swagger.description = 'Creates a self-service player account and logs it in (sets the session cookie). Available only when an admin has enabled password registration (player_registration = password|both); otherwise returns 403. Rate limited and behind bot/backoff guards; a hidden honeypot field must stay empty.'
|
|
/* #swagger.requestBody = { required: true, content: { "application/json": { schema: { $ref: "#/components/schemas/RegisterRequest" } } } } */
|
|
/* #swagger.responses[200] = { description: 'Account created and session issued', content: { "application/json": { schema: { $ref: "#/components/schemas/LoginResponse" } } } } */
|
|
/* #swagger.responses[400] = { description: 'Validation error or unavailable username', content: { "application/json": { schema: { $ref: "#/components/schemas/ValidationError" } } } } */
|
|
/* #swagger.responses[403] = { description: 'Registration is not open', content: { "application/json": { schema: { $ref: "#/components/schemas/Error" } } } } */
|
|
/* #swagger.responses[409] = { description: 'Username already taken', content: { "application/json": { schema: { $ref: "#/components/schemas/Error" } } } } */
|
|
/* #swagger.responses[429] = { description: 'Too many attempts (rate limited / backoff)', content: { "application/json": { schema: { $ref: "#/components/schemas/Error" } } } } */
|
|
...loginGuards,
|
|
registerLimiter,
|
|
body('username').isString().trim().isLength({ min: 3, max: 32 }),
|
|
body('password').isString().isLength({ min: 8, max: 64 }),
|
|
body('email').optional({ values: 'falsy' }).isEmail().isLength({ max: 255 }),
|
|
body(HONEYPOT_FIELD).optional(),
|
|
validate,
|
|
register,
|
|
)
|
|
|
|
module.exports = registerRouter
|