* Use text formatting for default factory values to produce dynamic names.
Header files contains duplicates of factory values defined in factory_settings.ini Removed them to simplify the code.
* Use text formatting for default factory values to produce dynamic names.
Header files contains duplicates of factory values defined in factory_settings.ini Removed them to simplify the code.
* Configured the WiFi host name to contain the device id by default
* Removed possibility to use placeholders for FACTORY_WIFI_SSID factory setting.
* Update README.md
Updated documentation
* Use text formatting for default factory values to produce dynamic names.
Header files contains duplicates of factory values defined in factory_settings.ini Removed them to simplify the code.
* Configured the WiFi host name to contain the device id by default
* Removed possibility to use placeholders for FACTORY_WIFI_SSID factory setting.
* Added a space to the end of the file to comply project code style
* fix typos
clang formatting
use 2 spaces in ini files
use ${platform}-${chip_id} for hostname
put chip id in brackets in AP SSID
* restore (and update) factory setting ifndefs
- this is so src can be built without an exaustive set build-time defines
- standardize ordering of defines: factory settings, paths, config
* format and modify comment
* escape spaces in pio defines
experiment with removing $'s from our format strings (they are being substituted with empty values by pio)
* fix formatting in readme
rename FactoryValue to SettingValue, put in own header
give example of direct usage of FactorySetting::format in README.md
* auto format
* use hash to delimit placeholders
* fix factory_settings.ini
* remove flash string helpers
* format ini file
* use MAC address instead of chip id for properly unique identifier
* use lower case hex encoding for unique id
use chip id and unique id for more secure secret
* fix comment
* Use random values for JWT secret
Arduino uses the ESP random number generator for "true random" numbers on both esp32 and esp8266
This makes a better JWT secret and may be useful for other factory defaults too
In addition a modification has been made to force the FSPersistance to save the file if applying defaults
* Don't use spaces in default AP SSID
* restore helpful comment in factory_settings.ini
fix default defines
Co-authored-by: kasedy <kasedy@gmail.com>
120 lines
3.6 KiB
C++
120 lines
3.6 KiB
C++
#ifndef SecuritySettingsService_h
|
|
#define SecuritySettingsService_h
|
|
|
|
#include <SettingValue.h>
|
|
#include <Features.h>
|
|
#include <SecurityManager.h>
|
|
#include <HttpEndpoint.h>
|
|
#include <FSPersistence.h>
|
|
|
|
#ifndef FACTORY_JWT_SECRET
|
|
#define FACTORY_JWT_SECRET "#{random}-#{random}"
|
|
#endif
|
|
|
|
#ifndef FACTORY_ADMIN_USERNAME
|
|
#define FACTORY_ADMIN_USERNAME "admin"
|
|
#endif
|
|
|
|
#ifndef FACTORY_ADMIN_PASSWORD
|
|
#define FACTORY_ADMIN_PASSWORD "admin"
|
|
#endif
|
|
|
|
#ifndef FACTORY_GUEST_USERNAME
|
|
#define FACTORY_GUEST_USERNAME "guest"
|
|
#endif
|
|
|
|
#ifndef FACTORY_GUEST_PASSWORD
|
|
#define FACTORY_GUEST_PASSWORD "guest"
|
|
#endif
|
|
|
|
#define SECURITY_SETTINGS_FILE "/config/securitySettings.json"
|
|
#define SECURITY_SETTINGS_PATH "/rest/securitySettings"
|
|
|
|
#if FT_ENABLED(FT_SECURITY)
|
|
|
|
class SecuritySettings {
|
|
public:
|
|
String jwtSecret;
|
|
std::list<User> users;
|
|
|
|
static void read(SecuritySettings& settings, JsonObject& root) {
|
|
// secret
|
|
root["jwt_secret"] = settings.jwtSecret;
|
|
|
|
// users
|
|
JsonArray users = root.createNestedArray("users");
|
|
for (User user : settings.users) {
|
|
JsonObject userRoot = users.createNestedObject();
|
|
userRoot["username"] = user.username;
|
|
userRoot["password"] = user.password;
|
|
userRoot["admin"] = user.admin;
|
|
}
|
|
}
|
|
|
|
static StateUpdateResult update(JsonObject& root, SecuritySettings& settings) {
|
|
// secret
|
|
settings.jwtSecret = root["jwt_secret"] | SettingValue::format(FACTORY_JWT_SECRET);
|
|
|
|
// users
|
|
settings.users.clear();
|
|
if (root["users"].is<JsonArray>()) {
|
|
for (JsonVariant user : root["users"].as<JsonArray>()) {
|
|
settings.users.push_back(User(user["username"], user["password"], user["admin"]));
|
|
}
|
|
} else {
|
|
settings.users.push_back(User(FACTORY_ADMIN_USERNAME, FACTORY_ADMIN_PASSWORD, true));
|
|
settings.users.push_back(User(FACTORY_GUEST_USERNAME, FACTORY_GUEST_PASSWORD, false));
|
|
}
|
|
return StateUpdateResult::CHANGED;
|
|
}
|
|
};
|
|
|
|
class SecuritySettingsService : public StatefulService<SecuritySettings>, public SecurityManager {
|
|
public:
|
|
SecuritySettingsService(AsyncWebServer* server, FS* fs);
|
|
|
|
void begin();
|
|
|
|
// Functions to implement SecurityManager
|
|
Authentication authenticate(const String& username, const String& password);
|
|
Authentication authenticateRequest(AsyncWebServerRequest* request);
|
|
String generateJWT(User* user);
|
|
ArRequestFilterFunction filterRequest(AuthenticationPredicate predicate);
|
|
ArRequestHandlerFunction wrapRequest(ArRequestHandlerFunction onRequest, AuthenticationPredicate predicate);
|
|
ArJsonRequestHandlerFunction wrapCallback(ArJsonRequestHandlerFunction callback, AuthenticationPredicate predicate);
|
|
|
|
private:
|
|
HttpEndpoint<SecuritySettings> _httpEndpoint;
|
|
FSPersistence<SecuritySettings> _fsPersistence;
|
|
ArduinoJsonJWT _jwtHandler;
|
|
|
|
void configureJWTHandler();
|
|
|
|
/*
|
|
* Lookup the user by JWT
|
|
*/
|
|
Authentication authenticateJWT(String& jwt);
|
|
|
|
/*
|
|
* Verify the payload is correct
|
|
*/
|
|
boolean validatePayload(JsonObject& parsedPayload, User* user);
|
|
};
|
|
|
|
#else
|
|
|
|
class SecuritySettingsService : public SecurityManager {
|
|
public:
|
|
SecuritySettingsService(AsyncWebServer* server, FS* fs);
|
|
~SecuritySettingsService();
|
|
|
|
// minimal set of functions to support framework with security settings disabled
|
|
Authentication authenticateRequest(AsyncWebServerRequest* request);
|
|
ArRequestFilterFunction filterRequest(AuthenticationPredicate predicate);
|
|
ArRequestHandlerFunction wrapRequest(ArRequestHandlerFunction onRequest, AuthenticationPredicate predicate);
|
|
ArJsonRequestHandlerFunction wrapCallback(ArJsonRequestHandlerFunction onRequest, AuthenticationPredicate predicate);
|
|
};
|
|
|
|
#endif // end FT_ENABLED(FT_SECURITY)
|
|
#endif // end SecuritySettingsService_h
|