diff options
author | tb <> | 2023-11-19 10:36:14 +0000 |
---|---|---|
committer | tb <> | 2023-11-19 10:36:14 +0000 |
commit | f5ed05316824ad237b1e00ea6981f83619de0209 (patch) | |
tree | dddd317bf1ee16b443c461d546f730dd54433df1 /src/lib/libcrypto/man/ENGINE_get_default_RSA.3 | |
parent | 804762513590f41c1b78252a3d44d2c96c3d6139 (diff) | |
download | openbsd-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_get_default_RSA.3')
-rw-r--r-- | src/lib/libcrypto/man/ENGINE_get_default_RSA.3 | 151 |
1 files changed, 0 insertions, 151 deletions
diff --git a/src/lib/libcrypto/man/ENGINE_get_default_RSA.3 b/src/lib/libcrypto/man/ENGINE_get_default_RSA.3 deleted file mode 100644 index 348f13670f..0000000000 --- a/src/lib/libcrypto/man/ENGINE_get_default_RSA.3 +++ /dev/null | |||
@@ -1,151 +0,0 @@ | |||
1 | .\" $OpenBSD: ENGINE_get_default_RSA.3,v 1.4 2023/07/21 04:35:36 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_GET_DEFAULT_RSA 3 | ||
21 | .Os | ||
22 | .Sh NAME | ||
23 | .Nm ENGINE_get_default_RSA , | ||
24 | .Nm ENGINE_get_default_DSA , | ||
25 | .Nm ENGINE_get_default_EC , | ||
26 | .Nm ENGINE_get_default_DH , | ||
27 | .Nm ENGINE_get_default_RAND , | ||
28 | .Nm ENGINE_get_cipher_engine , | ||
29 | .Nm ENGINE_get_digest_engine , | ||
30 | .Nm ENGINE_set_table_flags , | ||
31 | .Nm ENGINE_get_table_flags | ||
32 | .Nd retrieve the default ENGINE for an algorithm | ||
33 | .Sh SYNOPSIS | ||
34 | .In openssl/engine.h | ||
35 | .Ft ENGINE * | ||
36 | .Fn ENGINE_get_default_RSA void | ||
37 | .Ft ENGINE * | ||
38 | .Fn ENGINE_get_default_DSA void | ||
39 | .Ft ENGINE * | ||
40 | .Fn ENGINE_get_default_EC void | ||
41 | .Ft ENGINE * | ||
42 | .Fn ENGINE_get_default_DH void | ||
43 | .Ft ENGINE * | ||
44 | .Fn ENGINE_get_default_RAND void | ||
45 | .Ft ENGINE * | ||
46 | .Fo ENGINE_get_cipher_engine | ||
47 | .Fa "int nid" | ||
48 | .Fc | ||
49 | .Ft ENGINE * | ||
50 | .Fo ENGINE_get_digest_engine | ||
51 | .Fa "int nid" | ||
52 | .Fc | ||
53 | .Ft void | ||
54 | .Fo ENGINE_set_table_flags | ||
55 | .Fa "unsigned int flags" | ||
56 | .Fc | ||
57 | .Ft unsigned int | ||
58 | .Fn ENGINE_get_table_flags void | ||
59 | .Sh DESCRIPTION | ||
60 | These functions retrieve the current default | ||
61 | .Vt ENGINE | ||
62 | implementing the respective algorithm. | ||
63 | .Pp | ||
64 | If a default engine was previously selected, | ||
65 | .Xr ENGINE_init 3 | ||
66 | is called on it again and it is used. | ||
67 | Otherwise, these functions inspect the engines registered | ||
68 | with the functions documented in | ||
69 | .Xr ENGINE_register_RSA 3 | ||
70 | in the order of the table for the respective algorithm. | ||
71 | If an inspected engine is already successfully initialized, | ||
72 | .Xr ENGINE_init 3 | ||
73 | is called on it again and it is used as the new default. | ||
74 | Otherwise, unless the global flag | ||
75 | .Dv ENGINE_TABLE_FLAG_NOINIT | ||
76 | is set, | ||
77 | .Xr ENGINE_init 3 | ||
78 | is tried on it. | ||
79 | If it succeeds, that engine is used as the new default. | ||
80 | If it fails or if | ||
81 | .Dv ENGINE_TABLE_FLAG_NOINIT | ||
82 | is set, inspection continues with the next engine. | ||
83 | .Pp | ||
84 | The global flag can be set by calling | ||
85 | .Fn ENGINE_set_table_flags | ||
86 | with an argument of | ||
87 | .Dv ENGINE_TABLE_FLAG_NOINIT | ||
88 | or cleared by calling it with an argument of 0. | ||
89 | By default, the flag is not set. | ||
90 | .Pp | ||
91 | While all the other functions operate on exactly one algorithm, | ||
92 | .Fn ENGINE_get_cipher_engine | ||
93 | and | ||
94 | .Fn ENGINE_get_digest_engine | ||
95 | are special in so far as they can handle multiple algorithms, | ||
96 | identified by the given | ||
97 | .Fa nid . | ||
98 | The default engine is remembered separately for each algorithm. | ||
99 | .Pp | ||
100 | Application programs rarely need to call these functions because | ||
101 | they are called automatically when needed, in particular from | ||
102 | .Xr RSA_new 3 , | ||
103 | .Xr DSA_new 3 , | ||
104 | .Xr EC_KEY_new 3 , | ||
105 | .Xr DH_new 3 , | ||
106 | .Xr EVP_CipherInit_ex 3 , | ||
107 | and | ||
108 | .Xr EVP_DigestInit_ex 3 . | ||
109 | .Sh RETURN VALUES | ||
110 | These functions return a functional reference to an | ||
111 | .Vt ENGINE | ||
112 | object or | ||
113 | .Dv NULL | ||
114 | on failure, in particular when no engine implementing the algorithm | ||
115 | is available, when | ||
116 | .Xr ENGINE_init 3 | ||
117 | fails for all implementations, | ||
118 | or when insufficient memory is available. | ||
119 | Even when these functions fail, the application may still be able | ||
120 | to use the algorithm in question because the built-in implementation | ||
121 | is used in that case, if one is available. | ||
122 | .Pp | ||
123 | .Fn ENGINE_get_table_flags | ||
124 | returns | ||
125 | .Dv ENGINE_TABLE_FLAG_NOINIT | ||
126 | if the global flag is set or 0 otherwise. | ||
127 | .Sh SEE ALSO | ||
128 | .Xr ENGINE_init 3 , | ||
129 | .Xr ENGINE_new 3 , | ||
130 | .Xr ENGINE_register_RSA 3 , | ||
131 | .Xr ENGINE_set_default 3 | ||
132 | .Sh HISTORY | ||
133 | .Fn ENGINE_get_default_RSA , | ||
134 | .Fn ENGINE_get_default_DSA , | ||
135 | .Fn ENGINE_get_default_DH , | ||
136 | and | ||
137 | .Fn ENGINE_get_default_RAND | ||
138 | first appeared in OpenSSL 0.9.7 and have been available since | ||
139 | .Ox 2.9 . | ||
140 | .Pp | ||
141 | .Fn ENGINE_get_cipher_engine , | ||
142 | .Fn ENGINE_get_digest_engine , | ||
143 | .Fn ENGINE_set_table_flags , | ||
144 | and | ||
145 | .Fn ENGINE_get_table_flags | ||
146 | first appeared in OpenSSL 0.9.7 and have been available since | ||
147 | .Ox 3.2 . | ||
148 | .Pp | ||
149 | .Fn ENGINE_get_default_EC | ||
150 | first appeared in OpenSSL 1.1.0 and has been available since | ||
151 | .Ox 6.5 . | ||