From eadb0da62993796cb8ec06ba9b7991573bbadbf2 Mon Sep 17 00:00:00 2001
From: dreth <almost_a_nightmare@pm.me>
Date: Fri, 16 Aug 2024 00:00:18 +0200
Subject: [PATCH] add some comments

---
 backend/auth/jwt.go | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/backend/auth/jwt.go b/backend/auth/jwt.go
index db7aea8..ac95190 100644
--- a/backend/auth/jwt.go
+++ b/backend/auth/jwt.go
@@ -14,6 +14,7 @@ import (
 
 var jwtKey = []byte(env.MK)
 
+// GenerateJWT generates a JWT token with the given email and duration
 func GenerateJWT(email string, duration int) (string, error) {
 	// If the duration is 0, default to 720
 	if duration == 0 {
@@ -31,25 +32,36 @@ func GenerateJWT(email string, duration int) (string, error) {
 		},
 	}
 	token := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)
+
 	return token.SignedString(jwtKey)
 }
 
+// ValidateJWT validates a JWT token and returns the claims
 func ValidateJWT(tokenStr string) (*structs.Claims, error) {
+	// Parse the JWT token
 	claims := &structs.Claims{}
 	token, err := jwt.ParseWithClaims(tokenStr, claims, func(token *jwt.Token) (interface{}, error) {
 		return jwtKey, nil
 	})
+
+	// Check if the token is valid
 	if err != nil {
 		return nil, err
 	}
+
 	if !token.Valid {
 		return nil, errors.New("invalid token")
 	}
+
 	return claims, nil
 }
 
+// GetJWTDurationFromHeader gets the JWT duration from the header
 func GetJWTDurationFromHeader(c *gin.Context, defaultDuration int) (int, error) {
+	// Get the JWT duration from the header
 	jwtDurationStr := c.GetHeader("X-Jwt-Token-Duration")
+
+	// If the duration is not provided, return the default duration
 	if jwtDurationStr != "" {
 		jwtDuration, err := strconv.Atoi(jwtDurationStr)
 		if err != nil {
@@ -57,5 +69,6 @@ func GetJWTDurationFromHeader(c *gin.Context, defaultDuration int) (int, error)
 		}
 		return jwtDuration, nil
 	}
+
 	return defaultDuration, nil
 }