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 "internal/asn1_int.h"
14 #include <openssl/crypto.h>
15 #include <openssl/x509.h>
16 #include <openssl/asn1.h>
21 * ASN1_STRING_print_ex() and X509_NAME_print_ex(). Enhanced string and name
22 * printing routines handling multibyte characters, RFC2253 and a host of
26 #define CHARTYPE_BS_ESC (ASN1_STRFLGS_ESC_2253 | CHARTYPE_FIRST_ESC_2253 | CHARTYPE_LAST_ESC_2253)
28 #define ESC_FLAGS (ASN1_STRFLGS_ESC_2253 | \
29 ASN1_STRFLGS_ESC_2254 | \
30 ASN1_STRFLGS_ESC_QUOTE | \
31 ASN1_STRFLGS_ESC_CTRL | \
35 * Three IO functions for sending data to memory, a BIO and and a FILE
38 static int send_bio_chars(void *arg
, const void *buf
, int len
)
42 if (BIO_write(arg
, buf
, len
) != len
)
47 #ifndef OPENSSL_NO_STDIO
48 static int send_fp_chars(void *arg
, const void *buf
, int len
)
52 if (fwrite(buf
, 1, len
, arg
) != (unsigned int)len
)
58 typedef int char_io (void *arg
, const void *buf
, int len
);
61 * This function handles display of strings, one character at a time. It is
62 * passed an unsigned long for each character because it could come from 2 or
66 static int do_esc_char(unsigned long c
, unsigned char flags
, char *do_quotes
,
67 char_io
*io_ch
, void *arg
)
69 unsigned short chflgs
;
71 char tmphex
[HEX_SIZE(long) + 3];
76 BIO_snprintf(tmphex
, sizeof tmphex
, "\\W%08lX", c
);
77 if (!io_ch(arg
, tmphex
, 10))
82 BIO_snprintf(tmphex
, sizeof tmphex
, "\\U%04lX", c
);
83 if (!io_ch(arg
, tmphex
, 6))
87 chtmp
= (unsigned char)c
;
89 chflgs
= flags
& ASN1_STRFLGS_ESC_MSB
;
91 chflgs
= char_type
[chtmp
] & flags
;
92 if (chflgs
& CHARTYPE_BS_ESC
) {
93 /* If we don't escape with quotes, signal we need quotes */
94 if (chflgs
& ASN1_STRFLGS_ESC_QUOTE
) {
97 if (!io_ch(arg
, &chtmp
, 1))
101 if (!io_ch(arg
, "\\", 1))
103 if (!io_ch(arg
, &chtmp
, 1))
107 if (chflgs
& (ASN1_STRFLGS_ESC_CTRL
108 | ASN1_STRFLGS_ESC_MSB
109 | ASN1_STRFLGS_ESC_2254
)) {
110 BIO_snprintf(tmphex
, 11, "\\%02X", chtmp
);
111 if (!io_ch(arg
, tmphex
, 3))
116 * If we get this far and do any escaping at all must escape the escape
117 * character itself: backslash.
119 if (chtmp
== '\\' && flags
& ESC_FLAGS
) {
120 if (!io_ch(arg
, "\\\\", 2))
124 if (!io_ch(arg
, &chtmp
, 1))
129 #define BUF_TYPE_WIDTH_MASK 0x7
130 #define BUF_TYPE_CONVUTF8 0x8
133 * This function sends each character in a buffer to do_esc_char(). It
134 * interprets the content formats and converts to or from UTF8 as
138 static int do_buf(unsigned char *buf
, int buflen
,
139 int type
, unsigned short flags
, char *quotes
, char_io
*io_ch
,
143 unsigned short orflags
;
144 unsigned char *p
, *q
;
150 if (p
== buf
&& flags
& ASN1_STRFLGS_ESC_2253
)
151 orflags
= CHARTYPE_FIRST_ESC_2253
;
154 switch (type
& BUF_TYPE_WIDTH_MASK
) {
156 c
= ((unsigned long)*p
++) << 24;
157 c
|= ((unsigned long)*p
++) << 16;
158 c
|= ((unsigned long)*p
++) << 8;
163 c
= ((unsigned long)*p
++) << 8;
172 i
= UTF8_getc(p
, buflen
, &c
);
174 return -1; /* Invalid UTF8String */
178 return -1; /* invalid width */
180 if (p
== q
&& flags
& ASN1_STRFLGS_ESC_2253
)
181 orflags
= CHARTYPE_LAST_ESC_2253
;
182 if (type
& BUF_TYPE_CONVUTF8
) {
183 unsigned char utfbuf
[6];
185 utflen
= UTF8_putc(utfbuf
, sizeof utfbuf
, c
);
186 for (i
= 0; i
< utflen
; i
++) {
188 * We don't need to worry about setting orflags correctly
189 * because if utflen==1 its value will be correct anyway
190 * otherwise each character will be > 0x7f and so the
191 * character will never be escaped on first and last.
194 do_esc_char(utfbuf
[i
], (unsigned short)(flags
| orflags
),
202 do_esc_char(c
, (unsigned short)(flags
| orflags
), quotes
,
212 /* This function hex dumps a buffer of characters */
214 static int do_hex_dump(char_io
*io_ch
, void *arg
, unsigned char *buf
,
217 static const char hexdig
[] = "0123456789ABCDEF";
218 unsigned char *p
, *q
;
224 hextmp
[0] = hexdig
[*p
>> 4];
225 hextmp
[1] = hexdig
[*p
& 0xf];
226 if (!io_ch(arg
, hextmp
, 2))
235 * "dump" a string. This is done when the type is unknown, or the flags
236 * request it. We can either dump the content octets or the entire DER
237 * encoding. This uses the RFC2253 #01234 format.
240 static int do_dump(unsigned long lflags
, char_io
*io_ch
, void *arg
,
241 const ASN1_STRING
*str
)
244 * Placing the ASN1_STRING in a temp ASN1_TYPE allows the DER encoding to
248 unsigned char *der_buf
, *p
;
251 if (!io_ch(arg
, "#", 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
);
261 t
.value
.ptr
= (char *)str
;
262 der_len
= i2d_ASN1_TYPE(&t
, NULL
);
263 der_buf
= OPENSSL_malloc(der_len
);
267 i2d_ASN1_TYPE(&t
, &p
);
268 outlen
= do_hex_dump(io_ch
, arg
, der_buf
, der_len
);
269 OPENSSL_free(der_buf
);
276 * Lookup table to convert tags to character widths, 0 = UTF8 encoded, -1 is
277 * used for non string types otherwise it is the number of bytes per
281 static const signed char tag2nbyte
[] = {
282 -1, -1, -1, -1, -1, /* 0-4 */
283 -1, -1, -1, -1, -1, /* 5-9 */
284 -1, -1, 0, -1, /* 10-13 */
285 -1, -1, -1, -1, /* 15-17 */
287 -1, 1, 1, 1, /* 21-24 */
288 -1, 1, -1, /* 25-27 */
293 * This is the main function, print out an ASN1_STRING taking note of various
294 * escape and display options. Returns number of characters written or -1 if
298 static int do_print_ex(char_io
*io_ch
, void *arg
, unsigned long lflags
,
299 const ASN1_STRING
*str
)
304 unsigned short flags
;
306 /* Keep a copy of escape flags */
307 flags
= (unsigned short)(lflags
& ESC_FLAGS
);
313 if (lflags
& ASN1_STRFLGS_SHOW_TYPE
) {
315 tagname
= ASN1_tag2str(type
);
316 outlen
+= strlen(tagname
);
317 if (!io_ch(arg
, tagname
, outlen
) || !io_ch(arg
, ":", 1))
322 /* Decide what to do with type, either dump content or display it */
324 /* Dump everything */
325 if (lflags
& ASN1_STRFLGS_DUMP_ALL
)
327 /* Ignore the string type */
328 else if (lflags
& ASN1_STRFLGS_IGNORE_TYPE
)
331 /* Else determine width based on type */
332 if ((type
> 0) && (type
< 31))
333 type
= tag2nbyte
[type
];
336 if ((type
== -1) && !(lflags
& ASN1_STRFLGS_DUMP_UNKNOWN
))
341 len
= do_dump(lflags
, io_ch
, arg
, str
);
348 if (lflags
& ASN1_STRFLGS_UTF8_CONVERT
) {
350 * Note: if string is UTF8 and we want to convert to UTF8 then we
351 * just interpret it as 1 byte per character to avoid converting
357 type
|= BUF_TYPE_CONVUTF8
;
360 len
= do_buf(str
->data
, str
->length
, type
, flags
, "es
, io_ch
, NULL
);
368 if (quotes
&& !io_ch(arg
, "\"", 1))
370 if (do_buf(str
->data
, str
->length
, type
, flags
, NULL
, io_ch
, arg
) < 0)
372 if (quotes
&& !io_ch(arg
, "\"", 1))
377 /* Used for line indenting: print 'indent' spaces */
379 static int do_indent(char_io
*io_ch
, void *arg
, int indent
)
382 for (i
= 0; i
< indent
; i
++)
383 if (!io_ch(arg
, " ", 1))
388 #define FN_WIDTH_LN 25
389 #define FN_WIDTH_SN 10
391 static int do_name_ex(char_io
*io_ch
, void *arg
, const X509_NAME
*n
,
392 int indent
, unsigned long flags
)
394 int i
, prev
= -1, orflags
, cnt
;
397 const ASN1_STRING
*val
;
398 const X509_NAME_ENTRY
*ent
;
402 char *sep_dn
, *sep_mv
, *sep_eq
;
403 int sep_dn_len
, sep_mv_len
, sep_eq_len
;
407 if (!do_indent(io_ch
, arg
, indent
))
409 switch (flags
& XN_FLAG_SEP_MASK
) {
410 case XN_FLAG_SEP_MULTILINE
:
417 case XN_FLAG_SEP_COMMA_PLUS
:
425 case XN_FLAG_SEP_CPLUS_SPC
:
433 case XN_FLAG_SEP_SPLUS_SPC
:
445 if (flags
& XN_FLAG_SPC_EQ
) {
453 fn_opt
= flags
& XN_FLAG_FN_MASK
;
455 cnt
= X509_NAME_entry_count(n
);
456 for (i
= 0; i
< cnt
; i
++) {
457 if (flags
& XN_FLAG_DN_REV
)
458 ent
= X509_NAME_get_entry(n
, cnt
- i
- 1);
460 ent
= X509_NAME_get_entry(n
, i
);
462 if (prev
== X509_NAME_ENTRY_set(ent
)) {
463 if (!io_ch(arg
, sep_mv
, sep_mv_len
))
465 outlen
+= sep_mv_len
;
467 if (!io_ch(arg
, sep_dn
, sep_dn_len
))
469 outlen
+= sep_dn_len
;
470 if (!do_indent(io_ch
, arg
, indent
))
475 prev
= X509_NAME_ENTRY_set(ent
);
476 fn
= X509_NAME_ENTRY_get_object(ent
);
477 val
= X509_NAME_ENTRY_get_data(ent
);
478 fn_nid
= OBJ_obj2nid(fn
);
479 if (fn_opt
!= XN_FLAG_FN_NONE
) {
481 if ((fn_opt
== XN_FLAG_FN_OID
) || (fn_nid
== NID_undef
)) {
482 OBJ_obj2txt(objtmp
, sizeof objtmp
, fn
, 1);
483 fld_len
= 0; /* XXX: what should this be? */
486 if (fn_opt
== XN_FLAG_FN_SN
) {
487 fld_len
= FN_WIDTH_SN
;
488 objbuf
= OBJ_nid2sn(fn_nid
);
489 } else if (fn_opt
== XN_FLAG_FN_LN
) {
490 fld_len
= FN_WIDTH_LN
;
491 objbuf
= OBJ_nid2ln(fn_nid
);
493 fld_len
= 0; /* XXX: what should this be? */
497 objlen
= strlen(objbuf
);
498 if (!io_ch(arg
, objbuf
, objlen
))
500 if ((objlen
< fld_len
) && (flags
& XN_FLAG_FN_ALIGN
)) {
501 if (!do_indent(io_ch
, arg
, fld_len
- objlen
))
503 outlen
+= fld_len
- objlen
;
505 if (!io_ch(arg
, sep_eq
, sep_eq_len
))
507 outlen
+= objlen
+ sep_eq_len
;
510 * If the field name is unknown then fix up the DER dump flag. We
511 * might want to limit this further so it will DER dump on anything
512 * other than a few 'standard' fields.
514 if ((fn_nid
== NID_undef
) && (flags
& XN_FLAG_DUMP_UNKNOWN_FIELDS
))
515 orflags
= ASN1_STRFLGS_DUMP_ALL
;
519 len
= do_print_ex(io_ch
, arg
, flags
| orflags
, val
);
527 /* Wrappers round the main functions */
529 int X509_NAME_print_ex(BIO
*out
, const X509_NAME
*nm
, int indent
,
532 if (flags
== XN_FLAG_COMPAT
)
533 return X509_NAME_print(out
, nm
, indent
);
534 return do_name_ex(send_bio_chars
, out
, nm
, indent
, flags
);
537 #ifndef OPENSSL_NO_STDIO
538 int X509_NAME_print_ex_fp(FILE *fp
, const X509_NAME
*nm
, int indent
,
541 if (flags
== XN_FLAG_COMPAT
) {
544 btmp
= BIO_new_fp(fp
, BIO_NOCLOSE
);
547 ret
= X509_NAME_print(btmp
, nm
, indent
);
551 return do_name_ex(send_fp_chars
, fp
, nm
, indent
, flags
);
555 int ASN1_STRING_print_ex(BIO
*out
, const ASN1_STRING
*str
, unsigned long flags
)
557 return do_print_ex(send_bio_chars
, out
, flags
, str
);
560 #ifndef OPENSSL_NO_STDIO
561 int ASN1_STRING_print_ex_fp(FILE *fp
, const ASN1_STRING
*str
, unsigned long flags
)
563 return do_print_ex(send_fp_chars
, fp
, flags
, str
);
568 * Utility function: convert any string type to UTF8, returns number of bytes
569 * in output string or a negative error code
572 int ASN1_STRING_to_UTF8(unsigned char **out
, const ASN1_STRING
*in
)
574 ASN1_STRING stmp
, *str
= &stmp
;
575 int mbflag
, type
, ret
;
579 if ((type
< 0) || (type
> 30))
581 mbflag
= tag2nbyte
[type
];
584 mbflag
|= MBSTRING_FLAG
;
589 ASN1_mbstring_copy(&str
, in
->data
, in
->length
, mbflag
,
597 /* Return 1 if host is a valid hostname and 0 otherwise */
598 int asn1_valid_host(const ASN1_STRING
*host
)
600 int hostlen
= host
->length
;
601 const unsigned char *hostptr
= host
->data
;
602 int type
= host
->type
;
605 unsigned short chflags
= 0, prevchflags
;
607 if (type
> 0 && type
< 31)
608 width
= tag2nbyte
[type
];
609 if (width
== -1 || hostlen
== 0)
611 /* Treat UTF8String as width 1 as any MSB set is invalid */
614 for (i
= 0 ; i
< hostlen
; i
+= width
) {
615 prevchflags
= chflags
;
616 /* Value must be <= 0x7F: check upper bytes are all zeroes */
618 if (*hostptr
++ != 0 || *hostptr
++ != 0 || *hostptr
++ != 0)
620 } else if (width
== 2) {
626 chflags
= char_type
[*hostptr
++];
627 if (!(chflags
& (CHARTYPE_HOST_ANY
| CHARTYPE_HOST_WILD
))) {
628 /* Nothing else allowed at start or end of string */
629 if (i
== 0 || i
== hostlen
- 1)
631 /* Otherwise invalid if not dot or hyphen */
632 if (!(chflags
& (CHARTYPE_HOST_DOT
| CHARTYPE_HOST_HYPHEN
)))
635 * If previous is dot or hyphen then illegal unless both
636 * are hyphens: as .- -. .. are all illegal
638 if (prevchflags
& (CHARTYPE_HOST_DOT
| CHARTYPE_HOST_HYPHEN
)
639 && ((prevchflags
& CHARTYPE_HOST_DOT
)
640 || (chflags
& CHARTYPE_HOST_DOT
)))