vuman

Documentation

Index

• func GetEndpoints() (endpoints []*vnet.Endpoint)
• func GetStorage() vsec.UserStorage
• func MongoAuthenticator(params map[string]interface{}) (user *vsec.User, err error)
• func SetStorageStrategy(srg vsec.UserStorage)
• type MongoStorage
  • func (m *MongoStorage) CleanData() (err error)
  • func (m *MongoStorage) CreateIndices() (err error)
  • func (m *MongoStorage) CreateSuperUser(user *vsec.User, password string) (err error)
  • func (m *MongoStorage) CreateUser(user *vsec.User) (err error)
  • func (m *MongoStorage) DeleteUser(userID string) (err error)
  • func (m *MongoStorage) GetCount(filter *vcmn.Filter) (count int, err error)
  • func (m *MongoStorage) GetUser(userID string) (user *vsec.User, err error)
  • func (m *MongoStorage) GetUserAuthLevel(userID string) (level vsec.AuthLevel, err error)
  • func (m *MongoStorage) GetUsers(offset, limit int, filter *vcmn.Filter) (users []*vsec.User, err error)
  • func (m *MongoStorage) GetUsersWithCount(offset, limit int, filter *vcmn.Filter) (total int, users []*vsec.User, err error)
  • func (m *MongoStorage) ResetPassword(userID, oldPwd, newPwd string) (err error)
  • func (m *MongoStorage) SetPassword(userID, newPwd string) (err error)
  • func (m *MongoStorage) SetUserState(userID string, state vsec.UserState) (err error)
  • func (m *MongoStorage) UpdateProfile(user *vsec.User) (err error)
  • func (m *MongoStorage) UpdateUser(user *vsec.User) (err error)
  • func (m *MongoStorage) ValidateUser(userID, password string) (err error)
  • func (m *MongoStorage) VerifyUser(userID, verID string) (err error)
• type PGStorage
  • func (p *PGStorage) CleanData() (err error)
  • func (p *PGStorage) CreateIndices() (err error)
  • func (p *PGStorage) CreateSuperUser(user *vsec.User, password string) (err error)
  • func (p *PGStorage) CreateUser(user *vsec.User) (err error)
  • func (p *PGStorage) DeleteUser(userID string) (err error)
  • func (p *PGStorage) GetCount(filter *vcmn.Filter) (count int, err error)
  • func (p *PGStorage) GetUser(userID string) (user *vsec.User, err error)
  • func (p *PGStorage) GetUserAuthLevel(userID string) (level vsec.AuthLevel, err error)
  • func (p *PGStorage) GetUsers(offset int, limit int, filter *vcmn.Filter) (users []*vsec.User, err error)
  • func (p *PGStorage) GetUsersWithCount(offset int, limit int, filter *vcmn.Filter) (total int, users []*vsec.User, err error)
  • func (p *PGStorage) ResetPassword(userID, oldPwd, newPwd string) (err error)
  • func (p *PGStorage) SetPassword(userID, newPwd string) (err error)
  • func (p *PGStorage) SetUserState(userID string, state vsec.UserState) (err error)
  • func (p *PGStorage) UpdateProfile(user *vsec.User) (err error)
  • func (p *PGStorage) UpdateUser(user *vsec.User) (err error)
  • func (p *PGStorage) ValidateUser(userID, password string) (err error)
  • func (p *PGStorage) VerifyUser(userID, verID string) (err error)

Functions

func GetEndpoints

func GetEndpoints() (endpoints []*vnet.Endpoint)

GetEndpoints - gives REST endpoints for user manaagement

func GetStorage

func GetStorage() vsec.UserStorage

GetStorage - gets the underlying storage implementation

func MongoAuthenticator

func MongoAuthenticator(params map[string]interface{}) (
	user *vsec.User, err error)

MongoAuthenticator - authenticator that uses user information stored in mongo DB to authenticate userID and password given

func SetStorageStrategy

func SetStorageStrategy(srg vsec.UserStorage)

SetStorageStrategy - sets user storage strategy

Types

type MongoStorage

type MongoStorage struct{}

MongoStorage - mongodb storage for user information

func (*MongoStorage) CleanData

func (m *MongoStorage) CleanData() (err error)

CleanData - cleans user management related data from database

func (*MongoStorage) CreateIndices

func (m *MongoStorage) CreateIndices() (err error)

CreateIndices - creates mongoDB indeces for tables used for user management

func (*MongoStorage) CreateSuperUser

func (m *MongoStorage) CreateSuperUser(
	user *vsec.User, password string) (err error)

CreateSuperUser - creates the first super user for the application

func (*MongoStorage) CreateUser

func (m *MongoStorage) CreateUser(user *vsec.User) (err error)

CreateUser - creates user in database

func (*MongoStorage) DeleteUser

func (m *MongoStorage) DeleteUser(userID string) (err error)

DeleteUser - deletes user with given user ID

func (*MongoStorage) GetCount

func (m *MongoStorage) GetCount(filter *vcmn.Filter) (count int, err error)

GetCount - gives the number of user selected by given filter

func (*MongoStorage) GetUser

func (m *MongoStorage) GetUser(userID string) (user *vsec.User, err error)

GetUser - gets details of the user corresponding to ID

func (*MongoStorage) GetUserAuthLevel

func (m *MongoStorage) GetUserAuthLevel(
	userID string) (level vsec.AuthLevel, err error)

GetUserAuthLevel - gets user authorization level

func (*MongoStorage) GetUsers

func (m *MongoStorage) GetUsers(offset, limit int, filter *vcmn.Filter) (
	users []*vsec.User, err error)

GetUsers - gets all users based on offset, limit and filter

func (*MongoStorage) GetUsersWithCount

func (m *MongoStorage) GetUsersWithCount(
	offset, limit int, filter *vcmn.Filter) (
	total int, users []*vsec.User, err error)

GetUsersWithCount - Get users with total count

func (*MongoStorage) ResetPassword

func (m *MongoStorage) ResetPassword(
	userID, oldPwd, newPwd string) (err error)

ResetPassword - sets password of a unauthenticated user

func (*MongoStorage) SetPassword

func (m *MongoStorage) SetPassword(userID, newPwd string) (err error)

SetPassword - sets password of a already authenticated user, old password is not required

func (*MongoStorage) SetUserState

func (m *MongoStorage) SetUserState(
	userID string, state vsec.UserState) (err error)

SetUserState - sets state of an user account

func (*MongoStorage) UpdateProfile

func (m *MongoStorage) UpdateProfile(user *vsec.User) (err error)

UpdateProfile - updates user details - this should be used when user logged in is updating own user account

func (*MongoStorage) UpdateUser

func (m *MongoStorage) UpdateUser(user *vsec.User) (err error)

UpdateUser - updates user in database

func (*MongoStorage) ValidateUser

func (m *MongoStorage) ValidateUser(userID, password string) (err error)

ValidateUser - validates user ID and password

func (*MongoStorage) VerifyUser

func (m *MongoStorage) VerifyUser(userID, verID string) (err error)

VerifyUser - sets state of an user account to verified based on userID and verification ID

type PGStorage

type PGStorage struct{}

PGStorage - postgresql storage for user information

func (*PGStorage) CleanData

func (p *PGStorage) CleanData() (err error)

CleanData - cleans user management related data from database

func (*PGStorage) CreateIndices

func (p *PGStorage) CreateIndices() (err error)

CreateIndices - creates mongoDB indeces for tables used for user management

func (*PGStorage) CreateSuperUser

func (p *PGStorage) CreateSuperUser(
	user *vsec.User, password string) (err error)

CreateSuperUser - creates the first super user for the application

func (*PGStorage) CreateUser

func (p *PGStorage) CreateUser(user *vsec.User) (err error)

CreateUser - creates user in database

func (*PGStorage) DeleteUser

func (p *PGStorage) DeleteUser(userID string) (err error)

DeleteUser - deletes user with given user ID

func (*PGStorage) GetCount

func (p *PGStorage) GetCount(filter *vcmn.Filter) (count int, err error)

GetCount - gives the number of user selected by given filter

func (*PGStorage) GetUser

func (p *PGStorage) GetUser(userID string) (user *vsec.User, err error)

GetUser - gets details of the user corresponding to ID

func (*PGStorage) GetUserAuthLevel

func (p *PGStorage) GetUserAuthLevel(
	userID string) (level vsec.AuthLevel, err error)

GetUserAuthLevel - gets user authorization level

func (*PGStorage) GetUsers

func (p *PGStorage) GetUsers(offset int,
	limit int,
	filter *vcmn.Filter) (users []*vsec.User, err error)

GetUsers - gets all users based on offset and limit

func (*PGStorage) GetUsersWithCount

func (p *PGStorage) GetUsersWithCount(offset int,
	limit int,
	filter *vcmn.Filter) (total int, users []*vsec.User, err error)

GetUsersWithCount - gives a list of users paged with total count

func (*PGStorage) ResetPassword

func (p *PGStorage) ResetPassword(
	userID, oldPwd, newPwd string) (err error)

ResetPassword - sets password of a unauthenticated user

func (*PGStorage) SetPassword

func (p *PGStorage) SetPassword(userID, newPwd string) (err error)

SetPassword - sets password of a already authenticated user, old password is not required

func (*PGStorage) SetUserState

func (p *PGStorage) SetUserState(
	userID string, state vsec.UserState) (err error)

SetUserState - sets state of an user account

func (*PGStorage) UpdateProfile

func (p *PGStorage) UpdateProfile(user *vsec.User) (err error)

UpdateProfile - updates user details - this should be used when user logged in is updating own user account

func (*PGStorage) UpdateUser

func (p *PGStorage) UpdateUser(user *vsec.User) (err error)

UpdateUser - updates user in database

func (*PGStorage) ValidateUser

func (p *PGStorage) ValidateUser(userID, password string) (err error)

ValidateUser - validates user ID and password

func (*PGStorage) VerifyUser

func (p *PGStorage) VerifyUser(userID, verID string) (err error)

VerifyUser - sets state of an user account to verified based on userID and verification ID