Ulf Möller | 4486d0c | 2000-01-22 20:05:23 +0000 | [diff] [blame] | 1 | =pod |
| 2 | |
| 3 | =head1 NAME |
| 4 | |
Ulf Möller | 4d524e1 | 2000-02-24 11:55:57 +0000 | [diff] [blame] | 5 | DH_generate_key, DH_compute_key - perform Diffie-Hellman key exchange |
Ulf Möller | 4486d0c | 2000-01-22 20:05:23 +0000 | [diff] [blame] | 6 | |
| 7 | =head1 SYNOPSIS |
| 8 | |
| 9 | #include <openssl/dh.h> |
| 10 | |
| 11 | int DH_generate_key(DH *dh); |
| 12 | |
| 13 | int DH_compute_key(unsigned char *key, BIGNUM *pub_key, DH *dh); |
| 14 | |
| 15 | =head1 DESCRIPTION |
| 16 | |
| 17 | DH_generate_key() performs the first step of a Diffie-Hellman key |
| 18 | exchange by generating private and public DH values. By calling |
| 19 | DH_compute_key(), these are combined with the other party's public |
| 20 | value to compute the shared key. |
| 21 | |
| 22 | DH_generate_key() expects B<dh> to contain the shared parameters |
| 23 | B<dh-E<gt>p> and B<dh-E<gt>g>. It generates a random private DH value |
Bodo Möller | 924875e | 2001-07-27 22:34:25 +0000 | [diff] [blame] | 24 | unless B<dh-E<gt>priv_key> is already set, and computes the |
| 25 | corresponding public value B<dh-E<gt>pub_key>, which can then be |
| 26 | published. |
Ulf Möller | 4486d0c | 2000-01-22 20:05:23 +0000 | [diff] [blame] | 27 | |
| 28 | DH_compute_key() computes the shared secret from the private DH value |
| 29 | in B<dh> and the other party's public value in B<pub_key> and stores |
| 30 | it in B<key>. B<key> must point to B<DH_size(dh)> bytes of memory. |
| 31 | |
| 32 | =head1 RETURN VALUES |
| 33 | |
| 34 | DH_generate_key() returns 1 on success, 0 otherwise. |
| 35 | |
| 36 | DH_compute_key() returns the size of the shared secret on success, -1 |
| 37 | on error. |
| 38 | |
Rich Salz | 9b86974 | 2015-08-17 15:21:33 -0400 | [diff] [blame] | 39 | The error codes can be obtained by L<ERR_get_error(3)>. |
Ulf Möller | 4486d0c | 2000-01-22 20:05:23 +0000 | [diff] [blame] | 40 | |
| 41 | =head1 SEE ALSO |
| 42 | |
Richard Levitte | b97fdb5 | 2016-11-11 09:33:09 +0100 | [diff] [blame] | 43 | L<DH_new(3)>, L<ERR_get_error(3)>, L<RAND_bytes(3)>, L<DH_size(3)> |
Ulf Möller | 4486d0c | 2000-01-22 20:05:23 +0000 | [diff] [blame] | 44 | |
Rich Salz | e2f9261 | 2016-05-18 11:44:05 -0400 | [diff] [blame] | 45 | =head1 COPYRIGHT |
| 46 | |
| 47 | Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved. |
| 48 | |
| 49 | Licensed under the OpenSSL license (the "License"). You may not use |
| 50 | this file except in compliance with the License. You can obtain a copy |
| 51 | in the file LICENSE in the source distribution or at |
| 52 | L<https://www.openssl.org/source/license.html>. |
| 53 | |
| 54 | =cut |