diff options
| author | Pjotr Prins <pjotr.public01@thebird.nl> | 2026-10-05 07:34:26 +0000 |
|---|---|---|
| committer | Pjotr <wrk@bosa.lan> | 2026-10-05 07:34:26 +0000 |
| commit | 649ff6395bdca06530ceabd3e216c66851dc60d6 (patch) | |
| tree | 2bbe7008a8258b11ada120315fedff208d230206 /src/error.rs | |
| parent | 693e7ee89f8618c1abbf8af5c0db23b071700803 (diff) | |
| download | genenetwork4-649ff6395bdca06530ceabd3e216c66851dc60d6.tar.gz | |
Rename /dev/token to /get-test-token; require a token everywhere
Rename: POST /dev/token -> POST /get-test-token (src/routes/dev.rs,
TestToken replacing DevToken), matching tests/get_test_token.rs and
test/python/test_get_test_token.py (renamed from
tests/dev_token.rs/test_dev_token.py). Config::dev_token_enabled() and
the GN_AUTH_DEV_* config keys keep their names -- they're about the
dev-token feature generically, not tied to this one route's path.
Every endpoint now requires a valid token, not just the
dataset_probeset*/traits* family: species(_by_name/_datasets),
groups(_by_name/_strains/_traits*/_datasets) and dataset_by_name all
gain an AuthToken parameter. /, /version, /openapi.json and
/get-test-token itself are the only exceptions -- a health check, a
version check, the spec describing all this, and the endpoint that
hands out a token in the first place (which would be circular if it
needed one).
Rather than repeating security(("bearer_token" = [])) on every
#[utoipa::path], ApiDoc now declares it once as the document's default
security(...), and the three exceptions besides /get-test-token (/,
/version) override it with their own empty security() -- standard
OpenAPI semantics (an operation's own security, even empty, overrides
the document default; an absent one inherits it). error::Unauthorized,
a new #[derive(utoipa::IntoResponses)] type wrapping ApiError, is the
shared 401 every gated handler now references bare in its own
responses(...) list instead of writing out the same
(status = 401, description = "...", body = ApiError) tuple by hand.
Verified the resolved security per operation in a live /openapi.json.
tests/common::auth_token() (Rust) and the new
test/python/auth_helpers.auth_token() (Python, deduplicating what four
files previously each defined locally) now try this server's own
POST /get-test-token first, falling back to GN4_TEST_AUTH_TOKEN --
every previously-ungated test file gains a token check and switches to
get_with_token; the whole suite, both languages, now runs with zero
manually-provisioned tokens given GENENETWORK4_DEV_MODE=true
GENENETWORK4_BIND=127.0.0.1 for the test run. ServerTestCase gains
EXTRA_ENV so each Python test class can start its own server with dev
mode on. Verified both configured (auto-fetch) and unconfigured
(GN4_TEST_AUTH_TOKEN fallback, and full skip when neither is set, e.g.
the Guix build sandbox) paths.
README.md, docs/gn-auth.md and RELEASE_NOTES.md updated throughout for
the rename and the new blanket token requirement.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XDDpXvZBQat9uSgDeEMJ8d
Diffstat (limited to 'src/error.rs')
| -rw-r--r-- | src/error.rs | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/src/error.rs b/src/error.rs index f96f44b..eb58918 100644 --- a/src/error.rs +++ b/src/error.rs @@ -65,3 +65,16 @@ impl IntoResponse for ApiError { (status, Json(self)).into_response() } } + +/// The 401 every token-gated endpoint can return, as one shared +/// `IntoResponses` type (an `ApiError` body under the hood) instead of +/// writing out `(status = 401, description = "...", body = ApiError)` +/// by hand on each `#[utoipa::path(...)]` -- reference it bare inside +/// `responses(...)`, e.g. `responses(Unauthorized, (status = 200, ...))`. +/// Which endpoints actually need it (i.e. take `AuthToken`) is still a +/// per-handler decision; this only removes the repetition in +/// documenting the one response shape that decision implies. +#[derive(utoipa::IntoResponses)] +#[response(status = 401, description = "Missing or invalid token")] +#[allow(dead_code)] // only ever used for its OpenAPI schema, never constructed +pub struct Unauthorized(#[to_schema] ApiError); |
