Merge branch 'vendor/LESS'
[dragonfly.git] / secure / lib / libcrypto / man / DH_set_method.3
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.23)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65 .    \" fudge factors for nroff and troff
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 .    \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "DH_set_method 3"
127 .TH DH_set_method 3 "2013-02-11" "1.0.1e" "OpenSSL"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 DH_set_default_method, DH_get_default_method,
134 DH_set_method, DH_new_method, DH_OpenSSL \- select DH method
135 .SH "SYNOPSIS"
136 .IX Header "SYNOPSIS"
137 .Vb 2
138 \& #include <openssl/dh.h>
139 \& #include <openssl/engine.h>
140 \&
141 \& void DH_set_default_method(const DH_METHOD *meth);
142 \&
143 \& const DH_METHOD *DH_get_default_method(void);
144 \&
145 \& int DH_set_method(DH *dh, const DH_METHOD *meth);
146 \&
147 \& DH *DH_new_method(ENGINE *engine);
148 \&
149 \& const DH_METHOD *DH_OpenSSL(void);
150 .Ve
151 .SH "DESCRIPTION"
152 .IX Header "DESCRIPTION"
153 A \fB\s-1DH_METHOD\s0\fR specifies the functions that OpenSSL uses for Diffie-Hellman
154 operations. By modifying the method, alternative implementations
155 such as hardware accelerators may be used. \s-1IMPORTANT:\s0 See the \s-1NOTES\s0 section for
156 important information about how these \s-1DH\s0 \s-1API\s0 functions are affected by the use
157 of \fB\s-1ENGINE\s0\fR \s-1API\s0 calls.
158 .PP
159 Initially, the default \s-1DH_METHOD\s0 is the OpenSSL internal implementation, as
160 returned by \fIDH_OpenSSL()\fR.
161 .PP
162 \&\fIDH_set_default_method()\fR makes \fBmeth\fR the default method for all \s-1DH\s0
163 structures created later. \fB\s-1NB\s0\fR: This is true only whilst no \s-1ENGINE\s0 has been set
164 as a default for \s-1DH\s0, so this function is no longer recommended.
165 .PP
166 \&\fIDH_get_default_method()\fR returns a pointer to the current default \s-1DH_METHOD\s0.
167 However, the meaningfulness of this result is dependent on whether the \s-1ENGINE\s0
168 \&\s-1API\s0 is being used, so this function is no longer recommended.
169 .PP
170 \&\fIDH_set_method()\fR selects \fBmeth\fR to perform all operations using the key \fBdh\fR.
171 This will replace the \s-1DH_METHOD\s0 used by the \s-1DH\s0 key and if the previous method
172 was supplied by an \s-1ENGINE\s0, the handle to that \s-1ENGINE\s0 will be released during the
173 change. It is possible to have \s-1DH\s0 keys that only work with certain \s-1DH_METHOD\s0
174 implementations (eg. from an \s-1ENGINE\s0 module that supports embedded
175 hardware-protected keys), and in such cases attempting to change the \s-1DH_METHOD\s0
176 for the key can have unexpected results.
177 .PP
178 \&\fIDH_new_method()\fR allocates and initializes a \s-1DH\s0 structure so that \fBengine\fR will
179 be used for the \s-1DH\s0 operations. If \fBengine\fR is \s-1NULL\s0, the default \s-1ENGINE\s0 for \s-1DH\s0
180 operations is used, and if no default \s-1ENGINE\s0 is set, the \s-1DH_METHOD\s0 controlled by
181 \&\fIDH_set_default_method()\fR is used.
182 .SH "THE DH_METHOD STRUCTURE"
183 .IX Header "THE DH_METHOD STRUCTURE"
184 .Vb 4
185 \& typedef struct dh_meth_st
186 \& {
187 \&     /* name of the implementation */
188 \&        const char *name;
189 \&
190 \&     /* generate private and public DH values for key agreement */
191 \&        int (*generate_key)(DH *dh);
192 \&
193 \&     /* compute shared secret */
194 \&        int (*compute_key)(unsigned char *key, BIGNUM *pub_key, DH *dh);
195 \&
196 \&     /* compute r = a ^ p mod m (May be NULL for some implementations) */
197 \&        int (*bn_mod_exp)(DH *dh, BIGNUM *r, BIGNUM *a, const BIGNUM *p,
198 \&                                const BIGNUM *m, BN_CTX *ctx,
199 \&                                BN_MONT_CTX *m_ctx);
200 \&
201 \&     /* called at DH_new */
202 \&        int (*init)(DH *dh);
203 \&
204 \&     /* called at DH_free */
205 \&        int (*finish)(DH *dh);
206 \&
207 \&        int flags;
208 \&
209 \&        char *app_data; /* ?? */
210 \&
211 \& } DH_METHOD;
212 .Ve
213 .SH "RETURN VALUES"
214 .IX Header "RETURN VALUES"
215 \&\fIDH_OpenSSL()\fR and \fIDH_get_default_method()\fR return pointers to the respective
216 \&\fB\s-1DH_METHOD\s0\fRs.
217 .PP
218 \&\fIDH_set_default_method()\fR returns no value.
219 .PP
220 \&\fIDH_set_method()\fR returns non-zero if the provided \fBmeth\fR was successfully set as
221 the method for \fBdh\fR (including unloading the \s-1ENGINE\s0 handle if the previous
222 method was supplied by an \s-1ENGINE\s0).
223 .PP
224 \&\fIDH_new_method()\fR returns \s-1NULL\s0 and sets an error code that can be obtained by
225 \&\fIERR_get_error\fR\|(3) if the allocation fails. Otherwise it
226 returns a pointer to the newly allocated structure.
227 .SH "NOTES"
228 .IX Header "NOTES"
229 As of version 0.9.7, \s-1DH_METHOD\s0 implementations are grouped together with other
230 algorithmic APIs (eg. \s-1RSA_METHOD\s0, \s-1EVP_CIPHER\s0, etc) in \fB\s-1ENGINE\s0\fR modules. If a
231 default \s-1ENGINE\s0 is specified for \s-1DH\s0 functionality using an \s-1ENGINE\s0 \s-1API\s0 function,
232 that will override any \s-1DH\s0 defaults set using the \s-1DH\s0 \s-1API\s0 (ie.
233 \&\fIDH_set_default_method()\fR). For this reason, the \s-1ENGINE\s0 \s-1API\s0 is the recommended way
234 to control default implementations for use in \s-1DH\s0 and other cryptographic
235 algorithms.
236 .SH "SEE ALSO"
237 .IX Header "SEE ALSO"
238 \&\fIdh\fR\|(3), \fIDH_new\fR\|(3)
239 .SH "HISTORY"
240 .IX Header "HISTORY"
241 \&\fIDH_set_default_method()\fR, \fIDH_get_default_method()\fR, \fIDH_set_method()\fR,
242 \&\fIDH_new_method()\fR and \fIDH_OpenSSL()\fR were added in OpenSSL 0.9.4.
243 .PP
244 \&\fIDH_set_default_openssl_method()\fR and \fIDH_get_default_openssl_method()\fR replaced
245 \&\fIDH_set_default_method()\fR and \fIDH_get_default_method()\fR respectively, and
246 \&\fIDH_set_method()\fR and \fIDH_new_method()\fR were altered to use \fB\s-1ENGINE\s0\fRs rather than
247 \&\fB\s-1DH_METHOD\s0\fRs during development of the engine version of OpenSSL 0.9.6. For
248 0.9.7, the handling of defaults in the \s-1ENGINE\s0 \s-1API\s0 was restructured so that this
249 change was reversed, and behaviour of the other functions resembled more closely
250 the previous behaviour. The behaviour of defaults in the \s-1ENGINE\s0 \s-1API\s0 now
251 transparently overrides the behaviour of defaults in the \s-1DH\s0 \s-1API\s0 without
252 requiring changing these function prototypes.