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 there are more projects referencing it. If it last one,
 324         # do not remove reference, but order via kafka to delete it
 325         if session["project_id"] and session["project_id"]:
 326             other_projects_referencing = next((p for p in db_content["_admin"]["projects_read"]
 327                                                if p not in session["project_id"]), None)
 328
 329             # check if there are projects referencing it (apart from ANY, that means, public)....
 330             if other_projects_referencing:
 331                 # remove references but not delete
 332                 update_dict_pull = {"_admin.projects_read.{}".format(p): None for p in session["project_id"]}
 333                 update_dict_pull.update({"_admin.projects_write.{}".format(p): None for p in session["project_id"]})
 334                 self.db.set_one(self.topic, filter_q, update_dict=None, pull=update_dict_pull)
 335                 return None
 336             else:
 337                 can_write = next((p for p in db_content["_admin"]["projects_write"] if p == "ANY" or
 338                                   p in session["project_id"]), None)
 339                 if not can_write:
 340                     raise EngineException("You have not write permission to delete it",
 341                                           http_code=HTTPStatus.UNAUTHORIZED)
 342
 343         # It must be deleted
 344         if session["force"]:
 345             self.db.del_one(self.topic, {"_id": _id})
 346             op_id = None
 347             self._send_msg("deleted", {"_id": _id, "op_id": op_id}, not_send_msg=not_send_msg)
 348         else:
 349             update_dict = {"_admin.to_delete": True}
 350             self.db.set_one(self.topic, {"_id": _id},
 351                             update_dict=update_dict,
 352                             push={"_admin.operations": self._create_operation("delete")}
 353                             )
 354             # the number of operations is the operation_id. db_content does not contains the new operation inserted,
 355             # so the -1 is not needed
 356             op_id = "{}:{}".format(db_content["_id"], len(db_content["_admin"]["operations"]))
 357             self._send_msg("delete", {"_id": _id, "op_id": op_id}, not_send_msg=not_send_msg)
 358         return op_id
 359
 360
 361 class VimAccountTopic(CommonVimWimSdn):
 362     topic = "vim_accounts"
 363     topic_msg = "vim_account"
 364     schema_new = vim_account_new_schema
 365     schema_edit = vim_account_edit_schema
 366     multiproject = True
 367     password_to_encrypt = "vim_password"
 368     config_to_encrypt = {"1.1": ("admin_password", "nsx_password", "vcenter_password"),
 369                          "default": ("admin_password", "nsx_password", "vcenter_password", "vrops_password")}
 370
 371     def check_conflict_on_del(self, session, _id, db_content):
 372         """
 373         Check if deletion can be done because of dependencies if it is not force. To override
 374         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 375         :param _id: internal _id
 376         :param db_content: The database content of this item _id
 377         :return: None if ok or raises EngineException with the conflict
 378         """
 379         if session["force"]:
 380             return
 381         # check if used by VNF
 382         if self.db.get_list("vnfrs", {"vim-account-id": _id}):
 383             raise EngineException("There is at least one VNF using this VIM account", http_code=HTTPStatus.CONFLICT)
 384         super().check_conflict_on_del(session, _id, db_content)
 385
 386
 387 class WimAccountTopic(CommonVimWimSdn):
 388     topic = "wim_accounts"
 389     topic_msg = "wim_account"
 390     schema_new = wim_account_new_schema
 391     schema_edit = wim_account_edit_schema
 392     multiproject = True
 393     password_to_encrypt = "wim_password"
 394     config_to_encrypt = {}
 395
 396
 397 class SdnTopic(CommonVimWimSdn):
 398     topic = "sdns"
 399     topic_msg = "sdn"
 400     schema_new = sdn_new_schema
 401     schema_edit = sdn_edit_schema
 402     multiproject = True
 403     password_to_encrypt = "password"
 404     config_to_encrypt = {}
 405
 406     def _obtain_url(self, input, create):
 407         if input.get("ip") or input.get("port"):
 408             if not input.get("ip") or not input.get("port") or input.get('url'):
 409                 raise ValidationError("You must provide both 'ip' and 'port' (deprecated); or just 'url' (prefered)")
 410             input['url'] = "http://{}:{}/".format(input["ip"], input["port"])
 411             del input["ip"]
 412             del input["port"]
 413         elif create and not input.get('url'):
 414             raise ValidationError("You must provide 'url'")
 415         return input
 416
 417     def _validate_input_new(self, input, force=False):
 418         input = super()._validate_input_new(input, force)
 419         return self._obtain_url(input, True)
 420
 421     def _validate_input_edit(self, input, force=False):
 422         input = super()._validate_input_edit(input, force)
 423         return self._obtain_url(input, False)
 424
 425
 426 class K8sClusterTopic(CommonVimWimSdn):
 427     topic = "k8sclusters"
 428     topic_msg = "k8scluster"
 429     schema_new = k8scluster_new_schema
 430     schema_edit = k8scluster_edit_schema
 431     multiproject = True
 432     password_to_encrypt = None
 433     config_to_encrypt = {}
 434
 435     def format_on_new(self, content, project_id=None, make_public=False):
 436         oid = super().format_on_new(content, project_id, make_public)
 437         self.db.encrypt_decrypt_fields(content["credentials"], 'encrypt', ['password', 'secret'],
 438                                        schema_version=content["schema_version"], salt=content["_id"])
 439         # Add Helm/Juju Repo lists
 440         repos = {"helm-chart": [], "juju-bundle": []}
 441         for proj in content["_admin"]["projects_read"]:
 442             if proj != 'ANY':
 443                 for repo in self.db.get_list("k8srepos", {"_admin.projects_read": proj}):
 444                     if repo["_id"] not in repos[repo["type"]]:
 445                         repos[repo["type"]].append(repo["_id"])
 446         for k in repos:
 447             content["_admin"][k.replace('-', '_')+"_repos"] = repos[k]
 448         return oid
 449
 450     def format_on_edit(self, final_content, edit_content):
 451         if final_content.get("schema_version") and edit_content.get("credentials"):
 452             self.db.encrypt_decrypt_fields(edit_content["credentials"], 'encrypt', ['password', 'secret'],
 453                                            schema_version=final_content["schema_version"], salt=final_content["_id"])
 454             deep_update_rfc7396(final_content["credentials"], edit_content["credentials"])
 455         oid = super().format_on_edit(final_content, edit_content)
 456         return oid
 457
 458     def check_conflict_on_edit(self, session, final_content, edit_content, _id):
 459         super(CommonVimWimSdn, self).check_conflict_on_edit(session, final_content, edit_content, _id)
 460         super().check_conflict_on_edit(session, final_content, edit_content, _id)
 461         # Update Helm/Juju Repo lists
 462         repos = {"helm-chart": [], "juju-bundle": []}
 463         for proj in session.get("set_project", []):
 464             if proj != 'ANY':
 465                 for repo in self.db.get_list("k8srepos", {"_admin.projects_read": proj}):
 466                     if repo["_id"] not in repos[repo["type"]]:
 467                         repos[repo["type"]].append(repo["_id"])
 468         for k in repos:
 469             rlist = k.replace('-', '_') + "_repos"
 470             if rlist not in final_content["_admin"]:
 471                 final_content["_admin"][rlist] = []
 472             final_content["_admin"][rlist] += repos[k]
 473
 474
 475 class K8sRepoTopic(CommonVimWimSdn):
 476     topic = "k8srepos"
 477     topic_msg = "k8srepo"
 478     schema_new = k8srepo_new_schema
 479     schema_edit = k8srepo_edit_schema
 480     multiproject = True
 481     password_to_encrypt = None
 482     config_to_encrypt = {}
 483
 484     def format_on_new(self, content, project_id=None, make_public=False):
 485         oid = super().format_on_new(content, project_id, make_public)
 486         # Update Helm/Juju Repo lists
 487         repo_list = content["type"].replace('-', '_')+"_repos"
 488         for proj in content["_admin"]["projects_read"]:
 489             if proj != 'ANY':
 490                 self.db.set_list("k8sclusters",
 491                                  {"_admin.projects_read": proj, "_admin."+repo_list+".ne": content["_id"]}, {},
 492                                  push={"_admin."+repo_list: content["_id"]})
 493         return oid
 494
 495     def delete(self, session, _id, dry_run=False, not_send_msg=None):
 496         type = self.db.get_one("k8srepos", {"_id": _id})["type"]
 497         oid = super().delete(session, _id, dry_run, not_send_msg)
 498         if oid:
 499             # Remove from Helm/Juju Repo lists
 500             repo_list = type.replace('-', '_') + "_repos"
 501             self.db.set_list("k8sclusters", {"_admin."+repo_list: _id}, {}, pull={"_admin."+repo_list: _id})
 502         return oid
 503
 504
 505 class UserTopicAuth(UserTopic):
 506     # topic = "users"
 507     # topic_msg = "users"
 508     schema_new = user_new_schema
 509     schema_edit = user_edit_schema
 510
 511     def __init__(self, db, fs, msg, auth):
 512         UserTopic.__init__(self, db, fs, msg, auth)
 513         # self.auth = auth
 514
 515     def check_conflict_on_new(self, session, indata):
 516         """
 517         Check that the data to be inserted is valid
 518
 519         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 520         :param indata: data to be inserted
 521         :return: None or raises EngineException
 522         """
 523         username = indata.get("username")
 524         if is_valid_uuid(username):
 525             raise EngineException("username '{}' cannot have a uuid format".format(username),
 526                                   HTTPStatus.UNPROCESSABLE_ENTITY)
 527
 528         # Check that username is not used, regardless keystone already checks this
 529         if self.auth.get_user_list(filter_q={"name": username}):
 530             raise EngineException("username '{}' is already used".format(username), HTTPStatus.CONFLICT)
 531
 532         if "projects" in indata.keys():
 533             # convert to new format project_role_mappings
 534             role = self.auth.get_role_list({"name": "project_admin"})
 535             if not role:
 536                 role = self.auth.get_role_list()
 537             if not role:
 538                 raise AuthconnNotFoundException("Can't find default role for user '{}'".format(username))
 539             rid = role[0]["_id"]
 540             if not indata.get("project_role_mappings"):
 541                 indata["project_role_mappings"] = []
 542             for project in indata["projects"]:
 543                 pid = self.auth.get_project(project)["_id"]
 544                 prm = {"project": pid, "role": rid}
 545                 if prm not in indata["project_role_mappings"]:
 546                     indata["project_role_mappings"].append(prm)
 547             # raise EngineException("Format invalid: the keyword 'projects' is not allowed for keystone authentication",
 548             #                       HTTPStatus.BAD_REQUEST)
 549
 550     def check_conflict_on_edit(self, session, final_content, edit_content, _id):
 551         """
 552         Check that the data to be edited/uploaded is valid
 553
 554         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 555         :param final_content: data once modified
 556         :param edit_content: incremental data that contains the modifications to apply
 557         :param _id: internal _id
 558         :return: None or raises EngineException
 559         """
 560
 561         if "username" in edit_content:
 562             username = edit_content.get("username")
 563             if is_valid_uuid(username):
 564                 raise EngineException("username '{}' cannot have an uuid format".format(username),
 565                                       HTTPStatus.UNPROCESSABLE_ENTITY)
 566
 567             # Check that username is not used, regardless keystone already checks this
 568             if self.auth.get_user_list(filter_q={"name": username}):
 569                 raise EngineException("username '{}' is already used".format(username), HTTPStatus.CONFLICT)
 570
 571         if final_content["username"] == "admin":
 572             for mapping in edit_content.get("remove_project_role_mappings", ()):
 573                 if mapping["project"] == "admin" and mapping.get("role") in (None, "system_admin"):
 574                     # TODO make this also available for project id and role id
 575                     raise EngineException("You cannot remove system_admin role from admin user",
 576                                           http_code=HTTPStatus.FORBIDDEN)
 577
 578     def check_conflict_on_del(self, session, _id, db_content):
 579         """
 580         Check if deletion can be done because of dependencies if it is not force. To override
 581         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 582         :param _id: internal _id
 583         :param db_content: The database content of this item _id
 584         :return: None if ok or raises EngineException with the conflict
 585         """
 586         if db_content["username"] == session["username"]:
 587             raise EngineException("You cannot delete your own login user ", http_code=HTTPStatus.CONFLICT)
 588         # TODO: Check that user is not logged in ? How? (Would require listing current tokens)
 589
 590     @staticmethod
 591     def format_on_show(content):
 592         """
 593         Modifies the content of the role information to separate the role
 594         metadata from the role definition.
 595         """
 596         project_role_mappings = []
 597
 598         if "projects" in content:
 599             for project in content["projects"]:
 600                 for role in project["roles"]:
 601                     project_role_mappings.append({"project": project["_id"],
 602                                                   "project_name": project["name"],
 603                                                   "role": role["_id"],
 604                                                   "role_name": role["name"]})
 605             del content["projects"]
 606         content["project_role_mappings"] = project_role_mappings
 607
 608         return content
 609
 610     def new(self, rollback, session, indata=None, kwargs=None, headers=None):
 611         """
 612         Creates a new entry into the authentication backend.
 613
 614         NOTE: Overrides BaseTopic functionality because it doesn't require access to database.
 615
 616         :param rollback: list to append created items at database in case a rollback may to be done
 617         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 618         :param indata: data to be inserted
 619         :param kwargs: used to override the indata descriptor
 620         :param headers: http request headers
 621         :return: _id: identity of the inserted data, operation _id (None)
 622         """
 623         try:
 624             content = BaseTopic._remove_envelop(indata)
 625
 626             # Override descriptor with query string kwargs
 627             BaseTopic._update_input_with_kwargs(content, kwargs)
 628             content = self._validate_input_new(content, session["force"])
 629             self.check_conflict_on_new(session, content)
 630             # self.format_on_new(content, session["project_id"], make_public=session["public"])
 631             now = time()
 632             content["_admin"] = {"created": now, "modified": now}
 633             prms = []
 634             for prm in content.get("project_role_mappings", []):
 635                 proj = self.auth.get_project(prm["project"], not session["force"])
 636                 role = self.auth.get_role(prm["role"], not session["force"])
 637                 pid = proj["_id"] if proj else None
 638                 rid = role["_id"] if role else None
 639                 prl = {"project": pid, "role": rid}
 640                 if prl not in prms:
 641                     prms.append(prl)
 642             content["project_role_mappings"] = prms
 643             # _id = self.auth.create_user(content["username"], content["password"])["_id"]
 644             _id = self.auth.create_user(content)["_id"]
 645
 646             rollback.append({"topic": self.topic, "_id": _id})
 647             # del content["password"]
 648             # self._send_msg("created", content, not_send_msg=not_send_msg)
 649             return _id, None
 650         except ValidationError as e:
 651             raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
 652
 653     def show(self, session, _id):
 654         """
 655         Get complete information on an topic
 656
 657         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 658         :param _id: server internal id or username
 659         :return: dictionary, raise exception if not found.
 660         """
 661         # Allow _id to be a name or uuid
 662         filter_q = {"username": _id}
 663         # users = self.auth.get_user_list(filter_q)
 664         users = self.list(session, filter_q)   # To allow default filtering (Bug 853)
 665         if len(users) == 1:
 666             return users[0]
 667         elif len(users) > 1:
 668             raise EngineException("Too many users found for '{}'".format(_id), HTTPStatus.CONFLICT)
 669         else:
 670             raise EngineException("User '{}' not found".format(_id), HTTPStatus.NOT_FOUND)
 671
 672     def edit(self, session, _id, indata=None, kwargs=None, content=None):
 673         """
 674         Updates an user entry.
 675
 676         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 677         :param _id:
 678         :param indata: data to be inserted
 679         :param kwargs: used to override the indata descriptor
 680         :param content:
 681         :return: _id: identity of the inserted data.
 682         """
 683         indata = self._remove_envelop(indata)
 684
 685         # Override descriptor with query string kwargs
 686         if kwargs:
 687             BaseTopic._update_input_with_kwargs(indata, kwargs)
 688         try:
 689             indata = self._validate_input_edit(indata, force=session["force"])
 690
 691             if not content:
 692                 content = self.show(session, _id)
 693             self.check_conflict_on_edit(session, content, indata, _id=_id)
 694             # self.format_on_edit(content, indata)
 695
 696             if not ("password" in indata or "username" in indata or indata.get("remove_project_role_mappings") or
 697                     indata.get("add_project_role_mappings") or indata.get("project_role_mappings") or
 698                     indata.get("projects") or indata.get("add_projects")):
 699                 return _id
 700             if indata.get("project_role_mappings") \
 701                     and (indata.get("remove_project_role_mappings") or indata.get("add_project_role_mappings")):
 702                 raise EngineException("Option 'project_role_mappings' is incompatible with 'add_project_role_mappings"
 703                                       "' or 'remove_project_role_mappings'", http_code=HTTPStatus.BAD_REQUEST)
 704
 705             if indata.get("projects") or indata.get("add_projects"):
 706                 role = self.auth.get_role_list({"name": "project_admin"})
 707                 if not role:
 708                     role = self.auth.get_role_list()
 709                 if not role:
 710                     raise AuthconnNotFoundException("Can't find a default role for user '{}'"
 711                                                     .format(content["username"]))
 712                 rid = role[0]["_id"]
 713                 if "add_project_role_mappings" not in indata:
 714                     indata["add_project_role_mappings"] = []
 715                 if "remove_project_role_mappings" not in indata:
 716                     indata["remove_project_role_mappings"] = []
 717                 if isinstance(indata.get("projects"), dict):
 718                     # backward compatible
 719                     for k, v in indata["projects"].items():
 720                         if k.startswith("$") and v is None:
 721                             indata["remove_project_role_mappings"].append({"project": k[1:]})
 722                         elif k.startswith("$+"):
 723                             indata["add_project_role_mappings"].append({"project": v, "role": rid})
 724                     del indata["projects"]
 725                 for proj in indata.get("projects", []) + indata.get("add_projects", []):
 726                     indata["add_project_role_mappings"].append({"project": proj, "role": rid})
 727
 728             # user = self.show(session, _id)   # Already in 'content'
 729             original_mapping = content["project_role_mappings"]
 730
 731             mappings_to_add = []
 732             mappings_to_remove = []
 733
 734             # remove
 735             for to_remove in indata.get("remove_project_role_mappings", ()):
 736                 for mapping in original_mapping:
 737                     if to_remove["project"] in (mapping["project"], mapping["project_name"]):
 738                         if not to_remove.get("role") or to_remove["role"] in (mapping["role"], mapping["role_name"]):
 739                             mappings_to_remove.append(mapping)
 740
 741             # add
 742             for to_add in indata.get("add_project_role_mappings", ()):
 743                 for mapping in original_mapping:
 744                     if to_add["project"] in (mapping["project"], mapping["project_name"]) and \
 745                             to_add["role"] in (mapping["role"], mapping["role_name"]):
 746
 747                         if mapping in mappings_to_remove:   # do not remove
 748                             mappings_to_remove.remove(mapping)
 749                         break  # do not add, it is already at user
 750                 else:
 751                     pid = self.auth.get_project(to_add["project"])["_id"]
 752                     rid = self.auth.get_role(to_add["role"])["_id"]
 753                     mappings_to_add.append({"project": pid, "role": rid})
 754
 755             # set
 756             if indata.get("project_role_mappings"):
 757                 for to_set in indata["project_role_mappings"]:
 758                     for mapping in original_mapping:
 759                         if to_set["project"] in (mapping["project"], mapping["project_name"]) and \
 760                                 to_set["role"] in (mapping["role"], mapping["role_name"]):
 761                             if mapping in mappings_to_remove:   # do not remove
 762                                 mappings_to_remove.remove(mapping)
 763                             break  # do not add, it is already at user
 764                     else:
 765                         pid = self.auth.get_project(to_set["project"])["_id"]
 766                         rid = self.auth.get_role(to_set["role"])["_id"]
 767                         mappings_to_add.append({"project": pid, "role": rid})
 768                 for mapping in original_mapping:
 769                     for to_set in indata["project_role_mappings"]:
 770                         if to_set["project"] in (mapping["project"], mapping["project_name"]) and \
 771                                 to_set["role"] in (mapping["role"], mapping["role_name"]):
 772                             break
 773                     else:
 774                         # delete
 775                         if mapping not in mappings_to_remove:   # do not remove
 776                             mappings_to_remove.append(mapping)
 777
 778             self.auth.update_user({"_id": _id, "username": indata.get("username"), "password": indata.get("password"),
 779                                    "add_project_role_mappings": mappings_to_add,
 780                                    "remove_project_role_mappings": mappings_to_remove
 781                                    })
 782
 783             # return _id
 784         except ValidationError as e:
 785             raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
 786
 787     def list(self, session, filter_q=None):
 788         """
 789         Get a list of the topic that matches a filter
 790         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 791         :param filter_q: filter of data to be applied
 792         :return: The list, it can be empty if no one match the filter.
 793         """
 794         user_list = self.auth.get_user_list(filter_q)
 795         if not session["allow_show_user_project_role"]:
 796             # Bug 853 - Default filtering
 797             user_list = [usr for usr in user_list if usr["username"] == session["username"]]
 798         return user_list
 799
 800     def delete(self, session, _id, dry_run=False, not_send_msg=None):
 801         """
 802         Delete item by its internal _id
 803
 804         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 805         :param _id: server internal id
 806         :param force: indicates if deletion must be forced in case of conflict
 807         :param dry_run: make checking but do not delete
 808         :param not_send_msg: To not send message (False) or store content (list) instead
 809         :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
 810         """
 811         # Allow _id to be a name or uuid
 812         user = self.auth.get_user(_id)
 813         uid = user["_id"]
 814         self.check_conflict_on_del(session, uid, user)
 815         if not dry_run:
 816             v = self.auth.delete_user(uid)
 817             return v
 818         return None
 819
 820
 821 class ProjectTopicAuth(ProjectTopic):
 822     # topic = "projects"
 823     # topic_msg = "projects"
 824     schema_new = project_new_schema
 825     schema_edit = project_edit_schema
 826
 827     def __init__(self, db, fs, msg, auth):
 828         ProjectTopic.__init__(self, db, fs, msg, auth)
 829         # self.auth = auth
 830
 831     def check_conflict_on_new(self, session, indata):
 832         """
 833         Check that the data to be inserted is valid
 834
 835         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 836         :param indata: data to be inserted
 837         :return: None or raises EngineException
 838         """
 839         project_name = indata.get("name")
 840         if is_valid_uuid(project_name):
 841             raise EngineException("project name '{}' cannot have an uuid format".format(project_name),
 842                                   HTTPStatus.UNPROCESSABLE_ENTITY)
 843
 844         project_list = self.auth.get_project_list(filter_q={"name": project_name})
 845
 846         if project_list:
 847             raise EngineException("project '{}' exists".format(project_name), HTTPStatus.CONFLICT)
 848
 849     def check_conflict_on_edit(self, session, final_content, edit_content, _id):
 850         """
 851         Check that the data to be edited/uploaded is valid
 852
 853         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 854         :param final_content: data once modified
 855         :param edit_content: incremental data that contains the modifications to apply
 856         :param _id: internal _id
 857         :return: None or raises EngineException
 858         """
 859
 860         project_name = edit_content.get("name")
 861         if project_name != final_content["name"]:  # It is a true renaming
 862             if is_valid_uuid(project_name):
 863                 raise EngineException("project name '{}' cannot have an uuid format".format(project_name),
 864                                       HTTPStatus.UNPROCESSABLE_ENTITY)
 865
 866             if final_content["name"] == "admin":
 867                 raise EngineException("You cannot rename project 'admin'", http_code=HTTPStatus.CONFLICT)
 868
 869             # Check that project name is not used, regardless keystone already checks this
 870             if project_name and self.auth.get_project_list(filter_q={"name": project_name}):
 871                 raise EngineException("project '{}' is already used".format(project_name), HTTPStatus.CONFLICT)
 872
 873     def check_conflict_on_del(self, session, _id, db_content):
 874         """
 875         Check if deletion can be done because of dependencies if it is not force. To override
 876
 877         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 878         :param _id: internal _id
 879         :param db_content: The database content of this item _id
 880         :return: None if ok or raises EngineException with the conflict
 881         """
 882
 883         def check_rw_projects(topic, title, id_field):
 884             for desc in self.db.get_list(topic):
 885                 if _id in desc["_admin"]["projects_read"] + desc["_admin"]["projects_write"]:
 886                     raise EngineException("Project '{}' ({}) is being used by {} '{}'"
 887                                           .format(db_content["name"], _id, title, desc[id_field]), HTTPStatus.CONFLICT)
 888
 889         if _id in session["project_id"]:
 890             raise EngineException("You cannot delete your own project", http_code=HTTPStatus.CONFLICT)
 891
 892         if db_content["name"] == "admin":
 893             raise EngineException("You cannot delete project 'admin'", http_code=HTTPStatus.CONFLICT)
 894
 895         # If any user is using this project, raise CONFLICT exception
 896         if not session["force"]:
 897             for user in self.auth.get_user_list():
 898                 for prm in user.get("project_role_mappings"):
 899                     if prm["project"] == _id:
 900                         raise EngineException("Project '{}' ({}) is being used by user '{}'"
 901                                               .format(db_content["name"], _id, user["username"]), HTTPStatus.CONFLICT)
 902
 903         # If any VNFD, NSD, NST, PDU, etc. is using this project, raise CONFLICT exception
 904         if not session["force"]:
 905             check_rw_projects("vnfds", "VNF Descriptor", "id")
 906             check_rw_projects("nsds", "NS Descriptor", "id")
 907             check_rw_projects("nsts", "NS Template", "id")
 908             check_rw_projects("pdus", "PDU Descriptor", "name")
 909
 910     def new(self, rollback, session, indata=None, kwargs=None, headers=None):
 911         """
 912         Creates a new entry into the authentication backend.
 913
 914         NOTE: Overrides BaseTopic functionality because it doesn't require access to database.
 915
 916         :param rollback: list to append created items at database in case a rollback may to be done
 917         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 918         :param indata: data to be inserted
 919         :param kwargs: used to override the indata descriptor
 920         :param headers: http request headers
 921         :return: _id: identity of the inserted data, operation _id (None)
 922         """
 923         try:
 924             content = BaseTopic._remove_envelop(indata)
 925
 926             # Override descriptor with query string kwargs
 927             BaseTopic._update_input_with_kwargs(content, kwargs)
 928             content = self._validate_input_new(content, session["force"])
 929             self.check_conflict_on_new(session, content)
 930             self.format_on_new(content, project_id=session["project_id"], make_public=session["public"])
 931             _id = self.auth.create_project(content)
 932             rollback.append({"topic": self.topic, "_id": _id})
 933             # self._send_msg("created", content, not_send_msg=not_send_msg)
 934             return _id, None
 935         except ValidationError as e:
 936             raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
 937
 938     def show(self, session, _id):
 939         """
 940         Get complete information on an topic
 941
 942         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 943         :param _id: server internal id
 944         :return: dictionary, raise exception if not found.
 945         """
 946         # Allow _id to be a name or uuid
 947         filter_q = {self.id_field(self.topic, _id): _id}
 948         # projects = self.auth.get_project_list(filter_q=filter_q)
 949         projects = self.list(session, filter_q)   # To allow default filtering (Bug 853)
 950         if len(projects) == 1:
 951             return projects[0]
 952         elif len(projects) > 1:
 953             raise EngineException("Too many projects found", HTTPStatus.CONFLICT)
 954         else:
 955             raise EngineException("Project not found", HTTPStatus.NOT_FOUND)
 956
 957     def list(self, session, filter_q=None):
 958         """
 959         Get a list of the topic that matches a filter
 960
 961         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 962         :param filter_q: filter of data to be applied
 963         :return: The list, it can be empty if no one match the filter.
 964         """
 965         project_list = self.auth.get_project_list(filter_q)
 966         if not session["allow_show_user_project_role"]:
 967             # Bug 853 - Default filtering
 968             user = self.auth.get_user(session["username"])
 969             projects = [prm["project"] for prm in user["project_role_mappings"]]
 970             project_list = [proj for proj in project_list if proj["_id"] in projects]
 971         return project_list
 972
 973     def delete(self, session, _id, dry_run=False, not_send_msg=None):
 974         """
 975         Delete item by its internal _id
 976
 977         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 978         :param _id: server internal id
 979         :param dry_run: make checking but do not delete
 980         :param not_send_msg: To not send message (False) or store content (list) instead
 981         :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
 982         """
 983         # Allow _id to be a name or uuid
 984         proj = self.auth.get_project(_id)
 985         pid = proj["_id"]
 986         self.check_conflict_on_del(session, pid, proj)
 987         if not dry_run:
 988             v = self.auth.delete_project(pid)
 989             return v
 990         return None
 991
 992     def edit(self, session, _id, indata=None, kwargs=None, content=None):
 993         """
 994         Updates a project entry.
 995
 996         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 997         :param _id:
 998         :param indata: data to be inserted
 999         :param kwargs: used to override the indata descriptor
1000         :param content:
1001         :return: _id: identity of the inserted data.
1002         """
1003         indata = self._remove_envelop(indata)
1004
1005         # Override descriptor with query string kwargs
1006         if kwargs:
1007             BaseTopic._update_input_with_kwargs(indata, kwargs)
1008         try:
1009             indata = self._validate_input_edit(indata, force=session["force"])
1010
1011             if not content:
1012                 content = self.show(session, _id)
1013             self.check_conflict_on_edit(session, content, indata, _id=_id)
1014             self.format_on_edit(content, indata)
1015
1016             deep_update_rfc7396(content, indata)
1017             self.auth.update_project(content["_id"], content)
1018         except ValidationError as e:
1019             raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
1020
1021
1022 class RoleTopicAuth(BaseTopic):
1023     topic = "roles"
1024     topic_msg = None    # "roles"
1025     schema_new = roles_new_schema
1026     schema_edit = roles_edit_schema
1027     multiproject = False
1028
1029     def __init__(self, db, fs, msg, auth):
1030         BaseTopic.__init__(self, db, fs, msg, auth)
1031         # self.auth = auth
1032         self.operations = auth.role_permissions
1033         # self.topic = "roles_operations" if isinstance(auth, AuthconnKeystone) else "roles"
1034
1035     @staticmethod
1036     def validate_role_definition(operations, role_definitions):
1037         """
1038         Validates the role definition against the operations defined in
1039         the resources to operations files.
1040
1041         :param operations: operations list
1042         :param role_definitions: role definition to test
1043         :return: None if ok, raises ValidationError exception on error
1044         """
1045         if not role_definitions.get("permissions"):
1046             return
1047         ignore_fields = ["admin", "default"]
1048         for role_def in role_definitions["permissions"].keys():
1049             if role_def in ignore_fields:
1050                 continue
1051             if role_def[-1] == ":":
1052                 raise ValidationError("Operation cannot end with ':'")
1053
1054             role_def_matches = [op for op in operations if op.startswith(role_def)]
1055
1056             if len(role_def_matches) == 0:
1057                 raise ValidationError("Invalid permission '{}'".format(role_def))
1058
1059     def _validate_input_new(self, input, force=False):
1060         """
1061         Validates input user content for a new entry.
1062
1063         :param input: user input content for the new topic
1064         :param force: may be used for being more tolerant
1065         :return: The same input content, or a changed version of it.
1066         """
1067         if self.schema_new:
1068             validate_input(input, self.schema_new)
1069             self.validate_role_definition(self.operations, input)
1070
1071         return input
1072
1073     def _validate_input_edit(self, input, force=False):
1074         """
1075         Validates input user content for updating an entry.
1076
1077         :param input: user input content for the new topic
1078         :param force: may be used for being more tolerant
1079         :return: The same input content, or a changed version of it.
1080         """
1081         if self.schema_edit:
1082             validate_input(input, self.schema_edit)
1083             self.validate_role_definition(self.operations, input)
1084
1085         return input
1086
1087     def check_conflict_on_new(self, session, indata):
1088         """
1089         Check that the data to be inserted is valid
1090
1091         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1092         :param indata: data to be inserted
1093         :return: None or raises EngineException
1094         """
1095         # check name is not uuid
1096         role_name = indata.get("name")
1097         if is_valid_uuid(role_name):
1098             raise EngineException("role name '{}' cannot have an uuid format".format(role_name),
1099                                   HTTPStatus.UNPROCESSABLE_ENTITY)
1100         # check name not exists
1101         name = indata["name"]
1102         # if self.db.get_one(self.topic, {"name": indata.get("name")}, fail_on_empty=False, fail_on_more=False):
1103         if self.auth.get_role_list({"name": name}):
1104             raise EngineException("role name '{}' exists".format(name), HTTPStatus.CONFLICT)
1105
1106     def check_conflict_on_edit(self, session, final_content, edit_content, _id):
1107         """
1108         Check that the data to be edited/uploaded is valid
1109
1110         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1111         :param final_content: data once modified
1112         :param edit_content: incremental data that contains the modifications to apply
1113         :param _id: internal _id
1114         :return: None or raises EngineException
1115         """
1116         if "default" not in final_content["permissions"]:
1117             final_content["permissions"]["default"] = False
1118         if "admin" not in final_content["permissions"]:
1119             final_content["permissions"]["admin"] = False
1120
1121         # check name is not uuid
1122         role_name = edit_content.get("name")
1123         if is_valid_uuid(role_name):
1124             raise EngineException("role name '{}' cannot have an uuid format".format(role_name),
1125                                   HTTPStatus.UNPROCESSABLE_ENTITY)
1126
1127         # Check renaming of admin roles
1128         role = self.auth.get_role(_id)
1129         if role["name"] in ["system_admin", "project_admin"]:
1130             raise EngineException("You cannot rename role '{}'".format(role["name"]), http_code=HTTPStatus.FORBIDDEN)
1131
1132         # check name not exists
1133         if "name" in edit_content:
1134             role_name = edit_content["name"]
1135             # if self.db.get_one(self.topic, {"name":role_name,"_id.ne":_id}, fail_on_empty=False, fail_on_more=False):
1136             roles = self.auth.get_role_list({"name": role_name})
1137             if roles and roles[0][BaseTopic.id_field("roles", _id)] != _id:
1138                 raise EngineException("role name '{}' exists".format(role_name), HTTPStatus.CONFLICT)
1139
1140     def check_conflict_on_del(self, session, _id, db_content):
1141         """
1142         Check if deletion can be done because of dependencies if it is not force. To override
1143
1144         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1145         :param _id: internal _id
1146         :param db_content: The database content of this item _id
1147         :return: None if ok or raises EngineException with the conflict
1148         """
1149         role = self.auth.get_role(_id)
1150         if role["name"] in ["system_admin", "project_admin"]:
1151             raise EngineException("You cannot delete role '{}'".format(role["name"]), http_code=HTTPStatus.FORBIDDEN)
1152
1153         # If any user is using this role, raise CONFLICT exception
1154         if not session["force"]:
1155             for user in self.auth.get_user_list():
1156                 for prm in user.get("project_role_mappings"):
1157                     if prm["role"] == _id:
1158                         raise EngineException("Role '{}' ({}) is being used by user '{}'"
1159                                               .format(role["name"], _id, user["username"]), HTTPStatus.CONFLICT)
1160
1161     @staticmethod
1162     def format_on_new(content, project_id=None, make_public=False):   # TO BE REMOVED ?
1163         """
1164         Modifies content descriptor to include _admin
1165
1166         :param content: descriptor to be modified
1167         :param project_id: if included, it add project read/write permissions
1168         :param make_public: if included it is generated as public for reading.
1169         :return: None, but content is modified
1170         """
1171         now = time()
1172         if "_admin" not in content:
1173             content["_admin"] = {}
1174         if not content["_admin"].get("created"):
1175             content["_admin"]["created"] = now
1176         content["_admin"]["modified"] = now
1177
1178         if "permissions" not in content:
1179             content["permissions"] = {}
1180
1181         if "default" not in content["permissions"]:
1182             content["permissions"]["default"] = False
1183         if "admin" not in content["permissions"]:
1184             content["permissions"]["admin"] = False
1185
1186     @staticmethod
1187     def format_on_edit(final_content, edit_content):
1188         """
1189         Modifies final_content descriptor to include the modified date.
1190
1191         :param final_content: final descriptor generated
1192         :param edit_content: alterations to be include
1193         :return: None, but final_content is modified
1194         """
1195         if "_admin" in final_content:
1196             final_content["_admin"]["modified"] = time()
1197
1198         if "permissions" not in final_content:
1199             final_content["permissions"] = {}
1200
1201         if "default" not in final_content["permissions"]:
1202             final_content["permissions"]["default"] = False
1203         if "admin" not in final_content["permissions"]:
1204             final_content["permissions"]["admin"] = False
1205         return None
1206
1207     def show(self, session, _id):
1208         """
1209         Get complete information on an topic
1210
1211         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1212         :param _id: server internal id
1213         :return: dictionary, raise exception if not found.
1214         """
1215         filter_q = {BaseTopic.id_field(self.topic, _id): _id}
1216         # roles = self.auth.get_role_list(filter_q)
1217         roles = self.list(session, filter_q)   # To allow default filtering (Bug 853)
1218         if not roles:
1219             raise AuthconnNotFoundException("Not found any role with filter {}".format(filter_q))
1220         elif len(roles) > 1:
1221             raise AuthconnConflictException("Found more than one role with filter {}".format(filter_q))
1222         return roles[0]
1223
1224     def list(self, session, filter_q=None):
1225         """
1226         Get a list of the topic that matches a filter
1227
1228         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1229         :param filter_q: filter of data to be applied
1230         :return: The list, it can be empty if no one match the filter.
1231         """
1232         role_list = self.auth.get_role_list(filter_q)
1233         if not session["allow_show_user_project_role"]:
1234             # Bug 853 - Default filtering
1235             user = self.auth.get_user(session["username"])
1236             roles = [prm["role"] for prm in user["project_role_mappings"]]
1237             role_list = [role for role in role_list if role["_id"] in roles]
1238         return role_list
1239
1240     def new(self, rollback, session, indata=None, kwargs=None, headers=None):
1241         """
1242         Creates a new entry into database.
1243
1244         :param rollback: list to append created items at database in case a rollback may to be done
1245         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1246         :param indata: data to be inserted
1247         :param kwargs: used to override the indata descriptor
1248         :param headers: http request headers
1249         :return: _id: identity of the inserted data, operation _id (None)
1250         """
1251         try:
1252             content = self._remove_envelop(indata)
1253
1254             # Override descriptor with query string kwargs
1255             self._update_input_with_kwargs(content, kwargs)
1256             content = self._validate_input_new(content, session["force"])
1257             self.check_conflict_on_new(session, content)
1258             self.format_on_new(content, project_id=session["project_id"], make_public=session["public"])
1259             # role_name = content["name"]
1260             rid = self.auth.create_role(content)
1261             content["_id"] = rid
1262             # _id = self.db.create(self.topic, content)
1263             rollback.append({"topic": self.topic, "_id": rid})
1264             # self._send_msg("created", content, not_send_msg=not_send_msg)
1265             return rid, None
1266         except ValidationError as e:
1267             raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
1268
1269     def delete(self, session, _id, dry_run=False, not_send_msg=None):
1270         """
1271         Delete item by its internal _id
1272
1273         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1274         :param _id: server internal id
1275         :param dry_run: make checking but do not delete
1276         :param not_send_msg: To not send message (False) or store content (list) instead
1277         :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
1278         """
1279         filter_q = {BaseTopic.id_field(self.topic, _id): _id}
1280         roles = self.auth.get_role_list(filter_q)
1281         if not roles:
1282             raise AuthconnNotFoundException("Not found any role with filter {}".format(filter_q))
1283         elif len(roles) > 1:
1284             raise AuthconnConflictException("Found more than one role with filter {}".format(filter_q))
1285         rid = roles[0]["_id"]
1286         self.check_conflict_on_del(session, rid, None)
1287         # filter_q = {"_id": _id}
1288         # filter_q = {BaseTopic.id_field(self.topic, _id): _id}   # To allow role addressing by name
1289         if not dry_run:
1290             v = self.auth.delete_role(rid)
1291             # v = self.db.del_one(self.topic, filter_q)
1292             return v
1293         return None
1294
1295     def edit(self, session, _id, indata=None, kwargs=None, content=None):
1296         """
1297         Updates a role entry.
1298
1299         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1300         :param _id:
1301         :param indata: data to be inserted
1302         :param kwargs: used to override the indata descriptor
1303         :param content:
1304         :return: _id: identity of the inserted data.
1305         """
1306         if kwargs:
1307             self._update_input_with_kwargs(indata, kwargs)
1308         try:
1309             indata = self._validate_input_edit(indata, force=session["force"])
1310             if not content:
1311                 content = self.show(session, _id)
1312             deep_update_rfc7396(content, indata)
1313             self.check_conflict_on_edit(session, content, indata, _id=_id)
1314             self.format_on_edit(content, indata)
1315             self.auth.update_role(content)
1316         except ValidationError as e:
1317             raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)