mirror of https://github.com/tiangolo/fastapi.git
96 lines
3.1 KiB
Python
96 lines
3.1 KiB
Python
from typing import Optional
|
|
|
|
from annotated_doc import Doc
|
|
from fastapi.openapi.models import OpenIdConnect as OpenIdConnectModel
|
|
from fastapi.security.base import SecurityBase
|
|
from starlette.exceptions import HTTPException
|
|
from starlette.requests import HTTPConnection
|
|
from starlette.status import HTTP_401_UNAUTHORIZED
|
|
from typing_extensions import Annotated
|
|
|
|
|
|
class OpenIdConnect(SecurityBase):
|
|
"""
|
|
OpenID Connect authentication class. An instance of it would be used as a
|
|
dependency.
|
|
|
|
**Warning**: this is only a stub to connect the components with OpenAPI in FastAPI,
|
|
but it doesn't implement the full OpenIdConnect scheme, for example, it doesn't use
|
|
the OpenIDConnect URL. You would need to to subclass it and implement it in your
|
|
code.
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
*,
|
|
openIdConnectUrl: Annotated[
|
|
str,
|
|
Doc(
|
|
"""
|
|
The OpenID Connect URL.
|
|
"""
|
|
),
|
|
],
|
|
scheme_name: Annotated[
|
|
Optional[str],
|
|
Doc(
|
|
"""
|
|
Security scheme name.
|
|
|
|
It will be included in the generated OpenAPI (e.g. visible at `/docs`).
|
|
"""
|
|
),
|
|
] = None,
|
|
description: Annotated[
|
|
Optional[str],
|
|
Doc(
|
|
"""
|
|
Security scheme description.
|
|
|
|
It will be included in the generated OpenAPI (e.g. visible at `/docs`).
|
|
"""
|
|
),
|
|
] = None,
|
|
auto_error: Annotated[
|
|
bool,
|
|
Doc(
|
|
"""
|
|
By default, if no HTTP Authorization header is provided, required for
|
|
OpenID Connect authentication, it will automatically cancel the request
|
|
and send the client an error.
|
|
|
|
If `auto_error` is set to `False`, when the HTTP Authorization header
|
|
is not available, instead of erroring out, the dependency result will
|
|
be `None`.
|
|
|
|
This is useful when you want to have optional authentication.
|
|
|
|
It is also useful when you want to have authentication that can be
|
|
provided in one of multiple optional ways (for example, with OpenID
|
|
Connect or in a cookie).
|
|
"""
|
|
),
|
|
] = True,
|
|
):
|
|
self.model = OpenIdConnectModel(
|
|
openIdConnectUrl=openIdConnectUrl, description=description
|
|
)
|
|
self.scheme_name = scheme_name or self.__class__.__name__
|
|
self.auto_error = auto_error
|
|
|
|
def make_not_authenticated_error(self) -> HTTPException:
|
|
return HTTPException(
|
|
status_code=HTTP_401_UNAUTHORIZED,
|
|
detail="Not authenticated",
|
|
headers={"WWW-Authenticate": "Bearer"},
|
|
)
|
|
|
|
async def __call__(self, request: HTTPConnection) -> Optional[str]:
|
|
authorization = request.headers.get("Authorization")
|
|
if not authorization:
|
|
if self.auto_error:
|
|
raise self.make_not_authenticated_error()
|
|
else:
|
|
return None
|
|
return authorization
|