This changes the "ERR" code to have all access to state (a hash table of
[openssl.git] / crypto / err / err.h
index aa3354e2ddaaafc7f5977d9cb7bcf1a04ae026d3..70a3566f4cb5b92c37303ee965569fec689229b3 100644 (file)
@@ -1,5 +1,5 @@
 /* crypto/err/err.h */
-/* Copyright (C) 1995-1997 Eric Young (eay@cryptsoft.com)
+/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
  * All rights reserved.
  *
  * This package is an SSL implementation written
 #ifndef HEADER_ERR_H
 #define HEADER_ERR_H
 
-#ifdef __cplusplus
-extern "C" {
+#ifndef OPENSSL_NO_FP_API
+#include <stdio.h>
+#include <stdlib.h>
 #endif
 
-/* The following is a bit of a trick to help the object files only contain
- * the 'name of the file' string once.  Since 'err.h' is protected by the
- * HEADER_ERR_H stuff, this should be included only once per file. */
+#ifndef OPENSSL_NO_BIO
+#include <openssl/bio.h>
+#endif
+#ifndef OPENSSL_NO_LHASH
+#include <openssl/lhash.h>
+#endif
 
-#define ERR_file_name  __FILE__
+#ifdef __cplusplus
+extern "C" {
+#endif
 
-#ifndef NO_ERR
+#ifndef OPENSSL_NO_ERR
 #define ERR_PUT_error(a,b,c,d,e)       ERR_put_error(a,b,c,d,e)
 #else
 #define ERR_PUT_error(a,b,c,d,e)       ERR_put_error(a,b,c,NULL,0)
@@ -77,12 +83,17 @@ extern "C" {
 
 #include <errno.h>
 
-#define ERR_NUM_ERRORS 10
+#define ERR_TXT_MALLOCED       0x01
+#define ERR_TXT_STRING         0x02
+
+#define ERR_NUM_ERRORS 16
 typedef struct err_state_st
        {
        unsigned long pid;
        unsigned long err_buffer[ERR_NUM_ERRORS];
-       char *err_file[ERR_NUM_ERRORS];
+       char *err_data[ERR_NUM_ERRORS];
+       int err_data_flags[ERR_NUM_ERRORS];
+       const char *err_file[ERR_NUM_ERRORS];
        int err_line[ERR_NUM_ERRORS];
        int top,bottom;
        } ERR_STATE;
@@ -99,41 +110,53 @@ typedef struct err_state_st
 #define ERR_LIB_PEM            9
 #define ERR_LIB_DSA            10
 #define ERR_LIB_X509           11
-#define ERR_LIB_METH           12
+/* #define ERR_LIB_METH         12 */
 #define ERR_LIB_ASN1           13
 #define ERR_LIB_CONF           14
+#define ERR_LIB_CRYPTO         15
+#define ERR_LIB_EC             16
 #define ERR_LIB_SSL            20
-#define ERR_LIB_SSL23          21
-#define ERR_LIB_SSL2           22
-#define ERR_LIB_SSL3           23
-#define ERR_LIB_RSAREF         30
-#define ERR_LIB_PROXY          31
+/* #define ERR_LIB_SSL23        21 */
+/* #define ERR_LIB_SSL2         22 */
+/* #define ERR_LIB_SSL3         23 */
+/* #define ERR_LIB_RSAREF       30 */
+/* #define ERR_LIB_PROXY        31 */
 #define ERR_LIB_BIO            32
 #define ERR_LIB_PKCS7          33
+#define ERR_LIB_X509V3         34
+#define ERR_LIB_PKCS12         35
+#define ERR_LIB_RAND           36
+#define ERR_LIB_DSO            37
+#define ERR_LIB_ENGINE         38
+#define ERR_LIB_OCSP            39
+#define ERR_LIB_UI              40
 
 #define ERR_LIB_USER           128
 
-#define SYSerr(f,r)    ERR_PUT_error(ERR_LIB_SYS,(f),(r),ERR_file_name,__LINE__)
-#define BNerr(f,r)     ERR_PUT_error(ERR_LIB_BN,(f),(r),ERR_file_name,__LINE__)
-#define RSAerr(f,r)    ERR_PUT_error(ERR_LIB_RSA,(f),(r),ERR_file_name,__LINE__)
-#define DHerr(f,r)     ERR_PUT_error(ERR_LIB_DH,(f),(r),ERR_file_name,__LINE__)
-#define EVPerr(f,r)    ERR_PUT_error(ERR_LIB_EVP,(f),(r),ERR_file_name,__LINE__)
-#define BUFerr(f,r)    ERR_PUT_error(ERR_LIB_BUF,(f),(r),ERR_file_name,__LINE__)
-#define BIOerr(f,r)    ERR_PUT_error(ERR_LIB_BIO,(f),(r),ERR_file_name,__LINE__)
-#define OBJerr(f,r)    ERR_PUT_error(ERR_LIB_OBJ,(f),(r),ERR_file_name,__LINE__)
-#define PEMerr(f,r)    ERR_PUT_error(ERR_LIB_PEM,(f),(r),ERR_file_name,__LINE__)
-#define DSAerr(f,r)    ERR_PUT_error(ERR_LIB_DSA,(f),(r),ERR_file_name,__LINE__)
-#define X509err(f,r)   ERR_PUT_error(ERR_LIB_X509,(f),(r),ERR_file_name,__LINE__)
-#define METHerr(f,r)   ERR_PUT_error(ERR_LIB_METH,(f),(r),ERR_file_name,__LINE__)
-#define ASN1err(f,r)   ERR_PUT_error(ERR_LIB_ASN1,(f),(r),ERR_file_name,__LINE__)
-#define CONFerr(f,r)   ERR_PUT_error(ERR_LIB_CONF,(f),(r),ERR_file_name,__LINE__)
-#define SSLerr(f,r)    ERR_PUT_error(ERR_LIB_SSL,(f),(r),ERR_file_name,__LINE__)
-#define SSL23err(f,r)  ERR_PUT_error(ERR_LIB_SSL23,(f),(r),ERR_file_name,__LINE__)
-#define SSL2err(f,r)   ERR_PUT_error(ERR_LIB_SSL2,(f),(r),ERR_file_name,__LINE__)
-#define SSL3err(f,r)   ERR_PUT_error(ERR_LIB_SSL3,(f),(r),ERR_file_name,__LINE__)
-#define RSAREFerr(f,r) ERR_PUT_error(ERR_LIB_RSAREF,(f),(r),ERR_file_name,__LINE__)
-#define PROXYerr(f,r)  ERR_PUT_error(ERR_LIB_PROXY,(f),(r),ERR_file_name,__LINE__)
-#define PKCS7err(f,r)  ERR_PUT_error(ERR_LIB_PKCS7,(f),(r),ERR_file_name,__LINE__)
+#define SYSerr(f,r)  ERR_PUT_error(ERR_LIB_SYS,(f),(r),__FILE__,__LINE__)
+#define BNerr(f,r)   ERR_PUT_error(ERR_LIB_BN,(f),(r),__FILE__,__LINE__)
+#define RSAerr(f,r)  ERR_PUT_error(ERR_LIB_RSA,(f),(r),__FILE__,__LINE__)
+#define DHerr(f,r)   ERR_PUT_error(ERR_LIB_DH,(f),(r),__FILE__,__LINE__)
+#define EVPerr(f,r)  ERR_PUT_error(ERR_LIB_EVP,(f),(r),__FILE__,__LINE__)
+#define BUFerr(f,r)  ERR_PUT_error(ERR_LIB_BUF,(f),(r),__FILE__,__LINE__)
+#define OBJerr(f,r)  ERR_PUT_error(ERR_LIB_OBJ,(f),(r),__FILE__,__LINE__)
+#define PEMerr(f,r)  ERR_PUT_error(ERR_LIB_PEM,(f),(r),__FILE__,__LINE__)
+#define DSAerr(f,r)  ERR_PUT_error(ERR_LIB_DSA,(f),(r),__FILE__,__LINE__)
+#define X509err(f,r) ERR_PUT_error(ERR_LIB_X509,(f),(r),__FILE__,__LINE__)
+#define ASN1err(f,r) ERR_PUT_error(ERR_LIB_ASN1,(f),(r),__FILE__,__LINE__)
+#define CONFerr(f,r) ERR_PUT_error(ERR_LIB_CONF,(f),(r),__FILE__,__LINE__)
+#define CRYPTOerr(f,r) ERR_PUT_error(ERR_LIB_CRYPTO,(f),(r),__FILE__,__LINE__)
+#define ECerr(f,r)   ERR_PUT_error(ERR_LIB_EC,(f),(r),__FILE__,__LINE__)
+#define SSLerr(f,r)  ERR_PUT_error(ERR_LIB_SSL,(f),(r),__FILE__,__LINE__)
+#define BIOerr(f,r)  ERR_PUT_error(ERR_LIB_BIO,(f),(r),__FILE__,__LINE__)
+#define PKCS7err(f,r) ERR_PUT_error(ERR_LIB_PKCS7,(f),(r),__FILE__,__LINE__)
+#define X509V3err(f,r) ERR_PUT_error(ERR_LIB_X509V3,(f),(r),__FILE__,__LINE__)
+#define PKCS12err(f,r) ERR_PUT_error(ERR_LIB_PKCS12,(f),(r),__FILE__,__LINE__)
+#define RANDerr(f,r) ERR_PUT_error(ERR_LIB_RAND,(f),(r),__FILE__,__LINE__)
+#define DSOerr(f,r) ERR_PUT_error(ERR_LIB_DSO,(f),(r),__FILE__,__LINE__)
+#define ENGINEerr(f,r) ERR_PUT_error(ERR_LIB_ENGINE,(f),(r),__FILE__,__LINE__)
+#define OCSPerr(f,r) ERR_PUT_error(ERR_LIB_OCSP,(f),(r),__FILE__,__LINE__)
+#define UIerr(f,r) ERR_PUT_error(ERR_LIB_UI,(f),(r),__FILE__,__LINE__)
 
 /* Borland C seems too stupid to be able to shift and do longs in
  * the pre-processor :-( */
@@ -145,7 +168,8 @@ typedef struct err_state_st
 #define ERR_GET_REASON(l)      (int)((l)&0xfffL)
 #define ERR_FATAL_ERROR(l)     (int)((l)&ERR_R_FATAL)
 
-/* OS fuctions */
+
+/* OS functions */
 #define SYS_F_FOPEN            1
 #define SYS_F_CONNECT          2
 #define SYS_F_GETSERVBYNAME    3
@@ -155,108 +179,109 @@ typedef struct err_state_st
 #define SYS_F_LISTEN           7
 #define SYS_F_ACCEPT           8
 #define SYS_F_WSASTARTUP       9 /* Winsock stuff */
+#define SYS_F_OPENDIR          10
+
 
-#define ERR_R_FATAL            32      
 /* reasons */
-#define ERR_R_SYS_LIB  ERR_LIB_SYS
-#define ERR_R_BN_LIB   ERR_LIB_BN
-#define ERR_R_RSA_LIB  ERR_LIB_RSA
-#define ERR_R_DSA_LIB  ERR_LIB_DSA
-#define ERR_R_DH_LIB   ERR_LIB_DH
-#define ERR_R_EVP_LIB  ERR_LIB_EVP
-#define ERR_R_BUF_LIB  ERR_LIB_BUF
-#define ERR_R_BIO_LIB  ERR_LIB_BIO
-#define ERR_R_OBJ_LIB  ERR_LIB_OBJ
-#define ERR_R_PEM_LIB  ERR_LIB_PEM
-#define ERR_R_X509_LIB ERR_LIB_X509
-#define ERR_R_METH_LIB ERR_LIB_METH
-#define ERR_R_ASN1_LIB ERR_LIB_ASN1
-#define ERR_R_CONF_LIB ERR_LIB_CONF
-#define ERR_R_SSL_LIB  ERR_LIB_SSL
-#define ERR_R_SSL23_LIB        ERR_LIB_SSL23
-#define ERR_R_SSL2_LIB ERR_LIB_SSL2
-#define ERR_R_SSL3_LIB ERR_LIB_SSL3
-#define ERR_R_PROXY_LIB        ERR_LIB_PROXY
-#define ERR_R_BIO_LIB  ERR_LIB_BIO
-#define ERR_R_PKCS7_LIB        ERR_LIB_PKCS7
+#define ERR_R_SYS_LIB  ERR_LIB_SYS       /* 2 */
+#define ERR_R_BN_LIB   ERR_LIB_BN        /* 3 */
+#define ERR_R_RSA_LIB  ERR_LIB_RSA       /* 4 */
+#define ERR_R_DH_LIB   ERR_LIB_DH        /* 5 */
+#define ERR_R_EVP_LIB  ERR_LIB_EVP       /* 6 */
+#define ERR_R_BUF_LIB  ERR_LIB_BUF       /* 7 */
+#define ERR_R_OBJ_LIB  ERR_LIB_OBJ       /* 8 */
+#define ERR_R_PEM_LIB  ERR_LIB_PEM       /* 9 */
+#define ERR_R_DSA_LIB  ERR_LIB_DSA      /* 10 */
+#define ERR_R_X509_LIB ERR_LIB_X509     /* 11 */
+#define ERR_R_ASN1_LIB ERR_LIB_ASN1     /* 13 */
+#define ERR_R_CONF_LIB ERR_LIB_CONF     /* 14 */
+#define ERR_R_CRYPTO_LIB ERR_LIB_CRYPTO  /* 15 */
+#define ERR_R_EC_LIB   ERR_LIB_EC       /* 16 */
+#define ERR_R_SSL_LIB  ERR_LIB_SSL      /* 20 */
+#define ERR_R_BIO_LIB  ERR_LIB_BIO      /* 32 */
+#define ERR_R_PKCS7_LIB        ERR_LIB_PKCS7    /* 33 */
+#define ERR_R_X509V3_LIB ERR_LIB_X509V3  /* 34 */
+#define ERR_R_PKCS12_LIB ERR_LIB_PKCS12  /* 35 */
+#define ERR_R_RAND_LIB ERR_LIB_RAND     /* 36 */
+#define ERR_R_DSO_LIB  ERR_LIB_DSO      /* 37 */
+#define ERR_R_ENGINE_LIB ERR_LIB_ENGINE  /* 38 */
+#define ERR_R_OCSP_LIB  ERR_LIB_OCSP     /* 39 */
+#define ERR_R_UI_LIB    ERR_LIB_UI       /* 40 */
+
+#define ERR_R_NESTED_ASN1_ERROR                        58
+#define ERR_R_BAD_ASN1_OBJECT_HEADER           59
+#define ERR_R_BAD_GET_ASN1_OBJECT_CALL         60
+#define ERR_R_EXPECTING_AN_ASN1_SEQUENCE       61
+#define ERR_R_ASN1_LENGTH_MISMATCH             62
+#define ERR_R_MISSING_ASN1_EOS                 63
 
 /* fatal error */
+#define ERR_R_FATAL                            64
 #define        ERR_R_MALLOC_FAILURE                    (1|ERR_R_FATAL)
 #define        ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED       (2|ERR_R_FATAL)
 #define        ERR_R_PASSED_NULL_PARAMETER             (3|ERR_R_FATAL)
+#define        ERR_R_INTERNAL_ERROR                    (4|ERR_R_FATAL)
+
+/* 99 is the maximum possible ERR_R_... code, higher values
+ * are reserved for the individual libraries */
+
 
 typedef struct ERR_string_data_st
        {
        unsigned long error;
-       char *string;
+       const char *string;
        } ERR_STRING_DATA;
 
-#ifndef NOPROTO
-void ERR_put_error(int lib, int func,int reason,char *file,int line);
+void ERR_put_error(int lib, int func,int reason,const char *file,int line);
+void ERR_set_error_data(char *data,int flags);
+
 unsigned long ERR_get_error(void );
-unsigned long ERR_get_error_line(char **file,int *line);
+unsigned long ERR_get_error_line(const char **file,int *line);
+unsigned long ERR_get_error_line_data(const char **file,int *line,
+                                     const char **data, int *flags);
 unsigned long ERR_peek_error(void );
-unsigned long ERR_peek_error_line(char **file,int *line);
+unsigned long ERR_peek_error_line(const char **file,int *line);
+unsigned long ERR_peek_error_line_data(const char **file,int *line,
+                                      const char **data,int *flags);
 void ERR_clear_error(void );
 char *ERR_error_string(unsigned long e,char *buf);
-char *ERR_lib_error_string(unsigned long e);
-char *ERR_func_error_string(unsigned long e);
-char *ERR_reason_error_string(unsigned long e);
-#ifndef WIN16
+void ERR_error_string_n(unsigned long e, char *buf, size_t len);
+const char *ERR_lib_error_string(unsigned long e);
+const char *ERR_func_error_string(unsigned long e);
+const char *ERR_reason_error_string(unsigned long e);
+void ERR_print_errors_cb(int (*cb)(const char *str, size_t len, void *u),
+                        void *u);
+#ifndef OPENSSL_NO_FP_API
 void ERR_print_errors_fp(FILE *fp);
 #endif
-#ifdef HEADER_BIO_H
+#ifndef OPENSSL_NO_BIO
 void ERR_print_errors(BIO *bp);
+void ERR_add_error_data(int num, ...);
 #endif
 void ERR_load_strings(int lib,ERR_STRING_DATA str[]);
-void ERR_load_ERR_strings(void );
-void ERR_load_crypto_strings(void );
-void ERR_free_strings(void );
+void ERR_load_ERR_strings(void);
+void ERR_load_crypto_strings(void);
+void ERR_free_strings(void);
 
 void ERR_remove_state(unsigned long pid); /* if zero we look it up */
 ERR_STATE *ERR_get_state(void);
 
-#ifdef HEADER_LHASH_H
-LHASH *ERR_get_string_table(void );
-LHASH *ERR_get_err_state_table(void );
-#else
-char *ERR_get_string_table(void );
-char *ERR_get_err_state_table(void );
+#ifndef OPENSSL_NO_LHASH
+LHASH *ERR_get_string_table(void);
+LHASH *ERR_get_err_state_table(void); /* even less thread-safe than
+                                      * ERR_get_string_table :-) */
 #endif
 
-#else
-
-void ERR_put_error();
-unsigned long ERR_get_error();
-unsigned long ERR_get_error_line();
-unsigned long ERR_peek_error();
-unsigned long ERR_peek_error_line();
-void ERR_clear_error();
-char *ERR_error_string();
-char *ERR_lib_error_string();
-char *ERR_func_error_string();
-char *ERR_reason_error_string();
-#ifndef WIN16
-void ERR_print_errors_fp();
-#endif
-void ERR_print_errors();
-void ERR_load_strings();
-void ERR_load_ERR_strings();
-void ERR_load_crypto_strings();
-void ERR_free_strings();
+int ERR_get_next_error_library(void);
 
-void ERR_remove_state();
-ERR_STATE *ERR_get_state();
-
-#ifdef HEADER_LHASH_H
-LHASH *ERR_get_string_table();
-LHASH *ERR_get_err_state_table();
-#else
-char *ERR_get_string_table();
-char *ERR_get_err_state_table();
-#endif
-
-#endif
+/* This opaque type encapsulates the low-level error-state functions */
+typedef struct st_ERR_FNS ERR_FNS;
+/* An application can use this function and provide the return value to loaded
+ * modules that should use the application's ERR state/functionality */
+const ERR_FNS *ERR_get_implementation(void);
+/* A loaded module should call this function prior to any ERR operations using
+ * the application's "ERR_FNS". */
+int ERR_set_implementation(const ERR_FNS *fns);
 
 #ifdef __cplusplus
 }