New ASN.1 embed macro.
[openssl.git] / crypto / asn1 / tasn_fre.c
1 /* tasn_fre.c */
2 /*
3  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
4  * 2000.
5  */
6 /* ====================================================================
7  * Copyright (c) 2000 The OpenSSL Project.  All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in
18  *    the documentation and/or other materials provided with the
19  *    distribution.
20  *
21  * 3. All advertising materials mentioning features or use of this
22  *    software must display the following acknowledgment:
23  *    "This product includes software developed by the OpenSSL Project
24  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25  *
26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27  *    endorse or promote products derived from this software without
28  *    prior written permission. For written permission, please contact
29  *    licensing@OpenSSL.org.
30  *
31  * 5. Products derived from this software may not be called "OpenSSL"
32  *    nor may "OpenSSL" appear in their names without prior written
33  *    permission of the OpenSSL Project.
34  *
35  * 6. Redistributions of any form whatsoever must retain the following
36  *    acknowledgment:
37  *    "This product includes software developed by the OpenSSL Project
38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51  * OF THE POSSIBILITY OF SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This product includes cryptographic software written by Eric Young
55  * (eay@cryptsoft.com).  This product includes software written by Tim
56  * Hudson (tjh@cryptsoft.com).
57  *
58  */
59
60 #include <stddef.h>
61 #include <openssl/asn1.h>
62 #include <openssl/asn1t.h>
63 #include <openssl/objects.h>
64 #include "asn1_locl.h"
65
66 static void asn1_item_embed_free(ASN1_VALUE **pval, const ASN1_ITEM *it,
67                                  int embed);
68
69 /* Free up an ASN1 structure */
70
71 void ASN1_item_free(ASN1_VALUE *val, const ASN1_ITEM *it)
72 {
73     asn1_item_embed_free(&val, it, 0);
74 }
75
76 void ASN1_item_ex_free(ASN1_VALUE **pval, const ASN1_ITEM *it)
77 {
78     asn1_item_embed_free(pval, it, 0);
79 }
80
81 static void asn1_item_embed_free(ASN1_VALUE **pval, const ASN1_ITEM *it,
82                                  int embed)
83 {
84     const ASN1_TEMPLATE *tt = NULL, *seqtt;
85     const ASN1_EXTERN_FUNCS *ef;
86     const ASN1_AUX *aux = it->funcs;
87     ASN1_aux_cb *asn1_cb;
88     int i;
89
90     if (!pval)
91         return;
92     if ((it->itype != ASN1_ITYPE_PRIMITIVE) && !*pval)
93         return;
94     if (aux && aux->asn1_cb)
95         asn1_cb = aux->asn1_cb;
96     else
97         asn1_cb = 0;
98
99     switch (it->itype) {
100
101     case ASN1_ITYPE_PRIMITIVE:
102         if (it->templates)
103             asn1_template_free(pval, it->templates);
104         else
105             asn1_primitive_free(pval, it);
106         break;
107
108     case ASN1_ITYPE_MSTRING:
109         asn1_primitive_free(pval, it);
110         break;
111
112     case ASN1_ITYPE_CHOICE:
113         if (asn1_cb) {
114             i = asn1_cb(ASN1_OP_FREE_PRE, pval, it, NULL);
115             if (i == 2)
116                 return;
117         }
118         i = asn1_get_choice_selector(pval, it);
119         if ((i >= 0) && (i < it->tcount)) {
120             ASN1_VALUE **pchval;
121
122             tt = it->templates + i;
123             pchval = asn1_get_field_ptr(pval, tt);
124             asn1_template_free(pchval, tt);
125         }
126         if (asn1_cb)
127             asn1_cb(ASN1_OP_FREE_POST, pval, it, NULL);
128         OPENSSL_free(*pval);
129         *pval = NULL;
130         break;
131
132     case ASN1_ITYPE_EXTERN:
133         ef = it->funcs;
134         if (ef && ef->asn1_ex_free)
135             ef->asn1_ex_free(pval, it);
136         break;
137
138     case ASN1_ITYPE_NDEF_SEQUENCE:
139     case ASN1_ITYPE_SEQUENCE:
140         if (asn1_do_lock(pval, -1, it) > 0)
141             return;
142         if (asn1_cb) {
143             i = asn1_cb(ASN1_OP_FREE_PRE, pval, it, NULL);
144             if (i == 2)
145                 return;
146         }
147         asn1_enc_free(pval, it);
148         /*
149          * If we free up as normal we will invalidate any ANY DEFINED BY
150          * field and we wont be able to determine the type of the field it
151          * defines. So free up in reverse order.
152          */
153         tt = it->templates + it->tcount - 1;
154         for (i = 0; i < it->tcount; tt--, i++) {
155             ASN1_VALUE **pseqval;
156             seqtt = asn1_do_adb(pval, tt, 0);
157             if (!seqtt)
158                 continue;
159             pseqval = asn1_get_field_ptr(pval, seqtt);
160             asn1_template_free(pseqval, seqtt);
161         }
162         if (asn1_cb)
163             asn1_cb(ASN1_OP_FREE_POST, pval, it, NULL);
164         if (embed == 0) {
165             OPENSSL_free(*pval);
166             *pval = NULL;
167         }
168         break;
169     }
170 }
171
172 void asn1_template_free(ASN1_VALUE **pval, const ASN1_TEMPLATE *tt)
173 {
174     int embed = tt->flags & ASN1_TFLG_EMBED;
175     ASN1_VALUE *tval;
176     if (embed) {
177         tval = (ASN1_VALUE *)pval;
178         pval = &tval;
179     }
180     if (tt->flags & ASN1_TFLG_SK_MASK) {
181         STACK_OF(ASN1_VALUE) *sk = (STACK_OF(ASN1_VALUE) *)*pval;
182         int i;
183
184         for (i = 0; i < sk_ASN1_VALUE_num(sk); i++) {
185             ASN1_VALUE *vtmp = sk_ASN1_VALUE_value(sk, i);
186
187             asn1_item_embed_free(&vtmp, ASN1_ITEM_ptr(tt->item), embed);
188         }
189         sk_ASN1_VALUE_free(sk);
190         *pval = NULL;
191     } else {
192         asn1_item_embed_free(pval, ASN1_ITEM_ptr(tt->item), embed);
193     }
194 }
195
196 void asn1_primitive_free(ASN1_VALUE **pval, const ASN1_ITEM *it)
197 {
198     int utype;
199
200     /* Special case: if 'it' is a primitive with a free_func, use that. */
201     if (it) {
202         const ASN1_PRIMITIVE_FUNCS *pf = it->funcs;
203
204         if (pf && pf->prim_free) {
205             pf->prim_free(pval, it);
206             return;
207         }
208     }
209
210     /* Special case: if 'it' is NULL, free contents of ASN1_TYPE */
211     if (!it) {
212         ASN1_TYPE *typ = (ASN1_TYPE *)*pval;
213
214         utype = typ->type;
215         pval = &typ->value.asn1_value;
216         if (!*pval)
217             return;
218     } else if (it->itype == ASN1_ITYPE_MSTRING) {
219         utype = -1;
220         if (!*pval)
221             return;
222     } else {
223         utype = it->utype;
224         if ((utype != V_ASN1_BOOLEAN) && !*pval)
225             return;
226     }
227
228     switch (utype) {
229     case V_ASN1_OBJECT:
230         ASN1_OBJECT_free((ASN1_OBJECT *)*pval);
231         break;
232
233     case V_ASN1_BOOLEAN:
234         if (it)
235             *(ASN1_BOOLEAN *)pval = it->size;
236         else
237             *(ASN1_BOOLEAN *)pval = -1;
238         return;
239
240     case V_ASN1_NULL:
241         break;
242
243     case V_ASN1_ANY:
244         asn1_primitive_free(pval, NULL);
245         OPENSSL_free(*pval);
246         break;
247
248     default:
249         ASN1_STRING_free((ASN1_STRING *)*pval);
250         break;
251     }
252     if (*pval)
253         *pval = NULL;
254 }