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