Skip to content

Commit 5fe7f2b

Browse files
authored
Remove arbitrary kwargs. (jpadilla#657)
* Remove arbitrary kwargs. * Update CHANGELOG.
1 parent fdd795a commit 5fe7f2b

File tree

4 files changed

+26
-12
lines changed

4 files changed

+26
-12
lines changed

CHANGELOG.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ This project adheres to `Semantic Versioning <https://semver.org/>`__.
1010
Changed
1111
~~~~~~~
1212

13+
- Remove arbitrary kwalgs. `#657 <https://github.com/jpadilla/pyjwt/pull/657>`__
14+
1315
Fixed
1416
~~~~~
1517

jwt/api_jws.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,6 @@ def decode_complete(
137137
key: str = "",
138138
algorithms: List[str] = None,
139139
options: Dict = None,
140-
**kwargs,
141140
) -> Dict[str, Any]:
142141
if options is None:
143142
options = {}
@@ -166,9 +165,8 @@ def decode(
166165
key: str = "",
167166
algorithms: List[str] = None,
168167
options: Dict = None,
169-
**kwargs,
170168
) -> str:
171-
decoded = self.decode_complete(jwt, key, algorithms, options, **kwargs)
169+
decoded = self.decode_complete(jwt, key, algorithms, options)
172170
return decoded["payload"]
173171

174172
def get_unverified_header(self, jwt):

jwt/api_jwt.py

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,9 @@ def decode_complete(
6868
key: str = "",
6969
algorithms: List[str] = None,
7070
options: Dict = None,
71-
**kwargs,
71+
audience: Optional[Union[str, List[str]]] = None,
72+
issuer: Optional[str] = None,
73+
leeway: Union[float, timedelta] = 0,
7274
) -> Dict[str, Any]:
7375
if options is None:
7476
options = {"verify_signature": True}
@@ -92,7 +94,6 @@ def decode_complete(
9294
key=key,
9395
algorithms=algorithms,
9496
options=options,
95-
**kwargs,
9697
)
9798

9899
try:
@@ -103,7 +104,7 @@ def decode_complete(
103104
raise DecodeError("Invalid payload string: must be a json object")
104105

105106
merged_options = {**self.options, **options}
106-
self._validate_claims(payload, merged_options, **kwargs)
107+
self._validate_claims(payload, merged_options, audience, issuer, leeway)
107108

108109
decoded["payload"] = payload
109110
return decoded
@@ -114,18 +115,20 @@ def decode(
114115
key: str = "",
115116
algorithms: List[str] = None,
116117
options: Dict = None,
117-
**kwargs,
118+
audience: Optional[Union[str, List[str]]] = None,
119+
issuer: Optional[str] = None,
120+
leeway: Union[float, timedelta] = 0,
118121
) -> Dict[str, Any]:
119-
decoded = self.decode_complete(jwt, key, algorithms, options, **kwargs)
122+
decoded = self.decode_complete(
123+
jwt, key, algorithms, options, audience, issuer, leeway
124+
)
120125
return decoded["payload"]
121126

122-
def _validate_claims(
123-
self, payload, options, audience=None, issuer=None, leeway=0, **kwargs
124-
):
127+
def _validate_claims(self, payload, options, audience, issuer, leeway):
125128
if isinstance(leeway, timedelta):
126129
leeway = leeway.total_seconds()
127130

128-
if not isinstance(audience, (bytes, str, type(None), Iterable)):
131+
if not isinstance(audience, (str, type(None), Iterable)):
129132
raise TypeError("audience must be a string, iterable, or None")
130133

131134
self._validate_required_claims(payload, options)

tests/test_api_jwt.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,17 @@ def test_decode_with_non_mapping_payload_throws_exception(self, jwt):
106106
exception = context.value
107107
assert str(exception) == "Invalid payload string: must be a json object"
108108

109+
def test_decode_with_unknown_parameter_throws_exception(self, jwt):
110+
secret = "secret"
111+
example_jwt = (
112+
b"eyJhbGciOiAiSFMyNTYiLCAidHlwIjogIkpXVCJ9"
113+
b".eyJoZWxsbyI6ICJ3b3JsZCJ9"
114+
b".tvagLDLoaiJKxOKqpBXSEGy7SYSifZhjntgm9ctpyj8"
115+
)
116+
117+
with pytest.raises(TypeError):
118+
jwt.decode(example_jwt, key=secret, foo="bar", algorithms=["HS256"])
119+
109120
def test_decode_with_invalid_audience_param_throws_exception(self, jwt):
110121
secret = "secret"
111122
example_jwt = (

0 commit comments

Comments
 (0)