Debian Codegraph @

external/boringssl/include/openssl/asn1t.h

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