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