From 98a5c1d61ee180f5b3574e142f5938d24146ee99 Mon Sep 17 00:00:00 2001 From: Julian Maurin Date: Sun, 31 Jul 2022 17:24:02 +0200 Subject: [PATCH] Update audience typing (#782) * fix(api_jwt): update audience typing & type checking * doc(api): update decode.audience typing * feat(test_api_jwt): ensure audience as bytes raises error * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * refacto(api_jwt): precise typing Co-authored-by: Julian Maurin Update jwt/api_jwt.py Co-authored-by: Julian Maurin fix(jwt/api_jwt.py): backport future annotations * fix: handle audience=0 Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Asif Saif Uddin --- docs/api.rst | 2 +- jwt/api_jwt.py | 10 ++++++---- tests/test_api_jwt.py | 10 +++++++++- 3 files changed, 16 insertions(+), 6 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 2f81b1f7..919b6af9 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -62,7 +62,7 @@ API Reference if ``verify_exp``, ``verify_iat``, and ``verify_nbf`` respectively is set to ``True``). - :param Iterable audience: optional, the value for ``verify_aud`` check + :param Union[str, Iterable] audience: optional, the value for ``verify_aud`` check :param str issuer: optional, the value for ``verify_iss`` check :param float leeway: a time margin in seconds for the expiration check :rtype: dict diff --git a/jwt/api_jwt.py b/jwt/api_jwt.py index b08e9502..91a6d2e8 100644 --- a/jwt/api_jwt.py +++ b/jwt/api_jwt.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import json import warnings from calendar import timegm @@ -76,7 +78,7 @@ def decode_complete( detached_payload: Optional[bytes] = None, # passthrough arguments to _validate_claims # consider putting in options - audience: Optional[str] = None, + audience: Optional[Union[str, Iterable[str]]] = None, issuer: Optional[str] = None, leeway: Union[int, float, timedelta] = 0, # kwargs @@ -150,7 +152,7 @@ def decode( detached_payload: Optional[bytes] = None, # passthrough arguments to _validate_claims # consider putting in options - audience: Optional[str] = None, + audience: Optional[Union[str, Iterable[str]]] = None, issuer: Optional[str] = None, leeway: Union[int, float, timedelta] = 0, # kwargs @@ -180,8 +182,8 @@ def _validate_claims(self, payload, options, audience=None, issuer=None, leeway= if isinstance(leeway, timedelta): leeway = leeway.total_seconds() - if not isinstance(audience, (bytes, str, type(None), Iterable)): - raise TypeError("audience must be a string, iterable, or None") + if audience is not None and not isinstance(audience, (str, Iterable)): + raise TypeError("audience must be a string, iterable or None") self._validate_required_claims(payload, options) diff --git a/tests/test_api_jwt.py b/tests/test_api_jwt.py index d0443e89..bebe7d28 100644 --- a/tests/test_api_jwt.py +++ b/tests/test_api_jwt.py @@ -119,7 +119,7 @@ def test_decode_with_invalid_audience_param_throws_exception(self, jwt): jwt.decode(example_jwt, secret, audience=1, algorithms=["HS256"]) exception = context.value - assert str(exception) == "audience must be a string, iterable, or None" + assert str(exception) == "audience must be a string, iterable or None" def test_decode_with_nonlist_aud_claim_throws_exception(self, jwt): secret = "secret" @@ -419,6 +419,14 @@ def test_raise_exception_invalid_audience(self, jwt): with pytest.raises(InvalidAudienceError): jwt.decode(token, "secret", audience="urn-me", algorithms=["HS256"]) + def test_raise_exception_audience_as_bytes(self, jwt): + payload = {"some": "payload", "aud": ["urn:me", "urn:someone-else"]} + token = jwt.encode(payload, "secret") + with pytest.raises(InvalidAudienceError): + jwt.decode( + token, "secret", audience="urn:me".encode(), algorithms=["HS256"] + ) + def test_raise_exception_invalid_audience_in_array(self, jwt): payload = { "some": "payload",