2 /* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 2000 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).
61 #include <openssl/crypto.h>
62 #include <openssl/x509.h>
63 #include <openssl/asn1.h>
67 /* ASN1_STRING_print_ex() and X509_NAME_print_ex().
68 * Enhanced string and name printing routines handling
69 * multibyte characters, RFC2253 and a host of other
74 #define CHARTYPE_BS_ESC (ASN1_STRFLGS_ESC_2253 | CHARTYPE_FIRST_ESC_2253 | CHARTYPE_LAST_ESC_2253)
77 /* Three IO functions for sending data to memory, a BIO and
81 int send_mem_chars(void *arg
, const void *buf
, int len
)
83 unsigned char **out
= arg
;
85 memcpy(*out
, buf
, len
);
90 int send_bio_chars(void *arg
, const void *buf
, int len
)
93 if(BIO_write(arg
, buf
, len
) != len
) return 0;
97 int send_fp_chars(void *arg
, const void *buf
, int len
)
100 if(fwrite(buf
, 1, len
, arg
) != (unsigned int)len
) return 0;
104 typedef int char_io(void *arg
, const void *buf
, int len
);
106 /* This function handles display of
107 * strings, one character at a time.
108 * It is passed an unsigned long for each
109 * character because it could come from 2 or even
113 static int do_esc_char(unsigned long c
, unsigned char flags
, char *do_quotes
, char_io
*io_ch
, void *arg
)
115 unsigned char chflgs
, chtmp
;
118 BIO_snprintf(tmphex
, 11, "\\W%08lX", c
);
119 if(!io_ch(arg
, tmphex
, 10)) return -1;
123 BIO_snprintf(tmphex
, 11, "\\U%04lX", c
);
124 if(!io_ch(arg
, tmphex
, 6)) return -1;
127 chtmp
= (unsigned char)c
;
128 if(chtmp
> 0x7f) chflgs
= flags
& ASN1_STRFLGS_ESC_MSB
;
129 else chflgs
= char_type
[chtmp
] & flags
;
130 if(chflgs
& CHARTYPE_BS_ESC
) {
131 /* If we don't escape with quotes, signal we need quotes */
132 if(chflgs
& ASN1_STRFLGS_ESC_QUOTE
) {
133 if(do_quotes
) *do_quotes
= 1;
134 if(!io_ch(arg
, &chtmp
, 1)) return -1;
137 if(!io_ch(arg
, "\\", 1)) return -1;
138 if(!io_ch(arg
, &chtmp
, 1)) return -1;
141 if(chflgs
& (ASN1_STRFLGS_ESC_CTRL
|ASN1_STRFLGS_ESC_MSB
)) {
142 BIO_snprintf(tmphex
, 11, "\\%02X", chtmp
);
143 if(!io_ch(arg
, tmphex
, 3)) return -1;
146 if(!io_ch(arg
, &chtmp
, 1)) return -1;
150 #define BUF_TYPE_WIDTH_MASK 0x7
151 #define BUF_TYPE_CONVUTF8 0x8
153 /* This function sends each character in a buffer to
154 * do_esc_char(). It interprets the content formats
155 * and converts to or from UTF8 as appropriate.
158 static int do_buf(unsigned char *buf
, int buflen
,
159 int type
, unsigned char flags
, char *quotes
, char_io
*io_ch
, void *arg
)
162 unsigned char orflags
, *p
, *q
;
168 if(p
== buf
) orflags
= CHARTYPE_FIRST_ESC_2253
;
170 switch(type
& BUF_TYPE_WIDTH_MASK
) {
172 c
= ((unsigned long)*p
++) << 24;
173 c
|= ((unsigned long)*p
++) << 16;
174 c
|= ((unsigned long)*p
++) << 8;
179 c
= ((unsigned long)*p
++) << 8;
188 i
= UTF8_getc(p
, buflen
, &c
);
189 if(i
< 0) return -1; /* Invalid UTF8String */
193 if (p
== q
) orflags
= CHARTYPE_LAST_ESC_2253
;
194 if(type
& BUF_TYPE_CONVUTF8
) {
195 unsigned char utfbuf
[6];
197 utflen
= UTF8_putc(utfbuf
, 6, c
);
198 for(i
= 0; i
< utflen
; i
++) {
199 /* We don't need to worry about setting orflags correctly
200 * because if utflen==1 its value will be correct anyway
201 * otherwise each character will be > 0x7f and so the
202 * character will never be escaped on first and last.
204 len
= do_esc_char(utfbuf
[i
], (unsigned char)(flags
| orflags
), quotes
, io_ch
, arg
);
205 if(len
< 0) return -1;
209 len
= do_esc_char(c
, (unsigned char)(flags
| orflags
), quotes
, io_ch
, arg
);
210 if(len
< 0) return -1;
217 /* This function hex dumps a buffer of characters */
219 static int do_hex_dump(char_io
*io_ch
, void *arg
, unsigned char *buf
, int buflen
)
221 const static char hexdig
[] = "0123456789ABCDEF";
222 unsigned char *p
, *q
;
228 hextmp
[0] = hexdig
[*p
>> 4];
229 hextmp
[1] = hexdig
[*p
& 0xf];
230 if(!io_ch(arg
, hextmp
, 2)) return -1;
237 /* "dump" a string. This is done when the type is unknown,
238 * or the flags request it. We can either dump the content
239 * octets or the entire DER encoding. This uses the RFC2253
243 int do_dump(unsigned long lflags
, char_io
*io_ch
, void *arg
, ASN1_STRING
*str
)
245 /* Placing the ASN1_STRING in a temp ASN1_TYPE allows
246 * the DER encoding to readily obtained
249 unsigned char *der_buf
, *p
;
252 if(!io_ch(arg
, "#", 1)) return -1;
253 /* If we don't dump DER encoding just dump content octets */
254 if(!(lflags
& ASN1_STRFLGS_DUMP_DER
)) {
255 outlen
= do_hex_dump(io_ch
, arg
, str
->data
, str
->length
);
256 if(outlen
< 0) return -1;
260 t
.value
.ptr
= (char *)str
;
261 der_len
= i2d_ASN1_TYPE(&t
, NULL
);
262 der_buf
= OPENSSL_malloc(der_len
);
263 if(!der_buf
) return -1;
265 i2d_ASN1_TYPE(&t
, &p
);
266 outlen
= do_hex_dump(io_ch
, arg
, der_buf
, der_len
);
267 OPENSSL_free(der_buf
);
268 if(outlen
< 0) return -1;
272 /* Lookup table to convert tags to character widths,
273 * 0 = UTF8 encoded, -1 is used for non string types
274 * otherwise it is the number of bytes per character
277 const static char tag2nbyte
[] = {
278 -1, -1, -1, -1, -1, /* 0-4 */
279 -1, -1, -1, -1, -1, /* 5-9 */
280 -1, -1, 0, -1, /* 10-13 */
281 -1, -1, -1, -1, /* 15-17 */
282 -1, 1, 1, /* 18-20 */
283 -1, 1, -1,-1, /* 21-24 */
284 -1, 1, -1, /* 25-27 */
288 #define ESC_FLAGS (ASN1_STRFLGS_ESC_2253 | \
289 ASN1_STRFLGS_ESC_QUOTE | \
290 ASN1_STRFLGS_ESC_CTRL | \
291 ASN1_STRFLGS_ESC_MSB)
293 /* This is the main function, print out an
294 * ASN1_STRING taking note of various escape
295 * and display options. Returns number of
296 * characters written or -1 if an error
300 static int do_print_ex(char_io
*io_ch
, void *arg
, unsigned long lflags
, ASN1_STRING
*str
)
307 /* Keep a copy of escape flags */
308 flags
= (unsigned char)(lflags
& ESC_FLAGS
);
315 if(lflags
& ASN1_STRFLGS_SHOW_TYPE
) {
317 tagname
= ASN1_tag2str(type
);
318 outlen
+= strlen(tagname
);
319 if(!io_ch(arg
, tagname
, outlen
) || !io_ch(arg
, ":", 1)) return -1;
323 /* Decide what to do with type, either dump content or display it */
325 /* Dump everything */
326 if(lflags
& ASN1_STRFLGS_DUMP_ALL
) type
= -1;
327 /* Ignore the string type */
328 else if(lflags
& ASN1_STRFLGS_IGNORE_TYPE
) type
= 1;
330 /* Else determine width based on type */
331 if((type
> 0) && (type
< 31)) type
= tag2nbyte
[type
];
333 if((type
== -1) && !(lflags
& ASN1_STRFLGS_DUMP_UNKNOWN
)) type
= 1;
337 len
= do_dump(lflags
, io_ch
, arg
, str
);
338 if(len
< 0) return -1;
343 if(lflags
& ASN1_STRFLGS_UTF8_CONVERT
) {
344 /* Note: if string is UTF8 and we want
345 * to convert to UTF8 then we just interpret
346 * it as 1 byte per character to avoid converting
350 else type
|= BUF_TYPE_CONVUTF8
;
353 len
= do_buf(str
->data
, str
->length
, type
, flags
, "es
, io_ch
, NULL
);
354 if(outlen
< 0) return -1;
356 if(quotes
) outlen
+= 2;
357 if(!arg
) return outlen
;
358 if(quotes
&& !io_ch(arg
, "\"", 1)) return -1;
359 do_buf(str
->data
, str
->length
, type
, flags
, NULL
, io_ch
, arg
);
360 if(quotes
&& !io_ch(arg
, "\"", 1)) return -1;
364 /* Used for line indenting: print 'indent' spaces */
366 static int do_indent(char_io
*io_ch
, void *arg
, int indent
)
369 for(i
= 0; i
< indent
; i
++)
370 if(!io_ch(arg
, " ", 1)) return 0;
374 #define FN_WIDTH_LN 25
375 #define FN_WIDTH_SN 10
377 static int do_name_ex(char_io
*io_ch
, void *arg
, X509_NAME
*n
,
378 int indent
, unsigned long flags
)
380 int i
, prev
= -1, orflags
, cnt
;
384 X509_NAME_ENTRY
*ent
;
388 char *sep_dn
, *sep_mv
, *sep_eq
;
389 int sep_dn_len
, sep_mv_len
, sep_eq_len
;
390 if(indent
< 0) indent
= 0;
392 if(!do_indent(io_ch
, arg
, indent
)) return -1;
393 switch (flags
& XN_FLAG_SEP_MASK
)
395 case XN_FLAG_SEP_MULTILINE
:
402 case XN_FLAG_SEP_COMMA_PLUS
:
410 case XN_FLAG_SEP_CPLUS_SPC
:
418 case XN_FLAG_SEP_SPLUS_SPC
:
430 if(flags
& XN_FLAG_SPC_EQ
) {
438 fn_opt
= flags
& XN_FLAG_FN_MASK
;
440 cnt
= X509_NAME_entry_count(n
);
441 for(i
= 0; i
< cnt
; i
++) {
442 if(flags
& XN_FLAG_DN_REV
)
443 ent
= X509_NAME_get_entry(n
, cnt
- i
- 1);
444 else ent
= X509_NAME_get_entry(n
, i
);
446 if(prev
== ent
->set
) {
447 if(!io_ch(arg
, sep_mv
, sep_mv_len
)) return -1;
448 outlen
+= sep_mv_len
;
450 if(!io_ch(arg
, sep_dn
, sep_dn_len
)) return -1;
451 outlen
+= sep_dn_len
;
452 if(!do_indent(io_ch
, arg
, indent
)) return -1;
457 fn
= X509_NAME_ENTRY_get_object(ent
);
458 val
= X509_NAME_ENTRY_get_data(ent
);
459 fn_nid
= OBJ_obj2nid(fn
);
460 if(fn_opt
!= XN_FLAG_FN_NONE
) {
462 if((fn_opt
== XN_FLAG_FN_OID
) || (fn_nid
==NID_undef
) ) {
463 OBJ_obj2txt(objtmp
, 80, fn
, 1);
464 fld_len
= 0; /* XXX: what should this be? */
467 if(fn_opt
== XN_FLAG_FN_SN
) {
468 fld_len
= FN_WIDTH_SN
;
469 objbuf
= OBJ_nid2sn(fn_nid
);
470 } else if(fn_opt
== XN_FLAG_FN_LN
) {
471 fld_len
= FN_WIDTH_LN
;
472 objbuf
= OBJ_nid2ln(fn_nid
);
474 fld_len
= 0; /* XXX: what should this be? */
478 objlen
= strlen(objbuf
);
479 if(!io_ch(arg
, objbuf
, objlen
)) return -1;
480 if ((objlen
< fld_len
) && (flags
& XN_FLAG_FN_ALIGN
)) {
481 if (!do_indent(io_ch
, arg
, fld_len
- objlen
)) return -1;
482 outlen
+= fld_len
- objlen
;
484 if(!io_ch(arg
, sep_eq
, sep_eq_len
)) return -1;
485 outlen
+= objlen
+ sep_eq_len
;
487 /* If the field name is unknown then fix up the DER dump
488 * flag. We might want to limit this further so it will
489 * DER dump on anything other than a few 'standard' fields.
491 if((fn_nid
== NID_undef
) && (flags
& XN_FLAG_DUMP_UNKNOWN_FIELDS
))
492 orflags
= ASN1_STRFLGS_DUMP_ALL
;
495 len
= do_print_ex(io_ch
, arg
, flags
| orflags
, val
);
496 if(len
< 0) return -1;
502 /* Wrappers round the main functions */
504 int X509_NAME_print_ex(BIO
*out
, X509_NAME
*nm
, int indent
, unsigned long flags
)
506 if(flags
== XN_FLAG_COMPAT
)
507 return X509_NAME_print(out
, nm
, indent
);
508 return do_name_ex(send_bio_chars
, out
, nm
, indent
, flags
);
512 int X509_NAME_print_ex_fp(FILE *fp
, X509_NAME
*nm
, int indent
, unsigned long flags
)
514 if(flags
== XN_FLAG_COMPAT
)
518 btmp
= BIO_new_fp(fp
, BIO_NOCLOSE
);
520 ret
= X509_NAME_print(btmp
, nm
, indent
);
524 return do_name_ex(send_fp_chars
, fp
, nm
, indent
, flags
);
527 int ASN1_STRING_print_ex(BIO
*out
, ASN1_STRING
*str
, unsigned long flags
)
529 return do_print_ex(send_bio_chars
, out
, flags
, str
);
533 int ASN1_STRING_print_ex_fp(FILE *fp
, ASN1_STRING
*str
, unsigned long flags
)
535 return do_print_ex(send_fp_chars
, fp
, flags
, str
);
538 /* Utility function: convert any string type to UTF8, returns number of bytes
539 * in output string or a negative error code
542 int ASN1_STRING_to_UTF8(unsigned char **out
, ASN1_STRING
*in
)
544 ASN1_STRING stmp
, *str
= &stmp
;
545 int mbflag
, type
, ret
;
546 if(!*out
|| !in
) return -1;
548 if((type
< 0) || (type
> 30)) return -1;
549 mbflag
= tag2nbyte
[type
];
550 if(mbflag
== -1) return -1;
551 mbflag
|= MBSTRING_FLAG
;
553 ret
= ASN1_mbstring_copy(&str
, in
->data
, in
->length
, mbflag
, B_ASN1_UTF8STRING
);
554 if(ret
< 0) return ret
;
555 if(out
) *out
= stmp
.data
;