added private flag to asn1_ctx_t
[strongswan.git] / src / libstrongswan / asn1 / asn1.c
1 /* Simple ASN.1 parser
2 * Copyright (C) 2000-2004 Andreas Steffen, Zuercher Hochschule Winterthur
3 * Copyright (C) 2006 Martin Will, Hochschule fuer Technik Rapperswil
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * for more details.
14 */
15
16 #include <stdio.h>
17 #include <string.h>
18 #include <time.h>
19
20 #include "asn1.h"
21
22 #include <types.h>
23 #include <library.h>
24
25 /* some common prefabricated ASN.1 constants */
26 static u_char ASN1_INTEGER_0_str[] = { 0x02, 0x00 };
27 static u_char ASN1_INTEGER_1_str[] = { 0x02, 0x01, 0x01 };
28 static u_char ASN1_INTEGER_2_str[] = { 0x02, 0x01, 0x02 };
29
30 const chunk_t ASN1_INTEGER_0 = chunk_from_buf(ASN1_INTEGER_0_str);
31 const chunk_t ASN1_INTEGER_1 = chunk_from_buf(ASN1_INTEGER_1_str);
32 const chunk_t ASN1_INTEGER_2 = chunk_from_buf(ASN1_INTEGER_2_str);
33
34 /* some popular algorithmIdentifiers */
35
36 static u_char ASN1_md5_id_str[] = {
37 0x30, 0x0C,
38 0x06, 0x08, 0x2A, 0x86, 0x48, 0x86, 0xF7, 0x0D, 0x02, 0x05,
39 0x05, 0x00
40 };
41
42 static u_char ASN1_sha1_id_str[] = {
43 0x30, 0x09,
44 0x06, 0x05, 0x2B, 0x0E,0x03, 0x02, 0x1A,
45 0x05, 0x00
46 };
47
48 static u_char ASN1_md5WithRSA_id_str[] = {
49 0x30, 0x0D,
50 0x06, 0x09, 0x2A, 0x86, 0x48, 0x86, 0xF7, 0x0D, 0x01, 0x01, 0x04,
51 0x05, 0x00
52 };
53
54 static u_char ASN1_sha1WithRSA_id_str[] = {
55 0x30, 0x0D,
56 0x06, 0x09, 0x2A, 0x86, 0x48, 0x86, 0xF7, 0x0D, 0x01, 0x01, 0x05,
57 0x05, 0x00
58 };
59
60 static u_char ASN1_rsaEncryption_id_str[] = {
61 0x30, 0x0D,
62 0x06, 0x09, 0x2A, 0x86, 0x48, 0x86, 0xF7, 0x0D, 0x01, 0x01, 0x01,
63 0x05, 0x00
64 };
65
66 const chunk_t ASN1_md5_id = chunk_from_buf(ASN1_md5_id_str);
67 const chunk_t ASN1_sha1_id = chunk_from_buf(ASN1_sha1_id_str);
68 const chunk_t ASN1_rsaEncryption_id = chunk_from_buf(ASN1_rsaEncryption_id_str);
69 const chunk_t ASN1_md5WithRSA_id = chunk_from_buf(ASN1_md5WithRSA_id_str);
70 const chunk_t ASN1_sha1WithRSA_id = chunk_from_buf(ASN1_sha1WithRSA_id_str);
71
72 /* ASN.1 definiton of an algorithmIdentifier */
73 static const asn1Object_t algorithmIdentifierObjects[] = {
74 { 0, "algorithmIdentifier", ASN1_SEQUENCE, ASN1_NONE }, /* 0 */
75 { 1, "algorithm", ASN1_OID, ASN1_BODY }, /* 1 */
76 { 1, "parameters", ASN1_EOC, ASN1_RAW } /* 2 */
77 };
78
79 #define ALGORITHM_ID_ALG 1
80 #define ALGORITHM_ID_PARAMETERS 2
81 #define ALGORITHM_ID_ROOF 3
82
83 /**
84 * return the ASN.1 encoded algorithm identifier
85 */
86 chunk_t asn1_algorithmIdentifier(int oid)
87 {
88 switch (oid)
89 {
90 case OID_RSA_ENCRYPTION:
91 return ASN1_rsaEncryption_id;
92 case OID_MD5_WITH_RSA:
93 return ASN1_md5WithRSA_id;
94 case OID_SHA1_WITH_RSA:
95 return ASN1_sha1WithRSA_id;
96 case OID_MD5:
97 return ASN1_md5_id;
98 case OID_SHA1:
99 return ASN1_sha1_id;
100 default:
101 return CHUNK_INITIALIZER;
102 }
103 }
104
105 /**
106 * If the oid is listed in the oid_names table then the corresponding
107 * position in the oid_names table is returned otherwise -1 is returned
108 */
109 int known_oid(chunk_t object)
110 {
111 int oid = 0;
112
113 while (object.len)
114 {
115 if (oid_names[oid].octet == *object.ptr)
116 {
117 if (--object.len == 0 || oid_names[oid].down == 0)
118 {
119 return oid; /* found terminal symbol */
120 }
121 else
122 {
123 object.ptr++; oid++; /* advance to next hex octet */
124 }
125 }
126 else
127 {
128 if (oid_names[oid].next)
129 oid = oid_names[oid].next;
130 else
131 return OID_UNKNOWN;
132 }
133 }
134 return -1;
135 }
136
137 /**
138 * Decodes the length in bytes of an ASN.1 object
139 */
140 u_int asn1_length(chunk_t *blob)
141 {
142 u_char n;
143 size_t len;
144
145 /* advance from tag field on to length field */
146 blob->ptr++;
147 blob->len--;
148
149 /* read first octet of length field */
150 n = *blob->ptr++;
151 blob->len--;
152
153 if ((n & 0x80) == 0)
154 {/* single length octet */
155 return n;
156 }
157
158 /* composite length, determine number of length octets */
159 n &= 0x7f;
160
161 if (n > blob->len)
162 {
163 DBG2("number of length octets is larger than ASN.1 object");
164 return ASN1_INVALID_LENGTH;
165 }
166
167 if (n > sizeof(len))
168 {
169 DBG2("number of length octets is larger than limit of %d octets",
170 (int)sizeof(len));
171 return ASN1_INVALID_LENGTH;
172 }
173
174 len = 0;
175
176 while (n-- > 0)
177 {
178 len = 256*len + *blob->ptr++;
179 blob->len--;
180 }
181 return len;
182 }
183
184 /**
185 * determines if a character string is of type ASN.1 printableString
186 */
187 bool is_printablestring(chunk_t str)
188 {
189 const char printablestring_charset[] =
190 "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789 '()+,-./:=?";
191 u_int i;
192
193 for (i = 0; i < str.len; i++)
194 {
195 if (strchr(printablestring_charset, str.ptr[i]) == NULL)
196 return FALSE;
197 }
198 return TRUE;
199 }
200
201 /**
202 * Converts ASN.1 UTCTIME or GENERALIZEDTIME into calender time
203 */
204 time_t asn1totime(const chunk_t *utctime, asn1_t type)
205 {
206 struct tm t;
207 time_t tz_offset;
208 u_char *eot = NULL;
209
210 if ((eot = memchr(utctime->ptr, 'Z', utctime->len)) != NULL)
211 {
212 tz_offset = 0; /* Zulu time with a zero time zone offset */
213 }
214 else if ((eot = memchr(utctime->ptr, '+', utctime->len)) != NULL)
215 {
216 int tz_hour, tz_min;
217
218 sscanf(eot+1, "%2d%2d", &tz_hour, &tz_min);
219 tz_offset = 3600*tz_hour + 60*tz_min; /* positive time zone offset */
220 }
221 else if ((eot = memchr(utctime->ptr, '-', utctime->len)) != NULL)
222 {
223 int tz_hour, tz_min;
224
225 sscanf(eot+1, "%2d%2d", &tz_hour, &tz_min);
226 tz_offset = -3600*tz_hour - 60*tz_min; /* negative time zone offset */
227 }
228 else
229 {
230 return 0; /* error in time format */
231 }
232
233 {
234 const char* format = (type == ASN1_UTCTIME)? "%2d%2d%2d%2d%2d":
235 "%4d%2d%2d%2d%2d";
236
237 sscanf(utctime->ptr, format, &t.tm_year, &t.tm_mon, &t.tm_mday,
238 &t.tm_hour, &t.tm_min);
239 }
240
241 /* is there a seconds field? */
242 if ((eot - utctime->ptr) == ((type == ASN1_UTCTIME)?12:14))
243 {
244 sscanf(eot-2, "%2d", &t.tm_sec);
245 }
246 else
247 {
248 t.tm_sec = 0;
249 }
250
251 /* representation of year */
252 if (t.tm_year >= 1900)
253 {
254 t.tm_year -= 1900;
255 }
256 else if (t.tm_year >= 100)
257 {
258 return 0;
259 }
260 else if (t.tm_year < 50)
261 {
262 t.tm_year += 100;
263 }
264
265 /* representation of month 0..11*/
266 t.tm_mon--;
267
268 /* set daylight saving time to off */
269 t.tm_isdst = 0;
270
271 /* compensate timezone */
272
273 return mktime(&t) - timezone - tz_offset;
274 }
275
276 /**
277 * Initializes the internal context of the ASN.1 parser
278 */
279 void asn1_init(asn1_ctx_t *ctx, chunk_t blob, u_int level0,
280 bool implicit, bool private)
281 {
282 ctx->blobs[0] = blob;
283 ctx->level0 = level0;
284 ctx->implicit = implicit;
285 ctx->private = private;
286 memset(ctx->loopAddr, '\0', sizeof(ctx->loopAddr));
287 }
288
289 /**
290 * print the value of an ASN.1 simple object
291 */
292 static void debug_asn1_simple_object(chunk_t object, asn1_t type, bool private)
293 {
294 int oid;
295
296 switch (type)
297 {
298 case ASN1_OID:
299 oid = known_oid(object);
300 if (oid != OID_UNKNOWN)
301 {
302 DBG2(" '%s'", oid_names[oid].name);
303 return;
304 }
305 break;
306 case ASN1_UTF8STRING:
307 case ASN1_IA5STRING:
308 case ASN1_PRINTABLESTRING:
309 case ASN1_T61STRING:
310 case ASN1_VISIBLESTRING:
311 DBG2(" '%.*s'", (int)object.len, object.ptr);
312 return;
313 case ASN1_UTCTIME:
314 case ASN1_GENERALIZEDTIME:
315 {
316 DBG2(" '%T'", asn1totime(&object, type));
317 }
318 return;
319 default:
320 break;
321 }
322 if (private)
323 DBG4("%B", &object);
324 else
325 DBG3("%B", &object);
326 }
327
328 /**
329 * Parses and extracts the next ASN.1 object
330 */
331 bool extract_object(asn1Object_t const *objects, u_int *objectID, chunk_t *object, u_int *level, asn1_ctx_t *ctx)
332 {
333 asn1Object_t obj = objects[*objectID];
334 chunk_t *blob;
335 chunk_t *blob1;
336 u_char *start_ptr;
337
338 *object = CHUNK_INITIALIZER;
339
340 if (obj.flags & ASN1_END) /* end of loop or option found */
341 {
342 if (ctx->loopAddr[obj.level] && ctx->blobs[obj.level+1].len > 0)
343 {
344 *objectID = ctx->loopAddr[obj.level]; /* another iteration */
345 obj = objects[*objectID];
346 }
347 else
348 {
349 ctx->loopAddr[obj.level] = 0; /* exit loop or option*/
350 return TRUE;
351 }
352 }
353
354 *level = ctx->level0 + obj.level;
355 blob = ctx->blobs + obj.level;
356 blob1 = blob + 1;
357 start_ptr = blob->ptr;
358
359 /* handle ASN.1 defaults values */
360 if ((obj.flags & ASN1_DEF) && (blob->len == 0 || *start_ptr != obj.type) )
361 {
362 /* field is missing */
363 DBG2("L%d - %s:", *level, obj.name);
364 if (obj.type & ASN1_CONSTRUCTED)
365 {
366 (*objectID)++ ; /* skip context-specific tag */
367 }
368 return TRUE;
369 }
370
371 /* handle ASN.1 options */
372
373 if ((obj.flags & ASN1_OPT)
374 && (blob->len == 0 || *start_ptr != obj.type))
375 {
376 /* advance to end of missing option field */
377 do
378 (*objectID)++;
379 while (!((objects[*objectID].flags & ASN1_END)
380 && (objects[*objectID].level == obj.level)));
381 return TRUE;
382 }
383
384 /* an ASN.1 object must possess at least a tag and length field */
385
386 if (blob->len < 2)
387 {
388 DBG2("L%d - %s: ASN.1 object smaller than 2 octets",
389 *level, obj.name);
390 return FALSE;
391 }
392
393 blob1->len = asn1_length(blob);
394
395 if (blob1->len == ASN1_INVALID_LENGTH || blob->len < blob1->len)
396 {
397 DBG2("L%d - %s: length of ASN.1 object invalid or too large",
398 *level, obj.name);
399 return FALSE;
400 }
401
402 blob1->ptr = blob->ptr;
403 blob->ptr += blob1->len;
404 blob->len -= blob1->len;
405
406 /* return raw ASN.1 object without prior type checking */
407
408 if (obj.flags & ASN1_RAW)
409 {
410 DBG2("L%d - %s:", *level, obj.name);
411 object->ptr = start_ptr;
412 object->len = (size_t)(blob->ptr - start_ptr);
413 return TRUE;
414 }
415
416 if (*start_ptr != obj.type && !(ctx->implicit && *objectID == 0))
417 {
418 DBG1("L%d - %s: ASN1 tag 0x%02x expected, but is 0x%02x",
419 *level, obj.name, obj.type, *start_ptr);
420 DBG3("%b", start_ptr, (u_int)(blob->ptr - start_ptr));
421 return FALSE;
422 }
423
424 DBG2("L%d - %s:", ctx->level0+obj.level, obj.name);
425
426 /* In case of "SEQUENCE OF" or "SET OF" start a loop */
427 if (obj.flags & ASN1_LOOP)
428 {
429 if (blob1->len > 0)
430 {
431 /* at least one item, start the loop */
432 ctx->loopAddr[obj.level] = *objectID + 1;
433 }
434 else
435 {
436 /* no items, advance directly to end of loop */
437 do
438 (*objectID)++;
439 while (!((objects[*objectID].flags & ASN1_END)
440 && (objects[*objectID].level == obj.level)));
441 return TRUE;
442 }
443 }
444
445 if (obj.flags & ASN1_OBJ)
446 {
447 object->ptr = start_ptr;
448 object->len = (size_t)(blob->ptr - start_ptr);
449 if (ctx->private)
450 DBG4("%B", object);
451 else
452 DBG3("%B", object);
453 }
454 else if (obj.flags & ASN1_BODY)
455 {
456 *object = *blob1;
457 debug_asn1_simple_object(*object, obj.type, ctx->private);
458 }
459 return TRUE;
460 }
461
462 /**
463 * parse an ASN.1 simple type
464 */
465 bool parse_asn1_simple_object(chunk_t *object, asn1_t type, u_int level, const char* name)
466 {
467 size_t len;
468
469 /* an ASN.1 object must possess at least a tag and length field */
470 if (object->len < 2)
471 {
472 DBG2("L%d - %s: ASN.1 object smaller than 2 octets", level, name);
473 return FALSE;
474 }
475
476 if (*object->ptr != type)
477 {
478 DBG2("L%d - %s: ASN1 tag 0x%02x expected, but is 0x%02x",
479 level, name, type, *object->ptr);
480 return FALSE;
481 }
482
483 len = asn1_length(object);
484
485 if (len == ASN1_INVALID_LENGTH || object->len < len)
486 {
487 DBG2("L%d - %s: length of ASN.1 object invalid or too large",
488 level, name);
489 return FALSE;
490 }
491
492 DBG2("L%d - %s:", level, name);
493 debug_asn1_simple_object(*object, type, FALSE);
494 return TRUE;
495 }
496
497 /**
498 * extracts an algorithmIdentifier
499 */
500 int parse_algorithmIdentifier(chunk_t blob, int level0, chunk_t *parameters)
501 {
502 asn1_ctx_t ctx;
503 chunk_t object;
504 u_int level;
505 int alg = OID_UNKNOWN;
506 int objectID = 0;
507
508 asn1_init(&ctx, blob, level0, FALSE, FALSE);
509
510 while (objectID < ALGORITHM_ID_ROOF)
511 {
512 if (!extract_object(algorithmIdentifierObjects, &objectID, &object, &level, &ctx))
513 return OID_UNKNOWN;
514
515 switch (objectID)
516 {
517 case ALGORITHM_ID_ALG:
518 alg = known_oid(object);
519 break;
520 case ALGORITHM_ID_PARAMETERS:
521 if (parameters != NULL)
522 *parameters = object;
523 break;
524 default:
525 break;
526 }
527 objectID++;
528 }
529 return alg;
530 }
531
532 /*
533 * tests if a blob contains a valid ASN.1 set or sequence
534 */
535 bool is_asn1(chunk_t blob)
536 {
537 u_int len;
538 u_char tag = *blob.ptr;
539
540 if (tag != ASN1_SEQUENCE && tag != ASN1_SET)
541 {
542 DBG2(" file content is not binary ASN.1");
543 return FALSE;
544 }
545 len = asn1_length(&blob);
546 if (len != blob.len)
547 {
548 DBG2(" file size does not match ASN.1 coded length");
549 return FALSE;
550 }
551 return TRUE;
552 }
553
554 /**
555 * codes ASN.1 lengths up to a size of 16'777'215 bytes
556 */
557 void code_asn1_length(size_t length, chunk_t *code)
558 {
559 if (length < 128)
560 {
561 code->ptr[0] = length;
562 code->len = 1;
563 }
564 else if (length < 256)
565 {
566 code->ptr[0] = 0x81;
567 code->ptr[1] = (u_char) length;
568 code->len = 2;
569 }
570 else if (length < 65536)
571 {
572 code->ptr[0] = 0x82;
573 code->ptr[1] = length >> 8;
574 code->ptr[2] = length & 0x00ff;
575 code->len = 3;
576 }
577 else
578 {
579 code->ptr[0] = 0x83;
580 code->ptr[1] = length >> 16;
581 code->ptr[2] = (length >> 8) & 0x00ff;
582 code->ptr[3] = length & 0x0000ff;
583 code->len = 4;
584 }
585 }
586
587 /**
588 * build an empty asn.1 object with tag and length fields already filled in
589 */
590 u_char* build_asn1_object(chunk_t *object, asn1_t type, size_t datalen)
591 {
592 u_char length_buf[4];
593 chunk_t length = { length_buf, 0 };
594 u_char *pos;
595
596 /* code the asn.1 length field */
597 code_asn1_length(datalen, &length);
598
599 /* allocate memory for the asn.1 TLV object */
600 object->len = 1 + length.len + datalen;
601 object->ptr = malloc(object->len);
602
603 /* set position pointer at the start of the object */
604 pos = object->ptr;
605
606 /* copy the asn.1 tag field and advance the pointer */
607 *pos++ = type;
608
609 /* copy the asn.1 length field and advance the pointer */
610 memcpy(pos, length.ptr, length.len);
611 pos += length.len;
612
613 return pos;
614 }
615
616 /**
617 * build a simple ASN.1 object
618 */
619 chunk_t asn1_simple_object(asn1_t tag, chunk_t content)
620 {
621 chunk_t object;
622
623 u_char *pos = build_asn1_object(&object, tag, content.len);
624 memcpy(pos, content.ptr, content.len);
625 pos += content.len;
626
627 return object;
628 }
629
630 /**
631 * Build an ASN.1 object from a variable number of individual chunks.
632 * Depending on the mode, chunks either are moved ('m') or copied ('c').
633 */
634 chunk_t asn1_wrap(asn1_t type, const char *mode, ...)
635 {
636 chunk_t construct;
637 va_list chunks;
638 u_char *pos;
639 int i;
640 int count = strlen(mode);
641
642 /* sum up lengths of individual chunks */
643 va_start(chunks, mode);
644 construct.len = 0;
645 for (i = 0; i < count; i++)
646 {
647 chunk_t ch = va_arg(chunks, chunk_t);
648 construct.len += ch.len;
649 }
650 va_end(chunks);
651
652 /* allocate needed memory for construct */
653 pos = build_asn1_object(&construct, type, construct.len);
654
655 /* copy or move the chunks */
656 va_start(chunks, mode);
657 for (i = 0; i < count; i++)
658 {
659 chunk_t ch = va_arg(chunks, chunk_t);
660
661 switch (*mode++)
662 {
663 case 'm':
664 memcpy(pos, ch.ptr, ch.len);
665 pos += ch.len;
666 free(ch.ptr);
667 break;
668 case 'c':
669 default:
670 memcpy(pos, ch.ptr, ch.len);
671 pos += ch.len;
672 }
673 }
674 va_end(chunks);
675
676 return construct;
677 }
678
679 /**
680 * convert a MP integer into a DER coded ASN.1 object
681 */
682 chunk_t asn1_integer_from_mpz(const mpz_t value)
683 {
684 size_t bits = mpz_sizeinbase(value, 2); /* size in bits */
685 chunk_t n;
686 n.len = 1 + bits / 8; /* size in bytes */
687 n.ptr = mpz_export(NULL, NULL, 1, n.len, 1, 0, value);
688
689 return asn1_wrap(ASN1_INTEGER, "m", n);
690 }
691
692 /**
693 * convert a date into ASN.1 UTCTIME or GENERALIZEDTIME format
694 */
695 chunk_t timetoasn1(const time_t *time, asn1_t type)
696 {
697 int offset;
698 const char *format;
699 char buf[32];
700 chunk_t formatted_time;
701 struct tm *t = gmtime(time);
702
703 if (type == ASN1_GENERALIZEDTIME)
704 {
705 format = "%04d%02d%02d%02d%02d%02dZ";
706 offset = 1900;
707 }
708 else /* ASN1_UTCTIME */
709 {
710 format = "%02d%02d%02d%02d%02d%02dZ";
711 offset = (t->tm_year < 100)? 0 : -100;
712 }
713 snprintf(buf, sizeof(buf), format, t->tm_year + offset,
714 t->tm_mon + 1, t->tm_mday, t->tm_hour, t->tm_min, t->tm_sec);
715 formatted_time.ptr = buf;
716 formatted_time.len = strlen(buf);
717 return asn1_simple_object(type, formatted_time);
718 }