import secrets from os import environ from typing import Any, Dict, Optional from uuid import UUID from pydantic import BaseModel, EmailStr from litestar import Litestar, Request, Response, get, post from litestar.connection import ASGIConnection from litestar.openapi.config import OpenAPIConfig from litestar.security.jwt import OAuth2Login, OAuth2PasswordBearerAuth, Token # Let's assume we have a User model that is a pydantic model. # This though is not required - we need some sort of user class - # but it can be any arbitrary value, e.g. an SQLAlchemy model, a representation of a MongoDB etc. class User(BaseModel): id: UUID name: str email: EmailStr MOCK_DB: Dict[str, User] = {} # OAuth2PasswordBearerAuth requires a retrieve handler callable that receives the JWT token model and the ASGI connection # and returns the 'User' instance correlating to it. # # Notes: # - 'User' can be any arbitrary value you decide upon. # - The callable can be either sync or async - both will work. async def retrieve_user_handler(token: "Token", connection: "ASGIConnection[Any, Any, Any, Any]") -> Optional[User]: # logic here to retrieve the user instance return MOCK_DB.get(token.sub) oauth2_auth = OAuth2PasswordBearerAuth[User]( retrieve_user_handler=retrieve_user_handler, token_secret=environ.get("JWT_SECRET", secrets.token_hex()), # we are specifying the URL for retrieving a JWT access token token_url="/login", # we are specifying which endpoints should be excluded from authentication. In this case the login endpoint # and our openAPI docs. exclude=["/login", "/schema"], ) # Given an instance of 'OAuth2PasswordBearerAuth' we can create a login handler function: @post("/login") async def login_handler(request: "Request[Any, Any, Any]", data: "User") -> "Response[OAuth2Login]": MOCK_DB[str(data.id)] = data # if we do not define a response body, the login process will return a standard OAuth2 login response. Note the `Response[OAuth2Login]` return type. # you can do whatever you want to update the response instance here # e.g. response.set_cookie(...) return oauth2_auth.login(identifier=str(data.id)) @post("/login_custom") async def login_custom_response_handler(data: "User") -> "Response[User]": MOCK_DB[str(data.id)] = data # you can do whatever you want to update the response instance here # e.g. response.set_cookie(...) return oauth2_auth.login(identifier=str(data.id), response_body=data) # We also have some other routes, for example: @get("/some-path", sync_to_thread=False) def some_route_handler(request: "Request[User, Token, Any]") -> Any: # request.user is set to the instance of user returned by the middleware assert isinstance(request.user, User) # request.auth is the instance of 'litestar_jwt.Token' created from the data encoded in the auth header assert isinstance(request.auth, Token) # do stuff ... # We create our OpenAPIConfig as usual - the JWT security scheme will be injected into it. openapi_config = OpenAPIConfig( title="My API", version="1.0.0", ) # We initialize the app instance and pass the oauth2_auth 'on_app_init' handler to the constructor. # The hook handler will inject the JWT middleware and openapi configuration into the app. app = Litestar( route_handlers=[login_handler, some_route_handler], on_app_init=[oauth2_auth.on_app_init], openapi_config=openapi_config, )