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).
60 #include <openssl/crypto.h>
61 #include <openssl/x509.h>
62 #include <openssl/asn1.h>
66 /* ASN1_STRING_print_ex() and X509_NAME_print_ex().
67 * Enhanced string and name printing routines handling
68 * multibyte characters, RFC2253 and a host of other
73 #define CHARTYPE_BS_ESC (ASN1_STRFLGS_ESC_2253 | CHARTYPE_FIRST_ESC_2253 | CHARTYPE_LAST_ESC_2253)
76 /* Three IO functions for sending data to memory, a BIO and
80 int send_mem_chars(void *arg, const void *buf, int len)
82 unsigned char **out = arg;
84 memcpy(*out, buf, len);
89 int send_bio_chars(void *arg, const void *buf, int len)
92 if(BIO_write(arg, buf, len) != len) return 0;
96 int send_fp_chars(void *arg, const void *buf, int len)
99 if(fwrite(buf, 1, len, arg) != (unsigned int)len) return 0;
103 typedef int char_io(void *arg, const void *buf, int len);
105 /* This function handles display of
106 * strings, one character at a time.
107 * It is passed an unsigned long for each
108 * character because it could come from 2 or even
112 static int do_esc_char(unsigned long c, unsigned char flags, char *do_quotes, char_io *io_ch, void *arg)
114 unsigned char chflgs, chtmp;
117 BIO_snprintf(tmphex, 11, "\\W%08lX", c);
118 if(!io_ch(arg, tmphex, 10)) return -1;
122 BIO_snprintf(tmphex, 11, "\\U%04lX", c);
123 if(!io_ch(arg, tmphex, 6)) return -1;
126 chtmp = (unsigned char)c;
127 if(chtmp > 0x7f) chflgs = flags & ASN1_STRFLGS_ESC_MSB;
128 else chflgs = char_type[chtmp] & flags;
129 if(chflgs & CHARTYPE_BS_ESC) {
130 /* If we don't escape with quotes, signal we need quotes */
131 if(chflgs & ASN1_STRFLGS_ESC_QUOTE) {
132 if(do_quotes) *do_quotes = 1;
133 if(!io_ch(arg, &chtmp, 1)) return -1;
136 if(!io_ch(arg, "\\", 1)) return -1;
137 if(!io_ch(arg, &chtmp, 1)) return -1;
140 if(chflgs & (ASN1_STRFLGS_ESC_CTRL|ASN1_STRFLGS_ESC_MSB)) {
141 BIO_snprintf(tmphex, 11, "\\%02X", chtmp);
142 if(!io_ch(arg, tmphex, 3)) return -1;
145 if(!io_ch(arg, &chtmp, 1)) return -1;
149 #define BUF_TYPE_WIDTH_MASK 0x7
150 #define BUF_TYPE_CONVUTF8 0x8
152 /* This function sends each character in a buffer to
153 * do_esc_char(). It interprets the content formats
154 * and converts to or from UTF8 as appropriate.
157 static int do_buf(unsigned char *buf, int buflen,
158 int type, unsigned char flags, char *quotes, char_io *io_ch, void *arg)
161 unsigned char orflags, *p, *q;
167 if(p == buf) orflags = CHARTYPE_FIRST_ESC_2253;
169 switch(type & BUF_TYPE_WIDTH_MASK) {
171 c = ((unsigned long)*p++) << 24;
172 c |= ((unsigned long)*p++) << 16;
173 c |= ((unsigned long)*p++) << 8;
178 c = ((unsigned long)*p++) << 8;
187 i = UTF8_getc(p, buflen, &c);
188 if(i < 0) return -1; /* Invalid UTF8String */
192 if (p == q) orflags = CHARTYPE_LAST_ESC_2253;
193 if(type & BUF_TYPE_CONVUTF8) {
194 unsigned char utfbuf[6];
196 utflen = UTF8_putc(utfbuf, 6, c);
197 for(i = 0; i < utflen; i++) {
198 /* We don't need to worry about setting orflags correctly
199 * because if utflen==1 its value will be correct anyway
200 * otherwise each character will be > 0x7f and so the
201 * character will never be escaped on first and last.
203 len = do_esc_char(utfbuf[i], (unsigned char)(flags | orflags), quotes, io_ch, arg);
204 if(len < 0) return -1;
208 len = do_esc_char(c, (unsigned char)(flags | orflags), quotes, io_ch, arg);
209 if(len < 0) return -1;
216 /* This function hex dumps a buffer of characters */
218 static int do_hex_dump(char_io *io_ch, void *arg, unsigned char *buf, int buflen)
220 const static char hexdig[] = "0123456789ABCDEF";
221 unsigned char *p, *q;
227 hextmp[0] = hexdig[*p >> 4];
228 hextmp[1] = hexdig[*p & 0xf];
229 if(!io_ch(arg, hextmp, 2)) return -1;
236 /* "dump" a string. This is done when the type is unknown,
237 * or the flags request it. We can either dump the content
238 * octets or the entire DER encoding. This uses the RFC2253
242 int do_dump(unsigned long lflags, char_io *io_ch, void *arg, ASN1_STRING *str)
244 /* Placing the ASN1_STRING in a temp ASN1_TYPE allows
245 * the DER encoding to readily obtained
248 unsigned char *der_buf, *p;
251 if(!io_ch(arg, "#", 1)) return -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);
255 if(outlen < 0) return -1;
259 t.value.ptr = (char *)str;
260 der_len = i2d_ASN1_TYPE(&t, NULL);
261 der_buf = OPENSSL_malloc(der_len);
262 if(!der_buf) return -1;
264 i2d_ASN1_TYPE(&t, &p);
265 outlen = do_hex_dump(io_ch, arg, der_buf, der_len);
266 OPENSSL_free(der_buf);
267 if(outlen < 0) return -1;
271 /* Lookup table to convert tags to character widths,
272 * 0 = UTF8 encoded, -1 is used for non string types
273 * otherwise it is the number of bytes per character
276 const static char tag2nbyte[] = {
277 -1, -1, -1, -1, -1, /* 0-4 */
278 -1, -1, -1, -1, -1, /* 5-9 */
279 -1, -1, 0, -1, /* 10-13 */
280 -1, -1, -1, -1, /* 15-17 */
281 -1, 1, 1, /* 18-20 */
282 -1, 1, -1,-1, /* 21-24 */
283 -1, 1, -1, /* 25-27 */
287 #define ESC_FLAGS (ASN1_STRFLGS_ESC_2253 | \
288 ASN1_STRFLGS_ESC_QUOTE | \
289 ASN1_STRFLGS_ESC_CTRL | \
290 ASN1_STRFLGS_ESC_MSB)
292 /* This is the main function, print out an
293 * ASN1_STRING taking note of various escape
294 * and display options. Returns number of
295 * characters written or -1 if an error
299 static int do_print_ex(char_io *io_ch, void *arg, unsigned long lflags, ASN1_STRING *str)
306 /* Keep a copy of escape flags */
307 flags = (unsigned char)(lflags & ESC_FLAGS);
314 if(lflags & ASN1_STRFLGS_SHOW_TYPE) {
316 tagname = ASN1_tag2str(type);
317 outlen += strlen(tagname);
318 if(!io_ch(arg, tagname, outlen) || !io_ch(arg, ":", 1)) return -1;
322 /* Decide what to do with type, either dump content or display it */
324 /* Dump everything */
325 if(lflags & ASN1_STRFLGS_DUMP_ALL) type = -1;
326 /* Ignore the string type */
327 else if(lflags & ASN1_STRFLGS_IGNORE_TYPE) type = 1;
329 /* Else determine width based on type */
330 if((type > 0) && (type < 31)) type = tag2nbyte[type];
332 if((type == -1) && !(lflags & ASN1_STRFLGS_DUMP_UNKNOWN)) type = 1;
336 len = do_dump(lflags, io_ch, arg, str);
337 if(len < 0) return -1;
342 if(lflags & ASN1_STRFLGS_UTF8_CONVERT) {
343 /* Note: if string is UTF8 and we want
344 * to convert to UTF8 then we just interpret
345 * it as 1 byte per character to avoid converting
349 else type |= BUF_TYPE_CONVUTF8;
352 len = do_buf(str->data, str->length, type, flags, "es, io_ch, NULL);
353 if(outlen < 0) return -1;
355 if(quotes) outlen += 2;
356 if(!arg) return outlen;
357 if(quotes && !io_ch(arg, "\"", 1)) return -1;
358 do_buf(str->data, str->length, type, flags, NULL, io_ch, arg);
359 if(quotes && !io_ch(arg, "\"", 1)) return -1;
363 /* Used for line indenting: print 'indent' spaces */
365 static int do_indent(char_io *io_ch, void *arg, int indent)
368 for(i = 0; i < indent; i++)
369 if(!io_ch(arg, " ", 1)) return 0;
374 static int do_name_ex(char_io *io_ch, void *arg, X509_NAME *n,
375 int indent, unsigned long flags)
377 int i, prev = -1, orflags, cnt;
381 X509_NAME_ENTRY *ent;
385 char *sep_dn, *sep_mv, *sep_eq;
386 int sep_dn_len, sep_mv_len, sep_eq_len;
387 if(indent < 0) indent = 0;
389 if(!do_indent(io_ch, arg, indent)) return -1;
390 switch (flags & XN_FLAG_SEP_MASK)
392 case XN_FLAG_SEP_MULTILINE:
399 case XN_FLAG_SEP_COMMA_PLUS:
407 case XN_FLAG_SEP_CPLUS_SPC:
415 case XN_FLAG_SEP_SPLUS_SPC:
427 if(flags & XN_FLAG_SPC_EQ) {
435 fn_opt = flags & XN_FLAG_FN_MASK;
437 cnt = X509_NAME_entry_count(n);
438 for(i = 0; i < cnt; i++) {
439 if(flags & XN_FLAG_DN_REV)
440 ent = X509_NAME_get_entry(n, cnt - i - 1);
441 else ent = X509_NAME_get_entry(n, i);
443 if(prev == ent->set) {
444 if(!io_ch(arg, sep_mv, sep_mv_len)) return -1;
445 outlen += sep_mv_len;
447 if(!io_ch(arg, sep_dn, sep_dn_len)) return -1;
448 outlen += sep_dn_len;
449 if(!do_indent(io_ch, arg, indent)) return -1;
454 fn = X509_NAME_ENTRY_get_object(ent);
455 val = X509_NAME_ENTRY_get_data(ent);
456 fn_nid = OBJ_obj2nid(fn);
457 if(fn_opt != XN_FLAG_FN_NONE) {
459 if((fn_opt == XN_FLAG_FN_OID) || (fn_nid==NID_undef) ) {
460 OBJ_obj2txt(objtmp, 80, fn, 1);
463 if(fn_opt == XN_FLAG_FN_SN)
464 objbuf = OBJ_nid2sn(fn_nid);
465 else if(fn_opt == XN_FLAG_FN_LN)
466 objbuf = OBJ_nid2ln(fn_nid);
469 objlen = strlen(objbuf);
470 if(!io_ch(arg, objbuf, objlen)) return -1;
471 if(!io_ch(arg, sep_eq, sep_eq_len)) return -1;
472 outlen += objlen + sep_eq_len;
474 /* If the field name is unknown then fix up the DER dump
475 * flag. We might want to limit this further so it will
476 * DER dump on anything other than a few 'standard' fields.
478 if((fn_nid == NID_undef) && (flags & XN_FLAG_DUMP_UNKNOWN_FIELDS))
479 orflags = ASN1_STRFLGS_DUMP_ALL;
482 len = do_print_ex(io_ch, arg, flags | orflags, val);
483 if(len < 0) return -1;
489 /* Wrappers round the main functions */
491 int X509_NAME_print_ex(BIO *out, X509_NAME *nm, int indent, unsigned long flags)
493 return do_name_ex(send_bio_chars, out, nm, indent, flags);
497 int X509_NAME_print_ex_fp(FILE *fp, X509_NAME *nm, int indent, unsigned long flags)
499 return do_name_ex(send_fp_chars, fp, nm, indent, flags);
502 int ASN1_STRING_print_ex(BIO *out, ASN1_STRING *str, unsigned long flags)
504 return do_print_ex(send_bio_chars, out, flags, str);
508 int ASN1_STRING_print_ex_fp(FILE *fp, ASN1_STRING *str, unsigned long flags)
510 return do_print_ex(send_fp_chars, fp, flags, str);
513 /* Utility function: convert any string type to UTF8, returns number of bytes
514 * in output string or a negative error code
517 int ASN1_STRING_to_UTF8(unsigned char **out, ASN1_STRING *in)
519 ASN1_STRING stmp, *str = &stmp;
520 int mbflag, type, ret;
521 if(!*out || !in) return -1;
523 if((type < 0) || (type > 30)) return -1;
524 mbflag = tag2nbyte[type];
525 if(mbflag == -1) return -1;
526 mbflag |= MBSTRING_FLAG;
528 ret = ASN1_mbstring_copy(&str, in->data, in->length, mbflag, B_ASN1_UTF8STRING);
529 if(ret < 0) return ret;
530 if(out) *out = stmp.data;