diff options
author | Erlang/OTP <[email protected]> | 2018-08-23 08:00:31 +0200 |
---|---|---|
committer | Erlang/OTP <[email protected]> | 2018-08-23 08:00:31 +0200 |
commit | 38b181702725e770fcdde1c9652c551d1578691b (patch) | |
tree | 01c380fc1eced375b0ce5a2f5c1ceca7a0517096 /lib/crypto/doc/src/engine_load.xml | |
parent | dbda351d388555b5884f2e15bc8d96352c91a830 (diff) | |
parent | 5b51f9d9875750f27f2fa8a75f22e0fcb9a6bec0 (diff) | |
download | otp-38b181702725e770fcdde1c9652c551d1578691b.tar.gz otp-38b181702725e770fcdde1c9652c551d1578691b.tar.bz2 otp-38b181702725e770fcdde1c9652c551d1578691b.zip |
Merge branch 'lars/crypto/multiple-engine-load/OTP-15233' into maint-20
* lars/crypto/multiple-engine-load/OTP-15233:
Updated the engine load functionality
Diffstat (limited to 'lib/crypto/doc/src/engine_load.xml')
-rw-r--r-- | lib/crypto/doc/src/engine_load.xml | 31 |
1 files changed, 25 insertions, 6 deletions
diff --git a/lib/crypto/doc/src/engine_load.xml b/lib/crypto/doc/src/engine_load.xml index e5c3f5d561..3d0aa0c32a 100644 --- a/lib/crypto/doc/src/engine_load.xml +++ b/lib/crypto/doc/src/engine_load.xml @@ -42,6 +42,9 @@ operations. The hardware implementation usually offers improved performance over its software-based counterpart, which is known as cryptographic acceleration. </p> + <note> + <p>The file name requirement on the engine dynamic library can differ between SSL versions.</p> + </note> </section> <section> @@ -54,9 +57,6 @@ <code> 1> {ok, Engine} = crypto:engine_load(<<"otp_test_engine">>, [], []). {ok, #Ref}</code> - <note> - <p>The file name requirement on the engine dynamic library can differ between SSL versions.</p> - </note> </section> <section> @@ -72,9 +72,6 @@ <<"LOAD">>], []). {ok, #Ref}</code> - <note> - <p>The dynamic engine is not supported in LibreSSL from version 2.2.1</p> - </note> </section> <section> @@ -100,6 +97,28 @@ engine_method_pkey_meths, engine_method_pkey_asn1_meths]. </section> <section> + <title>Load with the ensure loaded function</title> + <p> + This function makes sure the engine is loaded just once and the ID is added to the internal + engine list of OpenSSL. The following calls to the function will check if the ID is loaded + and then just get a new reference to the engine. + </p> + <code> + 5> {ok, Engine} = crypto:ensure_engine_loaded(<<"MD5">>, + <<"/some/path/otp_test_engine.so">>). + {ok, #Ref}</code> + <p> + To unload it use crypto:ensure_engine_unloaded/1 which removes the ID from the internal list + before unloading the engine. + </p> + <code> + 6> crypto:ensure_engine_unloaded(<<"MD5">>). + ok</code> + </section> + + + + <section> <title>List all engines currently loaded</title> <code> 5> crypto:engine_list(). |