openssl/err.h

00001 /* crypto/err/err.h */
00002 /* Copyright (C) 1995-1998 Eric Young ([email protected])
00003  * All rights reserved.
00004  *
00005  * This package is an SSL implementation written
00006  * by Eric Young ([email protected]).
00007  * The implementation was written so as to conform with Netscapes SSL.
00008  * 
00009  * This library is free for commercial and non-commercial use as long as
00010  * the following conditions are aheared to.  The following conditions
00011  * apply to all code found in this distribution, be it the RC4, RSA,
00012  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
00013  * included with this distribution is covered by the same copyright terms
00014  * except that the holder is Tim Hudson ([email protected]).
00015  * 
00016  * Copyright remains Eric Young's, and as such any Copyright notices in
00017  * the code are not to be removed.
00018  * If this package is used in a product, Eric Young should be given attribution
00019  * as the author of the parts of the library used.
00020  * This can be in the form of a textual message at program startup or
00021  * in documentation (online or textual) provided with the package.
00022  * 
00023  * Redistribution and use in source and binary forms, with or without
00024  * modification, are permitted provided that the following conditions
00025  * are met:
00026  * 1. Redistributions of source code must retain the copyright
00027  *    notice, this list of conditions and the following disclaimer.
00028  * 2. Redistributions in binary form must reproduce the above copyright
00029  *    notice, this list of conditions and the following disclaimer in the
00030  *    documentation and/or other materials provided with the distribution.
00031  * 3. All advertising materials mentioning features or use of this software
00032  *    must display the following acknowledgement:
00033  *    "This product includes cryptographic software written by
00034  *     Eric Young ([email protected])"
00035  *    The word 'cryptographic' can be left out if the rouines from the library
00036  *    being used are not cryptographic related :-).
00037  * 4. If you include any Windows specific code (or a derivative thereof) from 
00038  *    the apps directory (application code) you must include an acknowledgement:
00039  *    "This product includes software written by Tim Hudson ([email protected])"
00040  * 
00041  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
00042  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00043  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00044  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
00045  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00046  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
00047  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00048  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00049  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
00050  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00051  * SUCH DAMAGE.
00052  * 
00053  * The licence and distribution terms for any publically available version or
00054  * derivative of this code cannot be changed.  i.e. this code cannot simply be
00055  * copied and put under another distribution licence
00056  * [including the GNU Public Licence.]
00057  */
00058  /*
00059  © Portions copyright (c) 2006 Nokia Corporation.  All rights reserved.
00060  */
00061 
00062 
00063 #ifndef HEADER_ERR_H
00064 #define HEADER_ERR_H
00065 
00066 #if (defined(__SYMBIAN32__) && !defined(SYMBIAN))
00067 #define SYMBIAN
00068 #endif
00069 
00070 #ifdef SYMBIAN
00071 #include <e32def.h>
00072 #endif
00073 #include <openssl/e_os2.h>
00074 
00075 #ifndef OPENSSL_NO_FP_API
00076 #include <stdio.h>
00077 #include <stdlib.h>
00078 #endif
00079 
00080 #include <openssl/ossl_typ.h>
00081 #ifndef OPENSSL_NO_BIO
00082 #include <openssl/bio.h>
00083 #endif
00084 #ifndef OPENSSL_NO_LHASH
00085 #include <openssl/lhash.h>
00086 #endif
00087 
00088 #ifdef  __cplusplus
00089 extern "C" {
00090 #endif
00091 
00092 #ifndef OPENSSL_NO_ERR
00093 #define ERR_PUT_error(a,b,c,d,e)        ERR_put_error(a,b,c,d,e)
00094 #else
00095 #define ERR_PUT_error(a,b,c,d,e)        ERR_put_error(a,b,c,NULL,0)
00096 #endif
00097 
00098 #include <errno.h>
00099 
00100 #define ERR_TXT_MALLOCED        0x01
00101 #define ERR_TXT_STRING          0x02
00102 
00103 #define ERR_FLAG_MARK           0x01
00104 
00105 #define ERR_NUM_ERRORS  16
00106 typedef struct err_state_st
00107         {
00108         unsigned long pid;
00109         int err_flags[ERR_NUM_ERRORS];
00110         unsigned long err_buffer[ERR_NUM_ERRORS];
00111         char *err_data[ERR_NUM_ERRORS];
00112         int err_data_flags[ERR_NUM_ERRORS];
00113         const char *err_file[ERR_NUM_ERRORS];
00114         int err_line[ERR_NUM_ERRORS];
00115         int top,bottom;
00116         } ERR_STATE;
00117 
00118 /* library */
00119 #define ERR_LIB_NONE            1
00120 #define ERR_LIB_SYS             2
00121 #define ERR_LIB_BN              3
00122 #define ERR_LIB_RSA             4
00123 #define ERR_LIB_DH              5
00124 #define ERR_LIB_EVP             6
00125 #define ERR_LIB_BUF             7
00126 #define ERR_LIB_OBJ             8
00127 #define ERR_LIB_PEM             9
00128 #define ERR_LIB_DSA             10
00129 #define ERR_LIB_X509            11
00130 /* #define ERR_LIB_METH         12 */
00131 #define ERR_LIB_ASN1            13
00132 #define ERR_LIB_CONF            14
00133 #define ERR_LIB_CRYPTO          15
00134 #define ERR_LIB_EC              16
00135 #define ERR_LIB_SSL             20
00136 /* #define ERR_LIB_SSL23        21 */
00137 /* #define ERR_LIB_SSL2         22 */
00138 /* #define ERR_LIB_SSL3         23 */
00139 /* #define ERR_LIB_RSAREF       30 */
00140 /* #define ERR_LIB_PROXY        31 */
00141 #define ERR_LIB_BIO             32
00142 #define ERR_LIB_PKCS7           33
00143 #define ERR_LIB_X509V3          34
00144 #define ERR_LIB_PKCS12          35
00145 #define ERR_LIB_RAND            36
00146 #define ERR_LIB_DSO             37
00147 #define ERR_LIB_ENGINE          38
00148 #define ERR_LIB_OCSP            39
00149 #define ERR_LIB_UI              40
00150 #define ERR_LIB_COMP            41
00151 #define ERR_LIB_ECDSA           42
00152 #define ERR_LIB_ECDH            43
00153 #define ERR_LIB_STORE           44
00154 
00155 #define ERR_LIB_USER            128
00156 
00157 #define SYSerr(f,r)  ERR_PUT_error(ERR_LIB_SYS,(f),(r),__FILE__,__LINE__)
00158 #define BNerr(f,r)   ERR_PUT_error(ERR_LIB_BN,(f),(r),__FILE__,__LINE__)
00159 #define RSAerr(f,r)  ERR_PUT_error(ERR_LIB_RSA,(f),(r),__FILE__,__LINE__)
00160 #define DHerr(f,r)   ERR_PUT_error(ERR_LIB_DH,(f),(r),__FILE__,__LINE__)
00161 #define EVPerr(f,r)  ERR_PUT_error(ERR_LIB_EVP,(f),(r),__FILE__,__LINE__)
00162 #define BUFerr(f,r)  ERR_PUT_error(ERR_LIB_BUF,(f),(r),__FILE__,__LINE__)
00163 #define OBJerr(f,r)  ERR_PUT_error(ERR_LIB_OBJ,(f),(r),__FILE__,__LINE__)
00164 #define PEMerr(f,r)  ERR_PUT_error(ERR_LIB_PEM,(f),(r),__FILE__,__LINE__)
00165 #define DSAerr(f,r)  ERR_PUT_error(ERR_LIB_DSA,(f),(r),__FILE__,__LINE__)
00166 #define X509err(f,r) ERR_PUT_error(ERR_LIB_X509,(f),(r),__FILE__,__LINE__)
00167 #define ASN1err(f,r) ERR_PUT_error(ERR_LIB_ASN1,(f),(r),__FILE__,__LINE__)
00168 #define CONFerr(f,r) ERR_PUT_error(ERR_LIB_CONF,(f),(r),__FILE__,__LINE__)
00169 #define CRYPTOerr(f,r) ERR_PUT_error(ERR_LIB_CRYPTO,(f),(r),__FILE__,__LINE__)
00170 #define ECerr(f,r)   ERR_PUT_error(ERR_LIB_EC,(f),(r),__FILE__,__LINE__)
00171 #define SSLerr(f,r)  ERR_PUT_error(ERR_LIB_SSL,(f),(r),__FILE__,__LINE__)
00172 #define BIOerr(f,r)  ERR_PUT_error(ERR_LIB_BIO,(f),(r),__FILE__,__LINE__)
00173 #define PKCS7err(f,r) ERR_PUT_error(ERR_LIB_PKCS7,(f),(r),__FILE__,__LINE__)
00174 #define X509V3err(f,r) ERR_PUT_error(ERR_LIB_X509V3,(f),(r),__FILE__,__LINE__)
00175 #define PKCS12err(f,r) ERR_PUT_error(ERR_LIB_PKCS12,(f),(r),__FILE__,__LINE__)
00176 #define RANDerr(f,r) ERR_PUT_error(ERR_LIB_RAND,(f),(r),__FILE__,__LINE__)
00177 #define DSOerr(f,r) ERR_PUT_error(ERR_LIB_DSO,(f),(r),__FILE__,__LINE__)
00178 #define ENGINEerr(f,r) ERR_PUT_error(ERR_LIB_ENGINE,(f),(r),__FILE__,__LINE__)
00179 #define OCSPerr(f,r) ERR_PUT_error(ERR_LIB_OCSP,(f),(r),__FILE__,__LINE__)
00180 #define UIerr(f,r) ERR_PUT_error(ERR_LIB_UI,(f),(r),__FILE__,__LINE__)
00181 #define COMPerr(f,r) ERR_PUT_error(ERR_LIB_COMP,(f),(r),__FILE__,__LINE__)
00182 #define ECDSAerr(f,r)  ERR_PUT_error(ERR_LIB_ECDSA,(f),(r),__FILE__,__LINE__)
00183 #define ECDHerr(f,r)  ERR_PUT_error(ERR_LIB_ECDH,(f),(r),__FILE__,__LINE__)
00184 #define STOREerr(f,r) ERR_PUT_error(ERR_LIB_STORE,(f),(r),__FILE__,__LINE__)
00185 
00186 /* Borland C seems too stupid to be able to shift and do longs in
00187  * the pre-processor :-( */
00188 #define ERR_PACK(l,f,r)         (((((unsigned long)l)&0xffL)*0x1000000)| \
00189                                 ((((unsigned long)f)&0xfffL)*0x1000)| \
00190                                 ((((unsigned long)r)&0xfffL)))
00191 #define ERR_GET_LIB(l)          (int)((((unsigned long)l)>>24L)&0xffL)
00192 #define ERR_GET_FUNC(l)         (int)((((unsigned long)l)>>12L)&0xfffL)
00193 #define ERR_GET_REASON(l)       (int)((l)&0xfffL)
00194 #define ERR_FATAL_ERROR(l)      (int)((l)&ERR_R_FATAL)
00195 
00196 
00197 /* OS functions */
00198 #define SYS_F_FOPEN             1
00199 #define SYS_F_CONNECT           2
00200 #define SYS_F_GETSERVBYNAME     3
00201 #define SYS_F_SOCKET            4
00202 #define SYS_F_IOCTLSOCKET       5
00203 #define SYS_F_BIND              6
00204 #define SYS_F_LISTEN            7
00205 #define SYS_F_ACCEPT            8
00206 #define SYS_F_WSASTARTUP        9 /* Winsock stuff */
00207 #define SYS_F_OPENDIR           10
00208 #define SYS_F_FREAD             11
00209 
00210 
00211 /* reasons */
00212 #define ERR_R_SYS_LIB   ERR_LIB_SYS       /* 2 */
00213 #define ERR_R_BN_LIB    ERR_LIB_BN        /* 3 */
00214 #define ERR_R_RSA_LIB   ERR_LIB_RSA       /* 4 */
00215 #define ERR_R_DH_LIB    ERR_LIB_DH        /* 5 */
00216 #define ERR_R_EVP_LIB   ERR_LIB_EVP       /* 6 */
00217 #define ERR_R_BUF_LIB   ERR_LIB_BUF       /* 7 */
00218 #define ERR_R_OBJ_LIB   ERR_LIB_OBJ       /* 8 */
00219 #define ERR_R_PEM_LIB   ERR_LIB_PEM       /* 9 */
00220 #define ERR_R_DSA_LIB   ERR_LIB_DSA      /* 10 */
00221 #define ERR_R_X509_LIB  ERR_LIB_X509     /* 11 */
00222 #define ERR_R_ASN1_LIB  ERR_LIB_ASN1     /* 13 */
00223 #define ERR_R_CONF_LIB  ERR_LIB_CONF     /* 14 */
00224 #define ERR_R_CRYPTO_LIB ERR_LIB_CRYPTO  /* 15 */
00225 #define ERR_R_EC_LIB    ERR_LIB_EC       /* 16 */
00226 #define ERR_R_SSL_LIB   ERR_LIB_SSL      /* 20 */
00227 #define ERR_R_BIO_LIB   ERR_LIB_BIO      /* 32 */
00228 #define ERR_R_PKCS7_LIB ERR_LIB_PKCS7    /* 33 */
00229 #define ERR_R_X509V3_LIB ERR_LIB_X509V3  /* 34 */
00230 #define ERR_R_PKCS12_LIB ERR_LIB_PKCS12  /* 35 */
00231 #define ERR_R_RAND_LIB  ERR_LIB_RAND     /* 36 */
00232 #define ERR_R_DSO_LIB   ERR_LIB_DSO      /* 37 */
00233 #define ERR_R_ENGINE_LIB ERR_LIB_ENGINE  /* 38 */
00234 #define ERR_R_OCSP_LIB  ERR_LIB_OCSP     /* 39 */
00235 #define ERR_R_UI_LIB    ERR_LIB_UI       /* 40 */
00236 #define ERR_R_COMP_LIB  ERR_LIB_COMP     /* 41 */
00237 #define ERR_R_ECDSA_LIB ERR_LIB_ECDSA    /* 42 */
00238 #define ERR_R_ECDH_LIB  ERR_LIB_ECDH     /* 43 */
00239 #define ERR_R_STORE_LIB ERR_LIB_STORE    /* 44 */
00240 
00241 #define ERR_R_NESTED_ASN1_ERROR                 58
00242 #define ERR_R_BAD_ASN1_OBJECT_HEADER            59
00243 #define ERR_R_BAD_GET_ASN1_OBJECT_CALL          60
00244 #define ERR_R_EXPECTING_AN_ASN1_SEQUENCE        61
00245 #define ERR_R_ASN1_LENGTH_MISMATCH              62
00246 #define ERR_R_MISSING_ASN1_EOS                  63
00247 
00248 /* fatal error */
00249 #define ERR_R_FATAL                             64
00250 #define ERR_R_MALLOC_FAILURE                    (1|ERR_R_FATAL)
00251 #define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED       (2|ERR_R_FATAL)
00252 #define ERR_R_PASSED_NULL_PARAMETER             (3|ERR_R_FATAL)
00253 #define ERR_R_INTERNAL_ERROR                    (4|ERR_R_FATAL)
00254 #define ERR_R_DISABLED                          (5|ERR_R_FATAL)
00255 
00256 /* 99 is the maximum possible ERR_R_... code, higher values
00257  * are reserved for the individual libraries */
00258 
00259 
00260 typedef struct ERR_string_data_st
00261         {
00262         unsigned long error;
00263         const char *string;
00264         } ERR_STRING_DATA;
00265 
00266 void ERR_put_error(int lib, int func,int reason,const char *file,int line);
00267 void ERR_set_error_data(char *data,int flags);
00268 
00269 IMPORT_C unsigned long ERR_get_error(void);
00270 IMPORT_C unsigned long ERR_get_error_line(const char **file,int *line);
00271 IMPORT_C unsigned long ERR_get_error_line_data(const char **file,int *line,
00272                                       const char **data, int *flags);
00273 IMPORT_C unsigned long ERR_peek_error(void);
00274 IMPORT_C unsigned long ERR_peek_error_line(const char **file,int *line);
00275 IMPORT_C unsigned long ERR_peek_error_line_data(const char **file,int *line,
00276                                        const char **data,int *flags);
00277 IMPORT_C unsigned long ERR_peek_last_error(void);
00278 IMPORT_C unsigned long ERR_peek_last_error_line(const char **file,int *line);
00279 IMPORT_C unsigned long ERR_peek_last_error_line_data(const char **file,int *line,
00280                                        const char **data,int *flags);
00281 IMPORT_C void ERR_clear_error(void );
00282 IMPORT_C char *ERR_error_string(unsigned long e,char *buf);
00283 IMPORT_C void ERR_error_string_n(unsigned long e, char *buf, size_t len);
00284 IMPORT_C const char *ERR_lib_error_string(unsigned long e);
00285 IMPORT_C const char *ERR_func_error_string(unsigned long e);
00286 IMPORT_C const char *ERR_reason_error_string(unsigned long e);
00287 IMPORT_C void ERR_print_errors_cb(int (*cb)(const char *str, size_t len, void *u),
00288                          void *u);
00289 #ifndef OPENSSL_NO_FP_API
00290 IMPORT_C void ERR_print_errors_fp(FILE *fp);
00291 #endif
00292 #ifndef OPENSSL_NO_BIO
00293 IMPORT_C void ERR_print_errors(BIO *bp);
00294 IMPORT_C void ERR_add_error_data(int num, ...);
00295 #endif
00296 IMPORT_C void ERR_load_strings(int lib,ERR_STRING_DATA str[]);
00297 IMPORT_C void ERR_unload_strings(int lib,ERR_STRING_DATA str[]);
00298 IMPORT_C void ERR_load_ERR_strings(void);
00299 IMPORT_C void ERR_load_crypto_strings(void);
00300 IMPORT_C void ERR_free_strings(void);
00301 
00302 IMPORT_C void ERR_remove_state(unsigned long pid); /* if zero we look it up */
00303 IMPORT_C ERR_STATE *ERR_get_state(void);
00304 
00305 #ifndef OPENSSL_NO_LHASH
00306 IMPORT_C LHASH *ERR_get_string_table(void);
00307 IMPORT_C LHASH *ERR_get_err_state_table(void);
00308 IMPORT_C void ERR_release_err_state_table(LHASH **hash);
00309 #endif
00310 
00311 IMPORT_C int ERR_get_next_error_library(void);
00312 
00313 IMPORT_C int ERR_set_mark(void);
00314 IMPORT_C int ERR_pop_to_mark(void);
00315 
00316 /* Already defined in ossl_typ.h */
00317 /* typedef struct st_ERR_FNS ERR_FNS; */
00318 /* An application can use this function and provide the return value to loaded
00319  * modules that should use the application's ERR state/functionality */
00320 IMPORT_C const ERR_FNS *ERR_get_implementation(void);
00321 /* A loaded module should call this function prior to any ERR operations using
00322  * the application's "ERR_FNS". */
00323 IMPORT_C int ERR_set_implementation(const ERR_FNS *fns);
00324 
00325 #ifdef  __cplusplus
00326 }
00327 #endif
00328 
00329 #endif