aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2016-12-21 21:10:03 -0600
committerAlex Gaynor <alex.gaynor@gmail.com>2016-12-21 22:10:03 -0500
commit5685baa2121cb7e5abc99b4325701dad44cb5f30 (patch)
treed6b0f3b6c204f77d58922c5db39e8a135ee069ca /docs
parente432562e771f7e190310a093e93a217871e35c90 (diff)
downloadcryptography-5685baa2121cb7e5abc99b4325701dad44cb5f30.tar.gz
cryptography-5685baa2121cb7e5abc99b4325701dad44cb5f30.tar.bz2
cryptography-5685baa2121cb7e5abc99b4325701dad44cb5f30.zip
add openssl_version_number & doc openssl_version_text (#3329)
* add openssl_version_number & doc openssl_version_text fixes #3315 * more docs + actually assert on the test... * text
Diffstat (limited to 'docs')
-rw-r--r--docs/hazmat/backends/openssl.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/hazmat/backends/openssl.rst b/docs/hazmat/backends/openssl.rst
index e293c064..22807f1c 100644
--- a/docs/hazmat/backends/openssl.rst
+++ b/docs/hazmat/backends/openssl.rst
@@ -36,6 +36,20 @@ greater.
The string name of this backend: ``"openssl"``
+ .. method:: openssl_version_text()
+
+ :return text: The friendly string name of the loaded OpenSSL library.
+ This is not necessarily the same version as it was compiled against.
+
+ .. method:: openssl_version_number()
+
+ .. versionadded:: 1.8
+
+ :return int: The integer version of the loaded OpenSSL library. This is
+ defined in ``opensslv.h`` as ``OPENSSL_VERSION_NUMBER`` and is
+ typically shown in hexadecimal (e.g. ``0x1010003f``). This is
+ not necessarily the same version as it was compiled against.
+
.. method:: activate_osrandom_engine()
Activates the OS random engine. This will effectively disable OpenSSL's