crypto/err/err.h

   1 /* crypto/err/err.h */
   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 #ifndef HEADER_ERR_H
  60 #define HEADER_ERR_H
  61
  62 #ifndef NO_FP_API
  63 #include <stdio.h>
  64 #include <stdlib.h>
  65 #endif
  66
  67 #ifndef NO_BIO
  68 #include <openssl/bio.h>
  69 #endif
  70 #ifndef NO_LHASH
  71 #include <openssl/lhash.h>
  72 #endif
  73
  74 #ifdef  __cplusplus
  75 extern "C" {
  76 #endif
  77
  78 /* The following is a bit of a trick to help the object files only contain
  79  * the 'name of the file' string once.  Since 'err.h' is protected by the
  80  * HEADER_ERR_H stuff, this should be included only once per file. */
  81
  82 #define ERR_file_name   __FILE__
  83
  84 #ifndef NO_ERR
  85 #define ERR_PUT_error(a,b,c,d,e)        ERR_put_error(a,b,c,d,e)
  86 #else
  87 #define ERR_PUT_error(a,b,c,d,e)        ERR_put_error(a,b,c,NULL,0)
  88 #endif
  89
  90 #include <errno.h>
  91
  92 #define ERR_TXT_MALLOCED        0x01
  93 #define ERR_TXT_STRING          0x02
  94
  95 #define ERR_NUM_ERRORS  16
  96 typedef struct err_state_st
  97         {
  98         unsigned long pid;
  99         unsigned long err_buffer[ERR_NUM_ERRORS];
 100         char *err_data[ERR_NUM_ERRORS];
 101         int err_data_flags[ERR_NUM_ERRORS];
 102         const char *err_file[ERR_NUM_ERRORS];
 103         int err_line[ERR_NUM_ERRORS];
 104         int top,bottom;
 105         } ERR_STATE;
 106
 107 /* library */
 108 #define ERR_LIB_NONE            1
 109 #define ERR_LIB_SYS             2
 110 #define ERR_LIB_BN              3
 111 #define ERR_LIB_RSA             4
 112 #define ERR_LIB_DH              5
 113 #define ERR_LIB_EVP             6
 114 #define ERR_LIB_BUF             7
 115 #define ERR_LIB_OBJ             8
 116 #define ERR_LIB_PEM             9
 117 #define ERR_LIB_DSA             10
 118 #define ERR_LIB_X509            11
 119 #define ERR_LIB_METH            12
 120 #define ERR_LIB_ASN1            13
 121 #define ERR_LIB_CONF            14
 122 #define ERR_LIB_CRYPTO          15
 123 #define ERR_LIB_SSL             20
 124 #define ERR_LIB_SSL23           21
 125 #define ERR_LIB_SSL2            22
 126 #define ERR_LIB_SSL3            23
 127 #define ERR_LIB_RSAREF          30
 128 #define ERR_LIB_PROXY           31
 129 #define ERR_LIB_BIO             32
 130 #define ERR_LIB_PKCS7           33
 131 #define ERR_LIB_X509V3          34
 132 #define ERR_LIB_PKCS12          35
 133 #define ERR_LIB_RAND            36
 134 #define ERR_LIB_DSO             37
 135 #define ERR_LIB_ENGINE          38
 136
 137 #define ERR_LIB_USER            128
 138
 139 #define SYSerr(f,r)  ERR_PUT_error(ERR_LIB_SYS,(f),(r),ERR_file_name,__LINE__)
 140 #define BNerr(f,r)   ERR_PUT_error(ERR_LIB_BN,(f),(r),ERR_file_name,__LINE__)
 141 #define RSAerr(f,r)  ERR_PUT_error(ERR_LIB_RSA,(f),(r),ERR_file_name,__LINE__)
 142 #define DHerr(f,r)   ERR_PUT_error(ERR_LIB_DH,(f),(r),ERR_file_name,__LINE__)
 143 #define EVPerr(f,r)  ERR_PUT_error(ERR_LIB_EVP,(f),(r),ERR_file_name,__LINE__)
 144 #define BUFerr(f,r)  ERR_PUT_error(ERR_LIB_BUF,(f),(r),ERR_file_name,__LINE__)
 145 #define BIOerr(f,r)  ERR_PUT_error(ERR_LIB_BIO,(f),(r),ERR_file_name,__LINE__)
 146 #define OBJerr(f,r)  ERR_PUT_error(ERR_LIB_OBJ,(f),(r),ERR_file_name,__LINE__)
 147 #define PEMerr(f,r)  ERR_PUT_error(ERR_LIB_PEM,(f),(r),ERR_file_name,__LINE__)
 148 #define DSAerr(f,r)  ERR_PUT_error(ERR_LIB_DSA,(f),(r),ERR_file_name,__LINE__)
 149 #define X509err(f,r) ERR_PUT_error(ERR_LIB_X509,(f),(r),ERR_file_name,__LINE__)
 150 #define METHerr(f,r) ERR_PUT_error(ERR_LIB_METH,(f),(r),ERR_file_name,__LINE__)
 151 #define ASN1err(f,r) ERR_PUT_error(ERR_LIB_ASN1,(f),(r),ERR_file_name,__LINE__)
 152 #define CONFerr(f,r) ERR_PUT_error(ERR_LIB_CONF,(f),(r),ERR_file_name,__LINE__)
 153 #define CRYPTOerr(f,r) ERR_PUT_error(ERR_LIB_CRYPTO,(f),(r),ERR_file_name,__LINE__)
 154 #define SSLerr(f,r)  ERR_PUT_error(ERR_LIB_SSL,(f),(r),ERR_file_name,__LINE__)
 155 #define SSL23err(f,r) ERR_PUT_error(ERR_LIB_SSL23,(f),(r),ERR_file_name,__LINE__)
 156 #define SSL2err(f,r) ERR_PUT_error(ERR_LIB_SSL2,(f),(r),ERR_file_name,__LINE__)
 157 #define SSL3err(f,r) ERR_PUT_error(ERR_LIB_SSL3,(f),(r),ERR_file_name,__LINE__)
 158 #define RSAREFerr(f,r) ERR_PUT_error(ERR_LIB_RSAREF,(f),(r),ERR_file_name,__LINE__)
 159 #define PROXYerr(f,r) ERR_PUT_error(ERR_LIB_PROXY,(f),(r),ERR_file_name,__LINE__)
 160 #define PKCS7err(f,r) ERR_PUT_error(ERR_LIB_PKCS7,(f),(r),ERR_file_name,__LINE__)
 161 #define X509V3err(f,r) ERR_PUT_error(ERR_LIB_X509V3,(f),(r),ERR_file_name,__LINE__)
 162 #define PKCS12err(f,r) ERR_PUT_error(ERR_LIB_PKCS12,(f),(r),ERR_file_name,__LINE__)
 163 #define RANDerr(f,r) ERR_PUT_error(ERR_LIB_RAND,(f),(r),ERR_file_name,__LINE__)
 164 #define DSOerr(f,r) ERR_PUT_error(ERR_LIB_DSO,(f),(r),ERR_file_name,__LINE__)
 165 #define ENGINEerr(f,r) ERR_PUT_error(ERR_LIB_ENGINE,(f),(r),ERR_file_name,__LINE__)
 166
 167 /* Borland C seems too stupid to be able to shift and do longs in
 168  * the pre-processor :-( */
 169 #define ERR_PACK(l,f,r)         (((((unsigned long)l)&0xffL)*0x1000000)| \
 170                                 ((((unsigned long)f)&0xfffL)*0x1000)| \
 171                                 ((((unsigned long)r)&0xfffL)))
 172 #define ERR_GET_LIB(l)          (int)((((unsigned long)l)>>24L)&0xffL)
 173 #define ERR_GET_FUNC(l)         (int)((((unsigned long)l)>>12L)&0xfffL)
 174 #define ERR_GET_REASON(l)       (int)((l)&0xfffL)
 175 #define ERR_FATAL_ERROR(l)      (int)((l)&ERR_R_FATAL)
 176
 177 /* OS functions */
 178 #define SYS_F_FOPEN             1
 179 #define SYS_F_CONNECT           2
 180 #define SYS_F_GETSERVBYNAME     3
 181 #define SYS_F_SOCKET            4
 182 #define SYS_F_IOCTLSOCKET       5
 183 #define SYS_F_BIND              6
 184 #define SYS_F_LISTEN            7
 185 #define SYS_F_ACCEPT            8
 186 #define SYS_F_WSASTARTUP        9 /* Winsock stuff */
 187 #define SYS_F_OPENDIR           10
 188
 189 #define ERR_R_FATAL             32
 190 /* reasons */
 191 #define ERR_R_SYS_LIB   ERR_LIB_SYS
 192 #define ERR_R_BN_LIB    ERR_LIB_BN
 193 #define ERR_R_RSA_LIB   ERR_LIB_RSA
 194 #define ERR_R_DSA_LIB   ERR_LIB_DSA
 195 #define ERR_R_DH_LIB    ERR_LIB_DH
 196 #define ERR_R_EVP_LIB   ERR_LIB_EVP
 197 #define ERR_R_BUF_LIB   ERR_LIB_BUF
 198 #define ERR_R_BIO_LIB   ERR_LIB_BIO
 199 #define ERR_R_OBJ_LIB   ERR_LIB_OBJ
 200 #define ERR_R_PEM_LIB   ERR_LIB_PEM
 201 #define ERR_R_X509_LIB  ERR_LIB_X509
 202 #define ERR_R_METH_LIB  ERR_LIB_METH
 203 #define ERR_R_ASN1_LIB  ERR_LIB_ASN1
 204 #define ERR_R_CONF_LIB  ERR_LIB_CONF
 205 #define ERR_R_CRYPTO_LIB ERR_LIB_CRYPTO
 206 #define ERR_R_SSL_LIB   ERR_LIB_SSL
 207 #define ERR_R_SSL23_LIB ERR_LIB_SSL23
 208 #define ERR_R_SSL2_LIB  ERR_LIB_SSL2
 209 #define ERR_R_SSL3_LIB  ERR_LIB_SSL3
 210 #define ERR_R_PROXY_LIB ERR_LIB_PROXY
 211 #define ERR_R_BIO_LIB   ERR_LIB_BIO
 212 #define ERR_R_PKCS7_LIB ERR_LIB_PKCS7
 213 #define ERR_R_PKCS12_LIB ERR_LIB_PKCS12
 214 #define ERR_R_DSO_LIB   ERR_LIB_DSO
 215 #define ERR_R_ENGINE_LIB ERR_LIB_ENGINE
 216
 217 /* fatal error */
 218 #define ERR_R_MALLOC_FAILURE                    (1|ERR_R_FATAL)
 219 #define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED       (2|ERR_R_FATAL)
 220 #define ERR_R_PASSED_NULL_PARAMETER             (3|ERR_R_FATAL)
 221 #define ERR_R_NESTED_ASN1_ERROR                 (4)
 222 #define ERR_R_BAD_ASN1_OBJECT_HEADER            (5)
 223 #define ERR_R_BAD_GET_ASN1_OBJECT_CALL          (6)
 224 #define ERR_R_EXPECTING_AN_ASN1_SEQUENCE        (7)
 225 #define ERR_R_ASN1_LENGTH_MISMATCH              (8)
 226 #define ERR_R_MISSING_ASN1_EOS                  (9)
 227
 228 typedef struct ERR_string_data_st
 229         {
 230         unsigned long error;
 231         const char *string;
 232         } ERR_STRING_DATA;
 233
 234 void ERR_put_error(int lib, int func,int reason,const char *file,int line);
 235 void ERR_set_error_data(char *data,int flags);
 236
 237 unsigned long ERR_get_error(void );
 238 unsigned long ERR_get_error_line(const char **file,int *line);
 239 unsigned long ERR_get_error_line_data(const char **file,int *line,
 240                                       const char **data, int *flags);
 241 unsigned long ERR_peek_error(void );
 242 unsigned long ERR_peek_error_line(const char **file,int *line);
 243 unsigned long ERR_peek_error_line_data(const char **file,int *line,
 244                                        const char **data,int *flags);
 245 void ERR_clear_error(void );
 246 char *ERR_error_string(unsigned long e,char *buf);
 247 void ERR_error_string_n(unsigned long e, char *buf, size_t len);
 248 const char *ERR_lib_error_string(unsigned long e);
 249 const char *ERR_func_error_string(unsigned long e);
 250 const char *ERR_reason_error_string(unsigned long e);
 251 #ifndef NO_FP_API
 252 void ERR_print_errors_fp(FILE *fp);
 253 #endif
 254 #ifndef NO_BIO
 255 void ERR_print_errors(BIO *bp);
 256 void ERR_add_error_data(int num, ...);
 257 #endif
 258 void ERR_load_strings(int lib,ERR_STRING_DATA str[]);
 259 void ERR_load_ERR_strings(void);
 260 void ERR_load_crypto_strings(void);
 261 void ERR_free_strings(void);
 262
 263 void ERR_remove_state(unsigned long pid); /* if zero we look it up */
 264 ERR_STATE *ERR_get_state(void);
 265
 266 #ifndef NO_LHASH
 267 LHASH *ERR_get_string_table(void);
 268 LHASH *ERR_get_err_state_table(void); /* even less thread-safe than
 269                                        * ERR_get_string_table :-) */
 270 #endif
 271
 272 int ERR_get_next_error_library(void);
 273
 274 #ifdef  __cplusplus
 275 }
 276 #endif
 277
 278 #endif