2 /* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 1999 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
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 * ====================================================================
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).
62 #include <openssl/asn1.h>
64 static int traverse_string(const unsigned char *p
, int len
, int inform
,
65 int (*rfunc
)(unsigned long value
, void *in
), void *arg
);
66 static int in_utf8(unsigned long value
, void *arg
);
67 static int out_utf8(unsigned long value
, void *arg
);
68 static int type_str(unsigned long value
, void *arg
);
69 static int cpy_asc(unsigned long value
, void *arg
);
70 static int cpy_bmp(unsigned long value
, void *arg
);
71 static int cpy_univ(unsigned long value
, void *arg
);
72 static int cpy_utf8(unsigned long value
, void *arg
);
73 static int is_printable(unsigned long value
);
75 /* These functions take a string in UTF8, ASCII or multibyte form and
76 * a mask of permissible ASN1 string types. It then works out the minimal
77 * type (using the order Printable < IA5 < T61 < BMP < Universal < UTF8)
78 * and creates a string of the correct type with the supplied data.
79 * Yes this is horrible: it has to be :-(
80 * The 'ncopy' form checks minimum and maximum size limits too.
83 int ASN1_mbstring_copy(ASN1_STRING
**out
, const unsigned char *in
, int len
,
84 int inform
, unsigned long mask
)
86 return ASN1_mbstring_ncopy(out
, in
, len
, inform
, mask
, 0, 0);
89 int ASN1_mbstring_ncopy(ASN1_STRING
**out
, const unsigned char *in
, int len
,
90 int inform
, unsigned long mask
,
91 long minsize
, long maxsize
)
101 int (*cpyfunc
)(unsigned long,void *) = NULL
;
102 if(len
== -1) len
= strlen((const char *)in
);
103 if(!mask
) mask
= DIRSTRING_TYPE
;
105 /* First do a string check and work out the number of characters */
110 ASN1err(ASN1_F_ASN1_MBSTRING_COPY
,
111 ASN1_R_INVALID_BMPSTRING_LENGTH
);
119 ASN1err(ASN1_F_ASN1_MBSTRING_COPY
,
120 ASN1_R_INVALID_UNIVERSALSTRING_LENGTH
);
128 /* This counts the characters and does utf8 syntax checking */
129 ret
= traverse_string(in
, len
, MBSTRING_UTF8
, in_utf8
, &nchar
);
131 ASN1err(ASN1_F_ASN1_MBSTRING_COPY
,
132 ASN1_R_INVALID_UTF8STRING
);
142 ASN1err(ASN1_F_ASN1_MBSTRING_COPY
, ASN1_R_UNKNOWN_FORMAT
);
146 if((minsize
> 0) && (nchar
< minsize
)) {
147 ASN1err(ASN1_F_ASN1_MBSTRING_COPY
, ASN1_R_STRING_TOO_SHORT
);
148 sprintf(strbuf
, "%ld", minsize
);
149 ERR_add_error_data(2, "minsize=", strbuf
);
153 if((maxsize
> 0) && (nchar
> maxsize
)) {
154 ASN1err(ASN1_F_ASN1_MBSTRING_COPY
, ASN1_R_STRING_TOO_LONG
);
155 sprintf(strbuf
, "%ld", maxsize
);
156 ERR_add_error_data(2, "maxsize=", strbuf
);
160 /* Now work out minimal type (if any) */
161 if(traverse_string(in
, len
, inform
, type_str
, &mask
) < 0) {
162 ASN1err(ASN1_F_ASN1_MBSTRING_COPY
, ASN1_R_ILLEGAL_CHARACTERS
);
167 /* Now work out output format and string type */
168 outform
= MBSTRING_ASC
;
169 if(mask
& B_ASN1_PRINTABLESTRING
) str_type
= V_ASN1_PRINTABLESTRING
;
170 else if(mask
& B_ASN1_IA5STRING
) str_type
= V_ASN1_IA5STRING
;
171 else if(mask
& B_ASN1_T61STRING
) str_type
= V_ASN1_T61STRING
;
172 else if(mask
& B_ASN1_BMPSTRING
) {
173 str_type
= V_ASN1_BMPSTRING
;
174 outform
= MBSTRING_BMP
;
175 } else if(mask
& B_ASN1_UNIVERSALSTRING
) {
176 str_type
= V_ASN1_UNIVERSALSTRING
;
177 outform
= MBSTRING_UNIV
;
179 str_type
= V_ASN1_UTF8STRING
;
180 outform
= MBSTRING_UTF8
;
182 if(!out
) return str_type
;
188 OPENSSL_free(dest
->data
);
191 dest
->type
= str_type
;
194 dest
= ASN1_STRING_type_new(str_type
);
196 ASN1err(ASN1_F_ASN1_MBSTRING_COPY
,
197 ERR_R_MALLOC_FAILURE
);
202 /* If both the same type just copy across */
203 if(inform
== outform
) {
204 if(!ASN1_STRING_set(dest
, in
, len
)) {
205 ASN1err(ASN1_F_ASN1_MBSTRING_COPY
,ERR_R_MALLOC_FAILURE
);
211 /* Work out how much space the destination will need */
230 traverse_string(in
, len
, inform
, out_utf8
, &outlen
);
234 if(!(p
= OPENSSL_malloc(outlen
+ 1))) {
235 if(free_out
) ASN1_STRING_free(dest
);
236 ASN1err(ASN1_F_ASN1_MBSTRING_COPY
,ERR_R_MALLOC_FAILURE
);
239 dest
->length
= outlen
;
242 traverse_string(in
, len
, inform
, cpyfunc
, &p
);
246 /* This function traverses a string and passes the value of each character
247 * to an optional function along with a void * argument.
250 static int traverse_string(const unsigned char *p
, int len
, int inform
,
251 int (*rfunc
)(unsigned long value
, void *in
), void *arg
)
256 if(inform
== MBSTRING_ASC
) {
259 } else if(inform
== MBSTRING_BMP
) {
263 } else if(inform
== MBSTRING_UNIV
) {
264 value
= ((unsigned long)*p
++) << 24;
265 value
|= ((unsigned long)*p
++) << 16;
270 ret
= UTF8_getc(p
, len
, &value
);
271 if(ret
< 0) return -1;
276 ret
= rfunc(value
, arg
);
277 if(ret
<= 0) return ret
;
283 /* Various utility functions for traverse_string */
285 /* Just count number of characters */
287 static int in_utf8(unsigned long value
, void *arg
)
295 /* Determine size of output as a UTF8 String */
297 static int out_utf8(unsigned long value
, void *arg
)
301 *outlen
+= UTF8_putc(NULL
, -1, value
);
305 /* Determine the "type" of a string: check each character against a
309 static int type_str(unsigned long value
, void *arg
)
312 types
= *((unsigned long *)arg
);
313 if((types
& B_ASN1_PRINTABLESTRING
) && !is_printable(value
))
314 types
&= ~B_ASN1_PRINTABLESTRING
;
315 if((types
& B_ASN1_IA5STRING
) && (value
> 127))
316 types
&= ~B_ASN1_IA5STRING
;
317 if((types
& B_ASN1_T61STRING
) && (value
> 0xff))
318 types
&= ~B_ASN1_T61STRING
;
319 if((types
& B_ASN1_BMPSTRING
) && (value
> 0xffff))
320 types
&= ~B_ASN1_BMPSTRING
;
321 if(!types
) return -1;
322 *((unsigned long *)arg
) = types
;
326 /* Copy one byte per character ASCII like strings */
328 static int cpy_asc(unsigned long value
, void *arg
)
330 unsigned char **p
, *q
;
333 *q
= (unsigned char) value
;
338 /* Copy two byte per character BMPStrings */
340 static int cpy_bmp(unsigned long value
, void *arg
)
342 unsigned char **p
, *q
;
345 *q
++ = (unsigned char) ((value
>> 8) & 0xff);
346 *q
= (unsigned char) (value
& 0xff);
351 /* Copy four byte per character UniversalStrings */
353 static int cpy_univ(unsigned long value
, void *arg
)
355 unsigned char **p
, *q
;
358 *q
++ = (unsigned char) ((value
>> 24) & 0xff);
359 *q
++ = (unsigned char) ((value
>> 16) & 0xff);
360 *q
++ = (unsigned char) ((value
>> 8) & 0xff);
361 *q
= (unsigned char) (value
& 0xff);
366 /* Copy to a UTF8String */
368 static int cpy_utf8(unsigned long value
, void *arg
)
373 /* We already know there is enough room so pass 0xff as the length */
374 ret
= UTF8_putc(*p
, 0xff, value
);
379 /* Return 1 if the character is permitted in a PrintableString */
380 static int is_printable(unsigned long value
)
383 if(value
> 0x7f) return 0;
385 /* Note: we can't use 'isalnum' because certain accented
386 * characters may count as alphanumeric in some environments.
388 #ifndef CHARSET_EBCDIC
389 if((ch
>= 'a') && (ch
<= 'z')) return 1;
390 if((ch
>= 'A') && (ch
<= 'Z')) return 1;
391 if((ch
>= '0') && (ch
<= '9')) return 1;
392 if ((ch
== ' ') || strchr("'()+,-./:=?", ch
)) return 1;
393 #else /*CHARSET_EBCDIC*/
394 if((ch
>= os_toascii
['a']) && (ch
<= os_toascii
['z'])) return 1;
395 if((ch
>= os_toascii
['A']) && (ch
<= os_toascii
['Z'])) return 1;
396 if((ch
>= os_toascii
['0']) && (ch
<= os_toascii
['9'])) return 1;
397 if ((ch
== os_toascii
[' ']) || strchr("'()+,-./:=?", os_toebcdic
[ch
])) return 1;
398 #endif /*CHARSET_EBCDIC*/