1import hmac
2import hashlib
3import unittest
4import warnings
5from test import test_support
6
7class TestVectorsTestCase(unittest.TestCase):
8
9    def test_md5_vectors(self):
10        # Test the HMAC module against test vectors from the RFC.
11
12        def md5test(key, data, digest):
13            h = hmac.HMAC(key, data)
14            self.assertEqual(h.hexdigest().upper(), digest.upper())
15
16        md5test(chr(0x0b) * 16,
17                "Hi There",
18                "9294727A3638BB1C13F48EF8158BFC9D")
19
20        md5test("Jefe",
21                "what do ya want for nothing?",
22                "750c783e6ab0b503eaa86e310a5db738")
23
24        md5test(chr(0xAA)*16,
25                chr(0xDD)*50,
26                "56be34521d144c88dbb8c733f0e8b3f6")
27
28        md5test("".join([chr(i) for i in range(1, 26)]),
29                chr(0xCD) * 50,
30                "697eaf0aca3a3aea3a75164746ffaa79")
31
32        md5test(chr(0x0C) * 16,
33                "Test With Truncation",
34                "56461ef2342edc00f9bab995690efd4c")
35
36        md5test(chr(0xAA) * 80,
37                "Test Using Larger Than Block-Size Key - Hash Key First",
38                "6b1ab7fe4bd7bf8f0b62e6ce61b9d0cd")
39
40        md5test(chr(0xAA) * 80,
41                ("Test Using Larger Than Block-Size Key "
42                 "and Larger Than One Block-Size Data"),
43                "6f630fad67cda0ee1fb1f562db3aa53e")
44
45    def test_sha_vectors(self):
46        def shatest(key, data, digest):
47            h = hmac.HMAC(key, data, digestmod=hashlib.sha1)
48            self.assertEqual(h.hexdigest().upper(), digest.upper())
49
50        shatest(chr(0x0b) * 20,
51                "Hi There",
52                "b617318655057264e28bc0b6fb378c8ef146be00")
53
54        shatest("Jefe",
55                "what do ya want for nothing?",
56                "effcdf6ae5eb2fa2d27416d5f184df9c259a7c79")
57
58        shatest(chr(0xAA)*20,
59                chr(0xDD)*50,
60                "125d7342b9ac11cd91a39af48aa17b4f63f175d3")
61
62        shatest("".join([chr(i) for i in range(1, 26)]),
63                chr(0xCD) * 50,
64                "4c9007f4026250c6bc8414f9bf50c86c2d7235da")
65
66        shatest(chr(0x0C) * 20,
67                "Test With Truncation",
68                "4c1a03424b55e07fe7f27be1d58bb9324a9a5a04")
69
70        shatest(chr(0xAA) * 80,
71                "Test Using Larger Than Block-Size Key - Hash Key First",
72                "aa4ae5e15272d00e95705637ce8a3b55ed402112")
73
74        shatest(chr(0xAA) * 80,
75                ("Test Using Larger Than Block-Size Key "
76                 "and Larger Than One Block-Size Data"),
77                "e8e99d0f45237d786d6bbaa7965c7808bbff1a91")
78
79    def _rfc4231_test_cases(self, hashfunc):
80        def hmactest(key, data, hexdigests):
81            h = hmac.HMAC(key, data, digestmod=hashfunc)
82            self.assertEqual(h.hexdigest().lower(), hexdigests[hashfunc])
83
84        # 4.2.  Test Case 1
85        hmactest(key = '\x0b'*20,
86                 data = 'Hi There',
87                 hexdigests = {
88                   hashlib.sha224: '896fb1128abbdf196832107cd49df33f'
89                                   '47b4b1169912ba4f53684b22',
90                   hashlib.sha256: 'b0344c61d8db38535ca8afceaf0bf12b'
91                                   '881dc200c9833da726e9376c2e32cff7',
92                   hashlib.sha384: 'afd03944d84895626b0825f4ab46907f'
93                                   '15f9dadbe4101ec682aa034c7cebc59c'
94                                   'faea9ea9076ede7f4af152e8b2fa9cb6',
95                   hashlib.sha512: '87aa7cdea5ef619d4ff0b4241a1d6cb0'
96                                   '2379f4e2ce4ec2787ad0b30545e17cde'
97                                   'daa833b7d6b8a702038b274eaea3f4e4'
98                                   'be9d914eeb61f1702e696c203a126854',
99                 })
100
101        # 4.3.  Test Case 2
102        hmactest(key = 'Jefe',
103                 data = 'what do ya want for nothing?',
104                 hexdigests = {
105                   hashlib.sha224: 'a30e01098bc6dbbf45690f3a7e9e6d0f'
106                                   '8bbea2a39e6148008fd05e44',
107                   hashlib.sha256: '5bdcc146bf60754e6a042426089575c7'
108                                   '5a003f089d2739839dec58b964ec3843',
109                   hashlib.sha384: 'af45d2e376484031617f78d2b58a6b1b'
110                                   '9c7ef464f5a01b47e42ec3736322445e'
111                                   '8e2240ca5e69e2c78b3239ecfab21649',
112                   hashlib.sha512: '164b7a7bfcf819e2e395fbe73b56e0a3'
113                                   '87bd64222e831fd610270cd7ea250554'
114                                   '9758bf75c05a994a6d034f65f8f0e6fd'
115                                   'caeab1a34d4a6b4b636e070a38bce737',
116                 })
117
118        # 4.4.  Test Case 3
119        hmactest(key = '\xaa'*20,
120                 data = '\xdd'*50,
121                 hexdigests = {
122                   hashlib.sha224: '7fb3cb3588c6c1f6ffa9694d7d6ad264'
123                                   '9365b0c1f65d69d1ec8333ea',
124                   hashlib.sha256: '773ea91e36800e46854db8ebd09181a7'
125                                   '2959098b3ef8c122d9635514ced565fe',
126                   hashlib.sha384: '88062608d3e6ad8a0aa2ace014c8a86f'
127                                   '0aa635d947ac9febe83ef4e55966144b'
128                                   '2a5ab39dc13814b94e3ab6e101a34f27',
129                   hashlib.sha512: 'fa73b0089d56a284efb0f0756c890be9'
130                                   'b1b5dbdd8ee81a3655f83e33b2279d39'
131                                   'bf3e848279a722c806b485a47e67c807'
132                                   'b946a337bee8942674278859e13292fb',
133                 })
134
135        # 4.5.  Test Case 4
136        hmactest(key = ''.join([chr(x) for x in xrange(0x01, 0x19+1)]),
137                 data = '\xcd'*50,
138                 hexdigests = {
139                   hashlib.sha224: '6c11506874013cac6a2abc1bb382627c'
140                                   'ec6a90d86efc012de7afec5a',
141                   hashlib.sha256: '82558a389a443c0ea4cc819899f2083a'
142                                   '85f0faa3e578f8077a2e3ff46729665b',
143                   hashlib.sha384: '3e8a69b7783c25851933ab6290af6ca7'
144                                   '7a9981480850009cc5577c6e1f573b4e'
145                                   '6801dd23c4a7d679ccf8a386c674cffb',
146                   hashlib.sha512: 'b0ba465637458c6990e5a8c5f61d4af7'
147                                   'e576d97ff94b872de76f8050361ee3db'
148                                   'a91ca5c11aa25eb4d679275cc5788063'
149                                   'a5f19741120c4f2de2adebeb10a298dd',
150                 })
151
152        # 4.7.  Test Case 6
153        hmactest(key = '\xaa'*131,
154                 data = 'Test Using Larger Than Block-Siz'
155                        'e Key - Hash Key First',
156                 hexdigests = {
157                   hashlib.sha224: '95e9a0db962095adaebe9b2d6f0dbce2'
158                                   'd499f112f2d2b7273fa6870e',
159                   hashlib.sha256: '60e431591ee0b67f0d8a26aacbf5b77f'
160                                   '8e0bc6213728c5140546040f0ee37f54',
161                   hashlib.sha384: '4ece084485813e9088d2c63a041bc5b4'
162                                   '4f9ef1012a2b588f3cd11f05033ac4c6'
163                                   '0c2ef6ab4030fe8296248df163f44952',
164                   hashlib.sha512: '80b24263c7c1a3ebb71493c1dd7be8b4'
165                                   '9b46d1f41b4aeec1121b013783f8f352'
166                                   '6b56d037e05f2598bd0fd2215d6a1e52'
167                                   '95e64f73f63f0aec8b915a985d786598',
168                 })
169
170        # 4.8.  Test Case 7
171        hmactest(key = '\xaa'*131,
172                 data = 'This is a test using a larger th'
173                        'an block-size key and a larger t'
174                        'han block-size data. The key nee'
175                        'ds to be hashed before being use'
176                        'd by the HMAC algorithm.',
177                 hexdigests = {
178                   hashlib.sha224: '3a854166ac5d9f023f54d517d0b39dbd'
179                                   '946770db9c2b95c9f6f565d1',
180                   hashlib.sha256: '9b09ffa71b942fcb27635fbcd5b0e944'
181                                   'bfdc63644f0713938a7f51535c3a35e2',
182                   hashlib.sha384: '6617178e941f020d351e2f254e8fd32c'
183                                   '602420feb0b8fb9adccebb82461e99c5'
184                                   'a678cc31e799176d3860e6110c46523e',
185                   hashlib.sha512: 'e37b6a775dc87dbaa4dfa9f96e5e3ffd'
186                                   'debd71f8867289865df5a32d20cdc944'
187                                   'b6022cac3c4982b10d5eeb55c3e4de15'
188                                   '134676fb6de0446065c97440fa8c6a58',
189                 })
190
191    def test_sha224_rfc4231(self):
192        self._rfc4231_test_cases(hashlib.sha224)
193
194    def test_sha256_rfc4231(self):
195        self._rfc4231_test_cases(hashlib.sha256)
196
197    def test_sha384_rfc4231(self):
198        self._rfc4231_test_cases(hashlib.sha384)
199
200    def test_sha512_rfc4231(self):
201        self._rfc4231_test_cases(hashlib.sha512)
202
203    def test_legacy_block_size_warnings(self):
204        class MockCrazyHash(object):
205            """Ain't no block_size attribute here."""
206            def __init__(self, *args):
207                self._x = hashlib.sha1(*args)
208                self.digest_size = self._x.digest_size
209            def update(self, v):
210                self._x.update(v)
211            def digest(self):
212                return self._x.digest()
213
214        with warnings.catch_warnings():
215            warnings.simplefilter('error', RuntimeWarning)
216            with self.assertRaises(RuntimeWarning):
217                hmac.HMAC('a', 'b', digestmod=MockCrazyHash)
218                self.fail('Expected warning about missing block_size')
219
220            MockCrazyHash.block_size = 1
221            with self.assertRaises(RuntimeWarning):
222                hmac.HMAC('a', 'b', digestmod=MockCrazyHash)
223                self.fail('Expected warning about small block_size')
224
225
226
227class ConstructorTestCase(unittest.TestCase):
228
229    def test_normal(self):
230        # Standard constructor call.
231        failed = 0
232        try:
233            h = hmac.HMAC("key")
234        except:
235            self.fail("Standard constructor call raised exception.")
236
237    def test_withtext(self):
238        # Constructor call with text.
239        try:
240            h = hmac.HMAC("key", "hash this!")
241        except:
242            self.fail("Constructor call with text argument raised exception.")
243
244    def test_withmodule(self):
245        # Constructor call with text and digest module.
246        try:
247            h = hmac.HMAC("key", "", hashlib.sha1)
248        except:
249            self.fail("Constructor call with hashlib.sha1 raised exception.")
250
251class SanityTestCase(unittest.TestCase):
252
253    def test_default_is_md5(self):
254        # Testing if HMAC defaults to MD5 algorithm.
255        # NOTE: this whitebox test depends on the hmac class internals
256        h = hmac.HMAC("key")
257        self.assertTrue(h.digest_cons == hashlib.md5)
258
259    def test_exercise_all_methods(self):
260        # Exercising all methods once.
261        # This must not raise any exceptions
262        try:
263            h = hmac.HMAC("my secret key")
264            h.update("compute the hash of this text!")
265            dig = h.digest()
266            dig = h.hexdigest()
267            h2 = h.copy()
268        except:
269            self.fail("Exception raised during normal usage of HMAC class.")
270
271class CopyTestCase(unittest.TestCase):
272
273    def test_attributes(self):
274        # Testing if attributes are of same type.
275        h1 = hmac.HMAC("key")
276        h2 = h1.copy()
277        self.assertTrue(h1.digest_cons == h2.digest_cons,
278            "digest constructors don't match.")
279        self.assertTrue(type(h1.inner) == type(h2.inner),
280            "Types of inner don't match.")
281        self.assertTrue(type(h1.outer) == type(h2.outer),
282            "Types of outer don't match.")
283
284    def test_realcopy(self):
285        # Testing if the copy method created a real copy.
286        h1 = hmac.HMAC("key")
287        h2 = h1.copy()
288        # Using id() in case somebody has overridden __cmp__.
289        self.assertTrue(id(h1) != id(h2), "No real copy of the HMAC instance.")
290        self.assertTrue(id(h1.inner) != id(h2.inner),
291            "No real copy of the attribute 'inner'.")
292        self.assertTrue(id(h1.outer) != id(h2.outer),
293            "No real copy of the attribute 'outer'.")
294
295    def test_equality(self):
296        # Testing if the copy has the same digests.
297        h1 = hmac.HMAC("key")
298        h1.update("some random text")
299        h2 = h1.copy()
300        self.assertTrue(h1.digest() == h2.digest(),
301            "Digest of copy doesn't match original digest.")
302        self.assertTrue(h1.hexdigest() == h2.hexdigest(),
303            "Hexdigest of copy doesn't match original hexdigest.")
304
305def test_main():
306    test_support.run_unittest(
307        TestVectorsTestCase,
308        ConstructorTestCase,
309        SanityTestCase,
310        CopyTestCase
311    )
312
313if __name__ == "__main__":
314    test_main()
315