2 * Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
12 #include "internal/cryptlib.h"
13 #include <openssl/crypto.h>
14 #include <openssl/x509.h>
15 #include <openssl/asn1.h>
20 * ASN1_STRING_print_ex() and X509_NAME_print_ex(). Enhanced string and name
21 * printing routines handling multibyte characters, RFC2253 and a host of
25 #define CHARTYPE_BS_ESC (ASN1_STRFLGS_ESC_2253 | CHARTYPE_FIRST_ESC_2253 | CHARTYPE_LAST_ESC_2253)
27 #define ESC_FLAGS (ASN1_STRFLGS_ESC_2253 | \
28 ASN1_STRFLGS_ESC_2254 | \
29 ASN1_STRFLGS_ESC_QUOTE | \
30 ASN1_STRFLGS_ESC_CTRL | \
34 * Three IO functions for sending data to memory, a BIO and and a FILE
37 static int send_bio_chars(void *arg, const void *buf, int len)
41 if (BIO_write(arg, buf, len) != len)
46 #ifndef OPENSSL_NO_STDIO
47 static int send_fp_chars(void *arg, const void *buf, int len)
51 if (fwrite(buf, 1, len, arg) != (unsigned int)len)
57 typedef int char_io (void *arg, const void *buf, int len);
60 * This function handles display of strings, one character at a time. It is
61 * passed an unsigned long for each character because it could come from 2 or
65 static int do_esc_char(unsigned long c, unsigned char flags, char *do_quotes,
66 char_io *io_ch, void *arg)
68 unsigned short chflgs;
70 char tmphex[HEX_SIZE(long) + 3];
75 BIO_snprintf(tmphex, sizeof tmphex, "\\W%08lX", c);
76 if (!io_ch(arg, tmphex, 10))
81 BIO_snprintf(tmphex, sizeof tmphex, "\\U%04lX", c);
82 if (!io_ch(arg, tmphex, 6))
86 chtmp = (unsigned char)c;
88 chflgs = flags & ASN1_STRFLGS_ESC_MSB;
90 chflgs = char_type[chtmp] & flags;
91 if (chflgs & CHARTYPE_BS_ESC) {
92 /* If we don't escape with quotes, signal we need quotes */
93 if (chflgs & ASN1_STRFLGS_ESC_QUOTE) {
96 if (!io_ch(arg, &chtmp, 1))
100 if (!io_ch(arg, "\\", 1))
102 if (!io_ch(arg, &chtmp, 1))
106 if (chflgs & (ASN1_STRFLGS_ESC_CTRL
107 | ASN1_STRFLGS_ESC_MSB
108 | ASN1_STRFLGS_ESC_2254)) {
109 BIO_snprintf(tmphex, 11, "\\%02X", chtmp);
110 if (!io_ch(arg, tmphex, 3))
115 * If we get this far and do any escaping at all must escape the escape
116 * character itself: backslash.
118 if (chtmp == '\\' && flags & ESC_FLAGS) {
119 if (!io_ch(arg, "\\\\", 2))
123 if (!io_ch(arg, &chtmp, 1))
128 #define BUF_TYPE_WIDTH_MASK 0x7
129 #define BUF_TYPE_CONVUTF8 0x8
132 * This function sends each character in a buffer to do_esc_char(). It
133 * interprets the content formats and converts to or from UTF8 as
137 static int do_buf(unsigned char *buf, int buflen,
138 int type, unsigned short flags, char *quotes, char_io *io_ch,
142 unsigned short orflags;
143 unsigned char *p, *q;
149 if (p == buf && flags & ASN1_STRFLGS_ESC_2253)
150 orflags = CHARTYPE_FIRST_ESC_2253;
153 switch (type & BUF_TYPE_WIDTH_MASK) {
155 c = ((unsigned long)*p++) << 24;
156 c |= ((unsigned long)*p++) << 16;
157 c |= ((unsigned long)*p++) << 8;
162 c = ((unsigned long)*p++) << 8;
171 i = UTF8_getc(p, buflen, &c);
173 return -1; /* Invalid UTF8String */
177 return -1; /* invalid width */
179 if (p == q && flags & ASN1_STRFLGS_ESC_2253)
180 orflags = CHARTYPE_LAST_ESC_2253;
181 if (type & BUF_TYPE_CONVUTF8) {
182 unsigned char utfbuf[6];
184 utflen = UTF8_putc(utfbuf, sizeof utfbuf, c);
185 for (i = 0; i < utflen; i++) {
187 * We don't need to worry about setting orflags correctly
188 * because if utflen==1 its value will be correct anyway
189 * otherwise each character will be > 0x7f and so the
190 * character will never be escaped on first and last.
193 do_esc_char(utfbuf[i], (unsigned short)(flags | orflags),
201 do_esc_char(c, (unsigned short)(flags | orflags), quotes,
211 /* This function hex dumps a buffer of characters */
213 static int do_hex_dump(char_io *io_ch, void *arg, unsigned char *buf,
216 static const char hexdig[] = "0123456789ABCDEF";
217 unsigned char *p, *q;
223 hextmp[0] = hexdig[*p >> 4];
224 hextmp[1] = hexdig[*p & 0xf];
225 if (!io_ch(arg, hextmp, 2))
234 * "dump" a string. This is done when the type is unknown, or the flags
235 * request it. We can either dump the content octets or the entire DER
236 * encoding. This uses the RFC2253 #01234 format.
239 static int do_dump(unsigned long lflags, char_io *io_ch, void *arg,
243 * Placing the ASN1_STRING in a temp ASN1_TYPE allows the DER encoding to
247 unsigned char *der_buf, *p;
250 if (!io_ch(arg, "#", 1))
252 /* If we don't dump DER encoding just dump content octets */
253 if (!(lflags & ASN1_STRFLGS_DUMP_DER)) {
254 outlen = do_hex_dump(io_ch, arg, str->data, str->length);
260 t.value.ptr = (char *)str;
261 der_len = i2d_ASN1_TYPE(&t, NULL);
262 der_buf = OPENSSL_malloc(der_len);
266 i2d_ASN1_TYPE(&t, &p);
267 outlen = do_hex_dump(io_ch, arg, der_buf, der_len);
268 OPENSSL_free(der_buf);
275 * Lookup table to convert tags to character widths, 0 = UTF8 encoded, -1 is
276 * used for non string types otherwise it is the number of bytes per
280 static const signed char tag2nbyte[] = {
281 -1, -1, -1, -1, -1, /* 0-4 */
282 -1, -1, -1, -1, -1, /* 5-9 */
283 -1, -1, 0, -1, /* 10-13 */
284 -1, -1, -1, -1, /* 15-17 */
286 -1, 1, 1, 1, /* 21-24 */
287 -1, 1, -1, /* 25-27 */
292 * This is the main function, print out an ASN1_STRING taking note of various
293 * escape and display options. Returns number of characters written or -1 if
297 static int do_print_ex(char_io *io_ch, void *arg, unsigned long lflags,
303 unsigned short flags;
305 /* Keep a copy of escape flags */
306 flags = (unsigned short)(lflags & ESC_FLAGS);
312 if (lflags & ASN1_STRFLGS_SHOW_TYPE) {
314 tagname = ASN1_tag2str(type);
315 outlen += strlen(tagname);
316 if (!io_ch(arg, tagname, outlen) || !io_ch(arg, ":", 1))
321 /* Decide what to do with type, either dump content or display it */
323 /* Dump everything */
324 if (lflags & ASN1_STRFLGS_DUMP_ALL)
326 /* Ignore the string type */
327 else if (lflags & ASN1_STRFLGS_IGNORE_TYPE)
330 /* Else determine width based on type */
331 if ((type > 0) && (type < 31))
332 type = tag2nbyte[type];
335 if ((type == -1) && !(lflags & ASN1_STRFLGS_DUMP_UNKNOWN))
340 len = do_dump(lflags, io_ch, arg, str);
347 if (lflags & ASN1_STRFLGS_UTF8_CONVERT) {
349 * Note: if string is UTF8 and we want to convert to UTF8 then we
350 * just interpret it as 1 byte per character to avoid converting
356 type |= BUF_TYPE_CONVUTF8;
359 len = do_buf(str->data, str->length, type, flags, "es, io_ch, NULL);
367 if (quotes && !io_ch(arg, "\"", 1))
369 if (do_buf(str->data, str->length, type, flags, NULL, io_ch, arg) < 0)
371 if (quotes && !io_ch(arg, "\"", 1))
376 /* Used for line indenting: print 'indent' spaces */
378 static int do_indent(char_io *io_ch, void *arg, int indent)
381 for (i = 0; i < indent; i++)
382 if (!io_ch(arg, " ", 1))
387 #define FN_WIDTH_LN 25
388 #define FN_WIDTH_SN 10
390 static int do_name_ex(char_io *io_ch, void *arg, X509_NAME *n,
391 int indent, unsigned long flags)
393 int i, prev = -1, orflags, cnt;
397 X509_NAME_ENTRY *ent;
401 char *sep_dn, *sep_mv, *sep_eq;
402 int sep_dn_len, sep_mv_len, sep_eq_len;
406 if (!do_indent(io_ch, arg, indent))
408 switch (flags & XN_FLAG_SEP_MASK) {
409 case XN_FLAG_SEP_MULTILINE:
416 case XN_FLAG_SEP_COMMA_PLUS:
424 case XN_FLAG_SEP_CPLUS_SPC:
432 case XN_FLAG_SEP_SPLUS_SPC:
444 if (flags & XN_FLAG_SPC_EQ) {
452 fn_opt = flags & XN_FLAG_FN_MASK;
454 cnt = X509_NAME_entry_count(n);
455 for (i = 0; i < cnt; i++) {
456 if (flags & XN_FLAG_DN_REV)
457 ent = X509_NAME_get_entry(n, cnt - i - 1);
459 ent = X509_NAME_get_entry(n, i);
461 if (prev == X509_NAME_ENTRY_set(ent)) {
462 if (!io_ch(arg, sep_mv, sep_mv_len))
464 outlen += sep_mv_len;
466 if (!io_ch(arg, sep_dn, sep_dn_len))
468 outlen += sep_dn_len;
469 if (!do_indent(io_ch, arg, indent))
474 prev = X509_NAME_ENTRY_set(ent);
475 fn = X509_NAME_ENTRY_get_object(ent);
476 val = X509_NAME_ENTRY_get_data(ent);
477 fn_nid = OBJ_obj2nid(fn);
478 if (fn_opt != XN_FLAG_FN_NONE) {
480 if ((fn_opt == XN_FLAG_FN_OID) || (fn_nid == NID_undef)) {
481 OBJ_obj2txt(objtmp, sizeof objtmp, fn, 1);
482 fld_len = 0; /* XXX: what should this be? */
485 if (fn_opt == XN_FLAG_FN_SN) {
486 fld_len = FN_WIDTH_SN;
487 objbuf = OBJ_nid2sn(fn_nid);
488 } else if (fn_opt == XN_FLAG_FN_LN) {
489 fld_len = FN_WIDTH_LN;
490 objbuf = OBJ_nid2ln(fn_nid);
492 fld_len = 0; /* XXX: what should this be? */
496 objlen = strlen(objbuf);
497 if (!io_ch(arg, objbuf, objlen))
499 if ((objlen < fld_len) && (flags & XN_FLAG_FN_ALIGN)) {
500 if (!do_indent(io_ch, arg, fld_len - objlen))
502 outlen += fld_len - objlen;
504 if (!io_ch(arg, sep_eq, sep_eq_len))
506 outlen += objlen + sep_eq_len;
509 * If the field name is unknown then fix up the DER dump flag. We
510 * might want to limit this further so it will DER dump on anything
511 * other than a few 'standard' fields.
513 if ((fn_nid == NID_undef) && (flags & XN_FLAG_DUMP_UNKNOWN_FIELDS))
514 orflags = ASN1_STRFLGS_DUMP_ALL;
518 len = do_print_ex(io_ch, arg, flags | orflags, val);
526 /* Wrappers round the main functions */
528 int X509_NAME_print_ex(BIO *out, X509_NAME *nm, int indent,
531 if (flags == XN_FLAG_COMPAT)
532 return X509_NAME_print(out, nm, indent);
533 return do_name_ex(send_bio_chars, out, nm, indent, flags);
536 #ifndef OPENSSL_NO_STDIO
537 int X509_NAME_print_ex_fp(FILE *fp, X509_NAME *nm, int indent,
540 if (flags == XN_FLAG_COMPAT) {
543 btmp = BIO_new_fp(fp, BIO_NOCLOSE);
546 ret = X509_NAME_print(btmp, nm, indent);
550 return do_name_ex(send_fp_chars, fp, nm, indent, flags);
554 int ASN1_STRING_print_ex(BIO *out, ASN1_STRING *str, unsigned long flags)
556 return do_print_ex(send_bio_chars, out, flags, str);
559 #ifndef OPENSSL_NO_STDIO
560 int ASN1_STRING_print_ex_fp(FILE *fp, ASN1_STRING *str, unsigned long flags)
562 return do_print_ex(send_fp_chars, fp, flags, str);
567 * Utility function: convert any string type to UTF8, returns number of bytes
568 * in output string or a negative error code
571 int ASN1_STRING_to_UTF8(unsigned char **out, ASN1_STRING *in)
573 ASN1_STRING stmp, *str = &stmp;
574 int mbflag, type, ret;
578 if ((type < 0) || (type > 30))
580 mbflag = tag2nbyte[type];
583 mbflag |= MBSTRING_FLAG;
588 ASN1_mbstring_copy(&str, in->data, in->length, mbflag,