UserAuthManager.h

Go to the documentation of this file.

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
#ifndef _USER_AUTH_MANAGER_H_
#define _USER_AUTH_MANAGER_H_
 
#include <predef.h>
 
#ifdef NB_SSH_SUPPORTED
 
#ifndef WOLFSSL_USER_SETTINGS
#define WOLFSSL_USER_SETTINGS   // This wasn't getting defined in the project source files in NBEclipse
#endif
 
#include <basictypes.h>
#include <nbstring.h>
 
#include <crypto/wolfssl/wolfcrypt/sha256.h>
 
#define MAX_AUTH_RECORDS 25
#define WC_SHA256_DIGEST_SIZE 32
 
enum AuthType : int8_t
{
    eAuthTypeDefault = 0,    
    eAuthTypePassword = 1,   
    eAuthTypeKey = 2,        
};
enum AuthResponse : int16_t
{
    eAuthSuccess = 1,                        
    eAuthErrorUserExists = -1,               
    eAuthErrorUserDoesNotExist = -2,         
    eAuthErrorNoEmptyUserAuthRecords = -3,   
    eAuthErrorUnableToCreateHash = -4,       
    eAuthErrorAuthCheckFailed = -5,          
    eAuthErrorAuthTypeMismatch = -6,         
    eAuthErrorFailedRecordUpdate = -7,       
    eAuthErrorUnableToAddUser = -8,          
    eAuthErrorSaveFailed = -9,               
};
struct UserAuthRecord
{
    NBString m_userName;                         
    uint8_t m_authHash[WC_SHA256_DIGEST_SIZE];   
    AuthType m_authType;                         
    uint32_t m_authLevel;   
};
 
// Callbacks used to load and save user authentication information
typedef int (*SaveAuthRecordsFn)(const UserAuthRecord *authRec);
 
typedef int (*LoadAuthRecordsFn)(UserAuthRecord *authRec);
 
class UserAuthManager
{
   public:
    UserAuthManager() {}
 
    ~UserAuthManager() {}
 
    bool Init(SaveAuthRecordsFn svRcFn, LoadAuthRecordsFn ldRcFn);
 
    bool UserExists(const NBString &userName);
 
    AuthResponse AddUserAuth(const NBString &userName, const NBString &auth, AuthType authType);
 
    AuthResponse CheckUserAuth(const NBString &userName, const NBString &auth, AuthType authType);
 
    AuthResponse CheckUserAuth(const NBString &userName, byte *auth, AuthType authType);
 
    AuthResponse UpdateUserAuth(const NBString &userName, const NBString &newAuth, AuthType authType);
 
    AuthResponse RemoveUserAuth(const NBString &userName);
 
    AuthResponse CheckUserAuthLevel(const NBString &userName, uint32_t authLevel, bool hasAll = true);
 
    AuthResponse SetUserAuthLevel(const NBString &userName, uint32_t authLevel);
 
    AuthResponse ClrUserAuthLevel(const NBString &userName, uint32_t authLevel);
 
    void ListUsers();
 
    int GetMaxAuthRecords() { return MAX_AUTH_RECORDS; }
 
   private:
    int16_t GetNextEmptyRecord();
 
    int16_t FindUser(const NBString &userName);
 
    bool CreateHash(const NBString &auth, uint8_t *outHash);
 
    // User defined functions for loading and saving auth data.
    int (*m_SaveAuthRecords)(const UserAuthRecord *authRec) = nullptr;
 
    int (*m_LoadAuthRecords)(UserAuthRecord *authRec) = nullptr;
 
    UserAuthRecord m_authRecords[MAX_AUTH_RECORDS];   
};
 
#endif   /* NB_SSH_SUPPORTED */
#endif   // _USER_AUTH_MANAGER_H_