1/* asn1t.h */ 2/* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL 3 * project 2000. 4 */ 5/* ==================================================================== 6 * Copyright (c) 2000 The OpenSSL Project. All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in 17 * the documentation and/or other materials provided with the 18 * distribution. 19 * 20 * 3. All advertising materials mentioning features or use of this 21 * software must display the following acknowledgment: 22 * "This product includes software developed by the OpenSSL Project 23 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" 24 * 25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 26 * endorse or promote products derived from this software without 27 * prior written permission. For written permission, please contact 28 * licensing@OpenSSL.org. 29 * 30 * 5. Products derived from this software may not be called "OpenSSL" 31 * nor may "OpenSSL" appear in their names without prior written 32 * permission of the OpenSSL Project. 33 * 34 * 6. Redistributions of any form whatsoever must retain the following 35 * acknowledgment: 36 * "This product includes software developed by the OpenSSL Project 37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" 38 * 39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 50 * OF THE POSSIBILITY OF SUCH DAMAGE. 51 * ==================================================================== 52 * 53 * This product includes cryptographic software written by Eric Young 54 * (eay@cryptsoft.com). This product includes software written by Tim 55 * Hudson (tjh@cryptsoft.com). 56 * 57 */ 58#ifndef HEADER_ASN1T_H 59#define HEADER_ASN1T_H 60 61#include <stddef.h> 62#include <stdlib.h> 63#include <time.h> 64#include "cs-asn1.h" 65 66#if 0 67#ifdef OPENSSL_BUILD_SHLIBCRYPTO 68# undef OPENSSL_EXTERN 69# define OPENSSL_EXTERN OPENSSL_EXPORT 70#endif 71#endif 72#define OPENSSL_EXTERN extern 73#define OPENSSL_GLOBAL 74 75/* ASN1 template defines, structures and functions */ 76 77#ifdef __cplusplus 78extern "C" { 79#endif 80 81 82#ifndef OPENSSL_EXPORT_VAR_AS_FUNCTION 83 84/* Macro to obtain ASN1_ADB pointer from a type (only used internally) */ 85#define ASN1_ADB_ptr(iptr) ((const ASN1_ADB *)(iptr)) 86 87 88/* Macros for start and end of ASN1_ITEM definition */ 89 90#define ASN1_ITEM_start(itname) \ 91 OPENSSL_GLOBAL const ASN1_ITEM itname##_it = { 92 93#define ASN1_ITEM_end(itname) \ 94 }; 95 96#else 97 98/* Macro to obtain ASN1_ADB pointer from a type (only used internally) */ 99#define ASN1_ADB_ptr(iptr) ((const ASN1_ADB *)(iptr())) 100 101 102/* Macros for start and end of ASN1_ITEM definition */ 103 104#define ASN1_ITEM_start(itname) \ 105 const ASN1_ITEM * itname##_it(void) \ 106 { \ 107 static const ASN1_ITEM local_it = { 108 109#define ASN1_ITEM_end(itname) \ 110 }; \ 111 return &local_it; \ 112 } 113 114#endif 115 116 117/* Macros to aid ASN1 template writing */ 118 119#define ASN1_ITEM_TEMPLATE(tname) \ 120 static const ASN1_TEMPLATE tname##_item_tt 121 122#define ASN1_ITEM_TEMPLATE_END(tname) \ 123 ;\ 124 ASN1_ITEM_start(tname) \ 125 ASN1_ITYPE_PRIMITIVE,\ 126 -1,\ 127 &tname##_item_tt,\ 128 0,\ 129 NULL,\ 130 0,\ 131 #tname \ 132 ASN1_ITEM_end(tname) 133 134 135/* This is a ASN1 type which just embeds a template */ 136 137/* This pair helps declare a SEQUENCE. We can do: 138 * 139 * ASN1_SEQUENCE(stname) = { 140 * ... SEQUENCE components ... 141 * } ASN1_SEQUENCE_END(stname) 142 * 143 * This will produce an ASN1_ITEM called stname_it 144 * for a structure called stname. 145 * 146 * If you want the same structure but a different 147 * name then use: 148 * 149 * ASN1_SEQUENCE(itname) = { 150 * ... SEQUENCE components ... 151 * } ASN1_SEQUENCE_END_name(stname, itname) 152 * 153 * This will create an item called itname_it using 154 * a structure called stname. 155 */ 156 157#define ASN1_SEQUENCE(tname) \ 158 static const ASN1_TEMPLATE tname##_seq_tt[] 159 160#define ASN1_SEQUENCE_END(stname) ASN1_SEQUENCE_END_name(stname, stname) 161 162#define ASN1_SEQUENCE_END_name(stname, tname) \ 163 ;\ 164 ASN1_ITEM_start(tname) \ 165 ASN1_ITYPE_SEQUENCE,\ 166 V_ASN1_SEQUENCE,\ 167 tname##_seq_tt,\ 168 sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\ 169 NULL,\ 170 sizeof(stname),\ 171 #stname \ 172 ASN1_ITEM_end(tname) 173 174#define ASN1_NDEF_SEQUENCE(tname) \ 175 ASN1_SEQUENCE(tname) 176 177#define ASN1_NDEF_SEQUENCE_cb(tname, cb) \ 178 ASN1_SEQUENCE_cb(tname, cb) 179 180#define ASN1_SEQUENCE_cb(tname, cb) \ 181 static const ASN1_AUX tname##_aux = {NULL, 0, 0, 0, cb, 0}; \ 182 ASN1_SEQUENCE(tname) 183 184#define ASN1_BROKEN_SEQUENCE(tname) \ 185 static const ASN1_AUX tname##_aux = {NULL, ASN1_AFLG_BROKEN, 0, 0, 0, 0}; \ 186 ASN1_SEQUENCE(tname) 187 188#define ASN1_SEQUENCE_ref(tname, cb, lck) \ 189 static const ASN1_AUX tname##_aux = {NULL, ASN1_AFLG_REFCOUNT, offsetof(tname, references), lck, cb, 0}; \ 190 ASN1_SEQUENCE(tname) 191 192#define ASN1_SEQUENCE_enc(tname, enc, cb) \ 193 static const ASN1_AUX tname##_aux = {NULL, ASN1_AFLG_ENCODING, 0, 0, cb, offsetof(tname, enc)}; \ 194 ASN1_SEQUENCE(tname) 195 196#define ASN1_NDEF_SEQUENCE_END(tname) \ 197 ;\ 198 ASN1_ITEM_start(tname) \ 199 ASN1_ITYPE_NDEF_SEQUENCE,\ 200 V_ASN1_SEQUENCE,\ 201 tname##_seq_tt,\ 202 sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\ 203 NULL,\ 204 sizeof(tname),\ 205 #tname \ 206 ASN1_ITEM_end(tname) 207 208#define ASN1_BROKEN_SEQUENCE_END(stname) ASN1_SEQUENCE_END_ref(stname, stname) 209 210#define ASN1_SEQUENCE_END_enc(stname, tname) ASN1_SEQUENCE_END_ref(stname, tname) 211 212#define ASN1_SEQUENCE_END_cb(stname, tname) ASN1_SEQUENCE_END_ref(stname, tname) 213 214#define ASN1_SEQUENCE_END_ref(stname, tname) \ 215 ;\ 216 ASN1_ITEM_start(tname) \ 217 ASN1_ITYPE_SEQUENCE,\ 218 V_ASN1_SEQUENCE,\ 219 tname##_seq_tt,\ 220 sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\ 221 &tname##_aux,\ 222 sizeof(stname),\ 223 #stname \ 224 ASN1_ITEM_end(tname) 225 226 227/* This pair helps declare a CHOICE type. We can do: 228 * 229 * ASN1_CHOICE(chname) = { 230 * ... CHOICE options ... 231 * ASN1_CHOICE_END(chname) 232 * 233 * This will produce an ASN1_ITEM called chname_it 234 * for a structure called chname. The structure 235 * definition must look like this: 236 * typedef struct { 237 * int type; 238 * union { 239 * ASN1_SOMETHING *opt1; 240 * ASN1_SOMEOTHER *opt2; 241 * } value; 242 * } chname; 243 * 244 * the name of the selector must be 'type'. 245 * to use an alternative selector name use the 246 * ASN1_CHOICE_END_selector() version. 247 */ 248 249#define ASN1_CHOICE(tname) \ 250 static const ASN1_TEMPLATE tname##_ch_tt[] 251 252#define ASN1_CHOICE_cb(tname, cb) \ 253 static const ASN1_AUX tname##_aux = {NULL, 0, 0, 0, cb, 0}; \ 254 ASN1_CHOICE(tname) 255 256#define ASN1_CHOICE_END(stname) ASN1_CHOICE_END_name(stname, stname) 257 258#define ASN1_CHOICE_END_name(stname, tname) ASN1_CHOICE_END_selector(stname, tname, type) 259 260#define ASN1_CHOICE_END_selector(stname, tname, selname) \ 261 ;\ 262 ASN1_ITEM_start(tname) \ 263 ASN1_ITYPE_CHOICE,\ 264 offsetof(stname,selname) ,\ 265 tname##_ch_tt,\ 266 sizeof(tname##_ch_tt) / sizeof(ASN1_TEMPLATE),\ 267 NULL,\ 268 sizeof(stname),\ 269 #stname \ 270 ASN1_ITEM_end(tname) 271 272#define ASN1_CHOICE_END_cb(stname, tname, selname) \ 273 ;\ 274 ASN1_ITEM_start(tname) \ 275 ASN1_ITYPE_CHOICE,\ 276 offsetof(stname,selname) ,\ 277 tname##_ch_tt,\ 278 sizeof(tname##_ch_tt) / sizeof(ASN1_TEMPLATE),\ 279 &tname##_aux,\ 280 sizeof(stname),\ 281 #stname \ 282 ASN1_ITEM_end(tname) 283 284/* This helps with the template wrapper form of ASN1_ITEM */ 285 286#define ASN1_EX_TEMPLATE_TYPE(flags, tag, name, type) { \ 287 (flags), (tag), 0,\ 288 #name, ASN1_ITEM_ref(type) } 289 290/* These help with SEQUENCE or CHOICE components */ 291 292/* used to declare other types */ 293 294#define ASN1_EX_TYPE(flags, tag, stname, field, type) { \ 295 (flags), (tag), offsetof(stname, field),\ 296 #field, ASN1_ITEM_ref(type) } 297 298/* used when the structure is combined with the parent */ 299 300#define ASN1_EX_COMBINE(flags, tag, type) { \ 301 (flags)|ASN1_TFLG_COMBINE, (tag), 0, NULL, ASN1_ITEM_ref(type) } 302 303/* implicit and explicit helper macros */ 304 305#define ASN1_IMP_EX(stname, field, type, tag, ex) \ 306 ASN1_EX_TYPE(ASN1_TFLG_IMPLICIT | ex, tag, stname, field, type) 307 308#define ASN1_EXP_EX(stname, field, type, tag, ex) \ 309 ASN1_EX_TYPE(ASN1_TFLG_EXPLICIT | ex, tag, stname, field, type) 310 311/* Any defined by macros: the field used is in the table itself */ 312 313#ifndef OPENSSL_EXPORT_VAR_AS_FUNCTION 314#define ASN1_ADB_OBJECT(tblname) { ASN1_TFLG_ADB_OID, -1, 0, #tblname, (const ASN1_ITEM *)&(tblname##_adb) } 315#define ASN1_ADB_INTEGER(tblname) { ASN1_TFLG_ADB_INT, -1, 0, #tblname, (const ASN1_ITEM *)&(tblname##_adb) } 316#else 317#define ASN1_ADB_OBJECT(tblname) { ASN1_TFLG_ADB_OID, -1, 0, #tblname, tblname##_adb } 318#define ASN1_ADB_INTEGER(tblname) { ASN1_TFLG_ADB_INT, -1, 0, #tblname, tblname##_adb } 319#endif 320/* Plain simple type */ 321#define ASN1_SIMPLE(stname, field, type) ASN1_EX_TYPE(0,0, stname, field, type) 322 323/* OPTIONAL simple type */ 324#define ASN1_OPT(stname, field, type) ASN1_EX_TYPE(ASN1_TFLG_OPTIONAL, 0, stname, field, type) 325 326/* IMPLICIT tagged simple type */ 327#define ASN1_IMP(stname, field, type, tag) ASN1_IMP_EX(stname, field, type, tag, 0) 328 329/* IMPLICIT tagged OPTIONAL simple type */ 330#define ASN1_IMP_OPT(stname, field, type, tag) ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_OPTIONAL) 331 332/* Same as above but EXPLICIT */ 333 334#define ASN1_EXP(stname, field, type, tag) ASN1_EXP_EX(stname, field, type, tag, 0) 335#define ASN1_EXP_OPT(stname, field, type, tag) ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_OPTIONAL) 336 337/* SEQUENCE OF type */ 338#define ASN1_SEQUENCE_OF(stname, field, type) \ 339 ASN1_EX_TYPE(ASN1_TFLG_SEQUENCE_OF, 0, stname, field, type) 340 341/* OPTIONAL SEQUENCE OF */ 342#define ASN1_SEQUENCE_OF_OPT(stname, field, type) \ 343 ASN1_EX_TYPE(ASN1_TFLG_SEQUENCE_OF|ASN1_TFLG_OPTIONAL, 0, stname, field, type) 344 345/* Same as above but for SET OF */ 346 347#define ASN1_SET_OF(stname, field, type) \ 348 ASN1_EX_TYPE(ASN1_TFLG_SET_OF, 0, stname, field, type) 349 350#define ASN1_SET_OF_OPT(stname, field, type) \ 351 ASN1_EX_TYPE(ASN1_TFLG_SET_OF|ASN1_TFLG_OPTIONAL, 0, stname, field, type) 352 353/* Finally compound types of SEQUENCE, SET, IMPLICIT, EXPLICIT and OPTIONAL */ 354 355#define ASN1_IMP_SET_OF(stname, field, type, tag) \ 356 ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_SET_OF) 357 358#define ASN1_EXP_SET_OF(stname, field, type, tag) \ 359 ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_SET_OF) 360 361#define ASN1_IMP_SET_OF_OPT(stname, field, type, tag) \ 362 ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_SET_OF|ASN1_TFLG_OPTIONAL) 363 364#define ASN1_EXP_SET_OF_OPT(stname, field, type, tag) \ 365 ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_SET_OF|ASN1_TFLG_OPTIONAL) 366 367#define ASN1_IMP_SEQUENCE_OF(stname, field, type, tag) \ 368 ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_SEQUENCE_OF) 369 370#define ASN1_IMP_SEQUENCE_OF_OPT(stname, field, type, tag) \ 371 ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_SEQUENCE_OF|ASN1_TFLG_OPTIONAL) 372 373#define ASN1_EXP_SEQUENCE_OF(stname, field, type, tag) \ 374 ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_SEQUENCE_OF) 375 376#define ASN1_EXP_SEQUENCE_OF_OPT(stname, field, type, tag) \ 377 ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_SEQUENCE_OF|ASN1_TFLG_OPTIONAL) 378 379/* EXPLICIT using indefinite length constructed form */ 380#define ASN1_NDEF_EXP(stname, field, type, tag) \ 381 ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_NDEF) 382 383/* EXPLICIT OPTIONAL using indefinite length constructed form */ 384#define ASN1_NDEF_EXP_OPT(stname, field, type, tag) \ 385 ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_OPTIONAL|ASN1_TFLG_NDEF) 386 387/* Macros for the ASN1_ADB structure */ 388 389#define ASN1_ADB(name) \ 390 static const ASN1_ADB_TABLE name##_adbtbl[] 391 392#ifndef OPENSSL_EXPORT_VAR_AS_FUNCTION 393 394#define ASN1_ADB_END(name, flags, field, app_table, def, none) \ 395 ;\ 396 static const ASN1_ADB name##_adb = {\ 397 flags,\ 398 offsetof(name, field),\ 399 app_table,\ 400 name##_adbtbl,\ 401 sizeof(name##_adbtbl) / sizeof(ASN1_ADB_TABLE),\ 402 def,\ 403 none\ 404 } 405 406#else 407 408#define ASN1_ADB_END(name, flags, field, app_table, def, none) \ 409 ;\ 410 static const ASN1_ITEM *name##_adb(void) \ 411 { \ 412 static const ASN1_ADB internal_adb = \ 413 {\ 414 flags,\ 415 offsetof(name, field),\ 416 app_table,\ 417 name##_adbtbl,\ 418 sizeof(name##_adbtbl) / sizeof(ASN1_ADB_TABLE),\ 419 def,\ 420 none\ 421 }; \ 422 return (const ASN1_ITEM *) &internal_adb; \ 423 } \ 424 void dummy_function(void) 425 426#endif 427 428#define ADB_ENTRY(val, template) {val, template} 429 430#define ASN1_ADB_TEMPLATE(name) \ 431 static const ASN1_TEMPLATE name##_tt 432 433/* This is the ASN1 template structure that defines 434 * a wrapper round the actual type. It determines the 435 * actual position of the field in the value structure, 436 * various flags such as OPTIONAL and the field name. 437 */ 438 439struct ASN1_TEMPLATE_st { 440unsigned long flags; /* Various flags */ 441long tag; /* tag, not used if no tagging */ 442unsigned long offset; /* Offset of this field in structure */ 443#ifndef NO_ASN1_FIELD_NAMES 444const char *field_name; /* Field name */ 445#endif 446ASN1_ITEM_EXP *item; /* Relevant ASN1_ITEM or ASN1_ADB */ 447}; 448 449/* Macro to extract ASN1_ITEM and ASN1_ADB pointer from ASN1_TEMPLATE */ 450 451#define ASN1_TEMPLATE_item(t) (t->item_ptr) 452#define ASN1_TEMPLATE_adb(t) (t->item_ptr) 453 454typedef struct ASN1_ADB_TABLE_st ASN1_ADB_TABLE; 455typedef struct ASN1_ADB_st ASN1_ADB; 456 457struct ASN1_ADB_st { 458 unsigned long flags; /* Various flags */ 459 unsigned long offset; /* Offset of selector field */ 460 STACK_OF(ASN1_ADB_TABLE) **app_items; /* Application defined items */ 461 const ASN1_ADB_TABLE *tbl; /* Table of possible types */ 462 long tblcount; /* Number of entries in tbl */ 463 const ASN1_TEMPLATE *default_tt; /* Type to use if no match */ 464 const ASN1_TEMPLATE *null_tt; /* Type to use if selector is NULL */ 465}; 466 467struct ASN1_ADB_TABLE_st { 468 long value; /* NID for an object or value for an int */ 469 const ASN1_TEMPLATE tt; /* item for this value */ 470}; 471 472/* template flags */ 473 474/* Field is optional */ 475#define ASN1_TFLG_OPTIONAL (0x1) 476 477/* Field is a SET OF */ 478#define ASN1_TFLG_SET_OF (0x1 << 1) 479 480/* Field is a SEQUENCE OF */ 481#define ASN1_TFLG_SEQUENCE_OF (0x2 << 1) 482 483/* Special case: this refers to a SET OF that 484 * will be sorted into DER order when encoded *and* 485 * the corresponding STACK will be modified to match 486 * the new order. 487 */ 488#define ASN1_TFLG_SET_ORDER (0x3 << 1) 489 490/* Mask for SET OF or SEQUENCE OF */ 491#define ASN1_TFLG_SK_MASK (0x3 << 1) 492 493/* These flags mean the tag should be taken from the 494 * tag field. If EXPLICIT then the underlying type 495 * is used for the inner tag. 496 */ 497 498/* IMPLICIT tagging */ 499#define ASN1_TFLG_IMPTAG (0x1 << 3) 500 501 502/* EXPLICIT tagging, inner tag from underlying type */ 503#define ASN1_TFLG_EXPTAG (0x2 << 3) 504 505#define ASN1_TFLG_TAG_MASK (0x3 << 3) 506 507/* context specific IMPLICIT */ 508#define ASN1_TFLG_IMPLICIT ASN1_TFLG_IMPTAG|ASN1_TFLG_CONTEXT 509 510/* context specific EXPLICIT */ 511#define ASN1_TFLG_EXPLICIT ASN1_TFLG_EXPTAG|ASN1_TFLG_CONTEXT 512 513/* If tagging is in force these determine the 514 * type of tag to use. Otherwise the tag is 515 * determined by the underlying type. These 516 * values reflect the actual octet format. 517 */ 518 519/* Universal tag */ 520#define ASN1_TFLG_UNIVERSAL (0x0<<6) 521/* Application tag */ 522#define ASN1_TFLG_APPLICATION (0x1<<6) 523/* Context specific tag */ 524#define ASN1_TFLG_CONTEXT (0x2<<6) 525/* Private tag */ 526#define ASN1_TFLG_PRIVATE (0x3<<6) 527 528#define ASN1_TFLG_TAG_CLASS (0x3<<6) 529 530/* These are for ANY DEFINED BY type. In this case 531 * the 'item' field points to an ASN1_ADB structure 532 * which contains a table of values to decode the 533 * relevant type 534 */ 535 536#define ASN1_TFLG_ADB_MASK (0x3<<8) 537 538#define ASN1_TFLG_ADB_OID (0x1<<8) 539 540#define ASN1_TFLG_ADB_INT (0x1<<9) 541 542/* This flag means a parent structure is passed 543 * instead of the field: this is useful is a 544 * SEQUENCE is being combined with a CHOICE for 545 * example. Since this means the structure and 546 * item name will differ we need to use the 547 * ASN1_CHOICE_END_name() macro for example. 548 */ 549 550#define ASN1_TFLG_COMBINE (0x1<<10) 551 552/* This flag when present in a SEQUENCE OF, SET OF 553 * or EXPLICIT causes indefinite length constructed 554 * encoding to be used if required. 555 */ 556 557#define ASN1_TFLG_NDEF (0x1<<11) 558 559/* This is the actual ASN1 item itself */ 560 561struct ASN1_ITEM_st { 562char itype; /* The item type, primitive, SEQUENCE, CHOICE or extern */ 563long utype; /* underlying type */ 564const ASN1_TEMPLATE *templates; /* If SEQUENCE or CHOICE this contains the contents */ 565long tcount; /* Number of templates if SEQUENCE or CHOICE */ 566const void *funcs; /* functions that handle this type */ 567long size; /* Structure size (usually)*/ 568#ifndef NO_ASN1_FIELD_NAMES 569const char *sname; /* Structure name */ 570#endif 571}; 572 573/* These are values for the itype field and 574 * determine how the type is interpreted. 575 * 576 * For PRIMITIVE types the underlying type 577 * determines the behaviour if items is NULL. 578 * 579 * Otherwise templates must contain a single 580 * template and the type is treated in the 581 * same way as the type specified in the template. 582 * 583 * For SEQUENCE types the templates field points 584 * to the members, the size field is the 585 * structure size. 586 * 587 * For CHOICE types the templates field points 588 * to each possible member (typically a union) 589 * and the 'size' field is the offset of the 590 * selector. 591 * 592 * The 'funcs' field is used for application 593 * specific functions. 594 * 595 * For COMPAT types the funcs field gives a 596 * set of functions that handle this type, this 597 * supports the old d2i, i2d convention. 598 * 599 * The EXTERN type uses a new style d2i/i2d. 600 * The new style should be used where possible 601 * because it avoids things like the d2i IMPLICIT 602 * hack. 603 * 604 * MSTRING is a multiple string type, it is used 605 * for a CHOICE of character strings where the 606 * actual strings all occupy an ASN1_STRING 607 * structure. In this case the 'utype' field 608 * has a special meaning, it is used as a mask 609 * of acceptable types using the B_ASN1 constants. 610 * 611 * NDEF_SEQUENCE is the same as SEQUENCE except 612 * that it will use indefinite length constructed 613 * encoding if requested. 614 * 615 */ 616 617#define ASN1_ITYPE_PRIMITIVE 0x0 618 619#define ASN1_ITYPE_SEQUENCE 0x1 620 621#define ASN1_ITYPE_CHOICE 0x2 622 623#define ASN1_ITYPE_COMPAT 0x3 624 625#define ASN1_ITYPE_EXTERN 0x4 626 627#define ASN1_ITYPE_MSTRING 0x5 628 629#define ASN1_ITYPE_NDEF_SEQUENCE 0x6 630 631/* Cache for ASN1 tag and length, so we 632 * don't keep re-reading it for things 633 * like CHOICE 634 */ 635 636struct ASN1_TLC_st{ 637 char valid; /* Values below are valid */ 638 int ret; /* return value */ 639 long plen; /* length */ 640 int ptag; /* class value */ 641 int pclass; /* class value */ 642 int hdrlen; /* header length */ 643}; 644 645/* Typedefs for ASN1 function pointers */ 646 647typedef ASN1_VALUE * ASN1_new_func(void); 648typedef void ASN1_free_func(ASN1_VALUE *a); 649typedef ASN1_VALUE * ASN1_d2i_func(ASN1_VALUE **a, const unsigned char ** in, long length); 650typedef int ASN1_i2d_func(ASN1_VALUE * a, unsigned char **in); 651 652typedef int ASN1_ex_d2i(ASN1_VALUE **pval, const unsigned char **in, long len, const ASN1_ITEM *it, 653 int tag, int aclass, char opt, ASN1_TLC *ctx); 654 655typedef int ASN1_ex_i2d(ASN1_VALUE **pval, unsigned char **out, const ASN1_ITEM *it, int tag, int aclass); 656typedef int ASN1_ex_new_func(ASN1_VALUE **pval, const ASN1_ITEM *it); 657typedef void ASN1_ex_free_func(ASN1_VALUE **pval, const ASN1_ITEM *it); 658 659typedef int ASN1_primitive_i2c(ASN1_VALUE **pval, unsigned char *cont, int *putype, const ASN1_ITEM *it); 660typedef int ASN1_primitive_c2i(ASN1_VALUE **pval, const unsigned char *cont, int len, int utype, char *free_cont, const ASN1_ITEM *it); 661 662typedef struct ASN1_COMPAT_FUNCS_st { 663 ASN1_new_func *asn1_new; 664 ASN1_free_func *asn1_free; 665 ASN1_d2i_func *asn1_d2i; 666 ASN1_i2d_func *asn1_i2d; 667} ASN1_COMPAT_FUNCS; 668 669typedef struct ASN1_EXTERN_FUNCS_st { 670 void *app_data; 671 ASN1_ex_new_func *asn1_ex_new; 672 ASN1_ex_free_func *asn1_ex_free; 673 ASN1_ex_free_func *asn1_ex_clear; 674 ASN1_ex_d2i *asn1_ex_d2i; 675 ASN1_ex_i2d *asn1_ex_i2d; 676} ASN1_EXTERN_FUNCS; 677 678typedef struct ASN1_PRIMITIVE_FUNCS_st { 679 void *app_data; 680 unsigned long flags; 681 ASN1_ex_new_func *prim_new; 682 ASN1_ex_free_func *prim_free; 683 ASN1_ex_free_func *prim_clear; 684 ASN1_primitive_c2i *prim_c2i; 685 ASN1_primitive_i2c *prim_i2c; 686} ASN1_PRIMITIVE_FUNCS; 687 688/* This is the ASN1_AUX structure: it handles various 689 * miscellaneous requirements. For example the use of 690 * reference counts and an informational callback. 691 * 692 * The "informational callback" is called at various 693 * points during the ASN1 encoding and decoding. It can 694 * be used to provide minor customisation of the structures 695 * used. This is most useful where the supplied routines 696 * *almost* do the right thing but need some extra help 697 * at a few points. If the callback returns zero then 698 * it is assumed a fatal error has occurred and the 699 * main operation should be abandoned. 700 * 701 * If major changes in the default behaviour are required 702 * then an external type is more appropriate. 703 */ 704 705typedef int ASN1_aux_cb(int operation, ASN1_VALUE **in, const ASN1_ITEM *it); 706 707typedef struct ASN1_AUX_st { 708 void *app_data; 709 int flags; 710 int ref_offset; /* Offset of reference value */ 711 int ref_lock; /* Lock type to use */ 712 ASN1_aux_cb *asn1_cb; 713 int enc_offset; /* Offset of ASN1_ENCODING structure */ 714} ASN1_AUX; 715 716/* Flags in ASN1_AUX */ 717 718/* Use a reference count */ 719#define ASN1_AFLG_REFCOUNT 1 720/* Save the encoding of structure (useful for signatures) */ 721#define ASN1_AFLG_ENCODING 2 722/* The Sequence length is invalid */ 723#define ASN1_AFLG_BROKEN 4 724 725/* operation values for asn1_cb */ 726 727#define ASN1_OP_NEW_PRE 0 728#define ASN1_OP_NEW_POST 1 729#define ASN1_OP_FREE_PRE 2 730#define ASN1_OP_FREE_POST 3 731#define ASN1_OP_D2I_PRE 4 732#define ASN1_OP_D2I_POST 5 733#define ASN1_OP_I2D_PRE 6 734#define ASN1_OP_I2D_POST 7 735 736/* Macro to implement a primitive type */ 737#define IMPLEMENT_ASN1_TYPE(stname) IMPLEMENT_ASN1_TYPE_ex(stname, stname, 0) 738#define IMPLEMENT_ASN1_TYPE_ex(itname, vname, ex) \ 739 ASN1_ITEM_start(itname) \ 740 ASN1_ITYPE_PRIMITIVE, V_##vname, NULL, 0, NULL, ex, #itname \ 741 ASN1_ITEM_end(itname) 742 743/* Macro to implement a multi string type */ 744#define IMPLEMENT_ASN1_MSTRING(itname, mask) \ 745 ASN1_ITEM_start(itname) \ 746 ASN1_ITYPE_MSTRING, mask, NULL, 0, NULL, sizeof(ASN1_STRING), #itname \ 747 ASN1_ITEM_end(itname) 748 749/* Macro to implement an ASN1_ITEM in terms of old style funcs */ 750 751#define IMPLEMENT_COMPAT_ASN1(sname) IMPLEMENT_COMPAT_ASN1_type(sname, V_ASN1_SEQUENCE) 752 753#define IMPLEMENT_COMPAT_ASN1_type(sname, tag) \ 754 static const ASN1_COMPAT_FUNCS sname##_ff = { \ 755 (ASN1_new_func *)sname##_new, \ 756 (ASN1_free_func *)sname##_free, \ 757 (ASN1_d2i_func *)d2i_##sname, \ 758 (ASN1_i2d_func *)i2d_##sname, \ 759 }; \ 760 ASN1_ITEM_start(sname) \ 761 ASN1_ITYPE_COMPAT, \ 762 tag, \ 763 NULL, \ 764 0, \ 765 &sname##_ff, \ 766 0, \ 767 #sname \ 768 ASN1_ITEM_end(sname) 769 770#define IMPLEMENT_EXTERN_ASN1(sname, tag, fptrs) \ 771 ASN1_ITEM_start(sname) \ 772 ASN1_ITYPE_EXTERN, \ 773 tag, \ 774 NULL, \ 775 0, \ 776 &fptrs, \ 777 0, \ 778 #sname \ 779 ASN1_ITEM_end(sname) 780 781/* Macro to implement standard functions in terms of ASN1_ITEM structures */ 782 783#define IMPLEMENT_ASN1_FUNCTIONS(stname) IMPLEMENT_ASN1_FUNCTIONS_fname(stname, stname, stname) 784 785#define IMPLEMENT_ASN1_FUNCTIONS_name(stname, itname) IMPLEMENT_ASN1_FUNCTIONS_fname(stname, itname, itname) 786 787#define IMPLEMENT_ASN1_FUNCTIONS_ENCODE_name(stname, itname) \ 788 IMPLEMENT_ASN1_FUNCTIONS_ENCODE_fname(stname, itname, itname) 789 790#define IMPLEMENT_ASN1_ALLOC_FUNCTIONS(stname) \ 791 IMPLEMENT_ASN1_ALLOC_FUNCTIONS_fname(stname, stname, stname) 792 793#define IMPLEMENT_ASN1_ALLOC_FUNCTIONS_fname(stname, itname, fname) \ 794 stname *fname##_new(void) \ 795 { \ 796 return (stname *)ASN1_item_new(ASN1_ITEM_rptr(itname)); \ 797 } \ 798 void fname##_free(stname *a) \ 799 { \ 800 ASN1_item_free((ASN1_VALUE *)a, ASN1_ITEM_rptr(itname)); \ 801 } 802 803#define IMPLEMENT_ASN1_FUNCTIONS_fname(stname, itname, fname) \ 804 IMPLEMENT_ASN1_ENCODE_FUNCTIONS_fname(stname, itname, fname) \ 805 IMPLEMENT_ASN1_ALLOC_FUNCTIONS_fname(stname, itname, fname) 806 807#define IMPLEMENT_ASN1_ENCODE_FUNCTIONS_fname(stname, itname, fname) \ 808 stname *d2i_##fname(stname **a, const unsigned char **in, long len) \ 809 { \ 810 return (stname *)ASN1_item_d2i((ASN1_VALUE **)a, in, len, ASN1_ITEM_rptr(itname));\ 811 } \ 812 int i2d_##fname(stname *a, unsigned char **out) \ 813 { \ 814 return ASN1_item_i2d((ASN1_VALUE *)a, out, ASN1_ITEM_rptr(itname));\ 815 } 816 817#define IMPLEMENT_ASN1_NDEF_FUNCTION(stname) \ 818 int i2d_##stname##_NDEF(stname *a, unsigned char **out) \ 819 { \ 820 return ASN1_item_ndef_i2d((ASN1_VALUE *)a, out, ASN1_ITEM_rptr(stname));\ 821 } 822 823/* This includes evil casts to remove const: they will go away when full 824 * ASN1 constification is done. 825 */ 826#define IMPLEMENT_ASN1_ENCODE_FUNCTIONS_const_fname(stname, itname, fname) \ 827 stname *d2i_##fname(stname **a, const unsigned char **in, long len) \ 828 { \ 829 return (stname *)ASN1_item_d2i((ASN1_VALUE **)a, in, len, ASN1_ITEM_rptr(itname));\ 830 } \ 831 int i2d_##fname(const stname *a, unsigned char **out) \ 832 { \ 833 return ASN1_item_i2d((ASN1_VALUE *)a, out, ASN1_ITEM_rptr(itname));\ 834 } 835 836#define IMPLEMENT_ASN1_DUP_FUNCTION(stname) \ 837 stname * stname##_dup(stname *x) \ 838 { \ 839 return ASN1_item_dup(ASN1_ITEM_rptr(stname), x); \ 840 } 841 842#define IMPLEMENT_ASN1_FUNCTIONS_const(name) \ 843 IMPLEMENT_ASN1_FUNCTIONS_const_fname(name, name, name) 844 845#define IMPLEMENT_ASN1_FUNCTIONS_const_fname(stname, itname, fname) \ 846 IMPLEMENT_ASN1_ENCODE_FUNCTIONS_const_fname(stname, itname, fname) \ 847 IMPLEMENT_ASN1_ALLOC_FUNCTIONS_fname(stname, itname, fname) 848 849/* external definitions for primitive types */ 850 851DECLARE_ASN1_ITEM(ASN1_BOOLEAN) 852DECLARE_ASN1_ITEM(ASN1_TBOOLEAN) 853DECLARE_ASN1_ITEM(ASN1_FBOOLEAN) 854DECLARE_ASN1_ITEM(ASN1_SEQUENCE) 855DECLARE_ASN1_ITEM(CBIGNUM) 856DECLARE_ASN1_ITEM(BIGNUM) 857DECLARE_ASN1_ITEM(LONG) 858DECLARE_ASN1_ITEM(ZLONG) 859 860DECLARE_STACK_OF(ASN1_VALUE) 861 862/* Functions used internally by the ASN1 code */ 863 864int ASN1_item_ex_new(ASN1_VALUE **pval, const ASN1_ITEM *it); 865void ASN1_item_ex_free(ASN1_VALUE **pval, const ASN1_ITEM *it); 866int ASN1_template_new(ASN1_VALUE **pval, const ASN1_TEMPLATE *tt); 867int ASN1_primitive_new(ASN1_VALUE **pval, const ASN1_ITEM *it); 868 869void ASN1_template_free(ASN1_VALUE **pval, const ASN1_TEMPLATE *tt); 870int ASN1_template_d2i(ASN1_VALUE **pval, const unsigned char **in, long len, const ASN1_TEMPLATE *tt); 871int ASN1_item_ex_d2i(ASN1_VALUE **pval, const unsigned char **in, long len, const ASN1_ITEM *it, int tag, int aclass, char opt, ASN1_TLC *ctx); 872 873int ASN1_item_ex_i2d(ASN1_VALUE **pval, unsigned char **out, const ASN1_ITEM *it, int tag, int aclass); 874int ASN1_template_i2d(ASN1_VALUE **pval, unsigned char **out, const ASN1_TEMPLATE *tt); 875void ASN1_primitive_free(ASN1_VALUE **pval, const ASN1_ITEM *it); 876 877int asn1_ex_i2c(ASN1_VALUE **pval, unsigned char *cont, int *putype, const ASN1_ITEM *it); 878int asn1_ex_c2i(ASN1_VALUE **pval, const unsigned char *cont, int len, int utype, char *free_cont, const ASN1_ITEM *it); 879 880int asn1_get_choice_selector(ASN1_VALUE **pval, const ASN1_ITEM *it); 881int asn1_set_choice_selector(ASN1_VALUE **pval, int value, const ASN1_ITEM *it); 882 883ASN1_VALUE ** asn1_get_field_ptr(ASN1_VALUE **pval, const ASN1_TEMPLATE *tt); 884 885const ASN1_TEMPLATE *asn1_do_adb(ASN1_VALUE **pval, const ASN1_TEMPLATE *tt, int nullerr); 886 887int asn1_do_lock(ASN1_VALUE **pval, int op, const ASN1_ITEM *it); 888 889void asn1_enc_init(ASN1_VALUE **pval, const ASN1_ITEM *it); 890void asn1_enc_free(ASN1_VALUE **pval, const ASN1_ITEM *it); 891int asn1_enc_restore(int *len, unsigned char **out, ASN1_VALUE **pval, const ASN1_ITEM *it); 892int asn1_enc_save(ASN1_VALUE **pval, const unsigned char *in, int inlen, const ASN1_ITEM *it); 893 894#ifdef __cplusplus 895} 896#endif 897#endif 898