]>
git.ipfire.org Git - thirdparty/openssl.git/blob - crypto/asn1/tasn_enc.c
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
:
189 fprintf(stderr
, "NDEF sequence from %s flags %d\n", it
->sname
, aclass
& ASN1_TFLG_NDEF
);
191 /* Use indefinite length constructed if requested */
192 if (aclass
& ASN1_TFLG_NDEF
) ndef
= 2;
195 case ASN1_ITYPE_SEQUENCE
:
196 i
= asn1_enc_restore(&seqcontlen
, out
, pval
, it
);
197 /* An error occurred */
199 /* We have a valid cached encoding... */
200 if(i
> 0) return seqcontlen
;
201 /* Otherwise carry on */
203 /* If no IMPLICIT tagging set to SEQUENCE, UNIVERSAL */
205 tag
= V_ASN1_SEQUENCE
;
206 /* Retain any other flags in aclass */
207 aclass
= (aclass
& ~ASN1_TFLG_TAG_CLASS
)
210 if(asn1_cb
&& !asn1_cb(ASN1_OP_I2D_PRE
, pval
, it
))
212 /* First work out sequence content length */
213 for(i
= 0, tt
= it
->templates
; i
< it
->tcount
; tt
++, i
++) {
214 const ASN1_TEMPLATE
*seqtt
;
215 ASN1_VALUE
**pseqval
;
216 seqtt
= asn1_do_adb(pval
, tt
, 1);
218 pseqval
= asn1_get_field_ptr(pval
, seqtt
);
219 /* FIXME: check for errors in enhanced version */
220 seqcontlen
+= asn1_template_ex_i2d(pseqval
, NULL
, seqtt
,
223 seqlen
= ASN1_object_size(ndef
, seqcontlen
, tag
);
224 if(!out
) return seqlen
;
225 /* Output SEQUENCE header */
226 ASN1_put_object(out
, ndef
, seqcontlen
, tag
, aclass
);
227 for(i
= 0, tt
= it
->templates
; i
< it
->tcount
; tt
++, i
++) {
228 const ASN1_TEMPLATE
*seqtt
;
229 ASN1_VALUE
**pseqval
;
230 seqtt
= asn1_do_adb(pval
, tt
, 1);
232 pseqval
= asn1_get_field_ptr(pval
, seqtt
);
233 /* FIXME: check for errors in enhanced version */
234 asn1_template_ex_i2d(pseqval
, out
, seqtt
, -1, aclass
);
236 if (ndef
== 2) ASN1_put_eoc(out
);
237 if(asn1_cb
&& !asn1_cb(ASN1_OP_I2D_POST
, pval
, it
))
247 static int asn1_template_ex_i2d(ASN1_VALUE
**pval
, unsigned char **out
, const ASN1_TEMPLATE
*tt
, int tag
, int iclass
)
249 int i
, ret
, flags
, ttag
, tclass
, ndef
;
251 /* Work out tag and class to use: tagging may come
252 * either from the template or the arguments, not both
253 * because this would create ambiguity. Additionally
254 * the iclass argument may contain some additional flags
255 * which should be noted and passed down to other levels.
257 if (flags
& ASN1_TFLG_TAG_MASK
)
259 /* Error if argument and template tagging */
261 /* FIXME: error code here */
263 /* Get tagging from template */
265 tclass
= flags
& ASN1_TFLG_TAG_CLASS
;
269 /* No template tagging, get from arguments */
271 tclass
= iclass
& ASN1_TFLG_TAG_CLASS
;
279 * Remove any class mask from iflag.
281 iclass
&= ~ASN1_TFLG_TAG_CLASS
;
283 /* At this point 'ttag' contains the outer tag to use,
284 * 'tclass' is the class and iclass is any flags passed
288 /* if template and arguments require ndef, use it */
289 if ((flags
& ASN1_TFLG_NDEF
) && (iclass
& ASN1_TFLG_NDEF
))
293 if(flags
& ASN1_TFLG_SK_MASK
) {
294 /* SET OF, SEQUENCE OF */
295 STACK_OF(ASN1_VALUE
) *sk
= (STACK_OF(ASN1_VALUE
) *)*pval
;
296 int isset
, sktag
, skaclass
;
297 int skcontlen
, sklen
;
302 if(flags
& ASN1_TFLG_SET_OF
) {
304 /* 2 means we reorder */
305 if(flags
& ASN1_TFLG_SEQUENCE_OF
) isset
= 2;
308 /* Work out inner tag value: if EXPLICIT
309 * or no tagging use underlying type.
311 if((ttag
!= -1) && !(flags
& ASN1_TFLG_EXPTAG
)) {
315 skaclass
= V_ASN1_UNIVERSAL
;
316 if(isset
) sktag
= V_ASN1_SET
;
317 else sktag
= V_ASN1_SEQUENCE
;
320 /* Determine total length of items */
322 for(i
= 0; i
< sk_ASN1_VALUE_num(sk
); i
++) {
323 skitem
= sk_ASN1_VALUE_value(sk
, i
);
324 skcontlen
+= ASN1_item_ex_i2d(&skitem
, NULL
,
325 ASN1_ITEM_ptr(tt
->item
),
328 sklen
= ASN1_object_size(ndef
, skcontlen
, sktag
);
329 /* If EXPLICIT need length of surrounding tag */
330 if(flags
& ASN1_TFLG_EXPTAG
)
331 ret
= ASN1_object_size(ndef
, sklen
, ttag
);
336 /* Now encode this lot... */
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
),
347 if(flags
& ASN1_TFLG_EXPTAG
)
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
),
360 /* Find length of EXPLICIT tag */
361 ret
= ASN1_object_size(ndef
, i
, ttag
);
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
),
367 if (ndef
== 2) ASN1_put_eoc(out
);
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
);
378 /* Temporary structure used to hold DER encoding of items for SET OF */
386 static int der_cmp(const void *a
, const void *b
)
388 const DER_ENC
*d1
= a
, *d2
= b
;
390 cmplen
= (d1
->length
< d2
->length
) ? d1
->length
: d2
->length
;
391 i
= memcmp(d1
->data
, d2
->data
, cmplen
);
393 return d1
->length
- d2
->length
;
396 /* Output the content octets of SET OF or SEQUENCE OF */
398 static int asn1_set_seq_out(STACK_OF(ASN1_VALUE
) *sk
, unsigned char **out
,
399 int skcontlen
, const ASN1_ITEM
*item
,
400 int do_sort
, int iclass
)
404 unsigned char *tmpdat
= NULL
, *p
= NULL
;
405 DER_ENC
*derlst
= NULL
, *tder
;
407 /* Don't need to sort less than 2 items */
408 if(sk_ASN1_VALUE_num(sk
) < 2) do_sort
= 0;
410 derlst
= OPENSSL_malloc(sk_ASN1_VALUE_num(sk
) * sizeof(*derlst
));
411 tmpdat
= OPENSSL_malloc(skcontlen
);
412 if(!derlst
|| !tmpdat
) return 0;
415 /* If not sorting just output each item */
417 for(i
= 0; i
< sk_ASN1_VALUE_num(sk
); i
++) {
418 skitem
= sk_ASN1_VALUE_value(sk
, i
);
419 ASN1_item_ex_i2d(&skitem
, out
, item
, -1, iclass
);
424 /* Doing sort: build up a list of each member's DER encoding */
425 for(i
= 0, tder
= derlst
; i
< sk_ASN1_VALUE_num(sk
); i
++, tder
++) {
426 skitem
= sk_ASN1_VALUE_value(sk
, i
);
428 tder
->length
= ASN1_item_ex_i2d(&skitem
, &p
, item
, -1, iclass
);
429 tder
->field
= skitem
;
432 qsort(derlst
, sk_ASN1_VALUE_num(sk
), sizeof(*derlst
), der_cmp
);
433 /* Output sorted DER encoding */
435 for(i
= 0, tder
= derlst
; i
< sk_ASN1_VALUE_num(sk
); i
++, tder
++) {
436 memcpy(p
, tder
->data
, tder
->length
);
440 /* If do_sort is 2 then reorder the STACK */
442 for(i
= 0, tder
= derlst
; i
< sk_ASN1_VALUE_num(sk
); i
++, tder
++)
443 sk_ASN1_VALUE_set(sk
, i
, tder
->field
);
445 OPENSSL_free(derlst
);
446 OPENSSL_free(tmpdat
);
450 static int asn1_i2d_ex_primitive(ASN1_VALUE
**pval
, unsigned char **out
, const ASN1_ITEM
*it
, int tag
, int aclass
)
459 /* Get length of content octets and maybe find
460 * out the underlying type.
463 len
= asn1_ex_i2c(pval
, NULL
, &utype
, it
);
465 /* If SEQUENCE, SET or OTHER then header is
466 * included in pseudo content octets so don't
467 * include tag+length. We need to check here
468 * because the call to asn1_ex_i2c() could change
471 if((utype
== V_ASN1_SEQUENCE
) || (utype
== V_ASN1_SET
) ||
472 (utype
== V_ASN1_OTHER
))
476 /* -1 means omit type */
481 /* -2 return is special meaning use ndef */
488 /* If not implicitly tagged get tag from underlying type */
489 if(tag
== -1) tag
= utype
;
491 /* Output tag+length followed by content octets */
493 if(usetag
) ASN1_put_object(out
, ndef
, len
, tag
, aclass
);
494 asn1_ex_i2c(pval
, *out
, &utype
, it
);
498 if(usetag
) return ASN1_object_size(ndef
, len
, tag
);
502 /* Produce content octets from a structure */
504 int asn1_ex_i2c(ASN1_VALUE
**pval
, unsigned char *cout
, int *putype
, const ASN1_ITEM
*it
)
506 ASN1_BOOLEAN
*tbool
= NULL
;
510 unsigned char *cont
, c
;
512 const ASN1_PRIMITIVE_FUNCS
*pf
;
514 if(pf
&& pf
->prim_i2c
) return pf
->prim_i2c(pval
, cout
, putype
, it
);
516 /* Should type be omitted? */
517 if((it
->itype
!= ASN1_ITYPE_PRIMITIVE
) || (it
->utype
!= V_ASN1_BOOLEAN
)) {
518 if(!*pval
) return -1;
521 if(it
->itype
== ASN1_ITYPE_MSTRING
) {
522 /* If MSTRING type set the underlying type */
523 strtmp
= (ASN1_STRING
*)*pval
;
524 utype
= strtmp
->type
;
526 } else if(it
->utype
== V_ASN1_ANY
) {
527 /* If ANY set type and pointer to value */
529 typ
= (ASN1_TYPE
*)*pval
;
532 pval
= (ASN1_VALUE
**)&typ
->value
.ptr
;
533 } else utype
= *putype
;
537 otmp
= (ASN1_OBJECT
*)*pval
;
548 tbool
= (ASN1_BOOLEAN
*)pval
;
549 if(*tbool
== -1) return -1;
550 /* Default handling if value == size field then omit */
551 if(*tbool
&& (it
->size
> 0)) return -1;
552 if(!*tbool
&& !it
->size
) return -1;
553 c
= (unsigned char)*tbool
;
558 case V_ASN1_BIT_STRING
:
559 return i2c_ASN1_BIT_STRING((ASN1_BIT_STRING
*)*pval
, cout
? &cout
: NULL
);
563 case V_ASN1_NEG_INTEGER
:
564 case V_ASN1_ENUMERATED
:
565 case V_ASN1_NEG_ENUMERATED
:
566 /* These are all have the same content format
569 return i2c_ASN1_INTEGER((ASN1_INTEGER
*)*pval
, cout
? &cout
: NULL
);
572 case V_ASN1_OCTET_STRING
:
573 case V_ASN1_NUMERICSTRING
:
574 case V_ASN1_PRINTABLESTRING
:
575 case V_ASN1_T61STRING
:
576 case V_ASN1_VIDEOTEXSTRING
:
577 case V_ASN1_IA5STRING
:
579 case V_ASN1_GENERALIZEDTIME
:
580 case V_ASN1_GRAPHICSTRING
:
581 case V_ASN1_VISIBLESTRING
:
582 case V_ASN1_GENERALSTRING
:
583 case V_ASN1_UNIVERSALSTRING
:
584 case V_ASN1_BMPSTRING
:
585 case V_ASN1_UTF8STRING
:
586 case V_ASN1_SEQUENCE
:
589 /* All based on ASN1_STRING and handled the same */
590 strtmp
= (ASN1_STRING
*)*pval
;
591 /* Special handling for NDEF */
592 if ((it
->size
== ASN1_TFLG_NDEF
)
593 && (strtmp
->flags
& ASN1_STRING_FLAG_NDEF
))
601 /* Special return code */
605 len
= strtmp
->length
;
610 if(cout
&& len
) memcpy(cout
, cont
, len
);