summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/DSA_generate_parameters.3
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libcrypto/man/DSA_generate_parameters.3')
-rw-r--r--src/lib/libcrypto/man/DSA_generate_parameters.364
1 files changed, 6 insertions, 58 deletions
diff --git a/src/lib/libcrypto/man/DSA_generate_parameters.3 b/src/lib/libcrypto/man/DSA_generate_parameters.3
index 07fa5acf93..bba6f9a566 100644
--- a/src/lib/libcrypto/man/DSA_generate_parameters.3
+++ b/src/lib/libcrypto/man/DSA_generate_parameters.3
@@ -1,4 +1,4 @@
1.\" $OpenBSD: DSA_generate_parameters.3,v 1.13 2023/05/14 09:27:15 tb Exp $ 1.\" $OpenBSD: DSA_generate_parameters.3,v 1.14 2023/12/29 19:12:47 tb Exp $
2.\" OpenSSL 9b86974e Aug 7 22:14:47 2015 -0400 2.\" OpenSSL 9b86974e Aug 7 22:14:47 2015 -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>,
@@ -49,12 +49,13 @@
49.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 49.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50.\" OF THE POSSIBILITY OF SUCH DAMAGE. 50.\" OF THE POSSIBILITY OF SUCH DAMAGE.
51.\" 51.\"
52.Dd $Mdocdate: May 14 2023 $ 52.Dd $Mdocdate: December 29 2023 $
53.Dt DSA_GENERATE_PARAMETERS 3 53.Dt DSA_GENERATE_PARAMETERS_EX 3
54.Os 54.Os
55.Sh NAME 55.Sh NAME
56.Nm DSA_generate_parameters_ex , 56.\" .Nm DSA_generate_parameters is intentionally undocumented
57.Nm DSA_generate_parameters 57.\" because it will be removed in the next major bump
58.Nm DSA_generate_parameters_ex
58.Nd generate DSA parameters 59.Nd generate DSA parameters
59.Sh SYNOPSIS 60.Sh SYNOPSIS
60.In openssl/dsa.h 61.In openssl/dsa.h
@@ -68,19 +69,6 @@
68.Fa "unsigned long *h_ret" 69.Fa "unsigned long *h_ret"
69.Fa "BN_GENCB *cb" 70.Fa "BN_GENCB *cb"
70.Fc 71.Fc
71.Pp
72Deprecated:
73.Pp
74.Ft DSA *
75.Fo DSA_generate_parameters
76.Fa "int bits"
77.Fa "unsigned char *seed"
78.Fa "int seed_len"
79.Fa "int *counter_ret"
80.Fa "unsigned long *h_ret"
81.Fa "void (*callback)(int, int, void *)"
82.Fa "void *cb_arg"
83.Fc
84.Sh DESCRIPTION 72.Sh DESCRIPTION
85.Fn DSA_generate_parameters_ex 73.Fn DSA_generate_parameters_ex
86generates primes p and q and a generator g for use in the DSA and stores 74generates primes p and q and a generator g for use in the DSA and stores
@@ -168,32 +156,10 @@ When the generator has been found,
168.Fn BN_GENCB_call cb 3 1 156.Fn BN_GENCB_call cb 3 1
169is called. 157is called.
170.El 158.El
171.Pp
172.Fn DSA_generate_parameters
173(deprecated) works in much the same way as for
174.Fn DSA_generate_parameters_ex ,
175except that no
176.Fa dsa
177parameter is passed and instead a newly allocated
178.Vt DSA
179structure is returned.
180Additionally "old style" callbacks are used instead of the newer
181.Vt BN_GENCB
182based approach.
183Refer to
184.Xr BN_generate_prime 3
185for further information.
186.Sh RETURN VALUES 159.Sh RETURN VALUES
187.Fn DSA_generate_parameters_ex 160.Fn DSA_generate_parameters_ex
188returns a 1 on success, or 0 otherwise. 161returns a 1 on success, or 0 otherwise.
189.Pp 162.Pp
190.Fn DSA_generate_parameters
191returns a pointer to the
192.Vt DSA
193structure, or
194.Dv NULL
195if the parameter generation fails.
196.Pp
197The error codes can be obtained by 163The error codes can be obtained by
198.Xr ERR_get_error 3 . 164.Xr ERR_get_error 3 .
199.Sh SEE ALSO 165.Sh SEE ALSO
@@ -201,24 +167,6 @@ The error codes can be obtained by
201.Xr DSA_get0_pqg 3 , 167.Xr DSA_get0_pqg 3 ,
202.Xr DSA_new 3 168.Xr DSA_new 3
203.Sh HISTORY 169.Sh HISTORY
204.Fn DSA_generate_parameters
205first appeared in SSLeay 0.8.0 and had its
206.Fa cb_arg
207argument added in SSLeay 0.9.0.
208It has been available since
209.Ox 2.4 .
210.Pp
211In versions up to OpenSSL 0.9.4,
212.Fn callback 1 ...\&
213was called in the inner loop of the Miller-Rabin test whenever it
214reached the squaring step (the parameters to
215.Fn callback
216did not reveal how many witnesses had been tested); since OpenSSL 0.9.5,
217.Fn callback 1 ...\&
218is called as in
219.Xr BN_is_prime_ex 3 ,
220i.e. once for each witness.
221.Pp
222.Fn DSA_generate_parameters_ex 170.Fn DSA_generate_parameters_ex
223first appeared in OpenSSL 0.9.8 and has been available since 171first appeared in OpenSSL 0.9.8 and has been available since
224.Ox 4.5 . 172.Ox 4.5 .