Jean-Paul Calderone | 8671c85 | 2011-03-02 19:26:20 -0500 | [diff] [blame] | 1 | # Copyright (c) Frederick Dean |
| 2 | # See LICENSE for details. |
Rick Dean | 433dc64 | 2009-07-07 13:11:55 -0500 | [diff] [blame] | 3 | |
| 4 | """ |
Jonathan Ballet | 648875f | 2011-07-16 14:14:58 +0900 | [diff] [blame] | 5 | Unit tests for :py:obj:`OpenSSL.rand`. |
Rick Dean | 433dc64 | 2009-07-07 13:11:55 -0500 | [diff] [blame] | 6 | """ |
| 7 | |
| 8 | from unittest import main |
Jean-Paul Calderone | e379d73 | 2010-07-30 17:06:48 -0400 | [diff] [blame] | 9 | import os |
Rick Dean | 433dc64 | 2009-07-07 13:11:55 -0500 | [diff] [blame] | 10 | import stat |
Jean-Paul Calderone | c7cd3e6 | 2013-12-31 13:54:39 -0500 | [diff] [blame] | 11 | import sys |
Rick Dean | 433dc64 | 2009-07-07 13:11:55 -0500 | [diff] [blame] | 12 | |
Jean-Paul Calderone | 210c0f3 | 2015-04-12 09:20:31 -0400 | [diff] [blame] | 13 | from OpenSSL.test.util import NON_ASCII, TestCase, b |
Rick Dean | 433dc64 | 2009-07-07 13:11:55 -0500 | [diff] [blame] | 14 | from OpenSSL import rand |
| 15 | |
Jean-Paul Calderone | bc2bb81 | 2009-07-16 13:31:20 -0400 | [diff] [blame] | 16 | |
Rick Dean | 433dc64 | 2009-07-07 13:11:55 -0500 | [diff] [blame] | 17 | class RandTests(TestCase): |
Jean-Paul Calderone | e379d73 | 2010-07-30 17:06:48 -0400 | [diff] [blame] | 18 | def test_bytes_wrong_args(self): |
| 19 | """ |
Jonathan Ballet | 648875f | 2011-07-16 14:14:58 +0900 | [diff] [blame] | 20 | :py:obj:`OpenSSL.rand.bytes` raises :py:obj:`TypeError` if called with the wrong |
| 21 | number of arguments or with a non-:py:obj:`int` argument. |
Jean-Paul Calderone | e379d73 | 2010-07-30 17:06:48 -0400 | [diff] [blame] | 22 | """ |
| 23 | self.assertRaises(TypeError, rand.bytes) |
| 24 | self.assertRaises(TypeError, rand.bytes, None) |
| 25 | self.assertRaises(TypeError, rand.bytes, 3, None) |
| 26 | |
Jean-Paul Calderone | c86bb7d | 2013-12-29 10:25:59 -0500 | [diff] [blame] | 27 | def test_insufficientMemory(self): |
| 28 | """ |
| 29 | :py:obj:`OpenSSL.rand.bytes` raises :py:obj:`MemoryError` if more bytes |
| 30 | are requested than will fit in memory. |
| 31 | """ |
Jean-Paul Calderone | 5c3f052 | 2014-01-11 09:08:37 -0500 | [diff] [blame] | 32 | self.assertRaises(MemoryError, rand.bytes, sys.maxsize) |
Jean-Paul Calderone | c86bb7d | 2013-12-29 10:25:59 -0500 | [diff] [blame] | 33 | |
Rick Dean | 433dc64 | 2009-07-07 13:11:55 -0500 | [diff] [blame] | 34 | def test_bytes(self): |
| 35 | """ |
| 36 | Verify that we can obtain bytes from rand_bytes() and |
| 37 | that they are different each time. Test the parameter |
| 38 | of rand_bytes() for bad values. |
| 39 | """ |
| 40 | b1 = rand.bytes(50) |
| 41 | self.assertEqual(len(b1), 50) |
| 42 | b2 = rand.bytes(num_bytes=50) # parameter by name |
| 43 | self.assertNotEqual(b1, b2) # Hip, Hip, Horay! FIPS complaince |
Jean-Paul Calderone | e379d73 | 2010-07-30 17:06:48 -0400 | [diff] [blame] | 44 | b3 = rand.bytes(num_bytes=0) |
Rick Dean | 433dc64 | 2009-07-07 13:11:55 -0500 | [diff] [blame] | 45 | self.assertEqual(len(b3), 0) |
Jean-Paul Calderone | bc2bb81 | 2009-07-16 13:31:20 -0400 | [diff] [blame] | 46 | exc = self.assertRaises(ValueError, rand.bytes, -1) |
Jean-Paul Calderone | d2ead82 | 2009-07-16 19:03:30 -0400 | [diff] [blame] | 47 | self.assertEqual(str(exc), "num_bytes must not be negative") |
Rick Dean | 433dc64 | 2009-07-07 13:11:55 -0500 | [diff] [blame] | 48 | |
Jean-Paul Calderone | ee0a1f0 | 2010-07-30 17:04:24 -0400 | [diff] [blame] | 49 | def test_add_wrong_args(self): |
| 50 | """ |
| 51 | When called with the wrong number of arguments, or with arguments not of |
Jonathan Ballet | 648875f | 2011-07-16 14:14:58 +0900 | [diff] [blame] | 52 | type :py:obj:`str` and :py:obj:`int`, :py:obj:`OpenSSL.rand.add` raises :py:obj:`TypeError`. |
Jean-Paul Calderone | ee0a1f0 | 2010-07-30 17:04:24 -0400 | [diff] [blame] | 53 | """ |
| 54 | self.assertRaises(TypeError, rand.add) |
Jean-Paul Calderone | 22cb312 | 2010-10-02 15:55:22 -0400 | [diff] [blame] | 55 | self.assertRaises(TypeError, rand.add, b("foo"), None) |
Jean-Paul Calderone | ee0a1f0 | 2010-07-30 17:04:24 -0400 | [diff] [blame] | 56 | self.assertRaises(TypeError, rand.add, None, 3) |
Jean-Paul Calderone | 22cb312 | 2010-10-02 15:55:22 -0400 | [diff] [blame] | 57 | self.assertRaises(TypeError, rand.add, b("foo"), 3, None) |
Jean-Paul Calderone | ee0a1f0 | 2010-07-30 17:04:24 -0400 | [diff] [blame] | 58 | |
Rick Dean | 433dc64 | 2009-07-07 13:11:55 -0500 | [diff] [blame] | 59 | def test_add(self): |
| 60 | """ |
Jonathan Ballet | 648875f | 2011-07-16 14:14:58 +0900 | [diff] [blame] | 61 | :py:obj:`OpenSSL.rand.add` adds entropy to the PRNG. |
Rick Dean | 433dc64 | 2009-07-07 13:11:55 -0500 | [diff] [blame] | 62 | """ |
Jean-Paul Calderone | 22cb312 | 2010-10-02 15:55:22 -0400 | [diff] [blame] | 63 | rand.add(b('hamburger'), 3) |
Jean-Paul Calderone | bc2bb81 | 2009-07-16 13:31:20 -0400 | [diff] [blame] | 64 | |
Jean-Paul Calderone | ee0a1f0 | 2010-07-30 17:04:24 -0400 | [diff] [blame] | 65 | def test_seed_wrong_args(self): |
| 66 | """ |
Jonathan Ballet | 648875f | 2011-07-16 14:14:58 +0900 | [diff] [blame] | 67 | When called with the wrong number of arguments, or with a non-:py:obj:`str` |
| 68 | argument, :py:obj:`OpenSSL.rand.seed` raises :py:obj:`TypeError`. |
Jean-Paul Calderone | ee0a1f0 | 2010-07-30 17:04:24 -0400 | [diff] [blame] | 69 | """ |
| 70 | self.assertRaises(TypeError, rand.seed) |
| 71 | self.assertRaises(TypeError, rand.seed, None) |
Jean-Paul Calderone | 22cb312 | 2010-10-02 15:55:22 -0400 | [diff] [blame] | 72 | self.assertRaises(TypeError, rand.seed, b("foo"), None) |
Jean-Paul Calderone | ee0a1f0 | 2010-07-30 17:04:24 -0400 | [diff] [blame] | 73 | |
Jean-Paul Calderone | bc2bb81 | 2009-07-16 13:31:20 -0400 | [diff] [blame] | 74 | def test_seed(self): |
| 75 | """ |
Jonathan Ballet | 648875f | 2011-07-16 14:14:58 +0900 | [diff] [blame] | 76 | :py:obj:`OpenSSL.rand.seed` adds entropy to the PRNG. |
Jean-Paul Calderone | bc2bb81 | 2009-07-16 13:31:20 -0400 | [diff] [blame] | 77 | """ |
Jean-Paul Calderone | 22cb312 | 2010-10-02 15:55:22 -0400 | [diff] [blame] | 78 | rand.seed(b('milk shake')) |
Jean-Paul Calderone | bc2bb81 | 2009-07-16 13:31:20 -0400 | [diff] [blame] | 79 | |
Jean-Paul Calderone | ee0a1f0 | 2010-07-30 17:04:24 -0400 | [diff] [blame] | 80 | def test_status_wrong_args(self): |
| 81 | """ |
Jonathan Ballet | 648875f | 2011-07-16 14:14:58 +0900 | [diff] [blame] | 82 | :py:obj:`OpenSSL.rand.status` raises :py:obj:`TypeError` when called with any |
Jean-Paul Calderone | ee0a1f0 | 2010-07-30 17:04:24 -0400 | [diff] [blame] | 83 | arguments. |
| 84 | """ |
| 85 | self.assertRaises(TypeError, rand.status, None) |
| 86 | |
Jean-Paul Calderone | bc2bb81 | 2009-07-16 13:31:20 -0400 | [diff] [blame] | 87 | def test_status(self): |
| 88 | """ |
Jonathan Ballet | 648875f | 2011-07-16 14:14:58 +0900 | [diff] [blame] | 89 | :py:obj:`OpenSSL.rand.status` returns :py:obj:`True` if the PRNG has sufficient |
| 90 | entropy, :py:obj:`False` otherwise. |
Jean-Paul Calderone | bc2bb81 | 2009-07-16 13:31:20 -0400 | [diff] [blame] | 91 | """ |
| 92 | # It's hard to know what it is actually going to return. Different |
| 93 | # OpenSSL random engines decide differently whether they have enough |
| 94 | # entropy or not. |
| 95 | self.assertTrue(rand.status() in (1, 2)) |
Rick Dean | 433dc64 | 2009-07-07 13:11:55 -0500 | [diff] [blame] | 96 | |
Jean-Paul Calderone | ee0a1f0 | 2010-07-30 17:04:24 -0400 | [diff] [blame] | 97 | def test_egd_wrong_args(self): |
| 98 | """ |
Jonathan Ballet | 648875f | 2011-07-16 14:14:58 +0900 | [diff] [blame] | 99 | :py:obj:`OpenSSL.rand.egd` raises :py:obj:`TypeError` when called with the wrong |
| 100 | number of arguments or with arguments not of type :py:obj:`str` and :py:obj:`int`. |
Jean-Paul Calderone | ee0a1f0 | 2010-07-30 17:04:24 -0400 | [diff] [blame] | 101 | """ |
| 102 | self.assertRaises(TypeError, rand.egd) |
| 103 | self.assertRaises(TypeError, rand.egd, None) |
| 104 | self.assertRaises(TypeError, rand.egd, "foo", None) |
| 105 | self.assertRaises(TypeError, rand.egd, None, 3) |
| 106 | self.assertRaises(TypeError, rand.egd, "foo", 3, None) |
| 107 | |
Jean-Paul Calderone | ee0a1f0 | 2010-07-30 17:04:24 -0400 | [diff] [blame] | 108 | def test_egd_missing(self): |
| 109 | """ |
Jean-Paul Calderone | 64efa2c | 2011-09-11 10:00:09 -0400 | [diff] [blame] | 110 | :py:obj:`OpenSSL.rand.egd` returns :py:obj:`0` or :py:obj:`-1` if the |
| 111 | EGD socket passed to it does not exist. |
Jean-Paul Calderone | ee0a1f0 | 2010-07-30 17:04:24 -0400 | [diff] [blame] | 112 | """ |
Jean-Paul Calderone | d28ca27 | 2010-09-19 09:13:11 -0400 | [diff] [blame] | 113 | result = rand.egd(self.mktemp()) |
| 114 | expected = (-1, 0) |
| 115 | self.assertTrue( |
| 116 | result in expected, |
| 117 | "%r not in %r" % (result, expected)) |
Jean-Paul Calderone | ee0a1f0 | 2010-07-30 17:04:24 -0400 | [diff] [blame] | 118 | |
Jean-Paul Calderone | 7cf3bf5 | 2013-12-29 10:29:48 -0500 | [diff] [blame] | 119 | def test_egd_missing_and_bytes(self): |
| 120 | """ |
| 121 | :py:obj:`OpenSSL.rand.egd` returns :py:obj:`0` or :py:obj:`-1` if the |
| 122 | EGD socket passed to it does not exist even if a size argument is |
| 123 | explicitly passed. |
| 124 | """ |
| 125 | result = rand.egd(self.mktemp(), 1024) |
| 126 | expected = (-1, 0) |
| 127 | self.assertTrue( |
| 128 | result in expected, |
| 129 | "%r not in %r" % (result, expected)) |
| 130 | |
Jean-Paul Calderone | ee0a1f0 | 2010-07-30 17:04:24 -0400 | [diff] [blame] | 131 | def test_cleanup_wrong_args(self): |
| 132 | """ |
Jonathan Ballet | 648875f | 2011-07-16 14:14:58 +0900 | [diff] [blame] | 133 | :py:obj:`OpenSSL.rand.cleanup` raises :py:obj:`TypeError` when called with any |
Jean-Paul Calderone | ee0a1f0 | 2010-07-30 17:04:24 -0400 | [diff] [blame] | 134 | arguments. |
| 135 | """ |
| 136 | self.assertRaises(TypeError, rand.cleanup, None) |
| 137 | |
Jean-Paul Calderone | ee0a1f0 | 2010-07-30 17:04:24 -0400 | [diff] [blame] | 138 | def test_cleanup(self): |
| 139 | """ |
Jonathan Ballet | 648875f | 2011-07-16 14:14:58 +0900 | [diff] [blame] | 140 | :py:obj:`OpenSSL.rand.cleanup` releases the memory used by the PRNG and returns |
| 141 | :py:obj:`None`. |
Jean-Paul Calderone | ee0a1f0 | 2010-07-30 17:04:24 -0400 | [diff] [blame] | 142 | """ |
| 143 | self.assertIdentical(rand.cleanup(), None) |
| 144 | |
Jean-Paul Calderone | ee0a1f0 | 2010-07-30 17:04:24 -0400 | [diff] [blame] | 145 | def test_load_file_wrong_args(self): |
| 146 | """ |
Jonathan Ballet | 648875f | 2011-07-16 14:14:58 +0900 | [diff] [blame] | 147 | :py:obj:`OpenSSL.rand.load_file` raises :py:obj:`TypeError` when called the wrong |
| 148 | number of arguments or arguments not of type :py:obj:`str` and :py:obj:`int`. |
Jean-Paul Calderone | ee0a1f0 | 2010-07-30 17:04:24 -0400 | [diff] [blame] | 149 | """ |
| 150 | self.assertRaises(TypeError, rand.load_file) |
| 151 | self.assertRaises(TypeError, rand.load_file, "foo", None) |
| 152 | self.assertRaises(TypeError, rand.load_file, None, 1) |
| 153 | self.assertRaises(TypeError, rand.load_file, "foo", 1, None) |
| 154 | |
Jean-Paul Calderone | ee0a1f0 | 2010-07-30 17:04:24 -0400 | [diff] [blame] | 155 | def test_write_file_wrong_args(self): |
| 156 | """ |
Jonathan Ballet | 648875f | 2011-07-16 14:14:58 +0900 | [diff] [blame] | 157 | :py:obj:`OpenSSL.rand.write_file` raises :py:obj:`TypeError` when called with the |
| 158 | wrong number of arguments or a non-:py:obj:`str` argument. |
Jean-Paul Calderone | ee0a1f0 | 2010-07-30 17:04:24 -0400 | [diff] [blame] | 159 | """ |
| 160 | self.assertRaises(TypeError, rand.write_file) |
| 161 | self.assertRaises(TypeError, rand.write_file, None) |
| 162 | self.assertRaises(TypeError, rand.write_file, "foo", None) |
| 163 | |
Jean-Paul Calderone | cbb68cc | 2015-04-11 12:41:30 -0400 | [diff] [blame] | 164 | def _read_write_test(self, path): |
Rick Dean | 433dc64 | 2009-07-07 13:11:55 -0500 | [diff] [blame] | 165 | """ |
Jean-Paul Calderone | cbb68cc | 2015-04-11 12:41:30 -0400 | [diff] [blame] | 166 | Verify that ``rand.write_file`` and ``rand.load_file`` can be used. |
Rick Dean | 433dc64 | 2009-07-07 13:11:55 -0500 | [diff] [blame] | 167 | """ |
Jean-Paul Calderone | cbb68cc | 2015-04-11 12:41:30 -0400 | [diff] [blame] | 168 | # Create the file so cleanup is more straightforward |
| 169 | with open(path, "w"): |
| 170 | pass |
| 171 | |
Jean-Paul Calderone | b534ff4 | 2009-07-16 13:44:56 -0400 | [diff] [blame] | 172 | try: |
Jean-Paul Calderone | cbb68cc | 2015-04-11 12:41:30 -0400 | [diff] [blame] | 173 | # Write random bytes to a file |
| 174 | rand.write_file(path) |
| 175 | |
Jean-Paul Calderone | b534ff4 | 2009-07-16 13:44:56 -0400 | [diff] [blame] | 176 | # Verify length of written file |
Jean-Paul Calderone | cbb68cc | 2015-04-11 12:41:30 -0400 | [diff] [blame] | 177 | size = os.stat(path)[stat.ST_SIZE] |
Jean-Paul Calderone | 20aae94 | 2014-01-11 09:46:47 -0500 | [diff] [blame] | 178 | self.assertEqual(1024, size) |
Jean-Paul Calderone | cbb68cc | 2015-04-11 12:41:30 -0400 | [diff] [blame] | 179 | |
Jean-Paul Calderone | ee0a1f0 | 2010-07-30 17:04:24 -0400 | [diff] [blame] | 180 | # Read random bytes from file |
Jean-Paul Calderone | cbb68cc | 2015-04-11 12:41:30 -0400 | [diff] [blame] | 181 | rand.load_file(path) |
| 182 | rand.load_file(path, 4) # specify a length |
Jean-Paul Calderone | b534ff4 | 2009-07-16 13:44:56 -0400 | [diff] [blame] | 183 | finally: |
| 184 | # Cleanup |
Jean-Paul Calderone | cbb68cc | 2015-04-11 12:41:30 -0400 | [diff] [blame] | 185 | os.unlink(path) |
| 186 | |
Jean-Paul Calderone | cbb68cc | 2015-04-11 12:41:30 -0400 | [diff] [blame] | 187 | def test_bytes_paths(self): |
| 188 | """ |
| 189 | Random data can be saved and loaded to files with paths specified as |
| 190 | bytes. |
| 191 | """ |
| 192 | path = self.mktemp() |
Jean-Paul Calderone | 210c0f3 | 2015-04-12 09:20:31 -0400 | [diff] [blame] | 193 | path += NON_ASCII.encode(sys.getfilesystemencoding()) |
Jean-Paul Calderone | cbb68cc | 2015-04-11 12:41:30 -0400 | [diff] [blame] | 194 | self._read_write_test(path) |
| 195 | |
Jean-Paul Calderone | cbb68cc | 2015-04-11 12:41:30 -0400 | [diff] [blame] | 196 | def test_unicode_paths(self): |
| 197 | """ |
| 198 | Random data can be saved and loaded to files with paths specified as |
| 199 | unicode. |
| 200 | """ |
Jean-Paul Calderone | 210c0f3 | 2015-04-12 09:20:31 -0400 | [diff] [blame] | 201 | path = self.mktemp().decode('utf-8') + NON_ASCII |
Jean-Paul Calderone | cbb68cc | 2015-04-11 12:41:30 -0400 | [diff] [blame] | 202 | self._read_write_test(path) |
Rick Dean | 433dc64 | 2009-07-07 13:11:55 -0500 | [diff] [blame] | 203 | |
| 204 | |
| 205 | if __name__ == '__main__': |
| 206 | main() |