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>
65 static int traverse_string(const unsigned char *p
, int len
, int inform
,
66 int (*rfunc
) (unsigned long value
, void *in
),
68 static int in_utf8(unsigned long value
, void *arg
);
69 static int out_utf8(unsigned long value
, void *arg
);
70 static int type_str(unsigned long value
, void *arg
);
71 static int cpy_asc(unsigned long value
, void *arg
);
72 static int cpy_bmp(unsigned long value
, void *arg
);
73 static int cpy_univ(unsigned long value
, void *arg
);
74 static int cpy_utf8(unsigned long value
, void *arg
);
75 static int is_printable(unsigned long value
);
78 * These functions take a string in UTF8, ASCII or multibyte form and a mask
79 * of permissible ASN1 string types. It then works out the minimal type
80 * (using the order Printable < IA5 < T61 < BMP < Universal < UTF8) and
81 * creates a string of the correct type with the supplied data. Yes this is
82 * horrible: it has to be :-( The 'ncopy' form checks minimum and maximum
86 int ASN1_mbstring_copy(ASN1_STRING
**out
, const unsigned char *in
, int len
,
87 int inform
, unsigned long mask
)
89 return ASN1_mbstring_ncopy(out
, in
, len
, inform
, mask
, 0, 0);
92 int ASN1_mbstring_ncopy(ASN1_STRING
**out
, const unsigned char *in
, int len
,
93 int inform
, unsigned long mask
,
94 long minsize
, long maxsize
)
99 int outform
, outlen
= 0;
104 int (*cpyfunc
) (unsigned long, void *) = NULL
;
106 len
= strlen((const char *)in
);
108 mask
= DIRSTRING_TYPE
;
110 /* First do a string check and work out the number of characters */
115 ASN1err(ASN1_F_ASN1_MBSTRING_NCOPY
,
116 ASN1_R_INVALID_BMPSTRING_LENGTH
);
124 ASN1err(ASN1_F_ASN1_MBSTRING_NCOPY
,
125 ASN1_R_INVALID_UNIVERSALSTRING_LENGTH
);
133 /* This counts the characters and does utf8 syntax checking */
134 ret
= traverse_string(in
, len
, MBSTRING_UTF8
, in_utf8
, &nchar
);
136 ASN1err(ASN1_F_ASN1_MBSTRING_NCOPY
, ASN1_R_INVALID_UTF8STRING
);
146 ASN1err(ASN1_F_ASN1_MBSTRING_NCOPY
, ASN1_R_UNKNOWN_FORMAT
);
150 if ((minsize
> 0) && (nchar
< minsize
)) {
151 ASN1err(ASN1_F_ASN1_MBSTRING_NCOPY
, ASN1_R_STRING_TOO_SHORT
);
152 BIO_snprintf(strbuf
, sizeof strbuf
, "%ld", minsize
);
153 ERR_add_error_data(2, "minsize=", strbuf
);
157 if ((maxsize
> 0) && (nchar
> maxsize
)) {
158 ASN1err(ASN1_F_ASN1_MBSTRING_NCOPY
, ASN1_R_STRING_TOO_LONG
);
159 BIO_snprintf(strbuf
, sizeof strbuf
, "%ld", maxsize
);
160 ERR_add_error_data(2, "maxsize=", strbuf
);
164 /* Now work out minimal type (if any) */
165 if (traverse_string(in
, len
, inform
, type_str
, &mask
) < 0) {
166 ASN1err(ASN1_F_ASN1_MBSTRING_NCOPY
, ASN1_R_ILLEGAL_CHARACTERS
);
170 /* Now work out output format and string type */
171 outform
= MBSTRING_ASC
;
172 if (mask
& B_ASN1_PRINTABLESTRING
)
173 str_type
= V_ASN1_PRINTABLESTRING
;
174 else if (mask
& B_ASN1_IA5STRING
)
175 str_type
= V_ASN1_IA5STRING
;
176 else if (mask
& B_ASN1_T61STRING
)
177 str_type
= V_ASN1_T61STRING
;
178 else if (mask
& B_ASN1_BMPSTRING
) {
179 str_type
= V_ASN1_BMPSTRING
;
180 outform
= MBSTRING_BMP
;
181 } else if (mask
& B_ASN1_UNIVERSALSTRING
) {
182 str_type
= V_ASN1_UNIVERSALSTRING
;
183 outform
= MBSTRING_UNIV
;
185 str_type
= V_ASN1_UTF8STRING
;
186 outform
= MBSTRING_UTF8
;
195 OPENSSL_free(dest
->data
);
198 dest
->type
= str_type
;
201 dest
= ASN1_STRING_type_new(str_type
);
203 ASN1err(ASN1_F_ASN1_MBSTRING_NCOPY
, ERR_R_MALLOC_FAILURE
);
208 /* If both the same type just copy across */
209 if (inform
== outform
) {
210 if (!ASN1_STRING_set(dest
, in
, len
)) {
211 ASN1err(ASN1_F_ASN1_MBSTRING_NCOPY
, ERR_R_MALLOC_FAILURE
);
217 /* Work out how much space the destination will need */
236 traverse_string(in
, len
, inform
, out_utf8
, &outlen
);
240 if (!(p
= OPENSSL_malloc(outlen
+ 1))) {
242 ASN1_STRING_free(dest
);
243 ASN1err(ASN1_F_ASN1_MBSTRING_NCOPY
, ERR_R_MALLOC_FAILURE
);
246 dest
->length
= outlen
;
249 traverse_string(in
, len
, inform
, cpyfunc
, &p
);
254 * This function traverses a string and passes the value of each character to
255 * an optional function along with a void * argument.
258 static int traverse_string(const unsigned char *p
, int len
, int inform
,
259 int (*rfunc
) (unsigned long value
, void *in
),
265 if (inform
== MBSTRING_ASC
) {
268 } else if (inform
== MBSTRING_BMP
) {
272 } else if (inform
== MBSTRING_UNIV
) {
273 value
= ((unsigned long)*p
++) << 24;
274 value
|= ((unsigned long)*p
++) << 16;
279 ret
= UTF8_getc(p
, len
, &value
);
286 ret
= rfunc(value
, arg
);
294 /* Various utility functions for traverse_string */
296 /* Just count number of characters */
298 static int in_utf8(unsigned long value
, void *arg
)
306 /* Determine size of output as a UTF8 String */
308 static int out_utf8(unsigned long value
, void *arg
)
312 *outlen
+= UTF8_putc(NULL
, -1, value
);
317 * Determine the "type" of a string: check each character against a supplied
321 static int type_str(unsigned long value
, void *arg
)
324 types
= *((unsigned long *)arg
);
325 if ((types
& B_ASN1_PRINTABLESTRING
) && !is_printable(value
))
326 types
&= ~B_ASN1_PRINTABLESTRING
;
327 if ((types
& B_ASN1_IA5STRING
) && (value
> 127))
328 types
&= ~B_ASN1_IA5STRING
;
329 if ((types
& B_ASN1_T61STRING
) && (value
> 0xff))
330 types
&= ~B_ASN1_T61STRING
;
331 if ((types
& B_ASN1_BMPSTRING
) && (value
> 0xffff))
332 types
&= ~B_ASN1_BMPSTRING
;
335 *((unsigned long *)arg
) = types
;
339 /* Copy one byte per character ASCII like strings */
341 static int cpy_asc(unsigned long value
, void *arg
)
343 unsigned char **p
, *q
;
346 *q
= (unsigned char)value
;
351 /* Copy two byte per character BMPStrings */
353 static int cpy_bmp(unsigned long value
, void *arg
)
355 unsigned char **p
, *q
;
358 *q
++ = (unsigned char)((value
>> 8) & 0xff);
359 *q
= (unsigned char)(value
& 0xff);
364 /* Copy four byte per character UniversalStrings */
366 static int cpy_univ(unsigned long value
, void *arg
)
368 unsigned char **p
, *q
;
371 *q
++ = (unsigned char)((value
>> 24) & 0xff);
372 *q
++ = (unsigned char)((value
>> 16) & 0xff);
373 *q
++ = (unsigned char)((value
>> 8) & 0xff);
374 *q
= (unsigned char)(value
& 0xff);
379 /* Copy to a UTF8String */
381 static int cpy_utf8(unsigned long value
, void *arg
)
386 /* We already know there is enough room so pass 0xff as the length */
387 ret
= UTF8_putc(*p
, 0xff, value
);
392 /* Return 1 if the character is permitted in a PrintableString */
393 static int is_printable(unsigned long value
)
400 * Note: we can't use 'isalnum' because certain accented characters may
401 * count as alphanumeric in some environments.
403 #ifndef CHARSET_EBCDIC
404 if ((ch
>= 'a') && (ch
<= 'z'))
406 if ((ch
>= 'A') && (ch
<= 'Z'))
408 if ((ch
>= '0') && (ch
<= '9'))
410 if ((ch
== ' ') || strchr("'()+,-./:=?", ch
))
412 #else /* CHARSET_EBCDIC */
413 if ((ch
>= os_toascii
['a']) && (ch
<= os_toascii
['z']))
415 if ((ch
>= os_toascii
['A']) && (ch
<= os_toascii
['Z']))
417 if ((ch
>= os_toascii
['0']) && (ch
<= os_toascii
['9']))
419 if ((ch
== os_toascii
[' ']) || strchr("'()+,-./:=?", os_toebcdic
[ch
]))
421 #endif /* CHARSET_EBCDIC */