diff options
Diffstat (limited to 'src/lib/libcrypto/man/DSA_set_method.3')
-rw-r--r-- | src/lib/libcrypto/man/DSA_set_method.3 | 178 |
1 files changed, 0 insertions, 178 deletions
diff --git a/src/lib/libcrypto/man/DSA_set_method.3 b/src/lib/libcrypto/man/DSA_set_method.3 deleted file mode 100644 index c60a3e29c3..0000000000 --- a/src/lib/libcrypto/man/DSA_set_method.3 +++ /dev/null | |||
@@ -1,178 +0,0 @@ | |||
1 | .\" $OpenBSD: DSA_set_method.3,v 1.12 2024/05/11 06:53:19 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: May 11 2024 $ | ||
52 | .Dt DSA_SET_METHOD 3 | ||
53 | .Os | ||
54 | .Sh NAME | ||
55 | .Nm DSA_set_default_method , | ||
56 | .Nm DSA_get_default_method , | ||
57 | .Nm DSA_set_method , | ||
58 | .Nm DSA_new_method , | ||
59 | .Nm DSA_OpenSSL | ||
60 | .Nd select DSA method | ||
61 | .Sh SYNOPSIS | ||
62 | .In openssl/dsa.h | ||
63 | .Ft void | ||
64 | .Fo DSA_set_default_method | ||
65 | .Fa "const DSA_METHOD *meth" | ||
66 | .Fc | ||
67 | .Ft const DSA_METHOD * | ||
68 | .Fn DSA_get_default_method void | ||
69 | .Ft int | ||
70 | .Fo DSA_set_method | ||
71 | .Fa "DSA *dsa" | ||
72 | .Fa "const DSA_METHOD *meth" | ||
73 | .Fc | ||
74 | .Ft DSA * | ||
75 | .Fo DSA_new_method | ||
76 | .Fa "ENGINE *engine" | ||
77 | .Fc | ||
78 | .Ft DSA_METHOD * | ||
79 | .Fn DSA_OpenSSL void | ||
80 | .Sh DESCRIPTION | ||
81 | A | ||
82 | .Vt DSA_METHOD | ||
83 | object contains pointers to the functions used for DSA operations. | ||
84 | By default, the internal implementation returned by | ||
85 | .Fn DSA_OpenSSL | ||
86 | is used. | ||
87 | By selecting another method, alternative implementations | ||
88 | such as hardware accelerators may be used. | ||
89 | .Pp | ||
90 | .Fn DSA_set_default_method | ||
91 | selects | ||
92 | .Fa meth | ||
93 | as the default method for all | ||
94 | .Vt DSA | ||
95 | structures created later. | ||
96 | .Pp | ||
97 | .Fn DSA_get_default_method | ||
98 | returns a pointer to the current default method. | ||
99 | .Pp | ||
100 | .Fn DSA_set_method | ||
101 | selects | ||
102 | .Fa meth | ||
103 | to perform all operations using the key | ||
104 | .Fa dsa . | ||
105 | This replaces the | ||
106 | .Vt DSA_METHOD | ||
107 | used by the DSA key. | ||
108 | It is possible to have DSA keys that only work with certain | ||
109 | .Vt DSA_METHOD | ||
110 | implementations, | ||
111 | and in such cases attempting to change the | ||
112 | .Vt DSA_METHOD | ||
113 | for the key can have unexpected results. | ||
114 | .Pp | ||
115 | .Fn DSA_new_method | ||
116 | allocates and initializes a | ||
117 | .Vt DSA | ||
118 | structure. | ||
119 | The | ||
120 | .Fa engine | ||
121 | argument is ignored and | ||
122 | the default method controlled by | ||
123 | .Fn DSA_set_default_method | ||
124 | is used. | ||
125 | .Pp | ||
126 | The | ||
127 | .Vt DSA_METHOD | ||
128 | structure is defined as follows: | ||
129 | .Bd -literal | ||
130 | struct { | ||
131 | /* name of the implementation */ | ||
132 | const char *name; | ||
133 | /* sign */ | ||
134 | DSA_SIG *(*dsa_do_sign)(const unsigned char *dgst, int dlen, | ||
135 | DSA *dsa); | ||
136 | /* pre-compute k^-1 and r */ | ||
137 | int (*dsa_sign_setup)(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp, | ||
138 | BIGNUM **rp); | ||
139 | /* verify */ | ||
140 | int (*dsa_do_verify)(const unsigned char *dgst, int dgst_len, | ||
141 | DSA_SIG *sig, DSA *dsa); | ||
142 | /* called at DSA_new */ | ||
143 | int (*init)(DSA *DSA); | ||
144 | /* called at DSA_free */ | ||
145 | int (*finish)(DSA *DSA); | ||
146 | int flags; | ||
147 | } DSA_METHOD; | ||
148 | .Ed | ||
149 | .Sh RETURN VALUES | ||
150 | .Fn DSA_OpenSSL | ||
151 | and | ||
152 | .Fn DSA_get_default_method | ||
153 | return pointers to the respective | ||
154 | .Vt DSA_METHOD . | ||
155 | .Pp | ||
156 | .Fn DSA_set_method | ||
157 | returns 1 on success or 0 on failure. | ||
158 | Currently, it cannot fail. | ||
159 | .Pp | ||
160 | .Fn DSA_new_method | ||
161 | returns | ||
162 | .Dv NULL | ||
163 | and sets an error code that can be obtained by | ||
164 | .Xr ERR_get_error 3 | ||
165 | if the allocation fails. | ||
166 | Otherwise it returns a pointer to the newly allocated structure. | ||
167 | .Sh SEE ALSO | ||
168 | .Xr DSA_meth_new 3 , | ||
169 | .Xr DSA_new 3 | ||
170 | .Sh HISTORY | ||
171 | .Fn DSA_set_default_method , | ||
172 | .Fn DSA_get_default_method , | ||
173 | .Fn DSA_set_method , | ||
174 | .Fn DSA_new_method , | ||
175 | and | ||
176 | .Fn DSA_OpenSSL | ||
177 | first appeared in OpenSSL 0.9.5 and have been available since | ||
178 | .Ox 2.7 . | ||