diff options
author | 2016-11-02 09:11:53 +0000 | |
---|---|---|
committer | 2016-11-02 09:11:53 +0000 | |
commit | 526c24c9561000760f09a3cb68d9208ff462ee44 (patch) | |
tree | 4ed3827df1ce7f786a0d156d23856a4e1bfda206 /lib/libcrypto/doc/DH_generate_key.pod | |
parent | poison the TAILQ_ENTRY in items in the per cpu pool cache. (diff) | |
download | wireguard-openbsd-526c24c9561000760f09a3cb68d9208ff462ee44.tar.xz wireguard-openbsd-526c24c9561000760f09a3cb68d9208ff462ee44.zip |
convert DES and DH manuals from pod to mdoc
Diffstat (limited to 'lib/libcrypto/doc/DH_generate_key.pod')
-rw-r--r-- | lib/libcrypto/doc/DH_generate_key.pod | 51 |
1 files changed, 0 insertions, 51 deletions
diff --git a/lib/libcrypto/doc/DH_generate_key.pod b/lib/libcrypto/doc/DH_generate_key.pod deleted file mode 100644 index 148e13762b7..00000000000 --- a/lib/libcrypto/doc/DH_generate_key.pod +++ /dev/null @@ -1,51 +0,0 @@ -=pod - -=head1 NAME - -DH_generate_key, DH_compute_key - perform Diffie-Hellman key exchange - -=head1 SYNOPSIS - - #include <openssl/dh.h> - - int DH_generate_key(DH *dh); - - int DH_compute_key(unsigned char *key, BIGNUM *pub_key, DH *dh); - -=head1 DESCRIPTION - -DH_generate_key() performs the first step of a Diffie-Hellman key -exchange by generating private and public DH values. By calling -DH_compute_key(), these are combined with the other party's public -value to compute the shared key. - -DH_generate_key() expects B<dh> to contain the shared parameters -B<dh-E<gt>p> and B<dh-E<gt>g>. It generates a random private DH value -unless B<dh-E<gt>priv_key> is already set, and computes the -corresponding public value B<dh-E<gt>pub_key>, which can then be -published. - -DH_compute_key() computes the shared secret from the private DH value -in B<dh> and the other party's public value in B<pub_key> and stores -it in B<key>. B<key> must point to B<DH_size(dh)> bytes of memory. - -=head1 RETURN VALUES - -DH_generate_key() returns 1 on success, 0 otherwise. - -DH_compute_key() returns the size of the shared secret on success, -1 -on error. - -The error codes can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>. - -=head1 SEE ALSO - -L<dh(3)|dh(3)>, L<ERR_get_error(3)|ERR_get_error(3)>, L<rand(3)|rand(3)>, -L<DH_size(3)|DH_size(3)> - -=head1 HISTORY - -DH_generate_key() and DH_compute_key() are available in all versions -of SSLeay and OpenSSL. - -=cut |