Added support for ARO registration failure

Added test API to set max child count
Added blacklist for neighbors if ARO registration fails
Added check for new neighbor creation
Added Wisun processing for NA ARO messages

Author: Mika Tervonen

nanostack/net_ws_test.h

@@ -40,7 +40,7 @@ extern "C" {
 #include "ns_types.h"
 
 /**
- * \brief Set extension name.
+ * \brief Set Pan size.
  *
  * Pan size is reported to advertisement. Using this function
  * actual value can be overridden.
@@ -54,6 +54,24 @@ extern "C" {
  * \return <0                        Failure
  */
 int ws_test_pan_size_set(int8_t interface_id, uint16_t pan_size);
+
+/**
+ * \brief Set maximum child count.
+ *
+ * Maximum amount of children allowed for this device
+ *
+ * Values above MAC neighbor table - RPL parents - temporary entries will cause undefined behaviour
+ *
+ * Set child count to 0xffff to stop override
+ *
+ * \param interface_id               Network Interface
+ * \param child_count                   Pan size reported in advertisements
+ *
+ * \return 0                         OK
+ * \return <0                        Failure
+ */
+int ws_test_max_child_count_set(int8_t interface_id, uint16_t child_count);
+
 #ifdef __cplusplus
 }
 #endif

source/6LoWPAN/ws/ws_bootstrap.c

@@ -57,6 +57,7 @@
 #include "Service_Libs/etx/etx.h"
 #include "Service_Libs/mac_neighbor_table/mac_neighbor_table.h"
 #include "Service_Libs/nd_proxy/nd_proxy.h"
+#include "Service_Libs/blacklist/blacklist.h"
 #include "platform/topo_trace.h"
 #include "libDHCPv6/libDHCPv6.h"
 #include "DHCPv6_client/dhcpv6_client_api.h"
@@ -149,6 +150,8 @@ static void ws_bootstrap_address_notification_cb(struct protocol_interface_info_
                 break;
             }
         }
+    } else {
+        tr_debug("Address notification addr: %s reason: %d", trace_ipv6(addr->address), reason);
     }
 }
 
@@ -636,6 +639,8 @@ static int8_t ws_bootstrap_up(protocol_interface_info_entry_t *cur)
     cur->ipv6_neighbour_cache.use_eui64_as_slla_in_aro = true;
     /* Omit sending of NA if ARO SUCCESS */
     cur->ipv6_neighbour_cache.omit_aro_success = true;
+    // do not process AROs from NA. This is overriden by Wi-SUN specific failure handling
+    cur->ipv6_neighbour_cache.recv_na_aro = false;
     /* Disable NUD Probes */
     cur->ipv6_neighbour_cache.send_nud_probes = false;
     cur->ipv6_neighbour_cache.probe_avoided_routers = true;
@@ -646,6 +651,14 @@ static int8_t ws_bootstrap_up(protocol_interface_info_entry_t *cur)
 
     ws_nud_table_reset(cur);
 
+    blacklist_params_set(
+        WS_BLACKLIST_ENTRY_LIFETIME,
+        WS_BLACKLIST_TIMER_MAX_TIMEOUT,
+        WS_BLACKLIST_TIMER_TIMEOUT,
+        WS_BLACKLIST_ENTRY_MAX_NBR,
+        WS_BLACKLIST_PURGE_NBR,
+        WS_BLACKLIST_PURGE_TIMER_TIMEOUT);
+
     ws_bootstrap_event_discovery_start(cur);
 
     return 0;
@@ -670,6 +683,7 @@ static int8_t ws_bootstrap_down(protocol_interface_info_entry_t *cur)
     ws_eapol_relay_delete(cur);
     ws_eapol_auth_relay_delete(cur);
     ws_pae_controller_stop(cur);
+    blacklist_clear();
 
     return nwk_6lowpan_down(cur);
 }
@@ -1235,6 +1249,17 @@ static bool ws_bootstrap_neighbor_info_request(struct protocol_interface_info_en
     if (!request_new) {
         return false;
     }
+    uint8_t ll_target[16];
+    memcpy(ll_target, ADDR_LINK_LOCAL_PREFIX, 8);
+    memcpy(ll_target + 8, mac_64, 8);
+    ll_target[8] ^= 2;
+
+
+    if (blacklist_reject(ll_target)) {
+        // Rejected by blacklist
+        return false;
+    }
+
     ws_bootstrap_neighbor_table_clean(interface);
 
     neighbor_buffer->neighbor = ws_bootstrap_mac_neighbor_add(interface, mac_64);
@@ -1357,6 +1382,10 @@ int ws_bootstrap_init(int8_t interface_id, net_6lowpan_mode_e bootstrap_mode)
     if (!etx_storage_list_allocate(cur->id, buffer.device_decription_table_size)) {
         return -1;
     }
+    if (blacklist_init() != 0) {
+        tr_err("MLE blacklist init failed.");
+        return -1;
+    }
 
     switch (bootstrap_mode) {
         //        case NET_6LOWPAN_SLEEPY_HOST:
@@ -1494,6 +1523,23 @@ int ws_bootstrap_restart(int8_t interface_id)
     return 0;
 }
 
+int ws_bootstrap_neighbor_remove(protocol_interface_info_entry_t *cur, const uint8_t *ll_address)
+{
+    tr_warn("ARO registration Failure %s", trace_ipv6(ll_address));
+
+    blacklist_update(ll_address, false);
+
+    mac_neighbor_table_entry_t *mac_neighbor = mac_neighbor_entry_get_by_ll64(mac_neighbor_info(cur), ll_address, false, NULL);
+
+    if (mac_neighbor) {
+        ws_bootstrap_neighbor_delete(cur, mac_neighbor->index);
+        // TODO Add to blacklist
+    }
+    return 0;
+}
+
+
+
 static void ws_bootstrap_mac_activate(protocol_interface_info_entry_t *cur, uint16_t channel, uint16_t panid, bool coordinator)
 {
     mlme_start_t start_req;

source/6LoWPAN/ws/ws_bootstrap.h

@@ -37,6 +37,8 @@ void ws_bootstrap_state_machine(protocol_interface_info_entry_t *cur);
 
 int ws_bootstrap_restart(int8_t interface_id);
 
+int ws_bootstrap_neighbor_remove(protocol_interface_info_entry_t *cur, const uint8_t *ll_address);
+
 /*State machine transactions*/
 void ws_bootstrap_event_discovery_start(protocol_interface_info_entry_t *cur);
 
@@ -71,6 +73,7 @@ void ws_dhcp_client_address_delete(protocol_interface_info_entry_t *cur, uint8_t
 #define ws_bootstrap_init(interface_id, bootstrap_mode) (-1)
 #define ws_bootstrap_state_machine(cur)
 #define ws_bootstrap_restart(cur)
+#define ws_bootstrap_neighbor_remove(cur, ll_address)
 #define ws_primary_parent_update(interface, neighbor)
 #define ws_secondary_parent_update(interface)
 

source/6LoWPAN/ws/ws_common.c

@@ -29,6 +29,7 @@
 #include "6LoWPAN/ws/ws_bootstrap.h"
 #include "6LoWPAN/ws/ws_bbr_api_internal.h"
 #include "Service_Libs/mac_neighbor_table/mac_neighbor_table.h"
+#include "Service_Libs/blacklist/blacklist.h"
 #include "ws_management_api.h"
 #include "mac_api.h"
 
@@ -62,7 +63,7 @@ static const trickle_params_t trickle_params_pan_discovery_small = {
                                  .TimerExpirations = TRICKLE_EXPIRATIONS_INFINITE
 };
 
-
+uint16_t test_max_child_count_override = 0xffff;
 
 
 int8_t ws_generate_channel_list(uint32_t *channel_mask, uint16_t number_of_channels, uint8_t regulatory_domain)
@@ -244,6 +245,7 @@ void ws_common_seconds_timer(protocol_interface_info_entry_t *cur, uint32_t seco
 {
     ws_bbr_seconds_timer(cur, seconds);
     ws_bootstrap_seconds_timer(cur, seconds);
+    blacklist_ttl_update(seconds);
 }
 
 void ws_common_fast_timer(protocol_interface_info_entry_t *cur, uint16_t ticks)
@@ -262,20 +264,33 @@ void ws_common_neighbor_update(protocol_interface_info_entry_t *cur, const uint8
     }
 }
 
+void ws_common_aro_failure(protocol_interface_info_entry_t *cur, const uint8_t *ll_address)
+{
+    //Neighbor connectected update
+    ws_bootstrap_neighbor_remove(cur, ll_address);
+}
+
 bool ws_common_allow_child_registration(protocol_interface_info_entry_t *interface)
 {
     uint8_t child_count = 0;
+    uint8_t max_child_count = mac_neighbor_info(interface)->list_total_size - WS_NON_CHILD_NEIGHBOUR_COUNT;
+
+    // Test API to limit child count
+    if (test_max_child_count_override != 0xffff) {
+        max_child_count = test_max_child_count_override;
+    }
+
     ns_list_foreach_safe(mac_neighbor_table_entry_t, cur, &mac_neighbor_info(interface)->neighbour_list) {
 
         if (ipv6_neighbour_has_registered_by_eui64(&interface->ipv6_neighbour_cache, cur->mac64)) {
             child_count++;
-            if (child_count > (mac_neighbor_info(interface)->list_total_size - WS_NON_CHILD_NEIGHBOUR_COUNT)) {
-                tr_warn("Child registration not allowed %d/%d, max:%d", child_count, (mac_neighbor_info(interface)->list_total_size - WS_NON_CHILD_NEIGHBOUR_COUNT), mac_neighbor_info(interface)->list_total_size);
-                return false;
-            }
         }
     }
-    tr_info("Child registration allowed %d/%d, max:%d", child_count, (mac_neighbor_info(interface)->list_total_size - WS_NON_CHILD_NEIGHBOUR_COUNT), mac_neighbor_info(interface)->list_total_size);
+    if (child_count >= max_child_count) {
+        tr_warn("Child registration not allowed %d/%d, max:%d", child_count, max_child_count, mac_neighbor_info(interface)->list_total_size);
+        return false;
+    }
+    tr_info("Child registration allowed %d/%d, max:%d", child_count, max_child_count, mac_neighbor_info(interface)->list_total_size);
     return true;
 }
 

source/6LoWPAN/ws/ws_common.h

@@ -28,6 +28,9 @@
 #include "6LoWPAN/ws/ws_neighbor_class.h"
 #include "Service_Libs/mac_neighbor_table/mac_neighbor_table.h"
 
+
+extern uint16_t test_max_child_count_override;
+
 struct ws_pan_information_s;
 struct ws_neighbor_class_s;
 
@@ -110,13 +113,16 @@ void ws_common_fast_timer(protocol_interface_info_entry_t *cur, uint16_t ticks);
 
 void ws_common_neighbor_update(protocol_interface_info_entry_t *cur, const uint8_t *ll_address);
 
+void ws_common_aro_failure(protocol_interface_info_entry_t *cur, const uint8_t *ll_address);
+
 bool ws_common_allow_child_registration(protocol_interface_info_entry_t *cur);
 
 #define ws_info(cur) ((cur)->ws_info)
 #else
 #define ws_info(cur) ((ws_info_t *) NULL)
 #define ws_common_seconds_timer(cur, seconds)
 #define ws_common_neighbor_update(cur, ll_address) ((void) 0)
+#define ws_common_aro_failure(cur, ll_address)
 #define ws_common_fast_timer(cur, ticks) ((void) 0)
 #define ws_common_allow_child_registration(cur) (false)
 

source/6LoWPAN/ws/ws_config.h

@@ -110,4 +110,15 @@ extern int8_t DEVICE_MIN_SENS;
 #define WS_TEMPORARY_NEIGHBOUR_ENTRIES 7
 #define WS_NON_CHILD_NEIGHBOUR_COUNT (WS_RPL_CANDIDATE_PARENT_COUNT + WS_TEMPORARY_NEIGHBOUR_ENTRIES)
 
+/*
+ * Neighbour blacklist timers
+ */
+#define WS_BLACKLIST_ENTRY_LIFETIME      60*30 // initial value for reject
+#define WS_BLACKLIST_TIMER_MAX_TIMEOUT   60*60 // Can increase to this
+#define WS_BLACKLIST_TIMER_TIMEOUT       60*30 // Blacklist is valid this time after first accept
+#define WS_BLACKLIST_ENTRY_MAX_NBR       10
+#define WS_BLACKLIST_PURGE_NBR            3
+#define WS_BLACKLIST_PURGE_TIMER_TIMEOUT 60
+
+
 #endif /* WS_CONFIG_H_ */

source/6LoWPAN/ws/ws_test_api.c

@@ -23,6 +23,7 @@
 #include <net_ws_test.h>
 #include "NWK_INTERFACE/Include/protocol.h"
 #include "6LoWPAN/ws/ws_config.h"
+#include "6LoWPAN/ws/ws_common.h"
 #include "6LoWPAN/ws/ws_bbr_api_internal.h"
 #include "randLIB.h"
 
@@ -41,4 +42,12 @@ int ws_test_pan_size_set(int8_t interface_id, uint16_t pan_size)
     return 0;
 }
 
+int ws_test_max_child_count_set(int8_t interface_id, uint16_t child_count)
+{
+
+    (void) interface_id;
+    test_max_child_count_override = child_count;
+    return 0;
+}
+
 #endif // HAVE_WS

source/Common_Protocols/icmpv6.c

@@ -340,6 +340,25 @@ static buffer_t *icmpv6_echo_request_handler(buffer_t *buf)
 }
 
 #ifdef HAVE_IPV6_ND
+
+static void icmpv6_na_wisun_aro_handler(protocol_interface_info_entry_t *cur_interface, const uint8_t *dptr, const uint8_t *src_addr)
+{
+    dptr += 2;
+    uint16_t life_time;
+    uint8_t nd_status  = *dptr;
+    dptr += 4;
+    life_time = common_read_16_bit(dptr);
+    dptr += 2;
+    if (memcmp(dptr, cur_interface->mac, 8) != 0) {
+        return;
+    }
+
+    (void)life_time;
+    if (nd_status != ARO_SUCCESS) {
+        ws_common_aro_failure(cur_interface, src_addr);
+    }
+}
+
 static void icmpv6_na_aro_handler(protocol_interface_info_entry_t *cur_interface, const uint8_t *dptr, const uint8_t *dst_addr)
 {
     (void)dst_addr;
@@ -985,11 +1004,14 @@ static buffer_t *icmpv6_na_handler(buffer_t *buf)
         goto drop;
     }
 
-    if (cur->ipv6_neighbour_cache.recv_na_aro) {
-        const uint8_t *aro = icmpv6_find_option_in_buffer(buf, 20, ICMPV6_OPT_ADDR_REGISTRATION, 2);
-        if (aro) {
+    const uint8_t *aro = icmpv6_find_option_in_buffer(buf, 20, ICMPV6_OPT_ADDR_REGISTRATION, 2);
+    if (aro) {
+        if (cur->ipv6_neighbour_cache.recv_na_aro) {
             icmpv6_na_aro_handler(cur, aro, buf->dst_sa.address);
         }
+        if (ws_info(cur)) {
+            icmpv6_na_wisun_aro_handler(cur, aro, buf->src_sa.address);
+        }
     }
 
     /* No need to create a neighbour cache entry if one doesn't already exist */

test/nanostack/unittest/stub/ws_bootstrap_stub.c

@@ -40,6 +40,11 @@ int ws_bootstrap_restart(int8_t interface_id)
     return 0;
 }
 
+int ws_bootstrap_neighbor_remove(protocol_interface_info_entry_t *cur, const uint8_t *ll_address)
+{
+    return 0;
+}
+
 void ws_bootstrap_state_machine(protocol_interface_info_entry_t *cur)
 {
     (void) cur;

test/nanostack/unittest/stub/ws_common_stub.c

@@ -67,4 +67,9 @@ bool ws_common_allow_child_registration(protocol_interface_info_entry_t *interfa
     (void) interface;
     return true;
 }
+void ws_common_aro_failure(protocol_interface_info_entry_t *cur, const uint8_t *ll_address)
+{
+    (void) cur;
+    (void) ll_address;
 
+}