Head

GCC Code Coverage Report

Directory:	./		Exec	Total	Coverage
File:	lib/libcrypto/engine/eng_lib.c	Lines:	59	112	52.7 %
Date:	2017-11-13	Branches:	19	30	63.3 %


/* $OpenBSD: eng_lib.c,v 1.12 2017/01/29 17:49:23 beck Exp $ */
/* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
 * project 2000.
 */
/* ====================================================================
 * Copyright (c) 1999-2001 The OpenSSL Project.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. All advertising materials mentioning features or use of this
 *    software must display the following acknowledgment:
 *    "This product includes software developed by the OpenSSL Project
 *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
 *
 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
 *    endorse or promote products derived from this software without
 *    prior written permission. For written permission, please contact
 *    licensing@OpenSSL.org.
 *
 * 5. Products derived from this software may not be called "OpenSSL"
 *    nor may "OpenSSL" appear in their names without prior written
 *    permission of the OpenSSL Project.
 *
 * 6. Redistributions of any form whatsoever must retain the following
 *    acknowledgment:
 *    "This product includes software developed by the OpenSSL Project
 *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
 *
 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 * ====================================================================
 *
 * This product includes cryptographic software written by Eric Young
 * (eay@cryptsoft.com).  This product includes software written by Tim
 * Hudson (tjh@cryptsoft.com).
 *
 */

#include <string.h>

#include <openssl/err.h>
#include <openssl/rand.h>

#include "eng_int.h"

/* The "new"/"free" stuff first */

ENGINE *
ENGINE_new(void)
{
	ENGINE *ret;

	ret = malloc(sizeof(ENGINE));
	if (ret == NULL) {
		ENGINEerror(ERR_R_MALLOC_FAILURE);
		return NULL;
	}
	memset(ret, 0, sizeof(ENGINE));
	ret->struct_ref = 1;
	engine_ref_debug(ret, 0, 1)
	CRYPTO_new_ex_data(CRYPTO_EX_INDEX_ENGINE, ret, &ret->ex_data);
	return ret;
}

/* Placed here (close proximity to ENGINE_new) so that modifications to the
 * elements of the ENGINE structure are more likely to be caught and changed
 * here. */
void
engine_set_all_null(ENGINE *e)
{
	e->id = NULL;
	e->name = NULL;
	e->rsa_meth = NULL;
	e->dsa_meth = NULL;
	e->dh_meth = NULL;
	e->rand_meth = NULL;
	e->store_meth = NULL;
	e->ciphers = NULL;
	e->digests = NULL;
	e->destroy = NULL;
	e->init = NULL;
	e->finish = NULL;
	e->ctrl = NULL;
	e->load_privkey = NULL;
	e->load_pubkey = NULL;
	e->cmd_defns = NULL;
	e->flags = 0;
}

int
engine_free_util(ENGINE *e, int locked)
{
	int i;

	if (e == NULL) {
		ENGINEerror(ERR_R_PASSED_NULL_PARAMETER);
		return 0;
	}
	if (locked)
		i = CRYPTO_add(&e->struct_ref, -1, CRYPTO_LOCK_ENGINE);
	else
		i = --e->struct_ref;
	engine_ref_debug(e, 0, -1)
	if (i > 0)
		return 1;

	/* Free up any dynamically allocated public key methods */
	engine_pkey_meths_free(e);
	engine_pkey_asn1_meths_free(e);
	/* Give the ENGINE a chance to do any structural cleanup corresponding
	 * to allocation it did in its constructor (eg. unload error strings) */
	if (e->destroy)
		e->destroy(e);
	CRYPTO_free_ex_data(CRYPTO_EX_INDEX_ENGINE, e, &e->ex_data);
	free(e);
	return 1;
}

int
ENGINE_free(ENGINE *e)
{
	return engine_free_util(e, 1);
}

/* Cleanup stuff */

/* ENGINE_cleanup() is coded such that anything that does work that will need
 * cleanup can register a "cleanup" callback here. That way we don't get linker
 * bloat by referring to all *possible* cleanups, but any linker bloat into code
 * "X" will cause X's cleanup function to end up here. */
static STACK_OF(ENGINE_CLEANUP_ITEM) *cleanup_stack = NULL;
static int
int_cleanup_check(int create)
{
	if (cleanup_stack)
		return 1;
	if (!create)
		return 0;
	cleanup_stack = sk_ENGINE_CLEANUP_ITEM_new_null();
	return (cleanup_stack ? 1 : 0);
}

static ENGINE_CLEANUP_ITEM *
int_cleanup_item(ENGINE_CLEANUP_CB *cb)
{
	ENGINE_CLEANUP_ITEM *item = malloc(sizeof(ENGINE_CLEANUP_ITEM));

	if (!item)
		return NULL;
	item->cb = cb;
	return item;
}

void
engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb)
{
	ENGINE_CLEANUP_ITEM *item;

	if (!int_cleanup_check(1))
		return;
	item = int_cleanup_item(cb);
	if (item)
		sk_ENGINE_CLEANUP_ITEM_insert(cleanup_stack, item, 0);
}

void
engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb)
{
	ENGINE_CLEANUP_ITEM *item;

	if (!int_cleanup_check(1))
		return;
	item = int_cleanup_item(cb);
	if (item)
		sk_ENGINE_CLEANUP_ITEM_push(cleanup_stack, item);
}
/* The API function that performs all cleanup */
static void
engine_cleanup_cb_free(ENGINE_CLEANUP_ITEM *item)
{
	(*(item->cb))();
	free(item);
}

void
ENGINE_cleanup(void)
{
	if (int_cleanup_check(0)) {
		sk_ENGINE_CLEANUP_ITEM_pop_free(cleanup_stack,
		    engine_cleanup_cb_free);
		cleanup_stack = NULL;
	}
	/* FIXME: This should be handled (somehow) through RAND, eg. by it
	 * registering a cleanup callback. */
	RAND_set_rand_method(NULL);
}

/* Now the "ex_data" support */

int
ENGINE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
    CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func)
{
	return CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_ENGINE, argl, argp,
	    new_func, dup_func, free_func);
}

int
ENGINE_set_ex_data(ENGINE *e, int idx, void *arg)
{
	return (CRYPTO_set_ex_data(&e->ex_data, idx, arg));
}

void *
ENGINE_get_ex_data(const ENGINE *e, int idx)
{
	return (CRYPTO_get_ex_data(&e->ex_data, idx));
}

/* Functions to get/set an ENGINE's elements - mainly to avoid exposing the
 * ENGINE structure itself. */

int
ENGINE_set_id(ENGINE *e, const char *id)
{
	if (id == NULL) {
		ENGINEerror(ERR_R_PASSED_NULL_PARAMETER);
		return 0;
	}
	e->id = id;
	return 1;
}

int
ENGINE_set_name(ENGINE *e, const char *name)
{
	if (name == NULL) {
		ENGINEerror(ERR_R_PASSED_NULL_PARAMETER);
		return 0;
	}
	e->name = name;
	return 1;
}

int
ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f)
{
	e->destroy = destroy_f;
	return 1;
}

int
ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f)
{
	e->init = init_f;
	return 1;
}

int
ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f)
{
	e->finish = finish_f;
	return 1;
}

int
ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f)
{
	e->ctrl = ctrl_f;
	return 1;
}

int
ENGINE_set_flags(ENGINE *e, int flags)
{
	e->flags = flags;
	return 1;
}

int
ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns)
{
	e->cmd_defns = defns;
	return 1;
}

const char *
ENGINE_get_id(const ENGINE *e)
{
	return e->id;
}

const char *
ENGINE_get_name(const ENGINE *e)
{
	return e->name;
}

ENGINE_GEN_INT_FUNC_PTR
ENGINE_get_destroy_function(const ENGINE *e)
{
	return e->destroy;
}

ENGINE_GEN_INT_FUNC_PTR
ENGINE_get_init_function(const ENGINE *e)
{
	return e->init;
}

ENGINE_GEN_INT_FUNC_PTR
ENGINE_get_finish_function(const ENGINE *e)
{
	return e->finish;
}

ENGINE_CTRL_FUNC_PTR
ENGINE_get_ctrl_function(const ENGINE *e)
{
	return e->ctrl;
}

int
ENGINE_get_flags(const ENGINE *e)
{
	return e->flags;
}

const ENGINE_CMD_DEFN *
ENGINE_get_cmd_defns(const ENGINE *e)
{
	return e->cmd_defns;
}

/* eng_lib.o is pretty much linked into anything that touches ENGINE already, so
 * put the "static_state" hack here. */

static int internal_static_hack = 0;

void *
ENGINE_get_static_state(void)
{
	return &internal_static_hack;
}


Generated by: GCOVR (Version 3.3)

Line	Branch	Exec	Source
1			/* $OpenBSD: eng_lib.c,v 1.12 2017/01/29 17:49:23 beck Exp $ */
2			/* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
3			* project 2000.
4			*/
5			/* ====================================================================
6			* Copyright (c) 1999-2001 The OpenSSL Project. All rights reserved.
7			*
8			* Redistribution and use in source and binary forms, with or without
9			* modification, are permitted provided that the following conditions
10			* are met:
11			*
12			* 1. Redistributions of source code must retain the above copyright
13			* notice, this list of conditions and the following disclaimer.
14			*
15			* 2. Redistributions in binary form must reproduce the above copyright
16			* notice, this list of conditions and the following disclaimer in
17			* the documentation and/or other materials provided with the
18			* distribution.
19			*
20			* 3. All advertising materials mentioning features or use of this
21			* software must display the following acknowledgment:
22			* "This product includes software developed by the OpenSSL Project
23			* for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
24			*
25			* 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26			* endorse or promote products derived from this software without
27			* prior written permission. For written permission, please contact
28			* licensing@OpenSSL.org.
29			*
30			* 5. Products derived from this software may not be called "OpenSSL"
31			* nor may "OpenSSL" appear in their names without prior written
32			* permission of the OpenSSL Project.
33			*
34			* 6. Redistributions of any form whatsoever must retain the following
35			* acknowledgment:
36			* "This product includes software developed by the OpenSSL Project
37			* for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38			*
39			* THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40			* EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41			* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42			* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43			* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44			* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45			* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46			* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47			* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48			* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49			* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50			* OF THE POSSIBILITY OF SUCH DAMAGE.
51			* ====================================================================
52			*
53			* This product includes cryptographic software written by Eric Young
54			* (eay@cryptsoft.com). This product includes software written by Tim
55			* Hudson (tjh@cryptsoft.com).
56			*
57			*/
58
59			#include <string.h>
60
61			#include <openssl/err.h>
62			#include <openssl/rand.h>
63
64			#include "eng_int.h"
65
66			/* The "new"/"free" stuff first */
67
68			ENGINE *
69			ENGINE_new(void)
70			{
71			ENGINE *ret;
72
73		3096	ret = malloc(sizeof(ENGINE));
74	✗✓	1548	if (ret == NULL) {
75			ENGINEerror(ERR_R_MALLOC_FAILURE);
76			return NULL;
77			}
78		1548	memset(ret, 0, sizeof(ENGINE));
79		1548	ret->struct_ref = 1;
80			engine_ref_debug(ret, 0, 1)
81		1548	CRYPTO_new_ex_data(CRYPTO_EX_INDEX_ENGINE, ret, &ret->ex_data);
82		1548	return ret;
83		1548	}
84
85			/* Placed here (close proximity to ENGINE_new) so that modifications to the
86			* elements of the ENGINE structure are more likely to be caught and changed
87			* here. */
88			void
89			engine_set_all_null(ENGINE *e)
90			{
91			e->id = NULL;
92			e->name = NULL;
93			e->rsa_meth = NULL;
94			e->dsa_meth = NULL;
95			e->dh_meth = NULL;
96			e->rand_meth = NULL;
97			e->store_meth = NULL;
98			e->ciphers = NULL;
99			e->digests = NULL;
100			e->destroy = NULL;
101			e->init = NULL;
102			e->finish = NULL;
103			e->ctrl = NULL;
104			e->load_privkey = NULL;
105			e->load_pubkey = NULL;
106			e->cmd_defns = NULL;
107			e->flags = 0;
108			}
109
110			int
111			engine_free_util(ENGINE *e, int locked)
112			{
113			int i;
114
115	✓✓	9372	if (e == NULL) {
116		27	ENGINEerror(ERR_R_PASSED_NULL_PARAMETER);
117		27	return 0;
118			}
119	✓✓	4659	if (locked)
120		3108	i = CRYPTO_add(&e->struct_ref, -1, CRYPTO_LOCK_ENGINE);
121			else
122		1551	i = --e->struct_ref;
123			engine_ref_debug(e, 0, -1)
124	✓✓	4659	if (i > 0)
125		3111	return 1;
126
127			/* Free up any dynamically allocated public key methods */
128		1548	engine_pkey_meths_free(e);
129		1548	engine_pkey_asn1_meths_free(e);
130			/* Give the ENGINE a chance to do any structural cleanup corresponding
131			* to allocation it did in its constructor (eg. unload error strings) */
132	✗✓	1548	if (e->destroy)
133			e->destroy(e);
134		1548	CRYPTO_free_ex_data(CRYPTO_EX_INDEX_ENGINE, e, &e->ex_data);
135		1548	free(e);
136		1548	return 1;
137		4686	}
138
139			int
140			ENGINE_free(ENGINE *e)
141			{
142		6270	return engine_free_util(e, 1);
143			}
144
145			/* Cleanup stuff */
146
147			/* ENGINE_cleanup() is coded such that anything that does work that will need
148			* cleanup can register a "cleanup" callback here. That way we don't get linker
149			* bloat by referring to all possible cleanups, but any linker bloat into code
150			* "X" will cause X's cleanup function to end up here. */
151			static STACK_OF(ENGINE_CLEANUP_ITEM) *cleanup_stack = NULL;
152			static int
153			int_cleanup_check(int create)
154			{
155	✓✓	354	if (cleanup_stack)
156		12	return 1;
157	✓✓	165	if (!create)
158		162	return 0;
159		3	cleanup_stack = sk_ENGINE_CLEANUP_ITEM_new_null();
160		3	return (cleanup_stack ? 1 : 0);
161		177	}
162
163			static ENGINE_CLEANUP_ITEM *
164			int_cleanup_item(ENGINE_CLEANUP_CB *cb)
165			{
166		24	ENGINE_CLEANUP_ITEM *item = malloc(sizeof(ENGINE_CLEANUP_ITEM));
167
168	✗✓	12	if (!item)
169			return NULL;
170		12	item->cb = cb;
171		12	return item;
172		12	}
173
174			void
175			engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb)
176			{
177			ENGINE_CLEANUP_ITEM *item;
178
179			if (!int_cleanup_check(1))
180			return;
181			item = int_cleanup_item(cb);
182			if (item)
183			sk_ENGINE_CLEANUP_ITEM_insert(cleanup_stack, item, 0);
184			}
185
186			void
187			engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb)
188			{
189			ENGINE_CLEANUP_ITEM *item;
190
191	✗✓	24	if (!int_cleanup_check(1))
192			return;
193		12	item = int_cleanup_item(cb);
194	✓✗	12	if (item)
195		12	sk_ENGINE_CLEANUP_ITEM_push(cleanup_stack, item);
196		24	}
197			/* The API function that performs all cleanup */
198			static void
199			engine_cleanup_cb_free(ENGINE_CLEANUP_ITEM *item)
200			{
201		24	(*(item->cb))();
202		12	free(item);
203		12	}
204
205			void
206			ENGINE_cleanup(void)
207			{
208	✓✓	330	if (int_cleanup_check(0)) {
209		3	sk_ENGINE_CLEANUP_ITEM_pop_free(cleanup_stack,
210			engine_cleanup_cb_free);
211		3	cleanup_stack = NULL;
212		3	}
213			/* FIXME: This should be handled (somehow) through RAND, eg. by it
214			* registering a cleanup callback. */
215		165	RAND_set_rand_method(NULL);
216		165	}
217
218			/* Now the "ex_data" support */
219
220			int
221			ENGINE_get_ex_new_index(long argl, void argp, CRYPTO_EX_new new_func,
222			CRYPTO_EX_dup dup_func, CRYPTO_EX_free free_func)
223			{
224			return CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_ENGINE, argl, argp,
225			new_func, dup_func, free_func);
226			}
227
228			int
229			ENGINE_set_ex_data(ENGINE e, int idx, void arg)
230			{
231			return (CRYPTO_set_ex_data(&e->ex_data, idx, arg));
232			}
233
234			void *
235			ENGINE_get_ex_data(const ENGINE *e, int idx)
236			{
237			return (CRYPTO_get_ex_data(&e->ex_data, idx));
238			}
239
240			/* Functions to get/set an ENGINE's elements - mainly to avoid exposing the
241			* ENGINE structure itself. */
242
243			int
244			ENGINE_set_id(ENGINE e, const char id)
245			{
246	✗✓	3096	if (id == NULL) {
247			ENGINEerror(ERR_R_PASSED_NULL_PARAMETER);
248			return 0;
249			}
250		1548	e->id = id;
251		1548	return 1;
252		1548	}
253
254			int
255			ENGINE_set_name(ENGINE e, const char name)
256			{
257	✗✓	3096	if (name == NULL) {
258			ENGINEerror(ERR_R_PASSED_NULL_PARAMETER);
259			return 0;
260			}
261		1548	e->name = name;
262		1548	return 1;
263		1548	}
264
265			int
266			ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f)
267			{
268			e->destroy = destroy_f;
269			return 1;
270			}
271
272			int
273			ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f)
274			{
275			e->init = init_f;
276			return 1;
277			}
278
279			int
280			ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f)
281			{
282			e->finish = finish_f;
283			return 1;
284			}
285
286			int
287			ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f)
288			{
289			e->ctrl = ctrl_f;
290			return 1;
291			}
292
293			int
294			ENGINE_set_flags(ENGINE *e, int flags)
295			{
296			e->flags = flags;
297			return 1;
298			}
299
300			int
301			ENGINE_set_cmd_defns(ENGINE e, const ENGINE_CMD_DEFN defns)
302			{
303			e->cmd_defns = defns;
304			return 1;
305			}
306
307			const char *
308			ENGINE_get_id(const ENGINE *e)
309			{
310		3114	return e->id;
311			}
312
313			const char *
314			ENGINE_get_name(const ENGINE *e)
315			{
316		3114	return e->name;
317			}
318
319			ENGINE_GEN_INT_FUNC_PTR
320			ENGINE_get_destroy_function(const ENGINE *e)
321			{
322			return e->destroy;
323			}
324
325			ENGINE_GEN_INT_FUNC_PTR
326			ENGINE_get_init_function(const ENGINE *e)
327			{
328			return e->init;
329			}
330
331			ENGINE_GEN_INT_FUNC_PTR
332			ENGINE_get_finish_function(const ENGINE *e)
333			{
334			return e->finish;
335			}
336
337			ENGINE_CTRL_FUNC_PTR
338			ENGINE_get_ctrl_function(const ENGINE *e)
339			{
340			return e->ctrl;
341			}
342
343			int
344			ENGINE_get_flags(const ENGINE *e)
345			{
346			return e->flags;
347			}
348
349			const ENGINE_CMD_DEFN *
350			ENGINE_get_cmd_defns(const ENGINE *e)
351			{
352			return e->cmd_defns;
353			}
354
355			/* eng_lib.o is pretty much linked into anything that touches ENGINE already, so
356			* put the "static_state" hack here. */
357
358			static int internal_static_hack = 0;
359
360			void *
361			ENGINE_get_static_state(void)
362			{
363			return &internal_static_hack;
364			}