summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/ENGINE_set_default.3
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/lib/libcrypto/man/ENGINE_set_default.3186
1 files changed, 0 insertions, 186 deletions
diff --git a/src/lib/libcrypto/man/ENGINE_set_default.3 b/src/lib/libcrypto/man/ENGINE_set_default.3
deleted file mode 100644
index c2655f2b9b..0000000000
--- a/src/lib/libcrypto/man/ENGINE_set_default.3
+++ /dev/null
@@ -1,186 +0,0 @@
1.\" $OpenBSD: ENGINE_set_default.3,v 1.4 2019/06/03 14:43:15 schwarze 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: June 3 2019 $
20.Dt ENGINE 3
21.Os
22.Sh NAME
23.Nm ENGINE_set_default ,
24.Nm ENGINE_set_default_string ,
25.Nm ENGINE_set_default_RSA ,
26.Nm ENGINE_set_default_DSA ,
27.Nm ENGINE_set_default_ECDH ,
28.Nm ENGINE_set_default_ECDSA ,
29.Nm ENGINE_set_default_DH ,
30.Nm ENGINE_set_default_RAND ,
31.Nm ENGINE_set_default_ciphers ,
32.Nm ENGINE_set_default_digests
33.Nd register an ENGINE as the default for an algorithm
34.Sh SYNOPSIS
35.In openssl/engine.h
36.Ft int
37.Fo ENGINE_set_default_RSA
38.Fa "ENGINE *e"
39.Fc
40.Ft int
41.Fo ENGINE_set_default_DSA
42.Fa "ENGINE *e"
43.Fc
44.Ft int
45.Fo ENGINE_set_default_ECDH
46.Fa "ENGINE *e"
47.Fc
48.Ft int
49.Fo ENGINE_set_default_ECDSA
50.Fa "ENGINE *e"
51.Fc
52.Ft int
53.Fo ENGINE_set_default_DH
54.Fa "ENGINE *e"
55.Fc
56.Ft int
57.Fo ENGINE_set_default_RAND
58.Fa "ENGINE *e"
59.Fc
60.Ft int
61.Fo ENGINE_set_default_ciphers
62.Fa "ENGINE *e"
63.Fc
64.Ft int
65.Fo ENGINE_set_default_digests
66.Fa "ENGINE *e"
67.Fc
68.Ft int
69.Fo ENGINE_set_default
70.Fa "ENGINE *e"
71.Fa "unsigned int flags"
72.Fc
73.Ft int
74.Fo ENGINE_set_default_string
75.Fa "ENGINE *e"
76.Fa "const char *list"
77.Fc
78.Sh DESCRIPTION
79These functions register
80.Fa e
81as implementing the respective algorithm
82like the functions described in the
83.Xr ENGINE_register_RSA 3
84manual page do it.
85In addition, they call
86.Xr ENGINE_init 3
87on
88.Fa e
89and select
90.Fa e
91as the default implementation of the respective algorithm to be
92returned by the functions described in
93.Xr ENGINE_get_default_RSA 3
94in the future.
95If another engine was previously selected
96as the default implementation of the respective algorithm,
97.Xr ENGINE_finish 3
98is called on that previous engine.
99.Pp
100If
101.Fa e
102implements more than one cipher or digest,
103.Fn ENGINE_set_default_ciphers
104and
105.Fn ENGINE_set_default_digests
106register and select it for all these ciphers and digests, respectively.
107.Pp
108.Fn ENGINE_set_default
109registers
110.Fa e
111as the default implementation of all algorithms specified by the
112.Fa flags
113by calling the appropriate ones among the other functions.
114Algorithms can be selected by combining any number of the
115following constants with bitwise OR:
116.Dv ENGINE_METHOD_ALL ,
117.Dv ENGINE_METHOD_RSA ,
118.Dv ENGINE_METHOD_DSA ,
119.Dv ENGINE_METHOD_ECDH ,
120.Dv ENGINE_METHOD_ECDSA ,
121.Dv ENGINE_METHOD_DH ,
122.Dv ENGINE_METHOD_RAND ,
123.Dv ENGINE_METHOD_CIPHERS ,
124.Dv ENGINE_METHOD_DIGESTS ,
125.Dv ENGINE_METHOD_PKEY_METHS ,
126and
127.Dv ENGINE_METHOD_PKEY_ASN1_METHS .
128.Pp
129.Fn ENGINE_set_default_string
130is similar except that it selects the algorithms according to the string
131.Fa def_list ,
132which contains an arbitrary number of comma-separated keywords from
133the following list: ALL, RSA, DSA, ECDH, ECDSA, DH, RAND, CIPHERS,
134DIGESTS, PKEY_CRYPTO, PKEY_ASN1, and PKEY.
135PKEY_CRYPTO corresponds to
136.Dv ENGINE_METHOD_PKEY_METHS ,
137PKEY_ASN1 to
138.Dv ENGINE_METHOD_PKEY_ASN1_METHS ,
139and PKEY selects both.
140.Sh RETURN VALUES
141These functions return 1 on success or 0 on error.
142They fail if
143.Xr ENGINE_init 3
144fails or if insufficient memory is available.
145.Sh SEE ALSO
146.Xr ENGINE_get_default_RSA 3 ,
147.Xr ENGINE_init 3 ,
148.Xr ENGINE_new 3 ,
149.Xr ENGINE_register_RSA 3 ,
150.Xr ENGINE_set_RSA 3 ,
151.Xr ENGINE_unregister_RSA 3
152.Sh HISTORY
153.Fn ENGINE_set_default ,
154.Fn ENGINE_set_default_RSA ,
155.Fn ENGINE_set_default_DSA ,
156.Fn ENGINE_set_default_DH ,
157and
158.Fn ENGINE_set_default_RAND
159first appeared in OpenSSL 0.9.7 and have been available since
160.Ox 2.9 .
161.Pp
162.Fn ENGINE_set_default_string ,
163.Fn ENGINE_set_default_ciphers ,
164and
165.Fn ENGINE_set_default_digests
166first appeared in OpenSSL 0.9.7 and have been available since
167.Ox 3.2 .
168.Pp
169.Fn ENGINE_set_default_ECDH
170and
171.Fn ENGINE_set_default_ECDSA
172first appeared in OpenSSL 0.9.8 and have been available since
173.Ox 4.5 .
174.Sh CAVEATS
175Failure of
176.Xr ENGINE_finish 3
177is ignored.
178.Sh BUGS
179Even when
180.Fn ENGINE_set_default
181or
182.Fn ENGINE_set_default_string
183fail, they typically still register
184.Fa e
185for some algorithms, but usually not for all it could be registered
186for by calling the individual functions.
generated by cgit v1.2.3-55-g6feb (git 2.39.1) at 2026-02-14 03:17:54 +0000