err_prn.c revision 296465 
1/* crypto/err/err_prn.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#include <stdio.h>
60#include "cryptlib.h"
61#include <openssl/lhash.h>
62#include <openssl/crypto.h>
63#include <openssl/buffer.h>
64#include <openssl/err.h>
65
66void ERR_print_errors_cb(int (*cb) (const char *str, size_t len, void *u),
67                         void *u)
68{
69    unsigned long l;
70    char buf[256];
71    char buf2[4096];
72    const char *file, *data;
73    int line, flags;
74    unsigned long es;
75
76    es = CRYPTO_thread_id();
77    while ((l = ERR_get_error_line_data(&file, &line, &data, &flags)) != 0) {
78        ERR_error_string_n(l, buf, sizeof buf);
79        BIO_snprintf(buf2, sizeof(buf2), "%lu:%s:%s:%d:%s\n", es, buf,
80                     file, line, (flags & ERR_TXT_STRING) ? data : "");
81        if (cb(buf2, strlen(buf2), u) <= 0)
82            break;              /* abort outputting the error report */
83    }
84}
85
86#ifndef OPENSSL_NO_FP_API
87static int print_fp(const char *str, size_t len, void *fp)
88{
89    BIO bio;
90
91    BIO_set(&bio, BIO_s_file());
92    BIO_set_fp(&bio, fp, BIO_NOCLOSE);
93
94    return BIO_printf(&bio, "%s", str);
95}
96
97void ERR_print_errors_fp(FILE *fp)
98{
99    ERR_print_errors_cb(print_fp, fp);
100}
101#endif
102
103void ERR_error_string_n(unsigned long e, char *buf, size_t len)
104{
105    char lsbuf[64], fsbuf[64], rsbuf[64];
106    const char *ls, *fs, *rs;
107    unsigned long l, f, r;
108
109    l = ERR_GET_LIB(e);
110    f = ERR_GET_FUNC(e);
111    r = ERR_GET_REASON(e);
112
113    ls = ERR_lib_error_string(e);
114    fs = ERR_func_error_string(e);
115    rs = ERR_reason_error_string(e);
116
117    if (ls == NULL)
118        BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
119    if (fs == NULL)
120        BIO_snprintf(fsbuf, sizeof(fsbuf), "func(%lu)", f);
121    if (rs == NULL)
122        BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
123
124    BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls ? ls : lsbuf,
125                 fs ? fs : fsbuf, rs ? rs : rsbuf);
126    if (strlen(buf) == len - 1) {
127        /*
128         * output may be truncated; make sure we always have 5
129         * colon-separated fields, i.e. 4 colons ...
130         */
131#define NUM_COLONS 4
132        if (len > NUM_COLONS) { /* ... if possible */
133            int i;
134            char *s = buf;
135
136            for (i = 0; i < NUM_COLONS; i++) {
137                char *colon = strchr(s, ':');
138                if (colon == NULL || colon > &buf[len - 1] - NUM_COLONS + i) {
139                    /*
140                     * set colon no. i at last possible position (buf[len-1]
141                     * is the terminating 0)
142                     */
143                    colon = &buf[len - 1] - NUM_COLONS + i;
144                    *colon = ':';
145                }
146                s = colon + 1;
147            }
148        }
149    }
150}
151
152/* BAD for multi-threading: uses a local buffer if ret == NULL */
153/*
154 * ERR_error_string_n should be used instead for ret != NULL as
155 * ERR_error_string cannot know how large the buffer is
156 */
157char *ERR_error_string(unsigned long e, char *ret)
158{
159    static char buf[256];
160
161    if (ret == NULL)
162        ret = buf;
163    ERR_error_string_n(e, ret, 256);
164
165    return ret;
166}
167