Constify X509_PUBKEY_get(), X509_PUBKEY_get0(), and X509_PUBKEY_get0_param()
[openssl.git] / doc / man3 / DSA_generate_key.pod
1 =pod
2
3 =head1 NAME
4
5 DSA_generate_key - generate DSA key pair
6
7 =head1 SYNOPSIS
8
9  #include <openssl/dsa.h>
10
11  int DSA_generate_key(DSA *a);
12
13 =head1 DESCRIPTION
14
15 DSA_generate_key() expects B<a> to contain DSA parameters. It generates
16 a new key pair and stores it in B<a-E<gt>pub_key> and B<a-E<gt>priv_key>.
17
18 The random generator must be seeded prior to calling DSA_generate_key().
19 If the automatic seeding or reseeding of the OpenSSL CSPRNG fails due to
20 external circumstances (see L<RAND(7)>), the operation will fail.
21
22 =head1 RETURN VALUES
23
24 DSA_generate_key() returns 1 on success, 0 otherwise.
25 The error codes can be obtained by L<ERR_get_error(3)>.
26
27 =head1 SEE ALSO
28
29 L<DSA_new(3)>, L<ERR_get_error(3)>, L<RAND_bytes(3)>,
30 L<DSA_generate_parameters_ex(3)>
31
32 =head1 COPYRIGHT
33
34 Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
35
36 Licensed under the Apache License 2.0 (the "License").  You may not use
37 this file except in compliance with the License.  You can obtain a copy
38 in the file LICENSE in the source distribution or at
39 L<https://www.openssl.org/source/license.html>.
40
41 =cut