2 /* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 2000-2002 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgment:
22 * "This product includes software developed by the OpenSSL Project
23 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26 * endorse or promote products derived from this software without
27 * prior written permission. For written permission, please contact
28 * licensing@OpenSSL.org.
30 * 5. Products derived from this software may not be called "OpenSSL"
31 * nor may "OpenSSL" appear in their names without prior written
32 * permission of the OpenSSL Project.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
51 * ====================================================================
53 * This product includes cryptographic software written by Eric Young
54 * (eay@cryptsoft.com). This product includes software written by Tim
55 * Hudson (tjh@cryptsoft.com).
62 #include <openssl/asn1.h>
63 #include <openssl/asn1t.h>
64 #include <openssl/objects.h>
66 static int asn1_i2d_ex_primitive(ASN1_VALUE **pval, unsigned char **out,
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,
75 static int asn1_item_flags_i2d(ASN1_VALUE *val, unsigned char **out,
76 const ASN1_ITEM *it, int flags);
78 /* Top level i2d equivalents: the 'ndef' variant instructs the encoder
79 * to use indefinite length constructed encoding, where appropriate
82 int ASN1_item_ndef_i2d(ASN1_VALUE *val, unsigned char **out, const ASN1_ITEM *it)
84 return asn1_item_flags_i2d(val, out, it, ASN1_TFLG_NDEF);
87 int ASN1_item_i2d(ASN1_VALUE *val, unsigned char **out, const ASN1_ITEM *it)
89 return asn1_item_flags_i2d(val, out, it, 0);
92 /* Encode an ASN1 item, this is use by the
93 * standard 'i2d' function. 'out' points to
94 * a buffer to output the data to.
96 * The new i2d has one additional feature. If the output
97 * buffer is NULL (i.e. *out == NULL) then a buffer is
98 * allocated and populated with the encoding.
101 static int asn1_item_flags_i2d(ASN1_VALUE *val, unsigned char **out, const ASN1_ITEM *it, int flags)
104 unsigned char *p, *buf;
106 len = ASN1_item_ex_i2d(&val, NULL, it, -1, flags);
107 if(len <= 0) return len;
108 buf = OPENSSL_malloc(len);
111 ASN1_item_ex_i2d(&val, &p, it, -1, flags);
116 return ASN1_item_ex_i2d(&val, out, it, -1, flags);
119 /* Encode an item, taking care of IMPLICIT tagging (if any).
120 * This function performs the normal item handling: it can be
121 * used in external types.
124 int ASN1_item_ex_i2d(ASN1_VALUE **pval, unsigned char **out,
125 const ASN1_ITEM *it, int tag, int aclass)
127 const ASN1_TEMPLATE *tt = NULL;
128 unsigned char *p = NULL;
129 int i, seqcontlen, seqlen, ndef = 1;
130 const ASN1_COMPAT_FUNCS *cf;
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);
150 case ASN1_ITYPE_MSTRING:
151 return asn1_i2d_ex_primitive(pval, out, it, -1, aclass);
153 case ASN1_ITYPE_CHOICE:
154 if(asn1_cb && !asn1_cb(ASN1_OP_I2D_PRE, pval, it))
156 i = asn1_get_choice_selector(pval, it);
157 if((i >= 0) && (i < it->tcount)) {
159 const ASN1_TEMPLATE *chtt;
160 chtt = it->templates + i;
161 pchval = asn1_get_field_ptr(pval, chtt);
162 return asn1_template_ex_i2d(pchval, out, chtt,
165 /* Fixme: error condition if selector out of range */
166 if(asn1_cb && !asn1_cb(ASN1_OP_I2D_POST, pval, it))
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_COMPAT:
176 /* old style hackery... */
179 i = cf->asn1_i2d(*pval, out);
180 /* Fixup for IMPLICIT tag: note this messes up for tags > 30,
181 * but so did the old code. Tags > 30 are very rare anyway.
183 if(out && (tag != -1))
184 *p = aclass | tag | (*p & V_ASN1_CONSTRUCTED);
187 case ASN1_ITYPE_NDEF_SEQUENCE:
188 /* Use indefinite length constructed if requested */
189 if (aclass & ASN1_TFLG_NDEF) ndef = 2;
192 case ASN1_ITYPE_SEQUENCE:
193 i = asn1_enc_restore(&seqcontlen, out, pval, it);
194 /* An error occurred */
196 /* We have a valid cached encoding... */
197 if(i > 0) return seqcontlen;
198 /* Otherwise carry on */
200 /* If no IMPLICIT tagging set to SEQUENCE, UNIVERSAL */
202 tag = V_ASN1_SEQUENCE;
203 /* Retain any other flags in aclass */
204 aclass = (aclass & ~ASN1_TFLG_TAG_CLASS)
207 if(asn1_cb && !asn1_cb(ASN1_OP_I2D_PRE, pval, it))
209 /* First work out sequence content length */
210 for(i = 0, tt = it->templates; i < it->tcount; tt++, i++) {
211 const ASN1_TEMPLATE *seqtt;
212 ASN1_VALUE **pseqval;
213 seqtt = asn1_do_adb(pval, tt, 1);
215 pseqval = asn1_get_field_ptr(pval, seqtt);
216 /* FIXME: check for errors in enhanced version */
217 seqcontlen += asn1_template_ex_i2d(pseqval, NULL, seqtt,
220 seqlen = ASN1_object_size(ndef, seqcontlen, tag);
221 if(!out) return seqlen;
222 /* Output SEQUENCE header */
223 ASN1_put_object(out, ndef, seqcontlen, tag, aclass);
224 for(i = 0, tt = it->templates; i < it->tcount; tt++, i++) {
225 const ASN1_TEMPLATE *seqtt;
226 ASN1_VALUE **pseqval;
227 seqtt = asn1_do_adb(pval, tt, 1);
229 pseqval = asn1_get_field_ptr(pval, seqtt);
230 /* FIXME: check for errors in enhanced version */
231 asn1_template_ex_i2d(pseqval, out, seqtt, -1, aclass);
233 if (ndef == 2) ASN1_put_eoc(out);
234 if(asn1_cb && !asn1_cb(ASN1_OP_I2D_POST, pval, it))
244 int ASN1_template_i2d(ASN1_VALUE **pval, unsigned char **out, const ASN1_TEMPLATE *tt)
246 return asn1_template_ex_i2d(pval, out, tt, -1, 0);
249 static int asn1_template_ex_i2d(ASN1_VALUE **pval, unsigned char **out, const ASN1_TEMPLATE *tt, int tag, int iclass)
251 int i, ret, flags, ttag, tclass, ndef;
253 /* Work out tag and class to use: tagging may come
254 * either from the template or the arguments, not both
255 * because this would create ambiguity. Additionally
256 * the iclass argument may contain some additional flags
257 * which should be noted and passed down to other levels.
259 if (flags & ASN1_TFLG_TAG_MASK)
261 /* Error if argument and template tagging */
263 /* FIXME: error code here */
265 /* Get tagging from template */
267 tclass = flags & ASN1_TFLG_TAG_CLASS;
271 /* No template tagging, get from arguments */
273 tclass = iclass & ASN1_TFLG_TAG_CLASS;
281 * Remove any class mask from iflag.
283 iclass &= ~ASN1_TFLG_TAG_CLASS;
285 /* At this point 'ttag' contains the outer tag to use,
286 * 'tclass' is the class and iclass is any flags passed
290 /* if template and arguments require ndef, use it */
291 if ((flags & ASN1_TFLG_NDEF) && (iclass & ASN1_TFLG_NDEF))
295 if(flags & ASN1_TFLG_SK_MASK) {
296 /* SET OF, SEQUENCE OF */
297 STACK_OF(ASN1_VALUE) *sk = (STACK_OF(ASN1_VALUE) *)*pval;
298 int isset, sktag, skaclass;
299 int skcontlen, sklen;
304 if(flags & ASN1_TFLG_SET_OF) {
306 /* 2 means we reorder */
307 if(flags & ASN1_TFLG_SEQUENCE_OF) isset = 2;
310 /* Work out inner tag value: if EXPLICIT
311 * or no tagging use underlying type.
313 if((ttag != -1) && !(flags & ASN1_TFLG_EXPTAG)) {
317 skaclass = V_ASN1_UNIVERSAL;
318 if(isset) sktag = V_ASN1_SET;
319 else 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);
338 /* Now encode this lot... */
340 if(flags & ASN1_TFLG_EXPTAG)
341 ASN1_put_object(out, ndef, sklen, ttag, tclass);
342 /* SET or SEQUENCE and IMPLICIT tag */
343 ASN1_put_object(out, ndef, skcontlen, sktag, skaclass);
344 /* And the stuff itself */
345 asn1_set_seq_out(sk, out, skcontlen, ASN1_ITEM_ptr(tt->item),
349 if(flags & ASN1_TFLG_EXPTAG)
356 if(flags & ASN1_TFLG_EXPTAG) {
357 /* EXPLICIT tagging */
358 /* Find length of tagged item */
359 i = ASN1_item_ex_i2d(pval, NULL, ASN1_ITEM_ptr(tt->item),
362 /* Find length of EXPLICIT tag */
363 ret = ASN1_object_size(ndef, i, ttag);
365 /* Output tag and item */
366 ASN1_put_object(out, ndef, i, ttag, tclass);
367 ASN1_item_ex_i2d(pval, out, ASN1_ITEM_ptr(tt->item),
369 if (ndef == 2) ASN1_put_eoc(out);
374 /* Either normal or IMPLICIT tagging: combine class and flags */
375 return ASN1_item_ex_i2d(pval, out, ASN1_ITEM_ptr(tt->item),
376 ttag, tclass | iclass);
380 /* Temporary structure used to hold DER encoding of items for SET OF */
388 static int der_cmp(const void *a, const void *b)
390 const DER_ENC *d1 = a, *d2 = b;
392 cmplen = (d1->length < d2->length) ? d1->length : d2->length;
393 i = memcmp(d1->data, d2->data, cmplen);
395 return d1->length - d2->length;
398 /* Output the content octets of SET OF or SEQUENCE OF */
400 static int asn1_set_seq_out(STACK_OF(ASN1_VALUE) *sk, unsigned char **out,
401 int skcontlen, const ASN1_ITEM *item,
402 int do_sort, int iclass)
406 unsigned char *tmpdat = NULL, *p = NULL;
407 DER_ENC *derlst = NULL, *tder;
409 /* Don't need to sort less than 2 items */
410 if(sk_ASN1_VALUE_num(sk) < 2) do_sort = 0;
412 derlst = OPENSSL_malloc(sk_ASN1_VALUE_num(sk) * sizeof(*derlst));
413 tmpdat = OPENSSL_malloc(skcontlen);
414 if(!derlst || !tmpdat) return 0;
417 /* If not sorting just output each item */
419 for(i = 0; i < sk_ASN1_VALUE_num(sk); i++) {
420 skitem = sk_ASN1_VALUE_value(sk, i);
421 ASN1_item_ex_i2d(&skitem, out, item, -1, iclass);
426 /* Doing sort: build up a list of each member's DER encoding */
427 for(i = 0, tder = derlst; i < sk_ASN1_VALUE_num(sk); i++, tder++) {
428 skitem = sk_ASN1_VALUE_value(sk, i);
430 tder->length = ASN1_item_ex_i2d(&skitem, &p, item, -1, iclass);
431 tder->field = skitem;
434 qsort(derlst, sk_ASN1_VALUE_num(sk), sizeof(*derlst), der_cmp);
435 /* Output sorted DER encoding */
437 for(i = 0, tder = derlst; i < sk_ASN1_VALUE_num(sk); i++, tder++) {
438 memcpy(p, tder->data, tder->length);
442 /* If do_sort is 2 then reorder the STACK */
444 for(i = 0, tder = derlst; i < sk_ASN1_VALUE_num(sk); i++, tder++)
445 sk_ASN1_VALUE_set(sk, i, tder->field);
447 OPENSSL_free(derlst);
448 OPENSSL_free(tmpdat);
452 static int asn1_i2d_ex_primitive(ASN1_VALUE **pval, unsigned char **out, const ASN1_ITEM *it, int tag, int aclass)
461 /* Get length of content octets and maybe find
462 * out the underlying type.
465 len = asn1_ex_i2c(pval, NULL, &utype, it);
467 /* If SEQUENCE, SET or OTHER then header is
468 * included in pseudo content octets so don't
469 * include tag+length. We need to check here
470 * because the call to asn1_ex_i2c() could change
473 if((utype == V_ASN1_SEQUENCE) || (utype == V_ASN1_SET) ||
474 (utype == V_ASN1_OTHER))
478 /* -1 means omit type */
483 /* -2 return is special meaning use ndef */
490 /* If not implicitly tagged get tag from underlying type */
491 if(tag == -1) tag = utype;
493 /* Output tag+length followed by content octets */
495 if(usetag) ASN1_put_object(out, ndef, len, tag, aclass);
496 asn1_ex_i2c(pval, *out, &utype, it);
503 if(usetag) return ASN1_object_size(ndef, len, tag);
507 /* Produce content octets from a structure */
509 int asn1_ex_i2c(ASN1_VALUE **pval, unsigned char *cout, int *putype, const ASN1_ITEM *it)
511 ASN1_BOOLEAN *tbool = NULL;
515 unsigned char *cont, c;
517 const ASN1_PRIMITIVE_FUNCS *pf;
519 if(pf && pf->prim_i2c) return pf->prim_i2c(pval, cout, putype, it);
521 /* Should type be omitted? */
522 if((it->itype != ASN1_ITYPE_PRIMITIVE) || (it->utype != V_ASN1_BOOLEAN)) {
523 if(!*pval) return -1;
526 if(it->itype == ASN1_ITYPE_MSTRING) {
527 /* If MSTRING type set the underlying type */
528 strtmp = (ASN1_STRING *)*pval;
529 utype = strtmp->type;
531 } else if(it->utype == V_ASN1_ANY) {
532 /* If ANY set type and pointer to value */
534 typ = (ASN1_TYPE *)*pval;
537 pval = (ASN1_VALUE **)&typ->value.ptr;
538 } else utype = *putype;
542 otmp = (ASN1_OBJECT *)*pval;
553 tbool = (ASN1_BOOLEAN *)pval;
554 if(*tbool == -1) return -1;
555 /* Default handling if value == size field then omit */
556 if(*tbool && (it->size > 0)) return -1;
557 if(!*tbool && !it->size) return -1;
558 c = (unsigned char)*tbool;
563 case V_ASN1_BIT_STRING:
564 return i2c_ASN1_BIT_STRING((ASN1_BIT_STRING *)*pval, cout ? &cout : NULL);
568 case V_ASN1_NEG_INTEGER:
569 case V_ASN1_ENUMERATED:
570 case V_ASN1_NEG_ENUMERATED:
571 /* These are all have the same content format
574 return i2c_ASN1_INTEGER((ASN1_INTEGER *)*pval, cout ? &cout : NULL);
577 case V_ASN1_OCTET_STRING:
578 case V_ASN1_NUMERICSTRING:
579 case V_ASN1_PRINTABLESTRING:
580 case V_ASN1_T61STRING:
581 case V_ASN1_VIDEOTEXSTRING:
582 case V_ASN1_IA5STRING:
584 case V_ASN1_GENERALIZEDTIME:
585 case V_ASN1_GRAPHICSTRING:
586 case V_ASN1_VISIBLESTRING:
587 case V_ASN1_GENERALSTRING:
588 case V_ASN1_UNIVERSALSTRING:
589 case V_ASN1_BMPSTRING:
590 case V_ASN1_UTF8STRING:
591 case V_ASN1_SEQUENCE:
594 /* All based on ASN1_STRING and handled the same */
595 strtmp = (ASN1_STRING *)*pval;
596 /* Special handling for NDEF */
597 if ((it->size == ASN1_TFLG_NDEF)
598 && (strtmp->flags & ASN1_STRING_FLAG_NDEF))
605 /* Special return code */
609 len = strtmp->length;
614 if(cout && len) memcpy(cout, cont, len);