1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
import hashlib
import pickle
from functools import partial
from io import BytesIO
from io import StringIO
from typing import Any
from typing import cast
from typing import IO
from typing import overload
from typing import Union
import pytest
from itsdangerous.exc import BadPayload
from itsdangerous.exc import BadSignature
from itsdangerous.serializer import Serializer
from itsdangerous.signer import _lazy_sha1
from itsdangerous.signer import Signer
@overload
def coerce_str(ref: str, s: str) -> str: ...
@overload
def coerce_str(ref: bytes, s: str) -> bytes: ...
def coerce_str(ref: Union[str, bytes], s: str) -> Union[str, bytes]:
if isinstance(ref, bytes):
return s.encode("utf8")
return s
class TestSerializer:
@pytest.fixture(params=(Serializer, partial(Serializer, serializer=pickle)))
def serializer_factory(self, request):
return partial(request.param, secret_key="secret_key")
@pytest.fixture()
def serializer(self, serializer_factory):
return serializer_factory()
@pytest.fixture()
def value(self):
return {"id": 42}
@pytest.mark.parametrize(
"value", (None, True, "str", "text", [1, 2, 3], {"id": 42})
)
def test_serializer(self, serializer: Serializer, value: Any):
assert serializer.loads(serializer.dumps(value)) == value
@pytest.mark.parametrize(
"transform",
(
lambda s: s.upper(),
lambda s: s + coerce_str(s, "a"),
lambda s: coerce_str(s, "a") + s[1:],
lambda s: s.replace(coerce_str(s, "."), coerce_str(s, "")),
),
)
def test_changed_value(self, serializer: Serializer, value: Any, transform):
signed = serializer.dumps(value)
assert serializer.loads(signed) == value
changed = transform(signed)
with pytest.raises(BadSignature):
serializer.loads(changed)
def test_bad_signature_exception(self, serializer: Serializer, value: Any):
bad_signed = serializer.dumps(value)[:-1]
with pytest.raises(BadSignature) as exc_info:
serializer.loads(bad_signed)
payload = cast(bytes, exc_info.value.payload)
assert serializer.load_payload(payload) == value
def test_bad_payload_exception(self, serializer: Serializer, value: Any):
original = serializer.dumps(value)
payload = original.rsplit(coerce_str(original, "."), 1)[0] # type: ignore
bad = serializer.make_signer().sign(payload[:-1])
with pytest.raises(BadPayload) as exc_info:
serializer.loads(bad)
assert exc_info.value.original_error is not None
def test_loads_unsafe(self, serializer: Serializer, value: Any):
signed = serializer.dumps(value)
assert serializer.loads_unsafe(signed) == (True, value)
bad_signed = signed[:-1]
assert serializer.loads_unsafe(bad_signed) == (False, value)
payload = signed.rsplit(coerce_str(signed, "."), 1)[0] # type: ignore
bad_payload = serializer.make_signer().sign(payload[:-1])[:-1]
assert serializer.loads_unsafe(bad_payload) == (False, None)
class BadUnsign(serializer.signer): # type: ignore
def unsign(self, signed_value, *args, **kwargs):
try:
return super().unsign(signed_value, *args, **kwargs)
except BadSignature as e:
e.payload = None
raise
serializer.signer = BadUnsign
assert serializer.loads_unsafe(bad_signed) == (False, None)
def test_file(self, serializer: Serializer, value: Any):
f = cast(
IO, BytesIO() if isinstance(serializer.dumps(value), bytes) else StringIO()
)
serializer.dump(value, f)
f.seek(0)
assert serializer.load(f) == value
f.seek(0)
assert serializer.load_unsafe(f) == (True, value)
def test_alt_salt(self, serializer: Serializer, value: Any):
signed = serializer.dumps(value, salt="other")
with pytest.raises(BadSignature):
serializer.loads(signed)
assert serializer.loads(signed, salt="other") == value
def test_signer_cls(self, serializer_factory, serializer: Serializer, value: Any):
class Other(serializer.signer): # type: ignore
default_key_derivation = "hmac"
other = serializer_factory(signer=Other)
assert other.loads(other.dumps(value)) == value
assert other.dumps(value) != serializer.dumps(value)
def test_signer_kwargs(
self, serializer_factory, serializer: Serializer, value: Any
):
other = serializer_factory(signer_kwargs={"key_derivation": "hmac"})
assert other.loads(other.dumps(value)) == value
assert other.dumps("value") != serializer.dumps("value")
def test_serializer_kwargs(self, serializer_factory):
serializer = serializer_factory(serializer_kwargs={"skipkeys": True})
try:
serializer.serializer.dumps(None, skipkeys=True)
except TypeError:
return
assert serializer.loads(serializer.dumps({(): 1})) == {}
def test_fallback_signers(self, serializer_factory, value: Any):
serializer = serializer_factory(signer_kwargs={"digest_method": hashlib.sha256})
signed = serializer.dumps(value)
fallback_serializer = serializer_factory(
signer_kwargs={"digest_method": hashlib.sha1},
fallback_signers=[{"digest_method": hashlib.sha256}],
)
assert fallback_serializer.loads(signed) == value
def test_iter_unsigners(self, serializer: Serializer, serializer_factory):
class Signer256(serializer.signer): # type: ignore
default_digest_method = hashlib.sha256
serializer = serializer_factory(
secret_key="secret_key",
fallback_signers=[
{"digest_method": hashlib.sha256},
(Signer, {"digest_method": hashlib.sha256}),
Signer256,
],
)
unsigners = serializer.iter_unsigners()
assert next(unsigners).digest_method == _lazy_sha1
for signer in unsigners:
assert signer.digest_method == hashlib.sha256
def test_digests():
factory = partial(Serializer, secret_key="dev key", salt="dev salt")
default_value = factory(signer_kwargs={}).dumps([42])
sha1_value = factory(signer_kwargs={"digest_method": hashlib.sha1}).dumps([42])
sha512_value = factory(signer_kwargs={"digest_method": hashlib.sha512}).dumps([42])
assert default_value == sha1_value
assert sha1_value == "[42].-9cNi0CxsSB3hZPNCe9a2eEs1ZM"
assert sha512_value == (
"[42].MKCz_0nXQqv7wKpfHZcRtJRmpT2T5uvs9YQsJEhJimqxc"
"9bCLxG31QzS5uC8OVBI1i6jyOLAFNoKaF5ckO9L5Q"
)
|
