diff options
Diffstat (limited to 'src/lib/libcrypto/doc/DSA_generate_key.pod')
| -rw-r--r-- | src/lib/libcrypto/doc/DSA_generate_key.pod | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/src/lib/libcrypto/doc/DSA_generate_key.pod b/src/lib/libcrypto/doc/DSA_generate_key.pod new file mode 100644 index 0000000000..af83ccfaa1 --- /dev/null +++ b/src/lib/libcrypto/doc/DSA_generate_key.pod | |||
| @@ -0,0 +1,34 @@ | |||
| 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 PRNG must be seeded prior to calling DSA_generate_key(). | ||
| 19 | |||
| 20 | =head1 RETURN VALUE | ||
| 21 | |||
| 22 | DSA_generate_key() returns 1 on success, 0 otherwise. | ||
| 23 | The error codes can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>. | ||
| 24 | |||
| 25 | =head1 SEE ALSO | ||
| 26 | |||
| 27 | L<dsa(3)|dsa(3)>, L<ERR_get_error(3)|ERR_get_error(3)>, L<rand(3)|rand(3)>, | ||
| 28 | L<DSA_generate_parameters(3)|DSA_generate_parameters(3)> | ||
| 29 | |||
| 30 | =head1 HISTORY | ||
| 31 | |||
| 32 | DSA_generate_key() is available since SSLeay 0.8. | ||
| 33 | |||
| 34 | =cut | ||
