Move internal only ASN.1 functions to asn1_locl.h
[openssl.git] / crypto / asn1 / tasn_utl.c
1 /* tasn_utl.c */
2 /*
3  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
4  * 2000.
5  */
6 /* ====================================================================
7  * Copyright (c) 2000-2004 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 <string.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, "%s: Reference Count: %d\n", it->sname, *lck);
122 #endif
123 #ifdef REF_CHECK
124     if (ret < 0)
125         fprintf(stderr, "%s, bad reference count\n", it->sname);
126 #endif
127     return ret;
128 }
129
130 static ASN1_ENCODING *asn1_get_enc_ptr(ASN1_VALUE **pval, const ASN1_ITEM *it)
131 {
132     const ASN1_AUX *aux;
133     if (!pval || !*pval)
134         return NULL;
135     aux = it->funcs;
136     if (!aux || !(aux->flags & ASN1_AFLG_ENCODING))
137         return NULL;
138     return offset2ptr(*pval, aux->enc_offset);
139 }
140
141 void asn1_enc_init(ASN1_VALUE **pval, const ASN1_ITEM *it)
142 {
143     ASN1_ENCODING *enc;
144     enc = asn1_get_enc_ptr(pval, it);
145     if (enc) {
146         enc->enc = NULL;
147         enc->len = 0;
148         enc->modified = 1;
149     }
150 }
151
152 void asn1_enc_free(ASN1_VALUE **pval, const ASN1_ITEM *it)
153 {
154     ASN1_ENCODING *enc;
155     enc = asn1_get_enc_ptr(pval, it);
156     if (enc) {
157         if (enc->enc)
158             OPENSSL_free(enc->enc);
159         enc->enc = NULL;
160         enc->len = 0;
161         enc->modified = 1;
162     }
163 }
164
165 int asn1_enc_save(ASN1_VALUE **pval, const unsigned char *in, int inlen,
166                   const ASN1_ITEM *it)
167 {
168     ASN1_ENCODING *enc;
169     enc = asn1_get_enc_ptr(pval, it);
170     if (!enc)
171         return 1;
172
173     if (enc->enc)
174         OPENSSL_free(enc->enc);
175     enc->enc = OPENSSL_malloc(inlen);
176     if (!enc->enc)
177         return 0;
178     memcpy(enc->enc, in, inlen);
179     enc->len = inlen;
180     enc->modified = 0;
181
182     return 1;
183 }
184
185 int asn1_enc_restore(int *len, unsigned char **out, ASN1_VALUE **pval,
186                      const ASN1_ITEM *it)
187 {
188     ASN1_ENCODING *enc;
189     enc = asn1_get_enc_ptr(pval, it);
190     if (!enc || enc->modified)
191         return 0;
192     if (out) {
193         memcpy(*out, enc->enc, enc->len);
194         *out += enc->len;
195     }
196     if (len)
197         *len = enc->len;
198     return 1;
199 }
200
201 /* Given an ASN1_TEMPLATE get a pointer to a field */
202 ASN1_VALUE **asn1_get_field_ptr(ASN1_VALUE **pval, const ASN1_TEMPLATE *tt)
203 {
204     ASN1_VALUE **pvaltmp;
205     if (tt->flags & ASN1_TFLG_COMBINE)
206         return pval;
207     pvaltmp = offset2ptr(*pval, tt->offset);
208     /*
209      * NOTE for BOOLEAN types the field is just a plain int so we can't
210      * return int **, so settle for (int *).
211      */
212     return pvaltmp;
213 }
214
215 /*
216  * Handle ANY DEFINED BY template, find the selector, look up the relevant
217  * ASN1_TEMPLATE in the table and return it.
218  */
219
220 const ASN1_TEMPLATE *asn1_do_adb(ASN1_VALUE **pval, const ASN1_TEMPLATE *tt,
221                                  int nullerr)
222 {
223     const ASN1_ADB *adb;
224     const ASN1_ADB_TABLE *atbl;
225     long selector;
226     ASN1_VALUE **sfld;
227     int i;
228     if (!(tt->flags & ASN1_TFLG_ADB_MASK))
229         return tt;
230
231     /* Else ANY DEFINED BY ... get the table */
232     adb = ASN1_ADB_ptr(tt->item);
233
234     /* Get the selector field */
235     sfld = offset2ptr(*pval, adb->offset);
236
237     /* Check if NULL */
238     if (!sfld) {
239         if (!adb->null_tt)
240             goto err;
241         return adb->null_tt;
242     }
243
244     /*
245      * Convert type to a long: NB: don't check for NID_undef here because it
246      * might be a legitimate value in the table
247      */
248     if (tt->flags & ASN1_TFLG_ADB_OID)
249         selector = OBJ_obj2nid((ASN1_OBJECT *)*sfld);
250     else
251         selector = ASN1_INTEGER_get((ASN1_INTEGER *)*sfld);
252
253     /*
254      * Try to find matching entry in table Maybe should check application
255      * types first to allow application override? Might also be useful to
256      * have a flag which indicates table is sorted and we can do a binary
257      * search. For now stick to a linear search.
258      */
259
260     for (atbl = adb->tbl, i = 0; i < adb->tblcount; i++, atbl++)
261         if (atbl->value == selector)
262             return &atbl->tt;
263
264     /* FIXME: need to search application table too */
265
266     /* No match, return default type */
267     if (!adb->default_tt)
268         goto err;
269     return adb->default_tt;
270
271  err:
272     /* FIXME: should log the value or OID of unsupported type */
273     if (nullerr)
274         ASN1err(ASN1_F_ASN1_DO_ADB, ASN1_R_UNSUPPORTED_ANY_DEFINED_BY_TYPE);
275     return NULL;
276 }