crypto/asn1/a_strnid.c

   1 /* a_strnid.c */
   2 /* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL
   3  * project 1999.
   4  */
   5 /* ====================================================================
   6  * Copyright (c) 1999 The OpenSSL Project.  All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  *
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in
  17  *    the documentation and/or other materials provided with the
  18  *    distribution.
  19  *
  20  * 3. All advertising materials mentioning features or use of this
  21  *    software must display the following acknowledgment:
  22  *    "This product includes software developed by the OpenSSL Project
  23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  24  *
  25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  26  *    endorse or promote products derived from this software without
  27  *    prior written permission. For written permission, please contact
  28  *    licensing@OpenSSL.org.
  29  *
  30  * 5. Products derived from this software may not be called "OpenSSL"
  31  *    nor may "OpenSSL" appear in their names without prior written
  32  *    permission of the OpenSSL Project.
  33  *
  34  * 6. Redistributions of any form whatsoever must retain the following
  35  *    acknowledgment:
  36  *    "This product includes software developed by the OpenSSL Project
  37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  38  *
  39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  50  * OF THE POSSIBILITY OF SUCH DAMAGE.
  51  * ====================================================================
  52  *
  53  * This product includes cryptographic software written by Eric Young
  54  * (eay@cryptsoft.com).  This product includes software written by Tim
  55  * Hudson (tjh@cryptsoft.com).
  56  *
  57  */
  58
  59 #include <stdio.h>
  60 #include <ctype.h>
  61 #include "cryptlib.h"
  62 #include <openssl/asn1.h>
  63 #include <openssl/objects.h>
  64
  65
  66 static STACK_OF(ASN1_STRING_TABLE) *stable = NULL;
  67 static void st_free(ASN1_STRING_TABLE *tbl);
  68 static int sk_table_cmp(ASN1_STRING_TABLE **a, ASN1_STRING_TABLE **b);
  69 static int table_cmp(ASN1_STRING_TABLE *a, ASN1_STRING_TABLE *b);
  70
  71
  72 /* This is the global mask for the mbstring functions: this is use to
  73  * mask out certain types (such as BMPString and UTF8String) because
  74  * certain software (e.g. Netscape) has problems with them.
  75  */
  76
  77 static long global_mask = 0xFFFFFFFFL;
  78
  79 void ASN1_STRING_set_default_mask(unsigned long mask)
  80 {
  81         global_mask = mask;
  82 }
  83
  84 unsigned long ASN1_STRING_get_default_mask(void)
  85 {
  86         return global_mask;
  87 }
  88
  89 /* This function sets the default to various "flavours" of configuration.
  90  * based on an ASCII string. Currently this is:
  91  * MASK:XXXX : a numerical mask value.
  92  * nobmp : Don't use BMPStrings (just Printable, T61).
  93  * pkix : PKIX recommendation in RFC2459.
  94  * utf8only : only use UTF8Strings (RFC2459 recommendation for 2004).
  95  * default:   the default value, Printable, T61, BMP.
  96  */
  97
  98 int ASN1_STRING_set_default_mask_asc(char *p)
  99 {
 100         unsigned long mask;
 101         char *end;
 102         if(!strncmp(p, "MASK:", 5)) {
 103                 if(!p[5]) return 0;
 104                 mask = strtoul(p + 5, &end, 0);
 105                 if(*end) return 0;
 106         } else if(!strcmp(p, "nombstr"))
 107                          mask = ~(B_ASN1_BMPSTRING|B_ASN1_UTF8STRING);
 108         else if(!strcmp(p, "pkix"))
 109                         mask = ~B_ASN1_T61STRING;
 110         else if(!strcmp(p, "utf8only")) mask = B_ASN1_UTF8STRING;
 111         else if(!strcmp(p, "default"))
 112             mask = 0xFFFFFFFFL;
 113         else return 0;
 114         ASN1_STRING_set_default_mask(mask);
 115         return 1;
 116 }
 117
 118 /* The following function generates an ASN1_STRING based on limits in a table.
 119  * Frequently the types and length of an ASN1_STRING are restricted by a
 120  * corresponding OID. For example certificates and certificate requests.
 121  */
 122
 123 ASN1_STRING *ASN1_STRING_set_by_NID(ASN1_STRING **out, const unsigned char *in,
 124                                         int inlen, int inform, int nid)
 125 {
 126         ASN1_STRING_TABLE *tbl;
 127         ASN1_STRING *str = NULL;
 128         unsigned long mask;
 129         int ret;
 130         if(!out) out = &str;
 131         tbl = ASN1_STRING_TABLE_get(nid);
 132         if(tbl) {
 133                 mask = tbl->mask;
 134                 if(!(tbl->flags & STABLE_NO_MASK)) mask &= global_mask;
 135                 ret = ASN1_mbstring_ncopy(out, in, inlen, inform, tbl->mask,
 136                                         tbl->minsize, tbl->maxsize);
 137         } else ret = ASN1_mbstring_copy(out, in, inlen, inform, DIRSTRING_TYPE & global_mask);
 138         if(ret <= 0) return NULL;
 139         return *out;
 140 }
 141
 142 /* Now the tables and helper functions for the string table:
 143  */
 144
 145 /* size limits: this stuff is taken straight from RFC2459 */
 146
 147 #define ub_name                         32768
 148 #define ub_common_name                  64
 149 #define ub_locality_name                128
 150 #define ub_state_name                   128
 151 #define ub_organization_name            64
 152 #define ub_organization_unit_name       64
 153 #define ub_title                        64
 154 #define ub_email_address                128
 155
 156 /* This table must be kept in NID order */
 157
 158 static ASN1_STRING_TABLE tbl_standard[] = {
 159 {NID_commonName,                1, ub_common_name, DIRSTRING_TYPE, 0},
 160 {NID_countryName,               2, 2, B_ASN1_PRINTABLESTRING, STABLE_NO_MASK},
 161 {NID_localityName,              1, ub_locality_name, DIRSTRING_TYPE, 0},
 162 {NID_stateOrProvinceName,       1, ub_state_name, DIRSTRING_TYPE, 0},
 163 {NID_organizationName,          1, ub_organization_name, DIRSTRING_TYPE, 0},
 164 {NID_organizationalUnitName,    1, ub_organization_unit_name, DIRSTRING_TYPE, 0},
 165 {NID_pkcs9_emailAddress,        1, ub_email_address, B_ASN1_IA5STRING, STABLE_NO_MASK},
 166 {NID_pkcs9_unstructuredName,    1, -1, PKCS9STRING_TYPE, 0},
 167 {NID_pkcs9_challengePassword,   1, -1, PKCS9STRING_TYPE, 0},
 168 {NID_pkcs9_unstructuredAddress, 1, -1, DIRSTRING_TYPE, 0},
 169 {NID_givenName,                 1, ub_name, DIRSTRING_TYPE, 0},
 170 {NID_surname,                   1, ub_name, DIRSTRING_TYPE, 0},
 171 {NID_initials,                  1, ub_name, DIRSTRING_TYPE, 0},
 172 {NID_name,                      1, ub_name, DIRSTRING_TYPE, 0},
 173 {NID_dnQualifier,               -1, -1, B_ASN1_PRINTABLESTRING, STABLE_NO_MASK}
 174 };
 175
 176 static int sk_table_cmp(ASN1_STRING_TABLE **a, ASN1_STRING_TABLE **b)
 177 {
 178         return (*a)->nid - (*b)->nid;
 179 }
 180
 181 static int table_cmp(ASN1_STRING_TABLE *a, ASN1_STRING_TABLE *b)
 182 {
 183         return a->nid - b->nid;
 184 }
 185
 186 ASN1_STRING_TABLE *ASN1_STRING_TABLE_get(int nid)
 187 {
 188         int idx;
 189         ASN1_STRING_TABLE *ttmp;
 190         ASN1_STRING_TABLE fnd;
 191         fnd.nid = nid;
 192         ttmp = (ASN1_STRING_TABLE *) OBJ_bsearch((char *)&fnd,
 193                                         (char *)tbl_standard,
 194                         sizeof(tbl_standard)/sizeof(ASN1_STRING_TABLE),
 195                         sizeof(ASN1_STRING_TABLE), (int(*)())table_cmp);
 196         if(ttmp) return ttmp;
 197         if(!stable) return NULL;
 198         idx = sk_ASN1_STRING_TABLE_find(stable, &fnd);
 199         if(idx < 0) return NULL;
 200         return sk_ASN1_STRING_TABLE_value(stable, idx);
 201 }
 202
 203 int ASN1_STRING_TABLE_add(int nid,
 204                  long minsize, long maxsize, unsigned long mask,
 205                                 unsigned long flags)
 206 {
 207         ASN1_STRING_TABLE *tmp;
 208         char new_nid = 0;
 209         flags &= ~STABLE_FLAGS_MALLOC;
 210         if(!stable) stable = sk_ASN1_STRING_TABLE_new(sk_table_cmp);
 211         if(!stable) {
 212                 ASN1err(ASN1_F_ASN1_STRING_TABLE_ADD, ERR_R_MALLOC_FAILURE);
 213                 return 0;
 214         }
 215         if(!(tmp = ASN1_STRING_TABLE_get(nid))) {
 216                 tmp = Malloc(sizeof(ASN1_STRING_TABLE));
 217                 if(!tmp) {
 218                         ASN1err(ASN1_F_ASN1_STRING_TABLE_ADD,
 219                                                         ERR_R_MALLOC_FAILURE);
 220                         return 0;
 221                 }
 222                 tmp->flags = flags | STABLE_FLAGS_MALLOC;
 223                 tmp->nid = nid;
 224                 new_nid = 1;
 225         } else tmp->flags = (tmp->flags & STABLE_FLAGS_MALLOC) | flags;
 226         if(minsize != -1) tmp->minsize = minsize;
 227         if(maxsize != -1) tmp->maxsize = maxsize;
 228         tmp->mask = mask;
 229         if(new_nid) sk_ASN1_STRING_TABLE_push(stable, tmp);
 230         return 1;
 231 }
 232
 233 void ASN1_STRING_TABLE_cleanup(void)
 234 {
 235         STACK_OF(ASN1_STRING_TABLE) *tmp;
 236         tmp = stable;
 237         if(!tmp) return;
 238         stable = NULL;
 239         sk_ASN1_STRING_TABLE_pop_free(tmp, st_free);
 240 }
 241
 242 static void st_free(ASN1_STRING_TABLE *tbl)
 243 {
 244         if(tbl->flags & STABLE_FLAGS_MALLOC) Free(tbl);
 245 }
 246
 247 IMPLEMENT_STACK_OF(ASN1_STRING_TABLE)