Fixes 1367 by preventing pyang discard repeated constituent-base-element-id
[osm/NBI.git] / osm_nbi / authconn_keystone.py
index 685773b..05f803a 100644 (file)
@@ -41,21 +41,40 @@ from keystoneauth1.exceptions.base import ClientException
 from keystoneauth1.exceptions.http import Conflict
 from keystoneclient.v3 import client
 from http import HTTPStatus
-from osm_nbi.validation import is_valid_uuid
+from osm_nbi.validation import is_valid_uuid, validate_input, http_schema
 
 
 class AuthconnKeystone(Authconn):
-    def __init__(self, config, db):
-        Authconn.__init__(self, config, db)
+    def __init__(self, config, db, role_permissions):
+        Authconn.__init__(self, config, db, role_permissions)
 
         self.logger = logging.getLogger("nbi.authenticator.keystone")
+        self.domains_id2name = {}
+        self.domains_name2id = {}
+
+        self.auth_url = config.get("auth_url")
+        if config.get("auth_url"):
+            validate_input(self.auth_url, http_schema)
+        else:
+            self.auth_url = "http://{0}:{1}/v3".format(config.get("auth_host", "keystone"),
+                                                       config.get("auth_port", "5000"))
+        self.user_domain_name_list = config.get("user_domain_name", "default")
+        self.user_domain_name_list = self.user_domain_name_list.split(",")
+        # read only domain list
+        self.user_domain_ro_list = [x[:-3] for x in self.user_domain_name_list if x.endswith(":ro")]
+        # remove the ":ro"
+        self.user_domain_name_list = [x if not x.endswith(":ro") else x[:-3] for x in self.user_domain_name_list]
 
-        self.auth_url = "http://{0}:{1}/v3".format(config.get("auth_url", "keystone"), config.get("auth_port", "5000"))
-        self.user_domain_name = config.get("user_domain_name", "default")
         self.admin_project = config.get("service_project", "service")
         self.admin_username = config.get("service_username", "nbi")
         self.admin_password = config.get("service_password", "nbi")
-        self.project_domain_name = config.get("project_domain_name", "default")
+        self.project_domain_name_list = config.get("project_domain_name", "default")
+        self.project_domain_name_list = self.project_domain_name_list.split(",")
+        if len(self.user_domain_name_list) != len(self.project_domain_name_list):
+            raise ValueError("Invalid configuration parameter fo authenticate. 'project_domain_name' and "
+                             "'user_domain_name' must be a comma-separated list with the same size. Revise "
+                             "configuration or/and 'OSMNBI_AUTHENTICATION_PROJECT_DOMAIN_NAME', "
+                             "'OSMNBI_AUTHENTICATION_USER_DOMAIN_NAME'  Variables")
 
         # Waiting for Keystone to be up
         available = None
@@ -70,21 +89,25 @@ class AuthconnKeystone(Authconn):
                 if counter == 0:
                     raise AuthException("Keystone not available after 300s timeout")
 
-        self.auth = v3.Password(user_domain_name=self.user_domain_name,
+        self.auth = v3.Password(user_domain_name=self.user_domain_name_list[0],
                                 username=self.admin_username,
                                 password=self.admin_password,
-                                project_domain_name=self.project_domain_name,
+                                project_domain_name=self.project_domain_name_list[0],
                                 project_name=self.admin_project,
                                 auth_url=self.auth_url)
         self.sess = session.Session(auth=self.auth)
-        self.keystone = client.Client(session=self.sess)
+        self.keystone = client.Client(session=self.sess, endpoint_override=self.auth_url)
 
-    def authenticate(self, user, password, project=None, token_info=None):
+    def authenticate(self, credentials, token_info=None):
         """
         Authenticate a user using username/password or token_info, plus project
-        :param user: user: name, id or None
-        :param password: password or None
-        :param project: name, id, or None. If None first found project will be used to get an scope token
+        :param credentials: dictionary that contains:
+            username: name, id or None
+            password: password or None
+            project_id: name, id, or None. If None first found project will be used to get an scope token
+            project_domain_name: (Optional) To use a concrete domain for the project
+            user_domain_name: (Optional) To use a concrete domain for the project
+            other items are allowed and ignored
         :param token_info: previous token_info to obtain authorization
         :return: the scoped token info or raises an exception. The token is a dictionary with:
             _id:  token string id,
@@ -94,69 +117,83 @@ class AuthconnKeystone(Authconn):
             expires: epoch time when it expires,
 
         """
-        try:
-            username = None
-            user_id = None
-            project_id = None
-            project_name = None
-
-            if user:
-                if is_valid_uuid(user):
-                    user_id = user
+        username = None
+        user_id = None
+        project_id = None
+        project_name = None
+        if credentials.get("project_domain_name"):
+            project_domain_name_list = (credentials["project_domain_name"], )
+        else:
+            project_domain_name_list = self.project_domain_name_list
+        if credentials.get("user_domain_name"):
+            user_domain_name_list = (credentials["user_domain_name"], )
+        else:
+            user_domain_name_list = self.user_domain_name_list
+
+        for index, project_domain_name in enumerate(project_domain_name_list):
+            user_domain_name = user_domain_name_list[index]
+            try:
+                if credentials.get("username"):
+                    if is_valid_uuid(credentials["username"]):
+                        user_id = credentials["username"]
+                    else:
+                        username = credentials["username"]
+
+                    # get an unscoped token firstly
+                    unscoped_token = self.keystone.get_raw_token_from_identity_service(
+                        auth_url=self.auth_url,
+                        user_id=user_id,
+                        username=username,
+                        password=credentials.get("password"),
+                        user_domain_name=user_domain_name,
+                        project_domain_name=project_domain_name)
+                elif token_info:
+                    unscoped_token = self.keystone.tokens.validate(token=token_info.get("_id"))
                 else:
-                    username = user
-
-                # get an unscoped token firstly
-                unscoped_token = self.keystone.get_raw_token_from_identity_service(
-                    auth_url=self.auth_url,
-                    user_id=user_id,
-                    username=username,
-                    password=password,
-                    user_domain_name=self.user_domain_name,
-                    project_domain_name=self.project_domain_name)
-            elif token_info:
-                unscoped_token = self.keystone.tokens.validate(token=token_info.get("_id"))
-            else:
-                raise AuthException("Provide credentials: username/password or Authorization Bearer token",
-                                    http_code=HTTPStatus.UNAUTHORIZED)
-
-            if not project:
-                # get first project for the user
-                project_list = self.keystone.projects.list(user=unscoped_token["user"]["id"])
-                if not project_list:
-                    raise AuthException("The user {} has not any project and cannot be used for authentication".
-                                        format(user), http_code=HTTPStatus.UNAUTHORIZED)
-                project_id = project_list[0].id
-            else:
-                if is_valid_uuid(project):
-                    project_id = project
+                    raise AuthException("Provide credentials: username/password or Authorization Bearer token",
+                                        http_code=HTTPStatus.UNAUTHORIZED)
+
+                if not credentials.get("project_id"):
+                    # get first project for the user
+                    project_list = self.keystone.projects.list(user=unscoped_token["user"]["id"])
+                    if not project_list:
+                        raise AuthException("The user {} has not any project and cannot be used for authentication".
+                                            format(credentials.get("username")), http_code=HTTPStatus.UNAUTHORIZED)
+                    project_id = project_list[0].id
                 else:
-                    project_name = project
-
-            scoped_token = self.keystone.get_raw_token_from_identity_service(
-                auth_url=self.auth_url,
-                project_name=project_name,
-                project_id=project_id,
-                user_domain_name=self.user_domain_name,
-                project_domain_name=self.project_domain_name,
-                token=unscoped_token["auth_token"])
-
-            auth_token = {
-                "_id": scoped_token.auth_token,
-                "id": scoped_token.auth_token,
-                "user_id": scoped_token.user_id,
-                "username": scoped_token.username,
-                "project_id": scoped_token.project_id,
-                "project_name": scoped_token.project_name,
-                "expires": scoped_token.expires.timestamp(),
-                "issued_at": scoped_token.issued.timestamp()
-            }
+                    if is_valid_uuid(credentials["project_id"]):
+                        project_id = credentials["project_id"]
+                    else:
+                        project_name = credentials["project_id"]
 
-            return auth_token
-        except ClientException as e:
-            # self.logger.exception("Error during user authentication using keystone. Method: basic: {}".format(e))
-            raise AuthException("Error during user authentication using Keystone: {}".format(e),
-                                http_code=HTTPStatus.UNAUTHORIZED)
+                scoped_token = self.keystone.get_raw_token_from_identity_service(
+                    auth_url=self.auth_url,
+                    project_name=project_name,
+                    project_id=project_id,
+                    user_domain_name=user_domain_name,
+                    project_domain_name=project_domain_name,
+                    token=unscoped_token["auth_token"])
+
+                auth_token = {
+                    "_id": scoped_token.auth_token,
+                    "id": scoped_token.auth_token,
+                    "user_id": scoped_token.user_id,
+                    "username": scoped_token.username,
+                    "project_id": scoped_token.project_id,
+                    "project_name": scoped_token.project_name,
+                    "project_domain_name": scoped_token.project_domain_name,
+                    "user_domain_name": scoped_token.user_domain_name,
+                    "expires": scoped_token.expires.timestamp(),
+                    "issued_at": scoped_token.issued.timestamp()
+                }
+
+                return auth_token
+            except ClientException as e:
+                if index >= len(user_domain_name_list)-1 or index >= len(project_domain_name_list)-1:
+                    # if last try, launch exception
+                    # self.logger.exception("Error during user authentication using keystone: {}".format(e))
+                    raise AuthException("Error during user authentication using Keystone: {}".format(e),
+                                        http_code=HTTPStatus.UNAUTHORIZED)
 
     def validate_token(self, token):
         """
@@ -210,6 +247,37 @@ class AuthconnKeystone(Authconn):
             raise AuthException("Error during token revocation using Keystone: {}".format(e),
                                 http_code=HTTPStatus.UNAUTHORIZED)
 
+    def _get_domain_id(self, domain_name, fail_if_not_found=True):
+        """
+        Get the domain id from  the domain_name
+        :param domain_name: Can be the name or id
+        :param fail_if_not_found: If False it returns None instead of raising an exception if not found
+        :return: str or None/exception if domain is not found
+        """
+        domain_id = self.domains_name2id.get(domain_name)
+        if not domain_id:
+            self._get_domains()
+            domain_id = self.domains_name2id.get(domain_name)
+        if not domain_id and domain_name in self.domains_id2name:
+            # domain_name is already an id
+            return domain_name
+        if not domain_id and fail_if_not_found:
+            raise AuthconnNotFoundException("Domain {} cannot be found".format(domain_name))
+        return domain_id
+
+    def _get_domains(self):
+        """
+        Obtain a dictionary with domain_id to domain_name, stored at self.domains_id2name
+        and from domain_name to domain_id, sored at self.domains_name2id
+        :return: None. Exceptions are ignored
+        """
+        try:
+            domains = self.keystone.domains.list()
+            self.domains_id2name = {x.id: x.name for x in domains}
+            self.domains_name2id = {x.name: x.id for x in domains}
+        except Exception:
+            pass
+
     def create_user(self, user_info):
         """
         Create a user.
@@ -219,11 +287,18 @@ class AuthconnKeystone(Authconn):
         :return: returns the id of the user in keystone.
         """
         try:
-            new_user = self.keystone.users.create(user_info["username"], password=user_info["password"],
-                                                  domain=self.user_domain_name, _admin=user_info["_admin"])
+
+            if user_info.get("domain_name") and user_info["domain_name"] in self.user_domain_ro_list:
+                raise AuthconnConflictException("Cannot create a user in the read only domain {}".
+                                                format(user_info["domain_name"]))
+
+            new_user = self.keystone.users.create(
+                user_info["username"], password=user_info["password"],
+                domain=self._get_domain_id(user_info.get("domain_name", self.user_domain_name_list[0])),
+                _admin=user_info["_admin"])
             if "project_role_mappings" in user_info.keys():
                 for mapping in user_info["project_role_mappings"]:
-                    self.assign_role_to_user(new_user.id, mapping["project"], mapping["role"])
+                    self.assign_role_to_user(new_user, mapping["project"], mapping["role"])
             return {"username": new_user.name, "_id": new_user.id}
         except Conflict as e:
             # self.logger.exception("Error during user creation using keystone: {}".format(e))
@@ -241,23 +316,48 @@ class AuthconnKeystone(Authconn):
         """
         try:
             user = user_info.get("_id") or user_info.get("username")
-            if is_valid_uuid(user):
-                user_obj_list = [self.keystone.users.get(user)]
-            else:
-                user_obj_list = self.keystone.users.list(name=user)
-            if not user_obj_list:
-                raise AuthconnNotFoundException("User '{}' not found".format(user))
-            user_obj = user_obj_list[0]
+            try:
+                user_obj = self.keystone.users.get(user)
+            except Exception:
+                user_obj = None
+            if not user_obj:
+                for user_domain in self.user_domain_name_list:
+                    domain_id = self._get_domain_id(user_domain, fail_if_not_found=False)
+                    if not domain_id:
+                        continue
+                    user_obj_list = self.keystone.users.list(name=user, domain=domain_id)
+                    if user_obj_list:
+                        user_obj = user_obj_list[0]
+                        break
+                else:   # user not found
+                    raise AuthconnNotFoundException("User '{}' not found".format(user))
+
             user_id = user_obj.id
-            if user_info.get("password") or user_info.get("username") \
+            domain_id = user_obj.domain_id
+            domain_name = self.domains_id2name.get(domain_id)
+
+            if domain_name in self.user_domain_ro_list:
+                if user_info.get("password") or user_info.get("username"):
+                    raise AuthconnConflictException("Cannot update the user {} belonging to a read only domain {}".
+                                                    format(user, domain_name))
+
+            elif user_info.get("password") or user_info.get("username") \
                     or user_info.get("add_project_role_mappings") or user_info.get("remove_project_role_mappings"):
+                # if user_index>0, it is an external domain, that should not be updated
                 ctime = user_obj._admin.get("created", 0) if hasattr(user_obj, "_admin") else 0
-                self.keystone.users.update(user_id, password=user_info.get("password"), name=user_info.get("username"),
-                                           _admin={"created": ctime, "modified": time.time()})
+                try:
+                    self.keystone.users.update(user_id, password=user_info.get("password"),
+                                               name=user_info.get("username"),
+                                               _admin={"created": ctime, "modified": time.time()})
+                except Exception as e:
+                    if user_info.get("username") or user_info.get("password"):
+                        raise AuthconnOperationException("Error during username/password change: {}".format(str(e)))
+                    self.logger.error("Error during updating user profile: {}".format(str(e)))
+
             for mapping in user_info.get("remove_project_role_mappings", []):
-                self.remove_role_from_user(user_id, mapping["project"], mapping["role"])
+                self.remove_role_from_user(user_obj, mapping["project"], mapping["role"])
             for mapping in user_info.get("add_project_role_mappings", []):
-                self.assign_role_to_user(user_id, mapping["project"], mapping["role"])
+                self.assign_role_to_user(user_obj, mapping["project"], mapping["role"])
         except ClientException as e:
             # self.logger.exception("Error during user password/name update using keystone: {}".format(e))
             raise AuthconnOperationException("Error during user update using Keystone: {}".format(e))
@@ -270,6 +370,13 @@ class AuthconnKeystone(Authconn):
         :raises AuthconnOperationException: if user deletion failed.
         """
         try:
+            user_obj = self.keystone.users.get(user_id)
+            domain_id = user_obj.domain_id
+            domain_name = self.domains_id2name.get(domain_id)
+            if domain_name in self.user_domain_ro_list:
+                raise AuthconnConflictException("Cannot delete user {} belonging to a read only domain {}".
+                                                format(user_id, domain_name))
+
             result, detail = self.keystone.users.delete(user_id)
             if result.status_code != 204:
                 raise ClientException("error {} {}".format(result.status_code, detail))
@@ -282,19 +389,53 @@ class AuthconnKeystone(Authconn):
         """
         Get user list.
 
-        :param filter_q: dictionary to filter user list by name (username is also admited) and/or _id
+        :param filter_q: dictionary to filter user list by one or several
+            _id:
+            name (username is also admitted).  If a user id is equal to the filter name, it is also provided
+            domain_id, domain_name
         :return: returns a list of users.
         """
         try:
-            filter_name = None
+            self._get_domains()
+            filter_name = filter_domain = None
             if filter_q:
                 filter_name = filter_q.get("name") or filter_q.get("username")
-            users = self.keystone.users.list(name=filter_name)
+                if filter_q.get("domain_name"):
+                    filter_domain = self._get_domain_id(filter_q["domain_name"], fail_if_not_found=False)
+                    # If domain is not found, use the same name to obtain an empty list
+                    filter_domain = filter_domain or filter_q["domain_name"]
+                if filter_q.get("domain_id"):
+                    filter_domain = filter_q["domain_id"]
+
+            users = self.keystone.users.list(name=filter_name, domain=filter_domain)
+            # get users from user_domain_name_list[1:], because it will not be provided in case of LDAP
+            if filter_domain is None and len(self.user_domain_name_list) > 1:
+                for user_domain in self.user_domain_name_list[1:]:
+                    domain_id = self._get_domain_id(user_domain, fail_if_not_found=False)
+                    if not domain_id:
+                        continue
+                    # find if users of this domain are already provided. In this case ignore
+                    for u in users:
+                        if u.domain_id == domain_id:
+                            break
+                    else:
+                        users += self.keystone.users.list(name=filter_name, domain=domain_id)
+
+            # if filter name matches a user id, provide it also
+            if filter_name:
+                try:
+                    user_obj = self.keystone.users.get(filter_name)
+                    if user_obj not in users:
+                        users.append(user_obj)
+                except Exception:
+                    pass
+
             users = [{
                 "username": user.name,
                 "_id": user.id,
                 "id": user.id,
-                "_admin": user.to_dict().get("_admin", {})   # TODO: REVISE
+                "_admin": user.to_dict().get("_admin", {}),   # TODO: REVISE
+                "domain_name": self.domains_id2name.get(user.domain_id)
             } for user in users if user.name != self.admin_username]
 
             if filter_q and filter_q.get("_id"):
@@ -413,16 +554,23 @@ class AuthconnKeystone(Authconn):
         :return: list of projects
         """
         try:
-            filter_name = None
+            self._get_domains()
+            filter_name = filter_domain = None
             if filter_q:
                 filter_name = filter_q.get("name")
-            projects = self.keystone.projects.list(name=filter_name)
+                if filter_q.get("domain_name"):
+                    filter_domain = self.domains_name2id.get(filter_q["domain_name"])
+                if filter_q.get("domain_id"):
+                    filter_domain = filter_q["domain_id"]
+
+            projects = self.keystone.projects.list(name=filter_name, domain=filter_domain)
 
             projects = [{
                 "name": project.name,
                 "_id": project.id,
                 "_admin": project.to_dict().get("_admin", {}),  # TODO: REVISE
                 "quotas": project.to_dict().get("quotas", {}),  # TODO: REVISE
+                "domain_name": self.domains_id2name.get(project.domain_id)
             } for project in projects]
 
             if filter_q and filter_q.get("_id"):
@@ -444,10 +592,12 @@ class AuthconnKeystone(Authconn):
         :raises AuthconnOperationException: if project creation failed.
         """
         try:
-            result = self.keystone.projects.create(project_info["name"], self.project_domain_name,
-                                                   _admin=project_info["_admin"],
-                                                   quotas=project_info.get("quotas", {})
-                                                   )
+            result = self.keystone.projects.create(
+                project_info["name"],
+                domain=self._get_domain_id(project_info.get("domain_name", self.project_domain_name_list[0])),
+                _admin=project_info["_admin"],
+                quotas=project_info.get("quotas", {})
+            )
             return result.id
         except ClientException as e:
             # self.logger.exception("Error during project creation using keystone: {}".format(e))
@@ -490,35 +640,27 @@ class AuthconnKeystone(Authconn):
             # self.logger.exception("Error during project update using keystone: {}".format(e))
             raise AuthconnOperationException("Error during project update using Keystone: {}".format(e))
 
-    def assign_role_to_user(self, user, project, role):
+    def assign_role_to_user(self, user_obj, project, role):
         """
         Assigning a role to a user in a project.
 
-        :param user: username.
+        :param user_obj: user object, obtained with keystone.users.get or list.
         :param project: project name.
         :param role: role name.
         :raises AuthconnOperationException: if role assignment failed.
         """
         try:
-            if is_valid_uuid(user):
-                user_obj = self.keystone.users.get(user)
-            else:
-                user_obj_list = self.keystone.users.list(name=user)
-                if not user_obj_list:
-                    raise AuthconnNotFoundException("User '{}' not found".format(user))
-                user_obj = user_obj_list[0]
-
-            if is_valid_uuid(project):
+            try:
                 project_obj = self.keystone.projects.get(project)
-            else:
+            except Exception:
                 project_obj_list = self.keystone.projects.list(name=project)
                 if not project_obj_list:
                     raise AuthconnNotFoundException("Project '{}' not found".format(project))
                 project_obj = project_obj_list[0]
 
-            if is_valid_uuid(role):
+            try:
                 role_obj = self.keystone.roles.get(role)
-            else:
+            except Exception:
                 role_obj_list = self.keystone.roles.list(name=role)
                 if not role_obj_list:
                     raise AuthconnNotFoundException("Role '{}' not found".format(role))
@@ -528,38 +670,30 @@ class AuthconnKeystone(Authconn):
         except ClientException as e:
             # self.logger.exception("Error during user role assignment using keystone: {}".format(e))
             raise AuthconnOperationException("Error during role '{}' assignment to user '{}' and project '{}' using "
-                                             "Keystone: {}".format(role, user, project, e))
+                                             "Keystone: {}".format(role, user_obj.name, project, e))
 
-    def remove_role_from_user(self, user, project, role):
+    def remove_role_from_user(self, user_obj, project, role):
         """
         Remove a role from a user in a project.
 
-        :param user: username.
+        :param user_obj: user object, obtained with keystone.users.get or list.
         :param project: project name or id.
         :param role: role name or id.
 
         :raises AuthconnOperationException: if role assignment revocation failed.
         """
         try:
-            if is_valid_uuid(user):
-                user_obj = self.keystone.users.get(user)
-            else:
-                user_obj_list = self.keystone.users.list(name=user)
-                if not user_obj_list:
-                    raise AuthconnNotFoundException("User '{}' not found".format(user))
-                user_obj = user_obj_list[0]
-
-            if is_valid_uuid(project):
+            try:
                 project_obj = self.keystone.projects.get(project)
-            else:
+            except Exception:
                 project_obj_list = self.keystone.projects.list(name=project)
                 if not project_obj_list:
                     raise AuthconnNotFoundException("Project '{}' not found".format(project))
                 project_obj = project_obj_list[0]
 
-            if is_valid_uuid(role):
+            try:
                 role_obj = self.keystone.roles.get(role)
-            else:
+            except Exception:
                 role_obj_list = self.keystone.roles.list(name=role)
                 if not role_obj_list:
                     raise AuthconnNotFoundException("Role '{}' not found".format(role))
@@ -569,4 +703,4 @@ class AuthconnKeystone(Authconn):
         except ClientException as e:
             # self.logger.exception("Error during user role revocation using keystone: {}".format(e))
             raise AuthconnOperationException("Error during role '{}' revocation to user '{}' and project '{}' using "
-                                             "Keystone: {}".format(role, user, project, e))
+                                             "Keystone: {}".format(role, user_obj.name, project, e))