933dda99b7bd11f9b43c14c2bd12471d63329d24
[openssl.git] / crypto / asn1 / a_strex.c
1 /*
2  * Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
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
8  */
9
10 #include <stdio.h>
11 #include <string.h>
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>
17
18 #include "charmap.h"
19
20 /*
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
23  * other options.
24  */
25
26 #define CHARTYPE_BS_ESC         (ASN1_STRFLGS_ESC_2253 | CHARTYPE_FIRST_ESC_2253 | CHARTYPE_LAST_ESC_2253)
27
28 #define ESC_FLAGS (ASN1_STRFLGS_ESC_2253 | \
29                   ASN1_STRFLGS_ESC_2254 | \
30                   ASN1_STRFLGS_ESC_QUOTE | \
31                   ASN1_STRFLGS_ESC_CTRL | \
32                   ASN1_STRFLGS_ESC_MSB)
33
34 /*
35  * Three IO functions for sending data to memory, a BIO and and a FILE
36  * pointer.
37  */
38 static int send_bio_chars(void *arg, const void *buf, int len)
39 {
40     if (!arg)
41         return 1;
42     if (BIO_write(arg, buf, len) != len)
43         return 0;
44     return 1;
45 }
46
47 #ifndef OPENSSL_NO_STDIO
48 static int send_fp_chars(void *arg, const void *buf, int len)
49 {
50     if (!arg)
51         return 1;
52     if (fwrite(buf, 1, len, arg) != (unsigned int)len)
53         return 0;
54     return 1;
55 }
56 #endif
57
58 typedef int char_io (void *arg, const void *buf, int len);
59
60 /*
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
63  * even 4 byte forms.
64  */
65
66 static int do_esc_char(unsigned long c, unsigned short flags, char *do_quotes,
67                        char_io *io_ch, void *arg)
68 {
69     unsigned short chflgs;
70     unsigned char chtmp;
71     char tmphex[HEX_SIZE(long) + 3];
72
73     if (c > 0xffffffffL)
74         return -1;
75     if (c > 0xffff) {
76         BIO_snprintf(tmphex, sizeof tmphex, "\\W%08lX", c);
77         if (!io_ch(arg, tmphex, 10))
78             return -1;
79         return 10;
80     }
81     if (c > 0xff) {
82         BIO_snprintf(tmphex, sizeof tmphex, "\\U%04lX", c);
83         if (!io_ch(arg, tmphex, 6))
84             return -1;
85         return 6;
86     }
87     chtmp = (unsigned char)c;
88     if (chtmp > 0x7f)
89         chflgs = flags & ASN1_STRFLGS_ESC_MSB;
90     else
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) {
95             if (do_quotes)
96                 *do_quotes = 1;
97             if (!io_ch(arg, &chtmp, 1))
98                 return -1;
99             return 1;
100         }
101         if (!io_ch(arg, "\\", 1))
102             return -1;
103         if (!io_ch(arg, &chtmp, 1))
104             return -1;
105         return 2;
106     }
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))
112             return -1;
113         return 3;
114     }
115     /*
116      * If we get this far and do any escaping at all must escape the escape
117      * character itself: backslash.
118      */
119     if (chtmp == '\\' && (flags & ESC_FLAGS)) {
120         if (!io_ch(arg, "\\\\", 2))
121             return -1;
122         return 2;
123     }
124     if (!io_ch(arg, &chtmp, 1))
125         return -1;
126     return 1;
127 }
128
129 #define BUF_TYPE_WIDTH_MASK     0x7
130 #define BUF_TYPE_CONVUTF8       0x8
131
132 /*
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
135  * appropriate.
136  */
137
138 static int do_buf(unsigned char *buf, int buflen,
139                   int type, unsigned short flags, char *quotes, char_io *io_ch,
140                   void *arg)
141 {
142     int i, outlen, len;
143     unsigned short orflags;
144     unsigned char *p, *q;
145     unsigned long c;
146
147     p = buf;
148     q = buf + buflen;
149     outlen = 0;
150     while (p != q) {
151         if (p == buf && flags & ASN1_STRFLGS_ESC_2253)
152             orflags = CHARTYPE_FIRST_ESC_2253;
153         else
154             orflags = 0;
155         switch (type & BUF_TYPE_WIDTH_MASK) {
156         case 4:
157             c = ((unsigned long)*p++) << 24;
158             c |= ((unsigned long)*p++) << 16;
159             c |= ((unsigned long)*p++) << 8;
160             c |= *p++;
161             break;
162
163         case 2:
164             c = ((unsigned long)*p++) << 8;
165             c |= *p++;
166             break;
167
168         case 1:
169             c = *p++;
170             break;
171
172         case 0:
173             i = UTF8_getc(p, buflen, &c);
174             if (i < 0)
175                 return -1;      /* Invalid UTF8String */
176             p += i;
177             break;
178         default:
179             return -1;          /* invalid width */
180         }
181         if (p == q && flags & ASN1_STRFLGS_ESC_2253)
182             orflags = CHARTYPE_LAST_ESC_2253;
183         if (type & BUF_TYPE_CONVUTF8) {
184             unsigned char utfbuf[6];
185             int utflen;
186             utflen = UTF8_putc(utfbuf, sizeof utfbuf, c);
187             for (i = 0; i < utflen; i++) {
188                 /*
189                  * We don't need to worry about setting orflags correctly
190                  * because if utflen==1 its value will be correct anyway
191                  * otherwise each character will be > 0x7f and so the
192                  * character will never be escaped on first and last.
193                  */
194                 len = do_esc_char(utfbuf[i], flags | orflags, quotes,
195                                   io_ch, arg);
196                 if (len < 0)
197                     return -1;
198                 outlen += len;
199             }
200         } else {
201             len = do_esc_char(c, flags | orflags, quotes,
202                               io_ch, arg);
203             if (len < 0)
204                 return -1;
205             outlen += len;
206         }
207     }
208     return outlen;
209 }
210
211 /* This function hex dumps a buffer of characters */
212
213 static int do_hex_dump(char_io *io_ch, void *arg, unsigned char *buf,
214                        int buflen)
215 {
216     static const char hexdig[] = "0123456789ABCDEF";
217     unsigned char *p, *q;
218     char hextmp[2];
219     if (arg) {
220         p = buf;
221         q = buf + buflen;
222         while (p != q) {
223             hextmp[0] = hexdig[*p >> 4];
224             hextmp[1] = hexdig[*p & 0xf];
225             if (!io_ch(arg, hextmp, 2))
226                 return -1;
227             p++;
228         }
229     }
230     return buflen << 1;
231 }
232
233 /*
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.
237  */
238
239 static int do_dump(unsigned long lflags, char_io *io_ch, void *arg,
240                    const ASN1_STRING *str)
241 {
242     /*
243      * Placing the ASN1_STRING in a temp ASN1_TYPE allows the DER encoding to
244      * readily obtained
245      */
246     ASN1_TYPE t;
247     unsigned char *der_buf, *p;
248     int outlen, der_len;
249
250     if (!io_ch(arg, "#", 1))
251         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)
256             return -1;
257         return outlen + 1;
258     }
259     t.type = str->type;
260     t.value.ptr = (char *)str;
261     der_len = i2d_ASN1_TYPE(&t, NULL);
262     der_buf = OPENSSL_malloc(der_len);
263     if (der_buf == NULL)
264         return -1;
265     p = der_buf;
266     i2d_ASN1_TYPE(&t, &p);
267     outlen = do_hex_dump(io_ch, arg, der_buf, der_len);
268     OPENSSL_free(der_buf);
269     if (outlen < 0)
270         return -1;
271     return outlen + 1;
272 }
273
274 /*
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
277  * character
278  */
279
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 */
285     1, 1, 1,                    /* 18-20 */
286     -1, 1, 1, 1,                /* 21-24 */
287     -1, 1, -1,                  /* 25-27 */
288     4, -1, 2                    /* 28-30 */
289 };
290
291 /*
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
294  * an error occurred.
295  */
296
297 static int do_print_ex(char_io *io_ch, void *arg, unsigned long lflags,
298                        const ASN1_STRING *str)
299 {
300     int outlen, len;
301     int type;
302     char quotes;
303     unsigned short flags;
304     quotes = 0;
305     /* Keep a copy of escape flags */
306     flags = (unsigned short)(lflags & ESC_FLAGS);
307
308     type = str->type;
309
310     outlen = 0;
311
312     if (lflags & ASN1_STRFLGS_SHOW_TYPE) {
313         const char *tagname;
314         tagname = ASN1_tag2str(type);
315         outlen += strlen(tagname);
316         if (!io_ch(arg, tagname, outlen) || !io_ch(arg, ":", 1))
317             return -1;
318         outlen++;
319     }
320
321     /* Decide what to do with type, either dump content or display it */
322
323     /* Dump everything */
324     if (lflags & ASN1_STRFLGS_DUMP_ALL)
325         type = -1;
326     /* Ignore the string type */
327     else if (lflags & ASN1_STRFLGS_IGNORE_TYPE)
328         type = 1;
329     else {
330         /* Else determine width based on type */
331         if ((type > 0) && (type < 31))
332             type = tag2nbyte[type];
333         else
334             type = -1;
335         if ((type == -1) && !(lflags & ASN1_STRFLGS_DUMP_UNKNOWN))
336             type = 1;
337     }
338
339     if (type == -1) {
340         len = do_dump(lflags, io_ch, arg, str);
341         if (len < 0)
342             return -1;
343         outlen += len;
344         return outlen;
345     }
346
347     if (lflags & ASN1_STRFLGS_UTF8_CONVERT) {
348         /*
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
351          * twice.
352          */
353         if (!type)
354             type = 1;
355         else
356             type |= BUF_TYPE_CONVUTF8;
357     }
358
359     len = do_buf(str->data, str->length, type, flags, &quotes, io_ch, NULL);
360     if (len < 0)
361         return -1;
362     outlen += len;
363     if (quotes)
364         outlen += 2;
365     if (!arg)
366         return outlen;
367     if (quotes && !io_ch(arg, "\"", 1))
368         return -1;
369     if (do_buf(str->data, str->length, type, flags, NULL, io_ch, arg) < 0)
370         return -1;
371     if (quotes && !io_ch(arg, "\"", 1))
372         return -1;
373     return outlen;
374 }
375
376 /* Used for line indenting: print 'indent' spaces */
377
378 static int do_indent(char_io *io_ch, void *arg, int indent)
379 {
380     int i;
381     for (i = 0; i < indent; i++)
382         if (!io_ch(arg, " ", 1))
383             return 0;
384     return 1;
385 }
386
387 #define FN_WIDTH_LN     25
388 #define FN_WIDTH_SN     10
389
390 static int do_name_ex(char_io *io_ch, void *arg, const X509_NAME *n,
391                       int indent, unsigned long flags)
392 {
393     int i, prev = -1, orflags, cnt;
394     int fn_opt, fn_nid;
395     ASN1_OBJECT *fn;
396     const ASN1_STRING *val;
397     const X509_NAME_ENTRY *ent;
398     char objtmp[80];
399     const char *objbuf;
400     int outlen, len;
401     char *sep_dn, *sep_mv, *sep_eq;
402     int sep_dn_len, sep_mv_len, sep_eq_len;
403     if (indent < 0)
404         indent = 0;
405     outlen = indent;
406     if (!do_indent(io_ch, arg, indent))
407         return -1;
408     switch (flags & XN_FLAG_SEP_MASK) {
409     case XN_FLAG_SEP_MULTILINE:
410         sep_dn = "\n";
411         sep_dn_len = 1;
412         sep_mv = " + ";
413         sep_mv_len = 3;
414         break;
415
416     case XN_FLAG_SEP_COMMA_PLUS:
417         sep_dn = ",";
418         sep_dn_len = 1;
419         sep_mv = "+";
420         sep_mv_len = 1;
421         indent = 0;
422         break;
423
424     case XN_FLAG_SEP_CPLUS_SPC:
425         sep_dn = ", ";
426         sep_dn_len = 2;
427         sep_mv = " + ";
428         sep_mv_len = 3;
429         indent = 0;
430         break;
431
432     case XN_FLAG_SEP_SPLUS_SPC:
433         sep_dn = "; ";
434         sep_dn_len = 2;
435         sep_mv = " + ";
436         sep_mv_len = 3;
437         indent = 0;
438         break;
439
440     default:
441         return -1;
442     }
443
444     if (flags & XN_FLAG_SPC_EQ) {
445         sep_eq = " = ";
446         sep_eq_len = 3;
447     } else {
448         sep_eq = "=";
449         sep_eq_len = 1;
450     }
451
452     fn_opt = flags & XN_FLAG_FN_MASK;
453
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);
458         else
459             ent = X509_NAME_get_entry(n, i);
460         if (prev != -1) {
461             if (prev == X509_NAME_ENTRY_set(ent)) {
462                 if (!io_ch(arg, sep_mv, sep_mv_len))
463                     return -1;
464                 outlen += sep_mv_len;
465             } else {
466                 if (!io_ch(arg, sep_dn, sep_dn_len))
467                     return -1;
468                 outlen += sep_dn_len;
469                 if (!do_indent(io_ch, arg, indent))
470                     return -1;
471                 outlen += indent;
472             }
473         }
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) {
479             int objlen, fld_len;
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? */
483                 objbuf = objtmp;
484             } else {
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);
491                 } else {
492                     fld_len = 0; /* XXX: what should this be? */
493                     objbuf = "";
494                 }
495             }
496             objlen = strlen(objbuf);
497             if (!io_ch(arg, objbuf, objlen))
498                 return -1;
499             if ((objlen < fld_len) && (flags & XN_FLAG_FN_ALIGN)) {
500                 if (!do_indent(io_ch, arg, fld_len - objlen))
501                     return -1;
502                 outlen += fld_len - objlen;
503             }
504             if (!io_ch(arg, sep_eq, sep_eq_len))
505                 return -1;
506             outlen += objlen + sep_eq_len;
507         }
508         /*
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.
512          */
513         if ((fn_nid == NID_undef) && (flags & XN_FLAG_DUMP_UNKNOWN_FIELDS))
514             orflags = ASN1_STRFLGS_DUMP_ALL;
515         else
516             orflags = 0;
517
518         len = do_print_ex(io_ch, arg, flags | orflags, val);
519         if (len < 0)
520             return -1;
521         outlen += len;
522     }
523     return outlen;
524 }
525
526 /* Wrappers round the main functions */
527
528 int X509_NAME_print_ex(BIO *out, const X509_NAME *nm, int indent,
529                        unsigned long flags)
530 {
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);
534 }
535
536 #ifndef OPENSSL_NO_STDIO
537 int X509_NAME_print_ex_fp(FILE *fp, const X509_NAME *nm, int indent,
538                           unsigned long flags)
539 {
540     if (flags == XN_FLAG_COMPAT) {
541         BIO *btmp;
542         int ret;
543         btmp = BIO_new_fp(fp, BIO_NOCLOSE);
544         if (!btmp)
545             return -1;
546         ret = X509_NAME_print(btmp, nm, indent);
547         BIO_free(btmp);
548         return ret;
549     }
550     return do_name_ex(send_fp_chars, fp, nm, indent, flags);
551 }
552 #endif
553
554 int ASN1_STRING_print_ex(BIO *out, const ASN1_STRING *str, unsigned long flags)
555 {
556     return do_print_ex(send_bio_chars, out, flags, str);
557 }
558
559 #ifndef OPENSSL_NO_STDIO
560 int ASN1_STRING_print_ex_fp(FILE *fp, const ASN1_STRING *str, unsigned long flags)
561 {
562     return do_print_ex(send_fp_chars, fp, flags, str);
563 }
564 #endif
565
566 /*
567  * Utility function: convert any string type to UTF8, returns number of bytes
568  * in output string or a negative error code
569  */
570
571 int ASN1_STRING_to_UTF8(unsigned char **out, const ASN1_STRING *in)
572 {
573     ASN1_STRING stmp, *str = &stmp;
574     int mbflag, type, ret;
575     if (!in)
576         return -1;
577     type = in->type;
578     if ((type < 0) || (type > 30))
579         return -1;
580     mbflag = tag2nbyte[type];
581     if (mbflag == -1)
582         return -1;
583     mbflag |= MBSTRING_FLAG;
584     stmp.data = NULL;
585     stmp.length = 0;
586     stmp.flags = 0;
587     ret =
588         ASN1_mbstring_copy(&str, in->data, in->length, mbflag,
589                            B_ASN1_UTF8STRING);
590     if (ret < 0)
591         return ret;
592     *out = stmp.data;
593     return stmp.length;
594 }
595
596 /* Return 1 if host is a valid hostname and 0 otherwise */
597 int asn1_valid_host(const ASN1_STRING *host)
598 {
599     int hostlen = host->length;
600     const unsigned char *hostptr = host->data;
601     int type = host->type;
602     int i;
603     signed char width = -1;
604     unsigned short chflags = 0, prevchflags;
605
606     if (type > 0 && type < 31)
607         width = tag2nbyte[type];
608     if (width == -1 || hostlen == 0)
609         return 0;
610     /* Treat UTF8String as width 1 as any MSB set is invalid */
611     if (width == 0)
612         width = 1;
613     for (i = 0 ; i < hostlen; i+= width) {
614         prevchflags = chflags;
615         /* Value must be <= 0x7F: check upper bytes are all zeroes */
616         if (width == 4) {
617             if (*hostptr++ != 0 || *hostptr++ != 0 || *hostptr++ != 0)
618                 return 0;
619         } else if (width == 2) {
620             if (*hostptr++ != 0)
621                 return 0;
622         }
623         if (*hostptr > 0x7f)
624             return 0;
625         chflags = char_type[*hostptr++];
626         if (!(chflags & (CHARTYPE_HOST_ANY | CHARTYPE_HOST_WILD))) {
627             /* Nothing else allowed at start or end of string */
628             if (i == 0 || i == hostlen - 1)
629                 return 0;
630             /* Otherwise invalid if not dot or hyphen */
631             if (!(chflags & (CHARTYPE_HOST_DOT | CHARTYPE_HOST_HYPHEN)))
632                 return 0;
633             /*
634              * If previous is dot or hyphen then illegal unless both
635              * are hyphens: as .- -. .. are all illegal
636              */
637             if (prevchflags & (CHARTYPE_HOST_DOT | CHARTYPE_HOST_HYPHEN)
638                 && ((prevchflags & CHARTYPE_HOST_DOT)
639                     || (chflags & CHARTYPE_HOST_DOT)))
640                 return 0;
641         }
642     }
643     return 1;
644 }