include/openssl/err.h

   1 /*
   2  * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #ifndef HEADER_ERR_H
  11 # define HEADER_ERR_H
  12
  13 # include <openssl/e_os2.h>
  14
  15 # ifndef OPENSSL_NO_STDIO
  16 #  include <stdio.h>
  17 #  include <stdlib.h>
  18 # endif
  19
  20 # include <openssl/ossl_typ.h>
  21 # include <openssl/bio.h>
  22 # include <openssl/lhash.h>
  23
  24 #ifdef  __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 # ifndef OPENSSL_NO_ERR
  29 #  define ERR_PUT_error(l,f,r,fn,ln)      ERR_put_error(l,f,r,fn,ln)
  30 #  define ERR_PUT_func_error(l,f,r,fn,ln) ERR_put_func_error(l,f,r,fn,ln)
  31 # else
  32 #  define ERR_PUT_error(l,f,r,fn,ln)      ERR_put_error(l,f,r,NULL,0)
  33 #  define ERR_PUT_func_error(l,f,r,fn,ln) ERR_put_func_error(l,f,r,NULL,0)
  34 # endif
  35
  36 # include <errno.h>
  37
  38 # define ERR_TXT_MALLOCED        0x01
  39 # define ERR_TXT_STRING          0x02
  40
  41 # define ERR_FLAG_MARK           0x01
  42 # define ERR_FLAG_CLEAR          0x02
  43
  44 # define ERR_NUM_ERRORS  16
  45 typedef struct err_state_st {
  46     int err_flags[ERR_NUM_ERRORS];
  47     unsigned long err_buffer[ERR_NUM_ERRORS];
  48     char *err_data[ERR_NUM_ERRORS];
  49     int err_data_flags[ERR_NUM_ERRORS];
  50     const char *err_file[ERR_NUM_ERRORS];
  51     int err_line[ERR_NUM_ERRORS];
  52     int top, bottom;
  53 } ERR_STATE;
  54
  55 /* library */
  56 # define ERR_LIB_NONE            1
  57 # define ERR_LIB_SYS             2
  58 # define ERR_LIB_BN              3
  59 # define ERR_LIB_RSA             4
  60 # define ERR_LIB_DH              5
  61 # define ERR_LIB_EVP             6
  62 # define ERR_LIB_BUF             7
  63 # define ERR_LIB_OBJ             8
  64 # define ERR_LIB_PEM             9
  65 # define ERR_LIB_DSA             10
  66 # define ERR_LIB_X509            11
  67 /* #define ERR_LIB_METH         12 */
  68 # define ERR_LIB_ASN1            13
  69 # define ERR_LIB_CONF            14
  70 # define ERR_LIB_CRYPTO          15
  71 # define ERR_LIB_EC              16
  72 # define ERR_LIB_SSL             20
  73 /* #define ERR_LIB_SSL23        21 */
  74 /* #define ERR_LIB_SSL2         22 */
  75 /* #define ERR_LIB_SSL3         23 */
  76 /* #define ERR_LIB_RSAREF       30 */
  77 /* #define ERR_LIB_PROXY        31 */
  78 # define ERR_LIB_BIO             32
  79 # define ERR_LIB_PKCS7           33
  80 # define ERR_LIB_X509V3          34
  81 # define ERR_LIB_PKCS12          35
  82 # define ERR_LIB_RAND            36
  83 # define ERR_LIB_DSO             37
  84 # define ERR_LIB_ENGINE          38
  85 # define ERR_LIB_OCSP            39
  86 # define ERR_LIB_UI              40
  87 # define ERR_LIB_COMP            41
  88 # define ERR_LIB_ECDSA           42
  89 # define ERR_LIB_ECDH            43
  90 # define ERR_LIB_OSSL_STORE      44
  91 # define ERR_LIB_FIPS            45
  92 # define ERR_LIB_CMS             46
  93 # define ERR_LIB_TS              47
  94 # define ERR_LIB_HMAC            48
  95 /* # define ERR_LIB_JPAKE       49 */
  96 # define ERR_LIB_CT              50
  97 # define ERR_LIB_ASYNC           51
  98 # define ERR_LIB_KDF             52
  99 # define ERR_LIB_SM2             53
 100 # define ERR_LIB_ESS             54
 101 # define ERR_LIB_PROP            55
 102 # define ERR_LIB_CRMF            56
 103 # define ERR_LIB_PROV            57
 104 # define ERR_LIB_CMP             58
 105
 106 # define ERR_LIB_USER            128
 107
 108 # if ! OPENSSL_API_3
 109 #  define SYSerr(f,r)  ERR_PUT_error(ERR_LIB_SYS,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 110 #endif
 111 # define FUNCerr(f,r)  ERR_PUT_func_error(ERR_LIB_SYS,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
 112 # define BNerr(f,r)   ERR_PUT_error(ERR_LIB_BN,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 113 # define RSAerr(f,r)  ERR_PUT_error(ERR_LIB_RSA,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 114 # define DHerr(f,r)   ERR_PUT_error(ERR_LIB_DH,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 115 # define EVPerr(f,r)  ERR_PUT_error(ERR_LIB_EVP,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 116 # define BUFerr(f,r)  ERR_PUT_error(ERR_LIB_BUF,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 117 # define OBJerr(f,r)  ERR_PUT_error(ERR_LIB_OBJ,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 118 # define PEMerr(f,r)  ERR_PUT_error(ERR_LIB_PEM,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 119 # define DSAerr(f,r)  ERR_PUT_error(ERR_LIB_DSA,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 120 # define X509err(f,r) ERR_PUT_error(ERR_LIB_X509,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 121 # define ASN1err(f,r) ERR_PUT_error(ERR_LIB_ASN1,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 122 # define CONFerr(f,r) ERR_PUT_error(ERR_LIB_CONF,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 123 # define CRYPTOerr(f,r) ERR_PUT_error(ERR_LIB_CRYPTO,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 124 # define ECerr(f,r)   ERR_PUT_error(ERR_LIB_EC,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 125 # define SSLerr(f,r)  ERR_PUT_error(ERR_LIB_SSL,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 126 # define BIOerr(f,r)  ERR_PUT_error(ERR_LIB_BIO,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 127 # define PKCS7err(f,r) ERR_PUT_error(ERR_LIB_PKCS7,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 128 # define X509V3err(f,r) ERR_PUT_error(ERR_LIB_X509V3,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 129 # define PKCS12err(f,r) ERR_PUT_error(ERR_LIB_PKCS12,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 130 # define RANDerr(f,r) ERR_PUT_error(ERR_LIB_RAND,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 131 # define DSOerr(f,r) ERR_PUT_error(ERR_LIB_DSO,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 132 # define ENGINEerr(f,r) ERR_PUT_error(ERR_LIB_ENGINE,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 133 # define OCSPerr(f,r) ERR_PUT_error(ERR_LIB_OCSP,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 134 # define UIerr(f,r) ERR_PUT_error(ERR_LIB_UI,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 135 # define COMPerr(f,r) ERR_PUT_error(ERR_LIB_COMP,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 136 # define ECDSAerr(f,r)  ERR_PUT_error(ERR_LIB_ECDSA,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 137 # define ECDHerr(f,r)  ERR_PUT_error(ERR_LIB_ECDH,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 138 # define OSSL_STOREerr(f,r) ERR_PUT_error(ERR_LIB_OSSL_STORE,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 139 # define FIPSerr(f,r) ERR_PUT_error(ERR_LIB_FIPS,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 140 # define CMSerr(f,r) ERR_PUT_error(ERR_LIB_CMS,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 141 # define CRMFerr(f,r) ERR_PUT_error(ERR_LIB_CRMF,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 142 # define CMPerr(f,r) ERR_PUT_error(ERR_LIB_CMP,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 143 # define TSerr(f,r) ERR_PUT_error(ERR_LIB_TS,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 144 # define HMACerr(f,r) ERR_PUT_error(ERR_LIB_HMAC,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 145 # define CTerr(f,r) ERR_PUT_error(ERR_LIB_CT,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 146 # define ASYNCerr(f,r) ERR_PUT_error(ERR_LIB_ASYNC,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 147 # define KDFerr(f,r) ERR_PUT_error(ERR_LIB_KDF,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 148 # define SM2err(f,r) ERR_PUT_error(ERR_LIB_SM2,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 149 # define ESSerr(f,r) ERR_PUT_error(ERR_LIB_ESS,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 150 # define PROPerr(f,r) ERR_PUT_error(ERR_LIB_PROP,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 151 # define PROVerr(f,r) ERR_PUT_error(ERR_LIB_PROV,0,(r),OPENSSL_FILE,OPENSSL_LINE)
 152
 153 # define ERR_PACK(l,f,r) ( \
 154         (((unsigned int)(l) & 0x0FF) << 24L) | \
 155         (((unsigned int)(f) & 0xFFF) << 12L) | \
 156         (((unsigned int)(r) & 0xFFF)       ) )
 157 # define ERR_GET_LIB(l)          (int)(((l) >> 24L) & 0x0FFL)
 158 # define ERR_GET_FUNC(l)         (int)(((l) >> 12L) & 0xFFFL)
 159 # define ERR_GET_REASON(l)       (int)( (l)         & 0xFFFL)
 160 # define ERR_FATAL_ERROR(l)      (int)( (l)         & ERR_R_FATAL)
 161
 162 /* reasons */
 163 # define ERR_R_SYS_LIB   ERR_LIB_SYS/* 2 */
 164 # define ERR_R_BN_LIB    ERR_LIB_BN/* 3 */
 165 # define ERR_R_RSA_LIB   ERR_LIB_RSA/* 4 */
 166 # define ERR_R_DH_LIB    ERR_LIB_DH/* 5 */
 167 # define ERR_R_EVP_LIB   ERR_LIB_EVP/* 6 */
 168 # define ERR_R_BUF_LIB   ERR_LIB_BUF/* 7 */
 169 # define ERR_R_OBJ_LIB   ERR_LIB_OBJ/* 8 */
 170 # define ERR_R_PEM_LIB   ERR_LIB_PEM/* 9 */
 171 # define ERR_R_DSA_LIB   ERR_LIB_DSA/* 10 */
 172 # define ERR_R_X509_LIB  ERR_LIB_X509/* 11 */
 173 # define ERR_R_ASN1_LIB  ERR_LIB_ASN1/* 13 */
 174 # define ERR_R_EC_LIB    ERR_LIB_EC/* 16 */
 175 # define ERR_R_BIO_LIB   ERR_LIB_BIO/* 32 */
 176 # define ERR_R_PKCS7_LIB ERR_LIB_PKCS7/* 33 */
 177 # define ERR_R_X509V3_LIB ERR_LIB_X509V3/* 34 */
 178 # define ERR_R_ENGINE_LIB ERR_LIB_ENGINE/* 38 */
 179 # define ERR_R_UI_LIB    ERR_LIB_UI/* 40 */
 180 # define ERR_R_ECDSA_LIB ERR_LIB_ECDSA/* 42 */
 181 # define ERR_R_OSSL_STORE_LIB ERR_LIB_OSSL_STORE/* 44 */
 182
 183 # define ERR_R_NESTED_ASN1_ERROR                 58
 184 # define ERR_R_MISSING_ASN1_EOS                  63
 185
 186 /* fatal error */
 187 # define ERR_R_FATAL                             64
 188 # define ERR_R_MALLOC_FAILURE                    (1|ERR_R_FATAL)
 189 # define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED       (2|ERR_R_FATAL)
 190 # define ERR_R_PASSED_NULL_PARAMETER             (3|ERR_R_FATAL)
 191 # define ERR_R_INTERNAL_ERROR                    (4|ERR_R_FATAL)
 192 # define ERR_R_DISABLED                          (5|ERR_R_FATAL)
 193 # define ERR_R_INIT_FAIL                         (6|ERR_R_FATAL)
 194 # define ERR_R_PASSED_INVALID_ARGUMENT           (7)
 195 # define ERR_R_OPERATION_FAIL                    (8|ERR_R_FATAL)
 196
 197 /*
 198  * 99 is the maximum possible ERR_R_... code, higher values are reserved for
 199  * the individual libraries
 200  */
 201
 202 typedef struct ERR_string_data_st {
 203     unsigned long error;
 204     const char *string;
 205 } ERR_STRING_DATA;
 206
 207 DEFINE_LHASH_OF(ERR_STRING_DATA);
 208
 209 void ERR_put_error(int lib, int func, int reason, const char *file, int line);
 210 void ERR_put_func_error(int lib, const char *func, int reason,
 211                         const char *file, int line);
 212 void ERR_set_error_data(char *data, int flags);
 213
 214 unsigned long ERR_get_error(void);
 215 unsigned long ERR_get_error_line(const char **file, int *line);
 216 unsigned long ERR_get_error_line_data(const char **file, int *line,
 217                                       const char **data, int *flags);
 218 unsigned long ERR_peek_error(void);
 219 unsigned long ERR_peek_error_line(const char **file, int *line);
 220 unsigned long ERR_peek_error_line_data(const char **file, int *line,
 221                                        const char **data, int *flags);
 222 unsigned long ERR_peek_last_error(void);
 223 unsigned long ERR_peek_last_error_line(const char **file, int *line);
 224 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
 225                                             const char **data, int *flags);
 226 void ERR_clear_error(void);
 227 char *ERR_error_string(unsigned long e, char *buf);
 228 void ERR_error_string_n(unsigned long e, char *buf, size_t len);
 229 const char *ERR_lib_error_string(unsigned long e);
 230 const char *ERR_func_error_string(unsigned long e);
 231 const char *ERR_reason_error_string(unsigned long e);
 232 void ERR_print_errors_cb(int (*cb) (const char *str, size_t len, void *u),
 233                          void *u);
 234 # ifndef OPENSSL_NO_STDIO
 235 void ERR_print_errors_fp(FILE *fp);
 236 # endif
 237 void ERR_print_errors(BIO *bp);
 238 void ERR_add_error_data(int num, ...);
 239 void ERR_add_error_vdata(int num, va_list args);
 240 int ERR_load_strings(int lib, ERR_STRING_DATA *str);
 241 int ERR_load_strings_const(const ERR_STRING_DATA *str);
 242 int ERR_unload_strings(int lib, ERR_STRING_DATA *str);
 243 int ERR_load_ERR_strings(void);
 244
 245 #if !OPENSSL_API_1_1_0
 246 # define ERR_load_crypto_strings() \
 247     OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL)
 248 # define ERR_free_strings() while(0) continue
 249 #endif
 250
 251 DEPRECATEDIN_1_1_0(void ERR_remove_thread_state(void *))
 252 DEPRECATEDIN_1_0_0(void ERR_remove_state(unsigned long pid))
 253 ERR_STATE *ERR_get_state(void);
 254
 255 int ERR_get_next_error_library(void);
 256
 257 int ERR_set_mark(void);
 258 int ERR_pop_to_mark(void);
 259 int ERR_clear_last_mark(void);
 260
 261 #ifdef  __cplusplus
 262 }
 263 #endif
 264
 265 #endif