Home | History | Annotate | Download | only in openssl
      1 /* Copyright (C) 1995-1998 Eric Young (eay (at) cryptsoft.com)
      2  * All rights reserved.
      3  *
      4  * This package is an SSL implementation written
      5  * by Eric Young (eay (at) cryptsoft.com).
      6  * The implementation was written so as to conform with Netscapes SSL.
      7  *
      8  * This library is free for commercial and non-commercial use as long as
      9  * the following conditions are aheared to.  The following conditions
     10  * apply to all code found in this distribution, be it the RC4, RSA,
     11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
     12  * included with this distribution is covered by the same copyright terms
     13  * except that the holder is Tim Hudson (tjh (at) cryptsoft.com).
     14  *
     15  * Copyright remains Eric Young's, and as such any Copyright notices in
     16  * the code are not to be removed.
     17  * If this package is used in a product, Eric Young should be given attribution
     18  * as the author of the parts of the library used.
     19  * This can be in the form of a textual message at program startup or
     20  * in documentation (online or textual) provided with the package.
     21  *
     22  * Redistribution and use in source and binary forms, with or without
     23  * modification, are permitted provided that the following conditions
     24  * are met:
     25  * 1. Redistributions of source code must retain the copyright
     26  *    notice, this list of conditions and the following disclaimer.
     27  * 2. Redistributions in binary form must reproduce the above copyright
     28  *    notice, this list of conditions and the following disclaimer in the
     29  *    documentation and/or other materials provided with the distribution.
     30  * 3. All advertising materials mentioning features or use of this software
     31  *    must display the following acknowledgement:
     32  *    "This product includes cryptographic software written by
     33  *     Eric Young (eay (at) cryptsoft.com)"
     34  *    The word 'cryptographic' can be left out if the rouines from the library
     35  *    being used are not cryptographic related :-).
     36  * 4. If you include any Windows specific code (or a derivative thereof) from
     37  *    the apps directory (application code) you must include an acknowledgement:
     38  *    "This product includes software written by Tim Hudson (tjh (at) cryptsoft.com)"
     39  *
     40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
     41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
     44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     50  * SUCH DAMAGE.
     51  *
     52  * The licence and distribution terms for any publically available version or
     53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
     54  * copied and put under another distribution licence
     55  * [including the GNU Public Licence.]
     56  */
     57 /* ====================================================================
     58  * Copyright (c) 1998-2006 The OpenSSL Project.  All rights reserved.
     59  *
     60  * Redistribution and use in source and binary forms, with or without
     61  * modification, are permitted provided that the following conditions
     62  * are met:
     63  *
     64  * 1. Redistributions of source code must retain the above copyright
     65  *    notice, this list of conditions and the following disclaimer.
     66  *
     67  * 2. Redistributions in binary form must reproduce the above copyright
     68  *    notice, this list of conditions and the following disclaimer in
     69  *    the documentation and/or other materials provided with the
     70  *    distribution.
     71  *
     72  * 3. All advertising materials mentioning features or use of this
     73  *    software must display the following acknowledgment:
     74  *    "This product includes software developed by the OpenSSL Project
     75  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
     76  *
     77  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
     78  *    endorse or promote products derived from this software without
     79  *    prior written permission. For written permission, please contact
     80  *    openssl-core (at) openssl.org.
     81  *
     82  * 5. Products derived from this software may not be called "OpenSSL"
     83  *    nor may "OpenSSL" appear in their names without prior written
     84  *    permission of the OpenSSL Project.
     85  *
     86  * 6. Redistributions of any form whatsoever must retain the following
     87  *    acknowledgment:
     88  *    "This product includes software developed by the OpenSSL Project
     89  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
     90  *
     91  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
     92  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     93  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     94  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
     95  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     96  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     97  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     98  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     99  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
    100  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    101  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
    102  * OF THE POSSIBILITY OF SUCH DAMAGE.
    103  * ====================================================================
    104  *
    105  * This product includes cryptographic software written by Eric Young
    106  * (eay (at) cryptsoft.com).  This product includes software written by Tim
    107  * Hudson (tjh (at) cryptsoft.com). */
    108 
    109 #ifndef OPENSSL_HEADER_ERR_H
    110 #define OPENSSL_HEADER_ERR_H
    111 
    112 #include <stdio.h>
    113 
    114 #include <openssl/base.h>
    115 
    116 #if defined(__cplusplus)
    117 extern "C" {
    118 #endif
    119 
    120 
    121 /* Error queue handling functions.
    122  *
    123  * Errors in OpenSSL are generally signalled by the return value of a function.
    124  * When a function fails it may add an entry to a per-thread error queue,
    125  * which is managed by the functions in this header.
    126  *
    127  * Each error contains:
    128  *   1) The library (i.e. ec, pem, rsa) which created it.
    129  *   2) The file and line number of the call that added the error.
    130  *   3) A pointer to some error specific data, which may be NULL.
    131  *
    132  * The library identifier and reason code are packed in a uint32_t and there
    133  * exist various functions for unpacking it.
    134  *
    135  * The typical behaviour is that an error will occur deep in a call queue and
    136  * that code will push an error onto the error queue. As the error queue
    137  * unwinds, other functions will push their own errors. Thus, the "least
    138  * recent" error is the most specific and the other errors will provide a
    139  * backtrace of sorts. */
    140 
    141 
    142 /* Startup and shutdown. */
    143 
    144 /* ERR_load_BIO_strings does nothing.
    145  *
    146  * TODO(fork): remove. libjingle calls this. */
    147 OPENSSL_EXPORT void ERR_load_BIO_strings(void);
    148 
    149 /* ERR_load_ERR_strings does nothing. */
    150 OPENSSL_EXPORT void ERR_load_ERR_strings(void);
    151 
    152 /* ERR_load_crypto_strings does nothing. */
    153 OPENSSL_EXPORT void ERR_load_crypto_strings(void);
    154 
    155 /* ERR_free_strings does nothing. */
    156 OPENSSL_EXPORT void ERR_free_strings(void);
    157 
    158 
    159 /* Reading and formatting errors. */
    160 
    161 /* ERR_get_error gets the packed error code for the least recent error and
    162  * removes that error from the queue. If there are no errors in the queue then
    163  * it returns zero. */
    164 OPENSSL_EXPORT uint32_t ERR_get_error(void);
    165 
    166 /* ERR_get_error_line acts like |ERR_get_error|, except that the file and line
    167  * number of the call that added the error are also returned. */
    168 OPENSSL_EXPORT uint32_t ERR_get_error_line(const char **file, int *line);
    169 
    170 /* ERR_get_error_line_data acts like |ERR_get_error_line|, but also returns the
    171  * error-specific data pointer and flags. The flags are a bitwise-OR of
    172  * |ERR_FLAG_*| values. The error-specific data is owned by the error queue
    173  * and the pointer becomes invalid after the next call that affects the same
    174  * thread's error queue. If |*flags| contains |ERR_FLAG_STRING| then |*data| is
    175  * human-readable. */
    176 OPENSSL_EXPORT uint32_t ERR_get_error_line_data(const char **file, int *line,
    177                                                 const char **data, int *flags);
    178 
    179 /* The "peek" functions act like the |ERR_get_error| functions, above, but they
    180  * do not remove the error from the queue. */
    181 OPENSSL_EXPORT uint32_t ERR_peek_error(void);
    182 OPENSSL_EXPORT uint32_t ERR_peek_error_line(const char **file, int *line);
    183 OPENSSL_EXPORT uint32_t ERR_peek_error_line_data(const char **file, int *line,
    184                                                  const char **data, int *flags);
    185 
    186 /* The "peek last" functions act like the "peek" functions, above, except that
    187  * they return the most recent error. */
    188 OPENSSL_EXPORT uint32_t ERR_peek_last_error(void);
    189 OPENSSL_EXPORT uint32_t ERR_peek_last_error_line(const char **file, int *line);
    190 OPENSSL_EXPORT uint32_t ERR_peek_last_error_line_data(const char **file,
    191                                                       int *line,
    192                                                       const char **data,
    193                                                       int *flags);
    194 
    195 /* ERR_error_string generates a human-readable string representing
    196  * |packed_error|, places it at |buf| (which must be at least
    197  * ERR_ERROR_STRING_BUF_LEN bytes long) and returns |buf|. If |buf| is NULL,
    198  * the error string is placed in a static buffer which is returned. (The static
    199  * buffer may be overridden by concurrent calls in other threads so this form
    200  * is deprecated.)
    201  *
    202  * The string will have the following format:
    203  *
    204  *   error:[error code]:[library name]:OPENSSL_internal:[reason string]
    205  *
    206  * error code is an 8 digit hexadecimal number; library name and reason string
    207  * are ASCII text.
    208  *
    209  * TODO(fork): remove in favour of |ERR_error_string_n|. */
    210 OPENSSL_EXPORT char *ERR_error_string(uint32_t packed_error, char *buf);
    211 #define ERR_ERROR_STRING_BUF_LEN 256
    212 
    213 /* ERR_error_string_n is a variant of |ERR_error_string| that writes at most
    214  * len characters (including the terminating NUL) and truncates the string if
    215  * necessary. If |len| is greater than zero then |buf| is always NUL
    216  * terminated. */
    217 OPENSSL_EXPORT void ERR_error_string_n(uint32_t packed_error, char *buf,
    218                                        size_t len);
    219 
    220 /* ERR_lib_error_string returns a string representation of the library that
    221  * generated |packed_error|. */
    222 OPENSSL_EXPORT const char *ERR_lib_error_string(uint32_t packed_error);
    223 
    224 /* ERR_reason_error_string returns a string representation of the reason for
    225  * |packed_error|. */
    226 OPENSSL_EXPORT const char *ERR_reason_error_string(uint32_t packed_error);
    227 
    228 /* ERR_print_errors_callback_t is the type of a function used by
    229  * |ERR_print_errors_cb|. It takes a pointer to a human readable string (and
    230  * its length) that describes an entry in the error queue. The |ctx| argument
    231  * is an opaque pointer given to |ERR_print_errors_cb|.
    232  *
    233  * It should return one on success or zero on error, which will stop the
    234  * iteration over the error queue. */
    235 typedef int (*ERR_print_errors_callback_t)(const char *str, size_t len,
    236                                            void *ctx);
    237 
    238 /* ERR_print_errors_cb calls |callback| with a string representation of each
    239  * error in the current thread's error queue, from the least recent to the most
    240  * recent error.
    241  *
    242  * The string will have the following format (which differs from
    243  * |ERR_error_string|):
    244  *
    245  *   [thread id]:error:[error code]:[library name]:OPENSSL_internal:
    246  *   [reason string]:[file]:[line number]:[optional string data]
    247  *
    248  * (All in one line.)
    249  *
    250  * The callback can return one to continue the iteration or zero to stop it.
    251  * The |ctx| argument is an opaque value that is passed through to the
    252  * callback. */
    253 OPENSSL_EXPORT void ERR_print_errors_cb(ERR_print_errors_callback_t callback,
    254                                         void *ctx);
    255 
    256 /* ERR_print_errors_fp prints the current contents of the error stack to |file|
    257  * using human readable strings where possible. */
    258 OPENSSL_EXPORT void ERR_print_errors_fp(FILE *file);
    259 
    260 
    261 /* Clearing errors. */
    262 
    263 /* ERR_clear_error clears the error queue for the current thread. */
    264 OPENSSL_EXPORT void ERR_clear_error(void);
    265 
    266 /* ERR_remove_thread_state clears the error queue for the current thread if
    267  * |tid| is NULL. Otherwise it calls |assert(0)|, because it's no longer
    268  * possible to delete the error queue for other threads.
    269  *
    270  * Error queues are thread-local data and are deleted automatically. You do not
    271  * need to call this function. Use |ERR_clear_error|. */
    272 OPENSSL_EXPORT void ERR_remove_thread_state(const CRYPTO_THREADID *tid);
    273 
    274 
    275 /* Custom errors. */
    276 
    277 /* ERR_get_next_error_library returns a value suitable for passing as the
    278  * |library| argument to |ERR_put_error|. This is intended for code that wishes
    279  * to push its own, non-standard errors to the error queue. */
    280 OPENSSL_EXPORT int ERR_get_next_error_library(void);
    281 
    282 
    283 /* Deprecated functions. */
    284 
    285 /* ERR_remove_state calls |ERR_clear_error|. */
    286 OPENSSL_EXPORT void ERR_remove_state(unsigned long pid);
    287 
    288 /* ERR_func_error_string returns the string "OPENSSL_internal". */
    289 OPENSSL_EXPORT const char *ERR_func_error_string(uint32_t packed_error);
    290 
    291 
    292 /* Private functions. */
    293 
    294 /* ERR_clear_system_error clears the system's error value (i.e. errno). */
    295 OPENSSL_EXPORT void ERR_clear_system_error(void);
    296 
    297 /* OPENSSL_PUT_ERROR is used by OpenSSL code to add an error to the error
    298  * queue. */
    299 #define OPENSSL_PUT_ERROR(library, reason) \
    300   ERR_put_error(ERR_LIB_##library, 0, reason, __FILE__, __LINE__)
    301 
    302 /* OPENSSL_PUT_SYSTEM_ERROR is used by OpenSSL code to add an error from the
    303  * operating system to the error queue.
    304  * TODO(fork): include errno. */
    305 #define OPENSSL_PUT_SYSTEM_ERROR() \
    306   ERR_put_error(ERR_LIB_SYS, 0, 0, __FILE__, __LINE__);
    307 
    308 /* ERR_put_error adds an error to the error queue, dropping the least recent
    309  * error if neccessary for space reasons. */
    310 OPENSSL_EXPORT void ERR_put_error(int library, int unused, int reason,
    311                                   const char *file, unsigned line);
    312 
    313 /* ERR_add_error_data takes a variable number (|count|) of const char*
    314  * pointers, concatenates them and sets the result as the data on the most
    315  * recent error. */
    316 OPENSSL_EXPORT void ERR_add_error_data(unsigned count, ...);
    317 
    318 /* ERR_add_error_dataf takes a printf-style format and arguments, and sets the
    319  * result as the data on the most recent error. */
    320 OPENSSL_EXPORT void ERR_add_error_dataf(const char *format, ...);
    321 
    322 /* ERR_set_mark "marks" the most recent error for use with |ERR_pop_to_mark|.
    323  * It returns one if an error was marked and zero if there are no errors. */
    324 OPENSSL_EXPORT int ERR_set_mark(void);
    325 
    326 /* ERR_pop_to_mark removes errors from the most recent to the least recent
    327  * until (and not including) a "marked" error. It returns zero if no marked
    328  * error was found (and thus all errors were removed) and one otherwise. Errors
    329  * are marked using |ERR_set_mark|. */
    330 OPENSSL_EXPORT int ERR_pop_to_mark(void);
    331 
    332 struct err_error_st {
    333   /* file contains the filename where the error occured. */
    334   const char *file;
    335   /* data contains optional data. It must be freed with |OPENSSL_free| if
    336    * |flags&ERR_FLAG_MALLOCED|. */
    337   char *data;
    338   /* packed contains the error library and reason, as packed by ERR_PACK. */
    339   uint32_t packed;
    340   /* line contains the line number where the error occured. */
    341   uint16_t line;
    342   /* flags contains a bitwise-OR of ERR_FLAG_* values. */
    343   uint8_t flags;
    344 };
    345 
    346 /* ERR_FLAG_STRING means that the |data| member is a NUL-terminated string that
    347  * can be printed. */
    348 #define ERR_FLAG_STRING 1
    349 /* ERR_TXT_STRING is provided for compatibility with code that assumes that
    350  * it's using OpenSSL. */
    351 #define ERR_TXT_STRING ERR_FLAG_STRING
    352 
    353 /* ERR_FLAG_PUBLIC_MASK is applied to the flags field before it is returned
    354  * from functions like |ERR_get_error_line_data|. */
    355 #define ERR_FLAG_PUBLIC_MASK 0xf
    356 
    357 /* The following flag values are internal and are masked when flags are
    358  * returned from functions like |ERR_get_error_line_data|. */
    359 
    360 /* ERR_FLAG_MALLOCED means the the |data| member must be freed when no longer
    361  * needed. */
    362 #define ERR_FLAG_MALLOCED 16
    363 /* ERR_FLAG_MARK is used to indicate a reversion point in the queue. See
    364  * |ERR_pop_to_mark|. */
    365 #define ERR_FLAG_MARK 32
    366 
    367 /* ERR_NUM_ERRORS is the limit of the number of errors in the queue. */
    368 #define ERR_NUM_ERRORS 16
    369 
    370 /* ERR_STATE contains the per-thread, error queue. */
    371 typedef struct err_state_st {
    372   /* errors contains the ERR_NUM_ERRORS most recent errors, organised as a ring
    373    * buffer. */
    374   struct err_error_st errors[ERR_NUM_ERRORS];
    375   /* top contains the index one past the most recent error. If |top| equals
    376    * |bottom| then the queue is empty. */
    377   unsigned top;
    378   /* bottom contains the index of the last error in the queue. */
    379   unsigned bottom;
    380 
    381   /* to_free, if not NULL, contains a pointer owned by this structure that was
    382    * previously a |data| pointer of one of the elements of |errors|. */
    383   void *to_free;
    384 } ERR_STATE;
    385 
    386 enum {
    387   ERR_LIB_NONE = 1,
    388   ERR_LIB_SYS,
    389   ERR_LIB_BN,
    390   ERR_LIB_RSA,
    391   ERR_LIB_DH,
    392   ERR_LIB_EVP,
    393   ERR_LIB_BUF,
    394   ERR_LIB_OBJ,
    395   ERR_LIB_PEM,
    396   ERR_LIB_DSA,
    397   ERR_LIB_X509,
    398   ERR_LIB_ASN1,
    399   ERR_LIB_CONF,
    400   ERR_LIB_CRYPTO,
    401   ERR_LIB_EC,
    402   ERR_LIB_SSL,
    403   ERR_LIB_BIO,
    404   ERR_LIB_PKCS7,
    405   ERR_LIB_PKCS8,
    406   ERR_LIB_X509V3,
    407   ERR_LIB_RAND,
    408   ERR_LIB_ENGINE,
    409   ERR_LIB_OCSP,
    410   ERR_LIB_UI,
    411   ERR_LIB_COMP,
    412   ERR_LIB_ECDSA,
    413   ERR_LIB_ECDH,
    414   ERR_LIB_HMAC,
    415   ERR_LIB_DIGEST,
    416   ERR_LIB_CIPHER,
    417   ERR_LIB_HKDF,
    418   ERR_LIB_USER,
    419   ERR_NUM_LIBS
    420 };
    421 
    422 #define ERR_R_SYS_LIB ERR_LIB_SYS
    423 #define ERR_R_BN_LIB ERR_LIB_BN
    424 #define ERR_R_RSA_LIB ERR_LIB_RSA
    425 #define ERR_R_DH_LIB ERR_LIB_DH
    426 #define ERR_R_EVP_LIB ERR_LIB_EVP
    427 #define ERR_R_BUF_LIB ERR_LIB_BUF
    428 #define ERR_R_OBJ_LIB ERR_LIB_OBJ
    429 #define ERR_R_PEM_LIB ERR_LIB_PEM
    430 #define ERR_R_DSA_LIB ERR_LIB_DSA
    431 #define ERR_R_X509_LIB ERR_LIB_X509
    432 #define ERR_R_ASN1_LIB ERR_LIB_ASN1
    433 #define ERR_R_CONF_LIB ERR_LIB_CONF
    434 #define ERR_R_CRYPTO_LIB ERR_LIB_CRYPTO
    435 #define ERR_R_EC_LIB ERR_LIB_EC
    436 #define ERR_R_SSL_LIB ERR_LIB_SSL
    437 #define ERR_R_BIO_LIB ERR_LIB_BIO
    438 #define ERR_R_PKCS7_LIB ERR_LIB_PKCS7
    439 #define ERR_R_PKCS8_LIB ERR_LIB_PKCS8
    440 #define ERR_R_X509V3_LIB ERR_LIB_X509V3
    441 #define ERR_R_RAND_LIB ERR_LIB_RAND
    442 #define ERR_R_DSO_LIB ERR_LIB_DSO
    443 #define ERR_R_ENGINE_LIB ERR_LIB_ENGINE
    444 #define ERR_R_OCSP_LIB ERR_LIB_OCSP
    445 #define ERR_R_UI_LIB ERR_LIB_UI
    446 #define ERR_R_COMP_LIB ERR_LIB_COMP
    447 #define ERR_R_ECDSA_LIB ERR_LIB_ECDSA
    448 #define ERR_R_ECDH_LIB ERR_LIB_ECDH
    449 #define ERR_R_STORE_LIB ERR_LIB_STORE
    450 #define ERR_R_FIPS_LIB ERR_LIB_FIPS
    451 #define ERR_R_CMS_LIB ERR_LIB_CMS
    452 #define ERR_R_TS_LIB ERR_LIB_TS
    453 #define ERR_R_HMAC_LIB ERR_LIB_HMAC
    454 #define ERR_R_JPAKE_LIB ERR_LIB_JPAKE
    455 #define ERR_R_USER_LIB ERR_LIB_USER
    456 #define ERR_R_DIGEST_LIB ERR_LIB_DIGEST
    457 #define ERR_R_CIPHER_LIB ERR_LIB_CIPHER
    458 #define ERR_R_HKDF_LIB ERR_LIB_HKDF
    459 
    460 /* Global reasons. */
    461 #define ERR_R_FATAL 64
    462 #define ERR_R_MALLOC_FAILURE (1 | ERR_R_FATAL)
    463 #define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED (2 | ERR_R_FATAL)
    464 #define ERR_R_PASSED_NULL_PARAMETER (3 | ERR_R_FATAL)
    465 #define ERR_R_INTERNAL_ERROR (4 | ERR_R_FATAL)
    466 #define ERR_R_OVERFLOW (5 | ERR_R_FATAL)
    467 
    468 #define ERR_PACK(lib, reason)                                              \
    469   (((((uint32_t)lib) & 0xff) << 24) | ((((uint32_t)reason) & 0xfff)))
    470 
    471 #define ERR_GET_LIB(packed_error) ((int)(((packed_error) >> 24) & 0xff))
    472 #define ERR_GET_FUNC(packed_error) 0
    473 #define ERR_GET_REASON(packed_error) ((int)((packed_error) & 0xfff))
    474 
    475 /* OPENSSL_DECLARE_ERROR_REASON is used by util/make_errors.h (which generates
    476  * the error defines) to recognise that an additional reason value is needed.
    477  * This is needed when the reason value is used outside of an
    478  * |OPENSSL_PUT_ERROR| macro. The resulting define will be
    479  * ${lib}_R_${reason}. */
    480 #define OPENSSL_DECLARE_ERROR_REASON(lib, reason)
    481 
    482 
    483 #if defined(__cplusplus)
    484 } /* extern C */
    485 #endif
    486 
    487 #endif /* OPENSSL_HEADER_ERR_H */
    488