Don't use *from++ in tolower as this is implemented as a macro on some
[openssl.git] / crypto / asn1 / x_name.c
index caece0f1585c6b63ca82a54c8026a694433f859c..063bf7c16bfbe0490aa6c9d6aaf7a180be6b8173 100644 (file)
  */
 
 #include <stdio.h>
+#include <ctype.h>
 #include "cryptlib.h"
 #include <openssl/asn1t.h>
 #include <openssl/x509.h>
+#include "asn1_locl.h"
 
-static int x509_name_ex_d2i(ASN1_VALUE **val, unsigned char **in, long len, const ASN1_ITEM *it,
-                                       int tag, int aclass, char opt, ASN1_TLC *ctx);
+typedef STACK_OF(X509_NAME_ENTRY) STACK_OF_X509_NAME_ENTRY;
+DECLARE_STACK_OF(STACK_OF_X509_NAME_ENTRY)
 
-static int x509_name_ex_i2d(ASN1_VALUE **val, unsigned char **out, const ASN1_ITEM *it, int tag, int aclass);
+static int x509_name_ex_d2i(ASN1_VALUE **val,
+                               const unsigned char **in, long len,
+                               const ASN1_ITEM *it,
+                               int tag, int aclass, char opt, ASN1_TLC *ctx);
+
+static int x509_name_ex_i2d(ASN1_VALUE **val, unsigned char **out,
+                               const ASN1_ITEM *it, int tag, int aclass);
 static int x509_name_ex_new(ASN1_VALUE **val, const ASN1_ITEM *it);
 static void x509_name_ex_free(ASN1_VALUE **val, const ASN1_ITEM *it);
 
 static int x509_name_encode(X509_NAME *a);
+static int x509_name_canon(X509_NAME *a);
+static int asn1_string_canon(ASN1_STRING *out, ASN1_STRING *in);
+static int i2d_name_canon(STACK_OF(STACK_OF_X509_NAME_ENTRY) *intname,
+                         unsigned char **in);
+
+
+static int x509_name_ex_print(BIO *out, ASN1_VALUE **pval,
+                                               int indent,
+                                               const char *fname, 
+                                               const ASN1_PCTX *pctx);
 
 ASN1_SEQUENCE(X509_NAME_ENTRY) = {
        ASN1_SIMPLE(X509_NAME_ENTRY, object, ASN1_OBJECT),
@@ -102,7 +120,8 @@ const ASN1_EXTERN_FUNCS x509_name_ff = {
        x509_name_ex_free,
        0,      /* Default clear behaviour is OK */
        x509_name_ex_d2i,
-       x509_name_ex_i2d
+       x509_name_ex_i2d,
+       x509_name_ex_print
 };
 
 IMPLEMENT_EXTERN_ASN1(X509_NAME, V_ASN1_SEQUENCE, x509_name_ff) 
@@ -118,12 +137,14 @@ static int x509_name_ex_new(ASN1_VALUE **val, const ASN1_ITEM *it)
        if ((ret->entries=sk_X509_NAME_ENTRY_new_null()) == NULL)
                goto memerr;
        if((ret->bytes = BUF_MEM_new()) == NULL) goto memerr;
+       ret->canon_enc = NULL;
+       ret->canon_enclen = 0;
        ret->modified=1;
        *val = (ASN1_VALUE *)ret;
        return 1;
 
  memerr:
-       ASN1err(ASN1_F_X509_NAME_NEW, ERR_R_MALLOC_FAILURE);
+       ASN1err(ASN1_F_X509_NAME_EX_NEW, ERR_R_MALLOC_FAILURE);
        if (ret)
                {
                if (ret->entries)
@@ -142,61 +163,59 @@ static void x509_name_ex_free(ASN1_VALUE **pval, const ASN1_ITEM *it)
 
        BUF_MEM_free(a->bytes);
        sk_X509_NAME_ENTRY_pop_free(a->entries,X509_NAME_ENTRY_free);
+       if (a->canon_enc)
+               OPENSSL_free(a->canon_enc);
        OPENSSL_free(a);
        *pval = NULL;
 }
 
-/* Used with sk_pop_free() to free up the internal representation.
- * NB: we only free the STACK and not its contents because it is
- * already present in the X509_NAME structure.
- */
-
-static void sk_internal_free(void *a)
-{
-       sk_free(a);
-}
-
-static int x509_name_ex_d2i(ASN1_VALUE **val, unsigned char **in, long len, const ASN1_ITEM *it,
-                                       int tag, int aclass, char opt, ASN1_TLC *ctx)
+static int x509_name_ex_d2i(ASN1_VALUE **val,
+                       const unsigned char **in, long len, const ASN1_ITEM *it,
+                               int tag, int aclass, char opt, ASN1_TLC *ctx)
 {
-       unsigned char *p = *in, *q;
-       STACK *intname = NULL;
+       const unsigned char *p = *in, *q;
+       union { STACK_OF(STACK_OF_X509_NAME_ENTRY) *s;
+               ASN1_VALUE *a; } intname = {NULL};
+       union { X509_NAME *x; ASN1_VALUE *a; } nm = {NULL};
        int i, j, ret;
-       X509_NAME *nm = NULL;
        STACK_OF(X509_NAME_ENTRY) *entries;
        X509_NAME_ENTRY *entry;
        q = p;
 
        /* Get internal representation of Name */
-       ret = ASN1_item_ex_d2i((ASN1_VALUE **)&intname, &p, len, ASN1_ITEM_rptr(X509_NAME_INTERNAL),
-                                                               tag, aclass, opt, ctx);
+       ret = ASN1_item_ex_d2i(&intname.a,
+                              &p, len, ASN1_ITEM_rptr(X509_NAME_INTERNAL),
+                              tag, aclass, opt, ctx);
        
        if(ret <= 0) return ret;
 
        if(*val) x509_name_ex_free(val, NULL);
-       if(!x509_name_ex_new((ASN1_VALUE **)&nm, NULL)) goto err;
+       if(!x509_name_ex_new(&nm.a, NULL)) goto err;
        /* We've decoded it: now cache encoding */
-       if(!BUF_MEM_grow(nm->bytes, p - q)) goto err;
-       memcpy(nm->bytes->data, q, p - q);
+       if(!BUF_MEM_grow(nm.x->bytes, p - q)) goto err;
+       memcpy(nm.x->bytes->data, q, p - q);
 
        /* Convert internal representation to X509_NAME structure */
-       for(i = 0; i < sk_num(intname); i++) {
-               entries = (STACK_OF(X509_NAME_ENTRY) *)sk_value(intname, i);
+       for(i = 0; i < sk_STACK_OF_X509_NAME_ENTRY_num(intname.s); i++) {
+               entries = sk_STACK_OF_X509_NAME_ENTRY_value(intname.s, i);
                for(j = 0; j < sk_X509_NAME_ENTRY_num(entries); j++) {
                        entry = sk_X509_NAME_ENTRY_value(entries, j);
                        entry->set = i;
-                       if(!sk_X509_NAME_ENTRY_push(nm->entries, entry))
+                       if(!sk_X509_NAME_ENTRY_push(nm.x->entries, entry))
                                goto err;
                }
                sk_X509_NAME_ENTRY_free(entries);
        }
-       sk_free(intname);
-       nm->modified = 0;
-       *val = (ASN1_VALUE *)nm;
+       sk_STACK_OF_X509_NAME_ENTRY_free(intname.s);
+       ret = x509_name_canon(nm.x);
+       if (!ret)
+               goto err;
+       nm.x->modified = 0;
+       *val = nm.a;
        *in = p;
        return ret;
        err:
-       ASN1err(ASN1_F_D2I_X509_NAME, ERR_R_NESTED_ASN1_ERROR);
+       ASN1err(ASN1_F_X509_NAME_EX_D2I, ERR_R_NESTED_ASN1_ERROR);
        return 0;
 }
 
@@ -205,8 +224,12 @@ static int x509_name_ex_i2d(ASN1_VALUE **val, unsigned char **out, const ASN1_IT
        int ret;
        X509_NAME *a = (X509_NAME *)*val;
        if(a->modified) {
-               ret = x509_name_encode((X509_NAME *)a);
-               if(ret < 0) return ret;
+               ret = x509_name_encode(a);
+               if(ret < 0)
+                       return ret;
+               ret = x509_name_canon(a);
+               if(ret < 0)
+                       return ret;
        }
        ret = a->bytes->length;
        if(out != NULL) {
@@ -216,39 +239,262 @@ static int x509_name_ex_i2d(ASN1_VALUE **val, unsigned char **out, const ASN1_IT
        return ret;
 }
 
+static void local_sk_X509_NAME_ENTRY_free(STACK_OF(X509_NAME_ENTRY) *ne)
+       {
+       sk_X509_NAME_ENTRY_free(ne);
+       }
+
+static void local_sk_X509_NAME_ENTRY_pop_free(STACK_OF(X509_NAME_ENTRY) *ne)
+       {
+       sk_X509_NAME_ENTRY_pop_free(ne, X509_NAME_ENTRY_free);
+       }
+
 static int x509_name_encode(X509_NAME *a)
 {
-       STACK *intname = NULL;
+       union { STACK_OF(STACK_OF_X509_NAME_ENTRY) *s;
+               ASN1_VALUE *a; } intname = {NULL};
        int len;
        unsigned char *p;
        STACK_OF(X509_NAME_ENTRY) *entries = NULL;
        X509_NAME_ENTRY *entry;
        int i, set = -1;
-       intname = sk_new_null();
-       if(!intname) goto memerr;
+       intname.s = sk_STACK_OF_X509_NAME_ENTRY_new_null();
+       if(!intname.s) goto memerr;
        for(i = 0; i < sk_X509_NAME_ENTRY_num(a->entries); i++) {
                entry = sk_X509_NAME_ENTRY_value(a->entries, i);
                if(entry->set != set) {
                        entries = sk_X509_NAME_ENTRY_new_null();
                        if(!entries) goto memerr;
-                       if(!sk_push(intname, (char *)entries)) goto memerr;
+                       if(!sk_STACK_OF_X509_NAME_ENTRY_push(intname.s,
+                                                            entries))
+                               goto memerr;
                        set = entry->set;
                }
                if(!sk_X509_NAME_ENTRY_push(entries, entry)) goto memerr;
        }
-       len = ASN1_item_ex_i2d((ASN1_VALUE **)&intname, NULL, ASN1_ITEM_rptr(X509_NAME_INTERNAL), -1, -1);
+       len = ASN1_item_ex_i2d(&intname.a, NULL,
+                              ASN1_ITEM_rptr(X509_NAME_INTERNAL), -1, -1);
        if (!BUF_MEM_grow(a->bytes,len)) goto memerr;
        p=(unsigned char *)a->bytes->data;
-       ASN1_item_ex_i2d((ASN1_VALUE **)&intname, &p, ASN1_ITEM_rptr(X509_NAME_INTERNAL), -1, -1);
-       sk_pop_free(intname, sk_internal_free);
+       ASN1_item_ex_i2d(&intname.a,
+                        &p, ASN1_ITEM_rptr(X509_NAME_INTERNAL), -1, -1);
+       sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname.s,
+                                            local_sk_X509_NAME_ENTRY_free);
        a->modified = 0;
        return len;
-       memerr:
-       sk_pop_free(intname, sk_internal_free);
-       ASN1err(ASN1_F_D2I_X509_NAME, ERR_R_MALLOC_FAILURE);
+memerr:
+       sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname.s,
+                                            local_sk_X509_NAME_ENTRY_free);
+       ASN1err(ASN1_F_X509_NAME_ENCODE, ERR_R_MALLOC_FAILURE);
        return -1;
 }
 
+static int x509_name_ex_print(BIO *out, ASN1_VALUE **pval,
+                                               int indent,
+                                               const char *fname, 
+                                               const ASN1_PCTX *pctx)
+       {
+       if (X509_NAME_print_ex(out, (X509_NAME *)*pval,
+                                       indent, pctx->nm_flags) <= 0)
+               return 0;
+       return 2;
+       }
+
+/* This function generates the canonical encoding of the Name structure.
+ * In it all strings are converted to UTF8, leading, trailing and
+ * multiple spaces collapsed, converted to lower case and the leading
+ * SEQUENCE header removed.
+ *
+ * In future we could also normalize the UTF8 too.
+ *
+ * By doing this comparison of Name structures can be rapidly
+ * perfomed by just using memcmp() of the canonical encoding.
+ * By omitting the leading SEQUENCE name constraints of type
+ * dirName can also be checked with a simple memcmp().
+ */
+
+static int x509_name_canon(X509_NAME *a)
+       {
+       unsigned char *p;
+       STACK_OF(STACK_OF_X509_NAME_ENTRY) *intname = NULL;
+       STACK_OF(X509_NAME_ENTRY) *entries = NULL;
+       X509_NAME_ENTRY *entry, *tmpentry = NULL;
+       int i, set = -1, ret = 0;
+
+       if (a->canon_enc)
+               {
+               OPENSSL_free(a->canon_enc);
+               a->canon_enc = NULL;
+               }
+       /* Special case: empty X509_NAME => null encoding */
+       if (sk_X509_NAME_ENTRY_num(a->entries) == 0)
+               {
+               a->canon_enclen = 0;
+               return 1;
+               }
+       intname = sk_STACK_OF_X509_NAME_ENTRY_new_null();
+       if(!intname)
+               goto err;
+       for(i = 0; i < sk_X509_NAME_ENTRY_num(a->entries); i++)
+               {
+               entry = sk_X509_NAME_ENTRY_value(a->entries, i);
+               if(entry->set != set)
+                       {
+                       entries = sk_X509_NAME_ENTRY_new_null();
+                       if(!entries)
+                               goto err;
+                       if(!sk_STACK_OF_X509_NAME_ENTRY_push(intname, entries))
+                               goto err;
+                       set = entry->set;
+                       }
+               tmpentry = X509_NAME_ENTRY_new();
+               tmpentry->object = OBJ_dup(entry->object);
+               if (!asn1_string_canon(tmpentry->value, entry->value))
+                       goto err;
+               if(!sk_X509_NAME_ENTRY_push(entries, tmpentry))
+                       goto err;
+               tmpentry = NULL;
+               }
+
+       /* Finally generate encoding */
+
+       a->canon_enclen = i2d_name_canon(intname, NULL);
+
+       p = OPENSSL_malloc(a->canon_enclen);
+
+       if (!p)
+               goto err;
+
+       a->canon_enc = p;
+
+       i2d_name_canon(intname, &p);
+
+       ret = 1;
+
+       err:
+
+       if (tmpentry)
+               X509_NAME_ENTRY_free(tmpentry);
+       if (intname)
+               sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname,
+                                       local_sk_X509_NAME_ENTRY_pop_free);
+       return ret;
+       }
+
+/* Bitmap of all the types of string that will be canonicalized. */
+
+#define ASN1_MASK_CANON        \
+       (B_ASN1_UTF8STRING | B_ASN1_BMPSTRING | B_ASN1_UNIVERSALSTRING \
+       | B_ASN1_PRINTABLESTRING | B_ASN1_T61STRING | B_ASN1_IA5STRING \
+       | B_ASN1_VISIBLESTRING)
+       
+
+static int asn1_string_canon(ASN1_STRING *out, ASN1_STRING *in)
+       {
+       unsigned char *to, *from;
+       int len, i;
+
+       /* If type not in bitmask just copy string across */
+       if (!(ASN1_tag2bit(in->type) & ASN1_MASK_CANON))
+               {
+               out->type = in->type;
+               if (!ASN1_STRING_set(out, in->data, in->length))
+                       return 0;
+               return 1;
+               }
+
+       out->type = V_ASN1_UTF8STRING;
+       out->length = ASN1_STRING_to_UTF8(&out->data, in);
+       if (out->length == -1)
+               return 0;
+
+       to = out->data;
+       from = to;
+
+       len = out->length;
+
+       /* Convert string in place to canonical form.
+        * Ultimately we may need to handle a wider range of characters
+        * but for now ignore anything with MSB set and rely on the
+        * isspace() and tolower() functions.
+        */
+
+       /* Ignore leading spaces */
+       while((len > 0) && !(*from & 0x80) && isspace(*from))
+               {
+               from++;
+               len--;
+               }
+
+       to = from + len - 1;
+
+       /* Ignore trailing spaces */
+       while ((len > 0) && !(*to & 0x80) && isspace(*to))
+               {
+               to--;
+               len--;
+               }
+
+       to = out->data;
+
+       i = 0;
+       while(i < len)
+               {
+               /* If MSB set just copy across */
+               if (*from & 0x80)
+                       {
+                       *to++ = *from++;
+                       i++;
+                       }
+               /* Collapse multiple spaces */
+               else if (isspace(*from))
+                       {
+                       /* Copy one space across */
+                       *to++ = ' ';
+                       /* Ignore subsequent spaces. Note: don't need to
+                        * check len here because we know the last 
+                        * character is a non-space so we can't overflow.
+                        */
+                       do
+                               {
+                               from++;
+                               i++;
+                               }
+                       while(!(*from & 0x80) && isspace(*from));
+                       }
+               else
+                       {
+                       *to++ = tolower(*from);
+                       from++;
+                       i++;
+                       }
+               }
+
+       out->length = to - out->data;
+
+       return 1;
+
+       }
+
+static int i2d_name_canon(STACK_OF(STACK_OF_X509_NAME_ENTRY) *_intname,
+                         unsigned char **in)
+       {
+       int i, len, ltmp;
+       ASN1_VALUE *v;
+       STACK_OF(ASN1_VALUE) *intname = (STACK_OF(ASN1_VALUE) *)_intname;
+
+       len = 0;
+       for (i = 0; i < sk_ASN1_VALUE_num(intname); i++)
+               {
+               v = sk_ASN1_VALUE_value(intname, i);
+               ltmp = ASN1_item_ex_i2d(&v, in,
+                       ASN1_ITEM_rptr(X509_NAME_ENTRIES), -1, -1);
+               if (ltmp < 0)
+                       return ltmp;
+               len += ltmp;
+               }
+       return len;
+       }
 
 int X509_NAME_set(X509_NAME **xn, X509_NAME *name)
        {