mirror of
https://github.com/zulip/zulip.git
synced 2025-11-04 14:03:30 +00:00
b7b7475672
There are three functional side effects: • Correct an insignificant but mathematically offensive bias toward repeated characters in generate_api_key introduced in commit 47b4283c4b4c70ecde4d3c8de871c90ee2506d87; its entropy is increased from 190.52864 bits to 190.53428 bits. • Use the base32 alphabet in confirmation.models.generate_key; its entropy is reduced from 124.07820 bits to the documented 120 bits, but now it uses 1 syscall instead of 24. • Use the base32 alphabet in get_bigbluebutton_url; its entropy is reduced from 51.69925 bits to 50 bits, but now it uses 1 syscall instead of 10. (The base32 alphabet is A-Z 2-7. We could probably replace all of these with plain secrets.token_urlsafe, since I expect most callers can handle the full urlsafe_b64 alphabet A-Z a-z 0-9 - _ without problems.) Signed-off-by: Anders Kaseorg <anders@zulip.com>
62 lines
2.4 KiB
Python
62 lines
2.4 KiB
Python
from unittest import mock
|
|
|
|
from zerver.lib.redis_utils import (
|
|
MAX_KEY_LENGTH,
|
|
ZulipRedisKeyOfWrongFormatError,
|
|
ZulipRedisKeyTooLongError,
|
|
get_dict_from_redis,
|
|
get_redis_client,
|
|
put_dict_in_redis,
|
|
)
|
|
from zerver.lib.test_classes import ZulipTestCase
|
|
|
|
|
|
class RedisUtilsTest(ZulipTestCase):
|
|
key_format = "test_redis_utils_{token}"
|
|
expiration_seconds = 60
|
|
|
|
@classmethod
|
|
def setUpClass(cls) -> None:
|
|
cls.redis_client = get_redis_client()
|
|
return super().setUpClass()
|
|
|
|
def test_put_and_get_data(self) -> None:
|
|
data = {
|
|
"a": 1,
|
|
"b": "some value",
|
|
}
|
|
key = put_dict_in_redis(self.redis_client, self.key_format, data,
|
|
expiration_seconds=self.expiration_seconds)
|
|
retrieved_data = get_dict_from_redis(self.redis_client, self.key_format, key)
|
|
self.assertEqual(data, retrieved_data)
|
|
|
|
def test_put_data_key_length_check(self) -> None:
|
|
data = {
|
|
"a": 1,
|
|
"b": "some value",
|
|
}
|
|
|
|
max_valid_token_length = MAX_KEY_LENGTH - (len(self.key_format) - len('{token}'))
|
|
key = put_dict_in_redis(self.redis_client, self.key_format, data,
|
|
expiration_seconds=self.expiration_seconds,
|
|
token_length=max_valid_token_length)
|
|
retrieved_data = get_dict_from_redis(self.redis_client, self.key_format, key)
|
|
self.assertEqual(data, retrieved_data)
|
|
|
|
# Trying to put data under an overly long key should get stopped before even
|
|
# generating the random token.
|
|
with mock.patch("secrets.token_hex") as mock_generate:
|
|
with self.assertRaises(ZulipRedisKeyTooLongError):
|
|
put_dict_in_redis(self.redis_client, self.key_format, data,
|
|
expiration_seconds=self.expiration_seconds,
|
|
token_length=max_valid_token_length + 1)
|
|
mock_generate.assert_not_called()
|
|
|
|
def test_get_data_key_length_check(self) -> None:
|
|
with self.assertRaises(ZulipRedisKeyTooLongError):
|
|
get_dict_from_redis(self.redis_client, key_format='{token}', key='A' * (MAX_KEY_LENGTH + 1))
|
|
|
|
def test_get_data_key_format_validation(self) -> None:
|
|
with self.assertRaises(ZulipRedisKeyOfWrongFormatError):
|
|
get_dict_from_redis(self.redis_client, self.key_format, 'nonmatching_format_1111')
|