d7588616d0681ae8c5f7ce26797243e593088f82
[oweals/openssl.git] / crypto / asn1 / tasn_enc.c
1 /* tasn_enc.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 "cryptlib.h"
63 #include <openssl/asn1.h>
64 #include <openssl/asn1t.h>
65 #include <openssl/objects.h>
66 #include "internal/asn1_int.h"
67 #include "asn1_locl.h"
68
69 static int asn1_i2d_ex_primitive(ASN1_VALUE **pval, unsigned char **out,
70                                  const ASN1_ITEM *it, int tag, int aclass);
71 static int asn1_set_seq_out(STACK_OF(ASN1_VALUE) *sk, unsigned char **out,
72                             int skcontlen, const ASN1_ITEM *item,
73                             int do_sort, int iclass);
74 static int asn1_template_ex_i2d(ASN1_VALUE **pval, unsigned char **out,
75                                 const ASN1_TEMPLATE *tt, int tag, int aclass);
76 static int asn1_item_flags_i2d(ASN1_VALUE *val, unsigned char **out,
77                                const ASN1_ITEM *it, int flags);
78
79 /*
80  * Top level i2d equivalents: the 'ndef' variant instructs the encoder to use
81  * indefinite length constructed encoding, where appropriate
82  */
83
84 int ASN1_item_ndef_i2d(ASN1_VALUE *val, unsigned char **out,
85                        const ASN1_ITEM *it)
86 {
87     return asn1_item_flags_i2d(val, out, it, ASN1_TFLG_NDEF);
88 }
89
90 int ASN1_item_i2d(ASN1_VALUE *val, unsigned char **out, const ASN1_ITEM *it)
91 {
92     return asn1_item_flags_i2d(val, out, it, 0);
93 }
94
95 /*
96  * Encode an ASN1 item, this is use by the standard 'i2d' function. 'out'
97  * points to a buffer to output the data to. The new i2d has one additional
98  * feature. If the output buffer is NULL (i.e. *out == NULL) then a buffer is
99  * allocated and populated with the encoding.
100  */
101
102 static int asn1_item_flags_i2d(ASN1_VALUE *val, unsigned char **out,
103                                const ASN1_ITEM *it, int flags)
104 {
105     if (out && !*out) {
106         unsigned char *p, *buf;
107         int len;
108         len = ASN1_item_ex_i2d(&val, NULL, it, -1, flags);
109         if (len <= 0)
110             return len;
111         buf = OPENSSL_malloc(len);
112         if (!buf)
113             return -1;
114         p = buf;
115         ASN1_item_ex_i2d(&val, &p, it, -1, flags);
116         *out = buf;
117         return len;
118     }
119
120     return ASN1_item_ex_i2d(&val, out, it, -1, flags);
121 }
122
123 /*
124  * Encode an item, taking care of IMPLICIT tagging (if any). This function
125  * performs the normal item handling: it can be used in external types.
126  */
127
128 int ASN1_item_ex_i2d(ASN1_VALUE **pval, unsigned char **out,
129                      const ASN1_ITEM *it, int tag, int aclass)
130 {
131     const ASN1_TEMPLATE *tt = NULL;
132     int i, seqcontlen, seqlen, ndef = 1;
133     const ASN1_EXTERN_FUNCS *ef;
134     const ASN1_AUX *aux = it->funcs;
135     ASN1_aux_cb *asn1_cb = 0;
136
137     if ((it->itype != ASN1_ITYPE_PRIMITIVE) && !*pval)
138         return 0;
139
140     if (aux && aux->asn1_cb)
141         asn1_cb = aux->asn1_cb;
142
143     switch (it->itype) {
144
145     case ASN1_ITYPE_PRIMITIVE:
146         if (it->templates)
147             return asn1_template_ex_i2d(pval, out, it->templates,
148                                         tag, aclass);
149         return asn1_i2d_ex_primitive(pval, out, it, tag, aclass);
150
151     case ASN1_ITYPE_MSTRING:
152         return asn1_i2d_ex_primitive(pval, out, it, -1, aclass);
153
154     case ASN1_ITYPE_CHOICE:
155         if (asn1_cb && !asn1_cb(ASN1_OP_I2D_PRE, pval, it, NULL))
156             return 0;
157         i = asn1_get_choice_selector(pval, it);
158         if ((i >= 0) && (i < it->tcount)) {
159             ASN1_VALUE **pchval;
160             const ASN1_TEMPLATE *chtt;
161             chtt = it->templates + i;
162             pchval = asn1_get_field_ptr(pval, chtt);
163             return asn1_template_ex_i2d(pchval, out, chtt, -1, aclass);
164         }
165         /* Fixme: error condition if selector out of range */
166         if (asn1_cb && !asn1_cb(ASN1_OP_I2D_POST, pval, it, NULL))
167             return 0;
168         break;
169
170     case ASN1_ITYPE_EXTERN:
171         /* If new style i2d it does all the work */
172         ef = it->funcs;
173         return ef->asn1_ex_i2d(pval, out, it, tag, aclass);
174
175     case ASN1_ITYPE_NDEF_SEQUENCE:
176         /* Use indefinite length constructed if requested */
177         if (aclass & ASN1_TFLG_NDEF)
178             ndef = 2;
179         /* fall through */
180
181     case ASN1_ITYPE_SEQUENCE:
182         i = asn1_enc_restore(&seqcontlen, out, pval, it);
183         /* An error occurred */
184         if (i < 0)
185             return 0;
186         /* We have a valid cached encoding... */
187         if (i > 0)
188             return seqcontlen;
189         /* Otherwise carry on */
190         seqcontlen = 0;
191         /* If no IMPLICIT tagging set to SEQUENCE, UNIVERSAL */
192         if (tag == -1) {
193             tag = V_ASN1_SEQUENCE;
194             /* Retain any other flags in aclass */
195             aclass = (aclass & ~ASN1_TFLG_TAG_CLASS)
196                 | V_ASN1_UNIVERSAL;
197         }
198         if (asn1_cb && !asn1_cb(ASN1_OP_I2D_PRE, pval, it, NULL))
199             return 0;
200         /* First work out sequence content length */
201         for (i = 0, tt = it->templates; i < it->tcount; tt++, i++) {
202             const ASN1_TEMPLATE *seqtt;
203             ASN1_VALUE **pseqval;
204             seqtt = asn1_do_adb(pval, tt, 1);
205             if (!seqtt)
206                 return 0;
207             pseqval = asn1_get_field_ptr(pval, seqtt);
208             /* FIXME: check for errors in enhanced version */
209             seqcontlen += asn1_template_ex_i2d(pseqval, NULL, seqtt,
210                                                -1, aclass);
211         }
212
213         seqlen = ASN1_object_size(ndef, seqcontlen, tag);
214         if (!out)
215             return seqlen;
216         /* Output SEQUENCE header */
217         ASN1_put_object(out, ndef, seqcontlen, tag, aclass);
218         for (i = 0, tt = it->templates; i < it->tcount; tt++, i++) {
219             const ASN1_TEMPLATE *seqtt;
220             ASN1_VALUE **pseqval;
221             seqtt = asn1_do_adb(pval, tt, 1);
222             if (!seqtt)
223                 return 0;
224             pseqval = asn1_get_field_ptr(pval, seqtt);
225             /* FIXME: check for errors in enhanced version */
226             asn1_template_ex_i2d(pseqval, out, seqtt, -1, aclass);
227         }
228         if (ndef == 2)
229             ASN1_put_eoc(out);
230         if (asn1_cb && !asn1_cb(ASN1_OP_I2D_POST, pval, it, NULL))
231             return 0;
232         return seqlen;
233
234     default:
235         return 0;
236
237     }
238     return 0;
239 }
240
241 static int asn1_template_ex_i2d(ASN1_VALUE **pval, unsigned char **out,
242                                 const ASN1_TEMPLATE *tt, int tag, int iclass)
243 {
244     int i, ret, flags, ttag, tclass, ndef;
245     flags = tt->flags;
246     /*
247      * Work out tag and class to use: tagging may come either from the
248      * template or the arguments, not both because this would create
249      * ambiguity. Additionally the iclass argument may contain some
250      * additional flags which should be noted and passed down to other
251      * levels.
252      */
253     if (flags & ASN1_TFLG_TAG_MASK) {
254         /* Error if argument and template tagging */
255         if (tag != -1)
256             /* FIXME: error code here */
257             return -1;
258         /* Get tagging from template */
259         ttag = tt->tag;
260         tclass = flags & ASN1_TFLG_TAG_CLASS;
261     } else if (tag != -1) {
262         /* No template tagging, get from arguments */
263         ttag = tag;
264         tclass = iclass & ASN1_TFLG_TAG_CLASS;
265     } else {
266         ttag = -1;
267         tclass = 0;
268     }
269     /*
270      * Remove any class mask from iflag.
271      */
272     iclass &= ~ASN1_TFLG_TAG_CLASS;
273
274     /*
275      * At this point 'ttag' contains the outer tag to use, 'tclass' is the
276      * class and iclass is any flags passed to this function.
277      */
278
279     /* if template and arguments require ndef, use it */
280     if ((flags & ASN1_TFLG_NDEF) && (iclass & ASN1_TFLG_NDEF))
281         ndef = 2;
282     else
283         ndef = 1;
284
285     if (flags & ASN1_TFLG_SK_MASK) {
286         /* SET OF, SEQUENCE OF */
287         STACK_OF(ASN1_VALUE) *sk = (STACK_OF(ASN1_VALUE) *)*pval;
288         int isset, sktag, skaclass;
289         int skcontlen, sklen;
290         ASN1_VALUE *skitem;
291
292         if (!*pval)
293             return 0;
294
295         if (flags & ASN1_TFLG_SET_OF) {
296             isset = 1;
297             /* 2 means we reorder */
298             if (flags & ASN1_TFLG_SEQUENCE_OF)
299                 isset = 2;
300         } else
301             isset = 0;
302
303         /*
304          * Work out inner tag value: if EXPLICIT or no tagging use underlying
305          * type.
306          */
307         if ((ttag != -1) && !(flags & ASN1_TFLG_EXPTAG)) {
308             sktag = ttag;
309             skaclass = tclass;
310         } else {
311             skaclass = V_ASN1_UNIVERSAL;
312             if (isset)
313                 sktag = V_ASN1_SET;
314             else
315                 sktag = V_ASN1_SEQUENCE;
316         }
317
318         /* Determine total length of items */
319         skcontlen = 0;
320         for (i = 0; i < sk_ASN1_VALUE_num(sk); i++) {
321             skitem = sk_ASN1_VALUE_value(sk, i);
322             skcontlen += ASN1_item_ex_i2d(&skitem, NULL,
323                                           ASN1_ITEM_ptr(tt->item),
324                                           -1, iclass);
325         }
326         sklen = ASN1_object_size(ndef, skcontlen, sktag);
327         /* If EXPLICIT need length of surrounding tag */
328         if (flags & ASN1_TFLG_EXPTAG)
329             ret = ASN1_object_size(ndef, sklen, ttag);
330         else
331             ret = sklen;
332
333         if (!out)
334             return ret;
335
336         /* Now encode this lot... */
337         /* EXPLICIT tag */
338         if (flags & ASN1_TFLG_EXPTAG)
339             ASN1_put_object(out, ndef, sklen, ttag, tclass);
340         /* SET or SEQUENCE and IMPLICIT tag */
341         ASN1_put_object(out, ndef, skcontlen, sktag, skaclass);
342         /* And the stuff itself */
343         asn1_set_seq_out(sk, out, skcontlen, ASN1_ITEM_ptr(tt->item),
344                          isset, iclass);
345         if (ndef == 2) {
346             ASN1_put_eoc(out);
347             if (flags & ASN1_TFLG_EXPTAG)
348                 ASN1_put_eoc(out);
349         }
350
351         return ret;
352     }
353
354     if (flags & ASN1_TFLG_EXPTAG) {
355         /* EXPLICIT tagging */
356         /* Find length of tagged item */
357         i = ASN1_item_ex_i2d(pval, NULL, ASN1_ITEM_ptr(tt->item), -1, iclass);
358         if (!i)
359             return 0;
360         /* Find length of EXPLICIT tag */
361         ret = ASN1_object_size(ndef, i, ttag);
362         if (out) {
363             /* Output tag and item */
364             ASN1_put_object(out, ndef, i, ttag, tclass);
365             ASN1_item_ex_i2d(pval, out, ASN1_ITEM_ptr(tt->item), -1, iclass);
366             if (ndef == 2)
367                 ASN1_put_eoc(out);
368         }
369         return ret;
370     }
371
372     /* Either normal or IMPLICIT tagging: combine class and flags */
373     return ASN1_item_ex_i2d(pval, out, ASN1_ITEM_ptr(tt->item),
374                             ttag, tclass | iclass);
375
376 }
377
378 /* Temporary structure used to hold DER encoding of items for SET OF */
379
380 typedef struct {
381     unsigned char *data;
382     int length;
383     ASN1_VALUE *field;
384 } DER_ENC;
385
386 static int der_cmp(const void *a, const void *b)
387 {
388     const DER_ENC *d1 = a, *d2 = b;
389     int cmplen, i;
390     cmplen = (d1->length < d2->length) ? d1->length : d2->length;
391     i = memcmp(d1->data, d2->data, cmplen);
392     if (i)
393         return i;
394     return d1->length - d2->length;
395 }
396
397 /* Output the content octets of SET OF or SEQUENCE OF */
398
399 static int asn1_set_seq_out(STACK_OF(ASN1_VALUE) *sk, unsigned char **out,
400                             int skcontlen, const ASN1_ITEM *item,
401                             int do_sort, int iclass)
402 {
403     int i;
404     ASN1_VALUE *skitem;
405     unsigned char *tmpdat = NULL, *p = NULL;
406     DER_ENC *derlst = NULL, *tder;
407     if (do_sort) {
408         /* Don't need to sort less than 2 items */
409         if (sk_ASN1_VALUE_num(sk) < 2)
410             do_sort = 0;
411         else {
412             derlst = OPENSSL_malloc(sk_ASN1_VALUE_num(sk)
413                                     * sizeof(*derlst));
414             if (!derlst)
415                 return 0;
416             tmpdat = OPENSSL_malloc(skcontlen);
417             if (!tmpdat) {
418                 OPENSSL_free(derlst);
419                 return 0;
420             }
421         }
422     }
423     /* If not sorting just output each item */
424     if (!do_sort) {
425         for (i = 0; i < sk_ASN1_VALUE_num(sk); i++) {
426             skitem = sk_ASN1_VALUE_value(sk, i);
427             ASN1_item_ex_i2d(&skitem, out, item, -1, iclass);
428         }
429         return 1;
430     }
431     p = tmpdat;
432
433     /* Doing sort: build up a list of each member's DER encoding */
434     for (i = 0, tder = derlst; i < sk_ASN1_VALUE_num(sk); i++, tder++) {
435         skitem = sk_ASN1_VALUE_value(sk, i);
436         tder->data = p;
437         tder->length = ASN1_item_ex_i2d(&skitem, &p, item, -1, iclass);
438         tder->field = skitem;
439     }
440
441     /* Now sort them */
442     qsort(derlst, sk_ASN1_VALUE_num(sk), sizeof(*derlst), der_cmp);
443     /* Output sorted DER encoding */
444     p = *out;
445     for (i = 0, tder = derlst; i < sk_ASN1_VALUE_num(sk); i++, tder++) {
446         memcpy(p, tder->data, tder->length);
447         p += tder->length;
448     }
449     *out = p;
450     /* If do_sort is 2 then reorder the STACK */
451     if (do_sort == 2) {
452         for (i = 0, tder = derlst; i < sk_ASN1_VALUE_num(sk); i++, tder++)
453             (void)sk_ASN1_VALUE_set(sk, i, tder->field);
454     }
455     OPENSSL_free(derlst);
456     OPENSSL_free(tmpdat);
457     return 1;
458 }
459
460 static int asn1_i2d_ex_primitive(ASN1_VALUE **pval, unsigned char **out,
461                                  const ASN1_ITEM *it, int tag, int aclass)
462 {
463     int len;
464     int utype;
465     int usetag;
466     int ndef = 0;
467
468     utype = it->utype;
469
470     /*
471      * Get length of content octets and maybe find out the underlying type.
472      */
473
474     len = asn1_ex_i2c(pval, NULL, &utype, it);
475
476     /*
477      * If SEQUENCE, SET or OTHER then header is included in pseudo content
478      * octets so don't include tag+length. We need to check here because the
479      * call to asn1_ex_i2c() could change utype.
480      */
481     if ((utype == V_ASN1_SEQUENCE) || (utype == V_ASN1_SET) ||
482         (utype == V_ASN1_OTHER))
483         usetag = 0;
484     else
485         usetag = 1;
486
487     /* -1 means omit type */
488
489     if (len == -1)
490         return 0;
491
492     /* -2 return is special meaning use ndef */
493     if (len == -2) {
494         ndef = 2;
495         len = 0;
496     }
497
498     /* If not implicitly tagged get tag from underlying type */
499     if (tag == -1)
500         tag = utype;
501
502     /* Output tag+length followed by content octets */
503     if (out) {
504         if (usetag)
505             ASN1_put_object(out, ndef, len, tag, aclass);
506         asn1_ex_i2c(pval, *out, &utype, it);
507         if (ndef)
508             ASN1_put_eoc(out);
509         else
510             *out += len;
511     }
512
513     if (usetag)
514         return ASN1_object_size(ndef, len, tag);
515     return len;
516 }
517
518 /* Produce content octets from a structure */
519
520 int asn1_ex_i2c(ASN1_VALUE **pval, unsigned char *cout, int *putype,
521                 const ASN1_ITEM *it)
522 {
523     ASN1_BOOLEAN *tbool = NULL;
524     ASN1_STRING *strtmp;
525     ASN1_OBJECT *otmp;
526     int utype;
527     const unsigned char *cont;
528     unsigned char c;
529     int len;
530     const ASN1_PRIMITIVE_FUNCS *pf;
531     pf = it->funcs;
532     if (pf && pf->prim_i2c)
533         return pf->prim_i2c(pval, cout, putype, it);
534
535     /* Should type be omitted? */
536     if ((it->itype != ASN1_ITYPE_PRIMITIVE)
537         || (it->utype != V_ASN1_BOOLEAN)) {
538         if (!*pval)
539             return -1;
540     }
541
542     if (it->itype == ASN1_ITYPE_MSTRING) {
543         /* If MSTRING type set the underlying type */
544         strtmp = (ASN1_STRING *)*pval;
545         utype = strtmp->type;
546         *putype = utype;
547     } else if (it->utype == V_ASN1_ANY) {
548         /* If ANY set type and pointer to value */
549         ASN1_TYPE *typ;
550         typ = (ASN1_TYPE *)*pval;
551         utype = typ->type;
552         *putype = utype;
553         pval = &typ->value.asn1_value;
554     } else
555         utype = *putype;
556
557     switch (utype) {
558     case V_ASN1_OBJECT:
559         otmp = (ASN1_OBJECT *)*pval;
560         cont = otmp->data;
561         len = otmp->length;
562         break;
563
564     case V_ASN1_NULL:
565         cont = NULL;
566         len = 0;
567         break;
568
569     case V_ASN1_BOOLEAN:
570         tbool = (ASN1_BOOLEAN *)pval;
571         if (*tbool == -1)
572             return -1;
573         if (it->utype != V_ASN1_ANY) {
574             /*
575              * Default handling if value == size field then omit
576              */
577             if (*tbool && (it->size > 0))
578                 return -1;
579             if (!*tbool && !it->size)
580                 return -1;
581         }
582         c = (unsigned char)*tbool;
583         cont = &c;
584         len = 1;
585         break;
586
587     case V_ASN1_BIT_STRING:
588         return i2c_ASN1_BIT_STRING((ASN1_BIT_STRING *)*pval,
589                                    cout ? &cout : NULL);
590
591     case V_ASN1_INTEGER:
592     case V_ASN1_NEG_INTEGER:
593     case V_ASN1_ENUMERATED:
594     case V_ASN1_NEG_ENUMERATED:
595         /*
596          * These are all have the same content format as ASN1_INTEGER
597          */
598         return i2c_ASN1_INTEGER((ASN1_INTEGER *)*pval, cout ? &cout : NULL);
599
600     case V_ASN1_OCTET_STRING:
601     case V_ASN1_NUMERICSTRING:
602     case V_ASN1_PRINTABLESTRING:
603     case V_ASN1_T61STRING:
604     case V_ASN1_VIDEOTEXSTRING:
605     case V_ASN1_IA5STRING:
606     case V_ASN1_UTCTIME:
607     case V_ASN1_GENERALIZEDTIME:
608     case V_ASN1_GRAPHICSTRING:
609     case V_ASN1_VISIBLESTRING:
610     case V_ASN1_GENERALSTRING:
611     case V_ASN1_UNIVERSALSTRING:
612     case V_ASN1_BMPSTRING:
613     case V_ASN1_UTF8STRING:
614     case V_ASN1_SEQUENCE:
615     case V_ASN1_SET:
616     default:
617         /* All based on ASN1_STRING and handled the same */
618         strtmp = (ASN1_STRING *)*pval;
619         /* Special handling for NDEF */
620         if ((it->size == ASN1_TFLG_NDEF)
621             && (strtmp->flags & ASN1_STRING_FLAG_NDEF)) {
622             if (cout) {
623                 strtmp->data = cout;
624                 strtmp->length = 0;
625             }
626             /* Special return code */
627             return -2;
628         }
629         cont = strtmp->data;
630         len = strtmp->length;
631
632         break;
633
634     }
635     if (cout && len)
636         memcpy(cout, cont, len);
637     return len;
638 }