Skip to content

v0.35.0

Choose a tag to compare

@github-actions github-actions released this 10 Nov 11:52
· 38 commits to main since this release
Immutable release. Only release title and notes can be modified.
0ca48c0

What changes in 0.35.0

0.35.0 installs webauth through one standard wiring:

  • The host names its sign-in paths once.
  • The installer applies every rule those paths imply, and gives every app the same defaults: a sign-in budget, a request budget and a body limit.

It also brings two other changes:

  • A route can tell a resource admission from a session admission without an exception.
  • A host with a single worker gets webauth's own in-memory stores.

Each host migrates once, through its item.

Per app

  • All browser hosts (hopin, skat, presentator, songmaker):
    • Pass sign_in_paths= to install_web_auth_middleware.
    • Drop what the installer now owns: the back-channel's CSRF exemption and body rule, the sign-in paths' no-store rule, the gate's sign-in public rules, and the rate and body constants that only restated webauth's defaults.
    • A policy that only adds an exemption or a rule keeps webauth's defaults, so no app copies 600/60 or 4 KiB.
  • hopin (hopin#652, which also replaces its store fork with SingleProcessStores):
    • Keeps its permissions, cache rules and the /health exemption (RateLimitPolicy(exempt=…)).
  • skat (skat#248, likewise with the store fork):
    • Keeps its permissions, cache rules, the /health exemption and its own LoginRedirect.
    • Passes its CSP additions as the wiring's parameters: the call origin's frame-ancestors, the sign-in pages' script hashes, and the route announcer's style hash derived by its own frontend build.
  • presentator (presentator#989):
    • Its sign-in budget constant leaves.
    • It keeps the lobby's 32 KiB body default, the hook's rule, its permissions and its CSP.
    • The talk host passes its talk-files rule in a RateLimitPolicy that names no default.
  • songmaker (songmaker#2921 part 1):
    • Drops its four derived references; its sign-in paths spend from the sign-in budget.
    • songmaker#2916 uses is_resource_admission.
  • speech-runtime: nothing to change beyond the pin. It calls neither the installer nor a derived property.
  • An app still on 0.34.0 may take 0.34.1 and 0.35.0 in one pin.

New

  • One standard wiring (#698, PR #704).
    • Derived rules. install_web_auth_middleware(app, sign_in_paths=…, …) puts the derived rules ahead of the host's own (SIGNIN-04 to SIGNIN-08, SIGNIN-44, SIGNIN-68):
      • no-store on every sign-in path;
      • the back-channel path's exemption from CSRF and from the rate limit, and its 32 KiB POST body;
      • with a session gate, the routes' public rules;
      • the policy's sign_in budget on start, callback and logout.
    • The sign-in budget is RateLimitPolicy.sign_in: 40 requests per 10 minutes per address unless the host sets another (SIGNIN-69).
    • Field defaults. The default budget is 600 requests per 60 seconds and the default body limit 4 KiB. These are the policies' own field defaults, and the installer applies them when the host passes no policy (STACK-05, STACK-06).
    • Rate limit details. A path in the host's RateLimitPolicy.exempt spends no budget, a sign-in path included (SIGNIN-72). The rate limit counts every method, HEAD and OPTIONS included (SIGNIN-73).
    • Permissions. The default permissions policy also turns off display-capture (STACK-07).
  • webauth.middleware.is_resource_admission(connection) -> bool (#693, PR #695). It tells a route whether the resource admitted this very request as its capped person (RESOURCE-81 to RESOURCE-83).
  • webauth.single_process_stores.SingleProcessStores(audit=…) (#697, PR #699). It gives accounts, sessions and transaction for a host with one worker (MEMSTORE-01 to MEMSTORE-20). The delete_for_user docstring of the port now says a store may also remove the account.
  • KEY_SET_REFRESH_WAIT_SECONDS came with 0.34.1.

Breaking

All from #698:

  • install_web_auth_middleware requires sign_in_paths.
  • The derived properties of SignInPaths are gone, with no alias: public_rules, browser_paths, backchannel, backchannel_body_size_rule and cache_control_rule. login_redirect stays.
  • A RateLimitPolicy whose default or one of its rules carries the sign-in budget's name ("sign-in" unless renamed) raises ValueError (SIGNIN-70).
  • When the host leaves out its own default, a rule or a renamed sign_in budget named "default" raises ValueError too (STACK-05).

Migration: as listed per app above. No data step.

Not visible to a host

  • CI jobs stop after 10 minutes, the tests run on parallel workers, and every run on main keeps a concurrency group of its own (#700, PRs #701 and #702).
  • Dependabot moved the locked anyio to 4.16.0 (#703). The floor anyio>=4.0,<5 stays.
  • A test proves both rate-limit windows (#706, PR #707).
  • The test arrangement module is split (#708, PR #709).

Full Changelog: v0.34.1...v0.35.0