Skip to content
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.

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

Already on GitHub? Sign in to your account

Update audience typing #782

Merged
merged 6 commits into from Jul 31, 2022
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api.rst
Expand Up @@ -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
JulianMaurin marked this conversation as resolved.
Show resolved Hide resolved
:param str issuer: optional, the value for ``verify_iss`` check
:param float leeway: a time margin in seconds for the expiration check
:rtype: dict
Expand Down
8 changes: 4 additions & 4 deletions jwt/api_jwt.py
Expand Up @@ -76,7 +76,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]] = None,
auvipy marked this conversation as resolved.
Show resolved Hide resolved
issuer: Optional[str] = None,
leeway: Union[int, float, timedelta] = 0,
# kwargs
Expand Down Expand Up @@ -150,7 +150,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]] = None,
auvipy marked this conversation as resolved.
Show resolved Hide resolved
issuer: Optional[str] = None,
leeway: Union[int, float, timedelta] = 0,
# kwargs
Expand Down Expand Up @@ -180,8 +180,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 and not isinstance(audience, (str, Iterable)):
JulianMaurin marked this conversation as resolved.
Show resolved Hide resolved
raise TypeError("audience must be a string, iterable or None")

self._validate_required_claims(payload, options)

Expand Down
10 changes: 9 additions & 1 deletion tests/test_api_jwt.py
Expand Up @@ -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"
Expand Down Expand Up @@ -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",
Expand Down