+
+class UserTopicAuth(UserTopic):
+ # topic = "users"
+ # topic_msg = "users"
+ schema_new = user_new_schema
+ schema_edit = user_edit_schema
+
+ def __init__(self, db, fs, msg, auth):
+ UserTopic.__init__(self, db, fs, msg)
+ self.auth = auth
+
+ def check_conflict_on_new(self, session, indata):
+ """
+ Check that the data to be inserted is valid
+
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
+ :param indata: data to be inserted
+ :return: None or raises EngineException
+ """
+ username = indata.get("username")
+ if is_valid_uuid(username):
+ raise EngineException("username '{}' cannot have a uuid format".format(username),
+ HTTPStatus.UNPROCESSABLE_ENTITY)
+
+ # Check that username is not used, regardless keystone already checks this
+ if self.auth.get_user_list(filter_q={"name": username}):
+ raise EngineException("username '{}' is already used".format(username), HTTPStatus.CONFLICT)
+
+ if "projects" in indata.keys():
+ # convert to new format project_role_mappings
+ if not indata.get("project_role_mappings"):
+ indata["project_role_mappings"] = []
+ for project in indata["projects"]:
+ indata["project_role_mappings"].append({"project": project, "role": "project_user"})
+ # raise EngineException("Format invalid: the keyword 'projects' is not allowed for keystone authentication",
+ # HTTPStatus.BAD_REQUEST)
+
+ def check_conflict_on_edit(self, session, final_content, edit_content, _id):
+ """
+ Check that the data to be edited/uploaded is valid
+
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
+ :param final_content: data once modified
+ :param edit_content: incremental data that contains the modifications to apply
+ :param _id: internal _id
+ :return: None or raises EngineException
+ """
+
+ if "username" in edit_content:
+ username = edit_content.get("username")
+ if is_valid_uuid(username):
+ raise EngineException("username '{}' cannot have an uuid format".format(username),
+ HTTPStatus.UNPROCESSABLE_ENTITY)
+
+ # Check that username is not used, regardless keystone already checks this
+ if self.auth.get_user_list(filter_q={"name": username}):
+ raise EngineException("username '{}' is already used".format(username), HTTPStatus.CONFLICT)
+
+ if final_content["username"] == "admin":
+ for mapping in edit_content.get("remove_project_role_mappings", ()):
+ if mapping["project"] == "admin" and mapping.get("role") in (None, "system_admin"):
+ # TODO make this also available for project id and role id
+ raise EngineException("You cannot remove system_admin role from admin user",
+ http_code=HTTPStatus.FORBIDDEN)
+
+ def check_conflict_on_del(self, session, _id, db_content):
+ """
+ Check if deletion can be done because of dependencies if it is not force. To override
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
+ :param _id: internal _id
+ :param db_content: The database content of this item _id
+ :return: None if ok or raises EngineException with the conflict
+ """
+ if db_content["username"] == session["username"]:
+ raise EngineException("You cannot delete your own login user ", http_code=HTTPStatus.CONFLICT)
+
+ # @staticmethod
+ # def format_on_new(content, project_id=None, make_public=False):
+ # """
+ # Modifies content descriptor to include _id.
+ #
+ # NOTE: No password salt required because the authentication backend
+ # should handle these security concerns.
+ #
+ # :param content: descriptor to be modified
+ # :param make_public: if included it is generated as public for reading.
+ # :return: None, but content is modified
+ # """
+ # BaseTopic.format_on_new(content, make_public=False)
+ # content["_id"] = content["username"]
+ # content["password"] = content["password"]
+
+ # @staticmethod
+ # def format_on_edit(final_content, edit_content):
+ # """
+ # Modifies final_content descriptor to include the modified date.
+ #
+ # NOTE: No password salt required because the authentication backend
+ # should handle these security concerns.
+ #
+ # :param final_content: final descriptor generated
+ # :param edit_content: alterations to be include
+ # :return: None, but final_content is modified
+ # """
+ # BaseTopic.format_on_edit(final_content, edit_content)
+ # if "password" in edit_content:
+ # final_content["password"] = edit_content["password"]
+ # else:
+ # final_content["project_role_mappings"] = edit_content["project_role_mappings"]
+
+ @staticmethod
+ def format_on_show(content):
+ """
+ Modifies the content of the role information to separate the role
+ metadata from the role definition.
+ """
+ project_role_mappings = []
+
+ for project in content["projects"]:
+ for role in project["roles"]:
+ project_role_mappings.append({"project": project["_id"],
+ "project_name": project["name"],
+ "role": role["_id"],
+ "role_name": role["name"]})
+
+ del content["projects"]
+ content["project_role_mappings"] = project_role_mappings
+
+ return content
+
+ def new(self, rollback, session, indata=None, kwargs=None, headers=None):
+ """
+ Creates a new entry into the authentication backend.
+
+ NOTE: Overrides BaseTopic functionality because it doesn't require access to database.
+
+ :param rollback: list to append created items at database in case a rollback may to be done
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
+ :param indata: data to be inserted
+ :param kwargs: used to override the indata descriptor
+ :param headers: http request headers
+ :return: _id: identity of the inserted data.
+ """
+ try:
+ content = BaseTopic._remove_envelop(indata)
+
+ # Override descriptor with query string kwargs
+ BaseTopic._update_input_with_kwargs(content, kwargs)
+ content = self._validate_input_new(content, session["force"])
+ self.check_conflict_on_new(session, content)
+ # self.format_on_new(content, session["project_id"], make_public=session["public"])
+ _id = self.auth.create_user(content["username"], content["password"])["_id"]
+
+ if "project_role_mappings" in content.keys():
+ for mapping in content["project_role_mappings"]:
+ self.auth.assign_role_to_user(_id, mapping["project"], mapping["role"])
+
+ rollback.append({"topic": self.topic, "_id": _id})
+ # del content["password"]
+ # self._send_msg("create", content)
+ return _id
+ except ValidationError as e:
+ raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
+
+ def show(self, session, _id):
+ """
+ Get complete information on an topic
+
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
+ :param _id: server internal id
+ :return: dictionary, raise exception if not found.
+ """
+ # Allow _id to be a name or uuid
+ filter_q = {self.id_field(self.topic, _id): _id}
+ users = self.auth.get_user_list(filter_q)
+
+ if len(users) == 1:
+ return self.format_on_show(users[0])
+ elif len(users) > 1:
+ raise EngineException("Too many users found", HTTPStatus.CONFLICT)
+ else:
+ raise EngineException("User not found", HTTPStatus.NOT_FOUND)
+
+ def edit(self, session, _id, indata=None, kwargs=None, content=None):
+ """
+ Updates an user entry.
+
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
+ :param _id:
+ :param indata: data to be inserted
+ :param kwargs: used to override the indata descriptor
+ :param content:
+ :return: _id: identity of the inserted data.
+ """
+ indata = self._remove_envelop(indata)
+
+ # Override descriptor with query string kwargs
+ if kwargs:
+ BaseTopic._update_input_with_kwargs(indata, kwargs)
+ try:
+ indata = self._validate_input_edit(indata, force=session["force"])
+
+ if not content:
+ content = self.show(session, _id)
+ self.check_conflict_on_edit(session, content, indata, _id=_id)
+ # self.format_on_edit(content, indata)
+
+ if "password" in indata or "username" in indata:
+ self.auth.update_user(_id, new_name=indata.get("username"), new_password=indata.get("password"))
+ if not indata.get("remove_project_role_mappings") and not indata.get("add_project_role_mappings") and \
+ not indata.get("project_role_mappings"):
+ return _id
+ if indata.get("project_role_mappings") and \
+ (indata.get("remove_project_role_mappings") or indata.get("add_project_role_mappings")):
+ raise EngineException("Option 'project_role_mappings' is incompatible with 'add_project_role_mappings"
+ "' or 'remove_project_role_mappings'", http_code=HTTPStatus.BAD_REQUEST)
+
+ user = self.show(session, _id)
+ original_mapping = user["project_role_mappings"]
+
+ mappings_to_add = []
+ mappings_to_remove = []
+
+ # remove
+ for to_remove in indata.get("remove_project_role_mappings", ()):
+ for mapping in original_mapping:
+ if to_remove["project"] in (mapping["project"], mapping["project_name"]):
+ if not to_remove.get("role") or to_remove["role"] in (mapping["role"], mapping["role_name"]):
+ mappings_to_remove.append(mapping)
+
+ # add
+ for to_add in indata.get("add_project_role_mappings", ()):
+ for mapping in original_mapping:
+ if to_add["project"] in (mapping["project"], mapping["project_name"]) and \
+ to_add["role"] in (mapping["role"], mapping["role_name"]):
+
+ if mapping in mappings_to_remove: # do not remove
+ mappings_to_remove.remove(mapping)
+ break # do not add, it is already at user
+ else:
+ mappings_to_add.append(to_add)
+
+ # set
+ if indata.get("project_role_mappings"):
+ for to_set in indata["project_role_mappings"]:
+ for mapping in original_mapping:
+ if to_set["project"] in (mapping["project"], mapping["project_name"]) and \
+ to_set["role"] in (mapping["role"], mapping["role_name"]):
+
+ if mapping in mappings_to_remove: # do not remove
+ mappings_to_remove.remove(mapping)
+ break # do not add, it is already at user
+ else:
+ mappings_to_add.append(to_set)
+ for mapping in original_mapping:
+ for to_set in indata["project_role_mappings"]:
+ if to_set["project"] in (mapping["project"], mapping["project_name"]) and \
+ to_set["role"] in (mapping["role"], mapping["role_name"]):
+ break
+ else:
+ # delete
+ if mapping not in mappings_to_remove: # do not remove
+ mappings_to_remove.append(mapping)
+
+ for mapping in mappings_to_remove:
+ self.auth.remove_role_from_user(
+ _id,
+ mapping["project"],
+ mapping["role"]
+ )
+
+ for mapping in mappings_to_add:
+ self.auth.assign_role_to_user(
+ _id,
+ mapping["project"],
+ mapping["role"]
+ )
+
+ return "_id"
+ except ValidationError as e:
+ raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
+
+ def list(self, session, filter_q=None):
+ """
+ Get a list of the topic that matches a filter
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
+ :param filter_q: filter of data to be applied
+ :return: The list, it can be empty if no one match the filter.
+ """
+ users = [self.format_on_show(user) for user in self.auth.get_user_list(filter_q)]
+
+ return users
+
+ def delete(self, session, _id, dry_run=False):
+ """
+ Delete item by its internal _id
+
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
+ :param _id: server internal id
+ :param force: indicates if deletion must be forced in case of conflict
+ :param dry_run: make checking but do not delete
+ :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
+ """
+ # Allow _id to be a name or uuid
+ filter_q = {self.id_field(self.topic, _id): _id}
+ user_list = self.auth.get_user_list(filter_q)
+ if not user_list:
+ raise EngineException("User '{}' not found".format(_id), http_code=HTTPStatus.NOT_FOUND)
+ _id = user_list[0]["_id"]
+ self.check_conflict_on_del(session, _id, user_list[0])
+ if not dry_run:
+ v = self.auth.delete_user(_id)
+ return v
+ return None
+
+
+class ProjectTopicAuth(ProjectTopic):
+ # topic = "projects"
+ # topic_msg = "projects"
+ schema_new = project_new_schema
+ schema_edit = project_edit_schema
+
+ def __init__(self, db, fs, msg, auth):
+ ProjectTopic.__init__(self, db, fs, msg)
+ self.auth = auth
+
+ def check_conflict_on_new(self, session, indata):
+ """
+ Check that the data to be inserted is valid
+
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
+ :param indata: data to be inserted
+ :return: None or raises EngineException
+ """
+ project_name = indata.get("name")
+ if is_valid_uuid(project_name):
+ raise EngineException("project name '{}' cannot have an uuid format".format(project_name),
+ HTTPStatus.UNPROCESSABLE_ENTITY)
+
+ project_list = self.auth.get_project_list(filter_q={"name": project_name})
+
+ if project_list:
+ raise EngineException("project '{}' exists".format(project_name), HTTPStatus.CONFLICT)
+
+ def check_conflict_on_edit(self, session, final_content, edit_content, _id):
+ """
+ Check that the data to be edited/uploaded is valid
+
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
+ :param final_content: data once modified
+ :param edit_content: incremental data that contains the modifications to apply
+ :param _id: internal _id
+ :return: None or raises EngineException
+ """
+
+ project_name = edit_content.get("name")
+ if project_name:
+ if is_valid_uuid(project_name):
+ raise EngineException("project name '{}' cannot be an uuid format".format(project_name),
+ HTTPStatus.UNPROCESSABLE_ENTITY)
+
+ # Check that project name is not used, regardless keystone already checks this
+ if self.auth.get_project_list(filter_q={"name": project_name}):
+ raise EngineException("project '{}' is already used".format(project_name), HTTPStatus.CONFLICT)
+
+ def check_conflict_on_del(self, session, _id, db_content):
+ """
+ Check if deletion can be done because of dependencies if it is not force. To override
+
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
+ :param _id: internal _id
+ :param db_content: The database content of this item _id
+ :return: None if ok or raises EngineException with the conflict
+ """
+ # projects = self.auth.get_project_list()
+ # current_project = [project for project in projects
+ # if project["name"] in session["project_id"]][0]
+ # TODO check that any user is using this project, raise CONFLICT exception
+ if _id == session["project_id"]:
+ raise EngineException("You cannot delete your own project", http_code=HTTPStatus.CONFLICT)
+
+ def new(self, rollback, session, indata=None, kwargs=None, headers=None):
+ """
+ Creates a new entry into the authentication backend.
+
+ NOTE: Overrides BaseTopic functionality because it doesn't require access to database.
+
+ :param rollback: list to append created items at database in case a rollback may to be done
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
+ :param indata: data to be inserted
+ :param kwargs: used to override the indata descriptor
+ :param headers: http request headers
+ :return: _id: identity of the inserted data.
+ """
+ try:
+ content = BaseTopic._remove_envelop(indata)
+
+ # Override descriptor with query string kwargs
+ BaseTopic._update_input_with_kwargs(content, kwargs)
+ content = self._validate_input_new(content, session["force"])
+ self.check_conflict_on_new(session, content)
+ self.format_on_new(content, project_id=session["project_id"], make_public=session["public"])
+ _id = self.auth.create_project(content["name"])
+ rollback.append({"topic": self.topic, "_id": _id})
+ # self._send_msg("create", content)
+ return _id
+ except ValidationError as e:
+ raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
+
+ def show(self, session, _id):
+ """
+ Get complete information on an topic
+
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
+ :param _id: server internal id
+ :return: dictionary, raise exception if not found.
+ """
+ # Allow _id to be a name or uuid
+ filter_q = {self.id_field(self.topic, _id): _id}
+ projects = self.auth.get_project_list(filter_q=filter_q)
+
+ if len(projects) == 1:
+ return projects[0]
+ elif len(projects) > 1:
+ raise EngineException("Too many projects found", HTTPStatus.CONFLICT)
+ else:
+ raise EngineException("Project not found", HTTPStatus.NOT_FOUND)
+
+ def list(self, session, filter_q=None):
+ """
+ Get a list of the topic that matches a filter
+
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
+ :param filter_q: filter of data to be applied
+ :return: The list, it can be empty if no one match the filter.
+ """
+ return self.auth.get_project_list(filter_q)
+
+ def delete(self, session, _id, dry_run=False):
+ """
+ Delete item by its internal _id
+
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
+ :param _id: server internal id
+ :param dry_run: make checking but do not delete
+ :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
+ """
+ # Allow _id to be a name or uuid
+ filter_q = {self.id_field(self.topic, _id): _id}
+ project_list = self.auth.get_project_list(filter_q)
+ if not project_list:
+ raise EngineException("Project '{}' not found".format(_id), http_code=HTTPStatus.NOT_FOUND)
+ _id = project_list[0]["_id"]
+ self.check_conflict_on_del(session, _id, project_list[0])
+ if not dry_run:
+ v = self.auth.delete_project(_id)
+ return v
+ return None
+
+ def edit(self, session, _id, indata=None, kwargs=None, content=None):
+ """
+ Updates a project entry.
+
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
+ :param _id:
+ :param indata: data to be inserted
+ :param kwargs: used to override the indata descriptor
+ :param content:
+ :return: _id: identity of the inserted data.
+ """
+ indata = self._remove_envelop(indata)
+
+ # Override descriptor with query string kwargs
+ if kwargs:
+ BaseTopic._update_input_with_kwargs(indata, kwargs)
+ try:
+ indata = self._validate_input_edit(indata, force=session["force"])
+
+ if not content:
+ content = self.show(session, _id)
+ self.check_conflict_on_edit(session, content, indata, _id=_id)
+ # self.format_on_edit(content, indata)
+
+ if "name" in indata:
+ self.auth.update_project(content["_id"], indata["name"])
+ except ValidationError as e:
+ raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
+
+
+class RoleTopicAuth(BaseTopic):
+ topic = "roles"
+ topic_msg = None # "roles"
+ schema_new = roles_new_schema
+ schema_edit = roles_edit_schema
+ multiproject = False
+
+ def __init__(self, db, fs, msg, auth, ops):