12 Commits

Author SHA1 Message Date
Adrian Zürcher
14968bfd4c replace static secrets with enviroment variables 2025-11-12 11:05:04 +01:00
Adrian Zürcher
f8e7b01a28 change member efault permission to 15 for import export permission 2025-11-12 09:02:27 +01:00
Adrian Zürcher
332a84aa57 add appName to user settings 2025-11-12 09:01:54 +01:00
Adrian Zürcher
e9fdea664f read role every refresh 2025-11-08 12:00:09 +01:00
Adrian Zürcher
7704fa9ecb new user expiration with user date format and never option 2025-11-08 11:27:45 +01:00
Adrian Zürcher
9a0019f3ad fix user defined exiration 2025-11-07 15:12:51 +01:00
Adrian Zürcher
0506ed6491 add new user defined user exiration 2025-11-07 13:51:58 +01:00
Adrian Zürcher
296c2e001d fix delete function 2025-11-07 08:19:20 +01:00
Adrian Zürcher
0c37d014a9 fix exist check 2025-11-07 08:06:54 +01:00
Adrian Zürcher
1f60813589 add new default permission 2025-11-06 14:03:13 +01:00
Adrian Zürcher
510d2df6b1 lift go mod versions 2025-10-31 08:13:48 +01:00
Adrian Zürcher
4670c93eff fix missing gin context (fixes #1) 2025-10-26 21:05:55 +01:00
11 changed files with 450 additions and 385 deletions

View File

@@ -1,10 +1,15 @@
package AccessHandler package AccessHandler
import ( import (
"os"
"gitea.tecamino.com/paadi/access-handler/handlers" "gitea.tecamino.com/paadi/access-handler/handlers"
"gitea.tecamino.com/paadi/tecamino-logger/logging" "gitea.tecamino.com/paadi/tecamino-logger/logging"
) )
func NewAccessHandler(path string, logger *logging.Logger) (aH *handlers.AccessHandler, err error) { func NewAccessHandler(path string, logger *logging.Logger) (aH *handlers.AccessHandler, err error) {
logger.Debug("NewAccessHandler", "get enviroment variables")
handlers.ACCESS_SECRET = []byte(os.Getenv("ACCESS_SECRET"))
handlers.REFRESH_SECRET = []byte(os.Getenv("REFRESH_SECRET"))
return handlers.NewAccessHandler(path, logger) return handlers.NewAccessHandler(path, logger)
} }

View File

@@ -3,8 +3,10 @@ package AccessHandler
import ( import (
"bytes" "bytes"
"encoding/json" "encoding/json"
"io"
"net/http" "net/http"
"net/http/httptest" "net/http/httptest"
"os"
"testing" "testing"
"gitea.tecamino.com/paadi/access-handler/models" "gitea.tecamino.com/paadi/access-handler/models"
@@ -13,7 +15,19 @@ import (
"github.com/go-playground/assert/v2" "github.com/go-playground/assert/v2"
) )
func TestAccesshandlerLogin(t *testing.T) { func TestDatabase(t *testing.T) {
// set enviroment variables
os.Setenv("ACCESS_SECRET", "12345678910111213141516171819202")
os.Setenv("REFRESH_SECRET", "9998979695949392919089888786858")
dbName := "user.db"
if _, err := os.Stat(dbName); err == nil {
t.Log("remove user.db to start test with empty database")
if err := os.Remove(dbName); err != nil {
t.Fatal(err)
}
}
t.Log("start access handler test") t.Log("start access handler test")
t.Log("initialize accessHandler") t.Log("initialize accessHandler")
@@ -22,39 +36,87 @@ func TestAccesshandlerLogin(t *testing.T) {
t.Fatal(err) t.Fatal(err)
} }
t.Log("add another user") r := gin.Default()
err = accessHandler.AddNewUser("guest", "guest@gmail.com", "passwordd1", "admin")
if err != nil { accessHandler.SetMiddlewareLogger(r)
t.Log(err)
r.POST("/users/add", accessHandler.AddUser)
r.GET("/users", accessHandler.GetUser)
r.GET("/roles", accessHandler.GetRole)
r.POST("/roles/add", accessHandler.AddRole)
type request struct {
Log string
Name string
Method string
Path string
Payload any
Cookie *http.Cookie
ignoreError bool
}
var requests []request
requests = append(requests,
request{Log: "add another user", Name: "add user", Method: "POST", Path: "/users/add", Payload: models.User{
Name: "guest",
Password: "passwordd1",
Role: "admin",
Email: "guest@gmail.com",
}, ignoreError: true},
request{Log: "Get all users", Name: "get all users", Method: "GET", Path: "/users"},
request{Log: "Get user id 1", Name: "get user id 1", Method: "GET", Path: "/users?id=1"},
request{Log: "Add new role", Name: "add new role", Method: "POST", Path: "/roles/add", Payload: models.Role{
Role: "testRole",
}, ignoreError: true},
request{Log: "Get all roles", Name: "get all roles", Method: "GET", Path: "/roles"},
request{Log: "Get all role id 1", Name: "get role id 1", Method: "GET", Path: "/roles?id=1"},
)
for _, request := range requests {
if request.Log != "" {
t.Log(request.Log)
}
var bodyReader io.Reader
if request.Payload != nil {
jsonBytes, _ := json.Marshal(request.Payload)
bodyReader = bytes.NewBuffer(jsonBytes)
}
req, _ := http.NewRequest(request.Method, request.Path, bodyReader)
if request.Cookie != nil {
req.AddCookie(request.Cookie) // attach refresh_token cookie
}
w := httptest.NewRecorder()
r.ServeHTTP(w, req)
t.Log(request.Name+" response:", w.Body.String())
if !request.ignoreError {
assert.Equal(t, http.StatusOK, w.Code)
}
} }
t.Log("get user id 1") // t.Log("get user id 1")
result, err := accessHandler.GetUserByKey("user_name", "admin", false) // result, err := accessHandler.GetUserByKey("user_name", "admin", false)
if err != nil { // if err != nil {
t.Fatal(err) // t.Fatal(err)
} // }
t.Log(result) // t.Log(result)
t.Log("get all users") // t.Log("get user by key")
result, err = accessHandler.GetUserById(0) // result, err = accessHandler.GetUserByKey("password", "passwordd", false)
if err != nil { // if err != nil {
t.Fatal(err) // t.Fatal(err)
} // }
t.Log(result) // t.Log(result)
t.Log("get user by key") // t.Log("get user by key and like")
result, err = accessHandler.GetUserByKey("password", "passwordd", false) // result, err = accessHandler.GetUserByKey("user_name", "a*", true)
if err != nil { // if err != nil {
t.Fatal(err) // t.Fatal(err)
} // }
t.Log(result) // t.Log(result)
t.Log("get user by key and like")
result, err = accessHandler.GetUserByKey("user_name", "a*", true)
if err != nil {
t.Fatal(err)
}
t.Log(result)
// var user_name string = "admin1" // var user_name string = "admin1"
// if len(result) > 0 { // if len(result) > 0 {
@@ -68,34 +130,37 @@ func TestAccesshandlerLogin(t *testing.T) {
// Name: user_name, // Name: user_name,
// }, "user_name", result[0].Name) // }, "user_name", result[0].Name)
// } // }
t.Log("read user again") // t.Log("read user again")
result, err = accessHandler.GetUserByKey("user_name", "a*", true) // result, err = accessHandler.GetUserByKey("user_name", "a*", true)
if err != nil { // if err != nil {
t.Fatal(err) // t.Fatal(err)
} // }
t.Log(result) // t.Log(result)
// t.Log("delete user id 1") // t.Log("delete user id 1")
// err = accessHandler.DeleteUserByKey("user_name", user_name, false) // err = accessHandler.DeleteUserByKey("user_name", user_name, false)
// if err != nil { // if err != nil {
// t.Fatal(err) // t.Fatal(err)
// } // }
t.Log("read user again") // t.Log("read user again")
result, err = accessHandler.GetUserById(0) // result, err = accessHandler.GetUserById(0)
if err != nil { // if err != nil {
t.Fatal(err) // t.Fatal(err)
} // }
t.Log(result) // t.Log(result)
t.Log("read admin permissions") // t.Log("read admin permissions")
result1, err := accessHandler.GetRoleByKey("role", "admin", false) // result1, err := accessHandler.GetRoleByKey("role", "admin", false)
if err != nil { // if err != nil {
t.Fatal(err) // t.Fatal(err)
} // }
t.Log(result1) // t.Log(result1)
} }
func TestLoginHandler(t *testing.T) { func TestLoginAndAuthorization(t *testing.T) {
os.Setenv("ACCESS_SECRET", "12345678910111213141516171819202")
os.Setenv("REFRESH_SECRET", "9998979695949392919089888786858")
gin.SetMode(gin.TestMode) gin.SetMode(gin.TestMode)
// Setup your AccessHandler and router // Setup your AccessHandler and router

2
go.mod
View File

@@ -3,7 +3,7 @@ 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/dbHandler v1.0.8
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/go-playground/assert/v2 v2.2.0 github.com/go-playground/assert/v2 v2.2.0

4
go.sum
View File

@@ -1,5 +1,5 @@
gitea.tecamino.com/paadi/dbHandler v1.0.2 h1:5d3sWIFY6JQLX0PGSTsxcvZFCSNTgtx4lHTX5lwF2H8= gitea.tecamino.com/paadi/dbHandler v1.0.8 h1:ZWSBM/KFtLwTv2cBqwK1mOxWAxAfL0BcWEC3kJ9JALU=
gitea.tecamino.com/paadi/dbHandler v1.0.2/go.mod h1:y/xn/POJg1DO++67uKvnO23lJQgh+XFQq7HZCS9Getw= gitea.tecamino.com/paadi/dbHandler v1.0.8/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

@@ -2,7 +2,6 @@ package handlers
import ( import (
"fmt" "fmt"
"log"
"net/http" "net/http"
"time" "time"
@@ -17,9 +16,9 @@ import (
// 🔐 AUTHENTICATION CONSTANTS // 🔐 AUTHENTICATION CONSTANTS
// ----------------------------- // -----------------------------
// JWT secrets (replace "*" with strong random values in production!) // JWT secrets
var ACCESS_SECRET = []byte("ShFRprALcXjlosJ2hFCnGYGG3Ce2uRx6") var ACCESS_SECRET []byte
var REFRESH_SECRET = []byte("pQIjuX6g6Tzf0FEfdScxttT3hlL9NFaa") var REFRESH_SECRET []byte
// DOMAIN defines where cookies are valid. Change this in production. // DOMAIN defines where cookies are valid. Change this in production.
var DOMAIN = "localhost" var DOMAIN = "localhost"
@@ -53,28 +52,18 @@ func (aH *AccessHandler) Login(c *gin.Context) {
} }
// Fetch user record from DB // Fetch user record from DB
var dbRecord []models.User dbUser, hasError := aH.getUserFromDB(c, user.Name)
err := aH.dbHandler.GetByKey(&dbRecord, "user_name", user.Name, false) if hasError {
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 return
} }
// Check password // Check password
if !utils.CheckPassword(user.Password, dbRecord[0].Password) { if !utils.CheckPassword(user.Password, dbUser.Password) {
aH.logger.Error("Login", "invalid password") aH.logger.Error("Login", "invalid password")
c.JSON(http.StatusUnauthorized, models.NewJsonMessageResponse("invalid credentials")) c.JSON(http.StatusUnauthorized, models.NewJsonMessageResponse("invalid credentials"))
return return
} }
user = dbRecord[0] user = dbUser
// ----------------------------- // -----------------------------
// 🔑 TOKEN CREATION // 🔑 TOKEN CREATION
@@ -175,7 +164,11 @@ func (aH *AccessHandler) Refresh(c *gin.Context) {
username := claims["username"].(string) username := claims["username"].(string)
id := int(claims["id"].(float64)) id := int(claims["id"].(float64))
role := claims["role"].(string)
user, hasError := aH.getUserFromDB(c, username)
if hasError {
return
}
// Create new access token // Create new access token
aH.logger.Debug("Refresh", "create new access token") aH.logger.Debug("Refresh", "create new access token")
@@ -183,7 +176,7 @@ func (aH *AccessHandler) Refresh(c *gin.Context) {
newAccess := jwt.NewWithClaims(jwt.SigningMethodHS256, jwt.MapClaims{ newAccess := jwt.NewWithClaims(jwt.SigningMethodHS256, jwt.MapClaims{
"id": id, "id": id,
"username": username, "username": username,
"role": role, "role": user.Role,
"exp": accessExp.Unix(), "exp": accessExp.Unix(),
}) })
accessString, _ := newAccess.SignedString(ACCESS_SECRET) accessString, _ := newAccess.SignedString(ACCESS_SECRET)
@@ -242,3 +235,34 @@ func (aH *AccessHandler) Logout(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{"message": "logged out"}) c.JSON(http.StatusOK, gin.H{"message": "logged out"})
} }
func (aH *AccessHandler) getUserFromDB(c *gin.Context, userName string) (user models.User, hasError bool) {
hasError = true
// Fetch user record from DB
var dbRecord []models.User
err := aH.dbHandler.GetByKey(&dbRecord, "user_name", userName, false)
if err != nil {
aH.logger.Error("Login", err)
c.JSON(http.StatusBadRequest, models.NewJsonErrorResponse(err))
return
}
if len(dbRecord) == 0 {
aH.logger.Error("Login", "no user "+userName+" found")
c.JSON(http.StatusUnauthorized, models.NewJsonMessageResponse("invalid credentials"))
return
}
if len(dbRecord) > 1 {
aH.logger.Error("Login", "more than one record found")
c.JSON(http.StatusInternalServerError, models.NewJsonMessageResponse("internal error"))
return
}
if !dbRecord[0].ExpirationIsValid() {
aH.logger.Error("Login", fmt.Sprintf("user %s is expired", userName))
c.JSON(http.StatusUnauthorized, models.NewJsonMessageResponse("user "+userName+" is expired"))
return
}
return dbRecord[0], false
}

View File

@@ -1,7 +1,6 @@
package handlers package handlers
import ( import (
"fmt"
"log" "log"
"net/http" "net/http"
"strings" "strings"
@@ -141,8 +140,7 @@ func (aH *AccessHandler) AuthorizeRole(suffix string) gin.HandlerFunc {
// Validate that a role was found // Validate that a role was found
if len(roles) == 0 { if len(roles) == 0 {
log.Println("not logged in") aH.logger.Error("AuthorizeRole", "not logged in")
aH.logger.Error("AuthorizeRole", "no logged in")
c.JSON(http.StatusUnauthorized, http.StatusUnauthorized) c.JSON(http.StatusUnauthorized, http.StatusUnauthorized)
return return
} else if len(roles) > 1 { } else if len(roles) > 1 {
@@ -153,7 +151,6 @@ func (aH *AccessHandler) AuthorizeRole(suffix string) gin.HandlerFunc {
// Check permissions // Check permissions
for _, permission := range roles[0].Permissions { for _, permission := range roles[0].Permissions {
fmt.Println(100, permissionPath, permission.Name)
if permission.Name == permissionPath { if permission.Name == permissionPath {
c.Next() c.Next()
return return

View File

@@ -2,50 +2,22 @@ package handlers
import ( import (
"fmt" "fmt"
"net/http"
"strconv"
"gitea.tecamino.com/paadi/access-handler/models" "gitea.tecamino.com/paadi/access-handler/models"
"github.com/gin-gonic/gin"
) )
// AddRoleTable
//
// Description:
//
// Creates a new database table for storing role definitions if it does not already exist.
//
// Behavior:
// - Uses the DBHandler to add a table based on the `models.Role` struct.
// - Returns an error if table creation fails.
//
// Returns:
// - 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
//
// Description:
//
// Ensures that a default administrative role exists in the database.
// If a role named "admin" is already present, it logs and skips creation.
//
// Behavior:
// 1. Checks for an existing "admin" role.
// 2. If not found, initializes default permissions using
// `models.Permissions.DefaultPermissions()`.
// 3. Creates a new role record with those permissions.
//
// Default Role:
// - Role: "admin"
// - Permissions: all default permissions defined in `models.Permissions`.
//
// Returns:
// - error: Any database or creation error encountered.
func (aH *AccessHandler) AddDefaultRole() (err error) { 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 aH.dbHandler.Exists(&models.Role{}, "role", role, false) {
// 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
@@ -64,134 +36,135 @@ func (aH *AccessHandler) AddDefaultRole() (err error) {
return return
} }
// AddNewRole func (aH *AccessHandler) AddRole(c *gin.Context) {
// var role models.Role
// Description: err := c.BindJSON(&role)
// if err != nil {
// Adds a new role with a specific set of permissions to the database. aH.logger.Error("AddRole", err)
// c.JSON(http.StatusBadRequest, models.NewJsonErrorResponse(err))
// Behavior: return
// 1. Checks whether a role with the same name already exists. }
// 2. If it does not exist, creates a new role record.
// if !role.IsValid() {
// Parameters: aH.logger.Error("AddRole", "user empty")
// - role: The role name (e.g., "manager", "viewer"). c.JSON(http.StatusBadRequest, models.NewJsonMessageResponse("user empty"))
// - permissions: A `models.Permissions` struct defining allowed actions. return
// }
// Returns:
// - error: If the role already exists or insertion fails.
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 aH.dbHandler.Exists(&models.Role{}, "role", role.Role, false) {
// Found a role → skip creation aH.logger.Error("AddRole", fmt.Sprintf("role with name %s already exists", role.Role))
return fmt.Errorf("role with name %s already exists", role) c.JSON(http.StatusBadRequest, models.NewJsonMessageResponse(fmt.Sprintf("role with name %s already exists", role.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.Role,
Permissions: permissions, Permissions: role.Permissions,
})
c.JSON(http.StatusOK, gin.H{
"message": fmt.Sprintf("role '%s' successfully added", role.Role),
})
}
func (aH *AccessHandler) 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 return
} }
err = aH.dbHandler.GetById(&roles, uint(i))
} else {
err = aH.dbHandler.GetById(&roles, 0)
// GetRoleById }
//
// Description: if err != nil {
// aH.logger.Error("GetRole", err)
// Retrieves a role record from the database by its numeric ID. c.JSON(http.StatusInternalServerError, nil)
//
// Parameters:
// - id: The unique ID of the role.
//
// Returns:
// - roles: A slice containing the matched role (usually length 1).
// - err: Any database error encountered.
func (aH *AccessHandler) GetRoleById(id uint) (roles []models.Role, err error) {
err = aH.dbHandler.GetById(&roles, id)
return return
}
c.JSON(http.StatusOK, roles)
} }
// GetRoleByKey func (aH *AccessHandler) UpdateRole(c *gin.Context) {
// var role models.Role
// Description: if err := c.BindJSON(&role); err != nil {
// aH.logger.Error("UpdateRole", err)
// Retrieves one or more roles based on a key/value query. c.JSON(http.StatusInternalServerError, nil)
//
// Parameters:
// - key: The column name to search by (e.g., "role").
// - value: The value to match (e.g., "admin").
// - likeSearch: Whether to use SQL LIKE for partial matches.
//
// Returns:
// - roles: A list of matched roles.
// - err: Any database error encountered.
func (aH *AccessHandler) GetRoleByKey(key string, value any, likeSearch bool) (roles []models.Role, err error) {
err = aH.dbHandler.GetByKey(&roles, key, value, likeSearch)
return 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+"'"))
} }
// UpdateRoleById func (aH *AccessHandler) DeleteRole(c *gin.Context) {
// queryRole := c.Query("role")
// Description: if queryRole == "" || queryRole == "null" || queryRole == "undefined" {
// aH.logger.Error("DeleteRole", "id query missing or wrong value: "+queryRole)
// Updates a role record identified by its numeric ID. c.JSON(http.StatusInternalServerError, nil)
// return
// Parameters: }
// - id: The ID of the role to update.
// - role: A struct containing updated role data.
//
// Returns:
// - error: Any database error encountered.
func (aH *AccessHandler) UpdateRoleById(id uint, role models.Role) error {
return aH.dbHandler.UpdateValuesById(&role, id)
}
// UpdateRoleByKey var request struct {
// Roles []string `json:"roles"`
// Description: }
//
// Updates a role record using a column key/value lookup.
//
// Parameters:
// - role: The updated role data.
// - key: The column name to search by.
// - value: The value to match against the key column.
//
// Returns:
// - error: Any database error encountered.
func (aH *AccessHandler) UpdateRoleByKey(role models.Role, key string, value any) error {
return aH.dbHandler.UpdateValuesByKey(&role, key, value)
}
// DeleteRoleById err := c.BindJSON(&request)
// if err != nil {
// Description: aH.logger.Error("DeleteRole", err)
// c.JSON(http.StatusBadRequest, nil)
// Deletes a role record from the database by its numeric ID. return
// }
// Parameters:
// - id: The ID of the role to delete.
//
// Returns:
// - error: Any database error encountered during deletion.
func (aH *AccessHandler) DeleteRoleById(id uint) (err error) {
return aH.dbHandler.DeleteById(&models.Role{}, id)
}
// DeleteRoleByKey if len(request.Roles) == 0 {
// aH.logger.Error("DeleteRole", "no ids given to be deleted")
// Description: c.JSON(http.StatusBadRequest, models.NewJsonMessageResponse("no roles given to be deleted"))
// return
// Deletes one or more roles from the database matching a given key/value pair. }
//
// Parameters: var ownRole string
// - key: The column name used for filtering (e.g., "role").
// - value: The matching value (e.g., "admin"). for _, role := range request.Roles {
// - likeSearch: If true, performs a LIKE (partial) match. if queryRole == role {
// ownRole = role
// Returns: continue
// - error: Any database error encountered. }
func (aH *AccessHandler) DeleteRoleByKey(key string, value any, likeSearch bool) (err error) { err = aH.dbHandler.DeleteByKey(&models.Role{}, "role", role, false)
return aH.dbHandler.DeleteByKey(&models.Role{}, key, value, likeSearch) 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,55 +1,27 @@
package handlers package handlers
import ( import (
"errors"
"fmt" "fmt"
"net/http"
"strconv"
"gitea.tecamino.com/paadi/access-handler/internal/utils" "gitea.tecamino.com/paadi/access-handler/internal/utils"
"gitea.tecamino.com/paadi/access-handler/models" "gitea.tecamino.com/paadi/access-handler/models"
"github.com/gin-gonic/gin"
) )
// AddUserTable
//
// Description:
//
// Creates a new database table for storing user records if it does not already exist.
//
// Behavior:
// - Uses the DBHandler to add a table based on the `models.User` struct.
// - Returns any error encountered during table creation.
//
// Returns:
// - 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
//
// Description:
//
// Ensures a default administrative user exists in the database.
// If a user with the predefined email already exists, the function logs
// a debug message and exits without making changes.
//
// Behavior:
// 1. Checks if the default user (admin) already exists by email.
// 2. If not found, creates default Quasar UI settings and adds the user.
//
// Default User:
// - Name: "admin"
// - Role: "admin"
// - Email: "zuercher@tecamino.ch"
// - Password: (empty or hashed later)
//
// Returns:
// - error: Any database or creation error encountered.
func (aH *AccessHandler) AddDefaultUser() (err error) { func (aH *AccessHandler) AddDefaultUser() (err error) {
name := "admin" name := "admin"
role := "admin" role := "admin"
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 aH.dbHandler.Exists(&models.User{}, "email", email, false) {
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
@@ -71,148 +43,161 @@ func (aH *AccessHandler) AddDefaultUser() (err error) {
return return
} }
// AddNewUser func (aH *AccessHandler) AddUser(c *gin.Context) {
// var user models.User
// Description: err := c.BindJSON(&user)
// if err != nil {
// Adds a new user record to the database with a hashed password. aH.logger.Error("AddUser", err)
// c.JSON(http.StatusInternalServerError, models.NewJsonErrorResponse(err))
// Behavior: return
// 1. Verifies that the email does not already exist. }
// 2. Hashes the password using utils.HashPassword().
// 3. Inserts the new user record into the database. if !user.IsValid() {
// aH.logger.Error("AddUser", "user empty")
// Parameters: c.JSON(http.StatusBadRequest, models.NewJsonMessageResponse("user empty"))
// - userName: The user's display name. return
// - email: The user's unique email address. }
// - password: The user's raw password (will be hashed).
// - role: The role assigned to the user.
//
// Returns:
// - error: If the user already exists or if hashing/insertion fails.
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 aH.dbHandler.Exists(&models.User{}, "email", user.Email, false) {
// Found a user → skip create // Found a user → skip create
aH.logger.Error("AddNewUser", "user with email "+email+" already exists") aH.logger.Error("AddUser", "user with email "+user.Email+" already exists")
return fmt.Errorf("user with email %s already exists", email) 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 the provided password before saving
hash, err := utils.HashPassword(password) hash, err := utils.HashPassword(user.Password)
if err != nil { if err != nil {
return err aH.logger.Error("AddUser", err)
c.JSON(http.StatusInternalServerError, nil)
return
} }
aH.logger.Debug("AddNewUser", "add new user "+userName+" with role "+role) aH.logger.Debug("AddUser", "add default quasar user setting ")
user.Settings.DefaultQuasarSettings()
aH.logger.Debug("AddUser", "add new user "+user.Name+" with role "+user.Role)
// Insert the new user record // Insert the new user record
aH.dbHandler.AddNewColum(&models.User{ aH.dbHandler.AddNewColum(&models.User{
Name: userName, Name: user.Name,
Role: role, Role: user.Role,
Email: email, Email: user.Email,
Password: hash, Password: hash,
Settings: user.Settings,
})
c.JSON(http.StatusOK, gin.H{
"message": fmt.Sprintf("user '%s' successfully added", user.Name),
})
}
func (aH *AccessHandler) GetUser(c *gin.Context) {
var i int
var err error
id := c.Query("id")
if id == "undefined" || id == "null" || id == "" {
i = 0
} else {
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 *AccessHandler) 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 *AccessHandler) 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 return
} }
// GetUserById var request struct {
// Ids []int `json:"ids"`
// Description: }
//
// Retrieves user(s) from the database by their unique ID. err := c.BindJSON(&request)
// if err != nil {
// Parameters: aH.logger.Error("DeleteUser", err)
// - id: The numeric user ID. c.JSON(http.StatusInternalServerError, nil)
//
// Returns:
// - users: A slice containing the matched user (usually length 1).
// - err: Any database error encountered.
func (aH *AccessHandler) GetUserById(id uint) (users []models.User, err error) {
err = aH.dbHandler.GetById(&users, id)
return return
} }
// GetUserByKey if len(request.Ids) == 0 {
// aH.logger.Error("DeleteUser", "no ids given to be deleted")
// Description: c.JSON(http.StatusBadRequest, gin.H{
// "message": "no ids given to be deleted",
// Queries users based on a given column key and value. })
//
// Parameters:
// - key: The column name to search by (e.g., "email").
// - value: The value to match.
// - likeSearch: If true, performs a LIKE (partial) search.
//
// Returns:
// - users: A list of users that match the search criteria.
// - err: Any database error encountered.
func (aH *AccessHandler) GetUserByKey(key string, value any, likeSearch bool) (users []models.User, err error) {
err = aH.dbHandler.GetByKey(&users, key, value, likeSearch)
return return
} }
// UpdateUserById var ownId string
// removeIds := make([]uint, len(request.Ids))
// Description: for i, id := range request.Ids {
// if queryId == fmt.Sprint(id) {
// Updates an existing user record identified by its numeric ID. ownId = queryId
// continue
// Parameters: }
// - id: The user ID to update. removeIds[i] = uint(id)
// - user: A struct containing updated field values. }
//
// Returns:
// - error: Any error encountered during the update.
func (aH *AccessHandler) UpdateUserById(id uint, user models.User) error {
return aH.dbHandler.UpdateValuesById(&user, id)
}
// UpdateUserByKey if ownId != "" {
// aH.logger.Error("DeleteUser", "can not delete logged in member id: "+queryId)
// Description: c.JSON(http.StatusBadRequest, gin.H{
// "message": "can not delete logged in member id: " + queryId,
// Updates a user record based on a specified column key and value. "id": queryId,
// })
// Parameters: return
// - user: The updated user data. }
// - key: The column name used for lookup.
// - value: The value to match against the key column.
//
// Returns:
// - error: Any error encountered during the update.
func (aH *AccessHandler) UpdateUserByKey(user models.User, key string, value any) error {
return aH.dbHandler.UpdateValuesByKey(&user, key, value)
}
// DeleteUserById err = aH.dbHandler.DeleteById(&models.User{}, removeIds...)
// if err != nil {
// Description: aH.logger.Error("DeleteUser", err)
// c.JSON(http.StatusInternalServerError, nil)
// Deletes a user from the database using their numeric ID. return
// }
// Parameters:
// - id: The ID of the user to delete.
//
// Returns:
// - error: Any database error encountered during deletion.
func (aH *AccessHandler) DeleteUserById(id uint) (err error) {
return aH.dbHandler.DeleteById(&models.User{}, id)
}
// DeleteUserByKey c.JSON(http.StatusOK, gin.H{
// "message": "member(s) deleted",
// Description: })
//
// Deletes users matching a specific key/value pair from the database.
//
// Parameters:
// - key: The column name to search by.
// - value: The value to match.
// - likeSearch: Whether to use a partial match (LIKE).
//
// Returns:
// - error: Any database error encountered during deletion.
func (aH *AccessHandler) DeleteUserByKey(key string, value any, likeSearch bool) (err error) {
return aH.dbHandler.DeleteByKey(&models.User{}, key, value, likeSearch)
} }

View File

@@ -12,8 +12,9 @@ func (r *Permissions) DefaultPermissions() {
*r = append(*r, *r = append(*r,
Permission{Name: "settings", Permission: 7}, Permission{Name: "settings", Permission: 7},
Permission{Name: "userSettings", Permission: 7}, Permission{Name: "userSettings", Permission: 7},
Permission{Name: "members", Permission: 7}, Permission{Name: "members", Permission: 15},
Permission{Name: "events", Permission: 7}, Permission{Name: "events", Permission: 7},
Permission{Name: "responsible", Permission: 7},
) )
} }

View File

@@ -12,6 +12,7 @@ type Settings struct {
SecondaryColor string `json:"secondaryColor,omitempty"` SecondaryColor string `json:"secondaryColor,omitempty"`
SecondaryColorText string `json:"secondaryColorText,omitempty"` SecondaryColorText string `json:"secondaryColorText,omitempty"`
Icon string `json:"icon,omitempty"` Icon string `json:"icon,omitempty"`
AppName string `json:"appName,omitempty"`
DatabaseName string `json:"databaseName,omitempty"` DatabaseName string `json:"databaseName,omitempty"`
DatabaseToken string `json:"databaseToken,omitempty"` DatabaseToken string `json:"databaseToken,omitempty"`
} }

View File

@@ -1,14 +1,28 @@
package models package models
import (
"time"
)
type User struct { type User struct {
Id uint `gorm:"primaryKey" json:"id"` Id uint `gorm:"primaryKey" json:"id"`
Name string `gorm:"column:user_name" json:"user"` Name string `gorm:"column:user_name" json:"user"`
Email string `gorm:"column:email" json:"email"` Email string `gorm:"column:email" json:"email"`
Role string `gorm:"column:role" json:"role"` Role string `gorm:"column:role" json:"role,omitempty"`
Password string `gorm:"column:password" json:"password"` Password string `gorm:"column:password" json:"password"`
Expiration string `gorm:"column:expiration" json:"expiration,omitempty"`
Settings Settings `gorm:"type:json" json:"settings"` Settings Settings `gorm:"type:json" json:"settings"`
} }
func (u *User) IsValid() bool { func (u *User) IsValid() bool {
return u.Name != "" return u.Name != ""
} }
func (u *User) ExpirationIsValid() bool {
if u.Expiration == "" || u.Expiration == "never" {
return true
}
loc := time.Now().Location()
parsedTime, _ := time.ParseInLocation("2006-01-02 15:04:05", u.Expiration, loc)
return parsedTime.After(time.Now())
}