xref: /netbsd-src/crypto/external/bsd/openssl/lib/libcrypto/man/DSA_generate_key.3 (revision 63372caa2f74032c7c1cb34e7cd32f28ad65b703)
$NetBSD: DSA_generate_key.3,v 1.25 2024/09/08 13:08:19 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..
..
.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . 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 ========================================================================

Title "DSA_generate_key 3"
DSA_generate_key 3 2024-09-03 3.0.15 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
DSA_generate_key - generate DSA key pair
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 OPENSSL_API_COMPAT with a suitable version value, see openssl_user_macros\|(7):

.Vb 1 int DSA_generate_key(DSA *a); .Ve

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

\fBDSA_generate_key() expects a to contain DSA parameters. It generates a new key pair and stores it in a->pub_key and a->priv_key.

The random generator must be seeded prior to calling DSA_generate_key(). If the automatic seeding or reseeding of the OpenSSL CSPRNG fails due to external circumstances (see RAND\|(7)), the operation will fail.

"RETURN VALUES"
Header "RETURN VALUES" \fBDSA_generate_key() returns 1 on success, 0 otherwise. The error codes can be obtained by ERR_get_error\|(3).
"SEE ALSO"
Header "SEE ALSO" \fBDSA_new\|(3), ERR_get_error\|(3), RAND_bytes\|(3), \fBDSA_generate_parameters_ex\|(3)
HISTORY
Header "HISTORY" This function was deprecated in OpenSSL 3.0.
COPYRIGHT
Header "COPYRIGHT" Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.

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