blob: 6daf22ca06fb80ad2b3d99fd36dbd3e33a89e643 [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:
14 from _hashlib import HMAC as C_HMAC
15 from _hashlib import hmac_new as c_hmac_new
Christian Heimesdb5aed92020-05-27 21:50:06 +020016 from _hashlib import compare_digest as openssl_compare_digest
Christian Heimes54f28982020-05-17 13:49:10 +020017except ImportError:
18 C_HMAC = None
19 c_hmac_new = None
Christian Heimesdb5aed92020-05-27 21:50:06 +020020 openssl_compare_digest = None
Christian Heimes54f28982020-05-17 13:49:10 +020021
Christian Heimes217f5c42013-11-24 23:14:16 +010022
23def ignore_warning(func):
24 @functools.wraps(func)
25 def wrapper(*args, **kwargs):
26 with warnings.catch_warnings():
27 warnings.filterwarnings("ignore",
Matthias Bussonnier8bb0b5b2018-05-22 15:55:31 -070028 category=DeprecationWarning)
Christian Heimes217f5c42013-11-24 23:14:16 +010029 return func(*args, **kwargs)
30 return wrapper
31
32
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +000033class TestVectorsTestCase(unittest.TestCase):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +000034
Christian Heimes54f28982020-05-17 13:49:10 +020035 def asssert_hmac(
36 self, key, data, digest, hashfunc, hashname, digest_size, block_size
37 ):
38 h = hmac.HMAC(key, data, digestmod=hashfunc)
39 self.assertEqual(h.hexdigest().upper(), digest.upper())
40 self.assertEqual(h.digest(), binascii.unhexlify(digest))
41 self.assertEqual(h.name, f"hmac-{hashname}")
42 self.assertEqual(h.digest_size, digest_size)
43 self.assertEqual(h.block_size, block_size)
44
45 h = hmac.HMAC(key, data, digestmod=hashname)
46 self.assertEqual(h.hexdigest().upper(), digest.upper())
47 self.assertEqual(h.digest(), binascii.unhexlify(digest))
48 self.assertEqual(h.name, f"hmac-{hashname}")
49 self.assertEqual(h.digest_size, digest_size)
50 self.assertEqual(h.block_size, block_size)
51
52 h = hmac.HMAC(key, digestmod=hashname)
53 h2 = h.copy()
54 h2.update(b"test update")
55 h.update(data)
56 self.assertEqual(h.hexdigest().upper(), digest.upper())
57
58 h = hmac.new(key, data, digestmod=hashname)
59 self.assertEqual(h.hexdigest().upper(), digest.upper())
60 self.assertEqual(h.digest(), binascii.unhexlify(digest))
61 self.assertEqual(h.name, f"hmac-{hashname}")
62 self.assertEqual(h.digest_size, digest_size)
63 self.assertEqual(h.block_size, block_size)
64
65 h = hmac.new(key, None, digestmod=hashname)
66 h.update(data)
67 self.assertEqual(h.hexdigest().upper(), digest.upper())
68
69 h = hmac.new(key, digestmod=hashname)
70 h.update(data)
71 self.assertEqual(h.hexdigest().upper(), digest.upper())
72
73 h = hmac.new(key, data, digestmod=hashfunc)
74 self.assertEqual(h.hexdigest().upper(), digest.upper())
75
76 self.assertEqual(
77 hmac.digest(key, data, digest=hashname),
78 binascii.unhexlify(digest)
79 )
80 self.assertEqual(
81 hmac.digest(key, data, digest=hashfunc),
82 binascii.unhexlify(digest)
83 )
84 with unittest.mock.patch('hmac._openssl_md_meths', {}):
85 self.assertEqual(
86 hmac.digest(key, data, digest=hashname),
87 binascii.unhexlify(digest)
88 )
89 self.assertEqual(
90 hmac.digest(key, data, digest=hashfunc),
91 binascii.unhexlify(digest)
92 )
93
94 if c_hmac_new is not None:
95 h = c_hmac_new(key, data, digestmod=hashname)
96 self.assertEqual(h.hexdigest().upper(), digest.upper())
97 self.assertEqual(h.digest(), binascii.unhexlify(digest))
98 self.assertEqual(h.name, f"hmac-{hashname}")
99 self.assertEqual(h.digest_size, digest_size)
100 self.assertEqual(h.block_size, block_size)
101
102 h = c_hmac_new(key, digestmod=hashname)
103 h2 = h.copy()
104 h2.update(b"test update")
105 h.update(data)
106 self.assertEqual(h.hexdigest().upper(), digest.upper())
107
Hai Shi66abe982020-04-29 09:11:29 +0800108 @hashlib_helper.requires_hashdigest('md5', openssl=True)
Jeremy Hylton893801e2003-05-27 16:16:41 +0000109 def test_md5_vectors(self):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000110 # Test the HMAC module against test vectors from the RFC.
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000111
112 def md5test(key, data, digest):
Christian Heimes54f28982020-05-17 13:49:10 +0200113 self.asssert_hmac(
114 key, data, digest,
115 hashfunc=hashlib.md5,
116 hashname="md5",
117 digest_size=16,
118 block_size=64
Christian Heimes2f050c72018-01-27 09:53:43 +0100119 )
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000120
Guido van Rossum3f429082007-07-10 13:35:52 +0000121 md5test(b"\x0b" * 16,
122 b"Hi There",
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000123 "9294727A3638BB1C13F48EF8158BFC9D")
124
Guido van Rossum3f429082007-07-10 13:35:52 +0000125 md5test(b"Jefe",
126 b"what do ya want for nothing?",
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000127 "750c783e6ab0b503eaa86e310a5db738")
128
Guido van Rossum3f429082007-07-10 13:35:52 +0000129 md5test(b"\xaa" * 16,
130 b"\xdd" * 50,
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000131 "56be34521d144c88dbb8c733f0e8b3f6")
132
Guido van Rossum39478e82007-08-27 17:23:59 +0000133 md5test(bytes(range(1, 26)),
Guido van Rossum3f429082007-07-10 13:35:52 +0000134 b"\xcd" * 50,
Jeremy Hylton893801e2003-05-27 16:16:41 +0000135 "697eaf0aca3a3aea3a75164746ffaa79")
136
Guido van Rossum39478e82007-08-27 17:23:59 +0000137 md5test(b"\x0C" * 16,
138 b"Test With Truncation",
Jeremy Hylton893801e2003-05-27 16:16:41 +0000139 "56461ef2342edc00f9bab995690efd4c")
140
Guido van Rossum3f429082007-07-10 13:35:52 +0000141 md5test(b"\xaa" * 80,
Guido van Rossum39478e82007-08-27 17:23:59 +0000142 b"Test Using Larger Than Block-Size Key - Hash Key First",
Jeremy Hylton893801e2003-05-27 16:16:41 +0000143 "6b1ab7fe4bd7bf8f0b62e6ce61b9d0cd")
144
Guido van Rossum3f429082007-07-10 13:35:52 +0000145 md5test(b"\xaa" * 80,
Guido van Rossum39478e82007-08-27 17:23:59 +0000146 (b"Test Using Larger Than Block-Size Key "
147 b"and Larger Than One Block-Size Data"),
Jeremy Hylton893801e2003-05-27 16:16:41 +0000148 "6f630fad67cda0ee1fb1f562db3aa53e")
149
Hai Shi66abe982020-04-29 09:11:29 +0800150 @hashlib_helper.requires_hashdigest('sha1', openssl=True)
Jeremy Hylton893801e2003-05-27 16:16:41 +0000151 def test_sha_vectors(self):
152 def shatest(key, data, digest):
Christian Heimes54f28982020-05-17 13:49:10 +0200153 self.asssert_hmac(
154 key, data, digest,
155 hashfunc=hashlib.sha1,
156 hashname="sha1",
157 digest_size=20,
158 block_size=64
Christian Heimes2f050c72018-01-27 09:53:43 +0100159 )
160
Guido van Rossum3f429082007-07-10 13:35:52 +0000161 shatest(b"\x0b" * 20,
162 b"Hi There",
Jeremy Hylton893801e2003-05-27 16:16:41 +0000163 "b617318655057264e28bc0b6fb378c8ef146be00")
164
Guido van Rossum3f429082007-07-10 13:35:52 +0000165 shatest(b"Jefe",
166 b"what do ya want for nothing?",
Jeremy Hylton893801e2003-05-27 16:16:41 +0000167 "effcdf6ae5eb2fa2d27416d5f184df9c259a7c79")
168
Guido van Rossum3f429082007-07-10 13:35:52 +0000169 shatest(b"\xAA" * 20,
170 b"\xDD" * 50,
Jeremy Hylton893801e2003-05-27 16:16:41 +0000171 "125d7342b9ac11cd91a39af48aa17b4f63f175d3")
172
Guido van Rossum3f429082007-07-10 13:35:52 +0000173 shatest(bytes(range(1, 26)),
174 b"\xCD" * 50,
Jeremy Hylton893801e2003-05-27 16:16:41 +0000175 "4c9007f4026250c6bc8414f9bf50c86c2d7235da")
176
Guido van Rossum39478e82007-08-27 17:23:59 +0000177 shatest(b"\x0C" * 20,
178 b"Test With Truncation",
Jeremy Hylton893801e2003-05-27 16:16:41 +0000179 "4c1a03424b55e07fe7f27be1d58bb9324a9a5a04")
180
Guido van Rossum3f429082007-07-10 13:35:52 +0000181 shatest(b"\xAA" * 80,
182 b"Test Using Larger Than Block-Size Key - Hash Key First",
Jeremy Hylton893801e2003-05-27 16:16:41 +0000183 "aa4ae5e15272d00e95705637ce8a3b55ed402112")
184
Guido van Rossum3f429082007-07-10 13:35:52 +0000185 shatest(b"\xAA" * 80,
186 (b"Test Using Larger Than Block-Size Key "
187 b"and Larger Than One Block-Size Data"),
Jeremy Hylton893801e2003-05-27 16:16:41 +0000188 "e8e99d0f45237d786d6bbaa7965c7808bbff1a91")
189
Christian Heimesc4ab1102013-11-20 17:35:06 +0100190 def _rfc4231_test_cases(self, hashfunc, hash_name, digest_size, block_size):
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000191 def hmactest(key, data, hexdigests):
Christian Heimes54f28982020-05-17 13:49:10 +0200192 digest = hexdigests[hashfunc]
Christian Heimesc4ab1102013-11-20 17:35:06 +0100193
Christian Heimes54f28982020-05-17 13:49:10 +0200194 self.asssert_hmac(
195 key, data, digest,
196 hashfunc=hashfunc,
197 hashname=hash_name,
198 digest_size=digest_size,
199 block_size=block_size
Christian Heimes2f050c72018-01-27 09:53:43 +0100200 )
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000201
202 # 4.2. Test Case 1
203 hmactest(key = b'\x0b'*20,
204 data = b'Hi There',
205 hexdigests = {
206 hashlib.sha224: '896fb1128abbdf196832107cd49df33f'
207 '47b4b1169912ba4f53684b22',
208 hashlib.sha256: 'b0344c61d8db38535ca8afceaf0bf12b'
209 '881dc200c9833da726e9376c2e32cff7',
210 hashlib.sha384: 'afd03944d84895626b0825f4ab46907f'
211 '15f9dadbe4101ec682aa034c7cebc59c'
212 'faea9ea9076ede7f4af152e8b2fa9cb6',
213 hashlib.sha512: '87aa7cdea5ef619d4ff0b4241a1d6cb0'
214 '2379f4e2ce4ec2787ad0b30545e17cde'
215 'daa833b7d6b8a702038b274eaea3f4e4'
216 'be9d914eeb61f1702e696c203a126854',
217 })
218
219 # 4.3. Test Case 2
220 hmactest(key = b'Jefe',
221 data = b'what do ya want for nothing?',
222 hexdigests = {
223 hashlib.sha224: 'a30e01098bc6dbbf45690f3a7e9e6d0f'
224 '8bbea2a39e6148008fd05e44',
225 hashlib.sha256: '5bdcc146bf60754e6a042426089575c7'
226 '5a003f089d2739839dec58b964ec3843',
227 hashlib.sha384: 'af45d2e376484031617f78d2b58a6b1b'
228 '9c7ef464f5a01b47e42ec3736322445e'
229 '8e2240ca5e69e2c78b3239ecfab21649',
230 hashlib.sha512: '164b7a7bfcf819e2e395fbe73b56e0a3'
231 '87bd64222e831fd610270cd7ea250554'
232 '9758bf75c05a994a6d034f65f8f0e6fd'
233 'caeab1a34d4a6b4b636e070a38bce737',
234 })
235
236 # 4.4. Test Case 3
237 hmactest(key = b'\xaa'*20,
238 data = b'\xdd'*50,
239 hexdigests = {
240 hashlib.sha224: '7fb3cb3588c6c1f6ffa9694d7d6ad264'
241 '9365b0c1f65d69d1ec8333ea',
242 hashlib.sha256: '773ea91e36800e46854db8ebd09181a7'
243 '2959098b3ef8c122d9635514ced565fe',
244 hashlib.sha384: '88062608d3e6ad8a0aa2ace014c8a86f'
245 '0aa635d947ac9febe83ef4e55966144b'
246 '2a5ab39dc13814b94e3ab6e101a34f27',
247 hashlib.sha512: 'fa73b0089d56a284efb0f0756c890be9'
248 'b1b5dbdd8ee81a3655f83e33b2279d39'
249 'bf3e848279a722c806b485a47e67c807'
250 'b946a337bee8942674278859e13292fb',
251 })
252
253 # 4.5. Test Case 4
254 hmactest(key = bytes(x for x in range(0x01, 0x19+1)),
255 data = b'\xcd'*50,
256 hexdigests = {
257 hashlib.sha224: '6c11506874013cac6a2abc1bb382627c'
258 'ec6a90d86efc012de7afec5a',
259 hashlib.sha256: '82558a389a443c0ea4cc819899f2083a'
260 '85f0faa3e578f8077a2e3ff46729665b',
261 hashlib.sha384: '3e8a69b7783c25851933ab6290af6ca7'
262 '7a9981480850009cc5577c6e1f573b4e'
263 '6801dd23c4a7d679ccf8a386c674cffb',
264 hashlib.sha512: 'b0ba465637458c6990e5a8c5f61d4af7'
265 'e576d97ff94b872de76f8050361ee3db'
266 'a91ca5c11aa25eb4d679275cc5788063'
267 'a5f19741120c4f2de2adebeb10a298dd',
268 })
269
270 # 4.7. Test Case 6
271 hmactest(key = b'\xaa'*131,
272 data = b'Test Using Larger Than Block-Siz'
273 b'e Key - Hash Key First',
274 hexdigests = {
275 hashlib.sha224: '95e9a0db962095adaebe9b2d6f0dbce2'
276 'd499f112f2d2b7273fa6870e',
277 hashlib.sha256: '60e431591ee0b67f0d8a26aacbf5b77f'
278 '8e0bc6213728c5140546040f0ee37f54',
279 hashlib.sha384: '4ece084485813e9088d2c63a041bc5b4'
280 '4f9ef1012a2b588f3cd11f05033ac4c6'
281 '0c2ef6ab4030fe8296248df163f44952',
282 hashlib.sha512: '80b24263c7c1a3ebb71493c1dd7be8b4'
283 '9b46d1f41b4aeec1121b013783f8f352'
284 '6b56d037e05f2598bd0fd2215d6a1e52'
285 '95e64f73f63f0aec8b915a985d786598',
286 })
287
288 # 4.8. Test Case 7
289 hmactest(key = b'\xaa'*131,
290 data = b'This is a test using a larger th'
291 b'an block-size key and a larger t'
292 b'han block-size data. The key nee'
293 b'ds to be hashed before being use'
294 b'd by the HMAC algorithm.',
295 hexdigests = {
296 hashlib.sha224: '3a854166ac5d9f023f54d517d0b39dbd'
297 '946770db9c2b95c9f6f565d1',
298 hashlib.sha256: '9b09ffa71b942fcb27635fbcd5b0e944'
299 'bfdc63644f0713938a7f51535c3a35e2',
300 hashlib.sha384: '6617178e941f020d351e2f254e8fd32c'
301 '602420feb0b8fb9adccebb82461e99c5'
302 'a678cc31e799176d3860e6110c46523e',
303 hashlib.sha512: 'e37b6a775dc87dbaa4dfa9f96e5e3ffd'
304 'debd71f8867289865df5a32d20cdc944'
305 'b6022cac3c4982b10d5eeb55c3e4de15'
306 '134676fb6de0446065c97440fa8c6a58',
307 })
308
Hai Shi66abe982020-04-29 09:11:29 +0800309 @hashlib_helper.requires_hashdigest('sha224', openssl=True)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000310 def test_sha224_rfc4231(self):
Christian Heimesc4ab1102013-11-20 17:35:06 +0100311 self._rfc4231_test_cases(hashlib.sha224, 'sha224', 28, 64)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000312
Hai Shi66abe982020-04-29 09:11:29 +0800313 @hashlib_helper.requires_hashdigest('sha256', openssl=True)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000314 def test_sha256_rfc4231(self):
Christian Heimesc4ab1102013-11-20 17:35:06 +0100315 self._rfc4231_test_cases(hashlib.sha256, 'sha256', 32, 64)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000316
Hai Shi66abe982020-04-29 09:11:29 +0800317 @hashlib_helper.requires_hashdigest('sha384', openssl=True)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000318 def test_sha384_rfc4231(self):
Christian Heimesc4ab1102013-11-20 17:35:06 +0100319 self._rfc4231_test_cases(hashlib.sha384, 'sha384', 48, 128)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000320
Hai Shi66abe982020-04-29 09:11:29 +0800321 @hashlib_helper.requires_hashdigest('sha512', openssl=True)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000322 def test_sha512_rfc4231(self):
Christian Heimesc4ab1102013-11-20 17:35:06 +0100323 self._rfc4231_test_cases(hashlib.sha512, 'sha512', 64, 128)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000324
Hai Shi66abe982020-04-29 09:11:29 +0800325 @hashlib_helper.requires_hashdigest('sha256')
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000326 def test_legacy_block_size_warnings(self):
327 class MockCrazyHash(object):
328 """Ain't no block_size attribute here."""
329 def __init__(self, *args):
Christian Heimesc64a1a62019-09-25 16:30:20 +0200330 self._x = hashlib.sha256(*args)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000331 self.digest_size = self._x.digest_size
332 def update(self, v):
333 self._x.update(v)
334 def digest(self):
335 return self._x.digest()
336
Brett Cannon1cd02472008-09-09 01:52:27 +0000337 with warnings.catch_warnings():
Christian Heimese25f35e2008-03-20 10:49:03 +0000338 warnings.simplefilter('error', RuntimeWarning)
Florent Xicluna41fe6152010-04-02 18:52:12 +0000339 with self.assertRaises(RuntimeWarning):
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000340 hmac.HMAC(b'a', b'b', digestmod=MockCrazyHash)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000341 self.fail('Expected warning about missing block_size')
342
343 MockCrazyHash.block_size = 1
Florent Xicluna41fe6152010-04-02 18:52:12 +0000344 with self.assertRaises(RuntimeWarning):
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000345 hmac.HMAC(b'a', b'b', digestmod=MockCrazyHash)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000346 self.fail('Expected warning about small block_size')
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000347
Matthias Bussonnier51a47432018-09-10 20:10:01 +0200348 def test_with_digestmod_no_default(self):
Gregory P. Smithf33c57d52019-10-17 20:30:42 -0700349 """The digestmod parameter is required as of Python 3.8."""
350 with self.assertRaisesRegex(TypeError, r'required.*digestmod'):
Christian Heimes634919a2013-11-20 17:23:06 +0100351 key = b"\x0b" * 16
352 data = b"Hi There"
Matthias Bussonnier51a47432018-09-10 20:10:01 +0200353 hmac.HMAC(key, data, digestmod=None)
Gregory P. Smithf33c57d52019-10-17 20:30:42 -0700354 with self.assertRaisesRegex(TypeError, r'required.*digestmod'):
355 hmac.new(key, data)
356 with self.assertRaisesRegex(TypeError, r'required.*digestmod'):
357 hmac.HMAC(key, msg=data, digestmod='')
Jeremy Hylton893801e2003-05-27 16:16:41 +0000358
Christian Heimesc64a1a62019-09-25 16:30:20 +0200359
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000360class ConstructorTestCase(unittest.TestCase):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000361
Christian Heimesc64a1a62019-09-25 16:30:20 +0200362 expected = (
363 "6c845b47f52b3b47f6590c502db7825aad757bf4fadc8fa972f7cd2e76a5bdeb"
364 )
365
Hai Shi66abe982020-04-29 09:11:29 +0800366 @hashlib_helper.requires_hashdigest('sha256')
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000367 def test_normal(self):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000368 # Standard constructor call.
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000369 try:
Christian Heimesc64a1a62019-09-25 16:30:20 +0200370 hmac.HMAC(b"key", digestmod='sha256')
Christian Heimes217f5c42013-11-24 23:14:16 +0100371 except Exception:
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000372 self.fail("Standard constructor call raised exception.")
373
Hai Shi66abe982020-04-29 09:11:29 +0800374 @hashlib_helper.requires_hashdigest('sha256')
Antoine Pitrou24ef3e92012-06-30 17:27:56 +0200375 def test_with_str_key(self):
376 # Pass a key of type str, which is an error, because it expects a key
377 # of type bytes
378 with self.assertRaises(TypeError):
Christian Heimesc64a1a62019-09-25 16:30:20 +0200379 h = hmac.HMAC("key", digestmod='sha256')
Antoine Pitrou24ef3e92012-06-30 17:27:56 +0200380
Hai Shi66abe982020-04-29 09:11:29 +0800381 @hashlib_helper.requires_hashdigest('sha256')
Antoine Pitrou24ef3e92012-06-30 17:27:56 +0200382 def test_dot_new_with_str_key(self):
383 # Pass a key of type str, which is an error, because it expects a key
384 # of type bytes
385 with self.assertRaises(TypeError):
Christian Heimesc64a1a62019-09-25 16:30:20 +0200386 h = hmac.new("key", digestmod='sha256')
Antoine Pitrou24ef3e92012-06-30 17:27:56 +0200387
Hai Shi66abe982020-04-29 09:11:29 +0800388 @hashlib_helper.requires_hashdigest('sha256')
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000389 def test_withtext(self):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000390 # Constructor call with text.
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000391 try:
Christian Heimesc64a1a62019-09-25 16:30:20 +0200392 h = hmac.HMAC(b"key", b"hash this!", digestmod='sha256')
Christian Heimes217f5c42013-11-24 23:14:16 +0100393 except Exception:
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000394 self.fail("Constructor call with text argument raised exception.")
Christian Heimesc64a1a62019-09-25 16:30:20 +0200395 self.assertEqual(h.hexdigest(), self.expected)
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000396
Hai Shi66abe982020-04-29 09:11:29 +0800397 @hashlib_helper.requires_hashdigest('sha256')
Christian Heimes04926ae2013-07-01 13:08:42 +0200398 def test_with_bytearray(self):
399 try:
Christian Heimes217f5c42013-11-24 23:14:16 +0100400 h = hmac.HMAC(bytearray(b"key"), bytearray(b"hash this!"),
Christian Heimesc64a1a62019-09-25 16:30:20 +0200401 digestmod="sha256")
Christian Heimes217f5c42013-11-24 23:14:16 +0100402 except Exception:
Christian Heimes04926ae2013-07-01 13:08:42 +0200403 self.fail("Constructor call with bytearray arguments raised exception.")
stratakis89433182019-12-03 16:35:54 +0100404 self.assertEqual(h.hexdigest(), self.expected)
Christian Heimes04926ae2013-07-01 13:08:42 +0200405
Hai Shi66abe982020-04-29 09:11:29 +0800406 @hashlib_helper.requires_hashdigest('sha256')
Christian Heimes04926ae2013-07-01 13:08:42 +0200407 def test_with_memoryview_msg(self):
408 try:
Christian Heimesc64a1a62019-09-25 16:30:20 +0200409 h = hmac.HMAC(b"key", memoryview(b"hash this!"), digestmod="sha256")
Christian Heimes217f5c42013-11-24 23:14:16 +0100410 except Exception:
Christian Heimes04926ae2013-07-01 13:08:42 +0200411 self.fail("Constructor call with memoryview msg raised exception.")
stratakis89433182019-12-03 16:35:54 +0100412 self.assertEqual(h.hexdigest(), self.expected)
Christian Heimes04926ae2013-07-01 13:08:42 +0200413
Hai Shi66abe982020-04-29 09:11:29 +0800414 @hashlib_helper.requires_hashdigest('sha256')
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000415 def test_withmodule(self):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000416 # Constructor call with text and digest module.
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000417 try:
Christian Heimesc64a1a62019-09-25 16:30:20 +0200418 h = hmac.HMAC(b"key", b"", hashlib.sha256)
Christian Heimes217f5c42013-11-24 23:14:16 +0100419 except Exception:
Christian Heimesc64a1a62019-09-25 16:30:20 +0200420 self.fail("Constructor call with hashlib.sha256 raised exception.")
421
Christian Heimes54f28982020-05-17 13:49:10 +0200422 @unittest.skipUnless(C_HMAC is not None, 'need _hashlib')
423 def test_internal_types(self):
424 # internal types like _hashlib.C_HMAC are not constructable
425 with self.assertRaisesRegex(
426 TypeError, "cannot create 'HMAC' instance"
427 ):
428 C_HMAC()
429
Tim Peters88768482001-11-13 21:51:26 +0000430
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000431class SanityTestCase(unittest.TestCase):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000432
Hai Shi66abe982020-04-29 09:11:29 +0800433 @hashlib_helper.requires_hashdigest('sha256')
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000434 def test_exercise_all_methods(self):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000435 # Exercising all methods once.
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000436 # This must not raise any exceptions
437 try:
Christian Heimesc64a1a62019-09-25 16:30:20 +0200438 h = hmac.HMAC(b"my secret key", digestmod="sha256")
Guido van Rossum39478e82007-08-27 17:23:59 +0000439 h.update(b"compute the hash of this text!")
Christian Heimes54f28982020-05-17 13:49:10 +0200440 h.digest()
441 h.hexdigest()
442 h.copy()
Christian Heimes217f5c42013-11-24 23:14:16 +0100443 except Exception:
Neal Norwitz28bb5722002-04-01 19:00:50 +0000444 self.fail("Exception raised during normal usage of HMAC class.")
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000445
Christian Heimesc64a1a62019-09-25 16:30:20 +0200446
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000447class CopyTestCase(unittest.TestCase):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000448
Hai Shi66abe982020-04-29 09:11:29 +0800449 @hashlib_helper.requires_hashdigest('sha256')
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000450 def test_attributes(self):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000451 # Testing if attributes are of same type.
Christian Heimesc64a1a62019-09-25 16:30:20 +0200452 h1 = hmac.HMAC(b"key", digestmod="sha256")
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000453 h2 = h1.copy()
Christian Heimes837f9e42020-05-17 01:05:40 +0200454 self.assertTrue(h1._digest_cons == h2._digest_cons,
Gregory P. Smithf21a5f72005-08-21 18:45:59 +0000455 "digest constructors don't match.")
Christian Heimes837f9e42020-05-17 01:05:40 +0200456 self.assertEqual(type(h1._inner), type(h2._inner),
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000457 "Types of inner don't match.")
Christian Heimes837f9e42020-05-17 01:05:40 +0200458 self.assertEqual(type(h1._outer), type(h2._outer),
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000459 "Types of outer don't match.")
460
Hai Shi66abe982020-04-29 09:11:29 +0800461 @hashlib_helper.requires_hashdigest('sha256')
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000462 def test_realcopy(self):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000463 # Testing if the copy method created a real copy.
Christian Heimesc64a1a62019-09-25 16:30:20 +0200464 h1 = hmac.HMAC(b"key", digestmod="sha256")
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000465 h2 = h1.copy()
Mark Dickinsona56c4672009-01-27 18:17:45 +0000466 # Using id() in case somebody has overridden __eq__/__ne__.
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000467 self.assertTrue(id(h1) != id(h2), "No real copy of the HMAC instance.")
Christian Heimes837f9e42020-05-17 01:05:40 +0200468 self.assertTrue(id(h1._inner) != id(h2._inner),
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000469 "No real copy of the attribute 'inner'.")
Christian Heimes837f9e42020-05-17 01:05:40 +0200470 self.assertTrue(id(h1._outer) != id(h2._outer),
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000471 "No real copy of the attribute 'outer'.")
Christian Heimes837f9e42020-05-17 01:05:40 +0200472 self.assertEqual(h1._inner, h1.inner)
473 self.assertEqual(h1._outer, h1.outer)
474 self.assertEqual(h1._digest_cons, h1.digest_cons)
475
476 @hashlib_helper.requires_hashdigest('sha256')
477 def test_properties(self):
478 # deprecated properties
479 h1 = hmac.HMAC(b"key", digestmod="sha256")
480 self.assertEqual(h1._inner, h1.inner)
481 self.assertEqual(h1._outer, h1.outer)
482 self.assertEqual(h1._digest_cons, h1.digest_cons)
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000483
Hai Shi66abe982020-04-29 09:11:29 +0800484 @hashlib_helper.requires_hashdigest('sha256')
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000485 def test_equality(self):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000486 # Testing if the copy has the same digests.
Christian Heimesc64a1a62019-09-25 16:30:20 +0200487 h1 = hmac.HMAC(b"key", digestmod="sha256")
Guido van Rossum39478e82007-08-27 17:23:59 +0000488 h1.update(b"some random text")
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000489 h2 = h1.copy()
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000490 self.assertEqual(h1.digest(), h2.digest(),
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000491 "Digest of copy doesn't match original digest.")
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000492 self.assertEqual(h1.hexdigest(), h2.hexdigest(),
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000493 "Hexdigest of copy doesn't match original hexdigest.")
494
Christian Heimes54f28982020-05-17 13:49:10 +0200495 @hashlib_helper.requires_hashdigest('sha256')
496 def test_equality_new(self):
497 # Testing if the copy has the same digests with hmac.new().
498 h1 = hmac.new(b"key", digestmod="sha256")
499 h1.update(b"some random text")
500 h2 = h1.copy()
501 self.assertTrue(
502 id(h1) != id(h2), "No real copy of the HMAC instance."
503 )
504 self.assertEqual(h1.digest(), h2.digest(),
505 "Digest of copy doesn't match original digest.")
506 self.assertEqual(h1.hexdigest(), h2.hexdigest(),
507 "Hexdigest of copy doesn't match original hexdigest.")
508
509
Nick Coghlan807770e2012-06-15 21:14:08 +1000510class CompareDigestTestCase(unittest.TestCase):
Charles-François Natali7feb9f42012-05-13 19:53:07 +0200511
Christian Heimesdb5aed92020-05-27 21:50:06 +0200512 def test_hmac_compare_digest(self):
513 self._test_compare_digest(hmac.compare_digest)
514 if openssl_compare_digest is not None:
515 self.assertIs(hmac.compare_digest, openssl_compare_digest)
516 else:
517 self.assertIs(hmac.compare_digest, operator_compare_digest)
518
519 def test_operator_compare_digest(self):
520 self._test_compare_digest(operator_compare_digest)
521
522 @unittest.skipIf(openssl_compare_digest is None, "test requires _hashlib")
523 def test_openssl_compare_digest(self):
524 self._test_compare_digest(openssl_compare_digest)
525
526 def _test_compare_digest(self, compare_digest):
Charles-François Natali7feb9f42012-05-13 19:53:07 +0200527 # Testing input type exception handling
528 a, b = 100, 200
Christian Heimesdb5aed92020-05-27 21:50:06 +0200529 self.assertRaises(TypeError, compare_digest, a, b)
Nick Coghlan807770e2012-06-15 21:14:08 +1000530 a, b = 100, b"foobar"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200531 self.assertRaises(TypeError, compare_digest, a, b)
Nick Coghlan807770e2012-06-15 21:14:08 +1000532 a, b = b"foobar", 200
Christian Heimesdb5aed92020-05-27 21:50:06 +0200533 self.assertRaises(TypeError, compare_digest, a, b)
Charles-François Natali7feb9f42012-05-13 19:53:07 +0200534 a, b = "foobar", b"foobar"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200535 self.assertRaises(TypeError, compare_digest, a, b)
Nick Coghlan807770e2012-06-15 21:14:08 +1000536 a, b = b"foobar", "foobar"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200537 self.assertRaises(TypeError, compare_digest, a, b)
Nick Coghlan807770e2012-06-15 21:14:08 +1000538
539 # Testing bytes of different lengths
540 a, b = b"foobar", b"foo"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200541 self.assertFalse(compare_digest(a, b))
Nick Coghlan807770e2012-06-15 21:14:08 +1000542 a, b = b"\xde\xad\xbe\xef", b"\xde\xad"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200543 self.assertFalse(compare_digest(a, b))
Nick Coghlan807770e2012-06-15 21:14:08 +1000544
545 # Testing bytes of same lengths, different values
546 a, b = b"foobar", b"foobaz"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200547 self.assertFalse(compare_digest(a, b))
Nick Coghlan807770e2012-06-15 21:14:08 +1000548 a, b = b"\xde\xad\xbe\xef", b"\xab\xad\x1d\xea"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200549 self.assertFalse(compare_digest(a, b))
Nick Coghlan807770e2012-06-15 21:14:08 +1000550
551 # Testing bytes of same lengths, same values
Charles-François Natali7feb9f42012-05-13 19:53:07 +0200552 a, b = b"foobar", b"foobar"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200553 self.assertTrue(compare_digest(a, b))
Charles-François Natali7feb9f42012-05-13 19:53:07 +0200554 a, b = b"\xde\xad\xbe\xef", b"\xde\xad\xbe\xef"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200555 self.assertTrue(compare_digest(a, b))
Charles-François Natali7feb9f42012-05-13 19:53:07 +0200556
Christian Heimes6cea6552012-06-24 13:48:32 +0200557 # Testing bytearrays of same lengths, same values
558 a, b = bytearray(b"foobar"), bytearray(b"foobar")
Christian Heimesdb5aed92020-05-27 21:50:06 +0200559 self.assertTrue(compare_digest(a, b))
Christian Heimes6cea6552012-06-24 13:48:32 +0200560
Min ho Kim39d87b52019-08-31 06:21:19 +1000561 # Testing bytearrays of different lengths
Christian Heimes6cea6552012-06-24 13:48:32 +0200562 a, b = bytearray(b"foobar"), bytearray(b"foo")
Christian Heimesdb5aed92020-05-27 21:50:06 +0200563 self.assertFalse(compare_digest(a, b))
Christian Heimes6cea6552012-06-24 13:48:32 +0200564
565 # Testing bytearrays of same lengths, different values
566 a, b = bytearray(b"foobar"), bytearray(b"foobaz")
Christian Heimesdb5aed92020-05-27 21:50:06 +0200567 self.assertFalse(compare_digest(a, b))
Christian Heimes6cea6552012-06-24 13:48:32 +0200568
569 # Testing byte and bytearray of same lengths, same values
570 a, b = bytearray(b"foobar"), b"foobar"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200571 self.assertTrue(compare_digest(a, b))
572 self.assertTrue(compare_digest(b, a))
Christian Heimes6cea6552012-06-24 13:48:32 +0200573
Min ho Kim39d87b52019-08-31 06:21:19 +1000574 # Testing byte bytearray of different lengths
Christian Heimes6cea6552012-06-24 13:48:32 +0200575 a, b = bytearray(b"foobar"), b"foo"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200576 self.assertFalse(compare_digest(a, b))
577 self.assertFalse(compare_digest(b, a))
Christian Heimes6cea6552012-06-24 13:48:32 +0200578
579 # Testing byte and bytearray of same lengths, different values
580 a, b = bytearray(b"foobar"), b"foobaz"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200581 self.assertFalse(compare_digest(a, b))
582 self.assertFalse(compare_digest(b, a))
Christian Heimes6cea6552012-06-24 13:48:32 +0200583
584 # Testing str of same lengths
585 a, b = "foobar", "foobar"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200586 self.assertTrue(compare_digest(a, b))
Christian Heimes6cea6552012-06-24 13:48:32 +0200587
Min ho Kim39d87b52019-08-31 06:21:19 +1000588 # Testing str of different lengths
Christian Heimes6cea6552012-06-24 13:48:32 +0200589 a, b = "foo", "foobar"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200590 self.assertFalse(compare_digest(a, b))
Christian Heimes6cea6552012-06-24 13:48:32 +0200591
592 # Testing bytes of same lengths, different values
593 a, b = "foobar", "foobaz"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200594 self.assertFalse(compare_digest(a, b))
Christian Heimes6cea6552012-06-24 13:48:32 +0200595
596 # Testing error cases
597 a, b = "foobar", b"foobar"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200598 self.assertRaises(TypeError, compare_digest, a, b)
Christian Heimes6cea6552012-06-24 13:48:32 +0200599 a, b = b"foobar", "foobar"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200600 self.assertRaises(TypeError, compare_digest, a, b)
Christian Heimes6cea6552012-06-24 13:48:32 +0200601 a, b = b"foobar", 1
Christian Heimesdb5aed92020-05-27 21:50:06 +0200602 self.assertRaises(TypeError, compare_digest, a, b)
Christian Heimes6cea6552012-06-24 13:48:32 +0200603 a, b = 100, 200
Christian Heimesdb5aed92020-05-27 21:50:06 +0200604 self.assertRaises(TypeError, compare_digest, a, b)
Christian Heimes6cea6552012-06-24 13:48:32 +0200605 a, b = "fooä", "fooä"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200606 self.assertRaises(TypeError, compare_digest, a, b)
Christian Heimes6cea6552012-06-24 13:48:32 +0200607
608 # subclasses are supported by ignore __eq__
609 class mystr(str):
610 def __eq__(self, other):
611 return False
612
613 a, b = mystr("foobar"), mystr("foobar")
Christian Heimesdb5aed92020-05-27 21:50:06 +0200614 self.assertTrue(compare_digest(a, b))
Christian Heimes6cea6552012-06-24 13:48:32 +0200615 a, b = mystr("foobar"), "foobar"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200616 self.assertTrue(compare_digest(a, b))
Christian Heimes6cea6552012-06-24 13:48:32 +0200617 a, b = mystr("foobar"), mystr("foobaz")
Christian Heimesdb5aed92020-05-27 21:50:06 +0200618 self.assertFalse(compare_digest(a, b))
Christian Heimes6cea6552012-06-24 13:48:32 +0200619
620 class mybytes(bytes):
621 def __eq__(self, other):
622 return False
623
624 a, b = mybytes(b"foobar"), mybytes(b"foobar")
Christian Heimesdb5aed92020-05-27 21:50:06 +0200625 self.assertTrue(compare_digest(a, b))
Christian Heimes6cea6552012-06-24 13:48:32 +0200626 a, b = mybytes(b"foobar"), b"foobar"
Christian Heimesdb5aed92020-05-27 21:50:06 +0200627 self.assertTrue(compare_digest(a, b))
Christian Heimes6cea6552012-06-24 13:48:32 +0200628 a, b = mybytes(b"foobar"), mybytes(b"foobaz")
Christian Heimesdb5aed92020-05-27 21:50:06 +0200629 self.assertFalse(compare_digest(a, b))
Christian Heimes6cea6552012-06-24 13:48:32 +0200630
631
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000632if __name__ == "__main__":
Zachary Ware38c707e2015-04-13 15:00:43 -0500633 unittest.main()