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