diff options
-rw-r--r-- | src/lib/libcrypto/man/engine.3 | 74 |
1 files changed, 54 insertions, 20 deletions
diff --git a/src/lib/libcrypto/man/engine.3 b/src/lib/libcrypto/man/engine.3 index 3d93c6fbb4..5b7cad4321 100644 --- a/src/lib/libcrypto/man/engine.3 +++ b/src/lib/libcrypto/man/engine.3 | |||
@@ -1,6 +1,55 @@ | |||
1 | .\" $OpenBSD: engine.3,v 1.4 2016/11/06 17:28:06 jmc Exp $ | 1 | .\" $OpenBSD: engine.3,v 1.5 2016/11/22 12:32:07 schwarze Exp $ |
2 | .\" OpenSSL a528d4f0 Oct 27 13:40:11 2015 -0400 | ||
2 | .\" | 3 | .\" |
3 | .Dd $Mdocdate: November 6 2016 $ | 4 | .\" This file was written by Geoff Thorpe <geoff@openssl.org>. |
5 | .\" Copyright (c) 2002, 2004, 2007, 2015 The OpenSSL Project. | ||
6 | .\" All rights reserved. | ||
7 | .\" | ||
8 | .\" Redistribution and use in source and binary forms, with or without | ||
9 | .\" modification, are permitted provided that the following conditions | ||
10 | .\" are met: | ||
11 | .\" | ||
12 | .\" 1. Redistributions of source code must retain the above copyright | ||
13 | .\" notice, this list of conditions and the following disclaimer. | ||
14 | .\" | ||
15 | .\" 2. Redistributions in binary form must reproduce the above copyright | ||
16 | .\" notice, this list of conditions and the following disclaimer in | ||
17 | .\" the documentation and/or other materials provided with the | ||
18 | .\" distribution. | ||
19 | .\" | ||
20 | .\" 3. All advertising materials mentioning features or use of this | ||
21 | .\" software must display the following acknowledgment: | ||
22 | .\" "This product includes software developed by the OpenSSL Project | ||
23 | .\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" | ||
24 | .\" | ||
25 | .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to | ||
26 | .\" endorse or promote products derived from this software without | ||
27 | .\" prior written permission. For written permission, please contact | ||
28 | .\" openssl-core@openssl.org. | ||
29 | .\" | ||
30 | .\" 5. Products derived from this software may not be called "OpenSSL" | ||
31 | .\" nor may "OpenSSL" appear in their names without prior written | ||
32 | .\" permission of the OpenSSL Project. | ||
33 | .\" | ||
34 | .\" 6. Redistributions of any form whatsoever must retain the following | ||
35 | .\" acknowledgment: | ||
36 | .\" "This product includes software developed by the OpenSSL Project | ||
37 | .\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" | ||
38 | .\" | ||
39 | .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY | ||
40 | .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
41 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
42 | .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR | ||
43 | .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
44 | .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT | ||
45 | .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
46 | .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
47 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | ||
48 | .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
49 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | ||
50 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | ||
51 | .\" | ||
52 | .Dd $Mdocdate: November 22 2016 $ | ||
4 | .Dt ENGINE 3 | 53 | .Dt ENGINE 3 |
5 | .Os | 54 | .Os |
6 | .Sh NAME | 55 | .Sh NAME |
@@ -552,7 +601,7 @@ If you have a functional reference to an | |||
552 | .Vt ENGINE , | 601 | .Vt ENGINE , |
553 | you have a guarantee that the | 602 | you have a guarantee that the |
554 | .Vt ENGINE | 603 | .Vt ENGINE |
555 | has been initialised ready to perform cryptographic operations and | 604 | has been initialised and is ready to perform cryptographic operations and |
556 | will remain uninitialised until after you have released your | 605 | will remain uninitialised until after you have released your |
557 | reference. | 606 | reference. |
558 | .Pp | 607 | .Pp |
@@ -852,7 +901,7 @@ admin to want to use the "ACME" | |||
852 | if it is available in the version of OpenSSL the application was | 901 | if it is available in the version of OpenSSL the application was |
853 | compiled with. | 902 | compiled with. |
854 | If it is available, it should be used by default for all RSA, DSA, and | 903 | If it is available, it should be used by default for all RSA, DSA, and |
855 | symmetric cipher operation, otherwise OpenSSL should use its builtin | 904 | symmetric cipher operations, otherwise OpenSSL should use its builtin |
856 | software as usual. | 905 | software as usual. |
857 | The following code illustrates how to approach this: | 906 | The following code illustrates how to approach this: |
858 | .Bd -literal | 907 | .Bd -literal |
@@ -887,7 +936,7 @@ Here we'll assume we want to load and register all | |||
887 | implementations bundled with OpenSSL, such that for any cryptographic | 936 | implementations bundled with OpenSSL, such that for any cryptographic |
888 | algorithm required by OpenSSL - if there is an | 937 | algorithm required by OpenSSL - if there is an |
889 | .Vt ENGINE | 938 | .Vt ENGINE |
890 | that implements it and can be initialise, it should be used. | 939 | that implements it and can be initialised, it should be used. |
891 | The following code illustrates how this can work; | 940 | The following code illustrates how this can work; |
892 | .Bd -literal | 941 | .Bd -literal |
893 | /* Load all bundled ENGINEs into memory and make them visible */ | 942 | /* Load all bundled ENGINEs into memory and make them visible */ |
@@ -1167,21 +1216,6 @@ to see if they implement "FOO_GET_VENDOR_LOGO_GIF" - and | |||
1167 | .Vt ENGINE | 1216 | .Vt ENGINE |
1168 | could therefore decide whether or not to support this "foo"-specific | 1217 | could therefore decide whether or not to support this "foo"-specific |
1169 | extension). | 1218 | extension). |
1170 | .Ss Future developments | ||
1171 | The | ||
1172 | .Nm engine | ||
1173 | API and internal architecture is currently being reviewed. | ||
1174 | Slated for possible release in 0.9.8 is support for transparent loading | ||
1175 | of "dynamic" | ||
1176 | .Vt ENGINE Ns s | ||
1177 | (built as self-contained shared libraries). | ||
1178 | This would allow | ||
1179 | .Vt ENGINE | ||
1180 | implementations to be provided independently of | ||
1181 | OpenSSL libraries and/or OpenSSL-based applications, and would also | ||
1182 | remove any requirement for applications to explicitly use the "dynamic" | ||
1183 | .Vt ENGINE | ||
1184 | to bind to shared-library implementations. | ||
1185 | .Sh SEE ALSO | 1219 | .Sh SEE ALSO |
1186 | .Xr dh 3 , | 1220 | .Xr dh 3 , |
1187 | .Xr dsa 3 , | 1221 | .Xr dsa 3 , |