blob: 3053d1adb3adc551a5ae044c788025f774982015 [file] [log] [blame]
Jean-Paul Calderone8671c852011-03-02 19:26:20 -05001# Copyright (c) Frederick Dean
2# See LICENSE for details.
Rick Dean433dc642009-07-07 13:11:55 -05003
4"""
Jonathan Ballet648875f2011-07-16 14:14:58 +09005Unit tests for :py:obj:`OpenSSL.rand`.
Rick Dean433dc642009-07-07 13:11:55 -05006"""
7
8from unittest import main
Jean-Paul Calderonee379d732010-07-30 17:06:48 -04009import os
Rick Dean433dc642009-07-07 13:11:55 -050010import stat
Jean-Paul Calderonec7cd3e62013-12-31 13:54:39 -050011import sys
Rick Dean433dc642009-07-07 13:11:55 -050012
Jean-Paul Calderone210c0f32015-04-12 09:20:31 -040013from OpenSSL.test.util import NON_ASCII, TestCase, b
Rick Dean433dc642009-07-07 13:11:55 -050014from OpenSSL import rand
15
Jean-Paul Calderonebc2bb812009-07-16 13:31:20 -040016
Rick Dean433dc642009-07-07 13:11:55 -050017class RandTests(TestCase):
Jean-Paul Calderonee379d732010-07-30 17:06:48 -040018 def test_bytes_wrong_args(self):
19 """
Jonathan Ballet648875f2011-07-16 14:14:58 +090020 :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 Calderonee379d732010-07-30 17:06:48 -040022 """
23 self.assertRaises(TypeError, rand.bytes)
24 self.assertRaises(TypeError, rand.bytes, None)
25 self.assertRaises(TypeError, rand.bytes, 3, None)
26
Jean-Paul Calderonec86bb7d2013-12-29 10:25:59 -050027 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 Calderone5c3f0522014-01-11 09:08:37 -050032 self.assertRaises(MemoryError, rand.bytes, sys.maxsize)
Jean-Paul Calderonec86bb7d2013-12-29 10:25:59 -050033
Rick Dean433dc642009-07-07 13:11:55 -050034 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 Calderonee379d732010-07-30 17:06:48 -040044 b3 = rand.bytes(num_bytes=0)
Rick Dean433dc642009-07-07 13:11:55 -050045 self.assertEqual(len(b3), 0)
Jean-Paul Calderonebc2bb812009-07-16 13:31:20 -040046 exc = self.assertRaises(ValueError, rand.bytes, -1)
Jean-Paul Calderoned2ead822009-07-16 19:03:30 -040047 self.assertEqual(str(exc), "num_bytes must not be negative")
Rick Dean433dc642009-07-07 13:11:55 -050048
Jean-Paul Calderoneee0a1f02010-07-30 17:04:24 -040049 def test_add_wrong_args(self):
50 """
51 When called with the wrong number of arguments, or with arguments not of
Jonathan Ballet648875f2011-07-16 14:14:58 +090052 type :py:obj:`str` and :py:obj:`int`, :py:obj:`OpenSSL.rand.add` raises :py:obj:`TypeError`.
Jean-Paul Calderoneee0a1f02010-07-30 17:04:24 -040053 """
54 self.assertRaises(TypeError, rand.add)
Jean-Paul Calderone22cb3122010-10-02 15:55:22 -040055 self.assertRaises(TypeError, rand.add, b("foo"), None)
Jean-Paul Calderoneee0a1f02010-07-30 17:04:24 -040056 self.assertRaises(TypeError, rand.add, None, 3)
Jean-Paul Calderone22cb3122010-10-02 15:55:22 -040057 self.assertRaises(TypeError, rand.add, b("foo"), 3, None)
Jean-Paul Calderoneee0a1f02010-07-30 17:04:24 -040058
Rick Dean433dc642009-07-07 13:11:55 -050059 def test_add(self):
60 """
Jonathan Ballet648875f2011-07-16 14:14:58 +090061 :py:obj:`OpenSSL.rand.add` adds entropy to the PRNG.
Rick Dean433dc642009-07-07 13:11:55 -050062 """
Jean-Paul Calderone22cb3122010-10-02 15:55:22 -040063 rand.add(b('hamburger'), 3)
Jean-Paul Calderonebc2bb812009-07-16 13:31:20 -040064
Jean-Paul Calderoneee0a1f02010-07-30 17:04:24 -040065 def test_seed_wrong_args(self):
66 """
Jonathan Ballet648875f2011-07-16 14:14:58 +090067 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 Calderoneee0a1f02010-07-30 17:04:24 -040069 """
70 self.assertRaises(TypeError, rand.seed)
71 self.assertRaises(TypeError, rand.seed, None)
Jean-Paul Calderone22cb3122010-10-02 15:55:22 -040072 self.assertRaises(TypeError, rand.seed, b("foo"), None)
Jean-Paul Calderoneee0a1f02010-07-30 17:04:24 -040073
Jean-Paul Calderonebc2bb812009-07-16 13:31:20 -040074 def test_seed(self):
75 """
Jonathan Ballet648875f2011-07-16 14:14:58 +090076 :py:obj:`OpenSSL.rand.seed` adds entropy to the PRNG.
Jean-Paul Calderonebc2bb812009-07-16 13:31:20 -040077 """
Jean-Paul Calderone22cb3122010-10-02 15:55:22 -040078 rand.seed(b('milk shake'))
Jean-Paul Calderonebc2bb812009-07-16 13:31:20 -040079
Jean-Paul Calderoneee0a1f02010-07-30 17:04:24 -040080 def test_status_wrong_args(self):
81 """
Jonathan Ballet648875f2011-07-16 14:14:58 +090082 :py:obj:`OpenSSL.rand.status` raises :py:obj:`TypeError` when called with any
Jean-Paul Calderoneee0a1f02010-07-30 17:04:24 -040083 arguments.
84 """
85 self.assertRaises(TypeError, rand.status, None)
86
Jean-Paul Calderonebc2bb812009-07-16 13:31:20 -040087 def test_status(self):
88 """
Jonathan Ballet648875f2011-07-16 14:14:58 +090089 :py:obj:`OpenSSL.rand.status` returns :py:obj:`True` if the PRNG has sufficient
90 entropy, :py:obj:`False` otherwise.
Jean-Paul Calderonebc2bb812009-07-16 13:31:20 -040091 """
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 Dean433dc642009-07-07 13:11:55 -050096
Jean-Paul Calderoneee0a1f02010-07-30 17:04:24 -040097 def test_egd_wrong_args(self):
98 """
Jonathan Ballet648875f2011-07-16 14:14:58 +090099 :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 Calderoneee0a1f02010-07-30 17:04:24 -0400101 """
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 Calderoneee0a1f02010-07-30 17:04:24 -0400108 def test_egd_missing(self):
109 """
Jean-Paul Calderone64efa2c2011-09-11 10:00:09 -0400110 :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 Calderoneee0a1f02010-07-30 17:04:24 -0400112 """
Jean-Paul Calderoned28ca272010-09-19 09:13:11 -0400113 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 Calderoneee0a1f02010-07-30 17:04:24 -0400118
Jean-Paul Calderone7cf3bf52013-12-29 10:29:48 -0500119 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 Calderoneee0a1f02010-07-30 17:04:24 -0400131 def test_cleanup_wrong_args(self):
132 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900133 :py:obj:`OpenSSL.rand.cleanup` raises :py:obj:`TypeError` when called with any
Jean-Paul Calderoneee0a1f02010-07-30 17:04:24 -0400134 arguments.
135 """
136 self.assertRaises(TypeError, rand.cleanup, None)
137
Jean-Paul Calderoneee0a1f02010-07-30 17:04:24 -0400138 def test_cleanup(self):
139 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900140 :py:obj:`OpenSSL.rand.cleanup` releases the memory used by the PRNG and returns
141 :py:obj:`None`.
Jean-Paul Calderoneee0a1f02010-07-30 17:04:24 -0400142 """
143 self.assertIdentical(rand.cleanup(), None)
144
Jean-Paul Calderoneee0a1f02010-07-30 17:04:24 -0400145 def test_load_file_wrong_args(self):
146 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900147 :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 Calderoneee0a1f02010-07-30 17:04:24 -0400149 """
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 Calderoneee0a1f02010-07-30 17:04:24 -0400155 def test_write_file_wrong_args(self):
156 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900157 :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 Calderoneee0a1f02010-07-30 17:04:24 -0400159 """
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 Calderonecbb68cc2015-04-11 12:41:30 -0400164 def _read_write_test(self, path):
Rick Dean433dc642009-07-07 13:11:55 -0500165 """
Jean-Paul Calderonecbb68cc2015-04-11 12:41:30 -0400166 Verify that ``rand.write_file`` and ``rand.load_file`` can be used.
Rick Dean433dc642009-07-07 13:11:55 -0500167 """
Jean-Paul Calderonecbb68cc2015-04-11 12:41:30 -0400168 # Create the file so cleanup is more straightforward
169 with open(path, "w"):
170 pass
171
Jean-Paul Calderoneb534ff42009-07-16 13:44:56 -0400172 try:
Jean-Paul Calderonecbb68cc2015-04-11 12:41:30 -0400173 # Write random bytes to a file
174 rand.write_file(path)
175
Jean-Paul Calderoneb534ff42009-07-16 13:44:56 -0400176 # Verify length of written file
Jean-Paul Calderonecbb68cc2015-04-11 12:41:30 -0400177 size = os.stat(path)[stat.ST_SIZE]
Jean-Paul Calderone20aae942014-01-11 09:46:47 -0500178 self.assertEqual(1024, size)
Jean-Paul Calderonecbb68cc2015-04-11 12:41:30 -0400179
Jean-Paul Calderoneee0a1f02010-07-30 17:04:24 -0400180 # Read random bytes from file
Jean-Paul Calderonecbb68cc2015-04-11 12:41:30 -0400181 rand.load_file(path)
182 rand.load_file(path, 4) # specify a length
Jean-Paul Calderoneb534ff42009-07-16 13:44:56 -0400183 finally:
184 # Cleanup
Jean-Paul Calderonecbb68cc2015-04-11 12:41:30 -0400185 os.unlink(path)
186
Jean-Paul Calderonecbb68cc2015-04-11 12:41:30 -0400187 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 Calderone210c0f32015-04-12 09:20:31 -0400193 path += NON_ASCII.encode(sys.getfilesystemencoding())
Jean-Paul Calderonecbb68cc2015-04-11 12:41:30 -0400194 self._read_write_test(path)
195
Jean-Paul Calderonecbb68cc2015-04-11 12:41:30 -0400196 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 Calderone210c0f32015-04-12 09:20:31 -0400201 path = self.mktemp().decode('utf-8') + NON_ASCII
Jean-Paul Calderonecbb68cc2015-04-11 12:41:30 -0400202 self._read_write_test(path)
Rick Dean433dc642009-07-07 13:11:55 -0500203
204
205if __name__ == '__main__':
206 main()