Deleted Added
sdiff udiff text old ( 206048 ) new ( 215698 )
full compact
engine.3 (206048) engine.3 (215698)
1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.37
1.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
2.\"
3.\" Standard preamble:
4.\" ========================================================================
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v
15.if n .sp
16..
17.de Vb \" Begin verbatim text
18.ft CW
19.nf
20.ne \\$1
21..
22.de Ve \" End verbatim text
23.ft R
24.fi
25..
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
5.de Sp \" Vertical space (when we can't use .PP)
6.if t .sp .5v
7.if n .sp
8..
9.de Vb \" Begin verbatim text
10.ft CW
11.nf
12.ne \\$1
13..
14.de Ve \" End verbatim text
15.ft R
16.fi
17..
18.\" Set up some character translations and predefined strings. \*(-- will
19.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
20.\" double quote, and \*(R" will give a right double quote. \*(C+ will
21.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23.\" nothing in troff, for use with C<>.
24.tr \(*W-
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
43'br\}
44.el\{\
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
49'br\}
50.\"
25.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26.ie n \{\
27. ds -- \(*W-
28. ds PI pi
29. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31. ds L" ""
32. ds R" ""
33. ds C` ""
34. ds C' ""
35'br\}
36.el\{\
37. ds -- \|\(em\|
38. ds PI \(*p
39. ds L" ``
40. ds R" ''
41'br\}
42.\"
43.\" Escape single quotes in literal strings from groff's Unicode transform.
44.ie \n(.g .ds Aq \(aq
45.el .ds Aq '
46.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
47.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
49.\" entries marked with X<> in POD. Of course, you'll have to process the
50.\" output yourself in some meaningful fashion.
55.if \nF \{\
51.ie \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
58..
59. nr % 0
60. rr F
61.\}
52. de IX
53. tm Index:\\$1\t\\n%\t"\\$2"
54..
55. nr % 0
56. rr F
57.\}
58.el \{\
59. de IX
60..
61.\}
62.\"
62.\"
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
71.if n \{\
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1

--- 48 unchanged lines hidden (view full) ---

124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
127.\}
128.rm #[ #] #H #V #F C
129.\" ========================================================================
130.\"
131.IX Title "engine 3"
63.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64.\" Fear. Run. Save yourself. No user-serviceable parts.
65. \" fudge factors for nroff and troff
66.if n \{\
67. ds #H 0
68. ds #V .8m
69. ds #F .3m
70. ds #[ \f1

--- 48 unchanged lines hidden (view full) ---

119. ds Th \o'LP'
120. ds ae ae
121. ds Ae AE
122.\}
123.rm #[ #] #H #V #F C
124.\" ========================================================================
125.\"
126.IX Title "engine 3"
132.TH engine 3 "2010-03-24" "0.9.8n" "OpenSSL"
127.TH engine 3 "2010-11-16" "0.9.8p" "OpenSSL"
128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents.
130.if n .ad l
131.nh
133.SH "NAME"
134engine \- ENGINE cryptographic module support
135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS"
137.Vb 1
138\& #include <openssl/engine.h>
132.SH "NAME"
133engine \- ENGINE cryptographic module support
134.SH "SYNOPSIS"
135.IX Header "SYNOPSIS"
136.Vb 1
137\& #include <openssl/engine.h>
139.Ve
140.PP
141.Vb 4
138\&
142\& ENGINE *ENGINE_get_first(void);
143\& ENGINE *ENGINE_get_last(void);
144\& ENGINE *ENGINE_get_next(ENGINE *e);
145\& ENGINE *ENGINE_get_prev(ENGINE *e);
139\& ENGINE *ENGINE_get_first(void);
140\& ENGINE *ENGINE_get_last(void);
141\& ENGINE *ENGINE_get_next(ENGINE *e);
142\& ENGINE *ENGINE_get_prev(ENGINE *e);
146.Ve
147.PP
148.Vb 2
143\&
149\& int ENGINE_add(ENGINE *e);
150\& int ENGINE_remove(ENGINE *e);
144\& int ENGINE_add(ENGINE *e);
145\& int ENGINE_remove(ENGINE *e);
151.Ve
152.PP
153.Vb 1
146\&
154\& ENGINE *ENGINE_by_id(const char *id);
147\& ENGINE *ENGINE_by_id(const char *id);
155.Ve
156.PP
157.Vb 2
148\&
158\& int ENGINE_init(ENGINE *e);
159\& int ENGINE_finish(ENGINE *e);
149\& int ENGINE_init(ENGINE *e);
150\& int ENGINE_finish(ENGINE *e);
160.Ve
161.PP
162.Vb 15
151\&
163\& void ENGINE_load_openssl(void);
164\& void ENGINE_load_dynamic(void);
165\& #ifndef OPENSSL_NO_STATIC_ENGINE
166\& void ENGINE_load_4758cca(void);
167\& void ENGINE_load_aep(void);
168\& void ENGINE_load_atalla(void);
169\& void ENGINE_load_chil(void);
170\& void ENGINE_load_cswift(void);
171\& void ENGINE_load_gmp(void);
172\& void ENGINE_load_nuron(void);
173\& void ENGINE_load_sureware(void);
174\& void ENGINE_load_ubsec(void);
175\& #endif
176\& void ENGINE_load_cryptodev(void);
177\& void ENGINE_load_builtin_engines(void);
152\& void ENGINE_load_openssl(void);
153\& void ENGINE_load_dynamic(void);
154\& #ifndef OPENSSL_NO_STATIC_ENGINE
155\& void ENGINE_load_4758cca(void);
156\& void ENGINE_load_aep(void);
157\& void ENGINE_load_atalla(void);
158\& void ENGINE_load_chil(void);
159\& void ENGINE_load_cswift(void);
160\& void ENGINE_load_gmp(void);
161\& void ENGINE_load_nuron(void);
162\& void ENGINE_load_sureware(void);
163\& void ENGINE_load_ubsec(void);
164\& #endif
165\& void ENGINE_load_cryptodev(void);
166\& void ENGINE_load_builtin_engines(void);
178.Ve
179.PP
180.Vb 1
167\&
181\& void ENGINE_cleanup(void);
168\& void ENGINE_cleanup(void);
182.Ve
183.PP
184.Vb 8
169\&
185\& ENGINE *ENGINE_get_default_RSA(void);
186\& ENGINE *ENGINE_get_default_DSA(void);
187\& ENGINE *ENGINE_get_default_ECDH(void);
188\& ENGINE *ENGINE_get_default_ECDSA(void);
189\& ENGINE *ENGINE_get_default_DH(void);
190\& ENGINE *ENGINE_get_default_RAND(void);
191\& ENGINE *ENGINE_get_cipher_engine(int nid);
192\& ENGINE *ENGINE_get_digest_engine(int nid);
170\& ENGINE *ENGINE_get_default_RSA(void);
171\& ENGINE *ENGINE_get_default_DSA(void);
172\& ENGINE *ENGINE_get_default_ECDH(void);
173\& ENGINE *ENGINE_get_default_ECDSA(void);
174\& ENGINE *ENGINE_get_default_DH(void);
175\& ENGINE *ENGINE_get_default_RAND(void);
176\& ENGINE *ENGINE_get_cipher_engine(int nid);
177\& ENGINE *ENGINE_get_digest_engine(int nid);
193.Ve
194.PP
195.Vb 9
178\&
196\& int ENGINE_set_default_RSA(ENGINE *e);
197\& int ENGINE_set_default_DSA(ENGINE *e);
198\& int ENGINE_set_default_ECDH(ENGINE *e);
199\& int ENGINE_set_default_ECDSA(ENGINE *e);
200\& int ENGINE_set_default_DH(ENGINE *e);
201\& int ENGINE_set_default_RAND(ENGINE *e);
202\& int ENGINE_set_default_ciphers(ENGINE *e);
203\& int ENGINE_set_default_digests(ENGINE *e);
204\& int ENGINE_set_default_string(ENGINE *e, const char *list);
179\& int ENGINE_set_default_RSA(ENGINE *e);
180\& int ENGINE_set_default_DSA(ENGINE *e);
181\& int ENGINE_set_default_ECDH(ENGINE *e);
182\& int ENGINE_set_default_ECDSA(ENGINE *e);
183\& int ENGINE_set_default_DH(ENGINE *e);
184\& int ENGINE_set_default_RAND(ENGINE *e);
185\& int ENGINE_set_default_ciphers(ENGINE *e);
186\& int ENGINE_set_default_digests(ENGINE *e);
187\& int ENGINE_set_default_string(ENGINE *e, const char *list);
205.Ve
206.PP
207.Vb 1
188\&
208\& int ENGINE_set_default(ENGINE *e, unsigned int flags);
189\& int ENGINE_set_default(ENGINE *e, unsigned int flags);
209.Ve
210.PP
211.Vb 2
190\&
212\& unsigned int ENGINE_get_table_flags(void);
213\& void ENGINE_set_table_flags(unsigned int flags);
191\& unsigned int ENGINE_get_table_flags(void);
192\& void ENGINE_set_table_flags(unsigned int flags);
214.Ve
215.PP
216.Vb 29
193\&
217\& int ENGINE_register_RSA(ENGINE *e);
218\& void ENGINE_unregister_RSA(ENGINE *e);
219\& void ENGINE_register_all_RSA(void);
220\& int ENGINE_register_DSA(ENGINE *e);
221\& void ENGINE_unregister_DSA(ENGINE *e);
222\& void ENGINE_register_all_DSA(void);
223\& int ENGINE_register_ECDH(ENGINE *e);
224\& void ENGINE_unregister_ECDH(ENGINE *e);

--- 13 unchanged lines hidden (view full) ---

238\& int ENGINE_register_ciphers(ENGINE *e);
239\& void ENGINE_unregister_ciphers(ENGINE *e);
240\& void ENGINE_register_all_ciphers(void);
241\& int ENGINE_register_digests(ENGINE *e);
242\& void ENGINE_unregister_digests(ENGINE *e);
243\& void ENGINE_register_all_digests(void);
244\& int ENGINE_register_complete(ENGINE *e);
245\& int ENGINE_register_all_complete(void);
194\& int ENGINE_register_RSA(ENGINE *e);
195\& void ENGINE_unregister_RSA(ENGINE *e);
196\& void ENGINE_register_all_RSA(void);
197\& int ENGINE_register_DSA(ENGINE *e);
198\& void ENGINE_unregister_DSA(ENGINE *e);
199\& void ENGINE_register_all_DSA(void);
200\& int ENGINE_register_ECDH(ENGINE *e);
201\& void ENGINE_unregister_ECDH(ENGINE *e);

--- 13 unchanged lines hidden (view full) ---

215\& int ENGINE_register_ciphers(ENGINE *e);
216\& void ENGINE_unregister_ciphers(ENGINE *e);
217\& void ENGINE_register_all_ciphers(void);
218\& int ENGINE_register_digests(ENGINE *e);
219\& void ENGINE_unregister_digests(ENGINE *e);
220\& void ENGINE_register_all_digests(void);
221\& int ENGINE_register_complete(ENGINE *e);
222\& int ENGINE_register_all_complete(void);
246.Ve
247.PP
248.Vb 6
223\&
249\& int ENGINE_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)(void));
250\& int ENGINE_cmd_is_executable(ENGINE *e, int cmd);
251\& int ENGINE_ctrl_cmd(ENGINE *e, const char *cmd_name,
252\& long i, void *p, void (*f)(void), int cmd_optional);
253\& int ENGINE_ctrl_cmd_string(ENGINE *e, const char *cmd_name, const char *arg,
254\& int cmd_optional);
224\& int ENGINE_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)(void));
225\& int ENGINE_cmd_is_executable(ENGINE *e, int cmd);
226\& int ENGINE_ctrl_cmd(ENGINE *e, const char *cmd_name,
227\& long i, void *p, void (*f)(void), int cmd_optional);
228\& int ENGINE_ctrl_cmd_string(ENGINE *e, const char *cmd_name, const char *arg,
229\& int cmd_optional);
255.Ve
256.PP
257.Vb 2
230\&
258\& int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg);
259\& void *ENGINE_get_ex_data(const ENGINE *e, int idx);
231\& int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg);
232\& void *ENGINE_get_ex_data(const ENGINE *e, int idx);
260.Ve
261.PP
262.Vb 2
233\&
263\& int ENGINE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
264\& CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
234\& int ENGINE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
235\& CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
265.Ve
266.PP
267.Vb 3
236\&
268\& ENGINE *ENGINE_new(void);
269\& int ENGINE_free(ENGINE *e);
270\& int ENGINE_up_ref(ENGINE *e);
237\& ENGINE *ENGINE_new(void);
238\& int ENGINE_free(ENGINE *e);
239\& int ENGINE_up_ref(ENGINE *e);
271.Ve
272.PP
273.Vb 19
240\&
274\& int ENGINE_set_id(ENGINE *e, const char *id);
275\& int ENGINE_set_name(ENGINE *e, const char *name);
276\& int ENGINE_set_RSA(ENGINE *e, const RSA_METHOD *rsa_meth);
277\& int ENGINE_set_DSA(ENGINE *e, const DSA_METHOD *dsa_meth);
278\& int ENGINE_set_ECDH(ENGINE *e, const ECDH_METHOD *dh_meth);
279\& int ENGINE_set_ECDSA(ENGINE *e, const ECDSA_METHOD *dh_meth);
280\& int ENGINE_set_DH(ENGINE *e, const DH_METHOD *dh_meth);
281\& int ENGINE_set_RAND(ENGINE *e, const RAND_METHOD *rand_meth);
282\& int ENGINE_set_STORE(ENGINE *e, const STORE_METHOD *rand_meth);
283\& int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f);
284\& int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f);
285\& int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f);
286\& int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f);
287\& int ENGINE_set_load_privkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpriv_f);
288\& int ENGINE_set_load_pubkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpub_f);
289\& int ENGINE_set_ciphers(ENGINE *e, ENGINE_CIPHERS_PTR f);
290\& int ENGINE_set_digests(ENGINE *e, ENGINE_DIGESTS_PTR f);
291\& int ENGINE_set_flags(ENGINE *e, int flags);
292\& int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns);
241\& int ENGINE_set_id(ENGINE *e, const char *id);
242\& int ENGINE_set_name(ENGINE *e, const char *name);
243\& int ENGINE_set_RSA(ENGINE *e, const RSA_METHOD *rsa_meth);
244\& int ENGINE_set_DSA(ENGINE *e, const DSA_METHOD *dsa_meth);
245\& int ENGINE_set_ECDH(ENGINE *e, const ECDH_METHOD *dh_meth);
246\& int ENGINE_set_ECDSA(ENGINE *e, const ECDSA_METHOD *dh_meth);
247\& int ENGINE_set_DH(ENGINE *e, const DH_METHOD *dh_meth);
248\& int ENGINE_set_RAND(ENGINE *e, const RAND_METHOD *rand_meth);
249\& int ENGINE_set_STORE(ENGINE *e, const STORE_METHOD *rand_meth);
250\& int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f);
251\& int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f);
252\& int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f);
253\& int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f);
254\& int ENGINE_set_load_privkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpriv_f);
255\& int ENGINE_set_load_pubkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpub_f);
256\& int ENGINE_set_ciphers(ENGINE *e, ENGINE_CIPHERS_PTR f);
257\& int ENGINE_set_digests(ENGINE *e, ENGINE_DIGESTS_PTR f);
258\& int ENGINE_set_flags(ENGINE *e, int flags);
259\& int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns);
293.Ve
294.PP
295.Vb 21
260\&
296\& const char *ENGINE_get_id(const ENGINE *e);
297\& const char *ENGINE_get_name(const ENGINE *e);
298\& const RSA_METHOD *ENGINE_get_RSA(const ENGINE *e);
299\& const DSA_METHOD *ENGINE_get_DSA(const ENGINE *e);
300\& const ECDH_METHOD *ENGINE_get_ECDH(const ENGINE *e);
301\& const ECDSA_METHOD *ENGINE_get_ECDSA(const ENGINE *e);
302\& const DH_METHOD *ENGINE_get_DH(const ENGINE *e);
303\& const RAND_METHOD *ENGINE_get_RAND(const ENGINE *e);

--- 5 unchanged lines hidden (view full) ---

309\& ENGINE_LOAD_KEY_PTR ENGINE_get_load_privkey_function(const ENGINE *e);
310\& ENGINE_LOAD_KEY_PTR ENGINE_get_load_pubkey_function(const ENGINE *e);
311\& ENGINE_CIPHERS_PTR ENGINE_get_ciphers(const ENGINE *e);
312\& ENGINE_DIGESTS_PTR ENGINE_get_digests(const ENGINE *e);
313\& const EVP_CIPHER *ENGINE_get_cipher(ENGINE *e, int nid);
314\& const EVP_MD *ENGINE_get_digest(ENGINE *e, int nid);
315\& int ENGINE_get_flags(const ENGINE *e);
316\& const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e);
261\& const char *ENGINE_get_id(const ENGINE *e);
262\& const char *ENGINE_get_name(const ENGINE *e);
263\& const RSA_METHOD *ENGINE_get_RSA(const ENGINE *e);
264\& const DSA_METHOD *ENGINE_get_DSA(const ENGINE *e);
265\& const ECDH_METHOD *ENGINE_get_ECDH(const ENGINE *e);
266\& const ECDSA_METHOD *ENGINE_get_ECDSA(const ENGINE *e);
267\& const DH_METHOD *ENGINE_get_DH(const ENGINE *e);
268\& const RAND_METHOD *ENGINE_get_RAND(const ENGINE *e);

--- 5 unchanged lines hidden (view full) ---

274\& ENGINE_LOAD_KEY_PTR ENGINE_get_load_privkey_function(const ENGINE *e);
275\& ENGINE_LOAD_KEY_PTR ENGINE_get_load_pubkey_function(const ENGINE *e);
276\& ENGINE_CIPHERS_PTR ENGINE_get_ciphers(const ENGINE *e);
277\& ENGINE_DIGESTS_PTR ENGINE_get_digests(const ENGINE *e);
278\& const EVP_CIPHER *ENGINE_get_cipher(ENGINE *e, int nid);
279\& const EVP_MD *ENGINE_get_digest(ENGINE *e, int nid);
280\& int ENGINE_get_flags(const ENGINE *e);
281\& const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e);
317.Ve
318.PP
319.Vb 4
282\&
320\& EVP_PKEY *ENGINE_load_private_key(ENGINE *e, const char *key_id,
321\& UI_METHOD *ui_method, void *callback_data);
322\& EVP_PKEY *ENGINE_load_public_key(ENGINE *e, const char *key_id,
323\& UI_METHOD *ui_method, void *callback_data);
283\& EVP_PKEY *ENGINE_load_private_key(ENGINE *e, const char *key_id,
284\& UI_METHOD *ui_method, void *callback_data);
285\& EVP_PKEY *ENGINE_load_public_key(ENGINE *e, const char *key_id,
286\& UI_METHOD *ui_method, void *callback_data);
324.Ve
325.PP
326.Vb 1
287\&
327\& void ENGINE_add_conf_module(void);
328.Ve
329.SH "DESCRIPTION"
330.IX Header "DESCRIPTION"
331These functions create, manipulate, and use cryptographic modules in the
332form of \fB\s-1ENGINE\s0\fR objects. These objects act as containers for
333implementations of cryptographic algorithms, and support a
334reference-counted mechanism to allow them to be dynamically loaded in and
335out of the running application.
336.PP
337The cryptographic functionality that can be provided by an \fB\s-1ENGINE\s0\fR
338implementation includes the following abstractions;
339.PP
340.Vb 6
288\& void ENGINE_add_conf_module(void);
289.Ve
290.SH "DESCRIPTION"
291.IX Header "DESCRIPTION"
292These functions create, manipulate, and use cryptographic modules in the
293form of \fB\s-1ENGINE\s0\fR objects. These objects act as containers for
294implementations of cryptographic algorithms, and support a
295reference-counted mechanism to allow them to be dynamically loaded in and
296out of the running application.
297.PP
298The cryptographic functionality that can be provided by an \fB\s-1ENGINE\s0\fR
299implementation includes the following abstractions;
300.PP
301.Vb 6
341\& RSA_METHOD - for providing alternative RSA implementations
302\& RSA_METHOD \- for providing alternative RSA implementations
342\& DSA_METHOD, DH_METHOD, RAND_METHOD, ECDH_METHOD, ECDSA_METHOD,
303\& DSA_METHOD, DH_METHOD, RAND_METHOD, ECDH_METHOD, ECDSA_METHOD,
343\& STORE_METHOD - similarly for other OpenSSL APIs
344\& EVP_CIPHER - potentially multiple cipher algorithms (indexed by 'nid')
345\& EVP_DIGEST - potentially multiple hash algorithms (indexed by 'nid')
346\& key-loading - loading public and/or private EVP_PKEY keys
304\& STORE_METHOD \- similarly for other OpenSSL APIs
305\& EVP_CIPHER \- potentially multiple cipher algorithms (indexed by \*(Aqnid\*(Aq)
306\& EVP_DIGEST \- potentially multiple hash algorithms (indexed by \*(Aqnid\*(Aq)
307\& key\-loading \- loading public and/or private EVP_PKEY keys
347.Ve
308.Ve
348.Sh "Reference counting and handles"
309.SS "Reference counting and handles"
349.IX Subsection "Reference counting and handles"
350Due to the modular nature of the \s-1ENGINE\s0 \s-1API\s0, pointers to ENGINEs need to be
351treated as handles \- ie. not only as pointers, but also as references to
352the underlying \s-1ENGINE\s0 object. Ie. one should obtain a new reference when
353making copies of an \s-1ENGINE\s0 pointer if the copies will be used (and
354released) independently.
355.PP
356\&\s-1ENGINE\s0 objects have two levels of reference-counting to match the way in

--- 70 unchanged lines hidden (view full) ---

427implicit structural reference as well).
428.PP
429The second way to get a functional reference is by asking OpenSSL for a
430default implementation for a given task, eg. by \fIENGINE_get_default_RSA()\fR,
431\&\fIENGINE_get_default_cipher_engine()\fR, etc. These are discussed in the next
432section, though they are not usually required by application programmers as
433they are used automatically when creating and using the relevant
434algorithm-specific types in OpenSSL, such as \s-1RSA\s0, \s-1DSA\s0, \s-1EVP_CIPHER_CTX\s0, etc.
310.IX Subsection "Reference counting and handles"
311Due to the modular nature of the \s-1ENGINE\s0 \s-1API\s0, pointers to ENGINEs need to be
312treated as handles \- ie. not only as pointers, but also as references to
313the underlying \s-1ENGINE\s0 object. Ie. one should obtain a new reference when
314making copies of an \s-1ENGINE\s0 pointer if the copies will be used (and
315released) independently.
316.PP
317\&\s-1ENGINE\s0 objects have two levels of reference-counting to match the way in

--- 70 unchanged lines hidden (view full) ---

388implicit structural reference as well).
389.PP
390The second way to get a functional reference is by asking OpenSSL for a
391default implementation for a given task, eg. by \fIENGINE_get_default_RSA()\fR,
392\&\fIENGINE_get_default_cipher_engine()\fR, etc. These are discussed in the next
393section, though they are not usually required by application programmers as
394they are used automatically when creating and using the relevant
395algorithm-specific types in OpenSSL, such as \s-1RSA\s0, \s-1DSA\s0, \s-1EVP_CIPHER_CTX\s0, etc.
435.Sh "Default implementations"
396.SS "Default implementations"
436.IX Subsection "Default implementations"
437For each supported abstraction, the \s-1ENGINE\s0 code maintains an internal table
438of state to control which implementations are available for a given
439abstraction and which should be used by default. These implementations are
440registered in the tables and indexed by an 'nid' value, because
441abstractions like \s-1EVP_CIPHER\s0 and \s-1EVP_DIGEST\s0 support many distinct
442algorithms and modes, and ENGINEs can support arbitrarily many of them.
443In the case of other abstractions like \s-1RSA\s0, \s-1DSA\s0, etc, there is only one

--- 22 unchanged lines hidden (view full) ---

466\&\fIENGINE_set_table_flags()\fR), no attempted initialisations will take place,
467instead the only way for the state table to return a non-NULL \s-1ENGINE\s0 to the
468\&\*(L"get_default\*(R" query will be if one is expressly set in the table. Eg.
469\&\fIENGINE_set_default_RSA()\fR does the same job as \fIENGINE_register_RSA()\fR except
470that it also sets the state table's cached response for the \*(L"get_default\*(R"
471query. In the case of abstractions like \s-1EVP_CIPHER\s0, where implementations are
472indexed by 'nid', these flags and cached-responses are distinct for each 'nid'
473value.
397.IX Subsection "Default implementations"
398For each supported abstraction, the \s-1ENGINE\s0 code maintains an internal table
399of state to control which implementations are available for a given
400abstraction and which should be used by default. These implementations are
401registered in the tables and indexed by an 'nid' value, because
402abstractions like \s-1EVP_CIPHER\s0 and \s-1EVP_DIGEST\s0 support many distinct
403algorithms and modes, and ENGINEs can support arbitrarily many of them.
404In the case of other abstractions like \s-1RSA\s0, \s-1DSA\s0, etc, there is only one

--- 22 unchanged lines hidden (view full) ---

427\&\fIENGINE_set_table_flags()\fR), no attempted initialisations will take place,
428instead the only way for the state table to return a non-NULL \s-1ENGINE\s0 to the
429\&\*(L"get_default\*(R" query will be if one is expressly set in the table. Eg.
430\&\fIENGINE_set_default_RSA()\fR does the same job as \fIENGINE_register_RSA()\fR except
431that it also sets the state table's cached response for the \*(L"get_default\*(R"
432query. In the case of abstractions like \s-1EVP_CIPHER\s0, where implementations are
433indexed by 'nid', these flags and cached-responses are distinct for each 'nid'
434value.
474.Sh "Application requirements"
435.SS "Application requirements"
475.IX Subsection "Application requirements"
476This section will explain the basic things an application programmer should
477support to make the most useful elements of the \s-1ENGINE\s0 functionality
478available to the user. The first thing to consider is whether the
479programmer wishes to make alternative \s-1ENGINE\s0 modules available to the
480application and user. OpenSSL maintains an internal linked list of
436.IX Subsection "Application requirements"
437This section will explain the basic things an application programmer should
438support to make the most useful elements of the \s-1ENGINE\s0 functionality
439available to the user. The first thing to consider is whether the
440programmer wishes to make alternative \s-1ENGINE\s0 modules available to the
441application and user. OpenSSL maintains an internal linked list of
481\&\*(L"visible\*(R" ENGINEs from which it has to operate \- at start\-up, this list is
442\&\*(L"visible\*(R" ENGINEs from which it has to operate \- at start-up, this list is
482empty and in fact if an application does not call any \s-1ENGINE\s0 \s-1API\s0 calls and
483it uses static linking against openssl, then the resulting application
484binary will not contain any alternative \s-1ENGINE\s0 code at all. So the first
485consideration is whether any/all available \s-1ENGINE\s0 implementations should be
486made visible to OpenSSL \- this is controlled by calling the various \*(L"load\*(R"
487functions, eg.
488.PP
489.Vb 9
490\& /* Make the "dynamic" ENGINE available */
491\& void ENGINE_load_dynamic(void);
492\& /* Make the CryptoSwift hardware acceleration support available */
493\& void ENGINE_load_cswift(void);
443empty and in fact if an application does not call any \s-1ENGINE\s0 \s-1API\s0 calls and
444it uses static linking against openssl, then the resulting application
445binary will not contain any alternative \s-1ENGINE\s0 code at all. So the first
446consideration is whether any/all available \s-1ENGINE\s0 implementations should be
447made visible to OpenSSL \- this is controlled by calling the various \*(L"load\*(R"
448functions, eg.
449.PP
450.Vb 9
451\& /* Make the "dynamic" ENGINE available */
452\& void ENGINE_load_dynamic(void);
453\& /* Make the CryptoSwift hardware acceleration support available */
454\& void ENGINE_load_cswift(void);
494\& /* Make support for nCipher's "CHIL" hardware available */
455\& /* Make support for nCipher\*(Aqs "CHIL" hardware available */
495\& void ENGINE_load_chil(void);
496\& ...
497\& /* Make ALL ENGINE implementations bundled with OpenSSL available */
498\& void ENGINE_load_builtin_engines(void);
499.Ve
500.PP
501Having called any of these functions, \s-1ENGINE\s0 objects would have been
502dynamically allocated and populated with these implementations and linked

--- 14 unchanged lines hidden (view full) ---

517register its cleanup details to be called during \fIENGINE_cleanup()\fR. This
518approach allows \fIENGINE_cleanup()\fR to clean up after any \s-1ENGINE\s0 functionality
519at all that your program uses, yet doesn't automatically create linker
520dependencies to all possible \s-1ENGINE\s0 functionality \- only the cleanup
521callbacks required by the functionality you do use will be required by the
522linker.
523.PP
524The fact that ENGINEs are made visible to OpenSSL (and thus are linked into
456\& void ENGINE_load_chil(void);
457\& ...
458\& /* Make ALL ENGINE implementations bundled with OpenSSL available */
459\& void ENGINE_load_builtin_engines(void);
460.Ve
461.PP
462Having called any of these functions, \s-1ENGINE\s0 objects would have been
463dynamically allocated and populated with these implementations and linked

--- 14 unchanged lines hidden (view full) ---

478register its cleanup details to be called during \fIENGINE_cleanup()\fR. This
479approach allows \fIENGINE_cleanup()\fR to clean up after any \s-1ENGINE\s0 functionality
480at all that your program uses, yet doesn't automatically create linker
481dependencies to all possible \s-1ENGINE\s0 functionality \- only the cleanup
482callbacks required by the functionality you do use will be required by the
483linker.
484.PP
485The fact that ENGINEs are made visible to OpenSSL (and thus are linked into
525the program and loaded into memory at run\-time) does not mean they are
486the program and loaded into memory at run-time) does not mean they are
526\&\*(L"registered\*(R" or called into use by OpenSSL automatically \- that behaviour
527is something for the application to control. Some applications
528will want to allow the user to specify exactly which \s-1ENGINE\s0 they want used
529if any is to be used at all. Others may prefer to load all support and have
530OpenSSL automatically use at run-time any \s-1ENGINE\s0 that is able to
531successfully initialise \- ie. to assume that this corresponds to
532acceleration hardware attached to the machine or some such thing. There are
533probably numerous other ways in which applications may prefer to handle

--- 5 unchanged lines hidden (view full) ---

539.PP
540Here we'll assume an application has been configured by its user or admin
541to want to use the \*(L"\s-1ACME\s0\*(R" \s-1ENGINE\s0 if it is available in the version of
542OpenSSL the application was compiled with. If it is available, it should be
543used by default for all \s-1RSA\s0, \s-1DSA\s0, and symmetric cipher operation, otherwise
544OpenSSL should use its builtin software as per usual. The following code
545illustrates how to approach this;
546.PP
487\&\*(L"registered\*(R" or called into use by OpenSSL automatically \- that behaviour
488is something for the application to control. Some applications
489will want to allow the user to specify exactly which \s-1ENGINE\s0 they want used
490if any is to be used at all. Others may prefer to load all support and have
491OpenSSL automatically use at run-time any \s-1ENGINE\s0 that is able to
492successfully initialise \- ie. to assume that this corresponds to
493acceleration hardware attached to the machine or some such thing. There are
494probably numerous other ways in which applications may prefer to handle

--- 5 unchanged lines hidden (view full) ---

500.PP
501Here we'll assume an application has been configured by its user or admin
502to want to use the \*(L"\s-1ACME\s0\*(R" \s-1ENGINE\s0 if it is available in the version of
503OpenSSL the application was compiled with. If it is available, it should be
504used by default for all \s-1RSA\s0, \s-1DSA\s0, and symmetric cipher operation, otherwise
505OpenSSL should use its builtin software as per usual. The following code
506illustrates how to approach this;
507.PP
547.Vb 22
508.Vb 10
548\& ENGINE *e;
549\& const char *engine_id = "ACME";
550\& ENGINE_load_builtin_engines();
551\& e = ENGINE_by_id(engine_id);
552\& if(!e)
509\& ENGINE *e;
510\& const char *engine_id = "ACME";
511\& ENGINE_load_builtin_engines();
512\& e = ENGINE_by_id(engine_id);
513\& if(!e)
553\& /* the engine isn't available */
514\& /* the engine isn\*(Aqt available */
554\& return;
555\& if(!ENGINE_init(e)) {
515\& return;
516\& if(!ENGINE_init(e)) {
556\& /* the engine couldn't initialise, release 'e' */
517\& /* the engine couldn\*(Aqt initialise, release \*(Aqe\*(Aq */
557\& ENGINE_free(e);
558\& return;
559\& }
560\& if(!ENGINE_set_default_RSA(e))
518\& ENGINE_free(e);
519\& return;
520\& }
521\& if(!ENGINE_set_default_RSA(e))
561\& /* This should only happen when 'e' can't initialise, but the previous
522\& /* This should only happen when \*(Aqe\*(Aq can\*(Aqt initialise, but the previous
562\& * statement suggests it did. */
563\& abort();
564\& ENGINE_set_default_DSA(e);
565\& ENGINE_set_default_ciphers(e);
566\& /* Release the functional reference from ENGINE_init() */
567\& ENGINE_finish(e);
568\& /* Release the structural reference from ENGINE_by_id() */
569\& ENGINE_free(e);

--- 12 unchanged lines hidden (view full) ---

582\& /* Register all of them for every algorithm they collectively implement */
583\& ENGINE_register_all_complete();
584.Ve
585.PP
586That's all that's required. Eg. the next time OpenSSL tries to set up an
587\&\s-1RSA\s0 key, any bundled ENGINEs that implement \s-1RSA_METHOD\s0 will be passed to
588\&\fIENGINE_init()\fR and if any of those succeed, that \s-1ENGINE\s0 will be set as the
589default for \s-1RSA\s0 use from then on.
523\& * statement suggests it did. */
524\& abort();
525\& ENGINE_set_default_DSA(e);
526\& ENGINE_set_default_ciphers(e);
527\& /* Release the functional reference from ENGINE_init() */
528\& ENGINE_finish(e);
529\& /* Release the structural reference from ENGINE_by_id() */
530\& ENGINE_free(e);

--- 12 unchanged lines hidden (view full) ---

543\& /* Register all of them for every algorithm they collectively implement */
544\& ENGINE_register_all_complete();
545.Ve
546.PP
547That's all that's required. Eg. the next time OpenSSL tries to set up an
548\&\s-1RSA\s0 key, any bundled ENGINEs that implement \s-1RSA_METHOD\s0 will be passed to
549\&\fIENGINE_init()\fR and if any of those succeed, that \s-1ENGINE\s0 will be set as the
550default for \s-1RSA\s0 use from then on.
590.Sh "Advanced configuration support"
551.SS "Advanced configuration support"
591.IX Subsection "Advanced configuration support"
592There is a mechanism supported by the \s-1ENGINE\s0 framework that allows each
593\&\s-1ENGINE\s0 implementation to define an arbitrary set of configuration
594\&\*(L"commands\*(R" and expose them to OpenSSL and any applications based on
595OpenSSL. This mechanism is entirely based on the use of name-value pairs
596and assumes \s-1ASCII\s0 input (no unicode or \s-1UTF\s0 for now!), so it is ideal if
597applications want to provide a transparent way for users to provide
598arbitrary configuration \*(L"directives\*(R" directly to such ENGINEs. It is also

--- 29 unchanged lines hidden (view full) ---

628initialisation, and another table for use after initialisation. Note that
629the string-pairs used for control commands consist of a command \*(L"name\*(R"
630followed by the command \*(L"parameter\*(R" \- the parameter could be \s-1NULL\s0 in some
631cases but the name can not. This function should initialise the \s-1ENGINE\s0
632(issuing the \*(L"pre\*(R" commands beforehand and the \*(L"post\*(R" commands afterwards)
633and set it as the default for everything except \s-1RAND\s0 and then return a
634boolean success or failure.
635.PP
552.IX Subsection "Advanced configuration support"
553There is a mechanism supported by the \s-1ENGINE\s0 framework that allows each
554\&\s-1ENGINE\s0 implementation to define an arbitrary set of configuration
555\&\*(L"commands\*(R" and expose them to OpenSSL and any applications based on
556OpenSSL. This mechanism is entirely based on the use of name-value pairs
557and assumes \s-1ASCII\s0 input (no unicode or \s-1UTF\s0 for now!), so it is ideal if
558applications want to provide a transparent way for users to provide
559arbitrary configuration \*(L"directives\*(R" directly to such ENGINEs. It is also

--- 29 unchanged lines hidden (view full) ---

589initialisation, and another table for use after initialisation. Note that
590the string-pairs used for control commands consist of a command \*(L"name\*(R"
591followed by the command \*(L"parameter\*(R" \- the parameter could be \s-1NULL\s0 in some
592cases but the name can not. This function should initialise the \s-1ENGINE\s0
593(issuing the \*(L"pre\*(R" commands beforehand and the \*(L"post\*(R" commands afterwards)
594and set it as the default for everything except \s-1RAND\s0 and then return a
595boolean success or failure.
596.PP
636.Vb 36
597.Vb 10
637\& int generic_load_engine_fn(const char *engine_id,
638\& const char **pre_cmds, int pre_num,
639\& const char **post_cmds, int post_num)
640\& {
641\& ENGINE *e = ENGINE_by_id(engine_id);
642\& if(!e) return 0;
598\& int generic_load_engine_fn(const char *engine_id,
599\& const char **pre_cmds, int pre_num,
600\& const char **post_cmds, int post_num)
601\& {
602\& ENGINE *e = ENGINE_by_id(engine_id);
603\& if(!e) return 0;
643\& while(pre_num--) {
604\& while(pre_num\-\-) {
644\& if(!ENGINE_ctrl_cmd_string(e, pre_cmds[0], pre_cmds[1], 0)) {
605\& if(!ENGINE_ctrl_cmd_string(e, pre_cmds[0], pre_cmds[1], 0)) {
645\& fprintf(stderr, "Failed command (%s - %s:%s)\en", engine_id,
606\& fprintf(stderr, "Failed command (%s \- %s:%s)\en", engine_id,
646\& pre_cmds[0], pre_cmds[1] ? pre_cmds[1] : "(NULL)");
647\& ENGINE_free(e);
648\& return 0;
649\& }
650\& pre_cmds += 2;
651\& }
652\& if(!ENGINE_init(e)) {
653\& fprintf(stderr, "Failed initialisation\en");
654\& ENGINE_free(e);
655\& return 0;
656\& }
657\& /* ENGINE_init() returned a functional reference, so free the structural
658\& * reference from ENGINE_by_id(). */
659\& ENGINE_free(e);
607\& pre_cmds[0], pre_cmds[1] ? pre_cmds[1] : "(NULL)");
608\& ENGINE_free(e);
609\& return 0;
610\& }
611\& pre_cmds += 2;
612\& }
613\& if(!ENGINE_init(e)) {
614\& fprintf(stderr, "Failed initialisation\en");
615\& ENGINE_free(e);
616\& return 0;
617\& }
618\& /* ENGINE_init() returned a functional reference, so free the structural
619\& * reference from ENGINE_by_id(). */
620\& ENGINE_free(e);
660\& while(post_num--) {
621\& while(post_num\-\-) {
661\& if(!ENGINE_ctrl_cmd_string(e, post_cmds[0], post_cmds[1], 0)) {
622\& if(!ENGINE_ctrl_cmd_string(e, post_cmds[0], post_cmds[1], 0)) {
662\& fprintf(stderr, "Failed command (%s - %s:%s)\en", engine_id,
623\& fprintf(stderr, "Failed command (%s \- %s:%s)\en", engine_id,
663\& post_cmds[0], post_cmds[1] ? post_cmds[1] : "(NULL)");
664\& ENGINE_finish(e);
665\& return 0;
666\& }
667\& post_cmds += 2;
668\& }
669\& ENGINE_set_default(e, ENGINE_METHOD_ALL & ~ENGINE_METHOD_RAND);
670\& /* Success */

--- 6 unchanged lines hidden (view full) ---

677failure if the \s-1ENGINE\s0 supported the given command name but failed while
678executing it, if the \s-1ENGINE\s0 doesn't support the command name it will simply
679return success without doing anything. In this case we assume the user is
680only supplying commands specific to the given \s-1ENGINE\s0 so we set this to
681\&\s-1FALSE\s0.
682.PP
683\&\fIDiscovering supported control commands\fR
684.PP
624\& post_cmds[0], post_cmds[1] ? post_cmds[1] : "(NULL)");
625\& ENGINE_finish(e);
626\& return 0;
627\& }
628\& post_cmds += 2;
629\& }
630\& ENGINE_set_default(e, ENGINE_METHOD_ALL & ~ENGINE_METHOD_RAND);
631\& /* Success */

--- 6 unchanged lines hidden (view full) ---

638failure if the \s-1ENGINE\s0 supported the given command name but failed while
639executing it, if the \s-1ENGINE\s0 doesn't support the command name it will simply
640return success without doing anything. In this case we assume the user is
641only supplying commands specific to the given \s-1ENGINE\s0 so we set this to
642\&\s-1FALSE\s0.
643.PP
644\&\fIDiscovering supported control commands\fR
645.PP
685It is possible to discover at run-time the names, numerical\-ids, descriptions
646It is possible to discover at run-time the names, numerical-ids, descriptions
686and input parameters of the control commands supported by an \s-1ENGINE\s0 using a
687structural reference. Note that some control commands are defined by OpenSSL
688itself and it will intercept and handle these control commands on behalf of the
689\&\s-1ENGINE\s0, ie. the \s-1ENGINE\s0's \fIctrl()\fR handler is not used for the control command.
690openssl/engine.h defines an index, \s-1ENGINE_CMD_BASE\s0, that all control commands
691implemented by ENGINEs should be numbered from. Any command value lower than
692this symbol is considered a \*(L"generic\*(R" command is handled directly by the
693OpenSSL core routines.

--- 41 unchanged lines hidden (view full) ---

735the first command supported by the \s-1ENGINE\s0, \s-1ENGINE_GET_NEXT_CMD_TYPE\s0 takes the
736identifier of a command supported by the \s-1ENGINE\s0 and returns the next command
737identifier or fails if there are no more, \s-1ENGINE_CMD_FROM_NAME\s0 takes a string
738name for a command and returns the corresponding identifier or fails if no such
739command name exists, and the remaining commands take a command identifier and
740return properties of the corresponding commands. All except
741\&\s-1ENGINE_CTRL_GET_FLAGS\s0 return the string length of a command name or description,
742or populate a supplied character buffer with a copy of the command name or
647and input parameters of the control commands supported by an \s-1ENGINE\s0 using a
648structural reference. Note that some control commands are defined by OpenSSL
649itself and it will intercept and handle these control commands on behalf of the
650\&\s-1ENGINE\s0, ie. the \s-1ENGINE\s0's \fIctrl()\fR handler is not used for the control command.
651openssl/engine.h defines an index, \s-1ENGINE_CMD_BASE\s0, that all control commands
652implemented by ENGINEs should be numbered from. Any command value lower than
653this symbol is considered a \*(L"generic\*(R" command is handled directly by the
654OpenSSL core routines.

--- 41 unchanged lines hidden (view full) ---

696the first command supported by the \s-1ENGINE\s0, \s-1ENGINE_GET_NEXT_CMD_TYPE\s0 takes the
697identifier of a command supported by the \s-1ENGINE\s0 and returns the next command
698identifier or fails if there are no more, \s-1ENGINE_CMD_FROM_NAME\s0 takes a string
699name for a command and returns the corresponding identifier or fails if no such
700command name exists, and the remaining commands take a command identifier and
701return properties of the corresponding commands. All except
702\&\s-1ENGINE_CTRL_GET_FLAGS\s0 return the string length of a command name or description,
703or populate a supplied character buffer with a copy of the command name or
743description. \s-1ENGINE_CTRL_GET_FLAGS\s0 returns a bitwise\-OR'd mask of the following
704description. \s-1ENGINE_CTRL_GET_FLAGS\s0 returns a bitwise-OR'd mask of the following
744possible values;
745.PP
746.Vb 4
747\& #define ENGINE_CMD_FLAG_NUMERIC (unsigned int)0x0001
748\& #define ENGINE_CMD_FLAG_STRING (unsigned int)0x0002
749\& #define ENGINE_CMD_FLAG_NO_INPUT (unsigned int)0x0004
750\& #define ENGINE_CMD_FLAG_INTERNAL (unsigned int)0x0008
751.Ve

--- 5 unchanged lines hidden (view full) ---

757by applications, administrations, users, etc. These can support arbitrary
758operations via \fIENGINE_ctrl()\fR, including passing to and/or from the control
759commands data of any arbitrary type. These commands are supported in the
760discovery mechanisms simply to allow applications determinie if an \s-1ENGINE\s0
761supports certain specific commands it might want to use (eg. application \*(L"foo\*(R"
762might query various ENGINEs to see if they implement \*(L"\s-1FOO_GET_VENDOR_LOGO_GIF\s0\*(R" \-
763and \s-1ENGINE\s0 could therefore decide whether or not to support this \*(L"foo\*(R"\-specific
764extension).
705possible values;
706.PP
707.Vb 4
708\& #define ENGINE_CMD_FLAG_NUMERIC (unsigned int)0x0001
709\& #define ENGINE_CMD_FLAG_STRING (unsigned int)0x0002
710\& #define ENGINE_CMD_FLAG_NO_INPUT (unsigned int)0x0004
711\& #define ENGINE_CMD_FLAG_INTERNAL (unsigned int)0x0008
712.Ve

--- 5 unchanged lines hidden (view full) ---

718by applications, administrations, users, etc. These can support arbitrary
719operations via \fIENGINE_ctrl()\fR, including passing to and/or from the control
720commands data of any arbitrary type. These commands are supported in the
721discovery mechanisms simply to allow applications determinie if an \s-1ENGINE\s0
722supports certain specific commands it might want to use (eg. application \*(L"foo\*(R"
723might query various ENGINEs to see if they implement \*(L"\s-1FOO_GET_VENDOR_LOGO_GIF\s0\*(R" \-
724and \s-1ENGINE\s0 could therefore decide whether or not to support this \*(L"foo\*(R"\-specific
725extension).
765.Sh "Future developments"
726.SS "Future developments"
766.IX Subsection "Future developments"
767The \s-1ENGINE\s0 \s-1API\s0 and internal architecture is currently being reviewed. Slated for
768possible release in 0.9.8 is support for transparent loading of \*(L"dynamic\*(R"
727.IX Subsection "Future developments"
728The \s-1ENGINE\s0 \s-1API\s0 and internal architecture is currently being reviewed. Slated for
729possible release in 0.9.8 is support for transparent loading of \*(L"dynamic\*(R"
769ENGINEs (built as self-contained shared\-libraries). This would allow \s-1ENGINE\s0
730ENGINEs (built as self-contained shared-libraries). This would allow \s-1ENGINE\s0
770implementations to be provided independently of OpenSSL libraries and/or
771OpenSSL-based applications, and would also remove any requirement for
772applications to explicitly use the \*(L"dynamic\*(R" \s-1ENGINE\s0 to bind to shared-library
773implementations.
774.SH "SEE ALSO"
775.IX Header "SEE ALSO"
776\&\fIrsa\fR\|(3), \fIdsa\fR\|(3), \fIdh\fR\|(3), \fIrand\fR\|(3)
731implementations to be provided independently of OpenSSL libraries and/or
732OpenSSL-based applications, and would also remove any requirement for
733applications to explicitly use the \*(L"dynamic\*(R" \s-1ENGINE\s0 to bind to shared-library
734implementations.
735.SH "SEE ALSO"
736.IX Header "SEE ALSO"
737\&\fIrsa\fR\|(3), \fIdsa\fR\|(3), \fIdh\fR\|(3), \fIrand\fR\|(3)