include/openssl/err.h

   1 /*
   2  * Copyright 1995-2020 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 OPENSSL_ERR_H
  11 # define OPENSSL_ERR_H
  12 # pragma once
  13
  14 # include <openssl/macros.h>
  15 # ifndef OPENSSL_NO_DEPRECATED_3_0
  16 #  define HEADER_ERR_H
  17 # endif
  18
  19 # include <openssl/e_os2.h>
  20
  21 # ifndef OPENSSL_NO_STDIO
  22 #  include <stdio.h>
  23 #  include <stdlib.h>
  24 # endif
  25
  26 # include <openssl/types.h>
  27 # include <openssl/bio.h>
  28 # include <openssl/lhash.h>
  29
  30 #ifdef  __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 # ifndef OPENSSL_NO_DEPRECATED_3_0
  35 #  ifndef OPENSSL_NO_FILENAMES
  36 #   define ERR_PUT_error(l,f,r,fn,ln)      ERR_put_error(l,f,r,fn,ln)
  37 #  else
  38 #   define ERR_PUT_error(l,f,r,fn,ln)      ERR_put_error(l,f,r,NULL,0)
  39 #  endif
  40 # endif
  41
  42 # include <errno.h>
  43
  44 # define ERR_TXT_MALLOCED        0x01
  45 # define ERR_TXT_STRING          0x02
  46
  47 # if !defined(OPENSSL_NO_DEPRECATED_3_0) || defined(OSSL_FORCE_ERR_STATE)
  48 #  define ERR_FLAG_MARK           0x01
  49 #  define ERR_FLAG_CLEAR          0x02
  50
  51 #  define ERR_NUM_ERRORS  16
  52 struct err_state_st {
  53     int err_flags[ERR_NUM_ERRORS];
  54     unsigned long err_buffer[ERR_NUM_ERRORS];
  55     char *err_data[ERR_NUM_ERRORS];
  56     size_t err_data_size[ERR_NUM_ERRORS];
  57     int err_data_flags[ERR_NUM_ERRORS];
  58     const char *err_file[ERR_NUM_ERRORS];
  59     int err_line[ERR_NUM_ERRORS];
  60     const char *err_func[ERR_NUM_ERRORS];
  61     int top, bottom;
  62 };
  63 # endif
  64
  65 /* library */
  66 # define ERR_LIB_NONE            1
  67 # define ERR_LIB_SYS             2
  68 # define ERR_LIB_BN              3
  69 # define ERR_LIB_RSA             4
  70 # define ERR_LIB_DH              5
  71 # define ERR_LIB_EVP             6
  72 # define ERR_LIB_BUF             7
  73 # define ERR_LIB_OBJ             8
  74 # define ERR_LIB_PEM             9
  75 # define ERR_LIB_DSA             10
  76 # define ERR_LIB_X509            11
  77 /* #define ERR_LIB_METH         12 */
  78 # define ERR_LIB_ASN1            13
  79 # define ERR_LIB_CONF            14
  80 # define ERR_LIB_CRYPTO          15
  81 # define ERR_LIB_EC              16
  82 # define ERR_LIB_SSL             20
  83 /* #define ERR_LIB_SSL23        21 */
  84 /* #define ERR_LIB_SSL2         22 */
  85 /* #define ERR_LIB_SSL3         23 */
  86 /* #define ERR_LIB_RSAREF       30 */
  87 /* #define ERR_LIB_PROXY        31 */
  88 # define ERR_LIB_BIO             32
  89 # define ERR_LIB_PKCS7           33
  90 # define ERR_LIB_X509V3          34
  91 # define ERR_LIB_PKCS12          35
  92 # define ERR_LIB_RAND            36
  93 # define ERR_LIB_DSO             37
  94 # define ERR_LIB_ENGINE          38
  95 # define ERR_LIB_OCSP            39
  96 # define ERR_LIB_UI              40
  97 # define ERR_LIB_COMP            41
  98 # define ERR_LIB_ECDSA           42
  99 # define ERR_LIB_ECDH            43
 100 # define ERR_LIB_OSSL_STORE      44
 101 # define ERR_LIB_FIPS            45
 102 # define ERR_LIB_CMS             46
 103 # define ERR_LIB_TS              47
 104 # define ERR_LIB_HMAC            48
 105 /* # define ERR_LIB_JPAKE       49 */
 106 # define ERR_LIB_CT              50
 107 # define ERR_LIB_ASYNC           51
 108 # define ERR_LIB_KDF             52
 109 # define ERR_LIB_SM2             53
 110 # define ERR_LIB_ESS             54
 111 # define ERR_LIB_PROP            55
 112 # define ERR_LIB_CRMF            56
 113 # define ERR_LIB_PROV            57
 114 # define ERR_LIB_CMP             58
 115 # define ERR_LIB_OSSL_SERIALIZER 59
 116 # define ERR_LIB_HTTP            60
 117
 118 # define ERR_LIB_USER            128
 119
 120 # if 1 || !defined(OPENSSL_NO_DEPRECATED_3_0)
 121 #  define ASN1err(f, r) ERR_raise_data(ERR_LIB_ASN1, (r), NULL)
 122 #  define ASYNCerr(f, r) ERR_raise_data(ERR_LIB_ASYNC, (r), NULL)
 123 #  define BIOerr(f, r) ERR_raise_data(ERR_LIB_BIO, (r), NULL)
 124 #  define BNerr(f, r)  ERR_raise_data(ERR_LIB_BN, (r), NULL)
 125 #  define BUFerr(f, r) ERR_raise_data(ERR_LIB_BUF, (r), NULL)
 126 #  define CMPerr(f, r) ERR_raise_data(ERR_LIB_CMP, (r), NULL)
 127 #  define CMSerr(f, r) ERR_raise_data(ERR_LIB_CMS, (r), NULL)
 128 #  define COMPerr(f, r) ERR_raise_data(ERR_LIB_COMP, (r), NULL)
 129 #  define CONFerr(f, r) ERR_raise_data(ERR_LIB_CONF, (r), NULL)
 130 #  define CRMFerr(f, r) ERR_raise_data(ERR_LIB_CRMF, (r), NULL)
 131 #  define CRYPTOerr(f, r) ERR_raise_data(ERR_LIB_CRYPTO, (r), NULL)
 132 #  define CTerr(f, r) ERR_raise_data(ERR_LIB_CT, (r), NULL)
 133 #  define DHerr(f, r)  ERR_raise_data(ERR_LIB_DH, (r), NULL)
 134 #  define DSAerr(f, r) ERR_raise_data(ERR_LIB_DSA, (r), NULL)
 135 #  define DSOerr(f, r) ERR_raise_data(ERR_LIB_DSO, (r), NULL)
 136 #  define ECDHerr(f, r) ERR_raise_data(ERR_LIB_ECDH, (r), NULL)
 137 #  define ECDSAerr(f, r) ERR_raise_data(ERR_LIB_ECDSA, (r), NULL)
 138 #  define ECerr(f, r)  ERR_raise_data(ERR_LIB_EC, (r), NULL)
 139 #  define ENGINEerr(f, r) ERR_raise_data(ERR_LIB_ENGINE, (r), NULL)
 140 #  define ESSerr(f, r) ERR_raise_data(ERR_LIB_ESS, (r), NULL)
 141 #  define EVPerr(f, r) ERR_raise_data(ERR_LIB_EVP, (r), NULL)
 142 #  define FIPSerr(f, r) ERR_raise_data(ERR_LIB_FIPS, (r), NULL)
 143 #  define HMACerr(f, r) ERR_raise_data(ERR_LIB_HMAC, (r), NULL)
 144 #  define HTTPerr(f, r) ERR_raise_data(ERR_LIB_HTTP, (r), NULL)
 145 #  define KDFerr(f, r) ERR_raise_data(ERR_LIB_KDF, (r), NULL)
 146 #  define OBJerr(f, r) ERR_raise_data(ERR_LIB_OBJ, (r), NULL)
 147 #  define OCSPerr(f, r) ERR_raise_data(ERR_LIB_OCSP, (r), NULL)
 148 #  define OSSL_STOREerr(f, r) ERR_raise_data(ERR_LIB_OSSL_STORE, (r), NULL)
 149 #  define PEMerr(f, r) ERR_raise_data(ERR_LIB_PEM, (r), NULL)
 150 #  define PKCS12err(f, r) ERR_raise_data(ERR_LIB_PKCS12, (r), NULL)
 151 #  define PKCS7err(f, r) ERR_raise_data(ERR_LIB_PKCS7, (r), NULL)
 152 #  define PROPerr(f, r) ERR_raise_data(ERR_LIB_PROP, (r), NULL)
 153 #  define PROVerr(f, r) ERR_raise_data(ERR_LIB_PROV, (r), NULL)
 154 #  define RANDerr(f, r) ERR_raise_data(ERR_LIB_RAND, (r), NULL)
 155 #  define RSAerr(f, r) ERR_raise_data(ERR_LIB_RSA, (r), NULL)
 156 #  define KDFerr(f, r) ERR_raise_data(ERR_LIB_KDF, (r), NULL)
 157 #  define SM2err(f, r) ERR_raise_data(ERR_LIB_SM2, (r), NULL)
 158 #  define SSLerr(f, r) ERR_raise_data(ERR_LIB_SSL, (r), NULL)
 159 #  define SYSerr(f, r) ERR_raise_data(ERR_LIB_SYS, (r), NULL)
 160 #  define TSerr(f, r) ERR_raise_data(ERR_LIB_TS, (r), NULL)
 161 #  define UIerr(f, r) ERR_raise_data(ERR_LIB_UI, (r), NULL)
 162 #  define X509V3err(f, r) ERR_raise_data(ERR_LIB_X509V3, (r), NULL)
 163 #  define X509err(f, r) ERR_raise_data(ERR_LIB_X509, (r), NULL)
 164 # endif
 165
 166 # define ERR_PACK(l,f,r) ( \
 167         (((unsigned int)(l) & 0x0FF) << 24L) | \
 168         (((unsigned int)(f) & 0xFFF) << 12L) | \
 169         (((unsigned int)(r) & 0xFFF)       ) )
 170 # define ERR_GET_LIB(l)          (int)(((l) >> 24L) & 0x0FFL)
 171 # define ERR_GET_FUNC(l)         (int)(((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 # ifndef OPENSSL_NO_DEPRECATED_3_0
 176 #  define SYS_F_FOPEN             0
 177 #  define SYS_F_CONNECT           0
 178 #  define SYS_F_GETSERVBYNAME     0
 179 #  define SYS_F_SOCKET            0
 180 #  define SYS_F_IOCTLSOCKET       0
 181 #  define SYS_F_BIND              0
 182 #  define SYS_F_LISTEN            0
 183 #  define SYS_F_ACCEPT            0
 184 #  define SYS_F_WSASTARTUP        0
 185 #  define SYS_F_OPENDIR           0
 186 #  define SYS_F_FREAD             0
 187 #  define SYS_F_GETADDRINFO       0
 188 #  define SYS_F_GETNAMEINFO       0
 189 #  define SYS_F_SETSOCKOPT        0
 190 #  define SYS_F_GETSOCKOPT        0
 191 #  define SYS_F_GETSOCKNAME       0
 192 #  define SYS_F_GETHOSTBYNAME     0
 193 #  define SYS_F_FFLUSH            0
 194 #  define SYS_F_OPEN              0
 195 #  define SYS_F_CLOSE             0
 196 #  define SYS_F_IOCTL             0
 197 #  define SYS_F_STAT              0
 198 #  define SYS_F_FCNTL             0
 199 #  define SYS_F_FSTAT             0
 200 #  define SYS_F_SENDFILE          0
 201 # endif
 202
 203 /* reasons */
 204 # define ERR_R_SYS_LIB   ERR_LIB_SYS/* 2 */
 205 # define ERR_R_BN_LIB    ERR_LIB_BN/* 3 */
 206 # define ERR_R_RSA_LIB   ERR_LIB_RSA/* 4 */
 207 # define ERR_R_DH_LIB    ERR_LIB_DH/* 5 */
 208 # define ERR_R_EVP_LIB   ERR_LIB_EVP/* 6 */
 209 # define ERR_R_BUF_LIB   ERR_LIB_BUF/* 7 */
 210 # define ERR_R_OBJ_LIB   ERR_LIB_OBJ/* 8 */
 211 # define ERR_R_PEM_LIB   ERR_LIB_PEM/* 9 */
 212 # define ERR_R_DSA_LIB   ERR_LIB_DSA/* 10 */
 213 # define ERR_R_X509_LIB  ERR_LIB_X509/* 11 */
 214 # define ERR_R_ASN1_LIB  ERR_LIB_ASN1/* 13 */
 215 # define ERR_R_EC_LIB    ERR_LIB_EC/* 16 */
 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_ENGINE_LIB ERR_LIB_ENGINE/* 38 */
 220 # define ERR_R_UI_LIB    ERR_LIB_UI/* 40 */
 221 # define ERR_R_ECDSA_LIB ERR_LIB_ECDSA/* 42 */
 222 # define ERR_R_OSSL_STORE_LIB ERR_LIB_OSSL_STORE/* 44 */
 223
 224 # define ERR_R_NESTED_ASN1_ERROR                 58
 225 # define ERR_R_MISSING_ASN1_EOS                  63
 226
 227 /* fatal error */
 228 # define ERR_R_FATAL                             64
 229 # define ERR_R_MALLOC_FAILURE                    (1|ERR_R_FATAL)
 230 # define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED       (2|ERR_R_FATAL)
 231 # define ERR_R_PASSED_NULL_PARAMETER             (3|ERR_R_FATAL)
 232 # define ERR_R_INTERNAL_ERROR                    (4|ERR_R_FATAL)
 233 # define ERR_R_DISABLED                          (5|ERR_R_FATAL)
 234 # define ERR_R_INIT_FAIL                         (6|ERR_R_FATAL)
 235 # define ERR_R_PASSED_INVALID_ARGUMENT           (7)
 236 # define ERR_R_OPERATION_FAIL                    (8|ERR_R_FATAL)
 237 # define ERR_R_INVALID_PROVIDER_FUNCTIONS        (9|ERR_R_FATAL)
 238 # define ERR_R_INTERRUPTED_OR_CANCELLED          (10)
 239
 240 /*
 241  * 99 is the maximum possible ERR_R_... code, higher values are reserved for
 242  * the individual libraries
 243  */
 244
 245 typedef struct ERR_string_data_st {
 246     unsigned long error;
 247     const char *string;
 248 } ERR_STRING_DATA;
 249
 250 DEFINE_LHASH_OF(ERR_STRING_DATA);
 251
 252 /* 12 lines and some on an 80 column terminal */
 253 #define ERR_MAX_DATA_SIZE       1024
 254
 255 /* Building blocks */
 256 void ERR_new(void);
 257 void ERR_set_debug(const char *file, int line, const char *func);
 258 void ERR_set_error(int lib, int reason, const char *fmt, ...);
 259 void ERR_vset_error(int lib, int reason, const char *fmt, va_list args);
 260
 261 /* Main error raising functions */
 262 # define ERR_raise(lib, reason) ERR_raise_data((lib),(reason),NULL)
 263 # define ERR_raise_data                                         \
 264     (ERR_new(),                                                 \
 265      ERR_set_debug(OPENSSL_FILE,OPENSSL_LINE,OPENSSL_FUNC),     \
 266      ERR_set_error)
 267
 268 # ifndef OPENSSL_NO_DEPRECATED_3_0
 269 /* Backward compatibility */
 270 #  define ERR_put_error(lib, func, reason, file, line)          \
 271     (ERR_new(),                                                 \
 272      ERR_set_debug((file), (line), OPENSSL_FUNC),               \
 273      ERR_set_error((lib), (reason), NULL))
 274 # endif
 275
 276 void ERR_set_error_data(char *data, int flags);
 277
 278 unsigned long ERR_get_error(void);
 279 /*
 280  * TODO(3.0) consider if the following three functions should be deprecated.
 281  * They all drop the error record from the error queue, so regardless of which
 282  * one is used, the rest of the information is lost, making them not so useful.
 283  * The recommendation should be to use the peek functions to extract all the
 284  * additional data.
 285  */
 286 unsigned long ERR_get_error_line(const char **file, int *line);
 287 unsigned long ERR_get_error_func(const char **func);
 288 unsigned long ERR_get_error_data(const char **data, int *flags);
 289 unsigned long ERR_get_error_all(const char **file, int *line,
 290                                 const char **func,
 291                                 const char **data, int *flags);
 292 DEPRECATEDIN_3_0(unsigned long ERR_get_error_line_data(const char **file,
 293                                                      int *line,
 294                                                      const char **data,
 295                                                      int *flags))
 296 unsigned long ERR_peek_error(void);
 297 unsigned long ERR_peek_error_line(const char **file, int *line);
 298 unsigned long ERR_peek_error_func(const char **func);
 299 unsigned long ERR_peek_error_data(const char **data, int *flags);
 300 unsigned long ERR_peek_error_all(const char **file, int *line,
 301                                  const char **func,
 302                                  const char **data, int *flags);
 303 DEPRECATEDIN_3_0(unsigned long ERR_peek_error_line_data(const char **file,
 304                                                       int *line,
 305                                                       const char **data,
 306                                                       int *flags))
 307 unsigned long ERR_peek_last_error(void);
 308 unsigned long ERR_peek_last_error_line(const char **file, int *line);
 309 unsigned long ERR_peek_last_error_func(const char **func);
 310 unsigned long ERR_peek_last_error_data(const char **data, int *flags);
 311 unsigned long ERR_peek_last_error_all(const char **file, int *line,
 312                                       const char **func,
 313                                       const char **data, int *flags);
 314 DEPRECATEDIN_3_0(unsigned long ERR_peek_last_error_line_data(const char **file,
 315                                                            int *line,
 316                                                            const char **data,
 317                                                            int *flags))
 318
 319 void ERR_clear_error(void);
 320
 321 char *ERR_error_string(unsigned long e, char *buf);
 322 void ERR_error_string_n(unsigned long e, char *buf, size_t len);
 323 const char *ERR_lib_error_string(unsigned long e);
 324 DEPRECATEDIN_3_0(const char *ERR_func_error_string(unsigned long e))
 325 const char *ERR_reason_error_string(unsigned long e);
 326
 327 void ERR_print_errors_cb(int (*cb) (const char *str, size_t len, void *u),
 328                          void *u);
 329 # ifndef OPENSSL_NO_STDIO
 330 void ERR_print_errors_fp(FILE *fp);
 331 # endif
 332 void ERR_print_errors(BIO *bp);
 333
 334 void ERR_add_error_data(int num, ...);
 335 void ERR_add_error_vdata(int num, va_list args);
 336 void ERR_add_error_txt(const char *sepr, const char *txt);
 337 void ERR_add_error_mem_bio(const char *sep, BIO *bio);
 338
 339 int ERR_load_strings(int lib, ERR_STRING_DATA *str);
 340 int ERR_load_strings_const(const ERR_STRING_DATA *str);
 341 int ERR_unload_strings(int lib, ERR_STRING_DATA *str);
 342 int ERR_load_ERR_strings(void);
 343
 344 #ifndef OPENSSL_NO_DEPRECATED_1_1_0
 345 # define ERR_load_crypto_strings() \
 346     OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL)
 347 # define ERR_free_strings() while(0) continue
 348 #endif
 349
 350 DEPRECATEDIN_1_1_0(void ERR_remove_thread_state(void *))
 351 DEPRECATEDIN_1_0_0(void ERR_remove_state(unsigned long pid))
 352 DEPRECATEDIN_3_0(ERR_STATE *ERR_get_state(void))
 353
 354 int ERR_get_next_error_library(void);
 355
 356 int ERR_set_mark(void);
 357 int ERR_pop_to_mark(void);
 358 int ERR_clear_last_mark(void);
 359
 360 #ifdef  __cplusplus
 361 }
 362 #endif
 363
 364 #endif