summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorschwarze <>2016-12-10 22:30:54 +0000
committerschwarze <>2016-12-10 22:30:54 +0000
commit6f9a6ff71554fb1061857515d470cf8eb769259c (patch)
tree9ef41372115ff103ed9112ef71e40afc5a8f74ca
parentc3b28403d3f080df57a3716f3e49c2f59c71101a (diff)
downloadopenbsd-6f9a6ff71554fb1061857515d470cf8eb769259c.tar.gz
openbsd-6f9a6ff71554fb1061857515d470cf8eb769259c.tar.bz2
openbsd-6f9a6ff71554fb1061857515d470cf8eb769259c.zip
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.
-rw-r--r--src/lib/libcrypto/man/DH_new.314
-rw-r--r--src/lib/libcrypto/man/Makefile3
-rw-r--r--src/lib/libcrypto/man/dh.362
3 files changed, 12 insertions, 67 deletions
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 @@
1.\" $OpenBSD: DH_new.3,v 1.3 2016/11/21 11:44:35 schwarze Exp $ 1.\" $OpenBSD: DH_new.3,v 1.4 2016/12/10 22:30:54 schwarze Exp $
2.\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 2.\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
3.\" 3.\"
4.\" This file was written by Ulf Moeller <ulf@openssl.org>. 4.\" This file was written by Ulf Moeller <ulf@openssl.org>.
@@ -48,7 +48,7 @@
48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49.\" OF THE POSSIBILITY OF SUCH DAMAGE. 49.\" OF THE POSSIBILITY OF SUCH DAMAGE.
50.\" 50.\"
51.Dd $Mdocdate: November 21 2016 $ 51.Dd $Mdocdate: December 10 2016 $
52.Dt DH_NEW 3 52.Dt DH_NEW 3
53.Os 53.Os
54.Sh NAME 54.Sh NAME
@@ -64,6 +64,8 @@
64.Fa "DH *dh" 64.Fa "DH *dh"
65.Fc 65.Fc
66.Sh DESCRIPTION 66.Sh DESCRIPTION
67The DH functions implement the Diffie-Hellman key agreement protocol.
68.Pp
67.Fn DH_new 69.Fn DH_new
68allocates and initializes a 70allocates and initializes a
69.Vt DH 71.Vt DH
@@ -88,9 +90,15 @@ and sets an error code that can be obtained by
88.Xr ERR_get_error 3 . 90.Xr ERR_get_error 3 .
89Otherwise it returns a pointer to the newly allocated structure. 91Otherwise it returns a pointer to the newly allocated structure.
90.Sh SEE ALSO 92.Sh SEE ALSO
91.Xr dh 3 , 93.Xr BN_new 3 ,
94.Xr d2i_DHparams 3 ,
92.Xr DH_generate_key 3 , 95.Xr DH_generate_key 3 ,
93.Xr DH_generate_parameters 3 , 96.Xr DH_generate_parameters 3 ,
97.Xr DH_get_ex_new_index 3 ,
98.Xr DH_set_method 3 ,
99.Xr DH_size 3 ,
100.Xr DHparams_print 3 ,
101.Xr DSA_dup_DH 3 ,
94.Xr ERR_get_error 3 102.Xr ERR_get_error 3
95.Sh HISTORY 103.Sh HISTORY
96.Fn DH_new 104.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 @@
1# $OpenBSD: Makefile,v 1.69 2016/12/10 21:17:09 schwarze Exp $ 1# $OpenBSD: Makefile,v 1.70 2016/12/10 22:30:54 schwarze Exp $
2 2
3.include <bsd.own.mk> 3.include <bsd.own.mk>
4 4
@@ -213,7 +213,6 @@ MAN= \
213 d2i_X509_REQ.3 \ 213 d2i_X509_REQ.3 \
214 d2i_X509_SIG.3 \ 214 d2i_X509_SIG.3 \
215 des_read_pw.3 \ 215 des_read_pw.3 \
216 dh.3 \
217 dsa.3 \ 216 dsa.3 \
218 ec.3 \ 217 ec.3 \
219 engine.3 \ 218 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 @@
1.\" $OpenBSD: dh.3,v 1.4 2016/12/10 21:13:25 schwarze Exp $
2.\"
3.Dd $Mdocdate: December 10 2016 $
4.Dt DH 3
5.Os
6.Sh NAME
7.Nm dh
8.Nd Diffie-Hellman key agreement
9.Sh SYNOPSIS
10.In openssl/dh.h
11.Sh DESCRIPTION
12These functions implement the Diffie-Hellman key agreement protocol.
13The generation of shared DH parameters is described in
14.Xr DH_generate_parameters 3 ;
15.Xr DH_generate_key 3
16describes how to perform a key agreement.
17.Pp
18The
19.Vt DH
20structure consists of several
21.Vt BIGNUM
22components.
23.Bd -literal
24typedef struct {
25 BIGNUM *p; // prime number (shared)
26 BIGNUM *g; // generator of Z_p (shared)
27 BIGNUM *priv_key; // private DH value x
28 BIGNUM *pub_key; // public DH value g^x
29 // ...
30} DH;
31.Ed
32.Pp
33Note that DH keys may use non-standard
34.Vt DH_METHOD
35implementations, either directly or by the use of
36.Vt ENGINE
37modules.
38In some cases (e.g. an
39.Vt ENGINE
40providing support for hardware-embedded keys), these
41.Vt BIGNUM
42values will not be used by the implementation or may be used for
43alternative data storage.
44For this reason, applications should generally avoid using
45.Vt DH
46structure elements directly and instead use API functions to query
47or modify keys.
48.Sh SEE ALSO
49.Xr BN_new 3 ,
50.Xr d2i_DHparams 3 ,
51.Xr DH_generate_key 3 ,
52.Xr DH_generate_parameters 3 ,
53.Xr DH_get_ex_new_index 3 ,
54.Xr DH_new 3 ,
55.Xr DH_set_method 3 ,
56.Xr DH_size 3 ,
57.Xr DHparams_print 3 ,
58.Xr dsa 3 ,
59.Xr DSA_dup_DH 3 ,
60.Xr engine 3 ,
61.Xr ERR 3 ,
62.Xr rsa 3