Document DH_get0_* for individual DH members.

author: tb <> 2023-03-06 13:25:46 +0000
committer: tb <> 2023-03-06 13:25:46 +0000
commit: 5baf747959849f87460fd5a4da03de36db526948 (patch)
tree: 2554f6f26a344a18f1a0611161275a752559ebfc
parent: 1a295aa91cd4f8eff4b3e040e2494be8d5819187 (diff)
download: openbsd-5baf747959849f87460fd5a4da03de36db526948.tar.gz
openbsd-5baf747959849f87460fd5a4da03de36db526948.tar.bz2
openbsd-5baf747959849f87460fd5a4da03de36db526948.zip
1 files changed, 78 insertions, 3 deletions
diff --git a/src/lib/libcrypto/man/DH_get0_pqg.3 b/src/lib/libcrypto/man/DH_get0_pqg.3
index b7dccfc9ac..340d50757b 100644
--- a/src/lib/libcrypto/man/DH_get0_pqg.3
+++ b/src/lib/libcrypto/man/DH_get0_pqg.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: DH_get0_pqg.3,v 1.6 2022/07/13 21:51:35 schwarze Exp $
+.\" $OpenBSD: DH_get0_pqg.3,v 1.7 2023/03/06 13:25:46 tb Exp $
 .\" selective merge up to: OpenSSL 83cf7abf May 29 13:07:08 2018 +0100
 .\"
 .\" This file was written by Matt Caswell <matt@openssl.org>.
@@ -48,13 +48,18 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: July 13 2022 $
+.Dd $Mdocdate: March 6 2023 $
 .Dt DH_GET0_PQG 3
 .Os
 .Sh NAME
 .Nm DH_get0_pqg ,
+.Nm DH_get0_p ,
+.Nm DH_get0_q ,
+.Nm DH_get0_g ,
 .Nm DH_set0_pqg ,
 .Nm DH_get0_key ,
+.Nm DH_get0_pub_key ,
+.Nm DH_get0_priv_key ,
 .Nm DH_set0_key ,
 .Nm DH_clear_flags ,
 .Nm DH_test_flags ,
@@ -71,6 +76,18 @@
 .Fa "const BIGNUM **q"
 .Fa "const BIGNUM **g"
 .Fc
+.Ft "const BIGNUM *"
+.Fo DH_get0_p
+.Fa "const DH *dh"
+.Fc
+.Ft "const BIGNUM *"
+.Fo DH_get0_q
+.Fa "const DH *dh"
+.Fc
+.Ft "const BIGNUM *"
+.Fo DH_get0_g
+.Fa "const DH *dh"
+.Fc
 .Ft int
 .Fo DH_set0_pqg
 .Fa "DH *dh"
@@ -84,6 +101,14 @@
 .Fa "const BIGNUM **pub_key"
 .Fa "const BIGNUM **priv_key"
 .Fc
+.Ft "const BIGNUM *"
+.Fo DH_get0_pub_key
+.Fa "const DH *dh"
+.Fc
+.Ft "const BIGNUM *"
+.Fo DH_get0_priv_key
+.Fa "const DH *dh"
+.Fc
 .Ft int
 .Fo DH_set0_key
 .Fa "DH *dh"
@@ -211,6 +236,25 @@ If needed, duplicate the received values using
 .Xr BN_dup 3
 and pass the duplicates.
 .Pp
+Any of the values
+.Fa p ,
+.Fa q ,
+.Fa g ,
+.Fa pub_key ,
+and
+.Fa priv_key
+can also be retrieved separately by the corresponding functions
+.Fn DH_get0_p ,
+.Fn DH_get0_q ,
+.Fn DH_get0_g ,
+.Fn DH_get0_pub_key ,
+and
+.Fn DH_get0_priv_key ,
+respectively.
+The pointers are owned by the
+.Vt DH
+object.
+.Pp
 .Fn DH_clear_flags
 clears the specified
 .Fa flags
@@ -236,6 +280,17 @@ sets the optional length attribute of
 indicating the length of the secret exponent (private key) in bits.
 If the length attribute is non-zero, it is used, otherwise it is ignored.
 .Sh RETURN VALUES
+.Fn DH_get0_p ,
+.Fn DH_get0_q ,
+.Fn DH_get0_g ,
+.Fn DH_get0_pub_key ,
+and
+.Fn DH_get0_priv_key ,
+return a pointer owned by the
+.Vt DH
+object if the corresponding value has been set,
+otherwise they return
+.Dv NULL .
 .Fn DH_set0_pqg ,
 .Fn DH_set0_key ,
 and
@@ -269,6 +324,26 @@ if no engine was set for this object.
 .Xr DH_size 3 ,
 .Xr DHparams_print 3
 .Sh HISTORY
-These functions first appeared in OpenSSL 1.1.0
+.Fn DH_get0_pqg ,
+.Fn DH_set0_pqg ,
+.Fn DH_get0_key ,
+.Fn DH_set0_key ,
+.Fn DH_clear_flags ,
+.Fn DH_test_flags ,
+.Fn DH_set_flags ,
+.Fn DH_get0_engine ,
+and
+.Fn DH_set_length
+first appeared in OpenSSL 1.1.0
 and have been available since
 .Ox 6.3 .
+.Pp
+.Fn DH_get0_p ,
+.Fn DH_get0_q ,
+.Fn DH_get0_g ,
+.Fn DH_get0_pub_key ,
+and
+.Fn DH_get0_priv_key
+first appeared in OpenSSL 1.1.1
+and have been available since
+.Ox 7.1 .
author	tb <>	2023-03-06 13:25:46 +0000
committer	tb <>	2023-03-06 13:25:46 +0000
commit	5baf747959849f87460fd5a4da03de36db526948 (patch)
tree	2554f6f26a344a18f1a0611161275a752559ebfc
parent	1a295aa91cd4f8eff4b3e040e2494be8d5819187 (diff)
download	openbsd-5baf747959849f87460fd5a4da03de36db526948.tar.gz openbsd-5baf747959849f87460fd5a4da03de36db526948.tar.bz2 openbsd-5baf747959849f87460fd5a4da03de36db526948.zip

diff --git a/src/lib/libcrypto/man/DH_get0_pqg.3 b/src/lib/libcrypto/man/DH_get0_pqg.3 index b7dccfc9ac..340d50757b 100644 --- a/src/lib/libcrypto/man/DH_get0_pqg.3 +++ b/src/lib/libcrypto/man/DH_get0_pqg.3
@@ -1,4 +1,4 @@
1	.\" $OpenBSD: DH_get0_pqg.3,v 1.6 2022/07/13 21:51:35 schwarze Exp $	1	.\" $OpenBSD: DH_get0_pqg.3,v 1.7 2023/03/06 13:25:46 tb Exp $
2	.\" selective merge up to: OpenSSL 83cf7abf May 29 13:07:08 2018 +0100	2	.\" selective merge up to: OpenSSL 83cf7abf May 29 13:07:08 2018 +0100
3	.\"	3	.\"
4	.\" This file was written by Matt Caswell <matt@openssl.org>.	4	.\" This file was written by Matt Caswell <matt@openssl.org>.
@@ -48,13 +48,18 @@
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: July 13 2022 $	51	.Dd $Mdocdate: March 6 2023 $
52	.Dt DH_GET0_PQG 3	52	.Dt DH_GET0_PQG 3
53	.Os	53	.Os
54	.Sh NAME	54	.Sh NAME
55	.Nm DH_get0_pqg ,	55	.Nm DH_get0_pqg ,
		56	.Nm DH_get0_p ,
		57	.Nm DH_get0_q ,
		58	.Nm DH_get0_g ,
56	.Nm DH_set0_pqg ,	59	.Nm DH_set0_pqg ,
57	.Nm DH_get0_key ,	60	.Nm DH_get0_key ,
		61	.Nm DH_get0_pub_key ,
		62	.Nm DH_get0_priv_key ,
58	.Nm DH_set0_key ,	63	.Nm DH_set0_key ,
59	.Nm DH_clear_flags ,	64	.Nm DH_clear_flags ,
60	.Nm DH_test_flags ,	65	.Nm DH_test_flags ,
@@ -71,6 +76,18 @@
71	.Fa "const BIGNUM **q"	76	.Fa "const BIGNUM **q"
72	.Fa "const BIGNUM **g"	77	.Fa "const BIGNUM **g"
73	.Fc	78	.Fc
		79	.Ft "const BIGNUM *"
		80	.Fo DH_get0_p
		81	.Fa "const DH *dh"
		82	.Fc
		83	.Ft "const BIGNUM *"
		84	.Fo DH_get0_q
		85	.Fa "const DH *dh"
		86	.Fc
		87	.Ft "const BIGNUM *"
		88	.Fo DH_get0_g
		89	.Fa "const DH *dh"
		90	.Fc
74	.Ft int	91	.Ft int
75	.Fo DH_set0_pqg	92	.Fo DH_set0_pqg
76	.Fa "DH *dh"	93	.Fa "DH *dh"
@@ -84,6 +101,14 @@
84	.Fa "const BIGNUM **pub_key"	101	.Fa "const BIGNUM **pub_key"
85	.Fa "const BIGNUM **priv_key"	102	.Fa "const BIGNUM **priv_key"
86	.Fc	103	.Fc
		104	.Ft "const BIGNUM *"
		105	.Fo DH_get0_pub_key
		106	.Fa "const DH *dh"
		107	.Fc
		108	.Ft "const BIGNUM *"
		109	.Fo DH_get0_priv_key
		110	.Fa "const DH *dh"
		111	.Fc
87	.Ft int	112	.Ft int
88	.Fo DH_set0_key	113	.Fo DH_set0_key
89	.Fa "DH *dh"	114	.Fa "DH *dh"
@@ -211,6 +236,25 @@ If needed, duplicate the received values using
211	.Xr BN_dup 3	236	.Xr BN_dup 3
212	and pass the duplicates.	237	and pass the duplicates.
213	.Pp	238	.Pp
		239	Any of the values
		240	.Fa p ,
		241	.Fa q ,
		242	.Fa g ,
		243	.Fa pub_key ,
		244	and
		245	.Fa priv_key
		246	can also be retrieved separately by the corresponding functions
		247	.Fn DH_get0_p ,
		248	.Fn DH_get0_q ,
		249	.Fn DH_get0_g ,
		250	.Fn DH_get0_pub_key ,
		251	and
		252	.Fn DH_get0_priv_key ,
		253	respectively.
		254	The pointers are owned by the
		255	.Vt DH
		256	object.
		257	.Pp
214	.Fn DH_clear_flags	258	.Fn DH_clear_flags
215	clears the specified	259	clears the specified
216	.Fa flags	260	.Fa flags
@@ -236,6 +280,17 @@ sets the optional length attribute of
236	indicating the length of the secret exponent (private key) in bits.	280	indicating the length of the secret exponent (private key) in bits.
237	If the length attribute is non-zero, it is used, otherwise it is ignored.	281	If the length attribute is non-zero, it is used, otherwise it is ignored.
238	.Sh RETURN VALUES	282	.Sh RETURN VALUES
		283	+.Fn DH_get0_p ,
		284	+.Fn DH_get0_q ,
		285	+.Fn DH_get0_g ,
		286	+.Fn DH_get0_pub_key ,
		287	+and
		288	+.Fn DH_get0_priv_key ,
		289	+return a pointer owned by the
		290	+.Vt DH
		291	+object if the corresponding value has been set,
		292	+otherwise they return
		293	+.Dv NULL .
239	.Fn DH_set0_pqg ,	294	.Fn DH_set0_pqg ,
240	.Fn DH_set0_key ,	295	.Fn DH_set0_key ,
241	and	296	and
@@ -269,6 +324,26 @@ if no engine was set for this object.
269	.Xr DH_size 3 ,	324	.Xr DH_size 3 ,
270	.Xr DHparams_print 3	325	.Xr DHparams_print 3
271	.Sh HISTORY	326	.Sh HISTORY
272	These functions first appeared in OpenSSL 1.1.0	327	.Fn DH_get0_pqg ,
		328	.Fn DH_set0_pqg ,
		329	.Fn DH_get0_key ,
		330	.Fn DH_set0_key ,
		331	.Fn DH_clear_flags ,
		332	.Fn DH_test_flags ,
		333	.Fn DH_set_flags ,
		334	.Fn DH_get0_engine ,
		335	and
		336	.Fn DH_set_length
		337	first appeared in OpenSSL 1.1.0
273	and have been available since	338	and have been available since
274	.Ox 6.3 .	339	.Ox 6.3 .
		340	.Pp
		341	.Fn DH_get0_p ,
		342	.Fn DH_get0_q ,
		343	.Fn DH_get0_g ,
		344	.Fn DH_get0_pub_key ,
		345	and
		346	.Fn DH_get0_priv_key
		347	first appeared in OpenSSL 1.1.1
		348	and have been available since
		349	.Ox 7.1 .