Compare commits
5 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8d8a1e3c33 | ||
|
|
b6988638c0 | ||
|
|
1b7218e5de | ||
|
|
8285cf0384 | ||
|
|
14994edcad |
123
accessHandler.go
123
accessHandler.go
@@ -1,127 +1,10 @@
|
||||
package AccessHandler
|
||||
|
||||
import (
|
||||
"gitea.tecamino.com/paadi/dbHandler"
|
||||
"gitea.tecamino.com/paadi/access-handler/handlers"
|
||||
"gitea.tecamino.com/paadi/tecamino-logger/logging"
|
||||
)
|
||||
|
||||
// AccessHandler
|
||||
//
|
||||
// Description:
|
||||
//
|
||||
// AccessHandler manages access-related functionality, including
|
||||
// database operations for users and roles, as well as logging.
|
||||
// It encapsulates a database handler and a logger so that
|
||||
// authentication and authorization operations can be performed
|
||||
// consistently across the application.
|
||||
type AccessHandler struct {
|
||||
dbHandler *dbHandler.DBHandler // Database handler used for managing users and roles
|
||||
logger *logging.Logger // Centralized application logger
|
||||
}
|
||||
|
||||
// NewAccessHandler
|
||||
//
|
||||
// Description:
|
||||
//
|
||||
// Creates and initializes a new AccessHandler instance.
|
||||
//
|
||||
// Behavior:
|
||||
// 1. If a logger is not provided (nil), it creates a new logger instance
|
||||
// that writes to "accessHandler.log".
|
||||
// 2. Initializes the AccessHandler struct.
|
||||
// 3. Sets up the internal DBAHandler with the same logger.
|
||||
// 4. Automatically creates required database tables and default data:
|
||||
// - User table
|
||||
// - Default user(s)
|
||||
// - Role table
|
||||
// - Default role(s)
|
||||
//
|
||||
// Parameters:
|
||||
// - dbPath: The file path to the database.
|
||||
// - logger: Optional pointer to a logging.Logger instance. If nil, a new one is created.
|
||||
//
|
||||
// Returns:
|
||||
// - aH: A pointer to the fully initialized AccessHandler.
|
||||
// - err: Any error that occurs during initialization.
|
||||
//
|
||||
// Example:
|
||||
//
|
||||
// handler, err := NewAccessHandler("data/app.db", appLogger)
|
||||
// if err != nil {
|
||||
// log.Fatal(err)
|
||||
// }
|
||||
func NewAccessHandler(path string, logger *logging.Logger) (aH *AccessHandler, err error) {
|
||||
if logger == nil {
|
||||
logger, err = logging.NewLogger("accessHandler.log", nil)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
logger.Debug("NewAccessHandler", "initialize new access handler")
|
||||
|
||||
// Initialize AccessHandler with logger
|
||||
aH = &AccessHandler{
|
||||
logger: logger,
|
||||
}
|
||||
|
||||
logger.Debug("NewAccessHandler", "initialize db handler")
|
||||
// Create a new DB handler instance
|
||||
aH.dbHandler, err = dbHandler.NewDBHandler(path, "user", logger)
|
||||
if err != nil {
|
||||
aH.logger.Error("NewAccessHandler", err)
|
||||
return
|
||||
}
|
||||
|
||||
logger.Debug("NewAccessHandler", "add user table")
|
||||
// Add the user table to the database
|
||||
err = aH.AddUserTable()
|
||||
if err != nil {
|
||||
aH.logger.Error("NewAccessHandler", err)
|
||||
return
|
||||
}
|
||||
|
||||
logger.Debug("NewAccessHandler", "add default user")
|
||||
// Add default users to the system
|
||||
err = aH.AddDefaultUser()
|
||||
if err != nil {
|
||||
aH.logger.Error("NewAccessHandler", err)
|
||||
return
|
||||
}
|
||||
|
||||
logger.Debug("NewAccessHandler", "add role table")
|
||||
// Add the role table to the database
|
||||
err = aH.AddRoleTable()
|
||||
if err != nil {
|
||||
aH.logger.Error("NewAccessHandler", err)
|
||||
return
|
||||
}
|
||||
|
||||
logger.Debug("NewAccessHandler", "add default role")
|
||||
// Add default roles to the system
|
||||
err = aH.AddDefaultRole()
|
||||
if err != nil {
|
||||
aH.logger.Error("NewAccessHandler", err)
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// GetLogger
|
||||
//
|
||||
// Description:
|
||||
//
|
||||
// Returns the logger associated with this AccessHandler instance.
|
||||
// Useful when another component or handler needs to reuse the
|
||||
// same logging instance for consistent log output.
|
||||
//
|
||||
// Returns:
|
||||
// - *logging.Logger: The logger assigned to this AccessHandler.
|
||||
//
|
||||
// Example:
|
||||
//
|
||||
// log := accessHandler.GetLogger()
|
||||
// log.Info("Some event")
|
||||
func (aH *AccessHandler) GetLogger() *logging.Logger {
|
||||
return aH.logger
|
||||
func NewAccessHandler(path string, logger *logging.Logger) (aH *handlers.AccessHandler, err error) {
|
||||
return handlers.NewAccessHandler(path, logger)
|
||||
}
|
||||
|
||||
@@ -1,158 +0,0 @@
|
||||
package AccessHandler
|
||||
|
||||
import (
|
||||
"gitea.tecamino.com/paadi/access-handler/models"
|
||||
"gitea.tecamino.com/paadi/dbHandler"
|
||||
"gitea.tecamino.com/paadi/tecamino-logger/logging"
|
||||
)
|
||||
|
||||
// AccessHandler
|
||||
//
|
||||
// Description:
|
||||
//
|
||||
// AccessHandler manages access-related functionality, including
|
||||
// database operations for users and roles, as well as logging.
|
||||
// It encapsulates a database handler and a logger so that
|
||||
// authentication and authorization operations can be performed
|
||||
// consistently across the application.
|
||||
type AccessHandlerAPI struct {
|
||||
dbHandler *dbHandler.DBHandler // Database handler used for managing users and roles
|
||||
logger *logging.Logger // Centralized application logger
|
||||
}
|
||||
|
||||
// NewAccessHandlerAPI
|
||||
//
|
||||
// Description:
|
||||
//
|
||||
// Creates and initializes a new AccessHandler instance.
|
||||
//
|
||||
// Behavior:
|
||||
// 1. If a logger is not provided (nil), it creates a new logger instance
|
||||
// that writes to "accessHandler.log".
|
||||
// 2. Initializes the AccessHandler struct.
|
||||
// 3. Sets up the internal DBAHandler with the same logger.
|
||||
// 4. Automatically creates required database tables and default data:
|
||||
// - User table
|
||||
// - Default user(s)
|
||||
// - Role table
|
||||
// - Default role(s)
|
||||
//
|
||||
// Parameters:
|
||||
// - dbPath: The file path to the database.
|
||||
// - logger: Optional pointer to a logging.Logger instance. If nil, a new one is created.
|
||||
//
|
||||
// Returns:
|
||||
// - aH: A pointer to the fully initialized AccessHandler.
|
||||
// - err: Any error that occurs during initialization.
|
||||
//
|
||||
// Example:
|
||||
//
|
||||
// handler, err := NewAccessHandlerAPI("data/app.db", appLogger)
|
||||
// if err != nil {
|
||||
// log.Fatal(err)
|
||||
// }
|
||||
func NewAccessHandlerAPI(path string, logger *logging.Logger) (aH *AccessHandlerAPI, err error) {
|
||||
if logger == nil {
|
||||
logger, err = logging.NewLogger("accessHandler.log", nil)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
logger.Debug("NewAccessHandlerAPI", "initialize new access handler")
|
||||
|
||||
// Initialize AccessHandler with logger
|
||||
aH = &AccessHandlerAPI{
|
||||
logger: logger,
|
||||
}
|
||||
|
||||
logger.Debug("NewAccessHandlerAPI", "initialize db handler")
|
||||
// Create a new DB handler instance
|
||||
aH.dbHandler, err = dbHandler.NewDBHandler(path, "user", logger)
|
||||
if err != nil {
|
||||
aH.logger.Error("NewAccessHandlerAPI", err)
|
||||
return
|
||||
}
|
||||
|
||||
logger.Debug("NewAccessHandlerAPI", "add user table")
|
||||
// Add the user table to the database
|
||||
err = aH.dbHandler.AddNewTable(models.User{})
|
||||
if err != nil {
|
||||
aH.logger.Error("NewAccessHandlerAPI", err)
|
||||
return
|
||||
}
|
||||
|
||||
logger.Debug("NewAccessHandlerAPI", "add default user")
|
||||
// Add default users to the system
|
||||
name := "admin"
|
||||
role := "admin"
|
||||
email := "zuercher@tecamino.ch"
|
||||
|
||||
// Check if a user with this email already exists
|
||||
if err := aH.dbHandler.Exists(&models.User{}, "email", email, false); err == nil {
|
||||
aH.logger.Debug("AddDefaultUser", "user email "+email+" exists already")
|
||||
// Found a user → skip create
|
||||
} else {
|
||||
// Create default settings for the new user
|
||||
settings := models.Settings{}
|
||||
aH.logger.Debug("AddDefaultUser", "set default quasar settings")
|
||||
settings.DefaultQuasarSettings()
|
||||
|
||||
// Insert default admin user into the database
|
||||
aH.dbHandler.AddNewColum(&models.User{
|
||||
Name: name,
|
||||
Role: role,
|
||||
Email: email,
|
||||
Password: "$2a$10$sZZOWBP8DSFLrLFQNoXw8OsEEr0tez1B8lPzKCHofaHg6PMNxx1pG",
|
||||
Settings: settings,
|
||||
})
|
||||
}
|
||||
|
||||
logger.Debug("NewAccessHandlerAPI", "add role table")
|
||||
// Add the role table to the database
|
||||
err = aH.dbHandler.AddNewTable(models.Role{})
|
||||
if err != nil {
|
||||
aH.logger.Error("NewAccessHandlerAPI", err)
|
||||
return
|
||||
}
|
||||
|
||||
// Add default roles to the system
|
||||
logger.Debug("NewAccessHandlerAPI", "add default role")
|
||||
|
||||
// Check if a role with this name already exists
|
||||
if err := aH.dbHandler.Exists(&models.Role{}, "role", role, false); err == nil {
|
||||
// Found a role → skip creation
|
||||
aH.logger.Debug("AddDefaultRole", "role "+role+" exists already")
|
||||
} else {
|
||||
// Initialize default permissions for admin
|
||||
permissions := models.Permissions{}
|
||||
aH.logger.Debug("AddDefaultRole", "set default Permissions")
|
||||
permissions.DefaultPermissions()
|
||||
|
||||
// Create the default admin role
|
||||
aH.dbHandler.AddNewColum(&models.Role{
|
||||
Role: role,
|
||||
Permissions: permissions,
|
||||
})
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
// GetLogger
|
||||
//
|
||||
// Description:
|
||||
//
|
||||
// Returns the logger associated with this AccessHandler instance.
|
||||
// Useful when another component or handler needs to reuse the
|
||||
// same logging instance for consistent log output.
|
||||
//
|
||||
// Returns:
|
||||
// - *logging.Logger: The logger assigned to this AccessHandler.
|
||||
//
|
||||
// Example:
|
||||
//
|
||||
// log := accessHandler.GetLogger()
|
||||
// log.Info("Some event")
|
||||
func (aH *AccessHandlerAPI) GetLogger() *logging.Logger {
|
||||
return aH.logger
|
||||
}
|
||||
305
api.go
305
api.go
@@ -1,305 +0,0 @@
|
||||
package AccessHandler
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"strconv"
|
||||
|
||||
"gitea.tecamino.com/paadi/access-handler/models"
|
||||
"gitea.tecamino.com/paadi/access-handler/utils"
|
||||
"github.com/gin-gonic/gin"
|
||||
)
|
||||
|
||||
func (aH *AccessHandlerAPI) AddUser(c *gin.Context) {
|
||||
var user models.User
|
||||
err := c.BindJSON(&user)
|
||||
if err != nil {
|
||||
aH.logger.Error("AddUser", err)
|
||||
c.JSON(http.StatusInternalServerError, models.NewJsonErrorResponse(err))
|
||||
return
|
||||
}
|
||||
|
||||
if !user.IsValid() {
|
||||
aH.logger.Error("AddUser", "user empty")
|
||||
c.JSON(http.StatusBadRequest, models.NewJsonMessageResponse("user empty"))
|
||||
return
|
||||
}
|
||||
|
||||
// Check if a user with this email already exists
|
||||
if err := aH.dbHandler.Exists(&models.User{}, "email", user.Email, false); err == nil {
|
||||
// Found a user → skip create
|
||||
aH.logger.Error("AddUser", "user with email "+user.Email+" already exists")
|
||||
c.JSON(http.StatusBadRequest, models.NewJsonMessageResponse(fmt.Sprintf("user with email %s already exists", user.Email)))
|
||||
return
|
||||
}
|
||||
|
||||
hash, err := utils.HashPassword(user.Password)
|
||||
if err != nil {
|
||||
aH.logger.Error("AddUser", err)
|
||||
c.JSON(http.StatusInternalServerError, nil)
|
||||
return
|
||||
}
|
||||
|
||||
if !utils.IsValidEmail(user.Email) {
|
||||
aH.logger.Error("AddUser", "not valid email address")
|
||||
c.JSON(http.StatusBadRequest, models.NewJsonErrorResponse(errors.New("not valid email address")))
|
||||
return
|
||||
}
|
||||
|
||||
// Hash the provided password before saving
|
||||
hash, err = utils.HashPassword(user.Password)
|
||||
if err != nil {
|
||||
aH.logger.Error("AddUser", err)
|
||||
c.JSON(http.StatusInternalServerError, nil)
|
||||
return
|
||||
}
|
||||
|
||||
aH.logger.Debug("AddUser", "add new user "+user.Name+" with role "+user.Role)
|
||||
|
||||
// Insert the new user record
|
||||
aH.dbHandler.AddNewColum(&models.User{
|
||||
Name: user.Name,
|
||||
Role: user.Role,
|
||||
Email: user.Email,
|
||||
Password: hash,
|
||||
})
|
||||
|
||||
c.JSON(http.StatusOK, gin.H{
|
||||
"message": fmt.Sprintf("user '%s' successfully added", user.Name),
|
||||
})
|
||||
}
|
||||
|
||||
func (aH *AccessHandlerAPI) GetUser(c *gin.Context) {
|
||||
var i int
|
||||
var err error
|
||||
|
||||
id := c.Query("id")
|
||||
if id != "" {
|
||||
i, err = strconv.Atoi(id)
|
||||
if err != nil {
|
||||
aH.logger.Error("GetUser", err)
|
||||
c.JSON(http.StatusInternalServerError, nil)
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
var users []models.User
|
||||
err = aH.dbHandler.GetById(&users, uint(i))
|
||||
if err != nil {
|
||||
aH.logger.Error("GetUser", err)
|
||||
c.JSON(http.StatusInternalServerError, nil)
|
||||
return
|
||||
}
|
||||
c.JSON(http.StatusOK, users)
|
||||
}
|
||||
|
||||
func (aH *AccessHandlerAPI) UpdateUser(c *gin.Context) {
|
||||
var user models.User
|
||||
if err := c.BindJSON(&user); err != nil {
|
||||
aH.logger.Error("UpdateUser", err)
|
||||
c.JSON(http.StatusInternalServerError, nil)
|
||||
return
|
||||
}
|
||||
err := aH.dbHandler.UpdateValuesById(&user, user.Id)
|
||||
if err != nil {
|
||||
aH.logger.Error("UpdateUser", err)
|
||||
c.JSON(http.StatusInternalServerError, nil)
|
||||
return
|
||||
}
|
||||
c.JSON(http.StatusOK, models.NewJsonMessageResponse("successfully updated user '"+user.Email+"'"))
|
||||
|
||||
}
|
||||
|
||||
func (aH *AccessHandlerAPI) DeleteUser(c *gin.Context) {
|
||||
queryId := c.Query("id")
|
||||
|
||||
if queryId == "" || queryId == "null" || queryId == "undefined" {
|
||||
aH.logger.Error("DeleteUser", "id query missing or wrong value: "+queryId)
|
||||
c.JSON(http.StatusBadRequest, gin.H{
|
||||
"message": "id query missing or wrong value: " + queryId,
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
var request struct {
|
||||
Ids []int `json:"ids"`
|
||||
}
|
||||
|
||||
err := c.BindJSON(&request)
|
||||
if err != nil {
|
||||
aH.logger.Error("DeleteUser", "id query missing or wrong value: "+queryId)
|
||||
c.JSON(http.StatusInternalServerError, nil)
|
||||
return
|
||||
}
|
||||
|
||||
if len(request.Ids) == 0 {
|
||||
aH.logger.Error("DeleteUser", "no ids given to be deleted")
|
||||
c.JSON(http.StatusBadRequest, gin.H{
|
||||
"message": "no ids given to be deleted",
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
var ownId string
|
||||
removeIds := make([]uint, len(request.Ids))
|
||||
for i, id := range request.Ids {
|
||||
if queryId == fmt.Sprint(id) {
|
||||
ownId = queryId
|
||||
continue
|
||||
}
|
||||
removeIds[i] = uint(id)
|
||||
}
|
||||
|
||||
if ownId != "" {
|
||||
aH.logger.Error("DeleteUser", "can not delete logged in member id: "+queryId)
|
||||
c.JSON(http.StatusBadRequest, gin.H{
|
||||
"message": "can not delete logged in member id: " + queryId,
|
||||
"id": queryId,
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
err = aH.dbHandler.DeleteById(&models.User{}, removeIds...)
|
||||
if err != nil {
|
||||
aH.logger.Error("DeleteUser", err)
|
||||
c.JSON(http.StatusInternalServerError, nil)
|
||||
return
|
||||
}
|
||||
|
||||
c.JSON(http.StatusOK, gin.H{
|
||||
"message": "member(s) deleted",
|
||||
})
|
||||
}
|
||||
|
||||
func (aH *AccessHandlerAPI) AddRole(c *gin.Context) {
|
||||
var role models.Role
|
||||
err := c.BindJSON(&role)
|
||||
if err != nil {
|
||||
aH.logger.Error("AddRole", err)
|
||||
c.JSON(http.StatusBadRequest, models.NewJsonErrorResponse(err))
|
||||
return
|
||||
}
|
||||
|
||||
if !role.IsValid() {
|
||||
aH.logger.Error("AddRole", "user empty")
|
||||
c.JSON(http.StatusBadRequest, models.NewJsonMessageResponse("user empty"))
|
||||
return
|
||||
}
|
||||
|
||||
// Check if a role with this name already exists
|
||||
if err := aH.dbHandler.Exists(&models.Role{}, "role", role, false); err == nil {
|
||||
aH.logger.Error("AddRole", fmt.Sprintf("role with name %s already exists", role.Role))
|
||||
c.JSON(http.StatusBadRequest, models.NewJsonMessageResponse(fmt.Sprintf("role with name %s already exists", role.Role)))
|
||||
}
|
||||
|
||||
// Insert new role with provided permissions
|
||||
aH.dbHandler.AddNewColum(&models.Role{
|
||||
Role: role.Role,
|
||||
Permissions: role.Permissions,
|
||||
})
|
||||
c.JSON(http.StatusOK, gin.H{
|
||||
"message": fmt.Sprintf("role '%s' successfully added", role.Role),
|
||||
})
|
||||
}
|
||||
|
||||
func (aH *AccessHandlerAPI) GetRole(c *gin.Context) {
|
||||
var i int
|
||||
var err error
|
||||
|
||||
id := c.Query("id")
|
||||
if id != "" {
|
||||
i, err = strconv.Atoi(id)
|
||||
if err != nil {
|
||||
aH.logger.Error("GetRole", err)
|
||||
c.JSON(http.StatusInternalServerError, nil)
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
var role []models.Role
|
||||
err = aH.dbHandler.GetById(&role, uint(i))
|
||||
if err != nil {
|
||||
aH.logger.Error("GetRole", err)
|
||||
c.JSON(http.StatusInternalServerError, nil)
|
||||
return
|
||||
}
|
||||
c.JSON(http.StatusOK, role)
|
||||
}
|
||||
|
||||
func (aH *AccessHandlerAPI) UpdateRole(c *gin.Context) {
|
||||
var role models.Role
|
||||
if err := c.BindJSON(&role); err != nil {
|
||||
aH.logger.Error("UpdateRole", err)
|
||||
c.JSON(http.StatusInternalServerError, nil)
|
||||
return
|
||||
}
|
||||
err := aH.dbHandler.UpdateValuesById(&role, role.Id)
|
||||
if err != nil {
|
||||
aH.logger.Error("UpdateRole", err)
|
||||
c.JSON(http.StatusInternalServerError, nil)
|
||||
return
|
||||
}
|
||||
c.JSON(http.StatusOK, models.NewJsonMessageResponse("successfully updated role '"+role.Role+"'"))
|
||||
}
|
||||
|
||||
func (aH *AccessHandlerAPI) DeleteRole(c *gin.Context) {
|
||||
queryId := c.Query("id")
|
||||
|
||||
if queryId == "" || queryId == "null" || queryId == "undefined" {
|
||||
aH.logger.Error("DeleteRole", "id query missing or wrong value: "+queryId)
|
||||
c.JSON(http.StatusBadRequest, gin.H{
|
||||
"message": "id query missing or wrong value: " + queryId,
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
var request struct {
|
||||
Ids []int `json:"ids"`
|
||||
}
|
||||
|
||||
err := c.BindJSON(&request)
|
||||
if err != nil {
|
||||
aH.logger.Error("DeleteRole", "id query missing or wrong value: "+queryId)
|
||||
c.JSON(http.StatusInternalServerError, nil)
|
||||
return
|
||||
}
|
||||
|
||||
if len(request.Ids) == 0 {
|
||||
aH.logger.Error("DeleteRole", "no ids given to be deleted")
|
||||
c.JSON(http.StatusBadRequest, gin.H{
|
||||
"message": "no ids given to be deleted",
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
var ownId string
|
||||
removeIds := make([]uint, len(request.Ids))
|
||||
for i, id := range request.Ids {
|
||||
if queryId == fmt.Sprint(id) {
|
||||
ownId = queryId
|
||||
continue
|
||||
}
|
||||
removeIds[i] = uint(id)
|
||||
}
|
||||
|
||||
if ownId != "" {
|
||||
aH.logger.Error("DeleteRole", "can not delete logged in member role id: "+queryId)
|
||||
c.JSON(http.StatusBadRequest, gin.H{
|
||||
"message": "can not delete logged in member id: " + queryId,
|
||||
"id": queryId,
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
err = aH.dbHandler.DeleteById(&models.Role{}, removeIds...)
|
||||
if err != nil {
|
||||
aH.logger.Error("DeleteUser", err)
|
||||
c.JSON(http.StatusInternalServerError, nil)
|
||||
return
|
||||
}
|
||||
|
||||
c.JSON(http.StatusOK, gin.H{
|
||||
"message": "role(s) deleted",
|
||||
})
|
||||
}
|
||||
@@ -106,13 +106,13 @@ func TestLoginHandler(t *testing.T) {
|
||||
|
||||
r := gin.Default()
|
||||
|
||||
SetMiddlewareLogger(r, aH.GetLogger())
|
||||
aH.SetMiddlewareLogger(r)
|
||||
|
||||
r.POST("/login", aH.Login)
|
||||
r.POST("/login/refresh", aH.Refresh)
|
||||
r.GET("/login/me", aH.Me)
|
||||
r.GET("/logout", aH.Logout)
|
||||
middleware := r.Group("", AuthMiddleware())
|
||||
middleware := r.Group("", aH.AuthMiddleware())
|
||||
|
||||
auth := middleware.Group("/members", aH.AuthorizeRole(""))
|
||||
auth.GET("", func(ctx *gin.Context) {
|
||||
|
||||
127
handlers/access.go
Normal file
127
handlers/access.go
Normal file
@@ -0,0 +1,127 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"gitea.tecamino.com/paadi/dbHandler"
|
||||
"gitea.tecamino.com/paadi/tecamino-logger/logging"
|
||||
)
|
||||
|
||||
// AccessHandler
|
||||
//
|
||||
// Description:
|
||||
//
|
||||
// AccessHandler manages access-related functionality, including
|
||||
// database operations for users and roles, as well as logging.
|
||||
// It encapsulates a database handler and a logger so that
|
||||
// authentication and authorization operations can be performed
|
||||
// consistently across the application.
|
||||
type AccessHandler struct {
|
||||
dbHandler *dbHandler.DBHandler // Database handler used for managing users and roles
|
||||
logger *logging.Logger // Centralized application logger
|
||||
}
|
||||
|
||||
// NewAccessHandler
|
||||
//
|
||||
// Description:
|
||||
//
|
||||
// Creates and initializes a new AccessHandler instance.
|
||||
//
|
||||
// Behavior:
|
||||
// 1. If a logger is not provided (nil), it creates a new logger instance
|
||||
// that writes to "accessHandler.log".
|
||||
// 2. Initializes the AccessHandler struct.
|
||||
// 3. Sets up the internal DBAHandler with the same logger.
|
||||
// 4. Automatically creates required database tables and default data:
|
||||
// - User table
|
||||
// - Default user(s)
|
||||
// - Role table
|
||||
// - Default role(s)
|
||||
//
|
||||
// Parameters:
|
||||
// - dbPath: The file path to the database.
|
||||
// - logger: Optional pointer to a logging.Logger instance. If nil, a new one is created.
|
||||
//
|
||||
// Returns:
|
||||
// - aH: A pointer to the fully initialized AccessHandler.
|
||||
// - err: Any error that occurs during initialization.
|
||||
//
|
||||
// Example:
|
||||
//
|
||||
// handler, err := NewAccessHandler("data/app.db", appLogger)
|
||||
// if err != nil {
|
||||
// log.Fatal(err)
|
||||
// }
|
||||
func NewAccessHandler(path string, logger *logging.Logger) (aH *AccessHandler, err error) {
|
||||
if logger == nil {
|
||||
logger, err = logging.NewLogger("accessHandler.log", nil)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
logger.Debug("NewAccessHandler", "initialize new access handler")
|
||||
|
||||
// Initialize AccessHandler with logger
|
||||
aH = &AccessHandler{
|
||||
logger: logger,
|
||||
}
|
||||
|
||||
logger.Debug("NewAccessHandler", "initialize db handler")
|
||||
// Create a new DB handler instance
|
||||
aH.dbHandler, err = dbHandler.NewDBHandler("user", path, logger)
|
||||
if err != nil {
|
||||
aH.logger.Error("NewAccessHandler", err)
|
||||
return
|
||||
}
|
||||
|
||||
logger.Debug("NewAccessHandler", "add user table")
|
||||
// Add the user table to the database
|
||||
err = aH.AddUserTable()
|
||||
if err != nil {
|
||||
aH.logger.Error("NewAccessHandler", err)
|
||||
return
|
||||
}
|
||||
|
||||
logger.Debug("NewAccessHandler", "add default user")
|
||||
// Add default users to the system
|
||||
err = aH.AddDefaultUser()
|
||||
if err != nil {
|
||||
aH.logger.Error("NewAccessHandler", err)
|
||||
return
|
||||
}
|
||||
|
||||
logger.Debug("NewAccessHandler", "add role table")
|
||||
// Add the role table to the database
|
||||
err = aH.AddRoleTable()
|
||||
if err != nil {
|
||||
aH.logger.Error("NewAccessHandler", err)
|
||||
return
|
||||
}
|
||||
|
||||
logger.Debug("NewAccessHandler", "add default role")
|
||||
// Add default roles to the system
|
||||
err = aH.AddDefaultRole()
|
||||
if err != nil {
|
||||
aH.logger.Error("NewAccessHandler", err)
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// GetLogger
|
||||
//
|
||||
// Description:
|
||||
//
|
||||
// Returns the logger associated with this AccessHandler instance.
|
||||
// Useful when another component or handler needs to reuse the
|
||||
// same logging instance for consistent log output.
|
||||
//
|
||||
// Returns:
|
||||
// - *logging.Logger: The logger assigned to this AccessHandler.
|
||||
//
|
||||
// Example:
|
||||
//
|
||||
// log := accessHandler.GetLogger()
|
||||
// log.Info("Some event")
|
||||
func (aH *AccessHandler) GetLogger() *logging.Logger {
|
||||
return aH.logger
|
||||
}
|
||||
@@ -1,4 +1,4 @@
|
||||
package AccessHandler
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
@@ -6,8 +6,8 @@ import (
|
||||
"net/http"
|
||||
"time"
|
||||
|
||||
"gitea.tecamino.com/paadi/access-handler/internal/utils"
|
||||
"gitea.tecamino.com/paadi/access-handler/models"
|
||||
"gitea.tecamino.com/paadi/access-handler/utils"
|
||||
|
||||
"github.com/gin-gonic/gin"
|
||||
"github.com/golang-jwt/jwt/v5"
|
||||
@@ -53,7 +53,8 @@ func (aH *AccessHandler) Login(c *gin.Context) {
|
||||
}
|
||||
|
||||
// Fetch user record from DB
|
||||
dbRecord, err := aH.GetUserByKey("user_name", user.Name, false)
|
||||
var dbRecord []models.User
|
||||
err := aH.dbHandler.GetByKey(&dbRecord, "user_name", user.Name, false)
|
||||
if err != nil {
|
||||
aH.logger.Error("Login", err)
|
||||
c.JSON(http.StatusBadRequest, models.NewJsonErrorResponse(err))
|
||||
@@ -1,4 +1,4 @@
|
||||
package AccessHandler
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
@@ -6,6 +6,7 @@ import (
|
||||
"net/http"
|
||||
"strings"
|
||||
|
||||
"gitea.tecamino.com/paadi/access-handler/models"
|
||||
"gitea.tecamino.com/paadi/tecamino-logger/logging"
|
||||
"github.com/gin-gonic/gin"
|
||||
"github.com/golang-jwt/jwt/v5"
|
||||
@@ -28,10 +29,10 @@ import (
|
||||
// Usage:
|
||||
//
|
||||
// SetMiddlewareLogger(router, logger)
|
||||
func SetMiddlewareLogger(r *gin.Engine, logger *logging.Logger) {
|
||||
func (aH *AccessHandler) SetMiddlewareLogger(r *gin.Engine) {
|
||||
// Add middleware that injects logger into context
|
||||
r.Use(func(c *gin.Context) {
|
||||
c.Set("logger", logger)
|
||||
c.Set("logger", aH.logger)
|
||||
c.Next()
|
||||
})
|
||||
}
|
||||
@@ -56,7 +57,7 @@ func SetMiddlewareLogger(r *gin.Engine, logger *logging.Logger) {
|
||||
// Usage:
|
||||
//
|
||||
// r.Use(AuthMiddleware())
|
||||
func AuthMiddleware() gin.HandlerFunc {
|
||||
func (aH *AccessHandler) AuthMiddleware() gin.HandlerFunc {
|
||||
return func(c *gin.Context) {
|
||||
// Retrieve logger from Gin context
|
||||
middlewareLogger, ok := c.Get("logger")
|
||||
@@ -130,7 +131,8 @@ func (aH *AccessHandler) AuthorizeRole(suffix string) gin.HandlerFunc {
|
||||
}
|
||||
|
||||
// Fetch roles and associated permissions from the database or store
|
||||
roles, err := aH.GetRoleByKey("role", role, false)
|
||||
var roles []models.Role
|
||||
err := aH.dbHandler.GetByKey(&roles, "role", role, false)
|
||||
if err != nil {
|
||||
aH.logger.Error("AuthorizeRole", err)
|
||||
c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"message": http.StatusInternalServerError})
|
||||
@@ -1,4 +1,4 @@
|
||||
package AccessHandler
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
@@ -1,10 +1,10 @@
|
||||
package AccessHandler
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"gitea.tecamino.com/paadi/access-handler/internal/utils"
|
||||
"gitea.tecamino.com/paadi/access-handler/models"
|
||||
"gitea.tecamino.com/paadi/access-handler/utils"
|
||||
)
|
||||
|
||||
// AddUserTable
|
||||
Reference in New Issue
Block a user