Completed Logging and Authentication Middleware, Testing Logging via JSON

Author: PythonHacker24

api/middleware/middleware.go

@@ -1 +1,53 @@
 package middleware
+
+import (
+	"net/http"
+	"time"
+
+	"github.com/PythonHacker24/linux-acl-management-backend/internal/authentication"
+	"go.uber.org/zap"
+)
+
+/* logging middleware for http requests */
+func LoggingMiddleware(next http.HandlerFunc) http.HandlerFunc {
+	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		start := time.Now()
+
+		/* logging recieved request at the instant of receiving */
+		zap.L().Info("Recieved request",
+			zap.String("Method", r.Method),	
+			zap.String("Path", r.URL.Path),
+		)
+
+		/* return the handler */
+		next(w, r)
+
+		/* logging time taken by the request */
+		zap.L().Info("Request completed",
+			zap.String("Method", r.Method),
+			zap.String("Path", r.URL.Path),
+			zap.Duration("Duration", time.Since(start)),
+		)
+	})
+}
+
+/* authentication middleware for http requests */
+func AuthenticationMiddleware(next http.HandlerFunc) http.HandlerFunc {
+	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+
+		/* authenticate the request through JWT */
+		username, err := authentication.ExtractUsernameFromRequest(r)		
+		if err != nil {
+			zap.L().Error("Error during authentication",
+				zap.Error(err),
+			)		
+			return
+		}
+
+		/* set the header with the username */
+		r.Header.Set("X-User", username)
+
+		/* return the handler */
+		next(w, r)
+	})
+}

api/routes/routes.go

@@ -3,9 +3,12 @@ package routes
 import (
 	"net/http"
 
+	"github.com/PythonHacker24/linux-acl-management-backend/api/middleware"
 	"github.com/PythonHacker24/linux-acl-management-backend/internal/handlers"
 )
 
 func RegisterRoutes(mux *http.ServeMux) {
-	mux.Handle("/health", http.HandlerFunc((handlers.HealthHandler)))
+	mux.Handle("GET /health", http.HandlerFunc(
+		middleware.LoggingMiddleware(handlers.HealthHandler),
+	))
 }

cmd/laclm/main.go

@@ -10,6 +10,8 @@ import (
 	"time"
 
 	"go.uber.org/zap"
+	"github.com/spf13/cobra"
+	"github.com/MakeNowJust/heredoc"
 
 	"github.com/PythonHacker24/linux-acl-management-backend/api/routes"
 	"github.com/PythonHacker24/linux-acl-management-backend/config"
@@ -26,14 +28,47 @@ func exec() error {
 
 	/* exec() wraps run() protecting it with user interrupts  */
 
+	utils.InitLogger(true)
 	/* zap.L() can be used all over the code for global level logging */
+
 	zap.L().Info("Logger Initiated ...")
+	
+	/* setting up cobra for cli interactions */
+	var(
+		configPath string
+		rootCmd = &cobra.Command{
+			Use:   "laclm <command> <subcommand>",
+			Short: "Backend server for linux acl management",
+			Example: heredoc.Doc(`
+				$ laclm
+				$ laclm --config /path/to/config.yaml
+			`),
+			Run: func(cmd *cobra.Command, args []string) {
+				if configPath != "" {
+					fmt.Printf("Using config file: %s\n", configPath)
+				} else {
+					fmt.Println("No config file provided.")
+				}
+			},
+		}
+	)
+
+	/* adding --config arguement */
+	rootCmd.PersistentFlags().StringVar(&configPath, "config", "", "Path to config file")
+
+	/* Execute the command */
+	if err := rootCmd.Execute(); err != nil {
+		zap.L().Error("arguements error",
+			zap.Error(err),
+		)
+		os.Exit(1)
+	}
 
 	/*
 		load config file
 		if there is an error in loading the config file, then it will exit with code 1
 	*/
-	config.LoadConfig("./config.yaml")
+	config.LoadConfig(configPath)
 
 	/*
 		load environment variables
@@ -42,7 +77,6 @@ func exec() error {
 	config.LoadEnv()
 
 	/* true for production, false for development mode */
-	utils.InitLogger(false)
 
 	ctx, cancel := context.WithCancel(context.Background())
 	defer cancel()

config.yaml

@@ -2,14 +2,14 @@
 
 # backend environment configs
 app:
-  name: 
-  version: 
-  environment:
+  name: laclm-dev
+  version: v1.1
+  environment: development
 
 # backend server deployment configs
 server:
-  host:
-  port:
+  host: localhost
+  port: 8080
 
 # databases for operations
 database:

go.mod

@@ -4,11 +4,15 @@ go 1.24.2
 
 require (
 	github.com/Azure/go-ntlmssp v0.0.0-20221128193559-754e69321358 // indirect
+	github.com/MakeNowJust/heredoc v1.0.0 // indirect
 	github.com/bufbuild/buf v1.53.0 // indirect
 	github.com/go-asn1-ber/asn1-ber v1.5.8-0.20250403174932-29230038a667 // indirect
 	github.com/go-ldap/ldap/v3 v3.4.11 // indirect
 	github.com/golang-jwt/jwt/v5 v5.2.2 // indirect
 	github.com/google/uuid v1.6.0 // indirect
+	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/spf13/cobra v1.9.1 // indirect
+	github.com/spf13/pflag v1.0.6 // indirect
 	go.uber.org/multierr v1.11.0 // indirect
 	go.uber.org/zap v1.27.0 // indirect
 	golang.org/x/crypto v0.37.0 // indirect

go.sum

@@ -1,7 +1,10 @@
 github.com/Azure/go-ntlmssp v0.0.0-20221128193559-754e69321358 h1:mFRzDkZVAjdal+s7s0MwaRv9igoPqLRdzOLzw/8Xvq8=
 github.com/Azure/go-ntlmssp v0.0.0-20221128193559-754e69321358/go.mod h1:chxPXzSsl7ZWRAuOIE23GDNzjWuZquvFlgA8xmpunjU=
+github.com/MakeNowJust/heredoc v1.0.0 h1:cXCdzVdstXyiTqTvfqk9SDHpKNjxuom+DOlyEeQ4pzQ=
+github.com/MakeNowJust/heredoc v1.0.0/go.mod h1:mG5amYoWBHf8vpLOuehzbGGw0EHxpZZ6lCpQ4fNJ8LE=
 github.com/bufbuild/buf v1.53.0 h1:i0OgpDkzv8yLyCokXRCgbQao/SqTnqXYtERre0Jw6Do=
 github.com/bufbuild/buf v1.53.0/go.mod h1:DylfLDMblZt5mX/SEFv2VzZMgdlePArhMGYVpk4M6N0=
+github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g=
 github.com/go-asn1-ber/asn1-ber v1.5.8-0.20250403174932-29230038a667 h1:BP4M0CvQ4S3TGls2FvczZtj5Re/2ZzkV9VwqPHH/3Bo=
 github.com/go-asn1-ber/asn1-ber v1.5.8-0.20250403174932-29230038a667/go.mod h1:hEBeB/ic+5LoWskz+yKT7vGhhPYkProFKoKdwZRWMe0=
 github.com/go-ldap/ldap/v3 v3.4.11 h1:4k0Yxweg+a3OyBLjdYn5OKglv18JNvfDykSoI8bW0gU=
@@ -10,6 +13,13 @@ github.com/golang-jwt/jwt/v5 v5.2.2 h1:Rl4B7itRWVtYIHFrSNd7vhTiz9UpLdi6gZhZ3wEeD
 github.com/golang-jwt/jwt/v5 v5.2.2/go.mod h1:pqrtFR0X4osieyHYxtmOUWsAWrfe1Q5UVIyoH402zdk=
 github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
 github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
+github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
+github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
+github.com/spf13/cobra v1.9.1 h1:CXSaggrXdbHK9CF+8ywj8Amf7PBRmPCOJugH954Nnlo=
+github.com/spf13/cobra v1.9.1/go.mod h1:nDyEzZ8ogv936Cinf6g1RU9MRY64Ir93oCnqb9wxYW0=
+github.com/spf13/pflag v1.0.6 h1:jFzHGLGAlb3ruxLB8MhbI6A8+AQX/2eW4qeyNZXNp2o=
+github.com/spf13/pflag v1.0.6/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
 go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0=
 go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y=
 go.uber.org/zap v1.27.0 h1:aJMhYGrd5QSmlpLMr2MftRKl7t8J8PTZPA732ud/XR8=

internal/authentication/authentication.go

@@ -51,7 +51,7 @@ func GetUsernameFromJWT(tokenString string) (string, error) {
 	/* get claims from JWT Token */
     claims, err := ValidateJWT(tokenString)
     if err != nil {
-        return "", fmt.Errorf("invalid token: %v", err)
+        return "", err
     }
 
 	/* extract username from JWT Token */

internal/handlers/handlers.go

@@ -24,54 +24,3 @@ func HealthHandler(w http.ResponseWriter, r *http.Request) {
 	}
 }
 
-/* allows users to create a session */
-func LoginHandler(w http.ResponseWriter, r *http.Request) {
-	var user models.User
-
-	/* decode json response*/
-	err := json.NewDecoder(r.Body).Decode(&user)
-	if err != nil {
-		zap.L().Warn("A request with invalid body recieved")
-		http.Error(w, "Invalid request body", http.StatusBadRequest)
-		return
-	}
-
-	/* check if username and password exists */
-	if user.Username == "" || user.Password == "" {
-		zap.L().Warn("A request with no username or password recieved")
-		http.Error(w, "Username and password are required", http.StatusBadRequest)
-		return
-	}
-
-	/* authenticate the user with ldap */
-	authStatus := ldap.AuthenticateUser()
-	if !authStatus {
-		zap.L().Warn("A request with invalid credentials recieved")
-		http.Error(w, "Invalid credentials", http.StatusUnauthorized)
-		return
-	}
-
-	/* create a session if user exists */
-	sessionmanager.CreateSession(user.Username)
-
-	/* create a JWT token for the user */
-	token, err := authentication.GenerateJWT(user.Username)
-	if err != nil {
-		zap.L().Error("Error generating token",
-			zap.Error(err),
-		)
-		http.Error(w, "Error generating token", http.StatusInternalServerError)
-		return
-	}
-
-	/* send response with JWT token to the user */
-	response := map[string]string{"token": token}
-	w.Header().Set("Content-Type", "application/json")
-	if err := json.NewEncoder(w).Encode(response); err != nil {
-		zap.L().Error("Failed to encode response",
-			zap.Error(err),
-		)
-		http.Error(w, "Failed to encode response", http.StatusInternalServerError)
-		return
-	}
-}

internal/services/services.go

@@ -0,0 +1 @@
+package services

internal/utils/utils.go

@@ -42,7 +42,12 @@ func InitLogger(isProduction bool) {
 		writeSyncer = zapcore.AddSync(os.Stdout)
 	}
 
-	core := zapcore.NewCore(encoder, writeSyncer, logLevel)
+	core := zapcore.NewCore(
+		encoder, 
+		writeSyncer, 
+		logLevel,
+	)
+
 	Log = zap.New(core, zap.AddCaller(), zap.AddStacktrace(zapcore.ErrorLevel))
 
 	/* allow global logging with zap.L() */