958089609670ff32f90b9e3d7d1835e0e447c1d2
[openssl.git] / crypto / x509v3 / v3_addr.c
1 /*
2  * Contributed to the OpenSSL Project by the American Registry for
3  * Internet Numbers ("ARIN").
4  */
5 /* ====================================================================
6  * Copyright (c) 2006 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer. 
14  *
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
18  *    distribution.
19  *
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/)"
24  *
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.
29  *
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.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
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  * ====================================================================
52  *
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).
56  */
57
58 /*
59  * Implementation of RFC 3779 section 2.2.
60  */
61
62 #include <stdio.h>
63 #include <stdlib.h>
64 #include <assert.h>
65 #include "cryptlib.h"
66 #include <openssl/conf.h>
67 #include <openssl/asn1.h>
68 #include <openssl/asn1t.h>
69 #include <openssl/x509v3.h>
70
71 #ifndef OPENSSL_NO_RFC3779
72
73 /*
74  * OpenSSL ASN.1 template translation of RFC 3779 2.2.3.
75  */
76
77 ASN1_SEQUENCE(IPAddressRange) = {
78   ASN1_SIMPLE(IPAddressRange, min, ASN1_BIT_STRING),
79   ASN1_SIMPLE(IPAddressRange, max, ASN1_BIT_STRING)
80 } ASN1_SEQUENCE_END(IPAddressRange)
81
82 ASN1_CHOICE(IPAddressOrRange) = {
83   ASN1_SIMPLE(IPAddressOrRange, u.addressPrefix, ASN1_BIT_STRING),
84   ASN1_SIMPLE(IPAddressOrRange, u.addressRange,  IPAddressRange)
85 } ASN1_CHOICE_END(IPAddressOrRange)
86
87 ASN1_CHOICE(IPAddressChoice) = {
88   ASN1_SIMPLE(IPAddressChoice,      u.inherit,           ASN1_NULL),
89   ASN1_SEQUENCE_OF(IPAddressChoice, u.addressesOrRanges, IPAddressOrRange)
90 } ASN1_CHOICE_END(IPAddressChoice)
91
92 ASN1_SEQUENCE(IPAddressFamily) = {
93   ASN1_SIMPLE(IPAddressFamily, addressFamily,   ASN1_OCTET_STRING),
94   ASN1_SIMPLE(IPAddressFamily, ipAddressChoice, IPAddressChoice)
95 } ASN1_SEQUENCE_END(IPAddressFamily)
96
97 ASN1_ITEM_TEMPLATE(IPAddrBlocks) = 
98   ASN1_EX_TEMPLATE_TYPE(ASN1_TFLG_SEQUENCE_OF, 0,
99                         IPAddrBlocks, IPAddressFamily)
100 ASN1_ITEM_TEMPLATE_END(IPAddrBlocks)
101
102 IMPLEMENT_ASN1_FUNCTIONS(IPAddressRange)
103 IMPLEMENT_ASN1_FUNCTIONS(IPAddressOrRange)
104 IMPLEMENT_ASN1_FUNCTIONS(IPAddressChoice)
105 IMPLEMENT_ASN1_FUNCTIONS(IPAddressFamily)
106
107 /*
108  * How much buffer space do we need for a raw address?
109  */
110 #define ADDR_RAW_BUF_LEN        16
111
112 /*
113  * What's the address length associated with this AFI?
114  */
115 static int length_from_afi(const unsigned afi)
116 {
117   switch (afi) {
118   case IANA_AFI_IPV4:
119     return 4;
120   case IANA_AFI_IPV6:
121     return 16;
122   default:
123     return 0;
124   }
125 }
126
127 /*
128  * Extract the AFI from an IPAddressFamily.
129  */
130 unsigned v3_addr_get_afi(const IPAddressFamily *f)
131 {
132   return ((f != NULL &&
133            f->addressFamily != NULL &&
134            f->addressFamily->data != NULL)
135           ? ((f->addressFamily->data[0] << 8) |
136              (f->addressFamily->data[1]))
137           : 0);
138 }
139
140 /*
141  * Expand the bitstring form of an address into a raw byte array.
142  * At the moment this is coded for simplicity, not speed.
143  */
144 static void addr_expand(unsigned char *addr,
145                         const ASN1_BIT_STRING *bs,
146                         const int length,
147                         const unsigned char fill)
148 {
149   assert(bs->length >= 0 && bs->length <= length);
150   if (bs->length > 0) {
151     memcpy(addr, bs->data, bs->length);
152     if ((bs->flags & 7) != 0) {
153       unsigned char mask = 0xFF >> (8 - (bs->flags & 7));
154       if (fill == 0)
155         addr[bs->length - 1] &= ~mask;
156       else
157         addr[bs->length - 1] |= mask;
158     }
159   }
160   memset(addr + bs->length, fill, length - bs->length);
161 }
162
163 /*
164  * Extract the prefix length from a bitstring.
165  */
166 #define addr_prefixlen(bs) ((int) ((bs)->length * 8 - ((bs)->flags & 7)))
167
168 /*
169  * i2r handler for one address bitstring.
170  */
171 static int i2r_address(BIO *out,
172                        const unsigned afi,
173                        const unsigned char fill,
174                        const ASN1_BIT_STRING *bs)
175 {
176   unsigned char addr[ADDR_RAW_BUF_LEN];
177   int i, n;
178
179   switch (afi) {
180   case IANA_AFI_IPV4:
181     addr_expand(addr, bs, 4, fill);
182     BIO_printf(out, "%d.%d.%d.%d", addr[0], addr[1], addr[2], addr[3]);
183     break;
184   case IANA_AFI_IPV6:
185     addr_expand(addr, bs, 16, fill);
186     for (n = 16; n > 1 && addr[n-1] == 0x00 && addr[n-2] == 0x00; n -= 2)
187       ;
188     for (i = 0; i < n; i += 2)
189       BIO_printf(out, "%x%s", (addr[i] << 8) | addr[i+1], (i < 14 ? ":" : ""));
190     if (i < 16)
191       BIO_puts(out, ":");
192     break;
193   default:
194     for (i = 0; i < bs->length; i++)
195       BIO_printf(out, "%s%02x", (i > 0 ? ":" : ""), bs->data[i]);
196     BIO_printf(out, "[%d]", (int) (bs->flags & 7));
197     break;
198   }
199   return 1;
200 }
201
202 /*
203  * i2r handler for a sequence of addresses and ranges.
204  */
205 static int i2r_IPAddressOrRanges(BIO *out,
206                                  const int indent,
207                                  const IPAddressOrRanges *aors,
208                                  const unsigned afi)
209 {
210   int i;
211   for (i = 0; i < sk_IPAddressOrRange_num(aors); i++) {
212     const IPAddressOrRange *aor = sk_IPAddressOrRange_value(aors, i);
213     BIO_printf(out, "%*s", indent, "");
214     switch (aor->type) {
215     case IPAddressOrRange_addressPrefix:
216       if (!i2r_address(out, afi, 0x00, aor->u.addressPrefix))
217         return 0;
218       BIO_printf(out, "/%d\n", addr_prefixlen(aor->u.addressPrefix));
219       continue;
220     case IPAddressOrRange_addressRange:
221       if (!i2r_address(out, afi, 0x00, aor->u.addressRange->min))
222         return 0;
223       BIO_puts(out, "-");
224       if (!i2r_address(out, afi, 0xFF, aor->u.addressRange->max))
225         return 0;
226       BIO_puts(out, "\n");
227       continue;
228     }
229   }
230   return 1;
231 }
232
233 /*
234  * i2r handler for an IPAddrBlocks extension.
235  */
236 static int i2r_IPAddrBlocks(X509V3_EXT_METHOD *method,
237                             void *ext,
238                             BIO *out,
239                             int indent)
240 {
241   const IPAddrBlocks *addr = ext;
242   int i;
243   for (i = 0; i < sk_IPAddressFamily_num(addr); i++) {
244     IPAddressFamily *f = sk_IPAddressFamily_value(addr, i);
245     const unsigned afi = v3_addr_get_afi(f);
246     switch (afi) {
247     case IANA_AFI_IPV4:
248       BIO_printf(out, "%*sIPv4", indent, "");
249       break;
250     case IANA_AFI_IPV6:
251       BIO_printf(out, "%*sIPv6", indent, "");
252       break;
253     default:
254       BIO_printf(out, "%*sUnknown AFI %u", indent, "", afi);
255       break;
256     }
257     if (f->addressFamily->length > 2) {
258       switch (f->addressFamily->data[2]) {
259       case   1:
260         BIO_puts(out, " (Unicast)");
261         break;
262       case   2:
263         BIO_puts(out, " (Multicast)");
264         break;
265       case   3:
266         BIO_puts(out, " (Unicast/Multicast)");
267         break;
268       case   4:
269         BIO_puts(out, " (MPLS)");
270         break;
271       case  64:
272         BIO_puts(out, " (Tunnel)");
273         break;
274       case  65:
275         BIO_puts(out, " (VPLS)");
276         break;
277       case  66:
278         BIO_puts(out, " (BGP MDT)");
279         break;
280       case 128:
281         BIO_puts(out, " (MPLS-labeled VPN)");
282         break;
283       default:  
284         BIO_printf(out, " (Unknown SAFI %u)",
285                    (unsigned) f->addressFamily->data[2]);
286         break;
287       }
288     }
289     switch (f->ipAddressChoice->type) {
290     case IPAddressChoice_inherit:
291       BIO_puts(out, ": inherit\n");
292       break;
293     case IPAddressChoice_addressesOrRanges:
294       BIO_puts(out, ":\n");
295       if (!i2r_IPAddressOrRanges(out,
296                                  indent + 2,
297                                  f->ipAddressChoice->u.addressesOrRanges,
298                                  afi))
299         return 0;
300       break;
301     }
302   }
303   return 1;
304 }
305
306 /*
307  * Sort comparison function for a sequence of IPAddressOrRange
308  * elements.
309  */
310 static int IPAddressOrRange_cmp(const IPAddressOrRange *a,
311                                 const IPAddressOrRange *b,
312                                 const int length)
313 {
314   unsigned char addr_a[ADDR_RAW_BUF_LEN], addr_b[ADDR_RAW_BUF_LEN];
315   int prefixlen_a = 0, prefixlen_b = 0;
316   int r;
317
318   switch (a->type) {
319   case IPAddressOrRange_addressPrefix:
320     addr_expand(addr_a, a->u.addressPrefix, length, 0x00);
321     prefixlen_a = addr_prefixlen(a->u.addressPrefix);
322     break;
323   case IPAddressOrRange_addressRange:
324     addr_expand(addr_a, a->u.addressRange->min, length, 0x00);
325     prefixlen_a = length * 8;
326     break;
327   }
328
329   switch (b->type) {
330   case IPAddressOrRange_addressPrefix:
331     addr_expand(addr_b, b->u.addressPrefix, length, 0x00);
332     prefixlen_b = addr_prefixlen(b->u.addressPrefix);
333     break;
334   case IPAddressOrRange_addressRange:
335     addr_expand(addr_b, b->u.addressRange->min, length, 0x00);
336     prefixlen_b = length * 8;
337     break;
338   }
339
340   if ((r = memcmp(addr_a, addr_b, length)) != 0)
341     return r;
342   else
343     return prefixlen_a - prefixlen_b;
344 }
345
346 /*
347  * IPv4-specific closure over IPAddressOrRange_cmp, since sk_sort()
348  * comparision routines are only allowed two arguments.
349  */
350 static int v4IPAddressOrRange_cmp(const IPAddressOrRange * const *a,
351                                   const IPAddressOrRange * const *b)
352 {
353   return IPAddressOrRange_cmp(*a, *b, 4);
354 }
355
356 /*
357  * IPv6-specific closure over IPAddressOrRange_cmp, since sk_sort()
358  * comparision routines are only allowed two arguments.
359  */
360 static int v6IPAddressOrRange_cmp(const IPAddressOrRange * const *a,
361                                   const IPAddressOrRange * const *b)
362 {
363   return IPAddressOrRange_cmp(*a, *b, 16);
364 }
365
366 /*
367  * Calculate whether a range collapses to a prefix.
368  * See last paragraph of RFC 3779 2.2.3.7.
369  */
370 static int range_should_be_prefix(const unsigned char *min,
371                                   const unsigned char *max,
372                                   const int length)
373 {
374   unsigned char mask;
375   int i, j;
376
377   for (i = 0; i < length && min[i] == max[i]; i++)
378     ;
379   for (j = length - 1; j >= 0 && min[j] == 0x00 && max[j] == 0xFF; j--)
380     ;
381   if (i < j)
382     return -1;
383   if (i > j)
384     return i * 8;
385   mask = min[i] ^ max[i];
386   switch (mask) {
387   case 0x01: j = 7; break;
388   case 0x03: j = 6; break;
389   case 0x07: j = 5; break;
390   case 0x0F: j = 4; break;
391   case 0x1F: j = 3; break;
392   case 0x3F: j = 2; break;
393   case 0x7F: j = 1; break;
394   default:   return -1;
395   }
396   if ((min[i] & mask) != 0 || (max[i] & mask) != mask)
397     return -1;
398   else
399     return i * 8 + j;
400 }
401
402 /*
403  * Construct a prefix.
404  */
405 static int make_addressPrefix(IPAddressOrRange **result,
406                               unsigned char *addr,
407                               const int prefixlen)
408 {
409   int bytelen = (prefixlen + 7) / 8, bitlen = prefixlen % 8;
410   IPAddressOrRange *aor = IPAddressOrRange_new();
411
412   if (aor == NULL)
413     return 0;
414   aor->type = IPAddressOrRange_addressPrefix;
415   if (aor->u.addressPrefix == NULL &&
416       (aor->u.addressPrefix = ASN1_BIT_STRING_new()) == NULL)
417     goto err;
418   if (!ASN1_BIT_STRING_set(aor->u.addressPrefix, addr, bytelen))
419     goto err;
420   aor->u.addressPrefix->flags &= ~7;
421   aor->u.addressPrefix->flags |= ASN1_STRING_FLAG_BITS_LEFT;
422   if (bitlen > 0) {
423     aor->u.addressPrefix->data[bytelen - 1] &= ~(0xFF >> bitlen);
424     aor->u.addressPrefix->flags |= 8 - bitlen;
425   }
426   
427   *result = aor;
428   return 1;
429
430  err:
431   IPAddressOrRange_free(aor);
432   return 0;
433 }
434
435 /*
436  * Construct a range.  If it can be expressed as a prefix,
437  * return a prefix instead.  Doing this here simplifies
438  * the rest of the code considerably.
439  */
440 static int make_addressRange(IPAddressOrRange **result,
441                              unsigned char *min,
442                              unsigned char *max,
443                              const int length)
444 {
445   IPAddressOrRange *aor;
446   int i, prefixlen;
447
448   if ((prefixlen = range_should_be_prefix(min, max, length)) >= 0)
449     return make_addressPrefix(result, min, prefixlen);
450
451   if ((aor = IPAddressOrRange_new()) == NULL)
452     return 0;
453   aor->type = IPAddressOrRange_addressRange;
454   assert(aor->u.addressRange == NULL);
455   if ((aor->u.addressRange = IPAddressRange_new()) == NULL)
456     goto err;
457   if (aor->u.addressRange->min == NULL &&
458       (aor->u.addressRange->min = ASN1_BIT_STRING_new()) == NULL)
459     goto err;
460   if (aor->u.addressRange->max == NULL &&
461       (aor->u.addressRange->max = ASN1_BIT_STRING_new()) == NULL)
462     goto err;
463
464   for (i = length; i > 0 && min[i - 1] == 0x00; --i)
465     ;
466   if (!ASN1_BIT_STRING_set(aor->u.addressRange->min, min, i))
467     goto err;
468   aor->u.addressRange->min->flags &= ~7;
469   aor->u.addressRange->min->flags |= ASN1_STRING_FLAG_BITS_LEFT;
470   if (i > 0) {
471     unsigned char b = min[i - 1];
472     int j = 1;
473     while ((b & (0xFFU >> j)) != 0) 
474       ++j;
475     aor->u.addressRange->min->flags |= 8 - j;
476   }
477
478   for (i = length; i > 0 && max[i - 1] == 0xFF; --i)
479     ;
480   if (!ASN1_BIT_STRING_set(aor->u.addressRange->max, max, i))
481     goto err;
482   aor->u.addressRange->max->flags &= ~7;
483   aor->u.addressRange->max->flags |= ASN1_STRING_FLAG_BITS_LEFT;
484   if (i > 0) {
485     unsigned char b = max[i - 1];
486     int j = 1;
487     while ((b & (0xFFU >> j)) != (0xFFU >> j))
488       ++j;
489     aor->u.addressRange->max->flags |= 8 - j;
490   }
491
492   *result = aor;
493   return 1;
494
495  err:
496   IPAddressOrRange_free(aor);
497   return 0;
498 }
499
500 /*
501  * Construct a new address family or find an existing one.
502  */
503 static IPAddressFamily *make_IPAddressFamily(IPAddrBlocks *addr,
504                                              const unsigned afi,
505                                              const unsigned *safi)
506 {
507   IPAddressFamily *f;
508   unsigned char key[3];
509   unsigned keylen;
510   int i;
511
512   key[0] = (afi >> 8) & 0xFF;
513   key[1] = afi & 0xFF;
514   if (safi != NULL) {
515     key[2] = *safi & 0xFF;
516     keylen = 3;
517   } else {
518     keylen = 2;
519   }
520
521   for (i = 0; i < sk_IPAddressFamily_num(addr); i++) {
522     f = sk_IPAddressFamily_value(addr, i);
523     assert(f->addressFamily->data != NULL);
524     if (f->addressFamily->length == keylen &&
525         !memcmp(f->addressFamily->data, key, keylen))
526       return f;
527   }
528
529   if ((f = IPAddressFamily_new()) == NULL)
530     goto err;
531   if (f->ipAddressChoice == NULL &&
532       (f->ipAddressChoice = IPAddressChoice_new()) == NULL)
533     goto err;
534   if (f->addressFamily == NULL && 
535       (f->addressFamily = ASN1_OCTET_STRING_new()) == NULL)
536     goto err;
537   if (!ASN1_OCTET_STRING_set(f->addressFamily, key, keylen))
538     goto err;
539   if (!sk_IPAddressFamily_push(addr, f))
540     goto err;
541
542   return f;
543
544  err:
545   IPAddressFamily_free(f);
546   return NULL;
547 }
548
549 /*
550  * Add an inheritance element.
551  */
552 int v3_addr_add_inherit(IPAddrBlocks *addr,
553                         const unsigned afi,
554                         const unsigned *safi)
555 {
556   IPAddressFamily *f = make_IPAddressFamily(addr, afi, safi);
557   if (f == NULL ||
558       f->ipAddressChoice == NULL ||
559       (f->ipAddressChoice->type == IPAddressChoice_addressesOrRanges &&
560        f->ipAddressChoice->u.addressesOrRanges != NULL))
561     return 0;
562   if (f->ipAddressChoice->type == IPAddressChoice_inherit &&
563       f->ipAddressChoice->u.inherit != NULL)
564     return 1;
565   if (f->ipAddressChoice->u.inherit == NULL &&
566       (f->ipAddressChoice->u.inherit = ASN1_NULL_new()) == NULL)
567     return 0;
568   f->ipAddressChoice->type = IPAddressChoice_inherit;
569   return 1;
570 }
571
572 /*
573  * Construct an IPAddressOrRange sequence, or return an existing one.
574  */
575 static IPAddressOrRanges *make_prefix_or_range(IPAddrBlocks *addr,
576                                                const unsigned afi,
577                                                const unsigned *safi)
578 {
579   IPAddressFamily *f = make_IPAddressFamily(addr, afi, safi);
580   IPAddressOrRanges *aors = NULL;
581
582   if (f == NULL ||
583       f->ipAddressChoice == NULL ||
584       (f->ipAddressChoice->type == IPAddressChoice_inherit &&
585        f->ipAddressChoice->u.inherit != NULL))
586     return NULL;
587   if (f->ipAddressChoice->type == IPAddressChoice_addressesOrRanges)
588     aors = f->ipAddressChoice->u.addressesOrRanges;
589   if (aors != NULL)
590     return aors;
591   if ((aors = sk_IPAddressOrRange_new_null()) == NULL)
592     return NULL;
593   switch (afi) {
594   case IANA_AFI_IPV4:
595     sk_IPAddressOrRange_set_cmp_func(aors, v4IPAddressOrRange_cmp);
596     break;
597   case IANA_AFI_IPV6:
598     sk_IPAddressOrRange_set_cmp_func(aors, v6IPAddressOrRange_cmp);
599     break;
600   }
601   f->ipAddressChoice->type = IPAddressChoice_addressesOrRanges;
602   f->ipAddressChoice->u.addressesOrRanges = aors;
603   return aors;
604 }
605
606 /*
607  * Add a prefix.
608  */
609 int v3_addr_add_prefix(IPAddrBlocks *addr,
610                        const unsigned afi,
611                        const unsigned *safi,
612                        unsigned char *a,
613                        const int prefixlen)
614 {
615   IPAddressOrRanges *aors = make_prefix_or_range(addr, afi, safi);
616   IPAddressOrRange *aor;
617   if (aors == NULL || !make_addressPrefix(&aor, a, prefixlen))
618     return 0;
619   if (sk_IPAddressOrRange_push(aors, aor))
620     return 1;
621   IPAddressOrRange_free(aor);
622   return 0;
623 }
624
625 /*
626  * Add a range.
627  */
628 int v3_addr_add_range(IPAddrBlocks *addr,
629                       const unsigned afi,
630                       const unsigned *safi,
631                       unsigned char *min,
632                       unsigned char *max)
633 {
634   IPAddressOrRanges *aors = make_prefix_or_range(addr, afi, safi);
635   IPAddressOrRange *aor;
636   int length = length_from_afi(afi);
637   if (aors == NULL)
638     return 0;
639   if (!make_addressRange(&aor, min, max, length))
640     return 0;
641   if (sk_IPAddressOrRange_push(aors, aor))
642     return 1;
643   IPAddressOrRange_free(aor);
644   return 0;
645 }
646
647 /*
648  * Extract min and max values from an IPAddressOrRange.
649  */
650 static void extract_min_max(IPAddressOrRange *aor,
651                             unsigned char *min,
652                             unsigned char *max,
653                             int length)
654 {
655   assert(aor != NULL && min != NULL && max != NULL);
656   switch (aor->type) {
657   case IPAddressOrRange_addressPrefix:
658     addr_expand(min, aor->u.addressPrefix, length, 0x00);
659     addr_expand(max, aor->u.addressPrefix, length, 0xFF);
660     return;
661   case IPAddressOrRange_addressRange:
662     addr_expand(min, aor->u.addressRange->min, length, 0x00);
663     addr_expand(max, aor->u.addressRange->max, length, 0xFF);
664     return;
665   }
666 }
667
668 /*
669  * Public wrapper for extract_min_max().
670  */
671 int v3_addr_get_range(IPAddressOrRange *aor,
672                       const unsigned afi,
673                       unsigned char *min,
674                       unsigned char *max,
675                       const int length)
676 {
677   int afi_length = length_from_afi(afi);
678   if (aor == NULL || min == NULL || max == NULL ||
679       afi_length == 0 || length < afi_length ||
680       (aor->type != IPAddressOrRange_addressPrefix &&
681        aor->type != IPAddressOrRange_addressRange))
682     return 0;
683   extract_min_max(aor, min, max, afi_length);
684   return afi_length;
685 }
686
687 /*
688  * Sort comparision function for a sequence of IPAddressFamily.
689  *
690  * The last paragraph of RFC 3779 2.2.3.3 is slightly ambiguous about
691  * the ordering: I can read it as meaning that IPv6 without a SAFI
692  * comes before IPv4 with a SAFI, which seems pretty weird.  The
693  * examples in appendix B suggest that the author intended the
694  * null-SAFI rule to apply only within a single AFI, which is what I
695  * would have expected and is what the following code implements.
696  */
697 static int IPAddressFamily_cmp(const IPAddressFamily * const *a_,
698                                const IPAddressFamily * const *b_)
699 {
700   const ASN1_OCTET_STRING *a = (*a_)->addressFamily;
701   const ASN1_OCTET_STRING *b = (*b_)->addressFamily;
702   int len = ((a->length <= b->length) ? a->length : b->length);
703   int cmp = memcmp(a->data, b->data, len);
704   return cmp ? cmp : a->length - b->length;
705 }
706
707 /*
708  * Check whether an IPAddrBLocks is in canonical form.
709  */
710 int v3_addr_is_canonical(IPAddrBlocks *addr)
711 {
712   unsigned char a_min[ADDR_RAW_BUF_LEN], a_max[ADDR_RAW_BUF_LEN];
713   unsigned char b_min[ADDR_RAW_BUF_LEN], b_max[ADDR_RAW_BUF_LEN];
714   IPAddressOrRanges *aors;
715   int i, j, k;
716
717   /*
718    * Empty extension is cannonical.
719    */
720   if (addr == NULL)
721     return 1;
722
723   /*
724    * Check whether the top-level list is in order.
725    */
726   for (i = 0; i < sk_IPAddressFamily_num(addr) - 1; i++) {
727     const IPAddressFamily *a = sk_IPAddressFamily_value(addr, i);
728     const IPAddressFamily *b = sk_IPAddressFamily_value(addr, i + 1);
729     if (IPAddressFamily_cmp(&a, &b) >= 0)
730       return 0;
731   }
732
733   /*
734    * Top level's ok, now check each address family.
735    */
736   for (i = 0; i < sk_IPAddressFamily_num(addr); i++) {
737     IPAddressFamily *f = sk_IPAddressFamily_value(addr, i);
738     int length = length_from_afi(v3_addr_get_afi(f));
739
740     /*
741      * Inheritance is canonical.  Anything other than inheritance or
742      * a SEQUENCE OF IPAddressOrRange is an ASN.1 error or something.
743      */
744     if (f == NULL || f->ipAddressChoice == NULL)
745       return 0;
746     switch (f->ipAddressChoice->type) {
747     case IPAddressChoice_inherit:
748       continue;
749     case IPAddressChoice_addressesOrRanges:
750       break;
751     default:
752       return 0;
753     }
754
755     /*
756      * It's an IPAddressOrRanges sequence, check it.
757      */
758     aors = f->ipAddressChoice->u.addressesOrRanges;
759     if (sk_IPAddressOrRange_num(aors) == 0)
760       return 0;
761     for (j = 0; j < sk_IPAddressOrRange_num(aors) - 1; j++) {
762       IPAddressOrRange *a = sk_IPAddressOrRange_value(aors, j);
763       IPAddressOrRange *b = sk_IPAddressOrRange_value(aors, j + 1);
764
765       extract_min_max(a, a_min, a_max, length);
766       extract_min_max(b, b_min, b_max, length);
767
768       /*
769        * Punt misordered list, overlapping start, or inverted range.
770        */
771       if (memcmp(a_min, b_min, length) >= 0 ||
772           memcmp(a_min, a_max, length) > 0 ||
773           memcmp(b_min, b_max, length) > 0)
774         return 0;
775
776       /*
777        * Punt if adjacent or overlapping.  Check for adjacency by
778        * subtracting one from b_min first.
779        */
780       for (k = length - 1; k >= 0 && b_min[k]-- == 0x00; k--)
781         ;
782       if (memcmp(a_max, b_min, length) >= 0)
783         return 0;
784
785       /*
786        * Check for range that should be expressed as a prefix.
787        */
788       if (a->type == IPAddressOrRange_addressRange &&
789           range_should_be_prefix(a_min, a_max, length) >= 0)
790         return 0;
791     }
792
793     /*
794      * Check final range to see if it should be a prefix.
795      */
796     j = sk_IPAddressOrRange_num(aors) - 1;
797     {
798       IPAddressOrRange *a = sk_IPAddressOrRange_value(aors, j);
799       if (a->type == IPAddressOrRange_addressRange) {
800         extract_min_max(a, a_min, a_max, length);
801         if (range_should_be_prefix(a_min, a_max, length) >= 0)
802           return 0;
803       }
804     }
805   }
806
807   /*
808    * If we made it through all that, we're happy.
809    */
810   return 1;
811 }
812
813 /*
814  * Whack an IPAddressOrRanges into canonical form.
815  */
816 static int IPAddressOrRanges_canonize(IPAddressOrRanges *aors,
817                                       const unsigned afi)
818 {
819   int i, j, length = length_from_afi(afi);
820
821   /*
822    * Sort the IPAddressOrRanges sequence.
823    */
824   sk_IPAddressOrRange_sort(aors);
825
826   /*
827    * Clean up representation issues, punt on duplicates or overlaps.
828    */
829   for (i = 0; i < sk_IPAddressOrRange_num(aors) - 1; i++) {
830     IPAddressOrRange *a = sk_IPAddressOrRange_value(aors, i);
831     IPAddressOrRange *b = sk_IPAddressOrRange_value(aors, i + 1);
832     unsigned char a_min[ADDR_RAW_BUF_LEN], a_max[ADDR_RAW_BUF_LEN];
833     unsigned char b_min[ADDR_RAW_BUF_LEN], b_max[ADDR_RAW_BUF_LEN];
834
835     extract_min_max(a, a_min, a_max, length);
836     extract_min_max(b, b_min, b_max, length);
837
838     /*
839      * Punt overlaps.
840      */
841     if (memcmp(a_max, b_min, length) >= 0)
842       return 0;
843
844     /*
845      * Merge if a and b are adjacent.  We check for
846      * adjacency by subtracting one from b_min first.
847      */
848     for (j = length - 1; j >= 0 && b_min[j]-- == 0x00; j--)
849       ;
850     if (memcmp(a_max, b_min, length) == 0) {
851       IPAddressOrRange *merged;
852       if (!make_addressRange(&merged, a_min, b_max, length))
853         return 0;
854       sk_IPAddressOrRange_set(aors, i, merged);
855       sk_IPAddressOrRange_delete(aors, i + 1);
856       IPAddressOrRange_free(a);
857       IPAddressOrRange_free(b);
858       --i;
859       continue;
860     }
861   }
862
863   return 1;
864 }
865
866 /*
867  * Whack an IPAddrBlocks extension into canonical form.
868  */
869 int v3_addr_canonize(IPAddrBlocks *addr)
870 {
871   int i;
872   for (i = 0; i < sk_IPAddressFamily_num(addr); i++) {
873     IPAddressFamily *f = sk_IPAddressFamily_value(addr, i);
874     if (f->ipAddressChoice->type == IPAddressChoice_addressesOrRanges &&
875         !IPAddressOrRanges_canonize(f->ipAddressChoice->u.addressesOrRanges,
876                                     v3_addr_get_afi(f)))
877       return 0;
878   }
879   sk_IPAddressFamily_sort(addr);
880   assert(v3_addr_is_canonical(addr));
881   return 1;
882 }
883
884 /*
885  * v2i handler for the IPAddrBlocks extension.
886  */
887 static void *v2i_IPAddrBlocks(struct v3_ext_method *method,
888                               struct v3_ext_ctx *ctx,
889                               STACK_OF(CONF_VALUE) *values)
890 {
891   static const char v4addr_chars[] = "0123456789.";
892   static const char v6addr_chars[] = "0123456789.:abcdefABCDEF";
893   IPAddrBlocks *addr = NULL;
894   char *s = NULL, *t;
895   int i;
896   
897   if ((addr = sk_IPAddressFamily_new(IPAddressFamily_cmp)) == NULL) {
898     X509V3err(X509V3_F_V2I_IPADDRBLOCKS, ERR_R_MALLOC_FAILURE);
899     return NULL;
900   }
901
902   for (i = 0; i < sk_CONF_VALUE_num(values); i++) {
903     CONF_VALUE *val = sk_CONF_VALUE_value(values, i);
904     unsigned char min[ADDR_RAW_BUF_LEN], max[ADDR_RAW_BUF_LEN];
905     unsigned afi, *safi = NULL, safi_;
906     const char *addr_chars;
907     int prefixlen, i1, i2, delim, length;
908
909     if (       !name_cmp(val->name, "IPv4")) {
910       afi = IANA_AFI_IPV4;
911     } else if (!name_cmp(val->name, "IPv6")) {
912       afi = IANA_AFI_IPV6;
913     } else if (!name_cmp(val->name, "IPv4-SAFI")) {
914       afi = IANA_AFI_IPV4;
915       safi = &safi_;
916     } else if (!name_cmp(val->name, "IPv6-SAFI")) {
917       afi = IANA_AFI_IPV6;
918       safi = &safi_;
919     } else {
920       X509V3err(X509V3_F_V2I_IPADDRBLOCKS, X509V3_R_EXTENSION_NAME_ERROR);
921       X509V3_conf_err(val);
922       goto err;
923     }
924
925     switch (afi) {
926     case IANA_AFI_IPV4:
927       addr_chars = v4addr_chars;
928       break;
929     case IANA_AFI_IPV6:
930       addr_chars = v6addr_chars;
931       break;
932     }
933
934     length = length_from_afi(afi);
935
936     /*
937      * Handle SAFI, if any, and strdup() so we can null-terminate
938      * the other input values.
939      */
940     if (safi != NULL) {
941       *safi = strtoul(val->value, &t, 0);
942       t += strspn(t, " \t");
943       if (*safi > 0xFF || *t++ != ':') {
944         X509V3err(X509V3_F_V2I_IPADDRBLOCKS, X509V3_R_INVALID_SAFI);
945         X509V3_conf_err(val);
946         goto err;
947       }
948       t += strspn(t, " \t");
949       s = strdup(t);
950     } else {
951       s = strdup(val->value);
952     }
953     if (s == NULL) {
954       X509V3err(X509V3_F_V2I_IPADDRBLOCKS, ERR_R_MALLOC_FAILURE);
955       goto err;
956     }
957
958     /*
959      * Check for inheritance.  Not worth additional complexity to
960      * optimize this (seldom-used) case.
961      */
962     if (!strcmp(s, "inherit")) {
963       if (!v3_addr_add_inherit(addr, afi, safi)) {
964         X509V3err(X509V3_F_V2I_IPADDRBLOCKS, X509V3_R_INVALID_INHERITANCE);
965         X509V3_conf_err(val);
966         goto err;
967       }
968       OPENSSL_free(s);
969       s = NULL;
970       continue;
971     }
972
973     i1 = strspn(s, addr_chars);
974     i2 = i1 + strspn(s + i1, " \t");
975     delim = s[i2++];
976     s[i1] = '\0';
977
978     if (a2i_ipadd(min, s) != length) {
979       X509V3err(X509V3_F_V2I_IPADDRBLOCKS, X509V3_R_INVALID_IPADDRESS);
980       X509V3_conf_err(val);
981       goto err;
982     }
983
984     switch (delim) {
985     case '/':
986       prefixlen = (int) strtoul(s + i2, &t, 10);
987       if (t == s + i2 || *t != '\0') {
988         X509V3err(X509V3_F_V2I_IPADDRBLOCKS, X509V3_R_EXTENSION_VALUE_ERROR);
989         X509V3_conf_err(val);
990         goto err;
991       }
992       if (!v3_addr_add_prefix(addr, afi, safi, min, prefixlen)) {
993         X509V3err(X509V3_F_V2I_IPADDRBLOCKS, ERR_R_MALLOC_FAILURE);
994         goto err;
995       }
996       break;
997     case '-':
998       i1 = i2 + strspn(s + i2, " \t");
999       i2 = i1 + strspn(s + i1, addr_chars);
1000       if (i1 == i2 || s[i2] != '\0') {
1001         X509V3err(X509V3_F_V2I_IPADDRBLOCKS, X509V3_R_EXTENSION_VALUE_ERROR);
1002         X509V3_conf_err(val);
1003         goto err;
1004       }
1005       if (a2i_ipadd(max, s + i1) != length) {
1006         X509V3err(X509V3_F_V2I_IPADDRBLOCKS, X509V3_R_INVALID_IPADDRESS);
1007         X509V3_conf_err(val);
1008         goto err;
1009       }
1010       if (!v3_addr_add_range(addr, afi, safi, min, max)) {
1011         X509V3err(X509V3_F_V2I_IPADDRBLOCKS, ERR_R_MALLOC_FAILURE);
1012         goto err;
1013       }
1014       break;
1015     case '\0':
1016       if (!v3_addr_add_prefix(addr, afi, safi, min, length * 8)) {
1017         X509V3err(X509V3_F_V2I_IPADDRBLOCKS, ERR_R_MALLOC_FAILURE);
1018         goto err;
1019       }
1020       break;
1021     default:
1022       X509V3err(X509V3_F_V2I_IPADDRBLOCKS, X509V3_R_EXTENSION_VALUE_ERROR);
1023       X509V3_conf_err(val);
1024       goto err;
1025     }
1026
1027     OPENSSL_free(s);
1028     s = NULL;
1029   }
1030
1031   /*
1032    * Canonize the result, then we're done.
1033    */
1034   if (!v3_addr_canonize(addr))
1035     goto err;    
1036   return addr;
1037
1038  err:
1039   OPENSSL_free(s);
1040   sk_IPAddressFamily_pop_free(addr, IPAddressFamily_free);
1041   return NULL;
1042 }
1043
1044 /*
1045  * OpenSSL dispatch
1046  */
1047 X509V3_EXT_METHOD v3_addr = {
1048   NID_sbgp_ipAddrBlock,         /* nid */
1049   0,                            /* flags */
1050   ASN1_ITEM_ref(IPAddrBlocks),  /* template */
1051   0, 0, 0, 0,                   /* old functions, ignored */
1052   0,                            /* i2s */
1053   0,                            /* s2i */
1054   0,                            /* i2v */
1055   v2i_IPAddrBlocks,             /* v2i */
1056   i2r_IPAddrBlocks,             /* i2r */
1057   0,                            /* r2i */
1058   NULL                          /* extension-specific data */
1059 };
1060
1061 /*
1062  * Figure out whether extension sues inheritance.
1063  */
1064 int v3_addr_inherits(IPAddrBlocks *addr)
1065 {
1066   int i;
1067   if (addr == NULL)
1068     return 0;
1069   for (i = 0; i < sk_IPAddressFamily_num(addr); i++) {
1070     IPAddressFamily *f = sk_IPAddressFamily_value(addr, i);
1071     if (f->ipAddressChoice->type == IPAddressChoice_inherit)
1072       return 1;
1073   }
1074   return 0;
1075 }
1076
1077 /*
1078  * Figure out whether parent contains child.
1079  */
1080 static int addr_contains(IPAddressOrRanges *parent,
1081                          IPAddressOrRanges *child,
1082                          int length)
1083 {
1084   unsigned char p_min[ADDR_RAW_BUF_LEN], p_max[ADDR_RAW_BUF_LEN];
1085   unsigned char c_min[ADDR_RAW_BUF_LEN], c_max[ADDR_RAW_BUF_LEN];
1086   int p, c;
1087
1088   if (child == NULL || parent == child)
1089     return 1;
1090   if (parent == NULL)
1091     return 0;
1092
1093   p = 0;
1094   for (c = 0; c < sk_IPAddressOrRange_num(child); c++) {
1095     extract_min_max(sk_IPAddressOrRange_value(child, c),
1096                     c_min, c_max, length);
1097     for (;; p++) {
1098       if (p >= sk_IPAddressOrRange_num(parent))
1099         return 0;
1100       extract_min_max(sk_IPAddressOrRange_value(parent, p),
1101                       p_min, p_max, length);
1102       if (memcmp(p_max, c_max, length) < 0)
1103         continue;
1104       if (memcmp(p_min, c_min, length) > 0)
1105         return 0;
1106       break;
1107     }
1108   }
1109
1110   return 1;
1111 }
1112
1113 /*
1114  * Test whether a is a subset of b.
1115  */
1116 int v3_addr_subset(IPAddrBlocks *a, IPAddrBlocks *b)
1117 {
1118   int i;
1119   if (a == NULL || a == b)
1120     return 1;
1121   if (b == NULL || v3_addr_inherits(a) || v3_addr_inherits(b))
1122     return 0;
1123   sk_IPAddressFamily_set_cmp_func(b, IPAddressFamily_cmp);
1124   for (i = 0; i < sk_IPAddressFamily_num(a); i++) {
1125     IPAddressFamily *fa = sk_IPAddressFamily_value(a, i);
1126     int j = sk_IPAddressFamily_find(b, fa);
1127     IPAddressFamily *fb = sk_IPAddressFamily_value(b, j);
1128     if (!addr_contains(fb->ipAddressChoice->u.addressesOrRanges, 
1129                        fa->ipAddressChoice->u.addressesOrRanges,
1130                        length_from_afi(v3_addr_get_afi(fb))))
1131       return 0;
1132   }
1133   return 1;
1134 }
1135
1136 /*
1137  * Validation error handling via callback.
1138  */
1139 #define validation_err(_err_)           \
1140   do {                                  \
1141     if (ctx != NULL) {                  \
1142       ctx->error = _err_;               \
1143       ctx->error_depth = i;             \
1144       ctx->current_cert = x;            \
1145       ret = ctx->verify_cb(0, ctx);     \
1146     } else {                            \
1147       ret = 0;                          \
1148     }                                   \
1149     if (!ret)                           \
1150       goto done;                        \
1151   } while (0)
1152
1153 /*
1154  * Core code for RFC 3779 2.3 path validation.
1155  */
1156 static int v3_addr_validate_path_internal(X509_STORE_CTX *ctx,
1157                                           STACK_OF(X509) *chain,
1158                                           IPAddrBlocks *ext)
1159 {
1160   IPAddrBlocks *child = NULL;
1161   int i, j, ret = 1;
1162   X509 *x;
1163
1164   assert(chain != NULL && sk_X509_num(chain) > 0);
1165   assert(ctx != NULL || ext != NULL);
1166   assert(ctx == NULL || ctx->verify_cb != NULL);
1167
1168   /*
1169    * Figure out where to start.  If we don't have an extension to
1170    * check, we're done.  Otherwise, check canonical form and
1171    * set up for walking up the chain.
1172    */
1173   if (ext != NULL) {
1174     i = -1;
1175     x = NULL;
1176   } else {
1177     i = 0;
1178     x = sk_X509_value(chain, i);
1179     assert(x != NULL);
1180     if ((ext = x->rfc3779_addr) == NULL)
1181       goto done;
1182   }
1183   if (!v3_addr_is_canonical(ext))
1184     validation_err(X509_V_ERR_INVALID_EXTENSION);
1185   sk_IPAddressFamily_set_cmp_func(ext, IPAddressFamily_cmp);
1186   if ((child = sk_IPAddressFamily_dup(ext)) == NULL) {
1187     X509V3err(X509V3_F_V3_ADDR_VALIDATE_PATH_INTERNAL, ERR_R_MALLOC_FAILURE);
1188     ret = 0;
1189     goto done;
1190   }
1191
1192   /*
1193    * Now walk up the chain.  No cert may list resources that its
1194    * parent doesn't list.
1195    */
1196   for (i++; i < sk_X509_num(chain); i++) {
1197     x = sk_X509_value(chain, i);
1198     assert(x != NULL);
1199     if (!v3_addr_is_canonical(x->rfc3779_addr))
1200       validation_err(X509_V_ERR_INVALID_EXTENSION);
1201     if (x->rfc3779_addr == NULL) {
1202       for (j = 0; j < sk_IPAddressFamily_num(child); j++) {
1203         IPAddressFamily *fc = sk_IPAddressFamily_value(child, j);
1204         if (fc->ipAddressChoice->type != IPAddressChoice_inherit) {
1205           validation_err(X509_V_ERR_UNNESTED_RESOURCE);
1206           break;
1207         }
1208       }
1209       continue;
1210     }
1211     sk_IPAddressFamily_set_cmp_func(x->rfc3779_addr, IPAddressFamily_cmp);
1212     for (j = 0; j < sk_IPAddressFamily_num(child); j++) {
1213       IPAddressFamily *fc = sk_IPAddressFamily_value(child, j);
1214       int k = sk_IPAddressFamily_find(x->rfc3779_addr, fc);
1215       IPAddressFamily *fp = sk_IPAddressFamily_value(x->rfc3779_addr, k);
1216       if (fp == NULL) {
1217         if (fc->ipAddressChoice->type == IPAddressChoice_addressesOrRanges) {
1218           validation_err(X509_V_ERR_UNNESTED_RESOURCE);
1219           break;
1220         }
1221         continue;
1222       }
1223       if (fp->ipAddressChoice->type == IPAddressChoice_addressesOrRanges) {
1224         if (fc->ipAddressChoice->type == IPAddressChoice_inherit ||
1225             addr_contains(fp->ipAddressChoice->u.addressesOrRanges, 
1226                           fc->ipAddressChoice->u.addressesOrRanges,
1227                           length_from_afi(v3_addr_get_afi(fc))))
1228           sk_IPAddressFamily_set(child, j, fp);
1229         else
1230           validation_err(X509_V_ERR_UNNESTED_RESOURCE);
1231       }
1232     }
1233   }
1234
1235   /*
1236    * Trust anchor can't inherit.
1237    */
1238   assert(x != NULL);
1239   if (x->rfc3779_addr != NULL) {
1240     for (j = 0; j < sk_IPAddressFamily_num(x->rfc3779_addr); j++) {
1241       IPAddressFamily *fp = sk_IPAddressFamily_value(x->rfc3779_addr, j);
1242       if (fp->ipAddressChoice->type == IPAddressChoice_inherit &&
1243           sk_IPAddressFamily_find(child, fp) >= 0)
1244         validation_err(X509_V_ERR_UNNESTED_RESOURCE);
1245     }
1246   }
1247
1248  done:
1249   sk_IPAddressFamily_free(child);
1250   return ret;
1251 }
1252
1253 #undef validation_err
1254
1255 /*
1256  * RFC 3779 2.3 path validation -- called from X509_verify_cert().
1257  */
1258 int v3_addr_validate_path(X509_STORE_CTX *ctx)
1259 {
1260   return v3_addr_validate_path_internal(ctx, ctx->chain, NULL);
1261 }
1262
1263 /*
1264  * RFC 3779 2.3 path validation of an extension.
1265  * Test whether chain covers extension.
1266  */
1267 int v3_addr_validate_resource_set(STACK_OF(X509) *chain,
1268                                   IPAddrBlocks *ext,
1269                                   int allow_inheritance)
1270 {
1271   if (ext == NULL)
1272     return 1;
1273   if (chain == NULL || sk_X509_num(chain) == 0)
1274     return 0;
1275   if (!allow_inheritance && v3_addr_inherits(ext))
1276     return 0;
1277   return v3_addr_validate_path_internal(NULL, chain, ext);
1278 }
1279
1280 #endif /* OPENSSL_NO_RFC3779 */