Set default global mask to UTF8 only.
[openssl.git] / crypto / asn1 / a_strnid.c
index cb37024db22902edc19d56291c30d94230eca099..89932644fe14595b367ccfade34fc27f6c1932a5 100644 (file)
@@ -1,5 +1,5 @@
 /* a_strnid.c */
-/* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL
+/* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
  * project 1999.
  */
 /* ====================================================================
 
 static STACK_OF(ASN1_STRING_TABLE) *stable = NULL;
 static void st_free(ASN1_STRING_TABLE *tbl);
-static int sk_table_cmp(ASN1_STRING_TABLE **a, ASN1_STRING_TABLE **b);
+static int sk_table_cmp(const ASN1_STRING_TABLE * const *a,
+                       const ASN1_STRING_TABLE * const *b);
+
+
+/* This is the global mask for the mbstring functions: this is use to
+ * mask out certain types (such as BMPString and UTF8String) because
+ * certain software (e.g. Netscape) has problems with them.
+ */
+
+static unsigned long global_mask = B_ASN1_UTF8STRING;
+
+void ASN1_STRING_set_default_mask(unsigned long mask)
+{
+       global_mask = mask;
+}
+
+unsigned long ASN1_STRING_get_default_mask(void)
+{
+       return global_mask;
+}
+
+/* This function sets the default to various "flavours" of configuration.
+ * based on an ASCII string. Currently this is:
+ * MASK:XXXX : a numerical mask value.
+ * nobmp : Don't use BMPStrings (just Printable, T61).
+ * pkix : PKIX recommendation in RFC2459.
+ * utf8only : only use UTF8Strings (RFC2459 recommendation for 2004).
+ * default:   the default value, Printable, T61, BMP.
+ */
+
+int ASN1_STRING_set_default_mask_asc(const char *p)
+{
+       unsigned long mask;
+       char *end;
+       if(!strncmp(p, "MASK:", 5)) {
+               if(!p[5]) return 0;
+               mask = strtoul(p + 5, &end, 0);
+               if(*end) return 0;
+       } else if(!strcmp(p, "nombstr"))
+                        mask = ~((unsigned long)(B_ASN1_BMPSTRING|B_ASN1_UTF8STRING));
+       else if(!strcmp(p, "pkix"))
+                       mask = ~((unsigned long)B_ASN1_T61STRING);
+       else if(!strcmp(p, "utf8only")) mask = B_ASN1_UTF8STRING;
+       else if(!strcmp(p, "default"))
+           mask = 0xFFFFFFFFL;
+       else return 0;
+       ASN1_STRING_set_default_mask(mask);
+       return 1;
+}
 
 /* The following function generates an ASN1_STRING based on limits in a table.
  * Frequently the types and length of an ASN1_STRING are restricted by a 
@@ -77,13 +125,16 @@ ASN1_STRING *ASN1_STRING_set_by_NID(ASN1_STRING **out, const unsigned char *in,
 {
        ASN1_STRING_TABLE *tbl;
        ASN1_STRING *str = NULL;
+       unsigned long mask;
        int ret;
        if(!out) out = &str;
-       if(!stable) ASN1_STRING_TABLE_add_standard();
        tbl = ASN1_STRING_TABLE_get(nid);
-       if(tbl) ret = ASN1_mbstring_ncopy(out, in, inlen, inform, tbl->mask,
+       if(tbl) {
+               mask = tbl->mask;
+               if(!(tbl->flags & STABLE_NO_MASK)) mask &= global_mask;
+               ret = ASN1_mbstring_ncopy(out, in, inlen, inform, mask,
                                        tbl->minsize, tbl->maxsize);
-       else ret = ASN1_mbstring_copy(out, in, inlen, inform, 0);
+       } else ret = ASN1_mbstring_copy(out, in, inlen, inform, DIRSTRING_TYPE & global_mask);
        if(ret <= 0) return NULL;
        return *out;
 }
@@ -91,7 +142,7 @@ ASN1_STRING *ASN1_STRING_set_by_NID(ASN1_STRING **out, const unsigned char *in,
 /* Now the tables and helper functions for the string table:
  */
 
-/* size limits: this stuff is taken straight from RFC2459 */
+/* size limits: this stuff is taken straight from RFC3280 */
 
 #define ub_name                                32768
 #define ub_common_name                 64
@@ -101,100 +152,174 @@ ASN1_STRING *ASN1_STRING_set_by_NID(ASN1_STRING **out, const unsigned char *in,
 #define ub_organization_unit_name      64
 #define ub_title                       64
 #define ub_email_address               128
+#define ub_serial_number               64
+
 
-static ASN1_STRING_TABLE tbl_standard[] = {
-{NID_name,                     1, ub_name, 0, 0},
-{NID_surname,                  1, ub_name, 0, 0},
-{NID_givenName,                        1, ub_name, 0, 0},
-{NID_initials,                 1, ub_name, 0, 0},
-{NID_commonName,               1, ub_common_name, 0, 0},
-{NID_localityName,             1, ub_locality_name, 0, 0},
-{NID_stateOrProvinceName,      1, ub_state_name, 0, 0},
-{NID_organizationName,         1, ub_organization_name, 0, 0},
-{NID_organizationalUnitName,   1, ub_organization_unit_name, 0, 0},
-{NID_dnQualifier,              -1, -1, B_ASN1_PRINTABLESTRING, 0},
-{NID_countryName,              2, 2, B_ASN1_PRINTABLESTRING, 0},
-{NID_pkcs9_emailAddress,       1, ub_email_address, B_ASN1_IA5STRING, 0},
-{NID_undef, 0, 0, 0, 0}
+/* This table must be kept in NID order */
+
+static const ASN1_STRING_TABLE tbl_standard[] = {
+{NID_commonName,               1, ub_common_name, DIRSTRING_TYPE, 0},
+{NID_countryName,              2, 2, B_ASN1_PRINTABLESTRING, STABLE_NO_MASK},
+{NID_localityName,             1, ub_locality_name, DIRSTRING_TYPE, 0},
+{NID_stateOrProvinceName,      1, ub_state_name, DIRSTRING_TYPE, 0},
+{NID_organizationName,         1, ub_organization_name, DIRSTRING_TYPE, 0},
+{NID_organizationalUnitName,   1, ub_organization_unit_name, DIRSTRING_TYPE, 0},
+{NID_pkcs9_emailAddress,       1, ub_email_address, B_ASN1_IA5STRING, STABLE_NO_MASK},
+{NID_pkcs9_unstructuredName,   1, -1, PKCS9STRING_TYPE, 0},
+{NID_pkcs9_challengePassword,  1, -1, PKCS9STRING_TYPE, 0},
+{NID_pkcs9_unstructuredAddress,        1, -1, DIRSTRING_TYPE, 0},
+{NID_givenName,                        1, ub_name, DIRSTRING_TYPE, 0},
+{NID_surname,                  1, ub_name, DIRSTRING_TYPE, 0},
+{NID_initials,                 1, ub_name, DIRSTRING_TYPE, 0},
+{NID_serialNumber,             1, ub_serial_number, B_ASN1_PRINTABLESTRING, STABLE_NO_MASK},
+{NID_friendlyName,             -1, -1, B_ASN1_BMPSTRING, STABLE_NO_MASK},
+{NID_name,                     1, ub_name, DIRSTRING_TYPE, 0},
+{NID_dnQualifier,              -1, -1, B_ASN1_PRINTABLESTRING, STABLE_NO_MASK},
+{NID_domainComponent,          1, -1, B_ASN1_IA5STRING, STABLE_NO_MASK},
+{NID_ms_csp_name,              -1, -1, B_ASN1_BMPSTRING, STABLE_NO_MASK}
 };
 
-int ASN1_STRING_TABLE_add_standard(void)
+static int sk_table_cmp(const ASN1_STRING_TABLE * const *a,
+                       const ASN1_STRING_TABLE * const *b)
 {
-       static int done = 0;
-       ASN1_STRING_TABLE *tmp;
-       if(done) return 1;
-       if(!stable) stable = sk_ASN1_STRING_TABLE_new(sk_table_cmp);
-       if(!stable) {
-               ASN1err(ASN1_F_ASN1_STRING_TABLE_ADD_STANDARD,
-                                               ERR_R_MALLOC_FAILURE);
-               return 0;
-       }
-       for(tmp = tbl_standard; tmp->nid != NID_undef; tmp++) {
-               if(!sk_ASN1_STRING_TABLE_push(stable, tmp)) {
-                       ASN1err(ASN1_F_ASN1_STRING_TABLE_ADD_STANDARD,
-                                                       ERR_R_MALLOC_FAILURE);
-                       return 0;
-               }
-       }
-       return 1;
+       return (*a)->nid - (*b)->nid;
 }
 
-static int sk_table_cmp(ASN1_STRING_TABLE **a, ASN1_STRING_TABLE **b)
+DECLARE_OBJ_BSEARCH_CMP_FN(ASN1_STRING_TABLE, ASN1_STRING_TABLE, table);
+
+static int table_cmp(const ASN1_STRING_TABLE *a, const ASN1_STRING_TABLE *b)
 {
-       return (*a)->nid - (*b)->nid;
+       return a->nid - b->nid;
 }
 
+IMPLEMENT_OBJ_BSEARCH_CMP_FN(ASN1_STRING_TABLE, ASN1_STRING_TABLE, table);
+
 ASN1_STRING_TABLE *ASN1_STRING_TABLE_get(int nid)
-{
+       {
        int idx;
        ASN1_STRING_TABLE fnd;
        fnd.nid = nid;
-       idx = sk_ASN1_STRING_TABLE_find(stable, &fnd);
-       if(idx < 0) return NULL;
-       return sk_ASN1_STRING_TABLE_value(stable, idx);
-}
-       
+       if (stable)
+               {
+               idx = sk_ASN1_STRING_TABLE_find(stable, &fnd);
+               if (idx >= 0)
+                       return sk_ASN1_STRING_TABLE_value(stable, idx);
+               }
+       return OBJ_bsearch_table(&fnd, tbl_standard, 
+                          sizeof(tbl_standard)/sizeof(ASN1_STRING_TABLE));
+       }
+
+/* Return a string table pointer which can be modified: either directly
+ * from table or a copy of an internal value added to the table.
+ */
+
+static ASN1_STRING_TABLE *stable_get(int nid)
+       {
+       ASN1_STRING_TABLE *tmp, *rv;
+       /* Always need a string table so allocate one if NULL */
+       if(!stable)
+               {
+               stable = sk_ASN1_STRING_TABLE_new(sk_table_cmp);
+               if (!stable)
+                       return NULL;
+               }
+       tmp = ASN1_STRING_TABLE_get(nid);
+       if (tmp && tmp->flags & STABLE_FLAGS_MALLOC)
+               return tmp;
+       rv = OPENSSL_malloc(sizeof(ASN1_STRING_TABLE));
+       if (!rv)
+               return NULL;
+       if (!sk_ASN1_STRING_TABLE_push(stable, rv))
+               {
+               OPENSSL_free(rv);
+               return NULL;
+               }
+       if (tmp)
+               {
+               rv->nid = tmp->nid;
+               rv->minsize = tmp->minsize;
+               rv->maxsize = tmp->maxsize;
+               rv->mask = tmp->mask;
+               rv->flags = tmp->flags | STABLE_FLAGS_MALLOC;
+               }
+       else
+               {
+               rv->minsize = -1;
+               rv->maxsize = -1;
+               rv->mask = 0;
+               rv->flags = STABLE_FLAGS_MALLOC;
+               }
+       return rv;
+       }
+
 int ASN1_STRING_TABLE_add(int nid,
                 long minsize, long maxsize, unsigned long mask,
                                unsigned long flags)
-{
+       {
        ASN1_STRING_TABLE *tmp;
-       char new_nid = 0;
-       if(!stable) stable = sk_ASN1_STRING_TABLE_new(sk_table_cmp);
-       if(!stable) {
+       tmp = stable_get(nid);
+       if (!tmp)
+               {
                ASN1err(ASN1_F_ASN1_STRING_TABLE_ADD, ERR_R_MALLOC_FAILURE);
                return 0;
-       }
-       if(!(tmp = ASN1_STRING_TABLE_get(nid))) {
-               tmp = Malloc(sizeof(ASN1_STRING_TABLE));
-               if(!tmp) {
-                       ASN1err(ASN1_F_ASN1_STRING_TABLE_ADD,
-                                                       ERR_R_MALLOC_FAILURE);
-                       return 0;
                }
-               tmp->flags = STABLE_FLAGS_MALLOC;
-               tmp->nid = nid;
-               new_nid = 1;
-       }
-       if(minsize != -1) tmp->minsize = minsize;
-       if(maxsize != -1) tmp->maxsize = maxsize;
-       tmp->mask = mask;
-       tmp->flags = flags & ~STABLE_FLAGS_MALLOC;
-       if(new_nid) sk_ASN1_STRING_TABLE_push(stable, tmp);
+       if (minsize >= 0)
+               tmp->minsize = minsize;
+       if (maxsize >= 0)
+               tmp->maxsize = maxsize;
+       if (mask)
+               tmp->mask = mask;
+       if (flags)
+               tmp->flags = STABLE_FLAGS_MALLOC | flags;
        return 1;
-}
+       }
 
 void ASN1_STRING_TABLE_cleanup(void)
 {
        STACK_OF(ASN1_STRING_TABLE) *tmp;
        tmp = stable;
+       if(!tmp) return;
        stable = NULL;
        sk_ASN1_STRING_TABLE_pop_free(tmp, st_free);
 }
 
 static void st_free(ASN1_STRING_TABLE *tbl)
 {
-       if(tbl->flags & STABLE_FLAGS_MALLOC) Free(tbl);
+       if(tbl->flags & STABLE_FLAGS_MALLOC) OPENSSL_free(tbl);
 }
 
+
 IMPLEMENT_STACK_OF(ASN1_STRING_TABLE)
+
+#ifdef STRING_TABLE_TEST
+
+main()
+{
+       ASN1_STRING_TABLE *tmp;
+       int i, last_nid = -1;
+
+       for (tmp = tbl_standard, i = 0;
+               i < sizeof(tbl_standard)/sizeof(ASN1_STRING_TABLE); i++, tmp++)
+               {
+                       if (tmp->nid < last_nid)
+                               {
+                               last_nid = 0;
+                               break;
+                               }
+                       last_nid = tmp->nid;
+               }
+
+       if (last_nid != 0)
+               {
+               printf("Table order OK\n");
+               exit(0);
+               }
+
+       for (tmp = tbl_standard, i = 0;
+               i < sizeof(tbl_standard)/sizeof(ASN1_STRING_TABLE); i++, tmp++)
+                       printf("Index %d, NID %d, Name=%s\n", i, tmp->nid,
+                                                       OBJ_nid2ln(tmp->nid));
+
+}
+
+#endif