asn1t.h 27 KB

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