2 /* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL
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).
62 #include <openssl/crypto.h>
63 #include <openssl/x509.h>
64 #include <openssl/asn1.h>
68 /* ASN1_STRING_print_ex() and X509_NAME_print_ex().
69 * Enhanced string and name printing routines handling
70 * multibyte characters, RFC2253 and a host of other
75 #define CHARTYPE_BS_ESC (ASN1_STRFLGS_ESC_2253 | CHARTYPE_FIRST_ESC_2253 | CHARTYPE_LAST_ESC_2253)
78 /* Three IO functions for sending data to memory, a BIO and
81 #if 0 /* never used */
82 static int send_mem_chars(void *arg
, const void *buf
, int len
)
84 unsigned char **out
= arg
;
86 memcpy(*out
, buf
, len
);
92 static int send_bio_chars(void *arg
, const void *buf
, int len
)
95 if(BIO_write(arg
, buf
, len
) != len
) return 0;
99 static int send_fp_chars(void *arg
, const void *buf
, int len
)
102 if(fwrite(buf
, 1, len
, arg
) != (unsigned int)len
) return 0;
106 typedef int char_io(void *arg
, const void *buf
, int len
);
108 /* This function handles display of
109 * strings, one character at a time.
110 * It is passed an unsigned long for each
111 * character because it could come from 2 or even
115 static int do_esc_char(unsigned long c
, unsigned char flags
, char *do_quotes
, char_io
*io_ch
, void *arg
)
117 unsigned char chflgs
, chtmp
;
118 char tmphex
[HEX_SIZE(long)+3];
123 BIO_snprintf(tmphex
, sizeof tmphex
, "\\W%08lX", c
);
124 if(!io_ch(arg
, tmphex
, 10)) return -1;
128 BIO_snprintf(tmphex
, sizeof tmphex
, "\\U%04lX", c
);
129 if(!io_ch(arg
, tmphex
, 6)) return -1;
132 chtmp
= (unsigned char)c
;
133 if(chtmp
> 0x7f) chflgs
= flags
& ASN1_STRFLGS_ESC_MSB
;
134 else chflgs
= char_type
[chtmp
] & flags
;
135 if(chflgs
& CHARTYPE_BS_ESC
) {
136 /* If we don't escape with quotes, signal we need quotes */
137 if(chflgs
& ASN1_STRFLGS_ESC_QUOTE
) {
138 if(do_quotes
) *do_quotes
= 1;
139 if(!io_ch(arg
, &chtmp
, 1)) return -1;
142 if(!io_ch(arg
, "\\", 1)) return -1;
143 if(!io_ch(arg
, &chtmp
, 1)) return -1;
146 if(chflgs
& (ASN1_STRFLGS_ESC_CTRL
|ASN1_STRFLGS_ESC_MSB
)) {
147 BIO_snprintf(tmphex
, 11, "\\%02X", chtmp
);
148 if(!io_ch(arg
, tmphex
, 3)) return -1;
151 if(!io_ch(arg
, &chtmp
, 1)) return -1;
155 #define BUF_TYPE_WIDTH_MASK 0x7
156 #define BUF_TYPE_CONVUTF8 0x8
158 /* This function sends each character in a buffer to
159 * do_esc_char(). It interprets the content formats
160 * and converts to or from UTF8 as appropriate.
163 static int do_buf(unsigned char *buf
, int buflen
,
164 int type
, unsigned char flags
, char *quotes
, char_io
*io_ch
, void *arg
)
167 unsigned char orflags
, *p
, *q
;
173 if(p
== buf
) orflags
= CHARTYPE_FIRST_ESC_2253
;
175 switch(type
& BUF_TYPE_WIDTH_MASK
) {
177 c
= ((unsigned long)*p
++) << 24;
178 c
|= ((unsigned long)*p
++) << 16;
179 c
|= ((unsigned long)*p
++) << 8;
184 c
= ((unsigned long)*p
++) << 8;
193 i
= UTF8_getc(p
, buflen
, &c
);
194 if(i
< 0) return -1; /* Invalid UTF8String */
198 if (p
== q
) orflags
= CHARTYPE_LAST_ESC_2253
;
199 if(type
& BUF_TYPE_CONVUTF8
) {
200 unsigned char utfbuf
[6];
202 utflen
= UTF8_putc(utfbuf
, sizeof utfbuf
, c
);
203 for(i
= 0; i
< utflen
; i
++) {
204 /* We don't need to worry about setting orflags correctly
205 * because if utflen==1 its value will be correct anyway
206 * otherwise each character will be > 0x7f and so the
207 * character will never be escaped on first and last.
209 len
= do_esc_char(utfbuf
[i
], (unsigned char)(flags
| orflags
), quotes
, io_ch
, arg
);
210 if(len
< 0) return -1;
214 len
= do_esc_char(c
, (unsigned char)(flags
| orflags
), quotes
, io_ch
, arg
);
215 if(len
< 0) return -1;
222 /* This function hex dumps a buffer of characters */
224 static int do_hex_dump(char_io
*io_ch
, void *arg
, unsigned char *buf
, int buflen
)
226 const static char hexdig
[] = "0123456789ABCDEF";
227 unsigned char *p
, *q
;
233 hextmp
[0] = hexdig
[*p
>> 4];
234 hextmp
[1] = hexdig
[*p
& 0xf];
235 if(!io_ch(arg
, hextmp
, 2)) return -1;
242 /* "dump" a string. This is done when the type is unknown,
243 * or the flags request it. We can either dump the content
244 * octets or the entire DER encoding. This uses the RFC2253
248 static int do_dump(unsigned long lflags
, char_io
*io_ch
, void *arg
, ASN1_STRING
*str
)
250 /* Placing the ASN1_STRING in a temp ASN1_TYPE allows
251 * the DER encoding to readily obtained
254 unsigned char *der_buf
, *p
;
257 if(!io_ch(arg
, "#", 1)) return -1;
258 /* If we don't dump DER encoding just dump content octets */
259 if(!(lflags
& ASN1_STRFLGS_DUMP_DER
)) {
260 outlen
= do_hex_dump(io_ch
, arg
, str
->data
, str
->length
);
261 if(outlen
< 0) return -1;
265 t
.value
.ptr
= (char *)str
;
266 der_len
= i2d_ASN1_TYPE(&t
, NULL
);
267 der_buf
= OPENSSL_malloc(der_len
);
268 if(!der_buf
) return -1;
270 i2d_ASN1_TYPE(&t
, &p
);
271 outlen
= do_hex_dump(io_ch
, arg
, der_buf
, der_len
);
272 OPENSSL_free(der_buf
);
273 if(outlen
< 0) return -1;
277 /* Lookup table to convert tags to character widths,
278 * 0 = UTF8 encoded, -1 is used for non string types
279 * otherwise it is the number of bytes per character
282 const static signed char tag2nbyte
[] = {
283 -1, -1, -1, -1, -1, /* 0-4 */
284 -1, -1, -1, -1, -1, /* 5-9 */
285 -1, -1, 0, -1, /* 10-13 */
286 -1, -1, -1, -1, /* 15-17 */
287 -1, 1, 1, /* 18-20 */
288 -1, 1, 1, 1, /* 21-24 */
289 -1, 1, -1, /* 25-27 */
293 #define ESC_FLAGS (ASN1_STRFLGS_ESC_2253 | \
294 ASN1_STRFLGS_ESC_QUOTE | \
295 ASN1_STRFLGS_ESC_CTRL | \
296 ASN1_STRFLGS_ESC_MSB)
298 /* This is the main function, print out an
299 * ASN1_STRING taking note of various escape
300 * and display options. Returns number of
301 * characters written or -1 if an error
305 static int do_print_ex(char_io
*io_ch
, void *arg
, unsigned long lflags
, ASN1_STRING
*str
)
312 /* Keep a copy of escape flags */
313 flags
= (unsigned char)(lflags
& ESC_FLAGS
);
320 if(lflags
& ASN1_STRFLGS_SHOW_TYPE
) {
322 tagname
= ASN1_tag2str(type
);
323 outlen
+= strlen(tagname
);
324 if(!io_ch(arg
, tagname
, outlen
) || !io_ch(arg
, ":", 1)) return -1;
328 /* Decide what to do with type, either dump content or display it */
330 /* Dump everything */
331 if(lflags
& ASN1_STRFLGS_DUMP_ALL
) type
= -1;
332 /* Ignore the string type */
333 else if(lflags
& ASN1_STRFLGS_IGNORE_TYPE
) type
= 1;
335 /* Else determine width based on type */
336 if((type
> 0) && (type
< 31)) type
= tag2nbyte
[type
];
338 if((type
== -1) && !(lflags
& ASN1_STRFLGS_DUMP_UNKNOWN
)) type
= 1;
342 len
= do_dump(lflags
, io_ch
, arg
, str
);
343 if(len
< 0) return -1;
348 if(lflags
& ASN1_STRFLGS_UTF8_CONVERT
) {
349 /* Note: if string is UTF8 and we want
350 * to convert to UTF8 then we just interpret
351 * it as 1 byte per character to avoid converting
355 else type
|= BUF_TYPE_CONVUTF8
;
358 len
= do_buf(str
->data
, str
->length
, type
, flags
, "es
, io_ch
, NULL
);
359 if(outlen
< 0) return -1;
361 if(quotes
) outlen
+= 2;
362 if(!arg
) return outlen
;
363 if(quotes
&& !io_ch(arg
, "\"", 1)) return -1;
364 do_buf(str
->data
, str
->length
, type
, flags
, NULL
, io_ch
, arg
);
365 if(quotes
&& !io_ch(arg
, "\"", 1)) return -1;
369 /* Used for line indenting: print 'indent' spaces */
371 static int do_indent(char_io
*io_ch
, void *arg
, int indent
)
374 for(i
= 0; i
< indent
; i
++)
375 if(!io_ch(arg
, " ", 1)) return 0;
379 #define FN_WIDTH_LN 25
380 #define FN_WIDTH_SN 10
382 static int do_name_ex(char_io
*io_ch
, void *arg
, X509_NAME
*n
,
383 int indent
, unsigned long flags
)
385 int i
, prev
= -1, orflags
, cnt
;
389 X509_NAME_ENTRY
*ent
;
393 char *sep_dn
, *sep_mv
, *sep_eq
;
394 int sep_dn_len
, sep_mv_len
, sep_eq_len
;
395 if(indent
< 0) indent
= 0;
397 if(!do_indent(io_ch
, arg
, indent
)) return -1;
398 switch (flags
& XN_FLAG_SEP_MASK
)
400 case XN_FLAG_SEP_MULTILINE
:
407 case XN_FLAG_SEP_COMMA_PLUS
:
415 case XN_FLAG_SEP_CPLUS_SPC
:
423 case XN_FLAG_SEP_SPLUS_SPC
:
435 if(flags
& XN_FLAG_SPC_EQ
) {
443 fn_opt
= flags
& XN_FLAG_FN_MASK
;
445 cnt
= X509_NAME_entry_count(n
);
446 for(i
= 0; i
< cnt
; i
++) {
447 if(flags
& XN_FLAG_DN_REV
)
448 ent
= X509_NAME_get_entry(n
, cnt
- i
- 1);
449 else ent
= X509_NAME_get_entry(n
, i
);
451 if(prev
== ent
->set
) {
452 if(!io_ch(arg
, sep_mv
, sep_mv_len
)) return -1;
453 outlen
+= sep_mv_len
;
455 if(!io_ch(arg
, sep_dn
, sep_dn_len
)) return -1;
456 outlen
+= sep_dn_len
;
457 if(!do_indent(io_ch
, arg
, indent
)) return -1;
462 fn
= X509_NAME_ENTRY_get_object(ent
);
463 val
= X509_NAME_ENTRY_get_data(ent
);
464 fn_nid
= OBJ_obj2nid(fn
);
465 if(fn_opt
!= XN_FLAG_FN_NONE
) {
467 if((fn_opt
== XN_FLAG_FN_OID
) || (fn_nid
==NID_undef
) ) {
468 OBJ_obj2txt(objtmp
, sizeof objtmp
, fn
, 1);
469 fld_len
= 0; /* XXX: what should this be? */
472 if(fn_opt
== XN_FLAG_FN_SN
) {
473 fld_len
= FN_WIDTH_SN
;
474 objbuf
= OBJ_nid2sn(fn_nid
);
475 } else if(fn_opt
== XN_FLAG_FN_LN
) {
476 fld_len
= FN_WIDTH_LN
;
477 objbuf
= OBJ_nid2ln(fn_nid
);
479 fld_len
= 0; /* XXX: what should this be? */
483 objlen
= strlen(objbuf
);
484 if(!io_ch(arg
, objbuf
, objlen
)) return -1;
485 if ((objlen
< fld_len
) && (flags
& XN_FLAG_FN_ALIGN
)) {
486 if (!do_indent(io_ch
, arg
, fld_len
- objlen
)) return -1;
487 outlen
+= fld_len
- objlen
;
489 if(!io_ch(arg
, sep_eq
, sep_eq_len
)) return -1;
490 outlen
+= objlen
+ sep_eq_len
;
492 /* If the field name is unknown then fix up the DER dump
493 * flag. We might want to limit this further so it will
494 * DER dump on anything other than a few 'standard' fields.
496 if((fn_nid
== NID_undef
) && (flags
& XN_FLAG_DUMP_UNKNOWN_FIELDS
))
497 orflags
= ASN1_STRFLGS_DUMP_ALL
;
500 len
= do_print_ex(io_ch
, arg
, flags
| orflags
, val
);
501 if(len
< 0) return -1;
507 /* Wrappers round the main functions */
509 int X509_NAME_print_ex(BIO
*out
, X509_NAME
*nm
, int indent
, unsigned long flags
)
511 if(flags
== XN_FLAG_COMPAT
)
512 return X509_NAME_print(out
, nm
, indent
);
513 return do_name_ex(send_bio_chars
, out
, nm
, indent
, flags
);
516 #ifndef OPENSSL_NO_FP_API
517 int X509_NAME_print_ex_fp(FILE *fp
, X509_NAME
*nm
, int indent
, unsigned long flags
)
519 if(flags
== XN_FLAG_COMPAT
)
523 btmp
= BIO_new_fp(fp
, BIO_NOCLOSE
);
525 ret
= X509_NAME_print(btmp
, nm
, indent
);
529 return do_name_ex(send_fp_chars
, fp
, nm
, indent
, flags
);
533 int ASN1_STRING_print_ex(BIO
*out
, ASN1_STRING
*str
, unsigned long flags
)
535 return do_print_ex(send_bio_chars
, out
, flags
, str
);
538 #ifndef OPENSSL_NO_FP_API
539 int ASN1_STRING_print_ex_fp(FILE *fp
, ASN1_STRING
*str
, unsigned long flags
)
541 return do_print_ex(send_fp_chars
, fp
, flags
, str
);
545 /* Utility function: convert any string type to UTF8, returns number of bytes
546 * in output string or a negative error code
549 int ASN1_STRING_to_UTF8(unsigned char **out
, ASN1_STRING
*in
)
551 ASN1_STRING stmp
, *str
= &stmp
;
552 int mbflag
, type
, ret
;
555 if((type
< 0) || (type
> 30)) return -1;
556 mbflag
= tag2nbyte
[type
];
557 if(mbflag
== -1) return -1;
558 mbflag
|= MBSTRING_FLAG
;
560 ret
= ASN1_mbstring_copy(&str
, in
->data
, in
->length
, mbflag
, B_ASN1_UTF8STRING
);
561 if(ret
< 0) return ret
;