wifi: Add PMK caching feature for station WPA2-enterprise

4. Pmksa cache expiry after dot11RSNAConfigPMKLifetime timeout.

components/wpa_supplicant/src/esp_supplicant/esp_wpa2.c

@@ -697,16 +697,9 @@ static int wpa2_start_eapol_internal(void)
         return ESP_FAIL;
     }
     if (wpa_sta_is_cur_pmksa_set()) {
-        if (0) {
-            wpa_printf(MSG_DEBUG,
-                    "RSN: Timeout on waiting for the AP to initiate 4-way handshake \
-                    for PMKSA caching or EAP authentication \
-                    - try to force it to start EAP authentication");
-        } else {
         wpa_printf(MSG_DEBUG,
                 "RSN: PMKSA caching - do not send EAPOL-Start");
-            return -1;
-        }
+        return ESP_FAIL;
     }
 
     ret = esp_wifi_get_assoc_bssid_internal(bssid);

components/wpa_supplicant/src/esp_supplicant/esp_wpa_main.c

@@ -109,14 +109,8 @@ void  wpa_neg_complete(void)
 bool  wpa_attach(void)
 {
     bool ret = true; 
-#ifndef IOT_SIP_MODE
     ret = wpa_sm_init(NULL, wpa_sendto_wrapper,
                  wpa_config_assoc_ie, wpa_install_key, wpa_get_key, wpa_deauthenticate, wpa_neg_complete);
-#else
-    u8 *payload = (u8 *)os_malloc(WPA_TX_MSG_BUFF_MAXLEN);
-    ret = wpa_sm_init(payload, wpa_sendto_wrapper,
-                 wpa_config_assoc_ie, wpa_install_key, wpa_get_key, wpa_deauthenticate, wpa_neg_complete);
-#endif
     if(ret) {   
         ret = (esp_wifi_register_tx_cb_internal(eapol_txcb, WIFI_TXCB_EAPOL_ID) == ESP_OK);
     }

components/wpa_supplicant/src/rsn_supp/pmksa_cache.c

@@ -13,15 +13,19 @@
 #include "common/eapol_common.h"
 #include "common/ieee802_11_defs.h"
 #include "pmksa_cache.h"
+#include "esp_timer.h"
 
 #ifdef IEEE8021X_EAPOL
 
 static const int pmksa_cache_max_entries = 10;
+static const int dot11RSNAConfigPMKLifetime = 43200;
+static const int dot11RSNAConfigPMKReauthThreshold = 70;
 
 struct rsn_pmksa_cache {
     struct rsn_pmksa_cache_entry *pmksa; /* PMKSA cache */
     int pmksa_count; /* number of entries in PMKSA cache */
     struct wpa_sm *sm; /* TODO: get rid of this reference(?) */
+    esp_timer_handle_t cache_timeout_timer;
 
     void (*free_cb)(struct rsn_pmksa_cache_entry *entry, void *ctx,
             enum pmksa_free_reason reason);
@@ -29,12 +33,12 @@ struct rsn_pmksa_cache {
 };
 
 
-//static void pmksa_cache_set_expiration(struct rsn_pmksa_cache *pmksa);
+static void pmksa_cache_set_expiration(struct rsn_pmksa_cache *pmksa);
 
 
 static void _pmksa_cache_free_entry(struct rsn_pmksa_cache_entry *entry)
 {
-	bin_clear_free(entry, sizeof(*entry));
+    wpa_bin_clear_free(entry, sizeof(*entry));
 }
 
 
@@ -42,20 +46,18 @@ static void pmksa_cache_free_entry(struct rsn_pmksa_cache *pmksa,
         struct rsn_pmksa_cache_entry *entry,
         enum pmksa_free_reason reason)
 {
-	//wpa_sm_remove_pmkid(pmksa->sm, entry->aa, entry->pmkid);
     pmksa->pmksa_count--;
     pmksa->free_cb(entry, pmksa->ctx, reason);
     _pmksa_cache_free_entry(entry);
 }
 
-#if 0
-static void pmksa_cache_expire(void *eloop_ctx, void *timeout_ctx)
+
+static void pmksa_cache_expire(void *eloop_ctx)
 {
     struct rsn_pmksa_cache *pmksa = eloop_ctx;
-	struct os_reltime now;
+    int64_t now_sec = esp_timer_get_time() / 1e6;
 
-	os_get_reltime(&now);
-	while (pmksa->pmksa && pmksa->pmksa->expiration <= now.sec) {
+    while (pmksa->pmksa && pmksa->pmksa->expiration <= now_sec) {
         struct rsn_pmksa_cache_entry *entry = pmksa->pmksa;
         pmksa->pmksa = entry->next;
         wpa_printf(MSG_DEBUG, "RSN: expired PMKSA cache entry for "
@@ -66,39 +68,20 @@ static void pmksa_cache_expire(void *eloop_ctx, void *timeout_ctx)
     pmksa_cache_set_expiration(pmksa);
 }
 
-static void pmksa_cache_reauth(void *eloop_ctx, void *timeout_ctx)
-{
-	struct rsn_pmksa_cache *pmksa = eloop_ctx;
-	pmksa->sm->cur_pmksa = NULL;
-	eapol_sm_request_reauth(pmksa->sm->eapol);
-}
-
 static void pmksa_cache_set_expiration(struct rsn_pmksa_cache *pmksa)
 {
     int sec;
-	struct rsn_pmksa_cache_entry *entry;
-	struct os_reltime now;
+    int64_t now_sec = esp_timer_get_time() / 1e6;
 
-	eloop_cancel_timeout(pmksa_cache_reauth, pmksa, NULL);
+    esp_timer_stop(pmksa->cache_timeout_timer);
     if (pmksa->pmksa == NULL)
         return;
-	os_get_reltime(&now);
-	sec = pmksa->pmksa->expiration - now.sec;
+    sec = pmksa->pmksa->expiration - now_sec;
     if (sec < 0)
         sec = 0;
-	eloop_register_timeout(sec + 1, 0, pmksa_cache_expire, pmksa, NULL);
 
-	entry = pmksa->sm->cur_pmksa ? pmksa->sm->cur_pmksa :
-		pmksa_cache_get(pmksa, pmksa->sm->bssid, NULL, NULL);
-	if (entry) {
-		sec = pmksa->pmksa->reauth_time - now.sec;
-		if (sec < 0)
-			sec = 0;
-		eloop_register_timeout(sec, 0, pmksa_cache_reauth, pmksa,
-				       NULL);
-	}
+    esp_timer_start_once(pmksa->cache_timeout_timer, (sec + 1) * 1e6);
 }
-#endif
 
 /**
  * pmksa_cache_add - Add a PMKSA cache entry
@@ -124,7 +107,7 @@ pmksa_cache_add(struct rsn_pmksa_cache *pmksa, const u8 *pmk, size_t pmk_len,
         const u8 *aa, const u8 *spa, void *network_ctx, int akmp)
 {
     struct rsn_pmksa_cache_entry *entry, *pos, *prev;
-	//struct os_reltime now;
+    int64_t now_sec = esp_timer_get_time() / 1e6;
 
     if (pmk_len > PMK_LEN)
         return NULL;
@@ -139,10 +122,9 @@ pmksa_cache_add(struct rsn_pmksa_cache *pmksa, const u8 *pmk, size_t pmk_len,
     entry->pmk_len = pmk_len;
     rsn_pmkid(pmk, pmk_len, aa, spa, entry->pmkid,
             wpa_key_mgmt_sha256(akmp));
-	//os_get_reltime(&now);
-	//entry->expiration = now.sec + pmksa->sm->dot11RSNAConfigPMKLifetime;
-	/*entry->reauth_time = now.sec + pmksa->sm->dot11RSNAConfigPMKLifetime *
-		pmksa->sm->dot11RSNAConfigPMKReauthThreshold / 100;*/
+    entry->expiration = now_sec + dot11RSNAConfigPMKLifetime;
+    entry->reauth_time = now_sec + dot11RSNAConfigPMKLifetime *
+        dot11RSNAConfigPMKReauthThreshold / 100;
     entry->akmp = akmp;
     os_memcpy(entry->aa, aa, ETH_ALEN);
     entry->network_ctx = network_ctx;
@@ -225,7 +207,7 @@ pmksa_cache_add(struct rsn_pmksa_cache *pmksa, const u8 *pmk, size_t pmk_len,
     if (prev == NULL) {
         entry->next = pmksa->pmksa;
         pmksa->pmksa = entry;
-		//pmksa_cache_set_expiration(pmksa);
+        pmksa_cache_set_expiration(pmksa);
     } else {
         entry->next = prev->next;
         prev->next = entry;
@@ -233,7 +215,6 @@ pmksa_cache_add(struct rsn_pmksa_cache *pmksa, const u8 *pmk, size_t pmk_len,
     pmksa->pmksa_count++;
     wpa_printf(MSG_DEBUG, "RSN: Added PMKSA cache entry for " MACSTR
             " network_ctx=%p", MAC2STR(entry->aa), network_ctx);
-	//wpa_sm_add_pmkid(pmksa->sm, entry->aa, entry->pmkid);
 
     return entry;
 }
@@ -297,8 +278,9 @@ void pmksa_cache_deinit(struct rsn_pmksa_cache *pmksa)
         entry = entry->next;
         os_free(prev);
     }
-	//pmksa_cache_set_expiration(pmksa);
+    pmksa_cache_set_expiration(pmksa);
     os_free(pmksa);
+    esp_timer_stop(pmksa->cache_timeout_timer);
 }
 
 
@@ -469,9 +451,7 @@ int pmksa_cache_list(struct rsn_pmksa_cache *pmksa, char *buf, size_t len)
     int i, ret;
     char *pos = buf;
     struct rsn_pmksa_cache_entry *entry;
-	//struct os_reltime now;
-
-	//os_get_reltime(&now);
+    int64_t now_sec = esp_timer_get_time() / 1e6;
     ret = os_snprintf(pos, buf + len - pos,
             "Index / AA / PMKID / expiration (in seconds) / "
             "opportunistic\n");
@@ -490,7 +470,7 @@ int pmksa_cache_list(struct rsn_pmksa_cache *pmksa, char *buf, size_t len)
         pos += wpa_snprintf_hex(pos, buf + len - pos, entry->pmkid,
                 PMKID_LEN);
         ret = os_snprintf(pos, buf + len - pos, " %d %d\n",
-				  (int) (entry->expiration),// - now.sec),
+                (int) (entry->expiration - now_sec),
                 entry->opportunistic);
         if (os_snprintf_error(buf + len - pos, ret))
             return pos - buf;
@@ -520,6 +500,16 @@ pmksa_cache_init(void (*free_cb)(struct rsn_pmksa_cache_entry *entry,
         pmksa->free_cb = free_cb;
         pmksa->ctx = ctx;
         pmksa->sm = sm;
+        pmksa->pmksa_count = 0;
+        pmksa->pmksa = NULL;
+
+        esp_timer_create_args_t pmksa_cache_timeout_timer_create = {
+            .callback = &pmksa_cache_expire,
+            .arg = pmksa,
+            .dispatch_method = ESP_TIMER_TASK,
+            .name = "pmksa_timeout_timer"
+        };
+        esp_timer_create(&pmksa_cache_timeout_timer_create, &(pmksa->cache_timeout_timer));
     }
 
     return pmksa;

components/wpa_supplicant/src/rsn_supp/pmksa_cache.h

@@ -72,7 +72,7 @@ void pmksa_cache_flush(struct rsn_pmksa_cache *pmksa, void *network_ctx,
 
 #else /* IEEE8021X_EAPOL */
 
-static inline struct rsn_pmksa_cache *
+    static inline struct rsn_pmksa_cache *
 pmksa_cache_init(void (*free_cb)(struct rsn_pmksa_cache_entry *entry,
             void *ctx, enum pmksa_free_reason reason),
         void *ctx, struct wpa_sm *sm)
@@ -84,14 +84,14 @@ static inline void pmksa_cache_deinit(struct rsn_pmksa_cache *pmksa)
 {
 }
 
-static inline struct rsn_pmksa_cache_entry *
+    static inline struct rsn_pmksa_cache_entry *
 pmksa_cache_get(struct rsn_pmksa_cache *pmksa, const u8 *aa, const u8 *pmkid,
         const void *network_ctx)
 {
     return NULL;
 }
 
-static inline struct rsn_pmksa_cache_entry *
+    static inline struct rsn_pmksa_cache_entry *
 pmksa_cache_get_current(struct wpa_sm *sm)
 {
     return NULL;
@@ -103,7 +103,7 @@ static inline int pmksa_cache_list(struct rsn_pmksa_cache *pmksa, char *buf,
     return -1;
 }
 
-static inline struct rsn_pmksa_cache_entry *
+    static inline struct rsn_pmksa_cache_entry *
 pmksa_cache_add(struct rsn_pmksa_cache *pmksa, const u8 *pmk, size_t pmk_len,
         const u8 *kck, size_t kck_len,
         const u8 *aa, const u8 *spa, void *network_ctx, int akmp)

components/wpa_supplicant/src/rsn_supp/wpa.c

@@ -528,6 +528,8 @@ void   wpa_supplicant_process_1_of_4(struct wpa_sm *sm,
     if (res)
         goto failed;
 
+    pmksa_cache_set_current(sm, NULL, sm->bssid, 0, 0);
+
     if (sm->renew_snonce) {
         if (os_get_random(sm->snonce, WPA_NONCE_LEN)) {
          #ifdef DEBUG_PRINT            

components/wpa_supplicant/src/utils/common.c

@@ -286,7 +286,7 @@ char * wpa_config_parse_string(const char *value, size_t *len)
 }
 
 
-int is_hex(const u8 *data, size_t len)
+int wpa_is_hex(const u8 *data, size_t len)
 {
 	size_t i;
 
@@ -298,7 +298,7 @@ int is_hex(const u8 *data, size_t len)
 }
 
 
-size_t merge_byte_arrays(u8 *res, size_t res_len,
+size_t wpa_merge_byte_arrays(u8 *res, size_t res_len,
 			 const u8 *src1, size_t src1_len,
 			 const u8 *src2, size_t src2_len)
 {
@@ -344,7 +344,7 @@ char * dup_binstr(const void *src, size_t len)
 
 	return res;
 }
-void bin_clear_free(void *bin, size_t len)
+void wpa_bin_clear_free(void *bin, size_t len)
 {
 	if (bin) {
 		os_memset(bin, 0, len);

components/wpa_supplicant/src/utils/common.h

@@ -396,8 +396,8 @@ size_t printf_decode(u8 *buf, size_t maxlen, const char *str);
 const char * wpa_ssid_txt(const u8 *ssid, size_t ssid_len);
 
 char * wpa_config_parse_string(const char *value, size_t *len);
-int is_hex(const u8 *data, size_t len);
-size_t merge_byte_arrays(u8 *res, size_t res_len,
+int wpa_is_hex(const u8 *data, size_t len);
+size_t wpa_merge_byte_arrays(u8 *res, size_t res_len,
 			 const u8 *src1, size_t src1_len,
 			 const u8 *src2, size_t src2_len);
 char * dup_binstr(const void *src, size_t len);
@@ -420,7 +420,7 @@ static inline int is_multicast_ether_addr(const u8 *a)
 #define broadcast_ether_addr (const u8 *) "\xff\xff\xff\xff\xff\xff"
 
 
-#include "wpa_debug.h"
+#include "utils/wpa_debug.h"
 
 
 struct wpa_freq_range_list {
@@ -431,32 +431,9 @@ struct wpa_freq_range_list {
 	unsigned int num;
 };
 
-int freq_range_list_parse(struct wpa_freq_range_list *res, const char *value);
-int freq_range_list_includes(const struct wpa_freq_range_list *list,
-			     unsigned int freq);
-char * freq_range_list_str(const struct wpa_freq_range_list *list);
-
-int int_array_len(const int *a);
-void int_array_concat(int **res, const int *a);
-void int_array_sort_unique(int *a);
-void int_array_add_unique(int **res, int a);
-
 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
 
-void str_clear_free(char *str);
-void bin_clear_free(void *bin, size_t len);
-
-int random_mac_addr(u8 *addr);
-int random_mac_addr_keep_oui(u8 *addr);
-
-const char * cstr_token(const char *str, const char *delim, const char **last);
-char * str_token(char *str, const char *delim, char **context);
-size_t utf8_escape(const char *inp, size_t in_size,
-		   char *outp, size_t out_size);
-size_t utf8_unescape(const char *inp, size_t in_size,
-		     char *outp, size_t out_size);
-int is_ctrl_char(char c);
-
+void wpa_bin_clear_free(void *bin, size_t len);
 
 /*
  * gcc 4.4 ends up generating strict-aliasing warnings about some very common