include/openssl/asn1t.h

   1 /* asn1t.h */
   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 #ifndef HEADER_ASN1T_H
  60 # define HEADER_ASN1T_H
  61
  62 # include <stddef.h>
  63 # include <openssl/e_os2.h>
  64 # include <openssl/asn1.h>
  65
  66 # ifdef OPENSSL_BUILD_SHLIBCRYPTO
  67 #  undef OPENSSL_EXTERN
  68 #  define OPENSSL_EXTERN OPENSSL_EXPORT
  69 # endif
  70
  71 /* ASN1 template defines, structures and functions */
  72
  73 #ifdef  __cplusplus
  74 extern "C" {
  75 #endif
  76
  77 # ifndef OPENSSL_EXPORT_VAR_AS_FUNCTION
  78
  79 /* Macro to obtain ASN1_ADB pointer from a type (only used internally) */
  80 #  define ASN1_ADB_ptr(iptr) ((const ASN1_ADB *)(iptr))
  81
  82 /* Macros for start and end of ASN1_ITEM definition */
  83
  84 #  define ASN1_ITEM_start(itname) \
  85         OPENSSL_GLOBAL const ASN1_ITEM itname##_it = {
  86
  87 #  define static_ASN1_ITEM_start(itname) \
  88         static const ASN1_ITEM itname##_it = {
  89
  90 #  define ASN1_ITEM_end(itname)                 \
  91                 };
  92
  93 # else
  94
  95 /* Macro to obtain ASN1_ADB pointer from a type (only used internally) */
  96 #  define ASN1_ADB_ptr(iptr) ((const ASN1_ADB *)(iptr()))
  97
  98 /* Macros for start and end of ASN1_ITEM definition */
  99
 100 #  define ASN1_ITEM_start(itname) \
 101         const ASN1_ITEM * itname##_it(void) \
 102         { \
 103                 static const ASN1_ITEM local_it = {
 104
 105 #  define static_ASN1_ITEM_start(itname) \
 106         ASN1_ITEM_start(itname)
 107
 108 #  define ASN1_ITEM_end(itname) \
 109                 }; \
 110         return &local_it; \
 111         }
 112
 113 # endif
 114
 115 /* Macros to aid ASN1 template writing */
 116
 117 # define ASN1_ITEM_TEMPLATE(tname) \
 118         static const ASN1_TEMPLATE tname##_item_tt
 119
 120 # define ASN1_ITEM_TEMPLATE_END(tname) \
 121         ;\
 122         ASN1_ITEM_start(tname) \
 123                 ASN1_ITYPE_PRIMITIVE,\
 124                 -1,\
 125                 &tname##_item_tt,\
 126                 0,\
 127                 NULL,\
 128                 0,\
 129                 #tname \
 130         ASN1_ITEM_end(tname)
 131 # define static_ASN1_ITEM_TEMPLATE_END(tname) \
 132         ;\
 133         static_ASN1_ITEM_start(tname) \
 134                 ASN1_ITYPE_PRIMITIVE,\
 135                 -1,\
 136                 &tname##_item_tt,\
 137                 0,\
 138                 NULL,\
 139                 0,\
 140                 #tname \
 141         ASN1_ITEM_end(tname)
 142
 143 /* This is a ASN1 type which just embeds a template */
 144
 145 /*-
 146  * This pair helps declare a SEQUENCE. We can do:
 147  *
 148  *      ASN1_SEQUENCE(stname) = {
 149  *              ... SEQUENCE components ...
 150  *      } ASN1_SEQUENCE_END(stname)
 151  *
 152  *      This will produce an ASN1_ITEM called stname_it
 153  *      for a structure called stname.
 154  *
 155  *      If you want the same structure but a different
 156  *      name then use:
 157  *
 158  *      ASN1_SEQUENCE(itname) = {
 159  *              ... SEQUENCE components ...
 160  *      } ASN1_SEQUENCE_END_name(stname, itname)
 161  *
 162  *      This will create an item called itname_it using
 163  *      a structure called stname.
 164  */
 165
 166 # define ASN1_SEQUENCE(tname) \
 167         static const ASN1_TEMPLATE tname##_seq_tt[]
 168
 169 # define ASN1_SEQUENCE_END(stname) ASN1_SEQUENCE_END_name(stname, stname)
 170
 171 # define static_ASN1_SEQUENCE_END(stname) static_ASN1_SEQUENCE_END_name(stname, stname)
 172
 173 # define ASN1_SEQUENCE_END_name(stname, tname) \
 174         ;\
 175         ASN1_ITEM_start(tname) \
 176                 ASN1_ITYPE_SEQUENCE,\
 177                 V_ASN1_SEQUENCE,\
 178                 tname##_seq_tt,\
 179                 sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\
 180                 NULL,\
 181                 sizeof(stname),\
 182                 #stname \
 183         ASN1_ITEM_end(tname)
 184
 185 # define static_ASN1_SEQUENCE_END_name(stname, tname) \
 186         ;\
 187         static_ASN1_ITEM_start(tname) \
 188                 ASN1_ITYPE_SEQUENCE,\
 189                 V_ASN1_SEQUENCE,\
 190                 tname##_seq_tt,\
 191                 sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\
 192                 NULL,\
 193                 sizeof(stname),\
 194                 #stname \
 195         ASN1_ITEM_end(tname)
 196
 197 # define ASN1_NDEF_SEQUENCE(tname) \
 198         ASN1_SEQUENCE(tname)
 199
 200 # define ASN1_NDEF_SEQUENCE_cb(tname, cb) \
 201         ASN1_SEQUENCE_cb(tname, cb)
 202
 203 # define ASN1_SEQUENCE_cb(tname, cb) \
 204         static const ASN1_AUX tname##_aux = {NULL, 0, 0, 0, cb, 0}; \
 205         ASN1_SEQUENCE(tname)
 206
 207 # define ASN1_BROKEN_SEQUENCE(tname) \
 208         static const ASN1_AUX tname##_aux = {NULL, ASN1_AFLG_BROKEN, 0, 0, 0, 0}; \
 209         ASN1_SEQUENCE(tname)
 210
 211 # define ASN1_SEQUENCE_ref(tname, cb, lck) \
 212         static const ASN1_AUX tname##_aux = {NULL, ASN1_AFLG_REFCOUNT, offsetof(tname, references), lck, cb, 0}; \
 213         ASN1_SEQUENCE(tname)
 214
 215 # define ASN1_SEQUENCE_enc(tname, enc, cb) \
 216         static const ASN1_AUX tname##_aux = {NULL, ASN1_AFLG_ENCODING, 0, 0, cb, offsetof(tname, enc)}; \
 217         ASN1_SEQUENCE(tname)
 218
 219 # define ASN1_NDEF_SEQUENCE_END(tname) \
 220         ;\
 221         ASN1_ITEM_start(tname) \
 222                 ASN1_ITYPE_NDEF_SEQUENCE,\
 223                 V_ASN1_SEQUENCE,\
 224                 tname##_seq_tt,\
 225                 sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\
 226                 NULL,\
 227                 sizeof(tname),\
 228                 #tname \
 229         ASN1_ITEM_end(tname)
 230 # define static_ASN1_NDEF_SEQUENCE_END(tname) \
 231         ;\
 232         static_ASN1_ITEM_start(tname)                   \
 233                 ASN1_ITYPE_NDEF_SEQUENCE,\
 234                 V_ASN1_SEQUENCE,\
 235                 tname##_seq_tt,\
 236                 sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\
 237                 NULL,\
 238                 sizeof(tname),\
 239                 #tname \
 240         ASN1_ITEM_end(tname)
 241
 242 # define ASN1_BROKEN_SEQUENCE_END(stname) ASN1_SEQUENCE_END_ref(stname, stname)
 243 # define static_ASN1_BROKEN_SEQUENCE_END(stname) \
 244         static_ASN1_SEQUENCE_END_ref(stname, stname)
 245
 246 # define ASN1_SEQUENCE_END_enc(stname, tname) ASN1_SEQUENCE_END_ref(stname, tname)
 247
 248 # define ASN1_SEQUENCE_END_cb(stname, tname) ASN1_SEQUENCE_END_ref(stname, tname)
 249 # define static_ASN1_SEQUENCE_END_cb(stname, tname) static_ASN1_SEQUENCE_END_ref(stname, tname)
 250
 251 # define ASN1_SEQUENCE_END_ref(stname, tname) \
 252         ;\
 253         ASN1_ITEM_start(tname) \
 254                 ASN1_ITYPE_SEQUENCE,\
 255                 V_ASN1_SEQUENCE,\
 256                 tname##_seq_tt,\
 257                 sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\
 258                 &tname##_aux,\
 259                 sizeof(stname),\
 260                 #stname \
 261         ASN1_ITEM_end(tname)
 262 # define static_ASN1_SEQUENCE_END_ref(stname, tname) \
 263         ;\
 264         static_ASN1_ITEM_start(tname) \
 265                 ASN1_ITYPE_SEQUENCE,\
 266                 V_ASN1_SEQUENCE,\
 267                 tname##_seq_tt,\
 268                 sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\
 269                 &tname##_aux,\
 270                 sizeof(stname),\
 271                 #stname \
 272         ASN1_ITEM_end(tname)
 273
 274 # define ASN1_NDEF_SEQUENCE_END_cb(stname, tname) \
 275         ;\
 276         ASN1_ITEM_start(tname) \
 277                 ASN1_ITYPE_NDEF_SEQUENCE,\
 278                 V_ASN1_SEQUENCE,\
 279                 tname##_seq_tt,\
 280                 sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\
 281                 &tname##_aux,\
 282                 sizeof(stname),\
 283                 #stname \
 284         ASN1_ITEM_end(tname)
 285
 286 /*-
 287  * This pair helps declare a CHOICE type. We can do:
 288  *
 289  *      ASN1_CHOICE(chname) = {
 290  *              ... CHOICE options ...
 291  *      ASN1_CHOICE_END(chname)
 292  *
 293  *      This will produce an ASN1_ITEM called chname_it
 294  *      for a structure called chname. The structure
 295  *      definition must look like this:
 296  *      typedef struct {
 297  *              int type;
 298  *              union {
 299  *                      ASN1_SOMETHING *opt1;
 300  *                      ASN1_SOMEOTHER *opt2;
 301  *              } value;
 302  *      } chname;
 303  *
 304  *      the name of the selector must be 'type'.
 305  *      to use an alternative selector name use the
 306  *      ASN1_CHOICE_END_selector() version.
 307  */
 308
 309 # define ASN1_CHOICE(tname) \
 310         static const ASN1_TEMPLATE tname##_ch_tt[]
 311
 312 # define ASN1_CHOICE_cb(tname, cb) \
 313         static const ASN1_AUX tname##_aux = {NULL, 0, 0, 0, cb, 0}; \
 314         ASN1_CHOICE(tname)
 315
 316 # define ASN1_CHOICE_END(stname) ASN1_CHOICE_END_name(stname, stname)
 317
 318 # define static_ASN1_CHOICE_END(stname) static_ASN1_CHOICE_END_name(stname, stname)
 319
 320 # define ASN1_CHOICE_END_name(stname, tname) ASN1_CHOICE_END_selector(stname, tname, type)
 321
 322 # define static_ASN1_CHOICE_END_name(stname, tname) static_ASN1_CHOICE_END_selector(stname, tname, type)
 323
 324 # define ASN1_CHOICE_END_selector(stname, tname, selname) \
 325         ;\
 326         ASN1_ITEM_start(tname) \
 327                 ASN1_ITYPE_CHOICE,\
 328                 offsetof(stname,selname) ,\
 329                 tname##_ch_tt,\
 330                 sizeof(tname##_ch_tt) / sizeof(ASN1_TEMPLATE),\
 331                 NULL,\
 332                 sizeof(stname),\
 333                 #stname \
 334         ASN1_ITEM_end(tname)
 335
 336 # define static_ASN1_CHOICE_END_selector(stname, tname, selname) \
 337         ;\
 338         static_ASN1_ITEM_start(tname) \
 339                 ASN1_ITYPE_CHOICE,\
 340                 offsetof(stname,selname) ,\
 341                 tname##_ch_tt,\
 342                 sizeof(tname##_ch_tt) / sizeof(ASN1_TEMPLATE),\
 343                 NULL,\
 344                 sizeof(stname),\
 345                 #stname \
 346         ASN1_ITEM_end(tname)
 347
 348 # define ASN1_CHOICE_END_cb(stname, tname, selname) \
 349         ;\
 350         ASN1_ITEM_start(tname) \
 351                 ASN1_ITYPE_CHOICE,\
 352                 offsetof(stname,selname) ,\
 353                 tname##_ch_tt,\
 354                 sizeof(tname##_ch_tt) / sizeof(ASN1_TEMPLATE),\
 355                 &tname##_aux,\
 356                 sizeof(stname),\
 357                 #stname \
 358         ASN1_ITEM_end(tname)
 359
 360 /* This helps with the template wrapper form of ASN1_ITEM */
 361
 362 # define ASN1_EX_TEMPLATE_TYPE(flags, tag, name, type) { \
 363         (flags), (tag), 0,\
 364         #name, ASN1_ITEM_ref(type) }
 365
 366 /* These help with SEQUENCE or CHOICE components */
 367
 368 /* used to declare other types */
 369
 370 # define ASN1_EX_TYPE(flags, tag, stname, field, type) { \
 371         (flags), (tag), offsetof(stname, field),\
 372         #field, ASN1_ITEM_ref(type) }
 373
 374 /* implicit and explicit helper macros */
 375
 376 # define ASN1_IMP_EX(stname, field, type, tag, ex) \
 377                 ASN1_EX_TYPE(ASN1_TFLG_IMPLICIT | ex, tag, stname, field, type)
 378
 379 # define ASN1_EXP_EX(stname, field, type, tag, ex) \
 380                 ASN1_EX_TYPE(ASN1_TFLG_EXPLICIT | ex, tag, stname, field, type)
 381
 382 /* Any defined by macros: the field used is in the table itself */
 383
 384 # ifndef OPENSSL_EXPORT_VAR_AS_FUNCTION
 385 #  define ASN1_ADB_OBJECT(tblname) { ASN1_TFLG_ADB_OID, -1, 0, #tblname, (const ASN1_ITEM *)&(tblname##_adb) }
 386 #  define ASN1_ADB_INTEGER(tblname) { ASN1_TFLG_ADB_INT, -1, 0, #tblname, (const ASN1_ITEM *)&(tblname##_adb) }
 387 # else
 388 #  define ASN1_ADB_OBJECT(tblname) { ASN1_TFLG_ADB_OID, -1, 0, #tblname, tblname##_adb }
 389 #  define ASN1_ADB_INTEGER(tblname) { ASN1_TFLG_ADB_INT, -1, 0, #tblname, tblname##_adb }
 390 # endif
 391 /* Plain simple type */
 392 # define ASN1_SIMPLE(stname, field, type) ASN1_EX_TYPE(0,0, stname, field, type)
 393
 394 /* OPTIONAL simple type */
 395 # define ASN1_OPT(stname, field, type) ASN1_EX_TYPE(ASN1_TFLG_OPTIONAL, 0, stname, field, type)
 396
 397 /* IMPLICIT tagged simple type */
 398 # define ASN1_IMP(stname, field, type, tag) ASN1_IMP_EX(stname, field, type, tag, 0)
 399
 400 /* IMPLICIT tagged OPTIONAL simple type */
 401 # define ASN1_IMP_OPT(stname, field, type, tag) ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_OPTIONAL)
 402
 403 /* Same as above but EXPLICIT */
 404
 405 # define ASN1_EXP(stname, field, type, tag) ASN1_EXP_EX(stname, field, type, tag, 0)
 406 # define ASN1_EXP_OPT(stname, field, type, tag) ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_OPTIONAL)
 407
 408 /* SEQUENCE OF type */
 409 # define ASN1_SEQUENCE_OF(stname, field, type) \
 410                 ASN1_EX_TYPE(ASN1_TFLG_SEQUENCE_OF, 0, stname, field, type)
 411
 412 /* OPTIONAL SEQUENCE OF */
 413 # define ASN1_SEQUENCE_OF_OPT(stname, field, type) \
 414                 ASN1_EX_TYPE(ASN1_TFLG_SEQUENCE_OF|ASN1_TFLG_OPTIONAL, 0, stname, field, type)
 415
 416 /* Same as above but for SET OF */
 417
 418 # define ASN1_SET_OF(stname, field, type) \
 419                 ASN1_EX_TYPE(ASN1_TFLG_SET_OF, 0, stname, field, type)
 420
 421 # define ASN1_SET_OF_OPT(stname, field, type) \
 422                 ASN1_EX_TYPE(ASN1_TFLG_SET_OF|ASN1_TFLG_OPTIONAL, 0, stname, field, type)
 423
 424 /* Finally compound types of SEQUENCE, SET, IMPLICIT, EXPLICIT and OPTIONAL */
 425
 426 # define ASN1_IMP_SET_OF(stname, field, type, tag) \
 427                         ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_SET_OF)
 428
 429 # define ASN1_EXP_SET_OF(stname, field, type, tag) \
 430                         ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_SET_OF)
 431
 432 # define ASN1_IMP_SET_OF_OPT(stname, field, type, tag) \
 433                         ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_SET_OF|ASN1_TFLG_OPTIONAL)
 434
 435 # define ASN1_EXP_SET_OF_OPT(stname, field, type, tag) \
 436                         ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_SET_OF|ASN1_TFLG_OPTIONAL)
 437
 438 # define ASN1_IMP_SEQUENCE_OF(stname, field, type, tag) \
 439                         ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_SEQUENCE_OF)
 440
 441 # define ASN1_IMP_SEQUENCE_OF_OPT(stname, field, type, tag) \
 442                         ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_SEQUENCE_OF|ASN1_TFLG_OPTIONAL)
 443
 444 # define ASN1_EXP_SEQUENCE_OF(stname, field, type, tag) \
 445                         ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_SEQUENCE_OF)
 446
 447 # define ASN1_EXP_SEQUENCE_OF_OPT(stname, field, type, tag) \
 448                         ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_SEQUENCE_OF|ASN1_TFLG_OPTIONAL)
 449
 450 /* EXPLICIT using indefinite length constructed form */
 451 # define ASN1_NDEF_EXP(stname, field, type, tag) \
 452                         ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_NDEF)
 453
 454 /* EXPLICIT OPTIONAL using indefinite length constructed form */
 455 # define ASN1_NDEF_EXP_OPT(stname, field, type, tag) \
 456                         ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_OPTIONAL|ASN1_TFLG_NDEF)
 457
 458 /* Macros for the ASN1_ADB structure */
 459
 460 # define ASN1_ADB(name) \
 461         static const ASN1_ADB_TABLE name##_adbtbl[]
 462
 463 # ifndef OPENSSL_EXPORT_VAR_AS_FUNCTION
 464
 465 #  define ASN1_ADB_END(name, flags, field, app_table, def, none) \
 466         ;\
 467         static const ASN1_ADB name##_adb = {\
 468                 flags,\
 469                 offsetof(name, field),\
 470                 app_table,\
 471                 name##_adbtbl,\
 472                 sizeof(name##_adbtbl) / sizeof(ASN1_ADB_TABLE),\
 473                 def,\
 474                 none\
 475         }
 476
 477 # else
 478
 479 #  define ASN1_ADB_END(name, flags, field, app_table, def, none) \
 480         ;\
 481         static const ASN1_ITEM *name##_adb(void) \
 482         { \
 483         static const ASN1_ADB internal_adb = \
 484                 {\
 485                 flags,\
 486                 offsetof(name, field),\
 487                 app_table,\
 488                 name##_adbtbl,\
 489                 sizeof(name##_adbtbl) / sizeof(ASN1_ADB_TABLE),\
 490                 def,\
 491                 none\
 492                 }; \
 493                 return (const ASN1_ITEM *) &internal_adb; \
 494         } \
 495         void dummy_function(void)
 496
 497 # endif
 498
 499 # define ADB_ENTRY(val, template) {val, template}
 500
 501 # define ASN1_ADB_TEMPLATE(name) \
 502         static const ASN1_TEMPLATE name##_tt
 503
 504 /*
 505  * This is the ASN1 template structure that defines a wrapper round the
 506  * actual type. It determines the actual position of the field in the value
 507  * structure, various flags such as OPTIONAL and the field name.
 508  */
 509
 510 struct ASN1_TEMPLATE_st {
 511     unsigned long flags;        /* Various flags */
 512     long tag;                   /* tag, not used if no tagging */
 513     unsigned long offset;       /* Offset of this field in structure */
 514 # ifndef NO_ASN1_FIELD_NAMES
 515     const char *field_name;     /* Field name */
 516 # endif
 517     ASN1_ITEM_EXP *item;        /* Relevant ASN1_ITEM or ASN1_ADB */
 518 };
 519
 520 /* Macro to extract ASN1_ITEM and ASN1_ADB pointer from ASN1_TEMPLATE */
 521
 522 # define ASN1_TEMPLATE_item(t) (t->item_ptr)
 523 # define ASN1_TEMPLATE_adb(t) (t->item_ptr)
 524
 525 typedef struct ASN1_ADB_TABLE_st ASN1_ADB_TABLE;
 526 typedef struct ASN1_ADB_st ASN1_ADB;
 527
 528 struct ASN1_ADB_st {
 529     unsigned long flags;        /* Various flags */
 530     unsigned long offset;       /* Offset of selector field */
 531     STACK_OF(ASN1_ADB_TABLE) **app_items; /* Application defined items */
 532     const ASN1_ADB_TABLE *tbl;  /* Table of possible types */
 533     long tblcount;              /* Number of entries in tbl */
 534     const ASN1_TEMPLATE *default_tt; /* Type to use if no match */
 535     const ASN1_TEMPLATE *null_tt; /* Type to use if selector is NULL */
 536 };
 537
 538 struct ASN1_ADB_TABLE_st {
 539     long value;                 /* NID for an object or value for an int */
 540     const ASN1_TEMPLATE tt;     /* item for this value */
 541 };
 542
 543 /* template flags */
 544
 545 /* Field is optional */
 546 # define ASN1_TFLG_OPTIONAL      (0x1)
 547
 548 /* Field is a SET OF */
 549 # define ASN1_TFLG_SET_OF        (0x1 << 1)
 550
 551 /* Field is a SEQUENCE OF */
 552 # define ASN1_TFLG_SEQUENCE_OF   (0x2 << 1)
 553
 554 /*
 555  * Special case: this refers to a SET OF that will be sorted into DER order
 556  * when encoded *and* the corresponding STACK will be modified to match the
 557  * new order.
 558  */
 559 # define ASN1_TFLG_SET_ORDER     (0x3 << 1)
 560
 561 /* Mask for SET OF or SEQUENCE OF */
 562 # define ASN1_TFLG_SK_MASK       (0x3 << 1)
 563
 564 /*
 565  * These flags mean the tag should be taken from the tag field. If EXPLICIT
 566  * then the underlying type is used for the inner tag.
 567  */
 568
 569 /* IMPLICIT tagging */
 570 # define ASN1_TFLG_IMPTAG        (0x1 << 3)
 571
 572 /* EXPLICIT tagging, inner tag from underlying type */
 573 # define ASN1_TFLG_EXPTAG        (0x2 << 3)
 574
 575 # define ASN1_TFLG_TAG_MASK      (0x3 << 3)
 576
 577 /* context specific IMPLICIT */
 578 # define ASN1_TFLG_IMPLICIT      ASN1_TFLG_IMPTAG|ASN1_TFLG_CONTEXT
 579
 580 /* context specific EXPLICIT */
 581 # define ASN1_TFLG_EXPLICIT      ASN1_TFLG_EXPTAG|ASN1_TFLG_CONTEXT
 582
 583 /*
 584  * If tagging is in force these determine the type of tag to use. Otherwise
 585  * the tag is determined by the underlying type. These values reflect the
 586  * actual octet format.
 587  */
 588
 589 /* Universal tag */
 590 # define ASN1_TFLG_UNIVERSAL     (0x0<<6)
 591 /* Application tag */
 592 # define ASN1_TFLG_APPLICATION   (0x1<<6)
 593 /* Context specific tag */
 594 # define ASN1_TFLG_CONTEXT       (0x2<<6)
 595 /* Private tag */
 596 # define ASN1_TFLG_PRIVATE       (0x3<<6)
 597
 598 # define ASN1_TFLG_TAG_CLASS     (0x3<<6)
 599
 600 /*
 601  * These are for ANY DEFINED BY type. In this case the 'item' field points to
 602  * an ASN1_ADB structure which contains a table of values to decode the
 603  * relevant type
 604  */
 605
 606 # define ASN1_TFLG_ADB_MASK      (0x3<<8)
 607
 608 # define ASN1_TFLG_ADB_OID       (0x1<<8)
 609
 610 # define ASN1_TFLG_ADB_INT       (0x1<<9)
 611
 612 /*
 613  * This flag when present in a SEQUENCE OF, SET OF or EXPLICIT causes
 614  * indefinite length constructed encoding to be used if required.
 615  */
 616
 617 # define ASN1_TFLG_NDEF          (0x1<<11)
 618
 619 /* This is the actual ASN1 item itself */
 620
 621 struct ASN1_ITEM_st {
 622     char itype;                 /* The item type, primitive, SEQUENCE, CHOICE
 623                                  * or extern */
 624     long utype;                 /* underlying type */
 625     const ASN1_TEMPLATE *templates; /* If SEQUENCE or CHOICE this contains
 626                                      * the contents */
 627     long tcount;                /* Number of templates if SEQUENCE or CHOICE */
 628     const void *funcs;          /* functions that handle this type */
 629     long size;                  /* Structure size (usually) */
 630 # ifndef NO_ASN1_FIELD_NAMES
 631     const char *sname;          /* Structure name */
 632 # endif
 633 };
 634
 635 /*-
 636  * These are values for the itype field and
 637  * determine how the type is interpreted.
 638  *
 639  * For PRIMITIVE types the underlying type
 640  * determines the behaviour if items is NULL.
 641  *
 642  * Otherwise templates must contain a single
 643  * template and the type is treated in the
 644  * same way as the type specified in the template.
 645  *
 646  * For SEQUENCE types the templates field points
 647  * to the members, the size field is the
 648  * structure size.
 649  *
 650  * For CHOICE types the templates field points
 651  * to each possible member (typically a union)
 652  * and the 'size' field is the offset of the
 653  * selector.
 654  *
 655  * The 'funcs' field is used for application
 656  * specific functions.
 657  *
 658  * The EXTERN type uses a new style d2i/i2d.
 659  * The new style should be used where possible
 660  * because it avoids things like the d2i IMPLICIT
 661  * hack.
 662  *
 663  * MSTRING is a multiple string type, it is used
 664  * for a CHOICE of character strings where the
 665  * actual strings all occupy an ASN1_STRING
 666  * structure. In this case the 'utype' field
 667  * has a special meaning, it is used as a mask
 668  * of acceptable types using the B_ASN1 constants.
 669  *
 670  * NDEF_SEQUENCE is the same as SEQUENCE except
 671  * that it will use indefinite length constructed
 672  * encoding if requested.
 673  *
 674  */
 675
 676 # define ASN1_ITYPE_PRIMITIVE            0x0
 677
 678 # define ASN1_ITYPE_SEQUENCE             0x1
 679
 680 # define ASN1_ITYPE_CHOICE               0x2
 681
 682 # define ASN1_ITYPE_EXTERN               0x4
 683
 684 # define ASN1_ITYPE_MSTRING              0x5
 685
 686 # define ASN1_ITYPE_NDEF_SEQUENCE        0x6
 687
 688 /*
 689  * Cache for ASN1 tag and length, so we don't keep re-reading it for things
 690  * like CHOICE
 691  */
 692
 693 struct ASN1_TLC_st {
 694     char valid;                 /* Values below are valid */
 695     int ret;                    /* return value */
 696     long plen;                  /* length */
 697     int ptag;                   /* class value */
 698     int pclass;                 /* class value */
 699     int hdrlen;                 /* header length */
 700 };
 701
 702 /* Typedefs for ASN1 function pointers */
 703
 704 typedef ASN1_VALUE *ASN1_new_func(void);
 705 typedef void ASN1_free_func(ASN1_VALUE *a);
 706 typedef ASN1_VALUE *ASN1_d2i_func(ASN1_VALUE **a, const unsigned char **in,
 707                                   long length);
 708 typedef int ASN1_i2d_func(ASN1_VALUE *a, unsigned char **in);
 709
 710 typedef int ASN1_ex_d2i(ASN1_VALUE **pval, const unsigned char **in, long len,
 711                         const ASN1_ITEM *it, int tag, int aclass, char opt,
 712                         ASN1_TLC *ctx);
 713
 714 typedef int ASN1_ex_i2d(ASN1_VALUE **pval, unsigned char **out,
 715                         const ASN1_ITEM *it, int tag, int aclass);
 716 typedef int ASN1_ex_new_func(ASN1_VALUE **pval, const ASN1_ITEM *it);
 717 typedef void ASN1_ex_free_func(ASN1_VALUE **pval, const ASN1_ITEM *it);
 718
 719 typedef int ASN1_ex_print_func(BIO *out, ASN1_VALUE **pval,
 720                                int indent, const char *fname,
 721                                const ASN1_PCTX *pctx);
 722
 723 typedef int ASN1_primitive_i2c(ASN1_VALUE **pval, unsigned char *cont,
 724                                int *putype, const ASN1_ITEM *it);
 725 typedef int ASN1_primitive_c2i(ASN1_VALUE **pval, const unsigned char *cont,
 726                                int len, int utype, char *free_cont,
 727                                const ASN1_ITEM *it);
 728 typedef int ASN1_primitive_print(BIO *out, ASN1_VALUE **pval,
 729                                  const ASN1_ITEM *it, int indent,
 730                                  const ASN1_PCTX *pctx);
 731
 732 typedef struct ASN1_EXTERN_FUNCS_st {
 733     void *app_data;
 734     ASN1_ex_new_func *asn1_ex_new;
 735     ASN1_ex_free_func *asn1_ex_free;
 736     ASN1_ex_free_func *asn1_ex_clear;
 737     ASN1_ex_d2i *asn1_ex_d2i;
 738     ASN1_ex_i2d *asn1_ex_i2d;
 739     ASN1_ex_print_func *asn1_ex_print;
 740 } ASN1_EXTERN_FUNCS;
 741
 742 typedef struct ASN1_PRIMITIVE_FUNCS_st {
 743     void *app_data;
 744     unsigned long flags;
 745     ASN1_ex_new_func *prim_new;
 746     ASN1_ex_free_func *prim_free;
 747     ASN1_ex_free_func *prim_clear;
 748     ASN1_primitive_c2i *prim_c2i;
 749     ASN1_primitive_i2c *prim_i2c;
 750     ASN1_primitive_print *prim_print;
 751 } ASN1_PRIMITIVE_FUNCS;
 752
 753 /*
 754  * This is the ASN1_AUX structure: it handles various miscellaneous
 755  * requirements. For example the use of reference counts and an informational
 756  * callback. The "informational callback" is called at various points during
 757  * the ASN1 encoding and decoding. It can be used to provide minor
 758  * customisation of the structures used. This is most useful where the
 759  * supplied routines *almost* do the right thing but need some extra help at
 760  * a few points. If the callback returns zero then it is assumed a fatal
 761  * error has occurred and the main operation should be abandoned. If major
 762  * changes in the default behaviour are required then an external type is
 763  * more appropriate.
 764  */
 765
 766 typedef int ASN1_aux_cb(int operation, ASN1_VALUE **in, const ASN1_ITEM *it,
 767                         void *exarg);
 768
 769 typedef struct ASN1_AUX_st {
 770     void *app_data;
 771     int flags;
 772     int ref_offset;             /* Offset of reference value */
 773     int ref_lock;               /* Lock type to use */
 774     ASN1_aux_cb *asn1_cb;
 775     int enc_offset;             /* Offset of ASN1_ENCODING structure */
 776 } ASN1_AUX;
 777
 778 /* For print related callbacks exarg points to this structure */
 779 typedef struct ASN1_PRINT_ARG_st {
 780     BIO *out;
 781     int indent;
 782     const ASN1_PCTX *pctx;
 783 } ASN1_PRINT_ARG;
 784
 785 /* For streaming related callbacks exarg points to this structure */
 786 typedef struct ASN1_STREAM_ARG_st {
 787     /* BIO to stream through */
 788     BIO *out;
 789     /* BIO with filters appended */
 790     BIO *ndef_bio;
 791     /* Streaming I/O boundary */
 792     unsigned char **boundary;
 793 } ASN1_STREAM_ARG;
 794
 795 /* Flags in ASN1_AUX */
 796
 797 /* Use a reference count */
 798 # define ASN1_AFLG_REFCOUNT      1
 799 /* Save the encoding of structure (useful for signatures) */
 800 # define ASN1_AFLG_ENCODING      2
 801 /* The Sequence length is invalid */
 802 # define ASN1_AFLG_BROKEN        4
 803
 804 /* operation values for asn1_cb */
 805
 806 # define ASN1_OP_NEW_PRE         0
 807 # define ASN1_OP_NEW_POST        1
 808 # define ASN1_OP_FREE_PRE        2
 809 # define ASN1_OP_FREE_POST       3
 810 # define ASN1_OP_D2I_PRE         4
 811 # define ASN1_OP_D2I_POST        5
 812 # define ASN1_OP_I2D_PRE         6
 813 # define ASN1_OP_I2D_POST        7
 814 # define ASN1_OP_PRINT_PRE       8
 815 # define ASN1_OP_PRINT_POST      9
 816 # define ASN1_OP_STREAM_PRE      10
 817 # define ASN1_OP_STREAM_POST     11
 818 # define ASN1_OP_DETACHED_PRE    12
 819 # define ASN1_OP_DETACHED_POST   13
 820
 821 /* Macro to implement a primitive type */
 822 # define IMPLEMENT_ASN1_TYPE(stname) IMPLEMENT_ASN1_TYPE_ex(stname, stname, 0)
 823 # define IMPLEMENT_ASN1_TYPE_ex(itname, vname, ex) \
 824                                 ASN1_ITEM_start(itname) \
 825                                         ASN1_ITYPE_PRIMITIVE, V_##vname, NULL, 0, NULL, ex, #itname \
 826                                 ASN1_ITEM_end(itname)
 827
 828 /* Macro to implement a multi string type */
 829 # define IMPLEMENT_ASN1_MSTRING(itname, mask) \
 830                                 ASN1_ITEM_start(itname) \
 831                                         ASN1_ITYPE_MSTRING, mask, NULL, 0, NULL, sizeof(ASN1_STRING), #itname \
 832                                 ASN1_ITEM_end(itname)
 833
 834 # define IMPLEMENT_EXTERN_ASN1(sname, tag, fptrs) \
 835         ASN1_ITEM_start(sname) \
 836                 ASN1_ITYPE_EXTERN, \
 837                 tag, \
 838                 NULL, \
 839                 0, \
 840                 &fptrs, \
 841                 0, \
 842                 #sname \
 843         ASN1_ITEM_end(sname)
 844
 845 /* Macro to implement standard functions in terms of ASN1_ITEM structures */
 846
 847 # define IMPLEMENT_ASN1_FUNCTIONS(stname) IMPLEMENT_ASN1_FUNCTIONS_fname(stname, stname, stname)
 848
 849 # define IMPLEMENT_ASN1_FUNCTIONS_name(stname, itname) IMPLEMENT_ASN1_FUNCTIONS_fname(stname, itname, itname)
 850
 851 # define IMPLEMENT_ASN1_FUNCTIONS_ENCODE_name(stname, itname) \
 852                         IMPLEMENT_ASN1_FUNCTIONS_ENCODE_fname(stname, itname, itname)
 853
 854 # define IMPLEMENT_STATIC_ASN1_ALLOC_FUNCTIONS(stname) \
 855                 IMPLEMENT_ASN1_ALLOC_FUNCTIONS_pfname(static, stname, stname, stname)
 856
 857 # define IMPLEMENT_ASN1_ALLOC_FUNCTIONS(stname) \
 858                 IMPLEMENT_ASN1_ALLOC_FUNCTIONS_fname(stname, stname, stname)
 859
 860 # define IMPLEMENT_ASN1_ALLOC_FUNCTIONS_pfname(pre, stname, itname, fname) \
 861         pre stname *fname##_new(void) \
 862         { \
 863                 return (stname *)ASN1_item_new(ASN1_ITEM_rptr(itname)); \
 864         } \
 865         pre void fname##_free(stname *a) \
 866         { \
 867                 ASN1_item_free((ASN1_VALUE *)a, ASN1_ITEM_rptr(itname)); \
 868         }
 869
 870 # define IMPLEMENT_ASN1_ALLOC_FUNCTIONS_fname(stname, itname, fname) \
 871         stname *fname##_new(void) \
 872         { \
 873                 return (stname *)ASN1_item_new(ASN1_ITEM_rptr(itname)); \
 874         } \
 875         void fname##_free(stname *a) \
 876         { \
 877                 ASN1_item_free((ASN1_VALUE *)a, ASN1_ITEM_rptr(itname)); \
 878         }
 879
 880 # define IMPLEMENT_ASN1_FUNCTIONS_fname(stname, itname, fname) \
 881         IMPLEMENT_ASN1_ENCODE_FUNCTIONS_fname(stname, itname, fname) \
 882         IMPLEMENT_ASN1_ALLOC_FUNCTIONS_fname(stname, itname, fname)
 883
 884 # define IMPLEMENT_ASN1_ENCODE_FUNCTIONS_fname(stname, itname, fname) \
 885         stname *d2i_##fname(stname **a, const unsigned char **in, long len) \
 886         { \
 887                 return (stname *)ASN1_item_d2i((ASN1_VALUE **)a, in, len, ASN1_ITEM_rptr(itname));\
 888         } \
 889         int i2d_##fname(stname *a, unsigned char **out) \
 890         { \
 891                 return ASN1_item_i2d((ASN1_VALUE *)a, out, ASN1_ITEM_rptr(itname));\
 892         }
 893
 894 # define IMPLEMENT_ASN1_NDEF_FUNCTION(stname) \
 895         int i2d_##stname##_NDEF(stname *a, unsigned char **out) \
 896         { \
 897                 return ASN1_item_ndef_i2d((ASN1_VALUE *)a, out, ASN1_ITEM_rptr(stname));\
 898         }
 899
 900 # define IMPLEMENT_STATIC_ASN1_ENCODE_FUNCTIONS(stname) \
 901         static stname *d2i_##stname(stname **a, \
 902                                    const unsigned char **in, long len) \
 903         { \
 904                 return (stname *)ASN1_item_d2i((ASN1_VALUE **)a, in, len, \
 905                                                ASN1_ITEM_rptr(stname)); \
 906         } \
 907         static int i2d_##stname(stname *a, unsigned char **out) \
 908         { \
 909                 return ASN1_item_i2d((ASN1_VALUE *)a, out, \
 910                                      ASN1_ITEM_rptr(stname)); \
 911         }
 912
 913 /*
 914  * This includes evil casts to remove const: they will go away when full ASN1
 915  * constification is done.
 916  */
 917 # define IMPLEMENT_ASN1_ENCODE_FUNCTIONS_const_fname(stname, itname, fname) \
 918         stname *d2i_##fname(stname **a, const unsigned char **in, long len) \
 919         { \
 920                 return (stname *)ASN1_item_d2i((ASN1_VALUE **)a, in, len, ASN1_ITEM_rptr(itname));\
 921         } \
 922         int i2d_##fname(const stname *a, unsigned char **out) \
 923         { \
 924                 return ASN1_item_i2d((ASN1_VALUE *)a, out, ASN1_ITEM_rptr(itname));\
 925         }
 926
 927 # define IMPLEMENT_ASN1_DUP_FUNCTION(stname) \
 928         stname * stname##_dup(stname *x) \
 929         { \
 930         return ASN1_item_dup(ASN1_ITEM_rptr(stname), x); \
 931         }
 932
 933 # define IMPLEMENT_ASN1_PRINT_FUNCTION(stname) \
 934         IMPLEMENT_ASN1_PRINT_FUNCTION_fname(stname, stname, stname)
 935
 936 # define IMPLEMENT_ASN1_PRINT_FUNCTION_fname(stname, itname, fname) \
 937         int fname##_print_ctx(BIO *out, stname *x, int indent, \
 938                                                 const ASN1_PCTX *pctx) \
 939         { \
 940                 return ASN1_item_print(out, (ASN1_VALUE *)x, indent, \
 941                         ASN1_ITEM_rptr(itname), pctx); \
 942         }
 943
 944 # define IMPLEMENT_ASN1_FUNCTIONS_const(name) \
 945                 IMPLEMENT_ASN1_FUNCTIONS_const_fname(name, name, name)
 946
 947 # define IMPLEMENT_ASN1_FUNCTIONS_const_fname(stname, itname, fname) \
 948         IMPLEMENT_ASN1_ENCODE_FUNCTIONS_const_fname(stname, itname, fname) \
 949         IMPLEMENT_ASN1_ALLOC_FUNCTIONS_fname(stname, itname, fname)
 950
 951 /* external definitions for primitive types */
 952
 953 DECLARE_ASN1_ITEM(ASN1_BOOLEAN)
 954 DECLARE_ASN1_ITEM(ASN1_TBOOLEAN)
 955 DECLARE_ASN1_ITEM(ASN1_FBOOLEAN)
 956 DECLARE_ASN1_ITEM(ASN1_SEQUENCE)
 957 DECLARE_ASN1_ITEM(CBIGNUM)
 958 DECLARE_ASN1_ITEM(BIGNUM)
 959 DECLARE_ASN1_ITEM(LONG)
 960 DECLARE_ASN1_ITEM(ZLONG)
 961
 962 DECLARE_STACK_OF(ASN1_VALUE)
 963
 964 /* Functions used internally by the ASN1 code */
 965
 966 int ASN1_item_ex_new(ASN1_VALUE **pval, const ASN1_ITEM *it);
 967 void ASN1_item_ex_free(ASN1_VALUE **pval, const ASN1_ITEM *it);
 968
 969 int ASN1_item_ex_d2i(ASN1_VALUE **pval, const unsigned char **in, long len,
 970                      const ASN1_ITEM *it, int tag, int aclass, char opt,
 971                      ASN1_TLC *ctx);
 972
 973 int ASN1_item_ex_i2d(ASN1_VALUE **pval, unsigned char **out,
 974                      const ASN1_ITEM *it, int tag, int aclass);
 975
 976 #ifdef  __cplusplus
 977 }
 978 #endif
 979 #endif