X-Git-Url: https://osm.etsi.org/gitweb/?p=osm%2FNBI.git;a=blobdiff_plain;f=osm_nbi%2Fauth.py;h=7d586ad13ad2460e0abb50814c5a9705b462218d;hp=a734b467d3f9fd090143fb9f85d7885f00068c7e;hb=29933fc257389f16f9c798f52a43e43800475a4a;hpb=d985a8dbd3c2a0ae7e1b6a28b12b6c0297c888b8;ds=sidebyside diff --git a/osm_nbi/auth.py b/osm_nbi/auth.py index a734b46..7d586ad 100644 --- a/osm_nbi/auth.py +++ b/osm_nbi/auth.py @@ -1,16 +1,32 @@ # -*- coding: utf-8 -*- +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + """ Authenticator is responsible for authenticating the users, create the tokens unscoped and scoped, retrieve the role list inside the projects that they are inserted """ +from os import path -__author__ = "Eduardo Sousa " +__author__ = "Eduardo Sousa ; Alfonso Tierno " __date__ = "$27-jul-2018 23:59:59$" import cherrypy import logging +import yaml from base64 import standard_b64decode from copy import deepcopy from functools import reduce @@ -18,6 +34,7 @@ from hashlib import sha256 from http import HTTPStatus from random import choice as random_choice from time import time +from uuid import uuid4 from authconn import AuthException from authconn_keystone import AuthconnKeystone @@ -34,6 +51,8 @@ class Authenticator: RBAC model to manage permissions on operations. """ + periodin_db_pruning = 60 * 30 # for the internal backend only. every 30 minutes expired tokens will be pruned + def __init__(self): """ Authenticator initializer. Setup the initial state of the object, @@ -42,7 +61,12 @@ class Authenticator: self.backend = None self.config = None self.db = None - self.tokens = dict() + self.tokens_cache = dict() + self.next_db_prune_time = 0 # time when next cleaning of expired tokens must be done + self.resources_to_operations_file = None + self.roles_to_operations_file = None + self.resources_to_operations_mapping = {} + self.operation_to_allowed_roles = {} self.logger = logging.getLogger("nbi.authenticator") def start(self, config): @@ -56,14 +80,6 @@ class Authenticator: self.config = config try: - if not self.backend: - if config["authentication"]["backend"] == "keystone": - self.backend = AuthconnKeystone(self.config["authentication"]) - elif config["authentication"]["backend"] == "internal": - pass - else: - raise AuthException("Unknown authentication backend: {}" - .format(config["authentication"]["backend"])) if not self.db: if config["database"]["driver"] == "mongo": self.db = dbmongo.DbMongo() @@ -74,6 +90,36 @@ class Authenticator: else: raise AuthException("Invalid configuration param '{}' at '[database]':'driver'" .format(config["database"]["driver"])) + if not self.backend: + if config["authentication"]["backend"] == "keystone": + self.backend = AuthconnKeystone(self.config["authentication"]) + elif config["authentication"]["backend"] == "internal": + self._internal_tokens_prune() + else: + raise AuthException("Unknown authentication backend: {}" + .format(config["authentication"]["backend"])) + if not self.resources_to_operations_file: + if "resources_to_operations" in config["rbac"]: + self.resources_to_operations_file = config["rbac"]["resources_to_operations"] + else: + for config_file in (__file__[:__file__.rfind("auth.py")] + "resources_to_operations.yml", + "./resources_to_operations.yml"): + if path.isfile(config_file): + self.resources_to_operations_file = config_file + break + if not self.resources_to_operations_file: + raise AuthException("Invalid permission configuration: resources_to_operations file missing") + if not self.roles_to_operations_file: + if "roles_to_operations" in config["rbac"]: + self.roles_to_operations_file = config["rbac"]["roles_to_operations"] + else: + for config_file in (__file__[:__file__.rfind("auth.py")] + "roles_to_operations.yml", + "./roles_to_operations.yml"): + if path.isfile(config_file): + self.roles_to_operations_file = config_file + break + if not self.roles_to_operations_file: + raise AuthException("Invalid permission configuration: roles_to_operations file missing") except Exception as e: raise AuthException(str(e)) @@ -84,15 +130,125 @@ class Authenticator: except DbException as e: raise AuthException(str(e), http_code=e.http_code) - def init_db(self, target_version='1.1'): + def init_db(self, target_version='1.0'): """ - Check if the database has been initialized, with at least one user. If not, create an adthe required tables + Check if the database has been initialized, with at least one user. If not, create the required tables and insert the predefined mappings between roles and permissions. :param target_version: schema version that should be present in the database. :return: None if OK, exception if error or version is different. """ - pass + # Always reads operation to resource mapping from file (this is static, no need to store it in MongoDB) + # Operations encoding: " " + # Note: it is faster to rewrite the value than to check if it is already there or not + operations = [] + with open(self.resources_to_operations_file, "r") as stream: + resources_to_operations_yaml = yaml.load(stream) + + for resource, operation in resources_to_operations_yaml["resources_to_operations"].items(): + operation_key = operation.replace(".", ":") + if operation_key not in operations: + operations.append(operation_key) + self.resources_to_operations_mapping[resource] = operation_key + + records = self.db.get_list("roles_operations") + + # Loading permissions to MongoDB. If there are permissions already in MongoDB, do nothing. + if len(records) == 0: + with open(self.roles_to_operations_file, "r") as stream: + roles_to_operations_yaml = yaml.load(stream) + + roles = [] + for role_with_operations in roles_to_operations_yaml["roles_to_operations"]: + # Verifying if role already exists. If it does, send warning to log and ignore it. + if role_with_operations["role"] not in roles: + roles.append(role_with_operations["role"]) + else: + self.logger.warning("Duplicated role with name: {0}. Role definition is ignored." + .format(role_with_operations["role"])) + continue + + operations = {} + root = None + + if not role_with_operations["operations"]: + continue + + for operation, is_allowed in role_with_operations["operations"].items(): + if not isinstance(is_allowed, bool): + continue + + if operation == ".": + root = is_allowed + continue + + if len(operation) != 1 and operation[-1] == ".": + self.logger.warning("Invalid operation {0} terminated in '.'. " + "Operation will be discarded" + .format(operation)) + continue + + operation_key = operation.replace(".", ":") + if operation_key not in operations.keys(): + operations[operation_key] = is_allowed + else: + self.logger.info("In role {0}, the operation {1} with the value {2} was discarded due to " + "repetition.".format(role_with_operations["role"], operation, is_allowed)) + + if not root: + root = False + self.logger.info("Root for role {0} not defined. Default value 'False' applied." + .format(role_with_operations["role"])) + + now = time() + operation_to_roles_item = { + "_id": str(uuid4()), + "_admin": { + "created": now, + "modified": now, + }, + "role": role_with_operations["role"], + "root": root + } + + for operation, value in operations.items(): + operation_to_roles_item[operation] = value + + self.db.create("roles_operations", operation_to_roles_item) + + permissions = {oper: [] for oper in operations} + records = self.db.get_list("roles_operations") + + ignore_fields = ["_id", "_admin", "role", "root"] + roles = [] + for record in records: + + roles.append(record["role"]) + record_permissions = {oper: record["root"] for oper in operations} + operations_joined = [(oper, value) for oper, value in record.items() if oper not in ignore_fields] + operations_joined.sort(key=lambda x: x[0].count(":")) + + for oper in operations_joined: + match = list(filter(lambda x: x.find(oper[0]) == 0, record_permissions.keys())) + + for m in match: + record_permissions[m] = oper[1] + + allowed_operations = [k for k, v in record_permissions.items() if v is True] + + for allowed_op in allowed_operations: + permissions[allowed_op].append(record["role"]) + + for oper, role_list in permissions.items(): + self.operation_to_allowed_roles[oper] = role_list + + if self.config["authentication"]["backend"] != "internal": + for role in roles: + if role == "anonymous": + continue + self.backend.create_role(role) + + self.backend.assign_role_to_user("admin", "admin", "system_admin") def authorize(self): token = None @@ -111,7 +267,7 @@ class Authenticator: # 2. Try using session before request a new token. If not, basic authentication will generate token = cherrypy.session.get("Authorization") if token == "logout": - token = None # force Unauthorized response to insert user pasword again + token = None # force Unauthorized response to insert user password again elif user_passwd64 and cherrypy.request.config.get("auth.allow_basic_authentication"): # 3. Get new token from user password user = None @@ -127,9 +283,15 @@ class Authenticator: if self.config["authentication"]["backend"] == "internal": return self._internal_authorize(token) else: + if not token: + raise AuthException("Needed a token or Authorization http header", + http_code=HTTPStatus.UNAUTHORIZED) try: self.backend.validate_token(token) - return self.tokens[token] + self.check_permissions(self.tokens_cache[token], cherrypy.request.path_info, + cherrypy.request.method) + # TODO: check if this can be avoided. Backend may provide enough information + return deepcopy(self.tokens_cache[token]) except AuthException: self.del_token(token) raise @@ -161,6 +323,9 @@ class Authenticator: else: project_id = projects[0] + if not session: + token, projects = self.backend.authenticate_with_token(token, project_id) + if project_id == "admin": session_admin = True else: @@ -184,7 +349,8 @@ class Authenticator: elif remote.ip: new_session["remote_host"] = remote.ip - self.tokens[token] = new_session + # TODO: check if this can be avoided. Backend may provide enough information + self.tokens_cache[token] = new_session return deepcopy(new_session) @@ -192,14 +358,16 @@ class Authenticator: if self.config["authentication"]["backend"] == "internal": return self._internal_get_token_list(session) else: - return [deepcopy(token) for token in self.tokens.values() + # TODO: check if this can be avoided. Backend may provide enough information + return [deepcopy(token) for token in self.tokens_cache.values() if token["username"] == session["username"]] def get_token(self, session, token): if self.config["authentication"]["backend"] == "internal": return self._internal_get_token(session, token) else: - token_value = self.tokens.get(token) + # TODO: check if this can be avoided. Backend may provide enough information + token_value = self.tokens_cache.get(token) if not token_value: raise AuthException("token not found", http_code=HTTPStatus.NOT_FOUND) if token_value["username"] != session["username"] and not session["admin"]: @@ -212,23 +380,107 @@ class Authenticator: else: try: self.backend.revoke_token(token) - del self.tokens[token] + del self.tokens_cache[token] return "token '{}' deleted".format(token) except KeyError: raise AuthException("Token '{}' not found".format(token), http_code=HTTPStatus.NOT_FOUND) - def _internal_authorize(self, token): + def check_permissions(self, session, url, method): + self.logger.info("Session: {}".format(session)) + self.logger.info("URL: {}".format(url)) + self.logger.info("Method: {}".format(method)) + + key, parameters = self._normalize_url(url, method) + + # TODO: Check if parameters might be useful for the decision + + operation = self.resources_to_operations_mapping[key] + roles_required = self.operation_to_allowed_roles[operation] + roles_allowed = self.backend.get_role_list(session["id"]) + + if "anonymous" in roles_required: + return + + for role in roles_allowed: + if role in roles_required: + return + + raise AuthException("Access denied: lack of permissions.") + + def _normalize_url(self, url, method): + # Removing query strings + normalized_url = url if '?' not in url else url[:url.find("?")] + normalized_url_splitted = normalized_url.split("/") + parameters = {} + + filtered_keys = [key for key in self.resources_to_operations_mapping.keys() + if method in key.split()[0]] + + for idx, path_part in enumerate(normalized_url_splitted): + tmp_keys = [] + for tmp_key in filtered_keys: + splitted = tmp_key.split()[1].split("/") + if "<" in splitted[idx] and ">" in splitted[idx]: + if splitted[idx] == "": + tmp_keys.append(tmp_key) + continue + elif idx == len(normalized_url_splitted) - 1 and \ + len(normalized_url_splitted) != len(splitted): + continue + else: + tmp_keys.append(tmp_key) + elif splitted[idx] == path_part: + if idx == len(normalized_url_splitted) - 1 and \ + len(normalized_url_splitted) != len(splitted): + continue + else: + tmp_keys.append(tmp_key) + filtered_keys = tmp_keys + if len(filtered_keys) == 1 and \ + filtered_keys[0].split("/")[-1] == "": + break + + if len(filtered_keys) == 0: + raise AuthException("Cannot make an authorization decision. URL not found. URL: {0}".format(url)) + elif len(filtered_keys) > 1: + raise AuthException("Cannot make an authorization decision. Multiple URLs found. URL: {0}".format(url)) + + filtered_key = filtered_keys[0] + + for idx, path_part in enumerate(filtered_key.split()[1].split("/")): + if "<" in path_part and ">" in path_part: + if path_part == "": + parameters[path_part[1:-1]] = "/".join(normalized_url_splitted[idx:]) + else: + parameters[path_part[1:-1]] = normalized_url_splitted[idx] + + return filtered_key, parameters + + def _internal_authorize(self, token_id): try: - if not token: + if not token_id: raise AuthException("Needed a token or Authorization http header", http_code=HTTPStatus.UNAUTHORIZED) - if token not in self.tokens: - raise AuthException("Invalid token or Authorization http header", http_code=HTTPStatus.UNAUTHORIZED) - session = self.tokens[token] + # try to get from cache first now = time() + session = self.tokens_cache.get(token_id) + if session and session["expires"] < now: + del self.tokens_cache[token_id] + session = None + if session: + return session + + # get from database if not in cache + session = self.db.get_one("tokens", {"_id": token_id}) if session["expires"] < now: - del self.tokens[token] raise AuthException("Expired Token or Authorization http header", http_code=HTTPStatus.UNAUTHORIZED) + self.tokens_cache[token_id] = session return session + except DbException as e: + if e.http_code == HTTPStatus.NOT_FOUND: + raise AuthException("Invalid Token or Authorization http header", http_code=HTTPStatus.UNAUTHORIZED) + else: + raise + except AuthException: if self.config["global"].get("test.user_not_authorized"): return {"id": "fake-token-id-for-test", @@ -244,7 +496,6 @@ class Authenticator: # Try using username/password if indata.get("username"): user_rows = self.db.get_list("users", {"username": indata.get("username")}) - user_content = None if user_rows: user_content = user_rows[0] salt = user_content["_admin"]["salt"] @@ -285,18 +536,19 @@ class Authenticator: elif remote.ip: new_session["remote_host"] = remote.ip - self.tokens[token_id] = new_session + self.tokens_cache[token_id] = new_session + self.db.create("tokens", new_session) + # check if database must be prune + self._internal_tokens_prune(now) return deepcopy(new_session) def _internal_get_token_list(self, session): - token_list = [] - for token_id, token_value in self.tokens.items(): - if token_value["username"] == session["username"]: - token_list.append(deepcopy(token_value)) + now = time() + token_list = self.db.get_list("tokens", {"username": session["username"], "expires.gt": now}) return token_list def _internal_get_token(self, session, token_id): - token_value = self.tokens.get(token_id) + token_value = self.db.get_one("tokens", {"_id": token_id}, fail_on_empty=False) if not token_value: raise AuthException("token not found", http_code=HTTPStatus.NOT_FOUND) if token_value["username"] != session["username"] and not session["admin"]: @@ -305,7 +557,18 @@ class Authenticator: def _internal_del_token(self, token_id): try: - del self.tokens[token_id] + self.tokens_cache.pop(token_id, None) + self.db.del_one("tokens", {"_id": token_id}) return "token '{}' deleted".format(token_id) - except KeyError: - raise AuthException("Token '{}' not found".format(token_id), http_code=HTTPStatus.NOT_FOUND) + except DbException as e: + if e.http_code == HTTPStatus.NOT_FOUND: + raise AuthException("Token '{}' not found".format(token_id), http_code=HTTPStatus.NOT_FOUND) + else: + raise + + def _internal_tokens_prune(self, now=None): + now = now or time() + if not self.next_db_prune_time or self.next_db_prune_time >= now: + self.db.del_list("tokens", {"expires.lt": now}) + self.next_db_prune_time = self.periodin_db_pruning + now + self.tokens_cache.clear() # force to reload tokens from database