summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/ENGINE_set_RSA.3
diff options
context:
space:
mode:
authortb <>2023-11-19 10:36:14 +0000
committertb <>2023-11-19 10:36:14 +0000
commitf5ed05316824ad237b1e00ea6981f83619de0209 (patch)
treedddd317bf1ee16b443c461d546f730dd54433df1 /src/lib/libcrypto/man/ENGINE_set_RSA.3
parent804762513590f41c1b78252a3d44d2c96c3d6139 (diff)
downloadopenbsd-f5ed05316824ad237b1e00ea6981f83619de0209.tar.gz
openbsd-f5ed05316824ad237b1e00ea6981f83619de0209.tar.bz2
openbsd-f5ed05316824ad237b1e00ea6981f83619de0209.zip
Remove remaining ENGINE manuals
They document functionality that no longer exists.
Diffstat (limited to 'src/lib/libcrypto/man/ENGINE_set_RSA.3')
-rw-r--r--src/lib/libcrypto/man/ENGINE_set_RSA.3317
1 files changed, 0 insertions, 317 deletions
diff --git a/src/lib/libcrypto/man/ENGINE_set_RSA.3 b/src/lib/libcrypto/man/ENGINE_set_RSA.3
deleted file mode 100644
index b2cec473bd..0000000000
--- a/src/lib/libcrypto/man/ENGINE_set_RSA.3
+++ /dev/null
@@ -1,317 +0,0 @@
1.\" $OpenBSD: ENGINE_set_RSA.3,v 1.7 2023/07/21 04:29:27 tb Exp $
2.\" content checked up to:
3.\" OpenSSL ENGINE_add 1f13ad31 Dec 25 17:50:39 2017 +0800
4.\"
5.\" Copyright (c) 2018 Ingo Schwarze <schwarze@openbsd.org>
6.\"
7.\" Permission to use, copy, modify, and distribute this software for any
8.\" purpose with or without fee is hereby granted, provided that the above
9.\" copyright notice and this permission notice appear in all copies.
10.\"
11.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18.\"
19.Dd $Mdocdate: July 21 2023 $
20.Dt ENGINE_SET_RSA 3
21.Os
22.Sh NAME
23.Nm ENGINE_set_RSA ,
24.Nm ENGINE_get_RSA ,
25.Nm ENGINE_set_DSA ,
26.Nm ENGINE_get_DSA ,
27.Nm ENGINE_set_EC ,
28.Nm ENGINE_get_EC ,
29.Nm ENGINE_set_DH ,
30.Nm ENGINE_get_DH ,
31.Nm ENGINE_set_RAND ,
32.Nm ENGINE_get_RAND ,
33.Nm ENGINE_set_STORE ,
34.Nm ENGINE_get_STORE ,
35.Nm ENGINE_set_ciphers ,
36.Nm ENGINE_get_ciphers ,
37.Nm ENGINE_get_cipher ,
38.Nm ENGINE_set_digests ,
39.Nm ENGINE_get_digests ,
40.Nm ENGINE_get_digest
41.Nd install and retrieve function tables of crypto engines
42.Sh SYNOPSIS
43.In openssl/engine.h
44.Ft int
45.Fo ENGINE_set_RSA
46.Fa "ENGINE *e"
47.Fa "const RSA_METHOD *rsa_meth"
48.Fc
49.Ft const RSA_METHOD *
50.Fo ENGINE_get_RSA
51.Fa "const ENGINE *e"
52.Fc
53.Ft int
54.Fo ENGINE_set_DSA
55.Fa "ENGINE *e"
56.Fa "const DSA_METHOD *dsa_meth"
57.Fc
58.Ft const DSA_METHOD *
59.Fo ENGINE_get_DSA
60.Fa "const ENGINE *e"
61.Fc
62.Ft int
63.Fo ENGINE_set_EC
64.Fa "ENGINE *e"
65.Fa "const EC_KEY_METHOD *ec_meth"
66.Fc
67.Ft const EC_KEY_METHOD *
68.Fo ENGINE_get_EC
69.Fa "const ENGINE *e"
70.Fc
71.Ft int
72.Fo ENGINE_set_DH
73.Fa "ENGINE *e"
74.Fa "const DH_METHOD *dh_meth"
75.Fc
76.Ft const DH_METHOD *
77.Fo ENGINE_get_DH
78.Fa "const ENGINE *e"
79.Fc
80.Ft int
81.Fo ENGINE_set_RAND
82.Fa "ENGINE *e"
83.Fa "const RAND_METHOD *rand_meth"
84.Fc
85.Ft const RAND_METHOD *
86.Fo ENGINE_get_RAND
87.Fa "const ENGINE *e"
88.Fc
89.Ft int
90.Fo ENGINE_set_STORE
91.Fa "ENGINE *e"
92.Fa "const STORE_METHOD *rand_meth"
93.Fc
94.Ft const STORE_METHOD *
95.Fo ENGINE_get_STORE
96.Fa "const ENGINE *e"
97.Fc
98.Ft typedef int
99.Fo (*ENGINE_CIPHERS_PTR)
100.Fa "ENGINE *e"
101.Fa "const EVP_CIPHER **impl"
102.Fa "const int **nids"
103.Fa "int nid"
104.Fc
105.Ft int
106.Fo ENGINE_set_ciphers
107.Fa "ENGINE *e"
108.Fa "ENGINE_CIPHERS_PTR f"
109.Fc
110.Ft ENGINE_CIPHERS_PTR
111.Fo ENGINE_get_ciphers
112.Fa "const ENGINE *e"
113.Fc
114.Ft const EVP_CIPHER *
115.Fo ENGINE_get_cipher
116.Fa "ENGINE *e"
117.Fa "int nid"
118.Fc
119.Ft typedef int
120.Fo (*ENGINE_DIGESTS_PTR)
121.Fa "ENGINE *e"
122.Fa "const EVP_MD **impl"
123.Fa "const int **nids"
124.Fa "int nid"
125.Fc
126.Ft int
127.Fo ENGINE_set_digests
128.Fa "ENGINE *e"
129.Fa "ENGINE_DIGESTS_PTR f"
130.Fc
131.Ft ENGINE_DIGESTS_PTR
132.Fo ENGINE_get_digests
133.Fa "const ENGINE *e"
134.Fc
135.Ft const EVP_MD *
136.Fo ENGINE_get_digest
137.Fa "ENGINE *e"
138.Fa "int nid"
139.Fc
140.Sh DESCRIPTION
141The
142.Fn ENGINE_set_*
143functions install a table of function pointers
144implementing the respective algorithm in
145.Fa e .
146Partial information about the various method objects is available from
147.Xr RSA_meth_new 3 ,
148.Xr RSA_get_default_method 3 ,
149.Xr DSA_meth_new 3 ,
150.Xr DSA_get_default_method 3 ,
151.Xr EC_KEY_get_default_method 3 ,
152.Xr DH_get_default_method 3 ,
153.Xr RAND_get_rand_method 3 ,
154.Xr EVP_get_cipherbynid 3 ,
155and
156.Xr EVP_get_digestbynid 3 .
157.Vt STORE_METHOD
158is an incomplete type, and the pointers to it are not used for anything.
159For complete descriptions of these types,
160refer to the respective header files.
161.Pp
162The functions described in the
163.Xr ENGINE_register_RSA 3
164and
165.Xr ENGINE_set_default 3
166manual pages only have an effect after function pointers
167were installed using the functions described here.
168.Pp
169.Fn ENGINE_set_ciphers
170and
171.Fn ENGINE_set_digests
172are special in so far as the
173.Vt ENGINE
174structure does not provide fields to store function pointers
175implementing ciphers or digests.
176Instead, these two functions only install a callback to
177retrieve implementations.
178Where the pointers to the implementations are stored internally,
179how they get initialized, and how the
180.Vt ENGINE_CIPHERS_PTR
181and
182.Vt ENGINE_DIGESTS_PTR
183callbacks retrieve them
184is up to the implementation of each individual engine.
185.Pp
186If the
187.Vt ENGINE_CIPHERS_PTR
188and
189.Vt ENGINE_DIGESTS_PTR
190callbacks are called with a non-zero
191.Fa nid ,
192they retrieve the implementation of that cipher or digest,
193respectively.
194In this case, a
195.Dv NULL
196pointer can be passed as the
197.Fa nids
198argument.
199.Fn ENGINE_get_cipher
200and
201.Fn ENGINE_get_digest
202call the callbacks installed in
203.Fa e
204in this way.
205.Pp
206If 0 is passed as the
207.Fa nid
208argument, an internal pointer
209to the array of implementations available in
210.Fa e
211is returned in
212.Pf * Fa impl ,
213and an internal pointer
214to the array of corresponding identifiers in
215.Pf * Fa nids .
216The return value of the callback indicates
217the number of implementations returned.
218.Pp
219The
220.Fn ENGINE_get_*
221functions retrieve the previously installed function tables.
222They are used when constructing basic cryptographic objects
223as shown in the following table:
224.Bl -column "ENGINE_get_digestMM"
225.It Accessor: Ta Called by:
226.It Fn ENGINE_get_RSA Ta Xr RSA_new_method 3 , Xr RSA_new 3
227.It Fn ENGINE_get_DSA Ta Xr DSA_new_method 3 , Xr DSA_new 3
228.It Fn ENGINE_get_EC Ta Xr EC_KEY_new_method 3 , Xr EC_KEY_new 3 ,
229.Xr EC_KEY_new_by_curve_name 3
230.It Fn ENGINE_get_DH Ta Xr DH_new_method 3 , Xr DH_new 3
231.It Fn ENGINE_get_RAND Ta unused
232.It Fn ENGINE_get_STORE Ta unused
233.It Fn ENGINE_get_cipher Ta Xr EVP_CipherInit_ex 3
234.It Fn ENGINE_get_digest Ta Xr EVP_DigestInit_ex 3
235.El
236.Sh RETURN VALUES
237The
238.Fn ENGINE_set_*
239functions return 1 on success or 0 on error.
240Currently, they cannot fail.
241.Pp
242The
243.Fn ENGINE_get_*
244functions return a method object for the respective algorithm, or
245.Dv NULL
246if none is installed.
247.Pp
248.Fn ENGINE_get_ciphers
249and
250.Fn ENGINE_get_digests
251return a function pointer to the respective callback, or
252.Dv NULL
253if none is installed.
254.Pp
255.Fn ENGINE_get_cipher
256returns an
257.Vt EVP_CIPHER
258object implementing the cipher
259.Fa nid
260or
261.Dv NULL
262if
263.Fa e
264does not implement that cipher.
265.Pp
266.Fn ENGINE_get_digest
267returns an
268.Vt EVP_MD
269object implementing the digest
270.Fa nid
271or
272.Dv NULL
273if
274.Fa e
275does not implement that digest.
276.Sh SEE ALSO
277.Xr DSA_new 3 ,
278.Xr ENGINE_ctrl 3 ,
279.Xr ENGINE_new 3 ,
280.Xr ENGINE_register_RSA 3 ,
281.Xr ENGINE_set_default 3 ,
282.Xr ENGINE_set_flags 3 ,
283.Xr EVP_DigestInit 3 ,
284.Xr EVP_EncryptInit 3 ,
285.Xr RSA_new 3
286.Sh HISTORY
287.Fn ENGINE_set_RSA ,
288.Fn ENGINE_get_RSA ,
289.Fn ENGINE_set_DSA ,
290.Fn ENGINE_get_DSA ,
291.Fn ENGINE_set_DH ,
292.Fn ENGINE_get_DH ,
293.Fn ENGINE_set_RAND ,
294.Fn ENGINE_get_RAND ,
295first appeared in OpenSSL 0.9.7 and have been available since
296.Ox 2.9 .
297.Pp
298.Fn ENGINE_set_ciphers ,
299.Fn ENGINE_get_ciphers ,
300.Fn ENGINE_get_cipher ,
301.Fn ENGINE_set_digests ,
302.Fn ENGINE_get_digests ,
303and
304.Fn ENGINE_get_digest
305first appeared in OpenSSL 0.9.7 and have been available since
306.Ox 3.2 .
307.Pp
308.Fn ENGINE_set_STORE
309and
310.Fn ENGINE_get_STORE
311first appeared in OpenSSL 0.9.8 and have been available since
312.Ox 4.5 .
313.Fn ENGINE_set_EC
314and
315.Fn ENGINE_get_EC
316first appeared in OpenSSL 1.1.0 and have been available since
317.Ox 6.5 .