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