Fixed #631 -- deprecate all of OpenSSL.rand (#658)

* Fixed #631 -- deprecate all of OpenSSL.rand * syntax fix * flake8
pyca · Jul 7, 2017 · 8a1de8d · 8a1de8d
1 parent a421276
commit 8a1de8d
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 43 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -18,7 +18,8 @@ Backward-incompatible changes:
 Deprecations:
 ^^^^^^^^^^^^^
 
-*none*
+- Deprecated ``OpenSSL.rand`` - callers should use ``os.urandom()`` instead.
+  `#658 <https://github.com/pyca/pyopenssl/pull/658>`_
 
 
 Changes:

diff --git a/doc/api.rst b/doc/api.rst
@@ -14,5 +14,4 @@ OpenSSL library. The following modules are defined:
    :maxdepth: 2
 
    api/crypto
-   api/rand
    api/ssl
diff --git a/doc/api/rand.rst b/doc/api/rand.rst
diff --git a/src/OpenSSL/rand.py b/src/OpenSSL/rand.py
@@ -2,6 +2,7 @@
 PRNG management routines, thin wrappers.
 """
 
+import warnings
 from functools import partial
 
 from six import integer_types as _integer_types
@@ -13,6 +14,12 @@
     path_string as _path_string)
 
 
+warnings.warn(
+    "OpenSSL.rand is deprecated - you should use os.urandom instead",
+    DeprecationWarning, stacklevel=3
+)
+
+
 class Error(Exception):
     """
     An error occurred in an :mod:`OpenSSL.rand` API.