include/openssl/err.h

   1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   2  * All rights reserved.
   3  *
   4  * This package is an SSL implementation written
   5  * by Eric Young (eay@cryptsoft.com).
   6  * The implementation was written so as to conform with Netscapes SSL.
   7  *
   8  * This library is free for commercial and non-commercial use as long as
   9  * the following conditions are aheared to.  The following conditions
  10  * apply to all code found in this distribution, be it the RC4, RSA,
  11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  12  * included with this distribution is covered by the same copyright terms
  13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  14  *
  15  * Copyright remains Eric Young's, and as such any Copyright notices in
  16  * the code are not to be removed.
  17  * If this package is used in a product, Eric Young should be given attribution
  18  * as the author of the parts of the library used.
  19  * This can be in the form of a textual message at program startup or
  20  * in documentation (online or textual) provided with the package.
  21  *
  22  * Redistribution and use in source and binary forms, with or without
  23  * modification, are permitted provided that the following conditions
  24  * are met:
  25  * 1. Redistributions of source code must retain the copyright
  26  *    notice, this list of conditions and the following disclaimer.
  27  * 2. Redistributions in binary form must reproduce the above copyright
  28  *    notice, this list of conditions and the following disclaimer in the
  29  *    documentation and/or other materials provided with the distribution.
  30  * 3. All advertising materials mentioning features or use of this software
  31  *    must display the following acknowledgement:
  32  *    "This product includes cryptographic software written by
  33  *     Eric Young (eay@cryptsoft.com)"
  34  *    The word 'cryptographic' can be left out if the rouines from the library
  35  *    being used are not cryptographic related :-).
  36  * 4. If you include any Windows specific code (or a derivative thereof) from
  37  *    the apps directory (application code) you must include an acknowledgement:
  38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  50  * SUCH DAMAGE.
  51  *
  52  * The licence and distribution terms for any publically available version or
  53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  54  * copied and put under another distribution licence
  55  * [including the GNU Public Licence.]
  56  */
  57 /* ====================================================================
  58  * Copyright (c) 1998-2006 The OpenSSL Project.  All rights reserved.
  59  *
  60  * Redistribution and use in source and binary forms, with or without
  61  * modification, are permitted provided that the following conditions
  62  * are met:
  63  *
  64  * 1. Redistributions of source code must retain the above copyright
  65  *    notice, this list of conditions and the following disclaimer.
  66  *
  67  * 2. Redistributions in binary form must reproduce the above copyright
  68  *    notice, this list of conditions and the following disclaimer in
  69  *    the documentation and/or other materials provided with the
  70  *    distribution.
  71  *
  72  * 3. All advertising materials mentioning features or use of this
  73  *    software must display the following acknowledgment:
  74  *    "This product includes software developed by the OpenSSL Project
  75  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  76  *
  77  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  78  *    endorse or promote products derived from this software without
  79  *    prior written permission. For written permission, please contact
  80  *    openssl-core@openssl.org.
  81  *
  82  * 5. Products derived from this software may not be called "OpenSSL"
  83  *    nor may "OpenSSL" appear in their names without prior written
  84  *    permission of the OpenSSL Project.
  85  *
  86  * 6. Redistributions of any form whatsoever must retain the following
  87  *    acknowledgment:
  88  *    "This product includes software developed by the OpenSSL Project
  89  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  90  *
  91  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  92  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  93  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  94  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  95  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  96  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  97  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  98  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  99  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 100  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 101  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 102  * OF THE POSSIBILITY OF SUCH DAMAGE.
 103  * ====================================================================
 104  *
 105  * This product includes cryptographic software written by Eric Young
 106  * (eay@cryptsoft.com).  This product includes software written by Tim
 107  * Hudson (tjh@cryptsoft.com).
 108  *
 109  */
 110
 111 #ifndef HEADER_ERR_H
 112 # define HEADER_ERR_H
 113
 114 # include <openssl/e_os2.h>
 115
 116 # ifndef OPENSSL_NO_STDIO
 117 #  include <stdio.h>
 118 #  include <stdlib.h>
 119 # endif
 120
 121 # include <openssl/ossl_typ.h>
 122 # include <openssl/bio.h>
 123 # include <openssl/lhash.h>
 124
 125 #ifdef  __cplusplus
 126 extern "C" {
 127 #endif
 128
 129 # ifndef OPENSSL_NO_ERR
 130 #  define ERR_PUT_error(a,b,c,d,e)        ERR_put_error(a,b,c,d,e)
 131 # else
 132 #  define ERR_PUT_error(a,b,c,d,e)        ERR_put_error(a,b,c,NULL,0)
 133 # endif
 134
 135 # include <errno.h>
 136
 137 # define ERR_TXT_MALLOCED        0x01
 138 # define ERR_TXT_STRING          0x02
 139
 140 # define ERR_FLAG_MARK           0x01
 141
 142 # define ERR_NUM_ERRORS  16
 143 typedef struct err_state_st {
 144     CRYPTO_THREADID tid;
 145     int err_flags[ERR_NUM_ERRORS];
 146     unsigned long err_buffer[ERR_NUM_ERRORS];
 147     char *err_data[ERR_NUM_ERRORS];
 148     int err_data_flags[ERR_NUM_ERRORS];
 149     const char *err_file[ERR_NUM_ERRORS];
 150     int err_line[ERR_NUM_ERRORS];
 151     int top, bottom;
 152 } ERR_STATE;
 153
 154 /* library */
 155 # define ERR_LIB_NONE            1
 156 # define ERR_LIB_SYS             2
 157 # define ERR_LIB_BN              3
 158 # define ERR_LIB_RSA             4
 159 # define ERR_LIB_DH              5
 160 # define ERR_LIB_EVP             6
 161 # define ERR_LIB_BUF             7
 162 # define ERR_LIB_OBJ             8
 163 # define ERR_LIB_PEM             9
 164 # define ERR_LIB_DSA             10
 165 # define ERR_LIB_X509            11
 166 /* #define ERR_LIB_METH         12 */
 167 # define ERR_LIB_ASN1            13
 168 # define ERR_LIB_CONF            14
 169 # define ERR_LIB_CRYPTO          15
 170 # define ERR_LIB_EC              16
 171 # define ERR_LIB_SSL             20
 172 /* #define ERR_LIB_SSL23        21 */
 173 /* #define ERR_LIB_SSL2         22 */
 174 /* #define ERR_LIB_SSL3         23 */
 175 /* #define ERR_LIB_RSAREF       30 */
 176 /* #define ERR_LIB_PROXY        31 */
 177 # define ERR_LIB_BIO             32
 178 # define ERR_LIB_PKCS7           33
 179 # define ERR_LIB_X509V3          34
 180 # define ERR_LIB_PKCS12          35
 181 # define ERR_LIB_RAND            36
 182 # define ERR_LIB_DSO             37
 183 # define ERR_LIB_ENGINE          38
 184 # define ERR_LIB_OCSP            39
 185 # define ERR_LIB_UI              40
 186 # define ERR_LIB_COMP            41
 187 # define ERR_LIB_ECDSA           42
 188 # define ERR_LIB_ECDH            43
 189 # define ERR_LIB_STORE           44
 190 # define ERR_LIB_FIPS            45
 191 # define ERR_LIB_CMS             46
 192 # define ERR_LIB_TS              47
 193 # define ERR_LIB_HMAC            48
 194 # define ERR_LIB_JPAKE           49
 195 # define ERR_LIB_CT              50
 196 # define ERR_LIB_ASYNC           51
 197
 198 # define ERR_LIB_USER            128
 199
 200 # define SYSerr(f,r)  ERR_PUT_error(ERR_LIB_SYS,(f),(r),__FILE__,__LINE__)
 201 # define BNerr(f,r)   ERR_PUT_error(ERR_LIB_BN,(f),(r),__FILE__,__LINE__)
 202 # define RSAerr(f,r)  ERR_PUT_error(ERR_LIB_RSA,(f),(r),__FILE__,__LINE__)
 203 # define DHerr(f,r)   ERR_PUT_error(ERR_LIB_DH,(f),(r),__FILE__,__LINE__)
 204 # define EVPerr(f,r)  ERR_PUT_error(ERR_LIB_EVP,(f),(r),__FILE__,__LINE__)
 205 # define BUFerr(f,r)  ERR_PUT_error(ERR_LIB_BUF,(f),(r),__FILE__,__LINE__)
 206 # define OBJerr(f,r)  ERR_PUT_error(ERR_LIB_OBJ,(f),(r),__FILE__,__LINE__)
 207 # define PEMerr(f,r)  ERR_PUT_error(ERR_LIB_PEM,(f),(r),__FILE__,__LINE__)
 208 # define DSAerr(f,r)  ERR_PUT_error(ERR_LIB_DSA,(f),(r),__FILE__,__LINE__)
 209 # define X509err(f,r) ERR_PUT_error(ERR_LIB_X509,(f),(r),__FILE__,__LINE__)
 210 # define ASN1err(f,r) ERR_PUT_error(ERR_LIB_ASN1,(f),(r),__FILE__,__LINE__)
 211 # define CONFerr(f,r) ERR_PUT_error(ERR_LIB_CONF,(f),(r),__FILE__,__LINE__)
 212 # define CRYPTOerr(f,r) ERR_PUT_error(ERR_LIB_CRYPTO,(f),(r),__FILE__,__LINE__)
 213 # define ECerr(f,r)   ERR_PUT_error(ERR_LIB_EC,(f),(r),__FILE__,__LINE__)
 214 # define SSLerr(f,r)  ERR_PUT_error(ERR_LIB_SSL,(f),(r),__FILE__,__LINE__)
 215 # define BIOerr(f,r)  ERR_PUT_error(ERR_LIB_BIO,(f),(r),__FILE__,__LINE__)
 216 # define PKCS7err(f,r) ERR_PUT_error(ERR_LIB_PKCS7,(f),(r),__FILE__,__LINE__)
 217 # define X509V3err(f,r) ERR_PUT_error(ERR_LIB_X509V3,(f),(r),__FILE__,__LINE__)
 218 # define PKCS12err(f,r) ERR_PUT_error(ERR_LIB_PKCS12,(f),(r),__FILE__,__LINE__)
 219 # define RANDerr(f,r) ERR_PUT_error(ERR_LIB_RAND,(f),(r),__FILE__,__LINE__)
 220 # define DSOerr(f,r) ERR_PUT_error(ERR_LIB_DSO,(f),(r),__FILE__,__LINE__)
 221 # define ENGINEerr(f,r) ERR_PUT_error(ERR_LIB_ENGINE,(f),(r),__FILE__,__LINE__)
 222 # define OCSPerr(f,r) ERR_PUT_error(ERR_LIB_OCSP,(f),(r),__FILE__,__LINE__)
 223 # define UIerr(f,r) ERR_PUT_error(ERR_LIB_UI,(f),(r),__FILE__,__LINE__)
 224 # define COMPerr(f,r) ERR_PUT_error(ERR_LIB_COMP,(f),(r),__FILE__,__LINE__)
 225 # define ECDSAerr(f,r)  ERR_PUT_error(ERR_LIB_ECDSA,(f),(r),__FILE__,__LINE__)
 226 # define ECDHerr(f,r)  ERR_PUT_error(ERR_LIB_ECDH,(f),(r),__FILE__,__LINE__)
 227 # define STOREerr(f,r) ERR_PUT_error(ERR_LIB_STORE,(f),(r),__FILE__,__LINE__)
 228 # define FIPSerr(f,r) ERR_PUT_error(ERR_LIB_FIPS,(f),(r),__FILE__,__LINE__)
 229 # define CMSerr(f,r) ERR_PUT_error(ERR_LIB_CMS,(f),(r),__FILE__,__LINE__)
 230 # define TSerr(f,r) ERR_PUT_error(ERR_LIB_TS,(f),(r),__FILE__,__LINE__)
 231 # define HMACerr(f,r) ERR_PUT_error(ERR_LIB_HMAC,(f),(r),__FILE__,__LINE__)
 232 # define JPAKEerr(f,r) ERR_PUT_error(ERR_LIB_JPAKE,(f),(r),__FILE__,__LINE__)
 233 # define CTerr(f,r) ERR_PUT_error(ERR_LIB_CT,(f),(r),__FILE__,__LINE__)
 234 # define ASYNCerr(f,r) ERR_PUT_error(ERR_LIB_ASYNC,(f),(r),__FILE__,__LINE__)
 235
 236 /*
 237  * Borland C seems too stupid to be able to shift and do longs in the
 238  * pre-processor :-(
 239  */
 240 # define ERR_PACK(l,f,r)         (((((unsigned long)l)&0xffL)*0x1000000)| \
 241                                 ((((unsigned long)f)&0xfffL)*0x1000)| \
 242                                 ((((unsigned long)r)&0xfffL)))
 243 # define ERR_GET_LIB(l)          (int)((((unsigned long)l)>>24L)&0xffL)
 244 # define ERR_GET_FUNC(l)         (int)((((unsigned long)l)>>12L)&0xfffL)
 245 # define ERR_GET_REASON(l)       (int)((l)&0xfffL)
 246 # define ERR_FATAL_ERROR(l)      (int)((l)&ERR_R_FATAL)
 247
 248 /* OS functions */
 249 # define SYS_F_FOPEN             1
 250 # define SYS_F_CONNECT           2
 251 # define SYS_F_GETSERVBYNAME     3
 252 # define SYS_F_SOCKET            4
 253 # define SYS_F_IOCTLSOCKET       5
 254 # define SYS_F_BIND              6
 255 # define SYS_F_LISTEN            7
 256 # define SYS_F_ACCEPT            8
 257 # define SYS_F_WSASTARTUP        9/* Winsock stuff */
 258 # define SYS_F_OPENDIR           10
 259 # define SYS_F_FREAD             11
 260 # define SYS_F_GETADDRINFO       12
 261 # define SYS_F_GETNAMEINFO       13
 262 # define SYS_F_SETSOCKOPT        14
 263 # define SYS_F_GETSOCKOPT        15
 264 # define SYS_F_GETSOCKNAME       16
 265 # define SYS_F_GETHOSTBYNAME     17
 266
 267 /* reasons */
 268 # define ERR_R_SYS_LIB   ERR_LIB_SYS/* 2 */
 269 # define ERR_R_BN_LIB    ERR_LIB_BN/* 3 */
 270 # define ERR_R_RSA_LIB   ERR_LIB_RSA/* 4 */
 271 # define ERR_R_DH_LIB    ERR_LIB_DH/* 5 */
 272 # define ERR_R_EVP_LIB   ERR_LIB_EVP/* 6 */
 273 # define ERR_R_BUF_LIB   ERR_LIB_BUF/* 7 */
 274 # define ERR_R_OBJ_LIB   ERR_LIB_OBJ/* 8 */
 275 # define ERR_R_PEM_LIB   ERR_LIB_PEM/* 9 */
 276 # define ERR_R_DSA_LIB   ERR_LIB_DSA/* 10 */
 277 # define ERR_R_X509_LIB  ERR_LIB_X509/* 11 */
 278 # define ERR_R_ASN1_LIB  ERR_LIB_ASN1/* 13 */
 279 # define ERR_R_CONF_LIB  ERR_LIB_CONF/* 14 */
 280 # define ERR_R_CRYPTO_LIB ERR_LIB_CRYPTO/* 15 */
 281 # define ERR_R_EC_LIB    ERR_LIB_EC/* 16 */
 282 # define ERR_R_SSL_LIB   ERR_LIB_SSL/* 20 */
 283 # define ERR_R_BIO_LIB   ERR_LIB_BIO/* 32 */
 284 # define ERR_R_PKCS7_LIB ERR_LIB_PKCS7/* 33 */
 285 # define ERR_R_X509V3_LIB ERR_LIB_X509V3/* 34 */
 286 # define ERR_R_PKCS12_LIB ERR_LIB_PKCS12/* 35 */
 287 # define ERR_R_RAND_LIB  ERR_LIB_RAND/* 36 */
 288 # define ERR_R_DSO_LIB   ERR_LIB_DSO/* 37 */
 289 # define ERR_R_ENGINE_LIB ERR_LIB_ENGINE/* 38 */
 290 # define ERR_R_OCSP_LIB  ERR_LIB_OCSP/* 39 */
 291 # define ERR_R_UI_LIB    ERR_LIB_UI/* 40 */
 292 # define ERR_R_COMP_LIB  ERR_LIB_COMP/* 41 */
 293 # define ERR_R_ECDSA_LIB ERR_LIB_ECDSA/* 42 */
 294 # define ERR_R_ECDH_LIB  ERR_LIB_ECDH/* 43 */
 295 # define ERR_R_STORE_LIB ERR_LIB_STORE/* 44 */
 296 # define ERR_R_TS_LIB    ERR_LIB_TS/* 45 */
 297
 298 # define ERR_R_NESTED_ASN1_ERROR                 58
 299 # define ERR_R_BAD_ASN1_OBJECT_HEADER            59
 300 # define ERR_R_BAD_GET_ASN1_OBJECT_CALL          60
 301 # define ERR_R_EXPECTING_AN_ASN1_SEQUENCE        61
 302 # define ERR_R_ASN1_LENGTH_MISMATCH              62
 303 # define ERR_R_MISSING_ASN1_EOS                  63
 304
 305 /* fatal error */
 306 # define ERR_R_FATAL                             64
 307 # define ERR_R_MALLOC_FAILURE                    (1|ERR_R_FATAL)
 308 # define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED       (2|ERR_R_FATAL)
 309 # define ERR_R_PASSED_NULL_PARAMETER             (3|ERR_R_FATAL)
 310 # define ERR_R_INTERNAL_ERROR                    (4|ERR_R_FATAL)
 311 # define ERR_R_DISABLED                          (5|ERR_R_FATAL)
 312
 313 /*
 314  * 99 is the maximum possible ERR_R_... code, higher values are reserved for
 315  * the individual libraries
 316  */
 317
 318 typedef struct ERR_string_data_st {
 319     unsigned long error;
 320     const char *string;
 321 } ERR_STRING_DATA;
 322
 323 DEFINE_LHASH_OF(ERR_STRING_DATA);
 324
 325 void ERR_put_error(int lib, int func, int reason, const char *file, int line);
 326 void ERR_set_error_data(char *data, int flags);
 327
 328 unsigned long ERR_get_error(void);
 329 unsigned long ERR_get_error_line(const char **file, int *line);
 330 unsigned long ERR_get_error_line_data(const char **file, int *line,
 331                                       const char **data, int *flags);
 332 unsigned long ERR_peek_error(void);
 333 unsigned long ERR_peek_error_line(const char **file, int *line);
 334 unsigned long ERR_peek_error_line_data(const char **file, int *line,
 335                                        const char **data, int *flags);
 336 unsigned long ERR_peek_last_error(void);
 337 unsigned long ERR_peek_last_error_line(const char **file, int *line);
 338 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
 339                                             const char **data, int *flags);
 340 void ERR_clear_error(void);
 341 char *ERR_error_string(unsigned long e, char *buf);
 342 void ERR_error_string_n(unsigned long e, char *buf, size_t len);
 343 const char *ERR_lib_error_string(unsigned long e);
 344 const char *ERR_func_error_string(unsigned long e);
 345 const char *ERR_reason_error_string(unsigned long e);
 346 void ERR_print_errors_cb(int (*cb) (const char *str, size_t len, void *u),
 347                          void *u);
 348 # ifndef OPENSSL_NO_STDIO
 349 void ERR_print_errors_fp(FILE *fp);
 350 # endif
 351 void ERR_print_errors(BIO *bp);
 352 void ERR_add_error_data(int num, ...);
 353 void ERR_add_error_vdata(int num, va_list args);
 354 void ERR_load_strings(int lib, ERR_STRING_DATA str[]);
 355 void ERR_unload_strings(int lib, ERR_STRING_DATA str[]);
 356 void ERR_load_ERR_strings(void);
 357
 358 #if OPENSSL_API_COMPAT < 0x10100000L
 359 # define ERR_load_crypto_strings() \
 360     OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL)
 361 #endif
 362
 363 void ERR_free_strings(void);
 364
 365 void ERR_remove_thread_state(const CRYPTO_THREADID *tid);
 366 DEPRECATEDIN_1_0_0(void ERR_remove_state(unsigned long pid)) /* if zero we
 367                                                               * look it up */
 368 ERR_STATE *ERR_get_state(void);
 369
 370 LHASH_OF(ERR_STRING_DATA) *ERR_get_string_table(void);
 371 LHASH_OF(ERR_STATE) *ERR_get_err_state_table(void);
 372 void ERR_release_err_state_table(LHASH_OF(ERR_STATE) **hash);
 373
 374 int ERR_get_next_error_library(void);
 375
 376 int ERR_set_mark(void);
 377 int ERR_pop_to_mark(void);
 378
 379 #ifdef  __cplusplus
 380 }
 381 #endif
 382
 383 #endif