NetBurner 3.5.0
PDF Version
 
User Authorization Manager

Topics

 Authorization Responses
 
 Authorization Types
 

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.
 

Detailed Description

The NetBurner User Authorization Manager

Typedef Documentation

◆ LoadAuthRecordsFn

typedef int(* LoadAuthRecordsFn) (UserAuthRecord *authRec)

#include <UserAuthManager.h>

User provided function for loading user authorization records. This allows the users to dictate where their authorization records are stored.

Parameters
authRecA pointer to an array of UserAuthRecords where the data will be loaded.
Return values
0If the authorization records were loaded correctly.
!0If there was an error loading the authorization records. Error codes are left to application developers to define.

◆ SaveAuthRecordsFn

typedef int(* SaveAuthRecordsFn) (const UserAuthRecord *authRec)

#include <UserAuthManager.h>

User provided function for saving user authorization records. This allows the users to dictate where their authorization records are stored.

Parameters
authRecA pointer to an array of UserAuthRecords that should be saved.
Return values
0If the authorization records were saved correctly.
!0If there was an error saving the authorization records. Error codes are left to application developers to define.