diff options
author | schwarze <> | 2022-07-10 13:41:59 +0000 |
---|---|---|
committer | schwarze <> | 2022-07-10 13:41:59 +0000 |
commit | 7d887b9aa507bc493c58cc3a0f9ba22de1287268 (patch) | |
tree | 69450f4db8ab267a0dca45a8931530eb3c57a09d /src | |
parent | 82296349ff9ff9c896000f4c948ebdfd211a13b7 (diff) | |
download | openbsd-7d887b9aa507bc493c58cc3a0f9ba22de1287268.tar.gz openbsd-7d887b9aa507bc493c58cc3a0f9ba22de1287268.tar.bz2 openbsd-7d887b9aa507bc493c58cc3a0f9ba22de1287268.zip |
In dsa.h rev. 1.38, tb@ provided DSA_meth_get0_name(3)
and DSA_meth_set1_name(3).
Merge the documentation from the OpenSSL 1.1.1 branch, which
is still under a free license, significantly tweaked by me.
Diffstat (limited to 'src')
-rw-r--r-- | src/lib/libcrypto/man/DSA_meth_new.3 | 63 |
1 files changed, 55 insertions, 8 deletions
diff --git a/src/lib/libcrypto/man/DSA_meth_new.3 b/src/lib/libcrypto/man/DSA_meth_new.3 index 0c4b166a29..d89cd397b0 100644 --- a/src/lib/libcrypto/man/DSA_meth_new.3 +++ b/src/lib/libcrypto/man/DSA_meth_new.3 | |||
@@ -1,10 +1,10 @@ | |||
1 | .\" $OpenBSD: DSA_meth_new.3,v 1.2 2022/01/15 23:38:50 jsg Exp $ | 1 | .\" $OpenBSD: DSA_meth_new.3,v 1.3 2022/07/10 13:41:59 schwarze Exp $ |
2 | .\" selective merge up to: OpenSSL a970b14f Jul 31 18:58:40 2017 -0400 | 2 | .\" selective merge up to: OpenSSL c4d3c19b Apr 3 13:57:12 2018 +0100 |
3 | .\" | 3 | .\" |
4 | .\" This file is a derived work. | 4 | .\" This file is a derived work. |
5 | .\" The changes are covered by the following Copyright and license: | 5 | .\" The changes are covered by the following Copyright and license: |
6 | .\" | 6 | .\" |
7 | .\" Copyright (c) 2018 Ingo Schwarze <schwarze@openbsd.org> | 7 | .\" Copyright (c) 2018, 2022 Ingo Schwarze <schwarze@openbsd.org> |
8 | .\" | 8 | .\" |
9 | .\" Permission to use, copy, modify, and distribute this software for any | 9 | .\" Permission to use, copy, modify, and distribute this software for any |
10 | .\" purpose with or without fee is hereby granted, provided that the above | 10 | .\" purpose with or without fee is hereby granted, provided that the above |
@@ -65,13 +65,15 @@ | |||
65 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | 65 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
66 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | 66 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. |
67 | .\" | 67 | .\" |
68 | .Dd $Mdocdate: January 15 2022 $ | 68 | .Dd $Mdocdate: July 10 2022 $ |
69 | .Dt DSA_METH_NEW 3 | 69 | .Dt DSA_METH_NEW 3 |
70 | .Os | 70 | .Os |
71 | .Sh NAME | 71 | .Sh NAME |
72 | .Nm DSA_meth_new , | 72 | .Nm DSA_meth_new , |
73 | .Nm DSA_meth_free , | 73 | .Nm DSA_meth_free , |
74 | .Nm DSA_meth_dup , | 74 | .Nm DSA_meth_dup , |
75 | .Nm DSA_meth_get0_name , | ||
76 | .Nm DSA_meth_set1_name , | ||
75 | .Nm DSA_meth_set_sign , | 77 | .Nm DSA_meth_set_sign , |
76 | .Nm DSA_meth_set_finish | 78 | .Nm DSA_meth_set_finish |
77 | .Nd build up DSA methods | 79 | .Nd build up DSA methods |
@@ -90,6 +92,15 @@ | |||
90 | .Fo DSA_meth_dup | 92 | .Fo DSA_meth_dup |
91 | .Fa "const DSA_METHOD *meth" | 93 | .Fa "const DSA_METHOD *meth" |
92 | .Fc | 94 | .Fc |
95 | .Ft const char * | ||
96 | .Fo DSA_meth_get0_name | ||
97 | .Fa "const DSA_METHOD *meth" | ||
98 | .Fc | ||
99 | .Ft int | ||
100 | .Fo DSA_meth_set1_name | ||
101 | .Fa "DSA_METHOD *meth" | ||
102 | .Fa "const char *name" | ||
103 | .Fc | ||
93 | .Ft int | 104 | .Ft int |
94 | .Fo DSA_meth_set_sign | 105 | .Fo DSA_meth_set_sign |
95 | .Fa "DSA_METHOD *meth" | 106 | .Fa "DSA_METHOD *meth" |
@@ -134,6 +145,18 @@ destroys | |||
134 | .Fa meth | 145 | .Fa meth |
135 | and frees any memory associated with it. | 146 | and frees any memory associated with it. |
136 | .Pp | 147 | .Pp |
148 | .Fn DSA_meth_get0_name | ||
149 | returns an internal pointer to the name of | ||
150 | .Fa meth . | ||
151 | .Fn DSA_meth_set1_name | ||
152 | stores a copy of the NUL-terminated | ||
153 | .Fa name | ||
154 | in | ||
155 | .Fa meth | ||
156 | after freeing the previously stored name. | ||
157 | Method names are ignored by the default DSA implementation but can be | ||
158 | used by alternative implementations and by the application program. | ||
159 | .Pp | ||
137 | .Fn DSA_meth_set_sign | 160 | .Fn DSA_meth_set_sign |
138 | sets the function used for creating a DSA signature. | 161 | sets the function used for creating a DSA signature. |
139 | This function will be called from | 162 | This function will be called from |
@@ -166,11 +189,22 @@ function. | |||
166 | .Fn DSA_meth_new | 189 | .Fn DSA_meth_new |
167 | and | 190 | and |
168 | .Fn DSA_meth_dup | 191 | .Fn DSA_meth_dup |
169 | return the newly allocated DSA_METHOD object or NULL on failure. | 192 | return the newly allocated |
193 | .Vt DSA_METHOD | ||
194 | object or | ||
195 | .Dv NULL | ||
196 | on failure. | ||
170 | .Pp | 197 | .Pp |
171 | All | 198 | .Fn DSA_meth_get0_name |
199 | returns an internal pointer which must not be freed by the caller. | ||
200 | .Pp | ||
201 | .Fn DSA_meth_set1_name | ||
202 | and all | ||
172 | .Fn DSA_meth_set_* | 203 | .Fn DSA_meth_set_* |
173 | functions return 1 on success or 0 on failure. | 204 | functions return 1 on success or 0 on failure. |
205 | In the current implementation, only | ||
206 | .Fn DSA_meth_set1_name | ||
207 | can actually fail. | ||
174 | .Sh SEE ALSO | 208 | .Sh SEE ALSO |
175 | .Xr DSA_do_sign 3 , | 209 | .Xr DSA_do_sign 3 , |
176 | .Xr DSA_new 3 , | 210 | .Xr DSA_new 3 , |
@@ -178,6 +212,19 @@ functions return 1 on success or 0 on failure. | |||
178 | .Xr DSA_SIG_new 3 , | 212 | .Xr DSA_SIG_new 3 , |
179 | .Xr DSA_sign 3 | 213 | .Xr DSA_sign 3 |
180 | .Sh HISTORY | 214 | .Sh HISTORY |
181 | These functions first appeared in OpenSSL 1.1.0 | 215 | These functions first appeared in OpenSSL 1.1.0. |
182 | and have been available since | 216 | .Pp |
217 | .Fn DSA_meth_new , | ||
218 | .Fn DSA_meth_free , | ||
219 | .Fn DSA_meth_dup , | ||
220 | .Fn DSA_meth_set_sign , | ||
221 | and | ||
222 | .Fn DSA_meth_set_finish | ||
223 | have been available since | ||
183 | .Ox 6.3 . | 224 | .Ox 6.3 . |
225 | .Pp | ||
226 | .Fn DSA_meth_get0_name | ||
227 | and | ||
228 | .Fn DSA_meth_set1_name | ||
229 | have been available since | ||
230 | .Ox 7.2 . | ||