Adding pkgs for teams and users

Author: javuto

.gitignore

@@ -17,6 +17,9 @@ tmp
 # Logs
 *.log
 
+# Tests
+coverage.out
+
 # Configuration files except Docker env
 *.json
 *.yaml

backend/Makefile

@@ -55,3 +55,9 @@ endif
 # Run linter
 lint:
 	golangci-lint run
+
+# Test with coverage
+test:
+	go test ./pkg/version -v -cover
+	go test ./pkg/users -v -cover
+	go test ./pkg/teams -v -cover

backend/cmd/api/handlers/handlers.go

@@ -3,6 +3,8 @@ package handlers
 import (
 	"github.com/jmpsec/mapctf/pkg/cache"
 	"github.com/jmpsec/mapctf/pkg/config"
+	"github.com/jmpsec/mapctf/pkg/teams"
+	"github.com/jmpsec/mapctf/pkg/users"
 	"github.com/rs/zerolog"
 	"gopkg.in/natefinch/lumberjack.v2"
 	"gorm.io/gorm"
@@ -25,6 +27,8 @@ const (
 type HandlersAPI struct {
 	DB         *gorm.DB
 	RedisCache *cache.RedisManager
+	Teams      *teams.TeamManager
+	Users      *users.UserManager
 	Config     config.MapCTFConfiguration
 	DebugHTTP  *zerolog.Logger
 }
@@ -61,6 +65,18 @@ func WithConfig(cfg config.MapCTFConfiguration) HandlersOption {
 	}
 }
 
+func WithTeams(teams *teams.TeamManager) HandlersOption {
+	return func(h *HandlersAPI) {
+		h.Teams = teams
+	}
+}
+
+func WithUsers(users *users.UserManager) HandlersOption {
+	return func(h *HandlersAPI) {
+		h.Users = users
+	}
+}
+
 // createDebugHTTP to initialize the debug HTTP logger
 func createDebugHTTP(filename string) (*zerolog.Logger, error) {
 	zerolog.TimeFieldFormat = LoggerTimeFormat

backend/cmd/api/main.go

@@ -15,6 +15,8 @@ import (
 	"github.com/jmpsec/mapctf/pkg/backend"
 	"github.com/jmpsec/mapctf/pkg/cache"
 	"github.com/jmpsec/mapctf/pkg/config"
+	"github.com/jmpsec/mapctf/pkg/teams"
+	"github.com/jmpsec/mapctf/pkg/users"
 	"github.com/jmpsec/mapctf/pkg/version"
 	"github.com/rs/zerolog"
 	"github.com/rs/zerolog/log"
@@ -35,6 +37,8 @@ const (
 	LoggerTimeFormat string = "2006-01-02T15:04:05.999Z07:00"
 	// Default path used when generating example configs
 	defaultExampleConfigPath = "config/mapctf.example.yaml"
+	// Default path for service configuration file
+	defaultConfigPath = "config/mapctf.yaml"
 )
 
 // Paths
@@ -64,6 +68,8 @@ const (
 	apiStatsPath = "/stats"
 	// API teams path
 	apiTeamsPath = "/teams"
+	// API users path
+	apiUsersPath = "/users"
 	// API challenges path
 	apiChallengesPath = "/challenges"
 )
@@ -109,7 +115,7 @@ func configFileFromCommand(cmd *cli.Command) string {
 	if flagParams.ConfigFile != "" {
 		return flagParams.ConfigFile
 	}
-	return "config/mapctf.yaml"
+	return defaultConfigPath
 }
 
 // Initialization code
@@ -135,7 +141,7 @@ DELETE /api/admin/challenges/:id - Delete challenge
 
 // Let's go!
 func mapCTFService() {
-	// ////////////////////////////// Backend
+	// Backend
 	log.Info().Msg("Initializing backend...")
 	for {
 		db, err = backend.CreateDBManager(flagParams.ConfigValues.DB)
@@ -152,7 +158,7 @@ func mapCTFService() {
 		log.Debug().Msgf("Backend NOT ready! Retrying in %d seconds...\n", flagParams.ConfigValues.DB.ConnRetry)
 		time.Sleep(time.Duration(flagParams.ConfigValues.DB.ConnRetry) * time.Second)
 	}
-	// ////////////////////////////// Cache
+	// Cache
 	log.Info().Msg("Initializing cache...")
 	for {
 		redis, err = cache.CreateRedisManager(flagParams.ConfigValues.Redis)
@@ -169,15 +175,23 @@ func mapCTFService() {
 		log.Debug().Msgf("Cache NOT ready! Retrying in %d seconds...\n", flagParams.ConfigValues.Redis.ConnRetry)
 		time.Sleep(time.Duration(flagParams.ConfigValues.Redis.ConnRetry) * time.Second)
 	}
-	// ////////////////////////////// Handlers
+	// Team Manager
+	log.Info().Msg("Initialize teams")
+	teamsMgr := teams.CreateTeams(db.Conn)
+	// User Manager
+	log.Info().Msg("Initialize users")
+	usersMgr := users.CreateUserManager(db.Conn)
+	// Handlers
 	log.Info().Msg("Initializing handlers")
 	handlersCTF := handlers.CreateHandlersAPI(
 		handlers.WithDB(db.Conn),
 		handlers.WithRedisCache(redis),
 		handlers.WithConfig(flagParams.ConfigValues),
+		handlers.WithTeams(teamsMgr),
+		handlers.WithUsers(usersMgr), // User manager to be added
 		handlers.WithDebugHTTP(&flagParams.ConfigValues.DebugHTTP),
 	)
-	// ////////////////////////////// Router
+	// Router
 	log.Info().Msg("Initializing router")
 	// Create router for API
 	muxAPI := http.NewServeMux()

backend/go.mod

@@ -43,6 +43,7 @@ require (
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/rs/zerolog v1.34.0
 	github.com/spf13/viper v1.21.0
+	github.com/tendermint/crypto v0.0.0-20191022145703-50d29ede1e15
 	github.com/urfave/cli/v3 v3.6.2
 	gopkg.in/natefinch/lumberjack.v2 v2.2.1
 	gopkg.in/yaml.v3 v3.0.1

backend/go.sum

@@ -95,6 +95,8 @@ github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu
 github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
 github.com/subosito/gotenv v1.6.0 h1:9NlTDc1FTs4qu0DDq7AEtTPNw6SVm7uBMsUCUjABIf8=
 github.com/subosito/gotenv v1.6.0/go.mod h1:Dk4QP5c2W3ibzajGcXpNraDfq2IrhjMIvMSWPKKo0FU=
+github.com/tendermint/crypto v0.0.0-20191022145703-50d29ede1e15 h1:hqAk8riJvK4RMWx1aInLzndwxKalgi5rTqgfXxOxbEI=
+github.com/tendermint/crypto v0.0.0-20191022145703-50d29ede1e15/go.mod h1:z4YtwM70uOnk8h0pjJYlj3zdYwi9l03By6iAIF5j/Pk=
 github.com/urfave/cli/v3 v3.5.0 h1:qCuFMmdayTF3zmjG8TSsoBzrDqszNrklYg2x3g4MSgw=
 github.com/urfave/cli/v3 v3.5.0/go.mod h1:ysVLtOEmg2tOy6PknnYVhDoouyC/6N42TMeoMzskhso=
 github.com/urfave/cli/v3 v3.6.2 h1:lQuqiPrZ1cIz8hz+HcrG0TNZFxU70dPZ3Yl+pSrH9A8=

backend/pkg/teams/teams.go

@@ -0,0 +1,131 @@
+package teams
+
+import (
+	"fmt"
+	"time"
+
+	"github.com/rs/zerolog/log"
+	"gorm.io/gorm"
+)
+
+// TeamManager to handle all teams of the platform
+type TeamManager struct {
+	DB *gorm.DB
+}
+
+// PlatformTeam to hold all teams of the platform
+type PlatformTeam struct {
+	gorm.Model
+	Name      string `gorm:"index"`
+	Logo      string
+	Points    int
+	LastScore time.Time
+	Protected bool
+	Visible   bool
+	Active    bool
+	EntID     uint
+}
+
+// TeamMembership to link users to teams
+type TeamMembership struct {
+	gorm.Model
+	TeamID     uint `gorm:"index"`
+	UserID     uint `gorm:"index"`
+	EntID      uint
+	AssignedBy uint
+}
+
+// TeamScore to hold all team scores over time
+type TeamScore struct {
+	gorm.Model
+	TeamID   uint `gorm:"index"`
+	Points   int
+	EntID    uint
+	ScoredBy uint
+}
+
+// CreateTeams to initialize the teams struct and its tables
+func CreateTeams(backend *gorm.DB) *TeamManager {
+	t := &TeamManager{
+		DB: backend,
+	}
+	// table platform_teams
+	if err := backend.AutoMigrate(&PlatformTeam{}); err != nil {
+		log.Fatal().Msgf("Failed to AutoMigrate table (platform_teams): %v", err)
+	}
+	// table team_memberships
+	if err := backend.AutoMigrate(&TeamMembership{}); err != nil {
+		log.Fatal().Msgf("Failed to AutoMigrate table (team_memberships): %v", err)
+	}
+	// table team_scores
+	if err := backend.AutoMigrate(&TeamScore{}); err != nil {
+		log.Fatal().Msgf("Failed to AutoMigrate table (team_scores): %v", err)
+	}
+	return t
+}
+
+// Create new team
+func (m *TeamManager) Create(team PlatformTeam) error {
+	if err := m.DB.Create(&team).Error; err != nil {
+		return fmt.Errorf("Create PlatformTeam %w", err)
+	}
+	return nil
+}
+
+// Exists checks if user exists
+func (m *TeamManager) Exists(name string) bool {
+	var results int64
+	m.DB.Model(&PlatformTeam{}).Where("name = ?", name).Count(&results)
+	return (results > 0)
+}
+
+// Get user by username including service users
+func (m *TeamManager) Get(name string) (PlatformTeam, error) {
+	var team PlatformTeam
+	if err := m.DB.Where("name = ?", name).First(&team).Error; err != nil {
+		return team, err
+	}
+	return team, nil
+}
+
+// Get user by username and by tenant ID, including service users
+func (m *TeamManager) GetByTenantID(name string, tenantID uint) (PlatformTeam, error) {
+	var team PlatformTeam
+	if err := m.DB.Where("name = ? AND ent_id = ?", name, tenantID).First(&team).Error; err != nil {
+		return team, err
+	}
+	return team, nil
+}
+
+// ExistsGet checks if user exists and returns the user
+func (m *TeamManager) ExistsGet(name string) (bool, PlatformTeam) {
+	team, err := m.Get(name)
+	if err != nil {
+		return false, PlatformTeam{}
+	}
+	return true, team
+}
+
+// ExistsGetByTenantID checks if user exists and returns the user
+func (m *TeamManager) ExistsGetByTenantID(name string, tenantID uint) (bool, PlatformTeam) {
+	team, err := m.GetByTenantID(name, tenantID)
+	if err != nil {
+		return false, PlatformTeam{}
+	}
+	return true, team
+}
+
+// New empty user
+func (m *TeamManager) New(name, logo, email string, protected, visible bool, eID uint) (PlatformTeam, error) {
+	if !m.Exists(name) {
+		return PlatformTeam{
+			Name:      name,
+			Logo:      logo,
+			Protected: protected,
+			Visible:   visible,
+			Active:    true,
+			EntID:     eID,
+		}, nil
+	}
+	return PlatformTeam{}, fmt.Errorf("%s already exists", name)
+}