From: Victor Stinner <victor.stinner@haypocalc.com>
Date: Wed, 25 May 2011 09:27:40 +0000 (+0200)
Subject: Issue #12049: Document errors cases of ssl.RAND_bytes() and
X-Git-Tag: v3.3.0a1~2183^2~111
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=a675206366435432118e443090d3e08613db6679;p=python

Issue #12049: Document errors cases of ssl.RAND_bytes() and
ssl.RAND_pseudo_bytes().  Add also links to RAND_status and RAND_add.
---

diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst
index 295d007f06..ca71d20405 100644
--- a/Doc/library/ssl.rst
+++ b/Doc/library/ssl.rst
@@ -164,10 +164,14 @@ Random generation
 
 .. function:: RAND_bytes(num)
 
-   Returns *num* cryptographically strong pseudo-random bytes.
+   Returns *num* cryptographically strong pseudo-random bytes. Raises an
+   :class:`SSLError` if the PRNG has not been seeded with enough data or if the
+   operation is not supported by the current RAND method. :func:`RAND_status`
+   can be used to check the status of the PRNG and :func:`RAND_add` can be used
+   to seed the PRNG.
 
    Read the Wikipedia article, `Cryptographically secure pseudorandom number
-   generator
+   generator (CSPRNG)
    <http://en.wikipedia.org/wiki/Cryptographically_secure_pseudorandom_number_generator>`_,
    to get the requirements of a cryptographically generator.
 
@@ -177,7 +181,8 @@ Random generation
 
    Returns (bytes, is_cryptographic): bytes are *num* pseudo-random bytes,
    is_cryptographic is True if the bytes generated are cryptographically
-   strong.
+   strong. Raises an :class:`SSLError` if the operation is not supported by the
+   current RAND method.
 
    Generated pseudo-random byte sequences will be unique if they are of
    sufficient length, but are not necessarily unpredictable. They can be used