err.h revision 142425
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 OPENSSL_NO_FP_API 63#include <stdio.h> 64#include <stdlib.h> 65#endif 66 67#ifndef OPENSSL_NO_BIO 68#include <openssl/bio.h> 69#endif 70#ifndef OPENSSL_NO_LHASH 71#include <openssl/lhash.h> 72#endif 73 74#ifdef __cplusplus 75extern "C" { 76#endif 77 78#ifndef OPENSSL_NO_ERR 79#define ERR_PUT_error(a,b,c,d,e) ERR_put_error(a,b,c,d,e) 80#else 81#define ERR_PUT_error(a,b,c,d,e) ERR_put_error(a,b,c,NULL,0) 82#endif 83 84#include <errno.h> 85 86#define ERR_TXT_MALLOCED 0x01 87#define ERR_TXT_STRING 0x02 88 89#define ERR_NUM_ERRORS 16 90typedef struct err_state_st 91 { 92 unsigned long pid; 93 unsigned long err_buffer[ERR_NUM_ERRORS]; 94 char *err_data[ERR_NUM_ERRORS]; 95 int err_data_flags[ERR_NUM_ERRORS]; 96 const char *err_file[ERR_NUM_ERRORS]; 97 int err_line[ERR_NUM_ERRORS]; 98 int top,bottom; 99 } ERR_STATE; 100 101/* library */ 102#define ERR_LIB_NONE 1 103#define ERR_LIB_SYS 2 104#define ERR_LIB_BN 3 105#define ERR_LIB_RSA 4 106#define ERR_LIB_DH 5 107#define ERR_LIB_EVP 6 108#define ERR_LIB_BUF 7 109#define ERR_LIB_OBJ 8 110#define ERR_LIB_PEM 9 111#define ERR_LIB_DSA 10 112#define ERR_LIB_X509 11 113/* #define ERR_LIB_METH 12 */ 114#define ERR_LIB_ASN1 13 115#define ERR_LIB_CONF 14 116#define ERR_LIB_CRYPTO 15 117#define ERR_LIB_EC 16 118#define ERR_LIB_SSL 20 119/* #define ERR_LIB_SSL23 21 */ 120/* #define ERR_LIB_SSL2 22 */ 121/* #define ERR_LIB_SSL3 23 */ 122/* #define ERR_LIB_RSAREF 30 */ 123/* #define ERR_LIB_PROXY 31 */ 124#define ERR_LIB_BIO 32 125#define ERR_LIB_PKCS7 33 126#define ERR_LIB_X509V3 34 127#define ERR_LIB_PKCS12 35 128#define ERR_LIB_RAND 36 129#define ERR_LIB_DSO 37 130#define ERR_LIB_ENGINE 38 131#define ERR_LIB_OCSP 39 132#define ERR_LIB_UI 40 133#define ERR_LIB_COMP 41 134#define ERR_LIB_FIPS 42 135 136#define ERR_LIB_USER 128 137 138#define SYSerr(f,r) ERR_PUT_error(ERR_LIB_SYS,(f),(r),__FILE__,__LINE__) 139#define BNerr(f,r) ERR_PUT_error(ERR_LIB_BN,(f),(r),__FILE__,__LINE__) 140#define RSAerr(f,r) ERR_PUT_error(ERR_LIB_RSA,(f),(r),__FILE__,__LINE__) 141#define DHerr(f,r) ERR_PUT_error(ERR_LIB_DH,(f),(r),__FILE__,__LINE__) 142#define EVPerr(f,r) ERR_PUT_error(ERR_LIB_EVP,(f),(r),__FILE__,__LINE__) 143#define BUFerr(f,r) ERR_PUT_error(ERR_LIB_BUF,(f),(r),__FILE__,__LINE__) 144#define OBJerr(f,r) ERR_PUT_error(ERR_LIB_OBJ,(f),(r),__FILE__,__LINE__) 145#define PEMerr(f,r) ERR_PUT_error(ERR_LIB_PEM,(f),(r),__FILE__,__LINE__) 146#define DSAerr(f,r) ERR_PUT_error(ERR_LIB_DSA,(f),(r),__FILE__,__LINE__) 147#define X509err(f,r) ERR_PUT_error(ERR_LIB_X509,(f),(r),__FILE__,__LINE__) 148#define ASN1err(f,r) ERR_PUT_error(ERR_LIB_ASN1,(f),(r),__FILE__,__LINE__) 149#define CONFerr(f,r) ERR_PUT_error(ERR_LIB_CONF,(f),(r),__FILE__,__LINE__) 150#define CRYPTOerr(f,r) ERR_PUT_error(ERR_LIB_CRYPTO,(f),(r),__FILE__,__LINE__) 151#define ECerr(f,r) ERR_PUT_error(ERR_LIB_EC,(f),(r),__FILE__,__LINE__) 152#define SSLerr(f,r) ERR_PUT_error(ERR_LIB_SSL,(f),(r),__FILE__,__LINE__) 153#define BIOerr(f,r) ERR_PUT_error(ERR_LIB_BIO,(f),(r),__FILE__,__LINE__) 154#define PKCS7err(f,r) ERR_PUT_error(ERR_LIB_PKCS7,(f),(r),__FILE__,__LINE__) 155#define X509V3err(f,r) ERR_PUT_error(ERR_LIB_X509V3,(f),(r),__FILE__,__LINE__) 156#define PKCS12err(f,r) ERR_PUT_error(ERR_LIB_PKCS12,(f),(r),__FILE__,__LINE__) 157#define RANDerr(f,r) ERR_PUT_error(ERR_LIB_RAND,(f),(r),__FILE__,__LINE__) 158#define DSOerr(f,r) ERR_PUT_error(ERR_LIB_DSO,(f),(r),__FILE__,__LINE__) 159#define ENGINEerr(f,r) ERR_PUT_error(ERR_LIB_ENGINE,(f),(r),__FILE__,__LINE__) 160#define OCSPerr(f,r) ERR_PUT_error(ERR_LIB_OCSP,(f),(r),__FILE__,__LINE__) 161#define UIerr(f,r) ERR_PUT_error(ERR_LIB_UI,(f),(r),__FILE__,__LINE__) 162#define COMPerr(f,r) ERR_PUT_error(ERR_LIB_COMP,(f),(r),__FILE__,__LINE__) 163#define FIPSerr(f,r) ERR_PUT_error(ERR_LIB_FIPS,(f),(r),__FILE__,__LINE__) 164 165/* Borland C seems too stupid to be able to shift and do longs in 166 * the pre-processor :-( */ 167#define ERR_PACK(l,f,r) (((((unsigned long)l)&0xffL)*0x1000000)| \ 168 ((((unsigned long)f)&0xfffL)*0x1000)| \ 169 ((((unsigned long)r)&0xfffL))) 170#define ERR_GET_LIB(l) (int)((((unsigned long)l)>>24L)&0xffL) 171#define ERR_GET_FUNC(l) (int)((((unsigned long)l)>>12L)&0xfffL) 172#define ERR_GET_REASON(l) (int)((l)&0xfffL) 173#define ERR_FATAL_ERROR(l) (int)((l)&ERR_R_FATAL) 174 175 176/* OS functions */ 177#define SYS_F_FOPEN 1 178#define SYS_F_CONNECT 2 179#define SYS_F_GETSERVBYNAME 3 180#define SYS_F_SOCKET 4 181#define SYS_F_IOCTLSOCKET 5 182#define SYS_F_BIND 6 183#define SYS_F_LISTEN 7 184#define SYS_F_ACCEPT 8 185#define SYS_F_WSASTARTUP 9 /* Winsock stuff */ 186#define SYS_F_OPENDIR 10 187#define SYS_F_FREAD 11 188 189 190/* reasons */ 191#define ERR_R_SYS_LIB ERR_LIB_SYS /* 2 */ 192#define ERR_R_BN_LIB ERR_LIB_BN /* 3 */ 193#define ERR_R_RSA_LIB ERR_LIB_RSA /* 4 */ 194#define ERR_R_DH_LIB ERR_LIB_DH /* 5 */ 195#define ERR_R_EVP_LIB ERR_LIB_EVP /* 6 */ 196#define ERR_R_BUF_LIB ERR_LIB_BUF /* 7 */ 197#define ERR_R_OBJ_LIB ERR_LIB_OBJ /* 8 */ 198#define ERR_R_PEM_LIB ERR_LIB_PEM /* 9 */ 199#define ERR_R_DSA_LIB ERR_LIB_DSA /* 10 */ 200#define ERR_R_X509_LIB ERR_LIB_X509 /* 11 */ 201#define ERR_R_ASN1_LIB ERR_LIB_ASN1 /* 13 */ 202#define ERR_R_CONF_LIB ERR_LIB_CONF /* 14 */ 203#define ERR_R_CRYPTO_LIB ERR_LIB_CRYPTO /* 15 */ 204#define ERR_R_EC_LIB ERR_LIB_EC /* 16 */ 205#define ERR_R_SSL_LIB ERR_LIB_SSL /* 20 */ 206#define ERR_R_BIO_LIB ERR_LIB_BIO /* 32 */ 207#define ERR_R_PKCS7_LIB ERR_LIB_PKCS7 /* 33 */ 208#define ERR_R_X509V3_LIB ERR_LIB_X509V3 /* 34 */ 209#define ERR_R_PKCS12_LIB ERR_LIB_PKCS12 /* 35 */ 210#define ERR_R_RAND_LIB ERR_LIB_RAND /* 36 */ 211#define ERR_R_DSO_LIB ERR_LIB_DSO /* 37 */ 212#define ERR_R_ENGINE_LIB ERR_LIB_ENGINE /* 38 */ 213#define ERR_R_OCSP_LIB ERR_LIB_OCSP /* 39 */ 214#define ERR_R_UI_LIB ERR_LIB_UI /* 40 */ 215#define ERR_R_COMP_LIB ERR_LIB_COMP /* 41 */ 216 217#define ERR_R_NESTED_ASN1_ERROR 58 218#define ERR_R_BAD_ASN1_OBJECT_HEADER 59 219#define ERR_R_BAD_GET_ASN1_OBJECT_CALL 60 220#define ERR_R_EXPECTING_AN_ASN1_SEQUENCE 61 221#define ERR_R_ASN1_LENGTH_MISMATCH 62 222#define ERR_R_MISSING_ASN1_EOS 63 223 224/* fatal error */ 225#define ERR_R_FATAL 64 226#define ERR_R_MALLOC_FAILURE (1|ERR_R_FATAL) 227#define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED (2|ERR_R_FATAL) 228#define ERR_R_PASSED_NULL_PARAMETER (3|ERR_R_FATAL) 229#define ERR_R_INTERNAL_ERROR (4|ERR_R_FATAL) 230 231/* 99 is the maximum possible ERR_R_... code, higher values 232 * are reserved for the individual libraries */ 233 234 235typedef struct ERR_string_data_st 236 { 237 unsigned long error; 238 const char *string; 239 } ERR_STRING_DATA; 240 241void ERR_put_error(int lib, int func,int reason,const char *file,int line); 242void ERR_set_error_data(char *data,int flags); 243 244unsigned long ERR_get_error(void); 245unsigned long ERR_get_error_line(const char **file,int *line); 246unsigned long ERR_get_error_line_data(const char **file,int *line, 247 const char **data, int *flags); 248unsigned long ERR_peek_error(void); 249unsigned long ERR_peek_error_line(const char **file,int *line); 250unsigned long ERR_peek_error_line_data(const char **file,int *line, 251 const char **data,int *flags); 252unsigned long ERR_peek_last_error(void); 253unsigned long ERR_peek_last_error_line(const char **file,int *line); 254unsigned long ERR_peek_last_error_line_data(const char **file,int *line, 255 const char **data,int *flags); 256void ERR_clear_error(void ); 257char *ERR_error_string(unsigned long e,char *buf); 258void ERR_error_string_n(unsigned long e, char *buf, size_t len); 259const char *ERR_lib_error_string(unsigned long e); 260const char *ERR_func_error_string(unsigned long e); 261const char *ERR_reason_error_string(unsigned long e); 262void ERR_print_errors_cb(int (*cb)(const char *str, size_t len, void *u), 263 void *u); 264#ifndef OPENSSL_NO_FP_API 265void ERR_print_errors_fp(FILE *fp); 266#endif 267#ifndef OPENSSL_NO_BIO 268void ERR_print_errors(BIO *bp); 269void ERR_add_error_data(int num, ...); 270#endif 271void ERR_load_strings(int lib,ERR_STRING_DATA str[]); 272void ERR_unload_strings(int lib,ERR_STRING_DATA str[]); 273void ERR_load_ERR_strings(void); 274void ERR_load_crypto_strings(void); 275void ERR_free_strings(void); 276 277void ERR_remove_state(unsigned long pid); /* if zero we look it up */ 278ERR_STATE *ERR_get_state(void); 279 280#ifndef OPENSSL_NO_LHASH 281LHASH *ERR_get_string_table(void); 282LHASH *ERR_get_err_state_table(void); 283void ERR_release_err_state_table(LHASH **hash); 284#endif 285 286int ERR_get_next_error_library(void); 287 288/* This opaque type encapsulates the low-level error-state functions */ 289typedef struct st_ERR_FNS ERR_FNS; 290/* An application can use this function and provide the return value to loaded 291 * modules that should use the application's ERR state/functionality */ 292const ERR_FNS *ERR_get_implementation(void); 293/* A loaded module should call this function prior to any ERR operations using 294 * the application's "ERR_FNS". */ 295int ERR_set_implementation(const ERR_FNS *fns); 296 297#ifdef __cplusplus 298} 299#endif 300 301#endif 302