Files
proxy/docs
wmantly a9a48c3445 Add self-service API tokens (PATs) with UI + Bearer auth (#119)
Personal access tokens so scripts/CI can call the management API without an
OIDC browser session. Each logged-in user mints their own token; it
authenticates as the creator (groups snapshotted at mint, mirroring the proxy's
browser AuthToken), and the existing authz layer (Permission.effectiveFor /
roles.resolveEffective) applies unchanged. Local groups and owned-domain rights
are recomputed live; only SSO/LDAP group membership is the mint-time snapshot.

- models/api_token.js: new ApiToken model (prx_<id>_<secret> format; id is the
  lookup key, secret bcrypt-hashed + isPrivate, shown once). add()/rotate()/
  authenticate(); optional expires_at; best-effort last_used_on; groups
  snapshot. No _ttl (persists). Deliberately NOT wrapped in ModelPs (so the
  last_used_on write on the auth path doesn't spam the socket).
- routes/api_token.js: self-service CRUD (list/get/update/delete/rotate),
  owner-scoped (created_by === reqUsername(req), 403 otherwise).
- middleware/auth.js + models/auth.js: accept `Authorization: Bearer prx_...`
  (precedence over the auth-token session header). Builds a synthetic req.token
  that satisfies the only three req.token reads (auth.js .user/.groupsArray,
  authz.js reqUsername .created_by) so the authz layer works unchanged.
  checkApiToken collapses every failure to one generic 401 (no leak).
- views/api_tokens.ejs + routes/render.js (GET /api-tokens): self-service page
  (forceLogin, no admin gate) — create (token shown once), rotate, revoke.
- views/top.ejs: "API Tokens" nav entry visible to all logged-in users.
- public/js/app.js: app.apiToken client module.
- DEPLOYMENT.md + docs/docker.md: API tokens section.

Co-authored-by: Claude <noreply@anthropic.com>
2026-07-12 17:12:38 -04:00
..
2025-12-31 16:51:27 -05:00
2025-12-31 16:51:27 -05:00
2026-02-11 11:21:00 -05:00
2019-06-30 21:58:02 -04:00
2025-12-31 16:51:27 -05:00
2025-12-31 16:51:27 -05:00
2020-04-11 16:57:57 -04:00

Documentation

This directory contains the GitHub Pages documentation site for the Proxy project.

Live site: https://theta42.github.io/proxy/

Pages

  • index.md - Home page with project overview
  • installation.md - Installation and setup guide
  • api.md - Complete API reference
  • architecture.md - System architecture and design
  • contributing.md - Development and contribution guide

Local Preview

To preview the site locally:

# Install Jekyll (one-time setup)
gem install jekyll bundler

# Run local server
cd docs
jekyll serve

# View at http://localhost:4000/proxy/

Theme

The site uses the Cayman theme (jekyll-theme-cayman). Configuration is in _config.yml.

Updating Documentation

  1. Edit markdown files in this directory
  2. Commit and push to master branch
  3. GitHub Pages automatically rebuilds (may take 1-2 minutes)
  4. Changes visible at https://theta42.github.io/proxy/

Legacy Documentation

  • dev_setup.md - Old development setup notes (kept for reference)
  • Update 4.11.md - Old update notes (kept for reference)