2 * Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 #ifndef HEADER_ASN1T_H
11 # define HEADER_ASN1T_H
14 # include <openssl/e_os2.h>
15 # include <openssl/asn1.h>
17 # ifdef OPENSSL_BUILD_SHLIBCRYPTO
18 # undef OPENSSL_EXTERN
19 # define OPENSSL_EXTERN OPENSSL_EXPORT
22 /* ASN1 template defines, structures and functions */
28 # ifndef OPENSSL_EXPORT_VAR_AS_FUNCTION
30 /* Macro to obtain ASN1_ADB pointer from a type (only used internally) */
31 # define ASN1_ADB_ptr(iptr) ((const ASN1_ADB *)(iptr))
33 /* Macros for start and end of ASN1_ITEM definition */
35 # define ASN1_ITEM_start(itname) \
36 const ASN1_ITEM itname##_it = {
38 # define static_ASN1_ITEM_start(itname) \
39 static const ASN1_ITEM itname##_it = {
41 # define ASN1_ITEM_end(itname) \
46 /* Macro to obtain ASN1_ADB pointer from a type (only used internally) */
47 # define ASN1_ADB_ptr(iptr) ((const ASN1_ADB *)((iptr)()))
49 /* Macros for start and end of ASN1_ITEM definition */
51 # define ASN1_ITEM_start(itname) \
52 const ASN1_ITEM * itname##_it(void) \
54 static const ASN1_ITEM local_it = {
56 # define static_ASN1_ITEM_start(itname) \
57 static ASN1_ITEM_start(itname)
59 # define ASN1_ITEM_end(itname) \
66 /* Macros to aid ASN1 template writing */
68 # define ASN1_ITEM_TEMPLATE(tname) \
69 static const ASN1_TEMPLATE tname##_item_tt
71 # define ASN1_ITEM_TEMPLATE_END(tname) \
73 ASN1_ITEM_start(tname) \
74 ASN1_ITYPE_PRIMITIVE,\
82 # define static_ASN1_ITEM_TEMPLATE_END(tname) \
84 static_ASN1_ITEM_start(tname) \
85 ASN1_ITYPE_PRIMITIVE,\
94 /* This is a ASN1 type which just embeds a template */
97 * This pair helps declare a SEQUENCE. We can do:
99 * ASN1_SEQUENCE(stname) = {
100 * ... SEQUENCE components ...
101 * } ASN1_SEQUENCE_END(stname)
103 * This will produce an ASN1_ITEM called stname_it
104 * for a structure called stname.
106 * If you want the same structure but a different
109 * ASN1_SEQUENCE(itname) = {
110 * ... SEQUENCE components ...
111 * } ASN1_SEQUENCE_END_name(stname, itname)
113 * This will create an item called itname_it using
114 * a structure called stname.
117 # define ASN1_SEQUENCE(tname) \
118 static const ASN1_TEMPLATE tname##_seq_tt[]
120 # define ASN1_SEQUENCE_END(stname) ASN1_SEQUENCE_END_name(stname, stname)
122 # define static_ASN1_SEQUENCE_END(stname) static_ASN1_SEQUENCE_END_name(stname, stname)
124 # define ASN1_SEQUENCE_END_name(stname, tname) \
126 ASN1_ITEM_start(tname) \
127 ASN1_ITYPE_SEQUENCE,\
130 sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\
136 # define static_ASN1_SEQUENCE_END_name(stname, tname) \
138 static_ASN1_ITEM_start(tname) \
139 ASN1_ITYPE_SEQUENCE,\
142 sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\
148 # define ASN1_NDEF_SEQUENCE(tname) \
151 # define ASN1_NDEF_SEQUENCE_cb(tname, cb) \
152 ASN1_SEQUENCE_cb(tname, cb)
154 # define ASN1_SEQUENCE_cb(tname, cb) \
155 static const ASN1_AUX tname##_aux = {NULL, 0, 0, 0, cb, 0, NULL}; \
158 # define ASN1_SEQUENCE_const_cb(tname, const_cb) \
159 static const ASN1_AUX tname##_aux = \
160 {NULL, ASN1_AFLG_CONST_CB, 0, 0, NULL, 0, const_cb}; \
163 # define ASN1_SEQUENCE_cb_const_cb(tname, cb, const_cb) \
164 static const ASN1_AUX tname##_aux = \
165 {NULL, ASN1_AFLG_CONST_CB, 0, 0, cb, 0, const_cb}; \
168 # define ASN1_BROKEN_SEQUENCE(tname) \
169 static const ASN1_AUX tname##_aux = {NULL, ASN1_AFLG_BROKEN, 0, 0, NULL, 0, NULL}; \
172 # define ASN1_SEQUENCE_ref(tname, cb) \
173 static const ASN1_AUX tname##_aux = {NULL, ASN1_AFLG_REFCOUNT, offsetof(tname, references), offsetof(tname, lock), cb, 0, NULL}; \
176 # define ASN1_SEQUENCE_enc(tname, enc, cb) \
177 static const ASN1_AUX tname##_aux = {NULL, ASN1_AFLG_ENCODING, 0, 0, cb, offsetof(tname, enc), NULL}; \
180 # define ASN1_NDEF_SEQUENCE_END(tname) \
182 ASN1_ITEM_start(tname) \
183 ASN1_ITYPE_NDEF_SEQUENCE,\
186 sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\
191 # define static_ASN1_NDEF_SEQUENCE_END(tname) \
193 static_ASN1_ITEM_start(tname) \
194 ASN1_ITYPE_NDEF_SEQUENCE,\
197 sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\
203 # define ASN1_BROKEN_SEQUENCE_END(stname) ASN1_SEQUENCE_END_ref(stname, stname)
204 # define static_ASN1_BROKEN_SEQUENCE_END(stname) \
205 static_ASN1_SEQUENCE_END_ref(stname, stname)
207 # define ASN1_SEQUENCE_END_enc(stname, tname) ASN1_SEQUENCE_END_ref(stname, tname)
209 # define ASN1_SEQUENCE_END_cb(stname, tname) ASN1_SEQUENCE_END_ref(stname, tname)
210 # define static_ASN1_SEQUENCE_END_cb(stname, tname) static_ASN1_SEQUENCE_END_ref(stname, tname)
212 # define ASN1_SEQUENCE_END_ref(stname, tname) \
214 ASN1_ITEM_start(tname) \
215 ASN1_ITYPE_SEQUENCE,\
218 sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\
223 # define static_ASN1_SEQUENCE_END_ref(stname, tname) \
225 static_ASN1_ITEM_start(tname) \
226 ASN1_ITYPE_SEQUENCE,\
229 sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\
235 # define ASN1_NDEF_SEQUENCE_END_cb(stname, tname) \
237 ASN1_ITEM_start(tname) \
238 ASN1_ITYPE_NDEF_SEQUENCE,\
241 sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\
248 * This pair helps declare a CHOICE type. We can do:
250 * ASN1_CHOICE(chname) = {
251 * ... CHOICE options ...
252 * ASN1_CHOICE_END(chname)
254 * This will produce an ASN1_ITEM called chname_it
255 * for a structure called chname. The structure
256 * definition must look like this:
260 * ASN1_SOMETHING *opt1;
261 * ASN1_SOMEOTHER *opt2;
265 * the name of the selector must be 'type'.
266 * to use an alternative selector name use the
267 * ASN1_CHOICE_END_selector() version.
270 # define ASN1_CHOICE(tname) \
271 static const ASN1_TEMPLATE tname##_ch_tt[]
273 # define ASN1_CHOICE_cb(tname, cb) \
274 static const ASN1_AUX tname##_aux = {NULL, 0, 0, 0, cb, 0, NULL}; \
277 # define ASN1_CHOICE_END(stname) ASN1_CHOICE_END_name(stname, stname)
279 # define static_ASN1_CHOICE_END(stname) static_ASN1_CHOICE_END_name(stname, stname)
281 # define ASN1_CHOICE_END_name(stname, tname) ASN1_CHOICE_END_selector(stname, tname, type)
283 # define static_ASN1_CHOICE_END_name(stname, tname) static_ASN1_CHOICE_END_selector(stname, tname, type)
285 # define ASN1_CHOICE_END_selector(stname, tname, selname) \
287 ASN1_ITEM_start(tname) \
289 offsetof(stname,selname) ,\
291 sizeof(tname##_ch_tt) / sizeof(ASN1_TEMPLATE),\
297 # define static_ASN1_CHOICE_END_selector(stname, tname, selname) \
299 static_ASN1_ITEM_start(tname) \
301 offsetof(stname,selname) ,\
303 sizeof(tname##_ch_tt) / sizeof(ASN1_TEMPLATE),\
309 # define ASN1_CHOICE_END_cb(stname, tname, selname) \
311 ASN1_ITEM_start(tname) \
313 offsetof(stname,selname) ,\
315 sizeof(tname##_ch_tt) / sizeof(ASN1_TEMPLATE),\
321 /* This helps with the template wrapper form of ASN1_ITEM */
323 # define ASN1_EX_TEMPLATE_TYPE(flags, tag, name, type) { \
325 #name, ASN1_ITEM_ref(type) }
327 /* These help with SEQUENCE or CHOICE components */
329 /* used to declare other types */
331 # define ASN1_EX_TYPE(flags, tag, stname, field, type) { \
332 (flags), (tag), offsetof(stname, field),\
333 #field, ASN1_ITEM_ref(type) }
335 /* implicit and explicit helper macros */
337 # define ASN1_IMP_EX(stname, field, type, tag, ex) \
338 ASN1_EX_TYPE(ASN1_TFLG_IMPLICIT | (ex), tag, stname, field, type)
340 # define ASN1_EXP_EX(stname, field, type, tag, ex) \
341 ASN1_EX_TYPE(ASN1_TFLG_EXPLICIT | (ex), tag, stname, field, type)
343 /* Any defined by macros: the field used is in the table itself */
345 # ifndef OPENSSL_EXPORT_VAR_AS_FUNCTION
346 # define ASN1_ADB_OBJECT(tblname) { ASN1_TFLG_ADB_OID, -1, 0, #tblname, (const ASN1_ITEM *)&(tblname##_adb) }
347 # define ASN1_ADB_INTEGER(tblname) { ASN1_TFLG_ADB_INT, -1, 0, #tblname, (const ASN1_ITEM *)&(tblname##_adb) }
349 # define ASN1_ADB_OBJECT(tblname) { ASN1_TFLG_ADB_OID, -1, 0, #tblname, tblname##_adb }
350 # define ASN1_ADB_INTEGER(tblname) { ASN1_TFLG_ADB_INT, -1, 0, #tblname, tblname##_adb }
352 /* Plain simple type */
353 # define ASN1_SIMPLE(stname, field, type) ASN1_EX_TYPE(0,0, stname, field, type)
354 /* Embedded simple type */
355 # define ASN1_EMBED(stname, field, type) ASN1_EX_TYPE(ASN1_TFLG_EMBED,0, stname, field, type)
357 /* OPTIONAL simple type */
358 # define ASN1_OPT(stname, field, type) ASN1_EX_TYPE(ASN1_TFLG_OPTIONAL, 0, stname, field, type)
359 # define ASN1_OPT_EMBED(stname, field, type) ASN1_EX_TYPE(ASN1_TFLG_OPTIONAL|ASN1_TFLG_EMBED, 0, stname, field, type)
361 /* IMPLICIT tagged simple type */
362 # define ASN1_IMP(stname, field, type, tag) ASN1_IMP_EX(stname, field, type, tag, 0)
363 # define ASN1_IMP_EMBED(stname, field, type, tag) ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_EMBED)
365 /* IMPLICIT tagged OPTIONAL simple type */
366 # define ASN1_IMP_OPT(stname, field, type, tag) ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_OPTIONAL)
367 # define ASN1_IMP_OPT_EMBED(stname, field, type, tag) ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_OPTIONAL|ASN1_TFLG_EMBED)
369 /* Same as above but EXPLICIT */
371 # define ASN1_EXP(stname, field, type, tag) ASN1_EXP_EX(stname, field, type, tag, 0)
372 # define ASN1_EXP_EMBED(stname, field, type, tag) ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_EMBED)
373 # define ASN1_EXP_OPT(stname, field, type, tag) ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_OPTIONAL)
374 # define ASN1_EXP_OPT_EMBED(stname, field, type, tag) ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_OPTIONAL|ASN1_TFLG_EMBED)
376 /* SEQUENCE OF type */
377 # define ASN1_SEQUENCE_OF(stname, field, type) \
378 ASN1_EX_TYPE(ASN1_TFLG_SEQUENCE_OF, 0, stname, field, type)
380 /* OPTIONAL SEQUENCE OF */
381 # define ASN1_SEQUENCE_OF_OPT(stname, field, type) \
382 ASN1_EX_TYPE(ASN1_TFLG_SEQUENCE_OF|ASN1_TFLG_OPTIONAL, 0, stname, field, type)
384 /* Same as above but for SET OF */
386 # define ASN1_SET_OF(stname, field, type) \
387 ASN1_EX_TYPE(ASN1_TFLG_SET_OF, 0, stname, field, type)
389 # define ASN1_SET_OF_OPT(stname, field, type) \
390 ASN1_EX_TYPE(ASN1_TFLG_SET_OF|ASN1_TFLG_OPTIONAL, 0, stname, field, type)
392 /* Finally compound types of SEQUENCE, SET, IMPLICIT, EXPLICIT and OPTIONAL */
394 # define ASN1_IMP_SET_OF(stname, field, type, tag) \
395 ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_SET_OF)
397 # define ASN1_EXP_SET_OF(stname, field, type, tag) \
398 ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_SET_OF)
400 # define ASN1_IMP_SET_OF_OPT(stname, field, type, tag) \
401 ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_SET_OF|ASN1_TFLG_OPTIONAL)
403 # define ASN1_EXP_SET_OF_OPT(stname, field, type, tag) \
404 ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_SET_OF|ASN1_TFLG_OPTIONAL)
406 # define ASN1_IMP_SEQUENCE_OF(stname, field, type, tag) \
407 ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_SEQUENCE_OF)
409 # define ASN1_IMP_SEQUENCE_OF_OPT(stname, field, type, tag) \
410 ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_SEQUENCE_OF|ASN1_TFLG_OPTIONAL)
412 # define ASN1_EXP_SEQUENCE_OF(stname, field, type, tag) \
413 ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_SEQUENCE_OF)
415 # define ASN1_EXP_SEQUENCE_OF_OPT(stname, field, type, tag) \
416 ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_SEQUENCE_OF|ASN1_TFLG_OPTIONAL)
418 /* EXPLICIT using indefinite length constructed form */
419 # define ASN1_NDEF_EXP(stname, field, type, tag) \
420 ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_NDEF)
422 /* EXPLICIT OPTIONAL using indefinite length constructed form */
423 # define ASN1_NDEF_EXP_OPT(stname, field, type, tag) \
424 ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_OPTIONAL|ASN1_TFLG_NDEF)
426 /* Macros for the ASN1_ADB structure */
428 # define ASN1_ADB(name) \
429 static const ASN1_ADB_TABLE name##_adbtbl[]
431 # ifndef OPENSSL_EXPORT_VAR_AS_FUNCTION
433 # define ASN1_ADB_END(name, flags, field, adb_cb, def, none) \
435 static const ASN1_ADB name##_adb = {\
437 offsetof(name, field),\
440 sizeof(name##_adbtbl) / sizeof(ASN1_ADB_TABLE),\
447 # define ASN1_ADB_END(name, flags, field, adb_cb, def, none) \
449 static const ASN1_ITEM *name##_adb(void) \
451 static const ASN1_ADB internal_adb = \
454 offsetof(name, field),\
457 sizeof(name##_adbtbl) / sizeof(ASN1_ADB_TABLE),\
461 return (const ASN1_ITEM *) &internal_adb; \
463 void dummy_function(void)
467 # define ADB_ENTRY(val, template) {val, template}
469 # define ASN1_ADB_TEMPLATE(name) \
470 static const ASN1_TEMPLATE name##_tt
473 * This is the ASN1 template structure that defines a wrapper round the
474 * actual type. It determines the actual position of the field in the value
475 * structure, various flags such as OPTIONAL and the field name.
478 struct ASN1_TEMPLATE_st {
479 unsigned long flags; /* Various flags */
480 long tag; /* tag, not used if no tagging */
481 unsigned long offset; /* Offset of this field in structure */
482 const char *field_name; /* Field name */
483 ASN1_ITEM_EXP *item; /* Relevant ASN1_ITEM or ASN1_ADB */
486 /* Macro to extract ASN1_ITEM and ASN1_ADB pointer from ASN1_TEMPLATE */
488 # define ASN1_TEMPLATE_item(t) (t->item_ptr)
489 # define ASN1_TEMPLATE_adb(t) (t->item_ptr)
491 typedef struct ASN1_ADB_TABLE_st ASN1_ADB_TABLE;
492 typedef struct ASN1_ADB_st ASN1_ADB;
495 unsigned long flags; /* Various flags */
496 unsigned long offset; /* Offset of selector field */
497 int (*adb_cb)(long *psel); /* Application callback */
498 const ASN1_ADB_TABLE *tbl; /* Table of possible types */
499 long tblcount; /* Number of entries in tbl */
500 const ASN1_TEMPLATE *default_tt; /* Type to use if no match */
501 const ASN1_TEMPLATE *null_tt; /* Type to use if selector is NULL */
504 struct ASN1_ADB_TABLE_st {
505 long value; /* NID for an object or value for an int */
506 const ASN1_TEMPLATE tt; /* item for this value */
511 /* Field is optional */
512 # define ASN1_TFLG_OPTIONAL (0x1)
514 /* Field is a SET OF */
515 # define ASN1_TFLG_SET_OF (0x1 << 1)
517 /* Field is a SEQUENCE OF */
518 # define ASN1_TFLG_SEQUENCE_OF (0x2 << 1)
521 * Special case: this refers to a SET OF that will be sorted into DER order
522 * when encoded *and* the corresponding STACK will be modified to match the
525 # define ASN1_TFLG_SET_ORDER (0x3 << 1)
527 /* Mask for SET OF or SEQUENCE OF */
528 # define ASN1_TFLG_SK_MASK (0x3 << 1)
531 * These flags mean the tag should be taken from the tag field. If EXPLICIT
532 * then the underlying type is used for the inner tag.
535 /* IMPLICIT tagging */
536 # define ASN1_TFLG_IMPTAG (0x1 << 3)
538 /* EXPLICIT tagging, inner tag from underlying type */
539 # define ASN1_TFLG_EXPTAG (0x2 << 3)
541 # define ASN1_TFLG_TAG_MASK (0x3 << 3)
543 /* context specific IMPLICIT */
544 # define ASN1_TFLG_IMPLICIT (ASN1_TFLG_IMPTAG|ASN1_TFLG_CONTEXT)
546 /* context specific EXPLICIT */
547 # define ASN1_TFLG_EXPLICIT (ASN1_TFLG_EXPTAG|ASN1_TFLG_CONTEXT)
550 * If tagging is in force these determine the type of tag to use. Otherwise
551 * the tag is determined by the underlying type. These values reflect the
552 * actual octet format.
556 # define ASN1_TFLG_UNIVERSAL (0x0<<6)
557 /* Application tag */
558 # define ASN1_TFLG_APPLICATION (0x1<<6)
559 /* Context specific tag */
560 # define ASN1_TFLG_CONTEXT (0x2<<6)
562 # define ASN1_TFLG_PRIVATE (0x3<<6)
564 # define ASN1_TFLG_TAG_CLASS (0x3<<6)
567 * These are for ANY DEFINED BY type. In this case the 'item' field points to
568 * an ASN1_ADB structure which contains a table of values to decode the
572 # define ASN1_TFLG_ADB_MASK (0x3<<8)
574 # define ASN1_TFLG_ADB_OID (0x1<<8)
576 # define ASN1_TFLG_ADB_INT (0x1<<9)
579 * This flag when present in a SEQUENCE OF, SET OF or EXPLICIT causes
580 * indefinite length constructed encoding to be used if required.
583 # define ASN1_TFLG_NDEF (0x1<<11)
585 /* Field is embedded and not a pointer */
586 # define ASN1_TFLG_EMBED (0x1 << 12)
588 /* This is the actual ASN1 item itself */
590 struct ASN1_ITEM_st {
591 char itype; /* The item type, primitive, SEQUENCE, CHOICE
593 long utype; /* underlying type */
594 const ASN1_TEMPLATE *templates; /* If SEQUENCE or CHOICE this contains
596 long tcount; /* Number of templates if SEQUENCE or CHOICE */
597 const void *funcs; /* functions that handle this type */
598 long size; /* Structure size (usually) */
599 const char *sname; /* Structure name */
603 * These are values for the itype field and
604 * determine how the type is interpreted.
606 * For PRIMITIVE types the underlying type
607 * determines the behaviour if items is NULL.
609 * Otherwise templates must contain a single
610 * template and the type is treated in the
611 * same way as the type specified in the template.
613 * For SEQUENCE types the templates field points
614 * to the members, the size field is the
617 * For CHOICE types the templates field points
618 * to each possible member (typically a union)
619 * and the 'size' field is the offset of the
622 * The 'funcs' field is used for application
623 * specific functions.
625 * The EXTERN type uses a new style d2i/i2d.
626 * The new style should be used where possible
627 * because it avoids things like the d2i IMPLICIT
630 * MSTRING is a multiple string type, it is used
631 * for a CHOICE of character strings where the
632 * actual strings all occupy an ASN1_STRING
633 * structure. In this case the 'utype' field
634 * has a special meaning, it is used as a mask
635 * of acceptable types using the B_ASN1 constants.
637 * NDEF_SEQUENCE is the same as SEQUENCE except
638 * that it will use indefinite length constructed
639 * encoding if requested.
643 # define ASN1_ITYPE_PRIMITIVE 0x0
645 # define ASN1_ITYPE_SEQUENCE 0x1
647 # define ASN1_ITYPE_CHOICE 0x2
649 # define ASN1_ITYPE_EXTERN 0x4
651 # define ASN1_ITYPE_MSTRING 0x5
653 # define ASN1_ITYPE_NDEF_SEQUENCE 0x6
656 * Cache for ASN1 tag and length, so we don't keep re-reading it for things
661 char valid; /* Values below are valid */
662 int ret; /* return value */
663 long plen; /* length */
664 int ptag; /* class value */
665 int pclass; /* class value */
666 int hdrlen; /* header length */
669 /* Typedefs for ASN1 function pointers */
670 typedef int ASN1_ex_d2i(ASN1_VALUE **pval, const unsigned char **in, long len,
671 const ASN1_ITEM *it, int tag, int aclass, char opt,
674 typedef int ASN1_ex_i2d(const ASN1_VALUE **pval, unsigned char **out,
675 const ASN1_ITEM *it, int tag, int aclass);
676 typedef int ASN1_ex_new_func(ASN1_VALUE **pval, const ASN1_ITEM *it);
677 typedef void ASN1_ex_free_func(ASN1_VALUE **pval, const ASN1_ITEM *it);
679 typedef int ASN1_ex_print_func(BIO *out, const ASN1_VALUE **pval,
680 int indent, const char *fname,
681 const ASN1_PCTX *pctx);
683 typedef int ASN1_primitive_i2c(const ASN1_VALUE **pval, unsigned char *cont,
684 int *putype, const ASN1_ITEM *it);
685 typedef int ASN1_primitive_c2i(ASN1_VALUE **pval, const unsigned char *cont,
686 int len, int utype, char *free_cont,
687 const ASN1_ITEM *it);
688 typedef int ASN1_primitive_print(BIO *out, const ASN1_VALUE **pval,
689 const ASN1_ITEM *it, int indent,
690 const ASN1_PCTX *pctx);
692 typedef struct ASN1_EXTERN_FUNCS_st {
694 ASN1_ex_new_func *asn1_ex_new;
695 ASN1_ex_free_func *asn1_ex_free;
696 ASN1_ex_free_func *asn1_ex_clear;
697 ASN1_ex_d2i *asn1_ex_d2i;
698 ASN1_ex_i2d *asn1_ex_i2d;
699 ASN1_ex_print_func *asn1_ex_print;
702 typedef struct ASN1_PRIMITIVE_FUNCS_st {
705 ASN1_ex_new_func *prim_new;
706 ASN1_ex_free_func *prim_free;
707 ASN1_ex_free_func *prim_clear;
708 ASN1_primitive_c2i *prim_c2i;
709 ASN1_primitive_i2c *prim_i2c;
710 ASN1_primitive_print *prim_print;
711 } ASN1_PRIMITIVE_FUNCS;
714 * This is the ASN1_AUX structure: it handles various miscellaneous
715 * requirements. For example the use of reference counts and an informational
716 * callback. The "informational callback" is called at various points during
717 * the ASN1 encoding and decoding. It can be used to provide minor
718 * customisation of the structures used. This is most useful where the
719 * supplied routines *almost* do the right thing but need some extra help at
720 * a few points. If the callback returns zero then it is assumed a fatal
721 * error has occurred and the main operation should be abandoned. If major
722 * changes in the default behaviour are required then an external type is
724 * For the operations ASN1_OP_I2D_PRE, ASN1_OP_I2D_POST, ASN1_OP_PRINT_PRE, and
725 * ASN1_OP_PRINT_POST, meanwhile a variant of the callback with const parameter
726 * 'in' is provided to make clear statically that its input is not modified. If
727 * and only if this variant is in use the flag ASN1_AFLG_CONST_CB must be set.
730 typedef int ASN1_aux_cb(int operation, ASN1_VALUE **in, const ASN1_ITEM *it,
732 typedef int ASN1_aux_const_cb(int operation, const ASN1_VALUE **in,
733 const ASN1_ITEM *it, void *exarg);
735 typedef struct ASN1_AUX_st {
738 int ref_offset; /* Offset of reference value */
739 int ref_lock; /* Lock type to use */
740 ASN1_aux_cb *asn1_cb;
741 int enc_offset; /* Offset of ASN1_ENCODING structure */
742 ASN1_aux_const_cb *asn1_const_cb; /* for ASN1_OP_I2D_ and ASN1_OP_PRINT_ */
745 /* For print related callbacks exarg points to this structure */
746 typedef struct ASN1_PRINT_ARG_st {
749 const ASN1_PCTX *pctx;
752 /* For streaming related callbacks exarg points to this structure */
753 typedef struct ASN1_STREAM_ARG_st {
754 /* BIO to stream through */
756 /* BIO with filters appended */
758 /* Streaming I/O boundary */
759 unsigned char **boundary;
762 /* Flags in ASN1_AUX */
764 /* Use a reference count */
765 # define ASN1_AFLG_REFCOUNT 1
766 /* Save the encoding of structure (useful for signatures) */
767 # define ASN1_AFLG_ENCODING 2
768 /* The Sequence length is invalid */
769 # define ASN1_AFLG_BROKEN 4
770 /* Use the new asn1_const_cb */
771 # define ASN1_AFLG_CONST_CB 8
773 /* operation values for asn1_cb */
775 # define ASN1_OP_NEW_PRE 0
776 # define ASN1_OP_NEW_POST 1
777 # define ASN1_OP_FREE_PRE 2
778 # define ASN1_OP_FREE_POST 3
779 # define ASN1_OP_D2I_PRE 4
780 # define ASN1_OP_D2I_POST 5
781 # define ASN1_OP_I2D_PRE 6
782 # define ASN1_OP_I2D_POST 7
783 # define ASN1_OP_PRINT_PRE 8
784 # define ASN1_OP_PRINT_POST 9
785 # define ASN1_OP_STREAM_PRE 10
786 # define ASN1_OP_STREAM_POST 11
787 # define ASN1_OP_DETACHED_PRE 12
788 # define ASN1_OP_DETACHED_POST 13
790 /* Macro to implement a primitive type */
791 # define IMPLEMENT_ASN1_TYPE(stname) IMPLEMENT_ASN1_TYPE_ex(stname, stname, 0)
792 # define IMPLEMENT_ASN1_TYPE_ex(itname, vname, ex) \
793 ASN1_ITEM_start(itname) \
794 ASN1_ITYPE_PRIMITIVE, V_##vname, NULL, 0, NULL, ex, #itname \
795 ASN1_ITEM_end(itname)
797 /* Macro to implement a multi string type */
798 # define IMPLEMENT_ASN1_MSTRING(itname, mask) \
799 ASN1_ITEM_start(itname) \
800 ASN1_ITYPE_MSTRING, mask, NULL, 0, NULL, sizeof(ASN1_STRING), #itname \
801 ASN1_ITEM_end(itname)
803 # define IMPLEMENT_EXTERN_ASN1(sname, tag, fptrs) \
804 ASN1_ITEM_start(sname) \
814 /* Macro to implement standard functions in terms of ASN1_ITEM structures */
816 # define IMPLEMENT_ASN1_FUNCTIONS(stname) IMPLEMENT_ASN1_FUNCTIONS_fname(stname, stname, stname)
818 # define IMPLEMENT_ASN1_FUNCTIONS_name(stname, itname) IMPLEMENT_ASN1_FUNCTIONS_fname(stname, itname, itname)
820 # define IMPLEMENT_ASN1_FUNCTIONS_ENCODE_name(stname, itname) \
821 IMPLEMENT_ASN1_FUNCTIONS_ENCODE_fname(stname, itname, itname)
823 # define IMPLEMENT_STATIC_ASN1_ALLOC_FUNCTIONS(stname) \
824 IMPLEMENT_ASN1_ALLOC_FUNCTIONS_pfname(static, stname, stname, stname)
826 # define IMPLEMENT_ASN1_ALLOC_FUNCTIONS(stname) \
827 IMPLEMENT_ASN1_ALLOC_FUNCTIONS_fname(stname, stname, stname)
829 # define IMPLEMENT_ASN1_ALLOC_FUNCTIONS_pfname(pre, stname, itname, fname) \
830 pre stname *fname##_new(void) \
832 return (stname *)ASN1_item_new(ASN1_ITEM_rptr(itname)); \
834 pre void fname##_free(stname *a) \
836 ASN1_item_free((ASN1_VALUE *)a, ASN1_ITEM_rptr(itname)); \
839 # define IMPLEMENT_ASN1_ALLOC_FUNCTIONS_fname(stname, itname, fname) \
840 stname *fname##_new(void) \
842 return (stname *)ASN1_item_new(ASN1_ITEM_rptr(itname)); \
844 void fname##_free(stname *a) \
846 ASN1_item_free((ASN1_VALUE *)a, ASN1_ITEM_rptr(itname)); \
849 # define IMPLEMENT_ASN1_FUNCTIONS_fname(stname, itname, fname) \
850 IMPLEMENT_ASN1_ENCODE_FUNCTIONS_fname(stname, itname, fname) \
851 IMPLEMENT_ASN1_ALLOC_FUNCTIONS_fname(stname, itname, fname)
853 # define IMPLEMENT_ASN1_ENCODE_FUNCTIONS_fname(stname, itname, fname) \
854 stname *d2i_##fname(stname **a, const unsigned char **in, long len) \
856 return (stname *)ASN1_item_d2i((ASN1_VALUE **)a, in, len, ASN1_ITEM_rptr(itname));\
858 int i2d_##fname(const stname *a, unsigned char **out) \
860 return ASN1_item_i2d((ASN1_VALUE *)a, out, ASN1_ITEM_rptr(itname));\
863 # define IMPLEMENT_ASN1_NDEF_FUNCTION(stname) \
864 int i2d_##stname##_NDEF(const stname *a, unsigned char **out) \
866 return ASN1_item_ndef_i2d((ASN1_VALUE *)a, out, ASN1_ITEM_rptr(stname));\
869 # define IMPLEMENT_STATIC_ASN1_ENCODE_FUNCTIONS(stname) \
870 static stname *d2i_##stname(stname **a, \
871 const unsigned char **in, long len) \
873 return (stname *)ASN1_item_d2i((ASN1_VALUE **)a, in, len, \
874 ASN1_ITEM_rptr(stname)); \
876 static int i2d_##stname(const stname *a, unsigned char **out) \
878 return ASN1_item_i2d((ASN1_VALUE *)a, out, \
879 ASN1_ITEM_rptr(stname)); \
882 # define IMPLEMENT_ASN1_DUP_FUNCTION(stname) \
883 stname * stname##_dup(const stname *x) \
885 return ASN1_item_dup(ASN1_ITEM_rptr(stname), x); \
888 # define IMPLEMENT_ASN1_PRINT_FUNCTION(stname) \
889 IMPLEMENT_ASN1_PRINT_FUNCTION_fname(stname, stname, stname)
891 # define IMPLEMENT_ASN1_PRINT_FUNCTION_fname(stname, itname, fname) \
892 int fname##_print_ctx(BIO *out, const stname *x, int indent, \
893 const ASN1_PCTX *pctx) \
895 return ASN1_item_print(out, (ASN1_VALUE *)x, indent, \
896 ASN1_ITEM_rptr(itname), pctx); \
899 /* external definitions for primitive types */
901 DECLARE_ASN1_ITEM(ASN1_BOOLEAN)
902 DECLARE_ASN1_ITEM(ASN1_TBOOLEAN)
903 DECLARE_ASN1_ITEM(ASN1_FBOOLEAN)
904 DECLARE_ASN1_ITEM(ASN1_SEQUENCE)
905 DECLARE_ASN1_ITEM(CBIGNUM)
906 DECLARE_ASN1_ITEM(BIGNUM)
907 DECLARE_ASN1_ITEM(INT32)
908 DECLARE_ASN1_ITEM(ZINT32)
909 DECLARE_ASN1_ITEM(UINT32)
910 DECLARE_ASN1_ITEM(ZUINT32)
911 DECLARE_ASN1_ITEM(INT64)
912 DECLARE_ASN1_ITEM(ZINT64)
913 DECLARE_ASN1_ITEM(UINT64)
914 DECLARE_ASN1_ITEM(ZUINT64)
918 * LONG and ZLONG are strongly discouraged for use as stored data, as the
919 * underlying C type (long) differs in size depending on the architecture.
920 * They are designed with 32-bit longs in mind.
922 DECLARE_ASN1_ITEM(LONG)
923 DECLARE_ASN1_ITEM(ZLONG)
926 DEFINE_STACK_OF(ASN1_VALUE)
928 /* Functions used internally by the ASN1 code */
930 int ASN1_item_ex_new(ASN1_VALUE **pval, const ASN1_ITEM *it);
931 void ASN1_item_ex_free(ASN1_VALUE **pval, const ASN1_ITEM *it);
933 int ASN1_item_ex_d2i(ASN1_VALUE **pval, const unsigned char **in, long len,
934 const ASN1_ITEM *it, int tag, int aclass, char opt,
937 int ASN1_item_ex_i2d(const ASN1_VALUE **pval, unsigned char **out,
938 const ASN1_ITEM *it, int tag, int aclass);
940 /* Legacy compatibility */
941 # define IMPLEMENT_ASN1_FUNCTIONS_const(name) IMPLEMENT_ASN1_FUNCTIONS(name)
942 # define IMPLEMENT_ASN1_ENCODE_FUNCTIONS_const_fname(stname, itname, fname) \
943 IMPLEMENT_ASN1_ENCODE_FUNCTIONS_fname(stname, itname, fname)