xref: /openbsd/lib/libcrypto/err/err.c (revision 17df1aa7)
1 /* crypto/err/err.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  *
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  *
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  *
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  *
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  *
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58 /* ====================================================================
59  * Copyright (c) 1998-2001 The OpenSSL Project.  All rights reserved.
60  *
61  * Redistribution and use in source and binary forms, with or without
62  * modification, are permitted provided that the following conditions
63  * are met:
64  *
65  * 1. Redistributions of source code must retain the above copyright
66  *    notice, this list of conditions and the following disclaimer.
67  *
68  * 2. Redistributions in binary form must reproduce the above copyright
69  *    notice, this list of conditions and the following disclaimer in
70  *    the documentation and/or other materials provided with the
71  *    distribution.
72  *
73  * 3. All advertising materials mentioning features or use of this
74  *    software must display the following acknowledgment:
75  *    "This product includes software developed by the OpenSSL Project
76  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
77  *
78  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79  *    endorse or promote products derived from this software without
80  *    prior written permission. For written permission, please contact
81  *    openssl-core@openssl.org.
82  *
83  * 5. Products derived from this software may not be called "OpenSSL"
84  *    nor may "OpenSSL" appear in their names without prior written
85  *    permission of the OpenSSL Project.
86  *
87  * 6. Redistributions of any form whatsoever must retain the following
88  *    acknowledgment:
89  *    "This product includes software developed by the OpenSSL Project
90  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91  *
92  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
96  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103  * OF THE POSSIBILITY OF SUCH DAMAGE.
104  * ====================================================================
105  *
106  * This product includes cryptographic software written by Eric Young
107  * (eay@cryptsoft.com).  This product includes software written by Tim
108  * Hudson (tjh@cryptsoft.com).
109  *
110  */
111 
112 #include <stdio.h>
113 #include <stdarg.h>
114 #include <string.h>
115 #include "cryptlib.h"
116 #include <openssl/lhash.h>
117 #include <openssl/crypto.h>
118 #include <openssl/buffer.h>
119 #include <openssl/bio.h>
120 #include <openssl/err.h>
121 
122 static unsigned long get_error_values(int inc,int top,
123 					const char **file,int *line,
124 					const char **data,int *flags);
125 
126 #define err_clear_data(p,i) \
127 	do { \
128 	if (((p)->err_data[i] != NULL) && \
129 		(p)->err_data_flags[i] & ERR_TXT_MALLOCED) \
130 		{  \
131 		OPENSSL_free((p)->err_data[i]); \
132 		(p)->err_data[i]=NULL; \
133 		} \
134 	(p)->err_data_flags[i]=0; \
135 	} while(0)
136 
137 #define err_clear(p,i) \
138 	do { \
139 	(p)->err_flags[i]=0; \
140 	(p)->err_buffer[i]=0; \
141 	err_clear_data(p,i); \
142 	(p)->err_file[i]=NULL; \
143 	(p)->err_line[i]= -1; \
144 	} while(0)
145 
146 void ERR_put_error(int lib, int func, int reason, const char *file,
147 	     int line)
148 	{
149 	ERR_STATE *es;
150 
151 #ifdef _OSD_POSIX
152 	/* In the BS2000-OSD POSIX subsystem, the compiler generates
153 	 * path names in the form "*POSIX(/etc/passwd)".
154 	 * This dirty hack strips them to something sensible.
155 	 * @@@ We shouldn't modify a const string, though.
156 	 */
157 	if (strncmp(file,"*POSIX(", sizeof("*POSIX(")-1) == 0) {
158 		char *end;
159 
160 		/* Skip the "*POSIX(" prefix */
161 		file += sizeof("*POSIX(")-1;
162 		end = &file[strlen(file)-1];
163 		if (*end == ')')
164 			*end = '\0';
165 		/* Optional: use the basename of the path only. */
166 		if ((end = strrchr(file, '/')) != NULL)
167 			file = &end[1];
168 	}
169 #endif
170 	es=ERR_get_state();
171 
172 	es->top=(es->top+1)%ERR_NUM_ERRORS;
173 	if (es->top == es->bottom)
174 		es->bottom=(es->bottom+1)%ERR_NUM_ERRORS;
175 	es->err_flags[es->top]=0;
176 	es->err_buffer[es->top]=ERR_PACK(lib,func,reason);
177 	es->err_file[es->top]=file;
178 	es->err_line[es->top]=line;
179 	err_clear_data(es,es->top);
180 	}
181 
182 void ERR_clear_error(void)
183 	{
184 	int i;
185 	ERR_STATE *es;
186 
187 	es=ERR_get_state();
188 
189 	for (i=0; i<ERR_NUM_ERRORS; i++)
190 		{
191 		err_clear(es,i);
192 		}
193 	es->top=es->bottom=0;
194 	}
195 
196 
197 unsigned long ERR_get_error(void)
198 	{ return(get_error_values(1,0,NULL,NULL,NULL,NULL)); }
199 
200 unsigned long ERR_get_error_line(const char **file,
201 	     int *line)
202 	{ return(get_error_values(1,0,file,line,NULL,NULL)); }
203 
204 unsigned long ERR_get_error_line_data(const char **file, int *line,
205 	     const char **data, int *flags)
206 	{ return(get_error_values(1,0,file,line,data,flags)); }
207 
208 
209 unsigned long ERR_peek_error(void)
210 	{ return(get_error_values(0,0,NULL,NULL,NULL,NULL)); }
211 
212 unsigned long ERR_peek_error_line(const char **file, int *line)
213 	{ return(get_error_values(0,0,file,line,NULL,NULL)); }
214 
215 unsigned long ERR_peek_error_line_data(const char **file, int *line,
216 	     const char **data, int *flags)
217 	{ return(get_error_values(0,0,file,line,data,flags)); }
218 
219 
220 unsigned long ERR_peek_last_error(void)
221 	{ return(get_error_values(0,1,NULL,NULL,NULL,NULL)); }
222 
223 unsigned long ERR_peek_last_error_line(const char **file, int *line)
224 	{ return(get_error_values(0,1,file,line,NULL,NULL)); }
225 
226 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
227 	     const char **data, int *flags)
228 	{ return(get_error_values(0,1,file,line,data,flags)); }
229 
230 
231 static unsigned long get_error_values(int inc, int top, const char **file, int *line,
232 	     const char **data, int *flags)
233 	{
234 	int i=0;
235 	ERR_STATE *es;
236 	unsigned long ret;
237 
238 	es=ERR_get_state();
239 
240 	if (inc && top)
241 		{
242 		if (file) *file = "";
243 		if (line) *line = 0;
244 		if (data) *data = "";
245 		if (flags) *flags = 0;
246 
247 		return ERR_R_INTERNAL_ERROR;
248 		}
249 
250 	if (es->bottom == es->top) return 0;
251 	if (top)
252 		i=es->top;			 /* last error */
253 	else
254 		i=(es->bottom+1)%ERR_NUM_ERRORS; /* first error */
255 
256 	ret=es->err_buffer[i];
257 	if (inc)
258 		{
259 		es->bottom=i;
260 		es->err_buffer[i]=0;
261 		}
262 
263 	if ((file != NULL) && (line != NULL))
264 		{
265 		if (es->err_file[i] == NULL)
266 			{
267 			*file="NA";
268 			if (line != NULL) *line=0;
269 			}
270 		else
271 			{
272 			*file=es->err_file[i];
273 			if (line != NULL) *line=es->err_line[i];
274 			}
275 		}
276 
277 	if (data == NULL)
278 		{
279 		if (inc)
280 			{
281 			err_clear_data(es, i);
282 			}
283 		}
284 	else
285 		{
286 		if (es->err_data[i] == NULL)
287 			{
288 			*data="";
289 			if (flags != NULL) *flags=0;
290 			}
291 		else
292 			{
293 			*data=es->err_data[i];
294 			if (flags != NULL) *flags=es->err_data_flags[i];
295 			}
296 		}
297 	return ret;
298 	}
299 
300 void ERR_set_error_data(char *data, int flags)
301 	{
302 	ERR_STATE *es;
303 	int i;
304 
305 	es=ERR_get_state();
306 
307 	i=es->top;
308 	if (i == 0)
309 		i=ERR_NUM_ERRORS-1;
310 
311 	err_clear_data(es,i);
312 	es->err_data[i]=data;
313 	es->err_data_flags[i]=flags;
314 	}
315 
316 void ERR_add_error_data(int num, ...)
317 	{
318 	va_list args;
319 	int i,n,s;
320 	char *str,*p,*a;
321 
322 	s=80;
323 	str=OPENSSL_malloc(s+1);
324 	if (str == NULL) return;
325 	str[0]='\0';
326 
327 	va_start(args, num);
328 	n=0;
329 	for (i=0; i<num; i++)
330 		{
331 		a=va_arg(args, char*);
332 		/* ignore NULLs, thanks to Bob Beck <beck@obtuse.com> */
333 		if (a != NULL)
334 			{
335 			n+=strlen(a);
336 			if (n > s)
337 				{
338 				s=n+20;
339 				p=OPENSSL_realloc(str,s+1);
340 				if (p == NULL)
341 					{
342 					OPENSSL_free(str);
343 					goto err;
344 					}
345 				else
346 					str=p;
347 				}
348 			BUF_strlcat(str,a,(size_t)s+1);
349 			}
350 		}
351 	ERR_set_error_data(str,ERR_TXT_MALLOCED|ERR_TXT_STRING);
352 
353 err:
354 	va_end(args);
355 	}
356 
357 int ERR_set_mark(void)
358 	{
359 	ERR_STATE *es;
360 
361 	es=ERR_get_state();
362 
363 	if (es->bottom == es->top) return 0;
364 	es->err_flags[es->top]|=ERR_FLAG_MARK;
365 	return 1;
366 	}
367 
368 int ERR_pop_to_mark(void)
369 	{
370 	ERR_STATE *es;
371 
372 	es=ERR_get_state();
373 
374 	while(es->bottom != es->top
375 		&& (es->err_flags[es->top] & ERR_FLAG_MARK) == 0)
376 		{
377 		err_clear(es,es->top);
378 		es->top-=1;
379 		if (es->top == -1) es->top=ERR_NUM_ERRORS-1;
380 		}
381 
382 	if (es->bottom == es->top) return 0;
383 	es->err_flags[es->top]&=~ERR_FLAG_MARK;
384 	return 1;
385 	}
386 
387 #ifdef OPENSSL_FIPS
388 
389 static ERR_STATE *fget_state(void)
390 	{
391 	static ERR_STATE fstate;
392 	return &fstate;
393 	}
394 
395 ERR_STATE *(*get_state_func)(void) = fget_state;
396 void (*remove_state_func)(unsigned long pid);
397 
398 ERR_STATE *ERR_get_state(void)
399 	{
400 	return get_state_func();
401 	}
402 
403 void int_ERR_set_state_func(ERR_STATE *(*get_func)(void),
404 				void (*remove_func)(unsigned long pid))
405 	{
406 	get_state_func = get_func;
407 	remove_state_func = remove_func;
408 	}
409 
410 void ERR_remove_state(unsigned long pid)
411 	{
412 	if (remove_state_func)
413 		remove_state_func(pid);
414 	}
415 
416 #endif
417