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