3 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
6 /* ====================================================================
7 * Copyright (c) 2000-2018 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/crypto.h>
64 #include <openssl/x509.h>
65 #include <openssl/asn1.h>
70 * ASN1_STRING_print_ex() and X509_NAME_print_ex(). Enhanced string and name
71 * printing routines handling multibyte characters, RFC2253 and a host of
75 #define CHARTYPE_BS_ESC (ASN1_STRFLGS_ESC_2253 | CHARTYPE_FIRST_ESC_2253 | CHARTYPE_LAST_ESC_2253)
77 #define ESC_FLAGS (ASN1_STRFLGS_ESC_2253 | \
78 ASN1_STRFLGS_ESC_QUOTE | \
79 ASN1_STRFLGS_ESC_CTRL | \
83 * Three IO functions for sending data to memory, a BIO and and a FILE
86 #if 0 /* never used */
87 static int send_mem_chars(void *arg, const void *buf, int len)
89 unsigned char **out = arg;
92 memcpy(*out, buf, len);
98 static int send_bio_chars(void *arg, const void *buf, int len)
102 if (BIO_write(arg, buf, len) != len)
107 static int send_fp_chars(void *arg, const void *buf, int len)
111 if (fwrite(buf, 1, len, arg) != (unsigned int)len)
116 typedef int char_io (void *arg, const void *buf, int len);
119 * This function handles display of strings, one character at a time. It is
120 * passed an unsigned long for each character because it could come from 2 or
124 static int do_esc_char(unsigned long c, unsigned char flags, char *do_quotes,
125 char_io *io_ch, void *arg)
127 unsigned char chflgs, chtmp;
128 char tmphex[HEX_SIZE(long) + 3];
133 BIO_snprintf(tmphex, sizeof(tmphex), "\\W%08lX", c);
134 if (!io_ch(arg, tmphex, 10))
139 BIO_snprintf(tmphex, sizeof(tmphex), "\\U%04lX", c);
140 if (!io_ch(arg, tmphex, 6))
144 chtmp = (unsigned char)c;
146 chflgs = flags & ASN1_STRFLGS_ESC_MSB;
148 chflgs = char_type[chtmp] & flags;
149 if (chflgs & CHARTYPE_BS_ESC) {
150 /* If we don't escape with quotes, signal we need quotes */
151 if (chflgs & ASN1_STRFLGS_ESC_QUOTE) {
154 if (!io_ch(arg, &chtmp, 1))
158 if (!io_ch(arg, "\\", 1))
160 if (!io_ch(arg, &chtmp, 1))
164 if (chflgs & (ASN1_STRFLGS_ESC_CTRL | ASN1_STRFLGS_ESC_MSB)) {
165 BIO_snprintf(tmphex, 11, "\\%02X", chtmp);
166 if (!io_ch(arg, tmphex, 3))
171 * If we get this far and do any escaping at all must escape the escape
172 * character itself: backslash.
174 if (chtmp == '\\' && flags & ESC_FLAGS) {
175 if (!io_ch(arg, "\\\\", 2))
179 if (!io_ch(arg, &chtmp, 1))
184 #define BUF_TYPE_WIDTH_MASK 0x7
185 #define BUF_TYPE_CONVUTF8 0x8
188 * This function sends each character in a buffer to do_esc_char(). It
189 * interprets the content formats and converts to or from UTF8 as
193 static int do_buf(unsigned char *buf, int buflen,
194 int type, unsigned char flags, char *quotes, char_io *io_ch,
197 int i, outlen, len, charwidth;
198 unsigned char orflags, *p, *q;
203 charwidth = type & BUF_TYPE_WIDTH_MASK;
208 ASN1err(ASN1_F_DO_BUF, ASN1_R_INVALID_UNIVERSALSTRING_LENGTH);
214 ASN1err(ASN1_F_DO_BUF, ASN1_R_INVALID_BMPSTRING_LENGTH);
223 if (p == buf && flags & ASN1_STRFLGS_ESC_2253)
224 orflags = CHARTYPE_FIRST_ESC_2253;
230 c = ((unsigned long)*p++) << 24;
231 c |= ((unsigned long)*p++) << 16;
232 c |= ((unsigned long)*p++) << 8;
237 c = ((unsigned long)*p++) << 8;
246 i = UTF8_getc(p, buflen, &c);
248 return -1; /* Invalid UTF8String */
253 return -1; /* invalid width */
255 if (p == q && flags & ASN1_STRFLGS_ESC_2253)
256 orflags = CHARTYPE_LAST_ESC_2253;
257 if (type & BUF_TYPE_CONVUTF8) {
258 unsigned char utfbuf[6];
260 utflen = UTF8_putc(utfbuf, sizeof(utfbuf), c);
261 for (i = 0; i < utflen; i++) {
263 * We don't need to worry about setting orflags correctly
264 * because if utflen==1 its value will be correct anyway
265 * otherwise each character will be > 0x7f and so the
266 * character will never be escaped on first and last.
269 do_esc_char(utfbuf[i], (unsigned char)(flags | orflags),
277 do_esc_char(c, (unsigned char)(flags | orflags), quotes,
287 /* This function hex dumps a buffer of characters */
289 static int do_hex_dump(char_io *io_ch, void *arg, unsigned char *buf,
292 static const char hexdig[] = "0123456789ABCDEF";
293 unsigned char *p, *q;
299 hextmp[0] = hexdig[*p >> 4];
300 hextmp[1] = hexdig[*p & 0xf];
301 if (!io_ch(arg, hextmp, 2))
310 * "dump" a string. This is done when the type is unknown, or the flags
311 * request it. We can either dump the content octets or the entire DER
312 * encoding. This uses the RFC2253 #01234 format.
315 static int do_dump(unsigned long lflags, char_io *io_ch, void *arg,
319 * Placing the ASN1_STRING in a temp ASN1_TYPE allows the DER encoding to
323 unsigned char *der_buf, *p;
326 if (!io_ch(arg, "#", 1))
328 /* If we don't dump DER encoding just dump content octets */
329 if (!(lflags & ASN1_STRFLGS_DUMP_DER)) {
330 outlen = do_hex_dump(io_ch, arg, str->data, str->length);
336 t.value.ptr = (char *)str;
337 der_len = i2d_ASN1_TYPE(&t, NULL);
338 der_buf = OPENSSL_malloc(der_len);
342 i2d_ASN1_TYPE(&t, &p);
343 outlen = do_hex_dump(io_ch, arg, der_buf, der_len);
344 OPENSSL_free(der_buf);
351 * Lookup table to convert tags to character widths, 0 = UTF8 encoded, -1 is
352 * used for non string types otherwise it is the number of bytes per
356 static const signed char tag2nbyte[] = {
357 -1, -1, -1, -1, -1, /* 0-4 */
358 -1, -1, -1, -1, -1, /* 5-9 */
359 -1, -1, 0, -1, /* 10-13 */
360 -1, -1, -1, -1, /* 15-17 */
362 -1, 1, 1, 1, /* 21-24 */
363 -1, 1, -1, /* 25-27 */
368 * This is the main function, print out an ASN1_STRING taking note of various
369 * escape and display options. Returns number of characters written or -1 if
373 static int do_print_ex(char_io *io_ch, void *arg, unsigned long lflags,
381 /* Keep a copy of escape flags */
382 flags = (unsigned char)(lflags & ESC_FLAGS);
388 if (lflags & ASN1_STRFLGS_SHOW_TYPE) {
390 tagname = ASN1_tag2str(type);
391 outlen += strlen(tagname);
392 if (!io_ch(arg, tagname, outlen) || !io_ch(arg, ":", 1))
397 /* Decide what to do with type, either dump content or display it */
399 /* Dump everything */
400 if (lflags & ASN1_STRFLGS_DUMP_ALL)
402 /* Ignore the string type */
403 else if (lflags & ASN1_STRFLGS_IGNORE_TYPE)
406 /* Else determine width based on type */
407 if ((type > 0) && (type < 31))
408 type = tag2nbyte[type];
411 if ((type == -1) && !(lflags & ASN1_STRFLGS_DUMP_UNKNOWN))
416 len = do_dump(lflags, io_ch, arg, str);
423 if (lflags & ASN1_STRFLGS_UTF8_CONVERT) {
425 * Note: if string is UTF8 and we want to convert to UTF8 then we
426 * just interpret it as 1 byte per character to avoid converting
432 type |= BUF_TYPE_CONVUTF8;
435 len = do_buf(str->data, str->length, type, flags, "es, io_ch, NULL);
443 if (quotes && !io_ch(arg, "\"", 1))
445 if (do_buf(str->data, str->length, type, flags, NULL, io_ch, arg) < 0)
447 if (quotes && !io_ch(arg, "\"", 1))
452 /* Used for line indenting: print 'indent' spaces */
454 static int do_indent(char_io *io_ch, void *arg, int indent)
457 for (i = 0; i < indent; i++)
458 if (!io_ch(arg, " ", 1))
463 #define FN_WIDTH_LN 25
464 #define FN_WIDTH_SN 10
466 static int do_name_ex(char_io *io_ch, void *arg, X509_NAME *n,
467 int indent, unsigned long flags)
469 int i, prev = -1, orflags, cnt;
473 X509_NAME_ENTRY *ent;
477 char *sep_dn, *sep_mv, *sep_eq;
478 int sep_dn_len, sep_mv_len, sep_eq_len;
482 if (!do_indent(io_ch, arg, indent))
484 switch (flags & XN_FLAG_SEP_MASK) {
485 case XN_FLAG_SEP_MULTILINE:
492 case XN_FLAG_SEP_COMMA_PLUS:
500 case XN_FLAG_SEP_CPLUS_SPC:
508 case XN_FLAG_SEP_SPLUS_SPC:
520 if (flags & XN_FLAG_SPC_EQ) {
528 fn_opt = flags & XN_FLAG_FN_MASK;
530 cnt = X509_NAME_entry_count(n);
531 for (i = 0; i < cnt; i++) {
532 if (flags & XN_FLAG_DN_REV)
533 ent = X509_NAME_get_entry(n, cnt - i - 1);
535 ent = X509_NAME_get_entry(n, i);
537 if (prev == ent->set) {
538 if (!io_ch(arg, sep_mv, sep_mv_len))
540 outlen += sep_mv_len;
542 if (!io_ch(arg, sep_dn, sep_dn_len))
544 outlen += sep_dn_len;
545 if (!do_indent(io_ch, arg, indent))
551 fn = X509_NAME_ENTRY_get_object(ent);
552 val = X509_NAME_ENTRY_get_data(ent);
553 fn_nid = OBJ_obj2nid(fn);
554 if (fn_opt != XN_FLAG_FN_NONE) {
556 if ((fn_opt == XN_FLAG_FN_OID) || (fn_nid == NID_undef)) {
557 OBJ_obj2txt(objtmp, sizeof(objtmp), fn, 1);
558 fld_len = 0; /* XXX: what should this be? */
561 if (fn_opt == XN_FLAG_FN_SN) {
562 fld_len = FN_WIDTH_SN;
563 objbuf = OBJ_nid2sn(fn_nid);
564 } else if (fn_opt == XN_FLAG_FN_LN) {
565 fld_len = FN_WIDTH_LN;
566 objbuf = OBJ_nid2ln(fn_nid);
568 fld_len = 0; /* XXX: what should this be? */
572 objlen = strlen(objbuf);
573 if (!io_ch(arg, objbuf, objlen))
575 if ((objlen < fld_len) && (flags & XN_FLAG_FN_ALIGN)) {
576 if (!do_indent(io_ch, arg, fld_len - objlen))
578 outlen += fld_len - objlen;
580 if (!io_ch(arg, sep_eq, sep_eq_len))
582 outlen += objlen + sep_eq_len;
585 * If the field name is unknown then fix up the DER dump flag. We
586 * might want to limit this further so it will DER dump on anything
587 * other than a few 'standard' fields.
589 if ((fn_nid == NID_undef) && (flags & XN_FLAG_DUMP_UNKNOWN_FIELDS))
590 orflags = ASN1_STRFLGS_DUMP_ALL;
594 len = do_print_ex(io_ch, arg, flags | orflags, val);
602 /* Wrappers round the main functions */
604 int X509_NAME_print_ex(BIO *out, X509_NAME *nm, int indent,
607 if (flags == XN_FLAG_COMPAT)
608 return X509_NAME_print(out, nm, indent);
609 return do_name_ex(send_bio_chars, out, nm, indent, flags);
612 #ifndef OPENSSL_NO_FP_API
613 int X509_NAME_print_ex_fp(FILE *fp, X509_NAME *nm, int indent,
616 if (flags == XN_FLAG_COMPAT) {
619 btmp = BIO_new_fp(fp, BIO_NOCLOSE);
622 ret = X509_NAME_print(btmp, nm, indent);
626 return do_name_ex(send_fp_chars, fp, nm, indent, flags);
630 int ASN1_STRING_print_ex(BIO *out, ASN1_STRING *str, unsigned long flags)
632 return do_print_ex(send_bio_chars, out, flags, str);
635 #ifndef OPENSSL_NO_FP_API
636 int ASN1_STRING_print_ex_fp(FILE *fp, ASN1_STRING *str, unsigned long flags)
638 return do_print_ex(send_fp_chars, fp, flags, str);
643 * Utility function: convert any string type to UTF8, returns number of bytes
644 * in output string or a negative error code
647 int ASN1_STRING_to_UTF8(unsigned char **out, ASN1_STRING *in)
649 ASN1_STRING stmp, *str = &stmp;
650 int mbflag, type, ret;
654 if ((type < 0) || (type > 30))
656 mbflag = tag2nbyte[type];
659 mbflag |= MBSTRING_FLAG;
664 ASN1_mbstring_copy(&str, in->data, in->length, mbflag,