3 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
6 /* ====================================================================
7 * Copyright (c) 1999 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
21 * 3. All advertising materials mentioning features or use of this
22 * software must display the following acknowledgment:
23 * "This product includes software developed by the OpenSSL Project
24 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 * endorse or promote products derived from this software without
28 * prior written permission. For written permission, please contact
29 * licensing@OpenSSL.org.
31 * 5. Products derived from this software may not be called "OpenSSL"
32 * nor may "OpenSSL" appear in their names without prior written
33 * permission of the OpenSSL Project.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 * OF THE POSSIBILITY OF SUCH DAMAGE.
52 * ====================================================================
54 * This product includes cryptographic software written by Eric Young
55 * (eay@cryptsoft.com). This product includes software written by Tim
56 * Hudson (tjh@cryptsoft.com).
63 #include <openssl/asn1.h>
64 #include <openssl/objects.h>
66 static STACK_OF(ASN1_STRING_TABLE
) *stable
= NULL
;
67 static void st_free(ASN1_STRING_TABLE
*tbl
);
68 static int sk_table_cmp(const ASN1_STRING_TABLE
*const *a
,
69 const ASN1_STRING_TABLE
*const *b
);
72 * This is the global mask for the mbstring functions: this is use to mask
73 * out certain types (such as BMPString and UTF8String) because certain
74 * software (e.g. Netscape) has problems with them.
77 static unsigned long global_mask
= B_ASN1_UTF8STRING
;
79 void ASN1_STRING_set_default_mask(unsigned long mask
)
84 unsigned long ASN1_STRING_get_default_mask(void)
90 * This function sets the default to various "flavours" of configuration.
91 * based on an ASCII string. Currently this is:
92 * MASK:XXXX : a numerical mask value.
93 * nobmp : Don't use BMPStrings (just Printable, T61).
94 * pkix : PKIX recommendation in RFC2459.
95 * utf8only : only use UTF8Strings (RFC2459 recommendation for 2004).
96 * default: the default value, Printable, T61, BMP.
99 int ASN1_STRING_set_default_mask_asc(const char *p
)
103 if (!strncmp(p
, "MASK:", 5)) {
106 mask
= strtoul(p
+ 5, &end
, 0);
109 } else if (!strcmp(p
, "nombstr"))
110 mask
= ~((unsigned long)(B_ASN1_BMPSTRING
| B_ASN1_UTF8STRING
));
111 else if (!strcmp(p
, "pkix"))
112 mask
= ~((unsigned long)B_ASN1_T61STRING
);
113 else if (!strcmp(p
, "utf8only"))
114 mask
= B_ASN1_UTF8STRING
;
115 else if (!strcmp(p
, "default"))
119 ASN1_STRING_set_default_mask(mask
);
124 * The following function generates an ASN1_STRING based on limits in a
125 * table. Frequently the types and length of an ASN1_STRING are restricted by
126 * a corresponding OID. For example certificates and certificate requests.
129 ASN1_STRING
*ASN1_STRING_set_by_NID(ASN1_STRING
**out
,
130 const unsigned char *in
, int inlen
,
133 ASN1_STRING_TABLE
*tbl
;
134 ASN1_STRING
*str
= NULL
;
139 tbl
= ASN1_STRING_TABLE_get(nid
);
142 if (!(tbl
->flags
& STABLE_NO_MASK
))
144 ret
= ASN1_mbstring_ncopy(out
, in
, inlen
, inform
, mask
,
145 tbl
->minsize
, tbl
->maxsize
);
148 ASN1_mbstring_copy(out
, in
, inlen
, inform
,
149 DIRSTRING_TYPE
& global_mask
);
156 * Now the tables and helper functions for the string table:
159 /* size limits: this stuff is taken straight from RFC3280 */
161 #define ub_name 32768
162 #define ub_common_name 64
163 #define ub_locality_name 128
164 #define ub_state_name 128
165 #define ub_organization_name 64
166 #define ub_organization_unit_name 64
168 #define ub_email_address 128
169 #define ub_serial_number 64
171 /* This table must be kept in NID order */
173 static const ASN1_STRING_TABLE tbl_standard
[] = {
174 {NID_commonName
, 1, ub_common_name
, DIRSTRING_TYPE
, 0},
175 {NID_countryName
, 2, 2, B_ASN1_PRINTABLESTRING
, STABLE_NO_MASK
},
176 {NID_localityName
, 1, ub_locality_name
, DIRSTRING_TYPE
, 0},
177 {NID_stateOrProvinceName
, 1, ub_state_name
, DIRSTRING_TYPE
, 0},
178 {NID_organizationName
, 1, ub_organization_name
, DIRSTRING_TYPE
, 0},
179 {NID_organizationalUnitName
, 1, ub_organization_unit_name
, DIRSTRING_TYPE
,
181 {NID_pkcs9_emailAddress
, 1, ub_email_address
, B_ASN1_IA5STRING
,
183 {NID_pkcs9_unstructuredName
, 1, -1, PKCS9STRING_TYPE
, 0},
184 {NID_pkcs9_challengePassword
, 1, -1, PKCS9STRING_TYPE
, 0},
185 {NID_pkcs9_unstructuredAddress
, 1, -1, DIRSTRING_TYPE
, 0},
186 {NID_givenName
, 1, ub_name
, DIRSTRING_TYPE
, 0},
187 {NID_surname
, 1, ub_name
, DIRSTRING_TYPE
, 0},
188 {NID_initials
, 1, ub_name
, DIRSTRING_TYPE
, 0},
189 {NID_serialNumber
, 1, ub_serial_number
, B_ASN1_PRINTABLESTRING
,
191 {NID_friendlyName
, -1, -1, B_ASN1_BMPSTRING
, STABLE_NO_MASK
},
192 {NID_name
, 1, ub_name
, DIRSTRING_TYPE
, 0},
193 {NID_dnQualifier
, -1, -1, B_ASN1_PRINTABLESTRING
, STABLE_NO_MASK
},
194 {NID_domainComponent
, 1, -1, B_ASN1_IA5STRING
, STABLE_NO_MASK
},
195 {NID_ms_csp_name
, -1, -1, B_ASN1_BMPSTRING
, STABLE_NO_MASK
}
198 static int sk_table_cmp(const ASN1_STRING_TABLE
*const *a
,
199 const ASN1_STRING_TABLE
*const *b
)
201 return (*a
)->nid
- (*b
)->nid
;
204 DECLARE_OBJ_BSEARCH_CMP_FN(ASN1_STRING_TABLE
, ASN1_STRING_TABLE
, table
);
206 static int table_cmp(const ASN1_STRING_TABLE
*a
, const ASN1_STRING_TABLE
*b
)
208 return a
->nid
- b
->nid
;
211 IMPLEMENT_OBJ_BSEARCH_CMP_FN(ASN1_STRING_TABLE
, ASN1_STRING_TABLE
, table
);
213 ASN1_STRING_TABLE
*ASN1_STRING_TABLE_get(int nid
)
216 ASN1_STRING_TABLE fnd
;
219 idx
= sk_ASN1_STRING_TABLE_find(stable
, &fnd
);
221 return sk_ASN1_STRING_TABLE_value(stable
, idx
);
223 return OBJ_bsearch_table(&fnd
, tbl_standard
,
224 sizeof(tbl_standard
) /
225 sizeof(ASN1_STRING_TABLE
));
229 * Return a string table pointer which can be modified: either directly from
230 * table or a copy of an internal value added to the table.
233 static ASN1_STRING_TABLE
*stable_get(int nid
)
235 ASN1_STRING_TABLE
*tmp
, *rv
;
236 /* Always need a string table so allocate one if NULL */
238 stable
= sk_ASN1_STRING_TABLE_new(sk_table_cmp
);
242 tmp
= ASN1_STRING_TABLE_get(nid
);
243 if (tmp
&& tmp
->flags
& STABLE_FLAGS_MALLOC
)
245 rv
= OPENSSL_malloc(sizeof(ASN1_STRING_TABLE
));
248 if (!sk_ASN1_STRING_TABLE_push(stable
, rv
)) {
254 rv
->minsize
= tmp
->minsize
;
255 rv
->maxsize
= tmp
->maxsize
;
256 rv
->mask
= tmp
->mask
;
257 rv
->flags
= tmp
->flags
| STABLE_FLAGS_MALLOC
;
262 rv
->flags
= STABLE_FLAGS_MALLOC
;
267 int ASN1_STRING_TABLE_add(int nid
,
268 long minsize
, long maxsize
, unsigned long mask
,
271 ASN1_STRING_TABLE
*tmp
;
272 tmp
= stable_get(nid
);
274 ASN1err(ASN1_F_ASN1_STRING_TABLE_ADD
, ERR_R_MALLOC_FAILURE
);
278 tmp
->minsize
= minsize
;
280 tmp
->maxsize
= maxsize
;
284 tmp
->flags
= STABLE_FLAGS_MALLOC
| flags
;
288 void ASN1_STRING_TABLE_cleanup(void)
290 STACK_OF(ASN1_STRING_TABLE
) *tmp
;
295 sk_ASN1_STRING_TABLE_pop_free(tmp
, st_free
);
298 static void st_free(ASN1_STRING_TABLE
*tbl
)
300 if (tbl
->flags
& STABLE_FLAGS_MALLOC
)
305 #ifdef STRING_TABLE_TEST
309 ASN1_STRING_TABLE
*tmp
;
310 int i
, last_nid
= -1;
312 for (tmp
= tbl_standard
, i
= 0;
313 i
< sizeof(tbl_standard
) / sizeof(ASN1_STRING_TABLE
); i
++, tmp
++) {
314 if (tmp
->nid
< last_nid
) {
322 printf("Table order OK\n");
326 for (tmp
= tbl_standard
, i
= 0;
327 i
< sizeof(tbl_standard
) / sizeof(ASN1_STRING_TABLE
); i
++, tmp
++)
328 printf("Index %d, NID %d, Name=%s\n", i
, tmp
->nid
,
329 OBJ_nid2ln(tmp
->nid
));