2 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
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 "internal/cryptlib.h"
62 #include <openssl/crypto.h>
63 #include <openssl/x509.h>
64 #include <openssl/asn1.h>
69 * ASN1_STRING_print_ex() and X509_NAME_print_ex(). Enhanced string and name
70 * printing routines handling multibyte characters, RFC2253 and a host of
74 #define CHARTYPE_BS_ESC (ASN1_STRFLGS_ESC_2253 | CHARTYPE_FIRST_ESC_2253 | CHARTYPE_LAST_ESC_2253)
76 #define ESC_FLAGS (ASN1_STRFLGS_ESC_2253 | \
77 ASN1_STRFLGS_ESC_QUOTE | \
78 ASN1_STRFLGS_ESC_CTRL | \
82 * Three IO functions for sending data to memory, a BIO and and a FILE
85 static int send_bio_chars(void *arg
, const void *buf
, int len
)
89 if (BIO_write(arg
, buf
, len
) != len
)
94 #ifndef OPENSSL_NO_STDIO
95 static int send_fp_chars(void *arg
, const void *buf
, int len
)
99 if (fwrite(buf
, 1, len
, arg
) != (unsigned int)len
)
105 typedef int char_io (void *arg
, const void *buf
, int len
);
108 * This function handles display of strings, one character at a time. It is
109 * passed an unsigned long for each character because it could come from 2 or
113 static int do_esc_char(unsigned long c
, unsigned char flags
, char *do_quotes
,
114 char_io
*io_ch
, void *arg
)
116 unsigned char chflgs
, chtmp
;
117 char tmphex
[HEX_SIZE(long) + 3];
122 BIO_snprintf(tmphex
, sizeof tmphex
, "\\W%08lX", c
);
123 if (!io_ch(arg
, tmphex
, 10))
128 BIO_snprintf(tmphex
, sizeof tmphex
, "\\U%04lX", c
);
129 if (!io_ch(arg
, tmphex
, 6))
133 chtmp
= (unsigned char)c
;
135 chflgs
= flags
& ASN1_STRFLGS_ESC_MSB
;
137 chflgs
= char_type
[chtmp
] & flags
;
138 if (chflgs
& CHARTYPE_BS_ESC
) {
139 /* If we don't escape with quotes, signal we need quotes */
140 if (chflgs
& ASN1_STRFLGS_ESC_QUOTE
) {
143 if (!io_ch(arg
, &chtmp
, 1))
147 if (!io_ch(arg
, "\\", 1))
149 if (!io_ch(arg
, &chtmp
, 1))
153 if (chflgs
& (ASN1_STRFLGS_ESC_CTRL
| ASN1_STRFLGS_ESC_MSB
)) {
154 BIO_snprintf(tmphex
, 11, "\\%02X", chtmp
);
155 if (!io_ch(arg
, tmphex
, 3))
160 * If we get this far and do any escaping at all must escape the escape
161 * character itself: backslash.
163 if (chtmp
== '\\' && flags
& ESC_FLAGS
) {
164 if (!io_ch(arg
, "\\\\", 2))
168 if (!io_ch(arg
, &chtmp
, 1))
173 #define BUF_TYPE_WIDTH_MASK 0x7
174 #define BUF_TYPE_CONVUTF8 0x8
177 * This function sends each character in a buffer to do_esc_char(). It
178 * interprets the content formats and converts to or from UTF8 as
182 static int do_buf(unsigned char *buf
, int buflen
,
183 int type
, unsigned char flags
, char *quotes
, char_io
*io_ch
,
187 unsigned char orflags
, *p
, *q
;
193 if (p
== buf
&& flags
& ASN1_STRFLGS_ESC_2253
)
194 orflags
= CHARTYPE_FIRST_ESC_2253
;
197 switch (type
& BUF_TYPE_WIDTH_MASK
) {
199 c
= ((unsigned long)*p
++) << 24;
200 c
|= ((unsigned long)*p
++) << 16;
201 c
|= ((unsigned long)*p
++) << 8;
206 c
= ((unsigned long)*p
++) << 8;
215 i
= UTF8_getc(p
, buflen
, &c
);
217 return -1; /* Invalid UTF8String */
221 return -1; /* invalid width */
223 if (p
== q
&& flags
& ASN1_STRFLGS_ESC_2253
)
224 orflags
= CHARTYPE_LAST_ESC_2253
;
225 if (type
& BUF_TYPE_CONVUTF8
) {
226 unsigned char utfbuf
[6];
228 utflen
= UTF8_putc(utfbuf
, sizeof utfbuf
, c
);
229 for (i
= 0; i
< utflen
; i
++) {
231 * We don't need to worry about setting orflags correctly
232 * because if utflen==1 its value will be correct anyway
233 * otherwise each character will be > 0x7f and so the
234 * character will never be escaped on first and last.
237 do_esc_char(utfbuf
[i
], (unsigned char)(flags
| orflags
),
245 do_esc_char(c
, (unsigned char)(flags
| orflags
), quotes
,
255 /* This function hex dumps a buffer of characters */
257 static int do_hex_dump(char_io
*io_ch
, void *arg
, unsigned char *buf
,
260 static const char hexdig
[] = "0123456789ABCDEF";
261 unsigned char *p
, *q
;
267 hextmp
[0] = hexdig
[*p
>> 4];
268 hextmp
[1] = hexdig
[*p
& 0xf];
269 if (!io_ch(arg
, hextmp
, 2))
278 * "dump" a string. This is done when the type is unknown, or the flags
279 * request it. We can either dump the content octets or the entire DER
280 * encoding. This uses the RFC2253 #01234 format.
283 static int do_dump(unsigned long lflags
, char_io
*io_ch
, void *arg
,
287 * Placing the ASN1_STRING in a temp ASN1_TYPE allows the DER encoding to
291 unsigned char *der_buf
, *p
;
294 if (!io_ch(arg
, "#", 1))
296 /* If we don't dump DER encoding just dump content octets */
297 if (!(lflags
& ASN1_STRFLGS_DUMP_DER
)) {
298 outlen
= do_hex_dump(io_ch
, arg
, str
->data
, str
->length
);
304 t
.value
.ptr
= (char *)str
;
305 der_len
= i2d_ASN1_TYPE(&t
, NULL
);
306 der_buf
= OPENSSL_malloc(der_len
);
310 i2d_ASN1_TYPE(&t
, &p
);
311 outlen
= do_hex_dump(io_ch
, arg
, der_buf
, der_len
);
312 OPENSSL_free(der_buf
);
319 * Lookup table to convert tags to character widths, 0 = UTF8 encoded, -1 is
320 * used for non string types otherwise it is the number of bytes per
324 static const signed char tag2nbyte
[] = {
325 -1, -1, -1, -1, -1, /* 0-4 */
326 -1, -1, -1, -1, -1, /* 5-9 */
327 -1, -1, 0, -1, /* 10-13 */
328 -1, -1, -1, -1, /* 15-17 */
329 -1, 1, 1, /* 18-20 */
330 -1, 1, 1, 1, /* 21-24 */
331 -1, 1, -1, /* 25-27 */
336 * This is the main function, print out an ASN1_STRING taking note of various
337 * escape and display options. Returns number of characters written or -1 if
341 static int do_print_ex(char_io
*io_ch
, void *arg
, unsigned long lflags
,
349 /* Keep a copy of escape flags */
350 flags
= (unsigned char)(lflags
& ESC_FLAGS
);
356 if (lflags
& ASN1_STRFLGS_SHOW_TYPE
) {
358 tagname
= ASN1_tag2str(type
);
359 outlen
+= strlen(tagname
);
360 if (!io_ch(arg
, tagname
, outlen
) || !io_ch(arg
, ":", 1))
365 /* Decide what to do with type, either dump content or display it */
367 /* Dump everything */
368 if (lflags
& ASN1_STRFLGS_DUMP_ALL
)
370 /* Ignore the string type */
371 else if (lflags
& ASN1_STRFLGS_IGNORE_TYPE
)
374 /* Else determine width based on type */
375 if ((type
> 0) && (type
< 31))
376 type
= tag2nbyte
[type
];
379 if ((type
== -1) && !(lflags
& ASN1_STRFLGS_DUMP_UNKNOWN
))
384 len
= do_dump(lflags
, io_ch
, arg
, str
);
391 if (lflags
& ASN1_STRFLGS_UTF8_CONVERT
) {
393 * Note: if string is UTF8 and we want to convert to UTF8 then we
394 * just interpret it as 1 byte per character to avoid converting
400 type
|= BUF_TYPE_CONVUTF8
;
403 len
= do_buf(str
->data
, str
->length
, type
, flags
, "es
, io_ch
, NULL
);
411 if (quotes
&& !io_ch(arg
, "\"", 1))
413 if (do_buf(str
->data
, str
->length
, type
, flags
, NULL
, io_ch
, arg
) < 0)
415 if (quotes
&& !io_ch(arg
, "\"", 1))
420 /* Used for line indenting: print 'indent' spaces */
422 static int do_indent(char_io
*io_ch
, void *arg
, int indent
)
425 for (i
= 0; i
< indent
; i
++)
426 if (!io_ch(arg
, " ", 1))
431 #define FN_WIDTH_LN 25
432 #define FN_WIDTH_SN 10
434 static int do_name_ex(char_io
*io_ch
, void *arg
, X509_NAME
*n
,
435 int indent
, unsigned long flags
)
437 int i
, prev
= -1, orflags
, cnt
;
441 X509_NAME_ENTRY
*ent
;
445 char *sep_dn
, *sep_mv
, *sep_eq
;
446 int sep_dn_len
, sep_mv_len
, sep_eq_len
;
450 if (!do_indent(io_ch
, arg
, indent
))
452 switch (flags
& XN_FLAG_SEP_MASK
) {
453 case XN_FLAG_SEP_MULTILINE
:
460 case XN_FLAG_SEP_COMMA_PLUS
:
468 case XN_FLAG_SEP_CPLUS_SPC
:
476 case XN_FLAG_SEP_SPLUS_SPC
:
488 if (flags
& XN_FLAG_SPC_EQ
) {
496 fn_opt
= flags
& XN_FLAG_FN_MASK
;
498 cnt
= X509_NAME_entry_count(n
);
499 for (i
= 0; i
< cnt
; i
++) {
500 if (flags
& XN_FLAG_DN_REV
)
501 ent
= X509_NAME_get_entry(n
, cnt
- i
- 1);
503 ent
= X509_NAME_get_entry(n
, i
);
505 if (prev
== X509_NAME_ENTRY_set(ent
)) {
506 if (!io_ch(arg
, sep_mv
, sep_mv_len
))
508 outlen
+= sep_mv_len
;
510 if (!io_ch(arg
, sep_dn
, sep_dn_len
))
512 outlen
+= sep_dn_len
;
513 if (!do_indent(io_ch
, arg
, indent
))
518 prev
= X509_NAME_ENTRY_set(ent
);
519 fn
= X509_NAME_ENTRY_get_object(ent
);
520 val
= X509_NAME_ENTRY_get_data(ent
);
521 fn_nid
= OBJ_obj2nid(fn
);
522 if (fn_opt
!= XN_FLAG_FN_NONE
) {
524 if ((fn_opt
== XN_FLAG_FN_OID
) || (fn_nid
== NID_undef
)) {
525 OBJ_obj2txt(objtmp
, sizeof objtmp
, fn
, 1);
526 fld_len
= 0; /* XXX: what should this be? */
529 if (fn_opt
== XN_FLAG_FN_SN
) {
530 fld_len
= FN_WIDTH_SN
;
531 objbuf
= OBJ_nid2sn(fn_nid
);
532 } else if (fn_opt
== XN_FLAG_FN_LN
) {
533 fld_len
= FN_WIDTH_LN
;
534 objbuf
= OBJ_nid2ln(fn_nid
);
536 fld_len
= 0; /* XXX: what should this be? */
540 objlen
= strlen(objbuf
);
541 if (!io_ch(arg
, objbuf
, objlen
))
543 if ((objlen
< fld_len
) && (flags
& XN_FLAG_FN_ALIGN
)) {
544 if (!do_indent(io_ch
, arg
, fld_len
- objlen
))
546 outlen
+= fld_len
- objlen
;
548 if (!io_ch(arg
, sep_eq
, sep_eq_len
))
550 outlen
+= objlen
+ sep_eq_len
;
553 * If the field name is unknown then fix up the DER dump flag. We
554 * might want to limit this further so it will DER dump on anything
555 * other than a few 'standard' fields.
557 if ((fn_nid
== NID_undef
) && (flags
& XN_FLAG_DUMP_UNKNOWN_FIELDS
))
558 orflags
= ASN1_STRFLGS_DUMP_ALL
;
562 len
= do_print_ex(io_ch
, arg
, flags
| orflags
, val
);
570 /* Wrappers round the main functions */
572 int X509_NAME_print_ex(BIO
*out
, X509_NAME
*nm
, int indent
,
575 if (flags
== XN_FLAG_COMPAT
)
576 return X509_NAME_print(out
, nm
, indent
);
577 return do_name_ex(send_bio_chars
, out
, nm
, indent
, flags
);
580 #ifndef OPENSSL_NO_STDIO
581 int X509_NAME_print_ex_fp(FILE *fp
, X509_NAME
*nm
, int indent
,
584 if (flags
== XN_FLAG_COMPAT
) {
587 btmp
= BIO_new_fp(fp
, BIO_NOCLOSE
);
590 ret
= X509_NAME_print(btmp
, nm
, indent
);
594 return do_name_ex(send_fp_chars
, fp
, nm
, indent
, flags
);
598 int ASN1_STRING_print_ex(BIO
*out
, ASN1_STRING
*str
, unsigned long flags
)
600 return do_print_ex(send_bio_chars
, out
, flags
, str
);
603 #ifndef OPENSSL_NO_STDIO
604 int ASN1_STRING_print_ex_fp(FILE *fp
, ASN1_STRING
*str
, unsigned long flags
)
606 return do_print_ex(send_fp_chars
, fp
, flags
, str
);
611 * Utility function: convert any string type to UTF8, returns number of bytes
612 * in output string or a negative error code
615 int ASN1_STRING_to_UTF8(unsigned char **out
, ASN1_STRING
*in
)
617 ASN1_STRING stmp
, *str
= &stmp
;
618 int mbflag
, type
, ret
;
622 if ((type
< 0) || (type
> 30))
624 mbflag
= tag2nbyte
[type
];
627 mbflag
|= MBSTRING_FLAG
;
632 ASN1_mbstring_copy(&str
, in
->data
, in
->length
, mbflag
,