Feature/wifi clear config #1761
Conversation
….0.0 SDK rules (no min length enforced, i.e. for WEP)
docs/en/modules/wifi.md
Outdated
| ## wifi.sta.clearconfig() | ||
|
|
||
| Clears the currently saved WiFi station configuration. This will erase the saved configuration from the flash (useful for | ||
| factory-reset scenarios, or to prepare for [End-User Setup](enduser-setup) so that the SoftAP can lock onto a single channel) |
There was a problem hiding this comment.
useful for factory-reset scenarios
The function node.restore() should be used to ensure complete erasure of WiFi configuration, since it completely overwrites the system parameter sectors that store WiFi configuration and other configuration information.
There was a problem hiding this comment.
This whole time, I never knew about node.restore().
Reset default settings of following APIs:
wifi_station_set_auto_connect,wifi_set_phy_mode,wifi_softap_set_configrelated,wifi_station_set_configrelated,wifi_set_opmode, and APs’ information recorded by#define AP_CACHE.
app/modules/wifi.c
Outdated
| memset(temp, 0, sizeof(temp)); | ||
| if(strlen(config[i].password) >= 8) | ||
| memset(temp, 0, sizeof(temp)); | ||
| if(strlen(config[i].password) >= 0) /* WPA = min 8, WEP = min 5 ASCII characters for a 40-bit key */ |
There was a problem hiding this comment.
If it's 5 for the 40-bit WEP, then shouldn't 5 be the new minimum?
There was a problem hiding this comment.
See #1706. tl;dr: 5 seems to be the smallest that would ever be used, but the SDK doesn't enforce a minimum.
There was a problem hiding this comment.
I suspect that this ought to be >= 1. I can't think of any way that strlen could return < 0.
There was a problem hiding this comment.
Yeah, strlen will never be <0. Looking at this now after having cooled down from when I made the change, I think >0 is what is appropriate for this code that is copying the passwords only if they exist. The question becomes, should "pwd" be included the Lua table even if there is no password for the entry?
There was a problem hiding this comment.
I'd leave out the pwd field if there is no password.
…g() docs, and added SDK verbiage to describe what node.restore() impacts.
| @@ -506,8 +506,8 @@ static int wifi_station_get_ap_info4lua( lua_State* L ) | |||
| c_sprintf(debug_temp, " %-6d %-32s ", i, temp); | |||
| #endif | |||
|
|
|||
| memset(temp, 0, sizeof(temp)); | |||
| if(strlen(config[i].password) >= 8) | |||
| memset(temp, 0, sizeof(temp)); | |||
There was a problem hiding this comment.
I also wonder -- is the size of the ssid field the same as the password field? If not, then trouble is nearby. Would prefer to eliminate the temp variable and just do a pushlstring of the correct length.
There was a problem hiding this comment.
Looking at the SDK docs, ssid=32, password=64. Looks like they're defining temp's length here as the max password length, and zeroing out before each write (so it is big enough to hold null-terminated strings for both password and ssid).
app/modules/wifi.c
Outdated
| wifi_station_disconnect(); | ||
|
|
||
| bool config_success; | ||
| if(save_to_flash) config_success = wifi_station_set_config(&sta_conf); |
There was a problem hiding this comment.
please format so that else lines up with if. The clauses should be on lines by themselves. I would prefer to use { and } in each case.
There was a problem hiding this comment.
That was existing code - not changed for this PR. I'm all for applying the Boy Scout Rule, but think it makes it harder for reviewers to see what exactly is new.
jfollas
force-pushed
the
feature/wifi-clear-config
branch
from
edba531
to
6f7c774
Compare
* Add wifi.sta.clearconfig(). Adjust password validation to match 2.0.0 SDK rules (no min length enforced, i.e. for WEP) * Updat comments about WEP key not having a minimum * Documentation: add note about node.restore() to wifi.sta.clearconfig() docs, and add SDK verbiage to describe what node.restore() impacts. * Normaliz if statements * Convert leading tabs to leading spaces for consistency
Fixes #1706 .
devbranch rather than formaster.docs/en/*.Added
wifi.sta.clearconfig()to remove the saved Wi-Fi configuration from flash. Useful in a couple of scenarios:Also included: Eliminated the minimum password length requirement for station passwords. It was 8 characters, but this prevented WEP from being used with 5-character keys (ASCII representation of a 40-bit key). See the discussion in issue #1706.