3 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
6 /* ====================================================================
7 * Copyright (c) 2000-2004 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
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 * ====================================================================
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).
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"
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);
80 * Top level i2d equivalents: the 'ndef' variant instructs the encoder to use
81 * indefinite length constructed encoding, where appropriate
84 int ASN1_item_ndef_i2d(ASN1_VALUE *val, unsigned char **out,
87 return asn1_item_flags_i2d(val, out, it, ASN1_TFLG_NDEF);
90 int ASN1_item_i2d(ASN1_VALUE *val, unsigned char **out, const ASN1_ITEM *it)
92 return asn1_item_flags_i2d(val, out, it, 0);
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.
102 static int asn1_item_flags_i2d(ASN1_VALUE *val, unsigned char **out,
103 const ASN1_ITEM *it, int flags)
106 unsigned char *p, *buf;
108 len = ASN1_item_ex_i2d(&val, NULL, it, -1, flags);
111 buf = OPENSSL_malloc(len);
115 ASN1_item_ex_i2d(&val, &p, it, -1, flags);
120 return ASN1_item_ex_i2d(&val, out, it, -1, flags);
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.
128 int ASN1_item_ex_i2d(ASN1_VALUE **pval, unsigned char **out,
129 const ASN1_ITEM *it, int tag, int aclass)
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;
137 if ((it->itype != ASN1_ITYPE_PRIMITIVE) && !*pval)
140 if (aux && aux->asn1_cb)
141 asn1_cb = aux->asn1_cb;
145 case ASN1_ITYPE_PRIMITIVE:
147 return asn1_template_ex_i2d(pval, out, it->templates,
149 return asn1_i2d_ex_primitive(pval, out, it, tag, aclass);
151 case ASN1_ITYPE_MSTRING:
152 return asn1_i2d_ex_primitive(pval, out, it, -1, aclass);
154 case ASN1_ITYPE_CHOICE:
155 if (asn1_cb && !asn1_cb(ASN1_OP_I2D_PRE, pval, it, NULL))
157 i = asn1_get_choice_selector(pval, it);
158 if ((i >= 0) && (i < it->tcount)) {
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);
165 /* Fixme: error condition if selector out of range */
166 if (asn1_cb && !asn1_cb(ASN1_OP_I2D_POST, pval, it, NULL))
170 case ASN1_ITYPE_EXTERN:
171 /* If new style i2d it does all the work */
173 return ef->asn1_ex_i2d(pval, out, it, tag, aclass);
175 case ASN1_ITYPE_NDEF_SEQUENCE:
176 /* Use indefinite length constructed if requested */
177 if (aclass & ASN1_TFLG_NDEF)
181 case ASN1_ITYPE_SEQUENCE:
182 i = asn1_enc_restore(&seqcontlen, out, pval, it);
183 /* An error occurred */
186 /* We have a valid cached encoding... */
189 /* Otherwise carry on */
191 /* If no IMPLICIT tagging set to SEQUENCE, UNIVERSAL */
193 tag = V_ASN1_SEQUENCE;
194 /* Retain any other flags in aclass */
195 aclass = (aclass & ~ASN1_TFLG_TAG_CLASS)
198 if (asn1_cb && !asn1_cb(ASN1_OP_I2D_PRE, pval, it, NULL))
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);
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,
213 seqlen = ASN1_object_size(ndef, seqcontlen, tag);
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);
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);
230 if (asn1_cb && !asn1_cb(ASN1_OP_I2D_POST, pval, it, NULL))
241 int ASN1_template_i2d(ASN1_VALUE **pval, unsigned char **out,
242 const ASN1_TEMPLATE *tt)
244 return asn1_template_ex_i2d(pval, out, tt, -1, 0);
247 static int asn1_template_ex_i2d(ASN1_VALUE **pval, unsigned char **out,
248 const ASN1_TEMPLATE *tt, int tag, int iclass)
250 int i, ret, flags, ttag, tclass, ndef;
253 * Work out tag and class to use: tagging may come either from the
254 * template or the arguments, not both because this would create
255 * ambiguity. Additionally the iclass argument may contain some
256 * additional flags which should be noted and passed down to other
259 if (flags & ASN1_TFLG_TAG_MASK) {
260 /* Error if argument and template tagging */
262 /* FIXME: error code here */
264 /* Get tagging from template */
266 tclass = flags & ASN1_TFLG_TAG_CLASS;
267 } else if (tag != -1) {
268 /* No template tagging, get from arguments */
270 tclass = iclass & ASN1_TFLG_TAG_CLASS;
276 * Remove any class mask from iflag.
278 iclass &= ~ASN1_TFLG_TAG_CLASS;
281 * At this point 'ttag' contains the outer tag to use, 'tclass' is the
282 * class and iclass is any flags passed to this function.
285 /* if template and arguments require ndef, use it */
286 if ((flags & ASN1_TFLG_NDEF) && (iclass & ASN1_TFLG_NDEF))
291 if (flags & ASN1_TFLG_SK_MASK) {
292 /* SET OF, SEQUENCE OF */
293 STACK_OF(ASN1_VALUE) *sk = (STACK_OF(ASN1_VALUE) *)*pval;
294 int isset, sktag, skaclass;
295 int skcontlen, sklen;
301 if (flags & ASN1_TFLG_SET_OF) {
303 /* 2 means we reorder */
304 if (flags & ASN1_TFLG_SEQUENCE_OF)
310 * Work out inner tag value: if EXPLICIT or no tagging use underlying
313 if ((ttag != -1) && !(flags & ASN1_TFLG_EXPTAG)) {
317 skaclass = V_ASN1_UNIVERSAL;
321 sktag = V_ASN1_SEQUENCE;
324 /* Determine total length of items */
326 for (i = 0; i < sk_ASN1_VALUE_num(sk); i++) {
327 skitem = sk_ASN1_VALUE_value(sk, i);
328 skcontlen += ASN1_item_ex_i2d(&skitem, NULL,
329 ASN1_ITEM_ptr(tt->item),
332 sklen = ASN1_object_size(ndef, skcontlen, sktag);
333 /* If EXPLICIT need length of surrounding tag */
334 if (flags & ASN1_TFLG_EXPTAG)
335 ret = ASN1_object_size(ndef, sklen, ttag);
342 /* Now encode this lot... */
344 if (flags & ASN1_TFLG_EXPTAG)
345 ASN1_put_object(out, ndef, sklen, ttag, tclass);
346 /* SET or SEQUENCE and IMPLICIT tag */
347 ASN1_put_object(out, ndef, skcontlen, sktag, skaclass);
348 /* And the stuff itself */
349 asn1_set_seq_out(sk, out, skcontlen, ASN1_ITEM_ptr(tt->item),
353 if (flags & ASN1_TFLG_EXPTAG)
360 if (flags & ASN1_TFLG_EXPTAG) {
361 /* EXPLICIT tagging */
362 /* Find length of tagged item */
363 i = ASN1_item_ex_i2d(pval, NULL, ASN1_ITEM_ptr(tt->item), -1, iclass);
366 /* Find length of EXPLICIT tag */
367 ret = ASN1_object_size(ndef, i, ttag);
369 /* Output tag and item */
370 ASN1_put_object(out, ndef, i, ttag, tclass);
371 ASN1_item_ex_i2d(pval, out, ASN1_ITEM_ptr(tt->item), -1, iclass);
378 /* Either normal or IMPLICIT tagging: combine class and flags */
379 return ASN1_item_ex_i2d(pval, out, ASN1_ITEM_ptr(tt->item),
380 ttag, tclass | iclass);
384 /* Temporary structure used to hold DER encoding of items for SET OF */
392 static int der_cmp(const void *a, const void *b)
394 const DER_ENC *d1 = a, *d2 = b;
396 cmplen = (d1->length < d2->length) ? d1->length : d2->length;
397 i = memcmp(d1->data, d2->data, cmplen);
400 return d1->length - d2->length;
403 /* Output the content octets of SET OF or SEQUENCE OF */
405 static int asn1_set_seq_out(STACK_OF(ASN1_VALUE) *sk, unsigned char **out,
406 int skcontlen, const ASN1_ITEM *item,
407 int do_sort, int iclass)
411 unsigned char *tmpdat = NULL, *p = NULL;
412 DER_ENC *derlst = NULL, *tder;
414 /* Don't need to sort less than 2 items */
415 if (sk_ASN1_VALUE_num(sk) < 2)
418 derlst = OPENSSL_malloc(sk_ASN1_VALUE_num(sk)
422 tmpdat = OPENSSL_malloc(skcontlen);
424 OPENSSL_free(derlst);
429 /* If not sorting just output each item */
431 for (i = 0; i < sk_ASN1_VALUE_num(sk); i++) {
432 skitem = sk_ASN1_VALUE_value(sk, i);
433 ASN1_item_ex_i2d(&skitem, out, item, -1, iclass);
439 /* Doing sort: build up a list of each member's DER encoding */
440 for (i = 0, tder = derlst; i < sk_ASN1_VALUE_num(sk); i++, tder++) {
441 skitem = sk_ASN1_VALUE_value(sk, i);
443 tder->length = ASN1_item_ex_i2d(&skitem, &p, item, -1, iclass);
444 tder->field = skitem;
448 qsort(derlst, sk_ASN1_VALUE_num(sk), sizeof(*derlst), der_cmp);
449 /* Output sorted DER encoding */
451 for (i = 0, tder = derlst; i < sk_ASN1_VALUE_num(sk); i++, tder++) {
452 memcpy(p, tder->data, tder->length);
456 /* If do_sort is 2 then reorder the STACK */
458 for (i = 0, tder = derlst; i < sk_ASN1_VALUE_num(sk); i++, tder++)
459 (void)sk_ASN1_VALUE_set(sk, i, tder->field);
461 OPENSSL_free(derlst);
462 OPENSSL_free(tmpdat);
466 static int asn1_i2d_ex_primitive(ASN1_VALUE **pval, unsigned char **out,
467 const ASN1_ITEM *it, int tag, int aclass)
477 * Get length of content octets and maybe find out the underlying type.
480 len = asn1_ex_i2c(pval, NULL, &utype, it);
483 * If SEQUENCE, SET or OTHER then header is included in pseudo content
484 * octets so don't include tag+length. We need to check here because the
485 * call to asn1_ex_i2c() could change utype.
487 if ((utype == V_ASN1_SEQUENCE) || (utype == V_ASN1_SET) ||
488 (utype == V_ASN1_OTHER))
493 /* -1 means omit type */
498 /* -2 return is special meaning use ndef */
504 /* If not implicitly tagged get tag from underlying type */
508 /* Output tag+length followed by content octets */
511 ASN1_put_object(out, ndef, len, tag, aclass);
512 asn1_ex_i2c(pval, *out, &utype, it);
520 return ASN1_object_size(ndef, len, tag);
524 /* Produce content octets from a structure */
526 int asn1_ex_i2c(ASN1_VALUE **pval, unsigned char *cout, int *putype,
529 ASN1_BOOLEAN *tbool = NULL;
533 const unsigned char *cont;
536 const ASN1_PRIMITIVE_FUNCS *pf;
538 if (pf && pf->prim_i2c)
539 return pf->prim_i2c(pval, cout, putype, it);
541 /* Should type be omitted? */
542 if ((it->itype != ASN1_ITYPE_PRIMITIVE)
543 || (it->utype != V_ASN1_BOOLEAN)) {
548 if (it->itype == ASN1_ITYPE_MSTRING) {
549 /* If MSTRING type set the underlying type */
550 strtmp = (ASN1_STRING *)*pval;
551 utype = strtmp->type;
553 } else if (it->utype == V_ASN1_ANY) {
554 /* If ANY set type and pointer to value */
556 typ = (ASN1_TYPE *)*pval;
559 pval = &typ->value.asn1_value;
565 otmp = (ASN1_OBJECT *)*pval;
576 tbool = (ASN1_BOOLEAN *)pval;
579 if (it->utype != V_ASN1_ANY) {
581 * Default handling if value == size field then omit
583 if (*tbool && (it->size > 0))
585 if (!*tbool && !it->size)
588 c = (unsigned char)*tbool;
593 case V_ASN1_BIT_STRING:
594 return i2c_ASN1_BIT_STRING((ASN1_BIT_STRING *)*pval,
595 cout ? &cout : NULL);
598 case V_ASN1_NEG_INTEGER:
599 case V_ASN1_ENUMERATED:
600 case V_ASN1_NEG_ENUMERATED:
602 * These are all have the same content format as ASN1_INTEGER
604 return i2c_ASN1_INTEGER((ASN1_INTEGER *)*pval, cout ? &cout : NULL);
606 case V_ASN1_OCTET_STRING:
607 case V_ASN1_NUMERICSTRING:
608 case V_ASN1_PRINTABLESTRING:
609 case V_ASN1_T61STRING:
610 case V_ASN1_VIDEOTEXSTRING:
611 case V_ASN1_IA5STRING:
613 case V_ASN1_GENERALIZEDTIME:
614 case V_ASN1_GRAPHICSTRING:
615 case V_ASN1_VISIBLESTRING:
616 case V_ASN1_GENERALSTRING:
617 case V_ASN1_UNIVERSALSTRING:
618 case V_ASN1_BMPSTRING:
619 case V_ASN1_UTF8STRING:
620 case V_ASN1_SEQUENCE:
623 /* All based on ASN1_STRING and handled the same */
624 strtmp = (ASN1_STRING *)*pval;
625 /* Special handling for NDEF */
626 if ((it->size == ASN1_TFLG_NDEF)
627 && (strtmp->flags & ASN1_STRING_FLAG_NDEF)) {
632 /* Special return code */
636 len = strtmp->length;
642 memcpy(cout, cont, len);