feat(auth): use JWT tokens

Signed-off-by: Gaurav Mishra <[email protected]>
fossology · Jan 5, 2024 · dba59dc · dba59dc
1 parent c426332
commit dba59dc
Show file tree

Hide file tree

Showing 14 changed files with 389 additions and 106 deletions.
diff --git a/.env b/.env
@@ -0,0 +1,6 @@
+# SPDX-License-Identifier: GPL-2.0-only
+
+# How long the token can be valid
+TOKEN_HOUR_LIFESPAN=24
+# Secret key to sign tokens (openssl rand -hex 32)
+API_SECRET=some-random-string
diff --git a/cmd/laas/docs/docs.go b/cmd/laas/docs/docs.go
@@ -27,7 +27,7 @@ const docTemplate = `{
             "get": {
                 "security": [
                     {
-                        "BasicAuth": []
+                        "ApiKeyAuth": []
                     }
                 ],
                 "description": "Get all audit records from the server",
@@ -62,7 +62,7 @@ const docTemplate = `{
             "get": {
                 "security": [
                     {
-                        "BasicAuth": []
+                        "ApiKeyAuth": []
                     }
                 ],
                 "description": "Get a specific audit records by ID",
@@ -112,7 +112,7 @@ const docTemplate = `{
             "get": {
                 "security": [
                     {
-                        "BasicAuth": []
+                        "ApiKeyAuth": []
                     }
                 ],
                 "description": "Get changelogs of an audit record",
@@ -162,7 +162,7 @@ const docTemplate = `{
             "get": {
                 "security": [
                     {
-                        "BasicAuth": []
+                        "ApiKeyAuth": []
                     }
                 ],
                 "description": "Get a specific changelog of an audit record by its ID",
@@ -333,7 +333,7 @@ const docTemplate = `{
             "post": {
                 "security": [
                     {
-                        "BasicAuth": []
+                        "ApiKeyAuth": []
                     }
                 ],
                 "description": "Create a new license in the service",
@@ -428,7 +428,7 @@ const docTemplate = `{
             "patch": {
                 "security": [
                     {
-                        "BasicAuth": []
+                        "ApiKeyAuth": []
                     }
                 ],
                 "description": "Update a license in the service",
@@ -495,6 +495,46 @@ const docTemplate = `{
                 }
             }
         },
+        "/login": {
+            "post": {
+                "description": "Login to get JWT token",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "Users"
+                ],
+                "summary": "Login",
+                "operationId": "Login",
+                "parameters": [
+                    {
+                        "description": "Login credentials",
+                        "name": "user",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/models.UserLogin"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "JWT token",
+                        "schema": {
+                            "type": "object",
+                            "properties": {
+                                "token": {
+                                    "type": "string"
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
         "/obligation_maps/license/{license}": {
             "get": {
                 "description": "Get obligation maps for a given license shortname",
@@ -577,7 +617,7 @@ const docTemplate = `{
             "put": {
                 "security": [
                     {
-                        "BasicAuth": []
+                        "ApiKeyAuth": []
                     }
                 ],
                 "description": "Replaces the license list of an obligation topic with the given list in the obligation map.",
@@ -634,7 +674,7 @@ const docTemplate = `{
             "patch": {
                 "security": [
                     {
-                        "BasicAuth": []
+                        "ApiKeyAuth": []
                     }
                 ],
                 "description": "Add or remove licenses from obligation map for a given obligation topic",
@@ -736,7 +776,7 @@ const docTemplate = `{
             "post": {
                 "security": [
                     {
-                        "BasicAuth": []
+                        "ApiKeyAuth": []
                     }
                 ],
                 "description": "Create an obligation and associate it with licenses",
@@ -831,7 +871,7 @@ const docTemplate = `{
             "delete": {
                 "security": [
                     {
-                        "BasicAuth": []
+                        "ApiKeyAuth": []
                     }
                 ],
                 "description": "Deactivate an obligation",
@@ -870,7 +910,7 @@ const docTemplate = `{
             "patch": {
                 "security": [
                     {
-                        "BasicAuth": []
+                        "ApiKeyAuth": []
                     }
                 ],
                 "description": "Update an existing obligation record",
@@ -982,7 +1022,7 @@ const docTemplate = `{
             "get": {
                 "security": [
                     {
-                        "BasicAuth": []
+                        "ApiKeyAuth": []
                     }
                 ],
                 "description": "Get all service users",
@@ -1015,7 +1055,7 @@ const docTemplate = `{
             "post": {
                 "security": [
                     {
-                        "BasicAuth": []
+                        "ApiKeyAuth": []
                     }
                 ],
                 "description": "Create a new service user",
@@ -1067,7 +1107,7 @@ const docTemplate = `{
             "get": {
                 "security": [
                     {
-                        "BasicAuth": []
+                        "ApiKeyAuth": []
                     }
                 ],
                 "description": "Get a single user by ID",
@@ -1812,6 +1852,22 @@ const docTemplate = `{
                 }
             }
         },
+        "models.UserLogin": {
+            "type": "object",
+            "required": [
+                "password",
+                "username"
+            ],
+            "properties": {
+                "password": {
+                    "type": "string"
+                },
+                "username": {
+                    "type": "string",
+                    "example": "fossy"
+                }
+            }
+        },
         "models.UserResponse": {
             "type": "object",
             "properties": {
@@ -1832,8 +1888,11 @@ const docTemplate = `{
         }
     },
     "securityDefinitions": {
-        "BasicAuth": {
-            "type": "basic"
+        "ApiKeyAuth": {
+            "description": "Token from /login endpoint",
+            "type": "apiKey",
+            "name": "Authorization",
+            "in": "header"
         }
     }
 }`