Coverage for fastapi / security / open_id_connect_url.py: 100%
21 statements
« prev ^ index » next coverage.py v7.13.3, created at 2026-02-12 18:15 +0000
1from typing import Annotated 1abcd
3from annotated_doc import Doc 1abcd
4from fastapi.openapi.models import OpenIdConnect as OpenIdConnectModel 1abcd
5from fastapi.security.base import SecurityBase 1abcd
6from starlette.exceptions import HTTPException 1abcd
7from starlette.requests import Request 1abcd
8from starlette.status import HTTP_401_UNAUTHORIZED 1abcd
11class OpenIdConnect(SecurityBase): 1abcd
12 """
13 OpenID Connect authentication class. An instance of it would be used as a
14 dependency.
16 **Warning**: this is only a stub to connect the components with OpenAPI in FastAPI,
17 but it doesn't implement the full OpenIdConnect scheme, for example, it doesn't use
18 the OpenIDConnect URL. You would need to to subclass it and implement it in your
19 code.
20 """
22 def __init__( 1abcd
23 self,
24 *,
25 openIdConnectUrl: Annotated[
26 str,
27 Doc(
28 """
29 The OpenID Connect URL.
30 """
31 ),
32 ],
33 scheme_name: Annotated[
34 str | None,
35 Doc(
36 """
37 Security scheme name.
39 It will be included in the generated OpenAPI (e.g. visible at `/docs`).
40 """
41 ),
42 ] = None,
43 description: Annotated[
44 str | None,
45 Doc(
46 """
47 Security scheme description.
49 It will be included in the generated OpenAPI (e.g. visible at `/docs`).
50 """
51 ),
52 ] = None,
53 auto_error: Annotated[
54 bool,
55 Doc(
56 """
57 By default, if no HTTP Authorization header is provided, required for
58 OpenID Connect authentication, it will automatically cancel the request
59 and send the client an error.
61 If `auto_error` is set to `False`, when the HTTP Authorization header
62 is not available, instead of erroring out, the dependency result will
63 be `None`.
65 This is useful when you want to have optional authentication.
67 It is also useful when you want to have authentication that can be
68 provided in one of multiple optional ways (for example, with OpenID
69 Connect or in a cookie).
70 """
71 ),
72 ] = True,
73 ):
74 self.model = OpenIdConnectModel( 1abcd
75 openIdConnectUrl=openIdConnectUrl, description=description
76 )
77 self.scheme_name = scheme_name or self.__class__.__name__ 1abcd
78 self.auto_error = auto_error 1abcd
80 def make_not_authenticated_error(self) -> HTTPException: 1abcd
81 return HTTPException( 1efghij
82 status_code=HTTP_401_UNAUTHORIZED,
83 detail="Not authenticated",
84 headers={"WWW-Authenticate": "Bearer"},
85 )
87 async def __call__(self, request: Request) -> str | None: 1abcd
88 authorization = request.headers.get("Authorization") 1neopfqrkstguvhwxlyziABjCDmE
89 if not authorization: 1neopfqrkstguvhwxlyziABjCDmE
90 if self.auto_error: 1efkghlijm
91 raise self.make_not_authenticated_error() 1efghij
92 else:
93 return None 1klm
94 return authorization 1nopqrstuvwxyzABCDE