1*de0e0e4dSAntonio Huete Jimenez /* $OpenBSD: eng_ctrl.c,v 1.11 2017/01/29 17:49:23 beck Exp $ */
2*de0e0e4dSAntonio Huete Jimenez /* ====================================================================
3*de0e0e4dSAntonio Huete Jimenez * Copyright (c) 1999-2001 The OpenSSL Project. All rights reserved.
4*de0e0e4dSAntonio Huete Jimenez *
5*de0e0e4dSAntonio Huete Jimenez * Redistribution and use in source and binary forms, with or without
6*de0e0e4dSAntonio Huete Jimenez * modification, are permitted provided that the following conditions
7*de0e0e4dSAntonio Huete Jimenez * are met:
8*de0e0e4dSAntonio Huete Jimenez *
9*de0e0e4dSAntonio Huete Jimenez * 1. Redistributions of source code must retain the above copyright
10*de0e0e4dSAntonio Huete Jimenez * notice, this list of conditions and the following disclaimer.
11*de0e0e4dSAntonio Huete Jimenez *
12*de0e0e4dSAntonio Huete Jimenez * 2. Redistributions in binary form must reproduce the above copyright
13*de0e0e4dSAntonio Huete Jimenez * notice, this list of conditions and the following disclaimer in
14*de0e0e4dSAntonio Huete Jimenez * the documentation and/or other materials provided with the
15*de0e0e4dSAntonio Huete Jimenez * distribution.
16*de0e0e4dSAntonio Huete Jimenez *
17*de0e0e4dSAntonio Huete Jimenez * 3. All advertising materials mentioning features or use of this
18*de0e0e4dSAntonio Huete Jimenez * software must display the following acknowledgment:
19*de0e0e4dSAntonio Huete Jimenez * "This product includes software developed by the OpenSSL Project
20*de0e0e4dSAntonio Huete Jimenez * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
21*de0e0e4dSAntonio Huete Jimenez *
22*de0e0e4dSAntonio Huete Jimenez * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
23*de0e0e4dSAntonio Huete Jimenez * endorse or promote products derived from this software without
24*de0e0e4dSAntonio Huete Jimenez * prior written permission. For written permission, please contact
25*de0e0e4dSAntonio Huete Jimenez * licensing@OpenSSL.org.
26*de0e0e4dSAntonio Huete Jimenez *
27*de0e0e4dSAntonio Huete Jimenez * 5. Products derived from this software may not be called "OpenSSL"
28*de0e0e4dSAntonio Huete Jimenez * nor may "OpenSSL" appear in their names without prior written
29*de0e0e4dSAntonio Huete Jimenez * permission of the OpenSSL Project.
30*de0e0e4dSAntonio Huete Jimenez *
31*de0e0e4dSAntonio Huete Jimenez * 6. Redistributions of any form whatsoever must retain the following
32*de0e0e4dSAntonio Huete Jimenez * acknowledgment:
33*de0e0e4dSAntonio Huete Jimenez * "This product includes software developed by the OpenSSL Project
34*de0e0e4dSAntonio Huete Jimenez * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
35*de0e0e4dSAntonio Huete Jimenez *
36*de0e0e4dSAntonio Huete Jimenez * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
37*de0e0e4dSAntonio Huete Jimenez * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
38*de0e0e4dSAntonio Huete Jimenez * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
39*de0e0e4dSAntonio Huete Jimenez * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
40*de0e0e4dSAntonio Huete Jimenez * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41*de0e0e4dSAntonio Huete Jimenez * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
42*de0e0e4dSAntonio Huete Jimenez * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
43*de0e0e4dSAntonio Huete Jimenez * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
44*de0e0e4dSAntonio Huete Jimenez * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
45*de0e0e4dSAntonio Huete Jimenez * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
46*de0e0e4dSAntonio Huete Jimenez * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
47*de0e0e4dSAntonio Huete Jimenez * OF THE POSSIBILITY OF SUCH DAMAGE.
48*de0e0e4dSAntonio Huete Jimenez * ====================================================================
49*de0e0e4dSAntonio Huete Jimenez *
50*de0e0e4dSAntonio Huete Jimenez * This product includes cryptographic software written by Eric Young
51*de0e0e4dSAntonio Huete Jimenez * (eay@cryptsoft.com). This product includes software written by Tim
52*de0e0e4dSAntonio Huete Jimenez * Hudson (tjh@cryptsoft.com).
53*de0e0e4dSAntonio Huete Jimenez *
54*de0e0e4dSAntonio Huete Jimenez */
55*de0e0e4dSAntonio Huete Jimenez
56*de0e0e4dSAntonio Huete Jimenez #include <string.h>
57*de0e0e4dSAntonio Huete Jimenez
58*de0e0e4dSAntonio Huete Jimenez #include <openssl/err.h>
59*de0e0e4dSAntonio Huete Jimenez
60*de0e0e4dSAntonio Huete Jimenez #include "eng_int.h"
61*de0e0e4dSAntonio Huete Jimenez
62*de0e0e4dSAntonio Huete Jimenez /* When querying a ENGINE-specific control command's 'description', this string
63*de0e0e4dSAntonio Huete Jimenez * is used if the ENGINE_CMD_DEFN has cmd_desc set to NULL. */
64*de0e0e4dSAntonio Huete Jimenez static const char *int_no_description = "";
65*de0e0e4dSAntonio Huete Jimenez
66*de0e0e4dSAntonio Huete Jimenez /* These internal functions handle 'CMD'-related control commands when the
67*de0e0e4dSAntonio Huete Jimenez * ENGINE in question has asked us to take care of it (ie. the ENGINE did not
68*de0e0e4dSAntonio Huete Jimenez * set the ENGINE_FLAGS_MANUAL_CMD_CTRL flag. */
69*de0e0e4dSAntonio Huete Jimenez
70*de0e0e4dSAntonio Huete Jimenez static int
int_ctrl_cmd_is_null(const ENGINE_CMD_DEFN * defn)71*de0e0e4dSAntonio Huete Jimenez int_ctrl_cmd_is_null(const ENGINE_CMD_DEFN *defn)
72*de0e0e4dSAntonio Huete Jimenez {
73*de0e0e4dSAntonio Huete Jimenez if ((defn->cmd_num == 0) || (defn->cmd_name == NULL))
74*de0e0e4dSAntonio Huete Jimenez return 1;
75*de0e0e4dSAntonio Huete Jimenez return 0;
76*de0e0e4dSAntonio Huete Jimenez }
77*de0e0e4dSAntonio Huete Jimenez
78*de0e0e4dSAntonio Huete Jimenez static int
int_ctrl_cmd_by_name(const ENGINE_CMD_DEFN * defn,const char * s)79*de0e0e4dSAntonio Huete Jimenez int_ctrl_cmd_by_name(const ENGINE_CMD_DEFN *defn, const char *s)
80*de0e0e4dSAntonio Huete Jimenez {
81*de0e0e4dSAntonio Huete Jimenez int idx = 0;
82*de0e0e4dSAntonio Huete Jimenez while (!int_ctrl_cmd_is_null(defn) &&
83*de0e0e4dSAntonio Huete Jimenez (strcmp(defn->cmd_name, s) != 0)) {
84*de0e0e4dSAntonio Huete Jimenez idx++;
85*de0e0e4dSAntonio Huete Jimenez defn++;
86*de0e0e4dSAntonio Huete Jimenez }
87*de0e0e4dSAntonio Huete Jimenez if (int_ctrl_cmd_is_null(defn))
88*de0e0e4dSAntonio Huete Jimenez /* The given name wasn't found */
89*de0e0e4dSAntonio Huete Jimenez return -1;
90*de0e0e4dSAntonio Huete Jimenez return idx;
91*de0e0e4dSAntonio Huete Jimenez }
92*de0e0e4dSAntonio Huete Jimenez
93*de0e0e4dSAntonio Huete Jimenez static int
int_ctrl_cmd_by_num(const ENGINE_CMD_DEFN * defn,unsigned int num)94*de0e0e4dSAntonio Huete Jimenez int_ctrl_cmd_by_num(const ENGINE_CMD_DEFN *defn, unsigned int num)
95*de0e0e4dSAntonio Huete Jimenez {
96*de0e0e4dSAntonio Huete Jimenez int idx = 0;
97*de0e0e4dSAntonio Huete Jimenez /* NB: It is stipulated that 'cmd_defn' lists are ordered by cmd_num. So
98*de0e0e4dSAntonio Huete Jimenez * our searches don't need to take any longer than necessary. */
99*de0e0e4dSAntonio Huete Jimenez while (!int_ctrl_cmd_is_null(defn) && (defn->cmd_num < num)) {
100*de0e0e4dSAntonio Huete Jimenez idx++;
101*de0e0e4dSAntonio Huete Jimenez defn++;
102*de0e0e4dSAntonio Huete Jimenez }
103*de0e0e4dSAntonio Huete Jimenez if (defn->cmd_num == num)
104*de0e0e4dSAntonio Huete Jimenez return idx;
105*de0e0e4dSAntonio Huete Jimenez /* The given cmd_num wasn't found */
106*de0e0e4dSAntonio Huete Jimenez return -1;
107*de0e0e4dSAntonio Huete Jimenez }
108*de0e0e4dSAntonio Huete Jimenez
109*de0e0e4dSAntonio Huete Jimenez static int
int_ctrl_helper(ENGINE * e,int cmd,long i,void * p,void (* f)(void))110*de0e0e4dSAntonio Huete Jimenez int_ctrl_helper(ENGINE *e, int cmd, long i, void *p, void (*f)(void))
111*de0e0e4dSAntonio Huete Jimenez {
112*de0e0e4dSAntonio Huete Jimenez int idx;
113*de0e0e4dSAntonio Huete Jimenez int ret;
114*de0e0e4dSAntonio Huete Jimenez char *s = (char *)p;
115*de0e0e4dSAntonio Huete Jimenez
116*de0e0e4dSAntonio Huete Jimenez /* Take care of the easy one first (eg. it requires no searches) */
117*de0e0e4dSAntonio Huete Jimenez if (cmd == ENGINE_CTRL_GET_FIRST_CMD_TYPE) {
118*de0e0e4dSAntonio Huete Jimenez if ((e->cmd_defns == NULL) ||
119*de0e0e4dSAntonio Huete Jimenez int_ctrl_cmd_is_null(e->cmd_defns))
120*de0e0e4dSAntonio Huete Jimenez return 0;
121*de0e0e4dSAntonio Huete Jimenez return e->cmd_defns->cmd_num;
122*de0e0e4dSAntonio Huete Jimenez }
123*de0e0e4dSAntonio Huete Jimenez /* One or two commands require that "p" be a valid string buffer */
124*de0e0e4dSAntonio Huete Jimenez if ((cmd == ENGINE_CTRL_GET_CMD_FROM_NAME) ||
125*de0e0e4dSAntonio Huete Jimenez (cmd == ENGINE_CTRL_GET_NAME_FROM_CMD) ||
126*de0e0e4dSAntonio Huete Jimenez (cmd == ENGINE_CTRL_GET_DESC_FROM_CMD)) {
127*de0e0e4dSAntonio Huete Jimenez if (s == NULL) {
128*de0e0e4dSAntonio Huete Jimenez ENGINEerror(ERR_R_PASSED_NULL_PARAMETER);
129*de0e0e4dSAntonio Huete Jimenez return -1;
130*de0e0e4dSAntonio Huete Jimenez }
131*de0e0e4dSAntonio Huete Jimenez }
132*de0e0e4dSAntonio Huete Jimenez /* Now handle cmd_name -> cmd_num conversion */
133*de0e0e4dSAntonio Huete Jimenez if (cmd == ENGINE_CTRL_GET_CMD_FROM_NAME) {
134*de0e0e4dSAntonio Huete Jimenez if ((e->cmd_defns == NULL) ||
135*de0e0e4dSAntonio Huete Jimenez ((idx = int_ctrl_cmd_by_name(e->cmd_defns, s)) < 0)) {
136*de0e0e4dSAntonio Huete Jimenez ENGINEerror(ENGINE_R_INVALID_CMD_NAME);
137*de0e0e4dSAntonio Huete Jimenez return -1;
138*de0e0e4dSAntonio Huete Jimenez }
139*de0e0e4dSAntonio Huete Jimenez return e->cmd_defns[idx].cmd_num;
140*de0e0e4dSAntonio Huete Jimenez }
141*de0e0e4dSAntonio Huete Jimenez /* For the rest of the commands, the 'long' argument must specify a
142*de0e0e4dSAntonio Huete Jimenez * valie command number - so we need to conduct a search. */
143*de0e0e4dSAntonio Huete Jimenez if ((e->cmd_defns == NULL) ||
144*de0e0e4dSAntonio Huete Jimenez ((idx = int_ctrl_cmd_by_num(e->cmd_defns, (unsigned int)i)) < 0)) {
145*de0e0e4dSAntonio Huete Jimenez ENGINEerror(ENGINE_R_INVALID_CMD_NUMBER);
146*de0e0e4dSAntonio Huete Jimenez return -1;
147*de0e0e4dSAntonio Huete Jimenez }
148*de0e0e4dSAntonio Huete Jimenez /* Now the logic splits depending on command type */
149*de0e0e4dSAntonio Huete Jimenez switch (cmd) {
150*de0e0e4dSAntonio Huete Jimenez case ENGINE_CTRL_GET_NEXT_CMD_TYPE:
151*de0e0e4dSAntonio Huete Jimenez idx++;
152*de0e0e4dSAntonio Huete Jimenez if (int_ctrl_cmd_is_null(e->cmd_defns + idx))
153*de0e0e4dSAntonio Huete Jimenez /* end-of-list */
154*de0e0e4dSAntonio Huete Jimenez return 0;
155*de0e0e4dSAntonio Huete Jimenez else
156*de0e0e4dSAntonio Huete Jimenez return e->cmd_defns[idx].cmd_num;
157*de0e0e4dSAntonio Huete Jimenez case ENGINE_CTRL_GET_NAME_LEN_FROM_CMD:
158*de0e0e4dSAntonio Huete Jimenez return strlen(e->cmd_defns[idx].cmd_name);
159*de0e0e4dSAntonio Huete Jimenez case ENGINE_CTRL_GET_NAME_FROM_CMD:
160*de0e0e4dSAntonio Huete Jimenez ret = snprintf(s, strlen(e->cmd_defns[idx].cmd_name) + 1,
161*de0e0e4dSAntonio Huete Jimenez "%s", e->cmd_defns[idx].cmd_name);
162*de0e0e4dSAntonio Huete Jimenez if (ret >= (strlen(e->cmd_defns[idx].cmd_name) + 1))
163*de0e0e4dSAntonio Huete Jimenez ret = -1;
164*de0e0e4dSAntonio Huete Jimenez return ret;
165*de0e0e4dSAntonio Huete Jimenez case ENGINE_CTRL_GET_DESC_LEN_FROM_CMD:
166*de0e0e4dSAntonio Huete Jimenez if (e->cmd_defns[idx].cmd_desc)
167*de0e0e4dSAntonio Huete Jimenez return strlen(e->cmd_defns[idx].cmd_desc);
168*de0e0e4dSAntonio Huete Jimenez return strlen(int_no_description);
169*de0e0e4dSAntonio Huete Jimenez case ENGINE_CTRL_GET_DESC_FROM_CMD:
170*de0e0e4dSAntonio Huete Jimenez if (e->cmd_defns[idx].cmd_desc) {
171*de0e0e4dSAntonio Huete Jimenez ret = snprintf(s,
172*de0e0e4dSAntonio Huete Jimenez strlen(e->cmd_defns[idx].cmd_desc) + 1,
173*de0e0e4dSAntonio Huete Jimenez "%s", e->cmd_defns[idx].cmd_desc);
174*de0e0e4dSAntonio Huete Jimenez if (ret >= strlen(e->cmd_defns[idx].cmd_desc) + 1)
175*de0e0e4dSAntonio Huete Jimenez ret = -1;
176*de0e0e4dSAntonio Huete Jimenez return ret;
177*de0e0e4dSAntonio Huete Jimenez }
178*de0e0e4dSAntonio Huete Jimenez ret = snprintf(s, strlen(int_no_description) + 1, "%s",
179*de0e0e4dSAntonio Huete Jimenez int_no_description);
180*de0e0e4dSAntonio Huete Jimenez if (ret >= strlen(int_no_description) + 1)
181*de0e0e4dSAntonio Huete Jimenez ret = -1;
182*de0e0e4dSAntonio Huete Jimenez return ret;
183*de0e0e4dSAntonio Huete Jimenez case ENGINE_CTRL_GET_CMD_FLAGS:
184*de0e0e4dSAntonio Huete Jimenez return e->cmd_defns[idx].cmd_flags;
185*de0e0e4dSAntonio Huete Jimenez }
186*de0e0e4dSAntonio Huete Jimenez
187*de0e0e4dSAntonio Huete Jimenez /* Shouldn't really be here ... */
188*de0e0e4dSAntonio Huete Jimenez ENGINEerror(ENGINE_R_INTERNAL_LIST_ERROR);
189*de0e0e4dSAntonio Huete Jimenez return -1;
190*de0e0e4dSAntonio Huete Jimenez }
191*de0e0e4dSAntonio Huete Jimenez
192*de0e0e4dSAntonio Huete Jimenez int
ENGINE_ctrl(ENGINE * e,int cmd,long i,void * p,void (* f)(void))193*de0e0e4dSAntonio Huete Jimenez ENGINE_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)(void))
194*de0e0e4dSAntonio Huete Jimenez {
195*de0e0e4dSAntonio Huete Jimenez int ctrl_exists, ref_exists;
196*de0e0e4dSAntonio Huete Jimenez
197*de0e0e4dSAntonio Huete Jimenez if (e == NULL) {
198*de0e0e4dSAntonio Huete Jimenez ENGINEerror(ERR_R_PASSED_NULL_PARAMETER);
199*de0e0e4dSAntonio Huete Jimenez return 0;
200*de0e0e4dSAntonio Huete Jimenez }
201*de0e0e4dSAntonio Huete Jimenez CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
202*de0e0e4dSAntonio Huete Jimenez ref_exists = ((e->struct_ref > 0) ? 1 : 0);
203*de0e0e4dSAntonio Huete Jimenez CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
204*de0e0e4dSAntonio Huete Jimenez ctrl_exists = ((e->ctrl == NULL) ? 0 : 1);
205*de0e0e4dSAntonio Huete Jimenez if (!ref_exists) {
206*de0e0e4dSAntonio Huete Jimenez ENGINEerror(ENGINE_R_NO_REFERENCE);
207*de0e0e4dSAntonio Huete Jimenez return 0;
208*de0e0e4dSAntonio Huete Jimenez }
209*de0e0e4dSAntonio Huete Jimenez /* Intercept any "root-level" commands before trying to hand them on to
210*de0e0e4dSAntonio Huete Jimenez * ctrl() handlers. */
211*de0e0e4dSAntonio Huete Jimenez switch (cmd) {
212*de0e0e4dSAntonio Huete Jimenez case ENGINE_CTRL_HAS_CTRL_FUNCTION:
213*de0e0e4dSAntonio Huete Jimenez return ctrl_exists;
214*de0e0e4dSAntonio Huete Jimenez case ENGINE_CTRL_GET_FIRST_CMD_TYPE:
215*de0e0e4dSAntonio Huete Jimenez case ENGINE_CTRL_GET_NEXT_CMD_TYPE:
216*de0e0e4dSAntonio Huete Jimenez case ENGINE_CTRL_GET_CMD_FROM_NAME:
217*de0e0e4dSAntonio Huete Jimenez case ENGINE_CTRL_GET_NAME_LEN_FROM_CMD:
218*de0e0e4dSAntonio Huete Jimenez case ENGINE_CTRL_GET_NAME_FROM_CMD:
219*de0e0e4dSAntonio Huete Jimenez case ENGINE_CTRL_GET_DESC_LEN_FROM_CMD:
220*de0e0e4dSAntonio Huete Jimenez case ENGINE_CTRL_GET_DESC_FROM_CMD:
221*de0e0e4dSAntonio Huete Jimenez case ENGINE_CTRL_GET_CMD_FLAGS:
222*de0e0e4dSAntonio Huete Jimenez if (ctrl_exists && !(e->flags & ENGINE_FLAGS_MANUAL_CMD_CTRL))
223*de0e0e4dSAntonio Huete Jimenez return int_ctrl_helper(e, cmd, i, p, f);
224*de0e0e4dSAntonio Huete Jimenez if (!ctrl_exists) {
225*de0e0e4dSAntonio Huete Jimenez ENGINEerror(ENGINE_R_NO_CONTROL_FUNCTION);
226*de0e0e4dSAntonio Huete Jimenez /* For these cmd-related functions, failure is indicated
227*de0e0e4dSAntonio Huete Jimenez * by a -1 return value (because 0 is used as a valid
228*de0e0e4dSAntonio Huete Jimenez * return in some places). */
229*de0e0e4dSAntonio Huete Jimenez return -1;
230*de0e0e4dSAntonio Huete Jimenez }
231*de0e0e4dSAntonio Huete Jimenez default:
232*de0e0e4dSAntonio Huete Jimenez break;
233*de0e0e4dSAntonio Huete Jimenez }
234*de0e0e4dSAntonio Huete Jimenez /* Anything else requires a ctrl() handler to exist. */
235*de0e0e4dSAntonio Huete Jimenez if (!ctrl_exists) {
236*de0e0e4dSAntonio Huete Jimenez ENGINEerror(ENGINE_R_NO_CONTROL_FUNCTION);
237*de0e0e4dSAntonio Huete Jimenez return 0;
238*de0e0e4dSAntonio Huete Jimenez }
239*de0e0e4dSAntonio Huete Jimenez return e->ctrl(e, cmd, i, p, f);
240*de0e0e4dSAntonio Huete Jimenez }
241*de0e0e4dSAntonio Huete Jimenez
242*de0e0e4dSAntonio Huete Jimenez int
ENGINE_cmd_is_executable(ENGINE * e,int cmd)243*de0e0e4dSAntonio Huete Jimenez ENGINE_cmd_is_executable(ENGINE *e, int cmd)
244*de0e0e4dSAntonio Huete Jimenez {
245*de0e0e4dSAntonio Huete Jimenez int flags;
246*de0e0e4dSAntonio Huete Jimenez
247*de0e0e4dSAntonio Huete Jimenez if ((flags = ENGINE_ctrl(e, ENGINE_CTRL_GET_CMD_FLAGS, cmd,
248*de0e0e4dSAntonio Huete Jimenez NULL, NULL)) < 0) {
249*de0e0e4dSAntonio Huete Jimenez ENGINEerror(ENGINE_R_INVALID_CMD_NUMBER);
250*de0e0e4dSAntonio Huete Jimenez return 0;
251*de0e0e4dSAntonio Huete Jimenez }
252*de0e0e4dSAntonio Huete Jimenez if (!(flags & ENGINE_CMD_FLAG_NO_INPUT) &&
253*de0e0e4dSAntonio Huete Jimenez !(flags & ENGINE_CMD_FLAG_NUMERIC) &&
254*de0e0e4dSAntonio Huete Jimenez !(flags & ENGINE_CMD_FLAG_STRING))
255*de0e0e4dSAntonio Huete Jimenez return 0;
256*de0e0e4dSAntonio Huete Jimenez return 1;
257*de0e0e4dSAntonio Huete Jimenez }
258*de0e0e4dSAntonio Huete Jimenez
259*de0e0e4dSAntonio Huete Jimenez int
ENGINE_ctrl_cmd(ENGINE * e,const char * cmd_name,long i,void * p,void (* f)(void),int cmd_optional)260*de0e0e4dSAntonio Huete Jimenez ENGINE_ctrl_cmd(ENGINE *e, const char *cmd_name, long i, void *p,
261*de0e0e4dSAntonio Huete Jimenez void (*f)(void), int cmd_optional)
262*de0e0e4dSAntonio Huete Jimenez {
263*de0e0e4dSAntonio Huete Jimenez int num;
264*de0e0e4dSAntonio Huete Jimenez
265*de0e0e4dSAntonio Huete Jimenez if ((e == NULL) || (cmd_name == NULL)) {
266*de0e0e4dSAntonio Huete Jimenez ENGINEerror(ERR_R_PASSED_NULL_PARAMETER);
267*de0e0e4dSAntonio Huete Jimenez return 0;
268*de0e0e4dSAntonio Huete Jimenez }
269*de0e0e4dSAntonio Huete Jimenez if ((e->ctrl == NULL) ||
270*de0e0e4dSAntonio Huete Jimenez ((num = ENGINE_ctrl(e, ENGINE_CTRL_GET_CMD_FROM_NAME,
271*de0e0e4dSAntonio Huete Jimenez 0, (void *)cmd_name, NULL)) <= 0)) {
272*de0e0e4dSAntonio Huete Jimenez /* If the command didn't *have* to be supported, we fake
273*de0e0e4dSAntonio Huete Jimenez * success. This allows certain settings to be specified for
274*de0e0e4dSAntonio Huete Jimenez * multiple ENGINEs and only require a change of ENGINE id
275*de0e0e4dSAntonio Huete Jimenez * (without having to selectively apply settings). Eg. changing
276*de0e0e4dSAntonio Huete Jimenez * from a hardware device back to the regular software ENGINE
277*de0e0e4dSAntonio Huete Jimenez * without editing the config file, etc. */
278*de0e0e4dSAntonio Huete Jimenez if (cmd_optional) {
279*de0e0e4dSAntonio Huete Jimenez ERR_clear_error();
280*de0e0e4dSAntonio Huete Jimenez return 1;
281*de0e0e4dSAntonio Huete Jimenez }
282*de0e0e4dSAntonio Huete Jimenez ENGINEerror(ENGINE_R_INVALID_CMD_NAME);
283*de0e0e4dSAntonio Huete Jimenez return 0;
284*de0e0e4dSAntonio Huete Jimenez }
285*de0e0e4dSAntonio Huete Jimenez
286*de0e0e4dSAntonio Huete Jimenez /* Force the result of the control command to 0 or 1, for the reasons
287*de0e0e4dSAntonio Huete Jimenez * mentioned before. */
288*de0e0e4dSAntonio Huete Jimenez if (ENGINE_ctrl(e, num, i, p, f) > 0)
289*de0e0e4dSAntonio Huete Jimenez return 1;
290*de0e0e4dSAntonio Huete Jimenez
291*de0e0e4dSAntonio Huete Jimenez return 0;
292*de0e0e4dSAntonio Huete Jimenez }
293*de0e0e4dSAntonio Huete Jimenez
294*de0e0e4dSAntonio Huete Jimenez int
ENGINE_ctrl_cmd_string(ENGINE * e,const char * cmd_name,const char * arg,int cmd_optional)295*de0e0e4dSAntonio Huete Jimenez ENGINE_ctrl_cmd_string(ENGINE *e, const char *cmd_name, const char *arg,
296*de0e0e4dSAntonio Huete Jimenez int cmd_optional)
297*de0e0e4dSAntonio Huete Jimenez {
298*de0e0e4dSAntonio Huete Jimenez int num, flags;
299*de0e0e4dSAntonio Huete Jimenez long l;
300*de0e0e4dSAntonio Huete Jimenez char *ptr;
301*de0e0e4dSAntonio Huete Jimenez
302*de0e0e4dSAntonio Huete Jimenez if ((e == NULL) || (cmd_name == NULL)) {
303*de0e0e4dSAntonio Huete Jimenez ENGINEerror(ERR_R_PASSED_NULL_PARAMETER);
304*de0e0e4dSAntonio Huete Jimenez return 0;
305*de0e0e4dSAntonio Huete Jimenez }
306*de0e0e4dSAntonio Huete Jimenez if ((e->ctrl == NULL) ||
307*de0e0e4dSAntonio Huete Jimenez ((num = ENGINE_ctrl(e, ENGINE_CTRL_GET_CMD_FROM_NAME, 0,
308*de0e0e4dSAntonio Huete Jimenez (void *)cmd_name, NULL)) <= 0)) {
309*de0e0e4dSAntonio Huete Jimenez /* If the command didn't *have* to be supported, we fake
310*de0e0e4dSAntonio Huete Jimenez * success. This allows certain settings to be specified for
311*de0e0e4dSAntonio Huete Jimenez * multiple ENGINEs and only require a change of ENGINE id
312*de0e0e4dSAntonio Huete Jimenez * (without having to selectively apply settings). Eg. changing
313*de0e0e4dSAntonio Huete Jimenez * from a hardware device back to the regular software ENGINE
314*de0e0e4dSAntonio Huete Jimenez * without editing the config file, etc. */
315*de0e0e4dSAntonio Huete Jimenez if (cmd_optional) {
316*de0e0e4dSAntonio Huete Jimenez ERR_clear_error();
317*de0e0e4dSAntonio Huete Jimenez return 1;
318*de0e0e4dSAntonio Huete Jimenez }
319*de0e0e4dSAntonio Huete Jimenez ENGINEerror(ENGINE_R_INVALID_CMD_NAME);
320*de0e0e4dSAntonio Huete Jimenez return 0;
321*de0e0e4dSAntonio Huete Jimenez }
322*de0e0e4dSAntonio Huete Jimenez if (!ENGINE_cmd_is_executable(e, num)) {
323*de0e0e4dSAntonio Huete Jimenez ENGINEerror(ENGINE_R_CMD_NOT_EXECUTABLE);
324*de0e0e4dSAntonio Huete Jimenez return 0;
325*de0e0e4dSAntonio Huete Jimenez }
326*de0e0e4dSAntonio Huete Jimenez if ((flags = ENGINE_ctrl(e, ENGINE_CTRL_GET_CMD_FLAGS, num,
327*de0e0e4dSAntonio Huete Jimenez NULL, NULL)) < 0) {
328*de0e0e4dSAntonio Huete Jimenez /* Shouldn't happen, given that ENGINE_cmd_is_executable()
329*de0e0e4dSAntonio Huete Jimenez * returned success. */
330*de0e0e4dSAntonio Huete Jimenez ENGINEerror(ENGINE_R_INTERNAL_LIST_ERROR);
331*de0e0e4dSAntonio Huete Jimenez return 0;
332*de0e0e4dSAntonio Huete Jimenez }
333*de0e0e4dSAntonio Huete Jimenez /* If the command takes no input, there must be no input. And vice
334*de0e0e4dSAntonio Huete Jimenez * versa. */
335*de0e0e4dSAntonio Huete Jimenez if (flags & ENGINE_CMD_FLAG_NO_INPUT) {
336*de0e0e4dSAntonio Huete Jimenez if (arg != NULL) {
337*de0e0e4dSAntonio Huete Jimenez ENGINEerror(ENGINE_R_COMMAND_TAKES_NO_INPUT);
338*de0e0e4dSAntonio Huete Jimenez return 0;
339*de0e0e4dSAntonio Huete Jimenez }
340*de0e0e4dSAntonio Huete Jimenez /* We deliberately force the result of ENGINE_ctrl() to 0 or 1
341*de0e0e4dSAntonio Huete Jimenez * rather than returning it as "return data". This is to ensure
342*de0e0e4dSAntonio Huete Jimenez * usage of these commands is consistent across applications and
343*de0e0e4dSAntonio Huete Jimenez * that certain applications don't understand it one way, and
344*de0e0e4dSAntonio Huete Jimenez * others another. */
345*de0e0e4dSAntonio Huete Jimenez if (ENGINE_ctrl(e, num, 0, (void *)arg, NULL) > 0)
346*de0e0e4dSAntonio Huete Jimenez return 1;
347*de0e0e4dSAntonio Huete Jimenez return 0;
348*de0e0e4dSAntonio Huete Jimenez }
349*de0e0e4dSAntonio Huete Jimenez /* So, we require input */
350*de0e0e4dSAntonio Huete Jimenez if (arg == NULL) {
351*de0e0e4dSAntonio Huete Jimenez ENGINEerror(ENGINE_R_COMMAND_TAKES_INPUT);
352*de0e0e4dSAntonio Huete Jimenez return 0;
353*de0e0e4dSAntonio Huete Jimenez }
354*de0e0e4dSAntonio Huete Jimenez /* If it takes string input, that's easy */
355*de0e0e4dSAntonio Huete Jimenez if (flags & ENGINE_CMD_FLAG_STRING) {
356*de0e0e4dSAntonio Huete Jimenez /* Same explanation as above */
357*de0e0e4dSAntonio Huete Jimenez if (ENGINE_ctrl(e, num, 0, (void *)arg, NULL) > 0)
358*de0e0e4dSAntonio Huete Jimenez return 1;
359*de0e0e4dSAntonio Huete Jimenez return 0;
360*de0e0e4dSAntonio Huete Jimenez }
361*de0e0e4dSAntonio Huete Jimenez /* If it doesn't take numeric either, then it is unsupported for use in
362*de0e0e4dSAntonio Huete Jimenez * a config-setting situation, which is what this function is for. This
363*de0e0e4dSAntonio Huete Jimenez * should never happen though, because ENGINE_cmd_is_executable() was
364*de0e0e4dSAntonio Huete Jimenez * used. */
365*de0e0e4dSAntonio Huete Jimenez if (!(flags & ENGINE_CMD_FLAG_NUMERIC)) {
366*de0e0e4dSAntonio Huete Jimenez ENGINEerror(ENGINE_R_INTERNAL_LIST_ERROR);
367*de0e0e4dSAntonio Huete Jimenez return 0;
368*de0e0e4dSAntonio Huete Jimenez }
369*de0e0e4dSAntonio Huete Jimenez l = strtol(arg, &ptr, 10);
370*de0e0e4dSAntonio Huete Jimenez if ((arg == ptr) || (*ptr != '\0')) {
371*de0e0e4dSAntonio Huete Jimenez ENGINEerror(ENGINE_R_ARGUMENT_IS_NOT_A_NUMBER);
372*de0e0e4dSAntonio Huete Jimenez return 0;
373*de0e0e4dSAntonio Huete Jimenez }
374*de0e0e4dSAntonio Huete Jimenez /* Force the result of the control command to 0 or 1, for the reasons
375*de0e0e4dSAntonio Huete Jimenez * mentioned before. */
376*de0e0e4dSAntonio Huete Jimenez if (ENGINE_ctrl(e, num, l, NULL, NULL) > 0)
377*de0e0e4dSAntonio Huete Jimenez return 1;
378*de0e0e4dSAntonio Huete Jimenez return 0;
379*de0e0e4dSAntonio Huete Jimenez }
380