+ # 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):
+ BaseTopic.__init__(self, db, fs, msg)
+ self.auth = auth
+ self.operations = ops
+ self.topic = "roles_operations" if isinstance(auth, AuthconnKeystone) else "roles"
+
+ @staticmethod
+ def validate_role_definition(operations, role_definitions):
+ """
+ Validates the role definition against the operations defined in
+ the resources to operations files.
+
+ :param operations: operations list
+ :param role_definitions: role definition to test
+ :return: None if ok, raises ValidationError exception on error
+ """
+ if not role_definitions.get("permissions"):
+ return
+ ignore_fields = ["admin", "default"]
+ for role_def in role_definitions["permissions"].keys():
+ if role_def in ignore_fields:
+ continue
+ if role_def[-1] == ":":
+ raise ValidationError("Operation cannot end with ':'")
+
+ role_def_matches = [op for op in operations if op.startswith(role_def)]
+
+ if len(role_def_matches) == 0:
+ raise ValidationError("Invalid permission '{}'".format(role_def))
+
+ def _validate_input_new(self, input, force=False):
+ """
+ Validates input user content for a new entry.
+
+ :param input: user input content for the new topic
+ :param force: may be used for being more tolerant
+ :return: The same input content, or a changed version of it.
+ """
+ if self.schema_new:
+ validate_input(input, self.schema_new)
+ self.validate_role_definition(self.operations, input)
+
+ return input
+
+ def _validate_input_edit(self, input, force=False):
+ """
+ Validates input user content for updating an entry.
+
+ :param input: user input content for the new topic
+ :param force: may be used for being more tolerant
+ :return: The same input content, or a changed version of it.
+ """
+ if self.schema_edit:
+ validate_input(input, self.schema_edit)
+ self.validate_role_definition(self.operations, input)
+
+ return input
+
+ 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
+ """
+ # check name not exists
+ if self.db.get_one(self.topic, {"name": indata.get("name")}, fail_on_empty=False, fail_on_more=False):
+ raise EngineException("role name '{}' exists".format(indata["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
+ """
+ if "default" not in final_content["permissions"]:
+ final_content["permissions"]["default"] = False
+ if "admin" not in final_content["permissions"]:
+ final_content["permissions"]["admin"] = False
+
+ # check name not exists
+ if "name" in edit_content:
+ role_name = edit_content["name"]
+ if self.db.get_one(self.topic, {"name": role_name, "_id.ne": _id}, fail_on_empty=False, fail_on_more=False):
+ raise EngineException("role name '{}' exists".format(role_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
+ """
+ roles = self.auth.get_role_list()
+ system_admin_roles = [role for role in roles if role["name"] == "system_admin"]
+
+ if system_admin_roles and _id == system_admin_roles[0]["_id"]:
+ raise EngineException("You cannot delete system_admin role", http_code=HTTPStatus.FORBIDDEN)
+
+ @staticmethod
+ def format_on_new(content, project_id=None, make_public=False):
+ """
+ Modifies content descriptor to include _admin
+
+ :param content: descriptor to be modified
+ :param project_id: if included, it add project read/write permissions
+ :param make_public: if included it is generated as public for reading.
+ :return: None, but content is modified
+ """
+ now = time()
+ if "_admin" not in content:
+ content["_admin"] = {}
+ if not content["_admin"].get("created"):
+ content["_admin"]["created"] = now
+ content["_admin"]["modified"] = now
+
+ if "permissions" not in content:
+ content["permissions"] = {}
+
+ if "default" not in content["permissions"]:
+ content["permissions"]["default"] = False
+ if "admin" not in content["permissions"]:
+ content["permissions"]["admin"] = False
+
+ @staticmethod
+ def format_on_edit(final_content, edit_content):
+ """
+ Modifies final_content descriptor to include the modified date.
+
+ :param final_content: final descriptor generated
+ :param edit_content: alterations to be include
+ :return: None, but final_content is modified
+ """
+ final_content["_admin"]["modified"] = time()
+
+ if "permissions" not in final_content:
+ final_content["permissions"] = {}
+
+ if "default" not in final_content["permissions"]:
+ final_content["permissions"]["default"] = False
+ if "admin" not in final_content["permissions"]:
+ final_content["permissions"]["admin"] = False
+ return None
+
+ # @staticmethod
+ # def format_on_show(content):
+ # """
+ # Modifies the content of the role information to separate the role
+ # metadata from the role definition. Eases the reading process of the
+ # role definition.
+ #
+ # :param definition: role definition to be processed
+ # """
+ # content["_id"] = str(content["_id"])
+ #
+ # 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.
+ # """
+ # filter_db = {"_id": _id}
+ # filter_db = { BaseTopic.id_field(self.topic, _id): _id } # To allow role addressing by name
+ #
+ # role = self.db.get_one(self.topic, filter_db)
+ # new_role = dict(role)
+ # self.format_on_show(new_role)
+ #
+ # return new_role
+
+ # 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.
+ # """
+ # if not filter_q:
+ # filter_q = {}
+ #
+ # if ":" in filter_q:
+ # filter_q["root"] = filter_q[":"]
+ #
+ # for key in filter_q.keys():
+ # if key == "name":
+ # continue
+ # filter_q[key] = filter_q[key] in ["True", "true"]
+ #
+ # roles = self.db.get_list(self.topic, filter_q)
+ # new_roles = []
+ #
+ # for role in roles:
+ # new_role = dict(role)
+ # self.format_on_show(new_role)
+ # new_roles.append(new_role)
+ #
+ # return new_roles
+
+ def new(self, rollback, session, indata=None, kwargs=None, headers=None):
+ """
+ Creates a new entry into 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 = self._remove_envelop(indata)
+
+ # Override descriptor with query string kwargs
+ self._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"])
+ role_name = content["name"]
+ role_id = self.auth.create_role(role_name)
+ content["_id"] = role_id
+ _id = self.db.create(self.topic, content)
+ 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 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, ...
+ """
+ self.check_conflict_on_del(session, _id, None)
+ # filter_q = {"_id": _id}
+ filter_q = {BaseTopic.id_field(self.topic, _id): _id} # To allow role addressing by name
+ if not dry_run:
+ self.auth.delete_role(_id)
+ v = self.db.del_one(self.topic, filter_q)
+ return v
+ return None
+
+ def edit(self, session, _id, indata=None, kwargs=None, content=None):
+ """
+ Updates a role 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.
+ """
+ _id = super().edit(session, _id, indata, kwargs, content)
+ if indata.get("name"):
+ self.auth.update_role(_id, name=indata.get("name"))