diff options
| author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-01-31 10:57:17 -0600 |
|---|---|---|
| committer | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-01-31 10:57:17 -0600 |
| commit | d52b89b4e881639bc68d9c30983e08a1b8085be8 (patch) | |
| tree | 75fa6c869dc8733e9fc49c262bc09fb75e33604c /docs/hazmat/backends/openssl.rst | |
| parent | 8042b2988d71d3675e06d25416e285215ae98636 (diff) | |
| download | cryptography-d52b89b4e881639bc68d9c30983e08a1b8085be8.tar.gz cryptography-d52b89b4e881639bc68d9c30983e08a1b8085be8.tar.bz2 cryptography-d52b89b4e881639bc68d9c30983e08a1b8085be8.zip | |
change register/unregister to activate/deactivate
Diffstat (limited to 'docs/hazmat/backends/openssl.rst')
| -rw-r--r-- | docs/hazmat/backends/openssl.rst | 13 |
1 files changed, 5 insertions, 8 deletions
diff --git a/docs/hazmat/backends/openssl.rst b/docs/hazmat/backends/openssl.rst index 81361f5a..1d40b93c 100644 --- a/docs/hazmat/backends/openssl.rst +++ b/docs/hazmat/backends/openssl.rst @@ -13,14 +13,14 @@ The `OpenSSL`_ C library. The string name of this backend: ``"openssl"`` - .. method:: register_osrandom_engine() + .. method:: activate_osrandom_engine() - Registers the OS random engine as default. This will effectively - disable OpenSSL's default CSPRNG. + Activates the OS random engine. This will effectively disable OpenSSL's + default CSPRNG. - .. method:: unregister_osrandom_engine() + .. method:: deactivate_osrandom_engine() - Unregisters the OS random engine if it is default. This will restore + Deactivates the OS random engine if it is default. This will restore the default OpenSSL CSPRNG. If the OS random engine is not the default engine (e.g. if another engine is set as default) nothing will be changed. @@ -45,9 +45,6 @@ This engine is **active** by default when importing the OpenSSL backend. When active this engine will be used to generate all the random data OpenSSL requests. -If you wish to deactivate the engine you may call -``unregister_osrandom_engine()`` on the backend object. - When importing only the binding it is added to the engine list but **not activated**. |