10 Commits

Author SHA1 Message Date
Adrian Zürcher
b6988638c0 fix minor bugs in role api 2025-10-24 17:35:32 +02:00
Adrian Zürcher
1b7218e5de change dlete role api from id to key 'role' 2025-10-24 17:10:28 +02:00
Adrian Zürcher
8285cf0384 add middleware for api 2025-10-24 16:29:37 +02:00
Adrian Zürcher
14994edcad add login for api handler 2025-10-24 16:22:17 +02:00
Adrian Zürcher
ab85632410 fix wrong handler namr 2025-10-24 16:10:19 +02:00
Adrian Zürcher
090cf0c1cc add api handler 2025-10-24 16:09:01 +02:00
Adrian Zürcher
a797700685 change db to fixed name and path is definable 2025-10-24 11:01:52 +02:00
Adrian Zürcher
d7890f747b change repo name 2025-10-24 10:51:25 +02:00
Adrian Zürcher
e469b61bb2 move handlers to root folder 2025-10-24 10:43:59 +02:00
Adrian Zürcher
42c4f1d915 move handlers to root folder 2025-10-24 10:42:31 +02:00
17 changed files with 952 additions and 389 deletions

1
.gitignore vendored
View File

@@ -1 +1,2 @@
*.log *.log
*.db

View File

@@ -21,13 +21,12 @@ It provides ready-to-use user authentication (login, refresh, logout, user info)
``` ```
AccessHandler/ AccessHandler/
├── handlers/ ├── access_handler.go # AccessHandler initialization
│ ├── access_handler.go # AccessHandler initialization ├── db_handler.go # Database handler using GORM
│ ├── db_handler.go # Database handler using GORM ├── login.go # Login, Refresh, Me, Logout handlers
│ ├── login.go # Login, Refresh, Me, Logout handlers ├── middleware.go # middleware authentification
│ ├── middleware.go # middleware authentification ├── role.go # database handling for roles
| ├── role.go # database handling for roles ├── user.go # database users for roles
| ├── user.go # database users for roles
| |
├── models/ ├── models/
│ ├── jsonResponse.go # Json responses model │ ├── jsonResponse.go # Json responses model
@@ -79,7 +78,7 @@ go get https://gitea.tecamino.com/paadi/tecamino-logger/logging
## 🔑 Authentication Constants ## 🔑 Authentication Constants
In `handlers/login.go`: In `login.go`:
```go ```go
// ----------------------------- // -----------------------------
@@ -119,7 +118,6 @@ var REFRESH_SECRET = []byte("*")
package main package main
import ( import (
"AccessHandler/handlers"
"gitea.tecamino.com/paadi/tecamino-logger/logging" "gitea.tecamino.com/paadi/tecamino-logger/logging"
"github.com/gin-gonic/gin" "github.com/gin-gonic/gin"
"log" "log"
@@ -127,7 +125,7 @@ import (
func main() { func main() {
logger, _ := logging.NewLogger("server.log", nil) logger, _ := logging.NewLogger("server.log", nil)
accessHandler, err := handlers.NewAccessHandler("access.db", logger) accessHandler, err := NewAccessHandler("access.db", logger)
if err != nil { if err != nil {
log.Fatal(err) log.Fatal(err)
} }

View File

@@ -1,33 +1,35 @@
package handlers package AccessHandler
import "gitea.tecamino.com/paadi/tecamino-logger/logging" import (
"gitea.tecamino.com/paadi/dbHandler"
"gitea.tecamino.com/paadi/tecamino-logger/logging"
)
//
// AccessHandler // AccessHandler
// //
// Description: // Description:
//
// AccessHandler manages access-related functionality, including // AccessHandler manages access-related functionality, including
// database operations for users and roles, as well as logging. // database operations for users and roles, as well as logging.
// It encapsulates a database handler and a logger so that // It encapsulates a database handler and a logger so that
// authentication and authorization operations can be performed // authentication and authorization operations can be performed
// consistently across the application. // consistently across the application.
//
type AccessHandler struct { type AccessHandler struct {
dbHandler *DBHandler // Database handler used for managing users and roles dbHandler *dbHandler.DBHandler // Database handler used for managing users and roles
logger *logging.Logger // Centralized application logger logger *logging.Logger // Centralized application logger
} }
//
// NewAccessHandler // NewAccessHandler
// //
// Description: // Description:
//
// Creates and initializes a new AccessHandler instance. // Creates and initializes a new AccessHandler instance.
// //
// Behavior: // Behavior:
// 1. If a logger is not provided (nil), it creates a new logger instance // 1. If a logger is not provided (nil), it creates a new logger instance
// that writes to "accessHandler.log". // that writes to "accessHandler.log".
// 2. Initializes the AccessHandler struct. // 2. Initializes the AccessHandler struct.
// 3. Sets up the internal DBHandler with the same logger. // 3. Sets up the internal DBAHandler with the same logger.
// 4. Automatically creates required database tables and default data: // 4. Automatically creates required database tables and default data:
// - User table // - User table
// - Default user(s) // - Default user(s)
@@ -35,7 +37,7 @@ type AccessHandler struct {
// - Default role(s) // - Default role(s)
// //
// Parameters: // Parameters:
// - dbPath: The file path or connection string for the database. // - dbPath: The file path to the database.
// - logger: Optional pointer to a logging.Logger instance. If nil, a new one is created. // - logger: Optional pointer to a logging.Logger instance. If nil, a new one is created.
// //
// Returns: // Returns:
@@ -43,12 +45,12 @@ type AccessHandler struct {
// - err: Any error that occurs during initialization. // - err: Any error that occurs during initialization.
// //
// Example: // Example:
// handler, err := handlers.NewAccessHandler("data/app.db", appLogger) //
// handler, err := NewAccessHandler("data/app.db", appLogger)
// if err != nil { // if err != nil {
// log.Fatal(err) // log.Fatal(err)
// } // }
// func NewAccessHandler(path string, logger *logging.Logger) (aH *AccessHandler, err error) {
func NewAccessHandler(dbPath string, logger *logging.Logger) (aH *AccessHandler, err error) {
if logger == nil { if logger == nil {
logger, err = logging.NewLogger("accessHandler.log", nil) logger, err = logging.NewLogger("accessHandler.log", nil)
if err != nil { if err != nil {
@@ -65,7 +67,7 @@ func NewAccessHandler(dbPath string, logger *logging.Logger) (aH *AccessHandler,
logger.Debug("NewAccessHandler", "initialize db handler") logger.Debug("NewAccessHandler", "initialize db handler")
// Create a new DB handler instance // Create a new DB handler instance
aH.dbHandler, err = NewDBHandler(dbPath, logger) aH.dbHandler, err = dbHandler.NewDBHandler(path, "user", logger)
if err != nil { if err != nil {
aH.logger.Error("NewAccessHandler", err) aH.logger.Error("NewAccessHandler", err)
return return
@@ -105,10 +107,10 @@ func NewAccessHandler(dbPath string, logger *logging.Logger) (aH *AccessHandler,
return return
} }
//
// GetLogger // GetLogger
// //
// Description: // Description:
//
// Returns the logger associated with this AccessHandler instance. // Returns the logger associated with this AccessHandler instance.
// Useful when another component or handler needs to reuse the // Useful when another component or handler needs to reuse the
// same logging instance for consistent log output. // same logging instance for consistent log output.
@@ -117,9 +119,9 @@ func NewAccessHandler(dbPath string, logger *logging.Logger) (aH *AccessHandler,
// - *logging.Logger: The logger assigned to this AccessHandler. // - *logging.Logger: The logger assigned to this AccessHandler.
// //
// Example: // Example:
//
// log := accessHandler.GetLogger() // log := accessHandler.GetLogger()
// log.Info("Some event") // log.Info("Some event")
//
func (aH *AccessHandler) GetLogger() *logging.Logger { func (aH *AccessHandler) GetLogger() *logging.Logger {
return aH.logger return aH.logger
} }

158
accessHandlerAPI.go Normal file
View File

@@ -0,0 +1,158 @@
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
}

296
api.go Normal file
View File

@@ -0,0 +1,296 @@
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
}
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.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
var roles []models.Role
role := c.Query("role")
id := c.Query("id")
if role != "" {
err = aH.dbHandler.GetByKey(&roles, "role", role, false)
} else if id != "" {
i, err = strconv.Atoi(id)
if err != nil {
c.JSON(http.StatusBadRequest, gin.H{
"message": err.Error(),
})
return
}
err = aH.dbHandler.GetById(&roles, uint(i))
}
if err != nil {
aH.logger.Error("GetRole", err)
c.JSON(http.StatusInternalServerError, nil)
return
}
c.JSON(http.StatusOK, roles)
}
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) {
queryRole := c.Query("role")
if queryRole == "" || queryRole == "null" || queryRole == "undefined" {
aH.logger.Error("DeleteRole", "id query missing or wrong value: "+queryRole)
c.JSON(http.StatusInternalServerError, nil)
return
}
var request struct {
Roles []string `json:"roles"`
}
err := c.BindJSON(&request)
if err != nil {
aH.logger.Error("DeleteRole", err)
c.JSON(http.StatusBadRequest, nil)
return
}
if len(request.Roles) == 0 {
aH.logger.Error("DeleteRole", "no ids given to be deleted")
c.JSON(http.StatusBadRequest, models.NewJsonMessageResponse("no roles given to be deleted"))
return
}
var ownRole string
for _, role := range request.Roles {
if queryRole == role {
ownRole = role
continue
}
err = aH.dbHandler.DeleteByKey(&models.Role{}, "role", role, false)
if err != nil {
aH.logger.Error("DeleteRole", err)
c.JSON(http.StatusInternalServerError, nil)
return
}
}
if ownRole != "" {
aH.logger.Error("DeleteRole", "can not delete logged in role id: "+ownRole)
c.JSON(http.StatusBadRequest, gin.H{
"message": "can not delete logged in role id: " + ownRole,
"role": ownRole,
})
return
}
c.JSON(http.StatusOK, gin.H{
"message": "role(s) deleted",
})
}

View File

@@ -1,4 +1,4 @@
package accessmanager_test package AccessHandler
import ( import (
"bytes" "bytes"
@@ -7,8 +7,7 @@ import (
"net/http/httptest" "net/http/httptest"
"testing" "testing"
"gitea.tecamino.com/paadi/AccessHandler/handlers" "gitea.tecamino.com/paadi/access-handler/models"
"gitea.tecamino.com/paadi/AccessHandler/models"
"github.com/gin-gonic/gin" "github.com/gin-gonic/gin"
"github.com/go-playground/assert/v2" "github.com/go-playground/assert/v2"
@@ -18,7 +17,7 @@ func TestAccesshandlerLogin(t *testing.T) {
t.Log("start access handler test") t.Log("start access handler test")
t.Log("initialize accessHandler") t.Log("initialize accessHandler")
accessHandler, err := handlers.NewAccessHandler("test.db", nil) accessHandler, err := NewAccessHandler(".", nil)
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
} }
@@ -100,20 +99,20 @@ func TestLoginHandler(t *testing.T) {
gin.SetMode(gin.TestMode) gin.SetMode(gin.TestMode)
// Setup your AccessHandler and router // Setup your AccessHandler and router
aH, err := handlers.NewAccessHandler("test.db", nil) aH, err := NewAccessHandler(".", nil)
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
} }
r := gin.Default() r := gin.Default()
handlers.SetMiddlewareLogger(r, aH.GetLogger()) SetMiddlewareLogger(r, aH.GetLogger())
r.POST("/login", aH.Login) r.POST("/login", aH.Login)
r.POST("/login/refresh", aH.Refresh) r.POST("/login/refresh", aH.Refresh)
r.GET("/login/me", aH.Me) r.GET("/login/me", aH.Me)
r.GET("/logout", aH.Logout) r.GET("/logout", aH.Logout)
middleware := r.Group("", handlers.AuthMiddleware()) middleware := r.Group("", aH.AuthMiddleware())
auth := middleware.Group("/members", aH.AuthorizeRole("")) auth := middleware.Group("/members", aH.AuthorizeRole(""))
auth.GET("", func(ctx *gin.Context) { auth.GET("", func(ctx *gin.Context) {

7
go.mod
View File

@@ -1,15 +1,14 @@
module gitea.tecamino.com/paadi/AccessHandler module gitea.tecamino.com/paadi/access-handler
go 1.24.5 go 1.24.5
require ( require (
gitea.tecamino.com/paadi/dbHandler v1.0.2
gitea.tecamino.com/paadi/tecamino-logger v0.2.1 gitea.tecamino.com/paadi/tecamino-logger v0.2.1
github.com/gin-gonic/gin v1.11.0 github.com/gin-gonic/gin v1.11.0
github.com/glebarez/sqlite v1.11.0
github.com/go-playground/assert/v2 v2.2.0 github.com/go-playground/assert/v2 v2.2.0
github.com/golang-jwt/jwt/v5 v5.3.0 github.com/golang-jwt/jwt/v5 v5.3.0
golang.org/x/crypto v0.43.0 golang.org/x/crypto v0.43.0
gorm.io/gorm v1.31.0
) )
require ( require (
@@ -20,6 +19,7 @@ require (
github.com/gabriel-vasile/mimetype v1.4.8 // indirect github.com/gabriel-vasile/mimetype v1.4.8 // indirect
github.com/gin-contrib/sse v1.1.0 // indirect github.com/gin-contrib/sse v1.1.0 // indirect
github.com/glebarez/go-sqlite v1.21.2 // indirect github.com/glebarez/go-sqlite v1.21.2 // indirect
github.com/glebarez/sqlite v1.11.0 // indirect
github.com/go-playground/locales v0.14.1 // indirect github.com/go-playground/locales v0.14.1 // indirect
github.com/go-playground/universal-translator v0.18.1 // indirect github.com/go-playground/universal-translator v0.18.1 // indirect
github.com/go-playground/validator/v10 v10.27.0 // indirect github.com/go-playground/validator/v10 v10.27.0 // indirect
@@ -52,6 +52,7 @@ require (
golang.org/x/tools v0.37.0 // indirect golang.org/x/tools v0.37.0 // indirect
google.golang.org/protobuf v1.36.9 // indirect google.golang.org/protobuf v1.36.9 // indirect
gopkg.in/natefinch/lumberjack.v2 v2.2.1 // indirect gopkg.in/natefinch/lumberjack.v2 v2.2.1 // indirect
gorm.io/gorm v1.31.0 // indirect
modernc.org/libc v1.22.5 // indirect modernc.org/libc v1.22.5 // indirect
modernc.org/mathutil v1.5.0 // indirect modernc.org/mathutil v1.5.0 // indirect
modernc.org/memory v1.5.0 // indirect modernc.org/memory v1.5.0 // indirect

2
go.sum
View File

@@ -1,3 +1,5 @@
gitea.tecamino.com/paadi/dbHandler v1.0.2 h1:5d3sWIFY6JQLX0PGSTsxcvZFCSNTgtx4lHTX5lwF2H8=
gitea.tecamino.com/paadi/dbHandler v1.0.2/go.mod h1:y/xn/POJg1DO++67uKvnO23lJQgh+XFQq7HZCS9Getw=
gitea.tecamino.com/paadi/tecamino-logger v0.2.1 h1:sQTBKYPdzn9mmWX2JXZBtGBvNQH7cuXIwsl4TD0aMgE= gitea.tecamino.com/paadi/tecamino-logger v0.2.1 h1:sQTBKYPdzn9mmWX2JXZBtGBvNQH7cuXIwsl4TD0aMgE=
gitea.tecamino.com/paadi/tecamino-logger v0.2.1/go.mod h1:FkzRTldUBBOd/iy2upycArDftSZ5trbsX5Ira5OzJgM= gitea.tecamino.com/paadi/tecamino-logger v0.2.1/go.mod h1:FkzRTldUBBOd/iy2upycArDftSZ5trbsX5Ira5OzJgM=
github.com/bytedance/sonic v1.14.0 h1:/OfKt8HFw0kh2rj8N0F6C/qPGRESq0BbaNZgcNXXzQQ= github.com/bytedance/sonic v1.14.0 h1:/OfKt8HFw0kh2rj8N0F6C/qPGRESq0BbaNZgcNXXzQQ=

View File

@@ -1,300 +0,0 @@
package handlers
import (
"errors"
"fmt"
"reflect"
"strings"
"gitea.tecamino.com/paadi/tecamino-logger/logging"
"github.com/glebarez/sqlite"
"gorm.io/gorm"
)
// DBHandler
//
// Description:
//
// Wraps the GORM database connection and provides helper methods for
// common CRUD operations, as well as integrated logging for traceability.
//
// Fields:
// - db: Active GORM database connection.
// - logger: Pointer to a custom logger instance for structured logging.
type DBHandler struct {
db *gorm.DB
logger *logging.Logger
}
// NewDBHandler
//
// Description:
//
// Creates a new database handler using the specified SQLite database file.
//
// Behavior:
// 1. Opens a GORM connection to the database file at `dbPath`.
// 2. Wraps it in a `DBHandler` struct with logging support.
//
// Parameters:
// - dbPath: Path to the SQLite database file.
// - logger: Logging instance to record DB operations.
//
// Returns:
// - dH: A pointer to the initialized `DBHandler`.
// - err: Any error encountered during database connection.
func NewDBHandler(dbPath string, logger *logging.Logger) (dH *DBHandler, err error) {
dH = &DBHandler{logger: logger}
logger.Debug("NewDBHandler", "open database "+dbPath)
dH.db, err = gorm.Open(sqlite.Open(dbPath), &gorm.Config{})
return
}
// addNewTable
//
// Description:
//
// Uses GORMs `AutoMigrate` to create or update the database schema
// for the provided model type.
//
// Parameters:
// - model: Struct type representing the database table schema.
//
// Returns:
// - error: Any migration error encountered.
func (dH *DBHandler) addNewTable(model any) error {
return dH.db.AutoMigrate(&model)
}
// addNewColum
//
// Description:
//
// Inserts a new record into the database table corresponding to `model`.
//
// Parameters:
// - model: Struct instance containing values to be inserted.
//
// Returns:
// - error: Any error encountered during record creation.
func (dH *DBHandler) addNewColum(model any) error {
return dH.db.Create(model).Error
}
// getById
//
// Description:
//
// Retrieves a record (or all records) from a table by numeric ID.
//
// Behavior:
// - If `id == 0`, returns all records in the table.
// - Otherwise, fetches the record matching the given ID.
//
// Parameters:
// - model: Pointer to a slice or struct to store the result.
// - id: Numeric ID to query by.
//
// Returns:
// - error: Any query error or “not found” message.
func (dH *DBHandler) getById(model any, id uint) error {
dH.logger.Debug("getById", "find id "+fmt.Sprint(id))
if id == 0 {
return dH.db.Find(model).Error
}
err := dH.db.First(model, id).Error
if errors.Is(err, gorm.ErrRecordNotFound) {
return fmt.Errorf("no record found for id: %v", id)
} else if err != nil {
return fmt.Errorf("query failed: %w", err)
}
return nil
}
// getByKey
//
// Description:
//
// Retrieves one or more records matching a key/value pair.
//
// Behavior:
// - If `LikeSearch` is true, performs a SQL LIKE query.
// - Otherwise, performs an exact match query.
//
// Parameters:
// - model: Pointer to a slice or struct to store results.
// - key: Column name (e.g., "email").
// - value: Value to match or partially match.
// - LikeSearch: If true, replaces '*' with '%' for wildcard matching.
//
// Returns:
// - error: Any database query error.
func (dH *DBHandler) getByKey(model any, key string, value any, LikeSearch bool) error {
if LikeSearch {
value = strings.ReplaceAll(fmt.Sprint(value), "*", "%")
dH.logger.Debug("getByKey", "find like key "+key+" value "+fmt.Sprint(value))
return dH.db.Where(key+" LIKE ?", value).Find(model).Error
}
dH.logger.Debug("getByKey", "find equal key "+key+" value "+fmt.Sprint(value))
return dH.db.Find(model, key+" = ?", value).Error
}
// updateValuesById
//
// Description:
//
// Updates record fields based on their unique ID.
//
// Behavior:
// 1. Confirms that `model` is a pointer to a struct.
// 2. Fetches the record by ID.
// 3. Updates all non-zero fields using `gorm.Model.Updates`.
//
// Parameters:
// - model: Pointer to struct containing new values.
// - id: Numeric ID of the record to update.
//
// Returns:
// - error: If the model is invalid or query/update fails.
func (dH *DBHandler) updateValuesById(model any, id uint) error {
dH.logger.Debug("updateValuesById", "model"+fmt.Sprint(model))
modelType := reflect.TypeOf(model)
if modelType.Kind() != reflect.Ptr {
return errors.New("model must be a pointer to struct")
}
lookUpModel := reflect.New(modelType.Elem()).Interface()
if err := dH.getById(lookUpModel, id); err != nil {
return err
}
return dH.db.Model(lookUpModel).Updates(model).Error
}
// updateValuesByKey
//
// Description:
//
// Updates records based on a key/value match.
//
// Behavior:
// 1. Confirms model type.
// 2. Fetches the matching record(s) using `getByKey`.
// 3. Updates all non-zero fields.
//
// Parameters:
// - model: Pointer to struct containing updated values.
// - key: Column name to filter by.
// - value: Value to match.
//
// Returns:
// - error: Any query or update error.
func (dH *DBHandler) updateValuesByKey(model any, key string, value any) error {
dH.logger.Debug("updateValuesByKey", "model"+fmt.Sprint(model))
modelType := reflect.TypeOf(model)
if modelType.Kind() != reflect.Ptr {
return errors.New("model must be a pointer to struct")
}
lookUpModel := reflect.New(modelType.Elem()).Interface()
if err := dH.getByKey(lookUpModel, key, value, false); err != nil {
return err
}
return dH.db.Model(lookUpModel).Updates(model).Error
}
// deleteById
//
// Description:
//
// Deletes records by their ID(s).
//
// Behavior:
// - If the first ID == 0, all records in the table are deleted.
// - Otherwise, deletes the provided IDs.
//
// Parameters:
// - model: Model struct type representing the table.
// - id: Variadic list of IDs to delete.
//
// Returns:
// - error: Any deletion error.
func (dH *DBHandler) deleteById(model any, id ...uint) error {
if id[0] == 0 {
dH.logger.Debug("deleteById", "delete all")
return dH.db.Where("1 = 1").Delete(model).Error
}
dH.logger.Debug("deleteById", "delete ids"+fmt.Sprint(id))
if err := dH.exists(model, "id", id, false); err != nil {
return err
}
return dH.db.Delete(model, id).Error
}
// deleteByKey
//
// Description:
//
// Deletes records that match a key/value pair.
//
// Behavior:
// - Supports LIKE queries if `LikeSearch` is true.
//
// Parameters:
// - model: Model struct type representing the table.
// - key: Column name to filter by.
// - value: Value to match.
// - LikeSearch: Whether to use wildcard search.
//
// Returns:
// - error: Any deletion error.
func (dH *DBHandler) deleteByKey(model any, key string, value any, LikeSearch bool) error {
if LikeSearch {
value = strings.ReplaceAll(fmt.Sprint(value), "*", "%")
dH.logger.Debug("deleteByKey", "delete like key "+key+" value "+fmt.Sprint(value))
return dH.db.Where(key+" LIKE ?", value).Delete(model).Error
}
dH.logger.Debug("deleteByKey", "delete equal key "+key+" value "+fmt.Sprint(value))
return dH.db.Where(key+" = ?", value).Delete(model).Error
}
// exists
//
// Description:
//
// Checks whether a record exists matching the specified key/value filter.
//
// Behavior:
// - Performs a `First` query on the database.
// - If `LikeSearch` is true, performs a LIKE query.
// - Returns an error if the record does not exist or query fails.
//
// Parameters:
// - model: Model struct type to search.
// - key: Column name to filter by.
// - value: Value to match.
// - LikeSearch: Whether to use wildcard search.
//
// Returns:
// - error: “no record found” or DB error.
func (dH *DBHandler) exists(model any, key string, value any, LikeSearch bool) (err error) {
if LikeSearch {
value = strings.ReplaceAll(fmt.Sprint(value), "*", "%")
key = key + " LIKE ?"
} else {
key = key + " = ?"
}
dH.logger.Debug("exists", "check if exists key "+key+" value "+fmt.Sprint(value))
err = dH.db.Where(key, value).First(model).Error
if errors.Is(err, gorm.ErrRecordNotFound) {
return fmt.Errorf("no record found for %s %v", key[:len(key)-1], value)
} else if err != nil {
return fmt.Errorf("query failed: %w", err)
}
return
}

View File

@@ -1,4 +1,4 @@
package handlers package AccessHandler
import ( import (
"fmt" "fmt"
@@ -6,8 +6,8 @@ import (
"net/http" "net/http"
"time" "time"
"gitea.tecamino.com/paadi/AccessHandler/models" "gitea.tecamino.com/paadi/access-handler/models"
"gitea.tecamino.com/paadi/AccessHandler/utils" "gitea.tecamino.com/paadi/access-handler/utils"
"github.com/gin-gonic/gin" "github.com/gin-gonic/gin"
"github.com/golang-jwt/jwt/v5" "github.com/golang-jwt/jwt/v5"

227
loginApi.go Normal file
View File

@@ -0,0 +1,227 @@
package AccessHandler
import (
"fmt"
"log"
"net/http"
"time"
"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"
)
// -----------------------------
// 🧠 HANDLERS
// -----------------------------
// Login authenticates a user and returns JWT tokens (access + refresh).
func (aH *AccessHandlerAPI) Login(c *gin.Context) {
var user models.User
aH.logger.Debug("Login", "bind JSON request")
if err := c.BindJSON(&user); err != nil {
aH.logger.Error("Login", err)
c.JSON(http.StatusBadRequest, models.NewJsonErrorResponse(err))
return
}
// Validate input
if !user.IsValid() {
aH.logger.Error("Login", "user empty")
c.JSON(http.StatusBadRequest, models.NewJsonMessageResponse("user empty"))
return
}
// Fetch user record from DB
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))
return
}
if len(dbRecord) > 1 {
log.Println("multiple users found")
aH.logger.Error("Login", "more than one record found")
c.JSON(http.StatusInternalServerError, models.NewJsonMessageResponse("internal error"))
return
}
// Check password
if !utils.CheckPassword(user.Password, dbRecord[0].Password) {
aH.logger.Error("Login", "invalid password")
c.JSON(http.StatusUnauthorized, models.NewJsonMessageResponse("invalid credentials"))
return
}
user = dbRecord[0]
// -----------------------------
// 🔑 TOKEN CREATION
// -----------------------------
aH.logger.Debug("Login", "create tokens")
accessTokenExp := time.Now().Add(ACCESS_TOKEN_TIME)
refreshTokenExp := time.Now().Add(REFRESH_TOKEN_TIME)
// Create access token
accessToken := jwt.NewWithClaims(jwt.SigningMethodHS256, jwt.MapClaims{
"id": user.Id,
"username": user.Name,
"role": user.Role,
"type": "access",
"exp": accessTokenExp.Unix(),
})
// Create refresh token
refreshToken := jwt.NewWithClaims(jwt.SigningMethodHS256, jwt.MapClaims{
"id": user.Id,
"username": user.Name,
"role": user.Role,
"type": "refresh",
"exp": refreshTokenExp.Unix(),
})
// Sign tokens
accessString, err := accessToken.SignedString(ACCESS_SECRET)
if err != nil {
aH.logger.Error("Login", "failed to sign access token")
c.JSON(http.StatusInternalServerError, models.NewJsonMessageResponse("could not create access token"))
return
}
refreshString, err := refreshToken.SignedString(REFRESH_SECRET)
if err != nil {
aH.logger.Error("Login", "failed to sign refresh token")
c.JSON(http.StatusInternalServerError, models.NewJsonMessageResponse("could not create refresh token"))
return
}
// -----------------------------
// 🍪 SET COOKIES
// -----------------------------
aH.logger.Debug("Login", "set cookies")
secure := gin.Mode() == gin.ReleaseMode
c.SetCookie("access_token", accessString, int(time.Until(accessTokenExp).Seconds()),
"/", "", secure, true)
c.SetCookie("refresh_token", refreshString, int(time.Until(refreshTokenExp).Seconds()),
"/", "", secure, true)
aH.logger.Info("Login", "user "+user.Name+" logged in successfully")
c.JSON(http.StatusOK, gin.H{
"message": "login successful",
"id": user.Id,
"user": user.Name,
"role": user.Role,
"settings": user.Settings,
})
}
// Refresh generates a new access token from a valid refresh token.
func (aH *AccessHandlerAPI) Refresh(c *gin.Context) {
aH.logger.Debug("Refresh", "get refresh cookie")
refreshCookie, err := c.Cookie("refresh_token")
if err != nil {
aH.logger.Error("Refresh", "no refresh token")
c.JSON(http.StatusUnauthorized, gin.H{"message": "no refresh token"})
return
}
// Validate token
aH.logger.Debug("Refresh", "parse token")
token, err := jwt.Parse(refreshCookie, func(token *jwt.Token) (any, error) {
if _, ok := token.Method.(*jwt.SigningMethodHMAC); !ok {
return nil, fmt.Errorf("unexpected signing method: %v", token.Header["alg"])
}
return REFRESH_SECRET, nil
})
if err != nil || !token.Valid {
aH.logger.Error("Refresh", err)
c.JSON(http.StatusUnauthorized, gin.H{"message": "invalid refresh token"})
return
}
// Extract claims
claims, ok := token.Claims.(jwt.MapClaims)
if !ok || claims["type"] != "refresh" {
aH.logger.Error("Refresh", "invalid token type")
c.JSON(http.StatusUnauthorized, gin.H{"message": "invalid token type"})
return
}
username := claims["username"].(string)
id := int(claims["id"].(float64))
role := claims["role"].(string)
// Create new access token
aH.logger.Debug("Refresh", "create new access token")
accessExp := time.Now().Add(ACCESS_TOKEN_TIME)
newAccess := jwt.NewWithClaims(jwt.SigningMethodHS256, jwt.MapClaims{
"id": id,
"username": username,
"role": role,
"exp": accessExp.Unix(),
})
accessString, _ := newAccess.SignedString(ACCESS_SECRET)
// Set new access cookie
aH.logger.Debug("Refresh", "set new access cookie")
c.SetCookie("access_token", accessString, int(time.Until(accessExp).Seconds()),
"/", DOMAIN, gin.Mode() == gin.ReleaseMode, true)
c.JSON(http.StatusOK, gin.H{"message": "token refreshed"})
}
// Me returns information about the currently authenticated user.
func (aH *AccessHandlerAPI) Me(c *gin.Context) {
aH.logger.Debug("Me", "get access cookie")
cookie, err := c.Cookie("access_token")
if err != nil {
aH.logger.Error("Me", err)
c.JSON(http.StatusUnauthorized, gin.H{"message": "not logged in"})
return
}
// Parse and validate access token
aH.logger.Debug("Me", "parse token")
token, err := jwt.Parse(cookie, func(t *jwt.Token) (any, error) {
if _, ok := t.Method.(*jwt.SigningMethodHMAC); !ok {
return nil, fmt.Errorf("unexpected signing method: %v", t.Header["alg"])
}
return ACCESS_SECRET, nil
})
if err != nil || !token.Valid {
aH.logger.Error("Me", err)
c.JSON(http.StatusUnauthorized, gin.H{"message": "invalid token"})
return
}
claims := token.Claims.(jwt.MapClaims)
c.JSON(http.StatusOK, gin.H{
"id": claims["id"],
"user": claims["username"],
"role": claims["role"],
})
}
// Logout clears authentication cookies and ends the session.
func (aH *AccessHandlerAPI) Logout(c *gin.Context) {
aH.logger.Info("Logout", "logout user")
secure := gin.Mode() == gin.ReleaseMode
aH.logger.Debug("Logout", fmt.Sprintf("domain=%s secure=%t", DOMAIN, secure))
// Clear cookies
c.SetCookie("access_token", "", -1, "/", DOMAIN, secure, true)
c.SetCookie("refresh_token", "", -1, "/", DOMAIN, secure, true)
c.JSON(http.StatusOK, gin.H{"message": "logged out"})
}

View File

@@ -1,4 +1,4 @@
package handlers package AccessHandler
import ( import (
"fmt" "fmt"
@@ -27,7 +27,7 @@ import (
// //
// Usage: // Usage:
// //
// handlers.SetMiddlewareLogger(router, logger) // SetMiddlewareLogger(router, logger)
func SetMiddlewareLogger(r *gin.Engine, logger *logging.Logger) { func SetMiddlewareLogger(r *gin.Engine, logger *logging.Logger) {
// Add middleware that injects logger into context // Add middleware that injects logger into context
r.Use(func(c *gin.Context) { r.Use(func(c *gin.Context) {
@@ -55,8 +55,8 @@ func SetMiddlewareLogger(r *gin.Engine, logger *logging.Logger) {
// //
// Usage: // Usage:
// //
// r.Use(handlers.AuthMiddleware()) // r.Use(AuthMiddleware())
func AuthMiddleware() gin.HandlerFunc { func (aH *AccessHandler) AuthMiddleware() gin.HandlerFunc {
return func(c *gin.Context) { return func(c *gin.Context) {
// Retrieve logger from Gin context // Retrieve logger from Gin context
middlewareLogger, ok := c.Get("logger") middlewareLogger, ok := c.Get("logger")

167
middlewareApi.go Normal file
View File

@@ -0,0 +1,167 @@
package AccessHandler
import (
"fmt"
"log"
"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"
)
// SetMiddlewareLogger
//
// Description:
//
// Registers a Gin middleware that attaches a custom logger instance
// to every incoming request via the Gin context. This allows other
// middleware and handlers to access the logger using:
//
// logger := c.MustGet("logger").(*logging.Logger)
//
// Parameters:
// - r: The Gin engine to which the middleware is applied.
// - logger: A pointer to the application's custom logger.
//
// Usage:
//
// SetMiddlewareLogger(router, logger)
func (aH *AccessHandlerAPI) SetMiddlewareLogger(r *gin.Engine, logger *logging.Logger) {
// Add middleware that injects logger into context
r.Use(func(c *gin.Context) {
c.Set("logger", logger)
c.Next()
})
}
// AuthMiddleware
//
// Description:
//
// A Gin middleware that performs authentication using a JWT token stored
// in a cookie named "access_token". It validates the token and extracts
// the user's role from the claims, storing it in the Gin context.
//
// Behavior:
// - Requires that SetMiddlewareLogger was used earlier to inject the logger.
// - If the JWT cookie is missing or invalid, it aborts the request with
// an appropriate HTTP error (401 or 500).
//
// Returns:
//
// A Gin handler function that can be used as middleware.
//
// Usage:
//
// r.Use(AuthMiddleware())
func (aH *AccessHandlerAPI) AuthMiddleware() gin.HandlerFunc {
return func(c *gin.Context) {
// Retrieve logger from Gin context
middlewareLogger, ok := c.Get("logger")
if !ok {
log.Fatal("middleware logger not set — use SetMiddlewareLogger first")
c.AbortWithStatusJSON(http.StatusInternalServerError, http.StatusInternalServerError)
return
}
logger := middlewareLogger.(*logging.Logger)
// Read access token from cookie
cookie, err := c.Cookie("access_token")
if err != nil {
logger.Error("AuthMiddleware", err)
c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{"message": "not logged in"})
return
}
// Parse and validate JWT token
token, err := jwt.Parse(cookie, func(t *jwt.Token) (any, error) {
return ACCESS_SECRET, nil
})
if err != nil || !token.Valid {
logger.Error("AuthMiddleware", err)
c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{"message": "invalid token"})
return
}
// Extract custom claims (role)
if claims, ok := token.Claims.(jwt.MapClaims); ok {
role, _ := claims["role"].(string)
c.Set("role", role)
}
c.Next()
}
}
// (AccessHandler).AuthorizeRole
//
// Description:
//
// A role-based authorization middleware. It checks whether the authenticated
// user (based on the "role" set in AuthMiddleware) has permission to access
// the given route. The check is performed by comparing the requested URL
// path against the users allowed permissions.
//
// Parameters:
// - suffix: A URL prefix to trim from the request path before matching
// permissions (e.g., "/api/v1").
//
// Behavior:
// - Fetches the user role from Gin context.
// - Uses aH.GetRoleByKey() to retrieve role records and permissions.
// - Grants access (calls c.Next()) if a matching permission is found.
// - Denies access (401 Unauthorized) if no permission matches.
//
// Usage:
//
// router.GET("/secure/:id", aH.AuthorizeRole("/api/v1"))
func (aH *AccessHandlerAPI) AuthorizeRole(suffix string) gin.HandlerFunc {
return func(c *gin.Context) {
aH.logger.Debug("AuthorizeRole", "permission path of url path")
permissionPath := strings.TrimPrefix(c.Request.URL.Path, suffix+"/")
aH.logger.Debug("AuthorizeRole", "get set role")
role, ok := c.Get("role")
if !ok {
aH.logger.Error("AuthorizeRole", "no role set")
c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"message": http.StatusInternalServerError})
return
}
// Fetch roles and associated permissions from the database or store
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})
return
}
// Validate that a role was found
if len(roles) == 0 {
log.Println("not logged in")
aH.logger.Error("AuthorizeRole", "no logged in")
c.JSON(http.StatusUnauthorized, http.StatusUnauthorized)
return
} else if len(roles) > 1 {
aH.logger.Error("AuthorizeRole", "more than one record found")
c.JSON(http.StatusInternalServerError, http.StatusInternalServerError)
return
}
// Check permissions
for _, permission := range roles[0].Permissions {
fmt.Println(100, permissionPath, permission.Name)
if permission.Name == permissionPath {
c.Next()
return
}
}
// Access denied
aH.logger.Error("AuthorizeRole", "Forbidden")
c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{"message": "Forbidden"})
}
}

View File

@@ -5,3 +5,7 @@ type Role struct {
Role string `gorm:"column:role" json:"role"` Role string `gorm:"column:role" json:"role"`
Permissions Permissions `gorm:"type:json" json:"permissions"` Permissions Permissions `gorm:"type:json" json:"permissions"`
} }
func (r *Role) IsValid() bool {
return r.Role != ""
}

View File

@@ -1,9 +1,9 @@
package handlers package AccessHandler
import ( import (
"fmt" "fmt"
"gitea.tecamino.com/paadi/AccessHandler/models" "gitea.tecamino.com/paadi/access-handler/models"
) )
// AddRoleTable // AddRoleTable
@@ -19,7 +19,7 @@ import (
// Returns: // Returns:
// - error: Any database error encountered. // - error: Any database error encountered.
func (aH *AccessHandler) AddRoleTable() error { func (aH *AccessHandler) AddRoleTable() error {
return aH.dbHandler.addNewTable(models.Role{}) return aH.dbHandler.AddNewTable(models.Role{})
} }
// AddDefaultRole // AddDefaultRole
@@ -45,7 +45,7 @@ func (aH *AccessHandler) AddDefaultRole() (err error) {
role := "admin" role := "admin"
// Check if a role with this name already exists // Check if a role with this name already exists
if err := aH.dbHandler.exists(&models.Role{}, "role", role, false); err == nil { if err := aH.dbHandler.Exists(&models.Role{}, "role", role, false); err == nil {
// Found a role → skip creation // Found a role → skip creation
aH.logger.Debug("AddDefaultRole", "role "+role+" exists already") aH.logger.Debug("AddDefaultRole", "role "+role+" exists already")
return nil return nil
@@ -57,7 +57,7 @@ func (aH *AccessHandler) AddDefaultRole() (err error) {
permissions.DefaultPermissions() permissions.DefaultPermissions()
// Create the default admin role // Create the default admin role
aH.dbHandler.addNewColum(&models.Role{ aH.dbHandler.AddNewColum(&models.Role{
Role: role, Role: role,
Permissions: permissions, Permissions: permissions,
}) })
@@ -82,13 +82,13 @@ func (aH *AccessHandler) AddDefaultRole() (err error) {
// - error: If the role already exists or insertion fails. // - error: If the role already exists or insertion fails.
func (aH *AccessHandler) AddNewRole(role string, permissions models.Permissions) (err error) { func (aH *AccessHandler) AddNewRole(role string, permissions models.Permissions) (err error) {
// Check if a role with this name already exists // Check if a role with this name already exists
if err := aH.dbHandler.exists(&models.Role{}, "role", role, false); err == nil { if err := aH.dbHandler.Exists(&models.Role{}, "role", role, false); err == nil {
// Found a role → skip creation // Found a role → skip creation
return fmt.Errorf("role with name %s already exists", role) return fmt.Errorf("role with name %s already exists", role)
} }
// Insert new role with provided permissions // Insert new role with provided permissions
aH.dbHandler.addNewColum(&models.Role{ aH.dbHandler.AddNewColum(&models.Role{
Role: role, Role: role,
Permissions: permissions, Permissions: permissions,
}) })
@@ -108,7 +108,7 @@ func (aH *AccessHandler) AddNewRole(role string, permissions models.Permissions)
// - roles: A slice containing the matched role (usually length 1). // - roles: A slice containing the matched role (usually length 1).
// - err: Any database error encountered. // - err: Any database error encountered.
func (aH *AccessHandler) GetRoleById(id uint) (roles []models.Role, err error) { func (aH *AccessHandler) GetRoleById(id uint) (roles []models.Role, err error) {
err = aH.dbHandler.getById(&roles, id) err = aH.dbHandler.GetById(&roles, id)
return return
} }
@@ -127,7 +127,7 @@ func (aH *AccessHandler) GetRoleById(id uint) (roles []models.Role, err error) {
// - roles: A list of matched roles. // - roles: A list of matched roles.
// - err: Any database error encountered. // - err: Any database error encountered.
func (aH *AccessHandler) GetRoleByKey(key string, value any, likeSearch bool) (roles []models.Role, err error) { func (aH *AccessHandler) GetRoleByKey(key string, value any, likeSearch bool) (roles []models.Role, err error) {
err = aH.dbHandler.getByKey(&roles, key, value, likeSearch) err = aH.dbHandler.GetByKey(&roles, key, value, likeSearch)
return return
} }
@@ -144,7 +144,7 @@ func (aH *AccessHandler) GetRoleByKey(key string, value any, likeSearch bool) (r
// Returns: // Returns:
// - error: Any database error encountered. // - error: Any database error encountered.
func (aH *AccessHandler) UpdateRoleById(id uint, role models.Role) error { func (aH *AccessHandler) UpdateRoleById(id uint, role models.Role) error {
return aH.dbHandler.updateValuesById(&role, id) return aH.dbHandler.UpdateValuesById(&role, id)
} }
// UpdateRoleByKey // UpdateRoleByKey
@@ -161,7 +161,7 @@ func (aH *AccessHandler) UpdateRoleById(id uint, role models.Role) error {
// Returns: // Returns:
// - error: Any database error encountered. // - error: Any database error encountered.
func (aH *AccessHandler) UpdateRoleByKey(role models.Role, key string, value any) error { func (aH *AccessHandler) UpdateRoleByKey(role models.Role, key string, value any) error {
return aH.dbHandler.updateValuesByKey(&role, key, value) return aH.dbHandler.UpdateValuesByKey(&role, key, value)
} }
// DeleteRoleById // DeleteRoleById
@@ -176,7 +176,7 @@ func (aH *AccessHandler) UpdateRoleByKey(role models.Role, key string, value any
// Returns: // Returns:
// - error: Any database error encountered during deletion. // - error: Any database error encountered during deletion.
func (aH *AccessHandler) DeleteRoleById(id uint) (err error) { func (aH *AccessHandler) DeleteRoleById(id uint) (err error) {
return aH.dbHandler.deleteById(&models.Role{}, id) return aH.dbHandler.DeleteById(&models.Role{}, id)
} }
// DeleteRoleByKey // DeleteRoleByKey
@@ -193,5 +193,5 @@ func (aH *AccessHandler) DeleteRoleById(id uint) (err error) {
// Returns: // Returns:
// - error: Any database error encountered. // - error: Any database error encountered.
func (aH *AccessHandler) DeleteRoleByKey(key string, value any, likeSearch bool) (err error) { func (aH *AccessHandler) DeleteRoleByKey(key string, value any, likeSearch bool) (err error) {
return aH.dbHandler.deleteByKey(&models.Role{}, key, value, likeSearch) return aH.dbHandler.DeleteByKey(&models.Role{}, key, value, likeSearch)
} }

View File

@@ -1,10 +1,10 @@
package handlers package AccessHandler
import ( import (
"fmt" "fmt"
"gitea.tecamino.com/paadi/AccessHandler/models" "gitea.tecamino.com/paadi/access-handler/models"
"gitea.tecamino.com/paadi/AccessHandler/utils" "gitea.tecamino.com/paadi/access-handler/utils"
) )
// AddUserTable // AddUserTable
@@ -20,7 +20,7 @@ import (
// Returns: // Returns:
// - error: Any database error that occurs while creating the table. // - error: Any database error that occurs while creating the table.
func (aH *AccessHandler) AddUserTable() error { func (aH *AccessHandler) AddUserTable() error {
return aH.dbHandler.addNewTable(models.User{}) return aH.dbHandler.AddNewTable(models.User{})
} }
// AddDefaultUser // AddDefaultUser
@@ -49,7 +49,7 @@ func (aH *AccessHandler) AddDefaultUser() (err error) {
email := "zuercher@tecamino.ch" email := "zuercher@tecamino.ch"
// Check if a user with this email already exists // Check if a user with this email already exists
if err := aH.dbHandler.exists(&models.User{}, "email", email, false); err == nil { if err := aH.dbHandler.Exists(&models.User{}, "email", email, false); err == nil {
aH.logger.Debug("AddDefaultUser", "user email "+email+" exists already") aH.logger.Debug("AddDefaultUser", "user email "+email+" exists already")
// Found a user → skip create // Found a user → skip create
return nil return nil
@@ -61,7 +61,7 @@ func (aH *AccessHandler) AddDefaultUser() (err error) {
settings.DefaultQuasarSettings() settings.DefaultQuasarSettings()
// Insert default admin user into the database // Insert default admin user into the database
aH.dbHandler.addNewColum(&models.User{ aH.dbHandler.AddNewColum(&models.User{
Name: name, Name: name,
Role: role, Role: role,
Email: email, Email: email,
@@ -92,7 +92,7 @@ func (aH *AccessHandler) AddDefaultUser() (err error) {
// - error: If the user already exists or if hashing/insertion fails. // - error: If the user already exists or if hashing/insertion fails.
func (aH *AccessHandler) AddNewUser(userName, email, password, role string) (err error) { func (aH *AccessHandler) AddNewUser(userName, email, password, role string) (err error) {
// Check if a user with this email already exists // Check if a user with this email already exists
if err := aH.dbHandler.exists(&models.User{}, "email", email, false); err == nil { if err := aH.dbHandler.Exists(&models.User{}, "email", email, false); err == nil {
// Found a user → skip create // Found a user → skip create
aH.logger.Error("AddNewUser", "user with email "+email+" already exists") aH.logger.Error("AddNewUser", "user with email "+email+" already exists")
return fmt.Errorf("user with email %s already exists", email) return fmt.Errorf("user with email %s already exists", email)
@@ -107,7 +107,7 @@ func (aH *AccessHandler) AddNewUser(userName, email, password, role string) (err
aH.logger.Debug("AddNewUser", "add new user "+userName+" with role "+role) aH.logger.Debug("AddNewUser", "add new user "+userName+" with role "+role)
// Insert the new user record // Insert the new user record
aH.dbHandler.addNewColum(&models.User{ aH.dbHandler.AddNewColum(&models.User{
Name: userName, Name: userName,
Role: role, Role: role,
Email: email, Email: email,
@@ -129,7 +129,7 @@ func (aH *AccessHandler) AddNewUser(userName, email, password, role string) (err
// - users: A slice containing the matched user (usually length 1). // - users: A slice containing the matched user (usually length 1).
// - err: Any database error encountered. // - err: Any database error encountered.
func (aH *AccessHandler) GetUserById(id uint) (users []models.User, err error) { func (aH *AccessHandler) GetUserById(id uint) (users []models.User, err error) {
err = aH.dbHandler.getById(&users, id) err = aH.dbHandler.GetById(&users, id)
return return
} }
@@ -148,7 +148,7 @@ func (aH *AccessHandler) GetUserById(id uint) (users []models.User, err error) {
// - users: A list of users that match the search criteria. // - users: A list of users that match the search criteria.
// - err: Any database error encountered. // - err: Any database error encountered.
func (aH *AccessHandler) GetUserByKey(key string, value any, likeSearch bool) (users []models.User, err error) { func (aH *AccessHandler) GetUserByKey(key string, value any, likeSearch bool) (users []models.User, err error) {
err = aH.dbHandler.getByKey(&users, key, value, likeSearch) err = aH.dbHandler.GetByKey(&users, key, value, likeSearch)
return return
} }
@@ -165,7 +165,7 @@ func (aH *AccessHandler) GetUserByKey(key string, value any, likeSearch bool) (u
// Returns: // Returns:
// - error: Any error encountered during the update. // - error: Any error encountered during the update.
func (aH *AccessHandler) UpdateUserById(id uint, user models.User) error { func (aH *AccessHandler) UpdateUserById(id uint, user models.User) error {
return aH.dbHandler.updateValuesById(&user, id) return aH.dbHandler.UpdateValuesById(&user, id)
} }
// UpdateUserByKey // UpdateUserByKey
@@ -182,7 +182,7 @@ func (aH *AccessHandler) UpdateUserById(id uint, user models.User) error {
// Returns: // Returns:
// - error: Any error encountered during the update. // - error: Any error encountered during the update.
func (aH *AccessHandler) UpdateUserByKey(user models.User, key string, value any) error { func (aH *AccessHandler) UpdateUserByKey(user models.User, key string, value any) error {
return aH.dbHandler.updateValuesByKey(&user, key, value) return aH.dbHandler.UpdateValuesByKey(&user, key, value)
} }
// DeleteUserById // DeleteUserById
@@ -197,7 +197,7 @@ func (aH *AccessHandler) UpdateUserByKey(user models.User, key string, value any
// Returns: // Returns:
// - error: Any database error encountered during deletion. // - error: Any database error encountered during deletion.
func (aH *AccessHandler) DeleteUserById(id uint) (err error) { func (aH *AccessHandler) DeleteUserById(id uint) (err error) {
return aH.dbHandler.deleteById(&models.User{}, id) return aH.dbHandler.DeleteById(&models.User{}, id)
} }
// DeleteUserByKey // DeleteUserByKey
@@ -214,5 +214,5 @@ func (aH *AccessHandler) DeleteUserById(id uint) (err error) {
// Returns: // Returns:
// - error: Any database error encountered during deletion. // - error: Any database error encountered during deletion.
func (aH *AccessHandler) DeleteUserByKey(key string, value any, likeSearch bool) (err error) { func (aH *AccessHandler) DeleteUserByKey(key string, value any, likeSearch bool) (err error) {
return aH.dbHandler.deleteByKey(&models.User{}, key, value, likeSearch) return aH.dbHandler.DeleteByKey(&models.User{}, key, value, likeSearch)
} }

8
utils/utils.go Normal file
View File

@@ -0,0 +1,8 @@
package utils
import "regexp"
func IsValidEmail(email string) bool {
re := regexp.MustCompile(`^[a-zA-Z0-9._%+\-]+@[a-zA-Z0-9.\-]+\.[a-zA-Z]{2,}$`)
return re.MatchString(email)
}