1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2  * All rights reserved.
3  *
4  * This package is an SSL implementation written
5  * by Eric Young (eay@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@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@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@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 #include <string.h>
61 
62 #include <openssl/err.h>
63 #include <openssl/mem.h>
64 #include <openssl/obj.h>
65 
66 static STACK_OF(ASN1_STRING_TABLE) *stable = NULL;
67 static void st_free(ASN1_STRING_TABLE *tbl);
68 
69 /*
70  * This is the global mask for the mbstring functions: this is use to mask
71  * out certain types (such as BMPString and UTF8String) because certain
72  * software (e.g. Netscape) has problems with them.
73  */
74 
75 static unsigned long global_mask = B_ASN1_UTF8STRING;
76 
ASN1_STRING_set_default_mask(unsigned long mask)77 void ASN1_STRING_set_default_mask(unsigned long mask)
78 {
79     global_mask = mask;
80 }
81 
ASN1_STRING_get_default_mask(void)82 unsigned long ASN1_STRING_get_default_mask(void)
83 {
84     return global_mask;
85 }
86 
87 /*
88  * This function sets the default to various "flavours" of configuration.
89  * based on an ASCII string. Currently this is: MASK:XXXX : a numerical mask
90  * value. nobmp : Don't use BMPStrings (just Printable, T61). pkix : PKIX
91  * recommendation in RFC2459. utf8only : only use UTF8Strings (RFC2459
92  * recommendation for 2004). default: the default value, Printable, T61, BMP.
93  */
94 
ASN1_STRING_set_default_mask_asc(const char * p)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])
101             return 0;
102         mask = strtoul(p + 5, &end, 0);
103         if (*end)
104             return 0;
105     } else if (!strcmp(p, "nombstr"))
106         mask = ~((unsigned long)(B_ASN1_BMPSTRING | B_ASN1_UTF8STRING));
107     else if (!strcmp(p, "pkix"))
108         mask = ~((unsigned long)B_ASN1_T61STRING);
109     else if (!strcmp(p, "utf8only"))
110         mask = B_ASN1_UTF8STRING;
111     else if (!strcmp(p, "default"))
112         mask = 0xFFFFFFFFL;
113     else
114         return 0;
115     ASN1_STRING_set_default_mask(mask);
116     return 1;
117 }
118 
119 /*
120  * The following function generates an ASN1_STRING based on limits in a
121  * table. Frequently the types and length of an ASN1_STRING are restricted by
122  * a corresponding OID. For example certificates and certificate requests.
123  */
124 
ASN1_STRING_set_by_NID(ASN1_STRING ** out,const unsigned char * in,int inlen,int inform,int nid)125 ASN1_STRING *ASN1_STRING_set_by_NID(ASN1_STRING **out,
126                                     const unsigned char *in, int inlen,
127                                     int inform, int nid)
128 {
129     ASN1_STRING_TABLE *tbl;
130     ASN1_STRING *str = NULL;
131     unsigned long mask;
132     int ret;
133     if (!out)
134         out = &str;
135     tbl = ASN1_STRING_TABLE_get(nid);
136     if (tbl) {
137         mask = tbl->mask;
138         if (!(tbl->flags & STABLE_NO_MASK))
139             mask &= global_mask;
140         ret = ASN1_mbstring_ncopy(out, in, inlen, inform, mask,
141                                   tbl->minsize, tbl->maxsize);
142     } else
143         ret =
144             ASN1_mbstring_copy(out, in, inlen, inform,
145                                DIRSTRING_TYPE & global_mask);
146     if (ret <= 0)
147         return NULL;
148     return *out;
149 }
150 
151 /*
152  * Now the tables and helper functions for the string table:
153  */
154 
155 /* size limits: this stuff is taken straight from RFC3280 */
156 
157 #define ub_name                         32768
158 #define ub_common_name                  64
159 #define ub_locality_name                128
160 #define ub_state_name                   128
161 #define ub_organization_name            64
162 #define ub_organization_unit_name       64
163 #define ub_title                        64
164 #define ub_email_address                128
165 #define ub_serial_number                64
166 
167 /* This table must be kept in NID order */
168 
169 static const ASN1_STRING_TABLE tbl_standard[] = {
170     {NID_commonName, 1, ub_common_name, DIRSTRING_TYPE, 0},
171     {NID_countryName, 2, 2, B_ASN1_PRINTABLESTRING, STABLE_NO_MASK},
172     {NID_localityName, 1, ub_locality_name, DIRSTRING_TYPE, 0},
173     {NID_stateOrProvinceName, 1, ub_state_name, DIRSTRING_TYPE, 0},
174     {NID_organizationName, 1, ub_organization_name, DIRSTRING_TYPE, 0},
175     {NID_organizationalUnitName, 1, ub_organization_unit_name, DIRSTRING_TYPE,
176      0},
177     {NID_pkcs9_emailAddress, 1, ub_email_address, B_ASN1_IA5STRING,
178      STABLE_NO_MASK},
179     {NID_pkcs9_unstructuredName, 1, -1, PKCS9STRING_TYPE, 0},
180     {NID_pkcs9_challengePassword, 1, -1, PKCS9STRING_TYPE, 0},
181     {NID_pkcs9_unstructuredAddress, 1, -1, DIRSTRING_TYPE, 0},
182     {NID_givenName, 1, ub_name, DIRSTRING_TYPE, 0},
183     {NID_surname, 1, ub_name, DIRSTRING_TYPE, 0},
184     {NID_initials, 1, ub_name, DIRSTRING_TYPE, 0},
185     {NID_serialNumber, 1, ub_serial_number, B_ASN1_PRINTABLESTRING,
186      STABLE_NO_MASK},
187     {NID_friendlyName, -1, -1, B_ASN1_BMPSTRING, STABLE_NO_MASK},
188     {NID_name, 1, ub_name, DIRSTRING_TYPE, 0},
189     {NID_dnQualifier, -1, -1, B_ASN1_PRINTABLESTRING, STABLE_NO_MASK},
190     {NID_domainComponent, 1, -1, B_ASN1_IA5STRING, STABLE_NO_MASK},
191     {NID_ms_csp_name, -1, -1, B_ASN1_BMPSTRING, STABLE_NO_MASK}
192 };
193 
sk_table_cmp(const ASN1_STRING_TABLE ** a,const ASN1_STRING_TABLE ** b)194 static int sk_table_cmp(const ASN1_STRING_TABLE **a,
195                         const ASN1_STRING_TABLE **b)
196 {
197     return (*a)->nid - (*b)->nid;
198 }
199 
table_cmp(const void * in_a,const void * in_b)200 static int table_cmp(const void *in_a, const void *in_b)
201 {
202     const ASN1_STRING_TABLE *a = in_a;
203     const ASN1_STRING_TABLE *b = in_b;
204     return a->nid - b->nid;
205 }
206 
ASN1_STRING_TABLE_get(int nid)207 ASN1_STRING_TABLE *ASN1_STRING_TABLE_get(int nid)
208 {
209     int found;
210     size_t idx;
211     ASN1_STRING_TABLE *ttmp;
212     ASN1_STRING_TABLE fnd;
213     fnd.nid = nid;
214 
215     ttmp =
216         bsearch(&fnd, tbl_standard,
217                 sizeof(tbl_standard) / sizeof(ASN1_STRING_TABLE),
218                 sizeof(ASN1_STRING_TABLE), table_cmp);
219     if (ttmp)
220         return ttmp;
221     if (!stable)
222         return NULL;
223     found = sk_ASN1_STRING_TABLE_find(stable, &idx, &fnd);
224     if (!found)
225         return NULL;
226     return sk_ASN1_STRING_TABLE_value(stable, idx);
227 }
228 
ASN1_STRING_TABLE_add(int nid,long minsize,long maxsize,unsigned long mask,unsigned long flags)229 int ASN1_STRING_TABLE_add(int nid,
230                           long minsize, long maxsize, unsigned long mask,
231                           unsigned long flags)
232 {
233     ASN1_STRING_TABLE *tmp;
234     char new_nid = 0;
235     flags &= ~STABLE_FLAGS_MALLOC;
236     if (!stable)
237         stable = sk_ASN1_STRING_TABLE_new(sk_table_cmp);
238     if (!stable) {
239         OPENSSL_PUT_ERROR(ASN1, ERR_R_MALLOC_FAILURE);
240         return 0;
241     }
242     if (!(tmp = ASN1_STRING_TABLE_get(nid))) {
243         tmp = OPENSSL_malloc(sizeof(ASN1_STRING_TABLE));
244         if (!tmp) {
245             OPENSSL_PUT_ERROR(ASN1, ERR_R_MALLOC_FAILURE);
246             return 0;
247         }
248         tmp->flags = flags | STABLE_FLAGS_MALLOC;
249         tmp->nid = nid;
250         tmp->minsize = tmp->maxsize = -1;
251         new_nid = 1;
252     } else
253         tmp->flags = (tmp->flags & STABLE_FLAGS_MALLOC) | flags;
254     if (minsize != -1)
255         tmp->minsize = minsize;
256     if (maxsize != -1)
257         tmp->maxsize = maxsize;
258     tmp->mask = mask;
259     if (new_nid)
260         sk_ASN1_STRING_TABLE_push(stable, tmp);
261     return 1;
262 }
263 
ASN1_STRING_TABLE_cleanup(void)264 void ASN1_STRING_TABLE_cleanup(void)
265 {
266     STACK_OF(ASN1_STRING_TABLE) *tmp;
267     tmp = stable;
268     if (!tmp)
269         return;
270     stable = NULL;
271     sk_ASN1_STRING_TABLE_pop_free(tmp, st_free);
272 }
273 
st_free(ASN1_STRING_TABLE * tbl)274 static void st_free(ASN1_STRING_TABLE *tbl)
275 {
276     if (tbl->flags & STABLE_FLAGS_MALLOC)
277         OPENSSL_free(tbl);
278 }
279 
280 #ifdef STRING_TABLE_TEST
281 
main(void)282 int main(void)
283 {
284     ASN1_STRING_TABLE *tmp;
285     int i, last_nid = -1;
286 
287     for (tmp = tbl_standard, i = 0;
288          i < sizeof(tbl_standard) / sizeof(ASN1_STRING_TABLE); i++, tmp++) {
289         if (tmp->nid < last_nid) {
290             last_nid = 0;
291             break;
292         }
293         last_nid = tmp->nid;
294     }
295 
296     if (last_nid != 0) {
297         printf("Table order OK\n");
298         exit(0);
299     }
300 
301     for (tmp = tbl_standard, i = 0;
302          i < sizeof(tbl_standard) / sizeof(ASN1_STRING_TABLE); i++, tmp++)
303         printf("Index %d, NID %d, Name=%s\n", i, tmp->nid,
304                OBJ_nid2ln(tmp->nid));
305 
306     return 0;
307 }
308 
309 #endif
310