API Improvements

backend/internal/user.js

@@ -337,21 +337,6 @@ const internalUser = {
 			});
 	},
 
-	/**
-	 * @param   {Access} access
-	 * @param   {Integer} [id_requested]
-	 * @returns {[String]}
-	 */
-	getUserOmisionsByAccess: (access, id_requested) => {
-		let response = []; // Admin response
-
-		if (!access.token.hasScope('admin') && access.token.getUserId(0) !== id_requested) {
-			response = ['roles', 'is_deleted']; // Restricted response
-		}
-
-		return response;
-	},
-
 	/**
 	 * @param  {Access}  access
 	 * @param  {Object}  data

backend/routes/users.js

@@ -111,7 +111,6 @@ router
 				return internalUser.get(res.locals.access, {
 					id:     data.user_id,
 					expand: data.expand,
-					omit:   internalUser.getUserOmisionsByAccess(res.locals.access, data.user_id)
 				});
 			})
 			.then((user) => {

backend/schema/common.json

@@ -68,6 +68,38 @@
 			"type": "integer",
 			"minimum": 0
 		},
+		"access_directive": {
+			"type": "string",
+			"enum": ["allow", "deny"]
+		},
+		"access_address": {
+			"oneOf": [
+				{
+					"type": "string",
+					"pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(/([0-9]|[1-2][0-9]|3[0-2]))?$"
+				},
+				{
+					"type": "string",
+					"pattern": "^s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*(/([0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$"
+				},
+				{
+					"type": "string",
+					"pattern": "^all$"
+				}
+			]
+		},
+		"authorization_username": {
+			"type": "string",
+			"minLength": 1
+		},
+		"authorization_password": {
+			"type": "string",
+			"minLength": 1
+		},
+		"authorization_hint": {
+			"type": "string",
+			"minLength": 1
+		},
 		"domain_names": {
 			"description": "Domain Names separated by a comma",
 			"type": "array",

backend/schema/components/access-list-list.json

@@ -0,0 +1,7 @@
+{
+	"type": "array",
+	"description": "Access list list",
+	"items": {
+		"$ref": "./access-list-object.json"
+	}
+}

backend/schema/components/access-list-object.json

@@ -20,26 +20,6 @@
 			"type": "string",
 			"minLength": 1
 		},
-		"directive": {
-			"type": "string",
-			"enum": ["allow", "deny"]
-		},
-		"address": {
-			"oneOf": [
-				{
-					"type": "string",
-					"pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(/([0-9]|[1-2][0-9]|3[0-2]))?$"
-				},
-				{
-					"type": "string",
-					"pattern": "^s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*(/([0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$"
-				},
-				{
-					"type": "string",
-					"pattern": "^all$"
-				}
-			]
-		},
 		"satisfy_any": {
 			"type": "boolean"
 		},
@@ -48,6 +28,76 @@
 		},
 		"meta": {
 			"type": "object"
+		},
+		"owner": {
+			"$ref": "./user-object.json"
+		},
+		"items": {
+			"type": "array",
+			"minItems": 0,
+			"items": {
+				"type": "object",
+				"required": ["id", "created_on", "modified_on", "access_list_id", "username", "password", "hint", "meta"],
+				"additionalProperties": false,
+				"properties": {
+					"id": {
+						"$ref": "../common.json#/properties/id"
+					},
+					"created_on": {
+						"$ref": "../common.json#/properties/created_on"
+					},
+					"modified_on": {
+						"$ref": "../common.json#/properties/modified_on"
+					},
+					"access_list_id": {
+						"$ref": "../common.json#/properties/access_list_id"
+					},
+					"username": {
+						"$ref": "../common.json#/properties/authorization_username"
+					},
+					"password": {
+						"$ref": "../common.json#/properties/authorization_password"
+					},
+					"hint": {
+						"$ref": "../common.json#/properties/authorization_hint"
+					},
+					"meta": {
+						"type": "object"
+					}
+				}
+			}
+		},
+		"clients": {
+			"type": "array",
+			"minItems": 0,
+			"items": {
+				"type": "object",
+				"required": ["id", "created_on", "modified_on", "access_list_id", "address", "directive", "meta"],
+				"additionalProperties": false,
+				"properties": {
+					"id": {
+						"$ref": "../common.json#/properties/id"
+					},
+					"created_on": {
+						"$ref": "../common.json#/properties/created_on"
+					},
+					"modified_on": {
+						"$ref": "../common.json#/properties/modified_on"
+					},
+					"access_list_id": {
+						"$ref": "../common.json#/properties/access_list_id"
+					},
+					"address": {
+						"$ref": "../common.json#/properties/access_address"
+					},
+					"directive": {
+						"$ref": "../common.json#/properties/access_directive"
+					},
+					"meta": {
+						"type": "object"
+					}
+				}
+			}
 		}
 	}
 }

backend/schema/components/permission-object.json

@@ -1,6 +1,7 @@
 {
 	"type": "object",
-	"minProperties": 1,
+	"required": ["visibility", "access_lists", "dead_hosts", "proxy_hosts", "redirection_hosts", "streams", "certificates"],
+	"additionalProperties": false,
 	"properties": {
 		"visibility": {
 			"type": "string",

backend/schema/components/stream-list.json

@@ -1,7 +1,7 @@
 {
 	"type": "array",
-	"description": "Proxy Hosts list",
+	"description": "Streams list",
 	"items": {
-		"$ref": "./proxy-host-object.json"
+		"$ref": "./stream-object.json"
 	}
 }

backend/schema/components/user-object.json

@@ -5,20 +5,13 @@
 	"additionalProperties": false,
 	"properties": {
 		"id": {
-			"type": "integer",
-			"description": "User ID",
-			"minimum": 1,
-			"example": 1
+			"$ref": "../common.json#/properties/id"
 		},
 		"created_on": {
-			"type": "string",
-			"description": "Created Date",
-			"example": "2020-01-30T09:36:08.000Z"
+			"$ref": "../common.json#/properties/created_on"
 		},
 		"modified_on": {
-			"type": "string",
-			"description": "Modified Date",
-			"example": "2020-01-30T09:41:04.000Z"
+			"$ref": "../common.json#/properties/modified_on"
 		},
 		"is_disabled": {
 			"type": "boolean",
@@ -54,6 +47,9 @@
 			"items": {
 				"type": "string"
 			}
+		},
+		"permissions": {
+			"$ref": "./permission-object.json"
 		}
 	}
 }

backend/schema/paths/nginx/access-lists/get.json

@@ -14,7 +14,7 @@
 			"description": "Expansions",
 			"schema": {
 				"type": "string",
-				"enum": ["owner", "items", "clients", "proxy_hosts"]
+				"enum": ["owner", "items", "clients"]
 			}
 		}
 	],
@@ -35,13 +35,60 @@
 									"meta": {},
 									"satisfy_any": true,
 									"pass_auth": false,
-									"proxy_host_count": 0
+									"proxy_host_count": 0,
+									"owner": {
+										"id": 1,
+										"created_on": "2024-10-07T22:43:55.000Z",
+										"modified_on": "2024-10-08T12:52:54.000Z",
+										"is_deleted": false,
+										"is_disabled": false,
+										"email": "[email protected]",
+										"name": "Administrator",
+										"nickname": "some guy",
+										"avatar": "//www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?default=mm",
+										"roles": [
+											"admin"
+										]
+									},
+									"items": [
+										{
+											"id": 1,
+											"created_on": "2024-10-08T22:15:40.000Z",
+											"modified_on": "2024-10-08T22:15:40.000Z",
+											"access_list_id": 1,
+											"username": "admin",
+											"password": "",
+											"meta": {},
+											"hint": "a****"
+										},
+										{
+											"id": 2,
+											"created_on": "2024-10-08T22:15:40.000Z",
+											"modified_on": "2024-10-08T22:15:40.000Z",
+											"access_list_id": 1,
+											"username": "asdad",
+											"password": "",
+											"meta": {},
+											"hint": "a*****"
+										}
+									],
+									"clients": [
+										{
+											"id": 1,
+											"created_on": "2024-10-08T22:15:40.000Z",
+											"modified_on": "2024-10-08T22:15:40.000Z",
+											"access_list_id": 1,
+											"address": "127.0.0.1",
+											"directive": "allow",
+											"meta": {}
+										}
+									]
 								}
 							]
 						}
 					},
 					"schema": {
-						"$ref": "../../../components/access-list-object.json"
+						"$ref": "../../../components/access-list-list.json"
 					}
 				}
 			}

backend/schema/paths/nginx/access-lists/listID/get.json

@@ -17,6 +17,15 @@
 			},
 			"required": true,
 			"example": 1
+		},
+		{
+			"in": "query",
+			"name": "expand",
+			"description": "Expansions",
+			"schema": {
+				"type": "string",
+				"enum": ["owner", "items", "clients"]
+			}
 		}
 	],
 	"responses": {
@@ -28,14 +37,61 @@
 						"default": {
 							"value": {
 								"id": 1,
-								"created_on": "2020-01-30T09:36:08.000Z",
-								"modified_on": "2020-01-30T09:41:04.000Z",
-								"is_disabled": false,
-								"email": "[email protected]",
-								"name": "Jamie Curnow",
-								"nickname": "James",
-								"avatar": "//www.gravatar.com/avatar/6193176330f8d38747f038c170ddb193?default=mm",
-								"roles": ["admin"]
+								"created_on": "2024-10-08T22:15:40.000Z",
+								"modified_on": "2024-10-08T22:15:40.000Z",
+								"owner_user_id": 1,
+								"name": "test1234",
+								"meta": {},
+								"satisfy_any": true,
+								"pass_auth": false,
+								"proxy_host_count": 0,
+								"owner": {
+									"id": 1,
+									"created_on": "2024-10-07T22:43:55.000Z",
+									"modified_on": "2024-10-08T12:52:54.000Z",
+									"is_deleted": false,
+									"is_disabled": false,
+									"email": "[email protected]",
+									"name": "Administrator",
+									"nickname": "some guy",
+									"avatar": "//www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?default=mm",
+									"roles": [
+										"admin"
+									]
+								},
+								"items": [
+									{
+										"id": 1,
+										"created_on": "2024-10-08T22:15:40.000Z",
+										"modified_on": "2024-10-08T22:15:40.000Z",
+										"access_list_id": 1,
+										"username": "admin",
+										"password": "",
+										"meta": {},
+										"hint": "a****"
+									},
+									{
+										"id": 2,
+										"created_on": "2024-10-08T22:15:40.000Z",
+										"modified_on": "2024-10-08T22:15:40.000Z",
+										"access_list_id": 1,
+										"username": "asdad",
+										"password": "",
+										"meta": {},
+										"hint": "a*****"
+									}
+								],
+								"clients": [
+									{
+										"id": 1,
+										"created_on": "2024-10-08T22:15:40.000Z",
+										"modified_on": "2024-10-08T22:15:40.000Z",
+										"access_list_id": 1,
+										"address": "127.0.0.1",
+										"directive": "allow",
+										"meta": {}
+									}
+								]
 							}
 						}
 					},