summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHynek Schlawack <hs@ox.cx>2015-10-20 18:34:13 +0200
committerHynek Schlawack <hs@ox.cx>2015-10-20 21:14:48 +0200
commit80d005f68754f268da419540a593db83286f3d0c (patch)
treea2be0539075cfe3a3dfd580d78cfe756a196da68 /doc
parentd283a6454a9d3929edd1b17e4e02663a6947b5d1 (diff)
downloadpyopenssl-git-80d005f68754f268da419540a593db83286f3d0c.tar.gz
Replace the only EGD call by urandom
Also harmonize documentation. #boyScout
Diffstat (limited to 'doc')
-rw-r--r--doc/api/rand.rst74
1 files changed, 19 insertions, 55 deletions
diff --git a/doc/api/rand.rst b/doc/api/rand.rst
index 18789b8..6c2a5f3 100644
--- a/doc/api/rand.rst
+++ b/doc/api/rand.rst
@@ -1,79 +1,43 @@
.. _openssl-rand:
-:py:mod:`rand` --- An interface to the OpenSSL pseudo random number generator
-=============================================================================
+:mod:`rand` --- An interface to the OpenSSL pseudo random number generator
+==========================================================================
-.. py:module:: OpenSSL.rand
- :synopsis: An interface to the OpenSSL pseudo random number generator
-
-
-This module handles the OpenSSL pseudo random number generator (PRNG) and
-declares the following:
-
-.. py:function:: add(string, entropy)
+.. warning::
+ Functions from this methods shouldn't be used.
+ `Use urandom <http://sockpuppet.org/blog/2014/02/25/safely-generate-random-numbers/>`_ instead.
- Mix bytes from *string* into the PRNG state. The *entropy* argument is
- (the lower bound of) an estimate of how much randomness is contained in
- *string*, measured in bytes. For more information, see e.g. :rfc:`1750`.
-
-.. py:function:: bytes(num_bytes)
-
- Get some random bytes from the PRNG as a string.
-
- This is a wrapper for the C function :py:func:`RAND_bytes`.
+.. py:module:: OpenSSL.rand
+ :synopsis: An interface to the OpenSSL pseudo random number generator
-.. py:function:: cleanup()
+This module handles the OpenSSL pseudo random number generator (PRNG) and declares the following:
- Erase the memory used by the PRNG.
+.. autofunction:: add
- This is a wrapper for the C function :py:func:`RAND_cleanup`.
+.. autofunction:: bytes
+.. autofunction:: cleanup
-.. py:function:: egd(path[, bytes])
+.. autofunction:: egd(path[, bytes])
- Query the `Entropy Gathering Daemon <http://www.lothar.com/tech/crypto/>`_ on
- socket *path* for *bytes* bytes of random data and uses :py:func:`add` to
- seed the PRNG. The default value of *bytes* is 255.
+.. autofunction:: load_file(filename[, bytes])
+.. autofunction:: seed
-.. py:function:: load_file(path[, bytes])
+.. autofunction:: status
- Read *bytes* bytes (or all of it, if *bytes* is negative) of data from the
- file *path* to seed the PRNG. The default value of *bytes* is -1.
+.. autofunction:: write_file
-.. py:function:: screen()
+.. function:: screen
Add the current contents of the screen to the PRNG state.
Availability: Windows.
+ :return: :obj:`None`
-.. py:function:: seed(string)
-
- This is equivalent to calling :py:func:`add` with *entropy* as the length
- of the string.
-
-
-.. py:function:: status()
-
- Returns true if the PRNG has been seeded with enough data, and false otherwise.
-
-
-.. py:function:: write_file(path)
-
- Write a number of random bytes (currently 1024) to the file *path*. This
- file can then be used with :py:func:`load_file` to seed the PRNG again.
-
-
-.. py:exception:: Error
-
- If the current RAND method supports any errors, this is raised when needed.
- The default method does not raise this when the entropy pool is depleted.
- Whenever this exception is raised directly, it has a list of error messages
- from the OpenSSL error queue, where each item is a tuple *(lib, function,
- reason)*. Here *lib*, *function* and *reason* are all strings, describing
- where and what the problem is. See :manpage:`err(3)` for more information.
+.. autoexception:: Error