Skip to content

fix: audience should support sequence too #4241

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 11 commits into
base: main
Choose a base branch
from
+31 −4
Open

fix: audience should support sequence too #4241

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
7aa7f85
Audience should support sequence too
casabre Jul 20, 2025
cfb0f72
feat(security): audience should support sequence too
casabre Jul 20, 2025
256ac46
feat(security): extending parameters for test_token to cover sequence…
casabre Sep 18, 2025
1209447
Merge remote-tracking branch 'origin/fix/audience-issue#4240' into fi…
casabre Sep 18, 2025
7600172
fix(security): adding own test for audience validation and removing p…
casabre Sep 18, 2025
8f73e71
Merge branch 'main' into fix/audience-issue#4240
casabre Sep 18, 2025
cf4eba1
Fix linting fails
casabre Sep 18, 2025
e08a526
Revert "feat(security): extending parameters for test_token to cover …
casabre Sep 18, 2025
05f11e3
fix(security): adding union type again
casabre Sep 19, 2025
ae07416
Revert "fix(security): adding union type again"
casabre Sep 19, 2025
49489d8
Moving Sequence import out of type checking block
casabre Sep 19, 2025
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: 3 additions & 3 deletions litestar/security/jwt/token.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import dataclasses
from dataclasses import asdict, dataclass, field
from datetime import datetime, timezone
from typing import TYPE_CHECKING, Any, Dict, Optional, Sequence, TypedDict
from typing import TYPE_CHECKING, Any, Dict, Optional, Sequence, TypedDict, Union

import jwt
import msgspec
Expand Down Expand Up @@ -57,8 +57,8 @@ class Token:
"""Issued at - should always be current now."""
iss: Optional[str] = field(default=None) # noqa: UP007
"""Issuer - optional unique identifier for the issuer."""
aud: Optional[str] = field(default=None) # noqa: UP007
"""Audience - intended audience."""
aud: Union[str, Sequence[str], None] = field(default=None) # noqa: UP007
"""Audience - intended audience(s)."""
jti: Optional[str] = field(default=None) # noqa: UP007
"""JWT ID - a unique identifier of the JWT between different issuers."""
extras: Dict[str, Any] = field(default_factory=dict) # noqa: UP006
Expand Down
40 changes: 34 additions & 6 deletions tests/unit/test_security/test_jwt/test_token.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,45 @@
from litestar.security.jwt.token import JWTDecodeOptions


@pytest.mark.parametrize("algorithm", ["HS256", "HS384", "HS512"])
@pytest.mark.parametrize("token_issuer", [None, "e3d7d10edbbc28bfebd8861d39ae7587acde1e1fcefe2cbbec686d235d68f475"])
@pytest.mark.parametrize("token_audience", [None, "627224198b4245ed91cf8353e4ccdf1650728c7ee92748f55fe1e9a9c4d961df"])
@pytest.mark.parametrize(
"token_unique_jwt_id", [None, "10f5c6967783ddd6bb0c4e8262d7097caeae64705e45f83275e3c32eee5d30f2"]
"algorithm",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doubles the amount of tests run, due to the multiple parametrize decorators. Could you maybe just add one simple case for the sequence audience?

[pytest.param("HS256", id="HS256"), pytest.param("HS384", id="HS384"), pytest.param("HS512", id="HS512")],
)
@pytest.mark.parametrize(
"token_issuer",
[
pytest.param(None, id="None"),
pytest.param("e3d7d10edbbc28bfebd8861d39ae7587acde1e1fcefe2cbbec686d235d68f475", id="String"),
],
)
@pytest.mark.parametrize(
"token_audience",
[
pytest.param(None, id="None"),
pytest.param("627224198b4245ed91cf8353e4ccdf1650728c7ee92748f55fe1e9a9c4d961df", id="String"),
pytest.param(
[
"627224198b4245ed91cf8353e4ccdf1650728c7ee92748f55fe1e9a9c4d961df",
"887224198b4245ed91cf8353e4ccdf1650728c7ee92748f55fe1e9a9c4d961df",
],
id="List",
),
],
)
@pytest.mark.parametrize(
"token_unique_jwt_id",
[
pytest.param(None, id="None"),
pytest.param("10f5c6967783ddd6bb0c4e8262d7097caeae64705e45f83275e3c32eee5d30f2", id="String"),
],
)
@pytest.mark.parametrize(
"token_extras", [pytest.param(None, id="None"), pytest.param({"email": "[email protected]"}, id="Dict")]
)
@pytest.mark.parametrize("token_extras", [None, {"email": "[email protected]"}])
def test_token(
algorithm: str,
token_issuer: str | None,
token_audience: str | None,
token_audience: str | Sequence[str] | None,
token_unique_jwt_id: str | None,
token_extras: dict[str, Any] | None,
) -> None:
Expand Down