diff options
author | cvs2svn <admin@example.com> | 2025-04-14 17:32:06 +0000 |
---|---|---|
committer | cvs2svn <admin@example.com> | 2025-04-14 17:32:06 +0000 |
commit | eb8dd9dca1228af0cd132f515509051ecfabf6f6 (patch) | |
tree | edb6da6af7e865d488dc1a29309f1e1ec226e603 /src/lib/libcrypto/man/DH_set_method.3 | |
parent | 247f0352e0ed72a4f476db9dc91f4d982bc83eb2 (diff) | |
download | openbsd-tb_20250414.tar.gz openbsd-tb_20250414.tar.bz2 openbsd-tb_20250414.zip |
This commit was manufactured by cvs2git to create tag 'tb_20250414'.tb_20250414
Diffstat (limited to 'src/lib/libcrypto/man/DH_set_method.3')
-rw-r--r-- | src/lib/libcrypto/man/DH_set_method.3 | 195 |
1 files changed, 0 insertions, 195 deletions
diff --git a/src/lib/libcrypto/man/DH_set_method.3 b/src/lib/libcrypto/man/DH_set_method.3 deleted file mode 100644 index 70cf367c9d..0000000000 --- a/src/lib/libcrypto/man/DH_set_method.3 +++ /dev/null | |||
@@ -1,195 +0,0 @@ | |||
1 | .\" $OpenBSD: DH_set_method.3,v 1.9 2023/11/19 10:34:26 tb Exp $ | ||
2 | .\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 | ||
3 | .\" | ||
4 | .\" This file was written by Ulf Moeller <ulf@openssl.org>. | ||
5 | .\" Copyright (c) 2000, 2002, 2007 The OpenSSL Project. All rights reserved. | ||
6 | .\" | ||
7 | .\" Redistribution and use in source and binary forms, with or without | ||
8 | .\" modification, are permitted provided that the following conditions | ||
9 | .\" are met: | ||
10 | .\" | ||
11 | .\" 1. Redistributions of source code must retain the above copyright | ||
12 | .\" notice, this list of conditions and the following disclaimer. | ||
13 | .\" | ||
14 | .\" 2. Redistributions in binary form must reproduce the above copyright | ||
15 | .\" notice, this list of conditions and the following disclaimer in | ||
16 | .\" the documentation and/or other materials provided with the | ||
17 | .\" distribution. | ||
18 | .\" | ||
19 | .\" 3. All advertising materials mentioning features or use of this | ||
20 | .\" software must display the following acknowledgment: | ||
21 | .\" "This product includes software developed by the OpenSSL Project | ||
22 | .\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" | ||
23 | .\" | ||
24 | .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to | ||
25 | .\" endorse or promote products derived from this software without | ||
26 | .\" prior written permission. For written permission, please contact | ||
27 | .\" openssl-core@openssl.org. | ||
28 | .\" | ||
29 | .\" 5. Products derived from this software may not be called "OpenSSL" | ||
30 | .\" nor may "OpenSSL" appear in their names without prior written | ||
31 | .\" permission of the OpenSSL Project. | ||
32 | .\" | ||
33 | .\" 6. Redistributions of any form whatsoever must retain the following | ||
34 | .\" acknowledgment: | ||
35 | .\" "This product includes software developed by the OpenSSL Project | ||
36 | .\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" | ||
37 | .\" | ||
38 | .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY | ||
39 | .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
40 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
41 | .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR | ||
42 | .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
43 | .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT | ||
44 | .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
45 | .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
46 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | ||
47 | .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
48 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | ||
49 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | ||
50 | .\" | ||
51 | .Dd $Mdocdate: November 19 2023 $ | ||
52 | .Dt DH_SET_METHOD 3 | ||
53 | .Os | ||
54 | .Sh NAME | ||
55 | .Nm DH_set_default_method , | ||
56 | .Nm DH_get_default_method , | ||
57 | .Nm DH_set_method , | ||
58 | .Nm DH_new_method , | ||
59 | .Nm DH_OpenSSL | ||
60 | .Nd select DH method | ||
61 | .Sh SYNOPSIS | ||
62 | .In openssl/dh.h | ||
63 | .Ft void | ||
64 | .Fo DH_set_default_method | ||
65 | .Fa "const DH_METHOD *meth" | ||
66 | .Fc | ||
67 | .Ft const DH_METHOD * | ||
68 | .Fo DH_get_default_method | ||
69 | .Fa void | ||
70 | .Fc | ||
71 | .Ft int | ||
72 | .Fo DH_set_method | ||
73 | .Fa "DH *dh" | ||
74 | .Fa "const DH_METHOD *meth" | ||
75 | .Fc | ||
76 | .Ft DH * | ||
77 | .Fo DH_new_method | ||
78 | .Fa "ENGINE *engine" | ||
79 | .Fc | ||
80 | .Ft const DH_METHOD * | ||
81 | .Fo DH_OpenSSL | ||
82 | .Fa void | ||
83 | .Fc | ||
84 | .Sh DESCRIPTION | ||
85 | A | ||
86 | .Vt DH_METHOD | ||
87 | object contains pointers to the functions | ||
88 | used for Diffie-Hellman operations. | ||
89 | By default, the internal implementation returned by | ||
90 | .Fn DH_OpenSSL | ||
91 | is used. | ||
92 | By selecting another method, alternative implementations | ||
93 | such as hardware accelerators may be used. | ||
94 | .Pp | ||
95 | .Fn DH_set_default_method | ||
96 | selects | ||
97 | .Fa meth | ||
98 | as the default method for all | ||
99 | .Vt DH | ||
100 | structures created later. | ||
101 | .Pp | ||
102 | .Fn DH_get_default_method | ||
103 | returns a pointer to the current default method. | ||
104 | .Pp | ||
105 | .Fn DH_set_method | ||
106 | selects | ||
107 | .Fa meth | ||
108 | to perform all operations using the key | ||
109 | .Fa dh . | ||
110 | This replaces the | ||
111 | .Vt DH_METHOD | ||
112 | used by the | ||
113 | .Fa dh | ||
114 | key. | ||
115 | It is possible to have | ||
116 | .Vt DH | ||
117 | keys that only work with certain | ||
118 | .Vt DH_METHOD | ||
119 | implementations, | ||
120 | and in such cases attempting to change the | ||
121 | .Vt DH_METHOD | ||
122 | for the key can have unexpected results. | ||
123 | .Pp | ||
124 | .Fn DH_new_method | ||
125 | allocates and initializes a | ||
126 | .Vt DH | ||
127 | structure. | ||
128 | The | ||
129 | .Fa engine | ||
130 | argument is ignored and | ||
131 | the default method controlled by | ||
132 | .Fn DH_set_default_method | ||
133 | is used. | ||
134 | .Pp | ||
135 | The | ||
136 | .Vt DH_METHOD | ||
137 | structure is defined as follows: | ||
138 | .Bd -literal | ||
139 | typedef struct dh_meth_st | ||
140 | { | ||
141 | /* name of the implementation */ | ||
142 | const char *name; | ||
143 | |||
144 | /* generate private and public DH values for key agreement */ | ||
145 | int (*generate_key)(DH *dh); | ||
146 | |||
147 | /* compute shared secret */ | ||
148 | int (*compute_key)(unsigned char *key, BIGNUM *pub_key, DH *dh); | ||
149 | |||
150 | /* compute r = a ^ p mod m (May be NULL for some implementations) */ | ||
151 | int (*bn_mod_exp)(DH *dh, BIGNUM *r, BIGNUM *a, const BIGNUM *p, | ||
152 | const BIGNUM *m, BN_CTX *ctx, | ||
153 | BN_MONT_CTX *m_ctx); | ||
154 | |||
155 | /* called at DH_new */ | ||
156 | int (*init)(DH *dh); | ||
157 | |||
158 | /* called at DH_free */ | ||
159 | int (*finish)(DH *dh); | ||
160 | |||
161 | int flags; | ||
162 | |||
163 | char *app_data; /* ?? */ | ||
164 | |||
165 | } DH_METHOD; | ||
166 | .Ed | ||
167 | .Sh RETURN VALUES | ||
168 | .Fn DH_OpenSSL | ||
169 | and | ||
170 | .Fn DH_get_default_method | ||
171 | return pointers to the respective | ||
172 | .Vt DH_METHOD . | ||
173 | .Pp | ||
174 | .Fn DH_set_method | ||
175 | returns 1 on success or 0 on failure. | ||
176 | Currently, it cannot fail. | ||
177 | .Pp | ||
178 | .Fn DH_new_method | ||
179 | returns | ||
180 | .Dv NULL | ||
181 | and sets an error code that can be obtained by | ||
182 | .Xr ERR_get_error 3 | ||
183 | if the allocation fails. | ||
184 | Otherwise it returns a pointer to the newly allocated structure. | ||
185 | .Sh SEE ALSO | ||
186 | .Xr DH_new 3 | ||
187 | .Sh HISTORY | ||
188 | .Fn DH_set_default_method , | ||
189 | .Fn DH_get_default_method , | ||
190 | .Fn DH_set_method , | ||
191 | .Fn DH_new_method | ||
192 | and | ||
193 | .Fn DH_OpenSSL | ||
194 | first appeared in OpenSSL 0.9.5 and have been available since | ||
195 | .Ox 2.7 . | ||