From d80b1b1ebc557367701c6476127726efb52c9e52 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A9n=C3=A9dikt=20Tran?= <10796600+picnixz@users.noreply.github.com> Date: Thu, 13 Feb 2025 14:26:33 +0100 Subject: [PATCH 01/24] add helper for _hashlib detection --- Lib/test/support/hashlib_helper.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/Lib/test/support/hashlib_helper.py b/Lib/test/support/hashlib_helper.py index a4e6c92203ab50..477e0f110eabba 100644 --- a/Lib/test/support/hashlib_helper.py +++ b/Lib/test/support/hashlib_helper.py @@ -8,6 +8,10 @@ _hashlib = None +def requires_hashlib(): + return unittest.skipIf(_hashlib is None, "requires _hashlib") + + def requires_hashdigest(digestname, openssl=None, usedforsecurity=True): """Decorator raising SkipTest if a hashing algorithm is not available @@ -44,7 +48,7 @@ def wrapper(*args, **kwargs): hashlib.new(digestname, usedforsecurity=usedforsecurity) except ValueError: raise unittest.SkipTest( - f"hash digest '{digestname}' is not available." + f"hash digest {digestname!r} is not available." ) return func_or_class(*args, **kwargs) return wrapper From 73b77564997301ad64eabe13c408ca9edcdae067 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A9n=C3=A9dikt=20Tran?= <10796600+picnixz@users.noreply.github.com> Date: Thu, 13 Feb 2025 14:27:47 +0100 Subject: [PATCH 02/24] remove unused function `ignore_warning` --- Lib/test/test_hmac.py | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/Lib/test/test_hmac.py b/Lib/test/test_hmac.py index 1502fba9f3e8b8..4e4578cd71b32b 100644 --- a/Lib/test/test_hmac.py +++ b/Lib/test/test_hmac.py @@ -27,16 +27,6 @@ sha256_module = None -def ignore_warning(func): - @functools.wraps(func) - def wrapper(*args, **kwargs): - with warnings.catch_warnings(): - warnings.filterwarnings("ignore", - category=DeprecationWarning) - return func(*args, **kwargs) - return wrapper - - class TestVectorsTestCase(unittest.TestCase): def assert_hmac_internals( From fe7a300a596dd3b5fb83d28f81af5b1fc774d588 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A9n=C3=A9dikt=20Tran?= <10796600+picnixz@users.noreply.github.com> Date: Thu, 13 Feb 2025 14:28:07 +0100 Subject: [PATCH 03/24] cleanup whitespaces --- Lib/test/test_hmac.py | 197 +++++++++++++++++++++--------------------- 1 file changed, 98 insertions(+), 99 deletions(-) diff --git a/Lib/test/test_hmac.py b/Lib/test/test_hmac.py index 4e4578cd71b32b..c7ea03f41fa054 100644 --- a/Lib/test/test_hmac.py +++ b/Lib/test/test_hmac.py @@ -30,7 +30,7 @@ class TestVectorsTestCase(unittest.TestCase): def assert_hmac_internals( - self, h, digest, hashname, digest_size, block_size + self, h, digest, hashname, digest_size, block_size ): self.assertEqual(h.hexdigest().upper(), digest.upper()) self.assertEqual(h.digest(), binascii.unhexlify(digest)) @@ -207,110 +207,110 @@ def hmactest(key, data, hexdigests): ) # 4.2. Test Case 1 - hmactest(key = b'\x0b'*20, - data = b'Hi There', - hexdigests = { - hashlib.sha224: '896fb1128abbdf196832107cd49df33f' - '47b4b1169912ba4f53684b22', - hashlib.sha256: 'b0344c61d8db38535ca8afceaf0bf12b' - '881dc200c9833da726e9376c2e32cff7', - hashlib.sha384: 'afd03944d84895626b0825f4ab46907f' - '15f9dadbe4101ec682aa034c7cebc59c' - 'faea9ea9076ede7f4af152e8b2fa9cb6', - hashlib.sha512: '87aa7cdea5ef619d4ff0b4241a1d6cb0' - '2379f4e2ce4ec2787ad0b30545e17cde' - 'daa833b7d6b8a702038b274eaea3f4e4' - 'be9d914eeb61f1702e696c203a126854', + hmactest(key=b'\x0b' * 20, + data=b'Hi There', + hexdigests={ + hashlib.sha224: '896fb1128abbdf196832107cd49df33f' + '47b4b1169912ba4f53684b22', + hashlib.sha256: 'b0344c61d8db38535ca8afceaf0bf12b' + '881dc200c9833da726e9376c2e32cff7', + hashlib.sha384: 'afd03944d84895626b0825f4ab46907f' + '15f9dadbe4101ec682aa034c7cebc59c' + 'faea9ea9076ede7f4af152e8b2fa9cb6', + hashlib.sha512: '87aa7cdea5ef619d4ff0b4241a1d6cb0' + '2379f4e2ce4ec2787ad0b30545e17cde' + 'daa833b7d6b8a702038b274eaea3f4e4' + 'be9d914eeb61f1702e696c203a126854', }) # 4.3. Test Case 2 - hmactest(key = b'Jefe', - data = b'what do ya want for nothing?', - hexdigests = { - hashlib.sha224: 'a30e01098bc6dbbf45690f3a7e9e6d0f' - '8bbea2a39e6148008fd05e44', - hashlib.sha256: '5bdcc146bf60754e6a042426089575c7' - '5a003f089d2739839dec58b964ec3843', - hashlib.sha384: 'af45d2e376484031617f78d2b58a6b1b' - '9c7ef464f5a01b47e42ec3736322445e' - '8e2240ca5e69e2c78b3239ecfab21649', - hashlib.sha512: '164b7a7bfcf819e2e395fbe73b56e0a3' - '87bd64222e831fd610270cd7ea250554' - '9758bf75c05a994a6d034f65f8f0e6fd' - 'caeab1a34d4a6b4b636e070a38bce737', + hmactest(key=b'Jefe', + data=b'what do ya want for nothing?', + hexdigests={ + hashlib.sha224: 'a30e01098bc6dbbf45690f3a7e9e6d0f' + '8bbea2a39e6148008fd05e44', + hashlib.sha256: '5bdcc146bf60754e6a042426089575c7' + '5a003f089d2739839dec58b964ec3843', + hashlib.sha384: 'af45d2e376484031617f78d2b58a6b1b' + '9c7ef464f5a01b47e42ec3736322445e' + '8e2240ca5e69e2c78b3239ecfab21649', + hashlib.sha512: '164b7a7bfcf819e2e395fbe73b56e0a3' + '87bd64222e831fd610270cd7ea250554' + '9758bf75c05a994a6d034f65f8f0e6fd' + 'caeab1a34d4a6b4b636e070a38bce737', }) # 4.4. Test Case 3 - hmactest(key = b'\xaa'*20, - data = b'\xdd'*50, - hexdigests = { - hashlib.sha224: '7fb3cb3588c6c1f6ffa9694d7d6ad264' - '9365b0c1f65d69d1ec8333ea', - hashlib.sha256: '773ea91e36800e46854db8ebd09181a7' - '2959098b3ef8c122d9635514ced565fe', - hashlib.sha384: '88062608d3e6ad8a0aa2ace014c8a86f' - '0aa635d947ac9febe83ef4e55966144b' - '2a5ab39dc13814b94e3ab6e101a34f27', - hashlib.sha512: 'fa73b0089d56a284efb0f0756c890be9' - 'b1b5dbdd8ee81a3655f83e33b2279d39' - 'bf3e848279a722c806b485a47e67c807' - 'b946a337bee8942674278859e13292fb', + hmactest(key=b'\xaa' * 20, + data=b'\xdd' * 50, + hexdigests={ + hashlib.sha224: '7fb3cb3588c6c1f6ffa9694d7d6ad264' + '9365b0c1f65d69d1ec8333ea', + hashlib.sha256: '773ea91e36800e46854db8ebd09181a7' + '2959098b3ef8c122d9635514ced565fe', + hashlib.sha384: '88062608d3e6ad8a0aa2ace014c8a86f' + '0aa635d947ac9febe83ef4e55966144b' + '2a5ab39dc13814b94e3ab6e101a34f27', + hashlib.sha512: 'fa73b0089d56a284efb0f0756c890be9' + 'b1b5dbdd8ee81a3655f83e33b2279d39' + 'bf3e848279a722c806b485a47e67c807' + 'b946a337bee8942674278859e13292fb', }) # 4.5. Test Case 4 - hmactest(key = bytes(x for x in range(0x01, 0x19+1)), - data = b'\xcd'*50, - hexdigests = { - hashlib.sha224: '6c11506874013cac6a2abc1bb382627c' - 'ec6a90d86efc012de7afec5a', - hashlib.sha256: '82558a389a443c0ea4cc819899f2083a' - '85f0faa3e578f8077a2e3ff46729665b', - hashlib.sha384: '3e8a69b7783c25851933ab6290af6ca7' - '7a9981480850009cc5577c6e1f573b4e' - '6801dd23c4a7d679ccf8a386c674cffb', - hashlib.sha512: 'b0ba465637458c6990e5a8c5f61d4af7' - 'e576d97ff94b872de76f8050361ee3db' - 'a91ca5c11aa25eb4d679275cc5788063' - 'a5f19741120c4f2de2adebeb10a298dd', + hmactest(key=bytes(x for x in range(0x01, 0x19 + 1)), + data=b'\xcd' * 50, + hexdigests={ + hashlib.sha224: '6c11506874013cac6a2abc1bb382627c' + 'ec6a90d86efc012de7afec5a', + hashlib.sha256: '82558a389a443c0ea4cc819899f2083a' + '85f0faa3e578f8077a2e3ff46729665b', + hashlib.sha384: '3e8a69b7783c25851933ab6290af6ca7' + '7a9981480850009cc5577c6e1f573b4e' + '6801dd23c4a7d679ccf8a386c674cffb', + hashlib.sha512: 'b0ba465637458c6990e5a8c5f61d4af7' + 'e576d97ff94b872de76f8050361ee3db' + 'a91ca5c11aa25eb4d679275cc5788063' + 'a5f19741120c4f2de2adebeb10a298dd', }) # 4.7. Test Case 6 - hmactest(key = b'\xaa'*131, - data = b'Test Using Larger Than Block-Siz' - b'e Key - Hash Key First', - hexdigests = { - hashlib.sha224: '95e9a0db962095adaebe9b2d6f0dbce2' - 'd499f112f2d2b7273fa6870e', - hashlib.sha256: '60e431591ee0b67f0d8a26aacbf5b77f' - '8e0bc6213728c5140546040f0ee37f54', - hashlib.sha384: '4ece084485813e9088d2c63a041bc5b4' - '4f9ef1012a2b588f3cd11f05033ac4c6' - '0c2ef6ab4030fe8296248df163f44952', - hashlib.sha512: '80b24263c7c1a3ebb71493c1dd7be8b4' - '9b46d1f41b4aeec1121b013783f8f352' - '6b56d037e05f2598bd0fd2215d6a1e52' - '95e64f73f63f0aec8b915a985d786598', + hmactest(key=b'\xaa' * 131, + data=b'Test Using Larger Than Block-Siz' + b'e Key - Hash Key First', + hexdigests={ + hashlib.sha224: '95e9a0db962095adaebe9b2d6f0dbce2' + 'd499f112f2d2b7273fa6870e', + hashlib.sha256: '60e431591ee0b67f0d8a26aacbf5b77f' + '8e0bc6213728c5140546040f0ee37f54', + hashlib.sha384: '4ece084485813e9088d2c63a041bc5b4' + '4f9ef1012a2b588f3cd11f05033ac4c6' + '0c2ef6ab4030fe8296248df163f44952', + hashlib.sha512: '80b24263c7c1a3ebb71493c1dd7be8b4' + '9b46d1f41b4aeec1121b013783f8f352' + '6b56d037e05f2598bd0fd2215d6a1e52' + '95e64f73f63f0aec8b915a985d786598', }) # 4.8. Test Case 7 - hmactest(key = b'\xaa'*131, - data = b'This is a test using a larger th' - b'an block-size key and a larger t' - b'han block-size data. The key nee' - b'ds to be hashed before being use' - b'd by the HMAC algorithm.', - hexdigests = { - hashlib.sha224: '3a854166ac5d9f023f54d517d0b39dbd' - '946770db9c2b95c9f6f565d1', - hashlib.sha256: '9b09ffa71b942fcb27635fbcd5b0e944' - 'bfdc63644f0713938a7f51535c3a35e2', - hashlib.sha384: '6617178e941f020d351e2f254e8fd32c' - '602420feb0b8fb9adccebb82461e99c5' - 'a678cc31e799176d3860e6110c46523e', - hashlib.sha512: 'e37b6a775dc87dbaa4dfa9f96e5e3ffd' - 'debd71f8867289865df5a32d20cdc944' - 'b6022cac3c4982b10d5eeb55c3e4de15' - '134676fb6de0446065c97440fa8c6a58', + hmactest(key=b'\xaa' * 131, + data=b'This is a test using a larger th' + b'an block-size key and a larger t' + b'han block-size data. The key nee' + b'ds to be hashed before being use' + b'd by the HMAC algorithm.', + hexdigests={ + hashlib.sha224: '3a854166ac5d9f023f54d517d0b39dbd' + '946770db9c2b95c9f6f565d1', + hashlib.sha256: '9b09ffa71b942fcb27635fbcd5b0e944' + 'bfdc63644f0713938a7f51535c3a35e2', + hashlib.sha384: '6617178e941f020d351e2f254e8fd32c' + '602420feb0b8fb9adccebb82461e99c5' + 'a678cc31e799176d3860e6110c46523e', + hashlib.sha512: 'e37b6a775dc87dbaa4dfa9f96e5e3ffd' + 'debd71f8867289865df5a32d20cdc944' + 'b6022cac3c4982b10d5eeb55c3e4de15' + '134676fb6de0446065c97440fa8c6a58', }) @hashlib_helper.requires_hashdigest('sha224', openssl=True) @@ -375,7 +375,6 @@ def test_with_fallback(self): class ConstructorTestCase(unittest.TestCase): - expected = ( "6c845b47f52b3b47f6590c502db7825aad757bf4fadc8fa972f7cd2e76a5bdeb" ) @@ -486,9 +485,9 @@ def test_attributes_old(self): h1._init_old(b"key", b"msg", digestmod="sha256") h2 = h1.copy() self.assertEqual(type(h1._inner), type(h2._inner), - "Types of inner don't match.") + "Types of inner don't match.") self.assertEqual(type(h1._outer), type(h2._outer), - "Types of outer don't match.") + "Types of outer don't match.") @hashlib_helper.requires_hashdigest('sha256') def test_realcopy_old(self): @@ -499,9 +498,9 @@ def test_realcopy_old(self): # Using id() in case somebody has overridden __eq__/__ne__. self.assertTrue(id(h1) != id(h2), "No real copy of the HMAC instance.") self.assertTrue(id(h1._inner) != id(h2._inner), - "No real copy of the attribute 'inner'.") + "No real copy of the attribute 'inner'.") self.assertTrue(id(h1._outer) != id(h2._outer), - "No real copy of the attribute 'outer'.") + "No real copy of the attribute 'outer'.") self.assertIs(h1._hmac, None) @unittest.skipIf(_hashopenssl is None, "test requires _hashopenssl") @@ -519,9 +518,9 @@ def test_equality(self): h1.update(b"some random text") h2 = h1.copy() self.assertEqual(h1.digest(), h2.digest(), - "Digest of copy doesn't match original digest.") + "Digest of copy doesn't match original digest.") self.assertEqual(h1.hexdigest(), h2.hexdigest(), - "Hexdigest of copy doesn't match original hexdigest.") + "Hexdigest of copy doesn't match original hexdigest.") @hashlib_helper.requires_hashdigest('sha256') def test_equality_new(self): @@ -533,9 +532,9 @@ def test_equality_new(self): id(h1) != id(h2), "No real copy of the HMAC instance." ) self.assertEqual(h1.digest(), h2.digest(), - "Digest of copy doesn't match original digest.") + "Digest of copy doesn't match original digest.") self.assertEqual(h1.hexdigest(), h2.hexdigest(), - "Hexdigest of copy doesn't match original hexdigest.") + "Hexdigest of copy doesn't match original hexdigest.") class CompareDigestTestCase(unittest.TestCase): From 72f956fd4c5f6db496b4499593794c7a17712586 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A9n=C3=A9dikt=20Tran?= <10796600+picnixz@users.noreply.github.com> Date: Thu, 13 Feb 2025 14:32:44 +0100 Subject: [PATCH 04/24] clean imports and test guards - Use `_hashlib` instead of `_hashopenssl` naming. - Use `_hashlib.*` instead of top-level imports. - Consistently use new hashlib helper guards. --- Lib/test/test_hmac.py | 45 ++++++++++++++++++++++--------------------- 1 file changed, 23 insertions(+), 22 deletions(-) diff --git a/Lib/test/test_hmac.py b/Lib/test/test_hmac.py index c7ea03f41fa054..1555284b0f01d4 100644 --- a/Lib/test/test_hmac.py +++ b/Lib/test/test_hmac.py @@ -2,29 +2,29 @@ import functools import hmac import hashlib +import test.support.hashlib_helper as hashlib_helper import unittest import unittest.mock import warnings - -from test.support import hashlib_helper, check_disallow_instantiation - from _operator import _compare_digest as operator_compare_digest +from test.support import check_disallow_instantiation +from test.support.import_helper import import_fresh_module try: - import _hashlib as _hashopenssl - from _hashlib import HMAC as C_HMAC - from _hashlib import hmac_new as c_hmac_new + import _hashlib from _hashlib import compare_digest as openssl_compare_digest except ImportError: - _hashopenssl = None - C_HMAC = None - c_hmac_new = None + _hashlib = None openssl_compare_digest = None try: - import _sha256 as sha256_module + import _sha2 as sha2 except ImportError: - sha256_module = None + sha2 = None + + +def requires_builtin_sha2(): + return unittest.skipIf(sha2 is None, "requires _sha2") class TestVectorsTestCase(unittest.TestCase): @@ -88,6 +88,7 @@ def assert_hmac( h, digest, hashname, digest_size, block_size ) + c_hmac_new = getattr(_hashlib, 'hmac_new', None) if c_hmac_new is not None: h = c_hmac_new(key, data, digestmod=hashname) self.assert_hmac_internals( @@ -100,7 +101,7 @@ def assert_hmac( h.update(data) self.assertEqual(h.hexdigest().upper(), digest.upper()) - func = getattr(_hashopenssl, f"openssl_{hashname}") + func = getattr(_hashlib, f"openssl_{hashname}") h = c_hmac_new(key, data, digestmod=func) self.assert_hmac_internals( h, digest, hashname, digest_size, block_size @@ -435,20 +436,20 @@ def test_withmodule(self): except Exception: self.fail("Constructor call with hashlib.sha256 raised exception.") - @unittest.skipUnless(C_HMAC is not None, 'need _hashlib') + @hashlib_helper.requires_hashlib() def test_internal_types(self): - # internal types like _hashlib.C_HMAC are not constructable - check_disallow_instantiation(self, C_HMAC) + # internal C types like are not constructable + check_disallow_instantiation(self, _hashlib.HMAC) with self.assertRaisesRegex(TypeError, "immutable type"): - C_HMAC.value = None + _hashlib.HMAC.value = None - @unittest.skipUnless(sha256_module is not None, 'need _sha256') - def test_with_sha256_module(self): - h = hmac.HMAC(b"key", b"hash this!", digestmod=sha256_module.sha256) + @requires_builtin_sha2() + def test_with_sha2(self): + h = hmac.HMAC(b"key", b"hash this!", digestmod=sha2.sha256) self.assertEqual(h.hexdigest(), self.expected) self.assertEqual(h.name, "hmac-sha256") - digest = hmac.digest(b"key", b"hash this!", sha256_module.sha256) + digest = hmac.digest(b"key", b"hash this!", sha2.sha256) self.assertEqual(digest, binascii.unhexlify(self.expected)) @@ -503,7 +504,7 @@ def test_realcopy_old(self): "No real copy of the attribute 'outer'.") self.assertIs(h1._hmac, None) - @unittest.skipIf(_hashopenssl is None, "test requires _hashopenssl") + @hashlib_helper.requires_hashlib() @hashlib_helper.requires_hashdigest('sha256') def test_realcopy_hmac(self): h1 = hmac.HMAC.__new__(hmac.HMAC) @@ -549,7 +550,7 @@ def test_hmac_compare_digest(self): def test_operator_compare_digest(self): self._test_compare_digest(operator_compare_digest) - @unittest.skipIf(openssl_compare_digest is None, "test requires _hashlib") + @hashlib_helper.requires_hashlib() def test_openssl_compare_digest(self): self._test_compare_digest(openssl_compare_digest) From 3e827a7d7484caff71b40cb2c911908c80c24b8b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A9n=C3=A9dikt=20Tran?= <10796600+picnixz@users.noreply.github.com> Date: Thu, 13 Feb 2025 14:40:18 +0100 Subject: [PATCH 05/24] Add mixins for interacting with HMAC --- Lib/test/test_hmac.py | 93 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 93 insertions(+) diff --git a/Lib/test/test_hmac.py b/Lib/test/test_hmac.py index 1555284b0f01d4..d0354e684ace8a 100644 --- a/Lib/test/test_hmac.py +++ b/Lib/test/test_hmac.py @@ -27,6 +27,99 @@ def requires_builtin_sha2(): return unittest.skipIf(sha2 is None, "requires _sha2") +class ModuleMixin: + hmac = None + + +class PyModuleMixin(ModuleMixin): + """Pure Python implementation of HMAC. + + The underlying hash functions may be OpenSSL-based or HACL* based, + depending on whether OpenSSL is present or not. + """ + + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.hmac = import_fresh_module('hmac', blocked=['_hashlib', '_hmac']) + + +@unittest.skip("no builtin implementation for HMAC for now") +class BuiltinModuleMixin(ModuleMixin): + # TODO(picnixz): uncomment once HACL* HMAC is here + + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.hmac = import_fresh_module('_hmac') + + +class CreatorMixin: + """Mixin exposing a method creating a HMAC object.""" + + def hmac_new(self, key, msg=None, digestmod=None): + raise NotImplementedError + + +class DigestMixin: + """Mixin exposing a method computing a HMAC digest.""" + + def hmac_digest(self, key, msg=None, digestmod=None): + raise NotImplementedError + + +class ThroughObjectMixin(ModuleMixin, CreatorMixin, DigestMixin): + """Mixin delegating to hmac.HMAC() and hmac.HMAC(...).digest().""" + + def hmac_new(self, key, msg=None, digestmod=None): + return self.hmac.HMAC(key, msg, digestmod=digestmod) + + def hmac_digest(self, key, msg=None, digestmod=None): + return self.hmac_new(key, msg, digestmod).digest() + + +class ThroughModuleAPIMixin(ModuleMixin, CreatorMixin, DigestMixin): + """Mixin delegating to hmac.new() and hmac.digest().""" + + def hmac_new(self, key, msg=None, digestmod=None): + return self.hmac.new(key, msg, digestmod=digestmod) + + def hmac_digest(self, key, msg=None, digestmod=None): + return self.hmac.digest(key, msg, digest=digestmod) + + +@hashlib_helper.requires_hashlib() +class ThroughOpenSSLAPIMixin(CreatorMixin, DigestMixin): + """Mixin delegating to _hashlib.hmac_new() and _hashlib.hmac_digest().""" + + def hmac_new(self, key, msg=None, digestmod=None): + return _hashlib.hmac_new(key, msg, digestmod=digestmod) + + def hmac_digest(self, key, msg=None, digestmod=None): + return _hashlib.hmac_digest(key, msg, digest=digestmod) + + +class ThroughBuiltinAPIMixin(ThroughModuleAPIMixin, BuiltinModuleMixin): + """Mixin delegating to _hmac.new() and _hmac.digest().""" + + +class CheckerMixin: + """Mixin for checking HMAC objects (pure Python, OpenSSL or built-in).""" + + def check_object(self, h, digest, hashname, digest_size, block_size): + self.check_internals(h, hashname, digest_size, block_size) + self.check_hexdigest(h, digest, digest_size) + + def check_internals(self, h, hashname, digest_size, block_size): + self.assertEqual(h.name, f"hmac-{hashname}") + self.assertEqual(h.digest_size, digest_size) + self.assertEqual(h.block_size, block_size) + + def check_hexdigest(self, h, digest, digest_size): + self.assertEqual(len(h.digest()), digest_size) + self.assertEqual(h.hexdigest().upper(), digest.upper()) + + class TestVectorsTestCase(unittest.TestCase): def assert_hmac_internals( From 7f4fcc8eaf232dbcfe80de9095c6bb7ed73c8a32 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A9n=C3=A9dikt=20Tran?= <10796600+picnixz@users.noreply.github.com> Date: Thu, 13 Feb 2025 14:40:46 +0100 Subject: [PATCH 06/24] add mixin for RFC test cases --- Lib/test/test_hmac.py | 132 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 132 insertions(+) diff --git a/Lib/test/test_hmac.py b/Lib/test/test_hmac.py index d0354e684ace8a..2753bbba852fe8 100644 --- a/Lib/test/test_hmac.py +++ b/Lib/test/test_hmac.py @@ -120,6 +120,138 @@ def check_hexdigest(self, h, digest, digest_size): self.assertEqual(h.hexdigest().upper(), digest.upper()) +class TestVectorsMixin(CreatorMixin, DigestMixin, CheckerMixin): + """Mixin class for all test vectors test cases.""" + + def hmac_new_by_name(self, key, msg=None, hashname=None): + """Alternative implementation of hmac_new().""" + self.assertIsInstance(hashname, str | None) + return self.hmac_new(key, msg, digestmod=hashname) + + def hmac_digest_by_name(self, key, msg=None, hashname=None): + """Alternative implementation of hmac_digest().""" + self.assertIsInstance(hashname, str | None) + return self.hmac_digest(key, msg, digestmod=hashname) + + def assert_hmac( + self, key, msg, digest, hashfunc, hashname, digest_size, block_size + ): + digestmods = list(filter(None, [hashfunc, hashname])) + self.assertNotEqual(digestmods, [], + "at least one implementation must be tested") + for digestmod in digestmods: + with self.subTest(digestmod=digestmod): + self.assert_hmac_new( + key, msg, digest, digestmod, + hashname, digest_size, block_size + ) + self.assert_hmac_digest( + key, msg, digest, digestmod, digest_size + ) + self.assert_hmac_cases( + key, msg, digest, digestmod, + hashname, digest_size, block_size + ) + + self.assert_hmac_new_by_name( + key, msg, digest, hashname, digest_size, block_size + ) + self.assert_hmac_digest_by_new( + key, msg, digest, hashname, digest_size + ) + + def assert_hmac_new( + self, key, msg, digest, digestmod, hashname, digest_size, block_size + ): + self._check_hmac_new( + key, msg, digest, hashname, digest_size, block_size, + hmac_new_func=self.hmac_new, + hmac_new_kwds={'digestmod': digestmod}, + ) + + def assert_hmac_new_by_name( + self, key, msg, digest, hashname, digest_size, block_size + ): + self._check_hmac_new( + key, msg, digest, hashname, digest_size, block_size, + hmac_new_func=self.hmac_new_by_name, + hmac_new_kwds={'hashname': hashname}, + ) + + def _check_hmac_new( + self, key, msg, digest, hashname, digest_size, block_size, + hmac_new_func, hmac_new_kwds, + ): + h = hmac_new_func(key, msg, **hmac_new_kwds) + self.check_object(h, digest, hashname, digest_size, block_size) + + def hmac_new_feed(*args): + h = hmac_new_func(key, *args, **hmac_new_kwds) + h.update(msg) + self.check_hexdigest(h, digest, digest_size) + + with self.subTest('no initial message'): + hmac_new_feed() + with self.subTest('initial message is empty'): + hmac_new_feed(b'') + with self.subTest('initial message is None'): + hmac_new_feed(None) + + def assert_hmac_cases( + self, key, msg, digest, hashimpl, hashname, digest_size, block_size + ): + """Extra tests that can be added in subclasses.""" + + def assert_hmac_digest( + self, key, msg, digest, digestmod, digest_size, + ): + d = self.hmac_digest(key, msg, digestmod=digestmod) + self.assertEqual(len(d), digest_size) + self.assertEqual(d, binascii.unhexlify(digest)) + + def assert_hmac_digest_by_new( + self, key, msg, digest, hashname, digest_size + ): + self.assertIsInstance(hashname, str | None) + d = self.hmac_digest_by_name(key, msg, hashname=hashname) + self.assertEqual(len(d), digest_size) + self.assertEqual(d, binascii.unhexlify(digest)) + + +class PyTestVectorsMixin(PyModuleMixin, TestVectorsMixin): + + def assert_hmac_cases( + self, key, msg, digest, digestmod, hashname, digest_size, block_size + ): + h1 = self.hmac.HMAC(key, digestmod=digestmod) + h2 = h1.copy() + h2.update(b"test update should not affect original") + h1.update(msg) + self.check_object(h1, digest, hashname, digest_size, block_size) + + h = self.hmac.HMAC.__new__(self.hmac.HMAC) + h._init_old(key, msg, digestmod=digestmod) + self.check_object(h, digest, hashname, digest_size, block_size) + + +class OpenSSLTestVectorsMixin(TestVectorsMixin): + + def hmac_new(self, key, msg=None, digestmod=None): + return _hashlib.hmac_new(key, msg, digestmod=digestmod) + + def hmac_digest(self, key, msg=None, digestmod=None): + return _hashlib.hmac_digest(key, msg, digest=digestmod) + + def hmac_new_by_name(self, key, msg=None, hashname=None): + # ignore 'digestmod' and use the exact openssl function + openssl_func = getattr(_hashlib, f"openssl_{hashname}") + return self.hmac_new(key, msg, digestmod=openssl_func) + + def hmac_digest_by_name(self, key, msg=None, hashname=None): + openssl_func = getattr(_hashlib, f"openssl_{hashname}") + return self.hmac_digest(key, msg, digestmod=openssl_func) + + class TestVectorsTestCase(unittest.TestCase): def assert_hmac_internals( From e47dd8b914a4c66c64fd3b09826020e697a775af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A9n=C3=A9dikt=20Tran?= <10796600+picnixz@users.noreply.github.com> Date: Thu, 13 Feb 2025 14:49:07 +0100 Subject: [PATCH 07/24] use RFC mixin classes --- Lib/test/test_hmac.py | 332 +++++++++++++++++------------------------- 1 file changed, 132 insertions(+), 200 deletions(-) diff --git a/Lib/test/test_hmac.py b/Lib/test/test_hmac.py index 2753bbba852fe8..aedb73e2a049d5 100644 --- a/Lib/test/test_hmac.py +++ b/Lib/test/test_hmac.py @@ -252,104 +252,29 @@ def hmac_digest_by_name(self, key, msg=None, hashname=None): return self.hmac_digest(key, msg, digestmod=openssl_func) -class TestVectorsTestCase(unittest.TestCase): +class RFCTestCasesMixin(TestVectorsMixin): + """Test HMAC implementations against test vectors from the RFC. - def assert_hmac_internals( - self, h, digest, hashname, digest_size, block_size - ): - self.assertEqual(h.hexdigest().upper(), digest.upper()) - self.assertEqual(h.digest(), binascii.unhexlify(digest)) - self.assertEqual(h.name, f"hmac-{hashname}") - self.assertEqual(h.digest_size, digest_size) - self.assertEqual(h.block_size, block_size) - - def assert_hmac( - self, key, data, digest, hashfunc, hashname, digest_size, block_size - ): - h = hmac.HMAC(key, data, digestmod=hashfunc) - self.assert_hmac_internals( - h, digest, hashname, digest_size, block_size - ) - - h = hmac.HMAC(key, data, digestmod=hashname) - self.assert_hmac_internals( - h, digest, hashname, digest_size, block_size - ) - - h = hmac.HMAC(key, digestmod=hashname) - h2 = h.copy() - h2.update(b"test update") - h.update(data) - self.assertEqual(h.hexdigest().upper(), digest.upper()) - - h = hmac.new(key, data, digestmod=hashname) - self.assert_hmac_internals( - h, digest, hashname, digest_size, block_size - ) - - h = hmac.new(key, None, digestmod=hashname) - h.update(data) - self.assertEqual(h.hexdigest().upper(), digest.upper()) - - h = hmac.new(key, digestmod=hashname) - h.update(data) - self.assertEqual(h.hexdigest().upper(), digest.upper()) - - h = hmac.new(key, data, digestmod=hashfunc) - self.assertEqual(h.hexdigest().upper(), digest.upper()) - - self.assertEqual( - hmac.digest(key, data, digest=hashname), - binascii.unhexlify(digest) - ) - self.assertEqual( - hmac.digest(key, data, digest=hashfunc), - binascii.unhexlify(digest) - ) - - h = hmac.HMAC.__new__(hmac.HMAC) - h._init_old(key, data, digestmod=hashname) - self.assert_hmac_internals( - h, digest, hashname, digest_size, block_size - ) - - c_hmac_new = getattr(_hashlib, 'hmac_new', None) - if c_hmac_new is not None: - h = c_hmac_new(key, data, digestmod=hashname) - self.assert_hmac_internals( - h, digest, hashname, digest_size, block_size - ) - - h = c_hmac_new(key, digestmod=hashname) - h2 = h.copy() - h2.update(b"test update") - h.update(data) - self.assertEqual(h.hexdigest().upper(), digest.upper()) + Subclasses must override the 'md5', 'sha1', and 'sha2_*' attributes + to test the implementations. Their value can be a string, a callable, + or a PEP-257 module. + """ - func = getattr(_hashlib, f"openssl_{hashname}") - h = c_hmac_new(key, data, digestmod=func) - self.assert_hmac_internals( - h, digest, hashname, digest_size, block_size - ) + ALGORITHMS = [ + 'md5', 'sha1', + 'sha224', 'sha256', 'sha384', 'sha512', + ] - h = hmac.HMAC.__new__(hmac.HMAC) - h._init_hmac(key, data, digestmod=hashname) - self.assert_hmac_internals( - h, digest, hashname, digest_size, block_size - ) + md5 = sha1 = sha224 = sha256 = sha384 = sha512 = None - @hashlib_helper.requires_hashdigest('md5', openssl=True) - def test_md5_vectors(self): - # Test the HMAC module against test vectors from the RFC. + def __init_subclass__(cls, *args, **kwargs): + super().__init_subclass__(*args, **kwargs) + for name in cls.ALGORITHMS: + setattr(cls, name, name) - def md5test(key, data, digest): - self.assert_hmac( - key, data, digest, - hashfunc=hashlib.md5, - hashname="md5", - digest_size=16, - block_size=64 - ) + def test_md5(self): + def md5test(key, msg, digest): + self.assert_hmac(key, msg, digest, self.md5, "md5", 16, 64) md5test(b"\x0b" * 16, b"Hi There", @@ -380,16 +305,9 @@ def md5test(key, data, digest): b"and Larger Than One Block-Size Data"), "6f630fad67cda0ee1fb1f562db3aa53e") - @hashlib_helper.requires_hashdigest('sha1', openssl=True) - def test_sha_vectors(self): - def shatest(key, data, digest): - self.assert_hmac( - key, data, digest, - hashfunc=hashlib.sha1, - hashname="sha1", - digest_size=20, - block_size=64 - ) + def test_sha1(self): + def shatest(key, msg, digest): + self.assert_hmac(key, msg, digest, self.sha1, "sha1", 20, 64) shatest(b"\x0b" * 20, b"Hi There", @@ -420,14 +338,27 @@ def shatest(key, data, digest): b"and Larger Than One Block-Size Data"), "e8e99d0f45237d786d6bbaa7965c7808bbff1a91") - def _rfc4231_test_cases(self, hashfunc, hash_name, digest_size, block_size): + def test_sha2_224_rfc4231(self): + self._test_sha2_rfc4231(self.sha224, 'sha224', 28, 64) + + def test_sha2_256_rfc4231(self): + self._test_sha2_rfc4231(self.sha256, 'sha256', 32, 64) + + def test_sha2_384_rfc4231(self): + self._test_sha2_rfc4231(self.sha384, 'sha384', 48, 128) + + def test_sha2_512_rfc4231(self): + self._test_sha2_rfc4231(self.sha512, 'sha512', 64, 128) + + def _test_sha2_rfc4231(self, hashfunc, hashname, digest_size, block_size): + def hmactest(key, data, hexdigests): - digest = hexdigests[hashfunc] + digest = hexdigests[hashname] self.assert_hmac( key, data, digest, hashfunc=hashfunc, - hashname=hash_name, + hashname=hashname, digest_size=digest_size, block_size=block_size ) @@ -436,68 +367,68 @@ def hmactest(key, data, hexdigests): hmactest(key=b'\x0b' * 20, data=b'Hi There', hexdigests={ - hashlib.sha224: '896fb1128abbdf196832107cd49df33f' - '47b4b1169912ba4f53684b22', - hashlib.sha256: 'b0344c61d8db38535ca8afceaf0bf12b' - '881dc200c9833da726e9376c2e32cff7', - hashlib.sha384: 'afd03944d84895626b0825f4ab46907f' - '15f9dadbe4101ec682aa034c7cebc59c' - 'faea9ea9076ede7f4af152e8b2fa9cb6', - hashlib.sha512: '87aa7cdea5ef619d4ff0b4241a1d6cb0' - '2379f4e2ce4ec2787ad0b30545e17cde' - 'daa833b7d6b8a702038b274eaea3f4e4' - 'be9d914eeb61f1702e696c203a126854', + 'sha224': '896fb1128abbdf196832107cd49df33f' + '47b4b1169912ba4f53684b22', + 'sha256': 'b0344c61d8db38535ca8afceaf0bf12b' + '881dc200c9833da726e9376c2e32cff7', + 'sha384': 'afd03944d84895626b0825f4ab46907f' + '15f9dadbe4101ec682aa034c7cebc59c' + 'faea9ea9076ede7f4af152e8b2fa9cb6', + 'sha512': '87aa7cdea5ef619d4ff0b4241a1d6cb0' + '2379f4e2ce4ec2787ad0b30545e17cde' + 'daa833b7d6b8a702038b274eaea3f4e4' + 'be9d914eeb61f1702e696c203a126854', }) # 4.3. Test Case 2 hmactest(key=b'Jefe', data=b'what do ya want for nothing?', hexdigests={ - hashlib.sha224: 'a30e01098bc6dbbf45690f3a7e9e6d0f' - '8bbea2a39e6148008fd05e44', - hashlib.sha256: '5bdcc146bf60754e6a042426089575c7' - '5a003f089d2739839dec58b964ec3843', - hashlib.sha384: 'af45d2e376484031617f78d2b58a6b1b' - '9c7ef464f5a01b47e42ec3736322445e' - '8e2240ca5e69e2c78b3239ecfab21649', - hashlib.sha512: '164b7a7bfcf819e2e395fbe73b56e0a3' - '87bd64222e831fd610270cd7ea250554' - '9758bf75c05a994a6d034f65f8f0e6fd' - 'caeab1a34d4a6b4b636e070a38bce737', + 'sha224': 'a30e01098bc6dbbf45690f3a7e9e6d0f' + '8bbea2a39e6148008fd05e44', + 'sha256': '5bdcc146bf60754e6a042426089575c7' + '5a003f089d2739839dec58b964ec3843', + 'sha384': 'af45d2e376484031617f78d2b58a6b1b' + '9c7ef464f5a01b47e42ec3736322445e' + '8e2240ca5e69e2c78b3239ecfab21649', + 'sha512': '164b7a7bfcf819e2e395fbe73b56e0a3' + '87bd64222e831fd610270cd7ea250554' + '9758bf75c05a994a6d034f65f8f0e6fd' + 'caeab1a34d4a6b4b636e070a38bce737', }) # 4.4. Test Case 3 hmactest(key=b'\xaa' * 20, data=b'\xdd' * 50, hexdigests={ - hashlib.sha224: '7fb3cb3588c6c1f6ffa9694d7d6ad264' - '9365b0c1f65d69d1ec8333ea', - hashlib.sha256: '773ea91e36800e46854db8ebd09181a7' - '2959098b3ef8c122d9635514ced565fe', - hashlib.sha384: '88062608d3e6ad8a0aa2ace014c8a86f' - '0aa635d947ac9febe83ef4e55966144b' - '2a5ab39dc13814b94e3ab6e101a34f27', - hashlib.sha512: 'fa73b0089d56a284efb0f0756c890be9' - 'b1b5dbdd8ee81a3655f83e33b2279d39' - 'bf3e848279a722c806b485a47e67c807' - 'b946a337bee8942674278859e13292fb', + 'sha224': '7fb3cb3588c6c1f6ffa9694d7d6ad264' + '9365b0c1f65d69d1ec8333ea', + 'sha256': '773ea91e36800e46854db8ebd09181a7' + '2959098b3ef8c122d9635514ced565fe', + 'sha384': '88062608d3e6ad8a0aa2ace014c8a86f' + '0aa635d947ac9febe83ef4e55966144b' + '2a5ab39dc13814b94e3ab6e101a34f27', + 'sha512': 'fa73b0089d56a284efb0f0756c890be9' + 'b1b5dbdd8ee81a3655f83e33b2279d39' + 'bf3e848279a722c806b485a47e67c807' + 'b946a337bee8942674278859e13292fb', }) # 4.5. Test Case 4 hmactest(key=bytes(x for x in range(0x01, 0x19 + 1)), data=b'\xcd' * 50, hexdigests={ - hashlib.sha224: '6c11506874013cac6a2abc1bb382627c' - 'ec6a90d86efc012de7afec5a', - hashlib.sha256: '82558a389a443c0ea4cc819899f2083a' - '85f0faa3e578f8077a2e3ff46729665b', - hashlib.sha384: '3e8a69b7783c25851933ab6290af6ca7' - '7a9981480850009cc5577c6e1f573b4e' - '6801dd23c4a7d679ccf8a386c674cffb', - hashlib.sha512: 'b0ba465637458c6990e5a8c5f61d4af7' - 'e576d97ff94b872de76f8050361ee3db' - 'a91ca5c11aa25eb4d679275cc5788063' - 'a5f19741120c4f2de2adebeb10a298dd', + 'sha224': '6c11506874013cac6a2abc1bb382627c' + 'ec6a90d86efc012de7afec5a', + 'sha256': '82558a389a443c0ea4cc819899f2083a' + '85f0faa3e578f8077a2e3ff46729665b', + 'sha384': '3e8a69b7783c25851933ab6290af6ca7' + '7a9981480850009cc5577c6e1f573b4e' + '6801dd23c4a7d679ccf8a386c674cffb', + 'sha512': 'b0ba465637458c6990e5a8c5f61d4af7' + 'e576d97ff94b872de76f8050361ee3db' + 'a91ca5c11aa25eb4d679275cc5788063' + 'a5f19741120c4f2de2adebeb10a298dd', }) # 4.7. Test Case 6 @@ -505,17 +436,17 @@ def hmactest(key, data, hexdigests): data=b'Test Using Larger Than Block-Siz' b'e Key - Hash Key First', hexdigests={ - hashlib.sha224: '95e9a0db962095adaebe9b2d6f0dbce2' - 'd499f112f2d2b7273fa6870e', - hashlib.sha256: '60e431591ee0b67f0d8a26aacbf5b77f' - '8e0bc6213728c5140546040f0ee37f54', - hashlib.sha384: '4ece084485813e9088d2c63a041bc5b4' - '4f9ef1012a2b588f3cd11f05033ac4c6' - '0c2ef6ab4030fe8296248df163f44952', - hashlib.sha512: '80b24263c7c1a3ebb71493c1dd7be8b4' - '9b46d1f41b4aeec1121b013783f8f352' - '6b56d037e05f2598bd0fd2215d6a1e52' - '95e64f73f63f0aec8b915a985d786598', + 'sha224': '95e9a0db962095adaebe9b2d6f0dbce2' + 'd499f112f2d2b7273fa6870e', + 'sha256': '60e431591ee0b67f0d8a26aacbf5b77f' + '8e0bc6213728c5140546040f0ee37f54', + 'sha384': '4ece084485813e9088d2c63a041bc5b4' + '4f9ef1012a2b588f3cd11f05033ac4c6' + '0c2ef6ab4030fe8296248df163f44952', + 'sha512': '80b24263c7c1a3ebb71493c1dd7be8b4' + '9b46d1f41b4aeec1121b013783f8f352' + '6b56d037e05f2598bd0fd2215d6a1e52' + '95e64f73f63f0aec8b915a985d786598', }) # 4.8. Test Case 7 @@ -526,35 +457,19 @@ def hmactest(key, data, hexdigests): b'ds to be hashed before being use' b'd by the HMAC algorithm.', hexdigests={ - hashlib.sha224: '3a854166ac5d9f023f54d517d0b39dbd' - '946770db9c2b95c9f6f565d1', - hashlib.sha256: '9b09ffa71b942fcb27635fbcd5b0e944' - 'bfdc63644f0713938a7f51535c3a35e2', - hashlib.sha384: '6617178e941f020d351e2f254e8fd32c' - '602420feb0b8fb9adccebb82461e99c5' - 'a678cc31e799176d3860e6110c46523e', - hashlib.sha512: 'e37b6a775dc87dbaa4dfa9f96e5e3ffd' - 'debd71f8867289865df5a32d20cdc944' - 'b6022cac3c4982b10d5eeb55c3e4de15' - '134676fb6de0446065c97440fa8c6a58', + 'sha224': '3a854166ac5d9f023f54d517d0b39dbd' + '946770db9c2b95c9f6f565d1', + 'sha256': '9b09ffa71b942fcb27635fbcd5b0e944' + 'bfdc63644f0713938a7f51535c3a35e2', + 'sha384': '6617178e941f020d351e2f254e8fd32c' + '602420feb0b8fb9adccebb82461e99c5' + 'a678cc31e799176d3860e6110c46523e', + 'sha512': 'e37b6a775dc87dbaa4dfa9f96e5e3ffd' + 'debd71f8867289865df5a32d20cdc944' + 'b6022cac3c4982b10d5eeb55c3e4de15' + '134676fb6de0446065c97440fa8c6a58', }) - @hashlib_helper.requires_hashdigest('sha224', openssl=True) - def test_sha224_rfc4231(self): - self._rfc4231_test_cases(hashlib.sha224, 'sha224', 28, 64) - - @hashlib_helper.requires_hashdigest('sha256', openssl=True) - def test_sha256_rfc4231(self): - self._rfc4231_test_cases(hashlib.sha256, 'sha256', 32, 64) - - @hashlib_helper.requires_hashdigest('sha384', openssl=True) - def test_sha384_rfc4231(self): - self._rfc4231_test_cases(hashlib.sha384, 'sha384', 48, 128) - - @hashlib_helper.requires_hashdigest('sha512', openssl=True) - def test_sha512_rfc4231(self): - self._rfc4231_test_cases(hashlib.sha512, 'sha512', 64, 128) - @hashlib_helper.requires_hashdigest('sha256') def test_legacy_block_size_warnings(self): class MockCrazyHash(object): @@ -578,28 +493,45 @@ def digest(self): hmac.HMAC(b'a', b'b', digestmod=MockCrazyHash) self.fail('Expected warning about small block_size') - def test_with_digestmod_no_default(self): - """The digestmod parameter is required as of Python 3.8.""" - with self.assertRaisesRegex(TypeError, r'required.*digestmod'): - key = b"\x0b" * 16 - data = b"Hi There" - hmac.HMAC(key, data, digestmod=None) - with self.assertRaisesRegex(TypeError, r'required.*digestmod'): - hmac.new(key, data) - with self.assertRaisesRegex(TypeError, r'required.*digestmod'): - hmac.HMAC(key, msg=data, digestmod='') - def test_with_fallback(self): cache = getattr(hashlib, '__builtin_constructor_cache') try: cache['foo'] = hashlib.sha256 hexdigest = hmac.digest(b'key', b'message', 'foo').hex() - expected = '6e9ef29b75fffc5b7abae527d58fdadb2fe42e7219011976917343065f58ed4a' + expected = ('6e9ef29b75fffc5b7abae527d58fdadb' + '2fe42e7219011976917343065f58ed4a') self.assertEqual(hexdigest, expected) finally: cache.pop('foo') +class PyRFCTestCase(PyTestVectorsMixin, ThroughObjectMixin, + RFCTestCasesMixin, unittest.TestCase): + """Python implementation of HMAC using hmac.HMAC().""" + + +class PyDotNewRFCTestCase(PyTestVectorsMixin, ThroughModuleAPIMixin, + RFCTestCasesMixin, unittest.TestCase): + """Python implementation of HMAC using hmac.new().""" + + +@hashlib_helper.requires_hashlib() +class OpenSSLRFCTestCase(OpenSSLTestVectorsMixin, RFCTestCasesMixin, + unittest.TestCase): + """OpenSSL implementation of HMAC.""" + + @classmethod + def setUpClass(cls): + super().setUpClass() + + for name in cls.ALGORITHMS: + @property + @hashlib_helper.requires_hashdigest(name, openssl=True) + def func(self, *, __name=name): # __name needed to bind 'name' + return getattr(_hashlib, f'openssl_{__name}') + setattr(cls, name, func) + + class ConstructorTestCase(unittest.TestCase): expected = ( "6c845b47f52b3b47f6590c502db7825aad757bf4fadc8fa972f7cd2e76a5bdeb" From acda1223551de56863a644b4af5d27dd85bbe9c8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A9n=C3=A9dikt=20Tran?= <10796600+picnixz@users.noreply.github.com> Date: Thu, 13 Feb 2025 14:51:03 +0100 Subject: [PATCH 08/24] refactor `CompareDigestTestCase` --- Lib/test/test_hmac.py | 161 ++++++++++++++++++++++-------------------- 1 file changed, 84 insertions(+), 77 deletions(-) diff --git a/Lib/test/test_hmac.py b/Lib/test/test_hmac.py index aedb73e2a049d5..fcf98af2fe3fb1 100644 --- a/Lib/test/test_hmac.py +++ b/Lib/test/test_hmac.py @@ -695,126 +695,133 @@ def test_equality_new(self): "Hexdigest of copy doesn't match original hexdigest.") -class CompareDigestTestCase(unittest.TestCase): +class CompareDigestMixin: - def test_hmac_compare_digest(self): - self._test_compare_digest(hmac.compare_digest) - if openssl_compare_digest is not None: - self.assertIs(hmac.compare_digest, openssl_compare_digest) - else: - self.assertIs(hmac.compare_digest, operator_compare_digest) - - def test_operator_compare_digest(self): - self._test_compare_digest(operator_compare_digest) - - @hashlib_helper.requires_hashlib() - def test_openssl_compare_digest(self): - self._test_compare_digest(openssl_compare_digest) - - def _test_compare_digest(self, compare_digest): - # Testing input type exception handling - a, b = 100, 200 - self.assertRaises(TypeError, compare_digest, a, b) - a, b = 100, b"foobar" - self.assertRaises(TypeError, compare_digest, a, b) - a, b = b"foobar", 200 - self.assertRaises(TypeError, compare_digest, a, b) - a, b = "foobar", b"foobar" - self.assertRaises(TypeError, compare_digest, a, b) - a, b = b"foobar", "foobar" - self.assertRaises(TypeError, compare_digest, a, b) + def compare_digest(self, a, b): + raise NotImplementedError + def assert_digest_equal(self, a, b): + with self.subTest(a=a, b=b): + self.assertTrue(self.compare_digest(a, b)) + with self.subTest(a=b, b=a): + self.assertTrue(self.compare_digest(b, a)) + + def assert_digest_not_equal(self, a, b): + with self.subTest(a=a, b=b): + self.assertFalse(self.compare_digest(a, b)) + with self.subTest(a=b, b=a): + self.assertFalse(self.compare_digest(b, a)) + + def test_exceptions(self): + for a, b in [ + # Testing input type exception handling + (100, 200), (100, b"foobar"), ("foobar", b"foobar"), + # non-ASCII strings + ("fooä", "fooä") + ]: + self.assertRaises(TypeError, self.compare_digest, a, b) + self.assertRaises(TypeError, self.compare_digest, b, a) + + def test_bytes(self): # Testing bytes of different lengths a, b = b"foobar", b"foo" - self.assertFalse(compare_digest(a, b)) + self.assert_digest_not_equal(a, b) a, b = b"\xde\xad\xbe\xef", b"\xde\xad" - self.assertFalse(compare_digest(a, b)) + self.assert_digest_not_equal(a, b) # Testing bytes of same lengths, different values a, b = b"foobar", b"foobaz" - self.assertFalse(compare_digest(a, b)) + self.assert_digest_not_equal(a, b) a, b = b"\xde\xad\xbe\xef", b"\xab\xad\x1d\xea" - self.assertFalse(compare_digest(a, b)) + self.assert_digest_not_equal(a, b) # Testing bytes of same lengths, same values a, b = b"foobar", b"foobar" - self.assertTrue(compare_digest(a, b)) + self.assert_digest_equal(a, b) a, b = b"\xde\xad\xbe\xef", b"\xde\xad\xbe\xef" - self.assertTrue(compare_digest(a, b)) + self.assert_digest_equal(a, b) + def test_bytearray(self): # Testing bytearrays of same lengths, same values a, b = bytearray(b"foobar"), bytearray(b"foobar") - self.assertTrue(compare_digest(a, b)) + self.assert_digest_equal(a, b) # Testing bytearrays of different lengths a, b = bytearray(b"foobar"), bytearray(b"foo") - self.assertFalse(compare_digest(a, b)) + self.assert_digest_not_equal(a, b) # Testing bytearrays of same lengths, different values a, b = bytearray(b"foobar"), bytearray(b"foobaz") - self.assertFalse(compare_digest(a, b)) + self.assert_digest_not_equal(a, b) + def test_mixed_types(self): # Testing byte and bytearray of same lengths, same values a, b = bytearray(b"foobar"), b"foobar" - self.assertTrue(compare_digest(a, b)) - self.assertTrue(compare_digest(b, a)) + self.assert_digest_equal(a, b) # Testing byte bytearray of different lengths a, b = bytearray(b"foobar"), b"foo" - self.assertFalse(compare_digest(a, b)) - self.assertFalse(compare_digest(b, a)) + self.assert_digest_not_equal(a, b) # Testing byte and bytearray of same lengths, different values a, b = bytearray(b"foobar"), b"foobaz" - self.assertFalse(compare_digest(a, b)) - self.assertFalse(compare_digest(b, a)) + self.assert_digest_not_equal(a, b) + def test_string(self): # Testing str of same lengths a, b = "foobar", "foobar" - self.assertTrue(compare_digest(a, b)) + self.assert_digest_equal(a, b) # Testing str of different lengths a, b = "foo", "foobar" - self.assertFalse(compare_digest(a, b)) + self.assert_digest_not_equal(a, b) - # Testing bytes of same lengths, different values + # Testing str of same lengths, different values a, b = "foobar", "foobaz" - self.assertFalse(compare_digest(a, b)) - - # Testing error cases - a, b = "foobar", b"foobar" - self.assertRaises(TypeError, compare_digest, a, b) - a, b = b"foobar", "foobar" - self.assertRaises(TypeError, compare_digest, a, b) - a, b = b"foobar", 1 - self.assertRaises(TypeError, compare_digest, a, b) - a, b = 100, 200 - self.assertRaises(TypeError, compare_digest, a, b) - a, b = "fooä", "fooä" - self.assertRaises(TypeError, compare_digest, a, b) - - # subclasses are supported by ignore __eq__ - class mystr(str): + self.assert_digest_not_equal(a, b) + + def test_string_subclass(self): + class S(str): def __eq__(self, other): - return False + raise ValueError("should not be called") - a, b = mystr("foobar"), mystr("foobar") - self.assertTrue(compare_digest(a, b)) - a, b = mystr("foobar"), "foobar" - self.assertTrue(compare_digest(a, b)) - a, b = mystr("foobar"), mystr("foobaz") - self.assertFalse(compare_digest(a, b)) + a, b = S("foobar"), S("foobar") + self.assert_digest_equal(a, b) + a, b = S("foobar"), "foobar" + self.assert_digest_equal(a, b) + a, b = S("foobar"), S("foobaz") + self.assert_digest_not_equal(a, b) - class mybytes(bytes): + def test_bytes_subclass(self): + class B(bytes): def __eq__(self, other): - return False - - a, b = mybytes(b"foobar"), mybytes(b"foobar") - self.assertTrue(compare_digest(a, b)) - a, b = mybytes(b"foobar"), b"foobar" - self.assertTrue(compare_digest(a, b)) - a, b = mybytes(b"foobar"), mybytes(b"foobaz") - self.assertFalse(compare_digest(a, b)) + raise ValueError("should not be called") + + a, b = B(b"foobar"), B(b"foobar") + self.assert_digest_equal(a, b) + a, b = B(b"foobar"), b"foobar" + self.assert_digest_equal(a, b) + a, b = B(b"foobar"), B(b"foobaz") + self.assert_digest_not_equal(a, b) + + +class HMACCompareDigestTestCase(CompareDigestMixin, unittest.TestCase): + compare_digest = hmac.compare_digest + + def test_compare_digest_func(self): + if openssl_compare_digest is not None: + self.assertIs(hmac.compare_digest, openssl_compare_digest) + else: + self.assertIs(hmac.compare_digest, operator_compare_digest) + + +@hashlib_helper.requires_hashlib() +class OpenSSLCompareDigestTestCase(CompareDigestMixin, unittest.TestCase): + compare_digest = openssl_compare_digest + + +class OperatorCompareDigestTestCase(CompareDigestMixin, unittest.TestCase): + compare_digest = operator_compare_digest if __name__ == "__main__": From d2eb48a282108ab1ad6f960133fe35551e0e0ff6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A9n=C3=A9dikt=20Tran?= <10796600+picnixz@users.noreply.github.com> Date: Thu, 13 Feb 2025 14:51:37 +0100 Subject: [PATCH 09/24] refactor `CopyTestCase` --- Lib/test/test_hmac.py | 42 +++++++++++++++--------------------------- 1 file changed, 15 insertions(+), 27 deletions(-) diff --git a/Lib/test/test_hmac.py b/Lib/test/test_hmac.py index fcf98af2fe3fb1..b83d4bad7df3db 100644 --- a/Lib/test/test_hmac.py +++ b/Lib/test/test_hmac.py @@ -634,65 +634,53 @@ def test_with_str_update(self): h.update("invalid update") +@hashlib_helper.requires_hashdigest('sha256') class CopyTestCase(unittest.TestCase): - @hashlib_helper.requires_hashdigest('sha256') def test_attributes_old(self): # Testing if attributes are of same type. h1 = hmac.HMAC.__new__(hmac.HMAC) h1._init_old(b"key", b"msg", digestmod="sha256") h2 = h1.copy() - self.assertEqual(type(h1._inner), type(h2._inner), - "Types of inner don't match.") - self.assertEqual(type(h1._outer), type(h2._outer), - "Types of outer don't match.") + self.assertEqual(type(h1._inner), type(h2._inner)) + self.assertEqual(type(h1._outer), type(h2._outer)) - @hashlib_helper.requires_hashdigest('sha256') def test_realcopy_old(self): # Testing if the copy method created a real copy. h1 = hmac.HMAC.__new__(hmac.HMAC) h1._init_old(b"key", b"msg", digestmod="sha256") + self.assertIsNone(h1._hmac) + h2 = h1.copy() + self.assertIsNone(h2._hmac) # Using id() in case somebody has overridden __eq__/__ne__. - self.assertTrue(id(h1) != id(h2), "No real copy of the HMAC instance.") - self.assertTrue(id(h1._inner) != id(h2._inner), - "No real copy of the attribute 'inner'.") - self.assertTrue(id(h1._outer) != id(h2._outer), - "No real copy of the attribute 'outer'.") - self.assertIs(h1._hmac, None) + self.assertNotEqual(id(h1), id(h2)) + self.assertNotEqual(id(h1._inner), id(h2._inner)) + self.assertNotEqual(id(h1._outer), id(h2._outer)) @hashlib_helper.requires_hashlib() - @hashlib_helper.requires_hashdigest('sha256') def test_realcopy_hmac(self): h1 = hmac.HMAC.__new__(hmac.HMAC) h1._init_hmac(b"key", b"msg", digestmod="sha256") h2 = h1.copy() - self.assertTrue(id(h1._hmac) != id(h2._hmac)) + self.assertNotEqual(id(h1._hmac), id(h2._hmac)) - @hashlib_helper.requires_hashdigest('sha256') def test_equality(self): # Testing if the copy has the same digests. h1 = hmac.HMAC(b"key", digestmod="sha256") h1.update(b"some random text") h2 = h1.copy() - self.assertEqual(h1.digest(), h2.digest(), - "Digest of copy doesn't match original digest.") - self.assertEqual(h1.hexdigest(), h2.hexdigest(), - "Hexdigest of copy doesn't match original hexdigest.") + self.assertEqual(h1.digest(), h2.digest()) + self.assertEqual(h1.hexdigest(), h2.hexdigest()) - @hashlib_helper.requires_hashdigest('sha256') def test_equality_new(self): # Testing if the copy has the same digests with hmac.new(). h1 = hmac.new(b"key", digestmod="sha256") h1.update(b"some random text") h2 = h1.copy() - self.assertTrue( - id(h1) != id(h2), "No real copy of the HMAC instance." - ) - self.assertEqual(h1.digest(), h2.digest(), - "Digest of copy doesn't match original digest.") - self.assertEqual(h1.hexdigest(), h2.hexdigest(), - "Hexdigest of copy doesn't match original hexdigest.") + self.assertNotEqual(id(h1), id(h2)) + self.assertEqual(h1.digest(), h2.digest()) + self.assertEqual(h1.hexdigest(), h2.hexdigest()) class CompareDigestMixin: From 105f6ce2aff47d376a92e9720f572f09ef441580 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A9n=C3=A9dikt=20Tran?= <10796600+picnixz@users.noreply.github.com> Date: Thu, 13 Feb 2025 14:52:04 +0100 Subject: [PATCH 10/24] refactor `UpdateTestCase` --- Lib/test/test_hmac.py | 48 +++++++++++++++++++++++++++++++++++++------ 1 file changed, 42 insertions(+), 6 deletions(-) diff --git a/Lib/test/test_hmac.py b/Lib/test/test_hmac.py index b83d4bad7df3db..cc63bef432aa4f 100644 --- a/Lib/test/test_hmac.py +++ b/Lib/test/test_hmac.py @@ -2,6 +2,7 @@ import functools import hmac import hashlib +import random import test.support.hashlib_helper as hashlib_helper import unittest import unittest.mock @@ -626,12 +627,47 @@ def test_exercise_all_methods(self): self.fail("Exception raised during normal usage of HMAC class.") -class UpdateTestCase(unittest.TestCase): - @hashlib_helper.requires_hashdigest('sha256') - def test_with_str_update(self): - with self.assertRaises(TypeError): - h = hmac.new(b"key", digestmod='sha256') - h.update("invalid update") +class UpdateTestCaseMixin: + + def HMAC(self, key, msg=None): + raise NotImplementedError + + def test_update(self): + key, msg = random.randbytes(16), random.randbytes(16) + with self.subTest(key=key, msg=msg): + h1 = self.HMAC(key, msg) + + h2 = self.HMAC(key) + h2.update(msg) + + self.assertEqual(h1.digest(), h2.digest()) + self.assertEqual(h1.hexdigest(), h2.hexdigest()) + + def test_update_exceptions(self): + h = self.HMAC(b"key") + for msg in ['invalid msg', 123, (), []]: + with self.subTest(msg=msg): + self.assertRaises(TypeError, h.update, msg) + + +@hashlib_helper.requires_hashdigest('sha256') +class PyUpdateTestCase(UpdateTestCaseMixin, unittest.TestCase): + + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.hmac = import_fresh_module('hmac', blocked=['_hashlib']) + + def HMAC(self, key, msg=None): + return self.hmac.HMAC(key, msg, digestmod='sha256') + + +@hashlib_helper.requires_hashlib() +@hashlib_helper.requires_hashdigest('sha256', openssl=True) +class OpenSSLUpdateTestCase(UpdateTestCaseMixin, unittest.TestCase): + + def HMAC(self, key, msg=None): + return hmac.new(key, msg, digestmod='sha256') @hashlib_helper.requires_hashdigest('sha256') From 412f5c2721cdbed12f1ad4a6b26b0c15710b4826 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A9n=C3=A9dikt=20Tran?= <10796600+picnixz@users.noreply.github.com> Date: Thu, 13 Feb 2025 14:52:44 +0100 Subject: [PATCH 11/24] refactor `SanityTestCase` --- Lib/test/test_hmac.py | 42 ++++++++++++++++++++++++++++++------------ 1 file changed, 30 insertions(+), 12 deletions(-) diff --git a/Lib/test/test_hmac.py b/Lib/test/test_hmac.py index cc63bef432aa4f..3b8a868078eabb 100644 --- a/Lib/test/test_hmac.py +++ b/Lib/test/test_hmac.py @@ -611,20 +611,38 @@ def test_with_sha2(self): self.assertEqual(digest, binascii.unhexlify(self.expected)) -class SanityTestCase(unittest.TestCase): +class SanityTestCaseMixin(CreatorMixin): + hmac_class = None @hashlib_helper.requires_hashdigest('sha256') - def test_exercise_all_methods(self): - # Exercising all methods once. - # This must not raise any exceptions - try: - h = hmac.HMAC(b"my secret key", digestmod="sha256") - h.update(b"compute the hash of this text!") - h.digest() - h.hexdigest() - h.copy() - except Exception: - self.fail("Exception raised during normal usage of HMAC class.") + def test_methods(self): + h = self.hmac_new(b"my secret key", digestmod="sha256") + self.check(h) + + def check(self, h): + self.assertIsInstance(h, self.hmac_class) + self.assertIsNone(h.update(b"compute the hash of this text!")) + self.assertIsInstance(h.digest(), bytes) + self.assertIsInstance(h.hexdigest(), str) + self.assertIsInstance(h.copy(), self.hmac_class) + + +class PySanityTestCase(ThroughObjectMixin, PyModuleMixin, SanityTestCaseMixin, + unittest.TestCase): + + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.hmac_class = cls.hmac.HMAC + + +class OpenSSLSanityTestCase(ThroughOpenSSLAPIMixin, SanityTestCaseMixin, + unittest.TestCase): + + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.hmac_class = _hashlib.HMAC class UpdateTestCaseMixin: From c68294509c2bf10d9cc0537ac8439253ac2dc488 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A9n=C3=A9dikt=20Tran?= <10796600+picnixz@users.noreply.github.com> Date: Thu, 13 Feb 2025 15:32:00 +0100 Subject: [PATCH 12/24] refactor `ConstructorTestCase` --- Lib/test/test_hmac.py | 237 ++++++++++++++++++++++++++++++------------ 1 file changed, 173 insertions(+), 64 deletions(-) diff --git a/Lib/test/test_hmac.py b/Lib/test/test_hmac.py index 3b8a868078eabb..cc39ede69aefed 100644 --- a/Lib/test/test_hmac.py +++ b/Lib/test/test_hmac.py @@ -61,6 +61,9 @@ class CreatorMixin: def hmac_new(self, key, msg=None, digestmod=None): raise NotImplementedError + def bind_hmac_new(self, digestmod): + return functools.partial(self.hmac_new, digestmod=digestmod) + class DigestMixin: """Mixin exposing a method computing a HMAC digest.""" @@ -68,6 +71,9 @@ class DigestMixin: def hmac_digest(self, key, msg=None, digestmod=None): raise NotImplementedError + def bind_hmac_digest(self, digestmod): + return functools.partial(self.hmac_digest, digestmod=digestmod) + class ThroughObjectMixin(ModuleMixin, CreatorMixin, DigestMixin): """Mixin delegating to hmac.HMAC() and hmac.HMAC(...).digest().""" @@ -533,82 +539,185 @@ def func(self, *, __name=name): # __name needed to bind 'name' setattr(cls, name, func) -class ConstructorTestCase(unittest.TestCase): - expected = ( - "6c845b47f52b3b47f6590c502db7825aad757bf4fadc8fa972f7cd2e76a5bdeb" - ) +class DigestModTestCaseMixin(CreatorMixin, DigestMixin): - @hashlib_helper.requires_hashdigest('sha256') - def test_normal(self): - # Standard constructor call. - try: - hmac.HMAC(b"key", digestmod='sha256') - except Exception: - self.fail("Standard constructor call raised exception.") + def make_digestmod_cases(self, func, digestmods): + return [ + *[ + (func, args, dict(digestmod=digestmod)) + for args in [(self.key,), (self.key, self.msg)] + for digestmod in digestmods + ], + *[ + (func, (self.key,), dict(msg=self.msg, digestmod=digestmod)) + for digestmod in digestmods + ], + ] - @hashlib_helper.requires_hashdigest('sha256') - def test_with_str_key(self): - # Pass a key of type str, which is an error, because it expects a key - # of type bytes - with self.assertRaises(TypeError): - h = hmac.HMAC("key", digestmod='sha256') + def assert_raises_missing_digestmod(self): + return self.assertRaisesRegex(TypeError, "Missing required.*digestmod") - @hashlib_helper.requires_hashdigest('sha256') - def test_dot_new_with_str_key(self): - # Pass a key of type str, which is an error, because it expects a key - # of type bytes - with self.assertRaises(TypeError): - h = hmac.new("key", digestmod='sha256') + def assert_raises_invalid_digestmod(self): + return self.assertRaisesRegex(ValueError, "[Uu]nsupported.*") - @hashlib_helper.requires_hashdigest('sha256') - def test_withtext(self): - # Constructor call with text. - try: - h = hmac.HMAC(b"key", b"hash this!", digestmod='sha256') - except Exception: - self.fail("Constructor call with text argument raised exception.") - self.assertEqual(h.hexdigest(), self.expected) + def test_constructor_missing_digestmod(self): + catcher = self.assert_raises_missing_digestmod + self.do_test_constructor_missing_digestmod(catcher) - @hashlib_helper.requires_hashdigest('sha256') - def test_with_bytearray(self): - try: - h = hmac.HMAC(bytearray(b"key"), bytearray(b"hash this!"), - digestmod="sha256") - except Exception: - self.fail("Constructor call with bytearray arguments raised exception.") - self.assertEqual(h.hexdigest(), self.expected) + def test_constructor_invalid_digestmod(self): + catcher = self.assert_raises_invalid_digestmod + self.do_test_constructor_invalid_digestmod(catcher) - @hashlib_helper.requires_hashdigest('sha256') - def test_with_memoryview_msg(self): - try: - h = hmac.HMAC(b"key", memoryview(b"hash this!"), digestmod="sha256") - except Exception: - self.fail("Constructor call with memoryview msg raised exception.") - self.assertEqual(h.hexdigest(), self.expected) + def do_test_constructor_missing_digestmod(self, catcher): + for func, args, kwds in self.cases_missing_digestmod_in_constructor(): + with self.subTest(args=args, kwds=kwds), catcher(): + func(*args, **kwds) - @hashlib_helper.requires_hashdigest('sha256') - def test_withmodule(self): - # Constructor call with text and digest module. - try: - h = hmac.HMAC(b"key", b"", hashlib.sha256) - except Exception: - self.fail("Constructor call with hashlib.sha256 raised exception.") + def do_test_constructor_invalid_digestmod(self, catcher): + for func, args, kwds in self.cases_invalid_digestmod_in_constructor(): + with self.subTest(args=args, kwds=kwds), catcher(): + func(*args, **kwds) + + def cases_missing_digestmod_in_constructor(self): + raise NotImplementedError + + def cases_invalid_digestmod_in_constructor(self): + raise NotImplementedError + + +class ConstructorTestCaseMixin(CreatorMixin, DigestMixin, CheckerMixin): + """HMAC constructor tests based on HMAC-SHA-2/256.""" + + key = b"key" + msg = b"hash this!" + res = "6c845b47f52b3b47f6590c502db7825aad757bf4fadc8fa972f7cd2e76a5bdeb" + + def do_test_constructor(self, hmac_on_key_and_msg): + self.do_test_constructor_invalid_types(hmac_on_key_and_msg) + self.do_test_constructor_supported_types(hmac_on_key_and_msg) + + def do_test_constructor_invalid_types(self, hmac_on_key_and_msg): + self.assertRaises(TypeError, hmac_on_key_and_msg, 1) + self.assertRaises(TypeError, hmac_on_key_and_msg, "key") + + self.assertRaises(TypeError, hmac_on_key_and_msg, b"key", 1) + self.assertRaises(TypeError, hmac_on_key_and_msg, b"key", "msg") + + def do_test_constructor_supported_types(self, hmac_on_key_and_msg): + for tp_key in [bytes, bytearray]: + for tp_msg in [bytes, bytearray, memoryview]: + with self.subTest(tp_key=tp_key, tp_msg=tp_msg): + h = hmac_on_key_and_msg(tp_key(self.key), tp_msg(self.msg)) + self.assertEqual(h.name, "hmac-sha256") + self.assertEqual(h.hexdigest(), self.res) + + @hashlib_helper.requires_hashdigest("sha256") + def test_constructor(self): + self.do_test_constructor(self.bind_hmac_new("sha256")) + + @hashlib_helper.requires_hashdigest("sha256") + def test_digest(self): + digest = self.hmac_digest(self.key, self.msg, "sha256") + self.assertEqual(digest, binascii.unhexlify(self.res)) + + +class PyConstructorBaseMixin(PyModuleMixin, + DigestModTestCaseMixin, + ConstructorTestCaseMixin): + + def cases_missing_digestmod_in_constructor(self): + func, key, msg = self.hmac_new, b'key', b'msg' + cases = self.make_digestmod_cases(func, ['', None, False]) + return [*cases, (func, (key,), {}), (func, (key, msg), {})] + + def cases_invalid_digestmod_in_constructor(self): + return self.make_digestmod_cases(self.hmac_new, ['unknown']) + + @requires_builtin_sha2() + def test_constructor_with_module(self): + self.do_test_constructor(self.bind_hmac_new(sha2.sha256)) + + @requires_builtin_sha2() + def test_digest_with_module(self): + digest = self.hmac_digest(self.key, self.msg, sha2.sha256) + self.assertEqual(digest, binascii.unhexlify(self.res)) + + +class PyConstructorTestCase(ThroughObjectMixin, PyConstructorBaseMixin, + unittest.TestCase): + """Test the hmac.HMAC() pure Python constructor.""" + + +class PyModuleConstructorTestCase(ThroughModuleAPIMixin, PyConstructorBaseMixin, + unittest.TestCase): + """Test the hmac.new() constructor function.""" + + def test_hmac_digest_digestmod_parameter(self): + func = self.hmac_digest + + def raiser(): + raise RuntimeError("custom exception") + + with self.assertRaisesRegex(RuntimeError, "custom exception"): + func(b'key', b'msg', raiser) + + with self.assertRaisesRegex(ValueError, 'hash type'): + func(b'key', b'msg', 'unknown') + + with self.assertRaisesRegex(AttributeError, 'new'): + func(b'key', b'msg', 1234) + with self.assertRaisesRegex(AttributeError, 'new'): + func(b'key', b'msg', None) + + +class ExtensionConstructorTestCaseMixin(DigestModTestCaseMixin, + ConstructorTestCaseMixin): + obj_type = None + exc_type = None - @hashlib_helper.requires_hashlib() def test_internal_types(self): - # internal C types like are not constructable - check_disallow_instantiation(self, _hashlib.HMAC) + # internal C types are immutable and cannot be instantiated + check_disallow_instantiation(self, self.obj_type) with self.assertRaisesRegex(TypeError, "immutable type"): - _hashlib.HMAC.value = None + self.obj_type.value = None - @requires_builtin_sha2() - def test_with_sha2(self): - h = hmac.HMAC(b"key", b"hash this!", digestmod=sha2.sha256) - self.assertEqual(h.hexdigest(), self.expected) - self.assertEqual(h.name, "hmac-sha256") + def assert_digestmod_error(self): + self.assertIsSubclass(self.exc_type, ValueError) + return self.assertRaises(self.exc_type) + + def test_constructor_missing_digestmod(self): + self.do_test_constructor_missing_digestmod(self.assert_digestmod_error) + + def test_constructor_invalid_digestmod(self): + self.do_test_constructor_invalid_digestmod(self.assert_digestmod_error) + + def cases_missing_digestmod_in_constructor(self): + func, key, msg = self.hmac_new, b'key', b'msg' + cases = self.make_digestmod_cases(func, ['', None, False]) + return [*cases, (func, (key,), {}), (func, (key, msg), {})] + + def cases_invalid_digestmod_in_constructor(self): + return self.make_digestmod_cases(self.hmac_new, ['unknown', 1234]) + + +class OpenSSLConstructorTestCase(ThroughOpenSSLAPIMixin, + ExtensionConstructorTestCaseMixin, + unittest.TestCase): + + @property + def obj_type(self): + return _hashlib.HMAC + + @property + def exc_type(self): + return _hashlib.UnsupportedDigestmodError - digest = hmac.digest(b"key", b"hash this!", sha2.sha256) - self.assertEqual(digest, binascii.unhexlify(self.expected)) + def test_hmac_digest_digestmod_parameter(self): + # TODO(picnixz): remove default arguments in _hashlib.hmac_digest() + # since the return value is not a HMAC object but a bytes object. + for value in [object, 'unknown', 1234, None]: + with self.subTest(value=value), self.assert_digestmod_error(): + self.hmac_digest(b'key', b'msg', value) class SanityTestCaseMixin(CreatorMixin): From c04233d27c1bd06cd5454e5956a739e6da8b1825 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A9n=C3=A9dikt=20Tran?= <10796600+picnixz@users.noreply.github.com> Date: Sat, 15 Feb 2025 11:21:56 +0100 Subject: [PATCH 13/24] update comments --- Lib/test/test_hmac.py | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/Lib/test/test_hmac.py b/Lib/test/test_hmac.py index cc39ede69aefed..1207672db86708 100644 --- a/Lib/test/test_hmac.py +++ b/Lib/test/test_hmac.py @@ -29,6 +29,8 @@ def requires_builtin_sha2(): class ModuleMixin: + """Mixin with a HMAC module implementation.""" + hmac = None @@ -47,7 +49,7 @@ def setUpClass(cls): @unittest.skip("no builtin implementation for HMAC for now") class BuiltinModuleMixin(ModuleMixin): - # TODO(picnixz): uncomment once HACL* HMAC is here + """Built-in HACL* implementation of HMAC.""" @classmethod def setUpClass(cls): @@ -62,6 +64,7 @@ def hmac_new(self, key, msg=None, digestmod=None): raise NotImplementedError def bind_hmac_new(self, digestmod): + """Return a specialization of hmac_new() with a bound digestmod.""" return functools.partial(self.hmac_new, digestmod=digestmod) @@ -72,11 +75,12 @@ def hmac_digest(self, key, msg=None, digestmod=None): raise NotImplementedError def bind_hmac_digest(self, digestmod): + """Return a specialization of hmac_digest() with a bound digestmod.""" return functools.partial(self.hmac_digest, digestmod=digestmod) class ThroughObjectMixin(ModuleMixin, CreatorMixin, DigestMixin): - """Mixin delegating to hmac.HMAC() and hmac.HMAC(...).digest().""" + """Mixin delegating to .HMAC() and .HMAC(...).digest().""" def hmac_new(self, key, msg=None, digestmod=None): return self.hmac.HMAC(key, msg, digestmod=digestmod) @@ -86,7 +90,7 @@ def hmac_digest(self, key, msg=None, digestmod=None): class ThroughModuleAPIMixin(ModuleMixin, CreatorMixin, DigestMixin): - """Mixin delegating to hmac.new() and hmac.digest().""" + """Mixin delegating to .new() and .digest().""" def hmac_new(self, key, msg=None, digestmod=None): return self.hmac.new(key, msg, digestmod=digestmod) From fb7e577a907fb86d96bd9a6101361045ee90e2f7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A9n=C3=A9dikt=20Tran?= <10796600+picnixz@users.noreply.github.com> Date: Sat, 15 Feb 2025 13:37:23 +0100 Subject: [PATCH 14/24] extend coverage --- Lib/test/test_hmac.py | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/Lib/test/test_hmac.py b/Lib/test/test_hmac.py index 1207672db86708..db71a8df67c4a9 100644 --- a/Lib/test/test_hmac.py +++ b/Lib/test/test_hmac.py @@ -159,7 +159,7 @@ def assert_hmac( self.assert_hmac_digest( key, msg, digest, digestmod, digest_size ) - self.assert_hmac_cases( + self.assert_hmac_extra_cases( key, msg, digest, digestmod, hashname, digest_size, block_size ) @@ -208,11 +208,6 @@ def hmac_new_feed(*args): with self.subTest('initial message is None'): hmac_new_feed(None) - def assert_hmac_cases( - self, key, msg, digest, hashimpl, hashname, digest_size, block_size - ): - """Extra tests that can be added in subclasses.""" - def assert_hmac_digest( self, key, msg, digest, digestmod, digest_size, ): @@ -228,18 +223,26 @@ def assert_hmac_digest_by_new( self.assertEqual(len(d), digest_size) self.assertEqual(d, binascii.unhexlify(digest)) - -class PyTestVectorsMixin(PyModuleMixin, TestVectorsMixin): - - def assert_hmac_cases( + def assert_hmac_extra_cases( self, key, msg, digest, digestmod, hashname, digest_size, block_size ): - h1 = self.hmac.HMAC(key, digestmod=digestmod) + """Extra tests that can be added in subclasses.""" + h1 = self.hmac_new(key, digestmod=digestmod) h2 = h1.copy() h2.update(b"test update should not affect original") h1.update(msg) self.check_object(h1, digest, hashname, digest_size, block_size) + +class PyTestVectorsMixin(PyModuleMixin, TestVectorsMixin): + + def assert_hmac_extra_cases( + self, key, msg, digest, digestmod, hashname, digest_size, block_size + ): + super().assert_hmac_extra_cases( + key, msg, digest, digestmod, hashname, digest_size, block_size + ) + h = self.hmac.HMAC.__new__(self.hmac.HMAC) h._init_old(key, msg, digestmod=digestmod) self.check_object(h, digest, hashname, digest_size, block_size) From 4177afac5b1746d30bc74af4a6398d1fe9a7e3ff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A9n=C3=A9dikt=20Tran?= <10796600+picnixz@users.noreply.github.com> Date: Tue, 25 Feb 2025 15:03:16 +0100 Subject: [PATCH 15/24] add regression test for HMAC `repr()` --- Lib/test/test_hmac.py | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/Lib/test/test_hmac.py b/Lib/test/test_hmac.py index db71a8df67c4a9..61422a1e0aba17 100644 --- a/Lib/test/test_hmac.py +++ b/Lib/test/test_hmac.py @@ -728,21 +728,23 @@ def test_hmac_digest_digestmod_parameter(self): class SanityTestCaseMixin(CreatorMixin): + hmac_class = None + digestname = None - @hashlib_helper.requires_hashdigest('sha256') def test_methods(self): - h = self.hmac_new(b"my secret key", digestmod="sha256") - self.check(h) - - def check(self, h): + h = self.hmac_new(b"my secret key", digestmod=self.digestname) self.assertIsInstance(h, self.hmac_class) self.assertIsNone(h.update(b"compute the hash of this text!")) self.assertIsInstance(h.digest(), bytes) self.assertIsInstance(h.hexdigest(), str) self.assertIsInstance(h.copy(), self.hmac_class) + def test_repr(self): + raise NotImplementedError + +@hashlib_helper.requires_hashdigest('sha256') class PySanityTestCase(ThroughObjectMixin, PyModuleMixin, SanityTestCaseMixin, unittest.TestCase): @@ -750,8 +752,14 @@ class PySanityTestCase(ThroughObjectMixin, PyModuleMixin, SanityTestCaseMixin, def setUpClass(cls): super().setUpClass() cls.hmac_class = cls.hmac.HMAC + cls.digestname = 'sha256' + + def test_repr(self): + h = self.hmac_new(b"my secret key", digestmod=self.digestname) + self.assertStartsWith(repr(h), " Date: Tue, 25 Feb 2025 15:18:09 +0100 Subject: [PATCH 16/24] change a bit the digestmod tests --- Lib/test/test_hmac.py | 66 ++++++++++++++++++++++--------------------- 1 file changed, 34 insertions(+), 32 deletions(-) diff --git a/Lib/test/test_hmac.py b/Lib/test/test_hmac.py index 61422a1e0aba17..b6253c1852f428 100644 --- a/Lib/test/test_hmac.py +++ b/Lib/test/test_hmac.py @@ -548,47 +548,47 @@ def func(self, *, __name=name): # __name needed to bind 'name' class DigestModTestCaseMixin(CreatorMixin, DigestMixin): - def make_digestmod_cases(self, func, digestmods): - return [ - *[ - (func, args, dict(digestmod=digestmod)) - for args in [(self.key,), (self.key, self.msg)] - for digestmod in digestmods - ], - *[ - (func, (self.key,), dict(msg=self.msg, digestmod=digestmod)) - for digestmod in digestmods - ], - ] - def assert_raises_missing_digestmod(self): return self.assertRaisesRegex(TypeError, "Missing required.*digestmod") - def assert_raises_invalid_digestmod(self): + def assert_raises_unknown_digestmod(self): return self.assertRaisesRegex(ValueError, "[Uu]nsupported.*") def test_constructor_missing_digestmod(self): catcher = self.assert_raises_missing_digestmod self.do_test_constructor_missing_digestmod(catcher) - def test_constructor_invalid_digestmod(self): - catcher = self.assert_raises_invalid_digestmod - self.do_test_constructor_invalid_digestmod(catcher) + def test_constructor_unknown_digestmod(self): + catcher = self.assert_raises_unknown_digestmod + self.do_test_constructor_unknown_digestmod(catcher) def do_test_constructor_missing_digestmod(self, catcher): for func, args, kwds in self.cases_missing_digestmod_in_constructor(): with self.subTest(args=args, kwds=kwds), catcher(): func(*args, **kwds) - def do_test_constructor_invalid_digestmod(self, catcher): - for func, args, kwds in self.cases_invalid_digestmod_in_constructor(): + def do_test_constructor_unknown_digestmod(self, catcher): + for func, args, kwds in self.cases_unknown_digestmod_in_constructor(): with self.subTest(args=args, kwds=kwds), catcher(): func(*args, **kwds) + def make_invalid_digestmod_cases(self, func, invalid_values): + """Generate cases for either missing or unknown digestmod tests.""" + key = b'unused key' + msg = b'unused msg' + + cases = [] + for digestmod in invalid_values: + kwargs = {'digestmod': digestmod} + cases.append((func, (key,), kwargs)) + cases.append((func, (key, msg), kwargs)) + cases.append((func, (key,), kwargs | {'msg': msg})) + return cases + def cases_missing_digestmod_in_constructor(self): raise NotImplementedError - def cases_invalid_digestmod_in_constructor(self): + def cases_unknown_digestmod_in_constructor(self): raise NotImplementedError @@ -633,12 +633,13 @@ class PyConstructorBaseMixin(PyModuleMixin, ConstructorTestCaseMixin): def cases_missing_digestmod_in_constructor(self): - func, key, msg = self.hmac_new, b'key', b'msg' - cases = self.make_digestmod_cases(func, ['', None, False]) - return [*cases, (func, (key,), {}), (func, (key, msg), {})] + func, key, msg = self.hmac_new, b'unused key', b'unused msg' + cases = self.make_invalid_digestmod_cases(func, ['', None, False]) + cases.extend([(func, (key,), {}), (func, (key, msg), {})]) + return cases - def cases_invalid_digestmod_in_constructor(self): - return self.make_digestmod_cases(self.hmac_new, ['unknown']) + def cases_unknown_digestmod_in_constructor(self): + return self.make_invalid_digestmod_cases(self.hmac_new, ['unknown']) @requires_builtin_sha2() def test_constructor_with_module(self): @@ -695,16 +696,17 @@ def assert_digestmod_error(self): def test_constructor_missing_digestmod(self): self.do_test_constructor_missing_digestmod(self.assert_digestmod_error) - def test_constructor_invalid_digestmod(self): - self.do_test_constructor_invalid_digestmod(self.assert_digestmod_error) + def test_constructor_unknown_digestmod(self): + self.do_test_constructor_unknown_digestmod(self.assert_digestmod_error) def cases_missing_digestmod_in_constructor(self): - func, key, msg = self.hmac_new, b'key', b'msg' - cases = self.make_digestmod_cases(func, ['', None, False]) - return [*cases, (func, (key,), {}), (func, (key, msg), {})] + func, key, msg = self.hmac_new, b'unused key', b'unused msg' + cases = self.make_invalid_digestmod_cases(func, ['', None, False]) + cases.extend([(func, (key,), {}), (func, (key, msg), {})]) + return cases - def cases_invalid_digestmod_in_constructor(self): - return self.make_digestmod_cases(self.hmac_new, ['unknown', 1234]) + def cases_unknown_digestmod_in_constructor(self): + return self.make_invalid_digestmod_cases(self.hmac_new, ['unknown', 1234]) class OpenSSLConstructorTestCase(ThroughOpenSSLAPIMixin, From dbe3ce4a1dba4dbb047e7198193c45f6a025993e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A9n=C3=A9dikt=20Tran?= <10796600+picnixz@users.noreply.github.com> Date: Mon, 3 Mar 2025 09:37:20 +0100 Subject: [PATCH 17/24] remove mixin that is not yet needed --- Lib/test/test_hmac.py | 4 ---- 1 file changed, 4 deletions(-) diff --git a/Lib/test/test_hmac.py b/Lib/test/test_hmac.py index b6253c1852f428..e19b36008d166b 100644 --- a/Lib/test/test_hmac.py +++ b/Lib/test/test_hmac.py @@ -110,10 +110,6 @@ def hmac_digest(self, key, msg=None, digestmod=None): return _hashlib.hmac_digest(key, msg, digest=digestmod) -class ThroughBuiltinAPIMixin(ThroughModuleAPIMixin, BuiltinModuleMixin): - """Mixin delegating to _hmac.new() and _hmac.digest().""" - - class CheckerMixin: """Mixin for checking HMAC objects (pure Python, OpenSSL or built-in).""" From ca0822af0354eaa37d1e8f7b78f6cd78c38362aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A9n=C3=A9dikt=20Tran?= <10796600+picnixz@users.noreply.github.com> Date: Mon, 3 Mar 2025 09:54:26 +0100 Subject: [PATCH 18/24] add comments --- Lib/test/test_hmac.py | 67 ++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 63 insertions(+), 4 deletions(-) diff --git a/Lib/test/test_hmac.py b/Lib/test/test_hmac.py index e19b36008d166b..91a7797e635f21 100644 --- a/Lib/test/test_hmac.py +++ b/Lib/test/test_hmac.py @@ -61,6 +61,7 @@ class CreatorMixin: """Mixin exposing a method creating a HMAC object.""" def hmac_new(self, key, msg=None, digestmod=None): + """Create a new HMAC object.""" raise NotImplementedError def bind_hmac_new(self, digestmod): @@ -72,6 +73,7 @@ class DigestMixin: """Mixin exposing a method computing a HMAC digest.""" def hmac_digest(self, key, msg=None, digestmod=None): + """Compute a HMAC digest.""" raise NotImplementedError def bind_hmac_digest(self, digestmod): @@ -80,12 +82,18 @@ def bind_hmac_digest(self, digestmod): class ThroughObjectMixin(ModuleMixin, CreatorMixin, DigestMixin): - """Mixin delegating to .HMAC() and .HMAC(...).digest().""" + """Mixin delegating to .HMAC() and .HMAC(...).digest(). + + Both the C implementation and the Python implementation of HMAC should + expose a HMAC class with the same functionalities. + """ def hmac_new(self, key, msg=None, digestmod=None): + """Create a HMAC object via a module-level class constructor.""" return self.hmac.HMAC(key, msg, digestmod=digestmod) def hmac_digest(self, key, msg=None, digestmod=None): + """Call the digest() method on a HMAC object obtained by hmac_new().""" return self.hmac_new(key, msg, digestmod).digest() @@ -93,9 +101,11 @@ class ThroughModuleAPIMixin(ModuleMixin, CreatorMixin, DigestMixin): """Mixin delegating to .new() and .digest().""" def hmac_new(self, key, msg=None, digestmod=None): + """Create a HMAC object via a module-level function.""" return self.hmac.new(key, msg, digestmod=digestmod) def hmac_digest(self, key, msg=None, digestmod=None): + """One-shot HMAC digest computation.""" return self.hmac.digest(key, msg, digest=digestmod) @@ -114,15 +124,18 @@ class CheckerMixin: """Mixin for checking HMAC objects (pure Python, OpenSSL or built-in).""" def check_object(self, h, digest, hashname, digest_size, block_size): + """Check a HMAC object 'h' against the given values.""" self.check_internals(h, hashname, digest_size, block_size) self.check_hexdigest(h, digest, digest_size) def check_internals(self, h, hashname, digest_size, block_size): + """Check the constant attributes of a HMAC object.""" self.assertEqual(h.name, f"hmac-{hashname}") self.assertEqual(h.digest_size, digest_size) self.assertEqual(h.block_size, block_size) def check_hexdigest(self, h, digest, digest_size): + """Check the HMAC digest of 'h' and its size.""" self.assertEqual(len(h.digest()), digest_size) self.assertEqual(h.hexdigest().upper(), digest.upper()) @@ -131,7 +144,14 @@ class TestVectorsMixin(CreatorMixin, DigestMixin, CheckerMixin): """Mixin class for all test vectors test cases.""" def hmac_new_by_name(self, key, msg=None, hashname=None): - """Alternative implementation of hmac_new().""" + """Alternative implementation of hmac_new(). + + This is typically useful when one needs to test against an HMAC + implementation which only recognizes underlying hash functions + by their name (all HMAC implementations must at least recognize + hash functions by their names but some may use aliases such as + `hashlib.sha1` instead of "sha1". + """ self.assertIsInstance(hashname, str | None) return self.hmac_new(key, msg, digestmod=hashname) @@ -143,6 +163,14 @@ def hmac_digest_by_name(self, key, msg=None, hashname=None): def assert_hmac( self, key, msg, digest, hashfunc, hashname, digest_size, block_size ): + """Check that HMAC(key, msg) == digest. + + The 'hashfunc' and 'hashname' are used as 'digestmod' values, + thereby allowing to test the underlying dispatching mechanism. + + At most one of 'hashfunc' or 'hashname' value can be None, in which + case it is ignored. + """ digestmods = list(filter(None, [hashfunc, hashname])) self.assertNotEqual(digestmods, [], "at least one implementation must be tested") @@ -170,6 +198,10 @@ def assert_hmac( def assert_hmac_new( self, key, msg, digest, digestmod, hashname, digest_size, block_size ): + """Check that HMAC(key, msg) == digest. + + This test uses the `hmac_new()` method to create HMAC objects. + """ self._check_hmac_new( key, msg, digest, hashname, digest_size, block_size, hmac_new_func=self.hmac_new, @@ -179,6 +211,10 @@ def assert_hmac_new( def assert_hmac_new_by_name( self, key, msg, digest, hashname, digest_size, block_size ): + """Check that HMAC(key, msg) == digest. + + This test uses the `hmac_new_by_name()` method to create HMAC objects. + """ self._check_hmac_new( key, msg, digest, hashname, digest_size, block_size, hmac_new_func=self.hmac_new_by_name, @@ -189,6 +225,12 @@ def _check_hmac_new( self, key, msg, digest, hashname, digest_size, block_size, hmac_new_func, hmac_new_kwds, ): + """Check that HMAC(key, msg) == digest. + + This also tests that using an empty/None initial message and + then calling `h.update(msg)` produces the same result, namely + that HMAC(key, msg) is equivalent to HMAC(key).update(msg). + """ h = hmac_new_func(key, msg, **hmac_new_kwds) self.check_object(h, digest, hashname, digest_size, block_size) @@ -207,6 +249,7 @@ def hmac_new_feed(*args): def assert_hmac_digest( self, key, msg, digest, digestmod, digest_size, ): + """Check a HMAC digest computed by hmac_digest().""" d = self.hmac_digest(key, msg, digestmod=digestmod) self.assertEqual(len(d), digest_size) self.assertEqual(d, binascii.unhexlify(digest)) @@ -214,6 +257,7 @@ def assert_hmac_digest( def assert_hmac_digest_by_new( self, key, msg, digest, hashname, digest_size ): + """Check a HMAC digest computed by hmac_digest_by_name().""" self.assertIsInstance(hashname, str | None) d = self.hmac_digest_by_name(key, msg, hashname=hashname) self.assertEqual(len(d), digest_size) @@ -676,7 +720,11 @@ def raiser(): class ExtensionConstructorTestCaseMixin(DigestModTestCaseMixin, ConstructorTestCaseMixin): + + # The underlying C class. obj_type = None + + # The exact exception class raised when a 'digestmod' parameter is invalid. exc_type = None def test_internal_types(self): @@ -726,9 +774,16 @@ def test_hmac_digest_digestmod_parameter(self): class SanityTestCaseMixin(CreatorMixin): + """Sanity checks for HMAC objects and their object interface. + + The tests here use a common digestname and do not check all supported + hash functions. + """ - hmac_class = None - digestname = None + # The underlying HMAC class to test. May be in C or in Python. + hmac_class: type + # The underlying hash function name (should be accepted by the HMAC class). + digestname: str def test_methods(self): h = self.hmac_new(b"my secret key", digestmod=self.digestname) @@ -739,6 +794,7 @@ def test_methods(self): self.assertIsInstance(h.copy(), self.hmac_class) def test_repr(self): + # HMAC object representation may differ across implementations raise NotImplementedError @@ -773,8 +829,10 @@ def test_repr(self): class UpdateTestCaseMixin: + """Tests for the update() method (streaming HMAC).""" def HMAC(self, key, msg=None): + """Create a HMAC object.""" raise NotImplementedError def test_update(self): @@ -867,6 +925,7 @@ def test_equality_new(self): class CompareDigestMixin: def compare_digest(self, a, b): + """Implementation of 'a == b' to test.""" raise NotImplementedError def assert_digest_equal(self, a, b): From a0b35699e593b04faa0af17aefba3ff1cbea9ba0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A9n=C3=A9dikt=20Tran?= <10796600+picnixz@users.noreply.github.com> Date: Mon, 3 Mar 2025 09:59:31 +0100 Subject: [PATCH 19/24] semantics: 'digest' -> 'hexdigest' --- Lib/test/test_hmac.py | 73 ++++++++++++++++++++++--------------------- 1 file changed, 37 insertions(+), 36 deletions(-) diff --git a/Lib/test/test_hmac.py b/Lib/test/test_hmac.py index 91a7797e635f21..947690aaf7f1fc 100644 --- a/Lib/test/test_hmac.py +++ b/Lib/test/test_hmac.py @@ -123,10 +123,10 @@ def hmac_digest(self, key, msg=None, digestmod=None): class CheckerMixin: """Mixin for checking HMAC objects (pure Python, OpenSSL or built-in).""" - def check_object(self, h, digest, hashname, digest_size, block_size): + def check_object(self, h, hexdigest, hashname, digest_size, block_size): """Check a HMAC object 'h' against the given values.""" self.check_internals(h, hashname, digest_size, block_size) - self.check_hexdigest(h, digest, digest_size) + self.check_hexdigest(h, hexdigest, digest_size) def check_internals(self, h, hashname, digest_size, block_size): """Check the constant attributes of a HMAC object.""" @@ -134,10 +134,11 @@ def check_internals(self, h, hashname, digest_size, block_size): self.assertEqual(h.digest_size, digest_size) self.assertEqual(h.block_size, block_size) - def check_hexdigest(self, h, digest, digest_size): + def check_hexdigest(self, h, hexdigest, digest_size): """Check the HMAC digest of 'h' and its size.""" self.assertEqual(len(h.digest()), digest_size) - self.assertEqual(h.hexdigest().upper(), digest.upper()) + self.assertEqual(h.digest(), binascii.unhexlify(hexdigest)) + self.assertEqual(h.hexdigest().upper(), hexdigest.upper()) class TestVectorsMixin(CreatorMixin, DigestMixin, CheckerMixin): @@ -161,7 +162,7 @@ def hmac_digest_by_name(self, key, msg=None, hashname=None): return self.hmac_digest(key, msg, digestmod=hashname) def assert_hmac( - self, key, msg, digest, hashfunc, hashname, digest_size, block_size + self, key, msg, hexdigest, hashfunc, hashname, digest_size, block_size ): """Check that HMAC(key, msg) == digest. @@ -177,52 +178,52 @@ def assert_hmac( for digestmod in digestmods: with self.subTest(digestmod=digestmod): self.assert_hmac_new( - key, msg, digest, digestmod, + key, msg, hexdigest, digestmod, hashname, digest_size, block_size ) - self.assert_hmac_digest( - key, msg, digest, digestmod, digest_size + self.assert_hmac_hexdigest( + key, msg, hexdigest, digestmod, digest_size ) self.assert_hmac_extra_cases( - key, msg, digest, digestmod, + key, msg, hexdigest, digestmod, hashname, digest_size, block_size ) self.assert_hmac_new_by_name( - key, msg, digest, hashname, digest_size, block_size + key, msg, hexdigest, hashname, digest_size, block_size ) - self.assert_hmac_digest_by_new( - key, msg, digest, hashname, digest_size + self.assert_hmac_hexdigest_by_new( + key, msg, hexdigest, hashname, digest_size ) def assert_hmac_new( - self, key, msg, digest, digestmod, hashname, digest_size, block_size + self, key, msg, hexdigest, digestmod, hashname, digest_size, block_size ): """Check that HMAC(key, msg) == digest. This test uses the `hmac_new()` method to create HMAC objects. """ self._check_hmac_new( - key, msg, digest, hashname, digest_size, block_size, + key, msg, hexdigest, hashname, digest_size, block_size, hmac_new_func=self.hmac_new, hmac_new_kwds={'digestmod': digestmod}, ) def assert_hmac_new_by_name( - self, key, msg, digest, hashname, digest_size, block_size + self, key, msg, hexdigest, hashname, digest_size, block_size ): """Check that HMAC(key, msg) == digest. This test uses the `hmac_new_by_name()` method to create HMAC objects. """ self._check_hmac_new( - key, msg, digest, hashname, digest_size, block_size, + key, msg, hexdigest, hashname, digest_size, block_size, hmac_new_func=self.hmac_new_by_name, hmac_new_kwds={'hashname': hashname}, ) def _check_hmac_new( - self, key, msg, digest, hashname, digest_size, block_size, + self, key, msg, hexdigest, hashname, digest_size, block_size, hmac_new_func, hmac_new_kwds, ): """Check that HMAC(key, msg) == digest. @@ -232,12 +233,12 @@ def _check_hmac_new( that HMAC(key, msg) is equivalent to HMAC(key).update(msg). """ h = hmac_new_func(key, msg, **hmac_new_kwds) - self.check_object(h, digest, hashname, digest_size, block_size) + self.check_object(h, hexdigest, hashname, digest_size, block_size) def hmac_new_feed(*args): h = hmac_new_func(key, *args, **hmac_new_kwds) h.update(msg) - self.check_hexdigest(h, digest, digest_size) + self.check_hexdigest(h, hexdigest, digest_size) with self.subTest('no initial message'): hmac_new_feed() @@ -246,46 +247,46 @@ def hmac_new_feed(*args): with self.subTest('initial message is None'): hmac_new_feed(None) - def assert_hmac_digest( - self, key, msg, digest, digestmod, digest_size, + def assert_hmac_hexdigest( + self, key, msg, hexdigest, digestmod, digest_size, ): """Check a HMAC digest computed by hmac_digest().""" d = self.hmac_digest(key, msg, digestmod=digestmod) self.assertEqual(len(d), digest_size) - self.assertEqual(d, binascii.unhexlify(digest)) + self.assertEqual(d, binascii.unhexlify(hexdigest)) - def assert_hmac_digest_by_new( - self, key, msg, digest, hashname, digest_size + def assert_hmac_hexdigest_by_new( + self, key, msg, hexdigest, hashname, digest_size ): """Check a HMAC digest computed by hmac_digest_by_name().""" self.assertIsInstance(hashname, str | None) d = self.hmac_digest_by_name(key, msg, hashname=hashname) self.assertEqual(len(d), digest_size) - self.assertEqual(d, binascii.unhexlify(digest)) + self.assertEqual(d, binascii.unhexlify(hexdigest)) def assert_hmac_extra_cases( - self, key, msg, digest, digestmod, hashname, digest_size, block_size + self, key, msg, hexdigest, digestmod, hashname, digest_size, block_size ): """Extra tests that can be added in subclasses.""" h1 = self.hmac_new(key, digestmod=digestmod) h2 = h1.copy() h2.update(b"test update should not affect original") h1.update(msg) - self.check_object(h1, digest, hashname, digest_size, block_size) + self.check_object(h1, hexdigest, hashname, digest_size, block_size) class PyTestVectorsMixin(PyModuleMixin, TestVectorsMixin): def assert_hmac_extra_cases( - self, key, msg, digest, digestmod, hashname, digest_size, block_size + self, key, msg, hexdigest, digestmod, hashname, digest_size, block_size ): super().assert_hmac_extra_cases( - key, msg, digest, digestmod, hashname, digest_size, block_size + key, msg, hexdigest, digestmod, hashname, digest_size, block_size ) h = self.hmac.HMAC.__new__(self.hmac.HMAC) h._init_old(key, msg, digestmod=digestmod) - self.check_object(h, digest, hashname, digest_size, block_size) + self.check_object(h, hexdigest, hashname, digest_size, block_size) class OpenSSLTestVectorsMixin(TestVectorsMixin): @@ -327,8 +328,8 @@ def __init_subclass__(cls, *args, **kwargs): setattr(cls, name, name) def test_md5(self): - def md5test(key, msg, digest): - self.assert_hmac(key, msg, digest, self.md5, "md5", 16, 64) + def md5test(key, msg, hexdigest): + self.assert_hmac(key, msg, hexdigest, self.md5, "md5", 16, 64) md5test(b"\x0b" * 16, b"Hi There", @@ -360,8 +361,8 @@ def md5test(key, msg, digest): "6f630fad67cda0ee1fb1f562db3aa53e") def test_sha1(self): - def shatest(key, msg, digest): - self.assert_hmac(key, msg, digest, self.sha1, "sha1", 20, 64) + def shatest(key, msg, hexdigest): + self.assert_hmac(key, msg, hexdigest, self.sha1, "sha1", 20, 64) shatest(b"\x0b" * 20, b"Hi There", @@ -407,10 +408,10 @@ def test_sha2_512_rfc4231(self): def _test_sha2_rfc4231(self, hashfunc, hashname, digest_size, block_size): def hmactest(key, data, hexdigests): - digest = hexdigests[hashname] + hexdigest = hexdigests[hashname] self.assert_hmac( - key, data, digest, + key, data, hexdigest, hashfunc=hashfunc, hashname=hashname, digest_size=digest_size, From 321a7a9b070fc77335274a35ea4626107700d3d0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A9n=C3=A9dikt=20Tran?= <10796600+picnixz@users.noreply.github.com> Date: Mon, 3 Mar 2025 10:04:44 +0100 Subject: [PATCH 20/24] use `__init_subclass__` instead of `setUpClass` --- Lib/test/test_hmac.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/Lib/test/test_hmac.py b/Lib/test/test_hmac.py index 947690aaf7f1fc..3f6725e97dfef9 100644 --- a/Lib/test/test_hmac.py +++ b/Lib/test/test_hmac.py @@ -310,7 +310,7 @@ def hmac_digest_by_name(self, key, msg=None, hashname=None): class RFCTestCasesMixin(TestVectorsMixin): """Test HMAC implementations against test vectors from the RFC. - Subclasses must override the 'md5', 'sha1', and 'sha2_*' attributes + Subclasses must override the 'md5' and other 'sha*' attributes to test the implementations. Their value can be a string, a callable, or a PEP-257 module. """ @@ -320,6 +320,8 @@ class RFCTestCasesMixin(TestVectorsMixin): 'sha224', 'sha256', 'sha384', 'sha512', ] + # Those will be automatically set to non-None on subclasses + # as they are set by __init_subclass()__. md5 = sha1 = sha224 = sha256 = sha384 = sha512 = None def __init_subclass__(cls, *args, **kwargs): @@ -575,9 +577,8 @@ class OpenSSLRFCTestCase(OpenSSLTestVectorsMixin, RFCTestCasesMixin, unittest.TestCase): """OpenSSL implementation of HMAC.""" - @classmethod - def setUpClass(cls): - super().setUpClass() + def __init_subclass__(cls, *args, **kwargs): + super().__init_subclass__(*args, **kwargs) for name in cls.ALGORITHMS: @property From ca7851c1228fac9a8e859b97a18be544682fae55 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A9n=C3=A9dikt=20Tran?= <10796600+picnixz@users.noreply.github.com> Date: Mon, 3 Mar 2025 10:07:15 +0100 Subject: [PATCH 21/24] document and reorganize method order in `DigestModTestCaseMixin` --- Lib/test/test_hmac.py | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/Lib/test/test_hmac.py b/Lib/test/test_hmac.py index 3f6725e97dfef9..f1aea5735a2666 100644 --- a/Lib/test/test_hmac.py +++ b/Lib/test/test_hmac.py @@ -589,11 +589,14 @@ def func(self, *, __name=name): # __name needed to bind 'name' class DigestModTestCaseMixin(CreatorMixin, DigestMixin): + """Tests for the 'digestmod' parameter.""" def assert_raises_missing_digestmod(self): + """A context manager catching errors when a digestmod is missing.""" return self.assertRaisesRegex(TypeError, "Missing required.*digestmod") def assert_raises_unknown_digestmod(self): + """A context manager catching errors when a digestmod is unknown.""" return self.assertRaisesRegex(ValueError, "[Uu]nsupported.*") def test_constructor_missing_digestmod(self): @@ -614,6 +617,12 @@ def do_test_constructor_unknown_digestmod(self, catcher): with self.subTest(args=args, kwds=kwds), catcher(): func(*args, **kwds) + def cases_missing_digestmod_in_constructor(self): + raise NotImplementedError + + def cases_unknown_digestmod_in_constructor(self): + raise NotImplementedError + def make_invalid_digestmod_cases(self, func, invalid_values): """Generate cases for either missing or unknown digestmod tests.""" key = b'unused key' @@ -627,12 +636,6 @@ def make_invalid_digestmod_cases(self, func, invalid_values): cases.append((func, (key,), kwargs | {'msg': msg})) return cases - def cases_missing_digestmod_in_constructor(self): - raise NotImplementedError - - def cases_unknown_digestmod_in_constructor(self): - raise NotImplementedError - class ConstructorTestCaseMixin(CreatorMixin, DigestMixin, CheckerMixin): """HMAC constructor tests based on HMAC-SHA-2/256.""" From a347ee502f3f23fa951fc314ff70e1fcbfd95c8c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A9n=C3=A9dikt=20Tran?= <10796600+picnixz@users.noreply.github.com> Date: Mon, 3 Mar 2025 10:19:13 +0100 Subject: [PATCH 22/24] use separate factories for creating bad digestmod cases One factory is for test cases when the digestmod parameter is missing; the other is for test cases when the digestmod parameter is unknown. --- Lib/test/test_hmac.py | 37 +++++++++++++++++++++---------------- 1 file changed, 21 insertions(+), 16 deletions(-) diff --git a/Lib/test/test_hmac.py b/Lib/test/test_hmac.py index f1aea5735a2666..6246d2c6c87d18 100644 --- a/Lib/test/test_hmac.py +++ b/Lib/test/test_hmac.py @@ -620,16 +620,23 @@ def do_test_constructor_unknown_digestmod(self, catcher): def cases_missing_digestmod_in_constructor(self): raise NotImplementedError + def make_missing_digestmod_cases(self, func, choices): + """Generate cases for missing digestmod tests.""" + key, msg = b'unused key', b'unused msg' + cases = self._invalid_digestmod_cases(func, key, msg, choices) + return [(func, (key,), {}), (func, (key, msg), {})] + cases + def cases_unknown_digestmod_in_constructor(self): raise NotImplementedError - def make_invalid_digestmod_cases(self, func, invalid_values): - """Generate cases for either missing or unknown digestmod tests.""" - key = b'unused key' - msg = b'unused msg' + def make_unknown_digestmod_cases(self, func, choices): + """Generate cases for unknown digestmod tests.""" + key, msg = b'unused key', b'unused msg' + return self._invalid_digestmod_cases(func, key, msg, choices) + def _invalid_digestmod_cases(self, func, key, msg, choices): cases = [] - for digestmod in invalid_values: + for digestmod in choices: kwargs = {'digestmod': digestmod} cases.append((func, (key,), kwargs)) cases.append((func, (key, msg), kwargs)) @@ -678,13 +685,12 @@ class PyConstructorBaseMixin(PyModuleMixin, ConstructorTestCaseMixin): def cases_missing_digestmod_in_constructor(self): - func, key, msg = self.hmac_new, b'unused key', b'unused msg' - cases = self.make_invalid_digestmod_cases(func, ['', None, False]) - cases.extend([(func, (key,), {}), (func, (key, msg), {})]) - return cases + func, choices = self.hmac_new, ['', None, False] + return self.make_missing_digestmod_cases(func, choices) def cases_unknown_digestmod_in_constructor(self): - return self.make_invalid_digestmod_cases(self.hmac_new, ['unknown']) + func, choices = self.hmac_new, ['unknown'] + return self.make_unknown_digestmod_cases(func, choices) @requires_builtin_sha2() def test_constructor_with_module(self): @@ -703,7 +709,7 @@ class PyConstructorTestCase(ThroughObjectMixin, PyConstructorBaseMixin, class PyModuleConstructorTestCase(ThroughModuleAPIMixin, PyConstructorBaseMixin, unittest.TestCase): - """Test the hmac.new() constructor function.""" + """Test the hmac.new() and hmac.digest() functions.""" def test_hmac_digest_digestmod_parameter(self): func = self.hmac_digest @@ -749,13 +755,12 @@ def test_constructor_unknown_digestmod(self): self.do_test_constructor_unknown_digestmod(self.assert_digestmod_error) def cases_missing_digestmod_in_constructor(self): - func, key, msg = self.hmac_new, b'unused key', b'unused msg' - cases = self.make_invalid_digestmod_cases(func, ['', None, False]) - cases.extend([(func, (key,), {}), (func, (key, msg), {})]) - return cases + func, choices = self.hmac_new, ['', None, False] + return self.make_missing_digestmod_cases(func, choices) def cases_unknown_digestmod_in_constructor(self): - return self.make_invalid_digestmod_cases(self.hmac_new, ['unknown', 1234]) + func, choices = self.hmac_new, ['unknown', 1234] + return self.make_unknown_digestmod_cases(func, choices) class OpenSSLConstructorTestCase(ThroughOpenSSLAPIMixin, From 85364b49b3d49173dc635b78109f42bcdfc7d27b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A9n=C3=A9dikt=20Tran?= <10796600+picnixz@users.noreply.github.com> Date: Mon, 3 Mar 2025 10:32:28 +0100 Subject: [PATCH 23/24] minor tweak on `CompareDigestMixin` --- Lib/test/test_hmac.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/Lib/test/test_hmac.py b/Lib/test/test_hmac.py index 6246d2c6c87d18..9a3c0ecddaffd7 100644 --- a/Lib/test/test_hmac.py +++ b/Lib/test/test_hmac.py @@ -934,7 +934,8 @@ def test_equality_new(self): class CompareDigestMixin: - def compare_digest(self, a, b): + @staticmethod + def compare_digest(a, b): """Implementation of 'a == b' to test.""" raise NotImplementedError @@ -1048,9 +1049,9 @@ class HMACCompareDigestTestCase(CompareDigestMixin, unittest.TestCase): def test_compare_digest_func(self): if openssl_compare_digest is not None: - self.assertIs(hmac.compare_digest, openssl_compare_digest) + self.assertIs(self.compare_digest, openssl_compare_digest) else: - self.assertIs(hmac.compare_digest, operator_compare_digest) + self.assertIs(self.compare_digest, operator_compare_digest) @hashlib_helper.requires_hashlib() From 740fe8183156abb34473548e55c21ece763edb0b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A9n=C3=A9dikt=20Tran?= <10796600+picnixz@users.noreply.github.com> Date: Mon, 3 Mar 2025 10:45:46 +0100 Subject: [PATCH 24/24] do not allow 'hashfunc' or 'hashname' to be None for RFC tests I previously allowed it to be None for future compatibility, but I think it's better to construct a fake hash function instead, or --- Lib/test/test_hmac.py | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/Lib/test/test_hmac.py b/Lib/test/test_hmac.py index 9a3c0ecddaffd7..982a5c53e0f324 100644 --- a/Lib/test/test_hmac.py +++ b/Lib/test/test_hmac.py @@ -151,7 +151,7 @@ def hmac_new_by_name(self, key, msg=None, hashname=None): implementation which only recognizes underlying hash functions by their name (all HMAC implementations must at least recognize hash functions by their names but some may use aliases such as - `hashlib.sha1` instead of "sha1". + `hashlib.sha1` instead of "sha1"). """ self.assertIsInstance(hashname, str | None) return self.hmac_new(key, msg, digestmod=hashname) @@ -169,13 +169,17 @@ def assert_hmac( The 'hashfunc' and 'hashname' are used as 'digestmod' values, thereby allowing to test the underlying dispatching mechanism. - At most one of 'hashfunc' or 'hashname' value can be None, in which - case it is ignored. + Note that 'hashfunc' may be a string, a callable, or a PEP-257 + module. Note that not all HMAC implementations may recognize the + same set of types for 'hashfunc', but they should always accept + a hash function by its name. """ - digestmods = list(filter(None, [hashfunc, hashname])) - self.assertNotEqual(digestmods, [], - "at least one implementation must be tested") - for digestmod in digestmods: + if hashfunc == hashname: + choices = [hashname] + else: + choices = [hashfunc, hashname] + + for digestmod in choices: with self.subTest(digestmod=digestmod): self.assert_hmac_new( key, msg, hexdigest, digestmod, @@ -268,7 +272,7 @@ def assert_hmac_extra_cases( self, key, msg, hexdigest, digestmod, hashname, digest_size, block_size ): """Extra tests that can be added in subclasses.""" - h1 = self.hmac_new(key, digestmod=digestmod) + h1 = self.hmac_new_by_name(key, hashname=hashname) h2 = h1.copy() h2.update(b"test update should not affect original") h1.update(msg)