Compare commits

...
68 Commits
Author SHA1 Message Date
LeoVasanko a37198bb4b README 2026-02-09 17:18:55 +00:00
LeoVasanko fb71ea1220 Storing config on database to simplify reloads by CLI. 2026-02-09 17:00:40 +00:00
LeoVasanko 25283eba9b Change database name to (rp-id).paskiadb (previously paskia.jsonl). Validate the rp-id in passkey init. 2026-02-09 16:42:12 +00:00
LeoVasanko 6a217978d6 Upgrade fastapi-vue-setup. 2026-02-09 16:29:24 +00:00
LeoVasanko 4d48c0720a README 2026-02-06 01:07:00 +00:00
LeoVasanko 083d20c8c9 README 2026-02-06 01:00:58 +00:00
LeoVasanko c662fbd39c README 2026-02-06 00:29:16 +00:00
LeoVasanko edf80aef52 README 2026-02-06 00:27:01 +00:00
LeoVasanko 8d5c53ab72 README 2026-02-06 00:25:38 +00:00
LeoVasanko f8a760ddfd README 2026-02-06 00:23:44 +00:00
LeoVasanko 430394a1e5 README 2026-02-06 00:22:03 +00:00
LeoVasanko 4c54ad5d1f Docs, screenshot of permissions view. 2026-02-06 00:16:29 +00:00
LeoVasanko 0b2be18b44 Docs 2026-02-06 00:08:27 +00:00
LeoVasanko 1c8be68811 README 2026-02-05 22:58:42 +00:00
LeoVasanko 116bc3c4ef README 2026-02-05 22:44:26 +00:00
LeoVasanko c641c721c7 README 2026-02-05 21:54:14 +00:00
LeoVasanko 8fc03ade04 Remove the reset subcommand that was broken and unnecessary. 2026-02-05 21:53:30 +00:00
LeoVasanko 6ad3aa7d8c Screenshots, README. 2026-02-05 21:38:57 +00:00
LeoVasanko d8444b0db8 New screenshot after theme changes. 2026-02-05 20:38:30 +00:00
LeoVasanko f515daeecd Release paskia-js 0.1.3 with minor updates on styling and metadata. 2026-02-05 19:49:39 +00:00
LeoVasanko 5deb57435b Remove paskia-migration script (SQL no longer supported). 2026-02-05 19:32:18 +00:00
LeoVasanko 250189dbe5 Update tests for the latest changes. 2026-02-05 19:26:20 +00:00
LeoVasanko 3469e6fa3f ruff check 2026-02-05 19:21:03 +00:00
LeoVasanko c3df6c318c Change host normalization to remove port numbers - sessions are per host, cookies don't respect port numbers. 2026-02-05 19:04:40 +00:00
LeoVasanko 615066a2a2 Upgrade by fastapi-vue-setup, devserver script entirely rewritten to use its facilities. 2026-02-05 18:50:08 +00:00
LeoVasanko 70c682b539 Improved client IP and UA handling. 2026-02-05 17:33:08 +00:00
LeoVasanko 8444d0399e Improved theme picker 2026-02-05 16:19:06 +00:00
LeoVasanko 3c5f8694b3 Load stylesheets directly from HTML to avoid flashing wrong background color first. 2026-02-05 15:39:51 +00:00
LeoVasanko 871eb149ab Styling updates, more robust dynamic/userpref light/dark switching. Sync with paskia-js. 2026-02-05 15:27:15 +00:00
LeoVasanko 291a665e21 Improved UI feedback on registration link creation. 2026-02-05 14:26:11 +00:00
LeoVasanko 0537b85085 Better UI for role deletions. 2026-02-05 14:05:36 +00:00
LeoVasanko af5a48f565 API/DB cleanup for flat URLs that don't include org where users etc. are referred to. Implement user deletion in admin app and API, UI improvement. Reset token DB factory function revised to create passphrase and key internally. Removed unneeded functions and args, using update_user_role instead of a separate deleted _in_organization function. 2026-02-05 13:57:07 +00:00
LeoVasanko 632278d4ce Change CLI to use --listen rather than positional hostport argument. Fix listening on all interfaces (runs lifespan twice, which needs to be OK). Update README with various CLI changes and more. 2026-02-05 02:54:07 +00:00
LeoVasanko 3faaeee7be Add missing __init__ that was causing ModuleFoundError trying to import paskia.util. 2026-02-05 02:33:05 +00:00
LeoVasanko 0f51f8501d Console startup box themed as well. 2026-01-31 00:30:14 +00:00
LeoVasanko a7e6eb7341 Missing theme file. Added favicon. 2026-01-31 00:25:38 +00:00
LeoVasanko 1800dc12ae Light/dark selection in user profile, if set this is preferred on the whole system, together with app overrides (the first one on the URL wins). 2026-01-30 23:31:06 +00:00
LeoVasanko cc55474e62 Light/dark override for in-app login dialogs to match app style e.g. light only 2026-01-30 22:59:52 +00:00
LeoVasanko 8ac2c8e5fa Screenshots on README. 2026-01-29 22:50:54 +00:00
LeoVasanko 2ee8ddf1d1 Log proper action for delete_session depending on what function it performs: logout, delete_session (user's own) or admin:delete_session. 2026-01-29 22:44:22 +00:00
LeoVasanko d58b3742b1 Smarter change logging on console, properly display newly created items (not available via jsondiffs). 2026-01-29 22:39:16 +00:00
LeoVasanko 5879be39a5 Better change entry logging. 2026-01-29 22:09:26 +00:00
LeoVasanko 5b3406025c Silence type checker about our unconventional imports. 2026-01-29 22:09:03 +00:00
LeoVasanko dda57ac27d Fix WS access log IP margin size change missed in earlier commit. 2026-01-29 21:39:30 +00:00
LeoVasanko 5e12dcba76 Add paskia-js to Python build; update build-frontend to use fastapi-vue utils for JS_RUNTIME that also can be set via env now. Fix paskia-js compatibility issue with deno, now works with all three runtimes. 2026-01-29 21:33:09 +00:00
LeoVasanko be7a9e7f00 Smarter access log formatting with IPv6. 2026-01-29 21:17:50 +00:00
LeoVasanko 3d2151fed7 Add support for perm=foo+bar to specify multiple scopes that are required. Multiple perm args are acceptable too. Pretty logging of permission denied errors. 2026-01-29 21:11:29 +00:00
LeoVasanko 58b56a09a4 Restrict remote auth to the existing granting user's credentials. 2026-01-29 20:24:26 +00:00
LeoVasanko 731b36b456 Cleanup auth WS code, refactor to remove duplication and pass proper context. 2026-01-29 20:15:01 +00:00
LeoVasanko 8f9cd1124c Add missing context on update_session. 2026-01-29 19:51:56 +00:00
LeoVasanko 7e49ef296a Create a stand-alone paskia npm package (paskia-js). Make the frontend use it (but from source tree to keep synced). 2026-01-29 19:46:26 +00:00
LeoVasanko af35ff3d4c Add a screenshot. 2026-01-29 19:15:17 +00:00
LeoVasanko dac1415a86 More of a normal white path color. 2026-01-29 16:57:30 +00:00
LeoVasanko 433844cf08 Refactor to separate paskia lib functionality generally useful for various apps. 2026-01-29 16:55:46 +00:00
LeoVasanko c9ea1c8948 Consistent and stronger session revalidation checks in Auth profile and Admin App. Fix missing handling of link generation network errors. 2026-01-29 16:02:29 +00:00
LeoVasanko 58f46c6abf Logging cleanup, better colors, suppress more useless messages. Enable reloading in devmode again (needs uvicorn.run to function). 2026-01-29 14:48:59 +00:00
LeoVasanko 7c4418e631 Smarter change logging on console. 2026-01-28 23:22:03 +00:00
LeoVasanko 1648c8641f Improved access logging. 2026-01-28 23:01:35 +00:00
LeoVasanko 63eb088dbd Cleanup 2026-01-28 20:31:33 +00:00
LeoVasanko e88cc004dd Implement versioning in metadata, outside of the DB itself. Cleanup to migration handling and changes. Implement new migration step using msgspec normalization. 2026-01-28 20:21:09 +00:00
LeoVasanko 76921e8b31 Add migrate:msgspec for changes in schema that don't require version bump. Rename the other migrations to migrate:sql and migrate:v{N}. 2026-01-28 19:24:15 +00:00
LeoVasanko c1b0aab296 Cleanup 2026-01-28 19:17:24 +00:00
LeoVasanko 8f89bb6d4b Modules missing git add 2026-01-28 19:04:18 +00:00
LeoVasanko d16d1ed1c2 Make database changes outside of transaction a fatal error. Fix bootstrap and migrate to work with various latest changes. 2026-01-28 19:04:00 +00:00
LeoVasanko 2cfca81672 Fix a bug with validate returning 401 when a session was refreshed. Simplify & cleanup. 2026-01-28 18:45:02 +00:00
LeoVasanko ce300ebdaf API to use msgspec structs as well. 2026-01-28 18:31:45 +00:00
LeoVasanko 7329223784 Implement full ORM. Various other cleanup. 2026-01-28 17:19:56 +00:00
LeoVasanko c8d659b5ca Move get_session_context to DB.session_ctx(). 2026-01-28 14:52:18 +00:00
93 changed files with 4152 additions and 3645 deletions
+1 -1
View File
@@ -5,7 +5,7 @@ dist/
*.lock *.lock
package-lock.json package-lock.json
paskia.sqlite paskia.sqlite
paskia.jsonl *.paskiadb
/paskia/frontend-build /paskia/frontend-build
/paskia/_version.py /paskia/_version.py
coverage-html/ coverage-html/
+166 -19
View File
@@ -1,38 +1,47 @@
# Paskia # Paskia
![Login dialog screenshot](https://git.zi.fi/leovasanko/paskia/raw/main/docs/screenshots/login-light.webp)
An easy to install passkey-based authentication service that protects any web application with strong passwordless login. An easy to install passkey-based authentication service that protects any web application with strong passwordless login.
## What is Paskia? ## What is Paskia?
- Easy to use fully featured auth&auth system (login and permissions) - Easy to use fully featured auth&auth system (login and permissions)
- Organization and role-based access control (optional) - Organization and role-based access control
* Org admins control their users and roles * Org admins control their users and roles
* Master admin can create multiple independent orgs * Multiple independent orgs
* Master admin makes permissions available for orgs to assign * Master admin can do everything or delegate to org admins
- User Profile and Administration by API and web interface. - User Profile and Admin by API and web interface
under `/auth/` or `auth.example.com` - Implements login/reauth/forbidden flows for you
- Reset tokens and additional device linking via QR code or codewords. - Single Sign-On (SSO): Users register once and authenticate across your services
- Pure Python, FastAPI, packaged with prebuilt Vue frontend - Remote autentication by entering random keywords from another device (like 2fa)
- No CORS, NodeJS or anything extra needed.
## Authenticate to get to your app, or in your app
Two interfaces:
- API fetch: auth checks and login without leaving your app - API fetch: auth checks and login without leaving your app
- Forward-auth proxy: protect any unprotected site or service (Caddy, Nginx) - Forward-auth proxy: protect any unprotected site or service (Caddy, Nginx)
The API mode is useful for applications that can be customized to run with Paskia. Forward auth can also protect your javascript and other assets. Each provides fine-grained permission control and reauthentication requests where needed, and both can be mixed where needed. The API mode is useful for applications that can be customized to run with Paskia. Forward auth can also protect your javascript and other assets. Each provides fine-grained permission control and reauthentication requests where needed, and both can be mixed where needed.
Single Sign-On (SSO): Users register once and authenticate across all applications under your domain name (configured rp-id). ## Authentication flows already done
![Forbidden dialog, dark mode](https://git.zi.fi/leovasanko/paskia/raw/main/docs/screenshots/forbidden-dark.webp)
**Automatic light/dark mode switching with overrides by user profile and protected app's theme.**
Paskia includes set of login, reauthentication and forbidden dialogs that it can use to perform the needed flows. We never leave the URL, no redirections, and if you make use of API mode, we won't even interrupt whatever your app was doing but retry the blocked API fetch after login like nothing happened.
## Quick Start ## Quick Start
Install [UV](https://docs.astral.sh/uv/getting-started/installation/) and run: Install [UV](https://docs.astral.sh/uv/getting-started/installation/) and run:
```fish ```fish
uvx paskia serve --rp-id example.com uvx paskia --rp-id example.com
``` ```
On the first run it downloads the software and prints a registration link for the Admin. The server will start up on [localhost:4401](http://localhost:4401) *for authentication required*, serving for `*.example.com`. If you are going to be connecting `localhost` directly, for testing, leave out the rp-id. On the first run it downloads the software and prints a registration link for the Admin. The server starts on [localhost:4401](http://localhost:4401), serving authentication for `*.example.com`. For local testing, leave out `--rp-id`.
Otherwise you will need a web server such as [Caddy](https://caddyserver.com/) to serve HTTPS on your actual domain names and proxy requests to Paskia and your backend apps (see documentation below). For production you need a web server such as [Caddy](https://caddyserver.com/) to serve HTTPS on your actual domain names and proxy requests to Paskia and your backend apps (see documentation below).
For a permanent install of `paskia` CLI command, not needing `uvx`: For a permanent install of `paskia` CLI command, not needing `uvx`:
@@ -42,19 +51,157 @@ uv tool install paskia
## Configuration ## Configuration
There is no config file. Pass only the options on CLI: You will need to specify your main domain to which all passkeys will be tied as rp-id. Use your main domain even if Paskia is not running there. All other options are optional.
```text ```text
paskia serve [options] paskia [options]
``` ```
| Option | Description | Default | | Option | Description | Default |
|--------|-------------|---------| |--------|-------------|---------|
| Listen address | One of *host***:***port* (default all hosts, port 4401) or **unix:***path***/paskia.socket** (Unix socket) | **localhost:4401** | | -l, --listen *endpoint* | Listen address: *host*:*port*, :*port* (all interfaces), or */path.sock* | **localhost:4401** |
| --rp-id *domain* | Main/top domain | **localhost** | | --rp-id *domain* | Main/top domain for passkeys | **localhost** |
| --rp-name *"text"* | Name of your company or site | Same as rp-id | | --rp-name *"text"* | Branding name for the entire system (passkey auth, login dialog). | Same as rp-id |
| --origin *url* | Explicitly list the domain names served | **https://**_rp-id_ | | --origin *url* | Only sites listed can login (repeatable) | rp-id and all subdomains |
| --auth-host *domain* | Dedicated authentication site (e.g., **auth.example.com**) | **Unspecified:** we use **/auth/** on **every** site under rp-id.| | --auth-host *url* | Dedicated authentication site, e.g. **auth.example.com** | Use **/auth/** path on each site |
| --save | Save current options to database | (only --rp-id required on further invocations) |
To clear a stored setting, pass an empty value like `--auth-host=`. The database is stored in `{rp-id}.paskiadb` in current directory. This can be overridden by environment `PASKIA_DB` if needed.
## Tutorial: From Local Testing to Production
This section walks you through a complete example, from running Paskia locally to protecting a real site in production.
### Step 1: Local Testing
For development and testing, run Paskia without any arguments:
```fish
paskia
```
This starts the server on [localhost:4401](http://localhost:4401) with passkeys bound to `localhost`. On first run, Paskia prints a registration link for the Master Admin—click it to register your first passkey.
### Step 2: Production Configuration
For a real deployment, configure Paskia with your domain name (rp-id). This enables SSO setup for that domain and any subdomains.
```fish
paskia --rp-id example.com --rp-name "Example Corp" --save
```
This binds passkeys to `*.example.com`. The `--rp-name` is shown to users during passkey registration. The `--save` option stores these settings in the database, so future runs only need `paskia --rp-id example.com`.
### Step 3: Set Up Caddy
Install [Caddy](https://caddyserver.com/) and copy the [auth folder](caddy/auth) to `/etc/caddy/auth`. Say your current unprotected Caddyfile looks like this:
```caddyfile
app.example.com {
reverse_proxy :3000
}
```
Add Paskia full site protection:
```caddyfile
app.example.com {
import auth/setup
handle {
import auth/require perm=myapp:login
reverse_proxy :3000
}
}
```
Run `systemctl reload caddy`. Now `app.example.com` requires the `myapp:login` permission. Try accessing it and you'll land on a login dialog.
### Step 4: Assign Permissions via Admin Panel
![Admin panel permissions](https://git.zi.fi/leovasanko/paskia/raw/main/docs/screenshots/master-permissions.webp)
1. Go to `app.example.com/auth/admin/`
2. Create a permission, give it a name and scope `myapp:login`
3. Assign it to Organization
4. In that organization, assign it to the Administration role
Now you have granted yourself the new permission.
Permission scopes are text identifiers with colons as separators that we can use for permission checks. The `myapp:` prefix is a convention to namespace permissions per application—you but you can use other forms as you see fit (urlsafe characters, no spaces allowed).
### Step 5: Add API Authentication to Your App
Your backend already receives `Remote-*` headers from Caddy's forward-auth. For frontend API calls, we provide a [JS paskia module](https://www.npmjs.com/package/paskia):
```js
import { apiJson } from 'https://cdn.jsdelivr.net/npm/paskia@latest/dist/paskia.js'
const data = await apiJson('/api/sensitive', { method: 'POST' })
```
When a 401/403 occurs, the auth dialog appears automatically, and the request retries after authentication.
To protect the API path with a different permission, update your Caddyfile:
```caddyfile
app.example.com {
import auth/setup
@api path /api/*
handle @api {
import auth/require perm=myapp:api
reverse_proxy :3000
}
handle {
import auth/require perm=myapp:login
reverse_proxy :3000
}
}
```
Create the `myapp:api` permission in the admin panel, that will be required for all API access. Link to `/auth/` for the built-in profile page.
You may also remove the `myapp:login` protection from the rest of your site paths, unless you wish to keep all your assets behind a login page. Having this as the last entry in your config allows free access to everything not matched by other sections.
```Caddyfile
handle {
reverse_proxy :3000
}
```
### Step 6: Run Paskia as a Service
Create a system user paskia, install UV on the system, and create a systemd unit:
```fish
sudo useradd --system --home-dir /srv/paskia --create-home paskia
curl -LsSf https://astral.sh/uv/install.sh | sudo env UV_INSTALL_DIR=/usr/local/bin sh
sudo systemctl edit --force --full paskia.service
```
Paste the following and save:
```ini
[Unit]
Description=Paskia Authentication Server
[Service]
Type=simple
User=paskia
WorkingDirectory=/srv/paskia
ExecStart=uvx paskia --rp-id=example.com
[Install]
WantedBy=multi-user.target
```
Then enable and start, view output for registration link:
```fish
sudo systemctl enable --now paskia && sudo journalctl -u paskia -f -n 20 -o cat
```
## Further Documentation ## Further Documentation
+188 -33
View File
@@ -1,43 +1,198 @@
# Integrating Paskia with your App # Integrating Paskia with your App
Protect API routes with forward-auth (see [Caddy configuration](Caddy.md)). Optionally protect your app assets and not just the API. This guide covers frontend and backend integration with Paskia. For Caddy forward-auth setup, see [Caddy configuration](Caddy.md).
Catch response status 401/403 in fetch calls to protected endpoints and implement authentication flow in this case. The response is JSON and contains `detail` (an error message describing what is needed) and `auth.iframe` (a URL). Render that URL in an iframe and retry the request after authentication (see below). ## Frontend Integration
While the app is in (active) use, call `/auth/api/validate` occasionally to keep the session alive (session lifetime is 24h), otherwise the user will have to login every day. Max-age limits are unaffected by this and can be used on endpoints needing to reauthenticate with passkey more frequently. ### Using the paskia-js Module
Fetch `/auth/api/user-info` to display user/session details, or link to `/auth/` if you prefer using the built-in profile UI and not having to do anything more. The [paskia](https://www.npmjs.com/package/paskia) JavaScript module provides utilities for API calls, session validation, and authentication overlays. Works with any framework or vanilla JS.
## Authentication Flow (iframe) ```html
<script type="module">
```js import { apiJson, apiFetch, SessionValidator } from 'https://cdn.jsdelivr.net/npm/paskia@latest/dist/paskia.js'
// Show an authentication dialog </script>
const iframe = document.createElement('iframe')
iframe.src = auth.url // from 401/403 response JSON
iframe.style.cssText = `
position: fixed;
inset: 0;
width: 100%;
height: 100%;
border: 0;
z-index: 9999;
background: transparent;
backdrop-filter: blur(0.1rem) brightness(0.7);
`
document.body.appendChild(iframe)
// Wait until user is finished with the dialog
const handler = ev => {
if (ev.origin !== location.origin) return
iframe.remove()
removeEventListener('message', handler)
if (ev.data?.type === 'auth-success') retry_original_fetch()
}
addEventListener('message', handler)
``` ```
This describes the frontend flow for handling 401/403 responses from endpoints protected by Paskia forward-auth, without ever exiting your app. Or install to your project:
When a protected request fails, the backend returns 401 (needs auth / reauth) or 403 (missing permission). For API requests, the response is JSON that includes an iframe URL. Your app should render that URL in a full-screen iframe overlay, and retry the request after the iframe reports success. If it reports `auth-cancel`, don't try again. The backdrop for the dialog is a stylistic choice, and you can style the background shown with the dialog any way you wish, and consider using CSS file with the iframe rather than inline styles as used in the example. ```sh
npm install paskia
```
Following this flow the user gets authenticated properly and after that your app keeps running as if nothing ever happened. ### API Fetch with Automatic Auth
Use `apiJson` or `apiFetch` for API calls. When a 401/403 response includes an auth URL, the authentication dialog appears automatically, then the request retries. The JSON variant is purely for convenience, doing JSON headers and conversions for you.
```js
import { apiJson, apiFetch, AuthCancelledError } from 'paskia'
// JSON API call (sets Content-Type, parses response)
try {
const data = await apiJson('/api/endpoint', { method: 'POST', body: { key: 'value' } })
} catch (e) {
if (e instanceof AuthCancelledError) {
// User cancelled auth dialog
}
}
// Raw fetch with auth handling (returns Response object)
const response = await apiFetch('/api/endpoint')
```
For requests that shouldn't trigger auth dialogs, use standard `fetch` or our `fetchJson`.
### Session Validation Polling
Keep sessions alive and detect when the user logs out or switches accounts:
```js
import { SessionValidator } from 'paskia'
const validator = new SessionValidator(
() => currentUser?.uuid, // getter for current user ID
(error) => handleSessionLost(error) // callback when session is lost or user changes
)
validator.start() // start polling (pauses on idle)
validator.stop() // stop polling
```
The validator calls `/auth/api/validate` periodically to:
- Renew the session cookie (24h lifetime)
- Detect if the user logged out or switched accounts
- Pause polling when the page is idle, allowing sessions to expire when not used
### Manual Auth Flow
If you need custom control, handle 401/403 responses manually:
```js
import { showAuthIframe, AuthCancelledError } from 'paskia'
const response = await fetch('/api/protected')
if (response.status === 401 || response.status === 403) {
const data = await response.json()
if (data.auth?.iframe) {
try {
await showAuthIframe(data.auth.iframe)
// Retry the original request
} catch (e) {
if (e instanceof AuthCancelledError) {
// User clicked Back
}
}
}
}
```
### User Info and Profile
Get current user details:
```js
const user = await apiJson('/auth/api/user-info', { method: 'POST' })
// Returns: { uuid, display_name, credentials, sessions, permissions, ... }
```
Or link to the built-in profile page: `/auth/`
## Backend Integration
### Using Forward-Auth Headers
When using Caddy forward-auth, your backend receives `Remote-*` headers on authenticated requests. See [Headers](Headers.md) for the full list.
```python
# Example: Python/FastAPI
@app.get("/api/data")
def get_data(request: Request):
user_id = request.headers.get("Remote-User")
org_id = request.headers.get("Remote-Org")
permissions = request.headers.get("Remote-Groups", "").split(",")
# ...
```
### Direct Validation from Backend
Your backend can validate sessions directly by calling Paskia's validate endpoint:
```python
import httpx
async def validate_session(request) -> dict:
"""Validate a session cookie and check permissions."""
authcookie = request.get("__Host-paskia")
response = await httpx.post(
"http://localhost:4401/auth/api/validate?perm=myapp:login+myapp:api",
headers={
"Host": request.headers["host"]
"X-Forwarded-For": request.client.host,
"Cookie": f"__Host-paskia={}",
},
)
if response.status_code != 200:
return response.json() # Return to client
# User authenticated... We are good to go!
ctx = response.json() # User and session information
```
This is useful for:
- WebSocket connections where headers aren't available after handshake
- Background jobs that need to verify a stored session
- APIs not behind forward-auth (auth/restrict)
### Validate Endpoint Parameters
`POST /auth/api/validate` accepts query parameters:
| Parameter | Description |
|-----------|-------------|
| `perm=scope:name` | Require this permission (repeatable) |
| `max_age=5min` | Require recent passkey use |
Returns 200 with user info on success, 401/403 on failure.
## Proxying /auth/ to Paskia
Your app server needs to proxy `/auth/` paths to Paskia. This can be done by your application but is much easier done by Caddy or Nginx.
### Caddy
This handles both HTTP and WebSocket connections. Caddy's `reverse_proxy` handles HTTP and WebSocket transparently. This is essentially what our Caddy [auth/setup](../caddy/auth/setup) snippet does: `reverse_proxy :4401`.
```caddyfile
app.example.com {
import auth/setup
# ... your routes in handle blocks
}
```
### Nginx
Certain headers need to be configured for correct host and WS support:
```nginx
location /auth/ {
proxy_pass http://localhost:4401;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_set_header Host $host;
}
```
### Node.js / Express
Using `http-proxy-middleware`:
```js
import { createProxyMiddleware } from 'http-proxy-middleware'
app.use('/auth', createProxyMiddleware({ target: 'http://localhost:4401', ws: true, changeOrigin: false }))
```
### Python / FastAPI
You will need to process and handle `/auth/` for HTTP requests and `/auth/ws/` for WebSockets manually, which is beyond the scope of this documentation.
We highly recommend Caddy instead as the simpler and more production-worthy solution that Just Works.
Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

+37 -106
View File
@@ -8,26 +8,6 @@
:root { :root {
color-scheme: light dark; /* Automatic themes by browser */ color-scheme: light dark; /* Automatic themes by browser */
} }
/* Login/reauth/forbidden dialog will appear in this iframe */
#auth-iframe {
/* Full viewport overlay */
border: none;
position: fixed;
top: 0;
left: 0;
width: 100%;
height: 100%;
z-index: 9999;
/* Optional transparent background with optional blur backdrop */
color-scheme: auto;
background: transparent;
backdrop-filter: blur(.1rem) brightness(0.7);
-webkit-backdrop-filter: blur(.1rem) brightness(0.7);
}
/* Prevent background scroll when auth-iframe is shown */
body:has(#auth-iframe) {
overflow: hidden;
}
</style> </style>
</head> </head>
<body> <body>
@@ -65,99 +45,50 @@
</div> </div>
</div> </div>
<script> <script type="module">
import { apiFetch, apiJson, AuthCancelledError } from '/paskia-js/dist/paskia.js'
const output = document.getElementById('output'); const output = document.getElementById('output');
let pendingCall = null; // Stores the API call to retry after auth
// The auth iframe posts messages when authentication completes or is cancelled.
// Message types: 'auth-success' (proceed), 'auth-back' (user cancelled)
// Errors during auth stay in the dialog allowing retry, no message is sent.
window.addEventListener('message', (event) => {
const { type, message } = event.data || {};
if (type === 'auth-success') {
log('✓ Authentication successful, retrying...');
hideAuthIframe();
// Retry the original API call that triggered authentication
if (pendingCall) {
const { url, method } = pendingCall;
pendingCall = null;
apiCall(url, method);
}
} else if (type === 'auth-back') {
log(message || 'Authentication cancelled');
hideAuthIframe();
pendingCall = null;
}
});
// Make an API call, handling 401/403 by showing the auth iframe.
// The server returns JSON with auth.iframe URL when authentication is needed.
async function apiCall(url, method = 'GET') {
log(`${method} ${url}...`);
const response = await fetch(url, { method });
// Server returns 401 (login/reauth) or 403 (missing permissions)
// with a JSON body containing the iframe URL for authentication
if (response.status === 401 || response.status === 403) {
const data = await response.json();
if (data.auth?.iframe) {
const mode = data.auth.mode; // 'login' or 'reauth'
log(`${mode === 'reauth' ? 'Re-authentication' : 'Authentication'} required...`);
pendingCall = { url, method };
showAuthIframe(data.auth.iframe);
return;
}
log(`Error: ${response.status} - ${data.detail}`);
return;
}
// Forward endpoint returns 204 on success (Caddy then adds Remote-* headers)
if (response.status === 204) {
log('✓ Success (204 No Content)\nHeaders:\n' +
[...response.headers].filter(([k]) => k.startsWith('remote-'))
.map(([k, v]) => ` ${k}: ${v}`).join('\n'));
return;
}
if (!response.ok) {
log(`Error: ${response.status} ${response.statusText}`);
return;
}
const data = await response.json();
log('✓ Response:\n' + JSON.stringify(data, null, 2));
}
async function logout() {
await fetch('/auth/api/logout', { method: 'POST' });
log('Logged out');
}
// Create fullscreen iframe for authentication.
// The 'allow' attribute enables WebAuthn (passkey) API inside the iframe.
function showAuthIframe(url) {
hideAuthIframe();
const iframe = document.createElement('iframe');
iframe.id = 'auth-iframe';
iframe.src = url;
document.body.appendChild(iframe);
log("Authentication dialog open...")
}
function hideAuthIframe() {
document.getElementById('auth-iframe')?.remove();
}
function log(msg) { function log(msg) {
output.textContent = msg; output.textContent = msg;
} }
// Make an API call using paskia module (handles 401/403 automatically)
window.apiCall = async function(url, method = 'GET') {
log(`${method} ${url}...`);
try {
const response = await apiFetch(url, { method });
// Forward endpoint returns 204 on success
if (response.status === 204) {
log('✓ Success (204 No Content)');
return;
}
if (!response.ok) {
log(`Error: ${response.status} ${response.statusText}`);
return;
}
const data = await response.json();
log('✓ Response:\n' + JSON.stringify(data, null, 2));
} catch (e) {
if (e instanceof AuthCancelledError) {
log('Authentication cancelled');
} else {
log(`Error: ${e.message}`);
}
}
}
window.logout = async function() {
await fetch('/auth/api/logout', { method: 'POST' });
log('Logged out');
}
// Browser mode: open the forward endpoint directly in a new window. // Browser mode: open the forward endpoint directly in a new window.
// When Accept: text/html, the server redirects to the login page if needed, window.browserNav = function(url) {
// then back to the original URL after authentication.
function browserNav(url) {
log('Opening in new window...\nIf not authenticated, you\'ll see the login page.\nAfter auth, you\'ll see a 204 response (blank page = success).'); log('Opening in new window...\nIf not authenticated, you\'ll see the login page.\nAfter auth, you\'ll see a 204 response (blank page = success).');
window.open(url, '_blank'); window.open(url, '_blank');
} }
+14 -48
View File
@@ -13,7 +13,8 @@
<script setup> <script setup>
import { computed, onMounted, onUnmounted, ref } from 'vue' import { computed, onMounted, onUnmounted, ref } from 'vue'
import { useAuthStore } from '@/stores/auth' import { useAuthStore } from '@/stores/auth'
import { apiJson, getAuthIframeUrl } from '@/utils/api' import { apiJson, SessionValidator, createAuthIframe, removeAuthIframe } from 'paskia'
import { getAuthIframeUrl } from '@/utils/api'
import StatusMessage from '@/components/StatusMessage.vue' import StatusMessage from '@/components/StatusMessage.vue'
import ProfileView from '@/components/ProfileView.vue' import ProfileView from '@/components/ProfileView.vue'
import HostProfileView from '@/components/HostProfileView.vue' import HostProfileView from '@/components/HostProfileView.vue'
@@ -46,19 +47,23 @@ const isHostMode = computed(() => {
const configuredHost = normalizeHost(authHost) const configuredHost = normalizeHost(authHost)
return currentHost !== configuredHost return currentHost !== configuredHost
}) })
let validationTimer = null const userUuid = computed(() => store.userInfo?.ctx.user.uuid)
let authIframe = null
function terminateSession() { function terminateSession() {
store.userInfo = null store.userInfo = null
viewState.value = 'terminal' viewState.value = 'terminal'
} }
const userUuidGetter = () => store.userInfo?.ctx.user.uuid
const sessionValidator = new SessionValidator(userUuidGetter, terminateSession)
onMounted(() => sessionValidator.start())
onUnmounted(() => sessionValidator.stop())
async function loadUserInfo() { async function loadUserInfo() {
try { try {
store.userInfo = await apiJson('/auth/api/user-info', { method: 'POST' }) store.userInfo = await apiJson('/auth/api/user-info', { method: 'POST' })
viewState.value = 'profile' viewState.value = 'profile'
startSessionValidation()
return true return true
} catch { } catch {
store.userInfo = null store.userInfo = null
@@ -67,27 +72,11 @@ async function loadUserInfo() {
} }
async function showAuthIframe() { async function showAuthIframe() {
// Remove existing iframe if any
hideAuthIframe()
// Create new iframe for authentication using src URL
const url = await getAuthIframeUrl('login') const url = await getAuthIframeUrl('login')
authIframe = document.createElement('iframe') createAuthIframe(url)
authIframe.id = 'auth-iframe'
authIframe.title = 'Authentication'
authIframe.allow = 'publickey-credentials-get; publickey-credentials-create'
authIframe.src = url
document.body.appendChild(authIframe)
loadingMessage.value = 'Authentication required...' loadingMessage.value = 'Authentication required...'
} }
function hideAuthIframe() {
if (authIframe) {
authIframe.remove()
authIframe = null
}
}
function handleAuthMessage(event) { function handleAuthMessage(event) {
const data = event.data const data = event.data
if (!data?.type) return if (!data?.type) return
@@ -95,7 +84,7 @@ function handleAuthMessage(event) {
switch (data.type) { switch (data.type) {
case 'auth-success': case 'auth-success':
// Authentication successful - reload user info // Authentication successful - reload user info
hideAuthIframe() removeAuthIframe()
viewState.value = 'loading' viewState.value = 'loading'
loadingMessage.value = 'Loading user profile...' loadingMessage.value = 'Loading user profile...'
loadUserInfo() loadUserInfo()
@@ -117,39 +106,17 @@ function handleAuthMessage(event) {
case 'auth-back': case 'auth-back':
// User clicked Back - show terminal state // User clicked Back - show terminal state
hideAuthIframe() removeAuthIframe()
terminateSession() terminateSession()
break break
case 'auth-close-request': case 'auth-close-request':
// Legacy support - treat as back // Legacy support - treat as back
hideAuthIframe() removeAuthIframe()
break break
} }
} }
async function validateSession() {
try {
await apiJson('/auth/api/validate', { method: 'POST' })
} catch {
stopSessionValidation()
terminateSession()
}
}
function startSessionValidation() {
// Validate session every 2 minutes
stopSessionValidation()
validationTimer = setInterval(validateSession, 2 * 60 * 1000)
}
function stopSessionValidation() {
if (validationTimer) {
clearInterval(validationTimer)
validationTimer = null
}
}
onMounted(async () => { onMounted(async () => {
// Listen for postMessage from auth iframe // Listen for postMessage from auth iframe
window.addEventListener('message', handleAuthMessage) window.addEventListener('message', handleAuthMessage)
@@ -178,8 +145,7 @@ onMounted(async () => {
onUnmounted(() => { onUnmounted(() => {
window.removeEventListener('message', handleAuthMessage) window.removeEventListener('message', handleAuthMessage)
stopSessionValidation() removeAuthIframe()
hideAuthIframe()
}) })
</script> </script>
+61 -18
View File
@@ -12,7 +12,7 @@ import AdminUserDetail from '@/admin/AdminUserDetail.vue'
import AdminDialogs from '@/admin/AdminDialogs.vue' import AdminDialogs from '@/admin/AdminDialogs.vue'
import { useAuthStore } from '@/stores/auth' import { useAuthStore } from '@/stores/auth'
import { adminUiPath, makeUiHref } from '@/utils/settings' import { adminUiPath, makeUiHref } from '@/utils/settings'
import { apiJson } from '@/utils/api' import { apiJson, SessionValidator } from 'paskia'
import { getDirection } from '@/utils/keynav' import { getDirection } from '@/utils/keynav'
import { goBack } from '@/utils/helpers' import { goBack } from '@/utils/helpers'
@@ -157,6 +157,21 @@ function clearSensitiveState() {
authenticated.value = false authenticated.value = false
} }
function onSessionLost(e) {
clearSensitiveState()
if (e.name === 'AuthCancelledError') {
showBackMessage.value = true
} else {
error.value = e.message
}
}
const userUuidGetter = () => info.value?.ctx.user.uuid
const sessionValidator = new SessionValidator(userUuidGetter, onSessionLost)
onMounted(() => sessionValidator.start())
onUnmounted(() => sessionValidator.stop())
async function load() { async function load() {
loading.value = true loading.value = true
loadingMessage.value = 'Loading...' loadingMessage.value = 'Loading...'
@@ -177,12 +192,7 @@ async function load() {
} }
} else parseHash() } else parseHash()
} catch (e) { } catch (e) {
clearSensitiveState() onSessionLost(e)
if (e.name === 'AuthCancelledError') {
showBackMessage.value = true
} else {
error.value = e.message
}
} finally { } finally {
loading.value = false loading.value = false
} }
@@ -229,12 +239,44 @@ function deleteOrg(org) {
function createUserInRole(org, role) { openDialog('user-create', { org, role }) } function createUserInRole(org, role) { openDialog('user-create', { org, role }) }
async function moveUserToRole(org, user, targetRoleDisplayName) { function deleteUser(user, userDetail) {
if (user.role === targetRoleDisplayName) return const credentialCount = userDetail?.credentials?.length || 0
const userUuid = user.uuid
const userName = user.display_name
const orgUuid = user.org // org UUID is stored in selectedUser
if (credentialCount === 0) {
// No credentials, safe to delete directly
performUserDeletion(userUuid, userName, orgUuid)
return
}
const passkeys = credentialCount === 1 ? '1 passkey' : `${credentialCount} passkeys`
openDialog('confirm', {
message: `Delete user "${userName}" with ${passkeys}? This action cannot be undone.`,
action: async () => {
await performUserDeletion(userUuid, userName, orgUuid)
}
})
}
async function performUserDeletion(userUuid, userName, orgUuid) {
try { try {
await apiJson(`/auth/api/admin/orgs/${org.uuid}/users/${user.uuid}/role`, { await apiJson(`/auth/api/admin/users/${userUuid}`, { method: 'DELETE' })
authStore.showMessage(`User "${userName}" deleted.`, 'success', 2500)
await loadOrgs()
window.location.hash = `#org/${orgUuid}`
} catch (e) {
authStore.showMessage(e.message || 'Failed to delete user', 'error')
}
}
async function moveUserToRole(user, targetRoleUuid) {
if (user.role_uuid === targetRoleUuid) return
try {
await apiJson(`/auth/api/admin/users/${user.uuid}/role`, {
method: 'PATCH', method: 'PATCH',
body: { role: targetRoleDisplayName } body: { role_uuid: targetRoleUuid }
}) })
await loadOrgs() await loadOrgs()
} catch (e) { } catch (e) {
@@ -258,7 +300,7 @@ function onRoleDrop(e, org, role) {
const data = JSON.parse(e.dataTransfer.getData('text/plain')) const data = JSON.parse(e.dataTransfer.getData('text/plain'))
if (data.org !== org.uuid) return // only within same org if (data.org !== org.uuid) return // only within same org
const user = org.roles.flatMap(r => r.users).find(u => u.uuid === data.user_uuid) const user = org.roles.flatMap(r => r.users).find(u => u.uuid === data.user_uuid)
if (user) moveUserToRole(org, user, role.display_name) if (user) moveUserToRole(user, role.uuid)
} catch (_) { /* ignore */ } } catch (_) { /* ignore */ }
} }
@@ -269,7 +311,7 @@ function updateRole(role) { openDialog('role-update', { role, name: role.display
function deleteRole(role) { function deleteRole(role) {
// UI only allows deleting empty roles, so no confirmation needed // UI only allows deleting empty roles, so no confirmation needed
apiJson(`/auth/api/admin/orgs/${role.org}/roles/${role.uuid}`, { method: 'DELETE' }) apiJson(`/auth/api/admin/roles/${role.uuid}`, { method: 'DELETE' })
.then(() => { .then(() => {
authStore.showMessage(`Role "${role.display_name}" deleted.`, 'success', 2500) authStore.showMessage(`Role "${role.display_name}" deleted.`, 'success', 2500)
loadOrgs() loadOrgs()
@@ -289,7 +331,7 @@ async function toggleRolePermission(role, pid, checked) {
try { try {
const method = checked ? 'POST' : 'DELETE' const method = checked ? 'POST' : 'DELETE'
await apiJson(`/auth/api/admin/orgs/${role.org}/roles/${role.uuid}/permissions/${pid}`, { await apiJson(`/auth/api/admin/roles/${role.uuid}/permissions/${pid}`, {
method method
}) })
await loadOrgs() await loadOrgs()
@@ -396,7 +438,7 @@ const breadcrumbEntries = computed(() => {
watch(selectedUser, async (u) => { watch(selectedUser, async (u) => {
if (!u) { userDetail.value = null; return } if (!u) { userDetail.value = null; return }
try { try {
userDetail.value = await apiJson(`/auth/api/admin/orgs/${u.org}/users/${u.uuid}`) userDetail.value = await apiJson(`/auth/api/admin/users/${u.uuid}`)
} catch (e) { } catch (e) {
userDetail.value = { error: e.message } userDetail.value = { error: e.message }
} }
@@ -532,7 +574,7 @@ async function refreshUserDetail() {
await loadOrgs() await loadOrgs()
if (selectedUser.value) { if (selectedUser.value) {
try { try {
userDetail.value = await apiJson(`/auth/api/admin/orgs/${selectedUser.value.org}/users/${selectedUser.value.uuid}`) userDetail.value = await apiJson(`/auth/api/admin/users/${selectedUser.value.uuid}`)
} catch (e) { authStore.showMessage(e.message || 'Failed to reload user', 'error') } } catch (e) { authStore.showMessage(e.message || 'Failed to reload user', 'error') }
} }
} }
@@ -594,7 +636,7 @@ async function submitDialog() {
// Close dialog immediately, then perform async operation // Close dialog immediately, then perform async operation
closeDialog() closeDialog()
apiJson(`/auth/api/admin/orgs/${role.org}/roles/${role.uuid}`, { method: 'PATCH', body: { display_name: name } }) apiJson(`/auth/api/admin/roles/${role.uuid}`, { method: 'PATCH', body: { display_name: name } })
.then(() => { .then(() => {
authStore.showMessage(`Role renamed to "${name}".`, 'success', 2500) authStore.showMessage(`Role renamed to "${name}".`, 'success', 2500)
loadOrgs() loadOrgs()
@@ -622,7 +664,7 @@ async function submitDialog() {
// Close dialog immediately, then perform async operation // Close dialog immediately, then perform async operation
closeDialog() closeDialog()
apiJson(`/auth/api/admin/orgs/${user.org}/users/${user.uuid}/display-name`, { method: 'PATCH', body: { display_name: name } }) apiJson(`/auth/api/admin/users/${user.uuid}/display-name`, { method: 'PATCH', body: { display_name: name } })
.then(() => { .then(() => {
authStore.showMessage(`User renamed to "${name}".`, 'success', 2500) authStore.showMessage(`User renamed to "${name}".`, 'success', 2500)
onUserNameSaved() onUserNameSaved()
@@ -761,6 +803,7 @@ async function submitDialog() {
@edit-user-name="editUserName" @edit-user-name="editUserName"
@close-reg-modal="showRegModal = false" @close-reg-modal="showRegModal = false"
@navigate-out="handlePanelNavigateOut" @navigate-out="handlePanelNavigateOut"
@delete-user="deleteUser(selectedUser, userDetail)"
/> />
<AdminOrgDetail <AdminOrgDetail
v-else-if="selectedOrg" v-else-if="selectedOrg"
+3 -1
View File
@@ -3,7 +3,9 @@
<head> <head>
<meta charset="UTF-8" /> <meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Admin</title> <title>Admin</title>
<script>(localStorage.getItem('paskia-theme')==='dark'||localStorage.getItem('paskia-theme')!=='light'&&matchMedia('(prefers-color-scheme:dark)').matches)&&document.documentElement.classList.add('dark')</script>
<link rel="stylesheet" href="/src/assets/style.css">
</head> </head>
<body> <body>
<div id="admin-app"></div> <div id="admin-app"></div>
+2 -1
View File
@@ -1,4 +1,5 @@
import '@/assets/style.css' import { initThemeFromCache } from '@/utils/theme'
initThemeFromCache()
import { createApp } from 'vue' import { createApp } from 'vue'
import { createPinia } from 'pinia' import { createPinia } from 'pinia'
+2
View File
@@ -4,6 +4,8 @@
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Auth Profile</title> <title>Auth Profile</title>
<script>(localStorage.getItem('paskia-theme')==='dark'||localStorage.getItem('paskia-theme')!=='light'&&matchMedia('(prefers-color-scheme:dark)').matches)&&document.documentElement.classList.add('dark')</script>
<link rel="stylesheet" href="/src/assets/style.css">
</head> </head>
<body> <body>
<div id="app"></div> <div id="app"></div>
+2 -1
View File
@@ -1,4 +1,5 @@
import '@/assets/style.css' import { initThemeFromCache } from '@/utils/theme'
initThemeFromCache()
import { createApp } from 'vue' import { createApp } from 'vue'
import { createPinia } from 'pinia' import { createPinia } from 'pinia'
+4 -9
View File
@@ -8,7 +8,7 @@
</template> </template>
<script setup> <script setup>
import { computed, onMounted, ref } from 'vue' import { onMounted, ref } from 'vue'
import RestrictedAuth from '@/components/RestrictedAuth.vue' import RestrictedAuth from '@/components/RestrictedAuth.vue'
// Check if this is a remote auth URL: /auth/{token} // Check if this is a remote auth URL: /auth/{token}
@@ -30,14 +30,9 @@ function extractRemoteToken() {
return null return null
} }
// Detect mode from URL hash fragment // Parse URL hash fragment
const authMode = computed(() => { const hashParams = new URLSearchParams(window.location.hash.slice(1))
const params = new URLSearchParams(window.location.hash.slice(1)) const authMode = ['reauth', 'forbidden'].includes(hashParams.get('mode')) ? hashParams.get('mode') : 'login'
const mode = params.get('mode')
if (mode === 'reauth') return 'reauth'
if (mode === 'forbidden') return 'forbidden'
return 'login'
})
function postToParent(message) { function postToParent(message) {
if (window.parent && window.parent !== window) { if (window.parent && window.parent !== window) {
+2
View File
@@ -3,6 +3,8 @@
<head> <head>
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<script>{let t=localStorage.getItem('paskia-theme');if(t!=='light'&&t!=='dark')t=new URLSearchParams(location.hash.slice(1)).get('theme');(t==='dark'||t!=='light'&&matchMedia('(prefers-color-scheme:dark)').matches)&&document.documentElement.classList.add('dark')}</script>
<link rel="stylesheet" href="/src/assets/style.css">
</head> </head>
<body> <body>
<div id="app"></div> <div id="app"></div>
+1 -1
View File
@@ -1,6 +1,6 @@
import './theme.js'
import { createApp } from 'vue' import { createApp } from 'vue'
import RestrictedApi from './RestrictedApi.vue' import RestrictedApi from './RestrictedApi.vue'
import '@/assets/style.css'
import { initKeyboardNavigation } from '@/utils/keynav' import { initKeyboardNavigation } from '@/utils/keynav'
createApp(RestrictedApi).mount('#app') createApp(RestrictedApi).mount('#app')
+11
View File
@@ -0,0 +1,11 @@
// Early theme for restricted app - first URL param wins, then localStorage
import { applyTheme, getCachedTheme } from '@/utils/theme.js'
function getTheme() {
const params = new URLSearchParams(location.hash.slice(1))
return params.get('theme') || getCachedTheme() || ''
}
// Apply theme class to document root
applyTheme(getTheme())
addEventListener('hashchange', () => applyTheme(getTheme()))
+1 -1
View File
@@ -59,7 +59,7 @@
import { computed, onMounted, reactive, ref } from 'vue' import { computed, onMounted, reactive, ref } from 'vue'
import passkey from '@/utils/passkey' import passkey from '@/utils/passkey'
import { getSettings, uiBasePath } from '@/utils/settings' import { getSettings, uiBasePath } from '@/utils/settings'
import { apiJson, ApiError, getUserFriendlyErrorMessage } from '@/utils/api' import { apiJson, ApiError, getUserFriendlyErrorMessage } from 'paskia'
const status = reactive({ const status = reactive({
show: false, show: false,
+1
View File
@@ -10,6 +10,7 @@
}, },
"dependencies": { "dependencies": {
"@simplewebauthn/browser": "^13.1.2", "@simplewebauthn/browser": "^13.1.2",
"paskia": "file:../paskia-js",
"pinia": "^3.0.3", "pinia": "^3.0.3",
"qrcode": "^1.5.4", "qrcode": "^1.5.4",
"sirv": "^3.0.2", "sirv": "^3.0.2",
BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

+2 -2
View File
@@ -339,6 +339,7 @@ defineExpose({ focusFirstElement })
<strong class="role-name" :title="r.uuid"> <strong class="role-name" :title="r.uuid">
<span>{{ r.display_name }}</span> <span>{{ r.display_name }}</span>
<button @click="$emit('updateRole', r)" class="icon-btn" aria-label="Edit role" title="Edit role"></button> <button @click="$emit('updateRole', r)" class="icon-btn" aria-label="Edit role" title="Edit role"></button>
<button v-if="r.users.length === 0" @click="$emit('deleteRole', r)" class="icon-btn delete-icon" aria-label="Delete role" title="Delete role"></button>
</strong> </strong>
<div class="role-actions"> <div class="role-actions">
<button @click="$emit('createUserInRole', selectedOrg, r)" class="plus-btn" aria-label="Add user" title="Add user"></button> <button @click="$emit('createUserInRole', selectedOrg, r)" class="plus-btn" aria-label="Add user" title="Add user"></button>
@@ -369,9 +370,8 @@ defineExpose({ focusFirstElement })
</li> </li>
</ul> </ul>
</template> </template>
<div v-else class="empty-role" @keydown="e => handleEmptyRoleKeydown(e, roleIndex)"> <div v-else class="empty-role">
<p class="empty-text muted">No members</p> <p class="empty-text muted">No members</p>
<button @click="$emit('deleteRole', r)" class="icon-btn delete-icon" aria-label="Delete empty role" title="Delete role"></button>
</div> </div>
</div> </div>
</div> </div>
+26 -21
View File
@@ -5,7 +5,7 @@ import CredentialList from '@/components/CredentialList.vue'
import RegistrationLinkModal from '@/components/RegistrationLinkModal.vue' import RegistrationLinkModal from '@/components/RegistrationLinkModal.vue'
import SessionList from '@/components/SessionList.vue' import SessionList from '@/components/SessionList.vue'
import { useAuthStore } from '@/stores/auth' import { useAuthStore } from '@/stores/auth'
import { apiJson } from '@/utils/api' import { apiJson } from 'paskia'
import { getDirection, navigateButtonRow, focusPreferred, focusAtIndex } from '@/utils/keynav' import { getDirection, navigateButtonRow, focusPreferred, focusAtIndex } from '@/utils/keynav'
const props = defineProps({ const props = defineProps({
@@ -17,7 +17,7 @@ const props = defineProps({
navigationDisabled: { type: Boolean, default: false } navigationDisabled: { type: Boolean, default: false }
}) })
const emit = defineEmits(['generateUserRegistrationLink', 'goOverview', 'openOrg', 'onUserNameSaved', 'closeRegModal', 'editUserName', 'refreshUserDetail', 'navigateOut']) const emit = defineEmits(['generateUserRegistrationLink', 'goOverview', 'openOrg', 'onUserNameSaved', 'closeRegModal', 'editUserName', 'refreshUserDetail', 'navigateOut', 'deleteUser'])
const authStore = useAuthStore() const authStore = useAuthStore()
const terminatingSessions = ref({}) const terminatingSessions = ref({})
@@ -45,7 +45,7 @@ function handleEditName() {
async function handleDelete(credential) { async function handleDelete(credential) {
try { try {
const data = await apiJson(`/auth/api/admin/orgs/${props.selectedUser.org}/users/${props.selectedUser.uuid}/credentials/${credential.credential}`, { method: 'DELETE' }) const data = await apiJson(`/auth/api/admin/users/${props.selectedUser.uuid}/credentials/${credential.credential}`, { method: 'DELETE' })
if (data.status === 'ok') { if (data.status === 'ok') {
emit('onUserNameSaved') // Reuse to refresh user detail emit('onUserNameSaved') // Reuse to refresh user detail
} else { } else {
@@ -61,7 +61,7 @@ async function handleTerminateSession(session) {
if (!sessionId) return if (!sessionId) return
terminatingSessions.value = { ...terminatingSessions.value, [sessionId]: true } terminatingSessions.value = { ...terminatingSessions.value, [sessionId]: true }
try { try {
const data = await apiJson(`/auth/api/admin/orgs/${props.selectedUser.org}/users/${props.selectedUser.uuid}/sessions/${sessionId}`, { method: 'DELETE' }) const data = await apiJson(`/auth/api/admin/users/${props.selectedUser.uuid}/sessions/${sessionId}`, { method: 'DELETE' })
if (data.status === 'ok') { if (data.status === 'ok') {
if (data.current_session_terminated) { if (data.current_session_terminated) {
sessionStorage.clear() sessionStorage.clear()
@@ -83,6 +83,10 @@ async function handleTerminateSession(session) {
} }
} }
async function handleDeleteUser() {
emit('deleteUser')
}
// Handle user info section keynav // Handle user info section keynav
function handleUserInfoKeydown(event) { function handleUserInfoKeydown(event) {
if (hasActiveModal.value || props.navigationDisabled) return if (hasActiveModal.value || props.navigationDisabled) return
@@ -183,24 +187,27 @@ defineExpose({ focusFirstElement })
:loading="loading" :loading="loading"
:org-display-name="userDetail.org.display_name" :org-display-name="userDetail.org.display_name"
:role-name="userDetail.role" :role-name="userDetail.role"
:update-endpoint="`/auth/api/admin/orgs/${selectedUser.org}/users/${selectedUser.uuid}/display-name`" :update-endpoint="`/auth/api/admin/users/${selectedUser.uuid}/display-name`"
@saved="$emit('onUserNameSaved')" @saved="$emit('onUserNameSaved')"
@edit-name="handleEditName" @edit-name="handleEditName"
/> >
<div class="admin-actions">
<button
class="btn-primary"
@click="$emit('generateUserRegistrationLink', selectedUser)"
:disabled="loading"
>{{ userDetail?.credentials?.length ? 'Recovery Link' : 'Registration Link' }}</button>
<button
class="btn-danger"
@click="handleDeleteUser"
:disabled="loading"
title="Delete this user"
>Delete User</button>
</div>
</UserBasicInfo>
</div> </div>
<div v-if="userDetail?.error" class="error small">{{ userDetail.error }}</div> <div v-if="userDetail?.error" class="error small">{{ userDetail.error }}</div>
<template v-if="userDetail && !userDetail.error"> <template v-if="userDetail && !userDetail.error">
<div class="registration-actions" ref="regActionsRef" @keydown="handleRegActionsKeydown">
<button
class="btn-secondary reg-token-btn"
@click="$emit('generateUserRegistrationLink', selectedUser)"
:disabled="loading"
>Generate Registration Token</button>
<p class="matrix-hint muted">
Generate a one-time registration link so this user can register or add another passkey.
Copy the link from the dialog and send it to the user, or have the user scan the QR code on their device.
</p>
</div>
<section class="section-block" data-section="registered-passkeys"> <section class="section-block" data-section="registered-passkeys">
<div class="section-header"> <div class="section-header">
<h2>Registered Passkeys</h2> <h2>Registered Passkeys</h2>
@@ -238,7 +245,7 @@ defineExpose({ focusFirstElement })
</div> </div>
<RegistrationLinkModal <RegistrationLinkModal
v-if="showRegModal" v-if="showRegModal"
:endpoint="`/auth/api/admin/orgs/${selectedUser.org}/users/${selectedUser.uuid}/create-link`" :endpoint="`/auth/api/admin/users/${selectedUser.uuid}/create-link`"
:user-name="userDetail?.display_name || selectedUser.display_name" :user-name="userDetail?.display_name || selectedUser.display_name"
@close="$emit('closeRegModal')" @close="$emit('closeRegModal')"
@copied="onLinkCopied" @copied="onLinkCopied"
@@ -248,13 +255,11 @@ defineExpose({ focusFirstElement })
<style scoped> <style scoped>
.user-detail { display: flex; flex-direction: column; gap: var(--space-lg); } .user-detail { display: flex; flex-direction: column; gap: var(--space-lg); }
.admin-actions { display: flex; gap: 0.5rem; }
.actions { display: flex; flex-wrap: wrap; gap: var(--space-sm); align-items: center; } .actions { display: flex; flex-wrap: wrap; gap: var(--space-sm); align-items: center; }
.ancillary-actions { margin-top: -0.5rem; } .ancillary-actions { margin-top: -0.5rem; }
.reg-token-btn { align-self: flex-start; }
.registration-actions { display: flex; flex-direction: column; gap: 0.5rem; }
.icon-btn { background: none; border: none; color: var(--color-text-muted); padding: 0.2rem; border-radius: var(--radius-sm); cursor: pointer; transition: background 0.2s ease, color 0.2s ease; } .icon-btn { background: none; border: none; color: var(--color-text-muted); padding: 0.2rem; border-radius: var(--radius-sm); cursor: pointer; transition: background 0.2s ease, color 0.2s ease; }
.icon-btn:hover { color: var(--color-heading); background: var(--color-surface-muted); } .icon-btn:hover { color: var(--color-heading); background: var(--color-surface-muted); }
.matrix-hint { font-size: 0.8rem; color: var(--color-text-muted); }
.error { color: var(--color-danger-text); } .error { color: var(--color-danger-text); }
.small { font-size: 0.9rem; } .small { font-size: 0.9rem; }
.muted { color: var(--color-text-muted); } .muted { color: var(--color-text-muted); }
+85 -112
View File
@@ -1,28 +1,37 @@
@property --hue {
syntax: '<angle>';
inherits: true;
initial-value: 0.72turn;
}
:root { :root {
--font-sans: "Inter", "Inter var", "Segoe UI", system-ui, -apple-system, "Helvetica Neue", sans-serif; --font-sans: "Inter", "Inter var", "Segoe UI", system-ui, -apple-system, "Helvetica Neue", sans-serif;
--font-mono: "DM Mono", "JetBrains Mono", "SFMono-Regular", Menlo, Monaco, Consolas, "Liberation Mono", monospace; --font-mono: "DM Mono", "JetBrains Mono", "SFMono-Regular", Menlo, Monaco, Consolas, "Liberation Mono", monospace;
--color-canvas: #ffffff; --color-canvas: white;
--color-surface: #eff6ff; --color-surface: oklch(0.97 0.005 var(--hue));
--color-surface-subtle: #dbeafe; --color-surface-subtle: oklch(0.94 0.01 var(--hue));
--color-border: #2563eb; --color-dialog: white;
--color-border-strong: #1e40af; --color-border: oklch(0.8 0.02 var(--hue));
--color-heading: #1e3a8a; --color-border-strong: oklch(0.55 0.15 var(--hue));
--color-text: #1e293b; --color-heading: oklch(0.3 0.05 var(--hue));
--color-text-muted: #475569; --color-text: oklch(0.25 0.02 var(--hue));
--color-link: #1d4ed8; --color-text-muted: oklch(0.5 0.02 var(--hue));
--color-link-hover: #1e40af; --color-link: oklch(0.5 0.18 var(--hue));
--color-accent: #2563eb; --color-link-hover: oklch(0.45 0.2 var(--hue));
--color-accent-strong: #1e40af; --color-accent: oklch(0.55 0.2 var(--hue));
--color-accent-contrast: #ffffff; --color-accent-strong: oklch(0.45 0.2 var(--hue));
--color-success-text: #166534; --color-accent-contrast: white;
--color-success-bg: #dcfce7; --color-secondary: oklch(0.55 0.05 var(--hue));
--color-error-text: #b91c1c; --color-secondary-strong: oklch(0.45 0.05 var(--hue));
--color-error-bg: #fee2e2; --color-success-text: oklch(0.4 0.15 0.4turn);
--color-info-text: #1e40af; --color-success-bg: oklch(0.95 0.03 0.4turn);
--color-info-bg: #dbeafe; --color-error-text: oklch(0.45 0.2 0.07turn);
--color-danger: #dc2626; --color-error-bg: oklch(0.95 0.03 0.07turn);
--shadow-soft: 0 10px 30px rgba(30, 64, 175, 0.15); --color-info-text: oklch(0.45 0.15 var(--hue));
--color-info-bg: oklch(0.95 0.02 var(--hue));
--color-danger: oklch(0.55 0.22 0.07turn);
--shadow-soft: 0 0 .2rem black;
--radius-none: 0; --radius-none: 0;
--radius-sm: 4px; --radius-sm: 4px;
--radius-md: 6px; --radius-md: 6px;
@@ -39,30 +48,31 @@
--focus-ring: 0 0 0 2px var(--color-accent); --focus-ring: 0 0 0 2px var(--color-accent);
} }
@media (prefers-color-scheme: dark) { :root.dark {
:root { --color-canvas: oklch(0.15 0.03 var(--hue));
--color-canvas: #0f172a; --color-surface: oklch(0.18 0.03 var(--hue));
--color-surface: #141b2f; --color-surface-subtle: oklch(0.22 0.03 var(--hue));
--color-surface-subtle: #1b243b; --color-dialog: oklch(0.22 0.03 var(--hue));
--color-border: #25304a; --color-border: oklch(0.3 0.03 var(--hue));
--color-border-strong: #3d4d6b; --color-border-strong: oklch(0.4 0.04 var(--hue));
--color-heading: #fff; --color-heading: white;
--color-text: #e2e8f0; --color-text: oklch(0.9 0.01 var(--hue));
--color-text-muted: #94a3b8; --color-text-muted: oklch(0.7 0.02 var(--hue));
--color-link: #60a5fa; --color-link: oklch(0.7 0.15 var(--hue));
--color-link-hover: #93c5fd; --color-link-hover: oklch(0.8 0.12 var(--hue));
--color-accent: #60a5fa; --color-accent: oklch(0.7 0.15 var(--hue));
--color-accent-strong: #3b82f6; --color-accent-strong: oklch(0.6 0.18 var(--hue));
--color-accent-contrast: #0b1120; --color-accent-contrast: oklch(0.12 0.03 var(--hue));
--color-success-text: #34d399; --color-secondary: oklch(0.6 0.05 var(--hue));
--color-success-bg: #1a4d2e; --color-secondary-strong: oklch(0.5 0.05 var(--hue));
--color-error-text: #fca5a5; --color-success-text: oklch(0.75 0.15 0.4turn);
--color-error-bg: #4a1f1f; --color-success-bg: oklch(0.3 0.08 0.4turn);
--color-info-text: #bae6fd; --color-error-text: oklch(0.8 0.12 0.07turn);
--color-info-bg: #1e3a5f; --color-error-bg: oklch(0.3 0.08 0.07turn);
--color-danger: #f87171; --color-info-text: oklch(0.8 0.1 var(--hue));
--shadow-soft: 0 0 0 #000000; --color-info-bg: oklch(0.3 0.05 var(--hue));
} --color-danger: oklch(0.7 0.18 0.07turn);
--shadow-soft: 0 0 0 black;
} }
*, *,
@@ -78,7 +88,6 @@ html {
} }
body { body {
color-scheme: light dark;
overflow: auto; overflow: auto;
scrollbar-gutter: stable; scrollbar-gutter: stable;
height: 100%; height: 100%;
@@ -132,6 +141,7 @@ a:focus-visible {
} }
.view-root { .view-root {
position: relative;
flex: 1; flex: 1;
width: 100%; width: 100%;
display: flex; display: flex;
@@ -229,6 +239,7 @@ button {
gap: 0.4rem; gap: 0.4rem;
background: var(--color-surface); background: var(--color-surface);
color: var(--color-text); color: var(--color-text);
transition: box-shadow var(--transition-base), background var(--transition-base), border-color var(--transition-base);
} }
button:disabled { button:disabled {
@@ -237,43 +248,41 @@ button:disabled {
} }
.btn-primary { .btn-primary {
background: var(--color-accent); background: linear-gradient(to bottom, oklch(1 0 0 / 0.15), transparent 60%) var(--color-accent);
color: var(--color-accent-contrast); color: var(--color-accent-contrast);
border-color: var(--color-accent); border-color: var(--color-accent);
}
.btn-primary:hover:not(:disabled),
.btn-primary:focus-visible {
background: linear-gradient(to bottom, oklch(1 0 0 / 0.15), transparent 60%) var(--color-accent-strong);
border-color: var(--color-accent-strong);
box-shadow: var(--shadow-soft); box-shadow: var(--shadow-soft);
} }
.btn-primary:hover:not(:disabled) {
background: var(--color-accent-strong);
border-color: var(--color-accent-strong);
}
.btn-secondary { .btn-secondary {
background: transparent; background: linear-gradient(to bottom, oklch(1 0 0 / 0.15), transparent 60%) var(--color-secondary);
color: var(--color-text);
border-color: var(--color-border);
}
.btn-secondary:hover:not(:disabled) {
border-color: var(--color-border-strong);
background: var(--color-surface-subtle);
}
.btn-danger {
background: var(--color-danger);
color: var(--color-accent-contrast); color: var(--color-accent-contrast);
border-color: transparent; border-color: transparent;
} }
.btn-danger:hover:not(:disabled) { .btn-secondary:hover:not(:disabled),
filter: brightness(0.92); .btn-secondary:focus-visible {
background: linear-gradient(to bottom, oklch(1 0 0 / 0.15), transparent 60%) var(--color-secondary-strong);
box-shadow: var(--shadow-soft);
} }
/* Focus-visible outlines for buttons */ .btn-danger {
.btn-primary:focus-visible, background: linear-gradient(to bottom, oklch(1 0 0 / 0.15), transparent 60%) var(--color-danger);
.btn-secondary:focus-visible, color: var(--color-accent-contrast);
border-color: transparent;
}
.btn-danger:hover:not(:disabled),
.btn-danger:focus-visible { .btn-danger:focus-visible {
outline: 1px solid var(-webkit-focus-ring-color); background: linear-gradient(to bottom, oklch(1 0 0 / 0.15), transparent 60%) var(--color-danger);
filter: brightness(0.92);
box-shadow: var(--shadow-soft);
} }
input[type="text"], input[type="text"],
@@ -407,7 +416,7 @@ th {
.device-dialog, .device-dialog,
.modal { .modal {
background: var(--color-surface); background: var(--color-dialog);
border: 1px solid var(--color-border); border: 1px solid var(--color-border);
border-radius: var(--radius-md); border-radius: var(--radius-md);
width: min(520px, 100%); width: min(520px, 100%);
@@ -429,7 +438,7 @@ th {
.qr-code { .qr-code {
padding: 1rem; padding: 1rem;
background: #fff; background: white;
box-shadow: var(--shadow-soft); box-shadow: var(--shadow-soft);
} }
@@ -567,7 +576,7 @@ th {
} }
.btn-card-delete { background: transparent; border: none; color: var(--color-danger); padding: 0.35rem 0.5rem; font-size: 1.05rem; line-height: 1; border-radius: var(--radius-sm); cursor: pointer; display: inline-flex; align-items: center; justify-content: center; } .btn-card-delete { background: transparent; border: none; color: var(--color-danger); padding: 0.35rem 0.5rem; font-size: 1.05rem; line-height: 1; border-radius: var(--radius-sm); cursor: pointer; display: inline-flex; align-items: center; justify-content: center; }
.btn-card-delete:hover:not(:disabled) { background: #fee; } .btn-card-delete:hover:not(:disabled) { filter: brightness(0.85); }
.btn-card-delete:disabled { filter: opacity(0.4); cursor: not-allowed; } .btn-card-delete:disabled { filter: opacity(0.4); cursor: not-allowed; }
@@ -692,8 +701,8 @@ th {
width: 100vw; width: 100vw;
height: 100vh; height: 100vh;
background: transparent; background: transparent;
backdrop-filter: blur(.1rem) brightness(0.7); backdrop-filter: blur(.2rem) brightness(0.7);
-webkit-backdrop-filter: blur(.1rem) brightness(0.7); -webkit-backdrop-filter: blur(.2rem) brightness(0.7);
display: flex; display: flex;
align-items: center; align-items: center;
justify-content: center; justify-content: center;
@@ -711,7 +720,7 @@ th {
width: 100%; width: 100%;
max-width: 480px; max-width: 480px;
padding: 2rem; padding: 2rem;
background: var(--color-surface); background: var(--color-dialog);
border-radius: var(--radius-lg); border-radius: var(--radius-lg);
box-shadow: 0 20px 60px #1e293b; box-shadow: 0 20px 60px #1e293b;
border: 1px solid var(--color-border); border: 1px solid var(--color-border);
@@ -731,42 +740,6 @@ th {
} }
} }
/* Global backdrop controlled by api.js ref-counting */
body::before {
content: '';
position: fixed;
inset: 0;
z-index: 1099;
background: transparent;
backdrop-filter: blur(0) brightness(1);
-webkit-backdrop-filter: blur(0) brightness(1);
pointer-events: none;
visibility: hidden;
transition: all 0.2s ease-out;
}
body.has-backdrop::before {
-webkit-backdrop-filter: blur(.2rem) brightness(0.5);
backdrop-filter: blur(.2rem) brightness(0.5);
visibility: visible;
}
body.has-backdrop {
overflow: auto;
}
#auth-iframe {
border: none;
position: fixed;
top: 0;
left: 0;
width: 100%;
height: 100%;
z-index: 9999;
color-scheme: auto;
background: transparent;
}
.slot-machine { .slot-machine {
padding: 0.875rem 1rem; padding: 0.875rem 1rem;
background: var(--color-surface-hover, rgba(0, 0, 0, 0.03)); background: var(--color-surface-hover, rgba(0, 0, 0, 0.03));
+7 -5
View File
@@ -1,5 +1,8 @@
<template> <template>
<section class="view-root" data-view="profile"> <section class="view-root" data-view="profile">
<div class="theme-toggle">
<ThemeSelector />
</div>
<header class="view-header"> <header class="view-header">
<h1>User Profile</h1> <h1>User Profile</h1>
<Breadcrumbs ref="breadcrumbs" :entries="breadcrumbEntries" @keydown="handleBreadcrumbKeydown" /> <Breadcrumbs ref="breadcrumbs" :entries="breadcrumbEntries" @keydown="handleBreadcrumbKeydown" />
@@ -117,6 +120,7 @@
import { ref, onMounted, onUnmounted, computed, watch } from 'vue' import { ref, onMounted, onUnmounted, computed, watch } from 'vue'
import Breadcrumbs from '@/components/Breadcrumbs.vue' import Breadcrumbs from '@/components/Breadcrumbs.vue'
import CredentialList from '@/components/CredentialList.vue' import CredentialList from '@/components/CredentialList.vue'
import ThemeSelector from '@/components/ThemeSelector.vue'
import UserBasicInfo from '@/components/UserBasicInfo.vue' import UserBasicInfo from '@/components/UserBasicInfo.vue'
import Modal from '@/components/Modal.vue' import Modal from '@/components/Modal.vue'
import NameEditForm from '@/components/NameEditForm.vue' import NameEditForm from '@/components/NameEditForm.vue'
@@ -127,7 +131,7 @@ import { useAuthStore } from '@/stores/auth'
import { adminUiPath, makeUiHref } from '@/utils/settings' import { adminUiPath, makeUiHref } from '@/utils/settings'
import passkey from '@/utils/passkey' import passkey from '@/utils/passkey'
import { goBack } from '@/utils/helpers' import { goBack } from '@/utils/helpers'
import { apiJson } from '@/utils/api' import { apiJson } from 'paskia'
import { navigateButtonRow, focusPreferred, focusAtIndex, getDirection } from '@/utils/keynav' import { navigateButtonRow, focusPreferred, focusAtIndex, getDirection } from '@/utils/keynav'
const authStore = useAuthStore() const authStore = useAuthStore()
@@ -352,8 +356,6 @@ const saveName = async () => {
.logout-note { margin: 0.75rem 0 0; color: var(--color-text-muted); font-size: 0.875rem; } .logout-note { margin: 0.75rem 0 0; color: var(--color-text-muted); font-size: 0.875rem; }
.remote-auth-inline { display: flex; flex-direction: column; gap: 0.5rem; } .remote-auth-inline { display: flex; flex-direction: column; gap: 0.5rem; }
.remote-auth-label { display: block; margin: 0; font-size: 0.875rem; color: var(--color-text-muted); font-weight: 500; } .remote-auth-label { display: block; margin: 0; font-size: 0.875rem; color: var(--color-text-muted); font-weight: 500; }
.remote-auth-description { .remote-auth-description { font-size: 0.75rem; color: var(--color-text-muted); }
font-size: 0.75rem; .theme-toggle { position: absolute; top: var(--layout-padding); right: var(--layout-padding); }
color: var(--color-text-muted);
}
</style> </style>
@@ -3,14 +3,14 @@
<div class="device-dialog" role="dialog" aria-modal="true" aria-labelledby="regTitle"> <div class="device-dialog" role="dialog" aria-modal="true" aria-labelledby="regTitle">
<div class="reg-header-row"> <div class="reg-header-row">
<h2 id="regTitle" class="reg-title"> <h2 id="regTitle" class="reg-title">
📱 <span v-if="userName">Registration for {{ userName }}</span><span v-else>Add Another Device</span> 📱 <span v-if="userName">{{ tokenType === 'account recovery' ? 'Recovery' : 'Registration' }} for {{ userName }}</span><span v-else>Add Another Device</span>
</h2> </h2>
<button class="icon-btn" @click="$emit('close')" aria-label="Close" tabindex="-1"></button> <button class="icon-btn" @click="$emit('close')" aria-label="Close" tabindex="-1"></button>
</div> </div>
<div class="device-link-section"> <div class="device-link-section">
<p class="reg-help"> <p class="reg-help">
Scan this QR code on the new device, or copy the link and open it there. {{ helpText }}
</p> </p>
<QRCodeDisplay <QRCodeDisplay
@@ -33,11 +33,12 @@
</template> </template>
<script setup> <script setup>
import { ref, onMounted, onUnmounted, nextTick } from 'vue' import { ref, computed, onMounted, onUnmounted, nextTick } from 'vue'
import QRCodeDisplay from '@/components/QRCodeDisplay.vue' import QRCodeDisplay from '@/components/QRCodeDisplay.vue'
import { apiJson } from '@/utils/api' import { apiJson } from 'paskia'
import { formatDate } from '@/utils/helpers' import { formatDate } from '@/utils/helpers'
import { getDirection } from '@/utils/keynav' import { getDirection } from '@/utils/keynav'
import { useAuthStore } from '@/stores/auth'
const props = defineProps({ const props = defineProps({
endpoint: { type: String, required: true }, endpoint: { type: String, required: true },
@@ -46,19 +47,35 @@ const props = defineProps({
const emit = defineEmits(['close', 'copied']) const emit = defineEmits(['close', 'copied'])
const authStore = useAuthStore()
const dialog = ref(null) const dialog = ref(null)
const linkUrl = ref(null) const linkUrl = ref(null)
const expiresAt = ref(null) const expiresAt = ref(null)
const tokenType = ref(null)
const actionsRow = ref(null) const actionsRow = ref(null)
// Store the element that had focus before modal opened // Store the element that had focus before modal opened
const previouslyFocusedElement = ref(null) const previouslyFocusedElement = ref(null)
// Determine if this is an admin action for another user
const isAdminAction = computed(() => !!props.userName)
// Compute the help text based on token type and context
const helpText = computed(() => {
if (!isAdminAction.value) {
// User adding their own device
return 'Scan this QR code on the new device, or copy the link and open it there.'
}
// Admin action for another user
return `Send this link to ${props.userName}, or have them scan the QR code.`
})
async function generateLink() { async function generateLink() {
try { try {
const data = await apiJson(props.endpoint, { method: 'POST' }) const data = await apiJson(props.endpoint, { method: 'POST' })
if (data.url) { if (data.url) {
linkUrl.value = data.url linkUrl.value = data.url
expiresAt.value = data.expires ? new Date(data.expires) : null expiresAt.value = data.expires ? new Date(data.expires) : null
tokenType.value = data.token_type || null
// Show the dialog as modal // Show the dialog as modal
await nextTick() await nextTick()
@@ -73,7 +90,8 @@ async function generateLink() {
} else { } else {
emit('close') emit('close')
} }
} catch { } catch (e) {
authStore.showMessage(e.message || 'Failed to generate link', 'error')
emit('close') emit('close')
} }
} }
+1 -1
View File
@@ -53,7 +53,7 @@
<!-- Device info display (shown when 3 words match a request) --> <!-- Device info display (shown when 3 words match a request) -->
<div v-else-if="deviceInfo" class="device-info"> <div v-else-if="deviceInfo" class="device-info">
<p class="device-permit-text">Permit {{ deviceInfo.action === 'register' ? 'registration' : 'login' }} to <strong>{{ deviceInfo.host }}</strong></p> <p class="device-permit-text">Permit {{ deviceInfo.action === 'register' ? 'registration' : 'login' }} to <strong>{{ deviceInfo.host }}</strong></p>
<p class="device-meta">{{ deviceInfo.user_agent_pretty }}</p> <p class="device-meta">{{ deviceInfo.user_agent_pretty || '—' }}</p>
<p v-if="error" class="error-message" style="margin-top: 0.5rem;">{{ error }}</p> <p v-if="error" class="error-message" style="margin-top: 0.5rem;">{{ error }}</p>
+1 -1
View File
@@ -58,7 +58,7 @@
import { computed, nextTick, onMounted, onUnmounted, reactive, ref, watch } from 'vue' import { computed, nextTick, onMounted, onUnmounted, reactive, ref, watch } from 'vue'
import passkey from '@/utils/passkey' import passkey from '@/utils/passkey'
import { getSettings, uiBasePath } from '@/utils/settings' import { getSettings, uiBasePath } from '@/utils/settings'
import { fetchJson, getUserFriendlyErrorMessage } from '@/utils/api' import { fetchJson, getUserFriendlyErrorMessage } from 'paskia'
import RemoteAuthRequest from '@/components/RemoteAuthRequest.vue' import RemoteAuthRequest from '@/components/RemoteAuthRequest.vue'
import { focusDialogButton } from '@/utils/keynav' import { focusDialogButton } from '@/utils/keynav'
+1 -1
View File
@@ -30,7 +30,7 @@
@keydown="handleItemKeydown($event, session)" @keydown="handleItemKeydown($event, session)"
> >
<div class="item-top"> <div class="item-top">
<h4 class="item-title">{{ session.user_agent }}</h4> <h4 class="item-title">{{ session.user_agent || '—' }}</h4>
<div class="item-actions"> <div class="item-actions">
<span v-if="session.is_current && !hoveredIp && !hoveredCredentialUuid" class="badge badge-current">Current</span> <span v-if="session.is_current && !hoveredIp && !hoveredCredentialUuid" class="badge badge-current">Current</span>
<span v-else-if="hoveredSession?.id === session.id" class="badge badge-current">Selected</span> <span v-else-if="hoveredSession?.id === session.id" class="badge badge-current">Selected</span>
+48
View File
@@ -0,0 +1,48 @@
<template>
<div class="theme-selector" @click.stop>
<button v-for="t in themes" :key="t.value" class="theme-icon" :class="{ hidden: isHidden(t.value) }"
:style="{ top: getPos(t.value).y + 'px', left: getPos(t.value).x + 'px' }" :title="t.title"
@click="handleClick(t.value)">{{ t.icon }}</button>
</div>
</template>
<script setup>
import { ref, onMounted, onUnmounted } from 'vue'
import { apiJson } from 'paskia'
import { updateThemeFromSession, getCachedTheme } from '@/utils/theme'
const open = ref(false), closing = ref(false), closingValue = ref(null), selected = ref(getCachedTheme())
const themes = [{ value: '', icon: '🌓', title: 'Auto' }, { value: 'light', icon: '☀️', title: 'Light' }, { value: 'dark', icon: '🌙', title: 'Dark' }]
const center = { x: 16, y: 16 }
const expanded = { '': { x: 16, y: 0 }, light: { x: 0, y: 28 }, dark: { x: 32, y: 28 } }
const getPos = v => closing.value ? (v === closingValue.value ? center : expanded[v]) : open.value ? expanded[v] : (v === selected.value ? center : expanded[v])
const isHidden = v => closing.value ? v !== closingValue.value : !open.value && v !== selected.value
function close(v) {
closingValue.value = v
closing.value = true
setTimeout(() => { open.value = closing.value = false; closingValue.value = null }, 200)
}
function handleClick(v) {
if (!open.value) { open.value = true; return }
close(v)
setTimeout(() => {
selected.value = v
updateThemeFromSession({ user: { theme: v } }, true)
apiJson('/auth/api/user/theme', { method: 'PATCH', body: { theme: v } }).catch(() => {})
}, 200)
}
function onOutside(e) { if (open.value && !closing.value && !e.target.closest('.theme-selector')) close(selected.value) }
onMounted(() => document.addEventListener('click', onOutside))
onUnmounted(() => document.removeEventListener('click', onOutside))
</script>
<style scoped>
.theme-selector { position: relative; width: 2rem; height: 2rem; }
.theme-icon { position: absolute; transform: translate(-50%, -50%); background: none; border: none; font-size: 1.25rem; cursor: pointer; padding: 0.25rem; transition: top 0.2s, left 0.2s, opacity 0.15s; }
.theme-icon:hover, .theme-icon:focus-visible { transform: translate(-50%, -50%) scale(1.15); }
.theme-icon.hidden { opacity: 0; pointer-events: none; }
</style>
+3 -1
View File
@@ -1,7 +1,8 @@
import { defineStore } from 'pinia' import { defineStore } from 'pinia'
import { register, authenticate } from '@/utils/passkey' import { register, authenticate } from '@/utils/passkey'
import { getSettings } from '@/utils/settings' import { getSettings } from '@/utils/settings'
import { apiJson } from '@/utils/api' import { apiJson } from 'paskia'
import { updateThemeFromSession } from '@/utils/theme'
export const useAuthStore = defineStore('auth', { export const useAuthStore = defineStore('auth', {
state: () => ({ state: () => ({
@@ -86,6 +87,7 @@ export const useAuthStore = defineStore('auth', {
async loadUserInfo() { async loadUserInfo() {
try { try {
this.userInfo = await apiJson('/auth/api/user-info', { method: 'POST' }) this.userInfo = await apiJson('/auth/api/user-info', { method: 'POST' })
updateThemeFromSession(this.userInfo?.ctx)
console.log('User info loaded:', this.userInfo) console.log('User info loaded:', this.userInfo)
} catch (error) { } catch (error) {
// Suppress toast for 401/403 errors - the auth iframe will handle these // Suppress toast for 401/403 errors - the auth iframe will handle these
-373
View File
@@ -1,77 +1,3 @@
/**
* API fetch wrapper that handles authentication errors with iframe-based re-authentication.
*
* When a 401 or 403 response is received with an `auth` object containing `iframe` URL,
* this wrapper shows an authentication iframe and retries the original request after
* successful authentication.
*/
/** Default timeout for API requests in milliseconds */
const DEFAULT_TIMEOUT_MS = 1000
/**
* Custom error class for API errors with full response context.
*/
export class ApiError extends Error {
constructor(url, response, data) {
super(data?.detail || `Request failed: ${response.status}`)
this.name = 'ApiError'
this.url = url
this.status = response.status
this.statusText = response.statusText
this.data = data
}
}
/**
* Custom error class for network/timeout errors.
*/
export class NetworkError extends Error {
constructor(message, originalError = null) {
super(message)
this.name = 'NetworkError'
this.originalError = originalError
}
}
/**
* Error thrown when user cancels authentication.
*/
export class AuthCancelledError extends Error {
constructor() {
super('Authentication cancelled')
this.name = 'AuthCancelledError'
}
}
let authIframe = null
let authPromise = null
let authResolve = null
let authReject = null
// Global backdrop ref-count (works independently of Pinia store)
let backdropHolders = 0
/**
* Hold global backdrop (increment ref-count).
* Multiple callers can hold the backdrop; it only hides when all release.
*/
export function holdGlobalBackdrop() {
backdropHolders++
document.body.classList.add('has-backdrop')
}
/**
* Release global backdrop (decrement ref-count).
* Backdrop hides only when ref-count reaches zero.
*/
export function releaseGlobalBackdrop() {
backdropHolders = Math.max(0, backdropHolders - 1)
if (backdropHolders === 0) {
document.body.classList.remove('has-backdrop')
}
}
// Cache for auth iframe URL by mode // Cache for auth iframe URL by mode
const authIframeUrlCache = {} const authIframeUrlCache = {}
@@ -104,302 +30,3 @@ export async function getAuthIframeUrl(mode = 'login') {
} }
throw new Error('Unable to fetch auth iframe URL') throw new Error('Unable to fetch auth iframe URL')
} }
/**
* Check if an auth iframe is already open (from any source).
* @returns {boolean}
*/
export function isAuthIframeOpen() {
return !!document.getElementById('auth-iframe')
}
/**
* Show the authentication iframe and return a promise that resolves on success.
* If an auth iframe is already open (from any source), hooks into its completion.
* Uses global backdrop system to avoid flicker between auth and caller's UI.
* @param {string} iframeUrl - The URL for the iframe src
* @returns {Promise<void>}
* @throws {AuthCancelledError} - If authentication is cancelled by user
*/
export function showAuthIframe(iframeUrl) {
// If we already have a promise (from us), return it
if (authPromise) return authPromise
// If there's already an iframe in the DOM (from App.vue or elsewhere),
// create a promise that hooks into the message handler
if (document.getElementById('auth-iframe')) {
authPromise = new Promise((resolve, reject) => {
authResolve = resolve
authReject = reject
})
return authPromise
}
authPromise = new Promise((resolve, reject) => {
authResolve = resolve
authReject = reject
})
// Remove existing iframe if any
hideAuthIframe()
// Hold global backdrop for auth iframe
holdGlobalBackdrop()
// Create new iframe for authentication using src URL
authIframe = document.createElement('iframe')
authIframe.id = 'auth-iframe'
authIframe.title = 'Authentication'
authIframe.allow = 'publickey-credentials-get; publickey-credentials-create'
authIframe.src = iframeUrl
document.body.appendChild(authIframe)
return authPromise
}
function hideAuthIframe() {
if (authIframe) {
authIframe.remove()
authIframe = null
releaseGlobalBackdrop()
}
}
function handleAuthMessage(event) {
const data = event.data
if (!data?.type) return
switch (data.type) {
case 'auth-success':
hideAuthIframe()
if (authResolve) {
authResolve()
authPromise = null
authResolve = null
authReject = null
}
break
case 'auth-back':
case 'auth-close-request':
hideAuthIframe()
if (authReject) {
authReject(new AuthCancelledError())
authPromise = null
authResolve = null
authReject = null
}
break
case 'auth-error':
// Keep iframe open for retry, but if cancelled, treat as back
if (data.cancelled && authReject) {
hideAuthIframe()
authReject(new AuthCancelledError())
authPromise = null
authResolve = null
authReject = null
}
break
}
}
// Install global message listener
if (typeof window !== 'undefined') {
window.addEventListener('message', handleAuthMessage)
}
/**
* Fetch wrapper that handles auth errors with iframe-based re-authentication.
* Loops until successful or user cancels authentication.
*
* @param {string|URL} url - The URL to fetch
* @param {RequestInit} [options] - Fetch options
* @param {number} [options.timeout] - Timeout in ms (default: 10000, use 0 to disable)
* @returns {Promise<Response>} - The fetch response
* @throws {AuthCancelledError} - If authentication is cancelled by user
* @throws {NetworkError} - If network error or timeout occurs
*/
export async function apiFetch(url, options = {}) {
const { timeout = DEFAULT_TIMEOUT_MS, ...fetchOptions } = options
// Ensure credentials are included for cookie-based auth
fetchOptions.credentials = fetchOptions.credentials || 'include'
while (true) {
let response
try {
response = await fetch(url, {...fetchOptions, signal: timeout && AbortSignal.timeout(timeout)})
} catch (error) {
// Handle network errors and timeouts
if (error.name === 'TimeoutError') {
throw new NetworkError('Request timed out', error)
}
if (error.name === 'AbortError') {
// Re-throw abort errors as-is (user-initiated cancellation)
throw error
}
if (error.name === 'TypeError' && error.message === 'Failed to fetch') {
throw new NetworkError('Unable to connect to server', error)
}
throw new NetworkError(error.message || 'Network error', error)
}
// Check for auth errors (401/403)
if (response.status === 401 || response.status === 403) {
// Try to parse the response to get the iframe URL
let authInfo = null
try {
const data = await response.clone().json()
authInfo = data.auth
} catch {
// If we can't parse JSON, no iframe available
}
// Authenticate via iframe (only in top-level window)
if (authInfo?.iframe && window === window.top) {
// Show auth iframe (or wait for existing one) and retry on success
// showAuthIframe returns existing promise if iframe is already open
await showAuthIframe(authInfo.iframe)
continue // Retry the original request
}
}
return response
}
}
/**
* Convenience method for JSON API calls.
* Automatically sets Accept and Content-Type headers.
* Returns parsed JSON directly if response is ok, throws ApiError otherwise.
*
* @param {string|URL} url - The URL to fetch
* @param {RequestInit} [options] - Fetch options
* @returns {Promise<any>} - Parsed JSON response
* @throws {ApiError} - If response is not ok
* @throws {NetworkError} - If network error or timeout occurs
* @throws {AuthCancelledError} - If authentication is cancelled by user
*/
export async function apiJson(url, options = {}) {
const fetchOptions = { ...options }
// Set default headers, allowing caller overrides
fetchOptions.headers = {
'Accept': 'application/json',
...fetchOptions.headers,
}
// Set Content-Type for requests with JSON body
if (fetchOptions.body && typeof fetchOptions.body === 'object' && !(fetchOptions.body instanceof FormData)) {
fetchOptions.headers = {
'Content-Type': 'application/json',
...fetchOptions.headers,
}
fetchOptions.body = JSON.stringify(fetchOptions.body)
}
const response = await apiFetch(url, fetchOptions)
const data = await response.json()
if (!response.ok) {
throw new ApiError(url, response, data)
}
return data
}
/**
* Simple JSON fetch without auto-auth iframe handling.
* Use this in contexts where showing an auth iframe would be inappropriate
* (e.g., inside the auth iframe itself).
*
* @param {string|URL} url - The URL to fetch
* @param {RequestInit} [options] - Fetch options
* @returns {Promise<any>} - Parsed JSON response
* @throws {ApiError} - If response is not ok
*/
export async function fetchJson(url, options = {}) {
const fetchOptions = {
...options,
headers: {
'Accept': 'application/json',
...options.headers,
},
}
const response = await fetch(url, fetchOptions)
const data = await response.json()
if (!response.ok) {
throw new ApiError(url, response, data)
}
return data
}
/**
* Convert an error to a user-friendly message.
* @param {Error} error - The error to convert
* @returns {string} - User-friendly error message
*/
export function getUserFriendlyErrorMessage(error) {
if (error instanceof NetworkError) {
return error.message
}
if (error instanceof ApiError) {
return error.message
}
if (error.name === 'TimeoutError') {
return 'Request timed out'
}
if (error.name === 'TypeError' && error.message === 'Failed to fetch') {
return 'Unable to connect to server'
}
return error.message || 'An error occurred'
}
/**
* Check if an error should show a toast to the user.
* @param {Error} error - The error to check
* @returns {boolean} - Whether to show a toast
*/
export function shouldShowErrorToast(error) {
// Don't show toast for user cancellations
if (error instanceof AuthCancelledError) return false
if (error.name === 'AbortError') return false
// Don't show toast for 401/403 errors - the auth iframe will handle these
if (error instanceof ApiError && (error.status === 401 || error.status === 403)) return false
return true
}
/**
* Create an API caller with error handling (toast + console.error).
* Wraps apiJson calls with consistent error handling for apps.
*
* @param {Function} showMessage - Function to show toast messages: (message, type, duration) => void
* @returns {Function} - Wrapped apiJson that handles errors
*/
export function createApiCaller(showMessage) {
/**
* @param {string|URL} url - The URL to fetch
* @param {RequestInit} [options] - Fetch options
* @returns {Promise<any>} - Parsed JSON response, or undefined on error
*/
return async function apiCall(url, options = {}) {
try {
return await apiJson(url, options)
} catch (error) {
if (!shouldShowErrorToast(error)) {
throw error
}
// Log full error details
console.error(`API error for ${url}:`, error instanceof ApiError ? { status: error.status, statusText: error.statusText, data: error.data } : error)
// Show user-friendly toast
showMessage(getUserFriendlyErrorMessage(error), 'error', 4000)
throw error
}
}
}
export default apiFetch
+1 -1
View File
@@ -1,7 +1,7 @@
import { startRegistration, startAuthentication } from '@simplewebauthn/browser' import { startRegistration, startAuthentication } from '@simplewebauthn/browser'
import aWebSocket from '@/utils/awaitable-websocket' import aWebSocket from '@/utils/awaitable-websocket'
import { getSettings } from '@/utils/settings' import { getSettings } from '@/utils/settings'
import { showAuthIframe } from '@/utils/api' import { showAuthIframe } from 'paskia'
// Generic path normalizer: if an auth_host is configured and differs from current // Generic path normalizer: if an auth_host is configured and differs from current
// host, return absolute URL (scheme derived by aWebSocket). Otherwise, keep as-is. // host, return absolute URL (scheme derived by aWebSocket). Otherwise, keep as-is.
+46
View File
@@ -0,0 +1,46 @@
// Theme override utilities - shared across apps
// User preference or URL hash can force light/dark mode
const TRANSITION_ID = 'theme-transition'
const STORAGE_KEY = 'paskia-theme'
/** Apply theme by setting class on documentElement */
export function applyTheme(theme, element = document.documentElement, animate = false) {
// Add temporary transition for smooth theme change
if (animate) {
let transitionStyle = document.getElementById(TRANSITION_ID)
if (!transitionStyle) {
transitionStyle = document.createElement('style')
transitionStyle.id = TRANSITION_ID
transitionStyle.textContent = '*, *::before, *::after { transition: background-color 0.3s, color 0.3s, border-color 0.3s, box-shadow 0.3s !important; }'
document.head.appendChild(transitionStyle)
}
setTimeout(() => document.getElementById(TRANSITION_ID)?.remove(), 350)
}
// If no explicit theme, check system preference
const isDark = theme === 'dark' || (theme !== 'light' && matchMedia('(prefers-color-scheme:dark)').matches)
element.classList.toggle('dark', isDark)
}
/** Get theme from localStorage cache */
export function getCachedTheme() {
return localStorage.getItem(STORAGE_KEY) || ''
}
/** Cache theme in localStorage */
export function setCachedTheme(theme) {
if (theme) localStorage.setItem(STORAGE_KEY, theme)
else localStorage.removeItem(STORAGE_KEY)
}
/** Initialize theme from user preference (with localStorage cache for fast load) */
export function initThemeFromCache() {
applyTheme(getCachedTheme())
}
/** Update theme from session context (call after login/session load) */
export function updateThemeFromSession(ctx, animate = false) {
const theme = ctx?.user?.theme || ''
setCachedTheme(theme)
applyTheme(theme, document.documentElement, animate)
}
+6 -5
View File
@@ -1,17 +1,18 @@
/** /**
* FastAPI-Vue Vite Plugin * FastAPI-Vue Vite Plugin
* auto-upgrade@fastapi-vue-setup -- remove this if you edit the plugin
* *
* Configures Vite for FastAPI backend integration: * Configures Vite for FastAPI backend integration:
* - Proxies /api/* requests to the FastAPI backend * - Proxies /api/* requests to the FastAPI backend
* - Builds to the Python module's frontend-build directory * - Builds to the Python module's frontend-build directory
* *
* Environment variables (with defaults): * Options:
* FASTAPI_VUE_BACKEND_URL=http://localhost:5180 - Backend API URL for proxying * paths - Array of paths to proxy (default: ["/api"])
*/ */
const backendUrl = process.env.FASTAPI_VUE_BACKEND_URL || "http://localhost:5180"
export default function fastapiVue({ paths = ["/api"] } = {}) { export default function fastapiVue({ paths = ["/api"] } = {}) {
const backendUrl = process.env.PASKIA_BACKEND_URL || "http://localhost:4402"
// Build proxy configuration for each path // Build proxy configuration for each path
const proxy = {} const proxy = {}
for (const path of paths) { for (const path of paths) {
@@ -23,7 +24,7 @@ export default function fastapiVue({ paths = ["/api"] } = {}) {
} }
return { return {
name: "fastapi-vite", name: "vite-plugin-fastapi-paskia",
config: () => ({ config: () => ({
server: { proxy }, server: { proxy },
build: { build: {
+3 -1
View File
@@ -90,7 +90,9 @@ export default defineConfig(({ command }) => ({
} }
].filter(Boolean), ].filter(Boolean),
resolve: { resolve: {
alias: { '@': fileURLToPath(new URL('./src', import.meta.url)) } alias: {
'@': fileURLToPath(new URL('./src', import.meta.url)),
}
}, },
base: '/', base: '/',
server: { server: {
+30
View File
@@ -0,0 +1,30 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*
node_modules
.DS_Store
dist
dist-ssr
coverage
*.local
/cypress/videos/
/cypress/screenshots/
# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
*.tsbuildinfo
+131
View File
@@ -0,0 +1,131 @@
# Paskia
![Screenshot](https://git.zi.fi/leovasanko/paskia/raw/main/docs/screenshots/forbidden-light.webp)
JavaScript utilities for [Paskia authentication system](https://git.zi.fi/leovasanko/paskia) integration into web apps.
## Installation
### NPM
No framework dependencies. Works with any framework (Vue, React, Svelte, etc.) or vanilla JS. Typescript typing included.
```sh
npm install paskia
```
```js
import { ... } from 'paskia'
```
### Plain JavaScript
Fetch the module directly from a CDN, or [download](https://cdn.jsdelivr.net/npm/paskia@latest/dist/paskia.js) first and host yourself. No Node needed.
```html
<script type="module">
import { ... } from 'https://cdn.jsdelivr.net/npm/paskia@latest/dist/paskia.js'
</script>
```
## Features
### Session Validation
Refresh session and track its validity with automatic polling. Pauses on lack of user activity to avoid useless traffic and to allow session expiry even when the page is left open but idle. This monitors that the same account stays logged in but doesn't do any permission checks.
```js
import { SessionValidator } from 'paskia'
const validator = new SessionValidator(
() => currentUser?.uuid, // getter for current user ID that we track
(error) => handleSessionLost(error) // callback when session is lost
)
validator.start() // call at your app startup/login
validator.stop() // stop the system (optional)
```
### API Fetch Utilities
Enhanced fetch functions with automatic error handling and authentication retry:
```js
import { apiJson, apiFetch } from 'paskia'
// JSON API calls with automatic auth handling
const data = await apiJson('/api/endpoint', { method: 'POST', body: { key: 'value' } })
// Raw fetch with auth handling
const response = await apiFetch('/api/endpoint')
```
When a 401/403 response includes an auth iframe URL, the request automatically pauses, displays the authentication UI, and retries upon success. In case this is not needed, use standard `fetch` or our `fetchJson`.
The JSON variants set headers automatically, with body and response in JSON.
### Authentication Overlay
Normally you use apiJson/apiFetch and they handle this automatically. If you need to wire it yourself, on a 401/403 response that includes `auth.iframe`, call `showAuthIframe(...)` and then retry the original request.
The backend returns 401/403 responses with the correct URL for proper user feedback. Alternatively you may use `/auth/restricted/#mode=login`, `mode=reauth` or `mode=forbidden` to trigger the UX flow you need.
```js
import { showAuthIframe, AuthCancelledError } from 'paskia'
const response = await fetch('/api/protected')
if (response.status === 401 || response.status === 403) {
const data = await response.json()
if (data.auth?.iframe) {
await showAuthIframe(data.auth.iframe) // Raises AuthCancelledError if the user cancels
}
}
```
This resolves after the user authenticates (possibly with another account than previously), and you should usually retry the original API request. Note that successful authentication doesn't guarantee that the user still has rights to what originally failed.
### Shared Blur Backdrop
The authentication dialog displays with a blur backdrop (z-index 1099). The auth iframe uses z-index 9999. Your app dialogs should use z-index 11009998 to appear above the backdrop but below authentication.
The backdrop is also reusable/refcounted, so you can keep consistent visuals for your own dialogs:
```js
import { holdGlobalBackdrop, releaseGlobalBackdrop } from 'paskia'
holdGlobalBackdrop()
try {
await your.own.dialog()
} finally {
releaseGlobalBackdrop()
}
```
The backdrop only disappears after all holders have released it.
## Error Handling
### AuthCancelledError (apiFetch, apiJson, showAuthIframe)
If the user clicks Back in the authentication dialog, refusing to authenticate, `AuthCancelledError` is risen (as a response to postMessage from the iframe). The dialog closes as expected and it is up to the app how to continue from there.
- Do nothing if the app can continue despite the failed operation (no UI notification needed)
- Display a simple Access Denied page with suggestion/button to reload the page to try again
Do not retry automatically.
### UI feedback
A set of small utilities are available for determining whether the user needs a notification and to format the error message.
```js
import { getUserFriendlyErrorMessage, shouldShowErrorToast } from 'paskia'
try {
await apiJson('/api/action')
} catch (e) {
if (shouldShowErrorToast(e)) {
your.message.display(getUserFriendlyErrorMessage(e))
}
}
```
+41
View File
@@ -0,0 +1,41 @@
{
"name": "paskia",
"version": "0.1.3",
"description": "Paskia authentication utilities for JavaScript",
"author": "Leo Vasanko",
"license": "Unlicense",
"homepage": "https://git.zi.fi/LeoVasanko/paskia",
"repository": {
"type": "git",
"url": "https://github.com/LeoVasanko/paskia",
"directory": "paskia-js"
},
"type": "module",
"main": "./dist/paskia.js",
"types": "./dist/paskia.d.ts",
"exports": {
".": {
"types": "./dist/paskia.d.ts",
"import": "./dist/paskia.js"
}
},
"files": [
"dist"
],
"scripts": {
"build": "vite build",
"prepublishOnly": "npm run build"
},
"devDependencies": {
"typescript": "~5.8.0",
"vite": "^7.3.1",
"vite-plugin-dts": "^4.5.4"
},
"keywords": [
"auth",
"authentication",
"paskia",
"passkey",
"webauthn"
]
}
+146
View File
@@ -0,0 +1,146 @@
import { showAuthIframe, AuthCancelledError } from './overlay'
export { AuthCancelledError }
const DEFAULT_TIMEOUT_MS = 1000
export interface ApiFetchOptions extends RequestInit {
timeout?: number
}
export interface FetchJsonOptions extends Omit<RequestInit, 'body'> {
timeout?: number
body?: BodyInit | Record<string, unknown> | null
}
export class ApiError extends Error {
readonly url: string
readonly status: number
readonly statusText: string
readonly data: unknown
constructor(url: string, response: Response, data: unknown) {
super((data as { detail?: string })?.detail || `Request failed: ${response.status}`)
this.name = 'ApiError'
this.url = url
this.status = response.status
this.statusText = response.statusText
this.data = data
}
}
export class NetworkError extends Error {
readonly originalError: Error | null
constructor(message: string, originalError: Error | null = null) {
super(message)
this.name = 'NetworkError'
this.originalError = originalError
}
}
export async function apiFetch(url: string, options: ApiFetchOptions = {}): Promise<Response> {
const { timeout = DEFAULT_TIMEOUT_MS, ...fetchOptions } = options
fetchOptions.credentials = fetchOptions.credentials || 'include'
while (true) {
let response: Response
try {
response = await fetch(url, {...fetchOptions, signal: timeout ? AbortSignal.timeout(timeout) : undefined})
} catch (error) {
const err = error as Error
if (err.name === 'TimeoutError') {
throw new NetworkError('Request timed out', err)
}
if (err.name === 'AbortError') {
throw error
}
if (err.name === 'TypeError' && err.message === 'Failed to fetch') {
throw new NetworkError('Unable to connect to server', err)
}
throw new NetworkError(err.message || 'Network error', err)
}
if (response.status === 401 || response.status === 403) {
let data: { auth?: { iframe?: string } } | null = null
try {
data = await response.clone().json()
} catch {}
if (data?.auth?.iframe && window === window.top) {
await showAuthIframe(data.auth.iframe)
continue // Retry the original request after successful auth
}
}
return response
}
}
type FetchFn = (url: string, options?: RequestInit) => Promise<Response>
export async function apiJson<T = unknown>(url: string, options: FetchJsonOptions = {}): Promise<T> {
return fetchJson<T>(url, options, apiFetch)
}
export async function fetchJson<T = unknown>(url: string, options: FetchJsonOptions = {}, fetchFn: FetchFn = fetch): Promise<T> {
const headers: Record<string, string> = {
'Accept': 'application/json',
...(options.headers as Record<string, string>),
}
let body: BodyInit | undefined
if (options.body && typeof options.body === 'object' && !(options.body instanceof FormData)) {
headers['Content-Type'] = 'application/json'
body = JSON.stringify(options.body)
} else {
body = options.body as BodyInit
}
const opt: RequestInit = { ...options, headers, body }
const response = await fetchFn(url, opt)
const data = await response.json() as T
if (!response.ok) {
throw new ApiError(url, response, data)
}
return data
}
export function getUserFriendlyErrorMessage(error: Error): string {
if (error instanceof NetworkError) return error.message
if (error instanceof ApiError) return error.message
if (error.name === 'TimeoutError') return 'Request timed out'
if (error.name === 'TypeError' && error.message === 'Failed to fetch') {
return 'Unable to connect to server'
}
return error.message || 'An error occurred'
}
export function shouldShowErrorToast(error: Error): boolean {
if (error instanceof AuthCancelledError) return false
if (error.name === 'AbortError') return false
if (error instanceof ApiError && (error.status === 401 || error.status === 403)) return false
return true
}
type ShowMessageFn = (message: string, type: string, duration: number) => void
export function createApiCaller(showMessage: ShowMessageFn) {
return async function apiCall<T = unknown>(url: string, options: FetchJsonOptions = {}): Promise<T> {
try {
return await apiJson<T>(url, options)
} catch (error) {
if (!shouldShowErrorToast(error as Error)) {
throw error
}
const err = error as Error
console.error(`API error for ${url}:`, err instanceof ApiError ? { status: err.status, statusText: err.statusText, data: err.data } : err)
showMessage(getUserFriendlyErrorMessage(err), 'error', 4000)
throw error
}
}
}
export default apiFetch
+25
View File
@@ -0,0 +1,25 @@
export {
ApiError,
NetworkError,
AuthCancelledError,
apiFetch,
apiJson,
fetchJson,
getUserFriendlyErrorMessage,
shouldShowErrorToast,
createApiCaller,
} from './fetch'
export type { ApiFetchOptions, FetchJsonOptions } from './fetch'
export {
holdGlobalBackdrop,
releaseGlobalBackdrop,
isAuthIframeOpen,
hideAuthIframe,
showAuthIframe,
createAuthIframe,
removeAuthIframe,
} from './overlay'
export { SessionValidator } from './validate'
+166
View File
@@ -0,0 +1,166 @@
const AUTH_IFRAME_ID = 'paskia-iframe'
const STYLES_ID = 'paskia-dialog'
const STYLES_TEXT = `\
body::before {
content: '';
position: fixed;
inset: 0;
z-index: 1099;
background: transparent;
backdrop-filter: blur(0) brightness(1);
-webkit-backdrop-filter: blur(0) brightness(1);
pointer-events: none;
visibility: hidden;
transition: all 0.2s ease-out;
}
body.paskia-backdrop::before {
backdrop-filter: blur(.2rem) brightness(0.7);
-webkit-backdrop-filter: blur(.2rem) brightness(0.7);
visibility: visible;
}
body.paskia-backdrop {
overflow: auto;
}
#${AUTH_IFRAME_ID} {
border: none;
position: fixed;
top: 0;
left: 0;
width: 100%;
height: 100%;
z-index: 9999;
color-scheme: auto;
background: transparent;
}
`
let authIframe: HTMLIFrameElement | null = null
let authPromise: Promise<void> | null = null
let authResolve: (() => void) | null = null
let authReject: ((error: Error) => void) | null = null
let messageListenerInstalled = false
let backdropHolders = 0
function injectStyles(): void {
if (document.getElementById(STYLES_ID)) return
const style = document.createElement('style')
style.id = STYLES_ID
style.textContent = STYLES_TEXT
document.head.insertBefore(style, document.head.firstChild)
}
export class AuthCancelledError extends Error {
constructor() {
super('Authentication cancelled')
this.name = 'AuthCancelledError'
}
}
export function holdGlobalBackdrop(): void {
backdropHolders++
document.body.classList.add('paskia-backdrop')
}
export function releaseGlobalBackdrop(): void {
backdropHolders = Math.max(0, backdropHolders - 1)
if (backdropHolders === 0) {
document.body.classList.remove('paskia-backdrop')
}
}
export function isAuthIframeOpen(): boolean {
return !!document.getElementById(AUTH_IFRAME_ID)
}
export function hideAuthIframe(): void {
if (authIframe) {
authIframe.remove()
authIframe = null
releaseGlobalBackdrop()
}
}
function handleAuthMessage(event: MessageEvent): void {
const data = event.data as { type?: string }
if (!data?.type) return
switch (data.type) {
case 'auth-success':
hideAuthIframe()
if (authResolve) {
authResolve()
authPromise = null
authResolve = null
authReject = null
}
break
case 'auth-back':
hideAuthIframe()
if (authReject) {
authReject(new AuthCancelledError())
authPromise = null
authResolve = null
authReject = null
}
break
}
}
function ensureMessageListener(): void {
if (messageListenerInstalled) return
if (typeof window !== 'undefined') {
window.addEventListener('message', handleAuthMessage)
messageListenerInstalled = true
}
}
export function showAuthIframe(iframeUrl: string, title = 'Authentication'): Promise<void> {
injectStyles()
ensureMessageListener()
if (authPromise) return authPromise
if (document.getElementById(AUTH_IFRAME_ID)) {
authPromise = new Promise((resolve, reject) => {
authResolve = resolve
authReject = reject
})
return authPromise
}
authPromise = new Promise((resolve, reject) => {
authResolve = resolve
authReject = reject
})
hideAuthIframe()
holdGlobalBackdrop()
authIframe = document.createElement('iframe')
authIframe.id = AUTH_IFRAME_ID
authIframe.title = title
authIframe.src = iframeUrl
document.body.appendChild(authIframe)
return authPromise
}
export function createAuthIframe(iframeUrl: string, title = 'Authentication'): HTMLIFrameElement {
injectStyles()
const existing = document.getElementById(AUTH_IFRAME_ID)
if (existing) existing.remove()
const iframe = document.createElement('iframe')
iframe.id = AUTH_IFRAME_ID
iframe.title = title
iframe.src = iframeUrl
document.body.appendChild(iframe)
return iframe
}
export function removeAuthIframe(): void {
const iframe = document.getElementById(AUTH_IFRAME_ID)
if (iframe) iframe.remove()
}
+66
View File
@@ -0,0 +1,66 @@
import { apiJson } from './fetch'
const POLL_INTERVAL = 60 * 1000
const IDLE_TIMEOUT = 5 * 60 * 1000
export class SessionValidator {
private userUuidGetter: () => string | undefined
private onSessionLost: (error: Error) => void
private pollTimer: ReturnType<typeof setInterval> | null = null
private idleTimer: ReturnType<typeof setTimeout> | null = null
private active = false
constructor(userUuidGetter: () => string | undefined, onSessionLost: (error: Error) => void) {
this.userUuidGetter = userUuidGetter
this.onSessionLost = onSessionLost
this.resetIdleTimer = this.resetIdleTimer.bind(this)
}
resetIdleTimer(): void {
if (this.idleTimer) clearTimeout(this.idleTimer)
if (!this.active) this.startPolling()
this.idleTimer = setTimeout(() => this.stopPolling(), IDLE_TIMEOUT)
}
async validate(): Promise<void> {
try {
const data = await apiJson<{ ctx?: { user?: { uuid?: string } } }>('/auth/api/validate', { method: 'POST' })
const newUuid = data.ctx?.user?.uuid
if (newUuid !== this.userUuidGetter()) {
window.location.reload()
}
} catch (error) {
if ((error as Error).name !== 'NetworkError') {
this.stopPolling()
this.onSessionLost(error as Error)
}
}
}
startPolling(): void {
if (this.active) return
this.active = true
this.pollTimer = setInterval(() => this.validate(), POLL_INTERVAL)
}
stopPolling(): void {
this.active = false
if (this.pollTimer) {
clearInterval(this.pollTimer)
this.pollTimer = null
}
}
start(): void {
window.addEventListener('pointermove', this.resetIdleTimer)
window.addEventListener('pointerdown', this.resetIdleTimer)
this.resetIdleTimer()
}
stop(): void {
window.removeEventListener('pointermove', this.resetIdleTimer)
window.removeEventListener('pointerdown', this.resetIdleTimer)
if (this.idleTimer) clearTimeout(this.idleTimer)
this.stopPolling()
}
}
+15
View File
@@ -0,0 +1,15 @@
{
"compilerOptions": {
"target": "ES2020",
"module": "ESNext",
"moduleResolution": "bundler",
"strict": true,
"declaration": true,
"declarationDir": "./dist",
"outDir": "./dist",
"rootDir": "./src",
"lib": ["ES2020", "DOM"],
"skipLibCheck": true
},
"include": ["src/**/*.ts"]
}
+17
View File
@@ -0,0 +1,17 @@
import { defineConfig } from 'vite'
import { resolve } from 'node:path'
import { fileURLToPath } from 'node:url'
import dts from 'vite-plugin-dts'
const __dirname = fileURLToPath(new URL('.', import.meta.url))
export default defineConfig({
plugins: [dts({ rollupTypes: true })],
build: {
lib: {
entry: resolve(__dirname, 'src/index.ts'),
fileName: 'paskia',
formats: ['es'],
},
},
})
+5 -4
View File
@@ -10,6 +10,7 @@ This module provides functionality to:
import json import json
from collections.abc import Iterable from collections.abc import Iterable
from importlib.resources import files from importlib.resources import files
from uuid import UUID
__ALL__ = ["AAGUID", "filter"] __ALL__ = ["AAGUID", "filter"]
@@ -18,15 +19,15 @@ AAGUID_FILE = files("paskia") / "aaguid" / "combined_aaguid.json"
AAGUID: dict[str, dict] = json.loads(AAGUID_FILE.read_text(encoding="utf-8")) AAGUID: dict[str, dict] = json.loads(AAGUID_FILE.read_text(encoding="utf-8"))
def filter(aaguids: Iterable[str]) -> dict[str, dict]: def filter(aaguids: Iterable[UUID]) -> dict[str, dict]:
""" """
Get AAGUID information only for the provided set of AAGUIDs. Get AAGUID information only for the provided set of AAGUIDs.
Args: Args:
aaguids: Set of AAGUID strings that the user has credentials for aaguids: Iterable of AAGUIDs (UUIDs) that the user has credentials for
Returns: Returns:
Dictionary mapping AAGUID to authenticator information for only Dictionary mapping AAGUID string to authenticator information for only
the AAGUIDs that the user has and that we have data for the AAGUIDs that the user has and that we have data for
""" """
return {aaguid: AAGUID[aaguid] for aaguid in aaguids if aaguid in AAGUID} return {(s := str(a)): AAGUID[s] for a in aaguids if (s := str(a)) in AAGUID}
+4 -19
View File
@@ -8,7 +8,7 @@ independent of any web framework:
- Credential management - Credential management
""" """
from datetime import datetime, timezone from datetime import UTC, datetime
from typing import TYPE_CHECKING from typing import TYPE_CHECKING
from uuid import UUID from uuid import UUID
@@ -23,11 +23,11 @@ EXPIRES = SESSION_LIFETIME
def expires() -> datetime: def expires() -> datetime:
return datetime.now(timezone.utc) + EXPIRES return datetime.now(UTC) + EXPIRES
def reset_expires() -> datetime: def reset_expires() -> datetime:
return datetime.now(timezone.utc) + RESET_LIFETIME return datetime.now(UTC) + RESET_LIFETIME
def get_reset(token: str) -> "ResetToken": def get_reset(token: str) -> "ResetToken":
@@ -39,24 +39,9 @@ def get_reset(token: str) -> "ResetToken":
raise ValueError("This authentication link is no longer valid.") raise ValueError("This authentication link is no longer valid.")
def refresh_session_token(token: str, *, ip: str, user_agent: str):
"""Refresh a session extending its expiry."""
session_record = db.data().sessions.get(token)
if not session_record:
raise ValueError("Session not found or expired")
updated = db.update_session(
token,
ip=ip,
user_agent=user_agent,
expiry=expires(),
)
if not updated:
raise ValueError("Session not found or expired")
def delete_credential(credential_uuid: UUID, auth: str, host: str | None = None): def delete_credential(credential_uuid: UUID, auth: str, host: str | None = None):
"""Delete a specific credential for the current user.""" """Delete a specific credential for the current user."""
ctx = db.get_session_context(auth, hostutil.normalize_host(host)) ctx = db.data().session_ctx(auth, hostutil.normalize_host(host))
if not ctx: if not ctx:
raise ValueError("Session expired") raise ValueError("Session expired")
db.delete_credential(credential_uuid, ctx.user.uuid) db.delete_credential(credential_uuid, ctx.user.uuid)
+10 -11
View File
@@ -10,23 +10,23 @@ import asyncio
import logging import logging
from paskia import authsession, db, globals from paskia import authsession, db, globals
from paskia.util import hostutil, passphrase from paskia.util import hostutil
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)
# Shared log message template for admin reset links # Shared log message template for admin reset links
ADMIN_RESET_MESSAGE = """\ ADMIN_RESET_MESSAGE = """
%s
👤 Admin %s 👤 Admin %s
- Use this link to register a Passkey for the admin user! - Use this link to register a Passkey for the admin user!
""" """
def _log_reset_link(message: str, passphrase: str) -> str: def _log_reset_link(passphrase: str, message: str | None = None) -> str:
"""Log a reset link message and return the URL.""" """Log a reset link message and return the URL."""
reset_link = hostutil.reset_link_url(passphrase) reset_link = hostutil.reset_link_url(passphrase)
logger.info(ADMIN_RESET_MESSAGE, message, reset_link) if message:
logger.info(message)
logger.info(ADMIN_RESET_MESSAGE, reset_link)
return reset_link return reset_link
@@ -41,7 +41,7 @@ async def bootstrap_system() -> None:
reset_passphrase = db.bootstrap() reset_passphrase = db.bootstrap()
# Log the reset link (this is separate from the transaction log) # Log the reset link (this is separate from the transaction log)
_log_reset_link("✅ Bootstrap completed!", reset_passphrase) _log_reset_link(reset_passphrase, "✅ Bootstrap completed!")
async def check_admin_credentials() -> bool: async def check_admin_credentials() -> bool:
@@ -72,16 +72,15 @@ async def check_admin_credentials() -> bool:
if not db.get_user_credential_ids(admin_user.uuid): if not db.get_user_credential_ids(admin_user.uuid):
# Admin exists but has no credentials, create reset link # Admin exists but has no credentials, create reset link
logger.info("⚠️ Admin user has no credentials!")
token = passphrase.generate()
expiry = authsession.reset_expires() expiry = authsession.reset_expires()
db.create_reset_token( token = db.create_reset_token(
user_uuid=admin_user.uuid, user_uuid=admin_user.uuid,
passphrase=token,
expiry=expiry, expiry=expiry,
token_type="admin registration", token_type="admin registration",
) )
_log_reset_link("⚠️ Admin user has no credentials!", token) _log_reset_link(token)
return True return True
return False return False
+4 -6
View File
@@ -2,7 +2,7 @@
Database module for WebAuthn passkey authentication. Database module for WebAuthn passkey authentication.
Read: Access data() directly, use build_* to convert to public structs. Read: Access data() directly, use build_* to convert to public structs.
CTX: get_session_context(key) returns SessionContext with effective permissions. CTX: data().session_ctx(key) returns SessionContext with effective permissions.
Write: Functions validate and commit, or raise ValueError. Write: Functions validate and commit, or raise ValueError.
Usage: Usage:
@@ -13,7 +13,7 @@ Usage:
user = db.build_user(user_uuid) user = db.build_user(user_uuid)
# Context # Context
ctx = db.get_session_context(session_key) ctx = db.data().session_ctx(session_key)
# Write # Write
db.create_user(user) db.create_user(user)
@@ -49,7 +49,6 @@ from paskia.db.operations import (
delete_user, delete_user,
get_organization_users, get_organization_users,
get_reset_token, get_reset_token,
get_session_context,
get_user_credential_ids, get_user_credential_ids,
get_user_organization, get_user_organization,
init, init,
@@ -64,7 +63,7 @@ from paskia.db.operations import (
update_session, update_session,
update_user_display_name, update_user_display_name,
update_user_role, update_user_role,
update_user_role_in_organization, update_user_theme,
) )
from paskia.db.structs import ( from paskia.db.structs import (
DB, DB,
@@ -113,7 +112,6 @@ __all__ = [
# Read ops # Read ops
"get_organization_users", "get_organization_users",
"get_reset_token", "get_reset_token",
"get_session_context",
"get_user_credential_ids", "get_user_credential_ids",
"get_user_organization", "get_user_organization",
# Write ops # Write ops
@@ -148,5 +146,5 @@ __all__ = [
"update_session", "update_session",
"update_user_display_name", "update_user_display_name",
"update_user_role", "update_user_role",
"update_user_role_in_organization", "update_user_theme",
] ]
+8 -11
View File
@@ -6,7 +6,7 @@ Periodically flushes pending changes to disk and cleans up expired items.
import asyncio import asyncio
import logging import logging
from datetime import datetime, timezone from datetime import UTC, datetime
from paskia.db.operations import _store, cleanup_expired from paskia.db.operations import _store, cleanup_expired
@@ -33,7 +33,7 @@ async def _background_loop():
cleanup_expired() cleanup_expired()
await flush() await flush()
last_cleanup = datetime.now(timezone.utc) last_cleanup = datetime.now(UTC)
while True: while True:
try: try:
@@ -42,7 +42,7 @@ async def _background_loop():
await flush() await flush()
# Run cleanup periodically # Run cleanup periodically
now = datetime.now(timezone.utc) now = datetime.now(UTC)
if (now - last_cleanup).total_seconds() >= CLEANUP_INTERVAL: if (now - last_cleanup).total_seconds() >= CLEANUP_INTERVAL:
cleanup_expired() cleanup_expired()
await flush() # Flush cleanup changes await flush() # Flush cleanup changes
@@ -74,21 +74,18 @@ async def start_background():
_logger.debug("Background task in different event loop, restarting") _logger.debug("Background task in different event loop, restarting")
_background_task = None _background_task = None
else: else:
# Task is running in the same event loop - this is an error # Task is already running in same loop - idempotent, just return
raise RuntimeError( # This happens with dual IPv4+IPv6 endpoints sharing the same process
"Background task is already running. " _logger.debug(
"start_background() must not be called multiple times in the same event loop." "Background task already running in same loop, skipping"
) )
except RuntimeError: return
raise # Re-raise RuntimeError from above
except Exception as e: except Exception as e:
_logger.debug("Error checking background task loop: %s, restarting", e) _logger.debug("Error checking background task loop: %s, restarting", e)
_background_task = None _background_task = None
if _background_task is None: if _background_task is None:
_background_task = asyncio.create_task(_background_loop()) _background_task = asyncio.create_task(_background_loop())
else:
_logger.debug("Background task already running: %s", _background_task)
async def stop_background(): async def stop_background():
+101 -113
View File
@@ -2,15 +2,11 @@
JSONL persistence layer for the database. JSONL persistence layer for the database.
""" """
from __future__ import annotations
import copy import copy
import json
import logging import logging
import sys
from collections import deque from collections import deque
from contextlib import contextmanager from contextlib import contextmanager
from datetime import datetime, timezone from datetime import UTC, datetime
from pathlib import Path from pathlib import Path
from typing import Any from typing import Any
from uuid import UUID from uuid import UUID
@@ -19,7 +15,8 @@ import aiofiles
import jsondiff import jsondiff
import msgspec import msgspec
from paskia.db.migrations import apply_migrations from paskia.db.logging import log_change
from paskia.db.migrations import DBVER, apply_all_migrations
from paskia.db.structs import DB, SessionContext from paskia.db.structs import DB, SessionContext
_logger = logging.getLogger(__name__) _logger = logging.getLogger(__name__)
@@ -33,6 +30,7 @@ class _ChangeRecord(msgspec.Struct, omit_defaults=True):
ts: datetime ts: datetime
a: str # action - describes the operation (e.g., "migrate", "login", "create_user") a: str # action - describes the operation (e.g., "migrate", "login", "create_user")
v: int # schema version after this change
u: str | None = None # user UUID who performed the action (None for system) u: str | None = None # user UUID who performed the action (None for system)
diff: dict = {} diff: dict = {}
@@ -41,43 +39,6 @@ class _ChangeRecord(msgspec.Struct, omit_defaults=True):
_change_encoder = msgspec.json.Encoder() _change_encoder = msgspec.json.Encoder()
async def load_jsonl(db_path: Path) -> dict:
"""Load data from disk by applying change log.
Replays all changes from JSONL file using plain dicts (to handle
schema evolution).
Args:
db_path: Path to the JSONL database file
Returns:
The final state after applying all changes
Raises:
ValueError: If file doesn't exist or cannot be loaded
"""
if not db_path.exists():
raise ValueError(f"Database file not found: {db_path}")
data_dict: dict = {}
try:
# Read entire file at once and split into lines
async with aiofiles.open(db_path, "rb") as f:
content = await f.read()
for line_num, line in enumerate(content.split(b"\n"), 1):
line = line.strip()
if not line:
continue
try:
change = msgspec.json.decode(line)
# Apply the diff to current state (marshal=True for $-prefixed keys)
data_dict = jsondiff.patch(data_dict, change["diff"], marshal=True)
except Exception as e:
raise ValueError(f"Error parsing line {line_num}: {e}")
except (OSError, ValueError, msgspec.DecodeError) as e:
raise ValueError(f"Failed to load database: {e}")
return data_dict
def compute_diff(previous: dict, current: dict) -> dict | None: def compute_diff(previous: dict, current: dict) -> dict | None:
"""Compute JSON diff between two states. """Compute JSON diff between two states.
@@ -93,19 +54,20 @@ def compute_diff(previous: dict, current: dict) -> dict | None:
def create_change_record( def create_change_record(
action: str, diff: dict, user: str | None = None action: str, version: int, diff: dict, user: str | None = None
) -> _ChangeRecord: ) -> _ChangeRecord:
"""Create a change record for persistence.""" """Create a change record for persistence."""
return _ChangeRecord( return _ChangeRecord(
ts=datetime.now(timezone.utc), ts=datetime.now(UTC),
a=action, a=action,
v=version,
u=user, u=user,
diff=diff, diff=diff,
) )
# Actions that are allowed to create a new database file # Actions that are allowed to create a new database file
_BOOTSTRAP_ACTIONS = frozenset({"bootstrap", "migrate"}) _BOOTSTRAP_ACTIONS = frozenset({"bootstrap"})
async def flush_changes( async def flush_changes(
@@ -129,7 +91,7 @@ async def flush_changes(
if first_action not in _BOOTSTRAP_ACTIONS: if first_action not in _BOOTSTRAP_ACTIONS:
_logger.error( _logger.error(
"Refusing to create database file with action '%s' - " "Refusing to create database file with action '%s' - "
"only bootstrap or migrate can create a new database", "only bootstrap can create a new database",
first_action, first_action,
) )
pending_changes.clear() pending_changes.clear()
@@ -166,66 +128,89 @@ class JsonlStore:
self._current_user: str | None = None self._current_user: str | None = None
self._in_transaction: bool = False self._in_transaction: bool = False
self._transaction_snapshot: dict[str, Any] | None = None self._transaction_snapshot: dict[str, Any] | None = None
self._current_version: int = DBVER # Schema version for new databases
async def load(self, db_path: str | None = None) -> None: async def load(self, db_path: str | None = None) -> None:
"""Load data from JSONL change log.""" """Load data from JSONL change log."""
if db_path is not None: if db_path is not None:
self.db_path = Path(db_path) self.db_path = Path(db_path)
if not self.db_path.exists():
return
# Replay change log to reconstruct state
data_dict: dict = {}
try: try:
data_dict = await load_jsonl(self.db_path) async with aiofiles.open(self.db_path, "rb") as f:
if data_dict: content = await f.read()
# Preserve original state before migrations (deep copy for nested dicts) for line_num, line in enumerate(content.split(b"\n"), 1):
original_dict = copy.deepcopy(data_dict) line = line.strip()
if not line:
# Apply schema migrations (modifies data_dict in place) continue
migrated = apply_migrations(data_dict)
decoder = msgspec.json.Decoder(DB)
self.db = decoder.decode(msgspec.json.encode(data_dict))
self.db._store = self
# Update previous state to migrated data FIRST (to avoid transaction hardening reset)
self._previous_builtins = data_dict
# Persist migration by manually computing and queueing the diff
if migrated:
diff = compute_diff(original_dict, data_dict)
if diff:
self._pending_changes.append(
create_change_record("migrate", diff, user=None)
)
_logger.info("Queued migration changes for persistence")
await self.flush()
except ValueError:
if self.db_path.exists():
raise
def _queue_change(self) -> None:
current = msgspec.to_builtins(self.db)
diff = compute_diff(self._previous_builtins, current)
if diff:
self._pending_changes.append(
create_change_record(self._current_action, diff, self._current_user)
)
self._previous_builtins = current
# Log the change with user display name if available
user_display = None
if self._current_user:
try: try:
user_uuid = UUID(self._current_user) change = msgspec.json.decode(line)
if user_uuid in self.db.users: data_dict = jsondiff.patch(data_dict, change["diff"], marshal=True)
user_display = self.db.users[user_uuid].display_name self._current_version = change.get("v", 0)
except (ValueError, KeyError): except Exception as e:
user_display = self._current_user raise ValueError(f"Error parsing line {line_num}: {e}")
except (OSError, ValueError, msgspec.DecodeError) as e:
raise ValueError(f"Failed to load database: {e}")
diff_json = json.dumps(diff, default=str) if not data_dict:
if user_display: return
print(
f"{self._current_action} by {user_display}: {diff_json}", # Set previous state for diffing (will be updated by _queue_change)
file=sys.stderr, self._previous_builtins = copy.deepcopy(data_dict)
)
else: # Callback to persist each migration
print(f"{self._current_action}: {diff_json}", file=sys.stderr) async def persist_migration(
action: str, new_version: int, current: dict
) -> None:
self._current_version = new_version
self._queue_change(action, new_version, current)
# Apply schema migrations one at a time
await apply_all_migrations(data_dict, self._current_version, persist_migration)
# Decode to msgspec struct
decoder = msgspec.json.Decoder(DB)
self.db = decoder.decode(msgspec.json.encode(data_dict))
self.db._store = self
# Normalize via msgspec round-trip (handles omit_defaults etc.)
# This ensures _previous_builtins matches what msgspec would produce
normalized_dict = msgspec.to_builtins(self.db)
await persist_migration(
"migrate:msgspec", self._current_version, normalized_dict
)
def _queue_change(
self, action: str, version: int, current: dict, user: str | None = None
) -> None:
"""Queue a change record and log it.
Args:
action: The action name for the change record
version: The schema version for the change record
current: The current state as a plain dict
user: Optional user UUID who performed the action
"""
diff = compute_diff(self._previous_builtins, current)
if not diff:
return
self._pending_changes.append(create_change_record(action, version, diff, user))
# Log the change with user display name if available
user_display = None
if user:
try:
user_uuid = UUID(user)
if user_uuid in self.db.users:
user_display = self.db.users[user_uuid].display_name
except (ValueError, KeyError):
user_display = user
log_change(action, diff, user_display, self._previous_builtins)
self._previous_builtins = copy.deepcopy(current)
@contextmanager @contextmanager
def transaction( def transaction(
@@ -248,19 +233,19 @@ class JsonlStore:
# Check for out-of-transaction modifications # Check for out-of-transaction modifications
current_state = msgspec.to_builtins(self.db) current_state = msgspec.to_builtins(self.db)
if current_state != self._previous_builtins: if current_state != self._previous_builtins:
diff = compute_diff(self._previous_builtins, current_state) # Allow bootstrap to create a new database from empty state
diff_json = json.dumps(diff, default=str, indent=2) is_bootstrap = action in _BOOTSTRAP_ACTIONS
_logger.error( if is_bootstrap and not self._previous_builtins:
"Database state modified outside of transaction! " pass # Expected: creating database from scratch
"This indicates a bug where DB changes occurred without a transaction wrapper. " else:
"Resetting to last known state from JSONL file.\n" diff = compute_diff(self._previous_builtins, current_state)
f"Changes detected:\n{diff_json}" diff_json = msgspec.json.encode(diff).decode()
) _logger.critical(
# Hard reset to last known good state "Database state modified outside of transaction! "
decoder = msgspec.json.Decoder(DB) "This indicates a bug where DB changes occurred without a transaction wrapper.\n"
self.db = decoder.decode(msgspec.json.encode(self._previous_builtins)) f"Changes detected:\n{diff_json}"
self.db._store = self )
current_state = self._previous_builtins.copy() raise SystemExit(1)
old_action = self._current_action old_action = self._current_action
old_user = self._current_user old_user = self._current_user
@@ -272,7 +257,10 @@ class JsonlStore:
try: try:
yield yield
self._queue_change() current = msgspec.to_builtins(self.db)
self._queue_change(
self._current_action, self._current_version, current, self._current_user
)
except Exception: except Exception:
# Rollback on error: restore from snapshot # Rollback on error: restore from snapshot
_logger.warning("Transaction '%s' failed, rolling back changes", action) _logger.warning("Transaction '%s' failed, rolling back changes", action)
+318
View File
@@ -0,0 +1,318 @@
"""
Database change logging with pretty-printed diffs.
Provides a logger for JSONL database changes that formats diffs
in a human-readable path.notation style with color coding.
"""
import logging
import re
import sys
from typing import Any
logger = logging.getLogger("paskia.db")
# Pattern to match control characters and bidirectional overrides
_UNSAFE_CHARS = re.compile(
r"[\x00-\x1f\x7f-\x9f" # C0 and C1 control characters
r"\u200e\u200f" # LRM, RLM
r"\u202a-\u202e" # LRE, RLE, PDF, LRO, RLO
r"\u2066-\u2069" # LRI, RLI, FSI, PDI
r"]"
)
# ANSI color codes (matching FastAPI logging style)
_RESET = "\033[0m"
_DIM = "\033[2m"
_PATH_PREFIX = "\033[1;30m" # Dark grey for path prefix (like host in access log)
_PATH_FINAL = "\033[0m" # Default for final element (like path in access log)
_DELETE = "\033[1;31m" # Red for deletions
_ADD = "\033[0;32m" # Green for additions
_ACTION = "\033[1;34m" # Bold blue for action name
_USER = "\033[0;34m" # Blue for user display
def _use_color() -> bool:
"""Check if we should use color output."""
return sys.stderr.isatty()
def _format_value(value: Any, use_color: bool, max_len: int = 60) -> str:
"""Format a value for display, truncating if needed."""
if value is None:
return "null"
if isinstance(value, bool):
return "true" if value else "false"
if isinstance(value, (int, float)):
return str(value)
if isinstance(value, str):
# Filter out control characters and bidirectional overrides
value = _UNSAFE_CHARS.sub("", value)
# Truncate long strings
if len(value) > max_len:
return value[: max_len - 3] + "..."
return value
if isinstance(value, dict):
if not value:
return "{}"
# For small dicts, show inline
if len(value) == 1:
k, v = next(iter(value.items()))
return "{" + f"{k}: {_format_value(v, use_color, max_len=30)}" + "}"
return f"{{...{len(value)} keys}}"
if isinstance(value, list):
if not value:
return "[]"
if len(value) == 1:
return "[" + _format_value(value[0], use_color, max_len=30) + "]"
return f"[...{len(value)} items]"
# Fallback for other types
text = str(value)
if len(text) > max_len:
text = text[: max_len - 3] + "..."
return text
def _format_path(path: list[str], use_color: bool) -> str:
"""Format a path as dot notation with prefix in dark grey, final in default."""
if not path:
return ""
if not use_color:
return ".".join(path)
if len(path) == 1:
return f"{_PATH_FINAL}{path[0]}{_RESET}"
prefix = ".".join(path[:-1])
final = path[-1]
return f"{_PATH_PREFIX}{prefix}.{_RESET}{_PATH_FINAL}{final}{_RESET}"
def _get_nested(data: dict | None, path: list[str]) -> Any:
"""Get a nested value from a dict by path, or None if not found."""
if data is None:
return None
current = data
for key in path:
if not isinstance(current, dict) or key not in current:
return None
current = current[key]
return current
def _collect_changes(
diff: dict,
path: list[str],
changes: list[tuple[str, list[str], Any]],
previous: dict | None,
) -> None:
"""
Recursively collect changes from a diff into a flat list.
Each change is a tuple of (change_type, path, new_value).
change_type is one of: 'add', 'update', 'delete'
"""
if not isinstance(diff, dict):
# Leaf value - check if it existed before
existed = _get_nested(previous, path) is not None
changes.append(("update" if existed else "add", path, diff))
return
for key, value in diff.items():
if key == "$delete":
# $delete contains a list of keys to delete
if isinstance(value, list):
for deleted_key in value:
changes.append(("delete", path + [str(deleted_key)], None))
else:
changes.append(("delete", path + [str(value)], None))
elif key == "$replace":
# $replace replaces the entire collection at this path
# We need to track what was added and what was deleted
old_collection = _get_nested(previous, path)
old_keys = (
set(old_collection.keys())
if isinstance(old_collection, dict)
else set()
)
new_keys = set(value.keys()) if isinstance(value, dict) else set()
# Items that existed before but not in new = deleted
for deleted_key in old_keys - new_keys:
changes.append(("delete", path + [str(deleted_key)], None))
# Items in new collection
if isinstance(value, dict):
for rkey, rval in value.items():
existed = rkey in old_keys
changes.append(
("update" if existed else "add", path + [str(rkey)], rval)
)
elif value or not old_keys:
# Non-dict replacement or empty replacement with nothing before
changes.append(
("update" if old_collection is not None else "add", path, value)
)
elif key.startswith("$"):
# Other special operations (future-proofing)
changes.append(("add", path, {key: value}))
else:
# Regular nested key - check if this item existed before
new_path = path + [str(key)]
existed = _get_nested(previous, new_path) is not None
if existed:
# Item exists - recurse to show specific field changes
_collect_changes(value, new_path, changes, previous)
else:
# New item - record as add with full value, don't recurse
changes.append(("add", new_path, value))
def _format_change_lines(
change_type: str, path: list[str], value: Any, use_color: bool
) -> list[str]:
"""Format a single change as one or more lines."""
if change_type == "delete":
if not use_color:
return [f" {'.'.join(path)}"]
if len(path) == 1:
return [f" {_DELETE}{path[0]}{_RESET}"]
prefix = ".".join(path[:-1])
final = path[-1]
return [f" {_PATH_PREFIX}{prefix}.{_RESET}{_DELETE}{final}{_RESET}"]
if change_type == "add":
# New item being created - only final element in green
# For dict values, show children on separate indented lines
if isinstance(value, dict) and value:
lines = []
# First line: path with green final element and grey =
if not use_color:
lines.append(f" {'.'.join(path)} =")
elif len(path) == 1:
lines.append(f" {_ADD}{path[0]}{_RESET} {_DIM}={_RESET}")
else:
prefix = ".".join(path[:-1])
final = path[-1]
lines.append(
f" {_PATH_PREFIX}{prefix}.{_RESET}{_ADD}{final}{_RESET} {_DIM}={_RESET}"
)
# Child lines: indented key: value, with aligned values
max_key_len = max(len(k) for k in value.keys())
field_width = max(max_key_len, 12) # minimum 12 chars
for k, v in value.items():
v_str = _format_value(v, use_color)
padding = " " * (field_width - len(k))
if use_color:
lines.append(f" {k}{_DIM}:{_RESET}{padding} {v_str}")
else:
lines.append(f" {k}:{padding} {v_str}")
return lines
else:
value_str = _format_value(value, use_color)
if not use_color:
return [f" {'.'.join(path)} = {value_str}"]
if len(path) == 1:
return [f" {_ADD}{path[0]}{_RESET} {_DIM}={_RESET} {value_str}"]
prefix = ".".join(path[:-1])
final = path[-1]
return [
f" {_PATH_PREFIX}{prefix}.{_RESET}{_ADD}{final}{_RESET} {_DIM}={_RESET} {value_str}"
]
# update: Existing item being updated - normal path colors
value_str = _format_value(value, use_color)
path_str = _format_path(path, use_color)
if use_color:
return [f" {path_str} {_DIM}={_RESET} {value_str}"]
return [f" {path_str} = {value_str}"]
def format_diff(diff: dict, previous: dict | None = None) -> list[str]:
"""
Format a JSON diff as human-readable lines.
Args:
diff: The JSON diff dict
previous: The previous state dict (for determining add vs update)
Returns a list of formatted lines (without newlines).
Single changes return one line, multiple changes return multiple lines.
"""
use_color = _use_color()
changes: list[tuple[str, list[str], Any]] = []
_collect_changes(diff, [], changes, previous)
if not changes:
return []
# Format each change
lines = []
for change_type, path, value in changes:
lines.extend(_format_change_lines(change_type, path, value, use_color))
return lines
def format_action_header(action: str, user_display: str | None = None) -> str:
"""Format the action header line."""
use_color = _use_color()
if use_color:
action_str = f"{_ACTION}{action}{_RESET}"
if user_display:
user_str = f"{_USER}{user_display}{_RESET}"
return f"{action_str} by {user_str}"
return action_str
else:
if user_display:
return f"{action} by {user_display}"
return action
def log_change(
action: str,
diff: dict,
user_display: str | None = None,
previous: dict | None = None,
) -> None:
"""
Log a database change with pretty-printed diff.
Args:
action: The action name (e.g., "login", "admin:delete_user")
diff: The JSON diff dict
user_display: Optional display name of the user who performed the action
previous: The previous state dict (for determining add vs update)
"""
header = format_action_header(action, user_display)
diff_lines = format_diff(diff, previous)
if not diff_lines:
logger.info(header)
return
if len(diff_lines) == 1:
# Single change - combine on one line
logger.info(f"{header}{diff_lines[0]}")
else:
# Multiple changes - header on its own line, then changes
logger.info(header)
for line in diff_lines:
logger.info(line)
def configure_db_logging() -> None:
"""Configure the database logger to output to stderr without prefix."""
handler = logging.StreamHandler(sys.stderr)
handler.setFormatter(logging.Formatter("%(message)s"))
logger.addHandler(handler)
logger.setLevel(logging.INFO)
logger.propagate = False
+20 -21
View File
@@ -5,30 +5,29 @@ Migrations are applied during database load based on the version field.
Each migration should be idempotent and only run when needed. Each migration should be idempotent and only run when needed.
""" """
import logging from collections.abc import Awaitable, Callable
_logger = logging.getLogger(__name__)
def apply_migrations(data_dict: dict) -> bool: def migrate_v1(d: dict) -> None:
"""Apply any pending schema migrations to the database dictionary. """Remove Org.created_at fields."""
for org_data in d["orgs"].values():
org_data.pop("created_at", None)
Args:
data_dict: The raw database dictionary loaded from JSONL
Returns: migrations = sorted(
True if any migrations were applied, False otherwise [f for n, f in globals().items() if n.startswith("migrate_v")],
""" key=lambda f: int(f.__name__.removeprefix("migrate_v")),
db_version = data_dict.get("v", 0) )
migrated = False
if db_version == 0: DBVER = len(migrations) # Used by bootstrap to set initial version
# Migration v0 -> v1: Remove created_at from orgs (field removed from schema)
if "orgs" in data_dict:
for org_data in data_dict["orgs"].values():
org_data.pop("created_at", None)
data_dict["v"] = 1
migrated = True
_logger.info("Applied schema migration: v0 -> v1 (removed org.created_at)")
return migrated
async def apply_all_migrations(
data_dict: dict,
current_version: int,
persist: Callable[[str, int, dict], Awaitable[None]],
) -> None:
while current_version < DBVER:
migrations[current_version](data_dict)
current_version += 1
await persist(f"migrate:v{current_version}", current_version, data_dict)
+154 -233
View File
@@ -2,7 +2,7 @@
Database for WebAuthn passkey authentication. Database for WebAuthn passkey authentication.
Read operations: Access _db directly, use build_* helpers to get public structs. Read operations: Access _db directly, use build_* helpers to get public structs.
Context lookup: get_session_context() returns full SessionContext with effective permissions. Context lookup: _db.session_ctx() returns full SessionContext with effective permissions.
Write operations: Functions that validate and commit, or raise ValueError. Write operations: Functions that validate and commit, or raise ValueError.
""" """
@@ -10,14 +10,13 @@ import hashlib
import logging import logging
import os import os
import secrets import secrets
from datetime import datetime, timezone from datetime import UTC, datetime
from uuid import UUID from uuid import UUID
import uuid7 import uuid7
from paskia.config import SESSION_LIFETIME from paskia.config import SESSION_LIFETIME
from paskia.db.jsonl import ( from paskia.db.jsonl import (
DB_PATH_DEFAULT,
JsonlStore, JsonlStore,
) )
from paskia.db.structs import ( from paskia.db.structs import (
@@ -31,8 +30,6 @@ from paskia.db.structs import (
SessionContext, SessionContext,
User, User,
) )
from paskia.util.hostutil import normalize_host
from paskia.util.passphrase import generate as generate_passphrase
from paskia.util.passphrase import is_well_formed as _is_passphrase from paskia.util.passphrase import is_well_formed as _is_passphrase
_logger = logging.getLogger(__name__) _logger = logging.getLogger(__name__)
@@ -44,15 +41,14 @@ _db._store = _store
_initialized = False _initialized = False
async def init(*args, **kwargs): async def init(rp_id: str = "localhost", *args, **kwargs):
"""Load database from JSONL file.""" """Load database from JSONL file."""
global _db, _initialized global _db, _initialized
if _initialized: if _initialized:
_logger.debug("Database already initialized, skipping reload") _logger.debug("Database already initialized, skipping reload")
return return
db_path = os.environ.get("PASKIA_DB", DB_PATH_DEFAULT) default_path = f"{rp_id}.paskiadb"
if db_path.startswith("json:"): db_path = os.environ.get("PASKIA_DB", default_path)
db_path = db_path[5:]
await _store.load(db_path) await _store.load(db_path)
_db = _store.db _db = _store.db
_initialized = True _initialized = True
@@ -69,21 +65,18 @@ def get_user_organization(user_uuid: UUID) -> tuple[Org, str]:
Raises ValueError if user not found. Raises ValueError if user not found.
Call sites: Call sites:
- Get user's organization when updating user role (admin.py:493) - admin_create_user_registration_link: org only
- Get user's organization for user credential listing (admin.py:530) - admin_get_user_detail: org and role
- Get user's organization for user details API (admin.py:579) - admin_update_user_display_name: org only
- Get user's organization for updating user display name (admin.py:721) - admin_delete_user_credential: org only
- Get user's organization for deleting user credential (admin.py:754) - admin_delete_user_session: org only
- Get user's organization for deleting user session (admin.py:783) - admin_update_user_role: org only
""" """
if user_uuid not in _db.users: if user_uuid not in _db.users:
raise ValueError(f"User {user_uuid} not found") raise ValueError(f"User {user_uuid} not found")
role_uuid = _db.users[user_uuid].role user = _db.users[user_uuid]
if role_uuid not in _db.roles: role = user.role
raise ValueError(f"Role {role_uuid} not found") return role.org, role.display_name
role_data = _db.roles[role_uuid]
org_uuid = role_data.org
return _db.orgs[org_uuid], role_data.display_name
def get_organization_users(org_uuid: UUID) -> list[tuple[User, str]]: def get_organization_users(org_uuid: UUID) -> list[tuple[User, str]]:
@@ -91,10 +84,8 @@ def get_organization_users(org_uuid: UUID) -> list[tuple[User, str]]:
Returns list of (User, role_display_name) tuples. Returns list of (User, role_display_name) tuples.
""" """
role_map = { org = _db.orgs[org_uuid]
rid: r.display_name for rid, r in _db.roles.items() if r.org == org_uuid return [(u, u.role.display_name) for role in org.roles for u in role.users]
}
return [(u, role_map[u.role]) for u in _db.users.values() if u.role in role_map]
def get_user_credential_ids(user_uuid: UUID) -> list[bytes]: def get_user_credential_ids(user_uuid: UUID) -> list[bytes]:
@@ -102,7 +93,8 @@ def get_user_credential_ids(user_uuid: UUID) -> list[bytes]:
Returns empty list if user has no credentials. Returns empty list if user has no credentials.
""" """
return [c.credential_id for c in _db.credentials.values() if c.user == user_uuid] assert user_uuid
return [c.credential_id for c in _db.users[user_uuid].credentials]
def _reset_key(passphrase: str) -> bytes: def _reset_key(passphrase: str) -> bytes:
@@ -126,92 +118,6 @@ def get_reset_token(passphrase: str) -> ResetToken | None:
return _db.reset_tokens.get(key) return _db.reset_tokens.get(key)
# -------------------------------------------------------------------------
# Context lookup
# -------------------------------------------------------------------------
def get_session_context(
session_key: str, host: str | None = None
) -> SessionContext | None:
"""Get full session context with effective permissions.
Args:
session_key: The session key string
host: Optional host for binding/validation and domain-scoped permissions
Returns:
SessionContext if valid, None if session not found, expired, or host mismatch
Call sites:
- Example usage in docstring (db/__init__.py:16)
- Get session context from auth token (util/permutil.py:43)
"""
if session_key not in _db.sessions:
return None
s = _db.sessions[session_key]
if s.expiry < datetime.now(timezone.utc):
return None
# Validate host matches (sessions are always created with a host)
if host is not None and s.host != host:
# Session bound to different host
return None
# Validate user exists
if s.user not in _db.users:
return None
# Validate role exists
role_uuid = _db.users[s.user].role
if role_uuid not in _db.roles:
return None
# Validate org exists
org_uuid = _db.roles[role_uuid].org
if org_uuid not in _db.orgs:
return None
session = _db.sessions[session_key]
user = _db.users[s.user]
role = _db.roles[role_uuid]
org = _db.orgs[org_uuid]
# Credential must exist (sessions are cascade-deleted when credential is deleted)
if s.credential not in _db.credentials:
return None
credential = _db.credentials[s.credential]
# Effective permissions: role's permissions that the org can grant
# Also filter by domain if host is provided
org_perm_uuids = {pid for pid, p in _db.permissions.items() if org_uuid in p.orgs}
normalized_host = normalize_host(host)
host_without_port = normalized_host.rsplit(":", 1)[0] if normalized_host else None
effective_perms = []
for perm_uuid in role.permission_set:
if perm_uuid not in org_perm_uuids:
continue
if perm_uuid not in _db.permissions:
continue
p = _db.permissions[perm_uuid]
# Check domain restriction
if p.domain is not None and p.domain != host_without_port:
continue
effective_perms.append(_db.permissions[perm_uuid])
return SessionContext(
session=session,
user=user,
org=org,
role=role,
credential=credential,
permissions=effective_perms,
)
# ------------------------------------------------------------------------- # -------------------------------------------------------------------------
# Write operations (validate, modify, commit or raise ValueError) # Write operations (validate, modify, commit or raise ValueError)
# ------------------------------------------------------------------------- # -------------------------------------------------------------------------
@@ -264,9 +170,9 @@ def create_org(org: Org, *, ctx: SessionContext | None = None) -> None:
if org.uuid in _db.orgs: if org.uuid in _db.orgs:
raise ValueError(f"Organization {org.uuid} already exists") raise ValueError(f"Organization {org.uuid} already exists")
with _db.transaction("admin:create_org", ctx): with _db.transaction("admin:create_org", ctx):
new_org = Org(display_name=org.display_name) new_org = Org.create(display_name=org.display_name)
_db.orgs[org.uuid] = new_org
new_org.uuid = org.uuid new_org.uuid = org.uuid
_db.orgs[org.uuid] = new_org
# Create Administration role with org admin permission # Create Administration role with org admin permission
admin_role_uuid = uuid7.create() admin_role_uuid = uuid7.create()
@@ -278,7 +184,7 @@ def create_org(org: Org, *, ctx: SessionContext | None = None) -> None:
break break
role_permissions = {org_admin_perm_uuid: True} if org_admin_perm_uuid else {} role_permissions = {org_admin_perm_uuid: True} if org_admin_perm_uuid else {}
admin_role = Role( admin_role = Role(
org=org.uuid, org_uuid=org.uuid,
display_name="Administration", display_name="Administration",
permissions=role_permissions, permissions=role_permissions,
) )
@@ -304,17 +210,15 @@ def delete_org(uuid: UUID, *, ctx: SessionContext | None = None) -> None:
if uuid not in _db.orgs: if uuid not in _db.orgs:
raise ValueError(f"Organization {uuid} not found") raise ValueError(f"Organization {uuid} not found")
with _db.transaction("admin:delete_org", ctx): with _db.transaction("admin:delete_org", ctx):
org = _db.orgs[uuid]
# Remove org from all permissions # Remove org from all permissions
for p in _db.permissions.values(): for p in _db.permissions.values():
p.orgs.pop(uuid, None) p.orgs.pop(uuid, None)
# Delete roles in this org # Delete roles in this org and their users
role_uuids = [rid for rid, r in _db.roles.items() if r.org == uuid] for role in org.roles:
for rid in role_uuids: for user in role.users:
del _db.roles[rid] del _db.users[user.uuid]
# Delete users with those roles del _db.roles[role.uuid]
user_uuids = [uid for uid, u in _db.users.items() if u.role in role_uuids]
for uid in user_uuids:
del _db.users[uid]
del _db.orgs[uuid] del _db.orgs[uuid]
@@ -356,8 +260,8 @@ def create_role(role: Role, *, ctx: SessionContext | None = None) -> None:
"""Create a new role.""" """Create a new role."""
if role.uuid in _db.roles: if role.uuid in _db.roles:
raise ValueError(f"Role {role.uuid} already exists") raise ValueError(f"Role {role.uuid} already exists")
if role.org not in _db.orgs: if role.org_uuid not in _db.orgs:
raise ValueError(f"Organization {role.org} not found") raise ValueError(f"Organization {role.org_uuid} not found")
with _db.transaction("admin:create_role", ctx): with _db.transaction("admin:create_role", ctx):
_db.roles[role.uuid] = role _db.roles[role.uuid] = role
@@ -408,7 +312,8 @@ def delete_role(uuid: UUID, *, ctx: SessionContext | None = None) -> None:
if uuid not in _db.roles: if uuid not in _db.roles:
raise ValueError(f"Role {uuid} not found") raise ValueError(f"Role {uuid} not found")
# Check no users have this role # Check no users have this role
if any(u.role == uuid for u in _db.users.values()): role = _db.roles[uuid]
if role.users:
raise ValueError(f"Cannot delete role {uuid}: users still assigned") raise ValueError(f"Cannot delete role {uuid}: users still assigned")
with _db.transaction("admin:delete_role", ctx): with _db.transaction("admin:delete_role", ctx):
del _db.roles[uuid] del _db.roles[uuid]
@@ -418,8 +323,8 @@ def create_user(new_user: User, *, ctx: SessionContext | None = None) -> None:
"""Create a new user.""" """Create a new user."""
if new_user.uuid in _db.users: if new_user.uuid in _db.users:
raise ValueError(f"User {new_user.uuid} already exists") raise ValueError(f"User {new_user.uuid} already exists")
if new_user.role not in _db.roles: if new_user.role_uuid not in _db.roles:
raise ValueError(f"Role {new_user.role} not found") raise ValueError(f"Role {new_user.role_uuid} not found")
with _db.transaction("admin:create_user", ctx): with _db.transaction("admin:create_user", ctx):
_db.users[new_user.uuid] = new_user _db.users[new_user.uuid] = new_user
@@ -444,6 +349,23 @@ def update_user_display_name(
_db.users[uuid].display_name = display_name _db.users[uuid].display_name = display_name
def update_user_theme(
uuid: UUID,
theme: str,
*,
ctx: SessionContext | None = None,
) -> None:
"""Update user theme preference ('' for auto, 'light', 'dark')."""
if isinstance(uuid, str):
uuid = UUID(uuid)
if uuid not in _db.users:
raise ValueError(f"User {uuid} not found")
if theme not in ("", "light", "dark"):
raise ValueError(f"Invalid theme: {theme}")
with _db.transaction("update_user_theme", ctx):
_db.users[uuid].theme = theme
def update_user_role( def update_user_role(
uuid: UUID, uuid: UUID,
role_uuid: UUID, role_uuid: UUID,
@@ -456,51 +378,25 @@ def update_user_role(
if role_uuid not in _db.roles: if role_uuid not in _db.roles:
raise ValueError(f"Role {role_uuid} not found") raise ValueError(f"Role {role_uuid} not found")
with _db.transaction("admin:update_user_role", ctx): with _db.transaction("admin:update_user_role", ctx):
_db.users[uuid].role = role_uuid _db.users[uuid].role_uuid = role_uuid
def update_user_role_in_organization(
user_uuid: UUID,
role_name: str,
*,
ctx: SessionContext | None = None,
) -> None:
"""Update user's role by role name within their current organization."""
if user_uuid not in _db.users:
raise ValueError(f"User {user_uuid} not found")
current_role_uuid = _db.users[user_uuid].role
if current_role_uuid not in _db.roles:
raise ValueError("Current role not found")
org_uuid = _db.roles[current_role_uuid].org
# Find role by name in the same org
new_role_uuid = None
for rid, r in _db.roles.items():
if r.org == org_uuid and r.display_name == role_name:
new_role_uuid = rid
break
if new_role_uuid is None:
raise ValueError(f"Role '{role_name}' not found in organization")
with _db.transaction("admin:update_user_role", ctx):
_db.users[user_uuid].role = new_role_uuid
def delete_user(uuid: UUID, *, ctx: SessionContext | None = None) -> None: def delete_user(uuid: UUID, *, ctx: SessionContext | None = None) -> None:
"""Delete user and their credentials/sessions.""" """Delete user and their credentials/sessions."""
if uuid not in _db.users: if uuid not in _db.users:
raise ValueError(f"User {uuid} not found") raise ValueError(f"User {uuid} not found")
user = _db.users[uuid]
with _db.transaction("admin:delete_user", ctx): with _db.transaction("admin:delete_user", ctx):
# Delete credentials # Delete credentials
cred_uuids = [cid for cid, c in _db.credentials.items() if c.user == uuid] for cred in user.credentials:
for cid in cred_uuids: del _db.credentials[cred.uuid]
del _db.credentials[cid]
# Delete sessions # Delete sessions
sess_keys = [k for k, s in _db.sessions.items() if s.user == uuid] for sess in user.sessions:
for k in sess_keys: del _db.sessions[sess.key]
del _db.sessions[k] # Delete reset tokens (iterate over dict items to get correct keys)
# Delete reset tokens for key, token in list(_db.reset_tokens.items()):
token_keys = [k for k, t in _db.reset_tokens.items() if t.user == uuid] if token.user_uuid == uuid:
for k in token_keys: del _db.reset_tokens[key]
del _db.reset_tokens[k]
del _db.users[uuid] del _db.users[uuid]
@@ -508,8 +404,8 @@ def create_credential(cred: Credential, *, ctx: SessionContext | None = None) ->
"""Create a new credential.""" """Create a new credential."""
if cred.uuid in _db.credentials: if cred.uuid in _db.credentials:
raise ValueError(f"Credential {cred.uuid} already exists") raise ValueError(f"Credential {cred.uuid} already exists")
if cred.user not in _db.users: if cred.user_uuid not in _db.users:
raise ValueError(f"User {cred.user} not found") raise ValueError(f"User {cred.user_uuid} not found")
with _db.transaction("create_credential", ctx): with _db.transaction("create_credential", ctx):
_db.credentials[cred.uuid] = cred _db.credentials[cred.uuid] = cred
@@ -542,20 +438,19 @@ def delete_credential(
""" """
if uuid not in _db.credentials: if uuid not in _db.credentials:
raise ValueError(f"Credential {uuid} not found") raise ValueError(f"Credential {uuid} not found")
cred = _db.credentials[uuid]
if user_uuid is not None: if user_uuid is not None:
cred_user = _db.credentials[uuid].user if cred.user_uuid != user_uuid:
if cred_user != user_uuid:
raise ValueError(f"Credential {uuid} does not belong to user {user_uuid}") raise ValueError(f"Credential {uuid} does not belong to user {user_uuid}")
with _db.transaction("delete_credential", ctx): with _db.transaction("delete_credential", ctx):
# Delete all sessions using this credential # Delete all sessions using this credential
keys = [k for k, s in _db.sessions.items() if s.credential == uuid] for sess in cred.sessions:
for k in keys: print(sess, repr(sess.key))
del _db.sessions[k] del _db.sessions[sess.key]
del _db.credentials[uuid] del _db.credentials[uuid]
def create_session( def create_session(
key: str,
user_uuid: UUID, user_uuid: UUID,
credential_uuid: UUID, credential_uuid: UUID,
host: str, host: str,
@@ -564,23 +459,25 @@ def create_session(
expiry: datetime, expiry: datetime,
*, *,
ctx: SessionContext | None = None, ctx: SessionContext | None = None,
) -> None: ) -> str:
"""Create a new session.""" """Create a new session. Returns the session key."""
if key in _db.sessions:
raise ValueError("Session already exists")
if user_uuid not in _db.users: if user_uuid not in _db.users:
raise ValueError(f"User {user_uuid} not found") raise ValueError(f"User {user_uuid} not found")
if credential_uuid not in _db.credentials: if credential_uuid not in _db.credentials:
raise ValueError(f"Credential {credential_uuid} not found") raise ValueError(f"Credential {credential_uuid} not found")
session = Session.create(
user=user_uuid,
credential=credential_uuid,
host=host,
ip=ip,
user_agent=user_agent,
expiry=expiry,
)
if session.key in _db.sessions:
raise ValueError("Session already exists")
with _db.transaction("create_session", ctx): with _db.transaction("create_session", ctx):
_db.sessions[key] = Session( _db.sessions[session.key] = session
user=user_uuid, return session.key
credential=credential_uuid,
host=host,
ip=ip,
user_agent=user_agent,
expiry=expiry,
)
def update_session( def update_session(
@@ -612,16 +509,18 @@ def set_session_host(key: str, host: str, *, ctx: SessionContext | None = None)
update_session(key, host=host, ctx=ctx) update_session(key, host=host, ctx=ctx)
def delete_session(key: str, *, ctx: SessionContext | None = None) -> None: def delete_session(
key: str, *, ctx: SessionContext | None = None, action: str = "delete_session"
) -> None:
"""Delete a session. """Delete a session.
The acting user should be logged via ctx. The acting user should be logged via ctx.
For user logout, pass ctx of the user's session. For user logout, pass ctx of the user's session and action="logout".
For admin terminating a session, pass admin's ctx. For admin terminating a session, pass admin's ctx.
""" """
if key not in _db.sessions: if key not in _db.sessions:
raise ValueError("Session not found") raise ValueError("Session not found")
with _db.transaction("delete_session", ctx): with _db.transaction(action, ctx):
del _db.sessions[key] del _db.sessions[key]
@@ -634,36 +533,43 @@ def delete_sessions_for_user(
For user logout-all, pass ctx of the user's session. For user logout-all, pass ctx of the user's session.
For admin bulk termination, pass admin's ctx. For admin bulk termination, pass admin's ctx.
""" """
user = _db.users.get(user_uuid)
if not user:
return
with _db.transaction("admin:delete_sessions_for_user", ctx): with _db.transaction("admin:delete_sessions_for_user", ctx):
keys = [k for k, s in _db.sessions.items() if s.user == user_uuid] for sess in user.sessions:
for k in keys: del _db.sessions[sess.key]
del _db.sessions[k]
def create_reset_token( def create_reset_token(
passphrase: str,
user_uuid: UUID, user_uuid: UUID,
expiry: datetime, expiry: datetime,
token_type: str, token_type: str,
*, *,
ctx: SessionContext | None = None, ctx: SessionContext | None = None,
) -> None: user: str | None = None,
"""Create a reset token from a passphrase. ) -> str:
"""Create a reset token and return the passphrase.
The acting user should be logged via ctx. The acting user should be logged via ctx.
For self-service (user creating own recovery link), pass user's ctx. For self-service (user creating own recovery link), pass user's ctx.
For admin operations, pass admin's ctx. For admin operations, pass admin's ctx.
For system operations (bootstrap), pass neither to log no user. For system operations (bootstrap), pass neither to log no user.
For API operations where ctx is not available but user is known, pass user.
Returns:
The passphrase to give to the user.
""" """
key = _reset_key(passphrase)
if key in _db.reset_tokens:
raise ValueError("Reset token already exists")
if user_uuid not in _db.users: if user_uuid not in _db.users:
raise ValueError(f"User {user_uuid} not found") raise ValueError(f"User {user_uuid} not found")
with _db.transaction("create_reset_token", ctx): token, passphrase = ResetToken.create(
_db.reset_tokens[key] = ResetToken( user=user_uuid, expiry=expiry, token_type=token_type
user=user_uuid, expiry=expiry, token_type=token_type )
) if token.key in _db.reset_tokens:
raise ValueError("Reset token already exists")
with _db.transaction("create_reset_token", ctx, user=user):
_db.reset_tokens[token.key] = token
return passphrase
def delete_reset_token(key: bytes, *, ctx: SessionContext | None = None) -> None: def delete_reset_token(key: bytes, *, ctx: SessionContext | None = None) -> None:
@@ -681,7 +587,7 @@ def delete_reset_token(key: bytes, *, ctx: SessionContext | None = None) -> None
def cleanup_expired() -> int: def cleanup_expired() -> int:
"""Remove expired sessions and reset tokens. Returns count removed.""" """Remove expired sessions and reset tokens. Returns count removed."""
now = datetime.now(timezone.utc) now = datetime.now(UTC)
count = 0 count = 0
with _db.transaction("expiry"): with _db.transaction("expiry"):
expired_sessions = [k for k, s in _db.sessions.items() if s.expiry < now] expired_sessions = [k for k, s in _db.sessions.items() if s.expiry < now]
@@ -726,13 +632,20 @@ def login(
""" """
if isinstance(user_uuid, str): if isinstance(user_uuid, str):
user_uuid = UUID(user_uuid) user_uuid = UUID(user_uuid)
now = datetime.now(timezone.utc) now = datetime.now(UTC)
if user_uuid not in _db.users: if user_uuid not in _db.users:
raise ValueError(f"User {user_uuid} not found") raise ValueError(f"User {user_uuid} not found")
if credential_uuid not in _db.credentials: if credential_uuid not in _db.credentials:
raise ValueError(f"Credential {credential_uuid} not found") raise ValueError(f"Credential {credential_uuid} not found")
session_key = _create_token() session = Session.create(
user=user_uuid,
credential=credential_uuid,
host=host,
ip=ip,
user_agent=user_agent,
expiry=expiry,
)
user_str = str(user_uuid) user_str = str(user_uuid)
with _db.transaction("login", user=user_str): with _db.transaction("login", user=user_str):
# Update user # Update user
@@ -742,15 +655,8 @@ def login(
_db.credentials[credential_uuid].sign_count = sign_count _db.credentials[credential_uuid].sign_count = sign_count
_db.credentials[credential_uuid].last_used = now _db.credentials[credential_uuid].last_used = now
# Create session # Create session
_db.sessions[session_key] = Session( _db.sessions[session.key] = session
user=user_uuid, return session.key
credential=credential_uuid,
host=host,
ip=ip,
user_agent=user_agent,
expiry=expiry,
)
return session_key
def create_credential_session( def create_credential_session(
@@ -773,13 +679,20 @@ def create_credential_session(
Returns the generated session token. Returns the generated session token.
""" """
now = datetime.now(timezone.utc) now = datetime.now(UTC)
expiry = now + SESSION_LIFETIME expiry = now + SESSION_LIFETIME
session_key = _create_token()
if user_uuid not in _db.users: if user_uuid not in _db.users:
raise ValueError(f"User {user_uuid} not found") raise ValueError(f"User {user_uuid} not found")
session = Session.create(
user=user_uuid,
credential=credential.uuid,
host=host,
ip=ip,
user_agent=user_agent,
expiry=expiry,
)
user_str = str(user_uuid) user_str = str(user_uuid)
with _db.transaction("create_credential_session", user=user_str): with _db.transaction("create_credential_session", user=user_str):
# Update display name if provided # Update display name if provided
@@ -790,20 +703,13 @@ def create_credential_session(
_db.credentials[credential.uuid] = credential _db.credentials[credential.uuid] = credential
# Create session # Create session
_db.sessions[session_key] = Session( _db.sessions[session.key] = session
user=user_uuid,
credential=credential.uuid,
host=host,
ip=ip,
user_agent=user_agent,
expiry=expiry,
)
# Delete reset token if provided # Delete reset token if provided
if reset_key: if reset_key:
if reset_key in _db.reset_tokens: if reset_key in _db.reset_tokens:
del _db.reset_tokens[reset_key] del _db.reset_tokens[reset_key]
return session_key return session.key
# ------------------------------------------------------------------------- # -------------------------------------------------------------------------
@@ -826,7 +732,7 @@ def bootstrap(
- Admin user with Administration role - Admin user with Administration role
- Reset token for admin registration - Reset token for admin registration
This is the only way to create a new database file (besides migrate). This is the only way to create a new database file.
All data is created atomically - if any step fails, nothing is written. All data is created atomically - if any step fails, nothing is written.
Args: Args:
@@ -853,16 +759,13 @@ def bootstrap(
role_uuid = uuid7.create() role_uuid = uuid7.create()
user_uuid = uuid7.create() user_uuid = uuid7.create()
# Generate reset token components # Set reset token expiry (passphrase generated by ResetToken.create)
if reset_passphrase is None:
reset_passphrase = generate_passphrase()
if reset_expiry is None: if reset_expiry is None:
from paskia.authsession import reset_expires # noqa: PLC0415 from paskia.authsession import reset_expires # noqa: PLC0415
reset_expiry = reset_expires() reset_expiry = reset_expires()
reset_key = _reset_key(reset_passphrase)
now = datetime.now(timezone.utc) now = datetime.now(UTC)
with _db.transaction("bootstrap"): with _db.transaction("bootstrap"):
# Create auth:admin permission # Create auth:admin permission
@@ -884,13 +787,13 @@ def bootstrap(
_db.permissions[perm_org_admin_uuid] = perm_org_admin _db.permissions[perm_org_admin_uuid] = perm_org_admin
# Create organization # Create organization
new_org = Org(display_name=org_name) new_org = Org.create(display_name=org_name)
new_org.uuid = org_uuid new_org.uuid = org_uuid
_db.orgs[org_uuid] = new_org _db.orgs[org_uuid] = new_org
# Create Administration role with both permissions # Create Administration role with both permissions
admin_role = Role( admin_role = Role(
org=org_uuid, org_uuid=org_uuid,
display_name="Administration", display_name="Administration",
permissions={perm_admin_uuid: True, perm_org_admin_uuid: True}, permissions={perm_admin_uuid: True, perm_org_admin_uuid: True},
) )
@@ -900,7 +803,7 @@ def bootstrap(
# Create admin user # Create admin user
admin_user = User( admin_user = User(
display_name=admin_name, display_name=admin_name,
role=role_uuid, role_uuid=role_uuid,
created_at=now, created_at=now,
last_seen=None, last_seen=None,
visits=0, visits=0,
@@ -909,10 +812,28 @@ def bootstrap(
_db.users[user_uuid] = admin_user _db.users[user_uuid] = admin_user
# Create reset token # Create reset token
_db.reset_tokens[reset_key] = ResetToken( reset_token, reset_passphrase = ResetToken.create(
user=user_uuid, user=user_uuid,
expiry=reset_expiry, expiry=reset_expiry,
token_type="admin bootstrap", token_type="admin bootstrap",
passphrase=reset_passphrase,
) )
_db.reset_tokens[reset_token.key] = reset_token
return reset_passphrase return reset_passphrase
# -------------------------------------------------------------------------
# Config operations
# -------------------------------------------------------------------------
def get_config() -> Config:
"""Get the stored configuration."""
return _db.config
async def set_config(config: Config) -> None:
"""Update the stored configuration."""
async with _db.transaction("update_config"):
_db.config = config
+282 -47
View File
@@ -1,9 +1,17 @@
from datetime import datetime, timezone from __future__ import annotations
import hashlib
import secrets
from datetime import UTC, datetime
from uuid import UUID from uuid import UUID
import msgspec import msgspec
import uuid7 import uuid7
from paskia import db
from paskia.util.hostutil import normalize_host
from paskia.util.passphrase import generate as generate_passphrase
# Sentinel for uuid fields before they are set by create() or DB post init # Sentinel for uuid fields before they are set by create() or DB post init
_UUID_UNSET = UUID(int=0) _UUID_UNSET = UUID(int=0)
@@ -22,20 +30,30 @@ class Permission(msgspec.Struct, dict=True, omit_defaults=True):
orgs: dict[UUID, bool] = {} # org_uuid -> True (which orgs can grant this) orgs: dict[UUID, bool] = {} # org_uuid -> True (which orgs can grant this)
def __post_init__(self): def __post_init__(self):
self.uuid: UUID = _UUID_UNSET # Convenience field, not serialized if not hasattr(self, "uuid"):
self.uuid: UUID = _UUID_UNSET
@property @property
def org_set(self) -> set[UUID]: def org_set(self) -> set[UUID]:
"""Get orgs that can grant this permission as a set.""" """Get orgs that can grant this permission as a set."""
return set(self.orgs.keys()) return set(self.orgs.keys())
@property
def orgs_list(self) -> list[Org]:
"""Get list of Org objects that can grant this permission."""
return [
db.data().orgs[org_uuid]
for org_uuid in self.orgs.keys()
if org_uuid in db.data().orgs
]
@classmethod @classmethod
def create( def create(
cls, cls,
scope: str, scope: str,
display_name: str, display_name: str,
domain: str | None = None, domain: str | None = None,
) -> "Permission": ) -> Permission:
"""Create a new Permission with auto-generated uuid7.""" """Create a new Permission with auto-generated uuid7."""
perm = cls( perm = cls(
scope=scope, scope=scope,
@@ -46,36 +64,84 @@ class Permission(msgspec.Struct, dict=True, omit_defaults=True):
return perm return perm
class Org(msgspec.Struct, dict=True):
"""Organization data structure."""
display_name: str
def __post_init__(self):
if not hasattr(self, "uuid"):
self.uuid: UUID = _UUID_UNSET
@property
def roles(self) -> list[Role]:
"""Get all roles that belong to this organization."""
return [r for r in db.data().roles.values() if r.org_uuid == self.uuid]
@property
def permissions(self) -> list[Permission]:
"""Get all permissions that this organization can grant."""
return [p for p in db.data().permissions.values() if self.uuid in p.orgs]
@classmethod
def create(cls, display_name: str) -> Org:
"""Create a new Org with auto-generated uuid7."""
org = cls(display_name=display_name)
org.uuid = uuid7.create()
return org
class Role(msgspec.Struct, dict=True, omit_defaults=True): class Role(msgspec.Struct, dict=True, omit_defaults=True):
"""Role data structure. """Role data structure.
Mutable fields: display_name, permissions Mutable fields: display_name, permissions
Immutable fields: org (set at creation, never modified) Immutable fields: org_uuid (set at creation, never modified)
uuid is generated at creation. uuid is generated at creation.
""" """
org: UUID org_uuid: UUID = msgspec.field(name="org")
display_name: str display_name: str
permissions: dict[UUID, bool] = {} # permission_uuid -> True permissions: dict[UUID, bool] = {} # permission_uuid -> True
def __post_init__(self): def __post_init__(self):
self.uuid: UUID = _UUID_UNSET # Convenience field, not serialized if not hasattr(self, "uuid"):
self.uuid: UUID = _UUID_UNSET
@property @property
def permission_set(self) -> set[UUID]: def permission_set(self) -> set[UUID]:
"""Get permissions as a set of UUIDs.""" """Get permissions as a set of UUIDs."""
return set(self.permissions.keys()) return set(self.permissions.keys())
@property
def permissions_list(self) -> list[Permission]:
"""Get list of Permission objects for this role."""
return [
db.data().permissions[perm_uuid]
for perm_uuid in self.permissions.keys()
if perm_uuid in db.data().permissions
]
@property
def org(self) -> Org:
"""Get the organization object this role belongs to."""
return db.data().orgs[self.org_uuid]
@property
def users(self) -> list[User]:
"""Get all users that have this role."""
return [u for u in db.data().users.values() if u.role_uuid == self.uuid]
@classmethod @classmethod
def create( def create(
cls, cls,
org: UUID, org: UUID | Org,
display_name: str, display_name: str,
permissions: set[UUID] | None = None, permissions: set[UUID] | None = None,
) -> "Role": ) -> Role:
"""Create a new Role with auto-generated uuid7.""" """Create a new Role with auto-generated uuid7."""
org_uuid = org if isinstance(org, UUID) else org.uuid
role = cls( role = cls(
org=org, org_uuid=org_uuid,
display_name=display_name, display_name=display_name,
permissions={p: True for p in (permissions or set())}, permissions={p: True for p in (permissions or set())},
) )
@@ -83,52 +149,63 @@ class Role(msgspec.Struct, dict=True, omit_defaults=True):
return role return role
class Org(msgspec.Struct, dict=True): class User(msgspec.Struct, dict=True, omit_defaults=True):
"""Organization data structure."""
display_name: str
def __post_init__(self):
self.uuid: UUID = _UUID_UNSET # Convenience field, not serialized
@classmethod
def create(cls, display_name: str) -> "Org":
"""Create a new Org with auto-generated uuid7."""
org = cls(display_name=display_name)
org.uuid = uuid7.create()
return org
class User(msgspec.Struct, dict=True):
"""User data structure. """User data structure.
Mutable fields: display_name, role, last_seen, visits Mutable fields: display_name, role_uuid, last_seen, visits, theme
Immutable fields: created_at (set at creation, never modified) Immutable fields: created_at (set at creation, never modified)
uuid is derived from created_at using uuid7. uuid is derived from created_at using uuid7.
""" """
display_name: str display_name: str
role: UUID role_uuid: UUID = msgspec.field(name="role")
created_at: datetime created_at: datetime
last_seen: datetime | None = None last_seen: datetime | None = None
visits: int = 0 visits: int = 0
theme: str = "" # "" or "auto" = OS default, "light", "dark"
def __post_init__(self): def __post_init__(self):
self.uuid: UUID = _UUID_UNSET # Convenience field, not serialized if not hasattr(self, "uuid"):
self.uuid: UUID = _UUID_UNSET
@property
def role(self) -> Role:
"""Get the role object this user has."""
return db.data().roles[self.role_uuid]
@property
def org(self) -> Org:
"""Get the organization this user belongs to (via role)."""
return self.role.org
@property
def credentials(self) -> list[Credential]:
"""Get all credentials for this user."""
return [c for c in db.data().credentials.values() if c.user_uuid == self.uuid]
@property
def sessions(self) -> list[Session]:
"""Get all sessions for this user."""
return [s for s in db.data().sessions.values() if s.user_uuid == self.uuid]
@property
def reset_tokens(self) -> list[ResetToken]:
"""Get all reset tokens for this user."""
return [t for t in db.data().reset_tokens.values() if t.user_uuid == self.uuid]
@classmethod @classmethod
def create( def create(
cls, cls,
display_name: str, display_name: str,
role: UUID, role: UUID | Role,
created_at: datetime | None = None, created_at: datetime | None = None,
) -> "User": ) -> User:
"""Create a new User with auto-generated uuid7.""" """Create a new User with auto-generated uuid7."""
role_uuid = role if isinstance(role, UUID) else role.uuid
user = cls( user = cls(
display_name=display_name, display_name=display_name,
role=role, role_uuid=role_uuid,
created_at=created_at or datetime.now(timezone.utc), created_at=created_at or datetime.now(UTC),
) )
user.uuid = uuid7.create(user.created_at) user.uuid = uuid7.create(user.created_at)
return user return user
@@ -143,7 +220,7 @@ class Credential(msgspec.Struct, dict=True):
""" """
credential_id: bytes # Long binary ID from the authenticator credential_id: bytes # Long binary ID from the authenticator
user: UUID user_uuid: UUID = msgspec.field(name="user")
aaguid: UUID aaguid: UUID
public_key: bytes public_key: bytes
sign_count: int sign_count: int
@@ -152,23 +229,37 @@ class Credential(msgspec.Struct, dict=True):
last_verified: datetime | None = None last_verified: datetime | None = None
def __post_init__(self): def __post_init__(self):
self.uuid: UUID = _UUID_UNSET # Convenience field, not serialized if not hasattr(self, "uuid"):
self.uuid: UUID = _UUID_UNSET
@property
def user(self) -> User:
"""Get the User object for this credential."""
return db.data().users[self.user_uuid]
@property
def sessions(self) -> list[Session]:
"""Get all sessions using this credential."""
return [
s for s in db.data().sessions.values() if s.credential_uuid == self.uuid
]
@classmethod @classmethod
def create( def create(
cls, cls,
credential_id: bytes, credential_id: bytes,
user: UUID, user: UUID | User,
aaguid: UUID, aaguid: UUID,
public_key: bytes, public_key: bytes,
sign_count: int, sign_count: int,
created_at: datetime | None = None, created_at: datetime | None = None,
) -> "Credential": ) -> Credential:
"""Create a new Credential with auto-generated uuid7.""" """Create a new Credential with auto-generated uuid7."""
now = created_at or datetime.now(timezone.utc) user_uuid = user if isinstance(user, UUID) else user.uuid
now = created_at or datetime.now(UTC)
cred = cls( cred = cls(
credential_id=credential_id, credential_id=credential_id,
user=user, user_uuid=user_uuid,
aaguid=aaguid, aaguid=aaguid,
public_key=public_key, public_key=public_key,
sign_count=sign_count, sign_count=sign_count,
@@ -184,19 +275,30 @@ class Session(msgspec.Struct, dict=True):
"""Session data structure. """Session data structure.
Mutable fields: expiry (updated on session refresh) Mutable fields: expiry (updated on session refresh)
Immutable fields: user, credential, host, ip, user_agent Immutable fields: user_uuid, credential_uuid, host, ip, user_agent
key is stored in the dict key, not in the struct. key is stored in the dict key, not in the struct.
""" """
user: UUID user_uuid: UUID = msgspec.field(name="user")
credential: UUID credential_uuid: UUID = msgspec.field(name="credential")
host: str host: str
ip: str ip: str
user_agent: str user_agent: str
expiry: datetime expiry: datetime
def __post_init__(self): def __post_init__(self):
self.key: str = "" # Convenience field, not serialized if not hasattr(self, "key"):
self.key: str = ""
@property
def user(self) -> User:
"""Get the User object for this session."""
return db.data().users[self.user_uuid]
@property
def credential(self) -> Credential:
"""Get the Credential object for this session."""
return db.data().credentials[self.credential_uuid]
def metadata(self) -> dict: def metadata(self) -> dict:
"""Return session metadata for backwards compatibility.""" """Return session metadata for backwards compatibility."""
@@ -206,6 +308,32 @@ class Session(msgspec.Struct, dict=True):
"expiry": self.expiry.isoformat(), "expiry": self.expiry.isoformat(),
} }
@classmethod
def create(
cls,
user: UUID | User,
credential: UUID | Credential,
host: str,
ip: str,
user_agent: str,
expiry: datetime,
) -> Session:
"""Create a new Session with auto-generated key."""
user_uuid = user if isinstance(user, UUID) else user.uuid
credential_uuid = (
credential if isinstance(credential, UUID) else credential.uuid
)
session = cls(
user_uuid=user_uuid,
credential_uuid=credential_uuid,
host=host,
ip=ip,
user_agent=user_agent,
expiry=expiry,
)
session.key = secrets.token_urlsafe(12)
return session
class ResetToken(msgspec.Struct, dict=True): class ResetToken(msgspec.Struct, dict=True):
"""Reset/device-addition token data structure. """Reset/device-addition token data structure.
@@ -214,12 +342,50 @@ class ResetToken(msgspec.Struct, dict=True):
key is stored in the dict key, not in the struct. key is stored in the dict key, not in the struct.
""" """
user: UUID user_uuid: UUID = msgspec.field(name="user")
expiry: datetime expiry: datetime
token_type: str token_type: str
def __post_init__(self): def __post_init__(self):
self.key: bytes = b"" # Convenience field, not serialized if not hasattr(self, "key"):
self.key: bytes = b""
@property
def user(self) -> User:
"""Get the User object for this reset token."""
return db.data().users[self.user_uuid]
@classmethod
def create(
cls,
user: UUID | User,
expiry: datetime,
token_type: str,
passphrase: str | None = None,
) -> tuple[ResetToken, str]:
"""Create a new ResetToken with auto-generated or provided passphrase.
Args:
user: User UUID or User object
expiry: Token expiration datetime
token_type: Type of token (e.g., "device addition", "account recovery")
passphrase: Optional passphrase to use (auto-generated if not provided)
Returns:
Tuple of (token, passphrase) where passphrase is the human-readable
code to give to the user.
"""
if passphrase is None:
passphrase = generate_passphrase()
key = hashlib.sha512(passphrase.encode()).digest()[:9]
user_uuid = user if isinstance(user, UUID) else user.uuid
token = cls(
user_uuid=user_uuid,
expiry=expiry,
token_type=token_type,
)
token.key = key
return token, passphrase
class SessionContext(msgspec.Struct): class SessionContext(msgspec.Struct):
@@ -231,6 +397,16 @@ class SessionContext(msgspec.Struct):
permissions: list[Permission] = [] permissions: list[Permission] = []
class Config(msgspec.Struct, dict=True, omit_defaults=True):
"""Stored configuration for the instance."""
rp_id: str | None = None
rp_name: str | None = None
origins: list[str] | None = None
auth_host: str | None = None
listen: str | None = None
# ------------------------------------------------------------------------- # -------------------------------------------------------------------------
# Database storage structure # Database storage structure
# ------------------------------------------------------------------------- # -------------------------------------------------------------------------
@@ -246,7 +422,7 @@ class DB(msgspec.Struct, dict=True, omit_defaults=False):
credentials: dict[UUID, Credential] = {} credentials: dict[UUID, Credential] = {}
sessions: dict[str, Session] = {} sessions: dict[str, Session] = {}
reset_tokens: dict[bytes, ResetToken] = {} reset_tokens: dict[bytes, ResetToken] = {}
v: int = 0 config: Config = Config()
def __post_init__(self): def __post_init__(self):
# Store reference for persistence (not serialized) # Store reference for persistence (not serialized)
@@ -270,3 +446,62 @@ class DB(msgspec.Struct, dict=True, omit_defaults=False):
def transaction(self, action, ctx=None, *, user=None): def transaction(self, action, ctx=None, *, user=None):
"""Wrap writes in transaction. Delegates to JsonlStore.""" """Wrap writes in transaction. Delegates to JsonlStore."""
return self._store.transaction(action, ctx, user=user) return self._store.transaction(action, ctx, user=user)
def session_ctx(
self, session_key: str, host: str | None = None
) -> SessionContext | None:
"""Get full session context with effective permissions.
Args:
session_key: The session key string
host: Optional host for binding/validation and domain-scoped permissions
Returns:
SessionContext if valid, None if session not found, expired, or host mismatch
"""
try:
s = self.sessions[session_key]
except KeyError:
return None
# Normalize host for comparison (stored hosts are already normalized)
normalized_input = normalize_host(host)
# Validate host matches (sessions are always created with a host)
if s.host != normalized_input:
# Session bound to different host
return None
try:
user = s.user
role = user.role
org = role.org
credential = s.credential
except KeyError:
return None
# Effective permissions: role's permissions that the org can grant
# Also filter by domain if host is provided
org_perm_uuids = {p.uuid for p in org.permissions}
effective_perms = []
for perm_uuid in role.permission_set:
if perm_uuid not in org_perm_uuids:
continue
try:
p = self.permissions[perm_uuid]
except KeyError:
continue
# Check domain restriction (normalized_input already has port stripped)
if p.domain is not None and p.domain != normalized_input:
continue
effective_perms.append(p)
return SessionContext(
session=s,
user=user,
org=org,
role=role,
credential=credential,
permissions=effective_perms,
)
+63 -39
View File
@@ -7,24 +7,24 @@ from urllib.parse import urlparse
from fastapi_vue.hostutil import parse_endpoint from fastapi_vue.hostutil import parse_endpoint
from uvicorn import Config, Server from uvicorn import Config, Server
from uvicorn import run as uvicorn_run
from paskia import globals as _globals from paskia import globals as _globals
from paskia.bootstrap import bootstrap_if_needed from paskia.bootstrap import bootstrap_if_needed
from paskia.config import PaskiaConfig from paskia.config import PaskiaConfig
from paskia.db import get_config, set_config
from paskia.db import init as db_init
from paskia.db.background import flush from paskia.db.background import flush
from paskia.fastapi import app as fastapi_app from paskia.db.structs import Config
from paskia.fastapi import reset as reset_cmd
from paskia.util import startupbox from paskia.util import startupbox
from paskia.util.hostutil import normalize_origin from paskia.util.hostutil import normalize_origin
DEFAULT_PORT = 4401 DEFAULT_PORT = 4401
DEVMODE = bool(os.getenv("PASKIA_FRONTEND_URL"))
EPILOG = """\ EPILOG = """\
Examples: Example:
paskia # localhost:4401 paskia --rp-id example.com --rp-name "Example Corporation" --auth-host auth.example.com
paskia :8080 # All interfaces, port 8080
paskia unix:/tmp/paskia.sock
paskia reset [user] # Generate passkey reset link
""" """
@@ -63,10 +63,12 @@ def add_common_options(p: argparse.ArgumentParser) -> None:
) )
p.add_argument( p.add_argument(
"--auth-host", "--auth-host",
help=( help=("Dedicated authentication site (optionally with scheme/port)"),
"Dedicated host (optionally with scheme/port) to serve the auth UI at the root," )
" e.g. auth.example.com or https://auth.example.com" p.add_argument(
), "--save",
action="store_true",
help="Save the CLI options to database for future runs.",
) )
@@ -81,32 +83,43 @@ def main():
epilog=EPILOG, epilog=EPILOG,
) )
# Primary argument: either host:port or "reset" subcommand
parser.add_argument( parser.add_argument(
"hostport", "-l",
nargs="?", "--listen",
metavar="LISTEN",
help=( help=(
"Endpoint (default: localhost:4401). Forms: host[:port] | :port | " "Endpoint to listen on (default: localhost:4401). "
"[ipv6][:port] | ipv6 | unix:/path.sock | 'reset' for credential reset" "Forms: host:port port :port [ipv6]:port unix:path /path.sock"
), ),
) )
parser.add_argument(
"reset_query",
nargs="?",
help="For 'reset' command: user UUID or substring of display name",
)
add_common_options(parser) add_common_options(parser)
args = parser.parse_args() args = parser.parse_args()
# Detect "reset" subcommand (first positional is "reset") # Handle clearing options
is_reset = args.hostport == "reset" if getattr(args, "auth_host", None) == "":
args.auth_host = None
if getattr(args, "rp_name", None) == "":
args.rp_name = None
if getattr(args, "listen", None) == "":
args.listen = None
if is_reset: # Init db and load stored config
endpoints = [] asyncio.run(db_init(rp_id=args.rp_id))
else: stored_config = get_config()
# Parse endpoint using fastapi_vue.hostutil
endpoints = parse_endpoint(args.hostport, DEFAULT_PORT) # Apply defaults from stored config
if args.rp_name is None and stored_config.rp_name is not None:
args.rp_name = stored_config.rp_name
if args.origins is None and stored_config.origins is not None:
args.origins = stored_config.origins
if args.auth_host is None and stored_config.auth_host is not None:
args.auth_host = stored_config.auth_host
if args.listen is None and stored_config.listen is not None:
args.listen = stored_config.listen
# Parse endpoint using fastapi_vue.hostutil
endpoints = parse_endpoint(args.listen, DEFAULT_PORT)
# Extract host/port/uds from first endpoint for config display and site_url # Extract host/port/uds from first endpoint for config display and site_url
ep = endpoints[0] if endpoints else {} ep = endpoints[0] if endpoints else {}
@@ -185,21 +198,28 @@ def main():
startupbox.print_startup_config(config) startupbox.print_startup_config(config)
devmode = bool(os.environ.get("FASTAPI_VUE_FRONTEND_URL")) if args.save:
new_config = Config(
rp_id=args.rp_id,
rp_name=args.rp_name,
origins=args.origins,
auth_host=args.auth_host,
listen=args.listen,
)
asyncio.run(set_config(new_config))
run_kwargs: dict = { run_kwargs: dict = {
"log_level": "info", "log_level": "warning", # Suppress startup messages; we use custom logging
"access_log": False, # We use custom AccessLogMiddleware instead
} }
if devmode: if DEVMODE:
# Security: dev mode must run on localhost:4402 to prevent # Security: dev mode must run on localhost:4402 to prevent
# accidental public exposure of the Vite dev server # accidental public exposure of the Vite dev server
if host != "localhost" or port != 4402: if host != "localhost" or port != 4402:
raise SystemExit(f"Dev mode requires localhost:4402, got {host}:{port}") raise SystemExit(f"Dev mode requires localhost:4402, got {host}:{port}")
run_kwargs["reload"] = True run_kwargs["reload"] = True
run_kwargs["reload_dirs"] = ["paskia"] run_kwargs["reload_dirs"] = ["paskia"]
# Suppress uvicorn startup messages in dev mode
run_kwargs["log_level"] = "warning"
async def async_main(): async def async_main():
await _globals.init( await _globals.init(
@@ -211,18 +231,22 @@ def main():
await bootstrap_if_needed() await bootstrap_if_needed()
await flush() await flush()
if is_reset:
exit_code = reset_cmd.run(args.reset_query)
raise SystemExit(exit_code)
if len(endpoints) > 1: if len(endpoints) > 1:
async with asyncio.TaskGroup() as tg: async with asyncio.TaskGroup() as tg:
for ep in endpoints: for ep in endpoints:
tg.create_task( tg.create_task(
Server(Config(app=fastapi_app, **run_kwargs, **ep)).serve() Server(
Config(app="paskia.fastapi:app", **run_kwargs, **ep)
).serve()
) )
elif DEVMODE:
# Use uvicorn.run for proper reload support (it handles subprocess spawning)
ep = endpoints[0]
uvicorn_run("paskia.fastapi:app", **run_kwargs, **ep)
else: else:
server = Server(Config(app=fastapi_app, **run_kwargs, **endpoints[0])) server = Server(
Config(app="paskia.fastapi:app", **run_kwargs, **endpoints[0])
)
await server.serve() await server.serve()
try: try:
+159 -276
View File
@@ -1,5 +1,4 @@
import logging import logging
from datetime import timezone
from uuid import UUID from uuid import UUID
from fastapi import Body, FastAPI, HTTPException, Query, Request, Response from fastapi import Body, FastAPI, HTTPException, Query, Request, Response
@@ -13,53 +12,33 @@ from paskia.db import Permission as PermDC
from paskia.db import Role as RoleDC from paskia.db import Role as RoleDC
from paskia.db import User as UserDC from paskia.db import User as UserDC
from paskia.fastapi import authz from paskia.fastapi import authz
from paskia.fastapi.response import MsgspecResponse
from paskia.fastapi.session import AUTH_COOKIE from paskia.fastapi.session import AUTH_COOKIE
from paskia.globals import passkey from paskia.globals import passkey
from paskia.util import ( from paskia.util import (
hostutil, hostutil,
passphrase,
permutil, permutil,
querysafe, querysafe,
useragent,
vitedev, vitedev,
) )
from paskia.util.apistructs import ApiPermission, ApiSession, format_datetime
from paskia.util.hostutil import normalize_host from paskia.util.hostutil import normalize_host
app = FastAPI(docs_url=None, redoc_url=None, openapi_url=None) app = FastAPI(docs_url=None, redoc_url=None, openapi_url=None)
def is_global_admin(ctx) -> bool: def master_admin(ctx) -> bool:
"""Check if user has global admin permission.""" return any(p.scope == "auth:admin" for p in ctx.permissions)
effective_scopes = (
{p.scope for p in (ctx.permissions or [])}
if ctx.permissions def org_admin(ctx, org_uuid: UUID) -> bool:
else set(ctx.role.permissions or []) return ctx.org.uuid == org_uuid and any(
p.scope == "auth:org:admin" for p in ctx.permissions
) )
return "auth:admin" in effective_scopes
def is_org_admin(ctx, org_uuid: UUID | None = None) -> bool:
"""Check if user has org admin permission.
If org_uuid is provided, checks if user is admin of that specific org.
If org_uuid is None, checks if user is admin of their own org.
"""
effective_scopes = (
{p.scope for p in (ctx.permissions or [])}
if ctx.permissions
else set(ctx.role.permissions or [])
)
if "auth:org:admin" not in effective_scopes:
return False
if org_uuid is None:
return True
# User must belong to the target org (via their role)
return ctx.org.uuid == org_uuid
def can_manage_org(ctx, org_uuid: UUID) -> bool: def can_manage_org(ctx, org_uuid: UUID) -> bool:
"""Check if user can manage the specified organization.""" return master_admin(ctx) or org_admin(ctx, org_uuid)
return is_global_admin(ctx) or is_org_admin(ctx, org_uuid)
@app.exception_handler(ValueError) @app.exception_handler(ValueError)
@@ -99,42 +78,39 @@ async def admin_list_orgs(request: Request, auth=AUTH_COOKIE):
host=request.headers.get("host"), host=request.headers.get("host"),
) )
orgs = list(db.data().orgs.values()) orgs = list(db.data().orgs.values())
if not is_global_admin(ctx): if not master_admin(ctx):
# Org admins can only see their own organization # Org admins can only see their own organization
orgs = [o for o in orgs if o.uuid == ctx.org.uuid] orgs = [o for o in orgs if o.uuid == ctx.org.uuid]
def role_to_dict(r): def org_to_dict(o):
return {
"uuid": str(r.uuid),
"org": str(r.org),
"display_name": r.display_name,
"permissions": list(r.permissions.keys()),
}
async def org_to_dict(o):
users = db.get_organization_users(o.uuid) users = db.get_organization_users(o.uuid)
return { return {
"uuid": str(o.uuid), "uuid": o.uuid,
"display_name": o.display_name, "display_name": o.display_name,
"permissions": { "permissions": {p.uuid for p in o.permissions},
pid for pid, p in db.data().permissions.items() if o.uuid in p.orgs
},
"roles": [ "roles": [
role_to_dict(r) for r in db.data().roles.values() if r.org == o.uuid {
"uuid": r.uuid,
"org": r.org_uuid,
"display_name": r.display_name,
"permissions": list(r.permissions.keys()),
}
for r in o.roles
], ],
"users": [ "users": [
{ {
"uuid": str(u.uuid), "uuid": u.uuid,
"display_name": u.display_name, "display_name": u.display_name,
"role": role_name, "role": role_name,
"role_uuid": u.role_uuid,
"visits": u.visits, "visits": u.visits,
"last_seen": u.last_seen.isoformat() if u.last_seen else None, "last_seen": u.last_seen,
} }
for (u, role_name) in users for (u, role_name) in users
], ],
} }
return [await org_to_dict(o) for o in orgs] return MsgspecResponse([org_to_dict(o) for o in orgs])
@app.post("/orgs") @app.post("/orgs")
@@ -151,7 +127,7 @@ async def admin_create_org(
db.create_org(org, ctx=ctx) db.create_org(org, ctx=ctx)
# Grant requested permissions to the new org # Grant requested permissions to the new org
for perm in permissions: for perm in permissions:
db.add_permission_to_org(str(org.uuid), perm) db.add_permission_to_org(str(org.uuid), perm, ctx=ctx)
return {"uuid": str(org.uuid)} return {"uuid": str(org.uuid)}
@@ -283,7 +259,8 @@ async def admin_create_role(
perms = payload.get("permissions") or [] perms = payload.get("permissions") or []
if org_uuid not in db.data().orgs: if org_uuid not in db.data().orgs:
raise HTTPException(status_code=404, detail="Organization not found") raise HTTPException(status_code=404, detail="Organization not found")
grantable = {pid for pid, p in db.data().permissions.items() if org_uuid in p.orgs} org = db.data().orgs[org_uuid]
grantable = {p.uuid for p in org.permissions}
# Normalize permission IDs to UUIDs # Normalize permission IDs to UUIDs
permission_uuids: set[UUID] = set() permission_uuids: set[UUID] = set()
@@ -304,28 +281,27 @@ async def admin_create_role(
return {"uuid": str(role.uuid)} return {"uuid": str(role.uuid)}
@app.patch("/orgs/{org_uuid}/roles/{role_uuid}") @app.patch("/roles/{role_uuid}")
async def admin_update_role_name( async def admin_update_role_name(
org_uuid: UUID,
role_uuid: UUID, role_uuid: UUID,
request: Request, request: Request,
payload: dict = Body(...), payload: dict = Body(...),
auth=AUTH_COOKIE, auth=AUTH_COOKIE,
): ):
"""Update role display name only.""" """Update role display name only."""
role = db.data().roles.get(role_uuid)
if not role:
raise HTTPException(status_code=404, detail="Role not found")
ctx = await authz.verify( ctx = await authz.verify(
auth, auth,
["auth:admin", "auth:org:admin"], ["auth:admin", "auth:org:admin"],
match=permutil.has_any, match=permutil.has_any,
host=request.headers.get("host"), host=request.headers.get("host"),
) )
if not can_manage_org(ctx, org_uuid): if not can_manage_org(ctx, role.org_uuid):
raise authz.AuthException( raise authz.AuthException(
status_code=403, detail="Insufficient permissions", mode="forbidden" status_code=403, detail="Insufficient permissions", mode="forbidden"
) )
role = db.data().roles.get(role_uuid)
if not role or role.org != org_uuid:
raise HTTPException(status_code=404, detail="Role not found in organization")
display_name = payload.get("display_name") display_name = payload.get("display_name")
if not display_name: if not display_name:
@@ -335,68 +311,64 @@ async def admin_update_role_name(
return {"status": "ok"} return {"status": "ok"}
@app.post("/orgs/{org_uuid}/roles/{role_uuid}/permissions/{permission_uuid}") @app.post("/roles/{role_uuid}/permissions/{permission_uuid}")
async def admin_add_role_permission( async def admin_add_role_permission(
org_uuid: UUID,
role_uuid: UUID, role_uuid: UUID,
permission_uuid: UUID, permission_uuid: UUID,
request: Request, request: Request,
auth=AUTH_COOKIE, auth=AUTH_COOKIE,
): ):
"""Add a permission to a role (intent-based API).""" """Add a permission to a role (intent-based API)."""
role = db.data().roles.get(role_uuid)
if not role:
raise HTTPException(status_code=404, detail="Role not found")
ctx = await authz.verify( ctx = await authz.verify(
auth, auth,
["auth:admin", "auth:org:admin"], ["auth:admin", "auth:org:admin"],
match=permutil.has_any, match=permutil.has_any,
host=request.headers.get("host"), host=request.headers.get("host"),
) )
if not can_manage_org(ctx, org_uuid): if not can_manage_org(ctx, role.org_uuid):
raise authz.AuthException( raise authz.AuthException(
status_code=403, detail="Insufficient permissions", mode="forbidden" status_code=403, detail="Insufficient permissions", mode="forbidden"
) )
role = db.data().roles.get(role_uuid)
if not role or role.org != org_uuid:
raise HTTPException(status_code=404, detail="Role not found in organization")
# Verify permission exists and org can grant it # Verify permission exists and org can grant it
perm = db.data().permissions.get(permission_uuid) perm = db.data().permissions.get(permission_uuid)
if not perm: if not perm:
raise HTTPException(status_code=404, detail="Permission not found") raise HTTPException(status_code=404, detail="Permission not found")
if org_uuid not in perm.orgs: if role.org_uuid not in perm.orgs:
raise ValueError("Permission not grantable by organization") raise ValueError("Permission not grantable by organization")
db.add_permission_to_role(role_uuid, permission_uuid, ctx=ctx) db.add_permission_to_role(role_uuid, permission_uuid, ctx=ctx)
return {"status": "ok"} return {"status": "ok"}
@app.delete("/orgs/{org_uuid}/roles/{role_uuid}/permissions/{permission_uuid}") @app.delete("/roles/{role_uuid}/permissions/{permission_uuid}")
async def admin_remove_role_permission( async def admin_remove_role_permission(
org_uuid: UUID,
role_uuid: UUID, role_uuid: UUID,
permission_uuid: UUID, permission_uuid: UUID,
request: Request, request: Request,
auth=AUTH_COOKIE, auth=AUTH_COOKIE,
): ):
"""Remove a permission from a role (intent-based API).""" """Remove a permission from a role (intent-based API)."""
role = db.data().roles.get(role_uuid)
if not role:
raise HTTPException(status_code=404, detail="Role not found")
ctx = await authz.verify( ctx = await authz.verify(
auth, auth,
["auth:admin", "auth:org:admin"], ["auth:admin", "auth:org:admin"],
match=permutil.has_any, match=permutil.has_any,
host=request.headers.get("host"), host=request.headers.get("host"),
) )
if not can_manage_org(ctx, org_uuid): if not can_manage_org(ctx, role.org_uuid):
raise authz.AuthException( raise authz.AuthException(
status_code=403, detail="Insufficient permissions", mode="forbidden" status_code=403, detail="Insufficient permissions", mode="forbidden"
) )
role = db.data().roles.get(role_uuid)
if not role or role.org != org_uuid:
raise HTTPException(status_code=404, detail="Role not found in organization")
# Sanity check: prevent admin from removing their own access # Sanity check: prevent admin from removing their own access
perm = db.data().permissions.get(permission_uuid) perm = db.data().permissions.get(permission_uuid)
if ctx.org.uuid == org_uuid and ctx.role.uuid == role_uuid: if ctx.org.uuid == role.org_uuid and ctx.role.uuid == role_uuid:
if perm and perm.scope in ["auth:admin", "auth:org:admin"]: if perm and perm.scope in ["auth:admin", "auth:org:admin"]:
# Check if removing this permission would leave no admin access # Check if removing this permission would leave no admin access
remaining_perms = role.permission_set - {permission_uuid} remaining_perms = role.permission_set - {permission_uuid}
@@ -413,13 +385,15 @@ async def admin_remove_role_permission(
return {"status": "ok"} return {"status": "ok"}
@app.delete("/orgs/{org_uuid}/roles/{role_uuid}") @app.delete("/roles/{role_uuid}")
async def admin_delete_role( async def admin_delete_role(
org_uuid: UUID,
role_uuid: UUID, role_uuid: UUID,
request: Request, request: Request,
auth=AUTH_COOKIE, auth=AUTH_COOKIE,
): ):
role = db.data().roles.get(role_uuid)
if not role:
raise HTTPException(status_code=404, detail="Role not found")
ctx = await authz.verify( ctx = await authz.verify(
auth, auth,
["auth:admin", "auth:org:admin"], ["auth:admin", "auth:org:admin"],
@@ -427,13 +401,10 @@ async def admin_delete_role(
host=request.headers.get("host"), host=request.headers.get("host"),
max_age="5m", max_age="5m",
) )
if not can_manage_org(ctx, org_uuid): if not can_manage_org(ctx, role.org_uuid):
raise authz.AuthException( raise authz.AuthException(
status_code=403, detail="Insufficient permissions", mode="forbidden" status_code=403, detail="Insufficient permissions", mode="forbidden"
) )
role = db.data().roles.get(role_uuid)
if not role or role.org != org_uuid:
raise HTTPException(status_code=404, detail="Role not found in organization")
# Sanity check: prevent admin from deleting their own role # Sanity check: prevent admin from deleting their own role
if ctx.role.uuid == role_uuid: if ctx.role.uuid == role_uuid:
@@ -468,8 +439,11 @@ async def admin_create_user(
if not display_name or not role_name: if not display_name or not role_name:
raise ValueError("display_name and role are required") raise ValueError("display_name and role are required")
roles = [r for r in db.data().roles.values() if r.org == org_uuid] org = db.data().orgs[org_uuid]
role_obj = next((r for r in roles if r.display_name == role_name), None) role_obj = next(
(r for r in org.roles if r.display_name == role_name),
None,
)
if not role_obj: if not role_obj:
raise ValueError("Role not found in organization") raise ValueError("Role not found in organization")
user = UserDC.create( user = UserDC.create(
@@ -480,60 +454,58 @@ async def admin_create_user(
return {"uuid": str(user.uuid)} return {"uuid": str(user.uuid)}
@app.patch("/orgs/{org_uuid}/users/{user_uuid}/role") @app.patch("/users/{user_uuid}/role")
async def admin_update_user_role( async def admin_update_user_role(
org_uuid: UUID,
user_uuid: UUID, user_uuid: UUID,
request: Request, request: Request,
payload: dict = Body(...), payload: dict = Body(...),
auth=AUTH_COOKIE, auth=AUTH_COOKIE,
): ):
try:
user_org, _current_role = db.get_user_organization(user_uuid)
except ValueError:
raise HTTPException(status_code=404, detail="User not found")
ctx = await authz.verify( ctx = await authz.verify(
auth, auth,
["auth:admin", "auth:org:admin"], ["auth:admin", "auth:org:admin"],
match=permutil.has_any, match=permutil.has_any,
host=request.headers.get("host"), host=request.headers.get("host"),
) )
if not can_manage_org(ctx, org_uuid): if not can_manage_org(ctx, user_org.uuid):
raise authz.AuthException( raise authz.AuthException(
status_code=403, detail="Insufficient permissions", mode="forbidden" status_code=403, detail="Insufficient permissions", mode="forbidden"
) )
new_role = payload.get("role") role_uuid_str = payload.get("role_uuid")
if not new_role: if not role_uuid_str:
raise ValueError("role is required") raise ValueError("role_uuid is required")
try: try:
user_org, _current_role = db.get_user_organization(user_uuid) new_role_uuid = UUID(role_uuid_str)
except ValueError: except (ValueError, TypeError):
raise ValueError("User not found") raise ValueError("Invalid role UUID")
if user_org.uuid != org_uuid: new_role = db.data().roles.get(new_role_uuid)
raise ValueError("User does not belong to this organization") if not new_role or new_role.org_uuid != user_org.uuid:
roles = [r for r in db.data().roles.values() if r.org == org_uuid]
if not any(r.display_name == new_role for r in roles):
raise ValueError("Role not found in organization") raise ValueError("Role not found in organization")
# Sanity check: prevent admin from removing their own access # Sanity check: prevent admin from removing their own access
if ctx.user.uuid == user_uuid: if ctx.user.uuid == user_uuid:
new_role_obj = next((r for r in roles if r.display_name == new_role), None) # Check if any permission in the new role is an admin permission
if new_role_obj: # pragma: no branch - always true, role validated above has_admin_access = False
# Check if any permission in the new role is an admin permission for perm_uuid in new_role.permissions:
has_admin_access = False perm = db.data().permissions.get(perm_uuid)
for perm_uuid in new_role_obj.permissions: if perm and perm.scope in ["auth:admin", "auth:org:admin"]:
perm = db.data().permissions.get(perm_uuid) has_admin_access = True
if perm and perm.scope in ["auth:admin", "auth:org:admin"]: break
has_admin_access = True if not has_admin_access:
break raise ValueError(
if not has_admin_access: "Cannot change your own role to one without admin permissions"
raise ValueError( )
"Cannot change your own role to one without admin permissions"
)
db.update_user_role_in_organization(user_uuid, new_role, ctx=ctx) db.update_user_role(user_uuid, new_role_uuid, ctx=ctx)
return {"status": "ok"} return {"status": "ok"}
@app.post("/orgs/{org_uuid}/users/{user_uuid}/create-link") @app.post("/users/{user_uuid}/create-link")
async def admin_create_user_registration_link( async def admin_create_user_registration_link(
org_uuid: UUID,
user_uuid: UUID, user_uuid: UUID,
request: Request, request: Request,
auth=AUTH_COOKIE, auth=AUTH_COOKIE,
@@ -542,8 +514,6 @@ async def admin_create_user_registration_link(
user_org, _role_name = db.get_user_organization(user_uuid) user_org, _role_name = db.get_user_organization(user_uuid)
except ValueError: except ValueError:
raise HTTPException(status_code=404, detail="User not found") raise HTTPException(status_code=404, detail="User not found")
if user_org.uuid != org_uuid:
raise HTTPException(status_code=404, detail="User not found in organization")
ctx = await authz.verify( ctx = await authz.verify(
auth, auth,
["auth:admin", "auth:org:admin"], ["auth:admin", "auth:org:admin"],
@@ -551,7 +521,7 @@ async def admin_create_user_registration_link(
host=request.headers.get("host"), host=request.headers.get("host"),
max_age="5m", max_age="5m",
) )
if not can_manage_org(ctx, org_uuid): if not can_manage_org(ctx, user_org.uuid):
raise authz.AuthException( raise authz.AuthException(
status_code=403, detail="Insufficient permissions", mode="forbidden" status_code=403, detail="Insufficient permissions", mode="forbidden"
) )
@@ -560,11 +530,9 @@ async def admin_create_user_registration_link(
has_credentials = db.get_user_credential_ids(user_uuid) has_credentials = db.get_user_credential_ids(user_uuid)
token_type = "user registration" if not has_credentials else "account recovery" token_type = "user registration" if not has_credentials else "account recovery"
token = passphrase.generate()
expiry = reset_expires() expiry = reset_expires()
db.create_reset_token( token = db.create_reset_token(
user_uuid=user_uuid, user_uuid=user_uuid,
passphrase=token,
expiry=expiry, expiry=expiry,
token_type=token_type, token_type=token_type,
ctx=ctx, ctx=ctx,
@@ -572,17 +540,13 @@ async def admin_create_user_registration_link(
url = hostutil.reset_link_url(token) url = hostutil.reset_link_url(token)
return { return {
"url": url, "url": url,
"expires": ( "expires": format_datetime(expiry),
expiry.astimezone(timezone.utc).isoformat().replace("+00:00", "Z") "token_type": token_type,
if expiry.tzinfo
else expiry.replace(tzinfo=timezone.utc).isoformat().replace("+00:00", "Z")
),
} }
@app.get("/orgs/{org_uuid}/users/{user_uuid}") @app.get("/users/{user_uuid}")
async def admin_get_user_detail( async def admin_get_user_detail(
org_uuid: UUID,
user_uuid: UUID, user_uuid: UUID,
request: Request, request: Request,
auth=AUTH_COOKIE, auth=AUTH_COOKIE,
@@ -591,138 +555,54 @@ async def admin_get_user_detail(
user_org, role_name = db.get_user_organization(user_uuid) user_org, role_name = db.get_user_organization(user_uuid)
except ValueError: except ValueError:
raise HTTPException(status_code=404, detail="User not found") raise HTTPException(status_code=404, detail="User not found")
if user_org.uuid != org_uuid:
raise HTTPException(status_code=404, detail="User not found in organization")
ctx = await authz.verify( ctx = await authz.verify(
auth, auth,
["auth:admin", "auth:org:admin"], ["auth:admin", "auth:org:admin"],
match=permutil.has_any, match=permutil.has_any,
host=request.headers.get("host"), host=request.headers.get("host"),
) )
if not can_manage_org(ctx, org_uuid): if not can_manage_org(ctx, user_org.uuid):
raise authz.AuthException( raise authz.AuthException(
status_code=403, detail="Insufficient permissions", mode="forbidden" status_code=403, detail="Insufficient permissions", mode="forbidden"
) )
user = db.data().users.get(user_uuid) user = db.data().users.get(user_uuid)
user_creds = [c for c in db.data().credentials.values() if c.user == user_uuid] normalized_host = hostutil.normalize_host(request.headers.get("host"))
creds: list[dict] = []
aaguids: set[str] = set() return MsgspecResponse(
for c in user_creds: {
aaguid_str = str(c.aaguid) "display_name": user.display_name,
aaguids.add(aaguid_str) "org": {"display_name": user_org.display_name},
creds.append( "role": role_name,
{ "visits": user.visits,
"credential": str(c.uuid), "created_at": user.created_at,
"aaguid": aaguid_str, "last_seen": user.last_seen,
"created_at": ( "credentials": [
c.created_at.astimezone(timezone.utc) {
.isoformat() "credential": c.uuid,
.replace("+00:00", "Z") "aaguid": c.aaguid,
if c.created_at.tzinfo "created_at": c.created_at,
else c.created_at.replace(tzinfo=timezone.utc) "last_used": c.last_used,
.isoformat() "last_verified": c.last_verified,
.replace("+00:00", "Z") "sign_count": c.sign_count,
), }
"last_used": ( for c in user.credentials
c.last_used.astimezone(timezone.utc) ],
.isoformat() "aaguid_info": aaguid_mod.filter(c.aaguid for c in user.credentials),
.replace("+00:00", "Z") "sessions": [
if c.last_used and c.last_used.tzinfo ApiSession.from_db(
else ( s,
c.last_used.replace(tzinfo=timezone.utc) current_key=auth,
.isoformat() normalized_host=normalized_host,
.replace("+00:00", "Z") expires_delta=EXPIRES,
if c.last_used
else None
)
),
"last_verified": (
c.last_verified.astimezone(timezone.utc)
.isoformat()
.replace("+00:00", "Z")
if c.last_verified and c.last_verified.tzinfo
else (
c.last_verified.replace(tzinfo=timezone.utc)
.isoformat()
.replace("+00:00", "Z")
if c.last_verified
else None
)
) )
if c.last_verified for s in user.sessions
else None, ],
"sign_count": c.sign_count, }
} )
)
aaguid_info = aaguid_mod.filter(aaguids)
# Get sessions for the user
normalized_request_host = hostutil.normalize_host(request.headers.get("host"))
session_records = [s for s in db.data().sessions.values() if s.user == user_uuid]
current_session_key = auth
sessions_payload: list[dict] = []
for entry in session_records:
renewed = entry.expiry - EXPIRES
sessions_payload.append(
{
"id": entry.key,
"credential": str(entry.credential),
"host": entry.host,
"ip": entry.ip,
"user_agent": useragent.compact_user_agent(entry.user_agent),
"last_renewed": (
renewed.astimezone(timezone.utc).isoformat().replace("+00:00", "Z")
if renewed.tzinfo
else renewed.replace(tzinfo=timezone.utc)
.isoformat()
.replace("+00:00", "Z")
),
"is_current": entry.key == current_session_key,
"is_current_host": bool(
normalized_request_host
and entry.host
and entry.host == normalized_request_host
),
}
)
return {
"display_name": user.display_name,
"org": {"display_name": user_org.display_name},
"role": role_name,
"visits": user.visits,
"created_at": (
user.created_at.astimezone(timezone.utc).isoformat().replace("+00:00", "Z")
if user.created_at and user.created_at.tzinfo
else (
user.created_at.replace(tzinfo=timezone.utc)
.isoformat()
.replace("+00:00", "Z")
if user.created_at
else None
)
),
"last_seen": (
user.last_seen.astimezone(timezone.utc).isoformat().replace("+00:00", "Z")
if user.last_seen and user.last_seen.tzinfo
else (
user.last_seen.replace(tzinfo=timezone.utc)
.isoformat()
.replace("+00:00", "Z")
if user.last_seen
else None
)
),
"credentials": creds,
"aaguid_info": aaguid_info,
"sessions": sessions_payload,
}
@app.patch("/orgs/{org_uuid}/users/{user_uuid}/display-name") @app.patch("/users/{user_uuid}/display-name")
async def admin_update_user_display_name( async def admin_update_user_display_name(
org_uuid: UUID,
user_uuid: UUID, user_uuid: UUID,
request: Request, request: Request,
payload: dict = Body(...), payload: dict = Body(...),
@@ -732,15 +612,13 @@ async def admin_update_user_display_name(
user_org, _role_name = db.get_user_organization(user_uuid) user_org, _role_name = db.get_user_organization(user_uuid)
except ValueError: except ValueError:
raise HTTPException(status_code=404, detail="User not found") raise HTTPException(status_code=404, detail="User not found")
if user_org.uuid != org_uuid:
raise HTTPException(status_code=404, detail="User not found in organization")
ctx = await authz.verify( ctx = await authz.verify(
auth, auth,
["auth:admin", "auth:org:admin"], ["auth:admin", "auth:org:admin"],
match=permutil.has_any, match=permutil.has_any,
host=request.headers.get("host"), host=request.headers.get("host"),
) )
if not can_manage_org(ctx, org_uuid): if not can_manage_org(ctx, user_org.uuid):
raise authz.AuthException( raise authz.AuthException(
status_code=403, detail="Insufficient permissions", mode="forbidden" status_code=403, detail="Insufficient permissions", mode="forbidden"
) )
@@ -753,9 +631,37 @@ async def admin_update_user_display_name(
return {"status": "ok"} return {"status": "ok"}
@app.delete("/orgs/{org_uuid}/users/{user_uuid}/credentials/{credential_uuid}") @app.delete("/users/{user_uuid}")
async def admin_delete_user(
user_uuid: UUID,
request: Request,
auth=AUTH_COOKIE,
):
"""Delete a user and all their credentials/sessions."""
try:
user_org, _role_name = db.get_user_organization(user_uuid)
except ValueError:
raise HTTPException(status_code=404, detail="User not found")
ctx = await authz.verify(
auth,
["auth:admin", "auth:org:admin"],
match=permutil.has_any,
host=request.headers.get("host"),
max_age="5m",
)
if not can_manage_org(ctx, user_org.uuid):
raise authz.AuthException(
status_code=403, detail="Insufficient permissions", mode="forbidden"
)
# Prevent admin from deleting themselves
if ctx.user.uuid == user_uuid:
raise ValueError("Cannot delete your own account")
db.delete_user(user_uuid, ctx=ctx)
return {"status": "ok"}
@app.delete("/users/{user_uuid}/credentials/{credential_uuid}")
async def admin_delete_user_credential( async def admin_delete_user_credential(
org_uuid: UUID,
user_uuid: UUID, user_uuid: UUID,
credential_uuid: UUID, credential_uuid: UUID,
request: Request, request: Request,
@@ -765,8 +671,6 @@ async def admin_delete_user_credential(
user_org, _role_name = db.get_user_organization(user_uuid) user_org, _role_name = db.get_user_organization(user_uuid)
except ValueError: except ValueError:
raise HTTPException(status_code=404, detail="User not found") raise HTTPException(status_code=404, detail="User not found")
if user_org.uuid != org_uuid:
raise HTTPException(status_code=404, detail="User not found in organization")
ctx = await authz.verify( ctx = await authz.verify(
auth, auth,
["auth:admin", "auth:org:admin"], ["auth:admin", "auth:org:admin"],
@@ -774,7 +678,7 @@ async def admin_delete_user_credential(
host=request.headers.get("host"), host=request.headers.get("host"),
max_age="5m", max_age="5m",
) )
if not can_manage_org(ctx, org_uuid): if not can_manage_org(ctx, user_org.uuid):
raise authz.AuthException( raise authz.AuthException(
status_code=403, detail="Insufficient permissions", mode="forbidden" status_code=403, detail="Insufficient permissions", mode="forbidden"
) )
@@ -782,9 +686,8 @@ async def admin_delete_user_credential(
return {"status": "ok"} return {"status": "ok"}
@app.delete("/orgs/{org_uuid}/users/{user_uuid}/sessions/{session_id}") @app.delete("/users/{user_uuid}/sessions/{session_id}")
async def admin_delete_user_session( async def admin_delete_user_session(
org_uuid: UUID,
user_uuid: UUID, user_uuid: UUID,
session_id: str, session_id: str,
request: Request, request: Request,
@@ -794,24 +697,22 @@ async def admin_delete_user_session(
user_org, _role_name = db.get_user_organization(user_uuid) user_org, _role_name = db.get_user_organization(user_uuid)
except ValueError: except ValueError:
raise HTTPException(status_code=404, detail="User not found") raise HTTPException(status_code=404, detail="User not found")
if user_org.uuid != org_uuid:
raise HTTPException(status_code=404, detail="User not found in organization")
ctx = await authz.verify( ctx = await authz.verify(
auth, auth,
["auth:admin", "auth:org:admin"], ["auth:admin", "auth:org:admin"],
match=permutil.has_any, match=permutil.has_any,
host=request.headers.get("host"), host=request.headers.get("host"),
) )
if not can_manage_org(ctx, org_uuid): if not can_manage_org(ctx, user_org.uuid):
raise authz.AuthException( raise authz.AuthException(
status_code=403, detail="Insufficient permissions", mode="forbidden" status_code=403, detail="Insufficient permissions", mode="forbidden"
) )
target_session = db.data().sessions.get(session_id) target_session = db.data().sessions.get(session_id)
if not target_session or target_session.user != user_uuid: if not target_session or target_session.user_uuid != user_uuid:
raise HTTPException(status_code=404, detail="Session not found") raise HTTPException(status_code=404, detail="Session not found")
db.delete_session(session_id, ctx=ctx) db.delete_session(session_id, ctx=ctx, action="admin:delete_session")
# Check if admin terminated their own session # Check if admin terminated their own session
current_terminated = session_id == auth current_terminated = session_id == auth
@@ -821,14 +722,6 @@ async def admin_delete_user_session(
# -------------------- Permissions (global) -------------------- # -------------------- Permissions (global) --------------------
def _perm_to_dict(p):
"""Convert Permission to dict, omitting domain if None."""
d = {"uuid": str(p.uuid), "scope": p.scope, "display_name": p.display_name}
if p.domain is not None:
d["domain"] = p.domain
return d
def _validate_permission_domain(domain: str | None) -> None: def _validate_permission_domain(domain: str | None) -> None:
"""Validate that domain is rp_id or a subdomain of it.""" """Validate that domain is rp_id or a subdomain of it."""
if domain is None: if domain is None:
@@ -919,18 +812,8 @@ async def admin_list_permissions(request: Request, auth=AUTH_COOKIE):
match=permutil.has_any, match=permutil.has_any,
host=request.headers.get("host"), host=request.headers.get("host"),
) )
perms = list(db.data().permissions.values()) perms = db.data().permissions.values() if master_admin(ctx) else ctx.org.permissions
return MsgspecResponse([ApiPermission.from_db(p) for p in perms])
# Global admins see all permissions
if is_global_admin(ctx):
return [_perm_to_dict(p) for p in perms]
# Org admins only see permissions their org can grant (by UUID)
grantable = {
pid for pid, p in db.data().permissions.items() if ctx.org.uuid in p.orgs
}
filtered_perms = [p for p in perms if p.uuid in grantable]
return [_perm_to_dict(p) for p in filtered_perms]
@app.post("/permissions") @app.post("/permissions")
+57 -59
View File
@@ -1,6 +1,6 @@
import logging import logging
from contextlib import suppress from contextlib import suppress
from datetime import datetime, timedelta, timezone from datetime import UTC, datetime, timedelta
from fastapi import ( from fastapi import (
Depends, Depends,
@@ -14,13 +14,10 @@ from fastapi.responses import JSONResponse
from fastapi.security import HTTPBearer from fastapi.security import HTTPBearer
from paskia import db from paskia import db
from paskia.authsession import ( from paskia.authsession import EXPIRES, expires, get_reset
EXPIRES,
get_reset,
refresh_session_token,
)
from paskia.fastapi import authz, session, user from paskia.fastapi import authz, session, user
from paskia.fastapi.session import AUTH_COOKIE, AUTH_COOKIE_NAME from paskia.fastapi.response import MsgspecResponse
from paskia.fastapi.session import AUTH_COOKIE, AUTH_COOKIE_NAME, get_client_ip
from paskia.globals import passkey as global_passkey from paskia.globals import passkey as global_passkey
from paskia.util import hostutil, htmlutil, passphrase, userinfo, vitedev from paskia.util import hostutil, htmlutil, passphrase, userinfo, vitedev
@@ -81,7 +78,7 @@ async def validate_token(
try: try:
ctx = await authz.verify( ctx = await authz.verify(
auth, auth,
perm, " ".join(perm).split(),
host=request.headers.get("host"), host=request.headers.get("host"),
max_age=max_age, max_age=max_age,
) )
@@ -90,44 +87,24 @@ async def validate_token(
raise raise
renewed = False renewed = False
if auth: if auth:
consumed = EXPIRES - (ctx.session.expiry - datetime.now(timezone.utc)) consumed = EXPIRES - (ctx.session.expiry - datetime.now(UTC))
if not timedelta(0) < consumed < _REFRESH_INTERVAL: if not timedelta(0) < consumed < _REFRESH_INTERVAL:
try: db.update_session(
refresh_session_token( auth,
auth, ip=get_client_ip(request),
ip=request.client.host if request.client else "", user_agent=request.headers.get("user-agent") or "",
user_agent=request.headers.get("user-agent") or "", expiry=expires(),
) ctx=ctx,
session.set_session_cookie(response, auth) )
renewed = True session.set_session_cookie(response, auth)
except ValueError: renewed = True
# Session disappeared, e.g. due to concurrent logout; global handler will clear return MsgspecResponse(
raise authz.AuthException( {
status_code=401, detail="Session expired", mode="login" "valid": True,
) "renewed": renewed,
return { "ctx": userinfo.build_session_context(ctx),
"valid": True, }
"renewed": renewed, )
"ctx": userinfo.format_session_context(ctx),
}
@app.get("/token-info")
async def token_info(credentials=Depends(bearer_auth)):
"""Get reset/device-add token info. Pass token via Bearer header."""
token = credentials.credentials
if not passphrase.is_well_formed(token):
raise HTTPException(400, "Invalid token format")
try:
reset_token = get_reset(token)
except ValueError as e:
raise HTTPException(401, str(e))
u = db.data().users.get(reset_token.user)
return {
"token_type": reset_token.token_type,
"display_name": u.display_name,
}
@app.get("/forward") @app.get("/forward")
@@ -154,7 +131,10 @@ async def forward_authentication(
""" """
try: try:
ctx = await authz.verify( ctx = await authz.verify(
auth, perm, host=request.headers.get("host"), max_age=max_age auth,
" ".join(perm).split(),
host=request.headers.get("host"),
max_age=max_age,
) )
# Build permission scopes for Remote-Groups header # Build permission scopes for Remote-Groups header
role_permissions = ( role_permissions = (
@@ -170,11 +150,9 @@ async def forward_authentication(
"Remote-Role": str(ctx.role.uuid), "Remote-Role": str(ctx.role.uuid),
"Remote-Role-Name": ctx.role.display_name, "Remote-Role-Name": ctx.role.display_name,
"Remote-Session-Expires": ( "Remote-Session-Expires": (
ctx.session.expiry.astimezone(timezone.utc) ctx.session.expiry.astimezone(UTC).isoformat().replace("+00:00", "Z")
.isoformat()
.replace("+00:00", "Z")
if ctx.session.expiry.tzinfo if ctx.session.expiry.tzinfo
else ctx.session.expiry.replace(tzinfo=timezone.utc) else ctx.session.expiry.replace(tzinfo=UTC)
.isoformat() .isoformat()
.replace("+00:00", "Z") .replace("+00:00", "Z")
), ),
@@ -233,28 +211,48 @@ async def api_user_info(
detail="Authentication required", detail="Authentication required",
mode="login", mode="login",
) )
ctx = db.get_session_context(auth, request.headers.get("host")) ctx = db.data().session_ctx(auth, request.headers.get("host"))
if not ctx: if not ctx:
raise HTTPException(401, "Session expired") raise HTTPException(401, "Session expired")
return await userinfo.format_user_info( return MsgspecResponse(
user_uuid=ctx.user.uuid, await userinfo.build_user_info(
auth=auth, user_uuid=ctx.user.uuid,
session_record=ctx.session, auth=auth,
request_host=request.headers.get("host"), session_record=ctx.session,
request_host=request.headers.get("host"),
)
) )
@app.get("/token-info")
async def token_info(credentials=Depends(bearer_auth)):
"""Get reset/device-add token info. Pass token via Bearer header."""
token = credentials.credentials
if not passphrase.is_well_formed(token):
raise HTTPException(400, "Invalid token format")
try:
reset_token = get_reset(token)
except ValueError as e:
raise HTTPException(401, str(e))
u = reset_token.user
return {
"token_type": reset_token.token_type,
"display_name": u.display_name,
}
@app.post("/logout") @app.post("/logout")
async def api_logout(request: Request, response: Response, auth=AUTH_COOKIE): async def api_logout(request: Request, response: Response, auth=AUTH_COOKIE):
if not auth: if not auth:
return {"message": "Already logged out"} return {"message": "Already logged out"}
host = request.headers.get("host") host = request.headers.get("host")
ctx = db.get_session_context(auth, host) ctx = db.data().session_ctx(auth, host)
if not ctx: if not ctx:
return {"message": "Already logged out"} return {"message": "Already logged out"}
with suppress(Exception): with suppress(Exception):
db.delete_session(auth, ctx=ctx) db.delete_session(auth, ctx=ctx, action="logout")
session.clear_session_cookie(response) session.clear_session_cookie(response)
return {"message": "Logged out successfully"} return {"message": "Logged out successfully"}
@@ -263,7 +261,7 @@ async def api_logout(request: Request, response: Response, auth=AUTH_COOKIE):
async def api_set_session( async def api_set_session(
request: Request, response: Response, auth=Depends(bearer_auth) request: Request, response: Response, auth=Depends(bearer_auth)
): ):
ctx = db.get_session_context(auth.credentials, request.headers.get("host")) ctx = db.data().session_ctx(auth.credentials, request.headers.get("host"))
if not ctx: if not ctx:
raise HTTPException(401, "Session expired") raise HTTPException(401, "Session expired")
session.set_session_cookie(response, auth.credentials) session.set_session_cookie(response, auth.credentials)
+11 -9
View File
@@ -2,6 +2,7 @@ import logging
from fastapi import HTTPException from fastapi import HTTPException
from paskia.fastapi.logging import log_permission_denied
from paskia.util import permutil, sessionutil from paskia.util import permutil, sessionutil
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)
@@ -79,6 +80,9 @@ async def verify(
mode="login", mode="login",
clear_session=True, clear_session=True,
) )
# User's theme preference for iframe (only if explicitly set)
user_theme = ctx.user.theme if ctx.user.theme else None
# Check max_age requirement if specified # Check max_age requirement if specified
if max_age: if max_age:
try: try:
@@ -87,29 +91,27 @@ async def verify(
status_code=401, status_code=401,
detail="Additional authentication required", detail="Additional authentication required",
mode="reauth", mode="reauth",
theme=user_theme,
) )
except ValueError as e: except ValueError as e:
# Invalid max_age format - log but don't fail the request # Invalid max_age format - log but don't fail the request
logger.warning(f"Invalid max_age format '{max_age}': {e}") logger.warning(f"Invalid max_age format '{max_age}': {e}")
if not match(ctx, perm): if not match(ctx, perm):
# Determine which permissions are missing for clearer diagnostics
effective_scopes = ( effective_scopes = (
{p.scope for p in (ctx.permissions or [])} {p.scope for p in (ctx.permissions or [])}
if ctx.permissions if ctx.permissions
else set(ctx.role.permissions or []) else set(ctx.role.permissions or [])
) )
missing = sorted(set(perm) - effective_scopes) missing = sorted(set(perm) - effective_scopes)
logger.warning( log_permission_denied(
"Permission denied: user=%s role=%s missing=%s required=%s granted=%s", # noqa: E501 ctx, perm, missing, require_all=(match == permutil.has_all)
getattr(ctx.user, "uuid", "?"),
getattr(ctx.role, "display_name", "?"),
missing,
perm,
list(effective_scopes),
) )
raise AuthException( raise AuthException(
status_code=403, mode="forbidden", detail="Permission required" status_code=403,
mode="forbidden",
detail="Permission required",
theme=user_theme,
) )
return ctx return ctx
+286
View File
@@ -0,0 +1,286 @@
"""Custom access logging middleware for FastAPI/Uvicorn."""
import logging
import sys
import time
from ipaddress import IPv6Address
from typing import TYPE_CHECKING
from starlette.middleware.base import BaseHTTPMiddleware
if TYPE_CHECKING:
from paskia.db.structs import SessionContext
from starlette.requests import Request
from starlette.responses import Response
logger = logging.getLogger("paskia.access")
_RESET = "\033[0m"
_STATUS_INFO = "\033[32m" # 1xx (green)
_STATUS_OK = "\033[1;92m" # 2xx (bright green)
_STATUS_REDIRECT = "\033[32m" # 3xx (green)
_STATUS_CLIENT_ERR = "\033[0;31m" # 4xx (red)
_STATUS_SERVER_ERR = "\033[1;91m" # 5xx (bold bright red)
_METHOD_READ = "\033[0;34m" # GET, HEAD, OPTIONS (blue)
_METHOD_WRITE = "\033[1;94m" # POST, PUT, DELETE, PATCH (bold bright blue)
_HOST = "\033[38;5;242m" # hostname (dark grey)
_PATH = "\033[38;5;250m" # path (white)
_TIMING = "\033[38;5;242m" # timing/devmode (dark grey)
_WS_OPEN = "\033[1;93m" # WebSocket connect (bold bright yellow)
_WS_CLOSE = "\033[33m" # WebSocket disconnect (yellow)
_WS_STATUS = "\033[38;5;242m" # WebSocket close status (dark grey)
_AUTHZ_DENIED = "\033[0;31m" # Permission denied (red)
_AUTHZ_USER = "\033[1;34m" # User info (light blue)
_AUTHZ_ORG = "\033[34m" # User info (blue)
_AUTHZ_NEEDS = "\033[1;38;5;231m" # Needs (brightest white)
_AUTHZ_MISSING = "\033[1;31m" # Missing scope (bold red)
_AUTHZ_GRANTED = "\033[0;32m" # Granted scope (green)
def format_ipv6_network(ip: str) -> str:
"""Format IPv6 address to show only network part (first 64 bits).
Special addresses are returned as-is for clarity:
- ::1 (loopback)
- :: (unspecified)
- ::ffff:x.x.x.x (IPv4-mapped, returns just the IPv4 part)
- fe80:: (link-local, returned as-is since interface-specific)
"""
try:
# Strip brackets that some proxies add around IPv6
ip = ip.strip("[]")
# Strip zone ID (e.g., fe80::1%eth0)
if "%" in ip:
ip = ip.split("%")[0]
addr = IPv6Address(ip)
# Special cases - return as-is or with minimal processing
if addr.is_loopback: # ::1
return "::1"
if addr.is_unspecified: # ::
return "::"
if addr.ipv4_mapped: # ::ffff:x.x.x.x
return str(addr.ipv4_mapped)
if addr.is_link_local: # fe80::/10 - interface-specific, keep full
return str(addr)
# Regular addresses: truncate to /64 network prefix
network_int = int(addr) >> 64
# Format as IPv6 with trailing ::
# Split into 4 groups of 16 bits
groups = []
for _ in range(4):
groups.insert(0, format(network_int & 0xFFFF, "x"))
network_int >>= 16
# Compress consecutive zero groups
result = ":".join(groups) + "::"
# Simplify leading zeros in groups and compress, then strip trailing ::
return str(IPv6Address(result + "0")).removesuffix("::")
except Exception:
return ip
def format_client_ip(ip: str) -> str:
"""Format client IP, compressing IPv6 to network part only."""
if not ip or ip == "-":
return "-"
# Strip brackets for detection (some proxies add them)
stripped = ip.strip("[]")
if ":" in stripped:
return format_ipv6_network(ip)
return ip
def status_color(status: int) -> str:
"""Return color code based on HTTP status."""
if status < 200:
return _STATUS_INFO
if status < 300:
return _STATUS_OK
if status < 400:
return _STATUS_REDIRECT
if status < 500:
return _STATUS_CLIENT_ERR
return _STATUS_SERVER_ERR
def method_color(method: str) -> str:
"""Return color code based on HTTP method."""
if method in ("GET", "HEAD", "OPTIONS"):
return _METHOD_READ
return _METHOD_WRITE
def format_access_log(
client: str, status: int, method: str, host: str, path: str, duration_ms: float
) -> str:
"""Format access log line with colors and aligned fields."""
use_color = sys.stderr.isatty()
# Format components with fixed widths for alignment
ip = format_client_ip(client).ljust(19) # IPv6 network max 19 chars
timing = f"{duration_ms:.0f}ms"
method_padded = method.ljust(7) # Longest method is OPTIONS (7)
if use_color:
status_str = f"{status_color(status)}{status}{_RESET}"
timing_str = f"{_TIMING}{timing}{_RESET}"
method_str = f"{method_color(method)}{method_padded}{_RESET}"
host_str = f"{_HOST}{host}{_RESET}"
path_str = f"{_PATH}{path}{_RESET}"
else:
status_str = str(status)
timing_str = timing
method_str = method_padded
host_str = host
path_str = path
# Format: "IP STATUS METHOD host path TIMING"
return f"{ip} {status_str} {method_str} {host_str}{path_str} {timing_str}"
# WebSocket connection counter (mod 100)
_ws_counter = 0
def _next_ws_id() -> int:
"""Get next WebSocket connection ID (0-99)."""
global _ws_counter
ws_id = _ws_counter
_ws_counter = (_ws_counter + 1) % 100
return ws_id
def log_ws_open(ws) -> int:
"""Log WebSocket connection open. Returns connection ID for use in close."""
use_color = sys.stderr.isatty()
ws_id = _next_ws_id()
client = ws.client.host if ws.client else "-"
host = ws.headers.get("host", "-")
path = ws.url.path
origin = ws.headers.get("origin")
ip = format_client_ip(client).ljust(19)
id_str = f"{ws_id:02d}".ljust(7) # Align with method field (7 chars)
# Determine if origin should be shown (omit when same as host)
# Origin header includes scheme (e.g., "https://example.com"), compare host part
origin_host = origin.split("://", 1)[-1] if origin else None
show_origin = origin_host and origin_host != host
if use_color:
# 🔌 aligned with status (takes ~2 char width), ID aligned with method
prefix = f"🔌 {_WS_OPEN}{id_str}{_RESET}"
host_str = f"{_HOST}{host}{_RESET}"
path_str = f"{_PATH}{path}{_RESET}"
origin_str = (
f" {_RESET}from {_HOST}{origin_host}{_RESET}" if show_origin else ""
)
else:
prefix = f"WS+ {id_str}"
host_str = host
path_str = path
origin_str = f" from {origin_host}" if show_origin else ""
logger.info(f"{ip} {prefix} {host_str}{path_str}{origin_str}")
return ws_id
# WebSocket close codes to human-readable status
WS_CLOSE_CODES = {
1000: "ok",
1001: "going away",
1002: "protocol error",
1003: "unsupported",
1005: "no status",
1006: "abnormal",
1007: "invalid data",
1008: "policy violation",
1009: "too large",
1010: "extension required",
1011: "server error",
1012: "restarting",
1013: "try again",
1014: "bad gateway",
1015: "tls error",
}
def log_ws_close(ws_id: int, close_code: int | None, duration: float) -> None:
"""Log WebSocket connection close with duration and status."""
use_color = sys.stderr.isatty()
id_str = f"{ws_id:02d}".ljust(7) # Align with method field (7 chars)
timing = f"{duration * 1000:.0f}ms"
# Convert close code to status text
if close_code is None:
status = "closed"
else:
status = WS_CLOSE_CODES.get(close_code, f"code {close_code}")
if use_color:
# 🔌 aligned with status, ID aligned with method
prefix = f"🔌 {_WS_CLOSE}{id_str}{_RESET}"
status_str = f"{_WS_STATUS}{status}{_RESET}"
timing_str = f"{_TIMING}{timing}{_RESET}"
else:
prefix = f"WS- {id_str}"
status_str = status
timing_str = timing
logger.info(f"{' ' * 19} {prefix} {status_str} {timing_str}")
def log_permission_denied(
ctx: "SessionContext", required: list[str], missing: list[str], *, require_all: bool
) -> None:
"""Log permission denied with org, role, user and highlighted missing scopes."""
missing_set = set(missing)
scopes = " ".join(
f"{_AUTHZ_MISSING}{s}{_RESET}"
if s in missing_set
else f"{_AUTHZ_GRANTED}{s}{_RESET}"
for s in required
)
n = "" if len(required) == 1 else " all" if require_all else " any"
logger.warning(
f"{_AUTHZ_DENIED}Permission denied{_RESET} "
f"{_AUTHZ_USER}{ctx.user.display_name}{_RESET} "
f"{_AUTHZ_ORG}({ctx.org.display_name} {ctx.role.display_name}){_RESET} "
f"{_AUTHZ_NEEDS}needs{n}:{_RESET} {scopes}"
)
class AccessLogMiddleware(BaseHTTPMiddleware):
"""Middleware that logs HTTP requests with custom format."""
async def dispatch(self, request: Request, call_next) -> Response:
start = time.perf_counter()
response = await call_next(request)
duration_ms = (time.perf_counter() - start) * 1000
client = request.client.host if request.client else "-"
host = request.headers.get("host", "-")
method = request.method
path = request.url.path
if request.url.query:
path = f"{path}?{request.url.query}"
status = response.status_code
line = format_access_log(client, status, method, host, path, duration_ms)
logger.info(line)
return response
def configure_access_logging():
"""Configure the access logger to output to stderr."""
handler = logging.StreamHandler(sys.stderr)
handler.setFormatter(logging.Formatter("%(message)s"))
logger.addHandler(handler)
logger.setLevel(logging.INFO)
logger.propagate = False
# Suppress watchfiles "X changes detected" INFO messages (keep WARNING for reload notification)
logging.getLogger("watchfiles.main").setLevel(logging.WARNING)
+23 -8
View File
@@ -10,14 +10,24 @@ from fastapi_vue import Frontend
from paskia import globals from paskia import globals
from paskia.db import start_background, stop_background from paskia.db import start_background, stop_background
from paskia.db.logging import configure_db_logging
from paskia.fastapi import admin, api, auth_host, ws from paskia.fastapi import admin, api, auth_host, ws
from paskia.fastapi.__main__ import DEVMODE
from paskia.fastapi.logging import AccessLogMiddleware, configure_access_logging
from paskia.fastapi.session import AUTH_COOKIE from paskia.fastapi.session import AUTH_COOKIE
from paskia.util import hostutil, passphrase, vitedev from paskia.util import hostutil, passphrase, vitedev
# Configure custom logging
configure_access_logging()
configure_db_logging()
_access_logger = logging.getLogger("paskia.access")
# Vue Frontend static files # Vue Frontend static files
frontend = Frontend( frontend = Frontend(
Path(__file__).parent.parent / "frontend-build", Path(__file__).parent.parent / "frontend-build",
cached=["/auth/assets/"], cached=["/auth/assets/"],
favicon="/paskia.webp",
) )
@@ -48,11 +58,11 @@ async def lifespan(app: FastAPI): # pragma: no cover - startup path
# Re-raise to fail fast # Re-raise to fail fast
raise raise
# Restore info level logging after startup (suppressed during uvicorn init in dev mode) # Restore uvicorn info logging (suppressed during startup in dev mode)
if frontend.devmode: # Keep uvicorn.error at WARNING to suppress WebSocket "connection open/closed" messages
if app.debug:
logging.getLogger("uvicorn").setLevel(logging.INFO) logging.getLogger("uvicorn").setLevel(logging.INFO)
logging.getLogger("uvicorn.access").setLevel(logging.INFO) logging.getLogger("uvicorn.error").setLevel(logging.WARNING)
await frontend.load() await frontend.load()
await start_background() await start_background()
yield yield
@@ -65,8 +75,12 @@ app = FastAPI(
docs_url=None, docs_url=None,
redoc_url=None, redoc_url=None,
openapi_url=None, openapi_url=None,
debug=DEVMODE,
) )
# Custom access logging (uvicorn's access_log is disabled)
app.add_middleware(AccessLogMiddleware)
# Apply redirections to auth-host if configured (deny access to restricted endpoints, remove /auth/) # Apply redirections to auth-host if configured (deny access to restricted endpoints, remove /auth/)
app.middleware("http")(auth_host.redirect_middleware) app.middleware("http")(auth_host.redirect_middleware)
@@ -124,6 +138,11 @@ async def examples_page():
return FileResponse(index_file, media_type="text/html") return FileResponse(index_file, media_type="text/html")
# Frontend static files - must be before /{token} catch-all routes
# (actual routes registered during lifespan after frontend.load())
frontend.route(app, "/")
# Note: this catch-all handler must be the last route defined # Note: this catch-all handler must be the last route defined
@app.get("/{token}") @app.get("/{token}")
@app.get("/auth/{token}") @app.get("/auth/{token}")
@@ -136,7 +155,3 @@ async def token_link(token: str):
raise HTTPException(status_code=404) raise HTTPException(status_code=404)
return Response(*await vitedev.read("/int/reset/index.html")) return Response(*await vitedev.read("/int/reset/index.html"))
# Final catch-all route for frontend files (keep at end of file)
frontend.route(app, "/")
+12 -41
View File
@@ -17,10 +17,10 @@ from fastapi import FastAPI, WebSocket, WebSocketDisconnect
from paskia import db, remoteauth from paskia import db, remoteauth
from paskia.authsession import expires from paskia.authsession import expires
from paskia.fastapi.session import infodict from paskia.fastapi.session import AUTH_COOKIE, infodict
from paskia.fastapi.wschat import authenticate_chat from paskia.fastapi.wschat import authenticate_and_login
from paskia.fastapi.wsutil import validate_origin, websocket_error_handler from paskia.fastapi.wsutil import validate_origin, websocket_error_handler
from paskia.util import hostutil, passphrase, pow, useragent from paskia.util import pow, useragent
# Create a FastAPI subapp for remote auth WebSocket endpoints # Create a FastAPI subapp for remote auth WebSocket endpoints
app = FastAPI(docs_url=None, redoc_url=None, openapi_url=None) app = FastAPI(docs_url=None, redoc_url=None, openapi_url=None)
@@ -252,7 +252,7 @@ async def websocket_remote_auth_request(ws: WebSocket):
@app.websocket("/permit") @app.websocket("/permit")
@websocket_error_handler @websocket_error_handler
async def websocket_remote_auth_permit(ws: WebSocket): async def websocket_remote_auth_permit(ws: WebSocket, auth=AUTH_COOKIE):
"""Complete a remote authentication request using a 3-word pairing code. """Complete a remote authentication request using a 3-word pairing code.
This endpoint is called from the user's profile on the authenticating device. This endpoint is called from the user's profile on the authenticating device.
@@ -270,7 +270,7 @@ async def websocket_remote_auth_permit(ws: WebSocket):
7. Server sends {status: "success", message: "..."} 7. Server sends {status: "success", message: "..."}
""" """
origin = validate_origin(ws) validate_origin(ws)
if remoteauth.instance is None: if remoteauth.instance is None:
raise ValueError("Remote authentication is not available") raise ValueError("Remote authentication is not available")
@@ -310,56 +310,27 @@ async def websocket_remote_auth_permit(ws: WebSocket):
# Handle authenticate request (no PoW needed - already validated during lookup) # Handle authenticate request (no PoW needed - already validated during lookup)
if msg.get("authenticate") and request is not None: if msg.get("authenticate") and request is not None:
cred, new_sign_count = await authenticate_chat(ws, origin) ctx = await authenticate_and_login(ws, auth)
# Create a session for the REQUESTING device session_token = ctx.session.key
assert cred.uuid is not None
session_token = None
reset_token = None reset_token = None
if request.action == "register": if request.action == "register":
# For registration, create a reset token for device addition # For registration, create a reset token for device addition
token_str = passphrase.generate()
expiry = expires() expiry = expires()
db.create_reset_token( reset_token = db.create_reset_token(
user_uuid=cred.user, user_uuid=ctx.user.uuid,
passphrase=token_str,
expiry=expiry, expiry=expiry,
token_type="device addition", token_type="device addition",
) user=str(ctx.user.uuid),
reset_token = token_str
# Also create a session so the device is logged in
normalized_host = hostutil.normalize_host(request.host)
session_token = db.login(
user_uuid=cred.user,
credential_uuid=cred.uuid,
sign_count=new_sign_count,
host=normalized_host,
ip=request.ip,
user_agent=request.user_agent,
expiry=expires(),
)
else:
# Default login action
normalized_host = hostutil.normalize_host(request.host)
session_token = db.login(
user_uuid=cred.user,
credential_uuid=cred.uuid,
sign_count=new_sign_count,
host=normalized_host,
ip=request.ip,
user_agent=request.user_agent,
expiry=expires(),
) )
# Complete the remote auth request (notifies the waiting device) # Complete the remote auth request (notifies the waiting device)
cred = db.data().credentials[ctx.session.credential_uuid]
completed = await remoteauth.instance.complete_request( completed = await remoteauth.instance.complete_request(
token=request.key, token=request.key,
session_token=session_token, session_token=session_token,
user_uuid=cred.user, user_uuid=ctx.user.uuid,
credential_uuid=cred.uuid, credential_uuid=cred.uuid,
reset_token=reset_token, reset_token=reset_token,
) )
-110
View File
@@ -1,110 +0,0 @@
"""CLI support for creating user credential reset links.
Usage (via main CLI):
paskia reset [query]
If query is omitted, the master admin (first Administration role user in
an organization granting auth:admin) is targeted. Otherwise query is
matched as either an exact UUID or a case-insensitive substring of the
display name. If multiple users match, they are listed and the command
aborts. A new one-time reset link is always created.
"""
from __future__ import annotations
import asyncio
from uuid import UUID
from paskia import authsession as _authsession
from paskia import db
from paskia.util import hostutil, passphrase
async def _resolve_targets(query: str | None):
if query:
# Try UUID
targets: list[tuple] = []
try:
q_uuid = UUID(query)
p = next(
(p for p in db.data().permissions.values() if p.scope == "auth:admin"),
None,
)
if p:
for org_uuid in p.orgs:
users = db.get_organization_users(org_uuid)
for u, role_name in users:
if u.uuid == q_uuid:
return [(u, role_name)]
# UUID not found among admin orgs -> fall back to substring search (rare case)
except ValueError:
pass
# Substring search
needle = query.lower()
p = next(
(p for p in db.data().permissions.values() if p.scope == "auth:admin"), None
)
if p:
for org_uuid in p.orgs:
users = db.get_organization_users(org_uuid)
for u, role_name in users:
if needle in (u.display_name or "").lower():
targets.append((u, role_name))
# De-duplicate
seen = set()
deduped = []
for u, role_name in targets:
if u.uuid not in seen:
seen.add(u.uuid)
deduped.append((u, role_name))
return deduped
# No query -> master admin
p = next(
(p for p in db.data().permissions.values() if p.scope == "auth:admin"), None
)
if not p or not p.orgs:
return []
first_org_uuid = next(iter(p.orgs))
users = db.get_organization_users(first_org_uuid)
admin_users = [pair for pair in users if pair[1] == "Administration"]
return admin_users[:1]
async def _create_reset(user, role_name: str):
token = passphrase.generate()
expiry = _authsession.reset_expires()
db.create_reset_token(
passphrase=token,
user_uuid=user.uuid,
expiry=expiry,
token_type="manual reset",
)
return hostutil.reset_link_url(token), token
async def _main(query: str | None) -> int:
try:
candidates = await _resolve_targets(query)
if not candidates:
print("No matching users found")
return 1
if len(candidates) > 1:
print("Multiple matches. Refine your query:")
for u, role_name in candidates:
print(f" - {u.display_name} ({u.uuid}) role={role_name}")
return 2
user, role_name = candidates[0]
link, token = await _create_reset(user, role_name)
print(f"Reset link for {user.display_name} ({user.uuid}):\n{link}\n")
return 0
except Exception as e: # pragma: no cover
print("Failed to create reset link:", e)
return 1
def run(query: str | None) -> int:
"""Synchronous wrapper for CLI entrypoint."""
return asyncio.run(_main(query))
__all__ = ["run"]
+22
View File
@@ -0,0 +1,22 @@
"""FastAPI response utilities for msgspec.Struct serialization."""
import msgspec
from fastapi import Response
class MsgspecResponse(Response):
"""Response that uses msgspec for JSON encoding.
Use this for returning msgspec.Struct, dict, or list with proper serialization.
"""
media_type = "application/json"
def __init__(
self,
content: msgspec.Struct | dict | list,
status_code: int = 200,
headers: dict | None = None,
):
body = msgspec.json.encode(content)
super().__init__(content=body, status_code=status_code, headers=headers)
+37 -1
View File
@@ -8,6 +8,8 @@ This module provides FastAPI-specific session management functionality:
Generic session management functions have been moved to authsession.py Generic session management functions have been moved to authsession.py
""" """
from ipaddress import IPv4Address, IPv6Address
from fastapi import Cookie, Request, Response, WebSocket from fastapi import Cookie, Request, Response, WebSocket
from paskia.authsession import EXPIRES from paskia.authsession import EXPIRES
@@ -16,10 +18,44 @@ AUTH_COOKIE_NAME = "__Host-paskia"
AUTH_COOKIE = Cookie(None, alias=AUTH_COOKIE_NAME) AUTH_COOKIE = Cookie(None, alias=AUTH_COOKIE_NAME)
def normalize_ip(ip: str) -> str:
"""Normalize IP address, stripping brackets and validating format.
Proxies may pass IPv6 in brackets like [::1] or with zone IDs.
IPv4-mapped IPv6 addresses (::ffff:x.x.x.x) are converted to plain IPv4.
Returns empty string for invalid addresses.
"""
if not ip:
return ""
# Strip brackets that some proxies add around IPv6
ip = ip.strip("[]")
# Strip zone ID (e.g., fe80::1%eth0)
if "%" in ip:
ip = ip.split("%")[0]
try:
# Validate and normalize
if ":" in ip:
addr = IPv6Address(ip)
# Convert IPv4-mapped addresses to plain IPv4
if addr.ipv4_mapped:
return str(addr.ipv4_mapped)
return str(addr)
return str(IPv4Address(ip))
except ValueError:
return ip # Return as-is if not a valid IP (could be hostname)
def get_client_ip(request: Request | WebSocket) -> str:
"""Get client IP from request, normalized."""
if not request.client:
return ""
return normalize_ip(request.client.host)
def infodict(request: Request | WebSocket, type: str) -> dict: def infodict(request: Request | WebSocket, type: str) -> dict:
"""Extract client information from request.""" """Extract client information from request."""
return { return {
"ip": request.client.host if request.client else "", "ip": get_client_ip(request),
"user_agent": request.headers.get("user-agent", "")[:500], "user_agent": request.headers.get("user-agent", "")[:500],
"session_type": type, "session_type": type,
} }
+32 -11
View File
@@ -1,4 +1,4 @@
from datetime import timezone from datetime import UTC
from uuid import UUID from uuid import UUID
from fastapi import ( from fastapi import (
@@ -17,7 +17,7 @@ from paskia.authsession import (
) )
from paskia.fastapi import authz, session from paskia.fastapi import authz, session
from paskia.fastapi.session import AUTH_COOKIE from paskia.fastapi.session import AUTH_COOKIE
from paskia.util import hostutil, passphrase from paskia.util import hostutil
app = FastAPI(docs_url=None, redoc_url=None, openapi_url=None) app = FastAPI(docs_url=None, redoc_url=None, openapi_url=None)
@@ -43,7 +43,7 @@ async def user_update_display_name(
status_code=401, detail="Authentication Required", mode="login" status_code=401, detail="Authentication Required", mode="login"
) )
host = request.headers.get("host") host = request.headers.get("host")
ctx = db.get_session_context(auth, host) ctx = db.data().session_ctx(auth, host)
if not ctx: if not ctx:
raise authz.AuthException( raise authz.AuthException(
status_code=401, detail="Session expired", mode="login" status_code=401, detail="Session expired", mode="login"
@@ -57,12 +57,34 @@ async def user_update_display_name(
return {"status": "ok"} return {"status": "ok"}
@app.patch("/theme")
async def user_update_theme(
request: Request,
payload: dict = Body(...),
auth=AUTH_COOKIE,
):
if not auth:
raise authz.AuthException(
status_code=401, detail="Authentication Required", mode="login"
)
ctx = db.data().session_ctx(auth, request.headers.get("host"))
if not ctx:
raise authz.AuthException(
status_code=401, detail="Session expired", mode="login"
)
theme = payload.get("theme", "")
if theme not in ("", "light", "dark"):
raise HTTPException(status_code=400, detail="Invalid theme")
db.update_user_theme(ctx.user.uuid, theme, ctx=ctx)
return {"status": "ok"}
@app.post("/logout-all") @app.post("/logout-all")
async def api_logout_all(request: Request, response: Response, auth=AUTH_COOKIE): async def api_logout_all(request: Request, response: Response, auth=AUTH_COOKIE):
if not auth: if not auth:
return {"message": "Already logged out"} return {"message": "Already logged out"}
host = request.headers.get("host") host = request.headers.get("host")
ctx = db.get_session_context(auth, host) ctx = db.data().session_ctx(auth, host)
if not ctx: if not ctx:
raise authz.AuthException( raise authz.AuthException(
status_code=401, detail="Session expired", mode="login" status_code=401, detail="Session expired", mode="login"
@@ -84,14 +106,14 @@ async def api_delete_session(
status_code=401, detail="Authentication Required", mode="login" status_code=401, detail="Authentication Required", mode="login"
) )
host = request.headers.get("host") host = request.headers.get("host")
ctx = db.get_session_context(auth, host) ctx = db.data().session_ctx(auth, host)
if not ctx: if not ctx:
raise authz.AuthException( raise authz.AuthException(
status_code=401, detail="Session expired", mode="login" status_code=401, detail="Session expired", mode="login"
) )
target_session = db.data().sessions.get(session_id) target_session = db.data().sessions.get(session_id)
if not target_session or target_session.user != ctx.user.uuid: if not target_session or target_session.user_uuid != ctx.user.uuid:
raise HTTPException(status_code=404, detail="Session not found") raise HTTPException(status_code=404, detail="Session not found")
db.delete_session(session_id, ctx=ctx) db.delete_session(session_id, ctx=ctx)
@@ -127,11 +149,9 @@ async def api_create_link(
): ):
# Require recent authentication for sensitive operation # Require recent authentication for sensitive operation
ctx = await authz.verify(auth, [], host=request.headers.get("host"), max_age="5m") ctx = await authz.verify(auth, [], host=request.headers.get("host"), max_age="5m")
token = passphrase.generate()
expiry = expires() expiry = expires()
db.create_reset_token( token = db.create_reset_token(
user_uuid=ctx.user.uuid, user_uuid=ctx.user.uuid,
passphrase=token,
expiry=expiry, expiry=expiry,
token_type="device addition", token_type="device addition",
ctx=ctx, ctx=ctx,
@@ -141,8 +161,9 @@ async def api_create_link(
"message": "Registration link generated successfully", "message": "Registration link generated successfully",
"url": url, "url": url,
"expires": ( "expires": (
expiry.astimezone(timezone.utc).isoformat().replace("+00:00", "Z") expiry.astimezone(UTC).isoformat().replace("+00:00", "Z")
if expiry.tzinfo if expiry.tzinfo
else expiry.replace(tzinfo=timezone.utc).isoformat().replace("+00:00", "Z") else expiry.replace(tzinfo=UTC).isoformat().replace("+00:00", "Z")
), ),
"token_type": "device addition",
} }
+14 -37
View File
@@ -1,10 +1,10 @@
from fastapi import FastAPI, WebSocket from fastapi import FastAPI, WebSocket
from paskia import db from paskia import db
from paskia.authsession import expires, get_reset from paskia.authsession import get_reset
from paskia.fastapi import authz, remote from paskia.fastapi import authz, remote
from paskia.fastapi.session import AUTH_COOKIE, infodict from paskia.fastapi.session import AUTH_COOKIE, infodict
from paskia.fastapi.wschat import authenticate_chat, register_chat from paskia.fastapi.wschat import authenticate_and_login, register_chat
from paskia.fastapi.wsutil import validate_origin, websocket_error_handler from paskia.fastapi.wsutil import validate_origin, websocket_error_handler
from paskia.globals import passkey from paskia.globals import passkey
from paskia.util import hostutil, passphrase from paskia.util import hostutil, passphrase
@@ -31,22 +31,22 @@ async def websocket_register_add(
- Reset token supplied as ?reset=... (auth cookie ignored) - Reset token supplied as ?reset=... (auth cookie ignored)
""" """
origin = validate_origin(ws) origin = validate_origin(ws)
host = origin.split("://", 1)[1] host = hostutil.normalize_host(origin.split("://", 1)[1])
if reset is not None: if reset is not None:
if not passphrase.is_well_formed(reset): if not passphrase.is_well_formed(reset):
raise ValueError( raise ValueError(
f"The reset link for {passkey.instance.rp_name} is invalid or has expired" f"The reset link for {passkey.instance.rp_name} is invalid or has expired"
) )
s = get_reset(reset) s = get_reset(reset)
user_uuid = s.user user_uuid = s.user_uuid
else: else:
# Require recent authentication for adding a new passkey # Require recent authentication for adding a new passkey
ctx = await authz.verify(auth, perm=[], host=host, max_age="5m") ctx = await authz.verify(auth, perm=[], host=host, max_age="5m")
user_uuid = ctx.session.user user_uuid = ctx.session.user_uuid
s = ctx.session s = ctx.session
# Get user information and determine effective user_name for this registration # Get user information and determine effective user_name for this registration
user = db.data().users.get(user_uuid) user = db.data().users[user_uuid]
user_name = user.display_name user_name = user.display_name
if name is not None: if name is not None:
stripped = name.strip() stripped = name.strip()
@@ -59,7 +59,7 @@ async def websocket_register_add(
# Create a new session and store everything in database # Create a new session and store everything in database
metadata = infodict(ws, "authenticated") metadata = infodict(ws, "authenticated")
token = db.create_credential_session( # type: ignore[attr-defined] token = db.create_credential_session(
user_uuid=user_uuid, user_uuid=user_uuid,
credential=credential, credential=credential,
reset_key=(s.key if reset is not None else None), reset_key=(s.key if reset is not None else None),
@@ -89,43 +89,20 @@ async def websocket_authenticate(ws: WebSocket, auth=AUTH_COOKIE):
# If there's an existing session, restrict to that user's credentials (reauth) # If there's an existing session, restrict to that user's credentials (reauth)
session_user_uuid = None session_user_uuid = None
credential_ids = None
if auth: if auth:
ctx = db.get_session_context(auth, host) existing_ctx = db.data().session_ctx(auth, host)
if ctx: if existing_ctx:
session_user_uuid = ctx.user.uuid session_user_uuid = existing_ctx.user.uuid
credential_ids = db.get_user_credential_ids(session_user_uuid) or None
cred, new_sign_count = await authenticate_chat(ws, origin, credential_ids) ctx = await authenticate_and_login(ws, auth)
# If reauth mode, verify the credential belongs to the session's user # If reauth mode, verify the credential belongs to the session's user
if session_user_uuid and cred.user != session_user_uuid: if session_user_uuid and ctx.user.uuid != session_user_uuid:
raise ValueError("This passkey belongs to a different account") raise ValueError("This passkey belongs to a different account")
# Create session and update user/credential in a single transaction
assert cred.uuid is not None
metadata = infodict(ws, "auth")
normalized_host = hostutil.normalize_host(host)
if not normalized_host:
raise ValueError("Host required for session creation")
hostname = normalized_host.split(":")[0]
rp_id = passkey.instance.rp_id
if not (hostname == rp_id or hostname.endswith(f".{rp_id}")):
raise ValueError(f"Host must be the same as or a subdomain of {rp_id}")
token = db.login(
user_uuid=cred.user,
credential_uuid=cred.uuid,
sign_count=new_sign_count,
host=normalized_host,
ip=metadata["ip"],
user_agent=metadata["user_agent"],
expiry=expires(),
)
await ws.send_json( await ws.send_json(
{ {
"user": str(cred.user), "user": str(ctx.user.uuid),
"session_token": token, "session_token": ctx.session.key,
} }
) )
+55 -2
View File
@@ -7,8 +7,12 @@ from uuid import UUID
from fastapi import WebSocket from fastapi import WebSocket
from paskia import db from paskia import db
from paskia.db import Credential from paskia.authsession import expires
from paskia.db import Credential, SessionContext
from paskia.fastapi.session import infodict
from paskia.fastapi.wsutil import validate_origin
from paskia.globals import passkey from paskia.globals import passkey
from paskia.util import hostutil
async def register_chat( async def register_chat(
@@ -31,7 +35,6 @@ async def register_chat(
async def authenticate_chat( async def authenticate_chat(
ws: WebSocket, ws: WebSocket,
origin: str,
credential_ids: list[bytes] | None = None, credential_ids: list[bytes] | None = None,
) -> tuple[Credential, int]: ) -> tuple[Credential, int]:
"""Run WebAuthn authentication flow and return the credential and new sign count. """Run WebAuthn authentication flow and return the credential and new sign count.
@@ -39,6 +42,7 @@ async def authenticate_chat(
Returns: Returns:
tuple of (credential, new_sign_count) where new_sign_count comes from WebAuthn verification tuple of (credential, new_sign_count) where new_sign_count comes from WebAuthn verification
""" """
origin = validate_origin(ws)
options, challenge = passkey.instance.auth_generate_options( options, challenge = passkey.instance.auth_generate_options(
credential_ids=credential_ids credential_ids=credential_ids
) )
@@ -60,3 +64,52 @@ async def authenticate_chat(
verification = passkey.instance.auth_verify(authcred, challenge, cred, origin) verification = passkey.instance.auth_verify(authcred, challenge, cred, origin)
return cred, verification.new_sign_count return cred, verification.new_sign_count
async def authenticate_and_login(
ws: WebSocket,
auth: str | None = None,
) -> SessionContext:
"""Run WebAuthn authentication flow, create session, and return the session context.
If auth is provided, restrict authentication to credentials of that session's user.
Returns:
SessionContext for the authenticated session
"""
origin = validate_origin(ws)
host = origin.split("://", 1)[1]
normalized_host = hostutil.normalize_host(host)
if not normalized_host:
raise ValueError("Host required for session creation")
hostname = normalized_host.split(":")[0]
rp_id = passkey.instance.rp_id
if not (hostname == rp_id or hostname.endswith(f".{rp_id}")):
raise ValueError(f"Host must be the same as or a subdomain of {rp_id}")
metadata = infodict(ws, "auth")
# Get credential IDs if restricting to a user's credentials
credential_ids = None
if auth:
existing_ctx = db.data().session_ctx(auth, host)
if existing_ctx:
credential_ids = db.get_user_credential_ids(existing_ctx.user.uuid) or None
cred, new_sign_count = await authenticate_chat(ws, credential_ids)
# Create session and update user/credential
token = db.login(
user_uuid=cred.user_uuid,
credential_uuid=cred.uuid,
sign_count=new_sign_count,
host=normalized_host,
ip=metadata["ip"],
user_agent=metadata["user_agent"],
expiry=expires(),
)
# Fetch and return the full session context
ctx = db.data().session_ctx(token, normalized_host)
if not ctx:
raise ValueError("Failed to create session context")
return ctx
+10 -2
View File
@@ -3,6 +3,7 @@ Shared WebSocket utilities for FastAPI endpoints.
""" """
import logging import logging
import time
from functools import wraps from functools import wraps
import base64url import base64url
@@ -10,6 +11,7 @@ from fastapi import WebSocket, WebSocketDisconnect
from webauthn.helpers.exceptions import InvalidAuthenticationResponse from webauthn.helpers.exceptions import InvalidAuthenticationResponse
from paskia.fastapi import authz from paskia.fastapi import authz
from paskia.fastapi.logging import log_ws_close, log_ws_open
from paskia.globals import passkey from paskia.globals import passkey
from paskia.util import pow from paskia.util import pow
@@ -19,11 +21,15 @@ def websocket_error_handler(func):
@wraps(func) @wraps(func)
async def wrapper(ws: WebSocket, *args, **kwargs): async def wrapper(ws: WebSocket, *args, **kwargs):
start = time.perf_counter()
ws_id = log_ws_open(ws)
close_code = None
try: try:
await ws.accept() await ws.accept()
return await func(ws, *args, **kwargs) return await func(ws, *args, **kwargs)
except WebSocketDisconnect: except WebSocketDisconnect as e:
pass close_code = e.code
except authz.AuthException as e: except authz.AuthException as e:
await ws.send_json( await ws.send_json(
{ {
@@ -36,6 +42,8 @@ def websocket_error_handler(func):
except Exception: except Exception:
logging.exception("Internal Server Error") logging.exception("Internal Server Error")
await ws.send_json({"status": 500, "detail": "Internal Server Error"}) await ws.send_json({"status": 500, "detail": "Internal Server Error"})
finally:
log_ws_close(ws_id, close_code, time.perf_counter() - start)
return wrapper return wrapper
+2 -2
View File
@@ -42,7 +42,7 @@ async def init(
Database configuration: Database configuration:
Set PASKIA_DB environment variable to specify the JSONL database file path. Set PASKIA_DB environment variable to specify the JSONL database file path.
Default: paskia.jsonl Default: {rp_id}.paskiadb
""" """
# Initialize passkey instance with provided parameters # Initialize passkey instance with provided parameters
@@ -53,7 +53,7 @@ async def init(
) )
# Initialize database # Initialize database
await db.init() await db.init(rp_id=rp_id)
# Initialize remote auth manager # Initialize remote auth manager
await remoteauth.init() await remoteauth.init()
-281
View File
@@ -1,281 +0,0 @@
"""
SQL to JSON migration module for Paskia.
This module contains the legacy SQL database implementation and migration tools
for converting from the old SQLite database to the new JSONL format.
Usage:
python -m paskia.migrate --sql sqlite+aiosqlite:///paskia.sqlite --json paskia.jsonl
Or via the CLI entry point (if installed):
paskia-migrate --sql sqlite+aiosqlite:///paskia.sqlite --json paskia.jsonl
"""
import argparse
import asyncio
import re
from datetime import datetime, timezone
from uuid import UUID
import base64url
import uuid7
from sqlalchemy import select
from paskia.authsession import EXPIRES
from paskia.db.jsonl import JsonlStore
from paskia.db.structs import (
DB,
Credential,
Org,
Permission,
ResetToken,
Role,
Session,
User,
)
from .sql import (
DB as SQLDB,
)
from .sql import (
CredentialModel,
ResetTokenModel,
SessionModel,
UserModel,
)
# Re-export for convenience
__all__ = ["migrate_from_sql", "main", "SQLDB"]
# Default paths
SQL_DB_DEFAULT = "sqlite+aiosqlite:///paskia.sqlite"
JSON_DB_DEFAULT = "paskia.jsonl"
async def migrate_from_sql(
sql_db_path: str = SQL_DB_DEFAULT,
json_db_path: str = JSON_DB_DEFAULT,
) -> None:
"""Migrate data from SQL database to JSON format.
Args:
sql_db_path: SQLAlchemy connection string for the source SQL database
json_db_path: Path for the destination JSONL file
"""
# Initialize source SQL database
sql_db = SQLDB(sql_db_path)
await sql_db.init_db()
# Initialize destination JSON database (fresh, don't load existing)
db = DB()
store = JsonlStore(db, json_db_path)
db._store = store
print(f"Migrating from {sql_db_path} to {json_db_path}...")
# Build all data directly without saving (we'll save once at the end)
# Track old permission ID -> new scope mapping for migration
# Also track org-specific admin permissions to consolidate
old_org_admin_pattern = re.compile(r"^auth:org:([0-9a-f-]+)$", re.IGNORECASE)
org_admin_uuids = set() # org UUIDs that had org-specific admin permissions
# First pass: identify org-specific admin permissions
permissions = await sql_db.list_permissions()
for perm in permissions:
match = old_org_admin_pattern.match(perm.id)
if match:
org_admin_uuids.add(match.group(1).lower())
# Migrate permissions with UUID keys and scope field
# Always create exactly one common auth:org:admin permission for all org admin needs
org_admin_perm_uuid: UUID = uuid7.create()
org_admin_perm = Permission(
scope="auth:org:admin",
display_name="Org Admin",
orgs={},
)
org_admin_perm.uuid = org_admin_perm_uuid
db.permissions[org_admin_perm_uuid] = org_admin_perm
# Mapping from old permission ID to new permission UUID
perm_id_to_uuid: dict[str, UUID] = {}
for perm in permissions:
# Skip old org-specific admin permissions (auth:org:{uuid}) - they map to auth:org:admin
match = old_org_admin_pattern.match(perm.id)
if match:
perm_id_to_uuid[perm.id] = org_admin_perm_uuid
continue
# Skip if this is already auth:org:admin - we created one above
if perm.id == "auth:org:admin":
perm_id_to_uuid[perm.id] = org_admin_perm_uuid
continue
# Regular permission - create with UUID key
perm_uuid: UUID = uuid7.create()
new_perm = Permission(
scope=perm.id, # Old ID becomes the scope
display_name=perm.display_name,
orgs={},
)
new_perm.uuid = perm_uuid
db.permissions[perm_uuid] = new_perm
perm_id_to_uuid[perm.id] = perm_uuid
print(
f" Migrated {len(permissions)} permissions (with {len(org_admin_uuids)} org-specific admins consolidated to auth:org:admin)"
)
# Migrate organizations
orgs = await sql_db.list_organizations()
for org in orgs:
org_key: UUID = org.uuid
new_org = Org(display_name=org.display_name)
new_org.uuid = org_key
db.orgs[org_key] = new_org
# Update permissions to allow this org to grant them (by UUID)
for old_perm_id in org.permissions:
perm_uuid = perm_id_to_uuid.get(old_perm_id)
if perm_uuid and perm_uuid in db.permissions:
db.permissions[perm_uuid].orgs[org_key] = True
# Ensure every org can grant auth:org:admin
db.permissions[org_admin_perm_uuid].orgs[org_key] = True
print(f" Migrated {len(orgs)} organizations")
# Migrate roles - convert old permission IDs to UUIDs
role_count = 0
for org in orgs:
for role in org.roles:
role_key: UUID = role.uuid
# Convert old permission IDs to UUIDs
new_permissions: dict[UUID, bool] = {}
for old_perm_id in role.permissions or []:
perm_uuid = perm_id_to_uuid.get(old_perm_id)
if perm_uuid:
new_permissions[perm_uuid] = True
new_role = Role(
org=role.org_uuid,
display_name=role.display_name,
permissions=new_permissions,
)
new_role.uuid = role_key
db.roles[role_key] = new_role
role_count += 1
print(f" Migrated {role_count} roles")
# Migrate users
async with sql_db.session() as session:
result = await session.execute(select(UserModel))
user_models = result.scalars().all()
for um in user_models:
legacy_user = um.as_dataclass()
user_key: UUID = legacy_user.uuid
new_user = User(
display_name=legacy_user.display_name,
role=legacy_user.role_uuid,
created_at=legacy_user.created_at or datetime.now(timezone.utc),
last_seen=legacy_user.last_seen,
visits=legacy_user.visits,
)
new_user.uuid = user_key
db.users[user_key] = new_user
print(f" Migrated {len(user_models)} users")
# Migrate credentials
async with sql_db.session() as session:
result = await session.execute(select(CredentialModel))
cred_models = result.scalars().all()
for cm in cred_models:
legacy_cred = cm.as_dataclass()
cred_key: UUID = legacy_cred.uuid
new_cred = Credential(
credential_id=legacy_cred.credential_id,
user=legacy_cred.user_uuid,
aaguid=legacy_cred.aaguid,
public_key=legacy_cred.public_key,
sign_count=legacy_cred.sign_count,
created_at=legacy_cred.created_at,
last_used=legacy_cred.last_used,
last_verified=legacy_cred.last_verified,
)
new_cred.uuid = cred_key
db.credentials[cred_key] = new_cred
print(f" Migrated {len(cred_models)} credentials")
# Migrate sessions
# Old format: b"sess" + 12 bytes -> New format: base64url string (16 chars)
async with sql_db.session() as session:
result = await session.execute(select(SessionModel))
session_models = result.scalars().all()
for sm in session_models:
sess = sm.as_dataclass()
old_key: bytes = sess.key
# Strip b"sess" prefix and encode remaining 12 bytes as base64url
if old_key.startswith(b"sess"):
session_key = base64url.enc(old_key[4:])
else:
# Already in new format or unknown - try to use as-is
session_key = base64url.enc(old_key[:12])
db.sessions[session_key] = Session(
user=sess.user_uuid,
credential=sess.credential_uuid,
host=sess.host,
ip=sess.ip,
user_agent=sess.user_agent,
expiry=sess.renewed + EXPIRES, # Convert renewed to expiry
)
print(f" Migrated {len(session_models)} sessions")
# Migrate reset tokens
# Old format: b"rset" + 16 bytes hash -> New format: 9 bytes (truncated hash)
async with sql_db.session() as session:
result = await session.execute(select(ResetTokenModel))
token_models = result.scalars().all()
for tm in token_models:
token = tm.as_dataclass()
old_key: bytes = token.key
# Strip b"rset" prefix and take first 9 bytes of hash
if old_key.startswith(b"rset"):
token_key = old_key[4:13] # 9 bytes after prefix
else:
# Already in new format or unknown - truncate to 9 bytes
token_key = old_key[:9]
db.reset_tokens[token_key] = ResetToken(
user=token.user_uuid,
expiry=token.expiry,
token_type=token.token_type,
)
print(f" Migrated {len(token_models)} reset tokens")
# Queue and flush all changes using the transaction mechanism
with db.transaction("migrate"):
pass # All data already added to _data, transaction commits on exit
await store.flush()
print("Migration complete!")
def main():
"""CLI entry point for migration."""
parser = argparse.ArgumentParser(
description="Migrate Paskia database from SQL to JSON"
)
parser.add_argument(
"--sql",
default=SQL_DB_DEFAULT,
help=f"Source SQL database connection string (default: {SQL_DB_DEFAULT})",
)
parser.add_argument(
"--json",
default=JSON_DB_DEFAULT,
help=f"Destination JSONL file path (default: {JSON_DB_DEFAULT})",
)
args = parser.parse_args()
asyncio.run(migrate_from_sql(args.sql, args.json))
if __name__ == "__main__":
main()
-431
View File
@@ -1,431 +0,0 @@
"""
Legacy SQL database implementation for migration purposes.
This module provides the async SQLAlchemy database layer that was used
before the JSONL format. It is kept here for migration purposes only.
DO NOT use this module for new code. Use paskia.db instead.
"""
from contextlib import asynccontextmanager
from dataclasses import dataclass
from datetime import datetime, timezone
from uuid import UUID
from sqlalchemy import (
DateTime,
ForeignKey,
Integer,
LargeBinary,
String,
event,
select,
)
from sqlalchemy.dialects.sqlite import BLOB
from sqlalchemy.ext.asyncio import async_sessionmaker, create_async_engine
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
from paskia.db import (
Org,
Role,
)
# Legacy User class for SQL schema (uses 'role_uuid' not 'role')
@dataclass
class _LegacyUser:
"""User as stored in the old SQL schema with role_uuid field."""
uuid: UUID
display_name: str
role_uuid: UUID
created_at: datetime | None = None
last_seen: datetime | None = None
visits: int = 0
# Legacy Credential class for SQL schema (uses 'user_uuid' not 'user')
@dataclass
class _LegacyCredential:
"""Credential as stored in the old SQL schema with user_uuid field."""
uuid: UUID
credential_id: bytes
user_uuid: UUID
aaguid: UUID
public_key: bytes
sign_count: int
created_at: datetime
last_used: datetime | None = None
last_verified: datetime | None = None
# Legacy Role class for SQL schema (uses 'org_uuid' not 'org')
@dataclass
class _LegacyRole:
"""Role as stored in the old SQL schema with org_uuid field."""
uuid: UUID
org_uuid: UUID
display_name: str
permissions: list[str] | None = None
# Legacy Session class for SQL schema (uses 'key' as field, 'user_uuid', 'credential_uuid')
@dataclass
class _LegacySession:
"""Session as stored in the old SQL schema."""
key: bytes
user_uuid: UUID
credential_uuid: UUID
host: str
ip: str
user_agent: str
renewed: datetime
# Legacy ResetToken class for SQL schema (uses 'key' as field, 'user_uuid')
@dataclass
class _LegacyResetToken:
"""ResetToken as stored in the old SQL schema."""
key: bytes
user_uuid: UUID
token_type: str
expiry: datetime
# Local Permission class for SQL schema (uses 'id' not 'uuid' + 'scope')
@dataclass
class SqlPermission:
"""Permission as stored in the old SQL schema with id field."""
id: str
display_name: str
DB_PATH_DEFAULT = "sqlite+aiosqlite:///paskia.sqlite"
def _normalize_dt(value: datetime | None) -> datetime | None:
if value is None:
return None
if value.tzinfo is None:
return value.replace(tzinfo=timezone.utc)
return value.astimezone(timezone.utc)
class Base(DeclarativeBase):
pass
class OrgModel(Base):
__tablename__ = "orgs"
uuid: Mapped[bytes] = mapped_column(LargeBinary(16), primary_key=True)
display_name: Mapped[str] = mapped_column(String, nullable=False)
def as_dataclass(self):
# Base Org without permissions/roles (filled by data accessors)
org = Org(display_name=self.display_name)
org.uuid = UUID(bytes=self.uuid)
return org
@staticmethod
def from_dataclass(org: Org):
return OrgModel(uuid=org.uuid.bytes, display_name=org.display_name)
class RoleModel(Base):
__tablename__ = "roles"
uuid: Mapped[bytes] = mapped_column(LargeBinary(16), primary_key=True)
org_uuid: Mapped[bytes] = mapped_column(
LargeBinary(16), ForeignKey("orgs.uuid", ondelete="CASCADE"), nullable=False
)
display_name: Mapped[str] = mapped_column(String, nullable=False)
def as_dataclass(self):
# Base Role without permissions (filled by data accessors)
return _LegacyRole(
uuid=UUID(bytes=self.uuid),
org_uuid=UUID(bytes=self.org_uuid),
display_name=self.display_name,
)
@staticmethod
def from_dataclass(role: _LegacyRole):
return RoleModel(
uuid=role.uuid.bytes,
org_uuid=role.org_uuid.bytes,
display_name=role.display_name,
)
class UserModel(Base):
__tablename__ = "users"
uuid: Mapped[bytes] = mapped_column(LargeBinary(16), primary_key=True)
display_name: Mapped[str] = mapped_column(String, nullable=False)
role_uuid: Mapped[bytes] = mapped_column(
LargeBinary(16), ForeignKey("roles.uuid", ondelete="CASCADE"), nullable=False
)
created_at: Mapped[datetime] = mapped_column(
DateTime(timezone=True), default=lambda: datetime.now(timezone.utc)
)
last_seen: Mapped[datetime | None] = mapped_column(
DateTime(timezone=True), nullable=True
)
visits: Mapped[int] = mapped_column(Integer, nullable=False, default=0)
def as_dataclass(self) -> "_LegacyUser":
return _LegacyUser(
uuid=UUID(bytes=self.uuid),
display_name=self.display_name,
role_uuid=UUID(bytes=self.role_uuid),
created_at=_normalize_dt(self.created_at) or self.created_at,
last_seen=_normalize_dt(self.last_seen) or self.last_seen,
visits=self.visits,
)
@staticmethod
def from_dataclass(user: "_LegacyUser"):
return UserModel(
uuid=user.uuid.bytes,
display_name=user.display_name,
role_uuid=user.role_uuid.bytes,
created_at=user.created_at or datetime.now(timezone.utc),
last_seen=user.last_seen,
visits=user.visits,
)
class CredentialModel(Base):
__tablename__ = "credentials"
uuid: Mapped[bytes] = mapped_column(LargeBinary(16), primary_key=True)
credential_id: Mapped[bytes] = mapped_column(
LargeBinary(64), unique=True, index=True
)
user_uuid: Mapped[bytes] = mapped_column(
LargeBinary(16), ForeignKey("users.uuid", ondelete="CASCADE")
)
aaguid: Mapped[bytes] = mapped_column(LargeBinary(16), nullable=False)
public_key: Mapped[bytes] = mapped_column(BLOB, nullable=False)
sign_count: Mapped[int] = mapped_column(Integer, nullable=False)
created_at: Mapped[datetime] = mapped_column(
DateTime(timezone=True), default=lambda: datetime.now(timezone.utc)
)
last_used: Mapped[datetime | None] = mapped_column(
DateTime(timezone=True), nullable=True
)
last_verified: Mapped[datetime | None] = mapped_column(
DateTime(timezone=True), nullable=True
)
def as_dataclass(self):
return _LegacyCredential(
uuid=UUID(bytes=self.uuid),
credential_id=self.credential_id,
user_uuid=UUID(bytes=self.user_uuid),
aaguid=UUID(bytes=self.aaguid),
public_key=self.public_key,
sign_count=self.sign_count,
created_at=_normalize_dt(self.created_at) or self.created_at,
last_used=_normalize_dt(self.last_used) or self.last_used,
last_verified=_normalize_dt(self.last_verified) or self.last_verified,
)
class SessionModel(Base):
__tablename__ = "sessions"
key: Mapped[bytes] = mapped_column(LargeBinary(16), primary_key=True)
user_uuid: Mapped[bytes] = mapped_column(
LargeBinary(16), ForeignKey("users.uuid", ondelete="CASCADE"), nullable=False
)
credential_uuid: Mapped[bytes] = mapped_column(
LargeBinary(16),
ForeignKey("credentials.uuid", ondelete="CASCADE"),
nullable=False,
)
host: Mapped[str] = mapped_column(String, nullable=False)
ip: Mapped[str] = mapped_column(String(64), nullable=False)
user_agent: Mapped[str] = mapped_column(String(512), nullable=False)
renewed: Mapped[datetime] = mapped_column(
DateTime(timezone=True),
default=lambda: datetime.now(timezone.utc),
nullable=False,
)
def as_dataclass(self):
return _LegacySession(
key=self.key,
user_uuid=UUID(bytes=self.user_uuid),
credential_uuid=UUID(bytes=self.credential_uuid),
host=self.host,
ip=self.ip,
user_agent=self.user_agent,
renewed=_normalize_dt(self.renewed) or self.renewed,
)
@staticmethod
def from_dataclass(session: _LegacySession):
return SessionModel(
key=session.key,
user_uuid=session.user_uuid.bytes,
credential_uuid=session.credential_uuid.bytes,
host=session.host,
ip=session.ip,
user_agent=session.user_agent,
renewed=session.renewed,
)
class ResetTokenModel(Base):
__tablename__ = "reset_tokens"
key: Mapped[bytes] = mapped_column(LargeBinary(16), primary_key=True)
user_uuid: Mapped[bytes] = mapped_column(
LargeBinary(16), ForeignKey("users.uuid", ondelete="CASCADE"), nullable=False
)
token_type: Mapped[str] = mapped_column(String, nullable=False)
expiry: Mapped[datetime] = mapped_column(DateTime(timezone=True), nullable=False)
def as_dataclass(self) -> _LegacyResetToken:
return _LegacyResetToken(
key=self.key,
user_uuid=UUID(bytes=self.user_uuid),
token_type=self.token_type,
expiry=_normalize_dt(self.expiry) or self.expiry,
)
class PermissionModel(Base):
__tablename__ = "permissions"
id: Mapped[str] = mapped_column(String(64), primary_key=True)
display_name: Mapped[str] = mapped_column(String, nullable=False)
def as_dataclass(self):
return SqlPermission(self.id, self.display_name)
@staticmethod
def from_dataclass(permission: SqlPermission):
return PermissionModel(
id=permission.id,
display_name=permission.display_name,
)
class OrgPermission(Base):
"""Permissions each organization is allowed to grant to its roles."""
__tablename__ = "org_permissions"
id: Mapped[int] = mapped_column(Integer, primary_key=True)
org_uuid: Mapped[bytes] = mapped_column(
LargeBinary(16), ForeignKey("orgs.uuid", ondelete="CASCADE")
)
permission_id: Mapped[str] = mapped_column(
String(64), ForeignKey("permissions.id", ondelete="CASCADE")
)
class RolePermission(Base):
"""Permissions that each role grants to its members."""
__tablename__ = "role_permissions"
id: Mapped[int] = mapped_column(Integer, primary_key=True)
role_uuid: Mapped[bytes] = mapped_column(
LargeBinary(16), ForeignKey("roles.uuid", ondelete="CASCADE")
)
permission_id: Mapped[str] = mapped_column(
String(64), ForeignKey("permissions.id", ondelete="CASCADE")
)
class DB:
"""Legacy SQL database class for migration purposes only."""
def __init__(self, db_path: str = DB_PATH_DEFAULT):
"""Initialize with database path."""
self.engine = create_async_engine(db_path, echo=False)
# Ensure SQLite foreign key enforcement is ON for every new connection
if db_path.startswith("sqlite"):
@event.listens_for(self.engine.sync_engine, "connect")
def _fk_on(dbapi_connection, connection_record):
try:
cursor = dbapi_connection.cursor()
cursor.execute("PRAGMA foreign_keys=ON;")
cursor.close()
except Exception:
pass
self.async_session_factory = async_sessionmaker(
self.engine, expire_on_commit=False
)
@asynccontextmanager
async def session(self):
"""Async context manager that provides a database session with transaction."""
async with self.async_session_factory() as session:
async with session.begin():
yield session
await session.flush()
await session.commit()
async def init_db(self) -> None:
"""Initialize database tables."""
async with self.engine.begin() as conn:
await conn.run_sync(Base.metadata.create_all)
async def list_permissions(self) -> list[SqlPermission]:
async with self.session() as session:
result = await session.execute(select(PermissionModel))
return [p.as_dataclass() for p in result.scalars().all()]
async def list_organizations(self) -> list[Org]:
async with self.session() as session:
# Load all orgs
orgs_result = await session.execute(select(OrgModel))
org_models = orgs_result.scalars().all()
if not org_models:
return []
# Preload org permissions mapping
org_perms_result = await session.execute(select(OrgPermission))
org_perms = org_perms_result.scalars().all()
perms_by_org: dict[bytes, list[str]] = {}
for op in org_perms:
perms_by_org.setdefault(op.org_uuid, []).append(op.permission_id)
# Preload roles
roles_result = await session.execute(select(RoleModel))
role_models = roles_result.scalars().all()
# Preload role permissions mapping
rp_result = await session.execute(select(RolePermission))
rps = rp_result.scalars().all()
perms_by_role: dict[bytes, list[str]] = {}
for rp in rps:
perms_by_role.setdefault(rp.role_uuid, []).append(rp.permission_id)
# Build org dataclasses with roles and permission IDs
roles_by_org: dict[bytes, list[Role]] = {}
for rm in role_models:
r_dc = rm.as_dataclass()
r_dc.permissions = perms_by_role.get(rm.uuid, [])
roles_by_org.setdefault(rm.org_uuid, []).append(r_dc)
orgs: list[Org] = []
for om in org_models:
o_dc = om.as_dataclass()
o_dc.permissions = perms_by_org.get(om.uuid, [])
o_dc.roles = roles_by_org.get(om.uuid, [])
orgs.append(o_dc)
return orgs
+6 -6
View File
@@ -19,9 +19,9 @@ The first 3 words of the token serve as the pairing code for manual entry.
import asyncio import asyncio
import logging import logging
from collections.abc import Callable
from dataclasses import dataclass from dataclasses import dataclass
from datetime import datetime, timedelta, timezone from datetime import UTC, datetime, timedelta
from typing import Callable
from uuid import UUID from uuid import UUID
from paskia.util import passphrase, pow from paskia.util import passphrase, pow
@@ -94,7 +94,7 @@ class RemoteAuthManager:
async def _cleanup_expired(self): async def _cleanup_expired(self):
"""Remove expired requests and notify waiting clients.""" """Remove expired requests and notify waiting clients."""
now = datetime.now(timezone.utc) now = datetime.now(UTC)
expired_keys = [] expired_keys = []
async with self._lock: async with self._lock:
for key, req in self._requests.items(): for key, req in self._requests.items():
@@ -123,7 +123,7 @@ class RemoteAuthManager:
Returns: Returns:
(code, expiry) - The 3-word passphrase code and expiration time (code, expiry) - The 3-word passphrase code and expiration time
""" """
now = datetime.now(timezone.utc) now = datetime.now(UTC)
expiry = now + REMOTE_AUTH_LIFETIME expiry = now + REMOTE_AUTH_LIFETIME
async with self._lock: async with self._lock:
@@ -160,7 +160,7 @@ class RemoteAuthManager:
req = self._requests.get(normalized) req = self._requests.get(normalized)
if req is None: if req is None:
return None return None
now = datetime.now(timezone.utc) now = datetime.now(UTC)
if now > req.created_at + REMOTE_AUTH_LIFETIME: if now > req.created_at + REMOTE_AUTH_LIFETIME:
# Expired # Expired
del self._requests[normalized] del self._requests[normalized]
@@ -331,7 +331,7 @@ class RemoteAuthManager:
req = self._requests.get(token) req = self._requests.get(token)
if req is None: if req is None:
return None return None
now = datetime.now(timezone.utc) now = datetime.now(UTC)
if now > req.created_at + REMOTE_AUTH_LIFETIME: if now > req.created_at + REMOTE_AUTH_LIFETIME:
del self._requests[token] del self._requests[token]
return None return None
+17
View File
@@ -8,6 +8,7 @@ This module provides a unified interface for WebAuthn operations including:
""" """
import json import json
import re
from urllib.parse import urlparse from urllib.parse import urlparse
from uuid import UUID from uuid import UUID
@@ -62,6 +63,7 @@ class Passkey:
ValueError: If any origin domain doesn't match or isn't a subdomain of rp_id. ValueError: If any origin domain doesn't match or isn't a subdomain of rp_id.
""" """
self.rp_id = rp_id self.rp_id = rp_id
self._validate_rp_id(rp_id)
self.rp_name = rp_name or rp_id self.rp_name = rp_name or rp_id
self.allowed_origins: set[str] | None = None self.allowed_origins: set[str] | None = None
if origins: if origins:
@@ -75,6 +77,21 @@ class Passkey:
COSEAlgorithmIdentifier.RSASSA_PKCS1_v1_5_SHA_256, COSEAlgorithmIdentifier.RSASSA_PKCS1_v1_5_SHA_256,
] ]
def _validate_rp_id(self, rp_id: str) -> None:
"""Validate that rp_id is a valid domain name."""
if not rp_id:
raise ValueError("rp_id cannot be empty")
# Allow localhost, or domain-like strings
if rp_id == "localhost":
return
# Regex for valid domain: letters, digits, hyphens, dots, but not starting/ending with hyphen, etc.
# Simplified: alphanumeric, dots, hyphens
if not re.match(
r"^[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$",
rp_id,
):
raise ValueError(f"rp_id '{rp_id}' is not a valid domain name")
def _validate_origin(self, origin: str, rp_id: str) -> None: def _validate_origin(self, origin: str, rp_id: str) -> None:
"""Validate an origin URL against the rp_id.""" """Validate an origin URL against the rp_id."""
hostname = urlparse(origin).hostname hostname = urlparse(origin).hostname
View File
+110
View File
@@ -0,0 +1,110 @@
"""API response utilities using msgspec for JSON serialization.
msgspec handles UUID and datetime conversion automatically.
API structs inherit from db structs with kw_only=True to add uuid/key fields.
"""
from datetime import UTC, datetime
from uuid import UUID
import msgspec
from paskia.db.structs import Org, Permission, Role, User
from paskia.util import useragent
def _utc_datetime(dt: datetime | None) -> datetime | None:
"""Convert datetime to UTC, handling both aware and naive datetimes."""
if dt is None:
return None
if dt.tzinfo:
return dt.astimezone(UTC)
return dt.replace(tzinfo=UTC)
def format_datetime(dt: datetime | None) -> str | None:
"""Format a datetime to ISO 8601 string with Z suffix for UTC."""
if dt is None:
return None
utc_dt = _utc_datetime(dt)
return utc_dt.isoformat().replace("+00:00", "Z") if utc_dt else None
# -------------------------------------------------------------------------
# API structs - inherit from db structs, add uuid for serialization
# -------------------------------------------------------------------------
class ApiUser(User, kw_only=True):
"""User with uuid serialized."""
uuid: UUID
@classmethod
def from_db(cls, u: User) -> "ApiUser":
return cls(uuid=u.uuid, **msgspec.structs.asdict(u))
class ApiOrg(Org, kw_only=True):
"""Org with uuid serialized."""
uuid: UUID
@classmethod
def from_db(cls, o: Org) -> "ApiOrg":
return cls(uuid=o.uuid, **msgspec.structs.asdict(o))
class ApiRole(Role, kw_only=True):
"""Role with uuid serialized."""
uuid: UUID
@classmethod
def from_db(cls, r: Role) -> "ApiRole":
return cls(uuid=r.uuid, **msgspec.structs.asdict(r))
class ApiPermission(Permission, kw_only=True):
"""Permission with uuid serialized."""
uuid: UUID
@classmethod
def from_db(cls, p: Permission) -> "ApiPermission":
return cls(uuid=p.uuid, **msgspec.structs.asdict(p))
class ApiSession(msgspec.Struct):
"""Session for API responses with computed fields."""
id: str
credential_uuid: UUID = msgspec.field(name="credential")
host: str
ip: str
user_agent: str
last_renewed: datetime
is_current: bool = False
is_current_host: bool = False
@classmethod
def from_db(
cls,
s, # Session
*,
current_key: str,
normalized_host: str | None,
expires_delta, # timedelta
) -> "ApiSession":
return cls(
id=s.key,
credential_uuid=s.credential_uuid,
host=s.host,
ip=s.ip,
user_agent=useragent.compact_user_agent(s.user_agent),
last_renewed=s.expiry - expires_delta,
is_current=s.key == current_key,
is_current_host=bool(
normalized_host and s.host and s.host == normalized_host
),
)
+7 -6
View File
@@ -56,7 +56,7 @@ def reload_config() -> None:
def normalize_host(raw_host: str | None) -> str | None: def normalize_host(raw_host: str | None) -> str | None:
"""Normalize a Host header preserving port (exact match required).""" """Normalize a Host header, stripping port numbers for consistent matching."""
if not raw_host: if not raw_host:
return None return None
candidate = raw_host.strip() candidate = raw_host.strip()
@@ -65,11 +65,12 @@ def normalize_host(raw_host: str | None) -> str | None:
# urlsplit to parse (add // for scheme-less); prefer netloc to retain port. # urlsplit to parse (add // for scheme-less); prefer netloc to retain port.
parsed = urlsplit(candidate if "//" in candidate else f"//{candidate}") parsed = urlsplit(candidate if "//" in candidate else f"//{candidate}")
netloc = parsed.netloc or parsed.path or "" netloc = parsed.netloc or parsed.path or ""
# Strip IPv6 brackets around host part but retain port suffix. # Handle IPv6 addresses: [ipv6]:port or [ipv6]
if netloc.startswith("["): if netloc.startswith("["):
# format: [ipv6]:port or [ipv6]
if "]" in netloc: if "]" in netloc:
host_part, _, rest = netloc.partition("]") host_part, _, _ = netloc.partition("]")
port_part = rest.lstrip(":") netloc = host_part.strip("[]")
netloc = host_part.strip("[]") + (f":{port_part}" if port_part else "") else:
# Strip port from host:port
netloc = netloc.rsplit(":", 1)[0]
return netloc.lower() or None return netloc.lower() or None
+1 -1
View File
@@ -40,4 +40,4 @@ async def session_context(auth: str | None, host: str | None = None):
if not auth: if not auth:
return None return None
normalized_host = normalize_host(host) if host else None normalized_host = normalize_host(host) if host else None
return db.get_session_context(auth, normalized_host) return db.data().session_ctx(auth, normalized_host)
+2 -2
View File
@@ -1,6 +1,6 @@
"""Utility functions for session validation and checking.""" """Utility functions for session validation and checking."""
from datetime import datetime, timezone from datetime import UTC, datetime
from paskia.authsession import EXPIRES from paskia.authsession import EXPIRES
from paskia.db import SessionContext from paskia.db import SessionContext
@@ -34,5 +34,5 @@ def check_session_age(ctx: SessionContext, max_age: str | None) -> bool:
else: else:
auth_time = ctx.session.expiry - EXPIRES auth_time = ctx.session.expiry - EXPIRES
time_since_auth = datetime.now(timezone.utc) - auth_time time_since_auth = datetime.now(UTC) - auth_time
return time_since_auth <= max_age_delta return time_since_auth <= max_age_delta
+35 -7
View File
@@ -1,6 +1,7 @@
"""Startup configuration box formatting utilities.""" """Startup configuration box formatting utilities."""
import os import os
import re
from sys import stderr from sys import stderr
from typing import TYPE_CHECKING from typing import TYPE_CHECKING
@@ -11,12 +12,26 @@ if TYPE_CHECKING:
BOX_WIDTH = 60 # Inner width (excluding box chars) BOX_WIDTH = 60 # Inner width (excluding box chars)
# ANSI color codes
RESET = "\033[0m"
YELLOW = "\033[33m" # Dark yellow
BRIGHT_YELLOW = "\033[93m" # Bright yellow
BRIGHT_WHITE = "\033[1;37m" # Bold bright white
def _visible_len(text: str) -> int:
"""Calculate visible length of text, ignoring ANSI escape codes."""
return len(re.sub(r"\033\[[0-9;]*m", "", text))
def line(text: str = "") -> str: def line(text: str = "") -> str:
"""Format a line inside the box with proper padding, truncating if needed.""" """Format a line inside the box with proper padding, truncating if needed."""
if len(text) > BOX_WIDTH: visible = _visible_len(text)
if visible > BOX_WIDTH:
text = text[: BOX_WIDTH - 1] + "" text = text[: BOX_WIDTH - 1] + ""
return f"{text:<{BOX_WIDTH}}\n" visible = BOX_WIDTH
padding = BOX_WIDTH - visible
return f"{text}{' ' * padding}\n"
def top() -> str: def top() -> str:
@@ -29,12 +44,25 @@ def bottom() -> str:
def print_startup_config(config: "PaskiaConfig") -> None: def print_startup_config(config: "PaskiaConfig") -> None:
"""Print server configuration on startup.""" """Print server configuration on startup."""
# Key graphic with yellow shading (bright for highlights, dark for body)
y = YELLOW # Dark yellow for main body
b = BRIGHT_YELLOW # Bright yellow for highlights/edges
w = BRIGHT_WHITE # Bold white for URL
r = RESET
lines = [top()] lines = [top()]
lines.append(line(" ▄▄▄▄▄")) lines.append(line(f" {b}▄▄▄▄▄{r}"))
lines.append(line("█ █ Paskia " + __version__)) lines.append(line(f"{b}{y} {b}{r} Paskia " + __version__))
lines.append(line("█ █▄▄▄▄▄▄▄▄▄▄▄▄")) lines.append(line(f"{b}{y} {b}{y}▄▄▄▄▄▄▄▄▄▄▄▄{r}"))
lines.append(line("█ █▀▀▀▀█▀▀█▀▀█ " + config.site_url + config.site_path)) lines.append(
lines.append(line(" ▀▀▀▀▀")) line(
f"{b}{y} {b}{y}▀▀▀▀{b}{y}▀▀{b}{y}▀▀{b}{r} {w}"
+ config.site_url
+ config.site_path
+ r
)
)
lines.append(line(f" {y}▀▀▀▀▀{r}"))
# Format auth host section # Format auth host section
if config.auth_host: if config.auth_host:
+26 -7
View File
@@ -1,10 +1,29 @@
import user_agents from ua_parser import parse
def compact_user_agent(ua: str | None) -> str: def compact_user_agent(ua: str | None) -> str:
if not ua: """Format user agent string into a compact display format.
return "-"
u = user_agents.parse(ua) Returns empty string for empty/missing user agents.
ver = u.browser.version_string.split(".")[0] Returns original UA for unrecognized ones.
dev = u.device.family if u.device.family not in ["Other", "Mac"] else "" """
return f"{u.browser.family}/{ver} {u.os.family} {dev}".strip() if not ua or not ua.strip() or ua == "-":
return ""
r = parse(ua)
browser = r.user_agent.family if r.user_agent else None
ver = r.user_agent.major if r.user_agent else ""
os_name = r.os.family if r.os else None
dev = r.device.family if r.device else None
# If browser is unrecognized, return original UA
if browser in (None, "Other") and os_name in (None, "Other"):
return ua
# Filter out "Other" values
browser = browser if browser and browser != "Other" else ""
os_name = os_name if os_name and os_name != "Other" else ""
# Exclude device if it's "Other" or matches browser family (parser bug)
if dev in (None, "Other") or dev == browser:
dev = ""
# Build compact string, filtering empty parts
parts = [f"{browser}/{ver}" if browser else "", os_name, dev]
result = " ".join(p for p in parts if p).strip()
return result
+39 -83
View File
@@ -1,107 +1,63 @@
"""User information formatting and retrieval logic.""" """User information formatting and retrieval logic."""
from datetime import timezone
from paskia import aaguid, db from paskia import aaguid, db
from paskia.authsession import EXPIRES from paskia.authsession import EXPIRES
from paskia.db import SessionContext from paskia.db import SessionContext
from paskia.util import hostutil, permutil, useragent from paskia.util import hostutil, permutil
from paskia.util.apistructs import ApiSession
def _format_datetime(dt): def build_session_context(ctx: SessionContext) -> dict:
"""Format a datetime object to ISO 8601 string with UTC timezone.""" """Build session context dict from SessionContext."""
if dt is None: result = {
return None "user": {"uuid": ctx.user.uuid, "display_name": ctx.user.display_name},
if dt.tzinfo: "org": {"uuid": ctx.org.uuid, "display_name": ctx.org.display_name},
return dt.astimezone(timezone.utc).isoformat().replace("+00:00", "Z") "role": {"uuid": ctx.role.uuid, "display_name": ctx.role.display_name},
else:
return dt.replace(tzinfo=timezone.utc).isoformat().replace("+00:00", "Z")
def format_session_context(ctx: SessionContext) -> dict:
"""Format SessionContext for JSON response."""
return {
"user": {
"uuid": str(ctx.user.uuid),
"display_name": ctx.user.display_name,
},
"org": {
"uuid": str(ctx.org.uuid),
"display_name": ctx.org.display_name,
},
"role": {
"uuid": str(ctx.role.uuid),
"display_name": ctx.role.display_name,
},
"permissions": [p.scope for p in ctx.permissions], "permissions": [p.scope for p in ctx.permissions],
} }
if ctx.user.theme:
result["user"]["theme"] = ctx.user.theme
return result
async def format_user_info( async def build_user_info(
*, *,
user_uuid, user_uuid,
auth: str, auth: str,
session_record, session_record,
request_host: str | None, request_host: str | None,
) -> dict: ) -> dict:
"""Format complete user information for authenticated users.""" """Build user info dict for authenticated users."""
ctx = await permutil.session_context(auth, request_host) ctx = await permutil.session_context(auth, request_host)
user = db.data().users[user_uuid]
normalized_host = hostutil.normalize_host(request_host)
# Fetch and format credentials credentials = sorted(user.credentials, key=lambda c: c.created_at)
user_credentials = [ return {
c for c in db.data().credentials.values() if c.user == user_uuid "ctx": build_session_context(ctx),
] "created_at": ctx.user.created_at,
credentials: list[dict] = [] "last_seen": ctx.user.last_seen,
user_aaguids: set[str] = set() "visits": ctx.user.visits,
"credentials": [
for c in user_credentials:
aaguid_str = str(c.aaguid)
user_aaguids.add(aaguid_str)
credentials.append(
{ {
"credential": str(c.uuid), "credential": c.uuid,
"aaguid": aaguid_str, "aaguid": c.aaguid,
"created_at": _format_datetime(c.created_at), "created_at": c.created_at,
"last_used": _format_datetime(c.last_used), "last_used": c.last_used,
"last_verified": _format_datetime(c.last_verified), "last_verified": c.last_verified,
"sign_count": c.sign_count, "sign_count": c.sign_count,
"is_current_session": session_record.credential == c.uuid, "is_current_session": session_record.credential == c.uuid,
} }
) for c in credentials
],
credentials.sort(key=lambda cred: cred["created_at"]) "aaguid_info": aaguid.filter(c.aaguid for c in credentials),
aaguid_info = aaguid.filter(user_aaguids) "sessions": [
ApiSession.from_db(
# Format sessions s,
normalized_request_host = hostutil.normalize_host(request_host) current_key=auth,
session_records = [s for s in db.data().sessions.values() if s.user == user_uuid] normalized_host=normalized_host,
current_session_key = auth expires_delta=EXPIRES,
sessions_payload: list[dict] = [] )
for s in user.sessions
for entry in session_records: ],
sessions_payload.append(
{
"id": entry.key,
"credential": str(entry.credential),
"host": entry.host,
"ip": entry.ip,
"user_agent": useragent.compact_user_agent(entry.user_agent),
"last_renewed": _format_datetime(entry.expiry - EXPIRES),
"is_current": entry.key == current_session_key,
"is_current_host": bool(
normalized_request_host
and entry.host
and entry.host == normalized_request_host
),
}
)
return {
"ctx": format_session_context(ctx),
"created_at": _format_datetime(ctx.user.created_at),
"last_seen": _format_datetime(ctx.user.last_seen),
"visits": ctx.user.visits,
"credentials": credentials,
"aaguid_info": aaguid_info,
"sessions": sessions_payload,
} }
+1 -10
View File
@@ -18,11 +18,11 @@ dependencies = [
"base64url>=1.0.0", "base64url>=1.0.0",
"uuid7-standard>=1.0.0", "uuid7-standard>=1.0.0",
"pyjwt>=2.8.0", "pyjwt>=2.8.0",
"user-agents>=2.2.0",
"jsondiff>=2.2.1", "jsondiff>=2.2.1",
"msgspec>=0.20.0", "msgspec>=0.20.0",
"aiofiles>=25.1.0", "aiofiles>=25.1.0",
"fastapi-vue>=0.3.0", "fastapi-vue>=0.3.0",
"ua-parser[regex]>=1.0.1",
] ]
requires-python = ">=3.11" requires-python = ">=3.11"
@@ -44,10 +44,6 @@ dev = [
"pytest-asyncio>=0.24.0", "pytest-asyncio>=0.24.0",
"httpx>=0.27.0", "httpx>=0.27.0",
] ]
migrate = [
"sqlalchemy[asyncio]>=2.0.0",
"aiosqlite>=0.19.0",
]
[tool.coverage.run] [tool.coverage.run]
source = ["paskia"] source = ["paskia"]
@@ -74,10 +70,6 @@ filterwarnings = [
"ignore::DeprecationWarning", "ignore::DeprecationWarning",
] ]
[tool.ruff]
target-version = "py39"
line-length = 88
[tool.ruff.lint] [tool.ruff.lint]
select = ["E", "F", "I", "N", "W", "UP", "PLC0415"] select = ["E", "F", "I", "N", "W", "UP", "PLC0415"]
ignore = ["E501"] # Line too long ignore = ["E501"] # Line too long
@@ -95,7 +87,6 @@ dev = [
[project.scripts] [project.scripts]
paskia = "paskia.fastapi.__main__:main" paskia = "paskia.fastapi.__main__:main"
paskia-migrate = "paskia.migrate:main"
[tool.hatch.build] [tool.hatch.build]
artifacts = ["paskia/frontend-build"] artifacts = ["paskia/frontend-build"]
+10 -40
View File
@@ -1,48 +1,18 @@
import shutil """Hatch build hook for building paskia-js and Vue frontend during package build."""
import subprocess
import sys
from pathlib import Path from pathlib import Path
from sys import stderr
from hatchling.builders.hooks.plugin.interface import BuildHookInterface from hatchling.builders.hooks.plugin.interface import BuildHookInterface # type: ignore
sys.path.insert(0, str(Path(__file__).parent / "fastapi-vue"))
def run(cmd, **kwargs): from buildutil import build # noqa: E402
display_cmd = [Path(cmd[0]).name, *cmd[1:]]
stderr.write(f"### {' '.join(display_cmd)}\n")
subprocess.run(cmd, check=True, **kwargs)
def find_build_tool():
install = [
("deno", "install", "--allow-scripts=npm:vue-demi"),
("npm", "install"),
("bun", "--bun", "install"),
]
build = [
("deno", "task", "build"),
("npm", "run", "build"),
("bun", "--bun", "run", "build"),
]
for i, b in zip(install, build, strict=False):
if tool := shutil.which(i[0]):
return [tool, *i[1:]], [tool, *b[1:]]
raise RuntimeError("Deno, npm or Bun is required for building but none was found")
class CustomBuildHook(BuildHookInterface): class CustomBuildHook(BuildHookInterface):
"""Build hook that compiles paskia-js and Vue frontend before packaging."""
def initialize(self, version, build_data): def initialize(self, version, build_data):
super().initialize(version, build_data) super().initialize(version, build_data)
stderr.write(">>> Building the frontend\n") build("paskia-js")
build("frontend")
install_cmd, build_cmd = find_build_tool()
try:
run(install_cmd, cwd="frontend")
stderr.write("\n")
run(build_cmd, cwd="frontend")
except Exception as e:
stderr.write(f"Error occurred while building frontend: {e}\n")
raise
-277
View File
@@ -1,277 +0,0 @@
#!/usr/bin/env -S uv run
# auto-upgrade@fastapi-vue-setup - remove this if you modify this file
"""Run Vite development server for frontend and FastAPI backend with auto-reload.
Usage:
uv run scripts/devserver.py [host:port] [--backend host:port]
The optional host:port argument sets where the Vite frontend listens.
Supported forms: host[:port], :port (all interfaces), or just port.
The --backend option sets where the FastAPI backend listens (default: localhost:5180).
Environment:
JS_RUNTIME Path or name of JS runtime to use (deno, npm/node or bun).
FASTAPI_VUE_FRONTEND_URL Set by this script for the backend to know where Vite is.
"""
import argparse
import asyncio
import contextlib
import os
from pathlib import Path
from sys import stderr
import httpx
from fastapi_vue.hostutil import parse_endpoint
exec((Path(__file__).parent / "fastapi-vue/util.py").read_text("UTF-8")) # noqa: S102
DEFAULT_VITE_PORT = 5173
DEFAULT_BACKEND_PORT = 5180
FRONTEND_PATH = Path(__file__).parent.parent / "frontend"
EPILOG = """
scripts/devserver.py # Default ports on localhost
scripts/devserver.py 3000 # Vite on localhost:3000
scripts/devserver.py :3000 --backend 8000 # *:3000, localhost:8000
"""
BUN_BUG = """\
Bun cannot correctly proxy API requests to the backend.
Bug report: https://github.com/oven-sh/bun/issues/9882
Consider using deno or npm instead for development.
"""
def resolve_frontend_tools(
vite_port: int, all_ifaces: bool
) -> tuple[list[str], list[str], str]:
"""Resolve frontend install and dev commands.
Returns (install_cmd, dev_cmd, tool_name).
Raises SystemExit if tools are not available.
"""
if not (FRONTEND_PATH / "package.json").exists():
stderr.write(f"┃ ⚠️ Frontend source not found at {FRONTEND_PATH}\n")
raise SystemExit(1)
result = find_js_runtime() # noqa # type: ignore
if result is None:
if not os.environ.get("JS_RUNTIME"):
stderr.write("┃ ⚠️ deno, npm or bun needed to run the frontend server.\n")
raise SystemExit(1)
tool, name = result
install_args = {
"deno": ("install", "--quiet", "--allow-scripts=npm:vue-demi"),
"npm": ("install", "--silent"),
"bun": ("install", "--silent"),
}
dev_args = {
"deno": ("run", "dev", "--"),
"npm": ("--silent", "run", "dev", "--"),
"bun": ("run", "dev", "--"),
}
install_cmd = [tool, *install_args[name]]
dev_cmd = [
tool,
*dev_args[name],
"--clearScreen=false",
f"--port={vite_port}",
]
if all_ifaces:
dev_cmd.append("--host")
if name == "bun":
stderr.write(BUN_BUG)
return install_cmd, dev_cmd, name
async def wait_for_backend(host: str, port: int):
"""Wait for the backend to be ready by polling the health endpoint."""
max_attempts = 50
url = f"http://{host}:{port}"
async with httpx.AsyncClient() as client:
for attempt in range(max_attempts):
try:
await client.get(url, timeout=1.0)
stderr.write("✓ Backend ready!\n")
return True
except httpx.RequestError:
if attempt == max_attempts - 1:
stderr.write("┃ ⚠️ Backend didn't start in time\n")
return False
await asyncio.sleep(0.1)
return False
async def _terminate_process(proc: asyncio.subprocess.Process, name: str) -> None:
"""Gracefully terminate a subprocess."""
if proc.returncode is not None:
return
try:
proc.terminate()
except ProcessLookupError:
return
try:
await asyncio.wait_for(proc.wait(), timeout=2)
except TimeoutError:
try:
proc.kill()
except ProcessLookupError:
return
await proc.wait()
async def run_devserver(
vite_port: int,
all_ifaces: bool,
backend_host: str,
backend_port: int,
) -> None:
"""Run the development server with install, backend, and frontend."""
install_cmd, dev_cmd, tool_name = resolve_frontend_tools(vite_port, all_ifaces)
# Tell the backend where the Vite dev server is
os.environ["FASTAPI_VUE_FRONTEND_URL"] = f"http://localhost:{vite_port}"
# Tell Vite where the backend is (for proxying /api requests)
os.environ["FASTAPI_VUE_BACKEND_URL"] = f"http://{backend_host}:{backend_port}"
backend_cmd = [
"uvicorn",
"paskia.app:app",
"--host",
backend_host,
"--port",
str(backend_port),
"--reload",
]
cwd = str(Path(__file__).parent.parent)
frontend_cwd = str(FRONTEND_PATH)
backend_proc: asyncio.subprocess.Process | None = None
install_proc: asyncio.subprocess.Process | None = None
frontend_proc: asyncio.subprocess.Process | None = None
try:
# Start install (concurrent with backend)
stderr.write(f">>> {tool_name} {' '.join(install_cmd[1:])}\n")
install_proc = await asyncio.create_subprocess_exec(
*install_cmd, cwd=frontend_cwd
)
await asyncio.sleep(0.1)
# Start backend (concurrent with install)
stderr.write(f">>> {' '.join(backend_cmd)}\n")
backend_proc = await asyncio.create_subprocess_exec(*backend_cmd, cwd=cwd)
# Wait for install to complete and backend to be ready
install_task = asyncio.create_task(install_proc.wait(), name="install")
backend_ready_task = asyncio.create_task(
wait_for_backend(backend_host, backend_port), name="backend_ready"
)
done, pending = await asyncio.wait(
{install_task, backend_ready_task},
return_when=asyncio.FIRST_COMPLETED,
)
for task in done:
if task.get_name() == "install":
if task.result() != 0:
stderr.write("┃ ⚠️ Install failed\n")
raise SystemExit(1)
elif task.get_name() == "backend_ready" and not task.result():
raise SystemExit(1)
if pending:
done2, _ = await asyncio.wait(pending)
for task in done2:
if task.get_name() == "install":
if task.result() != 0:
stderr.write("┃ ⚠️ Install failed\n")
raise SystemExit(1)
elif task.get_name() == "backend_ready" and not task.result():
raise SystemExit(1)
install_proc = None
# Start Vite dev server
stderr.write(f">>> {tool_name} {' '.join(dev_cmd[1:])}\n")
frontend_proc = await asyncio.create_subprocess_exec(*dev_cmd, cwd=frontend_cwd)
# Wait for either process to exit
done, pending = await asyncio.wait(
{
asyncio.create_task(backend_proc.wait(), name="backend"),
asyncio.create_task(frontend_proc.wait(), name="frontend"),
},
return_when=asyncio.FIRST_COMPLETED,
)
for t in done:
t.result()
for t in pending:
t.cancel()
except asyncio.CancelledError:
stderr.write("\n✓ Shutting down...\n")
finally:
if frontend_proc is not None:
await _terminate_process(frontend_proc, "frontend")
if install_proc is not None:
await _terminate_process(install_proc, "install")
if backend_proc is not None:
await _terminate_process(backend_proc, "backend")
def main():
parser = argparse.ArgumentParser(
description="Run Vite and FastAPI development servers",
formatter_class=argparse.RawDescriptionHelpFormatter,
epilog=EPILOG,
)
parser.add_argument(
"frontend",
nargs="?",
metavar="host:port",
help="Vite frontend endpoint (default: localhost:5173)",
)
parser.add_argument(
"--backend",
metavar="host:port",
help="FastAPI backend endpoint (default: localhost:5180)",
)
args = parser.parse_args()
# parse_endpoint returns list of dicts with host/port or uds keys
# Multiple entries means bind all interfaces (IPv4 + IPv6)
vite_endpoints = parse_endpoint(args.frontend, DEFAULT_VITE_PORT)
backend_endpoints = parse_endpoint(args.backend, DEFAULT_BACKEND_PORT)
# Vite doesn't support unix sockets
if "uds" in vite_endpoints[0]:
stderr.write("┃ ⚠️ Unix sockets not supported for frontend\n")
raise SystemExit(1)
if "uds" in backend_endpoints[0]:
stderr.write("┃ ⚠️ Unix sockets not supported for backend\n")
raise SystemExit(1)
vite_port = vite_endpoints[0]["port"]
all_ifaces = len(vite_endpoints) > 1
backend_host = backend_endpoints[0]["host"]
backend_port = backend_endpoints[0]["port"]
with contextlib.suppress(KeyboardInterrupt):
asyncio.run(run_devserver(vite_port, all_ifaces, backend_host, backend_port))
if __name__ == "__main__":
main()
+142 -372
View File
@@ -1,21 +1,21 @@
#!/usr/bin/env -S uv run #!/usr/bin/env -S uv run
"""Run Vite development server for frontend and FastAPI backend with auto-reload. """Run Vite development server for frontend and Paskia backend with auto-reload.
This script is only available when running from the git repository source, This script is only available when running from the git repository source,
not from the installed package. It starts both the Vite frontend dev server not from the installed package. It starts both the Vite frontend dev server
and the FastAPI backend with auto-reload enabled. and the Paskia backend with auto-reload enabled.
Usage: Usage:
uv run scripts/devserver.py [host:port] [options...] uv run scripts/devserver.py [-l host:port] [options...]
The optional host:port argument sets where the Vite frontend listens. The optional -l/--listen argument sets where the Vite frontend listens.
All other options are forwarded to `paskia`. All other options are forwarded to `paskia`.
Backend always listens on localhost:4402. Backend always listens on localhost:4402.
Environment: Environment:
FASTAPI_VUE_FRONTEND_URL Set by this script for the backend to know where Vite is. PASKIA_FRONTEND_URL Set by this script for the backend to know where Vite is.
FASTAPI_VUE_BACKEND_URL Set by this script for Vite to know where to proxy API calls. PASKIA_BACKEND_URL Set by this script for Vite to know where to proxy API calls.
PASKIA_SITE_URL User-facing URL for reset links (Caddy HTTPS or Vite HTTP). PASKIA_SITE_URL User-facing URL for reset links (Caddy HTTPS or Vite HTTP).
Options: Options:
--caddy Run Caddy as HTTPS proxy on port 443 (requires sudo) --caddy Run Caddy as HTTPS proxy on port 443 (requires sudo)
@@ -25,45 +25,30 @@ Options:
""" """
import argparse import argparse
import atexit import asyncio
import ipaddress
import json import json
import os import os
import shutil import shutil
import signal import sys
import subprocess from contextlib import suppress
from pathlib import Path from pathlib import Path
from sys import stderr
from threading import Thread
from urllib.parse import urlparse from urllib.parse import urlparse
# Import utilities from scripts/fastapi-vue (not a package, so we adjust sys.path)
sys.path.insert(0, str(Path(__file__).with_name("fastapi-vue")))
from devutil import ( # noqa: E402
ProcessGroup,
check_ports_free,
logger,
ready,
setup_cli,
setup_vite,
)
DEFAULT_VITE_PORT = 4403 # overrides by CLI option DEFAULT_VITE_PORT = 4403 # overrides by CLI option
BACKEND_PORT = 4402 # hardcoded, also in vite.config.ts BACKEND_PORT = 4402 # hardcoded, also in vite.config.ts
CADDY_PORT = 443 # HTTPS port for Caddy proxy CADDY_PORT = 443 # HTTPS port for Caddy proxy
CADDY_HTTP_PORT = 80 # HTTP port for ACME challenges CADDY_HTTP_PORT = 80 # HTTP port for ACME challenges
DEFAULT_HOST = "localhost"
NO_FRONTEND_TOOL = """\
deno, npm or bunx needed to run the frontend server.
"""
BUN_BUG = """\
Bun cannot correctly proxy API requests to the backend.
Bug report: https://github.com/oven-sh/bun/issues/9882
Options:
- sudo caddy run --config caddy/Caddyfile.dev
- Install deno or npm instead
Caddy will skip the Vite for API calls and serve everything at port 443.
Otherwise Vite serves at port 8077 and proxies to backend (broken with bun).
"""
NO_FRONTEND = """\
The backend will still try reaching Vite at {vite_url}
for various frontend assets, so make sure to start it manually.
"""
CADDYFILE_SITE_BLOCK = """\ CADDYFILE_SITE_BLOCK = """\
SITE_ADDR { SITE_ADDR {
@@ -79,140 +64,14 @@ SITE_ADDR {
""" """
def parse_endpoint( def build_caddyfile(origins: list[str], vite_port: int) -> str:
value: str | None, default_port: int """Build a Caddyfile for the given origins."""
) -> tuple[str | None, int | None, str | None, bool]:
"""Parse an endpoint for Vite (simplified version for dev.py).
Returns (host, port, uds_path, all_ifaces).
"""
if not value:
return DEFAULT_HOST, default_port, None, False
# Port only (numeric) -> localhost:port
if value.isdigit():
return DEFAULT_HOST, int(value), None, False
# Leading colon :port -> bind all interfaces
if value.startswith(":") and value != ":":
port_part = value[1:]
if not port_part.isdigit():
raise SystemExit(f"Invalid port in '{value}'")
return None, int(port_part), None, True
# UNIX domain socket
if value.startswith("unix:"):
uds_path = value[5:] or None
if uds_path is None:
raise SystemExit("unix: path must not be empty")
return None, None, uds_path, False
# Unbracketed IPv6 (cannot safely contain a port)
if value.count(":") > 1 and not value.startswith("["):
try:
ipaddress.IPv6Address(value)
except ValueError as e:
raise SystemExit(f"Invalid IPv6 address '{value}': {e}")
return value, default_port, None, False
# Use urllib.parse for everything else
parsed = urlparse(f"//{value}")
host = parsed.hostname or DEFAULT_HOST
port = parsed.port or default_port
return host, port, None, False
def run_vite(
vite_url: str,
vite_host: str | None,
vite_port: int,
env: dict,
auth_host: str | None = None,
):
"""Spawn the frontend dev server (deno, npm, or bunx) as a background process."""
devpath = Path(__file__).parent.parent / "frontend"
if not (devpath / "package.json").exists():
stderr.write(
f"┃ ⚠️ Frontend source not found at {devpath}\n"
+ NO_FRONTEND.format(vite_url=vite_url)
)
return
options = [
("deno", "run", "dev"),
("npm", "--silent", "run", "dev", "--"),
("bunx", "--bun", "vite"),
]
cmd = None
tool_name = None
for option in options:
if tool := shutil.which(option[0]):
cmd = [tool, *option[1:]]
tool_name = option[0]
break
# Add Vite CLI args for host/port
vite_args = ["--port", str(vite_port), "--logLevel", "silent"]
if vite_host:
vite_args.extend(["--host", vite_host])
vite_process = None
def start_vite():
nonlocal vite_process
if cmd is None:
stderr.write(NO_FRONTEND_TOOL + NO_FRONTEND.format(vite_url=vite_url))
return
assert tool_name is not None
try:
if tool_name == "bunx":
stderr.write(BUN_BUG)
full_cmd = cmd + vite_args
stderr.write(f">>> {' '.join([tool_name, *full_cmd[1:]])}\n")
vite_env = env.copy()
if auth_host:
vite_env["PASKIA_AUTH_HOST"] = auth_host
vite_process = subprocess.Popen(
full_cmd, cwd=str(devpath), shell=False, env=vite_env
)
except Exception as e:
stderr.write(
f"┃ ⚠️ Vite couldn't start: {e}\n"
+ NO_FRONTEND.format(vite_url=vite_url)
)
def cleanup():
if vite_process:
vite_process.terminate()
vite_process.wait()
# Start Vite in a separate thread
vite_thread = Thread(target=start_vite, daemon=True)
vite_thread.start()
atexit.register(cleanup)
signal.signal(signal.SIGTERM, lambda *_: cleanup())
signal.signal(signal.SIGINT, lambda *_: cleanup())
def run_caddy(origins: list[str], vite_port: int) -> subprocess.Popen | None:
"""Spawn Caddy as HTTPS reverse proxy for the given origins."""
caddy_path = shutil.which("caddy")
if not caddy_path:
stderr.write("┃ ⚠️ Caddy not found. Install it to use --caddy option.\n")
return None
# Build Caddyfile with a site block for each origin
caddyfile_parts = [] caddyfile_parts = []
for origin in origins: for origin in origins:
parsed = urlparse(origin) parsed = urlparse(origin)
# Extract scheme://host:port from origin URL
scheme = parsed.scheme or "https" scheme = parsed.scheme or "https"
host = parsed.hostname or parsed.path # handle case without scheme host = parsed.hostname or parsed.path
port = parsed.port or (CADDY_HTTP_PORT if scheme == "http" else CADDY_PORT) port = parsed.port or (CADDY_HTTP_PORT if scheme == "http" else CADDY_PORT)
# Use standard ports without explicit port in address (cleaner URLs)
if port in (80, 443): if port in (80, 443):
site_addr = f"{scheme}://{host}" site_addr = f"{scheme}://{host}"
else: else:
@@ -223,162 +82,150 @@ def run_caddy(origins: list[str], vite_port: int) -> subprocess.Popen | None:
.replace("VITE_PORT", str(vite_port)) .replace("VITE_PORT", str(vite_port))
) )
caddyfile_parts.append(block) caddyfile_parts.append(block)
return "\n".join(caddyfile_parts)
caddyfile = "\n".join(caddyfile_parts)
caddy_process = None
try: async def run_caddy(origins: list[str], vite_port: int) -> asyncio.subprocess.Process:
# Use sudo to bind to privileged ports (80/443) for ACME certificate fetching """Start Caddy as HTTPS reverse proxy, wait for ready signal."""
cmd = ["sudo", caddy_path, "run", "--config", "-", "--adapter", "caddyfile"] caddy_path = shutil.which("caddy")
caddy_process = subprocess.Popen( if not caddy_path:
cmd, logger.warning("Caddy not found. Install it to use --caddy option.")
stdin=subprocess.PIPE, raise SystemExit(1)
stderr=subprocess.PIPE,
)
caddy_process.stdin.write(caddyfile.encode())
caddy_process.stdin.close()
except Exception as e:
stderr.write(f"┃ ⚠️ Caddy couldn't start: {e}\n")
return None
# Helper to parse Caddy log line (JSON or plain text) into (level, logger, msg) caddyfile = build_caddyfile(origins, vite_port)
def parse_caddy_log(line: str) -> tuple[str, str, str] | None: cmd = ["sudo", caddy_path, "run", "--config", "-", "--adapter", "caddyfile"]
"""Parse a Caddy log line, return (level, logger, msg) or None if unparseable."""
line = line.rstrip("\n")
if not line:
return None
# Try JSON format first logger.info(">>> sudo caddy @ %s", " ".join(origins))
try: proc = await asyncio.create_subprocess_exec(
log = json.loads(line) *cmd,
return ( stdin=asyncio.subprocess.PIPE,
log.get("level", ""), stderr=asyncio.subprocess.PIPE,
log.get("logger", ""), )
log.get("msg", ""), proc.stdin.write(caddyfile.encode())
) await proc.stdin.drain()
except json.JSONDecodeError: proc.stdin.close()
pass
# Plain text format: "2025/12/06 22:59:41.390 INFO logger msg..." # Wait for ready signal or failure
# or "2025/12/06 22:59:41.390 INFO msg..." (no logger)
parts = line.split("\t")
if len(parts) >= 2:
# First part is "timestamp LEVEL", rest are logger and/or message
first = parts[0].rsplit(None, 1) # split off the level from timestamp
if len(first) == 2:
level = first[1].lower()
if len(parts) == 2:
return (level, "", parts[1])
else:
return (level, parts[1], "\t".join(parts[2:]))
# Unparseable - return as-is with no level/logger
return ("", "", line)
def strip_caddy_verbose(msg: str) -> str:
"""Remove verbose prefixes from Caddy error messages."""
return msg.replace("loading initial config: loading new config: ", "")
def format_caddy_log(level: str, logger: str, msg: str) -> str:
"""Format a parsed Caddy log for display."""
msg = strip_caddy_verbose(msg)
if logger:
return f"┃ [{level.upper()}] {logger}: {msg}\n"
else:
return f"┃ [{level.upper()}] {msg}\n"
# Read stderr line by line until Caddy signals it's ready or exits
# Caddy outputs logs; "serving initial configuration" means it's ready
while True: while True:
exit_code = caddy_process.poll() if proc.returncode is not None:
if exit_code is not None: remaining = await proc.stderr.read()
# Process exited - read remaining stderr and report failure for line in remaining.decode().splitlines():
remaining = ( if line:
caddy_process.stderr.read().decode() if caddy_process.stderr else "" logger.info("caddy: %s", line)
) logger.warning("Caddy startup failed (exit code %d)", proc.returncode)
if remaining: raise SystemExit(1)
for line in remaining.splitlines():
if line:
parsed = parse_caddy_log(line)
if parsed:
level, logger, msg = parsed
if level:
stderr.write(format_caddy_log(level, logger, msg))
else:
stderr.write(f"{strip_caddy_verbose(msg)}\n")
else:
stderr.write(f"{strip_caddy_verbose(line)}\n")
stderr.write(f"┃ ⚠️ Caddy startup failed (exit code {exit_code})\n")
return None
# Read one line from stderr (blocks until data available) line = await proc.stderr.readline()
line = caddy_process.stderr.readline().decode()
if not line: if not line:
continue continue
# Check for ready signal decoded = line.decode().rstrip()
if "serving initial configuration" in line: if "serving initial configuration" in decoded:
break break
parsed = parse_caddy_log(line) # Parse and show errors during startup
if not parsed: if decoded:
continue try:
log = json.loads(decoded)
level = log.get("level", "")
if level in ("error", "fatal", "warn"):
logger.warning("caddy: %s", log.get("msg", decoded))
except json.JSONDecodeError:
if "error" in decoded.lower() or "fatal" in decoded.lower():
logger.warning("caddy: %s", decoded)
level, logger, msg = parsed # Start background task to drain stderr
async def drain_caddy_stderr():
# Filter out info-level and admin messages
if level == "info" or logger == "admin":
continue
# Show errors/fatal to user
if level in ("error", "fatal"):
stderr.write(format_caddy_log(level, logger, msg))
elif not level:
# Unparseable non-empty line (e.g., sudo prompt) - pass through with prefix
stderr.write(f"{strip_caddy_verbose(msg)}\n")
stderr.flush()
# Start a background thread to drain stderr and show errors
def drain_stderr():
while True: while True:
line = caddy_process.stderr.readline().decode() line = await proc.stderr.readline()
if not line: if not line:
break break
decoded = line.decode().rstrip()
if decoded:
try:
log = json.loads(decoded)
level = log.get("level", "")
if level in ("error", "fatal", "warn"):
logger.warning("caddy: %s", log.get("msg", decoded))
except json.JSONDecodeError:
pass # Ignore non-JSON output after startup
parsed = parse_caddy_log(line) asyncio.create_task(drain_caddy_stderr())
if not parsed: return proc
continue
level, logger, msg = parsed
# Filter out info-level and admin messages async def run_devserver(args: argparse.Namespace, remaining: list[str]) -> None:
if level == "info" or logger == "admin": """Run the development server with all components."""
continue reporoot = Path(__file__).parent.parent
frontend_path = reporoot / "frontend"
if not (frontend_path / "package.json").exists():
logger.warning("Frontend source not found at %s", frontend_path)
raise SystemExit(1)
# Show errors/warnings to user viteurl, npm_install, vite = setup_vite(args.listen, DEFAULT_VITE_PORT)
if level in ("error", "fatal", "warn"): backurl, paskia = setup_cli("paskia", f"localhost:{BACKEND_PORT}", BACKEND_PORT)
stderr.write(format_caddy_log(level, logger, msg))
elif not level:
# Unparseable line - pass through with prefix
stderr.write(f"{strip_caddy_verbose(msg)}\n")
drain_thread = Thread(target=drain_stderr, daemon=True) # Extract vite port for Caddy config
drain_thread.start() vite_port = int(viteurl.rsplit(":", 1)[1])
def cleanup(): # Build paskia command with options
if caddy_process: paskia.extend(["--rp-id", args.rp_id])
caddy_process.terminate() if args.auth_host:
caddy_process.wait() paskia.extend(["--auth-host", args.auth_host])
if args.origins:
for origin in args.origins:
paskia.extend(["--origin", origin])
paskia.extend(remaining)
atexit.register(cleanup) # Compute origins for Caddy
caddy_origins = []
if args.auth_host:
auth_host = args.auth_host
if "://" not in auth_host:
auth_host = f"https://{auth_host}"
caddy_origins.append(auth_host)
caddy_origins.append(f"https://{args.rp_id}")
if args.origins:
for origin in args.origins:
if "://" not in origin:
origin = f"https://{origin}"
caddy_origins.append(origin)
if not args.auth_host and not args.origins:
caddy_origins.append(f"https://{args.rp_id}")
# Remove duplicates while preserving order
seen = set()
caddy_origins = [x for x in caddy_origins if not (x in seen or seen.add(x))]
return caddy_process # Set environment for subprocesses
os.environ["PASKIA_FRONTEND_URL"] = viteurl
os.environ["PASKIA_BACKEND_URL"] = backurl
os.environ["PASKIA_SITE_URL"] = caddy_origins[0] if args.caddy else viteurl
if args.auth_host:
os.environ["PASKIA_AUTH_HOST"] = args.auth_host
async with ProcessGroup() as pg:
# Start Caddy first if requested (needs to bind ports)
if args.caddy:
caddy_proc = await run_caddy(caddy_origins, vite_port)
pg._procs.append(caddy_proc)
pg._cmds[caddy_proc.pid] = "caddy"
npm_proc = await pg.spawn(*npm_install, cwd=frontend_path)
await check_ports_free(viteurl, backurl)
await pg.spawn(*paskia)
await pg.wait(npm_proc, ready(backurl, path="/api/health?from=devserver.py"))
await pg.spawn(*vite, cwd=frontend_path)
def main(): def main():
# Parse optional hostport argument for Vite frontend
parser = argparse.ArgumentParser(add_help=False) parser = argparse.ArgumentParser(add_help=False)
parser.add_argument("hostport", nargs="?", default=None) parser.add_argument(
"-l",
"--listen",
metavar="ENDPOINT",
default=None,
help="Vite frontend endpoint (default: localhost:4403)",
)
parser.add_argument("--caddy", action="store_true", help="Run Caddy as HTTPS proxy") parser.add_argument("--caddy", action="store_true", help="Run Caddy as HTTPS proxy")
parser.add_argument("--rp-id", default="localhost", help="Relying Party ID") parser.add_argument("--rp-id", default="localhost", help="Relying Party ID")
parser.add_argument( parser.add_argument(
@@ -387,85 +234,8 @@ def main():
parser.add_argument("--auth-host", help="Dedicated auth host") parser.add_argument("--auth-host", help="Dedicated auth host")
args, remaining = parser.parse_known_args() args, remaining = parser.parse_known_args()
# Parse Vite endpoint with suppress(KeyboardInterrupt):
vite_host, vite_port, vite_uds, all_ifaces = parse_endpoint( asyncio.run(run_devserver(args, remaining))
args.hostport, DEFAULT_VITE_PORT
)
if vite_uds:
raise SystemExit("┃ ⚠️ Unix sockets are not supported for Vite frontend")
# Handle all-interfaces case (:port syntax)
# Vite uses 0.0.0.0 to listen on all interfaces (IPv4 only, sufficient for dev)
if all_ifaces:
vite_host = "0.0.0.0"
# Build Vite URL for FASTAPI_VUE_FRONTEND_URL (always use localhost for URL)
vite_url = f"http://localhost:{vite_port}"
# Compute origins for Caddy (user-specified or auto-generated)
caddy_origins = []
if args.auth_host:
auth_host = args.auth_host
if "://" not in auth_host:
auth_host = f"https://{auth_host}"
caddy_origins.append(auth_host)
# Also run on rp-id when auth-host is specified
caddy_origins.append(f"https://{args.rp_id}")
if args.origins:
for origin in args.origins:
if "://" not in origin:
origin = f"https://{origin}"
caddy_origins.append(origin)
# If neither auth-host nor origins specified, run on rp-id
if not args.auth_host and not args.origins:
caddy_origins.append(f"https://{args.rp_id}")
# Remove duplicates while preserving order
seen = set()
caddy_origins = [x for x in caddy_origins if not (x in seen or seen.add(x))]
# Start Caddy if requested (after computing origins)
if args.caddy:
if not caddy_origins:
caddy_origins = [f"https://{args.rp_id}"]
stderr.write(f">>> sudo caddy @ {' '.join(caddy_origins)}\n")
if not run_caddy(caddy_origins, vite_port):
raise SystemExit(1)
# Set dev mode env vars for subprocesses (fastapi-vue convention)
env = os.environ.copy()
env["FASTAPI_VUE_FRONTEND_URL"] = vite_url
env["FASTAPI_VUE_BACKEND_URL"] = f"http://localhost:{BACKEND_PORT}"
# User-facing URL: Caddy HTTPS when running, else Vite HTTP
if args.caddy:
env["PASKIA_SITE_URL"] = caddy_origins[0] # auth-host or https://{rp-id}
else:
env["PASKIA_SITE_URL"] = vite_url
# Start Vite dev server
run_vite(vite_url, vite_host, vite_port, env, args.auth_host)
# Build command with origin args (no serve subcommand, host:port is first arg)
cmd = ["paskia", f"localhost:{BACKEND_PORT}"]
# Pass through rp-id (always pass, has default)
cmd.extend(["--rp-id", args.rp_id])
# Pass through auth-host if specified
if args.auth_host:
cmd.extend(["--auth-host", args.auth_host])
# Pass through origins as specified
if args.origins:
for origin in args.origins:
cmd.extend(["--origin", origin])
# Add remaining args (ones we didn't parse)
cmd.extend(remaining)
stderr.write(f">>> (devmode) {' '.join(cmd)}\n")
subprocess.run(cmd, env=env)
if __name__ == "__main__": if __name__ == "__main__":
+4 -23
View File
@@ -1,34 +1,15 @@
"""Hatch build hook for building Vue frontend during package build.""" """Hatch build hook for building Vue frontend during package build."""
import subprocess import sys
from pathlib import Path from pathlib import Path
from sys import stderr
from hatchling.builders.hooks.plugin.interface import BuildHookInterface # type: ignore from hatchling.builders.hooks.plugin.interface import BuildHookInterface # type: ignore
exec(Path(__file__).with_name("util.py").read_text("UTF-8")) # noqa: S102 sys.path.insert(0, str(Path(__file__).parent))
from buildutil import build
def run(cmd, **kwargs):
"""Run a command and display it."""
display_cmd = [Path(cmd[0]).name, *cmd[1:]]
stderr.write(f"### {' '.join(display_cmd)}\n")
subprocess.run(cmd, check=True, **kwargs)
class CustomBuildHook(BuildHookInterface): class CustomBuildHook(BuildHookInterface):
"""Build hook that compiles Vue frontend before packaging."""
def initialize(self, version, build_data): def initialize(self, version, build_data):
super().initialize(version, build_data) super().initialize(version, build_data)
stderr.write(">>> Building the frontend\n") build("frontend")
install_cmd, build_cmd = find_build_tool() # noqa # type: ignore
try:
run(install_cmd, cwd="frontend")
stderr.write("\n")
run(build_cmd, cwd="frontend")
except Exception as e:
stderr.write(f"Error occurred while building frontend: {e}\n")
raise
+191
View File
@@ -0,0 +1,191 @@
"""Utilities used at build time and in devserver script. No dependencies."""
import logging
import os
import re
import shutil
import subprocess
from pathlib import Path
class _PrefixFormatter(logging.Formatter):
"""Formatter that adds prefix based on log level."""
def format(self, record: logging.LogRecord) -> str:
if record.levelno >= logging.WARNING:
return f"⚠️ {record.getMessage()}"
return record.getMessage()
_handler = logging.StreamHandler()
_handler.setFormatter(_PrefixFormatter())
logger = logging.getLogger("fastapi-vue")
logger.addHandler(_handler)
logger.setLevel(logging.INFO)
def _check_node_version(node_path: str) -> None:
"""Check if Node.js version is >= 20.
Raises RuntimeError if version is too old or cannot be determined.
"""
try:
result = subprocess.run(
[node_path, "--version"], capture_output=True, text=True, check=True
)
version_str = result.stdout.strip()
# Parse version like "v20.10.0" or "v18.17.1"
match = re.match(r"v(\d+)", version_str)
if match:
major_version = int(match.group(1))
if major_version >= 20:
return
raise RuntimeError(
f"Node.js {version_str} found, but v20+ required (install with nvm)"
)
except (subprocess.CalledProcessError, FileNotFoundError, ValueError):
pass
raise RuntimeError("Could not determine Node.js version")
def find_js_runtime() -> tuple[str, str]:
"""Find a JavaScript runtime from JS_RUNTIME env or auto-detect.
Returns (tool_path, tool_name) where tool_name is "deno", "npm", or "bun".
Raises JSRuntimeError if no suitable runtime is found.
"""
options = ["npm", "deno", "bun"]
node_version_error: RuntimeError | None = None
# Check for JS_RUNTIME environment variable
if js_runtime_env := os.environ.get("JS_RUNTIME"):
js_runtime = js_runtime_env
js_path = Path(js_runtime)
runtime_name = js_path.name
# Map node to npm
if runtime_name == "node":
runtime_name = "npm"
js_runtime = str(js_path.parent / "npm") if js_path.parent.name else "npm"
for option in options:
if option == runtime_name or runtime_name.startswith(option):
tool = shutil.which(js_runtime)
if tool is None:
raise RuntimeError(
f"JS_RUNTIME={js_runtime_env}: {option} not found"
)
# Check Node.js version if using npm
if option == "npm":
node_path = shutil.which("node", path=str(Path(tool).parent))
if node_path is None:
raise RuntimeError(
f"JS_RUNTIME={js_runtime_env}: node not found"
)
_check_node_version(node_path) # Raises on failure
return tool, option
raise RuntimeError(f"JS_RUNTIME={js_runtime_env} not recognized")
# Auto-detect
for option in options:
if tool := shutil.which(option):
# Check Node.js version if using npm
if option == "npm":
node_path = shutil.which("node", path=str(Path(tool).parent))
if node_path is None:
continue
try:
_check_node_version(node_path)
except RuntimeError as e:
node_version_error = e
continue # Try next runtime
return tool, option
# No runtime found - provide helpful error
if node_version_error:
raise node_version_error
raise RuntimeError("Node.js (v20+), Deno or Bun is required but none was found")
def find_build_tool():
"""Find JavaScript runtime and construct install/build commands.
Returns (install_cmd, build_cmd) tuples of command lists.
Raises RuntimeError if no runtime is found.
"""
install = {
"deno": ("install", "--allow-scripts=npm:vue-demi"),
"npm": ("install",),
"bun": ("--bun", "install"),
}
# Run vite directly for deno to avoid npm-run-all2/run-p issues
build = {
"deno": ("run", "-A", "npm:vite", "build"),
"npm": ("run", "build"),
"bun": ("--bun", "run", "build"),
}
tool, name = find_js_runtime()
return [tool, *install[name]], [tool, *build[name]]
def find_dev_tool() -> list[str]:
"""Find JavaScript runtime and construct dev command.
Returns dev_cmd (without vite-specific args).
Raises RuntimeError if no runtime is found.
"""
dev_args = {
"deno": ("run", "-A", "npm:vite"),
"npm": ("--silent", "run", "dev", "--"),
"bun": ("run", "dev", "--"),
}
tool, name = find_js_runtime()
if name == "bun":
logger.warning(
"Bun has a bug in WS proxying (https://github.com/oven-sh/bun/issues/9882). Consider using npm instead."
)
return [tool, *dev_args[name]]
def find_install_tool() -> list[str]:
"""Find JavaScript runtime and construct install command.
Returns install_cmd.
Raises RuntimeError if no runtime is found.
"""
install_args = {
"deno": ("install", "--quiet", "--allow-scripts=npm:vue-demi"),
"npm": ("install", "--silent"),
"bun": ("install", "--silent"),
}
tool, name = find_js_runtime()
return [tool, *install_args[name]]
def build(folder: str = "frontend") -> None:
"""Build the frontend in the specified folder.
Raises SystemExit(1) on failure.
"""
logger.info(">>> Building %s", folder)
try:
install_cmd, build_cmd = find_build_tool()
except RuntimeError as e:
logger.warning(e)
raise SystemExit(1)
def run(cmd):
display_cmd = [Path(cmd[0]).stem, *cmd[1:]]
logger.info("### %s", " ".join(display_cmd))
subprocess.run(cmd, check=True, cwd=folder)
try:
run(install_cmd)
logger.info("")
run(build_cmd)
except subprocess.CalledProcessError:
raise SystemExit(1)
+211
View File
@@ -0,0 +1,211 @@
"""Utilities meant for devserver script, used only in source repository with dev deps."""
import asyncio
import subprocess
import sys
from collections.abc import Coroutine
from contextlib import suppress
from pathlib import Path
from typing import Any
import httpx
from buildutil import find_dev_tool, find_install_tool, logger
from fastapi_vue.hostutil import parse_endpoint
class ProcessGroup:
"""Manage async subprocesses with automatic cleanup, like TaskGroup for processes."""
def __init__(self):
self._procs: list[asyncio.subprocess.Process] = []
self._cmds: dict[int, str] = {} # pid -> command name
async def spawn(
self, *cmd: str, cwd: str | None = None
) -> asyncio.subprocess.Process:
"""Spawn a subprocess and track it."""
cmd_name = Path(cmd[0]).stem
logger.info(">>> %s", " ".join([cmd_name, *cmd[1:]]))
proc = await asyncio.create_subprocess_exec(*cmd, cwd=cwd)
self._procs.append(proc)
self._cmds[proc.pid] = cmd_name
return proc
async def wait(
self, *waitables: "asyncio.subprocess.Process | Coroutine[Any, Any, Any]"
) -> None:
"""Wait for processes/coroutines to complete, raise SystemExit on failure."""
async def wait_proc(proc: asyncio.subprocess.Process) -> None:
returncode = await proc.wait()
if returncode != 0:
cmd_name = self._cmds.get(proc.pid, "unknown")
raise subprocess.CalledProcessError(returncode, cmd_name)
tasks = [
wait_proc(w) if isinstance(w, asyncio.subprocess.Process) else w
for w in waitables
]
try:
await asyncio.gather(*tasks)
except subprocess.CalledProcessError as e:
logger.warning("%s failed with exit status %d", e.cmd, e.returncode)
raise SystemExit(1) from None
async def __aenter__(self):
return self
async def __aexit__(self, exc_type, *_):
"""Wait for one process to exit, terminate others, then wait for all."""
await self._cleanup(immediate=exc_type is not None)
async def _cleanup(self, immediate: bool = False):
running = [p for p in self._procs if p.returncode is None]
if not running:
return
if not immediate:
# Wait for any one process to exit
with suppress(asyncio.CancelledError):
await asyncio.wait(
[asyncio.create_task(p.wait()) for p in running],
return_when=asyncio.FIRST_COMPLETED,
)
# Terminate remaining processes
for p in self._procs:
if p.returncode is None:
with suppress(ProcessLookupError):
p.terminate()
# Wait for all to finish (with overall timeout), shielded from cancellation
still_running = [p for p in self._procs if p.returncode is None]
if still_running:
with suppress(asyncio.CancelledError):
try:
await asyncio.shield(
asyncio.wait_for(
asyncio.gather(*[p.wait() for p in still_running]),
timeout=10,
)
)
except TimeoutError:
for p in self._procs:
if p.returncode is None:
with suppress(ProcessLookupError):
p.kill()
await p.wait()
async def check_ports_free(*urls: str) -> None:
"""Verify URLs are not responding (ports are free). Raise SystemExit if any respond."""
async def check(client: httpx.AsyncClient, url: str) -> None:
with suppress(httpx.RequestError):
res = await client.get(url, timeout=0.1)
server = res.headers.get("server", "server")
logger.warning("Conflicting %s already running at %s", server, url)
raise SystemExit(1)
async with httpx.AsyncClient() as client:
await asyncio.gather(*[check(client, url) for url in urls])
async def ready(url: str, path: str = "") -> None:
"""Wait for the server to be ready by polling an endpoint.
Raises SystemExit(1) if server doesn't start in time.
"""
max_attempts = 50
full_url = f"{url}{path}"
async with httpx.AsyncClient() as client:
for attempt in range(max_attempts):
try:
await client.get(full_url, timeout=1.0)
logger.info("✓ Backend ready!")
return
except httpx.RequestError:
if attempt == max_attempts - 1:
logger.warning("Backend didn't start in time")
raise SystemExit(1)
await asyncio.sleep(0.1)
def setup_vite(
endpoint: str, default_port: int = 5173
) -> tuple[str, list[str], list[str]]:
"""Parse frontend endpoint and build commands.
Returns (url, install_cmd, dev_cmd).
Raises SystemExit(1) on invalid config.
"""
endpoints = parse_endpoint(endpoint, default_port)
if "uds" in endpoints[0]:
logger.warning("Unix sockets not supported with vite devserver")
raise SystemExit(1)
port = endpoints[0]["port"]
host = endpoints[0]["host"]
install_cmd = find_install_tool()
dev_cmd = find_dev_tool()
if host != "localhost":
dev_cmd.append("--host" if len(endpoints) > 1 else f"--host={host}")
dev_cmd.append(f"--port={port}")
return f"http://{host}:{port}", install_cmd, dev_cmd
def setup_fastapi(
endpoint: str, module: str, default_port: int = 8000
) -> tuple[str, list[str]]:
"""Parse backend endpoint and build uvicorn command.
Returns (url, uvicorn_cmd).
Raises SystemExit(1) on invalid config.
"""
endpoints = parse_endpoint(endpoint, default_port)
if "uds" in endpoints[0]:
logger.warning("Unix sockets not supported with vite devserver")
raise SystemExit(1)
host = endpoints[0]["host"]
port = endpoints[0]["port"]
reload_dir = module.split(".")[0] # Don't reload on frontend changes
cmd = [
sys.executable,
"-m",
"uvicorn",
module,
f"--host={host}",
f"--port={port}",
"--reload",
f"--reload-dir={reload_dir}",
"--forwarded-allow-ips=*",
]
return f"http://{host}:{port}", cmd
def setup_cli(
cli: str, endpoint: str, default_port: int = 8000
) -> tuple[str, list[str]]:
"""Parse backend endpoint and build CLI command.
Returns (url, cli_cmd).
Raises SystemExit(1) on invalid config.
"""
endpoints = parse_endpoint(endpoint, default_port)
if "uds" in endpoints[0]:
logger.warning("Unix sockets not supported with vite devserver")
raise SystemExit(1)
host = endpoints[0]["host"]
port = endpoints[0]["port"]
cmd = [cli, f"--listen={host}:{port}"]
return f"http://{host}:{port}", cmd
-87
View File
@@ -1,87 +0,0 @@
"""Shared utilities for build and dev scripts."""
import os
import shutil
from pathlib import Path
from sys import stderr
def find_js_runtime() -> tuple[str, str] | None:
"""Find a JavaScript runtime from JS_RUNTIME env or auto-detect.
Returns (tool_path, tool_name) where tool_name is "deno", "npm", or "bun".
Returns None if no runtime is found.
"""
options = ["deno", "npm", "bun"]
# Check for JS_RUNTIME environment variable
if js_runtime_env := os.environ.get("JS_RUNTIME"):
js_runtime = js_runtime_env
js_path = Path(js_runtime)
runtime_name = js_path.name
# Map node to npm
if runtime_name == "node":
runtime_name = "npm"
js_runtime = str(js_path.parent / "npm") if js_path.parent.name else "npm"
for option in options:
if option == runtime_name or runtime_name.startswith(option):
tool = shutil.which(js_runtime)
if tool is None:
stderr.write(f"┃ ⚠️ JS_RUNTIME={js_runtime_env} not found\n")
return None
return tool, option
stderr.write(f"┃ ⚠️ JS_RUNTIME={js_runtime_env} not recognized\n")
return None
# Auto-detect
for option in options:
if tool := shutil.which(option):
return tool, option
return None
def find_build_tool():
"""Find JavaScript runtime and construct install/build commands.
Returns (install_cmd, build_cmd) tuples of command lists.
Raises RuntimeError if no runtime is found.
"""
install = {
"deno": ("install", "--allow-scripts=npm:vue-demi"),
"npm": ("install",),
"bun": ("--bun", "install"),
}
# Run vite directly for deno to avoid npm-run-all2/run-p issues
build = {
"deno": ("run", "-A", "npm:vite", "build"),
"npm": ("run", "build"),
"bun": ("--bun", "run", "build"),
}
result = find_js_runtime()
if result is None:
raise RuntimeError(
"Deno, npm or Bun is required for building but none was found"
)
tool, name = result
return [tool, *install[name]], [tool, *build[name]]
def find_dev_tool():
"""Find JavaScript runtime and construct dev command.
Returns (dev_cmd, tool_name) or (None, None) if not found.
"""
dev_args = {
"deno": ("run", "dev", "--"),
"npm": ("--silent", "run", "dev", "--"),
"bun": ("run", "dev", "--"),
}
result = find_js_runtime()
if result is None:
return None, None
tool, name = result
return [tool, *dev_args[name]], name
+38 -64
View File
@@ -28,21 +28,17 @@ from paskia.db import (
Permission, Permission,
Role, Role,
User, User,
add_permission_to_org,
create_credential, create_credential,
create_org,
create_permission,
create_reset_token, create_reset_token,
create_role, create_role,
create_session, create_session,
create_user, create_user,
) )
from paskia.db.jsonl import JsonlStore from paskia.db.jsonl import JsonlStore
from paskia.db.operations import DB, _create_token from paskia.db.operations import DB
from paskia.fastapi.mainapp import app from paskia.fastapi.mainapp import app
from paskia.fastapi.session import AUTH_COOKIE_NAME from paskia.fastapi.session import AUTH_COOKIE_NAME
from paskia.sansio import Passkey from paskia.sansio import Passkey
from paskia.util.passphrase import generate
@pytest.fixture(scope="session") @pytest.fixture(scope="session")
@@ -55,7 +51,13 @@ def event_loop():
@pytest_asyncio.fixture(scope="function") @pytest_asyncio.fixture(scope="function")
async def test_db() -> AsyncGenerator[DB, None]: async def test_db() -> AsyncGenerator[DB, None]:
"""Create an in-memory JSON database for testing.""" """Create an in-memory JSON database for testing.
Uses bootstrap() to properly initialize the database with:
- auth:admin and auth:org:admin permissions
- A default organization with Administration role
- An admin user with the Administration role
"""
with tempfile.NamedTemporaryFile(suffix=".jsonl", delete=True) as f: with tempfile.NamedTemporaryFile(suffix=".jsonl", delete=True) as f:
db = DB() db = DB()
@@ -64,6 +66,11 @@ async def test_db() -> AsyncGenerator[DB, None]:
await store.load() await store.load()
ops_db._db = db ops_db._db = db
ops_db._store = store ops_db._store = store
# Bootstrap creates the initial permissions, org, role, and admin user
ops_db.bootstrap(
org_name="Test Organization",
admin_name="Test Admin",
)
yield db yield db
ops_db._db = None ops_db._db = None
ops_db._store = None ops_db._store = None
@@ -82,49 +89,30 @@ async def passkey_instance() -> Passkey:
paskia_globals.passkey._instance = None paskia_globals.passkey._instance = None
@pytest_asyncio.fixture(scope="function")
async def test_org(test_db: DB, admin_permission: Permission) -> Org:
"""Create a test organization with admin permission."""
org = Org.create(display_name="Test Organization")
create_org(org)
# Grant admin permission to this org
add_permission_to_org(org.uuid, admin_permission.uuid)
return org
@pytest_asyncio.fixture(scope="function") @pytest_asyncio.fixture(scope="function")
async def admin_permission(test_db: DB) -> Permission: async def admin_permission(test_db: DB) -> Permission:
"""Create the auth:admin permission.""" """Get the auth:admin permission created by bootstrap."""
perm = Permission.create(scope="auth:admin", display_name="Master Admin") return next(p for p in test_db.permissions.values() if p.scope == "auth:admin")
create_permission(perm)
return perm
@pytest_asyncio.fixture(scope="function") @pytest_asyncio.fixture(scope="function")
async def org_admin_permission(test_db: DB, test_org: Org) -> Permission: async def org_admin_permission(test_db: DB) -> Permission:
"""Create the auth:org:admin permission.""" """Get the auth:org:admin permission created by bootstrap."""
perm = Permission.create(scope="auth:org:admin", display_name="Organization Admin") return next(p for p in test_db.permissions.values() if p.scope == "auth:org:admin")
create_permission(perm)
# Make it grantable by the org
add_permission_to_org(test_org.uuid, perm.uuid)
return perm
@pytest_asyncio.fixture(scope="function") @pytest_asyncio.fixture(scope="function")
async def test_role( async def test_org(test_db: DB) -> Org:
test_db: DB, """Get the test organization created by bootstrap."""
test_org: Org, # Bootstrap creates exactly one org
admin_permission: Permission, return next(iter(test_db.orgs.values()))
org_admin_permission: Permission,
) -> Role:
"""Create a test role with admin permission.""" @pytest_asyncio.fixture(scope="function")
role = Role.create( async def test_role(test_db: DB) -> Role:
org=test_org.uuid, """Get the Administration role created by bootstrap."""
display_name="Test Admin Role", # Bootstrap creates exactly one role (Administration)
permissions={admin_permission.uuid, org_admin_permission.uuid}, return next(iter(test_db.roles.values()))
)
create_role(role)
return role
@pytest_asyncio.fixture(scope="function") @pytest_asyncio.fixture(scope="function")
@@ -139,14 +127,10 @@ async def user_role(test_db: DB, test_org: Org) -> Role:
@pytest_asyncio.fixture(scope="function") @pytest_asyncio.fixture(scope="function")
async def test_user(test_db: DB, test_role: Role) -> User: async def test_user(test_db: DB) -> User:
"""Create a test user with admin role.""" """Get the admin user created by bootstrap."""
user = User.create( # Bootstrap creates exactly one user (admin)
display_name="Test Admin", return next(iter(test_db.users.values()))
role=test_role.uuid,
)
create_user(user)
return user
@pytest_asyncio.fixture(scope="function") @pytest_asyncio.fixture(scope="function")
@@ -193,17 +177,14 @@ async def session_token(
test_db: DB, test_user: User, test_credential: Credential test_db: DB, test_user: User, test_credential: Credential
) -> str: ) -> str:
"""Create a session for the admin user and return the token.""" """Create a session for the admin user and return the token."""
token = _create_token() return create_session(
create_session(
user_uuid=test_user.uuid, user_uuid=test_user.uuid,
credential_uuid=test_credential.uuid, credential_uuid=test_credential.uuid,
key=token, host="localhost",
host="localhost:4401",
ip="127.0.0.1", ip="127.0.0.1",
user_agent="pytest", user_agent="pytest",
expiry=expires(), expiry=expires(),
) )
return token
@pytest_asyncio.fixture(scope="function") @pytest_asyncio.fixture(scope="function")
@@ -211,31 +192,24 @@ async def regular_session_token(
test_db: DB, regular_user: User, regular_credential: Credential test_db: DB, regular_user: User, regular_credential: Credential
) -> str: ) -> str:
"""Create a session for a regular user and return the token.""" """Create a session for a regular user and return the token."""
token = _create_token() return create_session(
create_session(
user_uuid=regular_user.uuid, user_uuid=regular_user.uuid,
credential_uuid=regular_credential.uuid, credential_uuid=regular_credential.uuid,
key=token, host="localhost",
host="localhost:4401",
ip="127.0.0.1", ip="127.0.0.1",
user_agent="pytest", user_agent="pytest",
expiry=expires(), expiry=expires(),
) )
return token
@pytest_asyncio.fixture(scope="function") @pytest_asyncio.fixture(scope="function")
async def reset_token(test_db: DB, test_user: User, test_credential: Credential) -> str: async def reset_token(test_db: DB, test_user: User, test_credential: Credential) -> str:
"""Create a reset token for the test user.""" """Create a reset token for the test user."""
return create_reset_token(
token = generate()
create_reset_token(
user_uuid=test_user.uuid, user_uuid=test_user.uuid,
passphrase=token,
expiry=reset_expires(), expiry=reset_expires(),
token_type="reset", token_type="reset",
) )
return token
@pytest_asyncio.fixture(scope="function") @pytest_asyncio.fixture(scope="function")
+231 -110
View File
@@ -12,7 +12,8 @@ These tests cover:
""" """
import os import os
from datetime import datetime, timezone import secrets
from datetime import UTC, datetime
from uuid import UUID from uuid import UUID
import httpx import httpx
@@ -36,7 +37,7 @@ from paskia.db import (
create_session, create_session,
create_user, create_user,
) )
from paskia.db.operations import DB, _create_token from paskia.db.operations import DB
from tests.conftest import auth_headers from tests.conftest import auth_headers
# -------------------- Additional Fixtures -------------------- # -------------------- Additional Fixtures --------------------
@@ -97,17 +98,14 @@ async def second_org_session_token(
test_db: DB, second_org_user: User, second_org_credential: Credential test_db: DB, second_org_user: User, second_org_credential: Credential
) -> str: ) -> str:
"""Create a session for the second org admin user.""" """Create a session for the second org admin user."""
token = _create_token() return create_session(
create_session(
user_uuid=second_org_user.uuid, user_uuid=second_org_user.uuid,
credential_uuid=second_org_credential.uuid, credential_uuid=second_org_credential.uuid,
key=token, host="localhost",
host="localhost:4401",
ip="127.0.0.1", ip="127.0.0.1",
user_agent="pytest", user_agent="pytest",
expiry=expires(), expiry=expires(),
) )
return token
@pytest_asyncio.fixture(scope="function") @pytest_asyncio.fixture(scope="function")
@@ -132,7 +130,7 @@ async def org_admin_user(test_db: DB, org_admin_role: Role) -> User:
role=org_admin_role.uuid, role=org_admin_role.uuid,
) )
user.visits = 5 user.visits = 5
user.last_seen = datetime.now(timezone.utc) user.last_seen = datetime.now(UTC)
create_user(user) create_user(user)
return user return user
@@ -157,17 +155,14 @@ async def org_admin_session_token(
test_db: DB, org_admin_user: User, org_admin_credential: Credential test_db: DB, org_admin_user: User, org_admin_credential: Credential
) -> str: ) -> str:
"""Create a session for the org admin user.""" """Create a session for the org admin user."""
token = _create_token() return create_session(
create_session(
user_uuid=org_admin_user.uuid, user_uuid=org_admin_user.uuid,
credential_uuid=org_admin_credential.uuid, credential_uuid=org_admin_credential.uuid,
key=token, host="localhost",
host="localhost:4401",
ip="127.0.0.1", ip="127.0.0.1",
user_agent="pytest", user_agent="pytest",
expiry=expires(), expiry=expires(),
) )
return token
@pytest_asyncio.fixture(scope="function") @pytest_asyncio.fixture(scope="function")
@@ -609,7 +604,7 @@ class TestAdminRoles:
): ):
"""Admin should be able to update a role.""" """Admin should be able to update a role."""
response = await client.patch( response = await client.patch(
f"/auth/api/admin/orgs/{test_org.uuid}/roles/{test_role.uuid}", f"/auth/api/admin/roles/{test_role.uuid}",
json={"display_name": "Updated Role Name"}, json={"display_name": "Updated Role Name"},
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
@@ -619,17 +614,19 @@ class TestAdminRoles:
@pytest.mark.asyncio @pytest.mark.asyncio
async def test_update_role_wrong_org( async def test_update_role_wrong_org(
self, client: httpx.AsyncClient, session_token: str, test_org, second_org_role self,
client: httpx.AsyncClient,
org_admin_session_token: str,
test_org,
second_org_role,
): ):
"""Cannot update role from another org.""" """Org admin cannot update role from another org."""
response = await client.patch( response = await client.patch(
f"/auth/api/admin/orgs/{test_org.uuid}/roles/{second_org_role.uuid}", f"/auth/api/admin/roles/{second_org_role.uuid}",
json={"display_name": "Try Update Wrong Org"}, json={"display_name": "Try Update Wrong Org"},
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(org_admin_session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 404 assert response.status_code == 403
data = response.json()
assert "Role not found" in data["detail"]
@pytest.mark.asyncio @pytest.mark.asyncio
async def test_update_role_add_grantable_permission( async def test_update_role_add_grantable_permission(
@@ -642,7 +639,7 @@ class TestAdminRoles:
): ):
"""Admin should be able to add grantable permissions to role.""" """Admin should be able to add grantable permissions to role."""
response = await client.post( response = await client.post(
f"/auth/api/admin/orgs/{test_org.uuid}/roles/{user_role.uuid}/permissions/{grantable_permission.uuid}", f"/auth/api/admin/roles/{user_role.uuid}/permissions/{grantable_permission.uuid}",
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 200 assert response.status_code == 200
@@ -664,7 +661,7 @@ class TestAdminRoles:
create_permission(perm) create_permission(perm)
response = await client.post( response = await client.post(
f"/auth/api/admin/orgs/{test_org.uuid}/roles/{user_role.uuid}/permissions/{perm.uuid}", f"/auth/api/admin/roles/{user_role.uuid}/permissions/{perm.uuid}",
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 400 assert response.status_code == 400
@@ -685,14 +682,14 @@ class TestAdminRoles:
# test_role has both auth:admin and auth:org:admin # test_role has both auth:admin and auth:org:admin
# Remove auth:admin first (should succeed since org:admin remains) # Remove auth:admin first (should succeed since org:admin remains)
response = await client.delete( response = await client.delete(
f"/auth/api/admin/orgs/{test_org.uuid}/roles/{test_role.uuid}/permissions/{admin_permission.uuid}", f"/auth/api/admin/roles/{test_role.uuid}/permissions/{admin_permission.uuid}",
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 200 assert response.status_code == 200
# Now try to remove auth:org:admin (should fail - would leave no admin access) # Now try to remove auth:org:admin (should fail - would leave no admin access)
response = await client.delete( response = await client.delete(
f"/auth/api/admin/orgs/{test_org.uuid}/roles/{test_role.uuid}/permissions/{org_admin_permission.uuid}", f"/auth/api/admin/roles/{test_role.uuid}/permissions/{org_admin_permission.uuid}",
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 400 assert response.status_code == 400
@@ -705,7 +702,7 @@ class TestAdminRoles:
): ):
"""Admin should be able to delete a role.""" """Admin should be able to delete a role."""
response = await client.delete( response = await client.delete(
f"/auth/api/admin/orgs/{test_org.uuid}/roles/{user_role.uuid}", f"/auth/api/admin/roles/{user_role.uuid}",
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 200 assert response.status_code == 200
@@ -714,16 +711,18 @@ class TestAdminRoles:
@pytest.mark.asyncio @pytest.mark.asyncio
async def test_delete_role_wrong_org( async def test_delete_role_wrong_org(
self, client: httpx.AsyncClient, session_token: str, test_org, second_org_role self,
client: httpx.AsyncClient,
org_admin_session_token: str,
test_org,
second_org_role,
): ):
"""Cannot delete role from another org.""" """Org admin cannot delete role from another org."""
response = await client.delete( response = await client.delete(
f"/auth/api/admin/orgs/{test_org.uuid}/roles/{second_org_role.uuid}", f"/auth/api/admin/roles/{second_org_role.uuid}",
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(org_admin_session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 404 assert response.status_code == 403
data = response.json()
assert "Role not found" in data["detail"]
@pytest.mark.asyncio @pytest.mark.asyncio
async def test_delete_own_role_fails( async def test_delete_own_role_fails(
@@ -731,7 +730,7 @@ class TestAdminRoles:
): ):
"""Admin cannot delete their own role.""" """Admin cannot delete their own role."""
response = await client.delete( response = await client.delete(
f"/auth/api/admin/orgs/{test_org.uuid}/roles/{test_role.uuid}", f"/auth/api/admin/roles/{test_role.uuid}",
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 400 assert response.status_code == 400
@@ -793,7 +792,7 @@ class TestAdminUsersInOrg:
): ):
"""Admin should be able to get user details within an org.""" """Admin should be able to get user details within an org."""
response = await client.get( response = await client.get(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{test_user.uuid}", f"/auth/api/admin/users/{test_user.uuid}",
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 200 assert response.status_code == 200
@@ -812,7 +811,7 @@ class TestAdminUsersInOrg:
"""Getting non-existent user should return 404.""" """Getting non-existent user should return 404."""
fake_uuid = uuid7.create() fake_uuid = uuid7.create()
response = await client.get( response = await client.get(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{fake_uuid}", f"/auth/api/admin/users/{fake_uuid}",
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 404 assert response.status_code == 404
@@ -821,16 +820,18 @@ class TestAdminUsersInOrg:
@pytest.mark.asyncio @pytest.mark.asyncio
async def test_get_user_wrong_org( async def test_get_user_wrong_org(
self, client: httpx.AsyncClient, session_token: str, test_org, second_org_user self,
client: httpx.AsyncClient,
org_admin_session_token: str,
test_org,
second_org_user,
): ):
"""Getting user from another org should return 404.""" """Org admin cannot get user from another org."""
response = await client.get( response = await client.get(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{second_org_user.uuid}", f"/auth/api/admin/users/{second_org_user.uuid}",
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(org_admin_session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 404 assert response.status_code == 403
data = response.json()
assert "User not found" in data["detail"]
@pytest.mark.asyncio @pytest.mark.asyncio
async def test_get_user_with_org_admin( async def test_get_user_with_org_admin(
@@ -842,7 +843,7 @@ class TestAdminUsersInOrg:
): ):
"""Org admin should be able to get user details.""" """Org admin should be able to get user details."""
response = await client.get( response = await client.get(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{org_admin_user.uuid}", f"/auth/api/admin/users/{org_admin_user.uuid}",
headers={**auth_headers(org_admin_session_token), "Host": "localhost:4401"}, headers={**auth_headers(org_admin_session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 200 assert response.status_code == 200
@@ -855,7 +856,7 @@ class TestAdminUsersInOrg:
): ):
"""Admin should be able to update user display name.""" """Admin should be able to update user display name."""
response = await client.patch( response = await client.patch(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{test_user.uuid}/display-name", f"/auth/api/admin/users/{test_user.uuid}/display-name",
json={"display_name": "Updated Admin Name"}, json={"display_name": "Updated Admin Name"},
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
@@ -868,7 +869,7 @@ class TestAdminUsersInOrg:
"""Updating non-existent user should return 404.""" """Updating non-existent user should return 404."""
fake_uuid = uuid7.create() fake_uuid = uuid7.create()
response = await client.patch( response = await client.patch(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{fake_uuid}/display-name", f"/auth/api/admin/users/{fake_uuid}/display-name",
json={"display_name": "New Name"}, json={"display_name": "New Name"},
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
@@ -878,15 +879,19 @@ class TestAdminUsersInOrg:
@pytest.mark.asyncio @pytest.mark.asyncio
async def test_update_user_display_name_wrong_org( async def test_update_user_display_name_wrong_org(
self, client: httpx.AsyncClient, session_token: str, test_org, second_org_user self,
client: httpx.AsyncClient,
org_admin_session_token: str,
test_org,
second_org_user,
): ):
"""Updating user from another org should return 404.""" """Org admin cannot update user from another org."""
response = await client.patch( response = await client.patch(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{second_org_user.uuid}/display-name", f"/auth/api/admin/users/{second_org_user.uuid}/display-name",
json={"display_name": "New Name"}, json={"display_name": "New Name"},
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(org_admin_session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 404 assert response.status_code == 403
@pytest.mark.asyncio @pytest.mark.asyncio
async def test_update_user_display_name_empty( async def test_update_user_display_name_empty(
@@ -894,7 +899,7 @@ class TestAdminUsersInOrg:
): ):
"""Updating user with empty display name should fail.""" """Updating user with empty display name should fail."""
response = await client.patch( response = await client.patch(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{test_user.uuid}/display-name", f"/auth/api/admin/users/{test_user.uuid}/display-name",
json={"display_name": " "}, json={"display_name": " "},
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
@@ -908,7 +913,7 @@ class TestAdminUsersInOrg:
): ):
"""Updating user with too long display name should fail.""" """Updating user with too long display name should fail."""
response = await client.patch( response = await client.patch(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{test_user.uuid}/display-name", f"/auth/api/admin/users/{test_user.uuid}/display-name",
json={"display_name": "x" * 100}, json={"display_name": "x" * 100},
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
@@ -928,8 +933,8 @@ class TestAdminUsersInOrg:
"""Admin should be able to change user's role within org.""" """Admin should be able to change user's role within org."""
# Use regular_user who is in the same org but not the session owner # Use regular_user who is in the same org but not the session owner
response = await client.patch( response = await client.patch(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{regular_user.uuid}/role", f"/auth/api/admin/users/{regular_user.uuid}/role",
json={"role": user_role.display_name}, json={"role_uuid": str(user_role.uuid)},
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 200 assert response.status_code == 200
@@ -940,13 +945,13 @@ class TestAdminUsersInOrg:
): ):
"""Updating user role without specifying role should fail.""" """Updating user role without specifying role should fail."""
response = await client.patch( response = await client.patch(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{test_user.uuid}/role", f"/auth/api/admin/users/{test_user.uuid}/role",
json={}, json={},
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 400 assert response.status_code == 400
data = response.json() data = response.json()
assert "role is required" in data["detail"] assert "role_uuid is required" in data["detail"]
@pytest.mark.asyncio @pytest.mark.asyncio
async def test_update_user_role_user_not_found( async def test_update_user_role_user_not_found(
@@ -955,27 +960,29 @@ class TestAdminUsersInOrg:
"""Updating role for non-existent user should fail.""" """Updating role for non-existent user should fail."""
fake_uuid = uuid7.create() fake_uuid = uuid7.create()
response = await client.patch( response = await client.patch(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{fake_uuid}/role", f"/auth/api/admin/users/{fake_uuid}/role",
json={"role": "User Role"}, json={"role_uuid": str(uuid7.create())},
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 400 assert response.status_code == 404
data = response.json() data = response.json()
assert "User not found" in data["detail"] assert "User not found" in data["detail"]
@pytest.mark.asyncio @pytest.mark.asyncio
async def test_update_user_role_wrong_org( async def test_update_user_role_wrong_org(
self, client: httpx.AsyncClient, session_token: str, test_org, second_org_user self,
client: httpx.AsyncClient,
org_admin_session_token: str,
test_org,
second_org_user,
): ):
"""Updating role for user in another org should fail.""" """Org admin cannot update role for user in another org."""
response = await client.patch( response = await client.patch(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{second_org_user.uuid}/role", f"/auth/api/admin/users/{second_org_user.uuid}/role",
json={"role": "User Role"}, json={"role_uuid": str(uuid7.create())},
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(org_admin_session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 400 assert response.status_code == 403
data = response.json()
assert "does not belong" in data["detail"]
@pytest.mark.asyncio @pytest.mark.asyncio
async def test_update_user_role_invalid_role( async def test_update_user_role_invalid_role(
@@ -983,8 +990,8 @@ class TestAdminUsersInOrg:
): ):
"""Updating user to non-existent role should fail.""" """Updating user to non-existent role should fail."""
response = await client.patch( response = await client.patch(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{test_user.uuid}/role", f"/auth/api/admin/users/{test_user.uuid}/role",
json={"role": "Nonexistent Role"}, json={"role_uuid": str(uuid7.create())},
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 400 assert response.status_code == 400
@@ -1002,8 +1009,8 @@ class TestAdminUsersInOrg:
): ):
"""Admin cannot change their own role to non-admin role.""" """Admin cannot change their own role to non-admin role."""
response = await client.patch( response = await client.patch(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{org_admin_user.uuid}/role", f"/auth/api/admin/users/{org_admin_user.uuid}/role",
json={"role": user_role.display_name}, json={"role_uuid": str(user_role.uuid)},
headers={**auth_headers(org_admin_session_token), "Host": "localhost:4401"}, headers={**auth_headers(org_admin_session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 400 assert response.status_code == 400
@@ -1023,8 +1030,8 @@ class TestAdminUsersInOrg:
# test_user is already on test_role which has auth:admin # test_user is already on test_role which has auth:admin
# Changing to the same role should succeed (no permission loss) # Changing to the same role should succeed (no permission loss)
response = await client.patch( response = await client.patch(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{test_user.uuid}/role", f"/auth/api/admin/users/{test_user.uuid}/role",
json={"role": test_role.display_name}, json={"role_uuid": str(test_role.uuid)},
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 200 assert response.status_code == 200
@@ -1035,7 +1042,7 @@ class TestAdminUsersInOrg:
): ):
"""Admin should be able to create reset links for users.""" """Admin should be able to create reset links for users."""
response = await client.post( response = await client.post(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{test_user.uuid}/create-link", f"/auth/api/admin/users/{test_user.uuid}/create-link",
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 200 assert response.status_code == 200
@@ -1050,7 +1057,7 @@ class TestAdminUsersInOrg:
"""Creating reset link for non-existent user should fail.""" """Creating reset link for non-existent user should fail."""
fake_uuid = uuid7.create() fake_uuid = uuid7.create()
response = await client.post( response = await client.post(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{fake_uuid}/create-link", f"/auth/api/admin/users/{fake_uuid}/create-link",
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 404 assert response.status_code == 404
@@ -1059,16 +1066,18 @@ class TestAdminUsersInOrg:
@pytest.mark.asyncio @pytest.mark.asyncio
async def test_create_user_reset_link_wrong_org( async def test_create_user_reset_link_wrong_org(
self, client: httpx.AsyncClient, session_token: str, test_org, second_org_user self,
client: httpx.AsyncClient,
org_admin_session_token: str,
test_org,
second_org_user,
): ):
"""Creating reset link for user in another org should fail.""" """Org admin cannot create reset link for user in another org."""
response = await client.post( response = await client.post(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{second_org_user.uuid}/create-link", f"/auth/api/admin/users/{second_org_user.uuid}/create-link",
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(org_admin_session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 404 assert response.status_code == 403
data = response.json()
assert "not found in organization" in data["detail"]
@pytest.mark.asyncio @pytest.mark.asyncio
async def test_create_user_registration_link_without_credentials( async def test_create_user_registration_link_without_credentials(
@@ -1088,7 +1097,7 @@ class TestAdminUsersInOrg:
create_user(user_no_cred) create_user(user_no_cred)
response = await client.post( response = await client.post(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{user_no_cred.uuid}/create-link", f"/auth/api/admin/users/{user_no_cred.uuid}/create-link",
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 200 assert response.status_code == 200
@@ -1096,6 +1105,120 @@ class TestAdminUsersInOrg:
assert "url" in data assert "url" in data
# -------------------- User Deletion Tests --------------------
class TestAdminUserDeletion:
"""Tests for admin user deletion"""
@pytest.mark.asyncio
async def test_delete_user_success(
self,
client: httpx.AsyncClient,
session_token: str,
test_org,
user_role,
test_db: DB,
):
"""Admin should be able to delete a user."""
# Create a user to delete
user_to_delete = User.create(
display_name="User To Delete",
role=user_role.uuid,
)
create_user(user_to_delete)
response = await client.delete(
f"/auth/api/admin/users/{user_to_delete.uuid}",
headers={**auth_headers(session_token), "Host": "localhost:4401"},
)
assert response.status_code == 200
data = response.json()
assert data["status"] == "ok"
# Verify user is actually deleted
assert user_to_delete.uuid not in db.data().users
@pytest.mark.asyncio
async def test_delete_user_not_found(
self, client: httpx.AsyncClient, session_token: str
):
"""Deleting non-existent user should return 404."""
fake_uuid = uuid7.create()
response = await client.delete(
f"/auth/api/admin/users/{fake_uuid}",
headers={**auth_headers(session_token), "Host": "localhost:4401"},
)
assert response.status_code == 404
data = response.json()
assert "User not found" in data["detail"]
@pytest.mark.asyncio
async def test_delete_own_user_fails(
self, client: httpx.AsyncClient, session_token: str, test_user
):
"""Admin cannot delete their own account."""
response = await client.delete(
f"/auth/api/admin/users/{test_user.uuid}",
headers={**auth_headers(session_token), "Host": "localhost:4401"},
)
assert response.status_code == 400
data = response.json()
assert "Cannot delete your own account" in data["detail"]
@pytest.mark.asyncio
async def test_delete_user_wrong_org(
self,
client: httpx.AsyncClient,
org_admin_session_token: str,
second_org_user,
):
"""Org admin cannot delete user from another org."""
response = await client.delete(
f"/auth/api/admin/users/{second_org_user.uuid}",
headers={**auth_headers(org_admin_session_token), "Host": "localhost:4401"},
)
assert response.status_code == 403
@pytest.mark.asyncio
async def test_delete_user_org_admin_success(
self,
client: httpx.AsyncClient,
org_admin_session_token: str,
test_org,
user_role,
test_db: DB,
):
"""Org admin should be able to delete users in their org."""
# Create a user in the same org to delete
user_to_delete = User.create(
display_name="Org User To Delete",
role=user_role.uuid,
)
create_user(user_to_delete)
response = await client.delete(
f"/auth/api/admin/users/{user_to_delete.uuid}",
headers={**auth_headers(org_admin_session_token), "Host": "localhost:4401"},
)
assert response.status_code == 200
data = response.json()
assert data["status"] == "ok"
@pytest.mark.asyncio
async def test_delete_user_regular_user_forbidden(
self,
client: httpx.AsyncClient,
regular_session_token: str,
test_user,
):
"""Regular user trying to delete user should get 403."""
response = await client.delete(
f"/auth/api/admin/users/{test_user.uuid}",
headers={**auth_headers(regular_session_token), "Host": "localhost:4401"},
)
assert response.status_code == 403
# -------------------- Credential Tests -------------------- # -------------------- Credential Tests --------------------
@@ -1113,7 +1236,7 @@ class TestAdminCredentials:
): ):
"""Admin should be able to delete a user's credential.""" """Admin should be able to delete a user's credential."""
response = await client.delete( response = await client.delete(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{test_user.uuid}/credentials/{test_credential.uuid}", f"/auth/api/admin/users/{test_user.uuid}/credentials/{test_credential.uuid}",
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 200 assert response.status_code == 200
@@ -1128,7 +1251,7 @@ class TestAdminCredentials:
fake_user_uuid = uuid7.create() fake_user_uuid = uuid7.create()
fake_cred_uuid = uuid7.create() fake_cred_uuid = uuid7.create()
response = await client.delete( response = await client.delete(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{fake_user_uuid}/credentials/{fake_cred_uuid}", f"/auth/api/admin/users/{fake_user_uuid}/credentials/{fake_cred_uuid}",
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 404 assert response.status_code == 404
@@ -1139,17 +1262,17 @@ class TestAdminCredentials:
async def test_delete_credential_wrong_org( async def test_delete_credential_wrong_org(
self, self,
client: httpx.AsyncClient, client: httpx.AsyncClient,
session_token: str, org_admin_session_token: str,
test_org, test_org,
second_org_user, second_org_user,
second_org_credential, second_org_credential,
): ):
"""Deleting credential for user in another org should fail.""" """Org admin cannot delete credential for user in another org."""
response = await client.delete( response = await client.delete(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{second_org_user.uuid}/credentials/{second_org_credential.uuid}", f"/auth/api/admin/users/{second_org_user.uuid}/credentials/{second_org_credential.uuid}",
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(org_admin_session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 404 assert response.status_code == 403
# -------------------- Session Tests -------------------- # -------------------- Session Tests --------------------
@@ -1170,11 +1293,9 @@ class TestAdminSessions:
): ):
"""Admin should be able to delete a user's session.""" """Admin should be able to delete a user's session."""
# Create an additional session to delete # Create an additional session to delete
extra_token = _create_token() extra_token = create_session(
create_session(
user_uuid=test_user.uuid, user_uuid=test_user.uuid,
credential_uuid=test_credential.uuid, credential_uuid=test_credential.uuid,
key=extra_token,
host="other.host:4401", host="other.host:4401",
ip="192.168.1.1", ip="192.168.1.1",
user_agent="other-agent", user_agent="other-agent",
@@ -1182,7 +1303,7 @@ class TestAdminSessions:
) )
response = await client.delete( response = await client.delete(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{test_user.uuid}/sessions/{extra_token}", f"/auth/api/admin/users/{test_user.uuid}/sessions/{extra_token}",
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 200 assert response.status_code == 200
@@ -1200,7 +1321,7 @@ class TestAdminSessions:
): ):
"""Admin can delete their own current session.""" """Admin can delete their own current session."""
response = await client.delete( response = await client.delete(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{test_user.uuid}/sessions/{session_token}", f"/auth/api/admin/users/{test_user.uuid}/sessions/{session_token}",
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 200 assert response.status_code == 200
@@ -1214,7 +1335,7 @@ class TestAdminSessions:
"""Deleting session for non-existent user should fail.""" """Deleting session for non-existent user should fail."""
fake_uuid = uuid7.create() fake_uuid = uuid7.create()
response = await client.delete( response = await client.delete(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{fake_uuid}/sessions/fake-session-id", f"/auth/api/admin/users/{fake_uuid}/sessions/fake-session-id",
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 404 assert response.status_code == 404
@@ -1225,16 +1346,16 @@ class TestAdminSessions:
async def test_delete_session_wrong_org( async def test_delete_session_wrong_org(
self, self,
client: httpx.AsyncClient, client: httpx.AsyncClient,
session_token: str, org_admin_session_token: str,
test_org, test_org,
second_org_user, second_org_user,
): ):
"""Deleting session for user in another org should fail.""" """Org admin cannot delete session for user in another org."""
response = await client.delete( response = await client.delete(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{second_org_user.uuid}/sessions/fake-session", f"/auth/api/admin/users/{second_org_user.uuid}/sessions/fake-session",
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(org_admin_session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 404 assert response.status_code == 403
@pytest.mark.asyncio @pytest.mark.asyncio
async def test_delete_session_invalid_id( async def test_delete_session_invalid_id(
@@ -1242,7 +1363,7 @@ class TestAdminSessions:
): ):
"""Deleting session with invalid/non-existent ID should fail.""" """Deleting session with invalid/non-existent ID should fail."""
response = await client.delete( response = await client.delete(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{test_user.uuid}/sessions/invalid!!id", f"/auth/api/admin/users/{test_user.uuid}/sessions/invalid!!id",
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 404 assert response.status_code == 404
@@ -1255,9 +1376,9 @@ class TestAdminSessions:
): ):
"""Deleting non-existent session should fail.""" """Deleting non-existent session should fail."""
# Use a valid format but non-existent key # Use a valid format but non-existent key
fake_token = _create_token() fake_token = secrets.token_urlsafe(12)
response = await client.delete( response = await client.delete(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{test_user.uuid}/sessions/{fake_token}", f"/auth/api/admin/users/{test_user.uuid}/sessions/{fake_token}",
headers={**auth_headers(session_token), "Host": "localhost:4401"}, headers={**auth_headers(session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 404 assert response.status_code == 404
@@ -1557,7 +1678,7 @@ class TestOrgAdminAuthExceptions:
): ):
"""Regular user (not org admin) trying to create reset link should get 403.""" """Regular user (not org admin) trying to create reset link should get 403."""
response = await client.post( response = await client.post(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{test_user.uuid}/create-link", f"/auth/api/admin/users/{test_user.uuid}/create-link",
headers={**auth_headers(regular_session_token), "Host": "localhost:4401"}, headers={**auth_headers(regular_session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 403 assert response.status_code == 403
@@ -1572,7 +1693,7 @@ class TestOrgAdminAuthExceptions:
): ):
"""Regular user trying to get user details should get 403.""" """Regular user trying to get user details should get 403."""
response = await client.get( response = await client.get(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{test_user.uuid}", f"/auth/api/admin/users/{test_user.uuid}",
headers={**auth_headers(regular_session_token), "Host": "localhost:4401"}, headers={**auth_headers(regular_session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 403 assert response.status_code == 403
@@ -1587,7 +1708,7 @@ class TestOrgAdminAuthExceptions:
): ):
"""Regular user trying to update display name should get 403.""" """Regular user trying to update display name should get 403."""
response = await client.patch( response = await client.patch(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{test_user.uuid}/display-name", f"/auth/api/admin/users/{test_user.uuid}/display-name",
json={"display_name": "New Name"}, json={"display_name": "New Name"},
headers={**auth_headers(regular_session_token), "Host": "localhost:4401"}, headers={**auth_headers(regular_session_token), "Host": "localhost:4401"},
) )
@@ -1604,7 +1725,7 @@ class TestOrgAdminAuthExceptions:
): ):
"""Regular user trying to delete credential should get 403.""" """Regular user trying to delete credential should get 403."""
response = await client.delete( response = await client.delete(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{test_user.uuid}/credentials/{test_credential.uuid}", f"/auth/api/admin/users/{test_user.uuid}/credentials/{test_credential.uuid}",
headers={**auth_headers(regular_session_token), "Host": "localhost:4401"}, headers={**auth_headers(regular_session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 403 assert response.status_code == 403
@@ -1619,7 +1740,7 @@ class TestOrgAdminAuthExceptions:
): ):
"""Regular user trying to delete session should get 403.""" """Regular user trying to delete session should get 403."""
response = await client.delete( response = await client.delete(
f"/auth/api/admin/orgs/{test_org.uuid}/users/{test_user.uuid}/sessions/some-session", f"/auth/api/admin/users/{test_user.uuid}/sessions/some-session",
headers={**auth_headers(regular_session_token), "Host": "localhost:4401"}, headers={**auth_headers(regular_session_token), "Host": "localhost:4401"},
) )
assert response.status_code == 403 assert response.status_code == 403
+6 -8
View File
@@ -10,14 +10,14 @@ These tests cover:
- /auth/api/set-session - Set session from bearer token - /auth/api/set-session - Set session from bearer token
""" """
from datetime import datetime, timedelta, timezone import secrets
from datetime import UTC, datetime, timedelta
import httpx import httpx
import pytest import pytest
from paskia.authsession import EXPIRES from paskia.authsession import EXPIRES
from paskia.db import create_session, delete_session from paskia.db import create_session, delete_session
from paskia.db.operations import _create_token
from paskia.util.passphrase import generate from paskia.util.passphrase import generate
from tests.conftest import auth_headers from tests.conftest import auth_headers
@@ -503,7 +503,7 @@ class TestValidateSessionRefresh:
"""Validate should handle session expiry during refresh attempt.""" """Validate should handle session expiry during refresh attempt."""
# Create a token but don't create a session for it # Create a token but don't create a session for it
token = _create_token() token = secrets.token_urlsafe(12)
response = await client.post( response = await client.post(
"/auth/api/validate", "/auth/api/validate",
headers={**auth_headers(token), "Host": "localhost:4401"}, headers={**auth_headers(token), "Host": "localhost:4401"},
@@ -522,13 +522,11 @@ class TestValidateSessionRefresh:
"""Validate should return 401 if session disappears during refresh.""" """Validate should return 401 if session disappears during refresh."""
# Create a session with an old expiry time to trigger refresh # Create a session with an old expiry time to trigger refresh
token = _create_token() old_expiry = datetime.now(UTC) + EXPIRES - timedelta(minutes=10)
old_expiry = datetime.now(timezone.utc) + EXPIRES - timedelta(minutes=10) token = create_session(
create_session(
user_uuid=test_user.uuid, user_uuid=test_user.uuid,
credential_uuid=test_credential.uuid, credential_uuid=test_credential.uuid,
key=token, host="localhost",
host="localhost:4401",
ip="127.0.0.1", ip="127.0.0.1",
user_agent="pytest", user_agent="pytest",
expiry=old_expiry, expiry=old_expiry,