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 <limits.h>
  43 # include <errno.h>
  44
  45 # define ERR_TXT_MALLOCED        0x01
  46 # define ERR_TXT_STRING          0x02
  47
  48 # if !defined(OPENSSL_NO_DEPRECATED_3_0) || defined(OSSL_FORCE_ERR_STATE)
  49 #  define ERR_FLAG_MARK           0x01
  50 #  define ERR_FLAG_CLEAR          0x02
  51
  52 #  define ERR_NUM_ERRORS  16
  53 struct err_state_st {
  54     int err_flags[ERR_NUM_ERRORS];
  55     unsigned long err_buffer[ERR_NUM_ERRORS];
  56     char *err_data[ERR_NUM_ERRORS];
  57     size_t err_data_size[ERR_NUM_ERRORS];
  58     int err_data_flags[ERR_NUM_ERRORS];
  59     const char *err_file[ERR_NUM_ERRORS];
  60     int err_line[ERR_NUM_ERRORS];
  61     const char *err_func[ERR_NUM_ERRORS];
  62     int top, bottom;
  63 };
  64 # endif
  65
  66 /* library */
  67 # define ERR_LIB_NONE            1
  68 # define ERR_LIB_SYS             2
  69 # define ERR_LIB_BN              3
  70 # define ERR_LIB_RSA             4
  71 # define ERR_LIB_DH              5
  72 # define ERR_LIB_EVP             6
  73 # define ERR_LIB_BUF             7
  74 # define ERR_LIB_OBJ             8
  75 # define ERR_LIB_PEM             9
  76 # define ERR_LIB_DSA             10
  77 # define ERR_LIB_X509            11
  78 /* #define ERR_LIB_METH         12 */
  79 # define ERR_LIB_ASN1            13
  80 # define ERR_LIB_CONF            14
  81 # define ERR_LIB_CRYPTO          15
  82 # define ERR_LIB_EC              16
  83 # define ERR_LIB_SSL             20
  84 /* #define ERR_LIB_SSL23        21 */
  85 /* #define ERR_LIB_SSL2         22 */
  86 /* #define ERR_LIB_SSL3         23 */
  87 /* #define ERR_LIB_RSAREF       30 */
  88 /* #define ERR_LIB_PROXY        31 */
  89 # define ERR_LIB_BIO             32
  90 # define ERR_LIB_PKCS7           33
  91 # define ERR_LIB_X509V3          34
  92 # define ERR_LIB_PKCS12          35
  93 # define ERR_LIB_RAND            36
  94 # define ERR_LIB_DSO             37
  95 # define ERR_LIB_ENGINE          38
  96 # define ERR_LIB_OCSP            39
  97 # define ERR_LIB_UI              40
  98 # define ERR_LIB_COMP            41
  99 # define ERR_LIB_ECDSA           42
 100 # define ERR_LIB_ECDH            43
 101 # define ERR_LIB_OSSL_STORE      44
 102 # define ERR_LIB_FIPS            45
 103 # define ERR_LIB_CMS             46
 104 # define ERR_LIB_TS              47
 105 # define ERR_LIB_HMAC            48
 106 /* # define ERR_LIB_JPAKE       49 */
 107 # define ERR_LIB_CT              50
 108 # define ERR_LIB_ASYNC           51
 109 # define ERR_LIB_KDF             52
 110 # define ERR_LIB_SM2             53
 111 # define ERR_LIB_ESS             54
 112 # define ERR_LIB_PROP            55
 113 # define ERR_LIB_CRMF            56
 114 # define ERR_LIB_PROV            57
 115 # define ERR_LIB_CMP             58
 116 # define ERR_LIB_OSSL_SERIALIZER 59
 117 # define ERR_LIB_OSSL_DESERIALIZER 60
 118 # define ERR_LIB_HTTP            61
 119
 120 # define ERR_LIB_USER            128
 121
 122 # if 1 || !defined(OPENSSL_NO_DEPRECATED_3_0)
 123 #  define ASN1err(f, r) ERR_raise_data(ERR_LIB_ASN1, (r), NULL)
 124 #  define ASYNCerr(f, r) ERR_raise_data(ERR_LIB_ASYNC, (r), NULL)
 125 #  define BIOerr(f, r) ERR_raise_data(ERR_LIB_BIO, (r), NULL)
 126 #  define BNerr(f, r)  ERR_raise_data(ERR_LIB_BN, (r), NULL)
 127 #  define BUFerr(f, r) ERR_raise_data(ERR_LIB_BUF, (r), NULL)
 128 #  define CMPerr(f, r) ERR_raise_data(ERR_LIB_CMP, (r), NULL)
 129 #  define CMSerr(f, r) ERR_raise_data(ERR_LIB_CMS, (r), NULL)
 130 #  define COMPerr(f, r) ERR_raise_data(ERR_LIB_COMP, (r), NULL)
 131 #  define CONFerr(f, r) ERR_raise_data(ERR_LIB_CONF, (r), NULL)
 132 #  define CRMFerr(f, r) ERR_raise_data(ERR_LIB_CRMF, (r), NULL)
 133 #  define CRYPTOerr(f, r) ERR_raise_data(ERR_LIB_CRYPTO, (r), NULL)
 134 #  define CTerr(f, r) ERR_raise_data(ERR_LIB_CT, (r), NULL)
 135 #  define DHerr(f, r)  ERR_raise_data(ERR_LIB_DH, (r), NULL)
 136 #  define DSAerr(f, r) ERR_raise_data(ERR_LIB_DSA, (r), NULL)
 137 #  define DSOerr(f, r) ERR_raise_data(ERR_LIB_DSO, (r), NULL)
 138 #  define ECDHerr(f, r) ERR_raise_data(ERR_LIB_ECDH, (r), NULL)
 139 #  define ECDSAerr(f, r) ERR_raise_data(ERR_LIB_ECDSA, (r), NULL)
 140 #  define ECerr(f, r)  ERR_raise_data(ERR_LIB_EC, (r), NULL)
 141 #  define ENGINEerr(f, r) ERR_raise_data(ERR_LIB_ENGINE, (r), NULL)
 142 #  define ESSerr(f, r) ERR_raise_data(ERR_LIB_ESS, (r), NULL)
 143 #  define EVPerr(f, r) ERR_raise_data(ERR_LIB_EVP, (r), NULL)
 144 #  define FIPSerr(f, r) ERR_raise_data(ERR_LIB_FIPS, (r), NULL)
 145 #  define HMACerr(f, r) ERR_raise_data(ERR_LIB_HMAC, (r), NULL)
 146 #  define HTTPerr(f, r) ERR_raise_data(ERR_LIB_HTTP, (r), NULL)
 147 #  define KDFerr(f, r) ERR_raise_data(ERR_LIB_KDF, (r), NULL)
 148 #  define OBJerr(f, r) ERR_raise_data(ERR_LIB_OBJ, (r), NULL)
 149 #  define OCSPerr(f, r) ERR_raise_data(ERR_LIB_OCSP, (r), NULL)
 150 #  define OSSL_STOREerr(f, r) ERR_raise_data(ERR_LIB_OSSL_STORE, (r), NULL)
 151 #  define PEMerr(f, r) ERR_raise_data(ERR_LIB_PEM, (r), NULL)
 152 #  define PKCS12err(f, r) ERR_raise_data(ERR_LIB_PKCS12, (r), NULL)
 153 #  define PKCS7err(f, r) ERR_raise_data(ERR_LIB_PKCS7, (r), NULL)
 154 #  define PROPerr(f, r) ERR_raise_data(ERR_LIB_PROP, (r), NULL)
 155 #  define PROVerr(f, r) ERR_raise_data(ERR_LIB_PROV, (r), NULL)
 156 #  define RANDerr(f, r) ERR_raise_data(ERR_LIB_RAND, (r), NULL)
 157 #  define RSAerr(f, r) ERR_raise_data(ERR_LIB_RSA, (r), NULL)
 158 #  define KDFerr(f, r) ERR_raise_data(ERR_LIB_KDF, (r), NULL)
 159 #  define SM2err(f, r) ERR_raise_data(ERR_LIB_SM2, (r), NULL)
 160 #  define SSLerr(f, r) ERR_raise_data(ERR_LIB_SSL, (r), NULL)
 161 #  define SYSerr(f, r) ERR_raise_data(ERR_LIB_SYS, (r), NULL)
 162 #  define TSerr(f, r) ERR_raise_data(ERR_LIB_TS, (r), NULL)
 163 #  define UIerr(f, r) ERR_raise_data(ERR_LIB_UI, (r), NULL)
 164 #  define X509V3err(f, r) ERR_raise_data(ERR_LIB_X509V3, (r), NULL)
 165 #  define X509err(f, r) ERR_raise_data(ERR_LIB_X509, (r), NULL)
 166 # endif
 167
 168 /*-
 169  * The error code packs differently depending on if it records a system
 170  * error or an OpenSSL error.
 171  *
 172  * A system error packs like this (we follow POSIX and only allow positive
 173  * numbers that fit in an |int|):
 174  *
 175  * +-+-------------------------------------------------------------+
 176  * |1|                     system error number                     |
 177  * +-+-------------------------------------------------------------+
 178  *
 179  * An OpenSSL error packs like this:
 180  *
 181  * <---------------------------- 32 bits -------------------------->
 182  *    <--- 8 bits ---><------------------ 23 bits ----------------->
 183  * +-+---------------+---------------------------------------------+
 184  * |0|    library    |                    reason                   |
 185  * +-+---------------+---------------------------------------------+
 186  *
 187  * A few of the reason bits are reserved as flags with special meaning:
 188  *
 189  *                    <4 bits><-------------- 19 bits ------------->
 190  *                   +-------+-------------------------------------+
 191  *                   | rflags|                reason               |
 192  *                   +-------+-------------------------------------+
 193  *
 194  * We have the reason flags being part of the overall reason code for
 195  * backward compatibility reasons, i.e. how ERR_R_FATAL was implemented.
 196  */
 197
 198 /* Macros to help decode recorded system errors */
 199 # define ERR_SYSTEM_FLAG                ((unsigned int)INT_MAX + 1)
 200 # define ERR_SYSTEM_MASK                ((unsigned int)INT_MAX)
 201
 202 /* Macros to help decode recorded OpenSSL errors */
 203 # define ERR_LIB_OFFSET                 23L
 204 # define ERR_LIB_MASK                   0xFF
 205 # define ERR_RFLAGS_OFFSET              19L
 206 # define ERR_RFLAGS_MASK                0xF
 207 # define ERR_REASON_MASK                0X7FFFFF
 208
 209 /*
 210  * Reason flags are defined pre-shifted to easily combine with the reason
 211  * number.
 212  */
 213 # define ERR_RFLAG_FATAL                (0x1 << ERR_RFLAGS_OFFSET)
 214
 215 # define ERR_SYSTEM_ERROR(errcode)      (((errcode) & ERR_SYSTEM_FLAG) != 0)
 216
 217 static ossl_inline int ERR_GET_LIB(unsigned long errcode)
 218 {
 219     if (ERR_SYSTEM_ERROR(errcode))
 220         return ERR_LIB_SYS;
 221     return (errcode >> ERR_LIB_OFFSET) & ERR_LIB_MASK;
 222 }
 223
 224 static ossl_inline int ERR_GET_FUNC(unsigned long errcode ossl_unused)
 225 {
 226     return 0;
 227 }
 228
 229 static ossl_inline int ERR_GET_RFLAGS(unsigned long errcode)
 230 {
 231     if (ERR_SYSTEM_ERROR(errcode))
 232         return 0;
 233     return errcode & (ERR_RFLAGS_MASK << ERR_RFLAGS_OFFSET);
 234 }
 235
 236 static ossl_inline int ERR_GET_REASON(unsigned long errcode)
 237 {
 238     if (ERR_SYSTEM_ERROR(errcode))
 239         return errcode & ERR_SYSTEM_MASK;
 240     return errcode & ERR_REASON_MASK;
 241 }
 242
 243 static ossl_inline int ERR_FATAL_ERROR(unsigned long errcode)
 244 {
 245     return (ERR_GET_RFLAGS(errcode) & ERR_RFLAG_FATAL) != 0;
 246 }
 247
 248 /*
 249  * ERR_PACK is a helper macro to properly pack OpenSSL error codes and may
 250  * only be used for that purpose.  System errors are packed internally.
 251  * ERR_PACK takes reason flags and reason code combined in |reason|.
 252  * ERR_PACK ignores |func|, that parameter is just legacy from pre-3.0 OpenSSL.
 253  */
 254 # define ERR_PACK(lib,func,reason)                                      \
 255     ( (((unsigned long)(lib)    & ERR_LIB_MASK   ) << ERR_LIB_OFFSET) | \
 256       (((unsigned long)(reason) & ERR_REASON_MASK)) )
 257
 258 # ifndef OPENSSL_NO_DEPRECATED_3_0
 259 #  define SYS_F_FOPEN             0
 260 #  define SYS_F_CONNECT           0
 261 #  define SYS_F_GETSERVBYNAME     0
 262 #  define SYS_F_SOCKET            0
 263 #  define SYS_F_IOCTLSOCKET       0
 264 #  define SYS_F_BIND              0
 265 #  define SYS_F_LISTEN            0
 266 #  define SYS_F_ACCEPT            0
 267 #  define SYS_F_WSASTARTUP        0
 268 #  define SYS_F_OPENDIR           0
 269 #  define SYS_F_FREAD             0
 270 #  define SYS_F_GETADDRINFO       0
 271 #  define SYS_F_GETNAMEINFO       0
 272 #  define SYS_F_SETSOCKOPT        0
 273 #  define SYS_F_GETSOCKOPT        0
 274 #  define SYS_F_GETSOCKNAME       0
 275 #  define SYS_F_GETHOSTBYNAME     0
 276 #  define SYS_F_FFLUSH            0
 277 #  define SYS_F_OPEN              0
 278 #  define SYS_F_CLOSE             0
 279 #  define SYS_F_IOCTL             0
 280 #  define SYS_F_STAT              0
 281 #  define SYS_F_FCNTL             0
 282 #  define SYS_F_FSTAT             0
 283 #  define SYS_F_SENDFILE          0
 284 # endif
 285
 286 /* "we came from here" global reason codes, range 1..63 */
 287 # define ERR_R_SYS_LIB   ERR_LIB_SYS/* 2 */
 288 # define ERR_R_BN_LIB    ERR_LIB_BN/* 3 */
 289 # define ERR_R_RSA_LIB   ERR_LIB_RSA/* 4 */
 290 # define ERR_R_DH_LIB    ERR_LIB_DH/* 5 */
 291 # define ERR_R_EVP_LIB   ERR_LIB_EVP/* 6 */
 292 # define ERR_R_BUF_LIB   ERR_LIB_BUF/* 7 */
 293 # define ERR_R_OBJ_LIB   ERR_LIB_OBJ/* 8 */
 294 # define ERR_R_PEM_LIB   ERR_LIB_PEM/* 9 */
 295 # define ERR_R_DSA_LIB   ERR_LIB_DSA/* 10 */
 296 # define ERR_R_X509_LIB  ERR_LIB_X509/* 11 */
 297 # define ERR_R_ASN1_LIB  ERR_LIB_ASN1/* 13 */
 298 # define ERR_R_EC_LIB    ERR_LIB_EC/* 16 */
 299 # define ERR_R_BIO_LIB   ERR_LIB_BIO/* 32 */
 300 # define ERR_R_PKCS7_LIB ERR_LIB_PKCS7/* 33 */
 301 # define ERR_R_X509V3_LIB ERR_LIB_X509V3/* 34 */
 302 # define ERR_R_ENGINE_LIB ERR_LIB_ENGINE/* 38 */
 303 # define ERR_R_UI_LIB    ERR_LIB_UI/* 40 */
 304 # define ERR_R_ECDSA_LIB ERR_LIB_ECDSA/* 42 */
 305 # define ERR_R_OSSL_STORE_LIB ERR_LIB_OSSL_STORE/* 44 */
 306
 307 /*
 308  * global reason codes, range 64..99 (sub-system specific codes start at 100)
 309  *
 310  * ERR_R_FATAL had dual purposes in pre-3.0 OpenSSL, as a standalone reason
 311  * code as well as a fatal flag.  This is still possible to do, as 2**6 (64)
 312  * is present in the whole range of global reason codes.
 313  */
 314 # define ERR_R_FATAL                             (64|ERR_RFLAG_FATAL)
 315 # define ERR_R_MALLOC_FAILURE                    (65|ERR_RFLAG_FATAL)
 316 # define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED       (66|ERR_RFLAG_FATAL)
 317 # define ERR_R_PASSED_NULL_PARAMETER             (67|ERR_RFLAG_FATAL)
 318 # define ERR_R_INTERNAL_ERROR                    (68|ERR_RFLAG_FATAL)
 319 # define ERR_R_DISABLED                          (69|ERR_RFLAG_FATAL)
 320 # define ERR_R_INIT_FAIL                         (70|ERR_RFLAG_FATAL)
 321 # define ERR_R_PASSED_INVALID_ARGUMENT           (71)
 322 # define ERR_R_OPERATION_FAIL                    (72|ERR_RFLAG_FATAL)
 323 # define ERR_R_INVALID_PROVIDER_FUNCTIONS        (73|ERR_RFLAG_FATAL)
 324 # define ERR_R_INTERRUPTED_OR_CANCELLED          (74)
 325 # define ERR_R_NESTED_ASN1_ERROR                 (76)
 326 # define ERR_R_MISSING_ASN1_EOS                  (77)
 327
 328 /*
 329  * 99 is the maximum possible ERR_R_... code, higher values are reserved for
 330  * the individual libraries
 331  */
 332
 333 typedef struct ERR_string_data_st {
 334     unsigned long error;
 335     const char *string;
 336 } ERR_STRING_DATA;
 337
 338 DEFINE_LHASH_OF(ERR_STRING_DATA);
 339
 340 /* 12 lines and some on an 80 column terminal */
 341 #define ERR_MAX_DATA_SIZE       1024
 342
 343 /* Building blocks */
 344 void ERR_new(void);
 345 void ERR_set_debug(const char *file, int line, const char *func);
 346 void ERR_set_error(int lib, int reason, const char *fmt, ...);
 347 void ERR_vset_error(int lib, int reason, const char *fmt, va_list args);
 348
 349 /* Main error raising functions */
 350 # define ERR_raise(lib, reason) ERR_raise_data((lib),(reason),NULL)
 351 # define ERR_raise_data                                         \
 352     (ERR_new(),                                                 \
 353      ERR_set_debug(OPENSSL_FILE,OPENSSL_LINE,OPENSSL_FUNC),     \
 354      ERR_set_error)
 355
 356 # ifndef OPENSSL_NO_DEPRECATED_3_0
 357 /* Backward compatibility */
 358 #  define ERR_put_error(lib, func, reason, file, line)          \
 359     (ERR_new(),                                                 \
 360      ERR_set_debug((file), (line), OPENSSL_FUNC),               \
 361      ERR_set_error((lib), (reason), NULL))
 362 # endif
 363
 364 void ERR_set_error_data(char *data, int flags);
 365
 366 unsigned long ERR_get_error(void);
 367 /*
 368  * TODO(3.0) consider if the following three functions should be deprecated.
 369  * They all drop the error record from the error queue, so regardless of which
 370  * one is used, the rest of the information is lost, making them not so useful.
 371  * The recommendation should be to use the peek functions to extract all the
 372  * additional data.
 373  */
 374 unsigned long ERR_get_error_line(const char **file, int *line);
 375 unsigned long ERR_get_error_func(const char **func);
 376 unsigned long ERR_get_error_data(const char **data, int *flags);
 377 unsigned long ERR_get_error_all(const char **file, int *line,
 378                                 const char **func,
 379                                 const char **data, int *flags);
 380 DEPRECATEDIN_3_0(unsigned long ERR_get_error_line_data(const char **file,
 381                                                      int *line,
 382                                                      const char **data,
 383                                                      int *flags))
 384 unsigned long ERR_peek_error(void);
 385 unsigned long ERR_peek_error_line(const char **file, int *line);
 386 unsigned long ERR_peek_error_func(const char **func);
 387 unsigned long ERR_peek_error_data(const char **data, int *flags);
 388 unsigned long ERR_peek_error_all(const char **file, int *line,
 389                                  const char **func,
 390                                  const char **data, int *flags);
 391 DEPRECATEDIN_3_0(unsigned long ERR_peek_error_line_data(const char **file,
 392                                                       int *line,
 393                                                       const char **data,
 394                                                       int *flags))
 395 unsigned long ERR_peek_last_error(void);
 396 unsigned long ERR_peek_last_error_line(const char **file, int *line);
 397 unsigned long ERR_peek_last_error_func(const char **func);
 398 unsigned long ERR_peek_last_error_data(const char **data, int *flags);
 399 unsigned long ERR_peek_last_error_all(const char **file, int *line,
 400                                       const char **func,
 401                                       const char **data, int *flags);
 402 DEPRECATEDIN_3_0(unsigned long ERR_peek_last_error_line_data(const char **file,
 403                                                            int *line,
 404                                                            const char **data,
 405                                                            int *flags))
 406
 407 void ERR_clear_error(void);
 408
 409 char *ERR_error_string(unsigned long e, char *buf);
 410 void ERR_error_string_n(unsigned long e, char *buf, size_t len);
 411 const char *ERR_lib_error_string(unsigned long e);
 412 DEPRECATEDIN_3_0(const char *ERR_func_error_string(unsigned long e))
 413 const char *ERR_reason_error_string(unsigned long e);
 414
 415 void ERR_print_errors_cb(int (*cb) (const char *str, size_t len, void *u),
 416                          void *u);
 417 # ifndef OPENSSL_NO_STDIO
 418 void ERR_print_errors_fp(FILE *fp);
 419 # endif
 420 void ERR_print_errors(BIO *bp);
 421
 422 void ERR_add_error_data(int num, ...);
 423 void ERR_add_error_vdata(int num, va_list args);
 424 void ERR_add_error_txt(const char *sepr, const char *txt);
 425 void ERR_add_error_mem_bio(const char *sep, BIO *bio);
 426
 427 int ERR_load_strings(int lib, ERR_STRING_DATA *str);
 428 int ERR_load_strings_const(const ERR_STRING_DATA *str);
 429 int ERR_unload_strings(int lib, ERR_STRING_DATA *str);
 430 int ERR_load_ERR_strings(void);
 431
 432 #ifndef OPENSSL_NO_DEPRECATED_1_1_0
 433 # define ERR_load_crypto_strings() \
 434     OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL)
 435 # define ERR_free_strings() while(0) continue
 436 #endif
 437
 438 DEPRECATEDIN_1_1_0(void ERR_remove_thread_state(void *))
 439 DEPRECATEDIN_1_0_0(void ERR_remove_state(unsigned long pid))
 440 DEPRECATEDIN_3_0(ERR_STATE *ERR_get_state(void))
 441
 442 int ERR_get_next_error_library(void);
 443
 444 int ERR_set_mark(void);
 445 int ERR_pop_to_mark(void);
 446 int ERR_clear_last_mark(void);
 447
 448 #ifdef  __cplusplus
 449 }
 450 #endif
 451
 452 #endif