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 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
|
# SPDX-License-Identifier: MIT
import secrets
import sys
import threading
from concurrent.futures import ThreadPoolExecutor
from unittest import mock
import pytest
from argon2 import PasswordHasher, Type, extract_parameters, profiles
from argon2._password_hasher import _ensure_bytes
from argon2._utils import Parameters
from argon2.exceptions import (
InvalidHash,
InvalidHashError,
UnsupportedParametersError,
)
class TestEnsureBytes:
def test_is_bytes(self):
"""
Bytes are just returned.
"""
s = "föö".encode()
rv = _ensure_bytes(s, "doesntmatter")
assert isinstance(rv, bytes)
assert s == rv
def test_is_str(self):
"""
Unicode str is encoded using the specified encoding.
"""
s = "föö"
rv = _ensure_bytes(s, "latin1")
assert isinstance(rv, bytes)
assert s.encode("latin1") == rv
bytes_and_str_password = pytest.mark.parametrize(
"password", ["pässword".encode("latin1"), "pässword"]
)
class TestPasswordHasher:
@bytes_and_str_password
def test_hash(self, password):
"""
Hashing works with str and bytes. Uses correct parameters.
"""
ph = PasswordHasher(1, 8, 1, 16, 16, "latin1")
h = ph.hash(password)
prefix = "$argon2id$v=19$m=8,t=1,p=1$"
assert isinstance(h, str)
assert h[: len(prefix)] == prefix
def test_custom_salt(self, password=b"password"):
"""
A custom salt can be specified.
"""
ph = PasswordHasher.from_parameters(profiles.CHEAPEST)
h = ph.hash(password, salt=b"1234567890123456")
assert h == (
"$argon2id$v=19$m=8,t=1,p=1$MTIzNDU2Nzg5MDEyMzQ1Ng$maTa5w"
)
@bytes_and_str_password
def test_verify_agility(self, password):
"""
Verification works with str and bytes and variant is correctly
detected.
"""
ph = PasswordHasher(1, 8, 1, 16, 16, "latin1")
hash = ( # handrolled artisanal test vector
"$argon2i$m=8,t=1,p=1$"
"bL/lLsegFKTuR+5vVyA8tA$VKz5CHavCtFOL1N5TIXWSA"
)
assert ph.verify(hash, password)
@bytes_and_str_password
def test_hash_verify(self, password):
"""
Hashes are valid and can be verified.
"""
ph = PasswordHasher()
assert ph.verify(ph.hash(password), password) is True
def test_check(self):
"""
Raises a helpful TypeError on wrong arguments.
"""
with pytest.raises(TypeError) as e:
PasswordHasher("1")
assert "'time_cost' must be a int (got str)." == e.value.args[0]
def test_verify_invalid_hash_error(self):
"""
If the hash can't be parsed, InvalidHashError is raised.
"""
with pytest.raises(InvalidHashError):
PasswordHasher().verify("tiger", "does not matter")
def test_verify_invalid_hash(self):
"""
InvalidHashError and the deprecrated InvalidHash are the same.
"""
with pytest.raises(InvalidHash):
PasswordHasher().verify("tiger", "does not matter")
@pytest.mark.parametrize("use_bytes", [True, False])
def test_check_needs_rehash_no(self, use_bytes):
"""
Return False if the hash has the correct parameters.
"""
ph = PasswordHasher(1, 8, 1, 16, 16)
hash = ph.hash("foo")
if use_bytes:
hash = hash.encode()
assert not ph.check_needs_rehash(hash)
@pytest.mark.parametrize("use_bytes", [True, False])
def test_check_needs_rehash_yes(self, use_bytes):
"""
Return True if any of the parameters changes.
"""
ph = PasswordHasher(1, 8, 1, 16, 16)
ph_old = PasswordHasher(1, 8, 1, 8, 8)
hash = ph_old.hash("foo")
if use_bytes:
hash = hash.encode()
assert ph.check_needs_rehash(hash)
def test_type_is_configurable(self):
"""
Argon2id is default but can be changed.
"""
ph = PasswordHasher(time_cost=1, memory_cost=64)
default_hash = ph.hash("foo")
assert Type.ID is ph.type is ph._parameters.type
assert Type.ID is extract_parameters(default_hash).type
ph = PasswordHasher(time_cost=1, memory_cost=64, type=Type.I)
assert Type.I is ph.type is ph._parameters.type
assert Type.I is extract_parameters(ph.hash("foo")).type
assert ph.check_needs_rehash(default_hash)
@mock.patch("sys.platform", "emscripten")
@pytest.mark.parametrize("machine", ["wasm32", "wasm64"])
def test_params_on_wasm(self, machine):
"""
Parameter validation catches invalid parameters on WebAssembly.
"""
with mock.patch("platform.machine", return_value=machine):
with pytest.raises(
UnsupportedParametersError,
match="In WebAssembly environments `parallelism` must be 1.",
):
PasswordHasher(parallelism=2)
# last param is parallelism so it should fail
params = Parameters(Type.I, 2, 8, 8, 3, 256, 8)
with pytest.raises(
UnsupportedParametersError,
match="In WebAssembly environments `parallelism` must be 1.",
):
ph = PasswordHasher.from_parameters(params)
# explicitly correct parameters
ph = PasswordHasher(parallelism=1)
hash = ph.hash("hello")
assert ph.verify(hash, "hello") is True
# explicit, but still default parameters
default_params = profiles.get_default_parameters()
ph = PasswordHasher.from_parameters(default_params)
hash = ph.hash("hello")
assert ph.verify(hash, "hello") is True
def test_multithreaded_hashing():
"""
Hash passwords in a thread pool and check for thread safety
"""
hasher = PasswordHasher(parallelism=2)
num_passwords = 100
passwords = [secrets.token_urlsafe(15) for _ in range(num_passwords)]
def closure(b, passwords):
b.wait()
for password in passwords:
assert hasher.verify(hasher.hash(password), password)
max_workers = 4
chunks = [passwords[i::max_workers] for i in range(max_workers)]
orig_interval = sys.getswitchinterval()
with ThreadPoolExecutor(max_workers=max_workers) as tpe:
barrier = threading.Barrier(max_workers)
futures = []
try:
sys.setswitchinterval(0.00001)
for chunk in chunks:
futures.append(tpe.submit(closure, barrier, chunk)) # noqa: PERF401
finally:
sys.setswitchinterval(orig_interval)
if len(futures) < max_workers:
barrier.abort()
for f in futures:
f.result()
|