blob: adf52adbf22afa61e4c71074e5a24ba29d92b5b5 [file] [log] [blame]
Christian Heimes2f050c72018-01-27 09:53:43 +01001import binascii
Christian Heimes217f5c42013-11-24 23:14:16 +01002import functools
Guido van Rossumf1669942001-09-11 15:54:16 +00003import hmac
Guido van Rossuma19f80c2007-11-06 20:51:31 +00004import hashlib
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +00005import unittest
Christian Heimes2f050c72018-01-27 09:53:43 +01006import unittest.mock
Guido van Rossuma19f80c2007-11-06 20:51:31 +00007import warnings
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +00008
Hai Shi66abe982020-04-29 09:11:29 +08009from test.support import hashlib_helper
Christian Heimesc64a1a62019-09-25 16:30:20 +020010
Christian Heimesdb5aed92020-05-27 21:50:06 +020011from _operator import _compare_digest as operator_compare_digest
12
Christian Heimes54f28982020-05-17 13:49:10 +020013try:
Christian Heimes933dfd72021-03-27 14:55:03 +010014 import _hashlib as _hashopenssl
Christian Heimes54f28982020-05-17 13:49:10 +020015 from _hashlib import HMAC as C_HMAC
16 from _hashlib import hmac_new as c_hmac_new
Christian Heimesdb5aed92020-05-27 21:50:06 +020017 from _hashlib import compare_digest as openssl_compare_digest
Christian Heimes54f28982020-05-17 13:49:10 +020018except ImportError:
Christian Heimes933dfd72021-03-27 14:55:03 +010019 _hashopenssl = None
Christian Heimes54f28982020-05-17 13:49:10 +020020 C_HMAC = None
21 c_hmac_new = None
Christian Heimesdb5aed92020-05-27 21:50:06 +020022 openssl_compare_digest = None
Christian Heimes54f28982020-05-17 13:49:10 +020023
Christian Heimes933dfd72021-03-27 14:55:03 +010024try:
25 import _sha256 as sha256_module
26except ImportError:
27 sha256_module = None
28
Christian Heimes217f5c42013-11-24 23:14:16 +010029
30def ignore_warning(func):
31 @functools.wraps(func)
32 def wrapper(*args, **kwargs):
33 with warnings.catch_warnings():
34 warnings.filterwarnings("ignore",
Matthias Bussonnier8bb0b5b2018-05-22 15:55:31 -070035 category=DeprecationWarning)
Christian Heimes217f5c42013-11-24 23:14:16 +010036 return func(*args, **kwargs)
37 return wrapper
38
39
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +000040class TestVectorsTestCase(unittest.TestCase):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +000041
Christian Heimes933dfd72021-03-27 14:55:03 +010042 def assert_hmac_internals(
43 self, h, digest, hashname, digest_size, block_size
Christian Heimes54f28982020-05-17 13:49:10 +020044 ):
Christian Heimes54f28982020-05-17 13:49:10 +020045 self.assertEqual(h.hexdigest().upper(), digest.upper())
46 self.assertEqual(h.digest(), binascii.unhexlify(digest))
47 self.assertEqual(h.name, f"hmac-{hashname}")
48 self.assertEqual(h.digest_size, digest_size)
49 self.assertEqual(h.block_size, block_size)
50
Christian Heimes933dfd72021-03-27 14:55:03 +010051 def assert_hmac(
52 self, key, data, digest, hashfunc, hashname, digest_size, block_size
53 ):
54 h = hmac.HMAC(key, data, digestmod=hashfunc)
55 self.assert_hmac_internals(
56 h, digest, hashname, digest_size, block_size
57 )
58
Christian Heimes54f28982020-05-17 13:49:10 +020059 h = hmac.HMAC(key, data, digestmod=hashname)
Christian Heimes933dfd72021-03-27 14:55:03 +010060 self.assert_hmac_internals(
61 h, digest, hashname, digest_size, block_size
62 )
Christian Heimes54f28982020-05-17 13:49:10 +020063
64 h = hmac.HMAC(key, digestmod=hashname)
65 h2 = h.copy()
66 h2.update(b"test update")
67 h.update(data)
68 self.assertEqual(h.hexdigest().upper(), digest.upper())
69
70 h = hmac.new(key, data, digestmod=hashname)
Christian Heimes933dfd72021-03-27 14:55:03 +010071 self.assert_hmac_internals(
72 h, digest, hashname, digest_size, block_size
73 )
Christian Heimes54f28982020-05-17 13:49:10 +020074
75 h = hmac.new(key, None, digestmod=hashname)
76 h.update(data)
77 self.assertEqual(h.hexdigest().upper(), digest.upper())
78
79 h = hmac.new(key, digestmod=hashname)
80 h.update(data)
81 self.assertEqual(h.hexdigest().upper(), digest.upper())
82
83 h = hmac.new(key, data, digestmod=hashfunc)
84 self.assertEqual(h.hexdigest().upper(), digest.upper())
85
86 self.assertEqual(
87 hmac.digest(key, data, digest=hashname),
88 binascii.unhexlify(digest)
89 )
90 self.assertEqual(
91 hmac.digest(key, data, digest=hashfunc),
92 binascii.unhexlify(digest)
93 )
Christian Heimes933dfd72021-03-27 14:55:03 +010094
95 h = hmac.HMAC.__new__(hmac.HMAC)
96 h._init_old(key, data, digestmod=hashname)
97 self.assert_hmac_internals(
98 h, digest, hashname, digest_size, block_size
99 )
Christian Heimes54f28982020-05-17 13:49:10 +0200100
101 if c_hmac_new is not None:
102 h = c_hmac_new(key, data, digestmod=hashname)
Christian Heimes933dfd72021-03-27 14:55:03 +0100103 self.assert_hmac_internals(
104 h, digest, hashname, digest_size, block_size
105 )
Christian Heimes54f28982020-05-17 13:49:10 +0200106
107 h = c_hmac_new(key, digestmod=hashname)
108 h2 = h.copy()
109 h2.update(b"test update")
110 h.update(data)
111 self.assertEqual(h.hexdigest().upper(), digest.upper())
112
Christian Heimes933dfd72021-03-27 14:55:03 +0100113 func = getattr(_hashopenssl, f"openssl_{hashname}")
114 h = c_hmac_new(key, data, digestmod=func)
115 self.assert_hmac_internals(
116 h, digest, hashname, digest_size, block_size
117 )
118
119 h = hmac.HMAC.__new__(hmac.HMAC)
120 h._init_hmac(key, data, digestmod=hashname)
121 self.assert_hmac_internals(
122 h, digest, hashname, digest_size, block_size
123 )
124
Hai Shi66abe982020-04-29 09:11:29 +0800125 @hashlib_helper.requires_hashdigest('md5', openssl=True)
Jeremy Hylton893801e2003-05-27 16:16:41 +0000126 def test_md5_vectors(self):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000127 # Test the HMAC module against test vectors from the RFC.
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000128
129 def md5test(key, data, digest):
Christian Heimes933dfd72021-03-27 14:55:03 +0100130 self.assert_hmac(
Christian Heimes54f28982020-05-17 13:49:10 +0200131 key, data, digest,
132 hashfunc=hashlib.md5,
133 hashname="md5",
134 digest_size=16,
135 block_size=64
Christian Heimes2f050c72018-01-27 09:53:43 +0100136 )
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000137
Guido van Rossum3f429082007-07-10 13:35:52 +0000138 md5test(b"\x0b" * 16,
139 b"Hi There",
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000140 "9294727A3638BB1C13F48EF8158BFC9D")
141
Guido van Rossum3f429082007-07-10 13:35:52 +0000142 md5test(b"Jefe",
143 b"what do ya want for nothing?",
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000144 "750c783e6ab0b503eaa86e310a5db738")
145
Guido van Rossum3f429082007-07-10 13:35:52 +0000146 md5test(b"\xaa" * 16,
147 b"\xdd" * 50,
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000148 "56be34521d144c88dbb8c733f0e8b3f6")
149
Guido van Rossum39478e82007-08-27 17:23:59 +0000150 md5test(bytes(range(1, 26)),
Guido van Rossum3f429082007-07-10 13:35:52 +0000151 b"\xcd" * 50,
Jeremy Hylton893801e2003-05-27 16:16:41 +0000152 "697eaf0aca3a3aea3a75164746ffaa79")
153
Guido van Rossum39478e82007-08-27 17:23:59 +0000154 md5test(b"\x0C" * 16,
155 b"Test With Truncation",
Jeremy Hylton893801e2003-05-27 16:16:41 +0000156 "56461ef2342edc00f9bab995690efd4c")
157
Guido van Rossum3f429082007-07-10 13:35:52 +0000158 md5test(b"\xaa" * 80,
Guido van Rossum39478e82007-08-27 17:23:59 +0000159 b"Test Using Larger Than Block-Size Key - Hash Key First",
Jeremy Hylton893801e2003-05-27 16:16:41 +0000160 "6b1ab7fe4bd7bf8f0b62e6ce61b9d0cd")
161
Guido van Rossum3f429082007-07-10 13:35:52 +0000162 md5test(b"\xaa" * 80,
Guido van Rossum39478e82007-08-27 17:23:59 +0000163 (b"Test Using Larger Than Block-Size Key "
164 b"and Larger Than One Block-Size Data"),
Jeremy Hylton893801e2003-05-27 16:16:41 +0000165 "6f630fad67cda0ee1fb1f562db3aa53e")
166
Hai Shi66abe982020-04-29 09:11:29 +0800167 @hashlib_helper.requires_hashdigest('sha1', openssl=True)
Jeremy Hylton893801e2003-05-27 16:16:41 +0000168 def test_sha_vectors(self):
169 def shatest(key, data, digest):
Christian Heimes933dfd72021-03-27 14:55:03 +0100170 self.assert_hmac(
Christian Heimes54f28982020-05-17 13:49:10 +0200171 key, data, digest,
172 hashfunc=hashlib.sha1,
173 hashname="sha1",
174 digest_size=20,
175 block_size=64
Christian Heimes2f050c72018-01-27 09:53:43 +0100176 )
177
Guido van Rossum3f429082007-07-10 13:35:52 +0000178 shatest(b"\x0b" * 20,
179 b"Hi There",
Jeremy Hylton893801e2003-05-27 16:16:41 +0000180 "b617318655057264e28bc0b6fb378c8ef146be00")
181
Guido van Rossum3f429082007-07-10 13:35:52 +0000182 shatest(b"Jefe",
183 b"what do ya want for nothing?",
Jeremy Hylton893801e2003-05-27 16:16:41 +0000184 "effcdf6ae5eb2fa2d27416d5f184df9c259a7c79")
185
Guido van Rossum3f429082007-07-10 13:35:52 +0000186 shatest(b"\xAA" * 20,
187 b"\xDD" * 50,
Jeremy Hylton893801e2003-05-27 16:16:41 +0000188 "125d7342b9ac11cd91a39af48aa17b4f63f175d3")
189
Guido van Rossum3f429082007-07-10 13:35:52 +0000190 shatest(bytes(range(1, 26)),
191 b"\xCD" * 50,
Jeremy Hylton893801e2003-05-27 16:16:41 +0000192 "4c9007f4026250c6bc8414f9bf50c86c2d7235da")
193
Guido van Rossum39478e82007-08-27 17:23:59 +0000194 shatest(b"\x0C" * 20,
195 b"Test With Truncation",
Jeremy Hylton893801e2003-05-27 16:16:41 +0000196 "4c1a03424b55e07fe7f27be1d58bb9324a9a5a04")
197
Guido van Rossum3f429082007-07-10 13:35:52 +0000198 shatest(b"\xAA" * 80,
199 b"Test Using Larger Than Block-Size Key - Hash Key First",
Jeremy Hylton893801e2003-05-27 16:16:41 +0000200 "aa4ae5e15272d00e95705637ce8a3b55ed402112")
201
Guido van Rossum3f429082007-07-10 13:35:52 +0000202 shatest(b"\xAA" * 80,
203 (b"Test Using Larger Than Block-Size Key "
204 b"and Larger Than One Block-Size Data"),
Jeremy Hylton893801e2003-05-27 16:16:41 +0000205 "e8e99d0f45237d786d6bbaa7965c7808bbff1a91")
206
Christian Heimesc4ab1102013-11-20 17:35:06 +0100207 def _rfc4231_test_cases(self, hashfunc, hash_name, digest_size, block_size):
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000208 def hmactest(key, data, hexdigests):
Christian Heimes54f28982020-05-17 13:49:10 +0200209 digest = hexdigests[hashfunc]
Christian Heimesc4ab1102013-11-20 17:35:06 +0100210
Christian Heimes933dfd72021-03-27 14:55:03 +0100211 self.assert_hmac(
Christian Heimes54f28982020-05-17 13:49:10 +0200212 key, data, digest,
213 hashfunc=hashfunc,
214 hashname=hash_name,
215 digest_size=digest_size,
216 block_size=block_size
Christian Heimes2f050c72018-01-27 09:53:43 +0100217 )
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000218
219 # 4.2. Test Case 1
220 hmactest(key = b'\x0b'*20,
221 data = b'Hi There',
222 hexdigests = {
223 hashlib.sha224: '896fb1128abbdf196832107cd49df33f'
224 '47b4b1169912ba4f53684b22',
225 hashlib.sha256: 'b0344c61d8db38535ca8afceaf0bf12b'
226 '881dc200c9833da726e9376c2e32cff7',
227 hashlib.sha384: 'afd03944d84895626b0825f4ab46907f'
228 '15f9dadbe4101ec682aa034c7cebc59c'
229 'faea9ea9076ede7f4af152e8b2fa9cb6',
230 hashlib.sha512: '87aa7cdea5ef619d4ff0b4241a1d6cb0'
231 '2379f4e2ce4ec2787ad0b30545e17cde'
232 'daa833b7d6b8a702038b274eaea3f4e4'
233 'be9d914eeb61f1702e696c203a126854',
234 })
235
236 # 4.3. Test Case 2
237 hmactest(key = b'Jefe',
238 data = b'what do ya want for nothing?',
239 hexdigests = {
240 hashlib.sha224: 'a30e01098bc6dbbf45690f3a7e9e6d0f'
241 '8bbea2a39e6148008fd05e44',
242 hashlib.sha256: '5bdcc146bf60754e6a042426089575c7'
243 '5a003f089d2739839dec58b964ec3843',
244 hashlib.sha384: 'af45d2e376484031617f78d2b58a6b1b'
245 '9c7ef464f5a01b47e42ec3736322445e'
246 '8e2240ca5e69e2c78b3239ecfab21649',
247 hashlib.sha512: '164b7a7bfcf819e2e395fbe73b56e0a3'
248 '87bd64222e831fd610270cd7ea250554'
249 '9758bf75c05a994a6d034f65f8f0e6fd'
250 'caeab1a34d4a6b4b636e070a38bce737',
251 })
252
253 # 4.4. Test Case 3
254 hmactest(key = b'\xaa'*20,
255 data = b'\xdd'*50,
256 hexdigests = {
257 hashlib.sha224: '7fb3cb3588c6c1f6ffa9694d7d6ad264'
258 '9365b0c1f65d69d1ec8333ea',
259 hashlib.sha256: '773ea91e36800e46854db8ebd09181a7'
260 '2959098b3ef8c122d9635514ced565fe',
261 hashlib.sha384: '88062608d3e6ad8a0aa2ace014c8a86f'
262 '0aa635d947ac9febe83ef4e55966144b'
263 '2a5ab39dc13814b94e3ab6e101a34f27',
264 hashlib.sha512: 'fa73b0089d56a284efb0f0756c890be9'
265 'b1b5dbdd8ee81a3655f83e33b2279d39'
266 'bf3e848279a722c806b485a47e67c807'
267 'b946a337bee8942674278859e13292fb',
268 })
269
270 # 4.5. Test Case 4
271 hmactest(key = bytes(x for x in range(0x01, 0x19+1)),
272 data = b'\xcd'*50,
273 hexdigests = {
274 hashlib.sha224: '6c11506874013cac6a2abc1bb382627c'
275 'ec6a90d86efc012de7afec5a',
276 hashlib.sha256: '82558a389a443c0ea4cc819899f2083a'
277 '85f0faa3e578f8077a2e3ff46729665b',
278 hashlib.sha384: '3e8a69b7783c25851933ab6290af6ca7'
279 '7a9981480850009cc5577c6e1f573b4e'
280 '6801dd23c4a7d679ccf8a386c674cffb',
281 hashlib.sha512: 'b0ba465637458c6990e5a8c5f61d4af7'
282 'e576d97ff94b872de76f8050361ee3db'
283 'a91ca5c11aa25eb4d679275cc5788063'
284 'a5f19741120c4f2de2adebeb10a298dd',
285 })
286
287 # 4.7. Test Case 6
288 hmactest(key = b'\xaa'*131,
289 data = b'Test Using Larger Than Block-Siz'
290 b'e Key - Hash Key First',
291 hexdigests = {
292 hashlib.sha224: '95e9a0db962095adaebe9b2d6f0dbce2'
293 'd499f112f2d2b7273fa6870e',
294 hashlib.sha256: '60e431591ee0b67f0d8a26aacbf5b77f'
295 '8e0bc6213728c5140546040f0ee37f54',
296 hashlib.sha384: '4ece084485813e9088d2c63a041bc5b4'
297 '4f9ef1012a2b588f3cd11f05033ac4c6'
298 '0c2ef6ab4030fe8296248df163f44952',
299 hashlib.sha512: '80b24263c7c1a3ebb71493c1dd7be8b4'
300 '9b46d1f41b4aeec1121b013783f8f352'
301 '6b56d037e05f2598bd0fd2215d6a1e52'
302 '95e64f73f63f0aec8b915a985d786598',
303 })
304
305 # 4.8. Test Case 7
306 hmactest(key = b'\xaa'*131,
307 data = b'This is a test using a larger th'
308 b'an block-size key and a larger t'
309 b'han block-size data. The key nee'
310 b'ds to be hashed before being use'
311 b'd by the HMAC algorithm.',
312 hexdigests = {
313 hashlib.sha224: '3a854166ac5d9f023f54d517d0b39dbd'
314 '946770db9c2b95c9f6f565d1',
315 hashlib.sha256: '9b09ffa71b942fcb27635fbcd5b0e944'
316 'bfdc63644f0713938a7f51535c3a35e2',
317 hashlib.sha384: '6617178e941f020d351e2f254e8fd32c'
318 '602420feb0b8fb9adccebb82461e99c5'
319 'a678cc31e799176d3860e6110c46523e',
320 hashlib.sha512: 'e37b6a775dc87dbaa4dfa9f96e5e3ffd'
321 'debd71f8867289865df5a32d20cdc944'
322 'b6022cac3c4982b10d5eeb55c3e4de15'
323 '134676fb6de0446065c97440fa8c6a58',
324 })
325
Hai Shi66abe982020-04-29 09:11:29 +0800326 @hashlib_helper.requires_hashdigest('sha224', openssl=True)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000327 def test_sha224_rfc4231(self):
Christian Heimesc4ab1102013-11-20 17:35:06 +0100328 self._rfc4231_test_cases(hashlib.sha224, 'sha224', 28, 64)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000329
Hai Shi66abe982020-04-29 09:11:29 +0800330 @hashlib_helper.requires_hashdigest('sha256', openssl=True)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000331 def test_sha256_rfc4231(self):
Christian Heimesc4ab1102013-11-20 17:35:06 +0100332 self._rfc4231_test_cases(hashlib.sha256, 'sha256', 32, 64)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000333
Hai Shi66abe982020-04-29 09:11:29 +0800334 @hashlib_helper.requires_hashdigest('sha384', openssl=True)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000335 def test_sha384_rfc4231(self):
Christian Heimesc4ab1102013-11-20 17:35:06 +0100336 self._rfc4231_test_cases(hashlib.sha384, 'sha384', 48, 128)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000337
Hai Shi66abe982020-04-29 09:11:29 +0800338 @hashlib_helper.requires_hashdigest('sha512', openssl=True)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000339 def test_sha512_rfc4231(self):
Christian Heimesc4ab1102013-11-20 17:35:06 +0100340 self._rfc4231_test_cases(hashlib.sha512, 'sha512', 64, 128)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000341
Hai Shi66abe982020-04-29 09:11:29 +0800342 @hashlib_helper.requires_hashdigest('sha256')
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000343 def test_legacy_block_size_warnings(self):
344 class MockCrazyHash(object):
345 """Ain't no block_size attribute here."""
346 def __init__(self, *args):
Christian Heimesc64a1a62019-09-25 16:30:20 +0200347 self._x = hashlib.sha256(*args)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000348 self.digest_size = self._x.digest_size
349 def update(self, v):
350 self._x.update(v)
351 def digest(self):
352 return self._x.digest()
353
Brett Cannon1cd02472008-09-09 01:52:27 +0000354 with warnings.catch_warnings():
Christian Heimese25f35e2008-03-20 10:49:03 +0000355 warnings.simplefilter('error', RuntimeWarning)
Florent Xicluna41fe6152010-04-02 18:52:12 +0000356 with self.assertRaises(RuntimeWarning):
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000357 hmac.HMAC(b'a', b'b', digestmod=MockCrazyHash)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000358 self.fail('Expected warning about missing block_size')
359
360 MockCrazyHash.block_size = 1
Florent Xicluna41fe6152010-04-02 18:52:12 +0000361 with self.assertRaises(RuntimeWarning):
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000362 hmac.HMAC(b'a', b'b', digestmod=MockCrazyHash)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000363 self.fail('Expected warning about small block_size')
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000364
Matthias Bussonnier51a47432018-09-10 20:10:01 +0200365 def test_with_digestmod_no_default(self):
Gregory P. Smithf33c57d52019-10-17 20:30:42 -0700366 """The digestmod parameter is required as of Python 3.8."""
367 with self.assertRaisesRegex(TypeError, r'required.*digestmod'):
Christian Heimes634919a2013-11-20 17:23:06 +0100368 key = b"\x0b" * 16
369 data = b"Hi There"
Matthias Bussonnier51a47432018-09-10 20:10:01 +0200370 hmac.HMAC(key, data, digestmod=None)
Gregory P. Smithf33c57d52019-10-17 20:30:42 -0700371 with self.assertRaisesRegex(TypeError, r'required.*digestmod'):
372 hmac.new(key, data)
373 with self.assertRaisesRegex(TypeError, r'required.*digestmod'):
374 hmac.HMAC(key, msg=data, digestmod='')
Jeremy Hylton893801e2003-05-27 16:16:41 +0000375
Christian Heimesc64a1a62019-09-25 16:30:20 +0200376
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000377class ConstructorTestCase(unittest.TestCase):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000378
Christian Heimesc64a1a62019-09-25 16:30:20 +0200379 expected = (
380 "6c845b47f52b3b47f6590c502db7825aad757bf4fadc8fa972f7cd2e76a5bdeb"
381 )
382
Hai Shi66abe982020-04-29 09:11:29 +0800383 @hashlib_helper.requires_hashdigest('sha256')
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000384 def test_normal(self):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000385 # Standard constructor call.
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000386 try:
Christian Heimesc64a1a62019-09-25 16:30:20 +0200387 hmac.HMAC(b"key", digestmod='sha256')
Christian Heimes217f5c42013-11-24 23:14:16 +0100388 except Exception:
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000389 self.fail("Standard constructor call raised exception.")
390
Hai Shi66abe982020-04-29 09:11:29 +0800391 @hashlib_helper.requires_hashdigest('sha256')
Antoine Pitrou24ef3e92012-06-30 17:27:56 +0200392 def test_with_str_key(self):
393 # Pass a key of type str, which is an error, because it expects a key
394 # of type bytes
395 with self.assertRaises(TypeError):
Christian Heimesc64a1a62019-09-25 16:30:20 +0200396 h = hmac.HMAC("key", digestmod='sha256')
Antoine Pitrou24ef3e92012-06-30 17:27:56 +0200397
Hai Shi66abe982020-04-29 09:11:29 +0800398 @hashlib_helper.requires_hashdigest('sha256')
Antoine Pitrou24ef3e92012-06-30 17:27:56 +0200399 def test_dot_new_with_str_key(self):
400 # Pass a key of type str, which is an error, because it expects a key
401 # of type bytes
402 with self.assertRaises(TypeError):
Christian Heimesc64a1a62019-09-25 16:30:20 +0200403 h = hmac.new("key", digestmod='sha256')
Antoine Pitrou24ef3e92012-06-30 17:27:56 +0200404
Hai Shi66abe982020-04-29 09:11:29 +0800405 @hashlib_helper.requires_hashdigest('sha256')
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000406 def test_withtext(self):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000407 # Constructor call with text.
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000408 try:
Christian Heimesc64a1a62019-09-25 16:30:20 +0200409 h = hmac.HMAC(b"key", b"hash this!", digestmod='sha256')
Christian Heimes217f5c42013-11-24 23:14:16 +0100410 except Exception:
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000411 self.fail("Constructor call with text argument raised exception.")
Christian Heimesc64a1a62019-09-25 16:30:20 +0200412 self.assertEqual(h.hexdigest(), self.expected)
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000413
Hai Shi66abe982020-04-29 09:11:29 +0800414 @hashlib_helper.requires_hashdigest('sha256')
Christian Heimes04926ae2013-07-01 13:08:42 +0200415 def test_with_bytearray(self):
416 try:
Christian Heimes217f5c42013-11-24 23:14:16 +0100417 h = hmac.HMAC(bytearray(b"key"), bytearray(b"hash this!"),
Christian Heimesc64a1a62019-09-25 16:30:20 +0200418 digestmod="sha256")
Christian Heimes217f5c42013-11-24 23:14:16 +0100419 except Exception:
Christian Heimes04926ae2013-07-01 13:08:42 +0200420 self.fail("Constructor call with bytearray arguments raised exception.")
stratakis89433182019-12-03 16:35:54 +0100421 self.assertEqual(h.hexdigest(), self.expected)
Christian Heimes04926ae2013-07-01 13:08:42 +0200422
Hai Shi66abe982020-04-29 09:11:29 +0800423 @hashlib_helper.requires_hashdigest('sha256')
Christian Heimes04926ae2013-07-01 13:08:42 +0200424 def test_with_memoryview_msg(self):
425 try:
Christian Heimesc64a1a62019-09-25 16:30:20 +0200426 h = hmac.HMAC(b"key", memoryview(b"hash this!"), digestmod="sha256")
Christian Heimes217f5c42013-11-24 23:14:16 +0100427 except Exception:
Christian Heimes04926ae2013-07-01 13:08:42 +0200428 self.fail("Constructor call with memoryview msg raised exception.")
stratakis89433182019-12-03 16:35:54 +0100429 self.assertEqual(h.hexdigest(), self.expected)
Christian Heimes04926ae2013-07-01 13:08:42 +0200430
Hai Shi66abe982020-04-29 09:11:29 +0800431 @hashlib_helper.requires_hashdigest('sha256')
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000432 def test_withmodule(self):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000433 # Constructor call with text and digest module.
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000434 try:
Christian Heimesc64a1a62019-09-25 16:30:20 +0200435 h = hmac.HMAC(b"key", b"", hashlib.sha256)
Christian Heimes217f5c42013-11-24 23:14:16 +0100436 except Exception:
Christian Heimesc64a1a62019-09-25 16:30:20 +0200437 self.fail("Constructor call with hashlib.sha256 raised exception.")
438
Christian Heimes54f28982020-05-17 13:49:10 +0200439 @unittest.skipUnless(C_HMAC is not None, 'need _hashlib')
440 def test_internal_types(self):
441 # internal types like _hashlib.C_HMAC are not constructable
442 with self.assertRaisesRegex(
443 TypeError, "cannot create 'HMAC' instance"
444 ):
445 C_HMAC()
446
Christian Heimes933dfd72021-03-27 14:55:03 +0100447 @unittest.skipUnless(sha256_module is not None, 'need _sha256')
448 def test_with_sha256_module(self):
449 h = hmac.HMAC(b"key", b"hash this!", digestmod=sha256_module.sha256)
450 self.assertEqual(h.hexdigest(), self.expected)
451 self.assertEqual(h.name, "hmac-sha256")
452
453 digest = hmac.digest(b"key", b"hash this!", sha256_module.sha256)
454 self.assertEqual(digest, binascii.unhexlify(self.expected))
455
Tim Peters88768482001-11-13 21:51:26 +0000456
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000457class SanityTestCase(unittest.TestCase):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000458
Hai Shi66abe982020-04-29 09:11:29 +0800459 @hashlib_helper.requires_hashdigest('sha256')
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000460 def test_exercise_all_methods(self):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000461 # Exercising all methods once.
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000462 # This must not raise any exceptions
463 try:
Christian Heimesc64a1a62019-09-25 16:30:20 +0200464 h = hmac.HMAC(b"my secret key", digestmod="sha256")
Guido van Rossum39478e82007-08-27 17:23:59 +0000465 h.update(b"compute the hash of this text!")
Christian Heimes54f28982020-05-17 13:49:10 +0200466 h.digest()
467 h.hexdigest()
468 h.copy()
Christian Heimes217f5c42013-11-24 23:14:16 +0100469 except Exception:
Neal Norwitz28bb5722002-04-01 19:00:50 +0000470 self.fail("Exception raised during normal usage of HMAC class.")
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000471
Christian Heimesc64a1a62019-09-25 16:30:20 +0200472
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000473class CopyTestCase(unittest.TestCase):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000474
Hai Shi66abe982020-04-29 09:11:29 +0800475 @hashlib_helper.requires_hashdigest('sha256')
Christian Heimes933dfd72021-03-27 14:55:03 +0100476 def test_attributes_old(self):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000477 # Testing if attributes are of same type.
Christian Heimes933dfd72021-03-27 14:55:03 +0100478 h1 = hmac.HMAC.__new__(hmac.HMAC)
479 h1._init_old(b"key", b"msg", digestmod="sha256")
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000480 h2 = h1.copy()
Christian Heimes837f9e42020-05-17 01:05:40 +0200481 self.assertEqual(type(h1._inner), type(h2._inner),
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000482 "Types of inner don't match.")
Christian Heimes837f9e42020-05-17 01:05:40 +0200483 self.assertEqual(type(h1._outer), type(h2._outer),
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000484 "Types of outer don't match.")
485
Hai Shi66abe982020-04-29 09:11:29 +0800486 @hashlib_helper.requires_hashdigest('sha256')
Christian Heimes933dfd72021-03-27 14:55:03 +0100487 def test_realcopy_old(self):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000488 # Testing if the copy method created a real copy.
Christian Heimes933dfd72021-03-27 14:55:03 +0100489 h1 = hmac.HMAC.__new__(hmac.HMAC)
490 h1._init_old(b"key", b"msg", digestmod="sha256")
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000491 h2 = h1.copy()
Mark Dickinsona56c4672009-01-27 18:17:45 +0000492 # Using id() in case somebody has overridden __eq__/__ne__.
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000493 self.assertTrue(id(h1) != id(h2), "No real copy of the HMAC instance.")
Christian Heimes837f9e42020-05-17 01:05:40 +0200494 self.assertTrue(id(h1._inner) != id(h2._inner),
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000495 "No real copy of the attribute 'inner'.")
Christian Heimes837f9e42020-05-17 01:05:40 +0200496 self.assertTrue(id(h1._outer) != id(h2._outer),
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000497 "No real copy of the attribute 'outer'.")
Christian Heimes933dfd72021-03-27 14:55:03 +0100498 self.assertIs(h1._hmac, None)
Christian Heimes837f9e42020-05-17 01:05:40 +0200499
Christian Heimes933dfd72021-03-27 14:55:03 +0100500 @unittest.skipIf(_hashopenssl is None, "test requires _hashopenssl")
Christian Heimes837f9e42020-05-17 01:05:40 +0200501 @hashlib_helper.requires_hashdigest('sha256')
Christian Heimes933dfd72021-03-27 14:55:03 +0100502 def test_realcopy_hmac(self):
503 h1 = hmac.HMAC.__new__(hmac.HMAC)
504 h1._init_hmac(b"key", b"msg", digestmod="sha256")
505 h2 = h1.copy()
506 self.assertTrue(id(h1._hmac) != id(h2._hmac))
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000507
Hai Shi66abe982020-04-29 09:11:29 +0800508 @hashlib_helper.requires_hashdigest('sha256')
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000509 def test_equality(self):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000510 # Testing if the copy has the same digests.
Christian Heimesc64a1a62019-09-25 16:30:20 +0200511 h1 = hmac.HMAC(b"key", digestmod="sha256")
Guido van Rossum39478e82007-08-27 17:23:59 +0000512 h1.update(b"some random text")
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000513 h2 = h1.copy()
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000514 self.assertEqual(h1.digest(), h2.digest(),
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000515 "Digest of copy doesn't match original digest.")
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000516 self.assertEqual(h1.hexdigest(), h2.hexdigest(),
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000517 "Hexdigest of copy doesn't match original hexdigest.")
518
Christian Heimes54f28982020-05-17 13:49:10 +0200519 @hashlib_helper.requires_hashdigest('sha256')
520 def test_equality_new(self):
521 # Testing if the copy has the same digests with hmac.new().
522 h1 = hmac.new(b"key", digestmod="sha256")
523 h1.update(b"some random text")
524 h2 = h1.copy()
525 self.assertTrue(
526 id(h1) != id(h2), "No real copy of the HMAC instance."
527 )
528 self.assertEqual(h1.digest(), h2.digest(),
529 "Digest of copy doesn't match original digest.")
530 self.assertEqual(h1.hexdigest(), h2.hexdigest(),
531 "Hexdigest of copy doesn't match original hexdigest.")
532
533
Nick Coghlan807770e2012-06-15 21:14:08 +1000534class CompareDigestTestCase(unittest.TestCase):
Charles-François Natali7feb9f42012-05-13 19:53:07 +0200535
Christian Heimesdb5aed92020-05-27 21:50:06 +0200536 def test_hmac_compare_digest(self):
537 self._test_compare_digest(hmac.compare_digest)
538 if openssl_compare_digest is not None:
539 self.assertIs(hmac.compare_digest, openssl_compare_digest)
540 else:
541 self.assertIs(hmac.compare_digest, operator_compare_digest)
542
543 def test_operator_compare_digest(self):
544 self._test_compare_digest(operator_compare_digest)
545
546 @unittest.skipIf(openssl_compare_digest is None, "test requires _hashlib")
547 def test_openssl_compare_digest(self):
548 self._test_compare_digest(openssl_compare_digest)
549
550 def _test_compare_digest(self, compare_digest):
Charles-François Natali7feb9f42012-05-13 19:53:07 +0200551 # Testing input type exception handling
552 a, b = 100, 200
Christian Heimesdb5aed92020-05-27 21:50:06 +0200553 self.assertRaises(TypeError, compare_digest, a, b)
Nick Coghlan807770e2012-06-15 21:14:08 +1000554 a, b = 100, b"foobar"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200555 self.assertRaises(TypeError, compare_digest, a, b)
Nick Coghlan807770e2012-06-15 21:14:08 +1000556 a, b = b"foobar", 200
Christian Heimesdb5aed92020-05-27 21:50:06 +0200557 self.assertRaises(TypeError, compare_digest, a, b)
Charles-François Natali7feb9f42012-05-13 19:53:07 +0200558 a, b = "foobar", b"foobar"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200559 self.assertRaises(TypeError, compare_digest, a, b)
Nick Coghlan807770e2012-06-15 21:14:08 +1000560 a, b = b"foobar", "foobar"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200561 self.assertRaises(TypeError, compare_digest, a, b)
Nick Coghlan807770e2012-06-15 21:14:08 +1000562
563 # Testing bytes of different lengths
564 a, b = b"foobar", b"foo"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200565 self.assertFalse(compare_digest(a, b))
Nick Coghlan807770e2012-06-15 21:14:08 +1000566 a, b = b"\xde\xad\xbe\xef", b"\xde\xad"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200567 self.assertFalse(compare_digest(a, b))
Nick Coghlan807770e2012-06-15 21:14:08 +1000568
569 # Testing bytes of same lengths, different values
570 a, b = b"foobar", b"foobaz"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200571 self.assertFalse(compare_digest(a, b))
Nick Coghlan807770e2012-06-15 21:14:08 +1000572 a, b = b"\xde\xad\xbe\xef", b"\xab\xad\x1d\xea"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200573 self.assertFalse(compare_digest(a, b))
Nick Coghlan807770e2012-06-15 21:14:08 +1000574
575 # Testing bytes of same lengths, same values
Charles-François Natali7feb9f42012-05-13 19:53:07 +0200576 a, b = b"foobar", b"foobar"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200577 self.assertTrue(compare_digest(a, b))
Charles-François Natali7feb9f42012-05-13 19:53:07 +0200578 a, b = b"\xde\xad\xbe\xef", b"\xde\xad\xbe\xef"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200579 self.assertTrue(compare_digest(a, b))
Charles-François Natali7feb9f42012-05-13 19:53:07 +0200580
Christian Heimes6cea6552012-06-24 13:48:32 +0200581 # Testing bytearrays of same lengths, same values
582 a, b = bytearray(b"foobar"), bytearray(b"foobar")
Christian Heimesdb5aed92020-05-27 21:50:06 +0200583 self.assertTrue(compare_digest(a, b))
Christian Heimes6cea6552012-06-24 13:48:32 +0200584
Min ho Kim39d87b52019-08-31 06:21:19 +1000585 # Testing bytearrays of different lengths
Christian Heimes6cea6552012-06-24 13:48:32 +0200586 a, b = bytearray(b"foobar"), bytearray(b"foo")
Christian Heimesdb5aed92020-05-27 21:50:06 +0200587 self.assertFalse(compare_digest(a, b))
Christian Heimes6cea6552012-06-24 13:48:32 +0200588
589 # Testing bytearrays of same lengths, different values
590 a, b = bytearray(b"foobar"), bytearray(b"foobaz")
Christian Heimesdb5aed92020-05-27 21:50:06 +0200591 self.assertFalse(compare_digest(a, b))
Christian Heimes6cea6552012-06-24 13:48:32 +0200592
593 # Testing byte and bytearray of same lengths, same values
594 a, b = bytearray(b"foobar"), b"foobar"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200595 self.assertTrue(compare_digest(a, b))
596 self.assertTrue(compare_digest(b, a))
Christian Heimes6cea6552012-06-24 13:48:32 +0200597
Min ho Kim39d87b52019-08-31 06:21:19 +1000598 # Testing byte bytearray of different lengths
Christian Heimes6cea6552012-06-24 13:48:32 +0200599 a, b = bytearray(b"foobar"), b"foo"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200600 self.assertFalse(compare_digest(a, b))
601 self.assertFalse(compare_digest(b, a))
Christian Heimes6cea6552012-06-24 13:48:32 +0200602
603 # Testing byte and bytearray of same lengths, different values
604 a, b = bytearray(b"foobar"), b"foobaz"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200605 self.assertFalse(compare_digest(a, b))
606 self.assertFalse(compare_digest(b, a))
Christian Heimes6cea6552012-06-24 13:48:32 +0200607
608 # Testing str of same lengths
609 a, b = "foobar", "foobar"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200610 self.assertTrue(compare_digest(a, b))
Christian Heimes6cea6552012-06-24 13:48:32 +0200611
Min ho Kim39d87b52019-08-31 06:21:19 +1000612 # Testing str of different lengths
Christian Heimes6cea6552012-06-24 13:48:32 +0200613 a, b = "foo", "foobar"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200614 self.assertFalse(compare_digest(a, b))
Christian Heimes6cea6552012-06-24 13:48:32 +0200615
616 # Testing bytes of same lengths, different values
617 a, b = "foobar", "foobaz"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200618 self.assertFalse(compare_digest(a, b))
Christian Heimes6cea6552012-06-24 13:48:32 +0200619
620 # Testing error cases
621 a, b = "foobar", b"foobar"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200622 self.assertRaises(TypeError, compare_digest, a, b)
Christian Heimes6cea6552012-06-24 13:48:32 +0200623 a, b = b"foobar", "foobar"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200624 self.assertRaises(TypeError, compare_digest, a, b)
Christian Heimes6cea6552012-06-24 13:48:32 +0200625 a, b = b"foobar", 1
Christian Heimesdb5aed92020-05-27 21:50:06 +0200626 self.assertRaises(TypeError, compare_digest, a, b)
Christian Heimes6cea6552012-06-24 13:48:32 +0200627 a, b = 100, 200
Christian Heimesdb5aed92020-05-27 21:50:06 +0200628 self.assertRaises(TypeError, compare_digest, a, b)
Christian Heimes6cea6552012-06-24 13:48:32 +0200629 a, b = "fooä", "fooä"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200630 self.assertRaises(TypeError, compare_digest, a, b)
Christian Heimes6cea6552012-06-24 13:48:32 +0200631
632 # subclasses are supported by ignore __eq__
633 class mystr(str):
634 def __eq__(self, other):
635 return False
636
637 a, b = mystr("foobar"), mystr("foobar")
Christian Heimesdb5aed92020-05-27 21:50:06 +0200638 self.assertTrue(compare_digest(a, b))
Christian Heimes6cea6552012-06-24 13:48:32 +0200639 a, b = mystr("foobar"), "foobar"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200640 self.assertTrue(compare_digest(a, b))
Christian Heimes6cea6552012-06-24 13:48:32 +0200641 a, b = mystr("foobar"), mystr("foobaz")
Christian Heimesdb5aed92020-05-27 21:50:06 +0200642 self.assertFalse(compare_digest(a, b))
Christian Heimes6cea6552012-06-24 13:48:32 +0200643
644 class mybytes(bytes):
645 def __eq__(self, other):
646 return False
647
648 a, b = mybytes(b"foobar"), mybytes(b"foobar")
Christian Heimesdb5aed92020-05-27 21:50:06 +0200649 self.assertTrue(compare_digest(a, b))
Christian Heimes6cea6552012-06-24 13:48:32 +0200650 a, b = mybytes(b"foobar"), b"foobar"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200651 self.assertTrue(compare_digest(a, b))
Christian Heimes6cea6552012-06-24 13:48:32 +0200652 a, b = mybytes(b"foobar"), mybytes(b"foobaz")
Christian Heimesdb5aed92020-05-27 21:50:06 +0200653 self.assertFalse(compare_digest(a, b))
Christian Heimes6cea6552012-06-24 13:48:32 +0200654
655
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000656if __name__ == "__main__":
Zachary Ware38c707e2015-04-13 15:00:43 -0500657 unittest.main()