Debian Codegraph @

upstream/debian-unstable/man3/DSA_generate_key.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "DSA_GENERATE_KEY 3SSL"
58 .TH DSA_GENERATE_KEY 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 DSA_generate_key \- generate DSA key pair
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/dsa.h>
69 .Ve
70 .PP
71 The following functions have been deprecated since OpenSSL 3.0, and can be
72 hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
73 see \fBopenssl_user_macros\fR\|(7):
74 .PP
75 .Vb 1
76 \& int DSA_generate_key(DSA *a);
77 .Ve
78 .SH DESCRIPTION
79 .IX Header "DESCRIPTION"
80 All of the functions described on this page are deprecated.
81 Applications should instead use \fBEVP_PKEY_keygen_init\fR\|(3) and
82 \&\fBEVP_PKEY_keygen\fR\|(3) as described in \fBEVP_PKEY\-DSA\fR\|(7).
83 .PP
84 \&\fBDSA_generate_key()\fR expects \fBa\fR to contain DSA parameters. It generates
85 a new key pair and stores it in \fBa\->pub_key\fR and \fBa\->priv_key\fR.
86 .PP
87 The random generator must be seeded prior to calling \fBDSA_generate_key()\fR.
88 If the automatic seeding or reseeding of the OpenSSL CSPRNG fails due to
89 external circumstances (see \fBRAND\fR\|(7)), the operation will fail.
90 .SH "RETURN VALUES"
91 .IX Header "RETURN VALUES"
92 \&\fBDSA_generate_key()\fR returns 1 on success, 0 otherwise.
93 The error codes can be obtained by \fBERR_get_error\fR\|(3).
94 .SH "SEE ALSO"
95 .IX Header "SEE ALSO"
96 \&\fBDSA_new\fR\|(3), \fBERR_get_error\fR\|(3), \fBRAND_bytes\fR\|(3),
97 \&\fBDSA_generate_parameters_ex\fR\|(3)
98 .SH HISTORY
99 .IX Header "HISTORY"
100 This function was deprecated in OpenSSL 3.0.
101 .SH COPYRIGHT
102 .IX Header "COPYRIGHT"
103 Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved.
104 .PP
105 Licensed under the Apache License 2.0 (the "License"). You may not use
106 this file except in compliance with the License. You can obtain a copy
107 in the file LICENSE in the source distribution or at
108 <https://www.openssl.org/source/license.html>.