Skip to content

Add leeway config for PyJWT's jwt.decode function #580

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
yaourtv wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add leeway config for PyJWT's jwt.decode function #580

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions docs/settings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,12 @@ of ``mozilla-django-oidc``.

Controls whether the OpenID Connect client verifies the signature of the JWT tokens

.. py:attribute:: OIDC_JWT_LEEWAY

:default: ``0``

A time margin in seconds for the expiration check.

.. py:attribute:: OIDC_VERIFY_KID

:default: ``True``
Expand Down
13 changes: 11 additions & 2 deletions mozilla_django_oidc/auth.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ def __init__(self, *args, **kwargs):
self.OIDC_RP_CLIENT_SECRET = self.get_settings("OIDC_RP_CLIENT_SECRET")
self.OIDC_RP_SIGN_ALGO = self.get_settings("OIDC_RP_SIGN_ALGO", "HS256")
self.OIDC_RP_IDP_SIGN_KEY = self.get_settings("OIDC_RP_IDP_SIGN_KEY", None)
self.OIDC_JWT_LEEWAY = self.get_settings("OIDC_JWT_LEEWAY", 0)

if (
self.OIDC_RP_SIGN_ALGO.startswith("RS")
Expand Down Expand Up @@ -142,7 +143,11 @@ def _verify_jws(self, payload, key):
try:
# Maybe add a settings to enforce audiance validation
return jwt.decode(
payload, key, algorithms=alg, options={"verify_aud": False}
payload,
key,
algorithms=alg,
leeway=self.OIDC_JWT_LEEWAY,
options={"verify_aud": False},
)
except jwt.DecodeError:
msg = "JWS token verification failed."
Expand Down Expand Up @@ -186,7 +191,11 @@ def get_payload_data(self, token, key):

# If config allows unsecured JWTs check the header and return the decoded payload
if "alg" in header and header["alg"] == "none":
return jwt.decode(token, options={"verify_signature": False})
return jwt.decode(
token,
leeway=self.OIDC_JWT_LEEWAY,
options={"verify_signature": False},
)

# By default fallback to verify JWT signatures
return self._verify_jws(token, key)
Expand Down