summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authortb <>2023-07-26 20:08:59 +0000
committertb <>2023-07-26 20:08:59 +0000
commitfa5c0091f4e78c4c6829aa0fb64a17d34a5d05fd (patch)
treec95f1df59ecad7fdc4c29644619e13e6c88a5f7f
parent02dcf97fe6b4150f3dd4ce85e13a39cf5184890a (diff)
downloadopenbsd-fa5c0091f4e78c4c6829aa0fb64a17d34a5d05fd.tar.gz
openbsd-fa5c0091f4e78c4c6829aa0fb64a17d34a5d05fd.tar.bz2
openbsd-fa5c0091f4e78c4c6829aa0fb64a17d34a5d05fd.zip
BN_BLINDING will be made internal-only. Remove its documentation
-rw-r--r--src/lib/libcrypto/man/BN_BLINDING_new.3317
-rw-r--r--src/lib/libcrypto/man/BN_new.35
-rw-r--r--src/lib/libcrypto/man/Makefile3
-rw-r--r--src/lib/libcrypto/man/RSA_blinding_on.35
4 files changed, 5 insertions, 325 deletions
diff --git a/src/lib/libcrypto/man/BN_BLINDING_new.3 b/src/lib/libcrypto/man/BN_BLINDING_new.3
deleted file mode 100644
index 36521d977c..0000000000
--- a/src/lib/libcrypto/man/BN_BLINDING_new.3
+++ /dev/null
@@ -1,317 +0,0 @@
1.\" $OpenBSD: BN_BLINDING_new.3,v 1.12 2023/04/25 20:07:55 tb Exp $
2.\" OpenSSL a528d4f0 Oct 27 13:40:11 2015 -0400
3.\"
4.\" This file was written by Nils Larsch <nils@openssl.org>.
5.\" Copyright (c) 2005, 2008, 2013, 2015 The OpenSSL Project.
6.\" All rights reserved.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\"
12.\" 1. Redistributions of source code must retain the above copyright
13.\" notice, this list of conditions and the following disclaimer.
14.\"
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\" notice, this list of conditions and the following disclaimer in
17.\" the documentation and/or other materials provided with the
18.\" distribution.
19.\"
20.\" 3. All advertising materials mentioning features or use of this
21.\" software must display the following acknowledgment:
22.\" "This product includes software developed by the OpenSSL Project
23.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
24.\"
25.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26.\" endorse or promote products derived from this software without
27.\" prior written permission. For written permission, please contact
28.\" openssl-core@openssl.org.
29.\"
30.\" 5. Products derived from this software may not be called "OpenSSL"
31.\" nor may "OpenSSL" appear in their names without prior written
32.\" permission of the OpenSSL Project.
33.\"
34.\" 6. Redistributions of any form whatsoever must retain the following
35.\" acknowledgment:
36.\" "This product includes software developed by the OpenSSL Project
37.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)"
38.\"
39.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50.\" OF THE POSSIBILITY OF SUCH DAMAGE.
51.\"
52.Dd $Mdocdate: April 25 2023 $
53.Dt BN_BLINDING_NEW 3
54.Os
55.Sh NAME
56.Nm BN_BLINDING_new ,
57.Nm BN_BLINDING_free ,
58.Nm BN_BLINDING_update ,
59.Nm BN_BLINDING_convert ,
60.Nm BN_BLINDING_invert ,
61.Nm BN_BLINDING_convert_ex ,
62.Nm BN_BLINDING_invert_ex ,
63.Nm BN_BLINDING_thread_id ,
64.Nm BN_BLINDING_get_flags ,
65.Nm BN_BLINDING_set_flags ,
66.Nm BN_BLINDING_create_param
67.Nd blinding related BIGNUM functions
68.Sh SYNOPSIS
69.In openssl/bn.h
70.Ft BN_BLINDING *
71.Fo BN_BLINDING_new
72.Fa "const BIGNUM *A"
73.Fa "const BIGNUM *Ai"
74.Fa "BIGNUM *mod"
75.Fc
76.Ft void
77.Fo BN_BLINDING_free
78.Fa "BN_BLINDING *b"
79.Fc
80.Ft int
81.Fo BN_BLINDING_update
82.Fa "BN_BLINDING *b"
83.Fa "BN_CTX *ctx"
84.Fc
85.Ft int
86.Fo BN_BLINDING_convert
87.Fa "BIGNUM *n"
88.Fa "BN_BLINDING *b"
89.Fa "BN_CTX *ctx"
90.Fc
91.Ft int
92.Fo BN_BLINDING_invert
93.Fa "BIGNUM *n"
94.Fa "BN_BLINDING *b"
95.Fa "BN_CTX *ctx"
96.Fc
97.Ft int
98.Fo BN_BLINDING_convert_ex
99.Fa "BIGNUM *n"
100.Fa "BIGNUM *r"
101.Fa "BN_BLINDING *b"
102.Fa "BN_CTX *ctx"
103.Fc
104.Ft int
105.Fo BN_BLINDING_invert_ex
106.Fa "BIGNUM *n"
107.Fa "const BIGNUM *r"
108.Fa "BN_BLINDING *b"
109.Fa "BN_CTX *ctx"
110.Fc
111.Ft CRYPTO_THREADID *
112.Fo BN_BLINDING_thread_id
113.Fa "BN_BLINDING *"
114.Fc
115.Ft unsigned long
116.Fo BN_BLINDING_get_flags
117.Fa "const BN_BLINDING *"
118.Fc
119.Ft void
120.Fo BN_BLINDING_set_flags
121.Fa "BN_BLINDING *"
122.Fa "unsigned long"
123.Fc
124.Ft BN_BLINDING *
125.Fo BN_BLINDING_create_param
126.Fa "BN_BLINDING *b"
127.Fa "const BIGNUM *e"
128.Fa "BIGNUM *m"
129.Fa "BN_CTX *ctx"
130.Fa "int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,\
131 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)"
132.Fa "BN_MONT_CTX *m_ctx"
133.Fc
134.Sh DESCRIPTION
135.Fn BN_BLINDING_new
136allocates a new
137.Vt BN_BLINDING
138structure and copies the
139.Fa A
140and
141.Fa \&Ai
142values into the newly created
143.Vt BN_BLINDING
144object.
145.Pp
146.Fn BN_BLINDING_free
147frees the
148.Vt BN_BLINDING
149structure.
150If
151.Fa b
152is a
153.Dv NULL
154pointer, no action occurs.
155.Pp
156.Fn BN_BLINDING_update
157updates the
158.Vt BN_BLINDING
159parameters by squaring the
160.Fa A
161and
162.Fa \&Ai
163or, after a specific number of uses and if the necessary parameters are
164set, by re-creating the blinding parameters.
165.Pp
166.Fn BN_BLINDING_convert_ex
167multiplies
168.Fa n
169with the blinding factor
170.Fa A .
171If
172.Fa r
173is not
174.Dv NULL ,
175a copy of the inverse blinding factor
176.Fa \&Ai
177will be returned in
178.Fa r
179(this is useful if an
180.Vt RSA
181object is shared among several threads).
182.Fn BN_BLINDING_invert_ex
183multiplies
184.Fa n
185with the inverse blinding factor
186.Fa \&Ai .
187If
188.Fa r
189is not
190.Dv NULL ,
191it will be used as the inverse blinding.
192.Pp
193.Fn BN_BLINDING_convert
194and
195.Fn BN_BLINDING_invert
196are wrapper functions for
197.Fn BN_BLINDING_convert_ex
198and
199.Fn BN_BLINDING_invert_ex
200with
201.Fa r
202set to
203.Dv NULL .
204.Pp
205.Fn BN_BLINDING_thread_id
206provides access to the
207.Vt CRYPTO_THREADID
208object within the
209.Vt BN_BLINDING
210structure.
211This is to help users provide proper locking if needed for
212multi-threaded use.
213The thread ID object of a newly allocated
214.Vt BN_BLINDING
215structure is initialised to the thread ID in which
216.Fn BN_BLINDING_new
217was called.
218.Pp
219.Fn BN_BLINDING_get_flags
220returns the
221.Dv BN_BLINDING_*
222flags.
223Currently there are two supported flags:
224.Dv BN_BLINDING_NO_UPDATE
225and
226.Dv BN_BLINDING_NO_RECREATE .
227.Dv BN_BLINDING_NO_UPDATE
228inhibits the automatic update of the
229.Vt BN_BLINDING
230parameters after each use and
231.Dv BN_BLINDING_NO_RECREATE
232inhibits the automatic re-creation of the
233.Vt BN_BLINDING
234parameters after a fixed number of uses (currently 32).
235In newly allocated
236.Vt BN_BLINDING
237objects no flags are set.
238.Fn BN_BLINDING_set_flags
239sets the
240.Dv BN_BLINDING_*
241parameters flags.
242.Pp
243.Fn BN_BLINDING_create_param
244creates new
245.Vt BN_BLINDING
246parameters using the exponent
247.Fa e
248and the modulus
249.Fa m .
250.Fa bn_mod_exp
251and
252.Fa m_ctx
253can be used to pass special functions for exponentiation (normally
254.Xr BN_mod_exp 3
255and
256.Vt BN_MONT_CTX ) .
257.Sh RETURN VALUES
258.Fn BN_BLINDING_new
259returns the newly allocated
260.Vt BN_BLINDING
261structure or
262.Dv NULL
263in case of an error.
264.Pp
265.Fn BN_BLINDING_update ,
266.Fn BN_BLINDING_convert ,
267.Fn BN_BLINDING_invert ,
268.Fn BN_BLINDING_convert_ex
269and
270.Fn BN_BLINDING_invert_ex
271return 1 on success and 0 if an error occurred.
272.Pp
273.Fn BN_BLINDING_thread_id
274returns a pointer to the thread ID object within a
275.Vt BN_BLINDING
276object.
277.Pp
278.Fn BN_BLINDING_get_flags
279returns the currently set
280.Dv BN_BLINDING_*
281flags (an
282.Vt unsigned long
283value).
284.Pp
285.Fn BN_BLINDING_create_param
286returns the newly created
287.Vt BN_BLINDING
288parameters or
289.Dv NULL
290on error.
291.Sh SEE ALSO
292.Xr BN_new 3 ,
293.Xr RSA_blinding_on 3
294.Sh HISTORY
295.Fn BN_BLINDING_new ,
296.Fn BN_BLINDING_free ,
297.Fn BN_BLINDING_update ,
298.Fn BN_BLINDING_convert ,
299and
300.Fn BN_BLINDING_invert
301first appeared in SSLeay 0.9.0 and have been available since
302.Ox 2.4 .
303.Pp
304.Fn BN_BLINDING_convert_ex ,
305.Fn BN_BLINDIND_invert_ex ,
306.Fn BN_BLINDING_get_flags ,
307.Fn BN_BLINDING_set_flags ,
308and
309.Fn BN_BLINDING_create_param
310first appeared in OpenSSL 0.9.8 and have been available since
311.Ox 4.5 .
312.Pp
313.Fn BN_BLINDING_thread_id
314first appeared in OpenSSL 1.0.0 and has been available since
315.Ox 4.9 .
316.Sh AUTHORS
317.An Nils Larsch Aq Mt nils@openssl.org
diff --git a/src/lib/libcrypto/man/BN_new.3 b/src/lib/libcrypto/man/BN_new.3
index 22bb77c173..088048c622 100644
--- a/src/lib/libcrypto/man/BN_new.3
+++ b/src/lib/libcrypto/man/BN_new.3
@@ -1,4 +1,4 @@
1.\" $OpenBSD: BN_new.3,v 1.30 2023/07/21 05:04:48 tb Exp $ 1.\" $OpenBSD: BN_new.3,v 1.31 2023/07/26 20:08:59 tb Exp $
2.\" full merge up to: OpenSSL man3/BN_new 2457c19d Mar 6 08:43:36 2004 +0000 2.\" full merge up to: OpenSSL man3/BN_new 2457c19d Mar 6 08:43:36 2004 +0000
3.\" selective merge up to: man3/BN_new 681acb31 Sep 29 13:10:34 2017 +0200 3.\" selective merge up to: man3/BN_new 681acb31 Sep 29 13:10:34 2017 +0200
4.\" full merge up to: OpenSSL man7/bn 05ea606a May 20 20:52:46 2016 -0400 4.\" full merge up to: OpenSSL man7/bn 05ea606a May 20 20:52:46 2016 -0400
@@ -50,7 +50,7 @@
50.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 50.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51.\" OF THE POSSIBILITY OF SUCH DAMAGE. 51.\" OF THE POSSIBILITY OF SUCH DAMAGE.
52.\" 52.\"
53.Dd $Mdocdate: July 21 2023 $ 53.Dd $Mdocdate: July 26 2023 $
54.Dt BN_NEW 3 54.Dt BN_NEW 3
55.Os 55.Os
56.Sh NAME 56.Sh NAME
@@ -135,7 +135,6 @@ and sets an error code that can be obtained by
135.Sh SEE ALSO 135.Sh SEE ALSO
136.Xr BN_add 3 , 136.Xr BN_add 3 ,
137.Xr BN_add_word 3 , 137.Xr BN_add_word 3 ,
138.Xr BN_BLINDING_new 3 ,
139.Xr BN_bn2bin 3 , 138.Xr BN_bn2bin 3 ,
140.Xr BN_cmp 3 , 139.Xr BN_cmp 3 ,
141.Xr BN_copy 3 , 140.Xr BN_copy 3 ,
diff --git a/src/lib/libcrypto/man/Makefile b/src/lib/libcrypto/man/Makefile
index 669b0c1395..1697357f62 100644
--- a/src/lib/libcrypto/man/Makefile
+++ b/src/lib/libcrypto/man/Makefile
@@ -1,4 +1,4 @@
1# $OpenBSD: Makefile,v 1.257 2023/07/26 20:01:04 tb Exp $ 1# $OpenBSD: Makefile,v 1.258 2023/07/26 20:08:59 tb Exp $
2 2
3.include <bsd.own.mk> 3.include <bsd.own.mk>
4 4
@@ -62,7 +62,6 @@ MAN= \
62 BIO_s_socket.3 \ 62 BIO_s_socket.3 \
63 BIO_set_callback.3 \ 63 BIO_set_callback.3 \
64 BIO_should_retry.3 \ 64 BIO_should_retry.3 \
65 BN_BLINDING_new.3 \
66 BN_CTX_new.3 \ 65 BN_CTX_new.3 \
67 BN_CTX_start.3 \ 66 BN_CTX_start.3 \
68 BN_add.3 \ 67 BN_add.3 \
diff --git a/src/lib/libcrypto/man/RSA_blinding_on.3 b/src/lib/libcrypto/man/RSA_blinding_on.3
index 5d4b4ab25d..bd2a301377 100644
--- a/src/lib/libcrypto/man/RSA_blinding_on.3
+++ b/src/lib/libcrypto/man/RSA_blinding_on.3
@@ -1,4 +1,4 @@
1.\" $OpenBSD: RSA_blinding_on.3,v 1.6 2019/06/06 01:06:59 schwarze Exp $ 1.\" $OpenBSD: RSA_blinding_on.3,v 1.7 2023/07/26 20:08:59 tb Exp $
2.\" OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400 2.\" OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400
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: June 6 2019 $ 51.Dd $Mdocdate: July 26 2023 $
52.Dt RSA_BLINDING_ON 3 52.Dt RSA_BLINDING_ON 3
53.Os 53.Os
54.Sh NAME 54.Sh NAME
@@ -88,7 +88,6 @@ turns blinding off and frees the memory used for the blinding factor.
88.Fn RSA_blinding_on 88.Fn RSA_blinding_on
89returns 1 on success, and 0 if an error occurred. 89returns 1 on success, and 0 if an error occurred.
90.Sh SEE ALSO 90.Sh SEE ALSO
91.Xr BN_BLINDING_new 3 ,
92.Xr RSA_new 3 91.Xr RSA_new 3
93.Sh HISTORY 92.Sh HISTORY
94.Fn RSA_blinding_on 93.Fn RSA_blinding_on