summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/ENGINE_add.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_add.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_add.3')
-rw-r--r--src/lib/libcrypto/man/ENGINE_add.3243
1 files changed, 0 insertions, 243 deletions
diff --git a/src/lib/libcrypto/man/ENGINE_add.3 b/src/lib/libcrypto/man/ENGINE_add.3
deleted file mode 100644
index 4ae878b4f5..0000000000
--- a/src/lib/libcrypto/man/ENGINE_add.3
+++ /dev/null
@@ -1,243 +0,0 @@
1.\" $OpenBSD: ENGINE_add.3,v 1.3 2018/04/18 03:39:22 schwarze Exp $
2.\" content checked up to: OpenSSL 1f13ad31 Dec 25 17:50:39 2017 +0800
3.\"
4.\" Copyright (c) 2018 Ingo Schwarze <schwarze@openbsd.org>
5.\"
6.\" Permission to use, copy, modify, and distribute this software for any
7.\" purpose with or without fee is hereby granted, provided that the above
8.\" copyright notice and this permission notice appear in all copies.
9.\"
10.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17.\"
18.Dd $Mdocdate: April 18 2018 $
19.Dt ENGINE_ADD 3
20.Os
21.Sh NAME
22.Nm ENGINE_add ,
23.Nm ENGINE_set_id ,
24.Nm ENGINE_get_id ,
25.Nm ENGINE_set_name ,
26.Nm ENGINE_get_name ,
27.Nm ENGINE_remove ,
28.Nm ENGINE_cleanup ,
29.Nm ENGINE_get_first ,
30.Nm ENGINE_get_last ,
31.Nm ENGINE_get_next ,
32.Nm ENGINE_get_prev ,
33.Nm ENGINE_by_id
34.Nd maintain a global list of ENGINE objects
35.Sh SYNOPSIS
36.In openssl/engine.h
37.Ft int
38.Fo ENGINE_add
39.Fa "ENGINE *e"
40.Fc
41.Ft int
42.Fo ENGINE_set_id
43.Fa "ENGINE *e"
44.Fa "const char *id"
45.Fc
46.Ft const char *
47.Fo ENGINE_get_id
48.Fa "const ENGINE *e"
49.Fc
50.Ft int
51.Fo ENGINE_set_name
52.Fa "ENGINE *e"
53.Fa "const char *name"
54.Fc
55.Ft const char *
56.Fo ENGINE_get_name
57.Fa "const ENGINE *e"
58.Fc
59.Ft int
60.Fo ENGINE_remove
61.Fa "ENGINE *e"
62.Fc
63.Ft void
64.Fn ENGINE_cleanup void
65.Ft ENGINE *
66.Fn ENGINE_get_first void
67.Ft ENGINE *
68.Fn ENGINE_get_last void
69.Ft ENGINE *
70.Fo ENGINE_get_next
71.Fa "ENGINE *e"
72.Fc
73.Ft ENGINE *
74.Fo ENGINE_get_prev
75.Fa "ENGINE *e"
76.Fc
77.Ft ENGINE *
78.Fo ENGINE_by_id
79.Fa "const char *id"
80.Fc
81.Sh DESCRIPTION
82The crypto library maintains a global list of
83.Vt ENGINE
84objects.
85.Pp
86.Fn ENGINE_add
87appends
88.Fa e
89to the end of the list
90and increments its structural reference count by 1.
91A unique identifier and a name of
92.Fa e
93have to be set with
94.Fn ENGINE_set_id
95and
96.Fn ENGINE_set_name
97before calling this function.
98.Fn ENGINE_add
99fails if the list already contains an
100.Vt ENGINE
101with the same identifier.
102.Pp
103.Fn ENGINE_remove
104removes
105.Fa e
106from the list.
107If successful, it calls
108.Xr ENGINE_free 3
109on
110.Fa e .
111.Pp
112.Fn ENGINE_cleanup
113calls
114.Xr ENGINE_finish 3
115on all
116.Vt ENGINE
117objects that were selected as default engines, for example using the
118functions documented in the
119.Xr ENGINE_set_default 3
120and
121.Xr ENGINE_get_default_RSA 3
122manual pages, and it calls
123.Fn ENGINE_remove
124on all
125.Vt ENGINE
126objects that were added to the global list with
127.Fn ENGINE_add .
128Calling this function is required at the end of each program using
129.Fn ENGINE_add ,
130even if no engines are explicitly registered or used.
131.Pp
132.Fn ENGINE_get_first
133and
134.Fn ENGINE_get_last
135provide access to the first and last
136.Vt ENGINE
137object on the list, respectively.
138Unless the list is empty, they increment the structural reference
139count of the retrieved object by 1.
140.Pp
141.Fn ENGINE_get_next
142and
143.Fn ENGINE_get_prev
144support iteration of the list.
145They always call
146.Xr ENGINE_free 3
147on
148.Fa e .
149Unless the end of the list is reached, they increment the structural
150reference count of the retrieved object by 1.
151.Pp
152.Fn ENGINE_by_id
153searches the list for an
154.Vt ENGINE
155object with a matching
156.Fa id .
157If found, it increments the structural reference count of the
158retrieved object by 1.
159If
160.Dv ENGINE_FLAGS_BY_ID_COPY
161was set on
162.Fa e
163with
164.Xr ENGINE_set_flags 3 ,
165it returns a shallow copy of the object rather than incrementing
166the reference count and returning a pointer to the original.
167.Sh RETURN VALUES
168.Fn ENGINE_add ,
169.Fn ENGINE_set_id ,
170.Fn ENGINE_set_name ,
171and
172.Fn ENGINE_remove
173return 1 on success or 0 on error.
174.Fn ENGINE_set_id
175and
176.Fn ENGINE_set_name
177can only fail if the supplied
178.Fa id
179or
180.Fa name
181is
182.Dv NULL .
183.Pp
184.Fn ENGINE_get_id
185and
186.Fn ENGINE_get_name
187return a pointer to an internal string
188representing the identifier and the name of
189.Fa e ,
190respectively.
191.Pp
192.Fn ENGINE_get_first
193and
194.Fn ENGINE_get_last
195return an
196.Vt ENGINE
197object or
198.Dv NULL
199if the list is empty.
200.Pp
201.Fn ENGINE_get_next
202and
203.Fn ENGINE_get_prev
204return an
205.Vt ENGINE
206object or
207.Dv NULL
208when the end of the list is reached.
209.Pp
210.Fn ENGINE_by_id
211returns an
212.Vt ENGINE
213object or
214.Dv NULL
215if no matching object is found.
216.Sh SEE ALSO
217.Xr ENGINE_get_default_RSA 3 ,
218.Xr ENGINE_init 3 ,
219.Xr ENGINE_new 3 ,
220.Xr ENGINE_register_all_RSA 3 ,
221.Xr ENGINE_register_RSA 3 ,
222.Xr ENGINE_set_default 3 ,
223.Xr ENGINE_set_flags 3 ,
224.Xr ENGINE_unregister_RSA 3
225.Sh HISTORY
226.Fn ENGINE_add ,
227.Fn ENGINE_set_id ,
228.Fn ENGINE_get_id ,
229.Fn ENGINE_set_name ,
230.Fn ENGINE_get_name ,
231.Fn ENGINE_remove ,
232.Fn ENGINE_get_first ,
233.Fn ENGINE_get_last ,
234.Fn ENGINE_get_next ,
235.Fn ENGINE_get_prev ,
236and
237.Fn ENGINE_by_id
238first appeared in OpenSSL 0.9.7 and have been available since
239.Ox 2.9 .
240.Pp
241.Fn ENGINE_cleanup
242first appeared in OpenSSL 0.9.7 and has been available since
243.Ox 3.2 .