3 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
6 /* ====================================================================
7 * Copyright (c) 2000 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 static int send_bio_chars(void *arg, const void *buf, int len)
90 if (BIO_write(arg, buf, len) != len)
95 static int send_fp_chars(void *arg, const void *buf, int len)
99 if (fwrite(buf, 1, len, arg) != (unsigned int)len)
104 typedef int char_io (void *arg, const void *buf, int len);
107 * This function handles display of strings, one character at a time. It is
108 * passed an unsigned long for each character because it could come from 2 or
112 static int do_esc_char(unsigned long c, unsigned char flags, char *do_quotes,
113 char_io *io_ch, void *arg)
115 unsigned char chflgs, chtmp;
116 char tmphex[HEX_SIZE(long) + 3];
121 BIO_snprintf(tmphex, sizeof tmphex, "\\W%08lX", c);
122 if (!io_ch(arg, tmphex, 10))
127 BIO_snprintf(tmphex, sizeof tmphex, "\\U%04lX", c);
128 if (!io_ch(arg, tmphex, 6))
132 chtmp = (unsigned char)c;
134 chflgs = flags & ASN1_STRFLGS_ESC_MSB;
136 chflgs = char_type[chtmp] & flags;
137 if (chflgs & CHARTYPE_BS_ESC) {
138 /* If we don't escape with quotes, signal we need quotes */
139 if (chflgs & ASN1_STRFLGS_ESC_QUOTE) {
142 if (!io_ch(arg, &chtmp, 1))
146 if (!io_ch(arg, "\\", 1))
148 if (!io_ch(arg, &chtmp, 1))
152 if (chflgs & (ASN1_STRFLGS_ESC_CTRL | ASN1_STRFLGS_ESC_MSB)) {
153 BIO_snprintf(tmphex, 11, "\\%02X", chtmp);
154 if (!io_ch(arg, tmphex, 3))
159 * If we get this far and do any escaping at all must escape the escape
160 * character itself: backslash.
162 if (chtmp == '\\' && flags & ESC_FLAGS) {
163 if (!io_ch(arg, "\\\\", 2))
167 if (!io_ch(arg, &chtmp, 1))
172 #define BUF_TYPE_WIDTH_MASK 0x7
173 #define BUF_TYPE_CONVUTF8 0x8
176 * This function sends each character in a buffer to do_esc_char(). It
177 * interprets the content formats and converts to or from UTF8 as
181 static int do_buf(unsigned char *buf, int buflen,
182 int type, unsigned char flags, char *quotes, char_io *io_ch,
186 unsigned char orflags, *p, *q;
192 if (p == buf && flags & ASN1_STRFLGS_ESC_2253)
193 orflags = CHARTYPE_FIRST_ESC_2253;
196 switch (type & BUF_TYPE_WIDTH_MASK) {
198 c = ((unsigned long)*p++) << 24;
199 c |= ((unsigned long)*p++) << 16;
200 c |= ((unsigned long)*p++) << 8;
205 c = ((unsigned long)*p++) << 8;
214 i = UTF8_getc(p, buflen, &c);
216 return -1; /* Invalid UTF8String */
220 return -1; /* invalid width */
222 if (p == q && flags & ASN1_STRFLGS_ESC_2253)
223 orflags = CHARTYPE_LAST_ESC_2253;
224 if (type & BUF_TYPE_CONVUTF8) {
225 unsigned char utfbuf[6];
227 utflen = UTF8_putc(utfbuf, sizeof utfbuf, c);
228 for (i = 0; i < utflen; i++) {
230 * We don't need to worry about setting orflags correctly
231 * because if utflen==1 its value will be correct anyway
232 * otherwise each character will be > 0x7f and so the
233 * character will never be escaped on first and last.
236 do_esc_char(utfbuf[i], (unsigned char)(flags | orflags),
244 do_esc_char(c, (unsigned char)(flags | orflags), quotes,
254 /* This function hex dumps a buffer of characters */
256 static int do_hex_dump(char_io *io_ch, void *arg, unsigned char *buf,
259 static const char hexdig[] = "0123456789ABCDEF";
260 unsigned char *p, *q;
266 hextmp[0] = hexdig[*p >> 4];
267 hextmp[1] = hexdig[*p & 0xf];
268 if (!io_ch(arg, hextmp, 2))
277 * "dump" a string. This is done when the type is unknown, or the flags
278 * request it. We can either dump the content octets or the entire DER
279 * encoding. This uses the RFC2253 #01234 format.
282 static int do_dump(unsigned long lflags, char_io *io_ch, void *arg,
286 * Placing the ASN1_STRING in a temp ASN1_TYPE allows the DER encoding to
290 unsigned char *der_buf, *p;
293 if (!io_ch(arg, "#", 1))
295 /* If we don't dump DER encoding just dump content octets */
296 if (!(lflags & ASN1_STRFLGS_DUMP_DER)) {
297 outlen = do_hex_dump(io_ch, arg, str->data, str->length);
303 t.value.ptr = (char *)str;
304 der_len = i2d_ASN1_TYPE(&t, NULL);
305 der_buf = OPENSSL_malloc(der_len);
309 i2d_ASN1_TYPE(&t, &p);
310 outlen = do_hex_dump(io_ch, arg, der_buf, der_len);
311 OPENSSL_free(der_buf);
318 * Lookup table to convert tags to character widths, 0 = UTF8 encoded, -1 is
319 * used for non string types otherwise it is the number of bytes per
323 static const signed char tag2nbyte[] = {
324 -1, -1, -1, -1, -1, /* 0-4 */
325 -1, -1, -1, -1, -1, /* 5-9 */
326 -1, -1, 0, -1, /* 10-13 */
327 -1, -1, -1, -1, /* 15-17 */
328 -1, 1, 1, /* 18-20 */
329 -1, 1, 1, 1, /* 21-24 */
330 -1, 1, -1, /* 25-27 */
335 * This is the main function, print out an ASN1_STRING taking note of various
336 * escape and display options. Returns number of characters written or -1 if
340 static int do_print_ex(char_io *io_ch, void *arg, unsigned long lflags,
348 /* Keep a copy of escape flags */
349 flags = (unsigned char)(lflags & ESC_FLAGS);
355 if (lflags & ASN1_STRFLGS_SHOW_TYPE) {
357 tagname = ASN1_tag2str(type);
358 outlen += strlen(tagname);
359 if (!io_ch(arg, tagname, outlen) || !io_ch(arg, ":", 1))
364 /* Decide what to do with type, either dump content or display it */
366 /* Dump everything */
367 if (lflags & ASN1_STRFLGS_DUMP_ALL)
369 /* Ignore the string type */
370 else if (lflags & ASN1_STRFLGS_IGNORE_TYPE)
373 /* Else determine width based on type */
374 if ((type > 0) && (type < 31))
375 type = tag2nbyte[type];
378 if ((type == -1) && !(lflags & ASN1_STRFLGS_DUMP_UNKNOWN))
383 len = do_dump(lflags, io_ch, arg, str);
390 if (lflags & ASN1_STRFLGS_UTF8_CONVERT) {
392 * Note: if string is UTF8 and we want to convert to UTF8 then we
393 * just interpret it as 1 byte per character to avoid converting
399 type |= BUF_TYPE_CONVUTF8;
402 len = do_buf(str->data, str->length, type, flags, "es, io_ch, NULL);
410 if (quotes && !io_ch(arg, "\"", 1))
412 if (do_buf(str->data, str->length, type, flags, NULL, io_ch, arg) < 0)
414 if (quotes && !io_ch(arg, "\"", 1))
419 /* Used for line indenting: print 'indent' spaces */
421 static int do_indent(char_io *io_ch, void *arg, int indent)
424 for (i = 0; i < indent; i++)
425 if (!io_ch(arg, " ", 1))
430 #define FN_WIDTH_LN 25
431 #define FN_WIDTH_SN 10
433 static int do_name_ex(char_io *io_ch, void *arg, X509_NAME *n,
434 int indent, unsigned long flags)
436 int i, prev = -1, orflags, cnt;
440 X509_NAME_ENTRY *ent;
444 char *sep_dn, *sep_mv, *sep_eq;
445 int sep_dn_len, sep_mv_len, sep_eq_len;
449 if (!do_indent(io_ch, arg, indent))
451 switch (flags & XN_FLAG_SEP_MASK) {
452 case XN_FLAG_SEP_MULTILINE:
459 case XN_FLAG_SEP_COMMA_PLUS:
467 case XN_FLAG_SEP_CPLUS_SPC:
475 case XN_FLAG_SEP_SPLUS_SPC:
487 if (flags & XN_FLAG_SPC_EQ) {
495 fn_opt = flags & XN_FLAG_FN_MASK;
497 cnt = X509_NAME_entry_count(n);
498 for (i = 0; i < cnt; i++) {
499 if (flags & XN_FLAG_DN_REV)
500 ent = X509_NAME_get_entry(n, cnt - i - 1);
502 ent = X509_NAME_get_entry(n, i);
504 if (prev == ent->set) {
505 if (!io_ch(arg, sep_mv, sep_mv_len))
507 outlen += sep_mv_len;
509 if (!io_ch(arg, sep_dn, sep_dn_len))
511 outlen += sep_dn_len;
512 if (!do_indent(io_ch, arg, indent))
518 fn = X509_NAME_ENTRY_get_object(ent);
519 val = X509_NAME_ENTRY_get_data(ent);
520 fn_nid = OBJ_obj2nid(fn);
521 if (fn_opt != XN_FLAG_FN_NONE) {
523 if ((fn_opt == XN_FLAG_FN_OID) || (fn_nid == NID_undef)) {
524 OBJ_obj2txt(objtmp, sizeof objtmp, fn, 1);
525 fld_len = 0; /* XXX: what should this be? */
528 if (fn_opt == XN_FLAG_FN_SN) {
529 fld_len = FN_WIDTH_SN;
530 objbuf = OBJ_nid2sn(fn_nid);
531 } else if (fn_opt == XN_FLAG_FN_LN) {
532 fld_len = FN_WIDTH_LN;
533 objbuf = OBJ_nid2ln(fn_nid);
535 fld_len = 0; /* XXX: what should this be? */
539 objlen = strlen(objbuf);
540 if (!io_ch(arg, objbuf, objlen))
542 if ((objlen < fld_len) && (flags & XN_FLAG_FN_ALIGN)) {
543 if (!do_indent(io_ch, arg, fld_len - objlen))
545 outlen += fld_len - objlen;
547 if (!io_ch(arg, sep_eq, sep_eq_len))
549 outlen += objlen + sep_eq_len;
552 * If the field name is unknown then fix up the DER dump flag. We
553 * might want to limit this further so it will DER dump on anything
554 * other than a few 'standard' fields.
556 if ((fn_nid == NID_undef) && (flags & XN_FLAG_DUMP_UNKNOWN_FIELDS))
557 orflags = ASN1_STRFLGS_DUMP_ALL;
561 len = do_print_ex(io_ch, arg, flags | orflags, val);
569 /* Wrappers round the main functions */
571 int X509_NAME_print_ex(BIO *out, X509_NAME *nm, int indent,
574 if (flags == XN_FLAG_COMPAT)
575 return X509_NAME_print(out, nm, indent);
576 return do_name_ex(send_bio_chars, out, nm, indent, flags);
579 #ifndef OPENSSL_NO_STDIO
580 int X509_NAME_print_ex_fp(FILE *fp, X509_NAME *nm, int indent,
583 if (flags == XN_FLAG_COMPAT) {
586 btmp = BIO_new_fp(fp, BIO_NOCLOSE);
589 ret = X509_NAME_print(btmp, nm, indent);
593 return do_name_ex(send_fp_chars, fp, nm, indent, flags);
597 int ASN1_STRING_print_ex(BIO *out, ASN1_STRING *str, unsigned long flags)
599 return do_print_ex(send_bio_chars, out, flags, str);
602 #ifndef OPENSSL_NO_STDIO
603 int ASN1_STRING_print_ex_fp(FILE *fp, ASN1_STRING *str, unsigned long flags)
605 return do_print_ex(send_fp_chars, fp, flags, str);
610 * Utility function: convert any string type to UTF8, returns number of bytes
611 * in output string or a negative error code
614 int ASN1_STRING_to_UTF8(unsigned char **out, ASN1_STRING *in)
616 ASN1_STRING stmp, *str = &stmp;
617 int mbflag, type, ret;
621 if ((type < 0) || (type > 30))
623 mbflag = tag2nbyte[type];
626 mbflag |= MBSTRING_FLAG;
631 ASN1_mbstring_copy(&str, in->data, in->length, mbflag,