c0d03e9aaa
A remote user is name@host here, in users.username, in paths (/@alice@music.example) and in mentions, through one handle rule in shared/validation.ts that paths, MENTION_RE and Markdown all build on; Markdown undoes GFM's email autolink of a handle. Their name, email and avatar come from their home at each sign-in and by its signed events (federation_outbox, delivered by the federation job with backoff): a rename at home leaves the old handle an alias here, and a password change or a withdrawn grant ends their sessions here. Their password, email, avatar and name can't change here (assertLocalUser), nor can they sign in elsewhere from here. An admin keeps the trusted and blocked instances on /manage (federation:manage): a trusted instance's users sign in from a button on the login page, a blocked one's can't and are signed out at once, and any other's join with an invite from the register page. The /authorize page asks the user once per instance, and /settings lists the instances their account signs in to, each disconnectable; /login?next= brings a signed-out visitor back to /authorize. Emails stay unique among local accounts only, and migration 0024 adds the tables, makes that index partial and reserves authorize and federation as category slugs. remote/gerbeur-instance.ts is the only way to other instances: https and public addresses only, no redirects, no certificate fallback, unless GERBEUR_FEDERATION_ALLOW_PRIVATE lets two instances on one machine talk. 298 backend tests and 702 frontend tests pass, and deno check, deno fmt, deno lint, tsc, eslint, doc:lint and i18n:compile --strict are clean; checked end to end with two built instances on one machine: sign-in through the other's login and consent pages, consent skipped once granted and asked again after disconnecting, a rename and a password change at home reaching the other, and blocking; screenshots of the login, consent, profile, settings and manage pages at 1280 and 390px. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
61 lines
1.5 KiB
TypeScript
61 lines
1.5 KiB
TypeScript
/**
|
|
* Keeps the server and the client agreed on what each role may do. The server
|
|
* enforces this table (`api/lib/permissions.ts`, `api/routes/ws.ts`) and the
|
|
* client reads the same one to hide what a role can't do
|
|
* (`src/utils/auth/permissions.ts`).
|
|
*
|
|
* @module
|
|
*/
|
|
|
|
import type { Role } from "./user.ts";
|
|
|
|
/**
|
|
* An action only some roles may take. A new one goes in this union and in
|
|
* `ALL_PERMISSIONS`, which is what grants it to admins.
|
|
*/
|
|
export type Permission =
|
|
| "dump:moderate"
|
|
| "comment:moderate"
|
|
| "playlist:moderate"
|
|
| "chat:moderate"
|
|
| "chat:everyone"
|
|
| "user:manage"
|
|
| "category:manage"
|
|
| "federation:manage";
|
|
|
|
const ALL_PERMISSIONS: readonly Permission[] = [
|
|
"dump:moderate",
|
|
"comment:moderate",
|
|
"playlist:moderate",
|
|
"chat:moderate",
|
|
"chat:everyone",
|
|
"user:manage",
|
|
"category:manage",
|
|
"federation:manage",
|
|
];
|
|
|
|
/**
|
|
* Read through {@link hasPermission}. Roles are fixed in code. An admin holds
|
|
* every permission, and a moderator the moderation ones and `@everyone` in
|
|
* the chat.
|
|
*/
|
|
export const ROLE_PERMISSIONS: Record<Role, readonly Permission[]> = {
|
|
admin: ALL_PERMISSIONS,
|
|
moderator: [
|
|
"dump:moderate",
|
|
"comment:moderate",
|
|
"playlist:moderate",
|
|
"chat:moderate",
|
|
"chat:everyone",
|
|
],
|
|
user: [],
|
|
};
|
|
|
|
/**
|
|
* Checks whether `role` grants `permission`. The server's `can` and the
|
|
* client's `can` both wrap it.
|
|
*/
|
|
export function hasPermission(role: Role, permission: Permission): boolean {
|
|
return ROLE_PERMISSIONS[role].includes(permission);
|
|
}
|