3 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
6 /* ====================================================================
7 * Copyright (c) 2000-2005 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
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 * ====================================================================
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).
59 #ifndef HEADER_ASN1T_H
60 # define HEADER_ASN1T_H
63 # include <openssl/e_os2.h>
64 # include <openssl/asn1.h>
66 # ifdef OPENSSL_BUILD_SHLIBCRYPTO
67 # undef OPENSSL_EXTERN
68 # define OPENSSL_EXTERN OPENSSL_EXPORT
71 /* ASN1 template defines, structures and functions */
77 # ifndef OPENSSL_EXPORT_VAR_AS_FUNCTION
79 /* Macro to obtain ASN1_ADB pointer from a type (only used internally) */
80 # define ASN1_ADB_ptr(iptr) ((const ASN1_ADB *)(iptr))
82 /* Macros for start and end of ASN1_ITEM definition */
84 # define ASN1_ITEM_start(itname) \
85 OPENSSL_GLOBAL const ASN1_ITEM itname##_it = {
87 # define static_ASN1_ITEM_start(itname) \
88 static const ASN1_ITEM itname##_it = {
90 # define ASN1_ITEM_end(itname) \
95 /* Macro to obtain ASN1_ADB pointer from a type (only used internally) */
96 # define ASN1_ADB_ptr(iptr) ((const ASN1_ADB *)(iptr()))
98 /* Macros for start and end of ASN1_ITEM definition */
100 # define ASN1_ITEM_start(itname) \
101 const ASN1_ITEM * itname##_it(void) \
103 static const ASN1_ITEM local_it = {
105 # define static_ASN1_ITEM_start(itname) \
106 ASN1_ITEM_start(itname)
108 # define ASN1_ITEM_end(itname) \
115 /* Macros to aid ASN1 template writing */
117 # define ASN1_ITEM_TEMPLATE(tname) \
118 static const ASN1_TEMPLATE tname##_item_tt
120 # define ASN1_ITEM_TEMPLATE_END(tname) \
122 ASN1_ITEM_start(tname) \
123 ASN1_ITYPE_PRIMITIVE,\
131 # define static_ASN1_ITEM_TEMPLATE_END(tname) \
133 static_ASN1_ITEM_start(tname) \
134 ASN1_ITYPE_PRIMITIVE,\
143 /* This is a ASN1 type which just embeds a template */
146 * This pair helps declare a SEQUENCE. We can do:
148 * ASN1_SEQUENCE(stname) = {
149 * ... SEQUENCE components ...
150 * } ASN1_SEQUENCE_END(stname)
152 * This will produce an ASN1_ITEM called stname_it
153 * for a structure called stname.
155 * If you want the same structure but a different
158 * ASN1_SEQUENCE(itname) = {
159 * ... SEQUENCE components ...
160 * } ASN1_SEQUENCE_END_name(stname, itname)
162 * This will create an item called itname_it using
163 * a structure called stname.
166 # define ASN1_SEQUENCE(tname) \
167 static const ASN1_TEMPLATE tname##_seq_tt[]
169 # define ASN1_SEQUENCE_END(stname) ASN1_SEQUENCE_END_name(stname, stname)
171 # define static_ASN1_SEQUENCE_END(stname) static_ASN1_SEQUENCE_END_name(stname, stname)
173 # define ASN1_SEQUENCE_END_name(stname, tname) \
175 ASN1_ITEM_start(tname) \
176 ASN1_ITYPE_SEQUENCE,\
179 sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\
185 # define static_ASN1_SEQUENCE_END_name(stname, tname) \
187 static_ASN1_ITEM_start(tname) \
188 ASN1_ITYPE_SEQUENCE,\
191 sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\
197 # define ASN1_NDEF_SEQUENCE(tname) \
200 # define ASN1_NDEF_SEQUENCE_cb(tname, cb) \
201 ASN1_SEQUENCE_cb(tname, cb)
203 # define ASN1_SEQUENCE_cb(tname, cb) \
204 static const ASN1_AUX tname##_aux = {NULL, 0, 0, 0, cb, 0}; \
207 # define ASN1_BROKEN_SEQUENCE(tname) \
208 static const ASN1_AUX tname##_aux = {NULL, ASN1_AFLG_BROKEN, 0, 0, 0, 0}; \
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}; \
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)}; \
219 # define ASN1_NDEF_SEQUENCE_END(tname) \
221 ASN1_ITEM_start(tname) \
222 ASN1_ITYPE_NDEF_SEQUENCE,\
225 sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\
230 # define static_ASN1_NDEF_SEQUENCE_END(tname) \
232 static_ASN1_ITEM_start(tname) \
233 ASN1_ITYPE_NDEF_SEQUENCE,\
236 sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\
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)
246 # define ASN1_SEQUENCE_END_enc(stname, tname) ASN1_SEQUENCE_END_ref(stname, tname)
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)
251 # define ASN1_SEQUENCE_END_ref(stname, tname) \
253 ASN1_ITEM_start(tname) \
254 ASN1_ITYPE_SEQUENCE,\
257 sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\
262 # define static_ASN1_SEQUENCE_END_ref(stname, tname) \
264 static_ASN1_ITEM_start(tname) \
265 ASN1_ITYPE_SEQUENCE,\
268 sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\
274 # define ASN1_NDEF_SEQUENCE_END_cb(stname, tname) \
276 ASN1_ITEM_start(tname) \
277 ASN1_ITYPE_NDEF_SEQUENCE,\
280 sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\
287 * This pair helps declare a CHOICE type. We can do:
289 * ASN1_CHOICE(chname) = {
290 * ... CHOICE options ...
291 * ASN1_CHOICE_END(chname)
293 * This will produce an ASN1_ITEM called chname_it
294 * for a structure called chname. The structure
295 * definition must look like this:
299 * ASN1_SOMETHING *opt1;
300 * ASN1_SOMEOTHER *opt2;
304 * the name of the selector must be 'type'.
305 * to use an alternative selector name use the
306 * ASN1_CHOICE_END_selector() version.
309 # define ASN1_CHOICE(tname) \
310 static const ASN1_TEMPLATE tname##_ch_tt[]
312 # define ASN1_CHOICE_cb(tname, cb) \
313 static const ASN1_AUX tname##_aux = {NULL, 0, 0, 0, cb, 0}; \
316 # define ASN1_CHOICE_END(stname) ASN1_CHOICE_END_name(stname, stname)
318 # define static_ASN1_CHOICE_END(stname) static_ASN1_CHOICE_END_name(stname, stname)
320 # define ASN1_CHOICE_END_name(stname, tname) ASN1_CHOICE_END_selector(stname, tname, type)
322 # define static_ASN1_CHOICE_END_name(stname, tname) static_ASN1_CHOICE_END_selector(stname, tname, type)
324 # define ASN1_CHOICE_END_selector(stname, tname, selname) \
326 ASN1_ITEM_start(tname) \
328 offsetof(stname,selname) ,\
330 sizeof(tname##_ch_tt) / sizeof(ASN1_TEMPLATE),\
336 # define static_ASN1_CHOICE_END_selector(stname, tname, selname) \
338 static_ASN1_ITEM_start(tname) \
340 offsetof(stname,selname) ,\
342 sizeof(tname##_ch_tt) / sizeof(ASN1_TEMPLATE),\
348 # define ASN1_CHOICE_END_cb(stname, tname, selname) \
350 ASN1_ITEM_start(tname) \
352 offsetof(stname,selname) ,\
354 sizeof(tname##_ch_tt) / sizeof(ASN1_TEMPLATE),\
360 /* This helps with the template wrapper form of ASN1_ITEM */
362 # define ASN1_EX_TEMPLATE_TYPE(flags, tag, name, type) { \
364 #name, ASN1_ITEM_ref(type) }
366 /* These help with SEQUENCE or CHOICE components */
368 /* used to declare other types */
370 # define ASN1_EX_TYPE(flags, tag, stname, field, type) { \
371 (flags), (tag), offsetof(stname, field),\
372 #field, ASN1_ITEM_ref(type) }
374 /* implicit and explicit helper macros */
376 # define ASN1_IMP_EX(stname, field, type, tag, ex) \
377 ASN1_EX_TYPE(ASN1_TFLG_IMPLICIT | ex, tag, stname, field, type)
379 # define ASN1_EXP_EX(stname, field, type, tag, ex) \
380 ASN1_EX_TYPE(ASN1_TFLG_EXPLICIT | ex, tag, stname, field, type)
382 /* Any defined by macros: the field used is in the table itself */
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) }
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 }
391 /* Plain simple type */
392 # define ASN1_SIMPLE(stname, field, type) ASN1_EX_TYPE(0,0, stname, field, type)
393 /* Embedded simple type */
394 # define ASN1_EMBED(stname, field, type) ASN1_EX_TYPE(ASN1_TFLG_EMBED,0, stname, field, type)
396 /* OPTIONAL simple type */
397 # define ASN1_OPT(stname, field, type) ASN1_EX_TYPE(ASN1_TFLG_OPTIONAL, 0, stname, field, type)
399 /* IMPLICIT tagged simple type */
400 # define ASN1_IMP(stname, field, type, tag) ASN1_IMP_EX(stname, field, type, tag, 0)
402 /* IMPLICIT tagged OPTIONAL simple type */
403 # define ASN1_IMP_OPT(stname, field, type, tag) ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_OPTIONAL)
405 /* Same as above but EXPLICIT */
407 # define ASN1_EXP(stname, field, type, tag) ASN1_EXP_EX(stname, field, type, tag, 0)
408 # define ASN1_EXP_OPT(stname, field, type, tag) ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_OPTIONAL)
410 /* SEQUENCE OF type */
411 # define ASN1_SEQUENCE_OF(stname, field, type) \
412 ASN1_EX_TYPE(ASN1_TFLG_SEQUENCE_OF, 0, stname, field, type)
414 /* OPTIONAL SEQUENCE OF */
415 # define ASN1_SEQUENCE_OF_OPT(stname, field, type) \
416 ASN1_EX_TYPE(ASN1_TFLG_SEQUENCE_OF|ASN1_TFLG_OPTIONAL, 0, stname, field, type)
418 /* Same as above but for SET OF */
420 # define ASN1_SET_OF(stname, field, type) \
421 ASN1_EX_TYPE(ASN1_TFLG_SET_OF, 0, stname, field, type)
423 # define ASN1_SET_OF_OPT(stname, field, type) \
424 ASN1_EX_TYPE(ASN1_TFLG_SET_OF|ASN1_TFLG_OPTIONAL, 0, stname, field, type)
426 /* Finally compound types of SEQUENCE, SET, IMPLICIT, EXPLICIT and OPTIONAL */
428 # define ASN1_IMP_SET_OF(stname, field, type, tag) \
429 ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_SET_OF)
431 # define ASN1_EXP_SET_OF(stname, field, type, tag) \
432 ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_SET_OF)
434 # define ASN1_IMP_SET_OF_OPT(stname, field, type, tag) \
435 ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_SET_OF|ASN1_TFLG_OPTIONAL)
437 # define ASN1_EXP_SET_OF_OPT(stname, field, type, tag) \
438 ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_SET_OF|ASN1_TFLG_OPTIONAL)
440 # define ASN1_IMP_SEQUENCE_OF(stname, field, type, tag) \
441 ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_SEQUENCE_OF)
443 # define ASN1_IMP_SEQUENCE_OF_OPT(stname, field, type, tag) \
444 ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_SEQUENCE_OF|ASN1_TFLG_OPTIONAL)
446 # define ASN1_EXP_SEQUENCE_OF(stname, field, type, tag) \
447 ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_SEQUENCE_OF)
449 # define ASN1_EXP_SEQUENCE_OF_OPT(stname, field, type, tag) \
450 ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_SEQUENCE_OF|ASN1_TFLG_OPTIONAL)
452 /* EXPLICIT using indefinite length constructed form */
453 # define ASN1_NDEF_EXP(stname, field, type, tag) \
454 ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_NDEF)
456 /* EXPLICIT OPTIONAL using indefinite length constructed form */
457 # define ASN1_NDEF_EXP_OPT(stname, field, type, tag) \
458 ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_OPTIONAL|ASN1_TFLG_NDEF)
460 /* Macros for the ASN1_ADB structure */
462 # define ASN1_ADB(name) \
463 static const ASN1_ADB_TABLE name##_adbtbl[]
465 # ifndef OPENSSL_EXPORT_VAR_AS_FUNCTION
467 # define ASN1_ADB_END(name, flags, field, app_table, def, none) \
469 static const ASN1_ADB name##_adb = {\
471 offsetof(name, field),\
474 sizeof(name##_adbtbl) / sizeof(ASN1_ADB_TABLE),\
481 # define ASN1_ADB_END(name, flags, field, app_table, def, none) \
483 static const ASN1_ITEM *name##_adb(void) \
485 static const ASN1_ADB internal_adb = \
488 offsetof(name, field),\
491 sizeof(name##_adbtbl) / sizeof(ASN1_ADB_TABLE),\
495 return (const ASN1_ITEM *) &internal_adb; \
497 void dummy_function(void)
501 # define ADB_ENTRY(val, template) {val, template}
503 # define ASN1_ADB_TEMPLATE(name) \
504 static const ASN1_TEMPLATE name##_tt
507 * This is the ASN1 template structure that defines a wrapper round the
508 * actual type. It determines the actual position of the field in the value
509 * structure, various flags such as OPTIONAL and the field name.
512 struct ASN1_TEMPLATE_st {
513 unsigned long flags; /* Various flags */
514 long tag; /* tag, not used if no tagging */
515 unsigned long offset; /* Offset of this field in structure */
516 # ifndef NO_ASN1_FIELD_NAMES
517 const char *field_name; /* Field name */
519 ASN1_ITEM_EXP *item; /* Relevant ASN1_ITEM or ASN1_ADB */
522 /* Macro to extract ASN1_ITEM and ASN1_ADB pointer from ASN1_TEMPLATE */
524 # define ASN1_TEMPLATE_item(t) (t->item_ptr)
525 # define ASN1_TEMPLATE_adb(t) (t->item_ptr)
527 typedef struct ASN1_ADB_TABLE_st ASN1_ADB_TABLE;
528 typedef struct ASN1_ADB_st ASN1_ADB;
531 unsigned long flags; /* Various flags */
532 unsigned long offset; /* Offset of selector field */
533 STACK_OF(ASN1_ADB_TABLE) **app_items; /* Application defined items */
534 const ASN1_ADB_TABLE *tbl; /* Table of possible types */
535 long tblcount; /* Number of entries in tbl */
536 const ASN1_TEMPLATE *default_tt; /* Type to use if no match */
537 const ASN1_TEMPLATE *null_tt; /* Type to use if selector is NULL */
540 struct ASN1_ADB_TABLE_st {
541 long value; /* NID for an object or value for an int */
542 const ASN1_TEMPLATE tt; /* item for this value */
547 /* Field is optional */
548 # define ASN1_TFLG_OPTIONAL (0x1)
550 /* Field is a SET OF */
551 # define ASN1_TFLG_SET_OF (0x1 << 1)
553 /* Field is a SEQUENCE OF */
554 # define ASN1_TFLG_SEQUENCE_OF (0x2 << 1)
557 * Special case: this refers to a SET OF that will be sorted into DER order
558 * when encoded *and* the corresponding STACK will be modified to match the
561 # define ASN1_TFLG_SET_ORDER (0x3 << 1)
563 /* Mask for SET OF or SEQUENCE OF */
564 # define ASN1_TFLG_SK_MASK (0x3 << 1)
567 * These flags mean the tag should be taken from the tag field. If EXPLICIT
568 * then the underlying type is used for the inner tag.
571 /* IMPLICIT tagging */
572 # define ASN1_TFLG_IMPTAG (0x1 << 3)
574 /* EXPLICIT tagging, inner tag from underlying type */
575 # define ASN1_TFLG_EXPTAG (0x2 << 3)
577 # define ASN1_TFLG_TAG_MASK (0x3 << 3)
579 /* context specific IMPLICIT */
580 # define ASN1_TFLG_IMPLICIT ASN1_TFLG_IMPTAG|ASN1_TFLG_CONTEXT
582 /* context specific EXPLICIT */
583 # define ASN1_TFLG_EXPLICIT ASN1_TFLG_EXPTAG|ASN1_TFLG_CONTEXT
586 * If tagging is in force these determine the type of tag to use. Otherwise
587 * the tag is determined by the underlying type. These values reflect the
588 * actual octet format.
592 # define ASN1_TFLG_UNIVERSAL (0x0<<6)
593 /* Application tag */
594 # define ASN1_TFLG_APPLICATION (0x1<<6)
595 /* Context specific tag */
596 # define ASN1_TFLG_CONTEXT (0x2<<6)
598 # define ASN1_TFLG_PRIVATE (0x3<<6)
600 # define ASN1_TFLG_TAG_CLASS (0x3<<6)
603 * These are for ANY DEFINED BY type. In this case the 'item' field points to
604 * an ASN1_ADB structure which contains a table of values to decode the
608 # define ASN1_TFLG_ADB_MASK (0x3<<8)
610 # define ASN1_TFLG_ADB_OID (0x1<<8)
612 # define ASN1_TFLG_ADB_INT (0x1<<9)
615 * This flag when present in a SEQUENCE OF, SET OF or EXPLICIT causes
616 * indefinite length constructed encoding to be used if required.
619 # define ASN1_TFLG_NDEF (0x1<<11)
621 /* Field is embedded and not a pointer */
622 # define ASN1_TFLG_EMBED (0x1 << 12)
624 /* This is the actual ASN1 item itself */
626 struct ASN1_ITEM_st {
627 char itype; /* The item type, primitive, SEQUENCE, CHOICE
629 long utype; /* underlying type */
630 const ASN1_TEMPLATE *templates; /* If SEQUENCE or CHOICE this contains
632 long tcount; /* Number of templates if SEQUENCE or CHOICE */
633 const void *funcs; /* functions that handle this type */
634 long size; /* Structure size (usually) */
635 # ifndef NO_ASN1_FIELD_NAMES
636 const char *sname; /* Structure name */
641 * These are values for the itype field and
642 * determine how the type is interpreted.
644 * For PRIMITIVE types the underlying type
645 * determines the behaviour if items is NULL.
647 * Otherwise templates must contain a single
648 * template and the type is treated in the
649 * same way as the type specified in the template.
651 * For SEQUENCE types the templates field points
652 * to the members, the size field is the
655 * For CHOICE types the templates field points
656 * to each possible member (typically a union)
657 * and the 'size' field is the offset of the
660 * The 'funcs' field is used for application
661 * specific functions.
663 * The EXTERN type uses a new style d2i/i2d.
664 * The new style should be used where possible
665 * because it avoids things like the d2i IMPLICIT
668 * MSTRING is a multiple string type, it is used
669 * for a CHOICE of character strings where the
670 * actual strings all occupy an ASN1_STRING
671 * structure. In this case the 'utype' field
672 * has a special meaning, it is used as a mask
673 * of acceptable types using the B_ASN1 constants.
675 * NDEF_SEQUENCE is the same as SEQUENCE except
676 * that it will use indefinite length constructed
677 * encoding if requested.
681 # define ASN1_ITYPE_PRIMITIVE 0x0
683 # define ASN1_ITYPE_SEQUENCE 0x1
685 # define ASN1_ITYPE_CHOICE 0x2
687 # define ASN1_ITYPE_EXTERN 0x4
689 # define ASN1_ITYPE_MSTRING 0x5
691 # define ASN1_ITYPE_NDEF_SEQUENCE 0x6
694 * Cache for ASN1 tag and length, so we don't keep re-reading it for things
699 char valid; /* Values below are valid */
700 int ret; /* return value */
701 long plen; /* length */
702 int ptag; /* class value */
703 int pclass; /* class value */
704 int hdrlen; /* header length */
707 /* Typedefs for ASN1 function pointers */
709 typedef ASN1_VALUE *ASN1_new_func(void);
710 typedef void ASN1_free_func(ASN1_VALUE *a);
711 typedef ASN1_VALUE *ASN1_d2i_func(ASN1_VALUE **a, const unsigned char **in,
713 typedef int ASN1_i2d_func(ASN1_VALUE *a, unsigned char **in);
715 typedef int ASN1_ex_d2i(ASN1_VALUE **pval, const unsigned char **in, long len,
716 const ASN1_ITEM *it, int tag, int aclass, char opt,
719 typedef int ASN1_ex_i2d(ASN1_VALUE **pval, unsigned char **out,
720 const ASN1_ITEM *it, int tag, int aclass);
721 typedef int ASN1_ex_new_func(ASN1_VALUE **pval, const ASN1_ITEM *it);
722 typedef void ASN1_ex_free_func(ASN1_VALUE **pval, const ASN1_ITEM *it);
724 typedef int ASN1_ex_print_func(BIO *out, ASN1_VALUE **pval,
725 int indent, const char *fname,
726 const ASN1_PCTX *pctx);
728 typedef int ASN1_primitive_i2c(ASN1_VALUE **pval, unsigned char *cont,
729 int *putype, const ASN1_ITEM *it);
730 typedef int ASN1_primitive_c2i(ASN1_VALUE **pval, const unsigned char *cont,
731 int len, int utype, char *free_cont,
732 const ASN1_ITEM *it);
733 typedef int ASN1_primitive_print(BIO *out, ASN1_VALUE **pval,
734 const ASN1_ITEM *it, int indent,
735 const ASN1_PCTX *pctx);
737 typedef struct ASN1_EXTERN_FUNCS_st {
739 ASN1_ex_new_func *asn1_ex_new;
740 ASN1_ex_free_func *asn1_ex_free;
741 ASN1_ex_free_func *asn1_ex_clear;
742 ASN1_ex_d2i *asn1_ex_d2i;
743 ASN1_ex_i2d *asn1_ex_i2d;
744 ASN1_ex_print_func *asn1_ex_print;
747 typedef struct ASN1_PRIMITIVE_FUNCS_st {
750 ASN1_ex_new_func *prim_new;
751 ASN1_ex_free_func *prim_free;
752 ASN1_ex_free_func *prim_clear;
753 ASN1_primitive_c2i *prim_c2i;
754 ASN1_primitive_i2c *prim_i2c;
755 ASN1_primitive_print *prim_print;
756 } ASN1_PRIMITIVE_FUNCS;
759 * This is the ASN1_AUX structure: it handles various miscellaneous
760 * requirements. For example the use of reference counts and an informational
761 * callback. The "informational callback" is called at various points during
762 * the ASN1 encoding and decoding. It can be used to provide minor
763 * customisation of the structures used. This is most useful where the
764 * supplied routines *almost* do the right thing but need some extra help at
765 * a few points. If the callback returns zero then it is assumed a fatal
766 * error has occurred and the main operation should be abandoned. If major
767 * changes in the default behaviour are required then an external type is
771 typedef int ASN1_aux_cb(int operation, ASN1_VALUE **in, const ASN1_ITEM *it,
774 typedef struct ASN1_AUX_st {
777 int ref_offset; /* Offset of reference value */
778 int ref_lock; /* Lock type to use */
779 ASN1_aux_cb *asn1_cb;
780 int enc_offset; /* Offset of ASN1_ENCODING structure */
783 /* For print related callbacks exarg points to this structure */
784 typedef struct ASN1_PRINT_ARG_st {
787 const ASN1_PCTX *pctx;
790 /* For streaming related callbacks exarg points to this structure */
791 typedef struct ASN1_STREAM_ARG_st {
792 /* BIO to stream through */
794 /* BIO with filters appended */
796 /* Streaming I/O boundary */
797 unsigned char **boundary;
800 /* Flags in ASN1_AUX */
802 /* Use a reference count */
803 # define ASN1_AFLG_REFCOUNT 1
804 /* Save the encoding of structure (useful for signatures) */
805 # define ASN1_AFLG_ENCODING 2
806 /* The Sequence length is invalid */
807 # define ASN1_AFLG_BROKEN 4
809 /* operation values for asn1_cb */
811 # define ASN1_OP_NEW_PRE 0
812 # define ASN1_OP_NEW_POST 1
813 # define ASN1_OP_FREE_PRE 2
814 # define ASN1_OP_FREE_POST 3
815 # define ASN1_OP_D2I_PRE 4
816 # define ASN1_OP_D2I_POST 5
817 # define ASN1_OP_I2D_PRE 6
818 # define ASN1_OP_I2D_POST 7
819 # define ASN1_OP_PRINT_PRE 8
820 # define ASN1_OP_PRINT_POST 9
821 # define ASN1_OP_STREAM_PRE 10
822 # define ASN1_OP_STREAM_POST 11
823 # define ASN1_OP_DETACHED_PRE 12
824 # define ASN1_OP_DETACHED_POST 13
826 /* Macro to implement a primitive type */
827 # define IMPLEMENT_ASN1_TYPE(stname) IMPLEMENT_ASN1_TYPE_ex(stname, stname, 0)
828 # define IMPLEMENT_ASN1_TYPE_ex(itname, vname, ex) \
829 ASN1_ITEM_start(itname) \
830 ASN1_ITYPE_PRIMITIVE, V_##vname, NULL, 0, NULL, ex, #itname \
831 ASN1_ITEM_end(itname)
833 /* Macro to implement a multi string type */
834 # define IMPLEMENT_ASN1_MSTRING(itname, mask) \
835 ASN1_ITEM_start(itname) \
836 ASN1_ITYPE_MSTRING, mask, NULL, 0, NULL, sizeof(ASN1_STRING), #itname \
837 ASN1_ITEM_end(itname)
839 # define IMPLEMENT_EXTERN_ASN1(sname, tag, fptrs) \
840 ASN1_ITEM_start(sname) \
850 /* Macro to implement standard functions in terms of ASN1_ITEM structures */
852 # define IMPLEMENT_ASN1_FUNCTIONS(stname) IMPLEMENT_ASN1_FUNCTIONS_fname(stname, stname, stname)
854 # define IMPLEMENT_ASN1_FUNCTIONS_name(stname, itname) IMPLEMENT_ASN1_FUNCTIONS_fname(stname, itname, itname)
856 # define IMPLEMENT_ASN1_FUNCTIONS_ENCODE_name(stname, itname) \
857 IMPLEMENT_ASN1_FUNCTIONS_ENCODE_fname(stname, itname, itname)
859 # define IMPLEMENT_STATIC_ASN1_ALLOC_FUNCTIONS(stname) \
860 IMPLEMENT_ASN1_ALLOC_FUNCTIONS_pfname(static, stname, stname, stname)
862 # define IMPLEMENT_ASN1_ALLOC_FUNCTIONS(stname) \
863 IMPLEMENT_ASN1_ALLOC_FUNCTIONS_fname(stname, stname, stname)
865 # define IMPLEMENT_ASN1_ALLOC_FUNCTIONS_pfname(pre, stname, itname, fname) \
866 pre stname *fname##_new(void) \
868 return (stname *)ASN1_item_new(ASN1_ITEM_rptr(itname)); \
870 pre void fname##_free(stname *a) \
872 ASN1_item_free((ASN1_VALUE *)a, ASN1_ITEM_rptr(itname)); \
875 # define IMPLEMENT_ASN1_ALLOC_FUNCTIONS_fname(stname, itname, fname) \
876 stname *fname##_new(void) \
878 return (stname *)ASN1_item_new(ASN1_ITEM_rptr(itname)); \
880 void fname##_free(stname *a) \
882 ASN1_item_free((ASN1_VALUE *)a, ASN1_ITEM_rptr(itname)); \
885 # define IMPLEMENT_ASN1_FUNCTIONS_fname(stname, itname, fname) \
886 IMPLEMENT_ASN1_ENCODE_FUNCTIONS_fname(stname, itname, fname) \
887 IMPLEMENT_ASN1_ALLOC_FUNCTIONS_fname(stname, itname, fname)
889 # define IMPLEMENT_ASN1_ENCODE_FUNCTIONS_fname(stname, itname, fname) \
890 stname *d2i_##fname(stname **a, const unsigned char **in, long len) \
892 return (stname *)ASN1_item_d2i((ASN1_VALUE **)a, in, len, ASN1_ITEM_rptr(itname));\
894 int i2d_##fname(stname *a, unsigned char **out) \
896 return ASN1_item_i2d((ASN1_VALUE *)a, out, ASN1_ITEM_rptr(itname));\
899 # define IMPLEMENT_ASN1_NDEF_FUNCTION(stname) \
900 int i2d_##stname##_NDEF(stname *a, unsigned char **out) \
902 return ASN1_item_ndef_i2d((ASN1_VALUE *)a, out, ASN1_ITEM_rptr(stname));\
905 # define IMPLEMENT_STATIC_ASN1_ENCODE_FUNCTIONS(stname) \
906 static stname *d2i_##stname(stname **a, \
907 const unsigned char **in, long len) \
909 return (stname *)ASN1_item_d2i((ASN1_VALUE **)a, in, len, \
910 ASN1_ITEM_rptr(stname)); \
912 static int i2d_##stname(stname *a, unsigned char **out) \
914 return ASN1_item_i2d((ASN1_VALUE *)a, out, \
915 ASN1_ITEM_rptr(stname)); \
919 * This includes evil casts to remove const: they will go away when full ASN1
920 * constification is done.
922 # define IMPLEMENT_ASN1_ENCODE_FUNCTIONS_const_fname(stname, itname, fname) \
923 stname *d2i_##fname(stname **a, const unsigned char **in, long len) \
925 return (stname *)ASN1_item_d2i((ASN1_VALUE **)a, in, len, ASN1_ITEM_rptr(itname));\
927 int i2d_##fname(const stname *a, unsigned char **out) \
929 return ASN1_item_i2d((ASN1_VALUE *)a, out, ASN1_ITEM_rptr(itname));\
932 # define IMPLEMENT_ASN1_DUP_FUNCTION(stname) \
933 stname * stname##_dup(stname *x) \
935 return ASN1_item_dup(ASN1_ITEM_rptr(stname), x); \
938 # define IMPLEMENT_ASN1_PRINT_FUNCTION(stname) \
939 IMPLEMENT_ASN1_PRINT_FUNCTION_fname(stname, stname, stname)
941 # define IMPLEMENT_ASN1_PRINT_FUNCTION_fname(stname, itname, fname) \
942 int fname##_print_ctx(BIO *out, stname *x, int indent, \
943 const ASN1_PCTX *pctx) \
945 return ASN1_item_print(out, (ASN1_VALUE *)x, indent, \
946 ASN1_ITEM_rptr(itname), pctx); \
949 # define IMPLEMENT_ASN1_FUNCTIONS_const(name) \
950 IMPLEMENT_ASN1_FUNCTIONS_const_fname(name, name, name)
952 # define IMPLEMENT_ASN1_FUNCTIONS_const_fname(stname, itname, fname) \
953 IMPLEMENT_ASN1_ENCODE_FUNCTIONS_const_fname(stname, itname, fname) \
954 IMPLEMENT_ASN1_ALLOC_FUNCTIONS_fname(stname, itname, fname)
956 /* external definitions for primitive types */
958 DECLARE_ASN1_ITEM(ASN1_BOOLEAN)
959 DECLARE_ASN1_ITEM(ASN1_TBOOLEAN)
960 DECLARE_ASN1_ITEM(ASN1_FBOOLEAN)
961 DECLARE_ASN1_ITEM(ASN1_SEQUENCE)
962 DECLARE_ASN1_ITEM(CBIGNUM)
963 DECLARE_ASN1_ITEM(BIGNUM)
964 DECLARE_ASN1_ITEM(LONG)
965 DECLARE_ASN1_ITEM(ZLONG)
967 DECLARE_STACK_OF(ASN1_VALUE)
969 /* Functions used internally by the ASN1 code */
971 int ASN1_item_ex_new(ASN1_VALUE **pval, const ASN1_ITEM *it);
972 void ASN1_item_ex_free(ASN1_VALUE **pval, const ASN1_ITEM *it);
974 int ASN1_item_ex_d2i(ASN1_VALUE **pval, const unsigned char **in, long len,
975 const ASN1_ITEM *it, int tag, int aclass, char opt,
978 int ASN1_item_ex_i2d(ASN1_VALUE **pval, unsigned char **out,
979 const ASN1_ITEM *it, int tag, int aclass);