From 6f9a6ff71554fb1061857515d470cf8eb769259c Mon Sep 17 00:00:00 2001 From: schwarze <> Date: Sat, 10 Dec 2016 22:30:54 +0000 Subject: Merge one sentence and the references from dh(3) to DH_new(3) and discard the rest of the text. There is no value in documenting some of the fields of a structure and then going on to say that the structure is intended as opaque. Besides, i doubt that we want such strong marketing of ENGINE support. --- src/lib/libcrypto/man/DH_new.3 | 14 ++++++++-- src/lib/libcrypto/man/Makefile | 3 +- src/lib/libcrypto/man/dh.3 | 62 ------------------------------------------ 3 files changed, 12 insertions(+), 67 deletions(-) delete mode 100644 src/lib/libcrypto/man/dh.3 (limited to 'src/lib/libcrypto') diff --git a/src/lib/libcrypto/man/DH_new.3 b/src/lib/libcrypto/man/DH_new.3 index a9335fcb21..28f1888c01 100644 --- a/src/lib/libcrypto/man/DH_new.3 +++ b/src/lib/libcrypto/man/DH_new.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: DH_new.3,v 1.3 2016/11/21 11:44:35 schwarze Exp $ +.\" $OpenBSD: DH_new.3,v 1.4 2016/12/10 22:30:54 schwarze Exp $ .\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 .\" .\" This file was written by Ulf Moeller . @@ -48,7 +48,7 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED .\" OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.Dd $Mdocdate: November 21 2016 $ +.Dd $Mdocdate: December 10 2016 $ .Dt DH_NEW 3 .Os .Sh NAME @@ -64,6 +64,8 @@ .Fa "DH *dh" .Fc .Sh DESCRIPTION +The DH functions implement the Diffie-Hellman key agreement protocol. +.Pp .Fn DH_new allocates and initializes a .Vt DH @@ -88,9 +90,15 @@ and sets an error code that can be obtained by .Xr ERR_get_error 3 . Otherwise it returns a pointer to the newly allocated structure. .Sh SEE ALSO -.Xr dh 3 , +.Xr BN_new 3 , +.Xr d2i_DHparams 3 , .Xr DH_generate_key 3 , .Xr DH_generate_parameters 3 , +.Xr DH_get_ex_new_index 3 , +.Xr DH_set_method 3 , +.Xr DH_size 3 , +.Xr DHparams_print 3 , +.Xr DSA_dup_DH 3 , .Xr ERR_get_error 3 .Sh HISTORY .Fn DH_new diff --git a/src/lib/libcrypto/man/Makefile b/src/lib/libcrypto/man/Makefile index e09095dc62..bdf5232212 100644 --- a/src/lib/libcrypto/man/Makefile +++ b/src/lib/libcrypto/man/Makefile @@ -1,4 +1,4 @@ -# $OpenBSD: Makefile,v 1.69 2016/12/10 21:17:09 schwarze Exp $ +# $OpenBSD: Makefile,v 1.70 2016/12/10 22:30:54 schwarze Exp $ .include @@ -213,7 +213,6 @@ MAN= \ d2i_X509_REQ.3 \ d2i_X509_SIG.3 \ des_read_pw.3 \ - dh.3 \ dsa.3 \ ec.3 \ engine.3 \ diff --git a/src/lib/libcrypto/man/dh.3 b/src/lib/libcrypto/man/dh.3 deleted file mode 100644 index 7429a4b6cf..0000000000 --- a/src/lib/libcrypto/man/dh.3 +++ /dev/null @@ -1,62 +0,0 @@ -.\" $OpenBSD: dh.3,v 1.4 2016/12/10 21:13:25 schwarze Exp $ -.\" -.Dd $Mdocdate: December 10 2016 $ -.Dt DH 3 -.Os -.Sh NAME -.Nm dh -.Nd Diffie-Hellman key agreement -.Sh SYNOPSIS -.In openssl/dh.h -.Sh DESCRIPTION -These functions implement the Diffie-Hellman key agreement protocol. -The generation of shared DH parameters is described in -.Xr DH_generate_parameters 3 ; -.Xr DH_generate_key 3 -describes how to perform a key agreement. -.Pp -The -.Vt DH -structure consists of several -.Vt BIGNUM -components. -.Bd -literal -typedef struct { - BIGNUM *p; // prime number (shared) - BIGNUM *g; // generator of Z_p (shared) - BIGNUM *priv_key; // private DH value x - BIGNUM *pub_key; // public DH value g^x - // ... -} DH; -.Ed -.Pp -Note that DH keys may use non-standard -.Vt DH_METHOD -implementations, either directly or by the use of -.Vt ENGINE -modules. -In some cases (e.g. an -.Vt ENGINE -providing support for hardware-embedded keys), these -.Vt BIGNUM -values will not be used by the implementation or may be used for -alternative data storage. -For this reason, applications should generally avoid using -.Vt DH -structure elements directly and instead use API functions to query -or modify keys. -.Sh SEE ALSO -.Xr BN_new 3 , -.Xr d2i_DHparams 3 , -.Xr DH_generate_key 3 , -.Xr DH_generate_parameters 3 , -.Xr DH_get_ex_new_index 3 , -.Xr DH_new 3 , -.Xr DH_set_method 3 , -.Xr DH_size 3 , -.Xr DHparams_print 3 , -.Xr dsa 3 , -.Xr DSA_dup_DH 3 , -.Xr engine 3 , -.Xr ERR 3 , -.Xr rsa 3 -- cgit v1.2.3-55-g6feb