ed1c2205258d8c9a076061aefe2cb5ce7e6d33b6
[openssl.git] / crypto / engine / eng_dyn.c
1 /* crypto/engine/eng_dyn.c */
2 /*
3  * Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL project
4  * 2001.
5  */
6 /* ====================================================================
7  * Copyright (c) 1999-2001 The OpenSSL Project.  All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in
18  *    the documentation and/or other materials provided with the
19  *    distribution.
20  *
21  * 3. All advertising materials mentioning features or use of this
22  *    software must display the following acknowledgment:
23  *    "This product includes software developed by the OpenSSL Project
24  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25  *
26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27  *    endorse or promote products derived from this software without
28  *    prior written permission. For written permission, please contact
29  *    licensing@OpenSSL.org.
30  *
31  * 5. Products derived from this software may not be called "OpenSSL"
32  *    nor may "OpenSSL" appear in their names without prior written
33  *    permission of the OpenSSL Project.
34  *
35  * 6. Redistributions of any form whatsoever must retain the following
36  *    acknowledgment:
37  *    "This product includes software developed by the OpenSSL Project
38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51  * OF THE POSSIBILITY OF SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This product includes cryptographic software written by Eric Young
55  * (eay@cryptsoft.com).  This product includes software written by Tim
56  * Hudson (tjh@cryptsoft.com).
57  *
58  */
59
60 #include "eng_int.h"
61 #include <openssl/dso.h>
62
63 /*
64  * Shared libraries implementing ENGINEs for use by the "dynamic" ENGINE
65  * loader should implement the hook-up functions with the following
66  * prototypes.
67  */
68
69 /* Our ENGINE handlers */
70 static int dynamic_init(ENGINE *e);
71 static int dynamic_finish(ENGINE *e);
72 static int dynamic_ctrl(ENGINE *e, int cmd, long i, void *p,
73                         void (*f) (void));
74 /* Predeclare our context type */
75 typedef struct st_dynamic_data_ctx dynamic_data_ctx;
76 /* The implementation for the important control command */
77 static int dynamic_load(ENGINE *e, dynamic_data_ctx *ctx);
78
79 #define DYNAMIC_CMD_SO_PATH             ENGINE_CMD_BASE
80 #define DYNAMIC_CMD_NO_VCHECK           (ENGINE_CMD_BASE + 1)
81 #define DYNAMIC_CMD_ID                  (ENGINE_CMD_BASE + 2)
82 #define DYNAMIC_CMD_LIST_ADD            (ENGINE_CMD_BASE + 3)
83 #define DYNAMIC_CMD_DIR_LOAD            (ENGINE_CMD_BASE + 4)
84 #define DYNAMIC_CMD_DIR_ADD             (ENGINE_CMD_BASE + 5)
85 #define DYNAMIC_CMD_LOAD                (ENGINE_CMD_BASE + 6)
86
87 /* The constants used when creating the ENGINE */
88 static const char *engine_dynamic_id = "dynamic";
89 static const char *engine_dynamic_name = "Dynamic engine loading support";
90 static const ENGINE_CMD_DEFN dynamic_cmd_defns[] = {
91     {DYNAMIC_CMD_SO_PATH,
92      "SO_PATH",
93      "Specifies the path to the new ENGINE shared library",
94      ENGINE_CMD_FLAG_STRING},
95     {DYNAMIC_CMD_NO_VCHECK,
96      "NO_VCHECK",
97      "Specifies to continue even if version checking fails (boolean)",
98      ENGINE_CMD_FLAG_NUMERIC},
99     {DYNAMIC_CMD_ID,
100      "ID",
101      "Specifies an ENGINE id name for loading",
102      ENGINE_CMD_FLAG_STRING},
103     {DYNAMIC_CMD_LIST_ADD,
104      "LIST_ADD",
105      "Whether to add a loaded ENGINE to the internal list (0=no,1=yes,2=mandatory)",
106      ENGINE_CMD_FLAG_NUMERIC},
107     {DYNAMIC_CMD_DIR_LOAD,
108      "DIR_LOAD",
109      "Specifies whether to load from 'DIR_ADD' directories (0=no,1=yes,2=mandatory)",
110      ENGINE_CMD_FLAG_NUMERIC},
111     {DYNAMIC_CMD_DIR_ADD,
112      "DIR_ADD",
113      "Adds a directory from which ENGINEs can be loaded",
114      ENGINE_CMD_FLAG_STRING},
115     {DYNAMIC_CMD_LOAD,
116      "LOAD",
117      "Load up the ENGINE specified by other settings",
118      ENGINE_CMD_FLAG_NO_INPUT},
119     {0, NULL, NULL, 0}
120 };
121
122 /*
123  * Loading code stores state inside the ENGINE structure via the "ex_data"
124  * element. We load all our state into a single structure and use that as a
125  * single context in the "ex_data" stack.
126  */
127 struct st_dynamic_data_ctx {
128     /* The DSO object we load that supplies the ENGINE code */
129     DSO *dynamic_dso;
130     /*
131      * The function pointer to the version checking shared library function
132      */
133     dynamic_v_check_fn v_check;
134     /*
135      * The function pointer to the engine-binding shared library function
136      */
137     dynamic_bind_engine bind_engine;
138     /* The default name/path for loading the shared library */
139     char *DYNAMIC_LIBNAME;
140     /* Whether to continue loading on a version check failure */
141     int no_vcheck;
142     /* If non-NULL, stipulates the 'id' of the ENGINE to be loaded */
143     char *engine_id;
144     /*
145      * If non-zero, a successfully loaded ENGINE should be added to the
146      * internal ENGINE list. If 2, the add must succeed or the entire load
147      * should fail.
148      */
149     int list_add_value;
150     /* The symbol name for the version checking function */
151     const char *DYNAMIC_F1;
152     /* The symbol name for the "initialise ENGINE structure" function */
153     const char *DYNAMIC_F2;
154     /*
155      * Whether to never use 'dirs', use 'dirs' as a fallback, or only use
156      * 'dirs' for loading. Default is to use 'dirs' as a fallback.
157      */
158     int dir_load;
159     /* A stack of directories from which ENGINEs could be loaded */
160     STACK_OF(OPENSSL_STRING) *dirs;
161 };
162
163 /*
164  * This is the "ex_data" index we obtain and reserve for use with our context
165  * structure.
166  */
167 static int dynamic_ex_data_idx = -1;
168
169 static void int_free_str(char *s)
170 {
171     OPENSSL_free(s);
172 }
173
174 /*
175  * Because our ex_data element may or may not get allocated depending on
176  * whether a "first-use" occurs before the ENGINE is freed, we have a memory
177  * leak problem to solve. We can't declare a "new" handler for the ex_data as
178  * we don't want a dynamic_data_ctx in *all* ENGINE structures of all types
179  * (this is a bug in the design of CRYPTO_EX_DATA). As such, we just declare
180  * a "free" handler and that will get called if an ENGINE is being destroyed
181  * and there was an ex_data element corresponding to our context type.
182  */
183 static void dynamic_data_ctx_free_func(void *parent, void *ptr,
184                                        CRYPTO_EX_DATA *ad, int idx, long argl,
185                                        void *argp)
186 {
187     if (ptr) {
188         dynamic_data_ctx *ctx = (dynamic_data_ctx *)ptr;
189         DSO_free(ctx->dynamic_dso);
190         OPENSSL_free(ctx->DYNAMIC_LIBNAME);
191         OPENSSL_free(ctx->engine_id);
192         sk_OPENSSL_STRING_pop_free(ctx->dirs, int_free_str);
193         OPENSSL_free(ctx);
194     }
195 }
196
197 /*
198  * Construct the per-ENGINE context. We create it blindly and then use a lock
199  * to check for a race - if so, all but one of the threads "racing" will have
200  * wasted their time. The alternative involves creating everything inside the
201  * lock which is far worse.
202  */
203 static int dynamic_set_data_ctx(ENGINE *e, dynamic_data_ctx **ctx)
204 {
205     dynamic_data_ctx *c = OPENSSL_malloc(sizeof(*c));
206
207     if (!c) {
208         ENGINEerr(ENGINE_F_DYNAMIC_SET_DATA_CTX, ERR_R_MALLOC_FAILURE);
209         return 0;
210     }
211     memset(c, 0, sizeof(dynamic_data_ctx));
212     c->dynamic_dso = NULL;
213     c->v_check = NULL;
214     c->bind_engine = NULL;
215     c->DYNAMIC_LIBNAME = NULL;
216     c->no_vcheck = 0;
217     c->engine_id = NULL;
218     c->list_add_value = 0;
219     c->DYNAMIC_F1 = "v_check";
220     c->DYNAMIC_F2 = "bind_engine";
221     c->dir_load = 1;
222     c->dirs = sk_OPENSSL_STRING_new_null();
223     if (!c->dirs) {
224         ENGINEerr(ENGINE_F_DYNAMIC_SET_DATA_CTX, ERR_R_MALLOC_FAILURE);
225         OPENSSL_free(c);
226         return 0;
227     }
228     CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
229     if ((*ctx = (dynamic_data_ctx *)ENGINE_get_ex_data(e,
230                                                        dynamic_ex_data_idx))
231         == NULL) {
232         /* Good, we're the first */
233         ENGINE_set_ex_data(e, dynamic_ex_data_idx, c);
234         *ctx = c;
235         c = NULL;
236     }
237     CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
238     /*
239      * If we lost the race to set the context, c is non-NULL and *ctx is the
240      * context of the thread that won.
241      */
242     OPENSSL_free(c);
243     return 1;
244 }
245
246 /*
247  * This function retrieves the context structure from an ENGINE's "ex_data",
248  * or if it doesn't exist yet, sets it up.
249  */
250 static dynamic_data_ctx *dynamic_get_data_ctx(ENGINE *e)
251 {
252     dynamic_data_ctx *ctx;
253     if (dynamic_ex_data_idx < 0) {
254         /*
255          * Create and register the ENGINE ex_data, and associate our "free"
256          * function with it to ensure any allocated contexts get freed when
257          * an ENGINE goes underground.
258          */
259         int new_idx = ENGINE_get_ex_new_index(0, NULL, NULL, NULL,
260                                               dynamic_data_ctx_free_func);
261         if (new_idx == -1) {
262             ENGINEerr(ENGINE_F_DYNAMIC_GET_DATA_CTX, ENGINE_R_NO_INDEX);
263             return NULL;
264         }
265         CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
266         /* Avoid a race by checking again inside this lock */
267         if (dynamic_ex_data_idx < 0) {
268             /* Good, someone didn't beat us to it */
269             dynamic_ex_data_idx = new_idx;
270             new_idx = -1;
271         }
272         CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
273         /*
274          * In theory we could "give back" the index here if (new_idx>-1), but
275          * it's not possible and wouldn't gain us much if it were.
276          */
277     }
278     ctx = (dynamic_data_ctx *)ENGINE_get_ex_data(e, dynamic_ex_data_idx);
279     /* Check if the context needs to be created */
280     if ((ctx == NULL) && !dynamic_set_data_ctx(e, &ctx))
281         /* "set_data" will set errors if necessary */
282         return NULL;
283     return ctx;
284 }
285
286 static ENGINE *engine_dynamic(void)
287 {
288     ENGINE *ret = ENGINE_new();
289     if (!ret)
290         return NULL;
291     if (!ENGINE_set_id(ret, engine_dynamic_id) ||
292         !ENGINE_set_name(ret, engine_dynamic_name) ||
293         !ENGINE_set_init_function(ret, dynamic_init) ||
294         !ENGINE_set_finish_function(ret, dynamic_finish) ||
295         !ENGINE_set_ctrl_function(ret, dynamic_ctrl) ||
296         !ENGINE_set_flags(ret, ENGINE_FLAGS_BY_ID_COPY) ||
297         !ENGINE_set_cmd_defns(ret, dynamic_cmd_defns)) {
298         ENGINE_free(ret);
299         return NULL;
300     }
301     return ret;
302 }
303
304 void ENGINE_load_dynamic(void)
305 {
306     ENGINE *toadd = engine_dynamic();
307     if (!toadd)
308         return;
309     ENGINE_add(toadd);
310     /*
311      * If the "add" worked, it gets a structural reference. So either way, we
312      * release our just-created reference.
313      */
314     ENGINE_free(toadd);
315     /*
316      * If the "add" didn't work, it was probably a conflict because it was
317      * already added (eg. someone calling ENGINE_load_blah then calling
318      * ENGINE_load_builtin_engines() perhaps).
319      */
320     ERR_clear_error();
321 }
322
323 static int dynamic_init(ENGINE *e)
324 {
325     /*
326      * We always return failure - the "dyanamic" engine itself can't be used
327      * for anything.
328      */
329     return 0;
330 }
331
332 static int dynamic_finish(ENGINE *e)
333 {
334     /*
335      * This should never be called on account of "dynamic_init" always
336      * failing.
337      */
338     return 0;
339 }
340
341 static int dynamic_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f) (void))
342 {
343     dynamic_data_ctx *ctx = dynamic_get_data_ctx(e);
344     int initialised;
345
346     if (!ctx) {
347         ENGINEerr(ENGINE_F_DYNAMIC_CTRL, ENGINE_R_NOT_LOADED);
348         return 0;
349     }
350     initialised = ((ctx->dynamic_dso == NULL) ? 0 : 1);
351     /* All our control commands require the ENGINE to be uninitialised */
352     if (initialised) {
353         ENGINEerr(ENGINE_F_DYNAMIC_CTRL, ENGINE_R_ALREADY_LOADED);
354         return 0;
355     }
356     switch (cmd) {
357     case DYNAMIC_CMD_SO_PATH:
358         /* a NULL 'p' or a string of zero-length is the same thing */
359         if (p && (strlen((const char *)p) < 1))
360             p = NULL;
361         OPENSSL_free(ctx->DYNAMIC_LIBNAME);
362         if (p)
363             ctx->DYNAMIC_LIBNAME = BUF_strdup(p);
364         else
365             ctx->DYNAMIC_LIBNAME = NULL;
366         return (ctx->DYNAMIC_LIBNAME ? 1 : 0);
367     case DYNAMIC_CMD_NO_VCHECK:
368         ctx->no_vcheck = ((i == 0) ? 0 : 1);
369         return 1;
370     case DYNAMIC_CMD_ID:
371         /* a NULL 'p' or a string of zero-length is the same thing */
372         if (p && (strlen((const char *)p) < 1))
373             p = NULL;
374         OPENSSL_free(ctx->engine_id);
375         if (p)
376             ctx->engine_id = BUF_strdup(p);
377         else
378             ctx->engine_id = NULL;
379         return (ctx->engine_id ? 1 : 0);
380     case DYNAMIC_CMD_LIST_ADD:
381         if ((i < 0) || (i > 2)) {
382             ENGINEerr(ENGINE_F_DYNAMIC_CTRL, ENGINE_R_INVALID_ARGUMENT);
383             return 0;
384         }
385         ctx->list_add_value = (int)i;
386         return 1;
387     case DYNAMIC_CMD_LOAD:
388         return dynamic_load(e, ctx);
389     case DYNAMIC_CMD_DIR_LOAD:
390         if ((i < 0) || (i > 2)) {
391             ENGINEerr(ENGINE_F_DYNAMIC_CTRL, ENGINE_R_INVALID_ARGUMENT);
392             return 0;
393         }
394         ctx->dir_load = (int)i;
395         return 1;
396     case DYNAMIC_CMD_DIR_ADD:
397         /* a NULL 'p' or a string of zero-length is the same thing */
398         if (!p || (strlen((const char *)p) < 1)) {
399             ENGINEerr(ENGINE_F_DYNAMIC_CTRL, ENGINE_R_INVALID_ARGUMENT);
400             return 0;
401         }
402         {
403             char *tmp_str = BUF_strdup(p);
404             if (!tmp_str) {
405                 ENGINEerr(ENGINE_F_DYNAMIC_CTRL, ERR_R_MALLOC_FAILURE);
406                 return 0;
407             }
408             sk_OPENSSL_STRING_insert(ctx->dirs, tmp_str, -1);
409         }
410         return 1;
411     default:
412         break;
413     }
414     ENGINEerr(ENGINE_F_DYNAMIC_CTRL, ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED);
415     return 0;
416 }
417
418 static int int_load(dynamic_data_ctx *ctx)
419 {
420     int num, loop;
421     /* Unless told not to, try a direct load */
422     if ((ctx->dir_load != 2) && (DSO_load(ctx->dynamic_dso,
423                                           ctx->DYNAMIC_LIBNAME, NULL,
424                                           0)) != NULL)
425         return 1;
426     /* If we're not allowed to use 'dirs' or we have none, fail */
427     if (!ctx->dir_load || (num = sk_OPENSSL_STRING_num(ctx->dirs)) < 1)
428         return 0;
429     for (loop = 0; loop < num; loop++) {
430         const char *s = sk_OPENSSL_STRING_value(ctx->dirs, loop);
431         char *merge = DSO_merge(ctx->dynamic_dso, ctx->DYNAMIC_LIBNAME, s);
432         if (!merge)
433             return 0;
434         if (DSO_load(ctx->dynamic_dso, merge, NULL, 0)) {
435             /* Found what we're looking for */
436             OPENSSL_free(merge);
437             return 1;
438         }
439         OPENSSL_free(merge);
440     }
441     return 0;
442 }
443
444 static int dynamic_load(ENGINE *e, dynamic_data_ctx *ctx)
445 {
446     ENGINE cpy;
447     dynamic_fns fns;
448
449     if (!ctx->dynamic_dso)
450         ctx->dynamic_dso = DSO_new();
451     if (!ctx->DYNAMIC_LIBNAME) {
452         if (!ctx->engine_id)
453             return 0;
454         ctx->DYNAMIC_LIBNAME =
455             DSO_convert_filename(ctx->dynamic_dso, ctx->engine_id);
456     }
457     if (!int_load(ctx)) {
458         ENGINEerr(ENGINE_F_DYNAMIC_LOAD, ENGINE_R_DSO_NOT_FOUND);
459         DSO_free(ctx->dynamic_dso);
460         ctx->dynamic_dso = NULL;
461         return 0;
462     }
463     /* We have to find a bind function otherwise it'll always end badly */
464     if (!
465         (ctx->bind_engine =
466          (dynamic_bind_engine) DSO_bind_func(ctx->dynamic_dso,
467                                              ctx->DYNAMIC_F2))) {
468         ctx->bind_engine = NULL;
469         DSO_free(ctx->dynamic_dso);
470         ctx->dynamic_dso = NULL;
471         ENGINEerr(ENGINE_F_DYNAMIC_LOAD, ENGINE_R_DSO_FAILURE);
472         return 0;
473     }
474     /* Do we perform version checking? */
475     if (!ctx->no_vcheck) {
476         unsigned long vcheck_res = 0;
477         /*
478          * Now we try to find a version checking function and decide how to
479          * cope with failure if/when it fails.
480          */
481         ctx->v_check =
482             (dynamic_v_check_fn) DSO_bind_func(ctx->dynamic_dso,
483                                                ctx->DYNAMIC_F1);
484         if (ctx->v_check)
485             vcheck_res = ctx->v_check(OSSL_DYNAMIC_VERSION);
486         /*
487          * We fail if the version checker veto'd the load *or* if it is
488          * deferring to us (by returning its version) and we think it is too
489          * old.
490          */
491         if (vcheck_res < OSSL_DYNAMIC_OLDEST) {
492             /* Fail */
493             ctx->bind_engine = NULL;
494             ctx->v_check = NULL;
495             DSO_free(ctx->dynamic_dso);
496             ctx->dynamic_dso = NULL;
497             ENGINEerr(ENGINE_F_DYNAMIC_LOAD,
498                       ENGINE_R_VERSION_INCOMPATIBILITY);
499             return 0;
500         }
501     }
502     /*
503      * First binary copy the ENGINE structure so that we can roll back if the
504      * hand-over fails
505      */
506     memcpy(&cpy, e, sizeof(ENGINE));
507     /*
508      * Provide the ERR, "ex_data", memory, and locking callbacks so the
509      * loaded library uses our state rather than its own. FIXME: As noted in
510      * engine.h, much of this would be simplified if each area of code
511      * provided its own "summary" structure of all related callbacks. It
512      * would also increase opaqueness.
513      */
514     fns.static_state = ENGINE_get_static_state();
515     fns.ex_data_fns = CRYPTO_get_ex_data_implementation();
516     CRYPTO_get_mem_functions(&fns.mem_fns.malloc_cb,
517                              &fns.mem_fns.realloc_cb, &fns.mem_fns.free_cb);
518     fns.lock_fns.lock_locking_cb = CRYPTO_get_locking_callback();
519     fns.lock_fns.lock_add_lock_cb = CRYPTO_get_add_lock_callback();
520     fns.lock_fns.dynlock_create_cb = CRYPTO_get_dynlock_create_callback();
521     fns.lock_fns.dynlock_lock_cb = CRYPTO_get_dynlock_lock_callback();
522     fns.lock_fns.dynlock_destroy_cb = CRYPTO_get_dynlock_destroy_callback();
523     /*
524      * Now that we've loaded the dynamic engine, make sure no "dynamic"
525      * ENGINE elements will show through.
526      */
527     engine_set_all_null(e);
528
529     /* Try to bind the ENGINE onto our own ENGINE structure */
530     if (!ctx->bind_engine(e, ctx->engine_id, &fns)) {
531         ctx->bind_engine = NULL;
532         ctx->v_check = NULL;
533         DSO_free(ctx->dynamic_dso);
534         ctx->dynamic_dso = NULL;
535         ENGINEerr(ENGINE_F_DYNAMIC_LOAD, ENGINE_R_INIT_FAILED);
536         /* Copy the original ENGINE structure back */
537         memcpy(e, &cpy, sizeof(ENGINE));
538         return 0;
539     }
540     /* Do we try to add this ENGINE to the internal list too? */
541     if (ctx->list_add_value > 0) {
542         if (!ENGINE_add(e)) {
543             /* Do we tolerate this or fail? */
544             if (ctx->list_add_value > 1) {
545                 /*
546                  * Fail - NB: By this time, it's too late to rollback, and
547                  * trying to do so allows the bind_engine() code to have
548                  * created leaks. We just have to fail where we are, after
549                  * the ENGINE has changed.
550                  */
551                 ENGINEerr(ENGINE_F_DYNAMIC_LOAD,
552                           ENGINE_R_CONFLICTING_ENGINE_ID);
553                 return 0;
554             }
555             /* Tolerate */
556             ERR_clear_error();
557         }
558     }
559     return 1;
560 }