fastapi-multiauth 0.2.0__tar.gz → 0.4.0__tar.gz

{fastapi_multiauth-0.2.0 → fastapi_multiauth-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-multiauth
-Version: 0.2.0
+Version: 0.4.0
 Summary: Composable authentication sources for FastAPI: bring your own validator, combine multiple schemes, correct OpenAPI by construction
 Keywords: fastapi,authentication,security,oauth,api-key,bearer,cookie
 Author: d3vyce
@@ -45,6 +45,7 @@ Composable authentication sources for FastAPI: bring your own validator, combine
 
 [![CI](https://github.com/d3vyce/fastapi-multiauth/actions/workflows/ci.yml/badge.svg)](https://github.com/d3vyce/fastapi-multiauth/actions/workflows/ci.yml)
 [![codecov](https://codecov.io/gh/d3vyce/fastapi-multiauth/graph/badge.svg)](https://codecov.io/gh/d3vyce/fastapi-multiauth)
+[![CodSpeed Badge](https://img.shields.io/endpoint?url=https://app.codspeed.io//badge.json)](https://app.codspeed.io//d3vyce/fastapi-multiauth?utm_source=badge)
 [![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)
 [![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
@@ -118,7 +119,7 @@ async def me(user=Security(auth)):
 - **`MultiAuth`**: try several sources in order on a single route (e.g. web session cookie + API bearer token), with all schemes documented in OpenAPI.
 - **Built-in sources**: covering the standard `fastapi.security` schemes:
     - **`HTTPBearerAuth`**: bearer tokens with optional Stripe-style `user_`/`org_` prefixes to route different token types to different validators, plus `generate_token()` for secure token creation.
-    - **`APIKeyCookieAuth`**: cookie sessions with optional HMAC-SHA256 signing (via [itsdangerous](https://itsdangerous.palletsprojects.com/)), embedded expiry, and key rotation.
+    - **`APIKeyCookieAuth`**: cookie sessions with optional HMAC-SHA256 signing (via [itsdangerous](https://itsdangerous.palletsprojects.com/)), embedded expiry, key rotation, and optional per-session ids so your app can list and revoke sessions individually.
     - **`APIKeyHeaderAuth`**: `X-API-Key`-style schemes, with **`APIKeyQueryAuth`** for legacy clients that can only pass a query parameter.
     - **`HTTPBasicAuth`**: `validator(username, password)` with `WWW-Authenticate` realm support.
 - **Token hashing helpers**: `hash_token`/`verify_token_hash` package the "store the hash, never the token" pattern with constant-time comparison.

{fastapi_multiauth-0.2.0 → fastapi_multiauth-0.4.0}/README.md

@@ -4,6 +4,7 @@ Composable authentication sources for FastAPI: bring your own validator, combine
 
 [![CI](https://github.com/d3vyce/fastapi-multiauth/actions/workflows/ci.yml/badge.svg)](https://github.com/d3vyce/fastapi-multiauth/actions/workflows/ci.yml)
 [![codecov](https://codecov.io/gh/d3vyce/fastapi-multiauth/graph/badge.svg)](https://codecov.io/gh/d3vyce/fastapi-multiauth)
+[![CodSpeed Badge](https://img.shields.io/endpoint?url=https://app.codspeed.io//badge.json)](https://app.codspeed.io//d3vyce/fastapi-multiauth?utm_source=badge)
 [![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)
 [![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
@@ -77,7 +78,7 @@ async def me(user=Security(auth)):
 - **`MultiAuth`**: try several sources in order on a single route (e.g. web session cookie + API bearer token), with all schemes documented in OpenAPI.
 - **Built-in sources**: covering the standard `fastapi.security` schemes:
     - **`HTTPBearerAuth`**: bearer tokens with optional Stripe-style `user_`/`org_` prefixes to route different token types to different validators, plus `generate_token()` for secure token creation.
-    - **`APIKeyCookieAuth`**: cookie sessions with optional HMAC-SHA256 signing (via [itsdangerous](https://itsdangerous.palletsprojects.com/)), embedded expiry, and key rotation.
+    - **`APIKeyCookieAuth`**: cookie sessions with optional HMAC-SHA256 signing (via [itsdangerous](https://itsdangerous.palletsprojects.com/)), embedded expiry, key rotation, and optional per-session ids so your app can list and revoke sessions individually.
     - **`APIKeyHeaderAuth`**: `X-API-Key`-style schemes, with **`APIKeyQueryAuth`** for legacy clients that can only pass a query parameter.
     - **`HTTPBasicAuth`**: `validator(username, password)` with `WWW-Authenticate` realm support.
 - **Token hashing helpers**: `hash_token`/`verify_token_hash` package the "store the hash, never the token" pattern with constant-time comparison.

fastapi_multiauth-0.4.0/pyproject.toml

@@ -0,0 +1,111 @@
+[project]
+name = "fastapi-multiauth"
+version = "0.4.0"
+description = "Composable authentication sources for FastAPI: bring your own validator, combine multiple schemes, correct OpenAPI by construction"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+keywords = [
+    "fastapi",
+    "authentication",
+    "security",
+    "oauth",
+    "api-key",
+    "bearer",
+    "cookie",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Framework :: AsyncIO",
+    "Framework :: FastAPI",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Internet :: WWW/HTTP :: Session",
+    "Topic :: Security",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Software Development :: Libraries",
+    "Typing :: Typed",
+]
+dependencies = [
+    "anyio>=3.7",
+    "async-lru>=2.0",
+    "fastapi>=0.100.0",
+    "httpx>=0.25.0",
+    "itsdangerous>=2.1",
+]
+
+[[project.authors]]
+name = "d3vyce"
+email = "contact@d3vyce.fr"
+
+[project.urls]
+Homepage = "https://github.com/d3vyce/fastapi-multiauth"
+Documentation = "https://fastapi-multiauth.d3vyce.fr/"
+Repository = "https://github.com/d3vyce/fastapi-multiauth"
+Issues = "https://github.com/d3vyce/fastapi-multiauth/issues"
+
+[project.optional-dependencies]
+jwt = ["pyjwt[crypto]>=2.13.0"]
+oauth = ["httpx-oauth>=0.16"]
+
+[dependency-groups]
+dev = [
+    { include-group = "tests" },
+    { include-group = "docs" },
+    "fastapi_multiauth[jwt,oauth]",
+    "prek>=0.3.8",
+    "ruff>=0.1.0",
+    "ty>=0.0.34",
+]
+tests = [
+    "coverage>=7.0.0",
+    "pytest-anyio>=0.0.0",
+    "pytest-codspeed>=5.0",
+    "pytest-cov>=4.0.0",
+    "pytest>=8.0.0",
+    "respx>=0.22",
+]
+docs = [
+    "mkdocstrings-python>=2.0.2",
+    "zensical>=0.0.30",
+]
+
+[build-system]
+requires = ["uv_build>=0.11.21,<0.13.0"]
+build-backend = "uv_build"
+
+[tool.ruff.lint]
+extend-select = ["S"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = [
+    "S",
+    "B008",
+]
+"benchmarks/**" = [
+    "S",
+    "B008",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+anyio_mode = "auto"
+filterwarnings = ["ignore::DeprecationWarning"]
+
+[tool.coverage.run]
+source = ["src/fastapi_multiauth"]
+branch = true
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "if TYPE_CHECKING:",
+    "raise NotImplementedError",
+]

fastapi_multiauth-0.2.0/pyproject.toml → fastapi_multiauth-0.4.0/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "fastapi-multiauth"
-version = "0.2.0"
+version = "0.4.0"
 description = "Composable authentication sources for FastAPI: bring your own validator, combine multiple schemes, correct OpenAPI by construction"
 readme = "README.md"
 license = "MIT"
@@ -62,6 +62,7 @@ dev = [
 tests = [
     "coverage>=7.0.0",
     "pytest-anyio>=0.0.0",
+    "pytest-codspeed>=5.0",
     "pytest-cov>=4.0.0",
     "pytest>=8.0.0",
     "respx>=0.22",
@@ -72,7 +73,7 @@ docs = [
 ]
 
 [build-system]
-requires = ["uv_build>=0.11.21,<0.12.0"]
+requires = ["uv_build>=0.11.21,<0.13.0"]
 build-backend = "uv_build"
 
 [tool.ruff.lint]
@@ -81,6 +82,7 @@ extend-select = ["S"]
 
 [tool.ruff.lint.per-file-ignores]
 "tests/**" = ["S", "B008"]
+"benchmarks/**" = ["S", "B008"]
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]

{fastapi_multiauth-0.2.0 → fastapi_multiauth-0.4.0}/src/fastapi_multiauth/__init__.py

@@ -23,7 +23,7 @@ from .sources import (
 )
 from .utils import hash_token, verify_token_hash
 
-__version__ = "0.2.0"
+__version__ = "0.4.0"
 
 __all__ = [
     "APIKeyCookieAuth",

{fastapi_multiauth-0.2.0 → fastapi_multiauth-0.4.0}/src/fastapi_multiauth/_http.py

@@ -1,5 +1,6 @@
 """Shared HTTP transport hygiene for the OAuth and JWT modules."""
 
+import contextlib
 import json
 from typing import Any
 from urllib.parse import urlsplit
@@ -31,11 +32,16 @@ async def _get_json(
     error_cls: type[Exception],
     description: str,
     headers: dict[str, str] | None = None,
+    client: httpx.AsyncClient | None = None,
 ) -> Any:
     """GET *url* and decode the JSON body, mapping failures to *error_cls*."""
-    async with httpx.AsyncClient(timeout=timeout) as client:
+    async with (
+        contextlib.nullcontext(client)
+        if client is not None
+        else httpx.AsyncClient(timeout=timeout)
+    ) as http:
         try:
-            resp = await client.get(url, headers=headers)
+            resp = await http.get(url, headers=headers)
             resp.raise_for_status()
             return resp.json()
         except httpx.HTTPError as exc:

{fastapi_multiauth-0.2.0 → fastapi_multiauth-0.4.0}/src/fastapi_multiauth/abc.py

@@ -17,23 +17,29 @@ if TYPE_CHECKING:
     from typing_extensions import Self
 
 
-def _reject_scopes_kwarg(kwargs: dict[str, Any]) -> None:
-    """Reject ``scopes`` as a validator kwarg."""
-    if "scopes" in kwargs:
-        raise ValueError(
-            "'scopes' is a reserved validator kwarg: security scopes declared "
-            "on the route via Security(..., scopes=[...]) are injected "
-            "automatically. Use a different keyword name."
-        )
-
-
-def _accepts_scopes(fn: Callable[..., Any]) -> bool:
-    """Return whether *fn* declares a ``scopes`` parameter."""
+_RESERVED_KWARGS = {
+    "scopes": "injected from the route by Security(..., scopes=[...])",
+    "session_id": "injected by APIKeyCookieAuth(session_id=True)",
+}
+
+
+def _reject_reserved_kwargs(kwargs: dict[str, Any]) -> None:
+    """Reject validator kwargs the library injects itself."""
+    for name, injected in _RESERVED_KWARGS.items():
+        if name in kwargs:
+            raise ValueError(
+                f"'{name}' is a reserved validator kwarg ({injected}): "
+                "the library sets it. Use a different keyword name."
+            )
+
+
+def _accepts_kwarg(fn: Callable[..., Any], name: str) -> bool:
+    """Return whether *fn* declares a *name* parameter."""
     try:
         parameters = inspect.signature(fn).parameters
     except (TypeError, ValueError):
         return False
-    param = parameters.get("scopes")
+    param = parameters.get(name)
     return param is not None and param.kind in (
         inspect.Parameter.POSITIONAL_OR_KEYWORD,
         inspect.Parameter.KEYWORD_ONLY,
@@ -51,17 +57,6 @@ def _unenforceable_scopes_error(owner: object, scopes: list[str]) -> RuntimeErro
     )
 
 
-def _scope_kwargs(
-    owner: object, accepts_scopes: bool, scopes: list[str]
-) -> dict[str, Any]:
-    """Return the ``scopes`` kwarg for a validator, failing closed when unsupported."""
-    if accepts_scopes:
-        return {"scopes": scopes}
-    if scopes:
-        raise _unenforceable_scopes_error(owner, scopes)
-    return {}
-
-
 class _DocOnlyScheme(SecurityBase):
     """Inert stand-in for a ``fastapi.security`` scheme.
 
@@ -193,18 +188,24 @@ class ValidatedAuthSource(AuthSource):
             validator: Sync or async callable returning the identity.
             scheme: Optional ``fastapi.security`` scheme for OpenAPI.
             **kwargs: Extra keyword arguments forwarded to the validator on
-                every call. ``scopes`` is reserved (injected from the route).
+                every call. Names the library injects itself are reserved:
+                ``scopes`` and ``session_id``.
         """
-        _reject_scopes_kwarg(kwargs)
+        _reject_reserved_kwargs(kwargs)
         self._validator = ensure_async(validator)
-        self._accepts_scopes = _accepts_scopes(validator)
+        self._accepts_scopes = _accepts_kwarg(validator, "scopes")
         self._kwargs = kwargs
         super().__init__(scheme)
 
-    async def _call_validator(self, *args: Any, scopes: list[str]) -> Any:
+    async def _call_validator(
+        self, *args: Any, scopes: list[str], **injected: Any
+    ) -> Any:
         """Invoke the validator with scope and configured kwargs forwarding."""
-        extra = _scope_kwargs(self, self._accepts_scopes, scopes)
-        return await self._validator(*args, **extra, **self._kwargs)
+        if self._accepts_scopes:
+            injected["scopes"] = scopes
+        elif scopes:  # fail closed: the validator cannot check them
+            raise _unenforceable_scopes_error(self, scopes)
+        return await self._validator(*args, **self._kwargs, **injected)
 
     async def authenticate(self, credential: str) -> Any:
         """Validate a credential and return the identity (no route scopes)."""
@@ -215,8 +216,11 @@ class ValidatedAuthSource(AuthSource):
         return await self._call_validator(credential, scopes=scopes)
 
     def require(self, **kwargs: Any) -> "Self":
-        """Return a copy of this source with additional (or overriding) validator kwargs."""
-        _reject_scopes_kwarg(kwargs)
+        """Return a copy of this source with additional (or overriding) validator kwargs.
+
+        Reserved names (``scopes``, ``session_id``) are rejected here too.
+        """
+        _reject_reserved_kwargs(kwargs)
         clone = copy.copy(self)
         clone._kwargs = {**self._kwargs, **kwargs}
         return clone

{fastapi_multiauth-0.2.0 → fastapi_multiauth-0.4.0}/src/fastapi_multiauth/jwt.py

@@ -149,7 +149,7 @@ class JWTValidator:
                 leeway=self._leeway,
                 options=self._decode_options,
             )
-        except self._jwt.InvalidTokenError:
+        except (self._jwt.exceptions.PyJWTError, TypeError, ValueError):
             raise UnauthorizedError() from None
         if scopes:
             missing = set(scopes) - self._granted_scopes(claims)

{fastapi_multiauth-0.2.0 → fastapi_multiauth-0.4.0}/src/fastapi_multiauth/oauth/client.py

@@ -1,5 +1,6 @@
 """OAuth 2.0 / OIDC network operations: discovery, code exchange, userinfo."""
 
+import contextlib
 import functools
 from typing import Any, Literal, NamedTuple
 
@@ -74,6 +75,7 @@ def _oauth2_client_class() -> type:
             access_token_endpoint: str,
             timeout: float,
             token_endpoint_auth_method: TokenEndpointAuthMethod,
+            client: httpx.AsyncClient | None,
         ) -> None:
             super().__init__(
                 client_id,
@@ -85,8 +87,13 @@ def _oauth2_client_class() -> type:
                 token_endpoint_auth_method=token_endpoint_auth_method,
             )
             self._timeout = timeout
+            self._client = client
 
-        def get_httpx_client(self) -> httpx.AsyncClient:
+        def get_httpx_client(self) -> Any:
+            # httpx-oauth only uses the return value as an async context
+            # manager, so a borrowed client is wrapped to survive the exit.
+            if self._client is not None:
+                return contextlib.nullcontext(self._client)
             return httpx.AsyncClient(timeout=self._timeout)
 
     return _TimeoutOAuth2
@@ -159,6 +166,7 @@ async def oauth_exchange_code(
     code_verifier: str | None = None,
     token_endpoint_auth_method: TokenEndpointAuthMethod = "client_secret_post",  # noqa: S107 — method name, not a secret
     timeout: float = DEFAULT_TIMEOUT,
+    client: httpx.AsyncClient | None = None,
 ) -> dict[str, Any]:
     """Exchange an authorization code for tokens and return the token response.
 
@@ -176,7 +184,11 @@ async def oauth_exchange_code(
             (from :func:`~fastapi_multiauth.oauth.oauth_generate_pkce_pair`).
         token_endpoint_auth_method: How credentials are sent — in the POST body
             (``client_secret_post``, default) or as a Basic header.
-        timeout: Timeout in seconds for the token request.
+        timeout: Timeout in seconds for the token request. Ignored when
+            *client* is provided.
+        client: Optional ``httpx.AsyncClient`` to reuse (connection pooling
+            across the login flow). Borrowed, not closed; its own configuration
+            (timeouts included) governs the request.
 
     Returns:
         The full token response as a ``dict`` (``access_token`` plus whatever
@@ -190,7 +202,7 @@ async def oauth_exchange_code(
     _require_https(token_url, "OAuth token_url")
 
     oauth_client = _oauth2_client_class()(
-        client_id, client_secret, token_url, timeout, token_endpoint_auth_method
+        client_id, client_secret, token_url, timeout, token_endpoint_auth_method, client
     )
     try:
         token_data = await oauth_client.get_access_token(
@@ -221,13 +233,18 @@ async def oauth_fetch_userinfo(
     userinfo_url: str,
     access_token: str,
     timeout: float = DEFAULT_TIMEOUT,
+    client: httpx.AsyncClient | None = None,
 ) -> dict[str, Any]:
     """Fetch the userinfo payload with a bearer access token.
 
     Args:
         userinfo_url: Provider's userinfo endpoint.
         access_token: Access token from :func:`oauth_exchange_code`.
-        timeout: Timeout in seconds for the userinfo request.
+        timeout: Timeout in seconds for the userinfo request. Ignored when
+            *client* is provided.
+        client: Optional ``httpx.AsyncClient`` to reuse (connection pooling
+            across the login flow). Borrowed, not closed; its own configuration
+            (timeouts included) governs the request.
 
     Returns:
         The JSON payload returned by the userinfo endpoint as a plain ``dict``.
@@ -243,4 +260,5 @@ async def oauth_fetch_userinfo(
         error_cls=OAuthUserinfoError,
         description="userinfo",
         headers={"Authorization": f"Bearer {access_token}"},
+        client=client,
     )

{fastapi_multiauth-0.2.0 → fastapi_multiauth-0.4.0}/src/fastapi_multiauth/sources/cookie.py

@@ -1,6 +1,7 @@
 """Cookie-based authentication source."""
 
 import hashlib
+import secrets
 from collections.abc import Callable, Sequence
 from typing import Any, Literal
 
@@ -10,7 +11,7 @@ from itsdangerous import BadSignature, TimestampSigner
 
 from fastapi_multiauth.exceptions import UnauthorizedError
 
-from ..abc import ValidatedAuthSource
+from ..abc import ValidatedAuthSource, _accepts_kwarg
 
 _MIN_SECRET_KEY_BYTES = 32
 _SALT_PREFIX = "fastapi-multiauth.cookie."
@@ -48,6 +49,10 @@ class APIKeyCookieAuth(ValidatedAuthSource):
             after signature verification when signed) and returning the identity.
         secret_key: One key or a sequence to rotate (first signs, all verify);
             each at least 32 bytes. When ``None``, the cookie is not signed.
+        session_id: Mint a random id per :meth:`set_cookie` and inject it into
+            the validator as ``session_id``. Requires ``secret_key`` and a
+            validator declaring that parameter; changing it invalidates
+            existing cookies.
         ttl: Cookie lifetime in seconds (default 24 h); also enforced
             server-side when the cookie is signed.
         secure: Set the ``Secure`` flag (default ``True``); disable only in local dev.
@@ -64,6 +69,7 @@ class APIKeyCookieAuth(ValidatedAuthSource):
         validator: Callable[..., Any],
         *,
         secret_key: str | Sequence[str] | None = None,
+        session_id: bool = False,
         ttl: int = 86400,
         secure: bool = True,
         samesite: SameSite = "lax",
@@ -76,12 +82,25 @@ class APIKeyCookieAuth(ValidatedAuthSource):
             raise ValueError("ttl must be a positive number of seconds")
         self._name = name
         self._secret_keys = _normalize_secret_keys(secret_key)
+        if session_id:
+            if not self._secret_keys:
+                raise ValueError(
+                    "session_id requires secret_key: without a signature the "
+                    "client could forge or swap the session id"
+                )
+            if not _accepts_kwarg(validator, "session_id"):
+                raise ValueError(
+                    "session_id requires a validator declaring a 'session_id' "
+                    "parameter: the minted id is injected on every call"
+                )
+        self._session_id = session_id
         # itsdangerous verifies against every key in the list but signs with
         # the last one — reverse so the first configured key is the signer.
+        # The salt also separates the two payload layouts.
         self._signer = (
             TimestampSigner(
                 list(reversed(self._secret_keys)),
-                salt=f"{_SALT_PREFIX}{name}",
+                salt=f"{_SALT_PREFIX}{name}{'.sid' if session_id else ''}",
                 digest_method=hashlib.sha256,
             )
             if self._secret_keys
@@ -118,17 +137,53 @@ class APIKeyCookieAuth(ValidatedAuthSource):
         except BadSignature:
             raise UnauthorizedError() from None
 
+    @property
+    def name(self) -> str:
+        """Cookie name. Read-only: the signing salt is derived from it."""
+        return self._name
+
+    @property
+    def ttl(self) -> int:
+        """Cookie lifetime in seconds: use it to derive your session's expiry."""
+        return self._ttl
+
     async def extract(self, request: Request) -> str | None:
         """Return the raw cookie value, or ``None`` when absent or empty."""
         return request.cookies.get(self._name) or None
 
+    def session_id_of(self, request: Request) -> str | None:
+        """Return *request*'s session id without running the validator.
+
+        ``None`` when ``session_id`` is off, or the cookie is absent, expired
+        or forged.
+        """
+        if not self._session_id:
+            return None
+        cookie_value = request.cookies.get(self._name)
+        if not cookie_value:
+            return None
+        try:
+            return self._verify(cookie_value).partition(".")[0]
+        except UnauthorizedError:
+            return None
+
     async def authenticate_scoped(self, credential: str, scopes: list[str]) -> Any:
         """Verify the cookie, forwarding route-declared scopes to the validator."""
         plain = self._verify(credential)
-        return await self._call_validator(plain, scopes=scopes)
-
-    def set_cookie(self, response: Response, value: str) -> None:
-        """Attach the cookie to *response*, signing it when ``secret_key`` is set."""
+        if not self._session_id:
+            return await self._call_validator(plain, scopes=scopes)
+        sid, _, value = plain.partition(".")
+        return await self._call_validator(value, scopes=scopes, session_id=sid)
+
+    def set_cookie(self, response: Response, value: str) -> str | None:
+        """Attach the cookie to *response*, signing it when ``secret_key`` is set.
+
+        Returns the minted session id: always a ``str`` when ``session_id`` is
+        on, always ``None`` when it is off.
+        """
+        sid = secrets.token_urlsafe(16) if self._session_id else None
+        if sid is not None:
+            value = f"{sid}.{value}"
         cookie_value = self._sign(value) if self._signer else value
         response.set_cookie(
             self._name,
@@ -140,9 +195,16 @@ class APIKeyCookieAuth(ValidatedAuthSource):
             domain=self._domain,
             path=self._path,
         )
+        return sid
+
+    def delete_cookie(
+        self, response: Response, request: Request | None = None
+    ) -> str | None:
+        """Clear the session cookie (logout) from this client only.
 
-    def delete_cookie(self, response: Response) -> None:
-        """Clear the session cookie (logout) from this client only."""
+        Returns *request*'s session id when it verifies (revoke it server-side
+        for a hard logout), ``None`` otherwise.
+        """
         response.delete_cookie(
             self._name,
             httponly=True,
@@ -151,3 +213,4 @@ class APIKeyCookieAuth(ValidatedAuthSource):
             domain=self._domain,
             path=self._path,
         )
+        return self.session_id_of(request) if request is not None else None