xref: /freebsd/secure/lib/libcrypto/man/man3/DSA_generate_parameters.3 (revision ba3c1f5972d7b90feb6e6da47905ff2757e0fe57)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "DSA_GENERATE_PARAMETERS 3"
DSA_GENERATE_PARAMETERS 3 "2023-05-30" "3.0.9" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
DSA_generate_parameters_ex, DSA_generate_parameters - generate DSA parameters
"SYNOPSIS"
Header "SYNOPSIS" .Vb 1 #include <openssl/dsa.h> .Ve

The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defining \s-1OPENSSL_API_COMPAT\s0 with a suitable version value, see openssl_user_macros\|(7):

.Vb 4 int DSA_generate_parameters_ex(DSA *dsa, int bits, const unsigned char *seed, int seed_len, int *counter_ret, unsigned long *h_ret, BN_GENCB *cb); .Ve

The following functions have been deprecated since OpenSSL 0.9.8, and can be hidden entirely by defining \s-1OPENSSL_API_COMPAT\s0 with a suitable version value, see openssl_user_macros\|(7):

.Vb 3 DSA *DSA_generate_parameters(int bits, unsigned char *seed, int seed_len, int *counter_ret, unsigned long *h_ret, void (*callback)(int, int, void *), void *cb_arg); .Ve

"DESCRIPTION"
Header "DESCRIPTION" All of the functions described on this page are deprecated. Applications should instead use EVP_PKEY_paramgen_init\|(3) and \fBEVP_PKEY_keygen\|(3) as described in \s-1EVP_PKEY-DSA\s0\|(7).

\fBDSA_generate_parameters_ex() generates primes p and q and a generator g for use in the \s-1DSA\s0 and stores the result in dsa.

\fBbits is the length of the prime p to be generated. For lengths under 2048 bits, the length of q is 160 bits; for lengths greater than or equal to 2048 bits, the length of q is set to 256 bits.

If seed is \s-1NULL,\s0 the primes will be generated at random. If seed_len is less than the length of q, an error is returned.

\fBDSA_generate_parameters_ex() places the iteration count in *counter_ret and a counter used for finding a generator in *h_ret, unless these are \s-1NULL\s0.

A callback function may be used to provide feedback about the progress of the key generation. If cb is not \s-1NULL\s0, it will be called as shown below. For information on the \s-1BN_GENCB\s0 structure and the BN_GENCB_call function discussed below, refer to \fBBN_generate_prime\|(3).

\fBDSA_generate_prime() is similar to DSA_generate_prime_ex() but expects an old-style callback function; see \fBBN_generate_prime\|(3) for information on the old-style callback.

"\(bu" 2
When a candidate for q is generated, BN_GENCB_call(cb, 0, m++) is called (m is 0 for the first candidate).
"\(bu" 2
When a candidate for q has passed a test by trial division, \fBBN_GENCB_call(cb, 1, -1) is called. While a candidate for q is tested by Miller-Rabin primality tests, \fBBN_GENCB_call(cb, 1, i) is called in the outer loop (once for each witness that confirms that the candidate may be prime); i is the loop counter (starting at 0).
"\(bu" 2
When a prime q has been found, BN_GENCB_call(cb, 2, 0) and \fBBN_GENCB_call(cb, 3, 0) are called.
"\(bu" 2
Before a candidate for p (other than the first) is generated and tested, \fBBN_GENCB_call(cb, 0, counter) is called.
"\(bu" 2
When a candidate for p has passed the test by trial division, \fBBN_GENCB_call(cb, 1, -1) is called. While it is tested by the Miller-Rabin primality test, \fBBN_GENCB_call(cb, 1, i) is called in the outer loop (once for each witness that confirms that the candidate may be prime). i is the loop counter (starting at 0).
"\(bu" 2
When p has been found, BN_GENCB_call(cb, 2, 1) is called.
"\(bu" 2
When the generator has been found, BN_GENCB_call(cb, 3, 1) is called.
"RETURN VALUES"
Header "RETURN VALUES" \fBDSA_generate_parameters_ex() returns a 1 on success, or 0 otherwise. The error codes can be obtained by ERR_get_error\|(3).

\fBDSA_generate_parameters() returns a pointer to the \s-1DSA\s0 structure or \fB\s-1NULL\s0 if the parameter generation fails.

"BUGS"
Header "BUGS" Seed lengths greater than 20 are not supported.
"SEE ALSO"
Header "SEE ALSO" \fBDSA_new\|(3), ERR_get_error\|(3), RAND_bytes\|(3), \fBDSA_free\|(3), BN_generate_prime\|(3)
"HISTORY"
Header "HISTORY" \fBDSA_generate_parameters_ex() was deprecated in OpenSSL 3.0.

\fBDSA_generate_parameters() was deprecated in OpenSSL 0.9.8; use \fBDSA_generate_parameters_ex() instead.

"COPYRIGHT"
Header "COPYRIGHT" Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.