WordClockESP/src/SecurityManager.h

99 lines
2.2 KiB
C
Raw Normal View History

#ifndef SecurityManager_h
#define SecurityManager_h
#include <list>
2019-04-29 23:30:43 +00:00
#include <SettingsService.h>
#include <DNSServer.h>
#include <IPAddress.h>
2019-05-02 23:31:20 +00:00
#include <jwt/ArduinoJsonJWT.h>
2019-04-29 23:30:43 +00:00
#define DEFAULT_JWT_SECRET "esp8266-react"
#define SECURITY_SETTINGS_FILE "/config/securitySettings.json"
#define USERS_PATH "/rest/users"
2019-04-29 23:30:43 +00:00
#define AUTHENTICATE_PATH "/rest/authenticate"
2019-05-02 23:31:20 +00:00
#define SIGN_IN_PATH "/rest/signIn"
2019-04-29 23:30:43 +00:00
2019-05-02 23:31:20 +00:00
#define MAX_JWT_SIZE 128
#define MAX_SECURITY_MANAGER_SETTINGS_SIZE 512
2019-04-29 23:30:43 +00:00
#define SECURITY_MANAGER_MAX_USERS 5
2019-05-02 23:31:20 +00:00
#define ANONYMOUS_USERNAME "_anonymous"
#define ANONYMOUS_PASSWORD ""
#define ANONYMOUS_ROLE ""
2019-04-29 23:30:43 +00:00
#define MAX_USERS_SIZE 1024
2019-04-29 23:30:43 +00:00
class User {
private:
String _username;
String _password;
String _role;
public:
User(String username, String password, String role): _username(username), _password(password), _role(role) {}
String getUsername() {
return _username;
}
String getPassword() {
return _password;
}
String getRole() {
return _role;
}
bool isAuthenticated() {
2019-05-02 23:31:20 +00:00
return _username != ANONYMOUS_USERNAME;
2019-04-29 23:30:43 +00:00
}
};
2019-05-02 23:31:20 +00:00
const User NOT_AUTHENTICATED = User(ANONYMOUS_USERNAME, ANONYMOUS_PASSWORD, ANONYMOUS_ROLE);
2019-04-29 23:30:43 +00:00
class SecurityManager : public SettingsPersistence {
public:
SecurityManager(AsyncWebServer* server, FS* fs);
~SecurityManager();
void begin();
2019-05-02 23:31:20 +00:00
/*
* Lookup the user by JWT
*/
2019-04-29 23:30:43 +00:00
User verifyUser(String jwt);
2019-05-02 23:31:20 +00:00
/*
* Authenticate, returning the user if found.
*/
User authenticate(String username, String password);
2019-05-02 23:31:20 +00:00
/*
* Generate a JWT for the user provided
*/
2019-04-29 23:30:43 +00:00
String generateJWT(User user);
protected:
void readFromJsonObject(JsonObject& root);
void writeToJsonObject(JsonObject& root);
private:
2019-05-02 23:31:20 +00:00
// jwt handler
ArduinoJsonJWT jwtHandler = ArduinoJsonJWT(DEFAULT_JWT_SECRET);
2019-04-29 23:30:43 +00:00
// server instance
AsyncWebServer* _server;
2019-05-02 23:31:20 +00:00
AsyncJsonRequestWebHandler _signInRequestHandler;
2019-04-29 23:30:43 +00:00
// access point settings
String _jwtSecret;
std::list<String> _roles;
std::list<User> _users;
// endpoint functions
void fetchUsers(AsyncWebServerRequest *request);
2019-05-02 23:31:20 +00:00
void signIn(AsyncWebServerRequest *request, JsonDocument &jsonDocument);
2019-04-29 23:30:43 +00:00
};
#endif // end SecurityManager_h