Fix all spelling errors found by codespell.
[tinc] / src / subnet_parse.c
index 22f5d70..88513f6 100644 (file)
@@ -27,6 +27,9 @@
 #include "utils.h"
 #include "xalloc.h"
 
+/* Changing this default will affect ADD_SUBNET messages - beware of inconsistencies between versions */
+static const int DEFAULT_WEIGHT = 10;
+
 /* Subnet mask handling */
 
 int maskcmp(const void *va, const void *vb, int masklen) {
@@ -36,13 +39,15 @@ int maskcmp(const void *va, const void *vb, int masklen) {
 
        for(m = masklen, i = 0; m >= 8; m -= 8, i++) {
                result = a[i] - b[i];
-               if(result)
+
+               if(result) {
                        return result;
+               }
        }
 
        if(m)
                return (a[i] & (0x100 - (1 << (8 - m)))) -
-                       (b[i] & (0x100 - (1 << (8 - m))));
+                      (b[i] & (0x100 - (1 << (8 - m))));
 
        return 0;
 }
@@ -54,11 +59,13 @@ void mask(void *va, int masklen, int len) {
        i = masklen / 8;
        masklen %= 8;
 
-       if(masklen)
+       if(masklen) {
                a[i++] &= (0x100 - (1 << (8 - masklen)));
+       }
 
-       for(; i < len; i++)
+       for(; i < len; i++) {
                a[i] = 0;
+       }
 }
 
 void maskcpy(void *va, const void *vb, int masklen, int len) {
@@ -66,16 +73,18 @@ void maskcpy(void *va, const void *vb, int masklen, int len) {
        char *a = va;
        const char *b = vb;
 
-       for(m = masklen, i = 0; m >= 8; m -= 8, i++)
+       for(m = masklen, i = 0; m >= 8; m -= 8, i++) {
                a[i] = b[i];
+       }
 
        if(m) {
                a[i] = b[i] & (0x100 - (1 << (8 - m)));
                i++;
        }
 
-       for(; i < len; i++)
+       for(; i < len; i++) {
                a[i] = 0;
+       }
 }
 
 bool maskcheck(const void *va, int masklen, int len) {
@@ -85,12 +94,14 @@ bool maskcheck(const void *va, int masklen, int len) {
        i = masklen / 8;
        masklen %= 8;
 
-       if(masklen && a[i++] & (0xff >> masklen))
+       if(masklen && a[i++] & (0xff >> masklen)) {
                return false;
+       }
 
        for(; i < len; i++)
-               if(a[i] != 0)
+               if(a[i] != 0) {
                        return false;
+               }
 
        return true;
 }
@@ -100,15 +111,17 @@ bool maskcheck(const void *va, int masklen, int len) {
 static int subnet_compare_mac(const subnet_t *a, const subnet_t *b) {
        int result;
 
-       result = memcmp(&a->net.mac.address, &b->net.mac.address, sizeof a->net.mac.address);
+       result = memcmp(&a->net.mac.address, &b->net.mac.address, sizeof(a->net.mac.address));
 
-       if(result)
+       if(result) {
                return result;
-       
+       }
+
        result = a->weight - b->weight;
 
-       if(result || !a->owner || !b->owner)
+       if(result || !a->owner || !b->owner) {
                return result;
+       }
 
        return strcmp(a->owner->name, b->owner->name);
 }
@@ -118,18 +131,21 @@ static int subnet_compare_ipv4(const subnet_t *a, const subnet_t *b) {
 
        result = b->net.ipv4.prefixlength - a->net.ipv4.prefixlength;
 
-       if(result)
+       if(result) {
                return result;
+       }
 
        result = memcmp(&a->net.ipv4.address, &b->net.ipv4.address, sizeof(ipv4_t));
 
-       if(result)
+       if(result) {
                return result;
-       
+       }
+
        result = a->weight - b->weight;
 
-       if(result || !a->owner || !b->owner)
+       if(result || !a->owner || !b->owner) {
                return result;
+       }
 
        return strcmp(a->owner->name, b->owner->name);
 }
@@ -139,18 +155,21 @@ static int subnet_compare_ipv6(const subnet_t *a, const subnet_t *b) {
 
        result = b->net.ipv6.prefixlength - a->net.ipv6.prefixlength;
 
-       if(result)
+       if(result) {
                return result;
-       
+       }
+
        result = memcmp(&a->net.ipv6.address, &b->net.ipv6.address, sizeof(ipv6_t));
 
-       if(result)
+       if(result) {
                return result;
-       
+       }
+
        result = a->weight - b->weight;
 
-       if(result || !a->owner || !b->owner)
+       if(result || !a->owner || !b->owner) {
                return result;
+       }
 
        return strcmp(a->owner->name, b->owner->name);
 }
@@ -160,16 +179,20 @@ int subnet_compare(const subnet_t *a, const subnet_t *b) {
 
        result = a->type - b->type;
 
-       if(result)
+       if(result) {
                return result;
+       }
 
-       switch (a->type) {
+       switch(a->type) {
        case SUBNET_MAC:
                return subnet_compare_mac(a, b);
+
        case SUBNET_IPV4:
                return subnet_compare_ipv4(a, b);
+
        case SUBNET_IPV6:
                return subnet_compare_ipv6(a, b);
+
        default:
                logger(DEBUG_ALWAYS, LOG_ERR, "subnet_compare() was called with unknown subnet type %d, exitting!", a->type);
                exit(1);
@@ -181,149 +204,164 @@ int subnet_compare(const subnet_t *a, const subnet_t *b) {
 /* Ascii representation of subnets */
 
 bool str2net(subnet_t *subnet, const char *subnetstr) {
-       int i, l;
-       uint16_t x[8];
-       int weight = 10;
+       char str[1024];
+       strncpy(str, subnetstr, sizeof(str));
+       str[sizeof(str) - 1] = 0;
+       int consumed;
+
+       int weight = DEFAULT_WEIGHT;
+       char *weight_separator = strchr(str, '#');
 
-       if(sscanf(subnetstr, "%hu.%hu.%hu.%hu/%d#%d",
-                         &x[0], &x[1], &x[2], &x[3], &l, &weight) >= 5) {
-               if(l < 0 || l > 32)
+       if(weight_separator) {
+               char *weight_str = weight_separator + 1;
+
+               if(sscanf(weight_str, "%d%n", &weight, &consumed) < 1) {
                        return false;
+               }
 
-               subnet->type = SUBNET_IPV4;
-               subnet->net.ipv4.prefixlength = l;
-               subnet->weight = weight;
+               if(weight_str[consumed]) {
+                       return false;
+               }
 
-               for(int i = 0; i < 4; i++) {
-                       if(x[i] > 255)
-                               return false;
-                       subnet->net.ipv4.address.x[i] = x[i];
+               *weight_separator = 0;
+       }
+
+       int prefixlength = -1;
+       char *prefixlength_separator = strchr(str, '/');
+
+       if(prefixlength_separator) {
+               char *prefixlength_str = prefixlength_separator + 1;
+
+               if(sscanf(prefixlength_str, "%d%n", &prefixlength, &consumed) < 1) {
+                       return false;
                }
 
-               return true;
+               if(prefixlength_str[consumed]) {
+                       return false;
+               }
+
+               *prefixlength_separator = 0;
+
+               if(prefixlength < 0) {
+                       return false;
+               }
        }
 
-       if(sscanf(subnetstr, "%hx:%hx:%hx:%hx:%hx:%hx:%hx:%hx/%d#%d",
-                         &x[0], &x[1], &x[2], &x[3], &x[4], &x[5], &x[6], &x[7],
-                         &l, &weight) >= 9) {
-               if(l < 0 || l > 128)
+       uint16_t x[8];
+
+       if(sscanf(str, "%hx:%hx:%hx:%hx:%hx:%hx%n", &x[0], &x[1], &x[2], &x[3], &x[4], &x[5], &consumed) >= 6 && !str[consumed]) {
+               /*
+                  Normally we should check that each part has two digits to prevent ambiguities.
+                  However, in old tinc versions net2str() will aggressively return MAC addresses with one-digit parts,
+                  so we have to accept them otherwise we would be unable to parse ADD_SUBNET messages.
+               */
+               if(prefixlength >= 0) {
                        return false;
+               }
 
-               subnet->type = SUBNET_IPV6;
-               subnet->net.ipv6.prefixlength = l;
+               subnet->type = SUBNET_MAC;
                subnet->weight = weight;
 
-               for(i = 0; i < 8; i++)
-                       subnet->net.ipv6.address.x[i] = htons(x[i]);
+               for(int i = 0; i < 6; i++) {
+                       subnet->net.mac.address.x[i] = x[i];
+               }
 
                return true;
        }
 
-       if(sscanf(subnetstr, "%hu.%hu.%hu.%hu#%d", &x[0], &x[1], &x[2], &x[3], &weight) >= 4) {
+       if(sscanf(str, "%hu.%hu.%hu.%hu%n", &x[0], &x[1], &x[2], &x[3], &consumed) >= 4 && !str[consumed]) {
+               if(prefixlength == -1) {
+                       prefixlength = 32;
+               }
+
+               if(prefixlength > 32) {
+                       return false;
+               }
+
                subnet->type = SUBNET_IPV4;
-               subnet->net.ipv4.prefixlength = 32;
+               subnet->net.ipv4.prefixlength = prefixlength;
                subnet->weight = weight;
 
-               for(i = 0; i < 4; i++) {
-                       if(x[i] > 255)
+               for(int i = 0; i < 4; i++) {
+                       if(x[i] > 255) {
                                return false;
+                       }
+
                        subnet->net.ipv4.address.x[i] = x[i];
                }
 
                return true;
        }
 
-       if(sscanf(subnetstr, "%hx:%hx:%hx:%hx:%hx:%hx:%hx:%hx#%d",
-                         &x[0], &x[1], &x[2], &x[3], &x[4], &x[5], &x[6], &x[7], &weight) >= 8) {
-               subnet->type = SUBNET_IPV6;
-               subnet->net.ipv6.prefixlength = 128;
-               subnet->weight = weight;
+       /* IPv6 */
 
-               for(i = 0; i < 8; i++)
-                       subnet->net.ipv6.address.x[i] = htons(x[i]);
+       char *last_colon = strrchr(str, ':');
 
-               return true;
-       }
+       if(last_colon && sscanf(last_colon, ":%hu.%hu.%hu.%hu%n", &x[0], &x[1], &x[2], &x[3], &consumed) >= 4 && !last_colon[consumed]) {
+               /* Dotted quad suffix notation, convert to standard IPv6 notation */
+               for(int i = 0; i < 4; i++)
+                       if(x[i] > 255) {
+                               return false;
+                       }
 
-       if(sscanf(subnetstr, "%hx:%hx:%hx:%hx:%hx:%hx#%d",
-                         &x[0], &x[1], &x[2], &x[3], &x[4], &x[5], &weight) >= 6) {
-               subnet->type = SUBNET_MAC;
-               subnet->weight = weight;
+               snprintf(last_colon, sizeof(str) - (last_colon - str), ":%02x%02x:%02x%02x", x[0], x[1], x[2], x[3]);
+       }
 
-               for(i = 0; i < 6; i++)
-                       subnet->net.mac.address.x[i] = x[i];
+       char *double_colon = strstr(str, "::");
 
-               return true;
-       }
+       if(double_colon) {
+               /* Figure out how many zero groups we need to expand */
+               int zero_group_count = 8;
 
-       // IPv6 short form
-       if(strstr(subnetstr, "::")) {
-               const char *p;
-               char *q;
-               int colons = 0;
+               for(const char *cur = str; *cur; cur++)
+                       if(*cur != ':') {
+                               zero_group_count--;
 
-               // Count number of colons
-               for(p = subnetstr; *p; p++)
-                       if(*p == ':')
-                               colons++;
+                               while(cur[1] && cur[1] != ':') {
+                                       cur++;
+                               }
+                       }
 
-               if(colons > 7)
+               if(zero_group_count < 1) {
                        return false;
-
-               // Scan numbers before the double colon
-               p = subnetstr;
-               for(i = 0; i < colons; i++) {
-                       if(*p == ':')
-                               break;
-                       x[i] = strtoul(p, &q, 0x10);
-                       if(!q || p == q || *q != ':')
-                               return false;
-                       p = ++q;
                }
 
-               p++;
-               colons -= i;
-               if(!i) {
-                       p++;
-                       colons--;
-               }
+               /* Split the double colon in the middle to make room for zero groups */
+               double_colon++;
+               memmove(double_colon + (zero_group_count * 2 - 1), double_colon, strlen(double_colon) + 1);
 
-               if(!*p || *p == '/' || *p == '#')
-                       colons--;
+               /* Write zero groups in the resulting gap, overwriting the second colon */
+               for(int i = 0; i < zero_group_count; i++) {
+                       memcpy(&double_colon[i * 2], "0:", 2);
+               }
 
-               // Fill in the blanks
-               for(; i < 8 - colons; i++)
-                       x[i] = 0;
+               /* Remove any leading or trailing colons */
+               if(str[0] == ':') {
+                       memmove(&str[0], &str[1], strlen(&str[1]) + 1);
+               }
 
-               // Scan the remaining numbers
-               for(; i < 8; i++) {
-                       x[i] = strtoul(p, &q, 0x10);
-                       if(!q || p == q)
-                               return false;
-                       if(i == 7) {
-                               p = q;
-                               break;
-                       }
-                       if(*q != ':')
-                               return false;
-                       p = ++q;
+               if(str[strlen(str) - 1] == ':') {
+                       str[strlen(str) - 1] = 0;
                }
+       }
 
-               l = 128;
-               if(*p == '/')
-                       sscanf(p, "/%d#%d", &l, &weight);
-               else if(*p == '#')
-                       sscanf(p, "#%d", &weight);
+       if(sscanf(str, "%hx:%hx:%hx:%hx:%hx:%hx:%hx:%hx%n",
+                       &x[0], &x[1], &x[2], &x[3], &x[4], &x[5], &x[6], &x[7], &consumed) >= 8 && !str[consumed]) {
+               if(prefixlength == -1) {
+                       prefixlength = 128;
+               }
 
-               if(l < 0 || l > 128)
+               if(prefixlength > 128) {
                        return false;
+               }
 
                subnet->type = SUBNET_IPV6;
-               subnet->net.ipv6.prefixlength = l;
+               subnet->net.ipv6.prefixlength = prefixlength;
                subnet->weight = weight;
 
-               for(i = 0; i < 8; i++)
+               for(int i = 0; i < 8; i++) {
                        subnet->net.ipv6.address.x[i] = htons(x[i]);
+               }
 
                return true;
        }
@@ -337,45 +375,115 @@ bool net2str(char *netstr, int len, const subnet_t *subnet) {
                return false;
        }
 
-       switch (subnet->type) {
-               case SUBNET_MAC:
-                       snprintf(netstr, len, "%hx:%hx:%hx:%hx:%hx:%hx#%d",
-                                        subnet->net.mac.address.x[0],
-                                        subnet->net.mac.address.x[1],
-                                        subnet->net.mac.address.x[2],
-                                        subnet->net.mac.address.x[3],
-                                        subnet->net.mac.address.x[4],
-                                        subnet->net.mac.address.x[5],
-                                        subnet->weight);
-                       break;
-
-               case SUBNET_IPV4:
-                       snprintf(netstr, len, "%hu.%hu.%hu.%hu/%d#%d",
-                                        subnet->net.ipv4.address.x[0],
-                                        subnet->net.ipv4.address.x[1],
-                                        subnet->net.ipv4.address.x[2],
-                                        subnet->net.ipv4.address.x[3],
-                                        subnet->net.ipv4.prefixlength,
-                                        subnet->weight);
-                       break;
-
-               case SUBNET_IPV6:
-                       snprintf(netstr, len, "%hx:%hx:%hx:%hx:%hx:%hx:%hx:%hx/%d#%d",
-                                        ntohs(subnet->net.ipv6.address.x[0]),
-                                        ntohs(subnet->net.ipv6.address.x[1]),
-                                        ntohs(subnet->net.ipv6.address.x[2]),
-                                        ntohs(subnet->net.ipv6.address.x[3]),
-                                        ntohs(subnet->net.ipv6.address.x[4]),
-                                        ntohs(subnet->net.ipv6.address.x[5]),
-                                        ntohs(subnet->net.ipv6.address.x[6]),
-                                        ntohs(subnet->net.ipv6.address.x[7]),
-                                        subnet->net.ipv6.prefixlength,
-                                        subnet->weight);
-                       break;
-
-               default:
-                       logger(DEBUG_ALWAYS, LOG_ERR, "net2str() was called with unknown subnet type %d, exiting!", subnet->type);
-                       exit(1);
+       int result;
+       int prefixlength = -1;
+
+       switch(subnet->type) {
+       case SUBNET_MAC:
+               result = snprintf(netstr, len, "%02x:%02x:%02x:%02x:%02x:%02x",
+                                 subnet->net.mac.address.x[0],
+                                 subnet->net.mac.address.x[1],
+                                 subnet->net.mac.address.x[2],
+                                 subnet->net.mac.address.x[3],
+                                 subnet->net.mac.address.x[4],
+                                 subnet->net.mac.address.x[5]);
+               netstr += result;
+               len -= result;
+               break;
+
+       case SUBNET_IPV4:
+               result = snprintf(netstr, len, "%u.%u.%u.%u",
+                                 subnet->net.ipv4.address.x[0],
+                                 subnet->net.ipv4.address.x[1],
+                                 subnet->net.ipv4.address.x[2],
+                                 subnet->net.ipv4.address.x[3]);
+               netstr += result;
+               len -= result;
+               prefixlength = subnet->net.ipv4.prefixlength;
+
+               if(prefixlength == 32) {
+                       prefixlength = -1;
+               }
+
+               break;
+
+       case SUBNET_IPV6: {
+               /* Find the longest sequence of consecutive zeroes */
+               int max_zero_length = 0;
+               int max_zero_length_index = 0;
+               int current_zero_length = 0;
+               int current_zero_length_index = 0;
+
+               for(int i = 0; i < 8; i++) {
+                       if(subnet->net.ipv6.address.x[i] != 0) {
+                               current_zero_length = 0;
+                       } else {
+                               if(current_zero_length == 0) {
+                                       current_zero_length_index = i;
+                               }
+
+                               current_zero_length++;
+
+                               if(current_zero_length > max_zero_length) {
+                                       max_zero_length = current_zero_length;
+                                       max_zero_length_index = current_zero_length_index;
+                               }
+                       }
+               }
+
+               /* Print the address */
+               for(int i = 0; i < 8;) {
+                       if(max_zero_length > 1 && max_zero_length_index == i) {
+                               /* Shorten the representation as per RFC 5952 */
+                               const char *const FORMATS[] = { "%.1s", "%.2s", "%.3s" };
+                               const char *const *format = &FORMATS[0];
+
+                               if(i == 0) {
+                                       format++;
+                               }
+
+                               if(i + max_zero_length == 8) {
+                                       format++;
+                               }
+
+                               result = snprintf(netstr, len, *format, ":::");
+                               i += max_zero_length;
+                       } else {
+                               result = snprintf(netstr, len, "%x:", ntohs(subnet->net.ipv6.address.x[i]));
+                               i++;
+                       }
+
+                       netstr += result;
+                       len -= result;
+               }
+
+               /* Remove the trailing colon */
+               netstr--;
+               len++;
+               *netstr = 0;
+
+               prefixlength = subnet->net.ipv6.prefixlength;
+
+               if(prefixlength == 128) {
+                       prefixlength = -1;
+               }
+
+               break;
+       }
+
+       default:
+               logger(DEBUG_ALWAYS, LOG_ERR, "net2str() was called with unknown subnet type %d, exiting!", subnet->type);
+               exit(1);
+       }
+
+       if(prefixlength >= 0) {
+               result = snprintf(netstr, len, "/%d", prefixlength);
+               netstr += result;
+               len -= result;
+       }
+
+       if(subnet->weight != DEFAULT_WEIGHT) {
+               snprintf(netstr, len, "#%d", subnet->weight);
        }
 
        return true;