1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
26 .\" Set up some character translations and predefined strings. \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
29 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
37 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
51 .\" Escape single quotes in literal strings from groff's Unicode transform.
55 .\" If the F register is turned on, we'll generate index entries on stderr for
56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57 .\" entries marked with X<> in POD. Of course, you'll have to process the
58 .\" output yourself in some meaningful fashion.
61 . tm Index:\\$1\t\\n%\t"\\$2"
71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72 .\" Fear. Run. Save yourself. No user-serviceable parts.
73 . \" fudge factors for nroff and troff
82 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
88 . \" simple accents for nroff and troff
98 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 . \" troff and (daisy-wheel) nroff accents
106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113 .ds ae a\h'-(\w'a'u*4/10)'e
114 .ds Ae A\h'-(\w'A'u*4/10)'E
115 . \" corrections for vroff
116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
118 . \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
132 .\" ========================================================================
135 .TH dh 3 "2009-11-06" "0.9.8l" "OpenSSL"
136 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
137 .\" way too many mistakes in technical documents.
141 dh \- Diffie\-Hellman key agreement
143 .IX Header "SYNOPSIS"
145 \& #include <openssl/dh.h>
146 \& #include <openssl/engine.h>
148 \& DH * DH_new(void);
149 \& void DH_free(DH *dh);
151 \& int DH_size(const DH *dh);
153 \& DH * DH_generate_parameters(int prime_len, int generator,
154 \& void (*callback)(int, int, void *), void *cb_arg);
155 \& int DH_check(const DH *dh, int *codes);
157 \& int DH_generate_key(DH *dh);
158 \& int DH_compute_key(unsigned char *key, BIGNUM *pub_key, DH *dh);
160 \& void DH_set_default_method(const DH_METHOD *meth);
161 \& const DH_METHOD *DH_get_default_method(void);
162 \& int DH_set_method(DH *dh, const DH_METHOD *meth);
163 \& DH *DH_new_method(ENGINE *engine);
164 \& const DH_METHOD *DH_OpenSSL(void);
166 \& int DH_get_ex_new_index(long argl, char *argp, int (*new_func)(),
167 \& int (*dup_func)(), void (*free_func)());
168 \& int DH_set_ex_data(DH *d, int idx, char *arg);
169 \& char *DH_get_ex_data(DH *d, int idx);
171 \& DH * d2i_DHparams(DH **a, unsigned char **pp, long length);
172 \& int i2d_DHparams(const DH *a, unsigned char **pp);
174 \& int DHparams_print_fp(FILE *fp, const DH *x);
175 \& int DHparams_print(BIO *bp, const DH *x);
178 .IX Header "DESCRIPTION"
179 These functions implement the Diffie-Hellman key agreement protocol.
180 The generation of shared \s-1DH\s0 parameters is described in
181 \&\fIDH_generate_parameters\fR\|(3); \fIDH_generate_key\fR\|(3) describes how
182 to perform a key agreement.
184 The \fB\s-1DH\s0\fR structure consists of several \s-1BIGNUM\s0 components.
189 \& BIGNUM *p; // prime number (shared)
190 \& BIGNUM *g; // generator of Z_p (shared)
191 \& BIGNUM *priv_key; // private DH value x
192 \& BIGNUM *pub_key; // public DH value g^x
198 Note that \s-1DH\s0 keys may use non-standard \fB\s-1DH_METHOD\s0\fR implementations,
199 either directly or by the use of \fB\s-1ENGINE\s0\fR modules. In some cases (eg. an
200 \&\s-1ENGINE\s0 providing support for hardware-embedded keys), these \s-1BIGNUM\s0 values
201 will not be used by the implementation or may be used for alternative data
202 storage. For this reason, applications should generally avoid using \s-1DH\s0
203 structure elements directly and instead use \s-1API\s0 functions to query or
206 .IX Header "SEE ALSO"
207 \&\fIdhparam\fR\|(1), \fIbn\fR\|(3), \fIdsa\fR\|(3), \fIerr\fR\|(3),
208 \&\fIrand\fR\|(3), \fIrsa\fR\|(3), \fIengine\fR\|(3),
209 \&\fIDH_set_method\fR\|(3), \fIDH_new\fR\|(3),
210 \&\fIDH_get_ex_new_index\fR\|(3),
211 \&\fIDH_generate_parameters\fR\|(3),
212 \&\fIDH_compute_key\fR\|(3), \fId2i_DHparams\fR\|(3),
213 \&\fIRSA_print\fR\|(3)