UserAuthManager.h File Reference

NetBurner User Authorization Manager. More...

#include <predef.h>
#include <basictypes.h>
#include <nbstring.h>
#include <crypto/wolfssl/wolfcrypt/sha256.h>

Go to the source code of this file.

Classes
struct	UserAuthRecord
	A stored record of a user's authorization credentials. The value is hashed when saved so it can't be read directly. User's can currently only have one authorization record per user name. More...
class	UserAuthManager
	The user authorization manager class allows application developers the ability to manage user authorization records. The can be loaded and saved to any storage space, including the config system or UserParams. Authorization values are hashed before being saved. Validation compares both the hash as well as the authorization type. Adding, updating, and removing records will automatically call the user devined save functions. For usage, please see the example found in examples/SSH/sshServerUserAuth. More...

Typedefs
typedef int(*	SaveAuthRecordsFn) (const UserAuthRecord *authRec)
	User provided function for saving user authorization records. This allows the users to dictate where their authorization records are stored.
typedef int(*	LoadAuthRecordsFn) (UserAuthRecord *authRec)
	User provided function for loading user authorization records. This allows the users to dictate where their authorization records are stored.

Enumerations
enum	AuthType : int8_t { eAuthTypeDefault = 0 , eAuthTypePassword = 1 , eAuthTypeKey = 2 }
	The types of authorization requests that are managed. These just indicate what the has value is, and don't provide any specific processing logic. More...
enum	AuthResponse : int16_t {   eAuthSuccess = 1 , eAuthErrorUserExists = -1 , eAuthErrorUserDoesNotExist = -2 , eAuthErrorNoEmptyUserAuthRecords = -3 ,   eAuthErrorUnableToCreateHash = -4 , eAuthErrorAuthCheckFailed = -5 , eAuthErrorAuthTypeMismatch = -6 , eAuthErrorFailedRecordUpdate = -7 ,   eAuthErrorUnableToAddUser = -8 , eAuthErrorSaveFailed = -9 }
	Response return codes when checking for the authorization status of a user. More...

Detailed Description

NetBurner User Authorization Manager.