Home | History | Annotate | Download | only in asn1
      1 /* Copyright (C) 1995-1998 Eric Young (eay (at) cryptsoft.com)
      2  * All rights reserved.
      3  *
      4  * This package is an SSL implementation written
      5  * by Eric Young (eay (at) cryptsoft.com).
      6  * The implementation was written so as to conform with Netscapes SSL.
      7  *
      8  * This library is free for commercial and non-commercial use as long as
      9  * the following conditions are aheared to.  The following conditions
     10  * apply to all code found in this distribution, be it the RC4, RSA,
     11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
     12  * included with this distribution is covered by the same copyright terms
     13  * except that the holder is Tim Hudson (tjh (at) cryptsoft.com).
     14  *
     15  * Copyright remains Eric Young's, and as such any Copyright notices in
     16  * the code are not to be removed.
     17  * If this package is used in a product, Eric Young should be given attribution
     18  * as the author of the parts of the library used.
     19  * This can be in the form of a textual message at program startup or
     20  * in documentation (online or textual) provided with the package.
     21  *
     22  * Redistribution and use in source and binary forms, with or without
     23  * modification, are permitted provided that the following conditions
     24  * are met:
     25  * 1. Redistributions of source code must retain the copyright
     26  *    notice, this list of conditions and the following disclaimer.
     27  * 2. Redistributions in binary form must reproduce the above copyright
     28  *    notice, this list of conditions and the following disclaimer in the
     29  *    documentation and/or other materials provided with the distribution.
     30  * 3. All advertising materials mentioning features or use of this software
     31  *    must display the following acknowledgement:
     32  *    "This product includes cryptographic software written by
     33  *     Eric Young (eay (at) cryptsoft.com)"
     34  *    The word 'cryptographic' can be left out if the rouines from the library
     35  *    being used are not cryptographic related :-).
     36  * 4. If you include any Windows specific code (or a derivative thereof) from
     37  *    the apps directory (application code) you must include an acknowledgement:
     38  *    "This product includes software written by Tim Hudson (tjh (at) cryptsoft.com)"
     39  *
     40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
     41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
     44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     50  * SUCH DAMAGE.
     51  *
     52  * The licence and distribution terms for any publically available version or
     53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
     54  * copied and put under another distribution licence
     55  * [including the GNU Public Licence.] */
     56 
     57 #include <openssl/asn1.h>
     58 
     59 #include <stdlib.h>  /* For bsearch */
     60 
     61 #include <openssl/err.h>
     62 #include <openssl/mem.h>
     63 #include <openssl/obj.h>
     64 
     65 
     66 static STACK_OF(ASN1_STRING_TABLE) *stable = NULL;
     67 static void st_free(ASN1_STRING_TABLE *tbl);
     68 
     69 /* This is the global mask for the mbstring functions: this is use to
     70  * mask out certain types (such as BMPString and UTF8String) because
     71  * certain software (e.g. Netscape) has problems with them.
     72  */
     73 
     74 static unsigned long global_mask = B_ASN1_UTF8STRING;
     75 
     76 void ASN1_STRING_set_default_mask(unsigned long mask)
     77 {
     78 	global_mask = mask;
     79 }
     80 
     81 unsigned long ASN1_STRING_get_default_mask(void)
     82 {
     83 	return global_mask;
     84 }
     85 
     86 /* This function sets the default to various "flavours" of configuration.
     87  * based on an ASCII string. Currently this is:
     88  * MASK:XXXX : a numerical mask value.
     89  * nobmp : Don't use BMPStrings (just Printable, T61).
     90  * pkix : PKIX recommendation in RFC2459.
     91  * utf8only : only use UTF8Strings (RFC2459 recommendation for 2004).
     92  * default:   the default value, Printable, T61, BMP.
     93  */
     94 
     95 int ASN1_STRING_set_default_mask_asc(const char *p)
     96 {
     97 	unsigned long mask;
     98 	char *end;
     99 	if(!strncmp(p, "MASK:", 5)) {
    100 		if(!p[5]) return 0;
    101 		mask = strtoul(p + 5, &end, 0);
    102 		if(*end) return 0;
    103 	} else if(!strcmp(p, "nombstr"))
    104 			 mask = ~((unsigned long)(B_ASN1_BMPSTRING|B_ASN1_UTF8STRING));
    105 	else if(!strcmp(p, "pkix"))
    106 			mask = ~((unsigned long)B_ASN1_T61STRING);
    107 	else if(!strcmp(p, "utf8only")) mask = B_ASN1_UTF8STRING;
    108 	else if(!strcmp(p, "default"))
    109 	    mask = 0xFFFFFFFFL;
    110 	else return 0;
    111 	ASN1_STRING_set_default_mask(mask);
    112 	return 1;
    113 }
    114 
    115 /* The following function generates an ASN1_STRING based on limits in a table.
    116  * Frequently the types and length of an ASN1_STRING are restricted by a
    117  * corresponding OID. For example certificates and certificate requests.
    118  */
    119 
    120 ASN1_STRING *ASN1_STRING_set_by_NID(ASN1_STRING **out, const unsigned char *in,
    121 					int inlen, int inform, int nid)
    122 {
    123 	ASN1_STRING_TABLE *tbl;
    124 	ASN1_STRING *str = NULL;
    125 	unsigned long mask;
    126 	int ret;
    127 	if(!out) out = &str;
    128 	tbl = ASN1_STRING_TABLE_get(nid);
    129 	if(tbl) {
    130 		mask = tbl->mask;
    131 		if(!(tbl->flags & STABLE_NO_MASK)) mask &= global_mask;
    132 		ret = ASN1_mbstring_ncopy(out, in, inlen, inform, mask,
    133 					tbl->minsize, tbl->maxsize);
    134 	} else ret = ASN1_mbstring_copy(out, in, inlen, inform, DIRSTRING_TYPE & global_mask);
    135 	if(ret <= 0) return NULL;
    136 	return *out;
    137 }
    138 
    139 /* Now the tables and helper functions for the string table:
    140  */
    141 
    142 /* size limits: this stuff is taken straight from RFC3280 */
    143 
    144 #define ub_name				32768
    145 #define ub_common_name			64
    146 #define ub_locality_name		128
    147 #define ub_state_name			128
    148 #define ub_organization_name		64
    149 #define ub_organization_unit_name	64
    150 #define ub_title			64
    151 #define ub_email_address		128
    152 #define ub_serial_number		64
    153 
    154 
    155 /* This table must be kept in NID order */
    156 
    157 static const ASN1_STRING_TABLE tbl_standard[] = {
    158 {NID_commonName,		1, ub_common_name, DIRSTRING_TYPE, 0},
    159 {NID_countryName,		2, 2, B_ASN1_PRINTABLESTRING, STABLE_NO_MASK},
    160 {NID_localityName,		1, ub_locality_name, DIRSTRING_TYPE, 0},
    161 {NID_stateOrProvinceName,	1, ub_state_name, DIRSTRING_TYPE, 0},
    162 {NID_organizationName,		1, ub_organization_name, DIRSTRING_TYPE, 0},
    163 {NID_organizationalUnitName,	1, ub_organization_unit_name, DIRSTRING_TYPE, 0},
    164 {NID_pkcs9_emailAddress,	1, ub_email_address, B_ASN1_IA5STRING, STABLE_NO_MASK},
    165 {NID_pkcs9_unstructuredName,	1, -1, PKCS9STRING_TYPE, 0},
    166 {NID_pkcs9_challengePassword,	1, -1, PKCS9STRING_TYPE, 0},
    167 {NID_pkcs9_unstructuredAddress,	1, -1, DIRSTRING_TYPE, 0},
    168 {NID_givenName,			1, ub_name, DIRSTRING_TYPE, 0},
    169 {NID_surname,			1, ub_name, DIRSTRING_TYPE, 0},
    170 {NID_initials,			1, ub_name, DIRSTRING_TYPE, 0},
    171 {NID_serialNumber,		1, ub_serial_number, B_ASN1_PRINTABLESTRING, STABLE_NO_MASK},
    172 {NID_friendlyName,		-1, -1, B_ASN1_BMPSTRING, STABLE_NO_MASK},
    173 {NID_name,			1, ub_name, DIRSTRING_TYPE, 0},
    174 {NID_dnQualifier,		-1, -1, B_ASN1_PRINTABLESTRING, STABLE_NO_MASK},
    175 {NID_domainComponent,		1, -1, B_ASN1_IA5STRING, STABLE_NO_MASK},
    176 {NID_ms_csp_name,		-1, -1, B_ASN1_BMPSTRING, STABLE_NO_MASK}
    177 };
    178 
    179 static int sk_table_cmp(const ASN1_STRING_TABLE **a,
    180 			const ASN1_STRING_TABLE **b)
    181 {
    182 	return (*a)->nid - (*b)->nid;
    183 }
    184 
    185 static int table_cmp(const void *in_a, const void *in_b)
    186 {
    187 	const ASN1_STRING_TABLE *a = in_a;
    188 	const ASN1_STRING_TABLE *b = in_b;
    189 	return a->nid - b->nid;
    190 }
    191 
    192 ASN1_STRING_TABLE *ASN1_STRING_TABLE_get(int nid)
    193 {
    194 	int found;
    195 	size_t idx;
    196 	ASN1_STRING_TABLE *ttmp;
    197 	ASN1_STRING_TABLE fnd;
    198 	fnd.nid = nid;
    199 
    200 	ttmp = bsearch(&fnd, tbl_standard, sizeof(tbl_standard)/sizeof(ASN1_STRING_TABLE), sizeof(ASN1_STRING_TABLE), table_cmp);
    201 	if(ttmp) return ttmp;
    202 	if(!stable) return NULL;
    203 	found = sk_ASN1_STRING_TABLE_find(stable, &idx, &fnd);
    204 	if (!found) return NULL;
    205 	return sk_ASN1_STRING_TABLE_value(stable, idx);
    206 }
    207 
    208 int ASN1_STRING_TABLE_add(int nid,
    209 		 long minsize, long maxsize, unsigned long mask,
    210 				unsigned long flags)
    211 {
    212 	ASN1_STRING_TABLE *tmp;
    213 	char new_nid = 0;
    214 	flags &= ~STABLE_FLAGS_MALLOC;
    215 	if(!stable) stable = sk_ASN1_STRING_TABLE_new(sk_table_cmp);
    216 	if(!stable) {
    217 		OPENSSL_PUT_ERROR(ASN1, ASN1_STRING_TABLE_add,  ERR_R_MALLOC_FAILURE);
    218 		return 0;
    219 	}
    220 	if(!(tmp = ASN1_STRING_TABLE_get(nid))) {
    221 		tmp = OPENSSL_malloc(sizeof(ASN1_STRING_TABLE));
    222 		if(!tmp) {
    223 			OPENSSL_PUT_ERROR(ASN1, ASN1_STRING_TABLE_add,  ERR_R_MALLOC_FAILURE);
    224 			return 0;
    225 		}
    226 		tmp->flags = flags | STABLE_FLAGS_MALLOC;
    227 		tmp->nid = nid;
    228 		new_nid = 1;
    229 	} else tmp->flags = (tmp->flags & STABLE_FLAGS_MALLOC) | flags;
    230 	if(minsize != -1) tmp->minsize = minsize;
    231 	if(maxsize != -1) tmp->maxsize = maxsize;
    232 	tmp->mask = mask;
    233 	if(new_nid) sk_ASN1_STRING_TABLE_push(stable, tmp);
    234 	return 1;
    235 }
    236 
    237 void ASN1_STRING_TABLE_cleanup(void)
    238 {
    239 	STACK_OF(ASN1_STRING_TABLE) *tmp;
    240 	tmp = stable;
    241 	if(!tmp) return;
    242 	stable = NULL;
    243 	sk_ASN1_STRING_TABLE_pop_free(tmp, st_free);
    244 }
    245 
    246 static void st_free(ASN1_STRING_TABLE *tbl)
    247 {
    248 	if(tbl->flags & STABLE_FLAGS_MALLOC) OPENSSL_free(tbl);
    249 }
    250 
    251 
    252 #ifdef STRING_TABLE_TEST
    253 
    254 int
    255 main(void)
    256 {
    257 	ASN1_STRING_TABLE *tmp;
    258 	int i, last_nid = -1;
    259 
    260 	for (tmp = tbl_standard, i = 0;
    261 		i < sizeof(tbl_standard)/sizeof(ASN1_STRING_TABLE); i++, tmp++)
    262 		{
    263 			if (tmp->nid < last_nid)
    264 				{
    265 				last_nid = 0;
    266 				break;
    267 				}
    268 			last_nid = tmp->nid;
    269 		}
    270 
    271 	if (last_nid != 0)
    272 		{
    273 		printf("Table order OK\n");
    274 		exit(0);
    275 		}
    276 
    277 	for (tmp = tbl_standard, i = 0;
    278 		i < sizeof(tbl_standard)/sizeof(ASN1_STRING_TABLE); i++, tmp++)
    279 			printf("Index %d, NID %d, Name=%s\n", i, tmp->nid,
    280 							OBJ_nid2ln(tmp->nid));
    281 
    282 	return 0;
    283 }
    284 
    285 #endif
    286