summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@cvs.openbsd.org>2016-11-22 12:32:08 +0000
committerIngo Schwarze <schwarze@cvs.openbsd.org>2016-11-22 12:32:08 +0000
commitf7dc2043e60a1d425fb1cf1617fdbb6bd469b70c (patch)
treef20c5b94eb43a8c045e93f87ee751ce2c47ea028 /lib
parent8314bfaf4cc9e01b152b3aeebd4f9093ea73b731 (diff)
Add Copyright and license.
Pull in a small number of typo fixes from OpenSSL. Drop speculations about future developments that OpenSSL deleted as well. This page is a mess for at least three reasons: (1) it doesn't actually document all functions listed in the SYNOPSIS, (2) it ought to be split into functional groups of reasonable size, and (3) the user interface is ill-designed to the point of absurdity. In view of item (3), i'm loath to tackle items (1) and (2), so i'm leaving this in its present sorry state for now, refraining even from renaming it to ENGINE_add(3) and expanding the NAME section as OpenSSL did - because that would merely sweep all the turds under the rug.
Diffstat (limited to 'lib')
-rw-r--r--lib/libcrypto/man/engine.374
1 files changed, 54 insertions, 20 deletions
diff --git a/lib/libcrypto/man/engine.3 b/lib/libcrypto/man/engine.3
index 3d93c6fbb4b..5b7cad43211 100644
--- a/lib/libcrypto/man/engine.3
+++ b/lib/libcrypto/man/engine.3
@@ -1,6 +1,55 @@
-.\" $OpenBSD: engine.3,v 1.4 2016/11/06 17:28:06 jmc Exp $
+.\" $OpenBSD: engine.3,v 1.5 2016/11/22 12:32:07 schwarze Exp $
+.\" OpenSSL a528d4f0 Oct 27 13:40:11 2015 -0400
.\"
-.Dd $Mdocdate: November 6 2016 $
+.\" This file was written by Geoff Thorpe <geoff@openssl.org>.
+.\" Copyright (c) 2002, 2004, 2007, 2015 The OpenSSL Project.
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\"
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\"
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in
+.\" the documentation and/or other materials provided with the
+.\" distribution.
+.\"
+.\" 3. All advertising materials mentioning features or use of this
+.\" software must display the following acknowledgment:
+.\" "This product includes software developed by the OpenSSL Project
+.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
+.\"
+.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
+.\" endorse or promote products derived from this software without
+.\" prior written permission. For written permission, please contact
+.\" openssl-core@openssl.org.
+.\"
+.\" 5. Products derived from this software may not be called "OpenSSL"
+.\" nor may "OpenSSL" appear in their names without prior written
+.\" permission of the OpenSSL Project.
+.\"
+.\" 6. Redistributions of any form whatsoever must retain the following
+.\" acknowledgment:
+.\" "This product includes software developed by the OpenSSL Project
+.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)"
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
+.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
+.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+.\" OF THE POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd $Mdocdate: November 22 2016 $
.Dt ENGINE 3
.Os
.Sh NAME
@@ -552,7 +601,7 @@ If you have a functional reference to an
.Vt ENGINE ,
you have a guarantee that the
.Vt ENGINE
-has been initialised ready to perform cryptographic operations and
+has been initialised and is ready to perform cryptographic operations and
will remain uninitialised until after you have released your
reference.
.Pp
@@ -852,7 +901,7 @@ admin to want to use the "ACME"
if it is available in the version of OpenSSL the application was
compiled with.
If it is available, it should be used by default for all RSA, DSA, and
-symmetric cipher operation, otherwise OpenSSL should use its builtin
+symmetric cipher operations, otherwise OpenSSL should use its builtin
software as usual.
The following code illustrates how to approach this:
.Bd -literal
@@ -887,7 +936,7 @@ Here we'll assume we want to load and register all
implementations bundled with OpenSSL, such that for any cryptographic
algorithm required by OpenSSL - if there is an
.Vt ENGINE
-that implements it and can be initialise, it should be used.
+that implements it and can be initialised, it should be used.
The following code illustrates how this can work;
.Bd -literal
/* 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
.Vt ENGINE
could therefore decide whether or not to support this "foo"-specific
extension).
-.Ss Future developments
-The
-.Nm engine
-API and internal architecture is currently being reviewed.
-Slated for possible release in 0.9.8 is support for transparent loading
-of "dynamic"
-.Vt ENGINE Ns s
-(built as self-contained shared libraries).
-This would allow
-.Vt ENGINE
-implementations to be provided independently of
-OpenSSL libraries and/or OpenSSL-based applications, and would also
-remove any requirement for applications to explicitly use the "dynamic"
-.Vt ENGINE
-to bind to shared-library implementations.
.Sh SEE ALSO
.Xr dh 3 ,
.Xr dsa 3 ,