Skip to content

Commit 3b47c48

Browse files
mrengineer7777mrengineer7777
committed
CrashFix WiFiGeneric
Fixes crash in WiFiGeneric due to bad index into system_event_reasons[]. Also replaced arduino_event_names[] to prevent a potential crash.
1 parent af47658 commit 3b47c48

File tree

2 files changed

+127
-23
lines changed

2 files changed

+127
-23
lines changed

‎libraries/WiFi/src/WiFiGeneric.cpp

Lines changed: 124 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -906,33 +906,15 @@ void WiFiGenericClass::removeEvent(wifi_event_id_t id)
906906
* callback for WiFi events
907907
* @param arg
908908
*/
909-
#if ARDUHAL_LOG_LEVEL >= ARDUHAL_LOG_LEVEL_DEBUG
910-
const char * arduino_event_names[] = {
911-
"WIFI_READY",
912-
"SCAN_DONE",
913-
"STA_START", "STA_STOP", "STA_CONNECTED", "STA_DISCONNECTED", "STA_AUTHMODE_CHANGE", "STA_GOT_IP", "STA_GOT_IP6", "STA_LOST_IP",
914-
"AP_START", "AP_STOP", "AP_STACONNECTED", "AP_STADISCONNECTED", "AP_STAIPASSIGNED", "AP_PROBEREQRECVED", "AP_GOT_IP6",
915-
"FTM_REPORT",
916-
"ETH_START", "ETH_STOP", "ETH_CONNECTED", "ETH_DISCONNECTED", "ETH_GOT_IP", "ETH_GOT_IP6",
917-
"WPS_ER_SUCCESS", "WPS_ER_FAILED", "WPS_ER_TIMEOUT", "WPS_ER_PIN", "WPS_ER_PBC_OVERLAP",
918-
"SC_SCAN_DONE", "SC_FOUND_CHANNEL", "SC_GOT_SSID_PSWD", "SC_SEND_ACK_DONE",
919-
"PROV_INIT", "PROV_DEINIT", "PROV_START", "PROV_END", "PROV_CRED_RECV", "PROV_CRED_FAIL", "PROV_CRED_SUCCESS"
920-
};
921-
#endif
922-
#if ARDUHAL_LOG_LEVEL >= ARDUHAL_LOG_LEVEL_WARN
923-
const char * system_event_reasons[] = { "UNSPECIFIED", "AUTH_EXPIRE", "AUTH_LEAVE", "ASSOC_EXPIRE", "ASSOC_TOOMANY", "NOT_AUTHED", "NOT_ASSOCED", "ASSOC_LEAVE", "ASSOC_NOT_AUTHED", "DISASSOC_PWRCAP_BAD", "DISASSOC_SUPCHAN_BAD", "UNSPECIFIED", "IE_INVALID", "MIC_FAILURE", "4WAY_HANDSHAKE_TIMEOUT", "GROUP_KEY_UPDATE_TIMEOUT", "IE_IN_4WAY_DIFFERS", "GROUP_CIPHER_INVALID", "PAIRWISE_CIPHER_INVALID", "AKMP_INVALID", "UNSUPP_RSN_IE_VERSION", "INVALID_RSN_IE_CAP", "802_1X_AUTH_FAILED", "CIPHER_SUITE_REJECTED", "BEACON_TIMEOUT", "NO_AP_FOUND", "AUTH_FAIL", "ASSOC_FAIL", "HANDSHAKE_TIMEOUT", "CONNECTION_FAIL" };
924-
#define reason2str(r) ((r>176)?system_event_reasons[r-176]:system_event_reasons[r-1])
925-
#endif
926909
esp_err_t WiFiGenericClass::_eventCallback(arduino_event_t *event)
927910
{
928911
static bool first_connect = true;
929912

930-
if(event->event_id < ARDUINO_EVENT_MAX) {
931-
log_d("Arduino Event: %d - %s", event->event_id, arduino_event_names[event->event_id]);
932-
}
913+
if(!event) return ESP_OK; //Null would crash this function
914+
915+
log_d("Arduino Event: %d - %s", event->event_id, ArduinoEventIdToCStr(event->event_id));
933916
if(event->event_id == ARDUINO_EVENT_WIFI_SCAN_DONE) {
934917
WiFiScanClass::_scanDone();
935-
936918
} else if(event->event_id == ARDUINO_EVENT_WIFI_STA_START) {
937919
WiFiSTAClass::_setStatus(WL_DISCONNECTED);
938920
setStatusBits(STA_STARTED_BIT);
@@ -945,14 +927,13 @@ esp_err_t WiFiGenericClass::_eventCallback(arduino_event_t *event)
945927
} else if(event->event_id == ARDUINO_EVENT_WIFI_STA_CONNECTED) {
946928
WiFiSTAClass::_setStatus(WL_IDLE_STATUS);
947929
setStatusBits(STA_CONNECTED_BIT);
948-
949930
//esp_netif_create_ip6_linklocal(esp_netifs[ESP_IF_WIFI_STA]);
950931
} else if(event->event_id == ARDUINO_EVENT_WIFI_STA_DISCONNECTED) {
951932
uint8_t reason = event->event_info.wifi_sta_disconnected.reason;
952933
// Reason 0 causes crash, use reason 1 (UNSPECIFIED) instead
953934
if(!reason)
954935
reason = WIFI_REASON_UNSPECIFIED;
955-
log_w("Reason: %u - %s", reason, reason2str(reason));
936+
log_w("Reason: %u - %s", reason, WiFiErrReasonToCStr((wifi_err_reason_t)reason));
956937
if(reason == WIFI_REASON_NO_AP_FOUND) {
957938
WiFiSTAClass::_setStatus(WL_NO_SSID_AVAIL);
958939
} else if((reason == WIFI_REASON_AUTH_FAIL) && !first_connect){
@@ -1431,6 +1412,126 @@ bool WiFiGenericClass::setDualAntennaConfig(uint8_t gpio_ant1, uint8_t gpio_ant2
14311412
return true;
14321413
}
14331414

1415+
/**
1416+
* @brief Convert arduino_event_id_t to a string.
1417+
* @param [in] id The event id to be converted.
1418+
* @return A string representation of the event id.
1419+
* @note: arduino_event_id_t values as of Mar 2023 (arduino-esp32 r2.0.7) are: 0-39 (ARDUINO_EVENT_MAX=40) and are defined in WiFiGeneric.h.
1420+
*/
1421+
const char WiFiGenericClass::ArduinoEventIdToCStr(arduino_event_id_t id) {
1422+
switch(id) {
1423+
case ARDUINO_EVENT_WIFI_READY: return "WIFI_READY";
1424+
case ARDUINO_EVENT_WIFI_SCAN_DONE: return "SCAN_DONE";
1425+
case ARDUINO_EVENT_WIFI_STA_START: return "STA_START";
1426+
case ARDUINO_EVENT_WIFI_STA_STOP: return "STA_STOP";
1427+
case ARDUINO_EVENT_WIFI_STA_CONNECTED: return "STA_CONNECTED";
1428+
case ARDUINO_EVENT_WIFI_STA_DISCONNECTED: return "STA_DISCONNECTED";
1429+
case ARDUINO_EVENT_WIFI_STA_AUTHMODE_CHANGE: return "STA_AUTHMODE_CHANGE";
1430+
case ARDUINO_EVENT_WIFI_STA_GOT_IP: return "STA_GOT_IP";
1431+
case ARDUINO_EVENT_WIFI_STA_GOT_IP6: return "STA_GOT_IP6";
1432+
case ARDUINO_EVENT_WIFI_STA_LOST_IP: return "STA_LOST_IP";
1433+
case ARDUINO_EVENT_WIFI_AP_START: return "AP_START";
1434+
case ARDUINO_EVENT_WIFI_AP_STOP: return "AP_STOP";
1435+
case ARDUINO_EVENT_WIFI_AP_STACONNECTED: return "AP_STACONNECTED";
1436+
case ARDUINO_EVENT_WIFI_AP_STADISCONNECTED: return "AP_STADISCONNECTED";
1437+
case ARDUINO_EVENT_WIFI_AP_STAIPASSIGNED: return "AP_STAIPASSIGNED";
1438+
case ARDUINO_EVENT_WIFI_AP_PROBEREQRECVED: return "AP_PROBEREQRECVED";
1439+
case ARDUINO_EVENT_WIFI_AP_GOT_IP6: return "AP_GOT_IP6";
1440+
case ARDUINO_EVENT_WIFI_FTM_REPORT: return "FTM_REPORT";
1441+
case ARDUINO_EVENT_ETH_START: return "ETH_START";
1442+
case ARDUINO_EVENT_ETH_STOP: return "ETH_STOP";
1443+
case ARDUINO_EVENT_ETH_CONNECTED: return "ETH_CONNECTED";
1444+
case ARDUINO_EVENT_ETH_DISCONNECTED: return "ETH_DISCONNECTED";
1445+
case ARDUINO_EVENT_ETH_GOT_IP: return "ETH_GOT_IP";
1446+
case ARDUINO_EVENT_ETH_GOT_IP6: return "ETH_GOT_IP6";
1447+
case ARDUINO_EVENT_WPS_ER_SUCCESS: return "WPS_ER_SUCCESS";
1448+
case ARDUINO_EVENT_WPS_ER_FAILED: return "WPS_ER_FAILED";
1449+
case ARDUINO_EVENT_WPS_ER_TIMEOUT: return "WPS_ER_TIMEOUT";
1450+
case ARDUINO_EVENT_WPS_ER_PIN: return "WPS_ER_PIN";
1451+
case ARDUINO_EVENT_WPS_ER_PBC_OVERLAP: return "WPS_ER_PBC_OVERLAP";
1452+
case ARDUINO_EVENT_SC_SCAN_DONE: return "SC_SCAN_DONE";
1453+
case ARDUINO_EVENT_SC_FOUND_CHANNEL: return "SC_FOUND_CHANNEL";
1454+
case ARDUINO_EVENT_SC_GOT_SSID_PSWD: return "SC_GOT_SSID_PSWD";
1455+
case ARDUINO_EVENT_SC_SEND_ACK_DONE: return "SC_SEND_ACK_DONE";
1456+
case ARDUINO_EVENT_PROV_INIT: return "PROV_INIT";
1457+
case ARDUINO_EVENT_PROV_DEINIT: return "PROV_DEINIT";
1458+
case ARDUINO_EVENT_PROV_START: return "PROV_START";
1459+
case ARDUINO_EVENT_PROV_END: return "PROV_END";
1460+
case ARDUINO_EVENT_PROV_CRED_RECV: return "PROV_CRED_RECV";
1461+
case ARDUINO_EVENT_PROV_CRED_FAIL: return "PROV_CRED_FAIL";
1462+
case ARDUINO_EVENT_PROV_CRED_SUCCESS: return "PROV_CRED_SUCCESS";
1463+
default: return "";
1464+
}
1465+
}
1466+
1467+
/**
1468+
* @brief Convert wifi_err_reason_t to a string.
1469+
* @param [in] reason The reason to be converted.
1470+
* @return A string representation of the error code.
1471+
* @note: wifi_err_reason_t values as of Mar 2023 (arduino-esp32 r2.0.7) are: (1-39, 46-51, 67-68, 200-208) and are defined in /tools/sdk/esp32/include/esp_wifi/include/esp_wifi_types.h.
1472+
*/
1473+
const char * WiFiGenericClass::WiFiErrReasonToCStr(wifi_err_reason_t reason) {
1474+
switch(reason) {
1475+
case WIFI_REASON_UNSPECIFIED: return "UNSPECIFIED";
1476+
case WIFI_REASON_AUTH_EXPIRE: return "AUTH_EXPIRE";
1477+
case WIFI_REASON_AUTH_LEAVE: return "AUTH_LEAVE";
1478+
case WIFI_REASON_ASSOC_EXPIRE: return "ASSOC_EXPIRE";
1479+
case WIFI_REASON_ASSOC_TOOMANY: return "ASSOC_TOOMANY";
1480+
case WIFI_REASON_NOT_AUTHED: return "NOT_AUTHED";
1481+
case WIFI_REASON_NOT_ASSOCED: return "NOT_ASSOCED";
1482+
case WIFI_REASON_ASSOC_LEAVE: return "ASSOC_LEAVE";
1483+
case WIFI_REASON_ASSOC_NOT_AUTHED: return "ASSOC_NOT_AUTHED";
1484+
case WIFI_REASON_DISASSOC_PWRCAP_BAD: return "DISASSOC_PWRCAP_BAD";
1485+
case WIFI_REASON_DISASSOC_SUPCHAN_BAD: return "DISASSOC_SUPCHAN_BAD";
1486+
case WIFI_REASON_BSS_TRANSITION_DISASSOC: return "BSS_TRANSITION_DISASSOC";
1487+
case WIFI_REASON_IE_INVALID: return "IE_INVALID";
1488+
case WIFI_REASON_MIC_FAILURE: return "MIC_FAILURE";
1489+
case WIFI_REASON_4WAY_HANDSHAKE_TIMEOUT: return "4WAY_HANDSHAKE_TIMEOUT";
1490+
case WIFI_REASON_GROUP_KEY_UPDATE_TIMEOUT: return "GROUP_KEY_UPDATE_TIMEOUT";
1491+
case WIFI_REASON_IE_IN_4WAY_DIFFERS: return "IE_IN_4WAY_DIFFERS";
1492+
case WIFI_REASON_GROUP_CIPHER_INVALID: return "GROUP_CIPHER_INVALID";
1493+
case WIFI_REASON_PAIRWISE_CIPHER_INVALID: return "PAIRWISE_CIPHER_INVALID";
1494+
case WIFI_REASON_AKMP_INVALID: return "AKMP_INVALID";
1495+
case WIFI_REASON_UNSUPP_RSN_IE_VERSION: return "UNSUPP_RSN_IE_VERSION";
1496+
case WIFI_REASON_INVALID_RSN_IE_CAP: return "INVALID_RSN_IE_CAP";
1497+
case WIFI_REASON_802_1X_AUTH_FAILED: return "802_1X_AUTH_FAILED";
1498+
case WIFI_REASON_CIPHER_SUITE_REJECTED: return "CIPHER_SUITE_REJECTED";
1499+
case WIFI_REASON_TDLS_PEER_UNREACHABLE: return "TDLS_PEER_UNREACHABLE";
1500+
case WIFI_REASON_TDLS_UNSPECIFIED: return "TDLS_UNSPECIFIED";
1501+
case WIFI_REASON_SSP_REQUESTED_DISASSOC: return "SSP_REQUESTED_DISASSOC";
1502+
case WIFI_REASON_NO_SSP_ROAMING_AGREEMENT: return "NO_SSP_ROAMING_AGREEMENT";
1503+
case WIFI_REASON_BAD_CIPHER_OR_AKM: return "BAD_CIPHER_OR_AKM";
1504+
case WIFI_REASON_NOT_AUTHORIZED_THIS_LOCATION: return "NOT_AUTHORIZED_THIS_LOCATION";
1505+
case WIFI_REASON_SERVICE_CHANGE_PERCLUDES_TS: return "SERVICE_CHANGE_PERCLUDES_TS";
1506+
case WIFI_REASON_UNSPECIFIED_QOS: return "UNSPECIFIED_QOS";
1507+
case WIFI_REASON_NOT_ENOUGH_BANDWIDTH: return "NOT_ENOUGH_BANDWIDTH";
1508+
case WIFI_REASON_MISSING_ACKS: return "MISSING_ACKS";
1509+
case WIFI_REASON_EXCEEDED_TXOP: return "EXCEEDED_TXOP";
1510+
case WIFI_REASON_STA_LEAVING: return "STA_LEAVING";
1511+
case WIFI_REASON_END_BA: return "END_BA";
1512+
case WIFI_REASON_UNKNOWN_BA: return "UNKNOWN_BA";
1513+
case WIFI_REASON_TIMEOUT: return "TIMEOUT";
1514+
case WIFI_REASON_PEER_INITIATED: return "PEER_INITIATED";
1515+
case WIFI_REASON_AP_INITIATED: return "AP_INITIATED";
1516+
case WIFI_REASON_INVALID_FT_ACTION_FRAME_COUNT: return "INVALID_FT_ACTION_FRAME_COUNT";
1517+
case WIFI_REASON_INVALID_PMKID: return "INVALID_PMKID";
1518+
case WIFI_REASON_INVALID_MDE: return "INVALID_MDE";
1519+
case WIFI_REASON_INVALID_FTE: return "INVALID_FTE";
1520+
case WIFI_REASON_TRANSMISSION_LINK_ESTABLISH_FAILED: return "TRANSMISSION_LINK_ESTABLISH_FAILED";
1521+
case WIFI_REASON_ALTERATIVE_CHANNEL_OCCUPIED: return "ALTERATIVE_CHANNEL_OCCUPIED";
1522+
case WIFI_REASON_BEACON_TIMEOUT: return "BEACON_TIMEOUT";
1523+
case WIFI_REASON_NO_AP_FOUND: return "NO_AP_FOUND";
1524+
case WIFI_REASON_AUTH_FAIL: return "AUTH_FAIL";
1525+
case WIFI_REASON_ASSOC_FAIL: return "ASSOC_FAIL";
1526+
case WIFI_REASON_HANDSHAKE_TIMEOUT: return "HANDSHAKE_TIMEOUT";
1527+
case WIFI_REASON_CONNECTION_FAIL: return "CONNECTION_FAIL";
1528+
case WIFI_REASON_AP_TSF_RESET: return "AP_TSF_RESET";
1529+
case WIFI_REASON_ROAMING: return "ROAMING";
1530+
case WIFI_REASON_ASSOC_COMEBACK_TIME_TOO_LONG: return "ASSOC_COMEBACK_TIME_TOO_LONG";
1531+
default: return "";
1532+
}
1533+
}
1534+
14341535
// -----------------------------------------------------------------------------------------------------------------------
14351536
// ------------------------------------------------ Generic Network function ---------------------------------------------
14361537
// -----------------------------------------------------------------------------------------------------------------------

‎libraries/WiFi/src/WiFiGeneric.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,9 @@ class WiFiGenericClass
197197
static void useStaticBuffers(bool bufferMode);
198198
static bool useStaticBuffers();
199199

200+
const char * ArduinoEventIdToCStr(arduino_event_id_t id);
201+
const char * WifiReasonToCStr(wifi_err_reason_t reason);
202+
200203
protected:
201204
static bool _persistent;
202205
static bool _long_range;

0 commit comments

Comments
 (0)