create the tokens unscoped and scoped, retrieve the role
list inside the projects that they are inserted
"""
-from os import path
__author__ = "Eduardo Sousa <esousa@whitestack.com>; Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
__date__ = "$27-jul-2018 23:59:59$"
import yaml
from base64 import standard_b64decode
from copy import deepcopy
-from functools import reduce
-from hashlib import sha256
+# from functools import reduce
from http import HTTPStatus
-from random import choice as random_choice
from time import time
-from uuid import uuid4
+from os import path
-from authconn import AuthException
+from authconn import AuthException, AuthExceptionUnauthorized
from authconn_keystone import AuthconnKeystone
+from authconn_internal import AuthconnInternal # Comment out for testing&debugging, uncomment when ready
from osm_common import dbmongo
from osm_common import dbmemory
from osm_common.dbbase import DbException
+from uuid import uuid4 # For Role _id with internal authentication backend
+
class Authenticator:
"""
Authorization. Initially it should support Openstack Keystone as a
backend through a plugin model where more backends can be added and a
RBAC model to manage permissions on operations.
+ This class must be threading safe
"""
periodin_db_pruning = 60 * 30 # for the internal backend only. every 30 minutes expired tokens will be pruned
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.roles_to_operations_table = None
self.resources_to_operations_mapping = {}
self.operation_to_allowed_roles = {}
self.logger = logging.getLogger("nbi.authenticator")
+ self.operations = []
def start(self, config):
"""
if config["authentication"]["backend"] == "keystone":
self.backend = AuthconnKeystone(self.config["authentication"])
elif config["authentication"]["backend"] == "internal":
+ self.backend = AuthconnInternal(self.config["authentication"], self.db, self.tokens_cache)
self._internal_tokens_prune()
else:
raise AuthException("Unknown authentication backend: {}"
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"):
+ possible_paths = (
+ __file__[:__file__.rfind("auth.py")] + "resources_to_operations.yml",
+ "./resources_to_operations.yml"
+ )
+ for config_file in possible_paths:
if path.isfile(config_file):
self.resources_to_operations_file = config_file
break
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"):
+ possible_paths = (
+ __file__[:__file__.rfind("auth.py")] + "roles_to_operations.yml",
+ "./roles_to_operations.yml"
+ )
+ for config_file in possible_paths:
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")
+ if not self.roles_to_operations_table: # PROVISIONAL ?
+ self.roles_to_operations_table = "roles_operations" \
+ if config["authentication"]["backend"] == "keystone" \
+ else "roles"
except Exception as e:
raise AuthException(str(e))
# Always reads operation to resource mapping from file (this is static, no need to store it in MongoDB)
# Operations encoding: "<METHOD> <URL>"
# Note: it is faster to rewrite the value than to check if it is already there or not
- operations = []
+
+ # PCR 28/05/2019 Commented out to allow initialization for internal backend
+ # if self.config["authentication"]["backend"] == "internal":
+ # return
+
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
+ if operation not in self.operations:
+ self.operations.append(operation)
+ self.resources_to_operations_mapping[resource] = operation
- records = self.db.get_list("roles_operations")
+ records = self.db.get_list(self.roles_to_operations_table)
- # Loading permissions to MongoDB. If there are permissions already in MongoDB, do nothing.
- if len(records) == 0:
+ # Loading permissions to MongoDB if there is not any permission.
+ if not records:
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"])
+ role_names = []
+ for role_with_operations in roles_to_operations_yaml["roles"]:
+ # Verifying if role already exists. If it does, raise exception
+ if role_with_operations["name"] not in role_names:
+ role_names.append(role_with_operations["name"])
else:
- self.logger.warning("Duplicated role with name: {0}. Role definition is ignored."
- .format(role_with_operations["role"]))
- continue
-
- operations = {}
- root = None
+ raise AuthException("Duplicated role name '{}' at file '{}''"
+ .format(role_with_operations["name"], self.roles_to_operations_file))
- if not role_with_operations["operations"]:
+ if not role_with_operations["permissions"]:
continue
- for operation, is_allowed in role_with_operations["operations"].items():
+ for permission, is_allowed in role_with_operations["permissions"].items():
if not isinstance(is_allowed, bool):
- continue
+ raise AuthException("Invalid value for permission '{}' at role '{}'; at file '{}'"
+ .format(permission, role_with_operations["name"],
+ self.roles_to_operations_file))
- if operation == ".":
- root = is_allowed
- continue
+ # TODO chek permission is ok
+ if permission[-1] == ":":
+ raise AuthException("Invalid permission '{}' terminated in ':' for role '{}'; at file {}"
+ .format(permission, role_with_operations["name"],
+ self.roles_to_operations_file))
- 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"]))
+ if "default" not in role_with_operations["permissions"]:
+ role_with_operations["permissions"]["default"] = False
+ if "admin" not in role_with_operations["permissions"]:
+ role_with_operations["permissions"]["admin"] = False
now = time()
- operation_to_roles_item = {
- "_id": str(uuid4()),
- "_admin": {
- "created": now,
- "modified": now,
- },
- "role": role_with_operations["role"],
- "root": root
+ role_with_operations["_admin"] = {
+ "created": now,
+ "modified": now,
}
- for operation, value in operations.items():
- operation_to_roles_item[operation] = value
+ if self.config["authentication"]["backend"] == "keystone":
+ if role_with_operations["name"] != "anonymous":
+ backend_roles = self.backend.get_role_list(filter_q={"name": role_with_operations["name"]})
+ if backend_roles:
+ backend_id = backend_roles[0]["_id"]
+ else:
+ backend_id = self.backend.create_role(role_with_operations["name"])
+ role_with_operations["_id"] = backend_id
+ else:
+ role_with_operations["_id"] = str(uuid4())
- self.db.create("roles_operations", operation_to_roles_item)
+ self.db.create(self.roles_to_operations_table, role_with_operations)
- permissions = {oper: [] for oper in operations}
- records = self.db.get_list("roles_operations")
+ if self.config["authentication"]["backend"] != "internal":
+ self.backend.assign_role_to_user("admin", "admin", "system_admin")
- ignore_fields = ["_id", "_admin", "role", "root"]
- roles = []
- for record in records:
+ self.load_operation_to_allowed_roles()
- 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]
+ def load_operation_to_allowed_roles(self):
+ """
+ Fills the internal self.operation_to_allowed_roles based on database role content and self.operations
+ It works in a shadow copy and replace at the end to allow other threads working with the old copy
+ :return: None
+ """
+
+ permissions = {oper: [] for oper in self.operations}
+ records = self.db.get_list(self.roles_to_operations_table)
+
+ ignore_fields = ["_id", "_admin", "name", "default"]
+ for record in records:
+ record_permissions = {oper: record["permissions"].get("default", False) for oper in self.operations}
+ operations_joined = [(oper, value) for oper, value in record["permissions"].items()
+ if oper not in ignore_fields]
operations_joined.sort(key=lambda x: x[0].count(":"))
for oper in operations_joined:
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"])
+ permissions[allowed_op].append(record["name"])
- 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")
+ self.operation_to_allowed_roles = permissions
def authorize(self):
token = None
outdata = self.new_token(None, {"username": user, "password": passwd})
token = outdata["id"]
cherrypy.session['Authorization'] = token
- 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)
- 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
+
+ if not token:
+ raise AuthException("Needed a token or Authorization http header",
+ http_code=HTTPStatus.UNAUTHORIZED)
+ token_info = self.backend.validate_token(token)
+ # TODO add to token info remote host, port
+
+ self.check_permissions(token_info, cherrypy.request.path_info,
+ cherrypy.request.method)
+ return token_info
+
except AuthException as e:
- if cherrypy.session.get('Authorization'):
- del cherrypy.session['Authorization']
- cherrypy.response.headers["WWW-Authenticate"] = 'Bearer realm="{}"'.format(e)
- raise AuthException(str(e))
+ if not isinstance(e, AuthExceptionUnauthorized):
+ if cherrypy.session.get('Authorization'):
+ del cherrypy.session['Authorization']
+ cherrypy.response.headers["WWW-Authenticate"] = 'Bearer realm="{}"'.format(e)
+ raise
def new_token(self, session, indata, remote):
- if self.config["authentication"]["backend"] == "internal":
- return self._internal_new_token(session, indata, remote)
- else:
- if indata.get("username"):
- token, projects = self.backend.authenticate_with_user_password(
- indata.get("username"), indata.get("password"))
- elif session:
- token, projects = self.backend.authenticate_with_token(
- session.get("id"), indata.get("project_id"))
- else:
- raise AuthException("Provide credentials: username/password or Authorization Bearer token",
- http_code=HTTPStatus.UNAUTHORIZED)
+ current_token = None
+ if session:
+ # current_token = session.get("token")
+ current_token = session.get("_id") if self.config["authentication"]["backend"] == "keystone" \
+ else session
+ token_info = self.backend.authenticate(
+ user=indata.get("username"),
+ password=indata.get("password"),
+ token=current_token,
+ project=indata.get("project_id")
+ )
- if indata.get("project_id"):
- project_id = indata.get("project_id")
- if project_id not in projects:
- raise AuthException("Project {} not allowed for this user".format(project_id),
- http_code=HTTPStatus.UNAUTHORIZED)
- 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:
- session_admin = reduce(lambda x, y: x or (True if y == "admin" else False),
- projects, False)
-
- now = time()
- new_session = {
- "_id": token,
- "id": token,
- "issued_at": now,
- "expires": now + 3600,
- "project_id": project_id,
- "username": indata.get("username") if not session else session.get("username"),
- "remote_port": remote.port,
- "admin": session_admin
- }
-
- if remote.name:
- new_session["remote_host"] = remote.name
- elif remote.ip:
- new_session["remote_host"] = remote.ip
+ now = time()
+ new_session = {
+ "_id": token_info["_id"],
+ "id": token_info["_id"],
+ "issued_at": now,
+ "expires": token_info.get("expires", now + 3600),
+ "project_id": token_info["project_id"],
+ "username": token_info.get("username") or session.get("username"),
+ "remote_port": remote.port,
+ "admin": True if token_info.get("project_name") == "admin" else False # TODO put admin in RBAC
+ }
- # TODO: check if this can be avoided. Backend may provide enough information
- self.tokens_cache[token] = new_session
+ if remote.name:
+ new_session["remote_host"] = remote.name
+ elif remote.ip:
+ new_session["remote_host"] = remote.ip
- return deepcopy(new_session)
+ # TODO: check if this can be avoided. Backend may provide enough information
+ self.tokens_cache[token_info["_id"]] = new_session
+
+ return deepcopy(new_session)
def get_token_list(self, session):
if self.config["authentication"]["backend"] == "internal":
return token_value
def del_token(self, token):
- if self.config["authentication"]["backend"] == "internal":
- return self._internal_del_token(token)
- else:
- try:
- self.backend.revoke_token(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)
+ try:
+ self.backend.revoke_token(token)
+ self.tokens_cache.pop(token, None)
+ return "token '{}' deleted".format(token)
+ except KeyError:
+ raise AuthException("Token '{}' not found".format(token), http_code=HTTPStatus.NOT_FOUND)
def check_permissions(self, session, url, method):
self.logger.info("Session: {}".format(session))
operation = self.resources_to_operations_mapping[key]
roles_required = self.operation_to_allowed_roles[operation]
- roles_allowed = self.backend.get_role_list(session["id"])
+ roles_allowed = [role["name"] for role in session["roles"]]
+
+ # fills session["admin"] if some roles allows it
+ session["admin"] = False
+ for role in roles_allowed:
+ if role in self.operation_to_allowed_roles["admin"]:
+ session["admin"] = True
+ break
if "anonymous" in roles_required:
return
if role in roles_required:
return
- raise AuthException("Access denied: lack of permissions.")
+ raise AuthExceptionUnauthorized("Access denied: lack of permissions.")
+
+ def get_user_list(self):
+ return self.backend.get_user_list()
def _normalize_url(self, url, method):
# Removing query strings
tmp_keys = []
for tmp_key in filtered_keys:
splitted = tmp_key.split()[1].split("/")
- if "<" in splitted[idx] and ">" in splitted[idx]:
+ if idx >= len(splitted):
+ continue
+ elif "<" in splitted[idx] and ">" in splitted[idx]:
if splitted[idx] == "<artifactPath>":
tmp_keys.append(tmp_key)
continue
return filtered_key, parameters
- def _internal_authorize(self, token_id):
- try:
- if not token_id:
- raise AuthException("Needed a token or Authorization http header", http_code=HTTPStatus.UNAUTHORIZED)
- # 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:
- 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",
- "project_id": self.config["global"].get("test.project_not_authorized", "admin"),
- "username": self.config["global"]["test.user_not_authorized"]}
- else:
- raise
-
- def _internal_new_token(self, session, indata, remote):
- now = time()
- user_content = None
-
- # Try using username/password
- if indata.get("username"):
- user_rows = self.db.get_list("users", {"username": indata.get("username")})
- if user_rows:
- user_content = user_rows[0]
- salt = user_content["_admin"]["salt"]
- shadow_password = sha256(indata.get("password", "").encode('utf-8') + salt.encode('utf-8')).hexdigest()
- if shadow_password != user_content["password"]:
- user_content = None
- if not user_content:
- raise AuthException("Invalid username/password", http_code=HTTPStatus.UNAUTHORIZED)
- elif session:
- user_rows = self.db.get_list("users", {"username": session["username"]})
- if user_rows:
- user_content = user_rows[0]
- else:
- raise AuthException("Invalid token", http_code=HTTPStatus.UNAUTHORIZED)
- else:
- raise AuthException("Provide credentials: username/password or Authorization Bearer token",
- http_code=HTTPStatus.UNAUTHORIZED)
-
- token_id = ''.join(random_choice('abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789')
- for _ in range(0, 32))
- if indata.get("project_id"):
- project_id = indata.get("project_id")
- if project_id not in user_content["projects"]:
- raise AuthException("project {} not allowed for this user"
- .format(project_id), http_code=HTTPStatus.UNAUTHORIZED)
- else:
- project_id = user_content["projects"][0]
- if project_id == "admin":
- session_admin = True
- else:
- project = self.db.get_one("projects", {"_id": project_id})
- session_admin = project.get("admin", False)
- new_session = {"issued_at": now, "expires": now + 3600,
- "_id": token_id, "id": token_id, "project_id": project_id, "username": user_content["username"],
- "remote_port": remote.port, "admin": session_admin}
- if remote.name:
- new_session["remote_host"] = remote.name
- elif remote.ip:
- new_session["remote_host"] = remote.ip
-
- 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):
now = time()
token_list = self.db.get_list("tokens", {"username": session["username"], "expires.gt": now})
raise AuthException("needed admin privileges", http_code=HTTPStatus.UNAUTHORIZED)
return token_value
- def _internal_del_token(self, token_id):
- try:
- self.tokens_cache.pop(token_id, None)
- self.db.del_one("tokens", {"_id": token_id})
- return "token '{}' deleted".format(token_id)
- 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:
projects / osm / NBI.git / blobdiff