summaryrefslogtreecommitdiff
path: root/lib/libcrypto/man
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@cvs.openbsd.org>2016-11-22 01:38:50 +0000
committerIngo Schwarze <schwarze@cvs.openbsd.org>2016-11-22 01:38:50 +0000
commitf7d5f34f6caf9963cd14755723ef6ce85df99a6c (patch)
tree0d60e9f78896fedbe9d7f1acb6fc51b057a8c11a /lib/libcrypto/man
parentaa1adb0268eddeb44d33e12887f247c355e1ff70 (diff)
Add Copyright and license.
Mention that EC_KEY_free(3) accepts NULL. Merge some auxiliary explanations regarding the effects of EC_KEY encoding flags, lifted from the separate page EC_KEY_get_enc_flags(3) that OpenSSL split off from EC_KEY_new(3).
Diffstat (limited to 'lib/libcrypto/man')
-rw-r--r--lib/libcrypto/man/EC_KEY_new.376
1 files changed, 74 insertions, 2 deletions
diff --git a/lib/libcrypto/man/EC_KEY_new.3 b/lib/libcrypto/man/EC_KEY_new.3
index 20fefc7caf0..e338012bf79 100644
--- a/lib/libcrypto/man/EC_KEY_new.3
+++ b/lib/libcrypto/man/EC_KEY_new.3
@@ -1,6 +1,54 @@
-.\" $OpenBSD: EC_KEY_new.3,v 1.5 2016/11/15 09:25:45 jmc Exp $
+.\" $OpenBSD: EC_KEY_new.3,v 1.6 2016/11/22 01:38:49 schwarze Exp $
+.\" OpenSSL d900a015 Oct 8 14:40:42 2015 +0200
.\"
-.Dd $Mdocdate: November 15 2016 $
+.\" This file was written by Matt Caswell <matt@openssl.org>.
+.\" Copyright (c) 2013, 2014 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 EC_KEY_NEW 3
.Os
.Sh NAME
@@ -206,6 +254,11 @@ decrements the reference count for the
.Vt EC_KEY
object and, if it has dropped to zero, then frees the memory associated
with it.
+If
+.Fa key
+is a
+.Dv NULL
+pointer, no action occurs.
.Pp
.Fn EC_KEY_copy
copies the contents of the
@@ -302,6 +355,25 @@ If
is set then the public key is not encoded along with the private
key.
.Pp
+The format of the external representation of the public key written by
+.Xr i2d_ECPrivateKey 3 ,
+such as whether it is stored in a compressed form or not,
+is described by the point_conversion_form.
+See
+.Xr EC_GROUP_copy 3
+for a description of point_conversion_form.
+.Pp
+When reading a private key encoded without an associated public key,
+for example if
+.Dv EC_PKEY_NO_PUBKEY
+was used,
+.Xr d2i_ECPrivateKey 3
+generates the missing public key automatically.
+Private keys encoded without parameters, for example if
+.Dv EC_PKEY_NO_PARAMETERS
+was used, cannot be loaded using
+.Xr d2i_ECPrivateKey 3 .
+.Pp
The functions
.Fn EC_KEY_get_conv_form
and