Harald Welte | 43ab79f | 2018-10-03 23:34:21 +0200 | [diff] [blame] | 1 | /*- |
| 2 | * Copyright (c) 2003, 2004, 2005, 2006 Lev Walkin <vlm@lionet.info>. |
| 3 | * All rights reserved. |
| 4 | * Redistribution and modifications are permitted subject to BSD license. |
| 5 | */ |
| 6 | /* |
| 7 | * This file contains the declaration structure called "ASN.1 Type Definition", |
| 8 | * which holds all information necessary for encoding and decoding routines. |
| 9 | * This structure even contains pointer to these encoding and decoding routines |
| 10 | * for each defined ASN.1 type. |
| 11 | */ |
| 12 | #ifndef _CONSTR_TYPE_H_ |
| 13 | #define _CONSTR_TYPE_H_ |
| 14 | |
| 15 | #include <ber_tlv_length.h> |
| 16 | #include <ber_tlv_tag.h> |
| 17 | |
| 18 | #ifdef __cplusplus |
| 19 | extern "C" { |
| 20 | #endif |
| 21 | |
| 22 | struct asn_TYPE_descriptor_s; /* Forward declaration */ |
| 23 | struct asn_TYPE_member_s; /* Forward declaration */ |
| 24 | |
| 25 | /* |
| 26 | * This type provides the context information for various ASN.1 routines, |
| 27 | * primarily ones doing decoding. A member _asn_ctx of this type must be |
| 28 | * included into certain target language's structures, such as compound types. |
| 29 | */ |
| 30 | typedef struct asn_struct_ctx_s { |
| 31 | short phase; /* Decoding phase */ |
| 32 | short step; /* Elementary step of a phase */ |
| 33 | int context; /* Other context information */ |
| 34 | void *ptr; /* Decoder-specific stuff (stack elements) */ |
| 35 | ber_tlv_len_t left; /* Number of bytes left, -1 for indefinite */ |
| 36 | } asn_struct_ctx_t; |
| 37 | |
| 38 | #include <ber_decoder.h> /* Basic Encoding Rules decoder */ |
| 39 | #include <der_encoder.h> /* Distinguished Encoding Rules encoder */ |
| 40 | #include <xer_decoder.h> /* Decoder of XER (XML, text) */ |
| 41 | #include <xer_encoder.h> /* Encoder into XER (XML, text) */ |
| 42 | #include <per_decoder.h> /* Packet Encoding Rules decoder */ |
| 43 | #include <per_encoder.h> /* Packet Encoding Rules encoder */ |
| 44 | #include <constraints.h> /* Subtype constraints support */ |
| 45 | |
| 46 | /* |
| 47 | * Free the structure according to its specification. |
| 48 | * If (free_contents_only) is set, the wrapper structure itself (struct_ptr) |
| 49 | * will not be freed. (It may be useful in case the structure is allocated |
| 50 | * statically or arranged on the stack, yet its elements are allocated |
| 51 | * dynamically.) |
| 52 | */ |
| 53 | typedef void (asn_struct_free_f)( |
| 54 | struct asn_TYPE_descriptor_s *type_descriptor, |
| 55 | void *struct_ptr, int free_contents_only); |
| 56 | #define ASN_STRUCT_FREE(asn_DEF, ptr) (asn_DEF).free_struct(&(asn_DEF),ptr,0) |
| 57 | #define ASN_STRUCT_FREE_CONTENTS_ONLY(asn_DEF, ptr) \ |
| 58 | (asn_DEF).free_struct(&(asn_DEF),ptr,1) |
| 59 | |
| 60 | /* |
| 61 | * Print the structure according to its specification. |
| 62 | */ |
| 63 | typedef int (asn_struct_print_f)( |
| 64 | struct asn_TYPE_descriptor_s *type_descriptor, |
| 65 | const void *struct_ptr, |
| 66 | int level, /* Indentation level */ |
| 67 | asn_app_consume_bytes_f *callback, void *app_key); |
| 68 | |
| 69 | /* |
| 70 | * Return the outmost tag of the type. |
| 71 | * If the type is untagged CHOICE, the dynamic operation is performed. |
| 72 | * NOTE: This function pointer type is only useful internally. |
| 73 | * Do not use it in your application. |
| 74 | */ |
| 75 | typedef ber_tlv_tag_t (asn_outmost_tag_f)( |
| 76 | const struct asn_TYPE_descriptor_s *type_descriptor, |
| 77 | const void *struct_ptr, int tag_mode, ber_tlv_tag_t tag); |
| 78 | /* The instance of the above function type; used internally. */ |
| 79 | asn_outmost_tag_f asn_TYPE_outmost_tag; |
| 80 | |
| 81 | |
| 82 | /* |
| 83 | * The definitive description of the destination language's structure. |
| 84 | */ |
| 85 | typedef struct asn_TYPE_descriptor_s { |
| 86 | const char *name; /* A name of the ASN.1 type. "" in some cases. */ |
| 87 | const char *xml_tag; /* Name used in XML tag */ |
| 88 | |
| 89 | /* |
| 90 | * Generalized functions for dealing with the specific type. |
| 91 | * May be directly invoked by applications. |
| 92 | */ |
| 93 | asn_struct_free_f *free_struct; /* Free the structure */ |
| 94 | asn_struct_print_f *print_struct; /* Human readable output */ |
| 95 | asn_constr_check_f *check_constraints; /* Constraints validator */ |
| 96 | ber_type_decoder_f *ber_decoder; /* Generic BER decoder */ |
| 97 | der_type_encoder_f *der_encoder; /* Canonical DER encoder */ |
| 98 | xer_type_decoder_f *xer_decoder; /* Generic XER decoder */ |
| 99 | xer_type_encoder_f *xer_encoder; /* [Canonical] XER encoder */ |
| 100 | per_type_decoder_f *uper_decoder; /* Unaligned PER decoder */ |
| 101 | per_type_encoder_f *uper_encoder; /* Unaligned PER encoder */ |
| 102 | per_type_decoder_f *aper_decoder; /* Aligned PER decoder */ |
| 103 | per_type_encoder_f *aper_encoder; /* Aligned PER encoder */ |
| 104 | |
| 105 | /*********************************************************************** |
| 106 | * Internally useful members. Not to be used by applications directly. * |
| 107 | **********************************************************************/ |
| 108 | |
| 109 | /* |
| 110 | * Tags that are expected to occur. |
| 111 | */ |
| 112 | asn_outmost_tag_f *outmost_tag; /* <optional, internal> */ |
| 113 | const ber_tlv_tag_t *tags; /* Effective tags sequence for this type */ |
| 114 | int tags_count; /* Number of tags which are expected */ |
| 115 | const ber_tlv_tag_t *all_tags; /* Every tag for BER/containment */ |
| 116 | int all_tags_count; /* Number of tags */ |
| 117 | |
| 118 | asn_per_constraints_t *per_constraints; /* PER compiled constraints */ |
| 119 | |
| 120 | /* |
| 121 | * An ASN.1 production type members (members of SEQUENCE, SET, CHOICE). |
| 122 | */ |
| 123 | struct asn_TYPE_member_s *elements; |
| 124 | int elements_count; |
| 125 | |
| 126 | /* |
| 127 | * Additional information describing the type, used by appropriate |
| 128 | * functions above. |
| 129 | */ |
| 130 | const void *specifics; |
| 131 | } asn_TYPE_descriptor_t; |
| 132 | |
| 133 | /* |
| 134 | * This type describes an element of the constructed type, |
| 135 | * i.e. SEQUENCE, SET, CHOICE, etc. |
| 136 | */ |
| 137 | enum asn_TYPE_flags_e { |
| 138 | ATF_NOFLAGS, |
| 139 | ATF_POINTER = 0x01, /* Represented by the pointer */ |
| 140 | ATF_OPEN_TYPE = 0x02 /* ANY type, without meaningful tag */ |
| 141 | }; |
| 142 | typedef struct asn_TYPE_member_s { |
| 143 | enum asn_TYPE_flags_e flags; /* Element's presentation flags */ |
| 144 | int optional; /* Following optional members, including current */ |
| 145 | int memb_offset; /* Offset of the element */ |
| 146 | ber_tlv_tag_t tag; /* Outmost (most immediate) tag */ |
| 147 | int tag_mode; /* IMPLICIT/no/EXPLICIT tag at current level */ |
| 148 | asn_TYPE_descriptor_t *type; /* Member type descriptor */ |
| 149 | asn_constr_check_f *memb_constraints; /* Constraints validator */ |
| 150 | asn_per_constraints_t *per_constraints; /* PER compiled constraints */ |
| 151 | int (*default_value)(int setval, void **sptr); /* DEFAULT <value> */ |
| 152 | const char *name; /* ASN.1 identifier of the element */ |
| 153 | } asn_TYPE_member_t; |
| 154 | |
| 155 | /* |
| 156 | * BER tag to element number mapping. |
| 157 | */ |
| 158 | typedef struct asn_TYPE_tag2member_s { |
| 159 | ber_tlv_tag_t el_tag; /* Outmost tag of the member */ |
| 160 | int el_no; /* Index of the associated member, base 0 */ |
Martin Hauke | 4e87beb | 2019-07-17 22:10:47 +0200 | [diff] [blame] | 161 | int toff_first; /* First occurrence of the el_tag, relative */ |
| 162 | int toff_last; /* Last occurrence of the el_tag, relatvie */ |
Harald Welte | 43ab79f | 2018-10-03 23:34:21 +0200 | [diff] [blame] | 163 | } asn_TYPE_tag2member_t; |
| 164 | |
| 165 | /* |
| 166 | * This function is a wrapper around (td)->print_struct, which prints out |
| 167 | * the contents of the target language's structure (struct_ptr) into the |
| 168 | * file pointer (stream) in human readable form. |
| 169 | * RETURN VALUES: |
| 170 | * 0: The structure is printed. |
| 171 | * -1: Problem dumping the structure. |
| 172 | * (See also xer_fprint() in xer_encoder.h) |
| 173 | */ |
| 174 | int asn_fprint(FILE *stream, /* Destination stream descriptor */ |
| 175 | asn_TYPE_descriptor_t *td, /* ASN.1 type descriptor */ |
| 176 | const void *struct_ptr); /* Structure to be printed */ |
| 177 | |
| 178 | #ifdef __cplusplus |
| 179 | } |
| 180 | #endif |
| 181 | |
| 182 | #endif /* _CONSTR_TYPE_H_ */ |