crypto/asn1/tasn_prn.c

   1 /* tasn_prn.c */
   2 /*
   3  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
   4  * 2000.
   5  */
   6 /* ====================================================================
   7  * Copyright (c) 2000,2005 The OpenSSL Project.  All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  *
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  *
  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
  19  *    distribution.
  20  *
  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/)"
  25  *
  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.
  30  *
  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.
  34  *
  35  * 6. Redistributions of any form whatsoever must retain the following
  36  *    acknowledgment:
  37  *    "This product includes software developed by the OpenSSL Project
  38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  39  *
  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  * ====================================================================
  53  *
  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).
  57  *
  58  */
  59
  60 #include <stddef.h>
  61 #include "cryptlib.h"
  62 #include <openssl/asn1.h>
  63 #include <openssl/asn1t.h>
  64 #include <openssl/objects.h>
  65 #include <openssl/buffer.h>
  66 #include <openssl/err.h>
  67 #include <openssl/x509v3.h>
  68 #include "asn1_locl.h"
  69
  70 /*
  71  * Print routines.
  72  */
  73
  74 /* ASN1_PCTX routines */
  75
  76 ASN1_PCTX default_pctx = {
  77     ASN1_PCTX_FLAGS_SHOW_ABSENT, /* flags */
  78     0,                          /* nm_flags */
  79     0,                          /* cert_flags */
  80     0,                          /* oid_flags */
  81     0                           /* str_flags */
  82 };
  83
  84 ASN1_PCTX *ASN1_PCTX_new(void)
  85 {
  86     ASN1_PCTX *ret;
  87     ret = OPENSSL_malloc(sizeof(ASN1_PCTX));
  88     if (ret == NULL) {
  89         ASN1err(ASN1_F_ASN1_PCTX_NEW, ERR_R_MALLOC_FAILURE);
  90         return NULL;
  91     }
  92     ret->flags = 0;
  93     ret->nm_flags = 0;
  94     ret->cert_flags = 0;
  95     ret->oid_flags = 0;
  96     ret->str_flags = 0;
  97     return ret;
  98 }
  99
 100 void ASN1_PCTX_free(ASN1_PCTX *p)
 101 {
 102     OPENSSL_free(p);
 103 }
 104
 105 unsigned long ASN1_PCTX_get_flags(ASN1_PCTX *p)
 106 {
 107     return p->flags;
 108 }
 109
 110 void ASN1_PCTX_set_flags(ASN1_PCTX *p, unsigned long flags)
 111 {
 112     p->flags = flags;
 113 }
 114
 115 unsigned long ASN1_PCTX_get_nm_flags(ASN1_PCTX *p)
 116 {
 117     return p->nm_flags;
 118 }
 119
 120 void ASN1_PCTX_set_nm_flags(ASN1_PCTX *p, unsigned long flags)
 121 {
 122     p->nm_flags = flags;
 123 }
 124
 125 unsigned long ASN1_PCTX_get_cert_flags(ASN1_PCTX *p)
 126 {
 127     return p->cert_flags;
 128 }
 129
 130 void ASN1_PCTX_set_cert_flags(ASN1_PCTX *p, unsigned long flags)
 131 {
 132     p->cert_flags = flags;
 133 }
 134
 135 unsigned long ASN1_PCTX_get_oid_flags(ASN1_PCTX *p)
 136 {
 137     return p->oid_flags;
 138 }
 139
 140 void ASN1_PCTX_set_oid_flags(ASN1_PCTX *p, unsigned long flags)
 141 {
 142     p->oid_flags = flags;
 143 }
 144
 145 unsigned long ASN1_PCTX_get_str_flags(ASN1_PCTX *p)
 146 {
 147     return p->str_flags;
 148 }
 149
 150 void ASN1_PCTX_set_str_flags(ASN1_PCTX *p, unsigned long flags)
 151 {
 152     p->str_flags = flags;
 153 }
 154
 155 /* Main print routines */
 156
 157 static int asn1_item_print_ctx(BIO *out, ASN1_VALUE **fld, int indent,
 158                                const ASN1_ITEM *it,
 159                                const char *fname, const char *sname,
 160                                int nohdr, const ASN1_PCTX *pctx);
 161
 162 int asn1_template_print_ctx(BIO *out, ASN1_VALUE **fld, int indent,
 163                             const ASN1_TEMPLATE *tt, const ASN1_PCTX *pctx);
 164
 165 static int asn1_primitive_print(BIO *out, ASN1_VALUE **fld,
 166                                 const ASN1_ITEM *it, int indent,
 167                                 const char *fname, const char *sname,
 168                                 const ASN1_PCTX *pctx);
 169
 170 static int asn1_print_fsname(BIO *out, int indent,
 171                              const char *fname, const char *sname,
 172                              const ASN1_PCTX *pctx);
 173
 174 int ASN1_item_print(BIO *out, ASN1_VALUE *ifld, int indent,
 175                     const ASN1_ITEM *it, const ASN1_PCTX *pctx)
 176 {
 177     const char *sname;
 178     if (pctx == NULL)
 179         pctx = &default_pctx;
 180     if (pctx->flags & ASN1_PCTX_FLAGS_NO_STRUCT_NAME)
 181         sname = NULL;
 182     else
 183         sname = it->sname;
 184     return asn1_item_print_ctx(out, &ifld, indent, it, NULL, sname, 0, pctx);
 185 }
 186
 187 static int asn1_item_print_ctx(BIO *out, ASN1_VALUE **fld, int indent,
 188                                const ASN1_ITEM *it,
 189                                const char *fname, const char *sname,
 190                                int nohdr, const ASN1_PCTX *pctx)
 191 {
 192     const ASN1_TEMPLATE *tt;
 193     const ASN1_EXTERN_FUNCS *ef;
 194     ASN1_VALUE **tmpfld;
 195     const ASN1_AUX *aux = it->funcs;
 196     ASN1_aux_cb *asn1_cb;
 197     ASN1_PRINT_ARG parg;
 198     int i;
 199     if (aux && aux->asn1_cb) {
 200         parg.out = out;
 201         parg.indent = indent;
 202         parg.pctx = pctx;
 203         asn1_cb = aux->asn1_cb;
 204     } else
 205         asn1_cb = 0;
 206
 207     if (*fld == NULL) {
 208         if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_ABSENT) {
 209             if (!nohdr && !asn1_print_fsname(out, indent, fname, sname, pctx))
 210                 return 0;
 211             if (BIO_puts(out, "<ABSENT>\n") <= 0)
 212                 return 0;
 213         }
 214         return 1;
 215     }
 216
 217     switch (it->itype) {
 218     case ASN1_ITYPE_PRIMITIVE:
 219         if (it->templates) {
 220             if (!asn1_template_print_ctx(out, fld, indent,
 221                                          it->templates, pctx))
 222                 return 0;
 223             break;
 224         }
 225         /* fall thru */
 226     case ASN1_ITYPE_MSTRING:
 227         if (!asn1_primitive_print(out, fld, it, indent, fname, sname, pctx))
 228             return 0;
 229         break;
 230
 231     case ASN1_ITYPE_EXTERN:
 232         if (!nohdr && !asn1_print_fsname(out, indent, fname, sname, pctx))
 233             return 0;
 234         /* Use new style print routine if possible */
 235         ef = it->funcs;
 236         if (ef && ef->asn1_ex_print) {
 237             i = ef->asn1_ex_print(out, fld, indent, "", pctx);
 238             if (!i)
 239                 return 0;
 240             if ((i == 2) && (BIO_puts(out, "\n") <= 0))
 241                 return 0;
 242             return 1;
 243         } else if (sname &&
 244                    BIO_printf(out, ":EXTERNAL TYPE %s\n", sname) <= 0)
 245             return 0;
 246         break;
 247
 248     case ASN1_ITYPE_CHOICE:
 249         /* CHOICE type, get selector */
 250         i = asn1_get_choice_selector(fld, it);
 251         /* This should never happen... */
 252         if ((i < 0) || (i >= it->tcount)) {
 253             if (BIO_printf(out, "ERROR: selector [%d] invalid\n", i) <= 0)
 254                 return 0;
 255             return 1;
 256         }
 257         tt = it->templates + i;
 258         tmpfld = asn1_get_field_ptr(fld, tt);
 259         if (!asn1_template_print_ctx(out, tmpfld, indent, tt, pctx))
 260             return 0;
 261         break;
 262
 263     case ASN1_ITYPE_SEQUENCE:
 264     case ASN1_ITYPE_NDEF_SEQUENCE:
 265         if (!nohdr && !asn1_print_fsname(out, indent, fname, sname, pctx))
 266             return 0;
 267         if (fname || sname) {
 268             if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_SEQUENCE) {
 269                 if (BIO_puts(out, " {\n") <= 0)
 270                     return 0;
 271             } else {
 272                 if (BIO_puts(out, "\n") <= 0)
 273                     return 0;
 274             }
 275         }
 276
 277         if (asn1_cb) {
 278             i = asn1_cb(ASN1_OP_PRINT_PRE, fld, it, &parg);
 279             if (i == 0)
 280                 return 0;
 281             if (i == 2)
 282                 return 1;
 283         }
 284
 285         /* Print each field entry */
 286         for (i = 0, tt = it->templates; i < it->tcount; i++, tt++) {
 287             const ASN1_TEMPLATE *seqtt;
 288             seqtt = asn1_do_adb(fld, tt, 1);
 289             if(!seqtt)
 290                 return 0;
 291             tmpfld = asn1_get_field_ptr(fld, seqtt);
 292             if (!asn1_template_print_ctx(out, tmpfld,
 293                                          indent + 2, seqtt, pctx))
 294                 return 0;
 295         }
 296         if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_SEQUENCE) {
 297             if (BIO_printf(out, "%*s}\n", indent, "") < 0)
 298                 return 0;
 299         }
 300
 301         if (asn1_cb) {
 302             i = asn1_cb(ASN1_OP_PRINT_POST, fld, it, &parg);
 303             if (i == 0)
 304                 return 0;
 305         }
 306         break;
 307
 308     default:
 309         BIO_printf(out, "Unprocessed type %d\n", it->itype);
 310         return 0;
 311     }
 312
 313     return 1;
 314 }
 315
 316 int asn1_template_print_ctx(BIO *out, ASN1_VALUE **fld, int indent,
 317                             const ASN1_TEMPLATE *tt, const ASN1_PCTX *pctx)
 318 {
 319     int i, flags;
 320     const char *sname, *fname;
 321     flags = tt->flags;
 322     if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_FIELD_STRUCT_NAME)
 323         sname = ASN1_ITEM_ptr(tt->item)->sname;
 324     else
 325         sname = NULL;
 326     if (pctx->flags & ASN1_PCTX_FLAGS_NO_FIELD_NAME)
 327         fname = NULL;
 328     else
 329         fname = tt->field_name;
 330     if (flags & ASN1_TFLG_SK_MASK) {
 331         char *tname;
 332         ASN1_VALUE *skitem;
 333         STACK_OF(ASN1_VALUE) *stack;
 334
 335         /* SET OF, SEQUENCE OF */
 336         if (fname) {
 337             if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_SSOF) {
 338                 if (flags & ASN1_TFLG_SET_OF)
 339                     tname = "SET";
 340                 else
 341                     tname = "SEQUENCE";
 342                 if (BIO_printf(out, "%*s%s OF %s {\n",
 343                                indent, "", tname, tt->field_name) <= 0)
 344                     return 0;
 345             } else if (BIO_printf(out, "%*s%s:\n", indent, "", fname) <= 0)
 346                 return 0;
 347         }
 348         stack = (STACK_OF(ASN1_VALUE) *)*fld;
 349         for (i = 0; i < sk_ASN1_VALUE_num(stack); i++) {
 350             if ((i > 0) && (BIO_puts(out, "\n") <= 0))
 351                 return 0;
 352
 353             skitem = sk_ASN1_VALUE_value(stack, i);
 354             if (!asn1_item_print_ctx(out, &skitem, indent + 2,
 355                                      ASN1_ITEM_ptr(tt->item), NULL, NULL, 1,
 356                                      pctx))
 357                 return 0;
 358         }
 359         if (!i && BIO_printf(out, "%*s<EMPTY>\n", indent + 2, "") <= 0)
 360             return 0;
 361         if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_SEQUENCE) {
 362             if (BIO_printf(out, "%*s}\n", indent, "") <= 0)
 363                 return 0;
 364         }
 365         return 1;
 366     }
 367     return asn1_item_print_ctx(out, fld, indent, ASN1_ITEM_ptr(tt->item),
 368                                fname, sname, 0, pctx);
 369 }
 370
 371 static int asn1_print_fsname(BIO *out, int indent,
 372                              const char *fname, const char *sname,
 373                              const ASN1_PCTX *pctx)
 374 {
 375     static const char spaces[] = "                    ";
 376     static const int nspaces = sizeof(spaces) - 1;
 377
 378     while (indent > nspaces) {
 379         if (BIO_write(out, spaces, nspaces) != nspaces)
 380             return 0;
 381         indent -= nspaces;
 382     }
 383     if (BIO_write(out, spaces, indent) != indent)
 384         return 0;
 385     if (pctx->flags & ASN1_PCTX_FLAGS_NO_STRUCT_NAME)
 386         sname = NULL;
 387     if (pctx->flags & ASN1_PCTX_FLAGS_NO_FIELD_NAME)
 388         fname = NULL;
 389     if (!sname && !fname)
 390         return 1;
 391     if (fname) {
 392         if (BIO_puts(out, fname) <= 0)
 393             return 0;
 394     }
 395     if (sname) {
 396         if (fname) {
 397             if (BIO_printf(out, " (%s)", sname) <= 0)
 398                 return 0;
 399         } else {
 400             if (BIO_puts(out, sname) <= 0)
 401                 return 0;
 402         }
 403     }
 404     if (BIO_write(out, ": ", 2) != 2)
 405         return 0;
 406     return 1;
 407 }
 408
 409 static int asn1_print_boolean_ctx(BIO *out, int boolval,
 410                                   const ASN1_PCTX *pctx)
 411 {
 412     const char *str;
 413     switch (boolval) {
 414     case -1:
 415         str = "BOOL ABSENT";
 416         break;
 417
 418     case 0:
 419         str = "FALSE";
 420         break;
 421
 422     default:
 423         str = "TRUE";
 424         break;
 425
 426     }
 427
 428     if (BIO_puts(out, str) <= 0)
 429         return 0;
 430     return 1;
 431
 432 }
 433
 434 static int asn1_print_integer_ctx(BIO *out, ASN1_INTEGER *str,
 435                                   const ASN1_PCTX *pctx)
 436 {
 437     char *s;
 438     int ret = 1;
 439     s = i2s_ASN1_INTEGER(NULL, str);
 440     if (BIO_puts(out, s) <= 0)
 441         ret = 0;
 442     OPENSSL_free(s);
 443     return ret;
 444 }
 445
 446 static int asn1_print_oid_ctx(BIO *out, const ASN1_OBJECT *oid,
 447                               const ASN1_PCTX *pctx)
 448 {
 449     char objbuf[80];
 450     const char *ln;
 451     ln = OBJ_nid2ln(OBJ_obj2nid(oid));
 452     if (!ln)
 453         ln = "";
 454     OBJ_obj2txt(objbuf, sizeof objbuf, oid, 1);
 455     if (BIO_printf(out, "%s (%s)", ln, objbuf) <= 0)
 456         return 0;
 457     return 1;
 458 }
 459
 460 static int asn1_print_obstring_ctx(BIO *out, ASN1_STRING *str, int indent,
 461                                    const ASN1_PCTX *pctx)
 462 {
 463     if (str->type == V_ASN1_BIT_STRING) {
 464         if (BIO_printf(out, " (%ld unused bits)\n", str->flags & 0x7) <= 0)
 465             return 0;
 466     } else if (BIO_puts(out, "\n") <= 0)
 467         return 0;
 468     if ((str->length > 0)
 469         && BIO_dump_indent(out, (char *)str->data, str->length,
 470                            indent + 2) <= 0)
 471         return 0;
 472     return 1;
 473 }
 474
 475 static int asn1_primitive_print(BIO *out, ASN1_VALUE **fld,
 476                                 const ASN1_ITEM *it, int indent,
 477                                 const char *fname, const char *sname,
 478                                 const ASN1_PCTX *pctx)
 479 {
 480     long utype;
 481     ASN1_STRING *str;
 482     int ret = 1, needlf = 1;
 483     const char *pname;
 484     const ASN1_PRIMITIVE_FUNCS *pf;
 485     pf = it->funcs;
 486     if (!asn1_print_fsname(out, indent, fname, sname, pctx))
 487         return 0;
 488     if (pf && pf->prim_print)
 489         return pf->prim_print(out, fld, it, indent, pctx);
 490     str = (ASN1_STRING *)*fld;
 491     if (it->itype == ASN1_ITYPE_MSTRING)
 492         utype = str->type & ~V_ASN1_NEG;
 493     else
 494         utype = it->utype;
 495     if (utype == V_ASN1_ANY) {
 496         ASN1_TYPE *atype = (ASN1_TYPE *)*fld;
 497         utype = atype->type;
 498         fld = &atype->value.asn1_value;
 499         str = (ASN1_STRING *)*fld;
 500         if (pctx->flags & ASN1_PCTX_FLAGS_NO_ANY_TYPE)
 501             pname = NULL;
 502         else
 503             pname = ASN1_tag2str(utype);
 504     } else {
 505         if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_TYPE)
 506             pname = ASN1_tag2str(utype);
 507         else
 508             pname = NULL;
 509     }
 510
 511     if (utype == V_ASN1_NULL) {
 512         if (BIO_puts(out, "NULL\n") <= 0)
 513             return 0;
 514         return 1;
 515     }
 516
 517     if (pname) {
 518         if (BIO_puts(out, pname) <= 0)
 519             return 0;
 520         if (BIO_puts(out, ":") <= 0)
 521             return 0;
 522     }
 523
 524     switch (utype) {
 525     case V_ASN1_BOOLEAN:
 526         {
 527             int boolval = *(int *)fld;
 528             if (boolval == -1)
 529                 boolval = it->size;
 530             ret = asn1_print_boolean_ctx(out, boolval, pctx);
 531         }
 532         break;
 533
 534     case V_ASN1_INTEGER:
 535     case V_ASN1_ENUMERATED:
 536         ret = asn1_print_integer_ctx(out, str, pctx);
 537         break;
 538
 539     case V_ASN1_UTCTIME:
 540         ret = ASN1_UTCTIME_print(out, str);
 541         break;
 542
 543     case V_ASN1_GENERALIZEDTIME:
 544         ret = ASN1_GENERALIZEDTIME_print(out, str);
 545         break;
 546
 547     case V_ASN1_OBJECT:
 548         ret = asn1_print_oid_ctx(out, (const ASN1_OBJECT *)*fld, pctx);
 549         break;
 550
 551     case V_ASN1_OCTET_STRING:
 552     case V_ASN1_BIT_STRING:
 553         ret = asn1_print_obstring_ctx(out, str, indent, pctx);
 554         needlf = 0;
 555         break;
 556
 557     case V_ASN1_SEQUENCE:
 558     case V_ASN1_SET:
 559     case V_ASN1_OTHER:
 560         if (BIO_puts(out, "\n") <= 0)
 561             return 0;
 562         if (ASN1_parse_dump(out, str->data, str->length, indent, 0) <= 0)
 563             ret = 0;
 564         needlf = 0;
 565         break;
 566
 567     default:
 568         ret = ASN1_STRING_print_ex(out, str, pctx->str_flags);
 569
 570     }
 571     if (!ret)
 572         return 0;
 573     if (needlf && BIO_puts(out, "\n") <= 0)
 574         return 0;
 575     return 1;
 576 }