blob: b85a26ad65685f671d9f33e70497ba1e9bc51171 [file] [log] [blame]
Christian Heimesb186d002008-03-18 15:15:01 +00001"""
2Test suite to check compilance with PEP 247, the standard API
3for hashing algorithms
4"""
Andrew M. Kuchlinga0b60352001-11-02 21:46:17 +00005
Guido van Rossuma8add0e2007-05-14 22:03:55 +00006import hmac
Christian Heimesb186d002008-03-18 15:15:01 +00007import unittest
Neal Norwitzc598b6f2008-03-18 20:47:14 +00008from hashlib import md5, sha1, sha224, sha256, sha384, sha512
Benjamin Petersonee8712c2008-05-20 21:35:26 +00009from test import support
Andrew M. Kuchlinga0b60352001-11-02 21:46:17 +000010
Christian Heimesb186d002008-03-18 15:15:01 +000011class Pep247Test(unittest.TestCase):
Christian Heimes180510d2008-03-03 19:15:45 +000012
Christian Heimesb186d002008-03-18 15:15:01 +000013 def check_module(self, module, key=None):
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000014 self.assertTrue(hasattr(module, 'digest_size'))
15 self.assertTrue(module.digest_size is None or module.digest_size > 0)
Neal Norwitzc598b6f2008-03-18 20:47:14 +000016 self.check_object(module.new, module.digest_size, key)
17
Christian Heimes634919a2013-11-20 17:23:06 +010018 def check_object(self, cls, digest_size, key, digestmod=None):
Neal Norwitzc598b6f2008-03-18 20:47:14 +000019 if key is not None:
Christian Heimes634919a2013-11-20 17:23:06 +010020 if digestmod is None:
21 digestmod = md5
22 obj1 = cls(key, digestmod=digestmod)
23 obj2 = cls(key, b'string', digestmod=digestmod)
24 h1 = cls(key, b'string', digestmod=digestmod).digest()
25 obj3 = cls(key, digestmod=digestmod)
Neal Norwitzc598b6f2008-03-18 20:47:14 +000026 obj3.update(b'string')
Christian Heimesb186d002008-03-18 15:15:01 +000027 h2 = obj3.digest()
28 else:
Neal Norwitzc598b6f2008-03-18 20:47:14 +000029 obj1 = cls()
30 obj2 = cls(b'string')
31 h1 = cls(b'string').digest()
32 obj3 = cls()
33 obj3.update(b'string')
Christian Heimesb186d002008-03-18 15:15:01 +000034 h2 = obj3.digest()
Ezio Melottib3aedd42010-11-20 19:04:17 +000035 self.assertEqual(h1, h2)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000036 self.assertTrue(hasattr(obj1, 'digest_size'))
Andrew M. Kuchlinga0b60352001-11-02 21:46:17 +000037
Neal Norwitzc598b6f2008-03-18 20:47:14 +000038 if digest_size is not None:
Ezio Melottib3aedd42010-11-20 19:04:17 +000039 self.assertEqual(obj1.digest_size, digest_size)
Andrew M. Kuchlinga0b60352001-11-02 21:46:17 +000040
Ezio Melottib3aedd42010-11-20 19:04:17 +000041 self.assertEqual(obj1.digest_size, len(h1))
Neal Norwitzc598b6f2008-03-18 20:47:14 +000042 obj1.update(b'string')
Christian Heimesb186d002008-03-18 15:15:01 +000043 obj_copy = obj1.copy()
Ezio Melottib3aedd42010-11-20 19:04:17 +000044 self.assertEqual(obj1.digest(), obj_copy.digest())
45 self.assertEqual(obj1.hexdigest(), obj_copy.hexdigest())
Andrew M. Kuchlinga0b60352001-11-02 21:46:17 +000046
Christian Heimesb186d002008-03-18 15:15:01 +000047 digest, hexdigest = obj1.digest(), obj1.hexdigest()
48 hd2 = ""
49 for byte in digest:
Neal Norwitzc598b6f2008-03-18 20:47:14 +000050 hd2 += '%02x' % byte
Ezio Melottib3aedd42010-11-20 19:04:17 +000051 self.assertEqual(hd2, hexdigest)
Andrew M. Kuchlinga0b60352001-11-02 21:46:17 +000052
Christian Heimesb186d002008-03-18 15:15:01 +000053 def test_md5(self):
Neal Norwitzc598b6f2008-03-18 20:47:14 +000054 self.check_object(md5, None, None)
Andrew M. Kuchlinga0b60352001-11-02 21:46:17 +000055
Christian Heimesb186d002008-03-18 15:15:01 +000056 def test_sha(self):
Neal Norwitzc598b6f2008-03-18 20:47:14 +000057 self.check_object(sha1, None, None)
58 self.check_object(sha224, None, None)
59 self.check_object(sha256, None, None)
60 self.check_object(sha384, None, None)
61 self.check_object(sha512, None, None)
Andrew M. Kuchlinga0b60352001-11-02 21:46:17 +000062
Christian Heimesb186d002008-03-18 15:15:01 +000063 def test_hmac(self):
Neal Norwitzc598b6f2008-03-18 20:47:14 +000064 self.check_module(hmac, key=b'abc')
Christian Heimes180510d2008-03-03 19:15:45 +000065
66def test_main():
Benjamin Petersonee8712c2008-05-20 21:35:26 +000067 support.run_unittest(Pep247Test)
Andrew M. Kuchlinga0b60352001-11-02 21:46:17 +000068
69if __name__ == '__main__':
Christian Heimes180510d2008-03-03 19:15:45 +000070 test_main()