Auto-activate for advanced_alchemy, alembic/, SQLAlchemyAsyncRepositoryService, SQLAlchemyAsyncConfig, repository_type, service_class, filters, or storage. Not for raw SQLAlchemy — use sqlspec.
中文简介正在准备中。当前显示原文说明。
Auto-activate for litestar_security, SecurityPlugin, SecurityConfig, SecureController, CurrentUser, Principal, SecurityContext, or requires_role/scope/tenant/capability/assurance. Not for basic Litestar Guards.
中文简介正在准备中。当前显示原文说明。
查看安装方法安装前可以查看交给 AI 代理的指令内容。
litestar-security 0.6.0 is a declarative authentication and authorization framework for Litestar. It provides credential slots and mechanisms, unified session management, local accounts, MFA, WebAuthn passkeys, OAuth/OIDC, API keys, workload JWTs, and browser hardening.
Two separate axes, wired through two separate Litestar keywords:
auth= (or opt={"auth": ...}).guards=[...].Do not conflate them: the policy helpers (public, required, any_of, all_of, at_least, optional, exclude, mechanism) take mechanism names, while the guard combinators (requires_any_of, requires_all_of, requires_at_least, requires_one_of) take predicates.
SecureController, PublicController, or auth=. Subclass SecureController (auth: ClassVar[AuthenticationPolicy] = required(...)) or PublicController for controllers, pass auth= on individual routes, and use opt={"auth": ...} on routers or third-party controllers. The nearest native owner wins. When a public controller needs native Litestar CSRF on cookie-session POST routes, subclass SecureController with auth: ClassVar[AuthenticationPolicy] = exclude() and set opt={"exclude_from_csrf": False} on the POST handlers (or set opt={"csrf_required": True} on individual handlers) because public() sets exclude_from_csrf=True and rejects opt={"exclude_from_csrf": False}.guards=[...]. Litestar's security= parameter is reserved for the OpenAPI requirements projected from auth.scheme_name and security_scheme on custom mechanisms. Every AuthenticationMechanism in SecurityConfig(mechanisms=(...,)) must set both scheme_name and security_scheme=SecurityScheme(...) when OpenAPI is enabled, or startup fails with ImproperlyConfiguredException.CurrentUser[T]. Annotate current_user: CurrentUser[UserType] (already a NamedDependency[UserType] alias); it rejects anonymous and userless service principals. principal and security_context stay typed on public routes too via NamedDependency.AuthorizationSnapshot produced by the configured authorization_resolver. Never query the database inside a guard.requires_*. Use requires_any_of, requires_all_of, requires_at_least, requires_one_of for predicate composition..well-known. Static assets and dashboards carry no auth and compile to implicit required(), so they answer 401 until listed in SecurityConfig(exclude=[...]). Litestar's OpenAPI routes (/schema, /docs) and ProtectedResourceConfig / LocalJWKSConfig routes are already public() — do not add them to exclude. Inspect routes with litestar security routes.WebSocketConnectTokenService or WebSocketConnectTokenIssuer.from litestar import Litestar, get
from litestar.di import NamedDependency
from litestar_security import (
SecurityConfig,
SecurityContext,
SecurityPlugin,
public,
)
@get("/", auth=public(), sync_to_thread=False)
def index(security_context: NamedDependency[SecurityContext]) -> dict[str, bool]:
return {"authenticated": bool(security_context.evidence)}
app = Litestar(
route_handlers=[index],
plugins=[SecurityPlugin(SecurityConfig())],
)
With mechanisms configured and no inherited policy, routes default to implicit required(). With no mechanisms at all they are public.
from typing import ClassVar
from litestar import get
from litestar_security import (
AuthenticationPolicy,
PublicController,
SecureController,
all_of,
any_of,
at_least,
public,
required,
)
policy_default = required()
policy_session = required("session")
policy_either = any_of("session", "api-key")
policy_both = all_of("api-key", "service-jwt")
policy_threshold = at_least(2, "session", "api-key", "service-jwt")
policy_public = public()
Apply policy on controllers via SecureController / PublicController and on routes via auth=:
class HealthController(PublicController):
path = "/health"
@get("/")
async def check(self) -> dict[str, str]:
return {"status": "ok"}
class AccountController(SecureController):
path = "/accounts"
auth: ClassVar[AuthenticationPolicy] = required("session")
Use opt={"auth": ...} only on Router, Litestar, or third-party controllers that cannot subclass SecureController.
from typing import ClassVar
from litestar import get
from litestar_security import (
AuthenticationPolicy,
SecureController,
required,
requires_any_of,
requires_role,
requires_scope,
)
class ReportsController(SecureController):
path = "/reports"
auth: ClassVar[AuthenticationPolicy] = required("session")
guards = [requires_role("analyst")]
@get("/", guards=[requires_any_of(requires_scope("read:all"), requires_scope("read:reports"))])
async def list_reports(self) -> list[dict[str, str]]:
return []
The plugin registers these; do not shadow them.
| Key | Type | Use |
|---|---|---|
principal | NamedDependency[Principal[User]] | Stable envelope identity plus the active user model |
security_context | NamedDependency[SecurityContext] | Active session, evidence, snapshot, and restrictions |
current_user | CurrentUser[User] | Narrowing shortcut (NamedDependency[User]); rejects anonymous and service principals |
csp_nonce | csp_nonce (NamedDependency[str]) | Per-request CSP nonce when ContentSecurityPolicy.nonce_directives is non-empty |
websocket_connect_tokens | NamedDependency[WebSocketConnectTokenIssuer] | Route-aware WebSocket connect-token issuer |
| Outcome | Status |
|---|---|
| Authentication failure | 401 |
| Guard denial | 403 |
| Verification unavailable (fails closed) | 503 |
Core install covers JWT/JWKS validation, API keys, IAP, and OIDC token verification. Use [argon2,mfa] for LocalAuth; add [passkeys] or [oauth] only when needed, or use [all].
Pick where identity is established — local accounts, OAuth/OIDC, Google IAP, API keys, or workload JWTs. Adding a provider makes its mechanism available; route policy decides where it is accepted. See Providers.
Implement an async resolve(principal) method that returns an AuthorizationSnapshot of granted roles, scopes, capabilities, tenant roles, and tenant IDs. Return InvalidCredentials or VerificationUnavailable for expected denial or dependency failure. It runs once per request, so guards must not perform I/O.
from litestar_security import AuthorizationSnapshot, Principal
class AppAuthorizationResolver:
async def resolve(self, principal: Principal[User]) -> AuthorizationSnapshot:
if not principal.is_authenticated:
return AuthorizationSnapshot()
user = principal.require_user()
return AuthorizationSnapshot(
roles=frozenset(user.roles),
scopes=frozenset(user.scopes),
)
Scope an application-wide opt={"auth": ...} default to the router that owns the application's own routes, so policy-less third-party routes keep the implicit default rather than counting as declared.
Add SecurityConfig(exclude=[...]) patterns for static files, queue dashboards, and schema browsers. See Composition.
Apply SecurityHeadersConfig.hardened(), supply every CSP directive explicitly, and move protector keys and peppers into secret management. See Hardening.
any_of / all_of / at_least. Those compose authentication mechanisms. Use requires_any_of, requires_all_of, requires_at_least, or requires_one_of for predicates.principal, security_context, current_user, csp_nonce, or websocket_connect_tokens.authorization_resolver.guards= for authentication or auth= for authorization. They compile to different things — runtime admission plus OpenAPI projection versus permission checks.opt={"exclude_from_csrf": False} on PublicController (auth = public()) routes. public() sets exclude_from_csrf=True and RouteCompiler._validate_csrf_metadata raises ImproperlyConfiguredException: Native CSRF exclusions must be exactly True. For a public controller whose cookie-session POST routes require native Litestar CSRF, set auth: ClassVar[AuthenticationPolicy] = exclude() on a SecureController subclass and opt={"exclude_from_csrf": False} on the POST handlers (or set opt={"csrf_required": True} on individual HTTP handlers).scheme_name and security_scheme on custom AuthenticationMechanism instances. When OpenAPI is enabled, OpenAPISchemeSet.from_registry() raises ImproperlyConfiguredException: Authentication mechanism <name> has no native OpenAPI security scheme./docs, /schema, or /.well-known to SecurityConfig.exclude. A route that both declares auth and matches an exclusion pattern is rejected at startup, and OpenAPI routes are already auto-detected as public().MFAConfig(require_at_login=True) before enrolling factors. Unenrolled accounts lock themselves out; use require_at_login="enrolled" to enforce login MFA only for accounts that have enrolled a factor.SecurityPlugin is registered in application plugins.auth= or inherited opt={"auth": ...}.guards=[...] with predicates, never the mechanism combinators.authorization_resolver implements async resolve() and returns an AuthorizationSnapshot, InvalidCredentials, or VerificationUnavailable.current_user: CurrentUser[UserType] (or NamedDependency[Principal[UserType]] / NamedDependency[SecurityContext]).401, 403, and 503 outcomes.from dataclasses import dataclass, field
from typing import ClassVar
from litestar import Litestar, get
from litestar_security import (
AuthenticationPolicy,
AuthorizationSnapshot,
CurrentUser,
Principal,
PublicController,
SecureController,
SecurityConfig,
SecurityHeadersConfig,
SecurityPlugin,
required,
requires_any_of,
requires_role,
requires_scope,
)
@dataclass
class User:
id: str
username: str
roles: list[str] = field(default_factory=list)
scopes: list[str] = field(default_factory=list)
class AppAuthorizationResolver:
async def resolve(self, principal: Principal[User]) -> AuthorizationSnapshot:
if not principal.is_authenticated:
return AuthorizationSnapshot()
user = principal.require_user()
return AuthorizationSnapshot(
roles=frozenset(user.roles),
scopes=frozenset(user.scopes),
)
class SystemController(PublicController):
path = "/health"
@get("/")
async def health(self) -> dict[str, str]:
return {"status": "ok"}
class OrdersController(SecureController):
path = "/api/orders"
auth: ClassVar[AuthenticationPolicy] = required("session")
@get(
"/",
guards=[requires_any_of(requires_scope("read:all"), requires_scope("read:orders"))],
)
async def list_orders(self, current_user: CurrentUser[User]) -> dict[str, str]:
return {"owner": current_user.username}
@get("/admin", guards=[requires_role("admin")])
async def admin_orders(self) -> list[dict[str, str]]:
return []
security_config = SecurityConfig[User](
authorization_resolver=AppAuthorizationResolver(),
headers=SecurityHeadersConfig.hardened(),
exclude=["^/static"],
)
app = Litestar(
route_handlers=[SystemController, OrdersController],
plugins=[SecurityPlugin(config=security_config)],
)
</example>
401 / 403 / 503 to Problem Details responses.还没有评价。欢迎分享你的使用感受。
无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。
还没有评论。来写第一条吧。
Auto-activate for advanced_alchemy, alembic/, SQLAlchemyAsyncRepositoryService, SQLAlchemyAsyncConfig, repository_type, service_class, filters, or storage. Not for raw SQLAlchemy — use sqlspec.
中文简介正在准备中。当前显示原文说明。
Auto-activate for Litestar, Controller, Router, @get/@post, FromPath, MsgspecDTO, OpenAPIConfig, Provide, FromDishka, Guard, ASGIMiddleware, HTTPException, ChannelsPlugin, or WebSocket. Not for standalone libs.
中文简介正在准备中。当前显示原文说明。
Auto-activate for Google ADK, LlmAgent, Runner, SQLSpecSessionService, google-genai, AgentRuntime, AgentGroup, SpecTree, DynamicWorkflow, FunctionTool, or SSE agent chats. Not for offline ML training.
中文简介正在准备中。当前显示原文说明。
Auto-activate for litestar_autowire, AutowirePlugin, AutowireConfig, domain_packages, AutowireIntegration, AutowireLoader, or clear_autowire_cache. Not for manual Router composition — use explicit routes.
中文简介正在准备中。当前显示原文说明。
Auto-activate for uv build, hatch build, PyApp, PYAPP_*, wheel assets, GitHub release matrices, cargo-zigbuild, or python-build-standalone. Not for runtime deployment.
中文简介正在准备中。当前显示原文说明。
Auto-activate for Dockerfile, compose, Railway, Cloud Run, GKE, systemd, Kubernetes, Terraform, deploy scripts, or granian/litestar run at runtime. Not for packaging artifacts.
中文简介正在准备中。当前显示原文说明。