Type-safe OBJ_bsearch_ex.
[openssl.git] / crypto / objects / objects.h
index 644716b16e46932d13fb1b6d21056d2c8e7442ee..ecbe03c2d9a390c6818edcd638e437887fab49b0 100644 (file)
 #ifndef HEADER_OBJECTS_H
 #define HEADER_OBJECTS_H
 
-#ifdef  __cplusplus
-extern "C" {
-#endif
+#define USE_OBJ_MAC
 
+#ifdef USE_OBJ_MAC
+#include <openssl/obj_mac.h>
+#else
 #define SN_undef                       "UNDEF"
 #define LN_undef                       "undefined"
 #define NID_undef                      0
@@ -232,6 +233,7 @@ extern "C" {
 #define SN_idea_cbc                    "IDEA-CBC"
 #define LN_idea_cbc                    "idea-cbc"
 #define NID_idea_cbc                   34
+#define OBJ_idea_cbc                   1L,3L,6L,1L,4L,1L,188L,7L,1L,1L,2L
 
 #define SN_idea_cfb64                  "IDEA-CFB"
 #define LN_idea_cfb64                  "idea-cfb"
@@ -450,58 +452,59 @@ extern "C" {
 #define LN_desx_cbc                    "desx-cbc"
 #define NID_desx_cbc                   80
 
-#define SN_ld_ce                       "ld-ce"
-#define NID_ld_ce                      81
-#define OBJ_ld_ce                      2L,5L,29L
+#define SN_id_ce                       "id-ce"
+#define NID_id_ce                      81
+#define OBJ_id_ce                      2L,5L,29L
 
 #define SN_subject_key_identifier      "subjectKeyIdentifier"
 #define LN_subject_key_identifier      "X509v3 Subject Key Identifier"
 #define NID_subject_key_identifier     82
-#define OBJ_subject_key_identifier     OBJ_ld_ce,14L
+#define OBJ_subject_key_identifier     OBJ_id_ce,14L
 
 #define SN_key_usage                   "keyUsage"
 #define LN_key_usage                   "X509v3 Key Usage"
 #define NID_key_usage                  83
-#define OBJ_key_usage                  OBJ_ld_ce,15L
+#define OBJ_key_usage                  OBJ_id_ce,15L
 
 #define SN_private_key_usage_period    "privateKeyUsagePeriod"
 #define LN_private_key_usage_period    "X509v3 Private Key Usage Period"
 #define NID_private_key_usage_period   84
-#define OBJ_private_key_usage_period   OBJ_ld_ce,16L
+#define OBJ_private_key_usage_period   OBJ_id_ce,16L
 
 #define SN_subject_alt_name            "subjectAltName"
 #define LN_subject_alt_name            "X509v3 Subject Alternative Name"
 #define NID_subject_alt_name           85
-#define OBJ_subject_alt_name           OBJ_ld_ce,17L
+#define OBJ_subject_alt_name           OBJ_id_ce,17L
 
 #define SN_issuer_alt_name             "issuerAltName"
 #define LN_issuer_alt_name             "X509v3 Issuer Alternative Name"
 #define NID_issuer_alt_name            86
-#define OBJ_issuer_alt_name            OBJ_ld_ce,18L
+#define OBJ_issuer_alt_name            OBJ_id_ce,18L
 
 #define SN_basic_constraints           "basicConstraints"
 #define LN_basic_constraints           "X509v3 Basic Constraints"
 #define NID_basic_constraints          87
-#define OBJ_basic_constraints          OBJ_ld_ce,19L
+#define OBJ_basic_constraints          OBJ_id_ce,19L
 
 #define SN_crl_number                  "crlNumber"
 #define LN_crl_number                  "X509v3 CRL Number"
 #define NID_crl_number                 88
-#define OBJ_crl_number                 OBJ_ld_ce,20L
+#define OBJ_crl_number                 OBJ_id_ce,20L
 
 #define SN_certificate_policies                "certificatePolicies"
 #define LN_certificate_policies                "X509v3 Certificate Policies"
 #define NID_certificate_policies       89
-#define OBJ_certificate_policies       OBJ_ld_ce,32L
+#define OBJ_certificate_policies       OBJ_id_ce,32L
 
 #define SN_authority_key_identifier    "authorityKeyIdentifier"
 #define LN_authority_key_identifier    "X509v3 Authority Key Identifier"
 #define NID_authority_key_identifier   90
-#define OBJ_authority_key_identifier   OBJ_ld_ce,35L
+#define OBJ_authority_key_identifier   OBJ_id_ce,35L
 
 #define SN_bf_cbc                      "BF-CBC"
 #define LN_bf_cbc                      "bf-cbc"
 #define NID_bf_cbc                     91
+#define OBJ_bf_cbc                     1L,3L,6L,1L,4L,1L,3029L,1L,2L
 
 #define SN_bf_ecb                      "BF-ECB"
 #define LN_bf_ecb                      "bf-ecb"
@@ -557,7 +560,7 @@ extern "C" {
 #define SN_crl_distribution_points     "crlDistributionPoints"
 #define LN_crl_distribution_points     "X509v3 CRL Distribution Points"
 #define NID_crl_distribution_points    103
-#define OBJ_crl_distribution_points    OBJ_ld_ce,31L
+#define OBJ_crl_distribution_points    OBJ_id_ce,31L
 
 #define SN_md5WithRSA                  "RSA-NP-MD5"
 #define LN_md5WithRSA                  "md5WithRSA"
@@ -630,7 +633,7 @@ extern "C" {
 #define OBJ_ripemd160                  1L,3L,36L,3L,2L,1L
 
 /* The name should actually be rsaSignatureWithripemd160, but I'm going
- * to contiune using the convention I'm using with the other ciphers */
+ * to continue using the convention I'm using with the other ciphers */
 #define SN_ripemd160WithRSA            "RSA-RIPEMD160"
 #define LN_ripemd160WithRSA            "ripemd160WithRSA"
 #define NID_ripemd160WithRSA           119
@@ -674,7 +677,7 @@ extern "C" {
 #define SN_ext_key_usage               "extendedKeyUsage"
 #define LN_ext_key_usage               "X509v3 Extended Key Usage"
 #define NID_ext_key_usage              126
-#define OBJ_ext_key_usage              OBJ_ld_ce,37
+#define OBJ_ext_key_usage              OBJ_id_ce,37
 
 #define SN_id_pkix                     "PKIX"
 #define NID_id_pkix                    127
@@ -738,7 +741,7 @@ extern "C" {
 #define NID_ms_efs                     138
 #define OBJ_ms_efs                     1L,3L,6L,1L,4L,1L,311L,10L,3L,4L
 
-/* Addidional usage: Netscape */
+/* Additional usage: Netscape */
 
 #define SN_ns_sgc                      "nsSGC"
 #define LN_ns_sgc                      "Netscape Server Gated Crypto"
@@ -748,17 +751,17 @@ extern "C" {
 #define SN_delta_crl                   "deltaCRL"
 #define LN_delta_crl                   "X509v3 Delta CRL Indicator"
 #define NID_delta_crl                  140
-#define OBJ_delta_crl                  OBJ_ld_ce,27L
+#define OBJ_delta_crl                  OBJ_id_ce,27L
 
 #define SN_crl_reason                  "CRLReason"
 #define LN_crl_reason                  "CRL Reason Code"
 #define NID_crl_reason                 141
-#define OBJ_crl_reason                 OBJ_ld_ce,21L
+#define OBJ_crl_reason                 OBJ_id_ce,21L
 
 #define SN_invalidity_date             "invalidityDate"
 #define LN_invalidity_date             "Invalidity Date"
 #define NID_invalidity_date            142
-#define OBJ_invalidity_date            OBJ_ld_ce,24L
+#define OBJ_invalidity_date            OBJ_id_ce,24L
 
 #define SN_sxnet                       "SXNetID"
 #define LN_sxnet                       "Strong Extranet ID"
@@ -947,10 +950,11 @@ extern "C" {
 #define NID_ad_ca_issuers              179
 #define OBJ_ad_ca_issuers              OBJ_id_ad,2L
 
-#define SN_OSCP_sign                   "OCSPSigning"
+#define SN_OCSP_sign                   "OCSPSigning"
 #define LN_OCSP_sign                   "OCSP Signing"
 #define NID_OCSP_sign                  180
 #define OBJ_OCSP_sign                  OBJ_id_kp,9L
+#endif /* USE_OBJ_MAC */
 
 #include <openssl/bio.h>
 #include <openssl/asn1.h>
@@ -962,8 +966,15 @@ extern "C" {
 #define        OBJ_NAME_TYPE_COMP_METH         0x04
 #define        OBJ_NAME_TYPE_NUM               0x05
 
-#define        OBJ_NAME_ALIAS          0x8000
+#define        OBJ_NAME_ALIAS                  0x8000
+
+#define OBJ_BSEARCH_VALUE_ON_NOMATCH           0x01
+#define OBJ_BSEARCH_FIRST_VALUE_ON_MATCH       0x02
+
 
+#ifdef  __cplusplus
+extern "C" {
+#endif
 
 typedef struct obj_name_st
        {
@@ -977,44 +988,127 @@ typedef struct obj_name_st
 
 
 int OBJ_NAME_init(void);
-int OBJ_NAME_new_index(unsigned long (*hash_func)(),int (*cmp_func)(),
-       void (*free_func)());
+int OBJ_NAME_new_index(unsigned long (*hash_func)(const char *),
+                      int (*cmp_func)(const char *, const char *),
+                      void (*free_func)(const char *, int, const char *));
 const char *OBJ_NAME_get(const char *name,int type);
 int OBJ_NAME_add(const char *name,int type,const char *data);
 int OBJ_NAME_remove(const char *name,int type);
 void OBJ_NAME_cleanup(int type); /* -1 for everything */
+void OBJ_NAME_do_all(int type,void (*fn)(const OBJ_NAME *,void *arg),
+                    void *arg);
+void OBJ_NAME_do_all_sorted(int type,void (*fn)(const OBJ_NAME *,void *arg),
+                           void *arg);
 
-ASN1_OBJECT *  OBJ_dup(ASN1_OBJECT *o);
+ASN1_OBJECT *  OBJ_dup(const ASN1_OBJECT *o);
 ASN1_OBJECT *  OBJ_nid2obj(int n);
 const char *   OBJ_nid2ln(int n);
 const char *   OBJ_nid2sn(int n);
-int            OBJ_obj2nid(ASN1_OBJECT *o);
+int            OBJ_obj2nid(const ASN1_OBJECT *o);
 ASN1_OBJECT *  OBJ_txt2obj(const char *s, int no_name);
-int    OBJ_obj2txt(char *buf, int buf_len, ASN1_OBJECT *a, int no_name);
-int            OBJ_txt2nid(char *s);
+int    OBJ_obj2txt(char *buf, int buf_len, const ASN1_OBJECT *a, int no_name);
+int            OBJ_txt2nid(const char *s);
 int            OBJ_ln2nid(const char *s);
 int            OBJ_sn2nid(const char *s);
-int            OBJ_cmp(ASN1_OBJECT *a,ASN1_OBJECT *b);
-char *         OBJ_bsearch(char *key,char *base,int num,int size,int (*cmp)());
-
-void           ERR_load_OBJ_strings(void );
+int            OBJ_cmp(const ASN1_OBJECT *a,const ASN1_OBJECT *b);
+const void *   OBJ_bsearch_(const void *key,const void *base,int num,int size,
+                            int (*cmp)(const void *, const void *));
+const void *   OBJ_bsearch_ex_(const void *key,const void *base,int num,
+                               int size,
+                               int (*cmp)(const void *, const void *),
+                               int flags);
+
+#define _DECLARE_OBJ_BSEARCH_CMP_FN(scope, type1, type2, cmp)  \
+  scope type1 *cmp##_type_1; \
+  scope type2 *cmp##_type_2;                                   \
+  scope int cmp##_BSEARCH_CMP_FN(const void *, const void *);          \
+  scope int cmp(const type1 const *, const type2 const *);
+
+#define DECLARE_OBJ_BSEARCH_CMP_FN(type1, type2, cmp)  \
+  _DECLARE_OBJ_BSEARCH_CMP_FN(static, type1, type2, cmp)
+#define DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(type1, type2, cmp)   \
+  _DECLARE_OBJ_BSEARCH_CMP_FN(, type1, type2, cmp)
+
+/*
+ * Unsolved problem: if a type is actually a pointer type, like
+ * nid_triple is, then its impossible to get a const where you need
+ * it. Consider:
+ *
+ * typedef int nid_triple[3];
+ * const void *a_;
+ * const nid_triple const *a = a_;
+ *
+ * The assignement discards a const because what you really want is:
+ *
+ * const int const * const *a = a_;
+ *
+ * But if you do that, you lose the fact that a is an array of 3 ints,
+ * which breaks comparison functions.
+ *
+ * Thus we end up having to cast, sadly, or unpack the
+ * declarations. Or, as I finally did in this case, delcare nid_triple
+ * to be a struct, which it should have been in the first place.
+ *
+ * Ben, August 2008.
+ *
+ * Also, strictly speaking not all types need be const, but handling
+ * the non-constness means a lot of complication, and in practice
+ * comparison routines do always not touch their arguments.
+ */
+#define _IMPLEMENT_OBJ_BSEARCH_CMP_FN(scope, type1, type2, cmp)        \
+  scope int cmp##_BSEARCH_CMP_FN(const void *a_, const void *b_)       \
+      { \
+      const type1 const *a = a_; \
+      const type2 const *b = b_; \
+      return cmp(a,b); \
+      }
+
+#define IMPLEMENT_OBJ_BSEARCH_CMP_FN(type1, type2, cmp) \
+  _IMPLEMENT_OBJ_BSEARCH_CMP_FN(static, type1, type2, cmp)
+#define IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(type1, type2, cmp) \
+  _IMPLEMENT_OBJ_BSEARCH_CMP_FN(, type1, type2, cmp)
+
+#define OBJ_bsearch(type1,key,type2,base,num,cmp)                             \
+  ((type2 *)OBJ_bsearch_(CHECKED_PTR_OF(type1,key),CHECKED_PTR_OF(type2,base), \
+                        num,sizeof(type2),                             \
+                        (cmp##_type_1=CHECKED_PTR_OF(type1,cmp##_type_1), \
+                         cmp##_type_2=CHECKED_PTR_OF(type2,cmp##_type_2), \
+                         cmp##_BSEARCH_CMP_FN)))
+
+#define OBJ_bsearch_ex(type1,key,type2,base,num,cmp,flags)                     \
+  ((type2 *)OBJ_bsearch_(CHECKED_PTR_OF(type1,key),CHECKED_PTR_OF(type2,base), \
+                        num,sizeof(type2),                             \
+                        (cmp##_type_1=CHECKED_PTR_OF(type1,cmp##_type_1), \
+                         cmp##_type_2=CHECKED_PTR_OF(type2,cmp##_type_2), \
+                         cmp##_BSEARCH_CMP_FN)),flags)
 
 int            OBJ_new_nid(int num);
-int            OBJ_add_object(ASN1_OBJECT *obj);
-int            OBJ_create(char *oid,char *sn,char *ln);
+int            OBJ_add_object(const ASN1_OBJECT *obj);
+int            OBJ_create(const char *oid,const char *sn,const char *ln);
 void           OBJ_cleanup(void );
 int            OBJ_create_objects(BIO *in);
 
+int OBJ_find_sigid_algs(int signid, int *pdig_nid, int *ppkey_nid);
+int OBJ_find_sigid_by_algs(int *psignid, int dig_nid, int pkey_nid);
+int OBJ_add_sigid(int signid, int dig_id, int pkey_id);
+void OBJ_sigid_free(void);
+
+extern int obj_cleanup_defer;
+void check_defer(int nid);
+
 /* BEGIN ERROR CODES */
 /* The following lines are auto generated by the script mkerr.pl. Any changes
  * made after this point may be overwritten when the script is next run.
  */
+void ERR_load_OBJ_strings(void);
 
 /* Error codes for the OBJ functions. */
 
 /* Function codes. */
+#define OBJ_F_OBJ_ADD_OBJECT                            105
 #define OBJ_F_OBJ_CREATE                                100
 #define OBJ_F_OBJ_DUP                                   101
+#define OBJ_F_OBJ_NAME_NEW_INDEX                        106
 #define OBJ_F_OBJ_NID2LN                                102
 #define OBJ_F_OBJ_NID2OBJ                               103
 #define OBJ_F_OBJ_NID2SN                                104
@@ -1027,4 +1121,3 @@ int               OBJ_create_objects(BIO *in);
 }
 #endif
 #endif
-