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>
67 static int asn1_i2d_ex_primitive(ASN1_VALUE **pval, unsigned char **out,
68 const ASN1_ITEM *it, int tag, int aclass);
69 static int asn1_set_seq_out(STACK_OF(ASN1_VALUE) *sk, unsigned char **out,
70 int skcontlen, const ASN1_ITEM *item,
71 int do_sort, int iclass);
72 static int asn1_template_ex_i2d(ASN1_VALUE **pval, unsigned char **out,
73 const ASN1_TEMPLATE *tt, int tag, int aclass);
74 static int asn1_item_flags_i2d(ASN1_VALUE *val, unsigned char **out,
75 const ASN1_ITEM *it, int flags);
78 * Top level i2d equivalents: the 'ndef' variant instructs the encoder to use
79 * indefinite length constructed encoding, where appropriate
82 int ASN1_item_ndef_i2d(ASN1_VALUE *val, unsigned char **out,
85 return asn1_item_flags_i2d(val, out, it, ASN1_TFLG_NDEF);
88 int ASN1_item_i2d(ASN1_VALUE *val, unsigned char **out, const ASN1_ITEM *it)
90 return asn1_item_flags_i2d(val, out, it, 0);
94 * Encode an ASN1 item, this is use by the standard 'i2d' function. 'out'
95 * points to a buffer to output the data to. The new i2d has one additional
96 * feature. If the output buffer is NULL (i.e. *out == NULL) then a buffer is
97 * allocated and populated with the encoding.
100 static int asn1_item_flags_i2d(ASN1_VALUE *val, unsigned char **out,
101 const ASN1_ITEM *it, int flags)
104 unsigned char *p, *buf;
106 len = ASN1_item_ex_i2d(&val, NULL, it, -1, flags);
109 buf = OPENSSL_malloc(len);
113 ASN1_item_ex_i2d(&val, &p, it, -1, flags);
118 return ASN1_item_ex_i2d(&val, out, it, -1, flags);
122 * Encode an item, taking care of IMPLICIT tagging (if any). This function
123 * performs the normal item handling: it can be used in external types.
126 int ASN1_item_ex_i2d(ASN1_VALUE **pval, unsigned char **out,
127 const ASN1_ITEM *it, int tag, int aclass)
129 const ASN1_TEMPLATE *tt = NULL;
130 int i, seqcontlen, seqlen, ndef = 1;
131 const ASN1_EXTERN_FUNCS *ef;
132 const ASN1_AUX *aux = it->funcs;
133 ASN1_aux_cb *asn1_cb = 0;
135 if ((it->itype != ASN1_ITYPE_PRIMITIVE) && !*pval)
138 if (aux && aux->asn1_cb)
139 asn1_cb = aux->asn1_cb;
143 case ASN1_ITYPE_PRIMITIVE:
145 return asn1_template_ex_i2d(pval, out, it->templates,
147 return asn1_i2d_ex_primitive(pval, out, it, tag, aclass);
149 case ASN1_ITYPE_MSTRING:
150 return asn1_i2d_ex_primitive(pval, out, it, -1, aclass);
152 case ASN1_ITYPE_CHOICE:
153 if (asn1_cb && !asn1_cb(ASN1_OP_I2D_PRE, pval, it, NULL))
155 i = asn1_get_choice_selector(pval, it);
156 if ((i >= 0) && (i < it->tcount)) {
158 const ASN1_TEMPLATE *chtt;
159 chtt = it->templates + i;
160 pchval = asn1_get_field_ptr(pval, chtt);
161 return asn1_template_ex_i2d(pchval, out, chtt, -1, aclass);
163 /* Fixme: error condition if selector out of range */
164 if (asn1_cb && !asn1_cb(ASN1_OP_I2D_POST, pval, it, NULL))
168 case ASN1_ITYPE_EXTERN:
169 /* If new style i2d it does all the work */
171 return ef->asn1_ex_i2d(pval, out, it, tag, aclass);
173 case ASN1_ITYPE_NDEF_SEQUENCE:
174 /* Use indefinite length constructed if requested */
175 if (aclass & ASN1_TFLG_NDEF)
179 case ASN1_ITYPE_SEQUENCE:
180 i = asn1_enc_restore(&seqcontlen, out, pval, it);
181 /* An error occurred */
184 /* We have a valid cached encoding... */
187 /* Otherwise carry on */
189 /* If no IMPLICIT tagging set to SEQUENCE, UNIVERSAL */
191 tag = V_ASN1_SEQUENCE;
192 /* Retain any other flags in aclass */
193 aclass = (aclass & ~ASN1_TFLG_TAG_CLASS)
196 if (asn1_cb && !asn1_cb(ASN1_OP_I2D_PRE, pval, it, NULL))
198 /* First work out sequence content length */
199 for (i = 0, tt = it->templates; i < it->tcount; tt++, i++) {
200 const ASN1_TEMPLATE *seqtt;
201 ASN1_VALUE **pseqval;
202 seqtt = asn1_do_adb(pval, tt, 1);
205 pseqval = asn1_get_field_ptr(pval, seqtt);
206 /* FIXME: check for errors in enhanced version */
207 seqcontlen += asn1_template_ex_i2d(pseqval, NULL, seqtt,
211 seqlen = ASN1_object_size(ndef, seqcontlen, tag);
214 /* Output SEQUENCE header */
215 ASN1_put_object(out, ndef, seqcontlen, tag, aclass);
216 for (i = 0, tt = it->templates; i < it->tcount; tt++, i++) {
217 const ASN1_TEMPLATE *seqtt;
218 ASN1_VALUE **pseqval;
219 seqtt = asn1_do_adb(pval, tt, 1);
222 pseqval = asn1_get_field_ptr(pval, seqtt);
223 /* FIXME: check for errors in enhanced version */
224 asn1_template_ex_i2d(pseqval, out, seqtt, -1, aclass);
228 if (asn1_cb && !asn1_cb(ASN1_OP_I2D_POST, pval, it, NULL))
239 int ASN1_template_i2d(ASN1_VALUE **pval, unsigned char **out,
240 const ASN1_TEMPLATE *tt)
242 return asn1_template_ex_i2d(pval, out, tt, -1, 0);
245 static int asn1_template_ex_i2d(ASN1_VALUE **pval, unsigned char **out,
246 const ASN1_TEMPLATE *tt, int tag, int iclass)
248 int i, ret, flags, ttag, tclass, ndef;
251 * Work out tag and class to use: tagging may come either from the
252 * template or the arguments, not both because this would create
253 * ambiguity. Additionally the iclass argument may contain some
254 * additional flags which should be noted and passed down to other
257 if (flags & ASN1_TFLG_TAG_MASK) {
258 /* Error if argument and template tagging */
260 /* FIXME: error code here */
262 /* Get tagging from template */
264 tclass = flags & ASN1_TFLG_TAG_CLASS;
265 } else if (tag != -1) {
266 /* No template tagging, get from arguments */
268 tclass = iclass & ASN1_TFLG_TAG_CLASS;
274 * Remove any class mask from iflag.
276 iclass &= ~ASN1_TFLG_TAG_CLASS;
279 * At this point 'ttag' contains the outer tag to use, 'tclass' is the
280 * class and iclass is any flags passed to this function.
283 /* if template and arguments require ndef, use it */
284 if ((flags & ASN1_TFLG_NDEF) && (iclass & ASN1_TFLG_NDEF))
289 if (flags & ASN1_TFLG_SK_MASK) {
290 /* SET OF, SEQUENCE OF */
291 STACK_OF(ASN1_VALUE) *sk = (STACK_OF(ASN1_VALUE) *)*pval;
292 int isset, sktag, skaclass;
293 int skcontlen, sklen;
299 if (flags & ASN1_TFLG_SET_OF) {
301 /* 2 means we reorder */
302 if (flags & ASN1_TFLG_SEQUENCE_OF)
308 * Work out inner tag value: if EXPLICIT or no tagging use underlying
311 if ((ttag != -1) && !(flags & ASN1_TFLG_EXPTAG)) {
315 skaclass = V_ASN1_UNIVERSAL;
319 sktag = V_ASN1_SEQUENCE;
322 /* Determine total length of items */
324 for (i = 0; i < sk_ASN1_VALUE_num(sk); i++) {
325 skitem = sk_ASN1_VALUE_value(sk, i);
326 skcontlen += ASN1_item_ex_i2d(&skitem, NULL,
327 ASN1_ITEM_ptr(tt->item),
330 sklen = ASN1_object_size(ndef, skcontlen, sktag);
331 /* If EXPLICIT need length of surrounding tag */
332 if (flags & ASN1_TFLG_EXPTAG)
333 ret = ASN1_object_size(ndef, sklen, ttag);
340 /* Now encode this lot... */
342 if (flags & ASN1_TFLG_EXPTAG)
343 ASN1_put_object(out, ndef, sklen, ttag, tclass);
344 /* SET or SEQUENCE and IMPLICIT tag */
345 ASN1_put_object(out, ndef, skcontlen, sktag, skaclass);
346 /* And the stuff itself */
347 asn1_set_seq_out(sk, out, skcontlen, ASN1_ITEM_ptr(tt->item),
351 if (flags & ASN1_TFLG_EXPTAG)
358 if (flags & ASN1_TFLG_EXPTAG) {
359 /* EXPLICIT tagging */
360 /* Find length of tagged item */
361 i = ASN1_item_ex_i2d(pval, NULL, ASN1_ITEM_ptr(tt->item), -1, iclass);
364 /* Find length of EXPLICIT tag */
365 ret = ASN1_object_size(ndef, i, ttag);
367 /* Output tag and item */
368 ASN1_put_object(out, ndef, i, ttag, tclass);
369 ASN1_item_ex_i2d(pval, out, ASN1_ITEM_ptr(tt->item), -1, iclass);
376 /* Either normal or IMPLICIT tagging: combine class and flags */
377 return ASN1_item_ex_i2d(pval, out, ASN1_ITEM_ptr(tt->item),
378 ttag, tclass | iclass);
382 /* Temporary structure used to hold DER encoding of items for SET OF */
390 static int der_cmp(const void *a, const void *b)
392 const DER_ENC *d1 = a, *d2 = b;
394 cmplen = (d1->length < d2->length) ? d1->length : d2->length;
395 i = memcmp(d1->data, d2->data, cmplen);
398 return d1->length - d2->length;
401 /* Output the content octets of SET OF or SEQUENCE OF */
403 static int asn1_set_seq_out(STACK_OF(ASN1_VALUE) *sk, unsigned char **out,
404 int skcontlen, const ASN1_ITEM *item,
405 int do_sort, int iclass)
409 unsigned char *tmpdat = NULL, *p = NULL;
410 DER_ENC *derlst = NULL, *tder;
412 /* Don't need to sort less than 2 items */
413 if (sk_ASN1_VALUE_num(sk) < 2)
416 derlst = OPENSSL_malloc(sk_ASN1_VALUE_num(sk)
420 tmpdat = OPENSSL_malloc(skcontlen);
422 OPENSSL_free(derlst);
427 /* If not sorting just output each item */
429 for (i = 0; i < sk_ASN1_VALUE_num(sk); i++) {
430 skitem = sk_ASN1_VALUE_value(sk, i);
431 ASN1_item_ex_i2d(&skitem, out, item, -1, iclass);
437 /* Doing sort: build up a list of each member's DER encoding */
438 for (i = 0, tder = derlst; i < sk_ASN1_VALUE_num(sk); i++, tder++) {
439 skitem = sk_ASN1_VALUE_value(sk, i);
441 tder->length = ASN1_item_ex_i2d(&skitem, &p, item, -1, iclass);
442 tder->field = skitem;
446 qsort(derlst, sk_ASN1_VALUE_num(sk), sizeof(*derlst), der_cmp);
447 /* Output sorted DER encoding */
449 for (i = 0, tder = derlst; i < sk_ASN1_VALUE_num(sk); i++, tder++) {
450 memcpy(p, tder->data, tder->length);
454 /* If do_sort is 2 then reorder the STACK */
456 for (i = 0, tder = derlst; i < sk_ASN1_VALUE_num(sk); i++, tder++)
457 (void)sk_ASN1_VALUE_set(sk, i, tder->field);
459 OPENSSL_free(derlst);
460 OPENSSL_free(tmpdat);
464 static int asn1_i2d_ex_primitive(ASN1_VALUE **pval, unsigned char **out,
465 const ASN1_ITEM *it, int tag, int aclass)
475 * Get length of content octets and maybe find out the underlying type.
478 len = asn1_ex_i2c(pval, NULL, &utype, it);
481 * If SEQUENCE, SET or OTHER then header is included in pseudo content
482 * octets so don't include tag+length. We need to check here because the
483 * call to asn1_ex_i2c() could change utype.
485 if ((utype == V_ASN1_SEQUENCE) || (utype == V_ASN1_SET) ||
486 (utype == V_ASN1_OTHER))
491 /* -1 means omit type */
496 /* -2 return is special meaning use ndef */
502 /* If not implicitly tagged get tag from underlying type */
506 /* Output tag+length followed by content octets */
509 ASN1_put_object(out, ndef, len, tag, aclass);
510 asn1_ex_i2c(pval, *out, &utype, it);
518 return ASN1_object_size(ndef, len, tag);
522 /* Produce content octets from a structure */
524 int asn1_ex_i2c(ASN1_VALUE **pval, unsigned char *cout, int *putype,
527 ASN1_BOOLEAN *tbool = NULL;
531 const unsigned char *cont;
534 const ASN1_PRIMITIVE_FUNCS *pf;
536 if (pf && pf->prim_i2c)
537 return pf->prim_i2c(pval, cout, putype, it);
539 /* Should type be omitted? */
540 if ((it->itype != ASN1_ITYPE_PRIMITIVE)
541 || (it->utype != V_ASN1_BOOLEAN)) {
546 if (it->itype == ASN1_ITYPE_MSTRING) {
547 /* If MSTRING type set the underlying type */
548 strtmp = (ASN1_STRING *)*pval;
549 utype = strtmp->type;
551 } else if (it->utype == V_ASN1_ANY) {
552 /* If ANY set type and pointer to value */
554 typ = (ASN1_TYPE *)*pval;
557 pval = &typ->value.asn1_value;
563 otmp = (ASN1_OBJECT *)*pval;
574 tbool = (ASN1_BOOLEAN *)pval;
577 if (it->utype != V_ASN1_ANY) {
579 * Default handling if value == size field then omit
581 if (*tbool && (it->size > 0))
583 if (!*tbool && !it->size)
586 c = (unsigned char)*tbool;
591 case V_ASN1_BIT_STRING:
592 return i2c_ASN1_BIT_STRING((ASN1_BIT_STRING *)*pval,
593 cout ? &cout : NULL);
596 case V_ASN1_NEG_INTEGER:
597 case V_ASN1_ENUMERATED:
598 case V_ASN1_NEG_ENUMERATED:
600 * These are all have the same content format as ASN1_INTEGER
602 return i2c_ASN1_INTEGER((ASN1_INTEGER *)*pval, cout ? &cout : NULL);
604 case V_ASN1_OCTET_STRING:
605 case V_ASN1_NUMERICSTRING:
606 case V_ASN1_PRINTABLESTRING:
607 case V_ASN1_T61STRING:
608 case V_ASN1_VIDEOTEXSTRING:
609 case V_ASN1_IA5STRING:
611 case V_ASN1_GENERALIZEDTIME:
612 case V_ASN1_GRAPHICSTRING:
613 case V_ASN1_VISIBLESTRING:
614 case V_ASN1_GENERALSTRING:
615 case V_ASN1_UNIVERSALSTRING:
616 case V_ASN1_BMPSTRING:
617 case V_ASN1_UTF8STRING:
618 case V_ASN1_SEQUENCE:
621 /* All based on ASN1_STRING and handled the same */
622 strtmp = (ASN1_STRING *)*pval;
623 /* Special handling for NDEF */
624 if ((it->size == ASN1_TFLG_NDEF)
625 && (strtmp->flags & ASN1_STRING_FLAG_NDEF)) {
630 /* Special return code */
634 len = strtmp->length;
640 memcpy(cout, cont, len);