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