refactor(user): Remove password from user response and get rid of red…

…undant structs Signed-off-by: deo002 <[email protected]>
fossology · Jul 29, 2024 · fb1e5aa · fb1e5aa
1 parent 8c96990
commit fb1e5aa
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 36 deletions.
diff --git a/cmd/laas/docs/docs.go b/cmd/laas/docs/docs.go
@@ -2563,7 +2563,6 @@ const docTemplate = `{
         "models.User": {
             "type": "object",
             "required": [
-                "password",
                 "userlevel",
                 "username"
             ],
@@ -2572,9 +2571,6 @@ const docTemplate = `{
                     "type": "integer",
                     "example": 123
                 },
-                "password": {
-                    "type": "string"
-                },
                 "userlevel": {
                     "type": "string",
                     "example": "admin"
@@ -2594,7 +2590,8 @@ const docTemplate = `{
             ],
             "properties": {
                 "password": {
-                    "type": "string"
+                    "type": "string",
+                    "example": "fossy"
                 },
                 "userlevel": {
                     "type": "string",
@@ -2614,7 +2611,8 @@ const docTemplate = `{
             ],
             "properties": {
                 "password": {
-                    "type": "string"
+                    "type": "string",
+                    "example": "fossy"
                 },
                 "username": {
                     "type": "string",

diff --git a/cmd/laas/docs/swagger.json b/cmd/laas/docs/swagger.json
@@ -2556,7 +2556,6 @@
         "models.User": {
             "type": "object",
             "required": [
-                "password",
                 "userlevel",
                 "username"
             ],
@@ -2565,9 +2564,6 @@
                     "type": "integer",
                     "example": 123
                 },
-                "password": {
-                    "type": "string"
-                },
                 "userlevel": {
                     "type": "string",
                     "example": "admin"
@@ -2587,7 +2583,8 @@
             ],
             "properties": {
                 "password": {
-                    "type": "string"
+                    "type": "string",
+                    "example": "fossy"
                 },
                 "userlevel": {
                     "type": "string",
@@ -2607,7 +2604,8 @@
             ],
             "properties": {
                 "password": {
-                    "type": "string"
+                    "type": "string",
+                    "example": "fossy"
                 },
                 "username": {
                     "type": "string",

diff --git a/cmd/laas/docs/swagger.yaml b/cmd/laas/docs/swagger.yaml
@@ -701,22 +701,20 @@ definitions:
       id:
         example: 123
         type: integer
-      password:
-        type: string
       userlevel:
         example: admin
         type: string
       username:
         example: fossy
         type: string
     required:
-    - password
     - userlevel
     - username
     type: object
   models.UserInput:
     properties:
       password:
+        example: fossy
         type: string
       userlevel:
         example: admin
@@ -732,6 +730,7 @@ definitions:
   models.UserLogin:
     properties:
       password:
+        example: fossy
         type: string
       username:
         example: fossy

diff --git a/pkg/api/licenses.go b/pkg/api/licenses.go
@@ -561,10 +561,6 @@ func UpdateLicense(c *gin.Context) {
 // addChangelogsForLicenseUpdate adds changelogs for the updated fields on license update
 func addChangelogsForLicenseUpdate(tx *gorm.DB, username string,
 	newLicense, oldLicense *models.LicenseDB) error {
-	var user models.User
-	if err := tx.Where(models.User{Username: username}).First(&user).Error; err != nil {
-		return err
-	}
 	var changes []models.ChangeLog
 
 	if oldLicense.Fullname != newLicense.Fullname {

diff --git a/pkg/auth/auth.go b/pkg/auth/auth.go
@@ -311,14 +311,8 @@ func generateToken(user models.User) (string, error) {
 		return "", err
 	}
 
-	jwtUser := models.JWTUser{
-		Id:        user.Id,
-		Username:  user.Username,
-		Userlevel: user.Userlevel,
-	}
-
 	claims := jwt.MapClaims{}
-	claims["user"] = jwtUser
+	claims["user"] = user
 	claims["nbf"] = time.Now().Unix()
 	claims["exp"] = time.Now().Add(time.Hour * time.Duration(tokenLifespan)).Unix()
 	token := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)

diff --git a/pkg/models/types.go b/pkg/models/types.go
@@ -256,25 +256,18 @@ type User struct {
 	Id           int64   `json:"id" gorm:"primary_key" example:"123"`
 	Username     string  `json:"username" gorm:"unique;not null" binding:"required" example:"fossy"`
 	Userlevel    string  `json:"userlevel" binding:"required" example:"admin"`
-	Userpassword *string `json:"password,omitempty" binding:"required"`
-}
-
-// JWTUser struct is representation of user information in JWT.
-type JWTUser struct {
-	Id        int64  `json:"id"`
-	Username  string `json:"username"`
-	Userlevel string `json:"userlevel"`
+	Userpassword *string `json:"-"`
 }
 
 type UserInput struct {
 	Username     string  `json:"username" gorm:"unique;not null" binding:"required" example:"fossy"`
 	Userlevel    string  `json:"userlevel" binding:"required" example:"admin"`
-	Userpassword *string `json:"password,omitempty" binding:"required"`
+	Userpassword *string `json:"password,omitempty" binding:"required" example:"fossy"`
 }
 
 type UserLogin struct {
 	Username     string `json:"username" binding:"required" example:"fossy"`
-	Userpassword string `json:"password" binding:"required"`
+	Userpassword string `json:"password" binding:"required" example:"fossy"`
 }
 
 // UserResponse struct is representation of design API response of user.