X-Git-Url: https://osm.etsi.org/gitweb/?p=osm%2FNBI.git;a=blobdiff_plain;f=osm_nbi%2Fauth.py;h=4ee9ce23ab2ee6bec66683d1f887537fa361de7c;hp=572ab88f01e87b8b2ee29275ccd59fe8cb4676a5;hb=819d34c8315de5c2010743f499f7882b8957dcbf;hpb=2f98821b1da7d26fd54f631330bc8e1aa1e8f631;ds=sidebyside diff --git a/osm_nbi/auth.py b/osm_nbi/auth.py index 572ab88..4ee9ce2 100644 --- a/osm_nbi/auth.py +++ b/osm_nbi/auth.py @@ -1,25 +1,90 @@ -import cherrypy +# -*- coding: utf-8 -*- + +""" +Authenticator is responsible for authenticating the users, +create the tokens unscoped and scoped, retrieve the role +list inside the projects that they are inserted +""" + +__author__ = "Eduardo Sousa " +__date__ = "$27-jul-2018 23:59:59$" + +import logging from base64 import standard_b64decode +from copy import deepcopy +from functools import reduce from http import HTTPStatus +from time import time +import cherrypy +from authconn import AuthException +from authconn_keystone import AuthconnKeystone from engine import EngineException -__author__ = "Eduardo Sousa " +class Authenticator: + """ + This class should hold all the mechanisms for User Authentication and + 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. + """ -class AuthenticatorException(Exception): - def __init__(self, message, http_code=HTTPStatus.UNAUTHORIZED): - self.http_code = http_code - Exception.__init__(self, message) + def __init__(self, engine): + """ + Authenticator initializer. Setup the initial state of the object, + while it waits for the config dictionary and database initialization. + Note: engine is only here until all the calls can to it can be replaced. -class Authenticator(object): - def __init__(self, engine): + :param engine: reference to engine object used. + """ super().__init__() self.engine = engine + self.backend = None + self.config = None + self.db = None + self.tokens = dict() + self.logger = logging.getLogger("nbi.authenticator") + + def start(self, config): + """ + Method to configure the Authenticator object. This method should be called + after object creation. It is responsible by initializing the selected backend, + as well as the initialization of the database connection. + + :param config: dictionary containing the relevant parameters for this object. + """ + 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 Exception("No authentication backend defined") + if not self.db: + pass + # TODO: Implement database initialization + # NOTE: Database needed to store the mappings + except Exception as e: + raise AuthException(str(e)) + + def init_db(self, target_version='1.0'): + """ + Check if the database has been initialized. 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 + def authorize(self): token = None user_passwd64 = None @@ -47,29 +112,98 @@ class Authenticator(object): user, _, passwd = user_passwd.partition(":") except Exception: pass - outdata = self.engine.new_token(None, {"username": user, "password": passwd}) + outdata = self.new_token(None, {"username": user, "password": passwd}) token = outdata["id"] cherrypy.session['Authorization'] = token - # 4. Get token from cookie - # if not token: - # auth_cookie = cherrypy.request.cookie.get("Authorization") - # if auth_cookie: - # token = auth_cookie.value - return self.engine.authorize(token) + if self.config["authentication"]["backend"] == "internal": + return self.engine.authorize(token) + else: + try: + self.backend.validate_token(token) + return self.tokens[token] + except AuthException: + self.del_token(token) + raise except EngineException as e: if cherrypy.session.get('Authorization'): del cherrypy.session['Authorization'] cherrypy.response.headers["WWW-Authenticate"] = 'Bearer realm="{}"'.format(e) - raise AuthenticatorException(str(e)) + raise AuthException(str(e)) def new_token(self, session, indata, remote): - return self.engine.new_token(session, indata, remote) + if self.config["authentication"]["backend"] == "internal": + return self.engine.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) + + 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 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 + + self.tokens[token] = new_session + + return deepcopy(new_session) def get_token_list(self, session): - return self.engine.get_token_list(session) + if self.config["authentication"]["backend"] == "internal": + return self.engine.get_token_list(session) + else: + return [deepcopy(token) for token in self.tokens.values() + if token["username"] == session["username"]] - def get_token(self, session, token_id): - return self.engine.get_token(session, token_id) + def get_token(self, session, token): + if self.config["authentication"]["backend"] == "internal": + return self.engine.get_token(session, token) + else: + token_value = self.tokens.get(token) + if not token_value: + raise EngineException("token not found", http_code=HTTPStatus.NOT_FOUND) + if token_value["username"] != session["username"] and not session["admin"]: + raise EngineException("needed admin privileges", http_code=HTTPStatus.UNAUTHORIZED) + return token_value - def del_token(self, token_id): - return self.engine.del_token(token_id) + def del_token(self, token): + if self.config["authentication"]["backend"] == "internal": + return self.engine.del_token(token) + else: + try: + self.backend.revoke_token(token) + del self.tokens[token] + return "token '{}' deleted".format(token) + except KeyError: + raise EngineException("Token '{}' not found".format(token), http_code=HTTPStatus.NOT_FOUND)