Skip to content

Make audiences nullable in Oauth2JwtAccessTokenValidator #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Make audiences nullable in Oauth2JwtAccessTokenValidator #8

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
46420fc
Make audiences nullable
irdkwmnsb Oct 1, 2022
997937c
Also allow for other options
irdkwmnsb Oct 1, 2022
999ce58
Document the option
irdkwmnsb Oct 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions fastapi_security/oauth2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,10 @@ def __init__(self):
def init(
self,
jwks_url: str,
audiences: Iterable[str],
audiences: Optional[Union[str, Iterable[str]]],
*,
jwks_cache_period: int = DEFAULT_JWKS_RESPONSE_CACHE_PERIOD,
decode_options: dict = None
):
"""Set up Oauth 2.0 JWT validation

Expand All @@ -52,9 +53,11 @@ def init(
The JWKS endpoint to fetch the public keys from. Usually in the
format: "https://domain/.well-known/jwks.json"
audiences:
Accepted `aud` values for incoming access tokens
Accepted `aud` values for incoming access tokens. Could be a list of string, a string or None.
jwks_cache_period:
How many seconds to cache the JWKS response. Defaults to 1 hour.
decode_options:
Other options for PyJWT's decode function.
"""
if aiohttp is None:
raise MissingDependency(
Expand All @@ -66,7 +69,8 @@ def init(
)
self._jwks_url = jwks_url
self._jwks_cache_period = float(jwks_cache_period)
self._audiences = list(audiences)
self._audiences = audiences
self._decode_options = decode_options

def is_configured(self) -> bool:
return bool(self._jwks_url)
Expand Down Expand Up @@ -161,4 +165,4 @@ def _decode_jwt_token(
self, public_key: _RSAPublicKey, access_token: str
) -> Dict[str, Any]:
# NOTE: jwt.decode has erroneously set key: str
return jwt.decode(access_token, key=public_key, audience=self._audiences, algorithms=["RS256"]) # type: ignore
return jwt.decode(access_token, key=public_key, audience=self._audiences, algorithms=["RS256"], **self._decode_options) # type: ignore