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         }
 224         /* fall thru */
 225     case ASN1_ITYPE_MSTRING:
 226         if (!asn1_primitive_print(out, fld, it, indent, fname, sname, pctx))
 227             return 0;
 228         break;
 229
 230     case ASN1_ITYPE_EXTERN:
 231         if (!nohdr && !asn1_print_fsname(out, indent, fname, sname, pctx))
 232             return 0;
 233         /* Use new style print routine if possible */
 234         ef = it->funcs;
 235         if (ef && ef->asn1_ex_print) {
 236             i = ef->asn1_ex_print(out, fld, indent, "", pctx);
 237             if (!i)
 238                 return 0;
 239             if ((i == 2) && (BIO_puts(out, "\n") <= 0))
 240                 return 0;
 241             return 1;
 242         } else if (sname &&
 243                    BIO_printf(out, ":EXTERNAL TYPE %s\n", sname) <= 0)
 244             return 0;
 245         break;
 246
 247     case ASN1_ITYPE_CHOICE:
 248 #if 0
 249         if (!nohdr && !asn1_print_fsname(out, indent, fname, sname, pctx))
 250             return 0;
 251 #endif
 252         /* CHOICE type, get selector */
 253         i = asn1_get_choice_selector(fld, it);
 254         /* This should never happen... */
 255         if ((i < 0) || (i >= it->tcount)) {
 256             if (BIO_printf(out, "ERROR: selector [%d] invalid\n", i) <= 0)
 257                 return 0;
 258             return 1;
 259         }
 260         tt = it->templates + i;
 261         tmpfld = asn1_get_field_ptr(fld, tt);
 262         if (!asn1_template_print_ctx(out, tmpfld, indent, tt, pctx))
 263             return 0;
 264         break;
 265
 266     case ASN1_ITYPE_SEQUENCE:
 267     case ASN1_ITYPE_NDEF_SEQUENCE:
 268         if (!nohdr && !asn1_print_fsname(out, indent, fname, sname, pctx))
 269             return 0;
 270         if (fname || sname) {
 271             if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_SEQUENCE) {
 272                 if (BIO_puts(out, " {\n") <= 0)
 273                     return 0;
 274             } else {
 275                 if (BIO_puts(out, "\n") <= 0)
 276                     return 0;
 277             }
 278         }
 279
 280         if (asn1_cb) {
 281             i = asn1_cb(ASN1_OP_PRINT_PRE, fld, it, &parg);
 282             if (i == 0)
 283                 return 0;
 284             if (i == 2)
 285                 return 1;
 286         }
 287
 288         /* Print each field entry */
 289         for (i = 0, tt = it->templates; i < it->tcount; i++, tt++) {
 290             const ASN1_TEMPLATE *seqtt;
 291             seqtt = asn1_do_adb(fld, tt, 1);
 292             tmpfld = asn1_get_field_ptr(fld, seqtt);
 293             if (!asn1_template_print_ctx(out, tmpfld,
 294                                          indent + 2, seqtt, pctx))
 295                 return 0;
 296         }
 297         if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_SEQUENCE) {
 298             if (BIO_printf(out, "%*s}\n", indent, "") < 0)
 299                 return 0;
 300         }
 301
 302         if (asn1_cb) {
 303             i = asn1_cb(ASN1_OP_PRINT_POST, fld, it, &parg);
 304             if (i == 0)
 305                 return 0;
 306         }
 307         break;
 308
 309     default:
 310         BIO_printf(out, "Unprocessed type %d\n", it->itype);
 311         return 0;
 312     }
 313
 314     return 1;
 315 }
 316
 317 int asn1_template_print_ctx(BIO *out, ASN1_VALUE **fld, int indent,
 318                             const ASN1_TEMPLATE *tt, const ASN1_PCTX *pctx)
 319 {
 320     int i, flags;
 321     const char *sname, *fname;
 322     flags = tt->flags;
 323     if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_FIELD_STRUCT_NAME)
 324         sname = ASN1_ITEM_ptr(tt->item)->sname;
 325     else
 326         sname = NULL;
 327     if (pctx->flags & ASN1_PCTX_FLAGS_NO_FIELD_NAME)
 328         fname = NULL;
 329     else
 330         fname = tt->field_name;
 331     if (flags & ASN1_TFLG_SK_MASK) {
 332         char *tname;
 333         ASN1_VALUE *skitem;
 334         STACK_OF(ASN1_VALUE) *stack;
 335
 336         /* SET OF, SEQUENCE OF */
 337         if (fname) {
 338             if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_SSOF) {
 339                 if (flags & ASN1_TFLG_SET_OF)
 340                     tname = "SET";
 341                 else
 342                     tname = "SEQUENCE";
 343                 if (BIO_printf(out, "%*s%s OF %s {\n",
 344                                indent, "", tname, tt->field_name) <= 0)
 345                     return 0;
 346             } else if (BIO_printf(out, "%*s%s:\n", indent, "", fname) <= 0)
 347                 return 0;
 348         }
 349         stack = (STACK_OF(ASN1_VALUE) *)*fld;
 350         for (i = 0; i < sk_ASN1_VALUE_num(stack); i++) {
 351             if ((i > 0) && (BIO_puts(out, "\n") <= 0))
 352                 return 0;
 353
 354             skitem = sk_ASN1_VALUE_value(stack, i);
 355             if (!asn1_item_print_ctx(out, &skitem, indent + 2,
 356                                      ASN1_ITEM_ptr(tt->item), NULL, NULL, 1,
 357                                      pctx))
 358                 return 0;
 359         }
 360         if (!i && BIO_printf(out, "%*s<EMPTY>\n", indent + 2, "") <= 0)
 361             return 0;
 362         if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_SEQUENCE) {
 363             if (BIO_printf(out, "%*s}\n", indent, "") <= 0)
 364                 return 0;
 365         }
 366         return 1;
 367     }
 368     return asn1_item_print_ctx(out, fld, indent, ASN1_ITEM_ptr(tt->item),
 369                                fname, sname, 0, pctx);
 370 }
 371
 372 static int asn1_print_fsname(BIO *out, int indent,
 373                              const char *fname, const char *sname,
 374                              const ASN1_PCTX *pctx)
 375 {
 376     static const char spaces[] = "                    ";
 377     static const int nspaces = sizeof(spaces) - 1;
 378
 379 #if 0
 380     if (!sname && !fname)
 381         return 1;
 382 #endif
 383
 384     while (indent > nspaces) {
 385         if (BIO_write(out, spaces, nspaces) != nspaces)
 386             return 0;
 387         indent -= nspaces;
 388     }
 389     if (BIO_write(out, spaces, indent) != indent)
 390         return 0;
 391     if (pctx->flags & ASN1_PCTX_FLAGS_NO_STRUCT_NAME)
 392         sname = NULL;
 393     if (pctx->flags & ASN1_PCTX_FLAGS_NO_FIELD_NAME)
 394         fname = NULL;
 395     if (!sname && !fname)
 396         return 1;
 397     if (fname) {
 398         if (BIO_puts(out, fname) <= 0)
 399             return 0;
 400     }
 401     if (sname) {
 402         if (fname) {
 403             if (BIO_printf(out, " (%s)", sname) <= 0)
 404                 return 0;
 405         } else {
 406             if (BIO_puts(out, sname) <= 0)
 407                 return 0;
 408         }
 409     }
 410     if (BIO_write(out, ": ", 2) != 2)
 411         return 0;
 412     return 1;
 413 }
 414
 415 static int asn1_print_boolean_ctx(BIO *out, int boolval,
 416                                   const ASN1_PCTX *pctx)
 417 {
 418     const char *str;
 419     switch (boolval) {
 420     case -1:
 421         str = "BOOL ABSENT";
 422         break;
 423
 424     case 0:
 425         str = "FALSE";
 426         break;
 427
 428     default:
 429         str = "TRUE";
 430         break;
 431
 432     }
 433
 434     if (BIO_puts(out, str) <= 0)
 435         return 0;
 436     return 1;
 437
 438 }
 439
 440 static int asn1_print_integer_ctx(BIO *out, ASN1_INTEGER *str,
 441                                   const ASN1_PCTX *pctx)
 442 {
 443     char *s;
 444     int ret = 1;
 445     s = i2s_ASN1_INTEGER(NULL, str);
 446     if (BIO_puts(out, s) <= 0)
 447         ret = 0;
 448     OPENSSL_free(s);
 449     return ret;
 450 }
 451
 452 static int asn1_print_oid_ctx(BIO *out, const ASN1_OBJECT *oid,
 453                               const ASN1_PCTX *pctx)
 454 {
 455     char objbuf[80];
 456     const char *ln;
 457     ln = OBJ_nid2ln(OBJ_obj2nid(oid));
 458     if (!ln)
 459         ln = "";
 460     OBJ_obj2txt(objbuf, sizeof objbuf, oid, 1);
 461     if (BIO_printf(out, "%s (%s)", ln, objbuf) <= 0)
 462         return 0;
 463     return 1;
 464 }
 465
 466 static int asn1_print_obstring_ctx(BIO *out, ASN1_STRING *str, int indent,
 467                                    const ASN1_PCTX *pctx)
 468 {
 469     if (str->type == V_ASN1_BIT_STRING) {
 470         if (BIO_printf(out, " (%ld unused bits)\n", str->flags & 0x7) <= 0)
 471             return 0;
 472     } else if (BIO_puts(out, "\n") <= 0)
 473         return 0;
 474     if ((str->length > 0)
 475         && BIO_dump_indent(out, (char *)str->data, str->length,
 476                            indent + 2) <= 0)
 477         return 0;
 478     return 1;
 479 }
 480
 481 static int asn1_primitive_print(BIO *out, ASN1_VALUE **fld,
 482                                 const ASN1_ITEM *it, int indent,
 483                                 const char *fname, const char *sname,
 484                                 const ASN1_PCTX *pctx)
 485 {
 486     long utype;
 487     ASN1_STRING *str;
 488     int ret = 1, needlf = 1;
 489     const char *pname;
 490     const ASN1_PRIMITIVE_FUNCS *pf;
 491     pf = it->funcs;
 492     if (!asn1_print_fsname(out, indent, fname, sname, pctx))
 493         return 0;
 494     if (pf && pf->prim_print)
 495         return pf->prim_print(out, fld, it, indent, pctx);
 496     str = (ASN1_STRING *)*fld;
 497     if (it->itype == ASN1_ITYPE_MSTRING)
 498         utype = str->type & ~V_ASN1_NEG;
 499     else
 500         utype = it->utype;
 501     if (utype == V_ASN1_ANY) {
 502         ASN1_TYPE *atype = (ASN1_TYPE *)*fld;
 503         utype = atype->type;
 504         fld = &atype->value.asn1_value;
 505         str = (ASN1_STRING *)*fld;
 506         if (pctx->flags & ASN1_PCTX_FLAGS_NO_ANY_TYPE)
 507             pname = NULL;
 508         else
 509             pname = ASN1_tag2str(utype);
 510     } else {
 511         if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_TYPE)
 512             pname = ASN1_tag2str(utype);
 513         else
 514             pname = NULL;
 515     }
 516
 517     if (utype == V_ASN1_NULL) {
 518         if (BIO_puts(out, "NULL\n") <= 0)
 519             return 0;
 520         return 1;
 521     }
 522
 523     if (pname) {
 524         if (BIO_puts(out, pname) <= 0)
 525             return 0;
 526         if (BIO_puts(out, ":") <= 0)
 527             return 0;
 528     }
 529
 530     switch (utype) {
 531     case V_ASN1_BOOLEAN:
 532         {
 533             int boolval = *(int *)fld;
 534             if (boolval == -1)
 535                 boolval = it->size;
 536             ret = asn1_print_boolean_ctx(out, boolval, pctx);
 537         }
 538         break;
 539
 540     case V_ASN1_INTEGER:
 541     case V_ASN1_ENUMERATED:
 542         ret = asn1_print_integer_ctx(out, str, pctx);
 543         break;
 544
 545     case V_ASN1_UTCTIME:
 546         ret = ASN1_UTCTIME_print(out, str);
 547         break;
 548
 549     case V_ASN1_GENERALIZEDTIME:
 550         ret = ASN1_GENERALIZEDTIME_print(out, str);
 551         break;
 552
 553     case V_ASN1_OBJECT:
 554         ret = asn1_print_oid_ctx(out, (const ASN1_OBJECT *)*fld, pctx);
 555         break;
 556
 557     case V_ASN1_OCTET_STRING:
 558     case V_ASN1_BIT_STRING:
 559         ret = asn1_print_obstring_ctx(out, str, indent, pctx);
 560         needlf = 0;
 561         break;
 562
 563     case V_ASN1_SEQUENCE:
 564     case V_ASN1_SET:
 565     case V_ASN1_OTHER:
 566         if (BIO_puts(out, "\n") <= 0)
 567             return 0;
 568         if (ASN1_parse_dump(out, str->data, str->length, indent, 0) <= 0)
 569             ret = 0;
 570         needlf = 0;
 571         break;
 572
 573     default:
 574         ret = ASN1_STRING_print_ex(out, str, pctx->str_flags);
 575
 576     }
 577     if (!ret)
 578         return 0;
 579     if (needlf && BIO_puts(out, "\n") <= 0)
 580         return 0;
 581     return 1;
 582 }