osm_nbi/admin_topics.py

   1 # -*- coding: utf-8 -*-
   2
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #    http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
  12 # implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15
  16 # import logging
  17 from uuid import uuid4
  18 from hashlib import sha256
  19 from http import HTTPStatus
  20 from time import time
  21 from osm_nbi.validation import user_new_schema, user_edit_schema, project_new_schema, project_edit_schema, \
  22     vim_account_new_schema, vim_account_edit_schema, sdn_new_schema, sdn_edit_schema, \
  23     wim_account_new_schema, wim_account_edit_schema, roles_new_schema, roles_edit_schema, \
  24     k8scluster_new_schema, k8scluster_edit_schema, k8srepo_new_schema, k8srepo_edit_schema, \
  25     validate_input, ValidationError, is_valid_uuid    # To check that User/Project Names don't look like UUIDs
  26 from osm_nbi.base_topic import BaseTopic, EngineException
  27 from osm_nbi.authconn import AuthconnNotFoundException, AuthconnConflictException
  28 from osm_common.dbbase import deep_update_rfc7396
  29
  30 __author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
  31
  32
  33 class UserTopic(BaseTopic):
  34     topic = "users"
  35     topic_msg = "users"
  36     schema_new = user_new_schema
  37     schema_edit = user_edit_schema
  38     multiproject = False
  39
  40     def __init__(self, db, fs, msg, auth):
  41         BaseTopic.__init__(self, db, fs, msg, auth)
  42
  43     @staticmethod
  44     def _get_project_filter(session):
  45         """
  46         Generates a filter dictionary for querying database users.
  47         Current policy is admin can show all, non admin, only its own user.
  48         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
  49         :return:
  50         """
  51         if session["admin"]:  # allows all
  52             return {}
  53         else:
  54             return {"username": session["username"]}
  55
  56     def check_conflict_on_new(self, session, indata):
  57         # check username not exists
  58         if self.db.get_one(self.topic, {"username": indata.get("username")}, fail_on_empty=False, fail_on_more=False):
  59             raise EngineException("username '{}' exists".format(indata["username"]), HTTPStatus.CONFLICT)
  60         # check projects
  61         if not session["force"]:
  62             for p in indata.get("projects") or []:
  63                 # To allow project addressing by Name as well as ID
  64                 if not self.db.get_one("projects", {BaseTopic.id_field("projects", p): p}, fail_on_empty=False,
  65                                        fail_on_more=False):
  66                     raise EngineException("project '{}' does not exist".format(p), HTTPStatus.CONFLICT)
  67
  68     def check_conflict_on_del(self, session, _id, db_content):
  69         """
  70         Check if deletion can be done because of dependencies if it is not force. To override
  71         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
  72         :param _id: internal _id
  73         :param db_content: The database content of this item _id
  74         :return: None if ok or raises EngineException with the conflict
  75         """
  76         if _id == session["username"]:
  77             raise EngineException("You cannot delete your own user", http_code=HTTPStatus.CONFLICT)
  78
  79     @staticmethod
  80     def format_on_new(content, project_id=None, make_public=False):
  81         BaseTopic.format_on_new(content, make_public=False)
  82         # Removed so that the UUID is kept, to allow User Name modification
  83         # content["_id"] = content["username"]
  84         salt = uuid4().hex
  85         content["_admin"]["salt"] = salt
  86         if content.get("password"):
  87             content["password"] = sha256(content["password"].encode('utf-8') + salt.encode('utf-8')).hexdigest()
  88         if content.get("project_role_mappings"):
  89             projects = [mapping["project"] for mapping in content["project_role_mappings"]]
  90
  91             if content.get("projects"):
  92                 content["projects"] += projects
  93             else:
  94                 content["projects"] = projects
  95
  96     @staticmethod
  97     def format_on_edit(final_content, edit_content):
  98         BaseTopic.format_on_edit(final_content, edit_content)
  99         if edit_content.get("password"):
 100             salt = uuid4().hex
 101             final_content["_admin"]["salt"] = salt
 102             final_content["password"] = sha256(edit_content["password"].encode('utf-8') +
 103                                                salt.encode('utf-8')).hexdigest()
 104         return None
 105
 106     def edit(self, session, _id, indata=None, kwargs=None, content=None):
 107         if not session["admin"]:
 108             raise EngineException("needed admin privileges", http_code=HTTPStatus.UNAUTHORIZED)
 109         # Names that look like UUIDs are not allowed
 110         name = (indata if indata else kwargs).get("username")
 111         if is_valid_uuid(name):
 112             raise EngineException("Usernames that look like UUIDs are not allowed",
 113                                   http_code=HTTPStatus.UNPROCESSABLE_ENTITY)
 114         return BaseTopic.edit(self, session, _id, indata=indata, kwargs=kwargs, content=content)
 115
 116     def new(self, rollback, session, indata=None, kwargs=None, headers=None):
 117         if not session["admin"]:
 118             raise EngineException("needed admin privileges", http_code=HTTPStatus.UNAUTHORIZED)
 119         # Names that look like UUIDs are not allowed
 120         name = indata["username"] if indata else kwargs["username"]
 121         if is_valid_uuid(name):
 122             raise EngineException("Usernames that look like UUIDs are not allowed",
 123                                   http_code=HTTPStatus.UNPROCESSABLE_ENTITY)
 124         return BaseTopic.new(self, rollback, session, indata=indata, kwargs=kwargs, headers=headers)
 125
 126
 127 class ProjectTopic(BaseTopic):
 128     topic = "projects"
 129     topic_msg = "projects"
 130     schema_new = project_new_schema
 131     schema_edit = project_edit_schema
 132     multiproject = False
 133
 134     def __init__(self, db, fs, msg, auth):
 135         BaseTopic.__init__(self, db, fs, msg, auth)
 136
 137     @staticmethod
 138     def _get_project_filter(session):
 139         """
 140         Generates a filter dictionary for querying database users.
 141         Current policy is admin can show all, non admin, only its own user.
 142         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 143         :return:
 144         """
 145         if session["admin"]:  # allows all
 146             return {}
 147         else:
 148             return {"_id.cont": session["project_id"]}
 149
 150     def check_conflict_on_new(self, session, indata):
 151         if not indata.get("name"):
 152             raise EngineException("missing 'name'")
 153         # check name not exists
 154         if self.db.get_one(self.topic, {"name": indata.get("name")}, fail_on_empty=False, fail_on_more=False):
 155             raise EngineException("name '{}' exists".format(indata["name"]), HTTPStatus.CONFLICT)
 156
 157     @staticmethod
 158     def format_on_new(content, project_id=None, make_public=False):
 159         BaseTopic.format_on_new(content, None)
 160         # Removed so that the UUID is kept, to allow Project Name modification
 161         # content["_id"] = content["name"]
 162
 163     def check_conflict_on_del(self, session, _id, db_content):
 164         """
 165         Check if deletion can be done because of dependencies if it is not force. To override
 166         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 167         :param _id: internal _id
 168         :param db_content: The database content of this item _id
 169         :return: None if ok or raises EngineException with the conflict
 170         """
 171         if _id in session["project_id"]:
 172             raise EngineException("You cannot delete your own project", http_code=HTTPStatus.CONFLICT)
 173         if session["force"]:
 174             return
 175         _filter = {"projects": _id}
 176         if self.db.get_list("users", _filter):
 177             raise EngineException("There is some USER that contains this project", http_code=HTTPStatus.CONFLICT)
 178
 179     def edit(self, session, _id, indata=None, kwargs=None, content=None):
 180         if not session["admin"]:
 181             raise EngineException("needed admin privileges", http_code=HTTPStatus.UNAUTHORIZED)
 182         # Names that look like UUIDs are not allowed
 183         name = (indata if indata else kwargs).get("name")
 184         if is_valid_uuid(name):
 185             raise EngineException("Project names that look like UUIDs are not allowed",
 186                                   http_code=HTTPStatus.UNPROCESSABLE_ENTITY)
 187         return BaseTopic.edit(self, session, _id, indata=indata, kwargs=kwargs, content=content)
 188
 189     def new(self, rollback, session, indata=None, kwargs=None, headers=None):
 190         if not session["admin"]:
 191             raise EngineException("needed admin privileges", http_code=HTTPStatus.UNAUTHORIZED)
 192         # Names that look like UUIDs are not allowed
 193         name = indata["name"] if indata else kwargs["name"]
 194         if is_valid_uuid(name):
 195             raise EngineException("Project names that look like UUIDs are not allowed",
 196                                   http_code=HTTPStatus.UNPROCESSABLE_ENTITY)
 197         return BaseTopic.new(self, rollback, session, indata=indata, kwargs=kwargs, headers=headers)
 198
 199
 200 class CommonVimWimSdn(BaseTopic):
 201     """Common class for VIM, WIM SDN just to unify methods that are equal to all of them"""
 202     config_to_encrypt = {}     # what keys at config must be encrypted because contains passwords
 203     password_to_encrypt = ""   # key that contains a password
 204
 205     @staticmethod
 206     def _create_operation(op_type, params=None):
 207         """
 208         Creates a dictionary with the information to an operation, similar to ns-lcm-op
 209         :param op_type: can be create, edit, delete
 210         :param params: operation input parameters
 211         :return: new dictionary with
 212         """
 213         now = time()
 214         return {
 215             "lcmOperationType": op_type,
 216             "operationState": "PROCESSING",
 217             "startTime": now,
 218             "statusEnteredTime": now,
 219             "detailed-status": "",
 220             "operationParams": params,
 221         }
 222
 223     def check_conflict_on_new(self, session, indata):
 224         """
 225         Check that the data to be inserted is valid. It is checked that name is unique
 226         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 227         :param indata: data to be inserted
 228         :return: None or raises EngineException
 229         """
 230         self.check_unique_name(session, indata["name"], _id=None)
 231
 232     def check_conflict_on_edit(self, session, final_content, edit_content, _id):
 233         """
 234         Check that the data to be edited/uploaded is valid. It is checked that name is unique
 235         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 236         :param final_content: data once modified. This method may change it.
 237         :param edit_content: incremental data that contains the modifications to apply
 238         :param _id: internal _id
 239         :return: None or raises EngineException
 240         """
 241         if not session["force"] and edit_content.get("name"):
 242             self.check_unique_name(session, edit_content["name"], _id=_id)
 243
 244     def format_on_edit(self, final_content, edit_content):
 245         """
 246         Modifies final_content inserting admin information upon edition
 247         :param final_content: final content to be stored at database
 248         :param edit_content: user requested update content
 249         :return: operation id
 250         """
 251         super().format_on_edit(final_content, edit_content)
 252
 253         # encrypt passwords
 254         schema_version = final_content.get("schema_version")
 255         if schema_version:
 256             if edit_content.get(self.password_to_encrypt):
 257                 final_content[self.password_to_encrypt] = self.db.encrypt(edit_content[self.password_to_encrypt],
 258                                                                           schema_version=schema_version,
 259                                                                           salt=final_content["_id"])
 260             config_to_encrypt_keys = self.config_to_encrypt.get(schema_version) or self.config_to_encrypt.get("default")
 261             if edit_content.get("config") and config_to_encrypt_keys:
 262
 263                 for p in config_to_encrypt_keys:
 264                     if edit_content["config"].get(p):
 265                         final_content["config"][p] = self.db.encrypt(edit_content["config"][p],
 266                                                                      schema_version=schema_version,
 267                                                                      salt=final_content["_id"])
 268
 269         # create edit operation
 270         final_content["_admin"]["operations"].append(self._create_operation("edit"))
 271         return "{}:{}".format(final_content["_id"], len(final_content["_admin"]["operations"]) - 1)
 272
 273     def format_on_new(self, content, project_id=None, make_public=False):
 274         """
 275         Modifies content descriptor to include _admin and insert create operation
 276         :param content: descriptor to be modified
 277         :param project_id: if included, it add project read/write permissions. Can be None or a list
 278         :param make_public: if included it is generated as public for reading.
 279         :return: op_id: operation id on asynchronous operation, None otherwise. In addition content is modified
 280         """
 281         super().format_on_new(content, project_id=project_id, make_public=make_public)
 282         content["schema_version"] = schema_version = "1.11"
 283
 284         # encrypt passwords
 285         if content.get(self.password_to_encrypt):
 286             content[self.password_to_encrypt] = self.db.encrypt(content[self.password_to_encrypt],
 287                                                                 schema_version=schema_version,
 288                                                                 salt=content["_id"])
 289         config_to_encrypt_keys = self.config_to_encrypt.get(schema_version) or self.config_to_encrypt.get("default")
 290         if content.get("config") and config_to_encrypt_keys:
 291             for p in config_to_encrypt_keys:
 292                 if content["config"].get(p):
 293                     content["config"][p] = self.db.encrypt(content["config"][p],
 294                                                            schema_version=schema_version,
 295                                                            salt=content["_id"])
 296
 297         content["_admin"]["operationalState"] = "PROCESSING"
 298
 299         # create operation
 300         content["_admin"]["operations"] = [self._create_operation("create")]
 301         content["_admin"]["current_operation"] = None
 302
 303         return "{}:0".format(content["_id"])
 304
 305     def delete(self, session, _id, dry_run=False, not_send_msg=None):
 306         """
 307         Delete item by its internal _id
 308         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 309         :param _id: server internal id
 310         :param dry_run: make checking but do not delete
 311         :param not_send_msg: To not send message (False) or store content (list) instead
 312         :return: operation id if it is ordered to delete. None otherwise
 313         """
 314
 315         filter_q = self._get_project_filter(session)
 316         filter_q["_id"] = _id
 317         db_content = self.db.get_one(self.topic, filter_q)
 318
 319         self.check_conflict_on_del(session, _id, db_content)
 320         if dry_run:
 321             return None
 322
 323         # remove reference from project_read. If not last delete
 324         if session["project_id"]:
 325             for project_id in session["project_id"]:
 326                 if project_id in db_content["_admin"]["projects_read"]:
 327                     db_content["_admin"]["projects_read"].remove(project_id)
 328                 if project_id in db_content["_admin"]["projects_write"]:
 329                     db_content["_admin"]["projects_write"].remove(project_id)
 330         else:
 331             db_content["_admin"]["projects_read"].clear()
 332             db_content["_admin"]["projects_write"].clear()
 333
 334         update_dict = {"_admin.projects_read": db_content["_admin"]["projects_read"],
 335                        "_admin.projects_write": db_content["_admin"]["projects_write"]
 336                        }
 337
 338         # check if there are projects referencing it (apart from ANY that means public)....
 339         if db_content["_admin"]["projects_read"] and (len(db_content["_admin"]["projects_read"]) > 1 or
 340                                                       db_content["_admin"]["projects_read"][0] != "ANY"):
 341             self.db.set_one(self.topic, filter_q, update_dict=update_dict)  # remove references but not delete
 342             return None
 343
 344         # It must be deleted
 345         if session["force"]:
 346             self.db.del_one(self.topic, {"_id": _id})
 347             op_id = None
 348             self._send_msg("deleted", {"_id": _id, "op_id": op_id}, not_send_msg=not_send_msg)
 349         else:
 350             update_dict["_admin.to_delete"] = True
 351             self.db.set_one(self.topic, {"_id": _id},
 352                             update_dict=update_dict,
 353                             push={"_admin.operations": self._create_operation("delete")}
 354                             )
 355             # the number of operations is the operation_id. db_content does not contains the new operation inserted,
 356             # so the -1 is not needed
 357             op_id = "{}:{}".format(db_content["_id"], len(db_content["_admin"]["operations"]))
 358             self._send_msg("delete", {"_id": _id, "op_id": op_id}, not_send_msg=not_send_msg)
 359         return op_id
 360
 361
 362 class VimAccountTopic(CommonVimWimSdn):
 363     topic = "vim_accounts"
 364     topic_msg = "vim_account"
 365     schema_new = vim_account_new_schema
 366     schema_edit = vim_account_edit_schema
 367     multiproject = True
 368     password_to_encrypt = "vim_password"
 369     config_to_encrypt = {"1.1": ("admin_password", "nsx_password", "vcenter_password"),
 370                          "default": ("admin_password", "nsx_password", "vcenter_password", "vrops_password")}
 371
 372     def check_conflict_on_del(self, session, _id, db_content):
 373         """
 374         Check if deletion can be done because of dependencies if it is not force. To override
 375         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 376         :param _id: internal _id
 377         :param db_content: The database content of this item _id
 378         :return: None if ok or raises EngineException with the conflict
 379         """
 380         if session["force"]:
 381             return
 382         # check if used by VNF
 383         if self.db.get_list("vnfrs", {"vim-account-id": _id}):
 384             raise EngineException("There is at least one VNF using this VIM account", http_code=HTTPStatus.CONFLICT)
 385         super().check_conflict_on_del(session, _id, db_content)
 386
 387
 388 class WimAccountTopic(CommonVimWimSdn):
 389     topic = "wim_accounts"
 390     topic_msg = "wim_account"
 391     schema_new = wim_account_new_schema
 392     schema_edit = wim_account_edit_schema
 393     multiproject = True
 394     password_to_encrypt = "wim_password"
 395     config_to_encrypt = {}
 396
 397
 398 class SdnTopic(CommonVimWimSdn):
 399     topic = "sdns"
 400     topic_msg = "sdn"
 401     schema_new = sdn_new_schema
 402     schema_edit = sdn_edit_schema
 403     multiproject = True
 404     password_to_encrypt = "password"
 405     config_to_encrypt = {}
 406
 407
 408 class K8sClusterTopic(CommonVimWimSdn):
 409     topic = "k8sclusters"
 410     topic_msg = "k8scluster"
 411     schema_new = k8scluster_new_schema
 412     schema_edit = k8scluster_edit_schema
 413     multiproject = True
 414     password_to_encrypt = None
 415     config_to_encrypt = {}
 416
 417     def format_on_new(self, content, project_id=None, make_public=False):
 418         oid = super().format_on_new(content, project_id, make_public)
 419         self.db.encrypt_decrypt_fields(content["credentials"], 'encrypt', ['password', 'secret'],
 420                                        schema_version=content["schema_version"], salt=content["_id"])
 421         return oid
 422
 423     def format_on_edit(self, final_content, edit_content):
 424         if final_content.get("schema_version") and edit_content.get("credentials"):
 425             self.db.encrypt_decrypt_fields(edit_content["credentials"], 'encrypt', ['password', 'secret'],
 426                                            schema_version=final_content["schema_version"], salt=final_content["_id"])
 427             deep_update_rfc7396(final_content["credentials"], edit_content["credentials"])
 428         oid = super().format_on_edit(final_content, edit_content)
 429         return oid
 430
 431
 432 class K8sRepoTopic(CommonVimWimSdn):
 433     topic = "k8srepos"
 434     topic_msg = "k8srepo"
 435     schema_new = k8srepo_new_schema
 436     schema_edit = k8srepo_edit_schema
 437     multiproject = True
 438     password_to_encrypt = None
 439     config_to_encrypt = {}
 440
 441
 442 class UserTopicAuth(UserTopic):
 443     # topic = "users"
 444     # topic_msg = "users"
 445     schema_new = user_new_schema
 446     schema_edit = user_edit_schema
 447
 448     def __init__(self, db, fs, msg, auth):
 449         UserTopic.__init__(self, db, fs, msg, auth)
 450         # self.auth = auth
 451
 452     def check_conflict_on_new(self, session, indata):
 453         """
 454         Check that the data to be inserted is valid
 455
 456         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 457         :param indata: data to be inserted
 458         :return: None or raises EngineException
 459         """
 460         username = indata.get("username")
 461         if is_valid_uuid(username):
 462             raise EngineException("username '{}' cannot have a uuid format".format(username),
 463                                   HTTPStatus.UNPROCESSABLE_ENTITY)
 464
 465         # Check that username is not used, regardless keystone already checks this
 466         if self.auth.get_user_list(filter_q={"name": username}):
 467             raise EngineException("username '{}' is already used".format(username), HTTPStatus.CONFLICT)
 468
 469         if "projects" in indata.keys():
 470             # convert to new format project_role_mappings
 471             role = self.auth.get_role_list({"name": "project_admin"})
 472             if not role:
 473                 role = self.auth.get_role_list()
 474             if not role:
 475                 raise AuthconnNotFoundException("Can't find default role for user '{}'".format(username))
 476             rid = role[0]["_id"]
 477             if not indata.get("project_role_mappings"):
 478                 indata["project_role_mappings"] = []
 479             for project in indata["projects"]:
 480                 pid = self.auth.get_project(project)["_id"]
 481                 prm = {"project": pid, "role": rid}
 482                 if prm not in indata["project_role_mappings"]:
 483                     indata["project_role_mappings"].append(prm)
 484             # raise EngineException("Format invalid: the keyword 'projects' is not allowed for keystone authentication",
 485             #                       HTTPStatus.BAD_REQUEST)
 486
 487     def check_conflict_on_edit(self, session, final_content, edit_content, _id):
 488         """
 489         Check that the data to be edited/uploaded is valid
 490
 491         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 492         :param final_content: data once modified
 493         :param edit_content: incremental data that contains the modifications to apply
 494         :param _id: internal _id
 495         :return: None or raises EngineException
 496         """
 497
 498         if "username" in edit_content:
 499             username = edit_content.get("username")
 500             if is_valid_uuid(username):
 501                 raise EngineException("username '{}' cannot have an uuid format".format(username),
 502                                       HTTPStatus.UNPROCESSABLE_ENTITY)
 503
 504             # Check that username is not used, regardless keystone already checks this
 505             if self.auth.get_user_list(filter_q={"name": username}):
 506                 raise EngineException("username '{}' is already used".format(username), HTTPStatus.CONFLICT)
 507
 508         if final_content["username"] == "admin":
 509             for mapping in edit_content.get("remove_project_role_mappings", ()):
 510                 if mapping["project"] == "admin" and mapping.get("role") in (None, "system_admin"):
 511                     # TODO make this also available for project id and role id
 512                     raise EngineException("You cannot remove system_admin role from admin user",
 513                                           http_code=HTTPStatus.FORBIDDEN)
 514
 515     def check_conflict_on_del(self, session, _id, db_content):
 516         """
 517         Check if deletion can be done because of dependencies if it is not force. To override
 518         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 519         :param _id: internal _id
 520         :param db_content: The database content of this item _id
 521         :return: None if ok or raises EngineException with the conflict
 522         """
 523         if db_content["username"] == session["username"]:
 524             raise EngineException("You cannot delete your own login user ", http_code=HTTPStatus.CONFLICT)
 525         # TODO: Check that user is not logged in ? How? (Would require listing current tokens)
 526
 527     @staticmethod
 528     def format_on_show(content):
 529         """
 530         Modifies the content of the role information to separate the role
 531         metadata from the role definition.
 532         """
 533         project_role_mappings = []
 534
 535         if "projects" in content:
 536             for project in content["projects"]:
 537                 for role in project["roles"]:
 538                     project_role_mappings.append({"project": project["_id"],
 539                                                   "project_name": project["name"],
 540                                                   "role": role["_id"],
 541                                                   "role_name": role["name"]})
 542             del content["projects"]
 543         content["project_role_mappings"] = project_role_mappings
 544
 545         return content
 546
 547     def new(self, rollback, session, indata=None, kwargs=None, headers=None):
 548         """
 549         Creates a new entry into the authentication backend.
 550
 551         NOTE: Overrides BaseTopic functionality because it doesn't require access to database.
 552
 553         :param rollback: list to append created items at database in case a rollback may to be done
 554         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 555         :param indata: data to be inserted
 556         :param kwargs: used to override the indata descriptor
 557         :param headers: http request headers
 558         :return: _id: identity of the inserted data, operation _id (None)
 559         """
 560         try:
 561             content = BaseTopic._remove_envelop(indata)
 562
 563             # Override descriptor with query string kwargs
 564             BaseTopic._update_input_with_kwargs(content, kwargs)
 565             content = self._validate_input_new(content, session["force"])
 566             self.check_conflict_on_new(session, content)
 567             # self.format_on_new(content, session["project_id"], make_public=session["public"])
 568             now = time()
 569             content["_admin"] = {"created": now, "modified": now}
 570             prms = []
 571             for prm in content.get("project_role_mappings", []):
 572                 proj = self.auth.get_project(prm["project"], not session["force"])
 573                 role = self.auth.get_role(prm["role"], not session["force"])
 574                 pid = proj["_id"] if proj else None
 575                 rid = role["_id"] if role else None
 576                 prl = {"project": pid, "role": rid}
 577                 if prl not in prms:
 578                     prms.append(prl)
 579             content["project_role_mappings"] = prms
 580             # _id = self.auth.create_user(content["username"], content["password"])["_id"]
 581             _id = self.auth.create_user(content)["_id"]
 582
 583             rollback.append({"topic": self.topic, "_id": _id})
 584             # del content["password"]
 585             # self._send_msg("created", content, not_send_msg=not_send_msg)
 586             return _id, None
 587         except ValidationError as e:
 588             raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
 589
 590     def show(self, session, _id):
 591         """
 592         Get complete information on an topic
 593
 594         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 595         :param _id: server internal id
 596         :return: dictionary, raise exception if not found.
 597         """
 598         # Allow _id to be a name or uuid
 599         filter_q = {self.id_field(self.topic, _id): _id}
 600         # users = self.auth.get_user_list(filter_q)
 601         users = self.list(session, filter_q)   # To allow default filtering (Bug 853)
 602         if len(users) == 1:
 603             return users[0]
 604         elif len(users) > 1:
 605             raise EngineException("Too many users found", HTTPStatus.CONFLICT)
 606         else:
 607             raise EngineException("User not found", HTTPStatus.NOT_FOUND)
 608
 609     def edit(self, session, _id, indata=None, kwargs=None, content=None):
 610         """
 611         Updates an user entry.
 612
 613         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 614         :param _id:
 615         :param indata: data to be inserted
 616         :param kwargs: used to override the indata descriptor
 617         :param content:
 618         :return: _id: identity of the inserted data.
 619         """
 620         indata = self._remove_envelop(indata)
 621
 622         # Override descriptor with query string kwargs
 623         if kwargs:
 624             BaseTopic._update_input_with_kwargs(indata, kwargs)
 625         try:
 626             indata = self._validate_input_edit(indata, force=session["force"])
 627
 628             if not content:
 629                 content = self.show(session, _id)
 630             self.check_conflict_on_edit(session, content, indata, _id=_id)
 631             # self.format_on_edit(content, indata)
 632
 633             if not ("password" in indata or "username" in indata or indata.get("remove_project_role_mappings") or
 634                     indata.get("add_project_role_mappings") or indata.get("project_role_mappings") or
 635                     indata.get("projects") or indata.get("add_projects")):
 636                 return _id
 637             if indata.get("project_role_mappings") \
 638                     and (indata.get("remove_project_role_mappings") or indata.get("add_project_role_mappings")):
 639                 raise EngineException("Option 'project_role_mappings' is incompatible with 'add_project_role_mappings"
 640                                       "' or 'remove_project_role_mappings'", http_code=HTTPStatus.BAD_REQUEST)
 641
 642             if indata.get("projects") or indata.get("add_projects"):
 643                 role = self.auth.get_role_list({"name": "project_admin"})
 644                 if not role:
 645                     role = self.auth.get_role_list()
 646                 if not role:
 647                     raise AuthconnNotFoundException("Can't find a default role for user '{}'"
 648                                                     .format(content["username"]))
 649                 rid = role[0]["_id"]
 650                 if "add_project_role_mappings" not in indata:
 651                     indata["add_project_role_mappings"] = []
 652                 if "remove_project_role_mappings" not in indata:
 653                     indata["remove_project_role_mappings"] = []
 654                 if isinstance(indata.get("projects"), dict):
 655                     # backward compatible
 656                     for k, v in indata["projects"].items():
 657                         if k.startswith("$") and v is None:
 658                             indata["remove_project_role_mappings"].append({"project": k[1:]})
 659                         elif k.startswith("$+"):
 660                             indata["add_project_role_mappings"].append({"project": v, "role": rid})
 661                     del indata["projects"]
 662                 for proj in indata.get("projects", []) + indata.get("add_projects", []):
 663                     indata["add_project_role_mappings"].append({"project": proj, "role": rid})
 664
 665             # user = self.show(session, _id)   # Already in 'content'
 666             original_mapping = content["project_role_mappings"]
 667
 668             mappings_to_add = []
 669             mappings_to_remove = []
 670
 671             # remove
 672             for to_remove in indata.get("remove_project_role_mappings", ()):
 673                 for mapping in original_mapping:
 674                     if to_remove["project"] in (mapping["project"], mapping["project_name"]):
 675                         if not to_remove.get("role") or to_remove["role"] in (mapping["role"], mapping["role_name"]):
 676                             mappings_to_remove.append(mapping)
 677
 678             # add
 679             for to_add in indata.get("add_project_role_mappings", ()):
 680                 for mapping in original_mapping:
 681                     if to_add["project"] in (mapping["project"], mapping["project_name"]) and \
 682                             to_add["role"] in (mapping["role"], mapping["role_name"]):
 683
 684                         if mapping in mappings_to_remove:   # do not remove
 685                             mappings_to_remove.remove(mapping)
 686                         break  # do not add, it is already at user
 687                 else:
 688                     pid = self.auth.get_project(to_add["project"])["_id"]
 689                     rid = self.auth.get_role(to_add["role"])["_id"]
 690                     mappings_to_add.append({"project": pid, "role": rid})
 691
 692             # set
 693             if indata.get("project_role_mappings"):
 694                 for to_set in indata["project_role_mappings"]:
 695                     for mapping in original_mapping:
 696                         if to_set["project"] in (mapping["project"], mapping["project_name"]) and \
 697                                 to_set["role"] in (mapping["role"], mapping["role_name"]):
 698                             if mapping in mappings_to_remove:   # do not remove
 699                                 mappings_to_remove.remove(mapping)
 700                             break  # do not add, it is already at user
 701                     else:
 702                         pid = self.auth.get_project(to_set["project"])["_id"]
 703                         rid = self.auth.get_role(to_set["role"])["_id"]
 704                         mappings_to_add.append({"project": pid, "role": rid})
 705                 for mapping in original_mapping:
 706                     for to_set in indata["project_role_mappings"]:
 707                         if to_set["project"] in (mapping["project"], mapping["project_name"]) and \
 708                                 to_set["role"] in (mapping["role"], mapping["role_name"]):
 709                             break
 710                     else:
 711                         # delete
 712                         if mapping not in mappings_to_remove:   # do not remove
 713                             mappings_to_remove.append(mapping)
 714
 715             self.auth.update_user({"_id": _id, "username": indata.get("username"), "password": indata.get("password"),
 716                                    "add_project_role_mappings": mappings_to_add,
 717                                    "remove_project_role_mappings": mappings_to_remove
 718                                    })
 719
 720             # return _id
 721         except ValidationError as e:
 722             raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
 723
 724     def list(self, session, filter_q=None):
 725         """
 726         Get a list of the topic that matches a filter
 727         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 728         :param filter_q: filter of data to be applied
 729         :return: The list, it can be empty if no one match the filter.
 730         """
 731         user_list = self.auth.get_user_list(filter_q)
 732         if not session["allow_show_user_project_role"]:
 733             # Bug 853 - Default filtering
 734             user_list = [usr for usr in user_list if usr["username"] == session["username"]]
 735         return user_list
 736
 737     def delete(self, session, _id, dry_run=False, not_send_msg=None):
 738         """
 739         Delete item by its internal _id
 740
 741         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 742         :param _id: server internal id
 743         :param force: indicates if deletion must be forced in case of conflict
 744         :param dry_run: make checking but do not delete
 745         :param not_send_msg: To not send message (False) or store content (list) instead
 746         :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
 747         """
 748         # Allow _id to be a name or uuid
 749         user = self.auth.get_user(_id)
 750         uid = user["_id"]
 751         self.check_conflict_on_del(session, uid, user)
 752         if not dry_run:
 753             v = self.auth.delete_user(uid)
 754             return v
 755         return None
 756
 757
 758 class ProjectTopicAuth(ProjectTopic):
 759     # topic = "projects"
 760     # topic_msg = "projects"
 761     schema_new = project_new_schema
 762     schema_edit = project_edit_schema
 763
 764     def __init__(self, db, fs, msg, auth):
 765         ProjectTopic.__init__(self, db, fs, msg, auth)
 766         # self.auth = auth
 767
 768     def check_conflict_on_new(self, session, indata):
 769         """
 770         Check that the data to be inserted is valid
 771
 772         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 773         :param indata: data to be inserted
 774         :return: None or raises EngineException
 775         """
 776         project_name = indata.get("name")
 777         if is_valid_uuid(project_name):
 778             raise EngineException("project name '{}' cannot have an uuid format".format(project_name),
 779                                   HTTPStatus.UNPROCESSABLE_ENTITY)
 780
 781         project_list = self.auth.get_project_list(filter_q={"name": project_name})
 782
 783         if project_list:
 784             raise EngineException("project '{}' exists".format(project_name), HTTPStatus.CONFLICT)
 785
 786     def check_conflict_on_edit(self, session, final_content, edit_content, _id):
 787         """
 788         Check that the data to be edited/uploaded is valid
 789
 790         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 791         :param final_content: data once modified
 792         :param edit_content: incremental data that contains the modifications to apply
 793         :param _id: internal _id
 794         :return: None or raises EngineException
 795         """
 796
 797         project_name = edit_content.get("name")
 798         if project_name != final_content["name"]:  # It is a true renaming
 799             if is_valid_uuid(project_name):
 800                 raise EngineException("project name '{}' cannot have an uuid format".format(project_name),
 801                                       HTTPStatus.UNPROCESSABLE_ENTITY)
 802
 803             if final_content["name"] == "admin":
 804                 raise EngineException("You cannot rename project 'admin'", http_code=HTTPStatus.CONFLICT)
 805
 806             # Check that project name is not used, regardless keystone already checks this
 807             if project_name and self.auth.get_project_list(filter_q={"name": project_name}):
 808                 raise EngineException("project '{}' is already used".format(project_name), HTTPStatus.CONFLICT)
 809
 810     def check_conflict_on_del(self, session, _id, db_content):
 811         """
 812         Check if deletion can be done because of dependencies if it is not force. To override
 813
 814         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 815         :param _id: internal _id
 816         :param db_content: The database content of this item _id
 817         :return: None if ok or raises EngineException with the conflict
 818         """
 819
 820         def check_rw_projects(topic, title, id_field):
 821             for desc in self.db.get_list(topic):
 822                 if _id in desc["_admin"]["projects_read"] + desc["_admin"]["projects_write"]:
 823                     raise EngineException("Project '{}' ({}) is being used by {} '{}'"
 824                                           .format(db_content["name"], _id, title, desc[id_field]), HTTPStatus.CONFLICT)
 825
 826         if _id in session["project_id"]:
 827             raise EngineException("You cannot delete your own project", http_code=HTTPStatus.CONFLICT)
 828
 829         if db_content["name"] == "admin":
 830             raise EngineException("You cannot delete project 'admin'", http_code=HTTPStatus.CONFLICT)
 831
 832         # If any user is using this project, raise CONFLICT exception
 833         if not session["force"]:
 834             for user in self.auth.get_user_list():
 835                 for prm in user.get("project_role_mappings"):
 836                     if prm["project"] == _id:
 837                         raise EngineException("Project '{}' ({}) is being used by user '{}'"
 838                                               .format(db_content["name"], _id, user["username"]), HTTPStatus.CONFLICT)
 839
 840         # If any VNFD, NSD, NST, PDU, etc. is using this project, raise CONFLICT exception
 841         if not session["force"]:
 842             check_rw_projects("vnfds", "VNF Descriptor", "id")
 843             check_rw_projects("nsds", "NS Descriptor", "id")
 844             check_rw_projects("nsts", "NS Template", "id")
 845             check_rw_projects("pdus", "PDU Descriptor", "name")
 846
 847     def new(self, rollback, session, indata=None, kwargs=None, headers=None):
 848         """
 849         Creates a new entry into the authentication backend.
 850
 851         NOTE: Overrides BaseTopic functionality because it doesn't require access to database.
 852
 853         :param rollback: list to append created items at database in case a rollback may to be done
 854         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 855         :param indata: data to be inserted
 856         :param kwargs: used to override the indata descriptor
 857         :param headers: http request headers
 858         :return: _id: identity of the inserted data, operation _id (None)
 859         """
 860         try:
 861             content = BaseTopic._remove_envelop(indata)
 862
 863             # Override descriptor with query string kwargs
 864             BaseTopic._update_input_with_kwargs(content, kwargs)
 865             content = self._validate_input_new(content, session["force"])
 866             self.check_conflict_on_new(session, content)
 867             self.format_on_new(content, project_id=session["project_id"], make_public=session["public"])
 868             _id = self.auth.create_project(content)
 869             rollback.append({"topic": self.topic, "_id": _id})
 870             # self._send_msg("created", content, not_send_msg=not_send_msg)
 871             return _id, None
 872         except ValidationError as e:
 873             raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
 874
 875     def show(self, session, _id):
 876         """
 877         Get complete information on an topic
 878
 879         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 880         :param _id: server internal id
 881         :return: dictionary, raise exception if not found.
 882         """
 883         # Allow _id to be a name or uuid
 884         filter_q = {self.id_field(self.topic, _id): _id}
 885         # projects = self.auth.get_project_list(filter_q=filter_q)
 886         projects = self.list(session, filter_q)   # To allow default filtering (Bug 853)
 887         if len(projects) == 1:
 888             return projects[0]
 889         elif len(projects) > 1:
 890             raise EngineException("Too many projects found", HTTPStatus.CONFLICT)
 891         else:
 892             raise EngineException("Project not found", HTTPStatus.NOT_FOUND)
 893
 894     def list(self, session, filter_q=None):
 895         """
 896         Get a list of the topic that matches a filter
 897
 898         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 899         :param filter_q: filter of data to be applied
 900         :return: The list, it can be empty if no one match the filter.
 901         """
 902         project_list = self.auth.get_project_list(filter_q)
 903         if not session["allow_show_user_project_role"]:
 904             # Bug 853 - Default filtering
 905             user = self.auth.get_user(session["username"])
 906             projects = [prm["project"] for prm in user["project_role_mappings"]]
 907             project_list = [proj for proj in project_list if proj["_id"] in projects]
 908         return project_list
 909
 910     def delete(self, session, _id, dry_run=False, not_send_msg=None):
 911         """
 912         Delete item by its internal _id
 913
 914         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 915         :param _id: server internal id
 916         :param dry_run: make checking but do not delete
 917         :param not_send_msg: To not send message (False) or store content (list) instead
 918         :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
 919         """
 920         # Allow _id to be a name or uuid
 921         proj = self.auth.get_project(_id)
 922         pid = proj["_id"]
 923         self.check_conflict_on_del(session, pid, proj)
 924         if not dry_run:
 925             v = self.auth.delete_project(pid)
 926             return v
 927         return None
 928
 929     def edit(self, session, _id, indata=None, kwargs=None, content=None):
 930         """
 931         Updates a project entry.
 932
 933         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 934         :param _id:
 935         :param indata: data to be inserted
 936         :param kwargs: used to override the indata descriptor
 937         :param content:
 938         :return: _id: identity of the inserted data.
 939         """
 940         indata = self._remove_envelop(indata)
 941
 942         # Override descriptor with query string kwargs
 943         if kwargs:
 944             BaseTopic._update_input_with_kwargs(indata, kwargs)
 945         try:
 946             indata = self._validate_input_edit(indata, force=session["force"])
 947
 948             if not content:
 949                 content = self.show(session, _id)
 950             self.check_conflict_on_edit(session, content, indata, _id=_id)
 951             self.format_on_edit(content, indata)
 952
 953             deep_update_rfc7396(content, indata)
 954             self.auth.update_project(content["_id"], content)
 955         except ValidationError as e:
 956             raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
 957
 958
 959 class RoleTopicAuth(BaseTopic):
 960     topic = "roles"
 961     topic_msg = None    # "roles"
 962     schema_new = roles_new_schema
 963     schema_edit = roles_edit_schema
 964     multiproject = False
 965
 966     def __init__(self, db, fs, msg, auth, ops):
 967         BaseTopic.__init__(self, db, fs, msg, auth)
 968         # self.auth = auth
 969         self.operations = ops
 970         # self.topic = "roles_operations" if isinstance(auth, AuthconnKeystone) else "roles"
 971
 972     @staticmethod
 973     def validate_role_definition(operations, role_definitions):
 974         """
 975         Validates the role definition against the operations defined in
 976         the resources to operations files.
 977
 978         :param operations: operations list
 979         :param role_definitions: role definition to test
 980         :return: None if ok, raises ValidationError exception on error
 981         """
 982         if not role_definitions.get("permissions"):
 983             return
 984         ignore_fields = ["admin", "default"]
 985         for role_def in role_definitions["permissions"].keys():
 986             if role_def in ignore_fields:
 987                 continue
 988             if role_def[-1] == ":":
 989                 raise ValidationError("Operation cannot end with ':'")
 990
 991             role_def_matches = [op for op in operations if op.startswith(role_def)]
 992
 993             if len(role_def_matches) == 0:
 994                 raise ValidationError("Invalid permission '{}'".format(role_def))
 995
 996     def _validate_input_new(self, input, force=False):
 997         """
 998         Validates input user content for a new entry.
 999
1000         :param input: user input content for the new topic
1001         :param force: may be used for being more tolerant
1002         :return: The same input content, or a changed version of it.
1003         """
1004         if self.schema_new:
1005             validate_input(input, self.schema_new)
1006             self.validate_role_definition(self.operations, input)
1007
1008         return input
1009
1010     def _validate_input_edit(self, input, force=False):
1011         """
1012         Validates input user content for updating an entry.
1013
1014         :param input: user input content for the new topic
1015         :param force: may be used for being more tolerant
1016         :return: The same input content, or a changed version of it.
1017         """
1018         if self.schema_edit:
1019             validate_input(input, self.schema_edit)
1020             self.validate_role_definition(self.operations, input)
1021
1022         return input
1023
1024     def check_conflict_on_new(self, session, indata):
1025         """
1026         Check that the data to be inserted is valid
1027
1028         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1029         :param indata: data to be inserted
1030         :return: None or raises EngineException
1031         """
1032         # check name is not uuid
1033         role_name = indata.get("name")
1034         if is_valid_uuid(role_name):
1035             raise EngineException("role name '{}' cannot have an uuid format".format(role_name),
1036                                   HTTPStatus.UNPROCESSABLE_ENTITY)
1037         # check name not exists
1038         name = indata["name"]
1039         # if self.db.get_one(self.topic, {"name": indata.get("name")}, fail_on_empty=False, fail_on_more=False):
1040         if self.auth.get_role_list({"name": name}):
1041             raise EngineException("role name '{}' exists".format(name), HTTPStatus.CONFLICT)
1042
1043     def check_conflict_on_edit(self, session, final_content, edit_content, _id):
1044         """
1045         Check that the data to be edited/uploaded is valid
1046
1047         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1048         :param final_content: data once modified
1049         :param edit_content: incremental data that contains the modifications to apply
1050         :param _id: internal _id
1051         :return: None or raises EngineException
1052         """
1053         if "default" not in final_content["permissions"]:
1054             final_content["permissions"]["default"] = False
1055         if "admin" not in final_content["permissions"]:
1056             final_content["permissions"]["admin"] = False
1057
1058         # check name is not uuid
1059         role_name = edit_content.get("name")
1060         if is_valid_uuid(role_name):
1061             raise EngineException("role name '{}' cannot have an uuid format".format(role_name),
1062                                   HTTPStatus.UNPROCESSABLE_ENTITY)
1063
1064         # Check renaming of admin roles
1065         role = self.auth.get_role(_id)
1066         if role["name"] in ["system_admin", "project_admin"]:
1067             raise EngineException("You cannot rename role '{}'".format(role["name"]), http_code=HTTPStatus.FORBIDDEN)
1068
1069         # check name not exists
1070         if "name" in edit_content:
1071             role_name = edit_content["name"]
1072             # if self.db.get_one(self.topic, {"name":role_name,"_id.ne":_id}, fail_on_empty=False, fail_on_more=False):
1073             roles = self.auth.get_role_list({"name": role_name})
1074             if roles and roles[0][BaseTopic.id_field("roles", _id)] != _id:
1075                 raise EngineException("role name '{}' exists".format(role_name), HTTPStatus.CONFLICT)
1076
1077     def check_conflict_on_del(self, session, _id, db_content):
1078         """
1079         Check if deletion can be done because of dependencies if it is not force. To override
1080
1081         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1082         :param _id: internal _id
1083         :param db_content: The database content of this item _id
1084         :return: None if ok or raises EngineException with the conflict
1085         """
1086         role = self.auth.get_role(_id)
1087         if role["name"] in ["system_admin", "project_admin"]:
1088             raise EngineException("You cannot delete role '{}'".format(role["name"]), http_code=HTTPStatus.FORBIDDEN)
1089
1090         # If any user is using this role, raise CONFLICT exception
1091         for user in self.auth.get_user_list():
1092             for prm in user.get("project_role_mappings"):
1093                 if prm["role"] == _id:
1094                     raise EngineException("Role '{}' ({}) is being used by user '{}'"
1095                                           .format(role["name"], _id, user["username"]), HTTPStatus.CONFLICT)
1096
1097     @staticmethod
1098     def format_on_new(content, project_id=None, make_public=False):   # TO BE REMOVED ?
1099         """
1100         Modifies content descriptor to include _admin
1101
1102         :param content: descriptor to be modified
1103         :param project_id: if included, it add project read/write permissions
1104         :param make_public: if included it is generated as public for reading.
1105         :return: None, but content is modified
1106         """
1107         now = time()
1108         if "_admin" not in content:
1109             content["_admin"] = {}
1110         if not content["_admin"].get("created"):
1111             content["_admin"]["created"] = now
1112         content["_admin"]["modified"] = now
1113
1114         if "permissions" not in content:
1115             content["permissions"] = {}
1116
1117         if "default" not in content["permissions"]:
1118             content["permissions"]["default"] = False
1119         if "admin" not in content["permissions"]:
1120             content["permissions"]["admin"] = False
1121
1122     @staticmethod
1123     def format_on_edit(final_content, edit_content):
1124         """
1125         Modifies final_content descriptor to include the modified date.
1126
1127         :param final_content: final descriptor generated
1128         :param edit_content: alterations to be include
1129         :return: None, but final_content is modified
1130         """
1131         if "_admin" in final_content:
1132             final_content["_admin"]["modified"] = time()
1133
1134         if "permissions" not in final_content:
1135             final_content["permissions"] = {}
1136
1137         if "default" not in final_content["permissions"]:
1138             final_content["permissions"]["default"] = False
1139         if "admin" not in final_content["permissions"]:
1140             final_content["permissions"]["admin"] = False
1141         return None
1142
1143     def show(self, session, _id):
1144         """
1145         Get complete information on an topic
1146
1147         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1148         :param _id: server internal id
1149         :return: dictionary, raise exception if not found.
1150         """
1151         filter_q = {BaseTopic.id_field(self.topic, _id): _id}
1152         # roles = self.auth.get_role_list(filter_q)
1153         roles = self.list(session, filter_q)   # To allow default filtering (Bug 853)
1154         if not roles:
1155             raise AuthconnNotFoundException("Not found any role with filter {}".format(filter_q))
1156         elif len(roles) > 1:
1157             raise AuthconnConflictException("Found more than one role with filter {}".format(filter_q))
1158         return roles[0]
1159
1160     def list(self, session, filter_q=None):
1161         """
1162         Get a list of the topic that matches a filter
1163
1164         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1165         :param filter_q: filter of data to be applied
1166         :return: The list, it can be empty if no one match the filter.
1167         """
1168         role_list = self.auth.get_role_list(filter_q)
1169         if not session["allow_show_user_project_role"]:
1170             # Bug 853 - Default filtering
1171             user = self.auth.get_user(session["username"])
1172             roles = [prm["role"] for prm in user["project_role_mappings"]]
1173             role_list = [role for role in role_list if role["_id"] in roles]
1174         return role_list
1175
1176     def new(self, rollback, session, indata=None, kwargs=None, headers=None):
1177         """
1178         Creates a new entry into database.
1179
1180         :param rollback: list to append created items at database in case a rollback may to be done
1181         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1182         :param indata: data to be inserted
1183         :param kwargs: used to override the indata descriptor
1184         :param headers: http request headers
1185         :return: _id: identity of the inserted data, operation _id (None)
1186         """
1187         try:
1188             content = self._remove_envelop(indata)
1189
1190             # Override descriptor with query string kwargs
1191             self._update_input_with_kwargs(content, kwargs)
1192             content = self._validate_input_new(content, session["force"])
1193             self.check_conflict_on_new(session, content)
1194             self.format_on_new(content, project_id=session["project_id"], make_public=session["public"])
1195             # role_name = content["name"]
1196             rid = self.auth.create_role(content)
1197             content["_id"] = rid
1198             # _id = self.db.create(self.topic, content)
1199             rollback.append({"topic": self.topic, "_id": rid})
1200             # self._send_msg("created", content, not_send_msg=not_send_msg)
1201             return rid, None
1202         except ValidationError as e:
1203             raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
1204
1205     def delete(self, session, _id, dry_run=False, not_send_msg=None):
1206         """
1207         Delete item by its internal _id
1208
1209         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1210         :param _id: server internal id
1211         :param dry_run: make checking but do not delete
1212         :param not_send_msg: To not send message (False) or store content (list) instead
1213         :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
1214         """
1215         filter_q = {BaseTopic.id_field(self.topic, _id): _id}
1216         roles = self.auth.get_role_list(filter_q)
1217         if not roles:
1218             raise AuthconnNotFoundException("Not found any role with filter {}".format(filter_q))
1219         elif len(roles) > 1:
1220             raise AuthconnConflictException("Found more than one role with filter {}".format(filter_q))
1221         rid = roles[0]["_id"]
1222         self.check_conflict_on_del(session, rid, None)
1223         # filter_q = {"_id": _id}
1224         # filter_q = {BaseTopic.id_field(self.topic, _id): _id}   # To allow role addressing by name
1225         if not dry_run:
1226             v = self.auth.delete_role(rid)
1227             # v = self.db.del_one(self.topic, filter_q)
1228             return v
1229         return None
1230
1231     def edit(self, session, _id, indata=None, kwargs=None, content=None):
1232         """
1233         Updates a role entry.
1234
1235         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1236         :param _id:
1237         :param indata: data to be inserted
1238         :param kwargs: used to override the indata descriptor
1239         :param content:
1240         :return: _id: identity of the inserted data.
1241         """
1242         if kwargs:
1243             self._update_input_with_kwargs(indata, kwargs)
1244         try:
1245             indata = self._validate_input_edit(indata, force=session["force"])
1246             if not content:
1247                 content = self.show(session, _id)
1248             deep_update_rfc7396(content, indata)
1249             self.check_conflict_on_edit(session, content, indata, _id=_id)
1250             self.format_on_edit(content, indata)
1251             self.auth.update_role(content)
1252         except ValidationError as e:
1253             raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)