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