Add ASN.1 ADB callback.
[openssl.git] / crypto / asn1 / tasn_utl.c
1 /*
2  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
3  * 2000.
4  */
5 /* ====================================================================
6  * Copyright (c) 2000-2004 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
59 #include <stddef.h>
60 #include <string.h>
61 #include <internal/cryptlib.h>
62 #include <openssl/asn1.h>
63 #include <openssl/asn1t.h>
64 #include <openssl/objects.h>
65 #include <openssl/err.h>
66 #include "asn1_locl.h"
67
68 /* Utility functions for manipulating fields and offsets */
69
70 /* Add 'offset' to 'addr' */
71 #define offset2ptr(addr, offset) (void *)(((char *) addr) + offset)
72
73 /*
74  * Given an ASN1_ITEM CHOICE type return the selector value
75  */
76
77 int asn1_get_choice_selector(ASN1_VALUE **pval, const ASN1_ITEM *it)
78 {
79     int *sel = offset2ptr(*pval, it->utype);
80     return *sel;
81 }
82
83 /*
84  * Given an ASN1_ITEM CHOICE type set the selector value, return old value.
85  */
86
87 int asn1_set_choice_selector(ASN1_VALUE **pval, int value,
88                              const ASN1_ITEM *it)
89 {
90     int *sel, ret;
91     sel = offset2ptr(*pval, it->utype);
92     ret = *sel;
93     *sel = value;
94     return ret;
95 }
96
97 /*
98  * Do reference counting. The value 'op' decides what to do. if it is +1
99  * then the count is incremented. If op is 0 count is set to 1. If op is -1
100  * count is decremented and the return value is the current reference count
101  * or 0 if no reference count exists.
102  */
103
104 int asn1_do_lock(ASN1_VALUE **pval, int op, const ASN1_ITEM *it)
105 {
106     const ASN1_AUX *aux;
107     int *lck, ret;
108     if ((it->itype != ASN1_ITYPE_SEQUENCE)
109         && (it->itype != ASN1_ITYPE_NDEF_SEQUENCE))
110         return 0;
111     aux = it->funcs;
112     if (!aux || !(aux->flags & ASN1_AFLG_REFCOUNT))
113         return 0;
114     lck = offset2ptr(*pval, aux->ref_offset);
115     if (op == 0) {
116         *lck = 1;
117         return 1;
118     }
119     ret = CRYPTO_add(lck, op, aux->ref_lock);
120 #ifdef REF_PRINT
121     fprintf(stderr, "%p:%4d:%s\n", it, *lck, it->sname);
122 #endif
123     REF_ASSERT_ISNT(ret < 0);
124     return ret;
125 }
126
127 static ASN1_ENCODING *asn1_get_enc_ptr(ASN1_VALUE **pval, const ASN1_ITEM *it)
128 {
129     const ASN1_AUX *aux;
130     if (!pval || !*pval)
131         return NULL;
132     aux = it->funcs;
133     if (!aux || !(aux->flags & ASN1_AFLG_ENCODING))
134         return NULL;
135     return offset2ptr(*pval, aux->enc_offset);
136 }
137
138 void asn1_enc_init(ASN1_VALUE **pval, const ASN1_ITEM *it)
139 {
140     ASN1_ENCODING *enc;
141     enc = asn1_get_enc_ptr(pval, it);
142     if (enc) {
143         enc->enc = NULL;
144         enc->len = 0;
145         enc->modified = 1;
146     }
147 }
148
149 void asn1_enc_free(ASN1_VALUE **pval, const ASN1_ITEM *it)
150 {
151     ASN1_ENCODING *enc;
152     enc = asn1_get_enc_ptr(pval, it);
153     if (enc) {
154         OPENSSL_free(enc->enc);
155         enc->enc = NULL;
156         enc->len = 0;
157         enc->modified = 1;
158     }
159 }
160
161 int asn1_enc_save(ASN1_VALUE **pval, const unsigned char *in, int inlen,
162                   const ASN1_ITEM *it)
163 {
164     ASN1_ENCODING *enc;
165     enc = asn1_get_enc_ptr(pval, it);
166     if (!enc)
167         return 1;
168
169     OPENSSL_free(enc->enc);
170     enc->enc = OPENSSL_malloc(inlen);
171     if (enc->enc == NULL)
172         return 0;
173     memcpy(enc->enc, in, inlen);
174     enc->len = inlen;
175     enc->modified = 0;
176
177     return 1;
178 }
179
180 int asn1_enc_restore(int *len, unsigned char **out, ASN1_VALUE **pval,
181                      const ASN1_ITEM *it)
182 {
183     ASN1_ENCODING *enc;
184     enc = asn1_get_enc_ptr(pval, it);
185     if (!enc || enc->modified)
186         return 0;
187     if (out) {
188         memcpy(*out, enc->enc, enc->len);
189         *out += enc->len;
190     }
191     if (len)
192         *len = enc->len;
193     return 1;
194 }
195
196 /* Given an ASN1_TEMPLATE get a pointer to a field */
197 ASN1_VALUE **asn1_get_field_ptr(ASN1_VALUE **pval, const ASN1_TEMPLATE *tt)
198 {
199     ASN1_VALUE **pvaltmp;
200     pvaltmp = offset2ptr(*pval, tt->offset);
201     /*
202      * NOTE for BOOLEAN types the field is just a plain int so we can't
203      * return int **, so settle for (int *).
204      */
205     return pvaltmp;
206 }
207
208 /*
209  * Handle ANY DEFINED BY template, find the selector, look up the relevant
210  * ASN1_TEMPLATE in the table and return it.
211  */
212
213 const ASN1_TEMPLATE *asn1_do_adb(ASN1_VALUE **pval, const ASN1_TEMPLATE *tt,
214                                  int nullerr)
215 {
216     const ASN1_ADB *adb;
217     const ASN1_ADB_TABLE *atbl;
218     long selector;
219     ASN1_VALUE **sfld;
220     int i;
221     if (!(tt->flags & ASN1_TFLG_ADB_MASK))
222         return tt;
223
224     /* Else ANY DEFINED BY ... get the table */
225     adb = ASN1_ADB_ptr(tt->item);
226
227     /* Get the selector field */
228     sfld = offset2ptr(*pval, adb->offset);
229
230     /* Check if NULL */
231     if (!sfld) {
232         if (!adb->null_tt)
233             goto err;
234         return adb->null_tt;
235     }
236
237     /*
238      * Convert type to a long: NB: don't check for NID_undef here because it
239      * might be a legitimate value in the table
240      */
241     if (tt->flags & ASN1_TFLG_ADB_OID)
242         selector = OBJ_obj2nid((ASN1_OBJECT *)*sfld);
243     else
244         selector = ASN1_INTEGER_get((ASN1_INTEGER *)*sfld);
245
246     /* Let application callback translate value */
247     if (adb->adb_cb != NULL && adb->adb_cb(&selector) == 0) {
248         ASN1err(ASN1_F_ASN1_DO_ADB, ASN1_R_UNSUPPORTED_ANY_DEFINED_BY_TYPE);
249         return NULL;
250     }
251
252     /*
253      * Try to find matching entry in table Maybe should check application
254      * types first to allow application override? Might also be useful to
255      * have a flag which indicates table is sorted and we can do a binary
256      * search. For now stick to a linear search.
257      */
258
259     for (atbl = adb->tbl, i = 0; i < adb->tblcount; i++, atbl++)
260         if (atbl->value == selector)
261             return &atbl->tt;
262
263     /* FIXME: need to search application table too */
264
265     /* No match, return default type */
266     if (!adb->default_tt)
267         goto err;
268     return adb->default_tt;
269
270  err:
271     /* FIXME: should log the value or OID of unsupported type */
272     if (nullerr)
273         ASN1err(ASN1_F_ASN1_DO_ADB, ASN1_R_UNSUPPORTED_ANY_DEFINED_BY_TYPE);
274     return NULL;
275 }