controllers

package
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 26, 2021 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthController 

type AuthController interface {
	// AuthenticateUserWithPassword authenticates a user with their username and password.
	// Returns the user if authentication was successful, or nil if not.
	// Also returns any errors.
	AuthenticateUserWithPassword(CRUD AuthControllerCRUD, username string, password string) (*models.User, common.CustomError)
}

type AuthControllerCRUD 

type AuthControllerCRUD interface {
	models.UserCRUD
}

AuthControllerCRUD encapsulates the CRUD operations required by the AuthController.

type ClientController 

type ClientController interface {
	// CreateClient creates a new client using the provided model.
	// Returns any errors.
	CreateClient(CRUD ClientControllerCRUD, client *models.Client) common.CustomError

	// GetClients gets all clients.
	// Returns the client models any errors.
	GetClients(CRUD ClientControllerCRUD) ([]*models.Client, common.CustomError)

	// UpdateClient updates the given client.
	// Returns any errors.
	UpdateClient(CRUD ClientControllerCRUD, client *models.Client) common.CustomError

	// DeleteClient deletes the client with the given uid.
	// Returns any errors.
	DeleteClient(CRUD ClientControllerCRUD, uid uuid.UUID) common.CustomError
}

type ClientControllerCRUD 

type ClientControllerCRUD interface {
	models.ClientCRUD
	models.SessionCRUD
}

ClientControllerCRUD encapsulates the CRUD operations required by the ClientController.

type Controllers 

type Controllers interface {
	UserController
	ClientController
	UserRoleController
	AuthController
	SessionController
	TokenController
}

Controllers encapsulates all other controller interfaces.

type CoreAuthController 

type CoreAuthController struct {
	PasswordHasher passwordhelpers.PasswordHasher
}

func (CoreAuthController) AuthenticateUserWithPassword 

func (c CoreAuthController) AuthenticateUserWithPassword(CRUD AuthControllerCRUD, username string, password string) (*models.User, common.CustomError)

type CoreClientController 

type CoreClientController struct{}

func (CoreClientController) CreateClient 

func (c CoreClientController) CreateClient(CRUD ClientControllerCRUD, client *models.Client) common.CustomError

func (CoreClientController) DeleteClient 

func (CoreClientController) DeleteClient(CRUD ClientControllerCRUD, uid uuid.UUID) common.CustomError

func (CoreClientController) GetClients 

func (CoreClientController) GetClients(CRUD ClientControllerCRUD) ([]*models.Client, common.CustomError)

func (CoreClientController) UpdateClient 

func (c CoreClientController) UpdateClient(CRUD ClientControllerCRUD, client *models.Client) common.CustomError

type CoreControllers 

type CoreControllers struct {
	UserController
	ClientController
	UserRoleController
	AuthController
	SessionController
	TokenController
}

type CoreSessionController 

type CoreSessionController struct {
	AuthController AuthController
}

func (CoreSessionController) CreateSession 

func (c CoreSessionController) CreateSession(CRUD SessionControllerCRUD, username string, password string) (*models.Session, common.CustomError)

func (CoreSessionController) DeleteAllOtherUserSessions 

func (c CoreSessionController) DeleteAllOtherUserSessions(CRUD SessionControllerCRUD, username string, id uuid.UUID) common.CustomError

func (CoreSessionController) DeleteAllUserSessions 

func (c CoreSessionController) DeleteAllUserSessions(CRUD SessionControllerCRUD, username string) common.CustomError

func (CoreSessionController) DeleteSession 

func (c CoreSessionController) DeleteSession(CRUD SessionControllerCRUD, id uuid.UUID) common.CustomError

type CoreTokenController 

type CoreTokenController struct {
	AuthController       AuthController
	TokenFactorySelector jwthelpers.TokenFactorySelector
}

func (CoreTokenController) CreateTokenRedirectURL 

func (c CoreTokenController) CreateTokenRedirectURL(CRUD TokenControllerCRUD, clientUID uuid.UUID, username string, password string) (string, common.CustomError)

type CoreUserController 

type CoreUserController struct {
	PasswordHasher            passwordhelpers.PasswordHasher
	PasswordCriteriaValidator passwordhelpers.PasswordCriteriaValidator
	AuthController            AuthController
	UserController            UserController
}

func (CoreUserController) CreateUser 

func (c CoreUserController) CreateUser(CRUD UserControllerCRUD, username string, password string, rank int) (*models.User, common.CustomError)

func (CoreUserController) DeleteUser 

func (c CoreUserController) DeleteUser(CRUD UserControllerCRUD, username string) common.CustomError

func (CoreUserController) GetUsersWithLesserRank 

func (CoreUserController) GetUsersWithLesserRank(CRUD UserControllerCRUD, rank int) ([]*models.User, common.CustomError)

func (CoreUserController) UpdateUser 

func (c CoreUserController) UpdateUser(CRUD UserControllerCRUD, username string, rank int) (*models.User, common.CustomError)

func (CoreUserController) UpdateUserPassword 

func (c CoreUserController) UpdateUserPassword(CRUD UserControllerCRUD, username string, password string) common.CustomError

func (CoreUserController) UpdateUserPasswordWithAuth 

func (c CoreUserController) UpdateUserPasswordWithAuth(CRUD UserControllerCRUD, username string, oldPassword string, newPassword string) common.CustomError

func (CoreUserController) VerifyUserRank 

func (CoreUserController) VerifyUserRank(CRUD UserControllerCRUD, username string, rank int) (bool, common.CustomError)

type CoreUserRoleController 

type CoreUserRoleController struct{}

func (CoreUserRoleController) CreateUserRole 

func (c CoreUserRoleController) CreateUserRole(CRUD UserRoleControllerCRUD, role *models.UserRole) common.CustomError

func (CoreUserRoleController) DeleteUserRole 

func (c CoreUserRoleController) DeleteUserRole(CRUD UserRoleControllerCRUD, clientUID uuid.UUID, username string) common.CustomError

func (CoreUserRoleController) GetUserRolesWithLesserRankByClientUID 

func (c CoreUserRoleController) GetUserRolesWithLesserRankByClientUID(CRUD UserRoleControllerCRUD, clientUID uuid.UUID, rank int) ([]*models.UserRole, common.CustomError)

func (CoreUserRoleController) UpdateUserRole 

func (c CoreUserRoleController) UpdateUserRole(CRUD UserRoleControllerCRUD, role *models.UserRole) common.CustomError

type SessionController 

type SessionController interface {
	// CreateSession creates a new session by authorizing the user with a password.
	// Returns the session model and any errors.
	CreateSession(CRUD SessionControllerCRUD, username string, password string) (*models.Session, common.CustomError)

	// DeleteSession deletes the session with the given id.
	// Returns any errors.
	DeleteSession(CRUD SessionControllerCRUD, id uuid.UUID) common.CustomError

	// DeleteAllUserSessions deletes all of the sessions for the given username.
	// Returns any errors.
	DeleteAllUserSessions(CRUD SessionControllerCRUD, username string) common.CustomError

	// DeleteAllOtherUserSessions deletes all of the sessions for the given username expect the one with the given id.
	// Returns any errors.
	DeleteAllOtherUserSessions(CRUD SessionControllerCRUD, username string, id uuid.UUID) common.CustomError
}

type SessionControllerCRUD 

type SessionControllerCRUD interface {
	models.UserCRUD
	models.SessionCRUD
}

SessionControllerCRUD encapsulates the CRUD operations required by the SessionController.

type TokenController 

type TokenController interface {
	// CreateTokenRedirectURL first authenticates using the username and password, then creates a signed JWT for the specified client.
	// The base-64 encoded token string is then appended to the client's redirect url.
	// Returns the url and any errors.
	CreateTokenRedirectURL(CRUD TokenControllerCRUD, clientId uuid.UUID, username string, password string) (string, common.CustomError)
}

type TokenControllerCRUD 

type TokenControllerCRUD interface {
	models.UserCRUD
	models.ClientCRUD
	models.UserRoleCRUD
}

TokenControllerCRUD encapsulates the CRUD operations required by the TokenController.

type UserController 

type UserController interface {
	// CreateUser creates a new user with the given username, password, and rank.
	// Returns the user model and any errors.
	CreateUser(CRUD UserControllerCRUD, username string, password string, rank int) (*models.User, common.CustomError)

	// GetUsersWithLesserRank gets all users with a rank less than the provided one.
	// Returns the user models and any errors.
	GetUsersWithLesserRank(CRUD UserControllerCRUD, rank int) ([]*models.User, common.CustomError)

	// UpdateUser updates the fields of the user for the given username.
	// Returns the user model and any errors.
	UpdateUser(CRUD UserControllerCRUD, username string, rank int) (*models.User, common.CustomError)

	// UpdateUserPassword updates the password for the user with the given username.
	// Returns any errors.
	UpdateUserPassword(CRUD UserControllerCRUD, username string, password string) common.CustomError

	// UpdateUserPasswordWithAuth authenticates the user and updates their password.
	// Returns any errors.
	UpdateUserPasswordWithAuth(CRUD UserControllerCRUD, username string, oldPassword string, newPassword string) common.CustomError

	// DeleteUser deletes the user with given username.
	// Returns any errors.
	DeleteUser(CRUD UserControllerCRUD, username string) common.CustomError

	// VerifyUserRank verifies the user with given username has a rank less than the provided rank.
	// Returns result and any errors.
	VerifyUserRank(CRUD UserControllerCRUD, username string, rank int) (bool, common.CustomError)
}

type UserControllerCRUD 

type UserControllerCRUD interface {
	models.UserCRUD
	models.SessionCRUD
}

UserControllerCRUD encapsulates the CRUD operations required by the UserController.

type UserRoleController 

type UserRoleController interface {
	// CreateUserRole creates a new user-role using the provided model.
	// Returns any errors.
	CreateUserRole(CRUD UserRoleControllerCRUD, role *models.UserRole) common.CustomError

	// GetUserRolesByClientUID gets the user-roles with the provided client uid and with a rank less than the provided rank.
	// Returns the user-role models and any errors.
	GetUserRolesWithLesserRankByClientUID(CRUD UserRoleControllerCRUD, clientUID uuid.UUID, rank int) ([]*models.UserRole, common.CustomError)

	// UpdateUserRole updates the given user-role.
	// Returns any errors.
	UpdateUserRole(CRUD UserRoleControllerCRUD, role *models.UserRole) common.CustomError

	// DeleteUserRole deletes the user-role with the given client uid and username.
	// Returns any errors.
	DeleteUserRole(CRUD UserRoleControllerCRUD, clientUID uuid.UUID, username string) common.CustomError
}

type UserRoleControllerCRUD 

type UserRoleControllerCRUD interface {
	models.UserRoleCRUD
}

UserRoleControllerCRUD encapsulates the CRUD operations required by the UserRoleController.

Source Files

View all Source files

Directories

Path Synopsis
mocks
mocks

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.