diff options
author | jmc <> | 2016-11-06 15:52:50 +0000 |
---|---|---|
committer | jmc <> | 2016-11-06 15:52:50 +0000 |
commit | 9b30976af18b8a407761e020380b9ed595770866 (patch) | |
tree | d98f3cbf729ef563011a9ca161b7885314ef68d3 /src/lib/libcrypto/man/engine.3 | |
parent | e91a5b9b0b9cb9b6adc699e59a9a6ed06a862192 (diff) | |
download | openbsd-9b30976af18b8a407761e020380b9ed595770866.tar.gz openbsd-9b30976af18b8a407761e020380b9ed595770866.tar.bz2 openbsd-9b30976af18b8a407761e020380b9ed595770866.zip |
first pass; ok schwarze
Diffstat (limited to 'src/lib/libcrypto/man/engine.3')
-rw-r--r-- | src/lib/libcrypto/man/engine.3 | 31 |
1 files changed, 17 insertions, 14 deletions
diff --git a/src/lib/libcrypto/man/engine.3 b/src/lib/libcrypto/man/engine.3 index 3624fa76e4..7ecc5f3bb2 100644 --- a/src/lib/libcrypto/man/engine.3 +++ b/src/lib/libcrypto/man/engine.3 | |||
@@ -1,4 +1,6 @@ | |||
1 | .Dd $Mdocdate: November 5 2016 $ | 1 | .\" $OpenBSD: engine.3,v 1.2 2016/11/06 15:52:50 jmc Exp $ |
2 | .\" | ||
3 | .Dd $Mdocdate: November 6 2016 $ | ||
2 | .Dt ENGINE 3 | 4 | .Dt ENGINE 3 |
3 | .Os | 5 | .Os |
4 | .Sh NAME | 6 | .Sh NAME |
@@ -511,7 +513,7 @@ Due to the modular nature of the | |||
511 | .Nm engine | 513 | .Nm engine |
512 | API, pointers to | 514 | API, pointers to |
513 | .Vt ENGINE Ns s | 515 | .Vt ENGINE Ns s |
514 | need to be treated as handles - ie. not only as pointers, but also | 516 | need to be treated as handles - i.e. not only as pointers, but also |
515 | as references to the underlying | 517 | as references to the underlying |
516 | .Vt ENGINE | 518 | .Vt ENGINE |
517 | object. | 519 | object. |
@@ -527,8 +529,8 @@ At the most basic level, each | |||
527 | pointer is inherently a | 529 | pointer is inherently a |
528 | .Sy structural | 530 | .Sy structural |
529 | reference - a structural reference is required to use the pointer value | 531 | reference - a structural reference is required to use the pointer value |
530 | at all, as this kind of reference is a guarantee that the structure can | 532 | at all, as this kind of reference is a guarantee that the structure cannot |
531 | not be deallocated until the reference is released. | 533 | be deallocated until the reference is released. |
532 | .Pp | 534 | .Pp |
533 | However, a structural reference provides no guarantee that the | 535 | However, a structural reference provides no guarantee that the |
534 | .Vt ENGINE | 536 | .Vt ENGINE |
@@ -653,7 +655,7 @@ function. | |||
653 | This returns zero if the | 655 | This returns zero if the |
654 | .Vt ENGINE | 656 | .Vt ENGINE |
655 | was not already operational and couldn't be successfully initialised | 657 | was not already operational and couldn't be successfully initialised |
656 | (eg. lack of system drivers, no special hardware attached, etc.), | 658 | (e.g. lack of system drivers, no special hardware attached), |
657 | otherwise it will return non-zero to indicate that the | 659 | otherwise it will return non-zero to indicate that the |
658 | .Vt ENGINE | 660 | .Vt ENGINE |
659 | is now operational and will have allocated a new | 661 | is now operational and will have allocated a new |
@@ -665,7 +667,7 @@ All functional references are released by calling | |||
665 | which removes the implicit structural reference as well. | 667 | which removes the implicit structural reference as well. |
666 | .Pp | 668 | .Pp |
667 | The second way to get a functional reference is by asking OpenSSL for a | 669 | The second way to get a functional reference is by asking OpenSSL for a |
668 | default implementation for a given task, eg. | 670 | default implementation for a given task, e.g. |
669 | by | 671 | by |
670 | .Fn ENGINE_get_default_RSA , | 672 | .Fn ENGINE_get_default_RSA , |
671 | .Fn ENGINE_get_default_cipher_engine , | 673 | .Fn ENGINE_get_default_cipher_engine , |
@@ -697,7 +699,7 @@ index. | |||
697 | .Pp | 699 | .Pp |
698 | When a default | 700 | When a default |
699 | .Vt ENGINE | 701 | .Vt ENGINE |
700 | is requested for a given abstraction/algorithm/mode, (eg. when | 702 | is requested for a given abstraction/algorithm/mode, (e.g. when |
701 | calling | 703 | calling |
702 | .Fn RSA_new_method NULL ) , | 704 | .Fn RSA_new_method NULL ) , |
703 | a "get_default" call will be made to the | 705 | a "get_default" call will be made to the |
@@ -781,7 +783,7 @@ code at all. | |||
781 | So the first consideration is whether any/all available | 783 | So the first consideration is whether any/all available |
782 | .Vt ENGINE | 784 | .Vt ENGINE |
783 | implementations should be made visible to OpenSSL. | 785 | implementations should be made visible to OpenSSL. |
784 | This is controlled by calling the various "load" functions, eg. | 786 | This is controlled by calling the various "load" functions, e.g. |
785 | .Fn ENGINE_load_builtin_engines | 787 | .Fn ENGINE_load_builtin_engines |
786 | to make all | 788 | to make all |
787 | .Vt ENGINE | 789 | .Vt ENGINE |
@@ -836,7 +838,7 @@ they want used if any is to be used at all. | |||
836 | Others may prefer to load all support and have OpenSSL automatically use | 838 | Others may prefer to load all support and have OpenSSL automatically use |
837 | at run-time any | 839 | at run-time any |
838 | .Vt ENGINE | 840 | .Vt ENGINE |
839 | that is able to successfully initialised - ie. to assume that this | 841 | that is able to successfully initialised - i.e. to assume that this |
840 | corresponds to acceleration hardware attached to the machine or | 842 | corresponds to acceleration hardware attached to the machine or |
841 | some such thing. | 843 | some such thing. |
842 | There are probably numerous other ways in which applications may prefer | 844 | There are probably numerous other ways in which applications may prefer |
@@ -942,11 +944,11 @@ nothing at all specific to the host system) so that it can be | |||
942 | initialised for use. | 944 | initialised for use. |
943 | This could include the path to any driver or config files it needs to | 945 | This could include the path to any driver or config files it needs to |
944 | load, required network addresses, smart-card identifiers, passwords to | 946 | load, required network addresses, smart-card identifiers, passwords to |
945 | initialise protected devices, logging information, etc etc. | 947 | initialise protected devices, logging information, etc. |
946 | This class of commands typically needs to be passed to an | 948 | This class of commands typically needs to be passed to an |
947 | .Vt ENGINE | 949 | .Vt ENGINE |
948 | .Sy before | 950 | .Sy before |
949 | attempting to initialise it, ie. before calling | 951 | attempting to initialise it, i.e. before calling |
950 | .Fn ENGINE_init . | 952 | .Fn ENGINE_init . |
951 | The other class of commands consist of settings or operations that tweak | 953 | The other class of commands consist of settings or operations that tweak |
952 | certain behaviour or cause certain operations to take place, and these | 954 | certain behaviour or cause certain operations to take place, and these |
@@ -1049,7 +1051,7 @@ using a structural reference. | |||
1049 | Note that some control commands are defined by OpenSSL itself and it | 1051 | Note that some control commands are defined by OpenSSL itself and it |
1050 | will intercept and handle these control commands on behalf of the | 1052 | will intercept and handle these control commands on behalf of the |
1051 | .Vt ENGINE , | 1053 | .Vt ENGINE , |
1052 | ie. the | 1054 | i.e. the |
1053 | .Vt ENGINE Ap s | 1055 | .Vt ENGINE Ap s |
1054 | ctrl() handler is not used for the control command. | 1056 | ctrl() handler is not used for the control command. |
1055 | .In openssl/engine.h | 1057 | .In openssl/engine.h |
@@ -1160,7 +1162,7 @@ arbitrary type. | |||
1160 | These commands are supported in the discovery mechanisms simply allow | 1162 | These commands are supported in the discovery mechanisms simply allow |
1161 | applications to determine if an | 1163 | applications to determine if an |
1162 | .Vt ENGINE | 1164 | .Vt ENGINE |
1163 | supports certain specific commands it might want to use (eg. | 1165 | supports certain specific commands it might want to use (e.g. |
1164 | application "foo" might query various | 1166 | application "foo" might query various |
1165 | .Vt ENGINE Ns s | 1167 | .Vt ENGINE Ns s |
1166 | to see if they implement "FOO_GET_VENDOR_LOGO_GIF" - and | 1168 | to see if they implement "FOO_GET_VENDOR_LOGO_GIF" - and |
@@ -1173,7 +1175,8 @@ The | |||
1173 | API and internal architecture is currently being reviewed. | 1175 | API and internal architecture is currently being reviewed. |
1174 | Slated for possible release in 0.9.8 is support for transparent loading | 1176 | Slated for possible release in 0.9.8 is support for transparent loading |
1175 | of "dynamic" | 1177 | of "dynamic" |
1176 | .Vt ENGINE Ns s (built as self-contained shared libraries). | 1178 | .Vt ENGINE Ns s |
1179 | (built as self-contained shared libraries). | ||
1177 | This would allow | 1180 | This would allow |
1178 | .Vt ENGINE | 1181 | .Vt ENGINE |
1179 | implementations to be provided independently of | 1182 | implementations to be provided independently of |