blob: 7a52e39c5d47113bd5b55bb18770dff8d13bb0a3 [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 Heimes54f28982020-05-17 13:49:10 +020011try:
12 from _hashlib import HMAC as C_HMAC
13 from _hashlib import hmac_new as c_hmac_new
14except ImportError:
15 C_HMAC = None
16 c_hmac_new = None
17
Christian Heimes217f5c42013-11-24 23:14:16 +010018
19def ignore_warning(func):
20 @functools.wraps(func)
21 def wrapper(*args, **kwargs):
22 with warnings.catch_warnings():
23 warnings.filterwarnings("ignore",
Matthias Bussonnier8bb0b5b2018-05-22 15:55:31 -070024 category=DeprecationWarning)
Christian Heimes217f5c42013-11-24 23:14:16 +010025 return func(*args, **kwargs)
26 return wrapper
27
28
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +000029class TestVectorsTestCase(unittest.TestCase):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +000030
Christian Heimes54f28982020-05-17 13:49:10 +020031 def asssert_hmac(
32 self, key, data, digest, hashfunc, hashname, digest_size, block_size
33 ):
34 h = hmac.HMAC(key, data, digestmod=hashfunc)
35 self.assertEqual(h.hexdigest().upper(), digest.upper())
36 self.assertEqual(h.digest(), binascii.unhexlify(digest))
37 self.assertEqual(h.name, f"hmac-{hashname}")
38 self.assertEqual(h.digest_size, digest_size)
39 self.assertEqual(h.block_size, block_size)
40
41 h = hmac.HMAC(key, data, digestmod=hashname)
42 self.assertEqual(h.hexdigest().upper(), digest.upper())
43 self.assertEqual(h.digest(), binascii.unhexlify(digest))
44 self.assertEqual(h.name, f"hmac-{hashname}")
45 self.assertEqual(h.digest_size, digest_size)
46 self.assertEqual(h.block_size, block_size)
47
48 h = hmac.HMAC(key, digestmod=hashname)
49 h2 = h.copy()
50 h2.update(b"test update")
51 h.update(data)
52 self.assertEqual(h.hexdigest().upper(), digest.upper())
53
54 h = hmac.new(key, data, digestmod=hashname)
55 self.assertEqual(h.hexdigest().upper(), digest.upper())
56 self.assertEqual(h.digest(), binascii.unhexlify(digest))
57 self.assertEqual(h.name, f"hmac-{hashname}")
58 self.assertEqual(h.digest_size, digest_size)
59 self.assertEqual(h.block_size, block_size)
60
61 h = hmac.new(key, None, digestmod=hashname)
62 h.update(data)
63 self.assertEqual(h.hexdigest().upper(), digest.upper())
64
65 h = hmac.new(key, digestmod=hashname)
66 h.update(data)
67 self.assertEqual(h.hexdigest().upper(), digest.upper())
68
69 h = hmac.new(key, data, digestmod=hashfunc)
70 self.assertEqual(h.hexdigest().upper(), digest.upper())
71
72 self.assertEqual(
73 hmac.digest(key, data, digest=hashname),
74 binascii.unhexlify(digest)
75 )
76 self.assertEqual(
77 hmac.digest(key, data, digest=hashfunc),
78 binascii.unhexlify(digest)
79 )
80 with unittest.mock.patch('hmac._openssl_md_meths', {}):
81 self.assertEqual(
82 hmac.digest(key, data, digest=hashname),
83 binascii.unhexlify(digest)
84 )
85 self.assertEqual(
86 hmac.digest(key, data, digest=hashfunc),
87 binascii.unhexlify(digest)
88 )
89
90 if c_hmac_new is not None:
91 h = c_hmac_new(key, data, digestmod=hashname)
92 self.assertEqual(h.hexdigest().upper(), digest.upper())
93 self.assertEqual(h.digest(), binascii.unhexlify(digest))
94 self.assertEqual(h.name, f"hmac-{hashname}")
95 self.assertEqual(h.digest_size, digest_size)
96 self.assertEqual(h.block_size, block_size)
97
98 h = c_hmac_new(key, digestmod=hashname)
99 h2 = h.copy()
100 h2.update(b"test update")
101 h.update(data)
102 self.assertEqual(h.hexdigest().upper(), digest.upper())
103
Hai Shi66abe982020-04-29 09:11:29 +0800104 @hashlib_helper.requires_hashdigest('md5', openssl=True)
Jeremy Hylton893801e2003-05-27 16:16:41 +0000105 def test_md5_vectors(self):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000106 # Test the HMAC module against test vectors from the RFC.
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000107
108 def md5test(key, data, digest):
Christian Heimes54f28982020-05-17 13:49:10 +0200109 self.asssert_hmac(
110 key, data, digest,
111 hashfunc=hashlib.md5,
112 hashname="md5",
113 digest_size=16,
114 block_size=64
Christian Heimes2f050c72018-01-27 09:53:43 +0100115 )
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000116
Guido van Rossum3f429082007-07-10 13:35:52 +0000117 md5test(b"\x0b" * 16,
118 b"Hi There",
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000119 "9294727A3638BB1C13F48EF8158BFC9D")
120
Guido van Rossum3f429082007-07-10 13:35:52 +0000121 md5test(b"Jefe",
122 b"what do ya want for nothing?",
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000123 "750c783e6ab0b503eaa86e310a5db738")
124
Guido van Rossum3f429082007-07-10 13:35:52 +0000125 md5test(b"\xaa" * 16,
126 b"\xdd" * 50,
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000127 "56be34521d144c88dbb8c733f0e8b3f6")
128
Guido van Rossum39478e82007-08-27 17:23:59 +0000129 md5test(bytes(range(1, 26)),
Guido van Rossum3f429082007-07-10 13:35:52 +0000130 b"\xcd" * 50,
Jeremy Hylton893801e2003-05-27 16:16:41 +0000131 "697eaf0aca3a3aea3a75164746ffaa79")
132
Guido van Rossum39478e82007-08-27 17:23:59 +0000133 md5test(b"\x0C" * 16,
134 b"Test With Truncation",
Jeremy Hylton893801e2003-05-27 16:16:41 +0000135 "56461ef2342edc00f9bab995690efd4c")
136
Guido van Rossum3f429082007-07-10 13:35:52 +0000137 md5test(b"\xaa" * 80,
Guido van Rossum39478e82007-08-27 17:23:59 +0000138 b"Test Using Larger Than Block-Size Key - Hash Key First",
Jeremy Hylton893801e2003-05-27 16:16:41 +0000139 "6b1ab7fe4bd7bf8f0b62e6ce61b9d0cd")
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 "
143 b"and Larger Than One Block-Size Data"),
Jeremy Hylton893801e2003-05-27 16:16:41 +0000144 "6f630fad67cda0ee1fb1f562db3aa53e")
145
Hai Shi66abe982020-04-29 09:11:29 +0800146 @hashlib_helper.requires_hashdigest('sha1', openssl=True)
Jeremy Hylton893801e2003-05-27 16:16:41 +0000147 def test_sha_vectors(self):
148 def shatest(key, data, digest):
Christian Heimes54f28982020-05-17 13:49:10 +0200149 self.asssert_hmac(
150 key, data, digest,
151 hashfunc=hashlib.sha1,
152 hashname="sha1",
153 digest_size=20,
154 block_size=64
Christian Heimes2f050c72018-01-27 09:53:43 +0100155 )
156
Guido van Rossum3f429082007-07-10 13:35:52 +0000157 shatest(b"\x0b" * 20,
158 b"Hi There",
Jeremy Hylton893801e2003-05-27 16:16:41 +0000159 "b617318655057264e28bc0b6fb378c8ef146be00")
160
Guido van Rossum3f429082007-07-10 13:35:52 +0000161 shatest(b"Jefe",
162 b"what do ya want for nothing?",
Jeremy Hylton893801e2003-05-27 16:16:41 +0000163 "effcdf6ae5eb2fa2d27416d5f184df9c259a7c79")
164
Guido van Rossum3f429082007-07-10 13:35:52 +0000165 shatest(b"\xAA" * 20,
166 b"\xDD" * 50,
Jeremy Hylton893801e2003-05-27 16:16:41 +0000167 "125d7342b9ac11cd91a39af48aa17b4f63f175d3")
168
Guido van Rossum3f429082007-07-10 13:35:52 +0000169 shatest(bytes(range(1, 26)),
170 b"\xCD" * 50,
Jeremy Hylton893801e2003-05-27 16:16:41 +0000171 "4c9007f4026250c6bc8414f9bf50c86c2d7235da")
172
Guido van Rossum39478e82007-08-27 17:23:59 +0000173 shatest(b"\x0C" * 20,
174 b"Test With Truncation",
Jeremy Hylton893801e2003-05-27 16:16:41 +0000175 "4c1a03424b55e07fe7f27be1d58bb9324a9a5a04")
176
Guido van Rossum3f429082007-07-10 13:35:52 +0000177 shatest(b"\xAA" * 80,
178 b"Test Using Larger Than Block-Size Key - Hash Key First",
Jeremy Hylton893801e2003-05-27 16:16:41 +0000179 "aa4ae5e15272d00e95705637ce8a3b55ed402112")
180
Guido van Rossum3f429082007-07-10 13:35:52 +0000181 shatest(b"\xAA" * 80,
182 (b"Test Using Larger Than Block-Size Key "
183 b"and Larger Than One Block-Size Data"),
Jeremy Hylton893801e2003-05-27 16:16:41 +0000184 "e8e99d0f45237d786d6bbaa7965c7808bbff1a91")
185
Christian Heimesc4ab1102013-11-20 17:35:06 +0100186 def _rfc4231_test_cases(self, hashfunc, hash_name, digest_size, block_size):
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000187 def hmactest(key, data, hexdigests):
Christian Heimes54f28982020-05-17 13:49:10 +0200188 digest = hexdigests[hashfunc]
Christian Heimesc4ab1102013-11-20 17:35:06 +0100189
Christian Heimes54f28982020-05-17 13:49:10 +0200190 self.asssert_hmac(
191 key, data, digest,
192 hashfunc=hashfunc,
193 hashname=hash_name,
194 digest_size=digest_size,
195 block_size=block_size
Christian Heimes2f050c72018-01-27 09:53:43 +0100196 )
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000197
198 # 4.2. Test Case 1
199 hmactest(key = b'\x0b'*20,
200 data = b'Hi There',
201 hexdigests = {
202 hashlib.sha224: '896fb1128abbdf196832107cd49df33f'
203 '47b4b1169912ba4f53684b22',
204 hashlib.sha256: 'b0344c61d8db38535ca8afceaf0bf12b'
205 '881dc200c9833da726e9376c2e32cff7',
206 hashlib.sha384: 'afd03944d84895626b0825f4ab46907f'
207 '15f9dadbe4101ec682aa034c7cebc59c'
208 'faea9ea9076ede7f4af152e8b2fa9cb6',
209 hashlib.sha512: '87aa7cdea5ef619d4ff0b4241a1d6cb0'
210 '2379f4e2ce4ec2787ad0b30545e17cde'
211 'daa833b7d6b8a702038b274eaea3f4e4'
212 'be9d914eeb61f1702e696c203a126854',
213 })
214
215 # 4.3. Test Case 2
216 hmactest(key = b'Jefe',
217 data = b'what do ya want for nothing?',
218 hexdigests = {
219 hashlib.sha224: 'a30e01098bc6dbbf45690f3a7e9e6d0f'
220 '8bbea2a39e6148008fd05e44',
221 hashlib.sha256: '5bdcc146bf60754e6a042426089575c7'
222 '5a003f089d2739839dec58b964ec3843',
223 hashlib.sha384: 'af45d2e376484031617f78d2b58a6b1b'
224 '9c7ef464f5a01b47e42ec3736322445e'
225 '8e2240ca5e69e2c78b3239ecfab21649',
226 hashlib.sha512: '164b7a7bfcf819e2e395fbe73b56e0a3'
227 '87bd64222e831fd610270cd7ea250554'
228 '9758bf75c05a994a6d034f65f8f0e6fd'
229 'caeab1a34d4a6b4b636e070a38bce737',
230 })
231
232 # 4.4. Test Case 3
233 hmactest(key = b'\xaa'*20,
234 data = b'\xdd'*50,
235 hexdigests = {
236 hashlib.sha224: '7fb3cb3588c6c1f6ffa9694d7d6ad264'
237 '9365b0c1f65d69d1ec8333ea',
238 hashlib.sha256: '773ea91e36800e46854db8ebd09181a7'
239 '2959098b3ef8c122d9635514ced565fe',
240 hashlib.sha384: '88062608d3e6ad8a0aa2ace014c8a86f'
241 '0aa635d947ac9febe83ef4e55966144b'
242 '2a5ab39dc13814b94e3ab6e101a34f27',
243 hashlib.sha512: 'fa73b0089d56a284efb0f0756c890be9'
244 'b1b5dbdd8ee81a3655f83e33b2279d39'
245 'bf3e848279a722c806b485a47e67c807'
246 'b946a337bee8942674278859e13292fb',
247 })
248
249 # 4.5. Test Case 4
250 hmactest(key = bytes(x for x in range(0x01, 0x19+1)),
251 data = b'\xcd'*50,
252 hexdigests = {
253 hashlib.sha224: '6c11506874013cac6a2abc1bb382627c'
254 'ec6a90d86efc012de7afec5a',
255 hashlib.sha256: '82558a389a443c0ea4cc819899f2083a'
256 '85f0faa3e578f8077a2e3ff46729665b',
257 hashlib.sha384: '3e8a69b7783c25851933ab6290af6ca7'
258 '7a9981480850009cc5577c6e1f573b4e'
259 '6801dd23c4a7d679ccf8a386c674cffb',
260 hashlib.sha512: 'b0ba465637458c6990e5a8c5f61d4af7'
261 'e576d97ff94b872de76f8050361ee3db'
262 'a91ca5c11aa25eb4d679275cc5788063'
263 'a5f19741120c4f2de2adebeb10a298dd',
264 })
265
266 # 4.7. Test Case 6
267 hmactest(key = b'\xaa'*131,
268 data = b'Test Using Larger Than Block-Siz'
269 b'e Key - Hash Key First',
270 hexdigests = {
271 hashlib.sha224: '95e9a0db962095adaebe9b2d6f0dbce2'
272 'd499f112f2d2b7273fa6870e',
273 hashlib.sha256: '60e431591ee0b67f0d8a26aacbf5b77f'
274 '8e0bc6213728c5140546040f0ee37f54',
275 hashlib.sha384: '4ece084485813e9088d2c63a041bc5b4'
276 '4f9ef1012a2b588f3cd11f05033ac4c6'
277 '0c2ef6ab4030fe8296248df163f44952',
278 hashlib.sha512: '80b24263c7c1a3ebb71493c1dd7be8b4'
279 '9b46d1f41b4aeec1121b013783f8f352'
280 '6b56d037e05f2598bd0fd2215d6a1e52'
281 '95e64f73f63f0aec8b915a985d786598',
282 })
283
284 # 4.8. Test Case 7
285 hmactest(key = b'\xaa'*131,
286 data = b'This is a test using a larger th'
287 b'an block-size key and a larger t'
288 b'han block-size data. The key nee'
289 b'ds to be hashed before being use'
290 b'd by the HMAC algorithm.',
291 hexdigests = {
292 hashlib.sha224: '3a854166ac5d9f023f54d517d0b39dbd'
293 '946770db9c2b95c9f6f565d1',
294 hashlib.sha256: '9b09ffa71b942fcb27635fbcd5b0e944'
295 'bfdc63644f0713938a7f51535c3a35e2',
296 hashlib.sha384: '6617178e941f020d351e2f254e8fd32c'
297 '602420feb0b8fb9adccebb82461e99c5'
298 'a678cc31e799176d3860e6110c46523e',
299 hashlib.sha512: 'e37b6a775dc87dbaa4dfa9f96e5e3ffd'
300 'debd71f8867289865df5a32d20cdc944'
301 'b6022cac3c4982b10d5eeb55c3e4de15'
302 '134676fb6de0446065c97440fa8c6a58',
303 })
304
Hai Shi66abe982020-04-29 09:11:29 +0800305 @hashlib_helper.requires_hashdigest('sha224', openssl=True)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000306 def test_sha224_rfc4231(self):
Christian Heimesc4ab1102013-11-20 17:35:06 +0100307 self._rfc4231_test_cases(hashlib.sha224, 'sha224', 28, 64)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000308
Hai Shi66abe982020-04-29 09:11:29 +0800309 @hashlib_helper.requires_hashdigest('sha256', openssl=True)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000310 def test_sha256_rfc4231(self):
Christian Heimesc4ab1102013-11-20 17:35:06 +0100311 self._rfc4231_test_cases(hashlib.sha256, 'sha256', 32, 64)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000312
Hai Shi66abe982020-04-29 09:11:29 +0800313 @hashlib_helper.requires_hashdigest('sha384', openssl=True)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000314 def test_sha384_rfc4231(self):
Christian Heimesc4ab1102013-11-20 17:35:06 +0100315 self._rfc4231_test_cases(hashlib.sha384, 'sha384', 48, 128)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000316
Hai Shi66abe982020-04-29 09:11:29 +0800317 @hashlib_helper.requires_hashdigest('sha512', openssl=True)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000318 def test_sha512_rfc4231(self):
Christian Heimesc4ab1102013-11-20 17:35:06 +0100319 self._rfc4231_test_cases(hashlib.sha512, 'sha512', 64, 128)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000320
Hai Shi66abe982020-04-29 09:11:29 +0800321 @hashlib_helper.requires_hashdigest('sha256')
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000322 def test_legacy_block_size_warnings(self):
323 class MockCrazyHash(object):
324 """Ain't no block_size attribute here."""
325 def __init__(self, *args):
Christian Heimesc64a1a62019-09-25 16:30:20 +0200326 self._x = hashlib.sha256(*args)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000327 self.digest_size = self._x.digest_size
328 def update(self, v):
329 self._x.update(v)
330 def digest(self):
331 return self._x.digest()
332
Brett Cannon1cd02472008-09-09 01:52:27 +0000333 with warnings.catch_warnings():
Christian Heimese25f35e2008-03-20 10:49:03 +0000334 warnings.simplefilter('error', RuntimeWarning)
Florent Xicluna41fe6152010-04-02 18:52:12 +0000335 with self.assertRaises(RuntimeWarning):
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000336 hmac.HMAC(b'a', b'b', digestmod=MockCrazyHash)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000337 self.fail('Expected warning about missing block_size')
338
339 MockCrazyHash.block_size = 1
Florent Xicluna41fe6152010-04-02 18:52:12 +0000340 with self.assertRaises(RuntimeWarning):
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000341 hmac.HMAC(b'a', b'b', digestmod=MockCrazyHash)
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000342 self.fail('Expected warning about small block_size')
Guido van Rossuma19f80c2007-11-06 20:51:31 +0000343
Matthias Bussonnier51a47432018-09-10 20:10:01 +0200344 def test_with_digestmod_no_default(self):
Gregory P. Smithf33c57d52019-10-17 20:30:42 -0700345 """The digestmod parameter is required as of Python 3.8."""
346 with self.assertRaisesRegex(TypeError, r'required.*digestmod'):
Christian Heimes634919a2013-11-20 17:23:06 +0100347 key = b"\x0b" * 16
348 data = b"Hi There"
Matthias Bussonnier51a47432018-09-10 20:10:01 +0200349 hmac.HMAC(key, data, digestmod=None)
Gregory P. Smithf33c57d52019-10-17 20:30:42 -0700350 with self.assertRaisesRegex(TypeError, r'required.*digestmod'):
351 hmac.new(key, data)
352 with self.assertRaisesRegex(TypeError, r'required.*digestmod'):
353 hmac.HMAC(key, msg=data, digestmod='')
Jeremy Hylton893801e2003-05-27 16:16:41 +0000354
Christian Heimesc64a1a62019-09-25 16:30:20 +0200355
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000356class ConstructorTestCase(unittest.TestCase):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000357
Christian Heimesc64a1a62019-09-25 16:30:20 +0200358 expected = (
359 "6c845b47f52b3b47f6590c502db7825aad757bf4fadc8fa972f7cd2e76a5bdeb"
360 )
361
Hai Shi66abe982020-04-29 09:11:29 +0800362 @hashlib_helper.requires_hashdigest('sha256')
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000363 def test_normal(self):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000364 # Standard constructor call.
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000365 try:
Christian Heimesc64a1a62019-09-25 16:30:20 +0200366 hmac.HMAC(b"key", digestmod='sha256')
Christian Heimes217f5c42013-11-24 23:14:16 +0100367 except Exception:
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000368 self.fail("Standard constructor call raised exception.")
369
Hai Shi66abe982020-04-29 09:11:29 +0800370 @hashlib_helper.requires_hashdigest('sha256')
Antoine Pitrou24ef3e92012-06-30 17:27:56 +0200371 def test_with_str_key(self):
372 # Pass a key of type str, which is an error, because it expects a key
373 # of type bytes
374 with self.assertRaises(TypeError):
Christian Heimesc64a1a62019-09-25 16:30:20 +0200375 h = hmac.HMAC("key", digestmod='sha256')
Antoine Pitrou24ef3e92012-06-30 17:27:56 +0200376
Hai Shi66abe982020-04-29 09:11:29 +0800377 @hashlib_helper.requires_hashdigest('sha256')
Antoine Pitrou24ef3e92012-06-30 17:27:56 +0200378 def test_dot_new_with_str_key(self):
379 # Pass a key of type str, which is an error, because it expects a key
380 # of type bytes
381 with self.assertRaises(TypeError):
Christian Heimesc64a1a62019-09-25 16:30:20 +0200382 h = hmac.new("key", digestmod='sha256')
Antoine Pitrou24ef3e92012-06-30 17:27:56 +0200383
Hai Shi66abe982020-04-29 09:11:29 +0800384 @hashlib_helper.requires_hashdigest('sha256')
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000385 def test_withtext(self):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000386 # Constructor call with text.
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000387 try:
Christian Heimesc64a1a62019-09-25 16:30:20 +0200388 h = hmac.HMAC(b"key", b"hash this!", digestmod='sha256')
Christian Heimes217f5c42013-11-24 23:14:16 +0100389 except Exception:
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000390 self.fail("Constructor call with text argument raised exception.")
Christian Heimesc64a1a62019-09-25 16:30:20 +0200391 self.assertEqual(h.hexdigest(), self.expected)
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000392
Hai Shi66abe982020-04-29 09:11:29 +0800393 @hashlib_helper.requires_hashdigest('sha256')
Christian Heimes04926ae2013-07-01 13:08:42 +0200394 def test_with_bytearray(self):
395 try:
Christian Heimes217f5c42013-11-24 23:14:16 +0100396 h = hmac.HMAC(bytearray(b"key"), bytearray(b"hash this!"),
Christian Heimesc64a1a62019-09-25 16:30:20 +0200397 digestmod="sha256")
Christian Heimes217f5c42013-11-24 23:14:16 +0100398 except Exception:
Christian Heimes04926ae2013-07-01 13:08:42 +0200399 self.fail("Constructor call with bytearray arguments raised exception.")
stratakis89433182019-12-03 16:35:54 +0100400 self.assertEqual(h.hexdigest(), self.expected)
Christian Heimes04926ae2013-07-01 13:08:42 +0200401
Hai Shi66abe982020-04-29 09:11:29 +0800402 @hashlib_helper.requires_hashdigest('sha256')
Christian Heimes04926ae2013-07-01 13:08:42 +0200403 def test_with_memoryview_msg(self):
404 try:
Christian Heimesc64a1a62019-09-25 16:30:20 +0200405 h = hmac.HMAC(b"key", memoryview(b"hash this!"), digestmod="sha256")
Christian Heimes217f5c42013-11-24 23:14:16 +0100406 except Exception:
Christian Heimes04926ae2013-07-01 13:08:42 +0200407 self.fail("Constructor call with memoryview msg raised exception.")
stratakis89433182019-12-03 16:35:54 +0100408 self.assertEqual(h.hexdigest(), self.expected)
Christian Heimes04926ae2013-07-01 13:08:42 +0200409
Hai Shi66abe982020-04-29 09:11:29 +0800410 @hashlib_helper.requires_hashdigest('sha256')
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000411 def test_withmodule(self):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000412 # Constructor call with text and digest module.
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000413 try:
Christian Heimesc64a1a62019-09-25 16:30:20 +0200414 h = hmac.HMAC(b"key", b"", hashlib.sha256)
Christian Heimes217f5c42013-11-24 23:14:16 +0100415 except Exception:
Christian Heimesc64a1a62019-09-25 16:30:20 +0200416 self.fail("Constructor call with hashlib.sha256 raised exception.")
417
Christian Heimes54f28982020-05-17 13:49:10 +0200418 @unittest.skipUnless(C_HMAC is not None, 'need _hashlib')
419 def test_internal_types(self):
420 # internal types like _hashlib.C_HMAC are not constructable
421 with self.assertRaisesRegex(
422 TypeError, "cannot create 'HMAC' instance"
423 ):
424 C_HMAC()
425
Tim Peters88768482001-11-13 21:51:26 +0000426
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000427class SanityTestCase(unittest.TestCase):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000428
Hai Shi66abe982020-04-29 09:11:29 +0800429 @hashlib_helper.requires_hashdigest('sha256')
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000430 def test_exercise_all_methods(self):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000431 # Exercising all methods once.
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000432 # This must not raise any exceptions
433 try:
Christian Heimesc64a1a62019-09-25 16:30:20 +0200434 h = hmac.HMAC(b"my secret key", digestmod="sha256")
Guido van Rossum39478e82007-08-27 17:23:59 +0000435 h.update(b"compute the hash of this text!")
Christian Heimes54f28982020-05-17 13:49:10 +0200436 h.digest()
437 h.hexdigest()
438 h.copy()
Christian Heimes217f5c42013-11-24 23:14:16 +0100439 except Exception:
Neal Norwitz28bb5722002-04-01 19:00:50 +0000440 self.fail("Exception raised during normal usage of HMAC class.")
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000441
Christian Heimesc64a1a62019-09-25 16:30:20 +0200442
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000443class CopyTestCase(unittest.TestCase):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000444
Hai Shi66abe982020-04-29 09:11:29 +0800445 @hashlib_helper.requires_hashdigest('sha256')
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000446 def test_attributes(self):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000447 # Testing if attributes are of same type.
Christian Heimesc64a1a62019-09-25 16:30:20 +0200448 h1 = hmac.HMAC(b"key", digestmod="sha256")
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000449 h2 = h1.copy()
Christian Heimes837f9e42020-05-17 01:05:40 +0200450 self.assertTrue(h1._digest_cons == h2._digest_cons,
Gregory P. Smithf21a5f72005-08-21 18:45:59 +0000451 "digest constructors don't match.")
Christian Heimes837f9e42020-05-17 01:05:40 +0200452 self.assertEqual(type(h1._inner), type(h2._inner),
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000453 "Types of inner don't match.")
Christian Heimes837f9e42020-05-17 01:05:40 +0200454 self.assertEqual(type(h1._outer), type(h2._outer),
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000455 "Types of outer don't match.")
456
Hai Shi66abe982020-04-29 09:11:29 +0800457 @hashlib_helper.requires_hashdigest('sha256')
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000458 def test_realcopy(self):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000459 # Testing if the copy method created a real copy.
Christian Heimesc64a1a62019-09-25 16:30:20 +0200460 h1 = hmac.HMAC(b"key", digestmod="sha256")
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000461 h2 = h1.copy()
Mark Dickinsona56c4672009-01-27 18:17:45 +0000462 # Using id() in case somebody has overridden __eq__/__ne__.
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000463 self.assertTrue(id(h1) != id(h2), "No real copy of the HMAC instance.")
Christian Heimes837f9e42020-05-17 01:05:40 +0200464 self.assertTrue(id(h1._inner) != id(h2._inner),
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000465 "No real copy of the attribute 'inner'.")
Christian Heimes837f9e42020-05-17 01:05:40 +0200466 self.assertTrue(id(h1._outer) != id(h2._outer),
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000467 "No real copy of the attribute 'outer'.")
Christian Heimes837f9e42020-05-17 01:05:40 +0200468 self.assertEqual(h1._inner, h1.inner)
469 self.assertEqual(h1._outer, h1.outer)
470 self.assertEqual(h1._digest_cons, h1.digest_cons)
471
472 @hashlib_helper.requires_hashdigest('sha256')
473 def test_properties(self):
474 # deprecated properties
475 h1 = hmac.HMAC(b"key", digestmod="sha256")
476 self.assertEqual(h1._inner, h1.inner)
477 self.assertEqual(h1._outer, h1.outer)
478 self.assertEqual(h1._digest_cons, h1.digest_cons)
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000479
Hai Shi66abe982020-04-29 09:11:29 +0800480 @hashlib_helper.requires_hashdigest('sha256')
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000481 def test_equality(self):
Guido van Rossum7e8fdba2002-08-22 19:38:14 +0000482 # Testing if the copy has the same digests.
Christian Heimesc64a1a62019-09-25 16:30:20 +0200483 h1 = hmac.HMAC(b"key", digestmod="sha256")
Guido van Rossum39478e82007-08-27 17:23:59 +0000484 h1.update(b"some random text")
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000485 h2 = h1.copy()
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000486 self.assertEqual(h1.digest(), h2.digest(),
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000487 "Digest of copy doesn't match original digest.")
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000488 self.assertEqual(h1.hexdigest(), h2.hexdigest(),
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000489 "Hexdigest of copy doesn't match original hexdigest.")
490
Christian Heimes54f28982020-05-17 13:49:10 +0200491 @hashlib_helper.requires_hashdigest('sha256')
492 def test_equality_new(self):
493 # Testing if the copy has the same digests with hmac.new().
494 h1 = hmac.new(b"key", digestmod="sha256")
495 h1.update(b"some random text")
496 h2 = h1.copy()
497 self.assertTrue(
498 id(h1) != id(h2), "No real copy of the HMAC instance."
499 )
500 self.assertEqual(h1.digest(), h2.digest(),
501 "Digest of copy doesn't match original digest.")
502 self.assertEqual(h1.hexdigest(), h2.hexdigest(),
503 "Hexdigest of copy doesn't match original hexdigest.")
504
505
Nick Coghlan807770e2012-06-15 21:14:08 +1000506class CompareDigestTestCase(unittest.TestCase):
Charles-François Natali7feb9f42012-05-13 19:53:07 +0200507
Christian Heimes6cea6552012-06-24 13:48:32 +0200508 def test_compare_digest(self):
Charles-François Natali7feb9f42012-05-13 19:53:07 +0200509 # Testing input type exception handling
510 a, b = 100, 200
Nick Coghlan807770e2012-06-15 21:14:08 +1000511 self.assertRaises(TypeError, hmac.compare_digest, a, b)
512 a, b = 100, b"foobar"
513 self.assertRaises(TypeError, hmac.compare_digest, a, b)
514 a, b = b"foobar", 200
515 self.assertRaises(TypeError, hmac.compare_digest, a, b)
Charles-François Natali7feb9f42012-05-13 19:53:07 +0200516 a, b = "foobar", b"foobar"
Nick Coghlan807770e2012-06-15 21:14:08 +1000517 self.assertRaises(TypeError, hmac.compare_digest, a, b)
518 a, b = b"foobar", "foobar"
519 self.assertRaises(TypeError, hmac.compare_digest, a, b)
Nick Coghlan807770e2012-06-15 21:14:08 +1000520
521 # Testing bytes of different lengths
522 a, b = b"foobar", b"foo"
523 self.assertFalse(hmac.compare_digest(a, b))
524 a, b = b"\xde\xad\xbe\xef", b"\xde\xad"
525 self.assertFalse(hmac.compare_digest(a, b))
526
527 # Testing bytes of same lengths, different values
528 a, b = b"foobar", b"foobaz"
529 self.assertFalse(hmac.compare_digest(a, b))
530 a, b = b"\xde\xad\xbe\xef", b"\xab\xad\x1d\xea"
531 self.assertFalse(hmac.compare_digest(a, b))
532
533 # Testing bytes of same lengths, same values
Charles-François Natali7feb9f42012-05-13 19:53:07 +0200534 a, b = b"foobar", b"foobar"
Nick Coghlan807770e2012-06-15 21:14:08 +1000535 self.assertTrue(hmac.compare_digest(a, b))
Charles-François Natali7feb9f42012-05-13 19:53:07 +0200536 a, b = b"\xde\xad\xbe\xef", b"\xde\xad\xbe\xef"
Nick Coghlan807770e2012-06-15 21:14:08 +1000537 self.assertTrue(hmac.compare_digest(a, b))
Charles-François Natali7feb9f42012-05-13 19:53:07 +0200538
Christian Heimes6cea6552012-06-24 13:48:32 +0200539 # Testing bytearrays of same lengths, same values
540 a, b = bytearray(b"foobar"), bytearray(b"foobar")
541 self.assertTrue(hmac.compare_digest(a, b))
542
Min ho Kim39d87b52019-08-31 06:21:19 +1000543 # Testing bytearrays of different lengths
Christian Heimes6cea6552012-06-24 13:48:32 +0200544 a, b = bytearray(b"foobar"), bytearray(b"foo")
545 self.assertFalse(hmac.compare_digest(a, b))
546
547 # Testing bytearrays of same lengths, different values
548 a, b = bytearray(b"foobar"), bytearray(b"foobaz")
549 self.assertFalse(hmac.compare_digest(a, b))
550
551 # Testing byte and bytearray of same lengths, same values
552 a, b = bytearray(b"foobar"), b"foobar"
553 self.assertTrue(hmac.compare_digest(a, b))
554 self.assertTrue(hmac.compare_digest(b, a))
555
Min ho Kim39d87b52019-08-31 06:21:19 +1000556 # Testing byte bytearray of different lengths
Christian Heimes6cea6552012-06-24 13:48:32 +0200557 a, b = bytearray(b"foobar"), b"foo"
558 self.assertFalse(hmac.compare_digest(a, b))
559 self.assertFalse(hmac.compare_digest(b, a))
560
561 # Testing byte and bytearray of same lengths, different values
562 a, b = bytearray(b"foobar"), b"foobaz"
563 self.assertFalse(hmac.compare_digest(a, b))
564 self.assertFalse(hmac.compare_digest(b, a))
565
566 # Testing str of same lengths
567 a, b = "foobar", "foobar"
568 self.assertTrue(hmac.compare_digest(a, b))
569
Min ho Kim39d87b52019-08-31 06:21:19 +1000570 # Testing str of different lengths
Christian Heimes6cea6552012-06-24 13:48:32 +0200571 a, b = "foo", "foobar"
572 self.assertFalse(hmac.compare_digest(a, b))
573
574 # Testing bytes of same lengths, different values
575 a, b = "foobar", "foobaz"
576 self.assertFalse(hmac.compare_digest(a, b))
577
578 # Testing error cases
579 a, b = "foobar", b"foobar"
580 self.assertRaises(TypeError, hmac.compare_digest, a, b)
581 a, b = b"foobar", "foobar"
582 self.assertRaises(TypeError, hmac.compare_digest, a, b)
583 a, b = b"foobar", 1
584 self.assertRaises(TypeError, hmac.compare_digest, a, b)
585 a, b = 100, 200
586 self.assertRaises(TypeError, hmac.compare_digest, a, b)
587 a, b = "fooä", "fooä"
588 self.assertRaises(TypeError, hmac.compare_digest, a, b)
589
590 # subclasses are supported by ignore __eq__
591 class mystr(str):
592 def __eq__(self, other):
593 return False
594
595 a, b = mystr("foobar"), mystr("foobar")
596 self.assertTrue(hmac.compare_digest(a, b))
597 a, b = mystr("foobar"), "foobar"
598 self.assertTrue(hmac.compare_digest(a, b))
599 a, b = mystr("foobar"), mystr("foobaz")
600 self.assertFalse(hmac.compare_digest(a, b))
601
602 class mybytes(bytes):
603 def __eq__(self, other):
604 return False
605
606 a, b = mybytes(b"foobar"), mybytes(b"foobar")
607 self.assertTrue(hmac.compare_digest(a, b))
608 a, b = mybytes(b"foobar"), b"foobar"
609 self.assertTrue(hmac.compare_digest(a, b))
610 a, b = mybytes(b"foobar"), mybytes(b"foobaz")
611 self.assertFalse(hmac.compare_digest(a, b))
612
613
Andrew M. Kuchlingf792bba2001-11-02 21:49:59 +0000614if __name__ == "__main__":
Zachary Ware38c707e2015-04-13 15:00:43 -0500615 unittest.main()