xref: /freebsd/crypto/openssl/crypto/asn1/tasn_dec.c (revision 430f7286a566b1407c7b32ce13585caf5aa59b92)
1 /* tasn_dec.c */
2 /*
3  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
4  * 2000.
5  */
6 /* ====================================================================
7  * Copyright (c) 2000-2005 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/buffer.h>
66 #include <openssl/err.h>
67 
68 static int asn1_check_eoc(const unsigned char **in, long len);
69 static int asn1_find_end(const unsigned char **in, long len, char inf);
70 
71 static int asn1_collect(BUF_MEM *buf, const unsigned char **in, long len,
72                         char inf, int tag, int aclass, int depth);
73 
74 static int collect_data(BUF_MEM *buf, const unsigned char **p, long plen);
75 
76 static int asn1_check_tlen(long *olen, int *otag, unsigned char *oclass,
77                            char *inf, char *cst,
78                            const unsigned char **in, long len,
79                            int exptag, int expclass, char opt, ASN1_TLC *ctx);
80 
81 static int asn1_template_ex_d2i(ASN1_VALUE **pval,
82                                 const unsigned char **in, long len,
83                                 const ASN1_TEMPLATE *tt, char opt,
84                                 ASN1_TLC *ctx);
85 static int asn1_template_noexp_d2i(ASN1_VALUE **val,
86                                    const unsigned char **in, long len,
87                                    const ASN1_TEMPLATE *tt, char opt,
88                                    ASN1_TLC *ctx);
89 static int asn1_d2i_ex_primitive(ASN1_VALUE **pval,
90                                  const unsigned char **in, long len,
91                                  const ASN1_ITEM *it,
92                                  int tag, int aclass, char opt,
93                                  ASN1_TLC *ctx);
94 
95 /* Table to convert tags to bit values, used for MSTRING type */
96 static const unsigned long tag2bit[32] = {
97     /* tags  0 -  3 */
98     0, 0, 0, B_ASN1_BIT_STRING,
99     /* tags  4- 7 */
100     B_ASN1_OCTET_STRING, 0, 0, B_ASN1_UNKNOWN,
101     /* tags  8-11 */
102     B_ASN1_UNKNOWN, B_ASN1_UNKNOWN, B_ASN1_UNKNOWN, B_ASN1_UNKNOWN,
103     /* tags 12-15 */
104     B_ASN1_UTF8STRING, B_ASN1_UNKNOWN, B_ASN1_UNKNOWN, B_ASN1_UNKNOWN,
105     /* tags 16-19 */
106     B_ASN1_SEQUENCE, 0, B_ASN1_NUMERICSTRING, B_ASN1_PRINTABLESTRING,
107     /* tags 20-22 */
108     B_ASN1_T61STRING, B_ASN1_VIDEOTEXSTRING, B_ASN1_IA5STRING,
109     /* tags 23-24 */
110     B_ASN1_UTCTIME, B_ASN1_GENERALIZEDTIME,
111     /* tags 25-27 */
112     B_ASN1_GRAPHICSTRING, B_ASN1_ISO64STRING, B_ASN1_GENERALSTRING,
113     /* tags 28-31 */
114     B_ASN1_UNIVERSALSTRING, B_ASN1_UNKNOWN, B_ASN1_BMPSTRING, B_ASN1_UNKNOWN,
115 };
116 
117 unsigned long ASN1_tag2bit(int tag)
118 {
119     if ((tag < 0) || (tag > 30))
120         return 0;
121     return tag2bit[tag];
122 }
123 
124 /* Macro to initialize and invalidate the cache */
125 
126 #define asn1_tlc_clear(c)       if (c) (c)->valid = 0
127 /* Version to avoid compiler warning about 'c' always non-NULL */
128 #define asn1_tlc_clear_nc(c)    (c)->valid = 0
129 
130 /*
131  * Decode an ASN1 item, this currently behaves just like a standard 'd2i'
132  * function. 'in' points to a buffer to read the data from, in future we
133  * will have more advanced versions that can input data a piece at a time and
134  * this will simply be a special case.
135  */
136 
137 ASN1_VALUE *ASN1_item_d2i(ASN1_VALUE **pval,
138                           const unsigned char **in, long len,
139                           const ASN1_ITEM *it)
140 {
141     ASN1_TLC c;
142     ASN1_VALUE *ptmpval = NULL;
143     if (!pval)
144         pval = &ptmpval;
145     asn1_tlc_clear_nc(&c);
146     if (ASN1_item_ex_d2i(pval, in, len, it, -1, 0, 0, &c) > 0)
147         return *pval;
148     return NULL;
149 }
150 
151 int ASN1_template_d2i(ASN1_VALUE **pval,
152                       const unsigned char **in, long len,
153                       const ASN1_TEMPLATE *tt)
154 {
155     ASN1_TLC c;
156     asn1_tlc_clear_nc(&c);
157     return asn1_template_ex_d2i(pval, in, len, tt, 0, &c);
158 }
159 
160 /*
161  * Decode an item, taking care of IMPLICIT tagging, if any. If 'opt' set and
162  * tag mismatch return -1 to handle OPTIONAL
163  */
164 
165 int ASN1_item_ex_d2i(ASN1_VALUE **pval, const unsigned char **in, long len,
166                      const ASN1_ITEM *it,
167                      int tag, int aclass, char opt, ASN1_TLC *ctx)
168 {
169     const ASN1_TEMPLATE *tt, *errtt = NULL;
170     const ASN1_COMPAT_FUNCS *cf;
171     const ASN1_EXTERN_FUNCS *ef;
172     const ASN1_AUX *aux = it->funcs;
173     ASN1_aux_cb *asn1_cb;
174     const unsigned char *p = NULL, *q;
175     unsigned char *wp = NULL;   /* BIG FAT WARNING! BREAKS CONST WHERE USED */
176     unsigned char imphack = 0, oclass;
177     char seq_eoc, seq_nolen, cst, isopt;
178     long tmplen;
179     int i;
180     int otag;
181     int ret = 0;
182     ASN1_VALUE **pchptr, *ptmpval;
183     int combine = aclass & ASN1_TFLG_COMBINE;
184     aclass &= ~ASN1_TFLG_COMBINE;
185     if (!pval)
186         return 0;
187     if (aux && aux->asn1_cb)
188         asn1_cb = aux->asn1_cb;
189     else
190         asn1_cb = 0;
191 
192     switch (it->itype) {
193     case ASN1_ITYPE_PRIMITIVE:
194         if (it->templates) {
195             /*
196              * tagging or OPTIONAL is currently illegal on an item template
197              * because the flags can't get passed down. In practice this
198              * isn't a problem: we include the relevant flags from the item
199              * template in the template itself.
200              */
201             if ((tag != -1) || opt) {
202                 ASN1err(ASN1_F_ASN1_ITEM_EX_D2I,
203                         ASN1_R_ILLEGAL_OPTIONS_ON_ITEM_TEMPLATE);
204                 goto err;
205             }
206             return asn1_template_ex_d2i(pval, in, len,
207                                         it->templates, opt, ctx);
208         }
209         return asn1_d2i_ex_primitive(pval, in, len, it,
210                                      tag, aclass, opt, ctx);
211         break;
212 
213     case ASN1_ITYPE_MSTRING:
214         p = *in;
215         /* Just read in tag and class */
216         ret = asn1_check_tlen(NULL, &otag, &oclass, NULL, NULL,
217                               &p, len, -1, 0, 1, ctx);
218         if (!ret) {
219             ASN1err(ASN1_F_ASN1_ITEM_EX_D2I, ERR_R_NESTED_ASN1_ERROR);
220             goto err;
221         }
222 
223         /* Must be UNIVERSAL class */
224         if (oclass != V_ASN1_UNIVERSAL) {
225             /* If OPTIONAL, assume this is OK */
226             if (opt)
227                 return -1;
228             ASN1err(ASN1_F_ASN1_ITEM_EX_D2I, ASN1_R_MSTRING_NOT_UNIVERSAL);
229             goto err;
230         }
231         /* Check tag matches bit map */
232         if (!(ASN1_tag2bit(otag) & it->utype)) {
233             /* If OPTIONAL, assume this is OK */
234             if (opt)
235                 return -1;
236             ASN1err(ASN1_F_ASN1_ITEM_EX_D2I, ASN1_R_MSTRING_WRONG_TAG);
237             goto err;
238         }
239         return asn1_d2i_ex_primitive(pval, in, len, it, otag, 0, 0, ctx);
240 
241     case ASN1_ITYPE_EXTERN:
242         /* Use new style d2i */
243         ef = it->funcs;
244         return ef->asn1_ex_d2i(pval, in, len, it, tag, aclass, opt, ctx);
245 
246     case ASN1_ITYPE_COMPAT:
247         /* we must resort to old style evil hackery */
248         cf = it->funcs;
249 
250         /* If OPTIONAL see if it is there */
251         if (opt) {
252             int exptag;
253             p = *in;
254             if (tag == -1)
255                 exptag = it->utype;
256             else
257                 exptag = tag;
258             /*
259              * Don't care about anything other than presence of expected tag
260              */
261 
262             ret = asn1_check_tlen(NULL, NULL, NULL, NULL, NULL,
263                                   &p, len, exptag, aclass, 1, ctx);
264             if (!ret) {
265                 ASN1err(ASN1_F_ASN1_ITEM_EX_D2I, ERR_R_NESTED_ASN1_ERROR);
266                 goto err;
267             }
268             if (ret == -1)
269                 return -1;
270         }
271 
272         /*
273          * This is the old style evil hack IMPLICIT handling: since the
274          * underlying code is expecting a tag and class other than the one
275          * present we change the buffer temporarily then change it back
276          * afterwards. This doesn't and never did work for tags > 30. Yes
277          * this is *horrible* but it is only needed for old style d2i which
278          * will hopefully not be around for much longer. FIXME: should copy
279          * the buffer then modify it so the input buffer can be const: we
280          * should *always* copy because the old style d2i might modify the
281          * buffer.
282          */
283 
284         if (tag != -1) {
285             wp = *(unsigned char **)in;
286             imphack = *wp;
287             if (p == NULL) {
288                 ASN1err(ASN1_F_ASN1_ITEM_EX_D2I, ERR_R_NESTED_ASN1_ERROR);
289                 goto err;
290             }
291             *wp = (unsigned char)((*p & V_ASN1_CONSTRUCTED)
292                                   | it->utype);
293         }
294 
295         ptmpval = cf->asn1_d2i(pval, in, len);
296 
297         if (tag != -1)
298             *wp = imphack;
299 
300         if (ptmpval)
301             return 1;
302 
303         ASN1err(ASN1_F_ASN1_ITEM_EX_D2I, ERR_R_NESTED_ASN1_ERROR);
304         goto err;
305 
306     case ASN1_ITYPE_CHOICE:
307         if (asn1_cb && !asn1_cb(ASN1_OP_D2I_PRE, pval, it, NULL))
308             goto auxerr;
309         if (*pval) {
310             /* Free up and zero CHOICE value if initialised */
311             i = asn1_get_choice_selector(pval, it);
312             if ((i >= 0) && (i < it->tcount)) {
313                 tt = it->templates + i;
314                 pchptr = asn1_get_field_ptr(pval, tt);
315                 ASN1_template_free(pchptr, tt);
316                 asn1_set_choice_selector(pval, -1, it);
317             }
318         } else if (!ASN1_item_ex_new(pval, it)) {
319             ASN1err(ASN1_F_ASN1_ITEM_EX_D2I, ERR_R_NESTED_ASN1_ERROR);
320             goto err;
321         }
322         /* CHOICE type, try each possibility in turn */
323         p = *in;
324         for (i = 0, tt = it->templates; i < it->tcount; i++, tt++) {
325             pchptr = asn1_get_field_ptr(pval, tt);
326             /*
327              * We mark field as OPTIONAL so its absence can be recognised.
328              */
329             ret = asn1_template_ex_d2i(pchptr, &p, len, tt, 1, ctx);
330             /* If field not present, try the next one */
331             if (ret == -1)
332                 continue;
333             /* If positive return, read OK, break loop */
334             if (ret > 0)
335                 break;
336             /* Otherwise must be an ASN1 parsing error */
337             errtt = tt;
338             ASN1err(ASN1_F_ASN1_ITEM_EX_D2I, ERR_R_NESTED_ASN1_ERROR);
339             goto err;
340         }
341 
342         /* Did we fall off the end without reading anything? */
343         if (i == it->tcount) {
344             /* If OPTIONAL, this is OK */
345             if (opt) {
346                 /* Free and zero it */
347                 ASN1_item_ex_free(pval, it);
348                 return -1;
349             }
350             ASN1err(ASN1_F_ASN1_ITEM_EX_D2I, ASN1_R_NO_MATCHING_CHOICE_TYPE);
351             goto err;
352         }
353 
354         asn1_set_choice_selector(pval, i, it);
355         if (asn1_cb && !asn1_cb(ASN1_OP_D2I_POST, pval, it, NULL))
356             goto auxerr;
357         *in = p;
358         return 1;
359 
360     case ASN1_ITYPE_NDEF_SEQUENCE:
361     case ASN1_ITYPE_SEQUENCE:
362         p = *in;
363         tmplen = len;
364 
365         /* If no IMPLICIT tagging set to SEQUENCE, UNIVERSAL */
366         if (tag == -1) {
367             tag = V_ASN1_SEQUENCE;
368             aclass = V_ASN1_UNIVERSAL;
369         }
370         /* Get SEQUENCE length and update len, p */
371         ret = asn1_check_tlen(&len, NULL, NULL, &seq_eoc, &cst,
372                               &p, len, tag, aclass, opt, ctx);
373         if (!ret) {
374             ASN1err(ASN1_F_ASN1_ITEM_EX_D2I, ERR_R_NESTED_ASN1_ERROR);
375             goto err;
376         } else if (ret == -1)
377             return -1;
378         if (aux && (aux->flags & ASN1_AFLG_BROKEN)) {
379             len = tmplen - (p - *in);
380             seq_nolen = 1;
381         }
382         /* If indefinite we don't do a length check */
383         else
384             seq_nolen = seq_eoc;
385         if (!cst) {
386             ASN1err(ASN1_F_ASN1_ITEM_EX_D2I, ASN1_R_SEQUENCE_NOT_CONSTRUCTED);
387             goto err;
388         }
389 
390         if (!*pval && !ASN1_item_ex_new(pval, it)) {
391             ASN1err(ASN1_F_ASN1_ITEM_EX_D2I, ERR_R_NESTED_ASN1_ERROR);
392             goto err;
393         }
394 
395         if (asn1_cb && !asn1_cb(ASN1_OP_D2I_PRE, pval, it, NULL))
396             goto auxerr;
397 
398         /* Free up and zero any ADB found */
399         for (i = 0, tt = it->templates; i < it->tcount; i++, tt++) {
400             if (tt->flags & ASN1_TFLG_ADB_MASK) {
401                 const ASN1_TEMPLATE *seqtt;
402                 ASN1_VALUE **pseqval;
403                 seqtt = asn1_do_adb(pval, tt, 1);
404                 pseqval = asn1_get_field_ptr(pval, seqtt);
405                 ASN1_template_free(pseqval, seqtt);
406             }
407         }
408 
409         /* Get each field entry */
410         for (i = 0, tt = it->templates; i < it->tcount; i++, tt++) {
411             const ASN1_TEMPLATE *seqtt;
412             ASN1_VALUE **pseqval;
413             seqtt = asn1_do_adb(pval, tt, 1);
414             if (!seqtt)
415                 goto err;
416             pseqval = asn1_get_field_ptr(pval, seqtt);
417             /* Have we ran out of data? */
418             if (!len)
419                 break;
420             q = p;
421             if (asn1_check_eoc(&p, len)) {
422                 if (!seq_eoc) {
423                     ASN1err(ASN1_F_ASN1_ITEM_EX_D2I, ASN1_R_UNEXPECTED_EOC);
424                     goto err;
425                 }
426                 len -= p - q;
427                 seq_eoc = 0;
428                 q = p;
429                 break;
430             }
431             /*
432              * This determines the OPTIONAL flag value. The field cannot be
433              * omitted if it is the last of a SEQUENCE and there is still
434              * data to be read. This isn't strictly necessary but it
435              * increases efficiency in some cases.
436              */
437             if (i == (it->tcount - 1))
438                 isopt = 0;
439             else
440                 isopt = (char)(seqtt->flags & ASN1_TFLG_OPTIONAL);
441             /*
442              * attempt to read in field, allowing each to be OPTIONAL
443              */
444 
445             ret = asn1_template_ex_d2i(pseqval, &p, len, seqtt, isopt, ctx);
446             if (!ret) {
447                 errtt = seqtt;
448                 goto err;
449             } else if (ret == -1) {
450                 /*
451                  * OPTIONAL component absent. Free and zero the field.
452                  */
453                 ASN1_template_free(pseqval, seqtt);
454                 continue;
455             }
456             /* Update length */
457             len -= p - q;
458         }
459 
460         /* Check for EOC if expecting one */
461         if (seq_eoc && !asn1_check_eoc(&p, len)) {
462             ASN1err(ASN1_F_ASN1_ITEM_EX_D2I, ASN1_R_MISSING_EOC);
463             goto err;
464         }
465         /* Check all data read */
466         if (!seq_nolen && len) {
467             ASN1err(ASN1_F_ASN1_ITEM_EX_D2I, ASN1_R_SEQUENCE_LENGTH_MISMATCH);
468             goto err;
469         }
470 
471         /*
472          * If we get here we've got no more data in the SEQUENCE, however we
473          * may not have read all fields so check all remaining are OPTIONAL
474          * and clear any that are.
475          */
476         for (; i < it->tcount; tt++, i++) {
477             const ASN1_TEMPLATE *seqtt;
478             seqtt = asn1_do_adb(pval, tt, 1);
479             if (!seqtt)
480                 goto err;
481             if (seqtt->flags & ASN1_TFLG_OPTIONAL) {
482                 ASN1_VALUE **pseqval;
483                 pseqval = asn1_get_field_ptr(pval, seqtt);
484                 ASN1_template_free(pseqval, seqtt);
485             } else {
486                 errtt = seqtt;
487                 ASN1err(ASN1_F_ASN1_ITEM_EX_D2I, ASN1_R_FIELD_MISSING);
488                 goto err;
489             }
490         }
491         /* Save encoding */
492         if (!asn1_enc_save(pval, *in, p - *in, it))
493             goto auxerr;
494         if (asn1_cb && !asn1_cb(ASN1_OP_D2I_POST, pval, it, NULL))
495             goto auxerr;
496         *in = p;
497         return 1;
498 
499     default:
500         return 0;
501     }
502  auxerr:
503     ASN1err(ASN1_F_ASN1_ITEM_EX_D2I, ASN1_R_AUX_ERROR);
504  err:
505     if (combine == 0)
506         ASN1_item_ex_free(pval, it);
507     if (errtt)
508         ERR_add_error_data(4, "Field=", errtt->field_name,
509                            ", Type=", it->sname);
510     else
511         ERR_add_error_data(2, "Type=", it->sname);
512     return 0;
513 }
514 
515 /*
516  * Templates are handled with two separate functions. One handles any
517  * EXPLICIT tag and the other handles the rest.
518  */
519 
520 static int asn1_template_ex_d2i(ASN1_VALUE **val,
521                                 const unsigned char **in, long inlen,
522                                 const ASN1_TEMPLATE *tt, char opt,
523                                 ASN1_TLC *ctx)
524 {
525     int flags, aclass;
526     int ret;
527     long len;
528     const unsigned char *p, *q;
529     char exp_eoc;
530     if (!val)
531         return 0;
532     flags = tt->flags;
533     aclass = flags & ASN1_TFLG_TAG_CLASS;
534 
535     p = *in;
536 
537     /* Check if EXPLICIT tag expected */
538     if (flags & ASN1_TFLG_EXPTAG) {
539         char cst;
540         /*
541          * Need to work out amount of data available to the inner content and
542          * where it starts: so read in EXPLICIT header to get the info.
543          */
544         ret = asn1_check_tlen(&len, NULL, NULL, &exp_eoc, &cst,
545                               &p, inlen, tt->tag, aclass, opt, ctx);
546         q = p;
547         if (!ret) {
548             ASN1err(ASN1_F_ASN1_TEMPLATE_EX_D2I, ERR_R_NESTED_ASN1_ERROR);
549             return 0;
550         } else if (ret == -1)
551             return -1;
552         if (!cst) {
553             ASN1err(ASN1_F_ASN1_TEMPLATE_EX_D2I,
554                     ASN1_R_EXPLICIT_TAG_NOT_CONSTRUCTED);
555             return 0;
556         }
557         /* We've found the field so it can't be OPTIONAL now */
558         ret = asn1_template_noexp_d2i(val, &p, len, tt, 0, ctx);
559         if (!ret) {
560             ASN1err(ASN1_F_ASN1_TEMPLATE_EX_D2I, ERR_R_NESTED_ASN1_ERROR);
561             return 0;
562         }
563         /* We read the field in OK so update length */
564         len -= p - q;
565         if (exp_eoc) {
566             /* If NDEF we must have an EOC here */
567             if (!asn1_check_eoc(&p, len)) {
568                 ASN1err(ASN1_F_ASN1_TEMPLATE_EX_D2I, ASN1_R_MISSING_EOC);
569                 goto err;
570             }
571         } else {
572             /*
573              * Otherwise we must hit the EXPLICIT tag end or its an error
574              */
575             if (len) {
576                 ASN1err(ASN1_F_ASN1_TEMPLATE_EX_D2I,
577                         ASN1_R_EXPLICIT_LENGTH_MISMATCH);
578                 goto err;
579             }
580         }
581     } else
582         return asn1_template_noexp_d2i(val, in, inlen, tt, opt, ctx);
583 
584     *in = p;
585     return 1;
586 
587  err:
588     ASN1_template_free(val, tt);
589     return 0;
590 }
591 
592 static int asn1_template_noexp_d2i(ASN1_VALUE **val,
593                                    const unsigned char **in, long len,
594                                    const ASN1_TEMPLATE *tt, char opt,
595                                    ASN1_TLC *ctx)
596 {
597     int flags, aclass;
598     int ret;
599     const unsigned char *p, *q;
600     if (!val)
601         return 0;
602     flags = tt->flags;
603     aclass = flags & ASN1_TFLG_TAG_CLASS;
604 
605     p = *in;
606     q = p;
607 
608     if (flags & ASN1_TFLG_SK_MASK) {
609         /* SET OF, SEQUENCE OF */
610         int sktag, skaclass;
611         char sk_eoc;
612         /* First work out expected inner tag value */
613         if (flags & ASN1_TFLG_IMPTAG) {
614             sktag = tt->tag;
615             skaclass = aclass;
616         } else {
617             skaclass = V_ASN1_UNIVERSAL;
618             if (flags & ASN1_TFLG_SET_OF)
619                 sktag = V_ASN1_SET;
620             else
621                 sktag = V_ASN1_SEQUENCE;
622         }
623         /* Get the tag */
624         ret = asn1_check_tlen(&len, NULL, NULL, &sk_eoc, NULL,
625                               &p, len, sktag, skaclass, opt, ctx);
626         if (!ret) {
627             ASN1err(ASN1_F_ASN1_TEMPLATE_NOEXP_D2I, ERR_R_NESTED_ASN1_ERROR);
628             return 0;
629         } else if (ret == -1)
630             return -1;
631         if (!*val)
632             *val = (ASN1_VALUE *)sk_new_null();
633         else {
634             /*
635              * We've got a valid STACK: free up any items present
636              */
637             STACK_OF(ASN1_VALUE) *sktmp = (STACK_OF(ASN1_VALUE) *)*val;
638             ASN1_VALUE *vtmp;
639             while (sk_ASN1_VALUE_num(sktmp) > 0) {
640                 vtmp = sk_ASN1_VALUE_pop(sktmp);
641                 ASN1_item_ex_free(&vtmp, ASN1_ITEM_ptr(tt->item));
642             }
643         }
644 
645         if (!*val) {
646             ASN1err(ASN1_F_ASN1_TEMPLATE_NOEXP_D2I, ERR_R_MALLOC_FAILURE);
647             goto err;
648         }
649 
650         /* Read as many items as we can */
651         while (len > 0) {
652             ASN1_VALUE *skfield;
653             q = p;
654             /* See if EOC found */
655             if (asn1_check_eoc(&p, len)) {
656                 if (!sk_eoc) {
657                     ASN1err(ASN1_F_ASN1_TEMPLATE_NOEXP_D2I,
658                             ASN1_R_UNEXPECTED_EOC);
659                     goto err;
660                 }
661                 len -= p - q;
662                 sk_eoc = 0;
663                 break;
664             }
665             skfield = NULL;
666             if (!ASN1_item_ex_d2i(&skfield, &p, len,
667                                   ASN1_ITEM_ptr(tt->item), -1, 0, 0, ctx)) {
668                 ASN1err(ASN1_F_ASN1_TEMPLATE_NOEXP_D2I,
669                         ERR_R_NESTED_ASN1_ERROR);
670                 goto err;
671             }
672             len -= p - q;
673             if (!sk_ASN1_VALUE_push((STACK_OF(ASN1_VALUE) *)*val, skfield)) {
674                 ASN1err(ASN1_F_ASN1_TEMPLATE_NOEXP_D2I, ERR_R_MALLOC_FAILURE);
675                 goto err;
676             }
677         }
678         if (sk_eoc) {
679             ASN1err(ASN1_F_ASN1_TEMPLATE_NOEXP_D2I, ASN1_R_MISSING_EOC);
680             goto err;
681         }
682     } else if (flags & ASN1_TFLG_IMPTAG) {
683         /* IMPLICIT tagging */
684         ret = ASN1_item_ex_d2i(val, &p, len,
685                                ASN1_ITEM_ptr(tt->item), tt->tag, aclass, opt,
686                                ctx);
687         if (!ret) {
688             ASN1err(ASN1_F_ASN1_TEMPLATE_NOEXP_D2I, ERR_R_NESTED_ASN1_ERROR);
689             goto err;
690         } else if (ret == -1)
691             return -1;
692     } else {
693         /* Nothing special */
694         ret = ASN1_item_ex_d2i(val, &p, len, ASN1_ITEM_ptr(tt->item),
695                                -1, tt->flags & ASN1_TFLG_COMBINE, opt, ctx);
696         if (!ret) {
697             ASN1err(ASN1_F_ASN1_TEMPLATE_NOEXP_D2I, ERR_R_NESTED_ASN1_ERROR);
698             goto err;
699         } else if (ret == -1)
700             return -1;
701     }
702 
703     *in = p;
704     return 1;
705 
706  err:
707     ASN1_template_free(val, tt);
708     return 0;
709 }
710 
711 static int asn1_d2i_ex_primitive(ASN1_VALUE **pval,
712                                  const unsigned char **in, long inlen,
713                                  const ASN1_ITEM *it,
714                                  int tag, int aclass, char opt, ASN1_TLC *ctx)
715 {
716     int ret = 0, utype;
717     long plen;
718     char cst, inf, free_cont = 0;
719     const unsigned char *p;
720     BUF_MEM buf = { 0, NULL, 0 };
721     const unsigned char *cont = NULL;
722     long len;
723     if (!pval) {
724         ASN1err(ASN1_F_ASN1_D2I_EX_PRIMITIVE, ASN1_R_ILLEGAL_NULL);
725         return 0;               /* Should never happen */
726     }
727 
728     if (it->itype == ASN1_ITYPE_MSTRING) {
729         utype = tag;
730         tag = -1;
731     } else
732         utype = it->utype;
733 
734     if (utype == V_ASN1_ANY) {
735         /* If type is ANY need to figure out type from tag */
736         unsigned char oclass;
737         if (tag >= 0) {
738             ASN1err(ASN1_F_ASN1_D2I_EX_PRIMITIVE, ASN1_R_ILLEGAL_TAGGED_ANY);
739             return 0;
740         }
741         if (opt) {
742             ASN1err(ASN1_F_ASN1_D2I_EX_PRIMITIVE,
743                     ASN1_R_ILLEGAL_OPTIONAL_ANY);
744             return 0;
745         }
746         p = *in;
747         ret = asn1_check_tlen(NULL, &utype, &oclass, NULL, NULL,
748                               &p, inlen, -1, 0, 0, ctx);
749         if (!ret) {
750             ASN1err(ASN1_F_ASN1_D2I_EX_PRIMITIVE, ERR_R_NESTED_ASN1_ERROR);
751             return 0;
752         }
753         if (oclass != V_ASN1_UNIVERSAL)
754             utype = V_ASN1_OTHER;
755     }
756     if (tag == -1) {
757         tag = utype;
758         aclass = V_ASN1_UNIVERSAL;
759     }
760     p = *in;
761     /* Check header */
762     ret = asn1_check_tlen(&plen, NULL, NULL, &inf, &cst,
763                           &p, inlen, tag, aclass, opt, ctx);
764     if (!ret) {
765         ASN1err(ASN1_F_ASN1_D2I_EX_PRIMITIVE, ERR_R_NESTED_ASN1_ERROR);
766         return 0;
767     } else if (ret == -1)
768         return -1;
769     ret = 0;
770     /* SEQUENCE, SET and "OTHER" are left in encoded form */
771     if ((utype == V_ASN1_SEQUENCE)
772         || (utype == V_ASN1_SET) || (utype == V_ASN1_OTHER)) {
773         /*
774          * Clear context cache for type OTHER because the auto clear when we
775          * have a exact match wont work
776          */
777         if (utype == V_ASN1_OTHER) {
778             asn1_tlc_clear(ctx);
779         }
780         /* SEQUENCE and SET must be constructed */
781         else if (!cst) {
782             ASN1err(ASN1_F_ASN1_D2I_EX_PRIMITIVE,
783                     ASN1_R_TYPE_NOT_CONSTRUCTED);
784             return 0;
785         }
786 
787         cont = *in;
788         /* If indefinite length constructed find the real end */
789         if (inf) {
790             if (!asn1_find_end(&p, plen, inf))
791                 goto err;
792             len = p - cont;
793         } else {
794             len = p - cont + plen;
795             p += plen;
796         }
797     } else if (cst) {
798         if (utype == V_ASN1_NULL || utype == V_ASN1_BOOLEAN
799             || utype == V_ASN1_OBJECT || utype == V_ASN1_INTEGER
800             || utype == V_ASN1_ENUMERATED) {
801             ASN1err(ASN1_F_ASN1_D2I_EX_PRIMITIVE, ASN1_R_TYPE_NOT_PRIMITIVE);
802             return 0;
803         }
804 
805         /* Free any returned 'buf' content */
806         free_cont = 1;
807         /*
808          * Should really check the internal tags are correct but some things
809          * may get this wrong. The relevant specs say that constructed string
810          * types should be OCTET STRINGs internally irrespective of the type.
811          * So instead just check for UNIVERSAL class and ignore the tag.
812          */
813         if (!asn1_collect(&buf, &p, plen, inf, -1, V_ASN1_UNIVERSAL, 0)) {
814             goto err;
815         }
816         len = buf.length;
817         /* Append a final null to string */
818         if (!BUF_MEM_grow_clean(&buf, len + 1)) {
819             ASN1err(ASN1_F_ASN1_D2I_EX_PRIMITIVE, ERR_R_MALLOC_FAILURE);
820             goto err;
821         }
822         buf.data[len] = 0;
823         cont = (const unsigned char *)buf.data;
824     } else {
825         cont = p;
826         len = plen;
827         p += plen;
828     }
829 
830     /* We now have content length and type: translate into a structure */
831     /* asn1_ex_c2i may reuse allocated buffer, and so sets free_cont to 0 */
832     if (!asn1_ex_c2i(pval, cont, len, utype, &free_cont, it))
833         goto err;
834 
835     *in = p;
836     ret = 1;
837  err:
838     if (free_cont && buf.data)
839         OPENSSL_free(buf.data);
840     return ret;
841 }
842 
843 /* Translate ASN1 content octets into a structure */
844 
845 int asn1_ex_c2i(ASN1_VALUE **pval, const unsigned char *cont, int len,
846                 int utype, char *free_cont, const ASN1_ITEM *it)
847 {
848     ASN1_VALUE **opval = NULL;
849     ASN1_STRING *stmp;
850     ASN1_TYPE *typ = NULL;
851     int ret = 0;
852     const ASN1_PRIMITIVE_FUNCS *pf;
853     ASN1_INTEGER **tint;
854     pf = it->funcs;
855 
856     if (pf && pf->prim_c2i)
857         return pf->prim_c2i(pval, cont, len, utype, free_cont, it);
858     /* If ANY type clear type and set pointer to internal value */
859     if (it->utype == V_ASN1_ANY) {
860         if (!*pval) {
861             typ = ASN1_TYPE_new();
862             if (typ == NULL)
863                 goto err;
864             *pval = (ASN1_VALUE *)typ;
865         } else
866             typ = (ASN1_TYPE *)*pval;
867 
868         if (utype != typ->type)
869             ASN1_TYPE_set(typ, utype, NULL);
870         opval = pval;
871         pval = &typ->value.asn1_value;
872     }
873     switch (utype) {
874     case V_ASN1_OBJECT:
875         if (!c2i_ASN1_OBJECT((ASN1_OBJECT **)pval, &cont, len))
876             goto err;
877         break;
878 
879     case V_ASN1_NULL:
880         if (len) {
881             ASN1err(ASN1_F_ASN1_EX_C2I, ASN1_R_NULL_IS_WRONG_LENGTH);
882             goto err;
883         }
884         *pval = (ASN1_VALUE *)1;
885         break;
886 
887     case V_ASN1_BOOLEAN:
888         if (len != 1) {
889             ASN1err(ASN1_F_ASN1_EX_C2I, ASN1_R_BOOLEAN_IS_WRONG_LENGTH);
890             goto err;
891         } else {
892             ASN1_BOOLEAN *tbool;
893             tbool = (ASN1_BOOLEAN *)pval;
894             *tbool = *cont;
895         }
896         break;
897 
898     case V_ASN1_BIT_STRING:
899         if (!c2i_ASN1_BIT_STRING((ASN1_BIT_STRING **)pval, &cont, len))
900             goto err;
901         break;
902 
903     case V_ASN1_INTEGER:
904     case V_ASN1_ENUMERATED:
905         tint = (ASN1_INTEGER **)pval;
906         if (!c2i_ASN1_INTEGER(tint, &cont, len))
907             goto err;
908         /* Fixup type to match the expected form */
909         (*tint)->type = utype | ((*tint)->type & V_ASN1_NEG);
910         break;
911 
912     case V_ASN1_OCTET_STRING:
913     case V_ASN1_NUMERICSTRING:
914     case V_ASN1_PRINTABLESTRING:
915     case V_ASN1_T61STRING:
916     case V_ASN1_VIDEOTEXSTRING:
917     case V_ASN1_IA5STRING:
918     case V_ASN1_UTCTIME:
919     case V_ASN1_GENERALIZEDTIME:
920     case V_ASN1_GRAPHICSTRING:
921     case V_ASN1_VISIBLESTRING:
922     case V_ASN1_GENERALSTRING:
923     case V_ASN1_UNIVERSALSTRING:
924     case V_ASN1_BMPSTRING:
925     case V_ASN1_UTF8STRING:
926     case V_ASN1_OTHER:
927     case V_ASN1_SET:
928     case V_ASN1_SEQUENCE:
929     default:
930         if (utype == V_ASN1_BMPSTRING && (len & 1)) {
931             ASN1err(ASN1_F_ASN1_EX_C2I, ASN1_R_BMPSTRING_IS_WRONG_LENGTH);
932             goto err;
933         }
934         if (utype == V_ASN1_UNIVERSALSTRING && (len & 3)) {
935             ASN1err(ASN1_F_ASN1_EX_C2I,
936                     ASN1_R_UNIVERSALSTRING_IS_WRONG_LENGTH);
937             goto err;
938         }
939         /* All based on ASN1_STRING and handled the same */
940         if (!*pval) {
941             stmp = ASN1_STRING_type_new(utype);
942             if (!stmp) {
943                 ASN1err(ASN1_F_ASN1_EX_C2I, ERR_R_MALLOC_FAILURE);
944                 goto err;
945             }
946             *pval = (ASN1_VALUE *)stmp;
947         } else {
948             stmp = (ASN1_STRING *)*pval;
949             stmp->type = utype;
950         }
951         /* If we've already allocated a buffer use it */
952         if (*free_cont) {
953             if (stmp->data)
954                 OPENSSL_free(stmp->data);
955             stmp->data = (unsigned char *)cont; /* UGLY CAST! RL */
956             stmp->length = len;
957             *free_cont = 0;
958         } else {
959             if (!ASN1_STRING_set(stmp, cont, len)) {
960                 ASN1err(ASN1_F_ASN1_EX_C2I, ERR_R_MALLOC_FAILURE);
961                 ASN1_STRING_free(stmp);
962                 *pval = NULL;
963                 goto err;
964             }
965         }
966         break;
967     }
968     /* If ASN1_ANY and NULL type fix up value */
969     if (typ && (utype == V_ASN1_NULL))
970         typ->value.ptr = NULL;
971 
972     ret = 1;
973  err:
974     if (!ret) {
975         ASN1_TYPE_free(typ);
976         if (opval)
977             *opval = NULL;
978     }
979     return ret;
980 }
981 
982 /*
983  * This function finds the end of an ASN1 structure when passed its maximum
984  * length, whether it is indefinite length and a pointer to the content. This
985  * is more efficient than calling asn1_collect because it does not recurse on
986  * each indefinite length header.
987  */
988 
989 static int asn1_find_end(const unsigned char **in, long len, char inf)
990 {
991     int expected_eoc;
992     long plen;
993     const unsigned char *p = *in, *q;
994     /* If not indefinite length constructed just add length */
995     if (inf == 0) {
996         *in += len;
997         return 1;
998     }
999     expected_eoc = 1;
1000     /*
1001      * Indefinite length constructed form. Find the end when enough EOCs are
1002      * found. If more indefinite length constructed headers are encountered
1003      * increment the expected eoc count otherwise just skip to the end of the
1004      * data.
1005      */
1006     while (len > 0) {
1007         if (asn1_check_eoc(&p, len)) {
1008             expected_eoc--;
1009             if (expected_eoc == 0)
1010                 break;
1011             len -= 2;
1012             continue;
1013         }
1014         q = p;
1015         /* Just read in a header: only care about the length */
1016         if (!asn1_check_tlen(&plen, NULL, NULL, &inf, NULL, &p, len,
1017                              -1, 0, 0, NULL)) {
1018             ASN1err(ASN1_F_ASN1_FIND_END, ERR_R_NESTED_ASN1_ERROR);
1019             return 0;
1020         }
1021         if (inf)
1022             expected_eoc++;
1023         else
1024             p += plen;
1025         len -= p - q;
1026     }
1027     if (expected_eoc) {
1028         ASN1err(ASN1_F_ASN1_FIND_END, ASN1_R_MISSING_EOC);
1029         return 0;
1030     }
1031     *in = p;
1032     return 1;
1033 }
1034 
1035 /*
1036  * This function collects the asn1 data from a constructred string type into
1037  * a buffer. The values of 'in' and 'len' should refer to the contents of the
1038  * constructed type and 'inf' should be set if it is indefinite length.
1039  */
1040 
1041 #ifndef ASN1_MAX_STRING_NEST
1042 /*
1043  * This determines how many levels of recursion are permitted in ASN1 string
1044  * types. If it is not limited stack overflows can occur. If set to zero no
1045  * recursion is allowed at all. Although zero should be adequate examples
1046  * exist that require a value of 1. So 5 should be more than enough.
1047  */
1048 # define ASN1_MAX_STRING_NEST 5
1049 #endif
1050 
1051 static int asn1_collect(BUF_MEM *buf, const unsigned char **in, long len,
1052                         char inf, int tag, int aclass, int depth)
1053 {
1054     const unsigned char *p, *q;
1055     long plen;
1056     char cst, ininf;
1057     p = *in;
1058     inf &= 1;
1059     /*
1060      * If no buffer and not indefinite length constructed just pass over the
1061      * encoded data
1062      */
1063     if (!buf && !inf) {
1064         *in += len;
1065         return 1;
1066     }
1067     while (len > 0) {
1068         q = p;
1069         /* Check for EOC */
1070         if (asn1_check_eoc(&p, len)) {
1071             /*
1072              * EOC is illegal outside indefinite length constructed form
1073              */
1074             if (!inf) {
1075                 ASN1err(ASN1_F_ASN1_COLLECT, ASN1_R_UNEXPECTED_EOC);
1076                 return 0;
1077             }
1078             inf = 0;
1079             break;
1080         }
1081 
1082         if (!asn1_check_tlen(&plen, NULL, NULL, &ininf, &cst, &p,
1083                              len, tag, aclass, 0, NULL)) {
1084             ASN1err(ASN1_F_ASN1_COLLECT, ERR_R_NESTED_ASN1_ERROR);
1085             return 0;
1086         }
1087 
1088         /* If indefinite length constructed update max length */
1089         if (cst) {
1090             if (depth >= ASN1_MAX_STRING_NEST) {
1091                 ASN1err(ASN1_F_ASN1_COLLECT, ASN1_R_NESTED_ASN1_STRING);
1092                 return 0;
1093             }
1094             if (!asn1_collect(buf, &p, plen, ininf, tag, aclass, depth + 1))
1095                 return 0;
1096         } else if (plen && !collect_data(buf, &p, plen))
1097             return 0;
1098         len -= p - q;
1099     }
1100     if (inf) {
1101         ASN1err(ASN1_F_ASN1_COLLECT, ASN1_R_MISSING_EOC);
1102         return 0;
1103     }
1104     *in = p;
1105     return 1;
1106 }
1107 
1108 static int collect_data(BUF_MEM *buf, const unsigned char **p, long plen)
1109 {
1110     int len;
1111     if (buf) {
1112         len = buf->length;
1113         if (!BUF_MEM_grow_clean(buf, len + plen)) {
1114             ASN1err(ASN1_F_COLLECT_DATA, ERR_R_MALLOC_FAILURE);
1115             return 0;
1116         }
1117         memcpy(buf->data + len, *p, plen);
1118     }
1119     *p += plen;
1120     return 1;
1121 }
1122 
1123 /* Check for ASN1 EOC and swallow it if found */
1124 
1125 static int asn1_check_eoc(const unsigned char **in, long len)
1126 {
1127     const unsigned char *p;
1128     if (len < 2)
1129         return 0;
1130     p = *in;
1131     if (!p[0] && !p[1]) {
1132         *in += 2;
1133         return 1;
1134     }
1135     return 0;
1136 }
1137 
1138 /*
1139  * Check an ASN1 tag and length: a bit like ASN1_get_object but it sets the
1140  * length for indefinite length constructed form, we don't know the exact
1141  * length but we can set an upper bound to the amount of data available minus
1142  * the header length just read.
1143  */
1144 
1145 static int asn1_check_tlen(long *olen, int *otag, unsigned char *oclass,
1146                            char *inf, char *cst,
1147                            const unsigned char **in, long len,
1148                            int exptag, int expclass, char opt, ASN1_TLC *ctx)
1149 {
1150     int i;
1151     int ptag, pclass;
1152     long plen;
1153     const unsigned char *p, *q;
1154     p = *in;
1155     q = p;
1156 
1157     if (ctx && ctx->valid) {
1158         i = ctx->ret;
1159         plen = ctx->plen;
1160         pclass = ctx->pclass;
1161         ptag = ctx->ptag;
1162         p += ctx->hdrlen;
1163     } else {
1164         i = ASN1_get_object(&p, &plen, &ptag, &pclass, len);
1165         if (ctx) {
1166             ctx->ret = i;
1167             ctx->plen = plen;
1168             ctx->pclass = pclass;
1169             ctx->ptag = ptag;
1170             ctx->hdrlen = p - q;
1171             ctx->valid = 1;
1172             /*
1173              * If definite length, and no error, length + header can't exceed
1174              * total amount of data available.
1175              */
1176             if (!(i & 0x81) && ((plen + ctx->hdrlen) > len)) {
1177                 ASN1err(ASN1_F_ASN1_CHECK_TLEN, ASN1_R_TOO_LONG);
1178                 asn1_tlc_clear(ctx);
1179                 return 0;
1180             }
1181         }
1182     }
1183 
1184     if (i & 0x80) {
1185         ASN1err(ASN1_F_ASN1_CHECK_TLEN, ASN1_R_BAD_OBJECT_HEADER);
1186         asn1_tlc_clear(ctx);
1187         return 0;
1188     }
1189     if (exptag >= 0) {
1190         if ((exptag != ptag) || (expclass != pclass)) {
1191             /*
1192              * If type is OPTIONAL, not an error: indicate missing type.
1193              */
1194             if (opt)
1195                 return -1;
1196             asn1_tlc_clear(ctx);
1197             ASN1err(ASN1_F_ASN1_CHECK_TLEN, ASN1_R_WRONG_TAG);
1198             return 0;
1199         }
1200         /*
1201          * We have a tag and class match: assume we are going to do something
1202          * with it
1203          */
1204         asn1_tlc_clear(ctx);
1205     }
1206 
1207     if (i & 1)
1208         plen = len - (p - q);
1209 
1210     if (inf)
1211         *inf = i & 1;
1212 
1213     if (cst)
1214         *cst = i & V_ASN1_CONSTRUCTED;
1215 
1216     if (olen)
1217         *olen = plen;
1218 
1219     if (oclass)
1220         *oclass = pclass;
1221 
1222     if (otag)
1223         *otag = ptag;
1224 
1225     *in = p;
1226     return 1;
1227 }
1228