[thirdparty/openssl.git] / doc / man3 / DSA_generate_key.pod

=pod

=head1 NAME

DSA_generate_key - generate DSA key pair

=head1 SYNOPSIS

 #include <openssl/dsa.h>

 int DSA_generate_key(DSA *a);

=head1 DESCRIPTION

DSA_generate_key() expects B<a> to contain DSA parameters. It generates
a new key pair and stores it in B<a-E<gt>pub_key> and B<a-E<gt>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 L<RAND(7)>), the operation will fail.

=head1 RETURN VALUES

DSA_generate_key() returns 1 on success, 0 otherwise.
The error codes can be obtained by L<ERR_get_error(3)>.

=head1 SEE ALSO

L<DSA_new(3)>, L<ERR_get_error(3)>, L<RAND_bytes(3)>,
L<DSA_generate_parameters_ex(3)>

=head1 COPYRIGHT

Copyright 2000-2018 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
L<https://www.openssl.org/source/license.html>.

=cut
Commit	Line	Data
38e33cef UM	1	=pod
	2
	3	=head1 NAME
	4
4d524e10	5	DSA_generate_key - generate DSA key pair
38e33cef UM	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
262c0088 DMSP	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.
38e33cef	21
1f13ad31	22	=head1 RETURN VALUES
38e33cef UM	23
38e33cef UM	24	DSA_generate_key() returns 1 on success, 0 otherwise.
9b86974e	25	The error codes can be obtained by L<ERR_get_error(3)>.
38e33cef UM	26
	27	=head1 SEE ALSO
	28
b97fdb57	29	L<DSA_new(3)>, L<ERR_get_error(3)>, L<RAND_bytes(3)>,
b3696a55	30	L<DSA_generate_parameters_ex(3)>
38e33cef	31
e2f92610 RS	32	=head1 COPYRIGHT
e2f92610 RS	33
61f805c1	34	Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
e2f92610	35
4746f25a	36	Licensed under the Apache License 2.0 (the "License"). You may not use
e2f92610 RS	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