Skip to content

Commit

Permalink
add digest auth (#1669)
Browse files Browse the repository at this point in the history
  • Loading branch information
@PotatoCider
PotatoCider authored Nov 4, 2023
1 parent 94529cd commit f417a3b
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 30 deletions.
70 changes: 42 additions & 28 deletions WiFiManager.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1296,30 +1296,25 @@ void WiFiManager::HTTPSend(const String &content){
}

/**
* HTTPD handler for page requests
* handles pre-request authentication
* return false if not authenticated
*/
void WiFiManager::handleRequest() {
bool WiFiManager::handleRequest() {
_webPortalAccessed = millis();

// TESTING HTTPD AUTH RFC 2617
// BASIC_AUTH will hold onto creds, hard to "logout", but convienent
// DIGEST_AUTH will require new auth often, and nonce is random
// bool authenticate(const char * username, const char * password);
// bool authenticateDigest(const String& username, const String& H1);
// void requestAuthentication(HTTPAuthMethod mode = BASIC_AUTH, const char* realm = NULL, const String& authFailMsg = String("") );

// 2.3 NO AUTH available
bool testauth = false;
if(!testauth) return;
// We use DIGEST_AUTH since connection is over insecure HTTP

if (!_enableAuth) return true;

DEBUG_WM(WM_DEBUG_DEV,F("DOING AUTH"));
bool res = server->authenticate("admin","12345");
if(!res){
bool authenticated = server->authenticate(_authUsername.c_str(), _authPassword.c_str());
if(!authenticated){
#ifndef WM_NOAUTH
server->requestAuthentication(HTTPAuthMethod::BASIC_AUTH); // DIGEST_AUTH
server->requestAuthentication(HTTPAuthMethod::DIGEST_AUTH);
#endif
DEBUG_WM(WM_DEBUG_DEV,F("AUTH FAIL"));
}
return authenticated;
}

/**
Expand All @@ -1330,7 +1325,7 @@ void WiFiManager::handleRoot() {
DEBUG_WM(WM_DEBUG_VERBOSE,F("<- HTTP Root"));
#endif
if (captivePortal()) return; // If captive portal redirect instead of displaying the page
handleRequest();
if (!handleRequest()) return;
String page = getHTTPHead(_title); // @token options @todo replace options with title
String str = FPSTR(HTTP_ROOT_MAIN); // @todo custom title
str.replace(FPSTR(T_t),_title);
Expand All @@ -1355,7 +1350,7 @@ void WiFiManager::handleWifi(boolean scan) {
#ifdef WM_DEBUG_LEVEL
DEBUG_WM(WM_DEBUG_VERBOSE,F("<- HTTP Wifi"));
#endif
handleRequest();
if (!handleRequest()) return;
String page = getHTTPHead(FPSTR(S_titlewifi)); // @token titlewifi
if (scan) {
#ifdef WM_DEBUG_LEVEL
Expand Down Expand Up @@ -1411,7 +1406,7 @@ void WiFiManager::handleParam(){
#ifdef WM_DEBUG_LEVEL
DEBUG_WM(WM_DEBUG_VERBOSE,F("<- HTTP Param"));
#endif
handleRequest();
if (!handleRequest()) return;
String page = getHTTPHead(FPSTR(S_titleparam)); // @token titlewifi

String pitem = "";
Expand Down Expand Up @@ -1791,7 +1786,7 @@ void WiFiManager::handleWiFiStatus(){
#ifdef WM_DEBUG_LEVEL
DEBUG_WM(WM_DEBUG_VERBOSE,F("<- HTTP WiFi status "));
#endif
handleRequest();
if (!handleRequest()) return;
String page;
// String page = "{\"result\":true,\"count\":1}";
#ifdef WM_JSTEST
Expand All @@ -1808,7 +1803,7 @@ void WiFiManager::handleWifiSave() {
DEBUG_WM(WM_DEBUG_VERBOSE,F("<- HTTP WiFi save "));
DEBUG_WM(WM_DEBUG_DEV,F("Method:"),server->method() == HTTP_GET ? (String)FPSTR(S_GET) : (String)FPSTR(S_POST));
#endif
handleRequest();
if (!handleRequest()) return;

//SAVE/connect here
_ssid = server->arg(F("s")).c_str();
Expand Down Expand Up @@ -1899,7 +1894,7 @@ void WiFiManager::handleParamSave() {
#ifdef WM_DEBUG_LEVEL
DEBUG_WM(WM_DEBUG_DEV,F("Method:"),server->method() == HTTP_GET ? (String)FPSTR(S_GET) : (String)FPSTR(S_POST));
#endif
handleRequest();
if (!handleRequest()) return;

doParamSave();

Expand Down Expand Up @@ -1968,7 +1963,7 @@ void WiFiManager::handleInfo() {
#ifdef WM_DEBUG_LEVEL
DEBUG_WM(WM_DEBUG_VERBOSE,F("<- HTTP Info"));
#endif
handleRequest();
if (!handleRequest()) return;
String page = getHTTPHead(FPSTR(S_titleinfo)); // @token titleinfo
reportStatus(page);

Expand Down Expand Up @@ -2313,7 +2308,7 @@ void WiFiManager::handleExit() {
#ifdef WM_DEBUG_LEVEL
DEBUG_WM(WM_DEBUG_VERBOSE,F("<- HTTP Exit"));
#endif
handleRequest();
if (!handleRequest()) return;
String page = getHTTPHead(FPSTR(S_titleexit)); // @token titleexit
page += FPSTR(S_exiting); // @token exiting
// ('Logout', 401, {'WWW-Authenticate': 'Basic realm="Login required"'})
Expand All @@ -2330,7 +2325,7 @@ void WiFiManager::handleReset() {
#ifdef WM_DEBUG_LEVEL
DEBUG_WM(WM_DEBUG_VERBOSE,F("<- HTTP Reset"));
#endif
handleRequest();
if (!handleRequest()) return;
String page = getHTTPHead(FPSTR(S_titlereset)); //@token titlereset
page += FPSTR(S_resetting); //@token resetting
page += FPSTR(HTTP_END);
Expand All @@ -2355,7 +2350,7 @@ void WiFiManager::handleErase(boolean opt) {
#ifdef WM_DEBUG_LEVEL
DEBUG_WM(WM_DEBUG_NOTIFY,F("<- HTTP Erase"));
#endif
handleRequest();
if (!handleRequest()) return;
String page = getHTTPHead(FPSTR(S_titleerase)); // @token titleerase

bool ret = erase(opt);
Expand Down Expand Up @@ -2385,7 +2380,7 @@ void WiFiManager::handleErase(boolean opt) {
*/
void WiFiManager::handleNotFound() {
if (captivePortal()) return; // If captive portal redirect instead of displaying the page
handleRequest();
if (!handleRequest()) return;
String message = FPSTR(S_notfound); // @token notfound

bool verbose404 = false; // show info in 404 body, uri,method, args
Expand Down Expand Up @@ -2452,12 +2447,14 @@ void WiFiManager::stopCaptivePortal(){

// HTTPD CALLBACK, handle close, stop captive portal, if not enabled undefined
void WiFiManager::handleClose(){
#ifdef WM_DEBUG_LEVEL
DEBUG_WM(WM_DEBUG_VERBOSE,F("Disabling Captive Portal"));
if (!handleRequest()) return;
#endif
stopCaptivePortal();
#ifdef WM_DEBUG_LEVEL
DEBUG_WM(WM_DEBUG_VERBOSE,F("<- HTTP close"));
#endif
handleRequest();
String page = getHTTPHead(FPSTR(S_titleclose)); // @token titleclose
page += FPSTR(S_closing); // @token closing
HTTPSend(page);
Expand Down Expand Up @@ -3271,6 +3268,24 @@ void WiFiManager::setDarkMode(bool enable){
_bodyClass = enable ? "invert" : "";
}

/**
* setAuthentication
* @param bool enables digest authentication for all pages
*/
void WiFiManager::setAuthentication(bool enable){
_enableAuth = enable;
}

/**
* setAuthCredentials
* @param String username
* @param String password
*/
void WiFiManager::setAuthCredientials(String username, String password){
_authUsername = username;
_authPassword = password;
}

/**
* setHttpPort
* @param uint16_t port webserver port number default 80
Expand All @@ -3279,7 +3294,6 @@ void WiFiManager::setHttpPort(uint16_t port){
_httpPort = port;
}


bool WiFiManager::preloadWiFi(String ssid, String pass){
_defaultssid = ssid;
_defaultpass = pass;
Expand Down
12 changes: 10 additions & 2 deletions WiFiManager.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -480,6 +480,12 @@ class WiFiManager
// set dark mode via invert class
void setDarkMode(bool enable);

// set digest authentication for all pages
void setAuthentication(bool enable);

// set authentication credentials
void setAuthCredientials(String username, String password);

// get default ap esp uses , esp_chipid etc
String getDefaultAPName();

Expand Down Expand Up @@ -564,7 +570,9 @@ class WiFiManager
// on some conn failure modes will add delays and many retries to work around esp and ap bugs, ie, anti de-auth protections
// https://github.com/tzapu/WiFiManager/issues/1067
bool _allowExit = true; // allow exit in nonblocking, else user exit/abort calls will be ignored including cptimeout

bool _enableAuth = false; // enables http digest authentication for all pages
String _authUsername = "admin"; // default username for http authentication
String _authPassword = "12345"; // default password for http authentication
#ifdef ESP32
wifi_event_id_t wm_event_id = 0;
static uint8_t _lastconxresulttmp; // tmp var for esp32 callback
Expand Down Expand Up @@ -679,7 +687,7 @@ class WiFiManager
void handleErase(boolean opt);
void handleParam();
void handleWiFiStatus();
void handleRequest();
bool handleRequest();
void handleParamSave();
void doParamSave();

Expand Down

0 comments on commit f417a3b

Please sign in to comment.