Debian Codegraph @

upstream/debian-unstable/man3/DH_generate_key.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "DH_GENERATE_KEY 3SSL"
58 .TH DH_GENERATE_KEY 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 DH_generate_key, DH_compute_key, DH_compute_key_padded \- perform
65 Diffie\-Hellman key exchange
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/dh.h>
70 .Ve
71 .PP
72 The following functions have been deprecated since OpenSSL 3.0, and can be
73 hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
74 see \fBopenssl_user_macros\fR\|(7):
75 .PP
76 .Vb 1
77 \& int DH_generate_key(DH *dh);
78 \&
79 \& int DH_compute_key(unsigned char *key, const BIGNUM *pub_key, DH *dh);
80 \&
81 \& int DH_compute_key_padded(unsigned char *key, const BIGNUM *pub_key, DH *dh);
82 .Ve
83 .SH DESCRIPTION
84 .IX Header "DESCRIPTION"
85 All of the functions described on this page are deprecated.
86 Applications should instead use \fBEVP_PKEY_derive_init\fR\|(3)
87 and \fBEVP_PKEY_derive\fR\|(3).
88 .PP
89 \&\fBDH_generate_key()\fR performs the first step of a Diffie-Hellman key
90 exchange by generating private and public DH values. By calling
91 \&\fBDH_compute_key()\fR or \fBDH_compute_key_padded()\fR, these are combined with
92 the other party's public value to compute the shared key.
93 .PP
94 \&\fBDH_generate_key()\fR expects \fBdh\fR to contain the shared parameters
95 \&\fBdh\->p\fR and \fBdh\->g\fR. It generates a random private DH value
96 unless \fBdh\->priv_key\fR is already set, and computes the
97 corresponding public value \fBdh\->pub_key\fR, which can then be
98 published.
99 .PP
100 \&\fBDH_compute_key()\fR computes the shared secret from the private DH value
101 in \fBdh\fR and the other party's public value in \fBpub_key\fR and stores
102 it in \fBkey\fR. \fBkey\fR must point to \fBDH_size(dh)\fR bytes of memory.
103 The padding style is RFC 5246 (8.1.2) that strips leading zero bytes.
104 It is not constant time due to the leading zero bytes being stripped.
105 The return value should be considered public.
106 .PP
107 \&\fBDH_compute_key_padded()\fR is similar but stores a fixed number of bytes.
108 The padding style is NIST SP 800\-56A (C.1) that retains leading zero bytes.
109 It is constant time due to the leading zero bytes being retained.
110 The return value should be considered public.
111 .SH "RETURN VALUES"
112 .IX Header "RETURN VALUES"
113 \&\fBDH_generate_key()\fR returns 1 on success, 0 otherwise.
114 .PP
115 \&\fBDH_compute_key()\fR returns the size of the shared secret on success, \-1
116 on error.
117 .PP
118 \&\fBDH_compute_key_padded()\fR returns \fBDH_size(dh)\fR on success, \-1 on error.
119 .PP
120 The error codes can be obtained by \fBERR_get_error\fR\|(3).
121 .SH "SEE ALSO"
122 .IX Header "SEE ALSO"
123 \&\fBEVP_PKEY_derive\fR\|(3),
124 \&\fBDH_new\fR\|(3), \fBERR_get_error\fR\|(3), \fBRAND_bytes\fR\|(3), \fBDH_size\fR\|(3)
125 .SH HISTORY
126 .IX Header "HISTORY"
127 \&\fBDH_compute_key_padded()\fR was added in OpenSSL 1.0.2.
128 .PP
129 All of these functions were deprecated in OpenSSL 3.0.
130 .SH COPYRIGHT
131 .IX Header "COPYRIGHT"
132 Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved.
133 .PP
134 Licensed under the Apache License 2.0 (the "License"). You may not use
135 this file except in compliance with the License. You can obtain a copy
136 in the file LICENSE in the source distribution or at
137 <https://www.openssl.org/source/license.html>.